2 * sysfs.h - definitions for the device driver filesystem
4 * Copyright (c) 2001,2002 Patrick Mochel
5 * Copyright (c) 2004 Silicon Graphics, Inc.
6 * Copyright (c) 2007 SUSE Linux Products GmbH
7 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
9 * Please see Documentation/filesystems/sysfs.txt for more information.
15 #include <linux/kernfs.h>
16 #include <linux/compiler.h>
17 #include <linux/errno.h>
18 #include <linux/list.h>
19 #include <linux/lockdep.h>
20 #include <linux/kobject_ns.h>
21 #include <linux/stat.h>
22 #include <linux/atomic.h>
32 #ifdef CONFIG_DEBUG_LOCK_ALLOC
33 bool ignore_lockdep:1;
34 struct lock_class_key *key;
35 struct lock_class_key skey;
40 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
41 * @attr: struct attribute to initialize
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.
49 #ifdef CONFIG_DEBUG_LOCK_ALLOC
50 #define sysfs_attr_init(attr) \
52 static struct lock_class_key __key; \
54 (attr)->key = &__key; \
57 #define sysfs_attr_init(attr) do {} while (0)
60 struct attribute_group {
62 umode_t (*is_visible)(struct kobject *,
63 struct attribute *, int);
64 struct attribute **attrs;
65 struct bin_attribute **bin_attrs;
69 * Use these macros to make defining attributes easier. See include/linux/device.h
73 #define __ATTR(_name, _mode, _show, _store) { \
74 .attr = {.name = __stringify(_name), .mode = _mode }, \
79 #define __ATTR_RO(_name) { \
80 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
81 .show = _name##_show, \
84 #define __ATTR_WO(_name) { \
85 .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \
86 .store = _name##_store, \
89 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
90 _name##_show, _name##_store)
92 #define __ATTR_NULL { .attr = { .name = NULL } }
94 #ifdef CONFIG_DEBUG_LOCK_ALLOC
95 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
96 .attr = {.name = __stringify(_name), .mode = _mode, \
97 .ignore_lockdep = true }, \
102 #define __ATTR_IGNORE_LOCKDEP __ATTR
105 #define __ATTRIBUTE_GROUPS(_name) \
106 static const struct attribute_group *_name##_groups[] = { \
111 #define ATTRIBUTE_GROUPS(_name) \
112 static const struct attribute_group _name##_group = { \
113 .attrs = _name##_attrs, \
115 __ATTRIBUTE_GROUPS(_name)
118 struct vm_area_struct;
120 struct bin_attribute {
121 struct attribute attr;
124 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
125 char *, loff_t, size_t);
126 ssize_t (*write)(struct file *, struct kobject *, struct bin_attribute *,
127 char *, loff_t, size_t);
128 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
129 struct vm_area_struct *vma);
133 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
134 * @attr: struct bin_attribute to initialize
136 * Initialize a dynamically allocated struct bin_attribute so we
137 * can make lockdep happy. This is a new requirement for
138 * attributes and initially this is only needed when lockdep is
139 * enabled. Lockdep gives a nice error when your attribute is
140 * added to sysfs if you don't have this.
142 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
144 /* macros to create static binary attributes easier */
145 #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
146 .attr = { .name = __stringify(_name), .mode = _mode }, \
152 #define __BIN_ATTR_RO(_name, _size) { \
153 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
154 .read = _name##_read, \
158 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
159 (S_IWUSR | S_IRUGO), _name##_read, \
160 _name##_write, _size)
162 #define __BIN_ATTR_NULL __ATTR_NULL
164 #define BIN_ATTR(_name, _mode, _read, _write, _size) \
165 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
168 #define BIN_ATTR_RO(_name, _size) \
169 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
171 #define BIN_ATTR_RW(_name, _size) \
172 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
175 ssize_t (*show)(struct kobject *, struct attribute *, char *);
176 ssize_t (*store)(struct kobject *, struct attribute *, const char *, size_t);
181 int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
182 void *data, struct module *owner);
184 int __must_check sysfs_create_dir_ns(struct kobject *kobj, const void *ns);
185 void sysfs_remove_dir(struct kobject *kobj);
186 int __must_check sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
188 int __must_check sysfs_move_dir_ns(struct kobject *kobj,
189 struct kobject *new_parent_kobj,
192 int __must_check sysfs_create_file_ns(struct kobject *kobj,
193 const struct attribute *attr,
195 int __must_check sysfs_create_files(struct kobject *kobj,
196 const struct attribute **attr);
197 int __must_check sysfs_chmod_file(struct kobject *kobj,
198 const struct attribute *attr, umode_t mode);
199 void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr,
201 bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr);
202 void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
204 int __must_check sysfs_create_bin_file(struct kobject *kobj,
205 const struct bin_attribute *attr);
206 void sysfs_remove_bin_file(struct kobject *kobj,
207 const struct bin_attribute *attr);
209 int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
211 int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
212 struct kobject *target,
214 void sysfs_remove_link(struct kobject *kobj, const char *name);
216 int sysfs_rename_link_ns(struct kobject *kobj, struct kobject *target,
217 const char *old_name, const char *new_name,
220 void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
223 int __must_check sysfs_create_group(struct kobject *kobj,
224 const struct attribute_group *grp);
225 int __must_check sysfs_create_groups(struct kobject *kobj,
226 const struct attribute_group **groups);
227 int sysfs_update_group(struct kobject *kobj,
228 const struct attribute_group *grp);
229 void sysfs_remove_group(struct kobject *kobj,
230 const struct attribute_group *grp);
231 void sysfs_remove_groups(struct kobject *kobj,
232 const struct attribute_group **groups);
233 int sysfs_add_file_to_group(struct kobject *kobj,
234 const struct attribute *attr, const char *group);
235 void sysfs_remove_file_from_group(struct kobject *kobj,
236 const struct attribute *attr, const char *group);
237 int sysfs_merge_group(struct kobject *kobj,
238 const struct attribute_group *grp);
239 void sysfs_unmerge_group(struct kobject *kobj,
240 const struct attribute_group *grp);
241 int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
242 struct kobject *target, const char *link_name);
243 void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
244 const char *link_name);
246 void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
248 int __must_check sysfs_init(void);
250 static inline void sysfs_enable_ns(struct kernfs_node *kn)
252 return kernfs_enable_ns(kn);
255 #else /* CONFIG_SYSFS */
257 static inline int sysfs_schedule_callback(struct kobject *kobj,
258 void (*func)(void *), void *data, struct module *owner)
263 static inline int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
268 static inline void sysfs_remove_dir(struct kobject *kobj)
272 static inline int sysfs_rename_dir_ns(struct kobject *kobj,
273 const char *new_name, const void *new_ns)
278 static inline int sysfs_move_dir_ns(struct kobject *kobj,
279 struct kobject *new_parent_kobj,
285 static inline int sysfs_create_file_ns(struct kobject *kobj,
286 const struct attribute *attr,
292 static inline int sysfs_create_files(struct kobject *kobj,
293 const struct attribute **attr)
298 static inline int sysfs_chmod_file(struct kobject *kobj,
299 const struct attribute *attr, umode_t mode)
304 static inline void sysfs_remove_file_ns(struct kobject *kobj,
305 const struct attribute *attr,
310 static inline bool sysfs_remove_file_self(struct kobject *kobj,
311 const struct attribute *attr)
316 static inline void sysfs_remove_files(struct kobject *kobj,
317 const struct attribute **attr)
321 static inline int sysfs_create_bin_file(struct kobject *kobj,
322 const struct bin_attribute *attr)
327 static inline void sysfs_remove_bin_file(struct kobject *kobj,
328 const struct bin_attribute *attr)
332 static inline int sysfs_create_link(struct kobject *kobj,
333 struct kobject *target, const char *name)
338 static inline int sysfs_create_link_nowarn(struct kobject *kobj,
339 struct kobject *target,
345 static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
349 static inline int sysfs_rename_link_ns(struct kobject *k, struct kobject *t,
350 const char *old_name,
351 const char *new_name, const void *ns)
356 static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
361 static inline int sysfs_create_group(struct kobject *kobj,
362 const struct attribute_group *grp)
367 static inline int sysfs_create_groups(struct kobject *kobj,
368 const struct attribute_group **groups)
373 static inline int sysfs_update_group(struct kobject *kobj,
374 const struct attribute_group *grp)
379 static inline void sysfs_remove_group(struct kobject *kobj,
380 const struct attribute_group *grp)
384 static inline void sysfs_remove_groups(struct kobject *kobj,
385 const struct attribute_group **groups)
389 static inline int sysfs_add_file_to_group(struct kobject *kobj,
390 const struct attribute *attr, const char *group)
395 static inline void sysfs_remove_file_from_group(struct kobject *kobj,
396 const struct attribute *attr, const char *group)
400 static inline int sysfs_merge_group(struct kobject *kobj,
401 const struct attribute_group *grp)
406 static inline void sysfs_unmerge_group(struct kobject *kobj,
407 const struct attribute_group *grp)
411 static inline int sysfs_add_link_to_group(struct kobject *kobj,
412 const char *group_name, struct kobject *target,
413 const char *link_name)
418 static inline void sysfs_remove_link_from_group(struct kobject *kobj,
419 const char *group_name, const char *link_name)
423 static inline void sysfs_notify(struct kobject *kobj, const char *dir,
428 static inline int __must_check sysfs_init(void)
433 static inline void sysfs_enable_ns(struct kernfs_node *kn)
437 #endif /* CONFIG_SYSFS */
439 static inline int __must_check sysfs_create_file(struct kobject *kobj,
440 const struct attribute *attr)
442 return sysfs_create_file_ns(kobj, attr, NULL);
445 static inline void sysfs_remove_file(struct kobject *kobj,
446 const struct attribute *attr)
448 return sysfs_remove_file_ns(kobj, attr, NULL);
451 static inline int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
452 const char *old_name, const char *new_name)
454 return sysfs_rename_link_ns(kobj, target, old_name, new_name, NULL);
457 static inline void sysfs_notify_dirent(struct kernfs_node *kn)
462 static inline struct kernfs_node *sysfs_get_dirent(struct kernfs_node *parent,
463 const unsigned char *name)
465 return kernfs_find_and_get(parent, name);
468 static inline struct kernfs_node *sysfs_get(struct kernfs_node *kn)
474 static inline void sysfs_put(struct kernfs_node *kn)
479 #endif /* _SYSFS_H_ */