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