]>
git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/sysfs.h
9f65758311a4efff6a325f0baeb33f86ec68e06f
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 * 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.
75 struct attribute_group
{
77 umode_t (*is_visible
)(struct kobject
*,
78 struct attribute
*, int);
79 struct attribute
**attrs
;
80 struct bin_attribute
**bin_attrs
;
84 * Use these macros to make defining attributes easier. See include/linux/device.h
88 #define SYSFS_PREALLOC 010000
90 #define __ATTR(_name, _mode, _show, _store) { \
91 .attr = {.name = __stringify(_name), \
92 .mode = VERIFY_OCTAL_PERMISSIONS(_mode) }, \
97 #define __ATTR_PREALLOC(_name, _mode, _show, _store) { \
98 .attr = {.name = __stringify(_name), \
99 .mode = SYSFS_PREALLOC | VERIFY_OCTAL_PERMISSIONS(_mode) },\
104 #define __ATTR_RO(_name) { \
105 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
106 .show = _name##_show, \
109 #define __ATTR_WO(_name) { \
110 .attr = { .name = __stringify(_name), .mode = S_IWUSR }, \
111 .store = _name##_store, \
114 #define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
115 _name##_show, _name##_store)
117 #define __ATTR_NULL { .attr = { .name = NULL } }
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 }, \
127 #define __ATTR_IGNORE_LOCKDEP __ATTR
130 #define __ATTRIBUTE_GROUPS(_name) \
131 static const struct attribute_group *_name##_groups[] = { \
136 #define ATTRIBUTE_GROUPS(_name) \
137 static const struct attribute_group _name##_group = { \
138 .attrs = _name##_attrs, \
140 __ATTRIBUTE_GROUPS(_name)
143 struct vm_area_struct
;
145 struct bin_attribute
{
146 struct attribute attr
;
149 ssize_t (*read
)(struct file
*, struct kobject
*, struct bin_attribute
*,
150 char *, loff_t
, size_t);
151 ssize_t (*write
)(struct file
*, struct kobject
*, struct bin_attribute
*,
152 char *, loff_t
, size_t);
153 int (*mmap
)(struct file
*, struct kobject
*, struct bin_attribute
*attr
,
154 struct vm_area_struct
*vma
);
158 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
159 * @attr: struct bin_attribute to initialize
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.
167 #define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
169 /* macros to create static binary attributes easier */
170 #define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
171 .attr = { .name = __stringify(_name), .mode = _mode }, \
177 #define __BIN_ATTR_RO(_name, _size) { \
178 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
179 .read = _name##_read, \
183 #define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
184 (S_IWUSR | S_IRUGO), _name##_read, \
185 _name##_write, _size)
187 #define __BIN_ATTR_NULL __ATTR_NULL
189 #define BIN_ATTR(_name, _mode, _read, _write, _size) \
190 struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
193 #define BIN_ATTR_RO(_name, _size) \
194 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
196 #define BIN_ATTR_RW(_name, _size) \
197 struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
200 ssize_t (*show
)(struct kobject
*, struct attribute
*, char *);
201 ssize_t (*store
)(struct kobject
*, struct attribute
*, const char *, size_t);
206 int __must_check
sysfs_create_dir_ns(struct kobject
*kobj
, const void *ns
);
207 void sysfs_remove_dir(struct kobject
*kobj
);
208 int __must_check
sysfs_rename_dir_ns(struct kobject
*kobj
, const char *new_name
,
210 int __must_check
sysfs_move_dir_ns(struct kobject
*kobj
,
211 struct kobject
*new_parent_kobj
,
213 int __must_check
sysfs_create_mount_point(struct kobject
*parent_kobj
,
215 void sysfs_remove_mount_point(struct kobject
*parent_kobj
,
218 int __must_check
sysfs_create_file_ns(struct kobject
*kobj
,
219 const struct attribute
*attr
,
221 int __must_check
sysfs_create_files(struct kobject
*kobj
,
222 const struct attribute
**attr
);
223 int __must_check
sysfs_chmod_file(struct kobject
*kobj
,
224 const struct attribute
*attr
, umode_t mode
);
225 void sysfs_remove_file_ns(struct kobject
*kobj
, const struct attribute
*attr
,
227 bool sysfs_remove_file_self(struct kobject
*kobj
, const struct attribute
*attr
);
228 void sysfs_remove_files(struct kobject
*kobj
, const struct attribute
**attr
);
230 int __must_check
sysfs_create_bin_file(struct kobject
*kobj
,
231 const struct bin_attribute
*attr
);
232 void sysfs_remove_bin_file(struct kobject
*kobj
,
233 const struct bin_attribute
*attr
);
235 int __must_check
sysfs_create_link(struct kobject
*kobj
, struct kobject
*target
,
237 int __must_check
sysfs_create_link_nowarn(struct kobject
*kobj
,
238 struct kobject
*target
,
240 void sysfs_remove_link(struct kobject
*kobj
, const char *name
);
242 int sysfs_rename_link_ns(struct kobject
*kobj
, struct kobject
*target
,
243 const char *old_name
, const char *new_name
,
246 void sysfs_delete_link(struct kobject
*dir
, struct kobject
*targ
,
249 int __must_check
sysfs_create_group(struct kobject
*kobj
,
250 const struct attribute_group
*grp
);
251 int __must_check
sysfs_create_groups(struct kobject
*kobj
,
252 const struct attribute_group
**groups
);
253 int sysfs_update_group(struct kobject
*kobj
,
254 const struct attribute_group
*grp
);
255 void sysfs_remove_group(struct kobject
*kobj
,
256 const struct attribute_group
*grp
);
257 void sysfs_remove_groups(struct kobject
*kobj
,
258 const struct attribute_group
**groups
);
259 int sysfs_add_file_to_group(struct kobject
*kobj
,
260 const struct attribute
*attr
, const char *group
);
261 void sysfs_remove_file_from_group(struct kobject
*kobj
,
262 const struct attribute
*attr
, const char *group
);
263 int sysfs_merge_group(struct kobject
*kobj
,
264 const struct attribute_group
*grp
);
265 void sysfs_unmerge_group(struct kobject
*kobj
,
266 const struct attribute_group
*grp
);
267 int sysfs_add_link_to_group(struct kobject
*kobj
, const char *group_name
,
268 struct kobject
*target
, const char *link_name
);
269 void sysfs_remove_link_from_group(struct kobject
*kobj
, const char *group_name
,
270 const char *link_name
);
272 void sysfs_notify(struct kobject
*kobj
, const char *dir
, const char *attr
);
274 int __must_check
sysfs_init(void);
276 static inline void sysfs_enable_ns(struct kernfs_node
*kn
)
278 return kernfs_enable_ns(kn
);
281 #else /* CONFIG_SYSFS */
283 static inline int sysfs_create_dir_ns(struct kobject
*kobj
, const void *ns
)
288 static inline void sysfs_remove_dir(struct kobject
*kobj
)
292 static inline int sysfs_rename_dir_ns(struct kobject
*kobj
,
293 const char *new_name
, const void *new_ns
)
298 static inline int sysfs_move_dir_ns(struct kobject
*kobj
,
299 struct kobject
*new_parent_kobj
,
305 static inline int sysfs_create_mount_point(struct kobject
*parent_kobj
,
311 static inline void sysfs_remove_mount_point(struct kobject
*parent_kobj
,
316 static inline int sysfs_create_file_ns(struct kobject
*kobj
,
317 const struct attribute
*attr
,
323 static inline int sysfs_create_files(struct kobject
*kobj
,
324 const struct attribute
**attr
)
329 static inline int sysfs_chmod_file(struct kobject
*kobj
,
330 const struct attribute
*attr
, umode_t mode
)
335 static inline void sysfs_remove_file_ns(struct kobject
*kobj
,
336 const struct attribute
*attr
,
341 static inline bool sysfs_remove_file_self(struct kobject
*kobj
,
342 const struct attribute
*attr
)
347 static inline void sysfs_remove_files(struct kobject
*kobj
,
348 const struct attribute
**attr
)
352 static inline int sysfs_create_bin_file(struct kobject
*kobj
,
353 const struct bin_attribute
*attr
)
358 static inline void sysfs_remove_bin_file(struct kobject
*kobj
,
359 const struct bin_attribute
*attr
)
363 static inline int sysfs_create_link(struct kobject
*kobj
,
364 struct kobject
*target
, const char *name
)
369 static inline int sysfs_create_link_nowarn(struct kobject
*kobj
,
370 struct kobject
*target
,
376 static inline void sysfs_remove_link(struct kobject
*kobj
, const char *name
)
380 static inline int sysfs_rename_link_ns(struct kobject
*k
, struct kobject
*t
,
381 const char *old_name
,
382 const char *new_name
, const void *ns
)
387 static inline void sysfs_delete_link(struct kobject
*k
, struct kobject
*t
,
392 static inline int sysfs_create_group(struct kobject
*kobj
,
393 const struct attribute_group
*grp
)
398 static inline int sysfs_create_groups(struct kobject
*kobj
,
399 const struct attribute_group
**groups
)
404 static inline int sysfs_update_group(struct kobject
*kobj
,
405 const struct attribute_group
*grp
)
410 static inline void sysfs_remove_group(struct kobject
*kobj
,
411 const struct attribute_group
*grp
)
415 static inline void sysfs_remove_groups(struct kobject
*kobj
,
416 const struct attribute_group
**groups
)
420 static inline int sysfs_add_file_to_group(struct kobject
*kobj
,
421 const struct attribute
*attr
, const char *group
)
426 static inline void sysfs_remove_file_from_group(struct kobject
*kobj
,
427 const struct attribute
*attr
, const char *group
)
431 static inline int sysfs_merge_group(struct kobject
*kobj
,
432 const struct attribute_group
*grp
)
437 static inline void sysfs_unmerge_group(struct kobject
*kobj
,
438 const struct attribute_group
*grp
)
442 static inline int sysfs_add_link_to_group(struct kobject
*kobj
,
443 const char *group_name
, struct kobject
*target
,
444 const char *link_name
)
449 static inline void sysfs_remove_link_from_group(struct kobject
*kobj
,
450 const char *group_name
, const char *link_name
)
454 static inline void sysfs_notify(struct kobject
*kobj
, const char *dir
,
459 static inline int __must_check
sysfs_init(void)
464 static inline void sysfs_enable_ns(struct kernfs_node
*kn
)
468 #endif /* CONFIG_SYSFS */
470 static inline int __must_check
sysfs_create_file(struct kobject
*kobj
,
471 const struct attribute
*attr
)
473 return sysfs_create_file_ns(kobj
, attr
, NULL
);
476 static inline void sysfs_remove_file(struct kobject
*kobj
,
477 const struct attribute
*attr
)
479 sysfs_remove_file_ns(kobj
, attr
, NULL
);
482 static inline int sysfs_rename_link(struct kobject
*kobj
, struct kobject
*target
,
483 const char *old_name
, const char *new_name
)
485 return sysfs_rename_link_ns(kobj
, target
, old_name
, new_name
, NULL
);
488 static inline void sysfs_notify_dirent(struct kernfs_node
*kn
)
493 static inline struct kernfs_node
*sysfs_get_dirent(struct kernfs_node
*parent
,
494 const unsigned char *name
)
496 return kernfs_find_and_get(parent
, name
);
499 static inline struct kernfs_node
*sysfs_get(struct kernfs_node
*kn
)
505 static inline void sysfs_put(struct kernfs_node
*kn
)
510 #endif /* _SYSFS_H_ */