Merge git://git.kernel.org/pub/scm/linux/kernel/git/steve/gfs2-3.0-fixes
[deliverable/linux.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; \
54} while(0)
55#else
56#define sysfs_attr_init(attr) do {} while(0)
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
aa01aa3c
OS
72#define __ATTR(_name,_mode,_show,_store) { \
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
aa01aa3c
OS
83#define __ATTR_RW(_name) __ATTR(_name, (S_IWUSR | S_IRUGO), \
84 _name##_show, _name##_store)
b9b32597 85
1da177e4 86#define __ATTR_NULL { .attr = { .name = NULL } }
356c05d5
AS
87
88#ifdef CONFIG_DEBUG_LOCK_ALLOC
89#define __ATTR_IGNORE_LOCKDEP(_name, _mode, _show, _store) { \
90 .attr = {.name = __stringify(_name), .mode = _mode, \
91 .ignore_lockdep = true }, \
92 .show = _show, \
93 .store = _store, \
94}
95#else
96#define __ATTR_IGNORE_LOCKDEP __ATTR
97#endif
1da177e4 98
3493f69f
OS
99#define __ATTRIBUTE_GROUPS(_name) \
100static const struct attribute_group *_name##_groups[] = { \
101 &_name##_group, \
f2f37f58
GKH
102 NULL, \
103}
104
3493f69f
OS
105#define ATTRIBUTE_GROUPS(_name) \
106static const struct attribute_group _name##_group = { \
107 .attrs = _name##_attrs, \
108}; \
109__ATTRIBUTE_GROUPS(_name)
110
1da177e4
LT
111#define attr_name(_attr) (_attr).attr.name
112
2c3c8bea 113struct file;
1da177e4
LT
114struct vm_area_struct;
115
116struct bin_attribute {
117 struct attribute attr;
118 size_t size;
119 void *private;
2c3c8bea 120 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
91a69029 121 char *, loff_t, size_t);
2c3c8bea 122 ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
91a69029 123 char *, loff_t, size_t);
2c3c8bea 124 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
1da177e4
LT
125 struct vm_area_struct *vma);
126};
127
35960258
EB
128/**
129 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
130 * @attr: struct bin_attribute to initialize
131 *
132 * Initialize a dynamically allocated struct bin_attribute so we
133 * can make lockdep happy. This is a new requirement for
134 * attributes and initially this is only needed when lockdep is
135 * enabled. Lockdep gives a nice error when your attribute is
136 * added to sysfs if you don't have this.
137 */
62e877b8 138#define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
6992f533 139
3493f69f
OS
140/* macros to create static binary attributes easier */
141#define __BIN_ATTR(_name, _mode, _read, _write, _size) { \
142 .attr = { .name = __stringify(_name), .mode = _mode }, \
143 .read = _read, \
144 .write = _write, \
145 .size = _size, \
146}
147
148#define __BIN_ATTR_RO(_name, _size) { \
149 .attr = { .name = __stringify(_name), .mode = S_IRUGO }, \
150 .read = _name##_read, \
151 .size = _size, \
e4b63603
GKH
152}
153
3493f69f
OS
154#define __BIN_ATTR_RW(_name, _size) __BIN_ATTR(_name, \
155 (S_IWUSR | S_IRUGO), _name##_read, \
156 _name##_write)
157
158#define __BIN_ATTR_NULL __ATTR_NULL
159
160#define BIN_ATTR(_name, _mode, _read, _write, _size) \
161struct bin_attribute bin_attr_##_name = __BIN_ATTR(_name, _mode, _read, \
162 _write, _size)
163
164#define BIN_ATTR_RO(_name, _size) \
165struct bin_attribute bin_attr_##_name = __BIN_ATTR_RO(_name, _size)
166
167#define BIN_ATTR_RW(_name, _size) \
168struct bin_attribute bin_attr_##_name = __BIN_ATTR_RW(_name, _size)
169
1da177e4
LT
170struct sysfs_ops {
171 ssize_t (*show)(struct kobject *, struct attribute *,char *);
172 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
487505c2 173 const void *(*namespace)(struct kobject *, const struct attribute *);
1da177e4
LT
174};
175
f1282c84
NB
176struct sysfs_dirent;
177
1da177e4
LT
178#ifdef CONFIG_SYSFS
179
59f69015
TH
180int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
181 void *data, struct module *owner);
1da177e4 182
59f69015
TH
183int __must_check sysfs_create_dir(struct kobject *kobj);
184void sysfs_remove_dir(struct kobject *kobj);
185int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
186int __must_check sysfs_move_dir(struct kobject *kobj,
187 struct kobject *new_parent_kobj);
31e5abe9 188
59f69015
TH
189int __must_check sysfs_create_file(struct kobject *kobj,
190 const struct attribute *attr);
1c205ae1
AK
191int __must_check sysfs_create_files(struct kobject *kobj,
192 const struct attribute **attr);
49c19400 193int __must_check sysfs_chmod_file(struct kobject *kobj,
48176a97 194 const struct attribute *attr, umode_t mode);
59f69015 195void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
1c205ae1 196void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
1da177e4 197
4a7fb636 198int __must_check sysfs_create_bin_file(struct kobject *kobj,
66ecb92b
PC
199 const struct bin_attribute *attr);
200void sysfs_remove_bin_file(struct kobject *kobj,
201 const struct bin_attribute *attr);
1da177e4 202
59f69015
TH
203int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
204 const char *name);
36ce6dad
CH
205int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
206 struct kobject *target,
207 const char *name);
59f69015
TH
208void sysfs_remove_link(struct kobject *kobj, const char *name);
209
7cb32942
EB
210int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
211 const char *old_name, const char *new_name);
212
746edb7a
EB
213void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
214 const char *name);
215
59f69015
TH
216int __must_check sysfs_create_group(struct kobject *kobj,
217 const struct attribute_group *grp);
0f423895
JB
218int sysfs_update_group(struct kobject *kobj,
219 const struct attribute_group *grp);
59f69015
TH
220void sysfs_remove_group(struct kobject *kobj,
221 const struct attribute_group *grp);
dfa87c82 222int sysfs_add_file_to_group(struct kobject *kobj,
59f69015 223 const struct attribute *attr, const char *group);
dfa87c82 224void sysfs_remove_file_from_group(struct kobject *kobj,
59f69015 225 const struct attribute *attr, const char *group);
69d44ffb
AS
226int sysfs_merge_group(struct kobject *kobj,
227 const struct attribute_group *grp);
228void sysfs_unmerge_group(struct kobject *kobj,
229 const struct attribute_group *grp);
0bb8f3d6
RW
230int sysfs_add_link_to_group(struct kobject *kobj, const char *group_name,
231 struct kobject *target, const char *link_name);
232void sysfs_remove_link_from_group(struct kobject *kobj, const char *group_name,
233 const char *link_name);
dfa87c82 234
8c0e3998 235void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
f1282c84
NB
236void sysfs_notify_dirent(struct sysfs_dirent *sd);
237struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 238 const void *ns,
f1282c84
NB
239 const unsigned char *name);
240struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
241void sysfs_put(struct sysfs_dirent *sd);
3ff195b0 242
f1282c84 243int __must_check sysfs_init(void);
f20a9ead 244
1da177e4
LT
245#else /* CONFIG_SYSFS */
246
d9a9cdfb 247static inline int sysfs_schedule_callback(struct kobject *kobj,
523ded71 248 void (*func)(void *), void *data, struct module *owner)
d9a9cdfb
AS
249{
250 return -ENOSYS;
251}
252
59f69015 253static inline int sysfs_create_dir(struct kobject *kobj)
1da177e4
LT
254{
255 return 0;
256}
257
59f69015 258static inline void sysfs_remove_dir(struct kobject *kobj)
1da177e4 259{
1da177e4
LT
260}
261
59f69015 262static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
1da177e4 263{
0b4a4fea 264 return 0;
1da177e4
LT
265}
266
59f69015
TH
267static inline int sysfs_move_dir(struct kobject *kobj,
268 struct kobject *new_parent_kobj)
8a82472f
CH
269{
270 return 0;
271}
272
59f69015
TH
273static inline int sysfs_create_file(struct kobject *kobj,
274 const struct attribute *attr)
1da177e4
LT
275{
276 return 0;
277}
278
1c205ae1
AK
279static inline int sysfs_create_files(struct kobject *kobj,
280 const struct attribute **attr)
281{
282 return 0;
283}
284
59f69015 285static inline int sysfs_chmod_file(struct kobject *kobj,
48176a97 286 const struct attribute *attr, umode_t mode)
31e5abe9
KS
287{
288 return 0;
289}
1da177e4 290
59f69015
TH
291static inline void sysfs_remove_file(struct kobject *kobj,
292 const struct attribute *attr)
1da177e4 293{
1da177e4
LT
294}
295
1c205ae1
AK
296static inline void sysfs_remove_files(struct kobject *kobj,
297 const struct attribute **attr)
298{
299}
300
59f69015 301static inline int sysfs_create_bin_file(struct kobject *kobj,
66ecb92b 302 const struct bin_attribute *attr)
1da177e4
LT
303{
304 return 0;
305}
306
3612e06b 307static inline void sysfs_remove_bin_file(struct kobject *kobj,
66ecb92b 308 const struct bin_attribute *attr)
1da177e4 309{
1da177e4
LT
310}
311
59f69015
TH
312static inline int sysfs_create_link(struct kobject *kobj,
313 struct kobject *target, const char *name)
1da177e4
LT
314{
315 return 0;
316}
317
36ce6dad
CH
318static inline int sysfs_create_link_nowarn(struct kobject *kobj,
319 struct kobject *target,
320 const char *name)
321{
322 return 0;
323}
324
59f69015 325static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
1da177e4 326{
1da177e4
LT
327}
328
7cb32942
EB
329static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
330 const char *old_name, const char *new_name)
331{
332 return 0;
333}
334
746edb7a
EB
335static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
336 const char *name)
337{
338}
339
59f69015
TH
340static inline int sysfs_create_group(struct kobject *kobj,
341 const struct attribute_group *grp)
1da177e4
LT
342{
343 return 0;
344}
345
1cbfb7a5
RD
346static inline int sysfs_update_group(struct kobject *kobj,
347 const struct attribute_group *grp)
348{
349 return 0;
350}
351
59f69015
TH
352static inline void sysfs_remove_group(struct kobject *kobj,
353 const struct attribute_group *grp)
1da177e4 354{
1da177e4
LT
355}
356
dfa87c82
AS
357static inline int sysfs_add_file_to_group(struct kobject *kobj,
358 const struct attribute *attr, const char *group)
359{
360 return 0;
361}
362
363static inline void sysfs_remove_file_from_group(struct kobject *kobj,
d701d8a3 364 const struct attribute *attr, const char *group)
dfa87c82 365{
dfa87c82
AS
366}
367
69d44ffb
AS
368static inline int sysfs_merge_group(struct kobject *kobj,
369 const struct attribute_group *grp)
370{
371 return 0;
372}
373
374static inline void sysfs_unmerge_group(struct kobject *kobj,
375 const struct attribute_group *grp)
376{
377}
378
0bb8f3d6
RW
379static inline int sysfs_add_link_to_group(struct kobject *kobj,
380 const char *group_name, struct kobject *target,
381 const char *link_name)
382{
383 return 0;
384}
385
386static inline void sysfs_remove_link_from_group(struct kobject *kobj,
387 const char *group_name, const char *link_name)
388{
389}
390
8c0e3998
TP
391static inline void sysfs_notify(struct kobject *kobj, const char *dir,
392 const char *attr)
4508a7a7
N
393{
394}
f1282c84
NB
395static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
396{
397}
398static inline
399struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 400 const void *ns,
f1282c84
NB
401 const unsigned char *name)
402{
403 return NULL;
404}
405static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
406{
407 return NULL;
408}
409static inline void sysfs_put(struct sysfs_dirent *sd)
410{
411}
4508a7a7 412
f20a9ead
AM
413static inline int __must_check sysfs_init(void)
414{
415 return 0;
416}
417
1da177e4
LT
418#endif /* CONFIG_SYSFS */
419
420#endif /* _SYSFS_H_ */
This page took 1.256433 seconds and 5 git commands to generate.