Commit | Line | Data |
---|---|---|
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 | ||
b8441ed2 | 15 | #include <linux/kernfs.h> |
4a7fb636 | 16 | #include <linux/compiler.h> |
5851fadc | 17 | #include <linux/errno.h> |
bf0acc33 | 18 | #include <linux/list.h> |
6992f533 | 19 | #include <linux/lockdep.h> |
8488a38f | 20 | #include <linux/kobject_ns.h> |
3493f69f | 21 | #include <linux/stat.h> |
60063497 | 22 | #include <linux/atomic.h> |
1da177e4 LT |
23 | |
24 | struct kobject; | |
25 | struct module; | |
6ab9cea1 | 26 | struct bin_attribute; |
3ff195b0 | 27 | enum kobj_ns_type; |
1da177e4 LT |
28 | |
29 | struct attribute { | |
59f69015 | 30 | const char *name; |
9104e427 | 31 | umode_t mode; |
6992f533 | 32 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
356c05d5 | 33 | bool ignore_lockdep:1; |
6992f533 EB |
34 | struct lock_class_key *key; |
35 | struct lock_class_key skey; | |
36 | #endif | |
1da177e4 LT |
37 | }; |
38 | ||
35960258 EB |
39 | /** |
40 | * sysfs_attr_init - initialize a dynamically allocated sysfs attribute | |
41 | * @attr: struct attribute to initialize | |
42 | * | |
43 | * Initialize a dynamically allocated struct attribute so we can | |
44 | * make lockdep happy. This is a new requirement for attributes | |
45 | * and initially this is only needed when lockdep is enabled. | |
46 | * Lockdep gives a nice error when your attribute is added to | |
47 | * sysfs if you don't have this. | |
48 | */ | |
6992f533 EB |
49 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
50 | #define sysfs_attr_init(attr) \ | |
51 | do { \ | |
52 | static struct lock_class_key __key; \ | |
53 | \ | |
54 | (attr)->key = &__key; \ | |
5da5c9c8 | 55 | } while (0) |
6992f533 | 56 | #else |
5da5c9c8 | 57 | #define sysfs_attr_init(attr) do {} while (0) |
6992f533 EB |
58 | #endif |
59 | ||
ba61af6f GR |
60 | /** |
61 | * struct attribute_group - data structure used to declare an attribute group. | |
62 | * @name: Optional: Attribute group name | |
63 | * If specified, the attribute group will be created in | |
64 | * a new subdirectory with this name. | |
65 | * @is_visible: Optional: Function to return permissions associated with an | |
66 | * attribute of the group. Will be called repeatedly for each | |
67 | * attribute in the group. Only read/write permissions as well as | |
68 | * SYSFS_PREALLOC are accepted. Must return 0 if an attribute is | |
69 | * not visible. The returned value will replace static permissions | |
70 | * defined in struct attribute or struct bin_attribute. | |
71 | * @attrs: Pointer to NULL terminated list of attributes. | |
72 | * @bin_attrs: Pointer to NULL terminated list of binary attributes. | |
73 | * Either attrs or bin_attrs or both must be provided. | |
74 | */ | |
1da177e4 | 75 | struct attribute_group { |
59f69015 | 76 | const char *name; |
587a1f16 | 77 | umode_t (*is_visible)(struct kobject *, |
d4acd722 | 78 | struct attribute *, int); |
59f69015 | 79 | struct attribute **attrs; |
6ab9cea1 | 80 | struct bin_attribute **bin_attrs; |
1da177e4 LT |
81 | }; |
82 | ||
1da177e4 LT |
83 | /** |
84 | * Use these macros to make defining attributes easier. See include/linux/device.h | |
85 | * for examples.. | |
86 | */ | |
87 | ||
2b75869b N |
88 | #define SYSFS_PREALLOC 010000 |
89 | ||
5da5c9c8 | 90 | #define __ATTR(_name, _mode, _show, _store) { \ |
58f86cc8 RR |
91 | .attr = {.name = __stringify(_name), \ |
92 | .mode = VERIFY_OCTAL_PERMISSIONS(_mode) }, \ | |
aa01aa3c OS |
93 | .show = _show, \ |
94 | .store = _store, \ | |
1da177e4 LT |
95 | } |
96 | ||
2b75869b N |
97 | #define __ATTR_PREALLOC(_name, _mode, _show, _store) { \ |
98 | .attr = {.name = __stringify(_name), \ | |
99 | .mode = SYSFS_PREALLOC | VERIFY_OCTAL_PERMISSIONS(_mode) },\ | |
100 | .show = _show, \ | |
101 | .store = _store, \ | |
102 | } | |
103 | ||
aa01aa3c OS |
104 | #define __ATTR_RO(_name) { \ |
105 | .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \ | |
106 | .show = _name##_show, \ | |
1da177e4 LT |
107 | } |
108 | ||
a65fcce7 GKH |
109 | #define __ATTR_WO(_name) { \ |
110 | .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \ | |
111 | .store = _name##_store, \ | |
112 | } | |
113 | ||
aa01aa3c OS |
114 | #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \ |
115 | _name##_show, _name##_store) | |
b9b32597 | 116 | |
1da177e4 | 117 | #define __ATTR_NULL { .attr = { .name = NULL } } |
356c05d5 AS |
118 | |
119 | #ifdef CONFIG_DEBUG_LOCK_ALLOC | |
120 | #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \ | |
121 | .attr = {.name = __stringify(_name), .mode = _mode, \ | |
122 | .ignore_lockdep = true }, \ | |
123 | .show = _show, \ | |
124 | .store = _store, \ | |
125 | } | |
126 | #else | |
127 | #define __ATTR_IGNORE_LOCKDEP __ATTR | |
128 | #endif | |
1da177e4 | 129 | |
3493f69f OS |
130 | #define __ATTRIBUTE_GROUPS(_name) \ |
131 | static const struct attribute_group *_name##_groups[] = { \ | |
132 | &_name##_group, \ | |
f2f37f58 GKH |
133 | NULL, \ |
134 | } | |
135 | ||
3493f69f OS |
136 | #define ATTRIBUTE_GROUPS(_name) \ |
137 | static const struct attribute_group _name##_group = { \ | |
138 | .attrs = _name##_attrs, \ | |
139 | }; \ | |
140 | __ATTRIBUTE_GROUPS(_name) | |
141 | ||
2c3c8bea | 142 | struct file; |
1da177e4 LT |
143 | struct vm_area_struct; |
144 | ||
145 | struct bin_attribute { | |
146 | struct attribute attr; | |
147 | size_t size; | |
148 | void *private; | |
2c3c8bea | 149 | ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *, |
91a69029 | 150 | char *, loff_t, size_t); |
5da5c9c8 | 151 | ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *, |
91a69029 | 152 | char *, loff_t, size_t); |
2c3c8bea | 153 | int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr, |
1da177e4 LT |
154 | struct vm_area_struct *vma); |
155 | }; | |
156 | ||
35960258 EB |
157 | /** |
158 | * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute | |
159 | * @attr: struct bin_attribute to initialize | |
160 | * | |
161 | * Initialize a dynamically allocated struct bin_attribute so we | |
162 | * can make lockdep happy. This is a new requirement for | |
163 | * attributes and initially this is only needed when lockdep is | |
164 | * enabled. Lockdep gives a nice error when your attribute is | |
165 | * added to sysfs if you don't have this. | |
166 | */ | |
62e877b8 | 167 | #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr) |
6992f533 | 168 | |
3493f69f OS |
169 | /* macros to create static binary attributes easier */ |
170 | #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \ | |
171 | .attr = { .name = __stringify(_name), .mode = _mode }, \ | |
172 | .read = _read, \ | |
173 | .write = _write, \ | |
174 | .size = _size, \ | |
175 | } | |
176 | ||
177 | #define __BIN_ATTR_RO(_name, _size) { \ | |
178 | .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \ | |
179 | .read = _name##_read, \ | |
180 | .size = _size, \ | |
e4b63603 GKH |
181 | } |
182 | ||
3493f69f OS |
183 | #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \ |
184 | (S_IWUSR | S_IRUGO), _name##_read, \ | |
68531526 | 185 | _name##_write, _size) |
3493f69f OS |
186 | |
187 | #define __BIN_ATTR_NULL __ATTR_NULL | |
188 | ||
189 | #define BIN_ATTR(_name, _mode, _read, _write, _size) \ | |
190 | struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \ | |
191 | _write, _size) | |
192 | ||
193 | #define BIN_ATTR_RO(_name, _size) \ | |
194 | struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size) | |
195 | ||
196 | #define BIN_ATTR_RW(_name, _size) \ | |
197 | struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size) | |
198 | ||
1da177e4 | 199 | struct sysfs_ops { |
5da5c9c8 GKH |
200 | ssize_t (*show)(struct kobject *, struct attribute *, char *); |
201 | ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t); | |
1da177e4 LT |
202 | }; |
203 | ||
1da177e4 LT |
204 | #ifdef CONFIG_SYSFS |
205 | ||
e34ff490 | 206 | int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns); |
59f69015 | 207 | void sysfs_remove_dir(struct kobject *kobj); |
e34ff490 TH |
208 | int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name, |
209 | const void *new_ns); | |
210 | int __must_check sysfs_move_dir_ns(struct kobject *kobj, | |
211 | struct kobject *new_parent_kobj, | |
212 | const void *new_ns); | |
31e5abe9 | 213 | |
58292cbe TH |
214 | int __must_check sysfs_create_file_ns(struct kobject *kobj, |
215 | const struct attribute *attr, | |
216 | const void *ns); | |
1c205ae1 AK |
217 | int __must_check sysfs_create_files(struct kobject *kobj, |
218 | const struct attribute **attr); | |
49c19400 | 219 | int __must_check sysfs_chmod_file(struct kobject *kobj, |
48176a97 | 220 | const struct attribute *attr, umode_t mode); |
58292cbe TH |
221 | void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr, |
222 | const void *ns); | |
6b0afc2a | 223 | bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr); |
1c205ae1 | 224 | void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr); |
1da177e4 | 225 | |
4a7fb636 | 226 | int __must_check sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b PC |
227 | const struct bin_attribute *attr); |
228 | void sysfs_remove_bin_file(struct kobject *kobj, | |
229 | const struct bin_attribute *attr); | |
1da177e4 | 230 | |
59f69015 TH |
231 | int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target, |
232 | const char *name); | |
36ce6dad CH |
233 | int __must_check sysfs_create_link_nowarn(struct kobject *kobj, |
234 | struct kobject *target, | |
235 | const char *name); | |
59f69015 TH |
236 | void sysfs_remove_link(struct kobject *kobj, const char *name); |
237 | ||
4b30ee58 TH |
238 | int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target, |
239 | const char *old_name, const char *new_name, | |
240 | const void *new_ns); | |
7cb32942 | 241 | |
746edb7a EB |
242 | void sysfs_delete_link(struct kobject *dir, struct kobject *targ, |
243 | const char *name); | |
244 | ||
59f69015 TH |
245 | int __must_check sysfs_create_group(struct kobject *kobj, |
246 | const struct attribute_group *grp); | |
3e9b2bae GKH |
247 | int __must_check sysfs_create_groups(struct kobject *kobj, |
248 | const struct attribute_group **groups); | |
0f423895 JB |
249 | int sysfs_update_group(struct kobject *kobj, |
250 | const struct attribute_group *grp); | |
59f69015 TH |
251 | void sysfs_remove_group(struct kobject *kobj, |
252 | const struct attribute_group *grp); | |
3e9b2bae GKH |
253 | void sysfs_remove_groups(struct kobject *kobj, |
254 | const struct attribute_group **groups); | |
dfa87c82 | 255 | int sysfs_add_file_to_group(struct kobject *kobj, |
59f69015 | 256 | const struct attribute *attr, const char *group); |
dfa87c82 | 257 | void sysfs_remove_file_from_group(struct kobject *kobj, |
59f69015 | 258 | const struct attribute *attr, const char *group); |
69d44ffb AS |
259 | int sysfs_merge_group(struct kobject *kobj, |
260 | const struct attribute_group *grp); | |
261 | void sysfs_unmerge_group(struct kobject *kobj, | |
262 | const struct attribute_group *grp); | |
0bb8f3d6 RW |
263 | int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name, |
264 | struct kobject *target, const char *link_name); | |
265 | void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name, | |
266 | const char *link_name); | |
dfa87c82 | 267 | |
8c0e3998 | 268 | void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr); |
3ff195b0 | 269 | |
f1282c84 | 270 | int __must_check sysfs_init(void); |
f20a9ead | 271 | |
fa4cd451 TH |
272 | static inline void sysfs_enable_ns(struct kernfs_node *kn) |
273 | { | |
274 | return kernfs_enable_ns(kn); | |
275 | } | |
276 | ||
1da177e4 LT |
277 | #else /* CONFIG_SYSFS */ |
278 | ||
e34ff490 | 279 | static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns) |
1da177e4 LT |
280 | { |
281 | return 0; | |
282 | } | |
283 | ||
59f69015 | 284 | static inline void sysfs_remove_dir(struct kobject *kobj) |
1da177e4 | 285 | { |
1da177e4 LT |
286 | } |
287 | ||
e34ff490 TH |
288 | static inline int sysfs_rename_dir_ns(struct kobject *kobj, |
289 | const char *new_name, const void *new_ns) | |
1da177e4 | 290 | { |
0b4a4fea | 291 | return 0; |
1da177e4 LT |
292 | } |
293 | ||
e34ff490 TH |
294 | static inline int sysfs_move_dir_ns(struct kobject *kobj, |
295 | struct kobject *new_parent_kobj, | |
296 | const void *new_ns) | |
8a82472f CH |
297 | { |
298 | return 0; | |
299 | } | |
300 | ||
58292cbe TH |
301 | static inline int sysfs_create_file_ns(struct kobject *kobj, |
302 | const struct attribute *attr, | |
303 | const void *ns) | |
1da177e4 LT |
304 | { |
305 | return 0; | |
306 | } | |
307 | ||
1c205ae1 AK |
308 | static inline int sysfs_create_files(struct kobject *kobj, |
309 | const struct attribute **attr) | |
310 | { | |
311 | return 0; | |
312 | } | |
313 | ||
59f69015 | 314 | static inline int sysfs_chmod_file(struct kobject *kobj, |
48176a97 | 315 | const struct attribute *attr, umode_t mode) |
31e5abe9 KS |
316 | { |
317 | return 0; | |
318 | } | |
1da177e4 | 319 | |
58292cbe TH |
320 | static inline void sysfs_remove_file_ns(struct kobject *kobj, |
321 | const struct attribute *attr, | |
322 | const void *ns) | |
1da177e4 | 323 | { |
1da177e4 LT |
324 | } |
325 | ||
6b0afc2a TH |
326 | static inline bool sysfs_remove_file_self(struct kobject *kobj, |
327 | const struct attribute *attr) | |
328 | { | |
329 | return false; | |
330 | } | |
331 | ||
1c205ae1 AK |
332 | static inline void sysfs_remove_files(struct kobject *kobj, |
333 | const struct attribute **attr) | |
334 | { | |
335 | } | |
336 | ||
59f69015 | 337 | static inline int sysfs_create_bin_file(struct kobject *kobj, |
66ecb92b | 338 | const struct bin_attribute *attr) |
1da177e4 LT |
339 | { |
340 | return 0; | |
341 | } | |
342 | ||
3612e06b | 343 | static inline void sysfs_remove_bin_file(struct kobject *kobj, |
66ecb92b | 344 | const struct bin_attribute *attr) |
1da177e4 | 345 | { |
1da177e4 LT |
346 | } |
347 | ||
59f69015 TH |
348 | static inline int sysfs_create_link(struct kobject *kobj, |
349 | struct kobject *target, const char *name) | |
1da177e4 LT |
350 | { |
351 | return 0; | |
352 | } | |
353 | ||
36ce6dad CH |
354 | static inline int sysfs_create_link_nowarn(struct kobject *kobj, |
355 | struct kobject *target, | |
356 | const char *name) | |
357 | { | |
358 | return 0; | |
359 | } | |
360 | ||
59f69015 | 361 | static inline void sysfs_remove_link(struct kobject *kobj, const char *name) |
1da177e4 | 362 | { |
1da177e4 LT |
363 | } |
364 | ||
4b30ee58 TH |
365 | static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t, |
366 | const char *old_name, | |
367 | const char *new_name, const void *ns) | |
7cb32942 EB |
368 | { |
369 | return 0; | |
370 | } | |
371 | ||
746edb7a EB |
372 | static inline void sysfs_delete_link(struct kobject *k, struct kobject *t, |
373 | const char *name) | |
374 | { | |
375 | } | |
376 | ||
59f69015 TH |
377 | static inline int sysfs_create_group(struct kobject *kobj, |
378 | const struct attribute_group *grp) | |
1da177e4 LT |
379 | { |
380 | return 0; | |
381 | } | |
382 | ||
f7998780 GKH |
383 | static inline int sysfs_create_groups(struct kobject *kobj, |
384 | const struct attribute_group **groups) | |
385 | { | |
574979c6 | 386 | return 0; |
f7998780 GKH |
387 | } |
388 | ||
1cbfb7a5 RD |
389 | static inline int sysfs_update_group(struct kobject *kobj, |
390 | const struct attribute_group *grp) | |
391 | { | |
392 | return 0; | |
393 | } | |
394 | ||
59f69015 TH |
395 | static inline void sysfs_remove_group(struct kobject *kobj, |
396 | const struct attribute_group *grp) | |
1da177e4 | 397 | { |
1da177e4 LT |
398 | } |
399 | ||
f7998780 GKH |
400 | static inline void sysfs_remove_groups(struct kobject *kobj, |
401 | const struct attribute_group **groups) | |
402 | { | |
403 | } | |
404 | ||
dfa87c82 AS |
405 | static inline int sysfs_add_file_to_group(struct kobject *kobj, |
406 | const struct attribute *attr, const char *group) | |
407 | { | |
408 | return 0; | |
409 | } | |
410 | ||
411 | static inline void sysfs_remove_file_from_group(struct kobject *kobj, | |
d701d8a3 | 412 | const struct attribute *attr, const char *group) |
dfa87c82 | 413 | { |
dfa87c82 AS |
414 | } |
415 | ||
69d44ffb AS |
416 | static inline int sysfs_merge_group(struct kobject *kobj, |
417 | const struct attribute_group *grp) | |
418 | { | |
419 | return 0; | |
420 | } | |
421 | ||
422 | static inline void sysfs_unmerge_group(struct kobject *kobj, | |
423 | const struct attribute_group *grp) | |
424 | { | |
425 | } | |
426 | ||
0bb8f3d6 RW |
427 | static inline int sysfs_add_link_to_group(struct kobject *kobj, |
428 | const char *group_name, struct kobject *target, | |
429 | const char *link_name) | |
430 | { | |
431 | return 0; | |
432 | } | |
433 | ||
434 | static inline void sysfs_remove_link_from_group(struct kobject *kobj, | |
435 | const char *group_name, const char *link_name) | |
436 | { | |
437 | } | |
438 | ||
8c0e3998 TP |
439 | static inline void sysfs_notify(struct kobject *kobj, const char *dir, |
440 | const char *attr) | |
4508a7a7 N |
441 | { |
442 | } | |
443 | ||
f20a9ead AM |
444 | static inline int __must_check sysfs_init(void) |
445 | { | |
446 | return 0; | |
447 | } | |
448 | ||
fa4cd451 TH |
449 | static inline void sysfs_enable_ns(struct kernfs_node *kn) |
450 | { | |
451 | } | |
452 | ||
1da177e4 LT |
453 | #endif /* CONFIG_SYSFS */ |
454 | ||
58292cbe TH |
455 | static inline int __must_check sysfs_create_file(struct kobject *kobj, |
456 | const struct attribute *attr) | |
457 | { | |
458 | return sysfs_create_file_ns(kobj, attr, NULL); | |
459 | } | |
460 | ||
461 | static inline void sysfs_remove_file(struct kobject *kobj, | |
462 | const struct attribute *attr) | |
463 | { | |
78e1da62 | 464 | sysfs_remove_file_ns(kobj, attr, NULL); |
58292cbe TH |
465 | } |
466 | ||
4b30ee58 TH |
467 | static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target, |
468 | const char *old_name, const char *new_name) | |
469 | { | |
470 | return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL); | |
471 | } | |
472 | ||
324a56e1 | 473 | static inline void sysfs_notify_dirent(struct kernfs_node *kn) |
ccf73cf3 | 474 | { |
324a56e1 | 475 | kernfs_notify(kn); |
ccf73cf3 TH |
476 | } |
477 | ||
324a56e1 TH |
478 | static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent, |
479 | const unsigned char *name) | |
388975cc | 480 | { |
324a56e1 | 481 | return kernfs_find_and_get(parent, name); |
388975cc TH |
482 | } |
483 | ||
324a56e1 | 484 | static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn) |
024f6471 | 485 | { |
324a56e1 TH |
486 | kernfs_get(kn); |
487 | return kn; | |
ccf73cf3 TH |
488 | } |
489 | ||
324a56e1 | 490 | static inline void sysfs_put(struct kernfs_node *kn) |
ccf73cf3 | 491 | { |
324a56e1 | 492 | kernfs_put(kn); |
024f6471 TH |
493 | } |
494 | ||
1da177e4 | 495 | #endif /* _SYSFS_H_ */ |