]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/sysfs.h
Merge tag 'writeback-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/wfg...
[mirror_ubuntu-bionic-kernel.git] / include / linux / sysfs.h
CommitLineData
1da177e4
LT
1/*
2 * sysfs.h - definitions for the device driver filesystem
3 *
4 * Copyright (c) 2001,2002 Patrick Mochel
5 * Copyright (c) 2004 Silicon Graphics, Inc.
6d66f5cd
TH
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
1da177e4
LT
8 *
9 * Please see Documentation/filesystems/sysfs.txt for more information.
10 */
11
12#ifndef _SYSFS_H_
13#define _SYSFS_H_
14
4a7fb636 15#include <linux/compiler.h>
5851fadc 16#include <linux/errno.h>
bf0acc33 17#include <linux/list.h>
6992f533 18#include <linux/lockdep.h>
8488a38f 19#include <linux/kobject_ns.h>
3493f69f 20#include <linux/stat.h>
60063497 21#include <linux/atomic.h>
1da177e4
LT
22
23struct kobject;
24struct module;
6ab9cea1 25struct bin_attribute;
3ff195b0 26enum kobj_ns_type;
1da177e4
LT
27
28struct attribute {
59f69015 29 const char *name;
9104e427 30 umode_t mode;
6992f533 31#ifdef CONFIG_DEBUG_LOCK_ALLOC
356c05d5 32 bool ignore_lockdep:1;
6992f533
EB
33 struct lock_class_key *key;
34 struct lock_class_key skey;
35#endif
1da177e4
LT
36};
37
35960258
EB
38/**
39 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
40 * @attr: struct attribute to initialize
41 *
42 * Initialize a dynamically allocated struct attribute so we can
43 * make lockdep happy. This is a new requirement for attributes
44 * and initially this is only needed when lockdep is enabled.
45 * Lockdep gives a nice error when your attribute is added to
46 * sysfs if you don't have this.
47 */
6992f533
EB
48#ifdef CONFIG_DEBUG_LOCK_ALLOC
49#define sysfs_attr_init(attr) \
50do { \
51 static struct lock_class_key __key; \
52 \
53 (attr)->key = &__key; \
5da5c9c8 54} while (0)
6992f533 55#else
5da5c9c8 56#define sysfs_attr_init(attr) do {} while (0)
6992f533
EB
57#endif
58
1da177e4 59struct attribute_group {
59f69015 60 const char *name;
587a1f16 61 umode_t (*is_visible)(struct kobject *,
d4acd722 62 struct attribute *, int);
59f69015 63 struct attribute **attrs;
6ab9cea1 64 struct bin_attribute **bin_attrs;
1da177e4
LT
65};
66
1da177e4
LT
67/**
68 * Use these macros to make defining attributes easier. See include/linux/device.h
69 * for examples..
70 */
71
5da5c9c8 72#define __ATTR(_name, _mode, _show, _store) { \
aa01aa3c
OS
73 .attr = {.name = __stringify(_name), .mode = _mode }, \
74 .show = _show, \
75 .store = _store, \
1da177e4
LT
76}
77
aa01aa3c
OS
78#define __ATTR_RO(_name) { \
79 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
80 .show = _name##_show, \
1da177e4
LT
81}
82
a65fcce7
GKH
83#define __ATTR_WO(_name) { \
84 .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \
85 .store = _name##_store, \
86}
87
aa01aa3c
OS
88#define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
89 _name##_show, _name##_store)
b9b32597 90
1da177e4 91#define __ATTR_NULL { .attr = { .name = NULL } }
356c05d5
AS
92
93#ifdef CONFIG_DEBUG_LOCK_ALLOC
94#define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
95 .attr = {.name = __stringify(_name), .mode = _mode, \
96 .ignore_lockdep = true }, \
97 .show = _show, \
98 .store = _store, \
99}
100#else
101#define __ATTR_IGNORE_LOCKDEP __ATTR
102#endif
1da177e4 103
3493f69f
OS
104#define __ATTRIBUTE_GROUPS(_name) \
105static const struct attribute_group *_name##_groups[] = { \
106 &_name##_group, \
f2f37f58
GKH
107 NULL, \
108}
109
3493f69f
OS
110#define ATTRIBUTE_GROUPS(_name) \
111static const struct attribute_group _name##_group = { \
112 .attrs = _name##_attrs, \
113}; \
114__ATTRIBUTE_GROUPS(_name)
115
2c3c8bea 116struct file;
1da177e4
LT
117struct vm_area_struct;
118
119struct bin_attribute {
120 struct attribute attr;
121 size_t size;
122 void *private;
2c3c8bea 123 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
91a69029 124 char *, loff_t, size_t);
5da5c9c8 125 ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
91a69029 126 char *, loff_t, size_t);
2c3c8bea 127 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
1da177e4
LT
128 struct vm_area_struct *vma);
129};
130
35960258
EB
131/**
132 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
133 * @attr: struct bin_attribute to initialize
134 *
135 * Initialize a dynamically allocated struct bin_attribute so we
136 * can make lockdep happy. This is a new requirement for
137 * attributes and initially this is only needed when lockdep is
138 * enabled. Lockdep gives a nice error when your attribute is
139 * added to sysfs if you don't have this.
140 */
62e877b8 141#define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
6992f533 142
3493f69f
OS
143/* macros to create static binary attributes easier */
144#define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
145 .attr = { .name = __stringify(_name), .mode = _mode }, \
146 .read = _read, \
147 .write = _write, \
148 .size = _size, \
149}
150
151#define __BIN_ATTR_RO(_name, _size) { \
152 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
153 .read = _name##_read, \
154 .size = _size, \
e4b63603
GKH
155}
156
3493f69f
OS
157#define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
158 (S_IWUSR | S_IRUGO), _name##_read, \
68531526 159 _name##_write, _size)
3493f69f
OS
160
161#define __BIN_ATTR_NULL __ATTR_NULL
162
163#define BIN_ATTR(_name, _mode, _read, _write, _size) \
164struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
165 _write, _size)
166
167#define BIN_ATTR_RO(_name, _size) \
168struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
169
170#define BIN_ATTR_RW(_name, _size) \
171struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
172
1da177e4 173struct sysfs_ops {
5da5c9c8
GKH
174 ssize_t (*show)(struct kobject *, struct attribute *, char *);
175 ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
487505c2 176 const void *(*namespace)(struct kobject *, const struct attribute *);
1da177e4
LT
177};
178
f1282c84
NB
179struct sysfs_dirent;
180
1da177e4
LT
181#ifdef CONFIG_SYSFS
182
59f69015
TH
183int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
184 void *data, struct module *owner);
1da177e4 185
59f69015
TH
186int __must_check sysfs_create_dir(struct kobject *kobj);
187void sysfs_remove_dir(struct kobject *kobj);
188int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
189int __must_check sysfs_move_dir(struct kobject *kobj,
190 struct kobject *new_parent_kobj);
31e5abe9 191
59f69015
TH
192int __must_check sysfs_create_file(struct kobject *kobj,
193 const struct attribute *attr);
1c205ae1
AK
194int __must_check sysfs_create_files(struct kobject *kobj,
195 const struct attribute **attr);
49c19400 196int __must_check sysfs_chmod_file(struct kobject *kobj,
48176a97 197 const struct attribute *attr, umode_t mode);
59f69015 198void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
1c205ae1 199void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
1da177e4 200
4a7fb636 201int __must_check sysfs_create_bin_file(struct kobject *kobj,
66ecb92b
PC
202 const struct bin_attribute *attr);
203void sysfs_remove_bin_file(struct kobject *kobj,
204 const struct bin_attribute *attr);
1da177e4 205
59f69015
TH
206int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
207 const char *name);
36ce6dad
CH
208int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
209 struct kobject *target,
210 const char *name);
59f69015
TH
211void sysfs_remove_link(struct kobject *kobj, const char *name);
212
7cb32942
EB
213int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
214 const char *old_name, const char *new_name);
215
746edb7a
EB
216void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
217 const char *name);
218
59f69015
TH
219int __must_check sysfs_create_group(struct kobject *kobj,
220 const struct attribute_group *grp);
3e9b2bae
GKH
221int __must_check sysfs_create_groups(struct kobject *kobj,
222 const struct attribute_group **groups);
0f423895
JB
223int sysfs_update_group(struct kobject *kobj,
224 const struct attribute_group *grp);
59f69015
TH
225void sysfs_remove_group(struct kobject *kobj,
226 const struct attribute_group *grp);
3e9b2bae
GKH
227void sysfs_remove_groups(struct kobject *kobj,
228 const struct attribute_group **groups);
dfa87c82 229int sysfs_add_file_to_group(struct kobject *kobj,
59f69015 230 const struct attribute *attr, const char *group);
dfa87c82 231void sysfs_remove_file_from_group(struct kobject *kobj,
59f69015 232 const struct attribute *attr, const char *group);
69d44ffb
AS
233int sysfs_merge_group(struct kobject *kobj,
234 const struct attribute_group *grp);
235void sysfs_unmerge_group(struct kobject *kobj,
236 const struct attribute_group *grp);
0bb8f3d6
RW
237int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
238 struct kobject *target, const char *link_name);
239void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
240 const char *link_name);
dfa87c82 241
8c0e3998 242void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
f1282c84
NB
243void sysfs_notify_dirent(struct sysfs_dirent *sd);
244struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 245 const void *ns,
f1282c84
NB
246 const unsigned char *name);
247struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
248void sysfs_put(struct sysfs_dirent *sd);
3ff195b0 249
f1282c84 250int __must_check sysfs_init(void);
f20a9ead 251
1da177e4
LT
252#else /* CONFIG_SYSFS */
253
d9a9cdfb 254static inline int sysfs_schedule_callback(struct kobject *kobj,
523ded71 255 void (*func)(void *), void *data, struct module *owner)
d9a9cdfb
AS
256{
257 return -ENOSYS;
258}
259
59f69015 260static inline int sysfs_create_dir(struct kobject *kobj)
1da177e4
LT
261{
262 return 0;
263}
264
59f69015 265static inline void sysfs_remove_dir(struct kobject *kobj)
1da177e4 266{
1da177e4
LT
267}
268
59f69015 269static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
1da177e4 270{
0b4a4fea 271 return 0;
1da177e4
LT
272}
273
59f69015
TH
274static inline int sysfs_move_dir(struct kobject *kobj,
275 struct kobject *new_parent_kobj)
8a82472f
CH
276{
277 return 0;
278}
279
59f69015
TH
280static inline int sysfs_create_file(struct kobject *kobj,
281 const struct attribute *attr)
1da177e4
LT
282{
283 return 0;
284}
285
1c205ae1
AK
286static inline int sysfs_create_files(struct kobject *kobj,
287 const struct attribute **attr)
288{
289 return 0;
290}
291
59f69015 292static inline int sysfs_chmod_file(struct kobject *kobj,
48176a97 293 const struct attribute *attr, umode_t mode)
31e5abe9
KS
294{
295 return 0;
296}
1da177e4 297
59f69015
TH
298static inline void sysfs_remove_file(struct kobject *kobj,
299 const struct attribute *attr)
1da177e4 300{
1da177e4
LT
301}
302
1c205ae1
AK
303static inline void sysfs_remove_files(struct kobject *kobj,
304 const struct attribute **attr)
305{
306}
307
59f69015 308static inline int sysfs_create_bin_file(struct kobject *kobj,
66ecb92b 309 const struct bin_attribute *attr)
1da177e4
LT
310{
311 return 0;
312}
313
3612e06b 314static inline void sysfs_remove_bin_file(struct kobject *kobj,
66ecb92b 315 const struct bin_attribute *attr)
1da177e4 316{
1da177e4
LT
317}
318
59f69015
TH
319static inline int sysfs_create_link(struct kobject *kobj,
320 struct kobject *target, const char *name)
1da177e4
LT
321{
322 return 0;
323}
324
36ce6dad
CH
325static inline int sysfs_create_link_nowarn(struct kobject *kobj,
326 struct kobject *target,
327 const char *name)
328{
329 return 0;
330}
331
59f69015 332static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
1da177e4 333{
1da177e4
LT
334}
335
7cb32942
EB
336static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
337 const char *old_name, const char *new_name)
338{
339 return 0;
340}
341
746edb7a
EB
342static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
343 const char *name)
344{
345}
346
59f69015
TH
347static inline int sysfs_create_group(struct kobject *kobj,
348 const struct attribute_group *grp)
1da177e4
LT
349{
350 return 0;
351}
352
f7998780
GKH
353static inline int sysfs_create_groups(struct kobject *kobj,
354 const struct attribute_group **groups)
355{
574979c6 356 return 0;
f7998780
GKH
357}
358
1cbfb7a5
RD
359static inline int sysfs_update_group(struct kobject *kobj,
360 const struct attribute_group *grp)
361{
362 return 0;
363}
364
59f69015
TH
365static inline void sysfs_remove_group(struct kobject *kobj,
366 const struct attribute_group *grp)
1da177e4 367{
1da177e4
LT
368}
369
f7998780
GKH
370static inline void sysfs_remove_groups(struct kobject *kobj,
371 const struct attribute_group **groups)
372{
373}
374
dfa87c82
AS
375static inline int sysfs_add_file_to_group(struct kobject *kobj,
376 const struct attribute *attr, const char *group)
377{
378 return 0;
379}
380
381static inline void sysfs_remove_file_from_group(struct kobject *kobj,
d701d8a3 382 const struct attribute *attr, const char *group)
dfa87c82 383{
dfa87c82
AS
384}
385
69d44ffb
AS
386static inline int sysfs_merge_group(struct kobject *kobj,
387 const struct attribute_group *grp)
388{
389 return 0;
390}
391
392static inline void sysfs_unmerge_group(struct kobject *kobj,
393 const struct attribute_group *grp)
394{
395}
396
0bb8f3d6
RW
397static inline int sysfs_add_link_to_group(struct kobject *kobj,
398 const char *group_name, struct kobject *target,
399 const char *link_name)
400{
401 return 0;
402}
403
404static inline void sysfs_remove_link_from_group(struct kobject *kobj,
405 const char *group_name, const char *link_name)
406{
407}
408
8c0e3998
TP
409static inline void sysfs_notify(struct kobject *kobj, const char *dir,
410 const char *attr)
4508a7a7
N
411{
412}
f1282c84
NB
413static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
414{
415}
416static inline
417struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 418 const void *ns,
f1282c84
NB
419 const unsigned char *name)
420{
421 return NULL;
422}
423static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
424{
425 return NULL;
426}
427static inline void sysfs_put(struct sysfs_dirent *sd)
428{
429}
4508a7a7 430
f20a9ead
AM
431static inline int __must_check sysfs_init(void)
432{
433 return 0;
434}
435
1da177e4
LT
436#endif /* CONFIG_SYSFS */
437
438#endif /* _SYSFS_H_ */