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