]> bbs.cooldavid.org Git - net-next-2.6.git/blame - include/linux/sysfs.h
netfilter: fix IP_VS dependencies
[net-next-2.6.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>
1da177e4
LT
20#include <asm/atomic.h>
21
22struct kobject;
23struct module;
3ff195b0 24enum kobj_ns_type;
1da177e4
LT
25
26struct attribute {
59f69015 27 const char *name;
1da177e4 28 mode_t mode;
6992f533
EB
29#ifdef CONFIG_DEBUG_LOCK_ALLOC
30 struct lock_class_key *key;
31 struct lock_class_key skey;
32#endif
1da177e4
LT
33};
34
35960258
EB
35/**
36 * sysfs_attr_init - initialize a dynamically allocated sysfs attribute
37 * @attr: struct attribute to initialize
38 *
39 * Initialize a dynamically allocated struct attribute so we can
40 * make lockdep happy. This is a new requirement for attributes
41 * and initially this is only needed when lockdep is enabled.
42 * Lockdep gives a nice error when your attribute is added to
43 * sysfs if you don't have this.
44 */
6992f533
EB
45#ifdef CONFIG_DEBUG_LOCK_ALLOC
46#define sysfs_attr_init(attr) \
47do { \
48 static struct lock_class_key __key; \
49 \
50 (attr)->key = &__key; \
51} while(0)
52#else
53#define sysfs_attr_init(attr) do {} while(0)
54#endif
55
1da177e4 56struct attribute_group {
59f69015 57 const char *name;
0f423895 58 mode_t (*is_visible)(struct kobject *,
d4acd722 59 struct attribute *, int);
59f69015 60 struct attribute **attrs;
1da177e4
LT
61};
62
63
64
65/**
66 * Use these macros to make defining attributes easier. See include/linux/device.h
67 * for examples..
68 */
69
70#define __ATTR(_name,_mode,_show,_store) { \
7b595756 71 .attr = {.name = __stringify(_name), .mode = _mode }, \
1da177e4
LT
72 .show = _show, \
73 .store = _store, \
74}
75
76#define __ATTR_RO(_name) { \
7b595756
TH
77 .attr = { .name = __stringify(_name), .mode = 0444 }, \
78 .show = _name##_show, \
1da177e4
LT
79}
80
81#define __ATTR_NULL { .attr = { .name = NULL } }
82
83#define attr_name(_attr) (_attr).attr.name
84
2c3c8bea 85struct file;
1da177e4
LT
86struct vm_area_struct;
87
88struct bin_attribute {
89 struct attribute attr;
90 size_t size;
91 void *private;
2c3c8bea 92 ssize_t (*read)(struct file *, struct kobject *, struct bin_attribute *,
91a69029 93 char *, loff_t, size_t);
2c3c8bea 94 ssize_t (*write)(struct file *,struct kobject *, struct bin_attribute *,
91a69029 95 char *, loff_t, size_t);
2c3c8bea 96 int (*mmap)(struct file *, struct kobject *, struct bin_attribute *attr,
1da177e4
LT
97 struct vm_area_struct *vma);
98};
99
35960258
EB
100/**
101 * sysfs_bin_attr_init - initialize a dynamically allocated bin_attribute
102 * @attr: struct bin_attribute to initialize
103 *
104 * Initialize a dynamically allocated struct bin_attribute so we
105 * can make lockdep happy. This is a new requirement for
106 * attributes and initially this is only needed when lockdep is
107 * enabled. Lockdep gives a nice error when your attribute is
108 * added to sysfs if you don't have this.
109 */
62e877b8 110#define sysfs_bin_attr_init(bin_attr) sysfs_attr_init(&(bin_attr)->attr)
6992f533 111
1da177e4
LT
112struct sysfs_ops {
113 ssize_t (*show)(struct kobject *, struct attribute *,char *);
114 ssize_t (*store)(struct kobject *,struct attribute *,const char *, size_t);
115};
116
f1282c84
NB
117struct sysfs_dirent;
118
1da177e4
LT
119#ifdef CONFIG_SYSFS
120
59f69015
TH
121int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
122 void *data, struct module *owner);
1da177e4 123
59f69015
TH
124int __must_check sysfs_create_dir(struct kobject *kobj);
125void sysfs_remove_dir(struct kobject *kobj);
126int __must_check sysfs_rename_dir(struct kobject *kobj, const char *new_name);
127int __must_check sysfs_move_dir(struct kobject *kobj,
128 struct kobject *new_parent_kobj);
31e5abe9 129
59f69015
TH
130int __must_check sysfs_create_file(struct kobject *kobj,
131 const struct attribute *attr);
1c205ae1
AK
132int __must_check sysfs_create_files(struct kobject *kobj,
133 const struct attribute **attr);
49c19400
JD
134int __must_check sysfs_chmod_file(struct kobject *kobj,
135 const struct attribute *attr, mode_t mode);
59f69015 136void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr);
1c205ae1 137void sysfs_remove_files(struct kobject *kobj, const struct attribute **attr);
1da177e4 138
4a7fb636 139int __must_check sysfs_create_bin_file(struct kobject *kobj,
66ecb92b
PC
140 const struct bin_attribute *attr);
141void sysfs_remove_bin_file(struct kobject *kobj,
142 const struct bin_attribute *attr);
1da177e4 143
59f69015
TH
144int __must_check sysfs_create_link(struct kobject *kobj, struct kobject *target,
145 const char *name);
36ce6dad
CH
146int __must_check sysfs_create_link_nowarn(struct kobject *kobj,
147 struct kobject *target,
148 const char *name);
59f69015
TH
149void sysfs_remove_link(struct kobject *kobj, const char *name);
150
7cb32942
EB
151int sysfs_rename_link(struct kobject *kobj, struct kobject *target,
152 const char *old_name, const char *new_name);
153
746edb7a
EB
154void sysfs_delete_link(struct kobject *dir, struct kobject *targ,
155 const char *name);
156
59f69015
TH
157int __must_check sysfs_create_group(struct kobject *kobj,
158 const struct attribute_group *grp);
0f423895
JB
159int sysfs_update_group(struct kobject *kobj,
160 const struct attribute_group *grp);
59f69015
TH
161void sysfs_remove_group(struct kobject *kobj,
162 const struct attribute_group *grp);
dfa87c82 163int sysfs_add_file_to_group(struct kobject *kobj,
59f69015 164 const struct attribute *attr, const char *group);
dfa87c82 165void sysfs_remove_file_from_group(struct kobject *kobj,
59f69015 166 const struct attribute *attr, const char *group);
69d44ffb
AS
167int sysfs_merge_group(struct kobject *kobj,
168 const struct attribute_group *grp);
169void sysfs_unmerge_group(struct kobject *kobj,
170 const struct attribute_group *grp);
dfa87c82 171
8c0e3998 172void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr);
f1282c84
NB
173void sysfs_notify_dirent(struct sysfs_dirent *sd);
174struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 175 const void *ns,
f1282c84
NB
176 const unsigned char *name);
177struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd);
178void sysfs_put(struct sysfs_dirent *sd);
ae87221d 179void sysfs_printk_last_file(void);
3ff195b0 180
be867b19 181/* Called to clear a ns tag when it is no longer valid */
3ff195b0
EB
182void sysfs_exit_ns(enum kobj_ns_type type, const void *tag);
183
f1282c84 184int __must_check sysfs_init(void);
f20a9ead 185
1da177e4
LT
186#else /* CONFIG_SYSFS */
187
d9a9cdfb 188static inline int sysfs_schedule_callback(struct kobject *kobj,
523ded71 189 void (*func)(void *), void *data, struct module *owner)
d9a9cdfb
AS
190{
191 return -ENOSYS;
192}
193
59f69015 194static inline int sysfs_create_dir(struct kobject *kobj)
1da177e4
LT
195{
196 return 0;
197}
198
59f69015 199static inline void sysfs_remove_dir(struct kobject *kobj)
1da177e4 200{
1da177e4
LT
201}
202
59f69015 203static inline int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
1da177e4 204{
0b4a4fea 205 return 0;
1da177e4
LT
206}
207
59f69015
TH
208static inline int sysfs_move_dir(struct kobject *kobj,
209 struct kobject *new_parent_kobj)
8a82472f
CH
210{
211 return 0;
212}
213
59f69015
TH
214static inline int sysfs_create_file(struct kobject *kobj,
215 const struct attribute *attr)
1da177e4
LT
216{
217 return 0;
218}
219
1c205ae1
AK
220static inline int sysfs_create_files(struct kobject *kobj,
221 const struct attribute **attr)
222{
223 return 0;
224}
225
59f69015 226static inline int sysfs_chmod_file(struct kobject *kobj,
49c19400 227 const struct attribute *attr, mode_t mode)
31e5abe9
KS
228{
229 return 0;
230}
1da177e4 231
59f69015
TH
232static inline void sysfs_remove_file(struct kobject *kobj,
233 const struct attribute *attr)
1da177e4 234{
1da177e4
LT
235}
236
1c205ae1
AK
237static inline void sysfs_remove_files(struct kobject *kobj,
238 const struct attribute **attr)
239{
240}
241
59f69015 242static inline int sysfs_create_bin_file(struct kobject *kobj,
66ecb92b 243 const struct bin_attribute *attr)
1da177e4
LT
244{
245 return 0;
246}
247
3612e06b 248static inline void sysfs_remove_bin_file(struct kobject *kobj,
66ecb92b 249 const struct bin_attribute *attr)
1da177e4 250{
1da177e4
LT
251}
252
59f69015
TH
253static inline int sysfs_create_link(struct kobject *kobj,
254 struct kobject *target, const char *name)
1da177e4
LT
255{
256 return 0;
257}
258
36ce6dad
CH
259static inline int sysfs_create_link_nowarn(struct kobject *kobj,
260 struct kobject *target,
261 const char *name)
262{
263 return 0;
264}
265
59f69015 266static inline void sysfs_remove_link(struct kobject *kobj, const char *name)
1da177e4 267{
1da177e4
LT
268}
269
7cb32942
EB
270static inline int sysfs_rename_link(struct kobject *k, struct kobject *t,
271 const char *old_name, const char *new_name)
272{
273 return 0;
274}
275
746edb7a
EB
276static inline void sysfs_delete_link(struct kobject *k, struct kobject *t,
277 const char *name)
278{
279}
280
59f69015
TH
281static inline int sysfs_create_group(struct kobject *kobj,
282 const struct attribute_group *grp)
1da177e4
LT
283{
284 return 0;
285}
286
1cbfb7a5
RD
287static inline int sysfs_update_group(struct kobject *kobj,
288 const struct attribute_group *grp)
289{
290 return 0;
291}
292
59f69015
TH
293static inline void sysfs_remove_group(struct kobject *kobj,
294 const struct attribute_group *grp)
1da177e4 295{
1da177e4
LT
296}
297
dfa87c82
AS
298static inline int sysfs_add_file_to_group(struct kobject *kobj,
299 const struct attribute *attr, const char *group)
300{
301 return 0;
302}
303
304static inline void sysfs_remove_file_from_group(struct kobject *kobj,
d701d8a3 305 const struct attribute *attr, const char *group)
dfa87c82 306{
dfa87c82
AS
307}
308
69d44ffb
AS
309static inline int sysfs_merge_group(struct kobject *kobj,
310 const struct attribute_group *grp)
311{
312 return 0;
313}
314
315static inline void sysfs_unmerge_group(struct kobject *kobj,
316 const struct attribute_group *grp)
317{
318}
319
8c0e3998
TP
320static inline void sysfs_notify(struct kobject *kobj, const char *dir,
321 const char *attr)
4508a7a7
N
322{
323}
f1282c84
NB
324static inline void sysfs_notify_dirent(struct sysfs_dirent *sd)
325{
326}
327static inline
328struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
3ff195b0 329 const void *ns,
f1282c84
NB
330 const unsigned char *name)
331{
332 return NULL;
333}
334static inline struct sysfs_dirent *sysfs_get(struct sysfs_dirent *sd)
335{
336 return NULL;
337}
338static inline void sysfs_put(struct sysfs_dirent *sd)
339{
340}
4508a7a7 341
27eabc7c 342static inline void sysfs_exit_ns(int type, const void *tag)
3ff195b0
EB
343{
344}
345
f20a9ead
AM
346static inline int __must_check sysfs_init(void)
347{
348 return 0;
349}
350
ae87221d
AM
351static inline void sysfs_printk_last_file(void)
352{
353}
354
1da177e4
LT
355#endif /* CONFIG_SYSFS */
356
357#endif /* _SYSFS_H_ */