]>
git.proxmox.com Git - mirror_ubuntu-eoan-kernel.git/blob - include/linux/sysfs.h
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)
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 * non-binary attribute in the group. Only read/write
68 * permissions as well as SYSFS_PREALLOC are accepted. Must
69 * return 0 if an attribute is not visible. The returned value
70 * will replace static permissions defined in struct attribute.
72 * Optional: Function to return permissions associated with a
73 * binary attribute of the group. Will be called repeatedly
74 * for each binary attribute in the group. Only read/write
75 * permissions as well as SYSFS_PREALLOC are accepted. Must
76 * return 0 if a binary attribute is not visible. The returned
77 * value will replace static permissions defined in
78 * struct bin_attribute.
79 * @attrs: Pointer to NULL terminated list of attributes.
80 * @bin_attrs: Pointer to NULL terminated list of binary attributes.
81 * Either attrs or bin_attrs or both must be provided.
83 struct attribute_group
{
85 umode_t (*is_visible
)(struct kobject
*,
86 struct attribute
*, int);
87 umode_t (*is_bin_visible
)(struct kobject
*,
88 struct bin_attribute
*, int);
89 struct attribute
**attrs
;
90 struct bin_attribute
**bin_attrs
;
94 * Use these macros to make defining attributes easier. See include/linux/device.h
98 #define SYSFS_PREALLOC 010000
100 #define __ATTR(_name, _mode, _show, _store) { \
101 .attr = {.name = __stringify(_name), \
102 .mode = VERIFY_OCTAL_PERMISSIONS(_mode) }, \
107 #define __ATTR_PREALLOC(_name, _mode, _show, _store) { \
108 .attr = {.name = __stringify(_name), \
109 .mode = SYSFS_PREALLOC | VERIFY_OCTAL_PERMISSIONS(_mode) },\
114 #define __ATTR_RO(_name) { \
115 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
116 .show = _name##_show, \
119 #define __ATTR_WO(_name) { \
120 .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \
121 .store = _name##_store, \
124 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
125 _name##_show, _name##_store)
127 #define __ATTR_NULL { .attr = { .name = NULL } }
129 #ifdef CONFIG_DEBUG_LOCK_ALLOC
130 #define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
131 .attr = {.name = __stringify(_name), .mode = _mode, \
132 .ignore_lockdep = true }, \
137 #define __ATTR_IGNORE_LOCKDEP __ATTR
140 #define __ATTRIBUTE_GROUPS(_name) \
141 static const struct attribute_group *_name##_groups[] = { \
146 #define ATTRIBUTE_GROUPS(_name) \
147 static const struct attribute_group _name##_group = { \
148 .attrs = _name##_attrs, \
150 __ATTRIBUTE_GROUPS(_name)
153 struct vm_area_struct
;
155 struct bin_attribute
{
156 struct attribute attr
;
159 ssize_t (*read
)(struct file
*, struct kobject
*, struct bin_attribute
*,
160 char *, loff_t
, size_t);
161 ssize_t (*write
)(struct file
*, struct kobject
*, struct bin_attribute
*,
162 char *, loff_t
, size_t);
163 int (*mmap
)(struct file
*, struct kobject
*, struct bin_attribute
*attr
,
164 struct vm_area_struct
*vma
);
168 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
169 * @attr: struct bin_attribute to initialize
171 * Initialize a dynamically allocated struct bin_attribute so we
172 * can make lockdep happy. This is a new requirement for
173 * attributes and initially this is only needed when lockdep is
174 * enabled. Lockdep gives a nice error when your attribute is
175 * added to sysfs if you don't have this.
177 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
179 /* macros to create static binary attributes easier */
180 #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
181 .attr = { .name = __stringify(_name), .mode = _mode }, \
187 #define __BIN_ATTR_RO(_name, _size) { \
188 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
189 .read = _name##_read, \
193 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
194 (S_IWUSR | S_IRUGO), _name##_read, \
195 _name##_write, _size)
197 #define __BIN_ATTR_NULL __ATTR_NULL
199 #define BIN_ATTR(_name, _mode, _read, _write, _size) \
200 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
203 #define BIN_ATTR_RO(_name, _size) \
204 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
206 #define BIN_ATTR_RW(_name, _size) \
207 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
210 ssize_t (*show
)(struct kobject
*, struct attribute
*, char *);
211 ssize_t (*store
)(struct kobject
*, struct attribute
*, const char *, size_t);
216 int __must_check
sysfs_create_dir_ns(struct kobject
*kobj
, const void *ns
);
217 void sysfs_remove_dir(struct kobject
*kobj
);
218 int __must_check
sysfs_rename_dir_ns(struct kobject
*kobj
, const char *new_name
,
220 int __must_check
sysfs_move_dir_ns(struct kobject
*kobj
,
221 struct kobject
*new_parent_kobj
,
223 int __must_check
sysfs_create_mount_point(struct kobject
*parent_kobj
,
225 void sysfs_remove_mount_point(struct kobject
*parent_kobj
,
228 int __must_check
sysfs_create_file_ns(struct kobject
*kobj
,
229 const struct attribute
*attr
,
231 int __must_check
sysfs_create_files(struct kobject
*kobj
,
232 const struct attribute
**attr
);
233 int __must_check
sysfs_chmod_file(struct kobject
*kobj
,
234 const struct attribute
*attr
, umode_t mode
);
235 void sysfs_remove_file_ns(struct kobject
*kobj
, const struct attribute
*attr
,
237 bool sysfs_remove_file_self(struct kobject
*kobj
, const struct attribute
*attr
);
238 void sysfs_remove_files(struct kobject
*kobj
, const struct attribute
**attr
);
240 int __must_check
sysfs_create_bin_file(struct kobject
*kobj
,
241 const struct bin_attribute
*attr
);
242 void sysfs_remove_bin_file(struct kobject
*kobj
,
243 const struct bin_attribute
*attr
);
245 int __must_check
sysfs_create_link(struct kobject
*kobj
, struct kobject
*target
,
247 int __must_check
sysfs_create_link_nowarn(struct kobject
*kobj
,
248 struct kobject
*target
,
250 void sysfs_remove_link(struct kobject
*kobj
, const char *name
);
252 int sysfs_rename_link_ns(struct kobject
*kobj
, struct kobject
*target
,
253 const char *old_name
, const char *new_name
,
256 void sysfs_delete_link(struct kobject
*dir
, struct kobject
*targ
,
259 int __must_check
sysfs_create_group(struct kobject
*kobj
,
260 const struct attribute_group
*grp
);
261 int __must_check
sysfs_create_groups(struct kobject
*kobj
,
262 const struct attribute_group
**groups
);
263 int sysfs_update_group(struct kobject
*kobj
,
264 const struct attribute_group
*grp
);
265 void sysfs_remove_group(struct kobject
*kobj
,
266 const struct attribute_group
*grp
);
267 void sysfs_remove_groups(struct kobject
*kobj
,
268 const struct attribute_group
**groups
);
269 int sysfs_add_file_to_group(struct kobject
*kobj
,
270 const struct attribute
*attr
, const char *group
);
271 void sysfs_remove_file_from_group(struct kobject
*kobj
,
272 const struct attribute
*attr
, const char *group
);
273 int sysfs_merge_group(struct kobject
*kobj
,
274 const struct attribute_group
*grp
);
275 void sysfs_unmerge_group(struct kobject
*kobj
,
276 const struct attribute_group
*grp
);
277 int sysfs_add_link_to_group(struct kobject
*kobj
, const char *group_name
,
278 struct kobject
*target
, const char *link_name
);
279 void sysfs_remove_link_from_group(struct kobject
*kobj
, const char *group_name
,
280 const char *link_name
);
281 int __compat_only_sysfs_link_entry_to_kobj(struct kobject
*kobj
,
282 struct kobject
*target_kobj
,
283 const char *target_name
);
285 void sysfs_notify(struct kobject
*kobj
, const char *dir
, const char *attr
);
287 int __must_check
sysfs_init(void);
289 static inline void sysfs_enable_ns(struct kernfs_node
*kn
)
291 return kernfs_enable_ns(kn
);
294 #else /* CONFIG_SYSFS */
296 static inline int sysfs_create_dir_ns(struct kobject
*kobj
, const void *ns
)
301 static inline void sysfs_remove_dir(struct kobject
*kobj
)
305 static inline int sysfs_rename_dir_ns(struct kobject
*kobj
,
306 const char *new_name
, const void *new_ns
)
311 static inline int sysfs_move_dir_ns(struct kobject
*kobj
,
312 struct kobject
*new_parent_kobj
,
318 static inline int sysfs_create_mount_point(struct kobject
*parent_kobj
,
324 static inline void sysfs_remove_mount_point(struct kobject
*parent_kobj
,
329 static inline int sysfs_create_file_ns(struct kobject
*kobj
,
330 const struct attribute
*attr
,
336 static inline int sysfs_create_files(struct kobject
*kobj
,
337 const struct attribute
**attr
)
342 static inline int sysfs_chmod_file(struct kobject
*kobj
,
343 const struct attribute
*attr
, umode_t mode
)
348 static inline void sysfs_remove_file_ns(struct kobject
*kobj
,
349 const struct attribute
*attr
,
354 static inline bool sysfs_remove_file_self(struct kobject
*kobj
,
355 const struct attribute
*attr
)
360 static inline void sysfs_remove_files(struct kobject
*kobj
,
361 const struct attribute
**attr
)
365 static inline int sysfs_create_bin_file(struct kobject
*kobj
,
366 const struct bin_attribute
*attr
)
371 static inline void sysfs_remove_bin_file(struct kobject
*kobj
,
372 const struct bin_attribute
*attr
)
376 static inline int sysfs_create_link(struct kobject
*kobj
,
377 struct kobject
*target
, const char *name
)
382 static inline int sysfs_create_link_nowarn(struct kobject
*kobj
,
383 struct kobject
*target
,
389 static inline void sysfs_remove_link(struct kobject
*kobj
, const char *name
)
393 static inline int sysfs_rename_link_ns(struct kobject
*k
, struct kobject
*t
,
394 const char *old_name
,
395 const char *new_name
, const void *ns
)
400 static inline void sysfs_delete_link(struct kobject
*k
, struct kobject
*t
,
405 static inline int sysfs_create_group(struct kobject
*kobj
,
406 const struct attribute_group
*grp
)
411 static inline int sysfs_create_groups(struct kobject
*kobj
,
412 const struct attribute_group
**groups
)
417 static inline int sysfs_update_group(struct kobject
*kobj
,
418 const struct attribute_group
*grp
)
423 static inline void sysfs_remove_group(struct kobject
*kobj
,
424 const struct attribute_group
*grp
)
428 static inline void sysfs_remove_groups(struct kobject
*kobj
,
429 const struct attribute_group
**groups
)
433 static inline int sysfs_add_file_to_group(struct kobject
*kobj
,
434 const struct attribute
*attr
, const char *group
)
439 static inline void sysfs_remove_file_from_group(struct kobject
*kobj
,
440 const struct attribute
*attr
, const char *group
)
444 static inline int sysfs_merge_group(struct kobject
*kobj
,
445 const struct attribute_group
*grp
)
450 static inline void sysfs_unmerge_group(struct kobject
*kobj
,
451 const struct attribute_group
*grp
)
455 static inline int sysfs_add_link_to_group(struct kobject
*kobj
,
456 const char *group_name
, struct kobject
*target
,
457 const char *link_name
)
462 static inline void sysfs_remove_link_from_group(struct kobject
*kobj
,
463 const char *group_name
, const char *link_name
)
467 static inline int __compat_only_sysfs_link_entry_to_kobj(
468 struct kobject
*kobj
,
469 struct kobject
*target_kobj
,
470 const char *target_name
)
475 static inline void sysfs_notify(struct kobject
*kobj
, const char *dir
,
480 static inline int __must_check
sysfs_init(void)
485 static inline void sysfs_enable_ns(struct kernfs_node
*kn
)
489 #endif /* CONFIG_SYSFS */
491 static inline int __must_check
sysfs_create_file(struct kobject
*kobj
,
492 const struct attribute
*attr
)
494 return sysfs_create_file_ns(kobj
, attr
, NULL
);
497 static inline void sysfs_remove_file(struct kobject
*kobj
,
498 const struct attribute
*attr
)
500 sysfs_remove_file_ns(kobj
, attr
, NULL
);
503 static inline int sysfs_rename_link(struct kobject
*kobj
, struct kobject
*target
,
504 const char *old_name
, const char *new_name
)
506 return sysfs_rename_link_ns(kobj
, target
, old_name
, new_name
, NULL
);
509 static inline void sysfs_notify_dirent(struct kernfs_node
*kn
)
514 static inline struct kernfs_node
*sysfs_get_dirent(struct kernfs_node
*parent
,
515 const unsigned char *name
)
517 return kernfs_find_and_get(parent
, name
);
520 static inline struct kernfs_node
*sysfs_get(struct kernfs_node
*kn
)
526 static inline void sysfs_put(struct kernfs_node
*kn
)
531 #endif /* _SYSFS_H_ */