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), \
75 .mode = VERIFY_OCTAL_PERMISSIONS(_mode) }, \
80 #define __ATTR_RO(_name) { \
81 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
82 .show = _name##_show, \
85 #define __ATTR_WO(_name) { \
86 .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \
87 .store = _name##_store, \
90 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
91 _name##_show, _name##_store)
93 #define __ATTR_NULL { .attr = { .name = NULL } }
95 #ifdef CONFIG_DEBUG_LOCK_ALLOC
96 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
97 .attr = {.name = __stringify(_name), .mode = _mode, \
98 .ignore_lockdep = true }, \
103 #define __ATTR_IGNORE_LOCKDEP __ATTR
106 #define __ATTRIBUTE_GROUPS(_name) \
107 static const struct attribute_group *_name##_groups[] = { \
112 #define ATTRIBUTE_GROUPS(_name) \
113 static const struct attribute_group _name##_group = { \
114 .attrs = _name##_attrs, \
116 __ATTRIBUTE_GROUPS(_name)
119 struct vm_area_struct
;
121 struct bin_attribute
{
122 struct attribute attr
;
125 ssize_t (*read
)(struct file
*, struct kobject
*, struct bin_attribute
*,
126 char *, loff_t
, size_t);
127 ssize_t (*write
)(struct file
*, struct kobject
*, struct bin_attribute
*,
128 char *, loff_t
, size_t);
129 int (*mmap
)(struct file
*, struct kobject
*, struct bin_attribute
*attr
,
130 struct vm_area_struct
*vma
);
134 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
135 * @attr: struct bin_attribute to initialize
137 * Initialize a dynamically allocated struct bin_attribute so we
138 * can make lockdep happy. This is a new requirement for
139 * attributes and initially this is only needed when lockdep is
140 * enabled. Lockdep gives a nice error when your attribute is
141 * added to sysfs if you don't have this.
143 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
145 /* macros to create static binary attributes easier */
146 #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
147 .attr = { .name = __stringify(_name), .mode = _mode }, \
153 #define __BIN_ATTR_RO(_name, _size) { \
154 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
155 .read = _name##_read, \
159 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
160 (S_IWUSR | S_IRUGO), _name##_read, \
161 _name##_write, _size)
163 #define __BIN_ATTR_NULL __ATTR_NULL
165 #define BIN_ATTR(_name, _mode, _read, _write, _size) \
166 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
169 #define BIN_ATTR_RO(_name, _size) \
170 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
172 #define BIN_ATTR_RW(_name, _size) \
173 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
176 ssize_t (*show
)(struct kobject
*, struct attribute
*, char *);
177 ssize_t (*store
)(struct kobject
*, struct attribute
*, const char *, size_t);
182 int __must_check
sysfs_create_dir_ns(struct kobject
*kobj
, const void *ns
);
183 void sysfs_remove_dir(struct kobject
*kobj
);
184 int __must_check
sysfs_rename_dir_ns(struct kobject
*kobj
, const char *new_name
,
186 int __must_check
sysfs_move_dir_ns(struct kobject
*kobj
,
187 struct kobject
*new_parent_kobj
,
190 int __must_check
sysfs_create_file_ns(struct kobject
*kobj
,
191 const struct attribute
*attr
,
193 int __must_check
sysfs_create_files(struct kobject
*kobj
,
194 const struct attribute
**attr
);
195 int __must_check
sysfs_chmod_file(struct kobject
*kobj
,
196 const struct attribute
*attr
, umode_t mode
);
197 void sysfs_remove_file_ns(struct kobject
*kobj
, const struct attribute
*attr
,
199 bool sysfs_remove_file_self(struct kobject
*kobj
, const struct attribute
*attr
);
200 void sysfs_remove_files(struct kobject
*kobj
, const struct attribute
**attr
);
202 int __must_check
sysfs_create_bin_file(struct kobject
*kobj
,
203 const struct bin_attribute
*attr
);
204 void sysfs_remove_bin_file(struct kobject
*kobj
,
205 const struct bin_attribute
*attr
);
207 int __must_check
sysfs_create_link(struct kobject
*kobj
, struct kobject
*target
,
209 int __must_check
sysfs_create_link_nowarn(struct kobject
*kobj
,
210 struct kobject
*target
,
212 void sysfs_remove_link(struct kobject
*kobj
, const char *name
);
214 int sysfs_rename_link_ns(struct kobject
*kobj
, struct kobject
*target
,
215 const char *old_name
, const char *new_name
,
218 void sysfs_delete_link(struct kobject
*dir
, struct kobject
*targ
,
221 int __must_check
sysfs_create_group(struct kobject
*kobj
,
222 const struct attribute_group
*grp
);
223 int __must_check
sysfs_create_groups(struct kobject
*kobj
,
224 const struct attribute_group
**groups
);
225 int sysfs_update_group(struct kobject
*kobj
,
226 const struct attribute_group
*grp
);
227 void sysfs_remove_group(struct kobject
*kobj
,
228 const struct attribute_group
*grp
);
229 void sysfs_remove_groups(struct kobject
*kobj
,
230 const struct attribute_group
**groups
);
231 int sysfs_add_file_to_group(struct kobject
*kobj
,
232 const struct attribute
*attr
, const char *group
);
233 void sysfs_remove_file_from_group(struct kobject
*kobj
,
234 const struct attribute
*attr
, const char *group
);
235 int sysfs_merge_group(struct kobject
*kobj
,
236 const struct attribute_group
*grp
);
237 void sysfs_unmerge_group(struct kobject
*kobj
,
238 const struct attribute_group
*grp
);
239 int sysfs_add_link_to_group(struct kobject
*kobj
, const char *group_name
,
240 struct kobject
*target
, const char *link_name
);
241 void sysfs_remove_link_from_group(struct kobject
*kobj
, const char *group_name
,
242 const char *link_name
);
244 void sysfs_notify(struct kobject
*kobj
, const char *dir
, const char *attr
);
246 int __must_check
sysfs_init(void);
248 static inline void sysfs_enable_ns(struct kernfs_node
*kn
)
250 return kernfs_enable_ns(kn
);
253 #else /* CONFIG_SYSFS */
255 static inline int sysfs_create_dir_ns(struct kobject
*kobj
, const void *ns
)
260 static inline void sysfs_remove_dir(struct kobject
*kobj
)
264 static inline int sysfs_rename_dir_ns(struct kobject
*kobj
,
265 const char *new_name
, const void *new_ns
)
270 static inline int sysfs_move_dir_ns(struct kobject
*kobj
,
271 struct kobject
*new_parent_kobj
,
277 static inline int sysfs_create_file_ns(struct kobject
*kobj
,
278 const struct attribute
*attr
,
284 static inline int sysfs_create_files(struct kobject
*kobj
,
285 const struct attribute
**attr
)
290 static inline int sysfs_chmod_file(struct kobject
*kobj
,
291 const struct attribute
*attr
, umode_t mode
)
296 static inline void sysfs_remove_file_ns(struct kobject
*kobj
,
297 const struct attribute
*attr
,
302 static inline bool sysfs_remove_file_self(struct kobject
*kobj
,
303 const struct attribute
*attr
)
308 static inline void sysfs_remove_files(struct kobject
*kobj
,
309 const struct attribute
**attr
)
313 static inline int sysfs_create_bin_file(struct kobject
*kobj
,
314 const struct bin_attribute
*attr
)
319 static inline void sysfs_remove_bin_file(struct kobject
*kobj
,
320 const struct bin_attribute
*attr
)
324 static inline int sysfs_create_link(struct kobject
*kobj
,
325 struct kobject
*target
, const char *name
)
330 static inline int sysfs_create_link_nowarn(struct kobject
*kobj
,
331 struct kobject
*target
,
337 static inline void sysfs_remove_link(struct kobject
*kobj
, const char *name
)
341 static inline int sysfs_rename_link_ns(struct kobject
*k
, struct kobject
*t
,
342 const char *old_name
,
343 const char *new_name
, const void *ns
)
348 static inline void sysfs_delete_link(struct kobject
*k
, struct kobject
*t
,
353 static inline int sysfs_create_group(struct kobject
*kobj
,
354 const struct attribute_group
*grp
)
359 static inline int sysfs_create_groups(struct kobject
*kobj
,
360 const struct attribute_group
**groups
)
365 static inline int sysfs_update_group(struct kobject
*kobj
,
366 const struct attribute_group
*grp
)
371 static inline void sysfs_remove_group(struct kobject
*kobj
,
372 const struct attribute_group
*grp
)
376 static inline void sysfs_remove_groups(struct kobject
*kobj
,
377 const struct attribute_group
**groups
)
381 static inline int sysfs_add_file_to_group(struct kobject
*kobj
,
382 const struct attribute
*attr
, const char *group
)
387 static inline void sysfs_remove_file_from_group(struct kobject
*kobj
,
388 const struct attribute
*attr
, const char *group
)
392 static inline int sysfs_merge_group(struct kobject
*kobj
,
393 const struct attribute_group
*grp
)
398 static inline void sysfs_unmerge_group(struct kobject
*kobj
,
399 const struct attribute_group
*grp
)
403 static inline int sysfs_add_link_to_group(struct kobject
*kobj
,
404 const char *group_name
, struct kobject
*target
,
405 const char *link_name
)
410 static inline void sysfs_remove_link_from_group(struct kobject
*kobj
,
411 const char *group_name
, const char *link_name
)
415 static inline void sysfs_notify(struct kobject
*kobj
, const char *dir
,
420 static inline int __must_check
sysfs_init(void)
425 static inline void sysfs_enable_ns(struct kernfs_node
*kn
)
429 #endif /* CONFIG_SYSFS */
431 static inline int __must_check
sysfs_create_file(struct kobject
*kobj
,
432 const struct attribute
*attr
)
434 return sysfs_create_file_ns(kobj
, attr
, NULL
);
437 static inline void sysfs_remove_file(struct kobject
*kobj
,
438 const struct attribute
*attr
)
440 sysfs_remove_file_ns(kobj
, attr
, NULL
);
443 static inline int sysfs_rename_link(struct kobject
*kobj
, struct kobject
*target
,
444 const char *old_name
, const char *new_name
)
446 return sysfs_rename_link_ns(kobj
, target
, old_name
, new_name
, NULL
);
449 static inline void sysfs_notify_dirent(struct kernfs_node
*kn
)
454 static inline struct kernfs_node
*sysfs_get_dirent(struct kernfs_node
*parent
,
455 const unsigned char *name
)
457 return kernfs_find_and_get(parent
, name
);
460 static inline struct kernfs_node
*sysfs_get(struct kernfs_node
*kn
)
466 static inline void sysfs_put(struct kernfs_node
*kn
)
471 #endif /* _SYSFS_H_ */