kobject: add kobject_add_ng function
[linux-2.6.git] / include / linux / kobject.h
1 /*
2  * kobject.h - generic kernel object infrastructure.
3  *
4  * Copyright (c) 2002-2003 Patrick Mochel
5  * Copyright (c) 2002-2003 Open Source Development Labs
6  * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
7  * Copyright (c) 2006-2007 Novell Inc.
8  *
9  * This file is released under the GPLv2.
10  *
11  * 
12  * Please read Documentation/kobject.txt before using the kobject
13  * interface, ESPECIALLY the parts about reference counts and object
14  * destructors. 
15  */
16
17 #ifndef _KOBJECT_H_
18 #define _KOBJECT_H_
19
20 #ifdef __KERNEL__
21
22 #include <linux/types.h>
23 #include <linux/list.h>
24 #include <linux/sysfs.h>
25 #include <linux/compiler.h>
26 #include <linux/spinlock.h>
27 #include <linux/kref.h>
28 #include <linux/kernel.h>
29 #include <linux/wait.h>
30 #include <asm/atomic.h>
31
32 #define KOBJ_NAME_LEN                   20
33 #define UEVENT_HELPER_PATH_LEN          256
34 #define UEVENT_NUM_ENVP                 32      /* number of env pointers */
35 #define UEVENT_BUFFER_SIZE              2048    /* buffer for the variables */
36
37 /* path to the userspace helper executed on an event */
38 extern char uevent_helper[];
39
40 /* counter to tag the uevent, read only except for the kobject core */
41 extern u64 uevent_seqnum;
42
43 /*
44  * The actions here must match the index to the string array
45  * in lib/kobject_uevent.c
46  *
47  * Do not add new actions here without checking with the driver-core
48  * maintainers. Action strings are not meant to express subsystem
49  * or device specific properties. In most cases you want to send a
50  * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event
51  * specific variables added to the event environment.
52  */
53 enum kobject_action {
54         KOBJ_ADD,
55         KOBJ_REMOVE,
56         KOBJ_CHANGE,
57         KOBJ_MOVE,
58         KOBJ_ONLINE,
59         KOBJ_OFFLINE,
60         KOBJ_MAX
61 };
62
63 struct kobject {
64         const char              * k_name;
65         struct kref             kref;
66         struct list_head        entry;
67         struct kobject          * parent;
68         struct kset             * kset;
69         struct kobj_type        * ktype;
70         struct sysfs_dirent     * sd;
71 };
72
73 extern int kobject_set_name(struct kobject *, const char *, ...)
74         __attribute__((format(printf,2,3)));
75
76 static inline const char * kobject_name(const struct kobject * kobj)
77 {
78         return kobj->k_name;
79 }
80
81 extern void kobject_init(struct kobject *);
82 extern void kobject_init_ng(struct kobject *kobj, struct kobj_type *ktype);
83 extern int __must_check kobject_add(struct kobject *);
84 extern int __must_check kobject_add_ng(struct kobject *kobj,
85                                        struct kobject *parent,
86                                        const char *fmt, ...);
87 extern void kobject_del(struct kobject *);
88
89 extern int __must_check kobject_rename(struct kobject *, const char *new_name);
90 extern int __must_check kobject_move(struct kobject *, struct kobject *);
91
92 extern int __must_check kobject_register(struct kobject *);
93 extern void kobject_unregister(struct kobject *);
94
95 extern struct kobject * kobject_get(struct kobject *);
96 extern void kobject_put(struct kobject *);
97
98 extern struct kobject *kobject_kset_add_dir(struct kset *kset,
99                                             struct kobject *, const char *);
100 extern struct kobject *kobject_add_dir(struct kobject *, const char *);
101
102 extern char * kobject_get_path(struct kobject *, gfp_t);
103
104 struct kobj_type {
105         void (*release)(struct kobject *);
106         struct sysfs_ops        * sysfs_ops;
107         struct attribute        ** default_attrs;
108 };
109
110 struct kobj_uevent_env {
111         char *envp[UEVENT_NUM_ENVP];
112         int envp_idx;
113         char buf[UEVENT_BUFFER_SIZE];
114         int buflen;
115 };
116
117 struct kset_uevent_ops {
118         int (*filter)(struct kset *kset, struct kobject *kobj);
119         const char *(*name)(struct kset *kset, struct kobject *kobj);
120         int (*uevent)(struct kset *kset, struct kobject *kobj,
121                       struct kobj_uevent_env *env);
122 };
123
124 /**
125  * struct kset - a set of kobjects of a specific type, belonging to a specific subsystem.
126  *
127  * A kset defines a group of kobjects.  They can be individually
128  * different "types" but overall these kobjects all want to be grouped
129  * together and operated on in the same manner.  ksets are used to
130  * define the attribute callbacks and other common events that happen to
131  * a kobject.
132  *
133  * @ktype: the struct kobj_type for this specific kset
134  * @list: the list of all kobjects for this kset
135  * @list_lock: a lock for iterating over the kobjects
136  * @kobj: the embedded kobject for this kset (recursion, isn't it fun...)
137  * @uevent_ops: the set of uevent operations for this kset.  These are
138  * called whenever a kobject has something happen to it so that the kset
139  * can add new environment variables, or filter out the uevents if so
140  * desired.
141  */
142 struct kset {
143         struct kobj_type        *ktype;
144         struct list_head        list;
145         spinlock_t              list_lock;
146         struct kobject          kobj;
147         struct kset_uevent_ops  *uevent_ops;
148 };
149
150
151 extern void kset_init(struct kset * k);
152 extern int __must_check kset_add(struct kset * k);
153 extern int __must_check kset_register(struct kset * k);
154 extern void kset_unregister(struct kset * k);
155
156 static inline struct kset * to_kset(struct kobject * kobj)
157 {
158         return kobj ? container_of(kobj,struct kset,kobj) : NULL;
159 }
160
161 static inline struct kset * kset_get(struct kset * k)
162 {
163         return k ? to_kset(kobject_get(&k->kobj)) : NULL;
164 }
165
166 static inline void kset_put(struct kset * k)
167 {
168         kobject_put(&k->kobj);
169 }
170
171 static inline struct kobj_type * get_ktype(struct kobject * k)
172 {
173         if (k->kset && k->kset->ktype)
174                 return k->kset->ktype;
175         else 
176                 return k->ktype;
177 }
178
179 extern struct kobject * kset_find_obj(struct kset *, const char *);
180
181
182 /*
183  * Use this when initializing an embedded kset with no other 
184  * fields to initialize.
185  */
186 #define set_kset_name(str)      .kset = { .kobj = { .k_name = str } }
187
188
189 #define decl_subsys(_name,_type,_uevent_ops) \
190 struct kset _name##_subsys = { \
191         .kobj = { .k_name = __stringify(_name) }, \
192         .ktype = _type, \
193         .uevent_ops =_uevent_ops, \
194 }
195 #define decl_subsys_name(_varname,_name,_type,_uevent_ops) \
196 struct kset _varname##_subsys = { \
197         .kobj = { .k_name = __stringify(_name) }, \
198         .ktype = _type, \
199         .uevent_ops =_uevent_ops, \
200 }
201
202 /* The global /sys/kernel/ subsystem for people to chain off of */
203 extern struct kset kernel_subsys;
204 /* The global /sys/hypervisor/ subsystem  */
205 extern struct kset hypervisor_subsys;
206
207 /*
208  * Helpers for setting the kset of registered objects.
209  * Often, a registered object belongs to a kset embedded in a 
210  * subsystem. These do no magic, just make the resulting code
211  * easier to follow. 
212  */
213
214 /**
215  *      kobj_set_kset_s(obj,subsys) - set kset for embedded kobject.
216  *      @obj:           ptr to some object type.
217  *      @subsys:        a subsystem object (not a ptr).
218  *
219  *      Can be used for any object type with an embedded ->kobj.
220  */
221
222 #define kobj_set_kset_s(obj,subsys) \
223         (obj)->kobj.kset = &(subsys)
224
225 extern int __must_check subsystem_register(struct kset *);
226 extern void subsystem_unregister(struct kset *);
227
228 struct subsys_attribute {
229         struct attribute attr;
230         ssize_t (*show)(struct kset *, char *);
231         ssize_t (*store)(struct kset *, const char *, size_t);
232 };
233
234 extern int __must_check subsys_create_file(struct kset *,
235                                         struct subsys_attribute *);
236
237 #if defined(CONFIG_HOTPLUG)
238 int kobject_uevent(struct kobject *kobj, enum kobject_action action);
239 int kobject_uevent_env(struct kobject *kobj, enum kobject_action action,
240                         char *envp[]);
241
242 int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
243         __attribute__((format (printf, 2, 3)));
244
245 int kobject_action_type(const char *buf, size_t count,
246                         enum kobject_action *type);
247 #else
248 static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action)
249 { return 0; }
250 static inline int kobject_uevent_env(struct kobject *kobj,
251                                       enum kobject_action action,
252                                       char *envp[])
253 { return 0; }
254
255 static inline int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...)
256 { return 0; }
257
258 static inline int kobject_action_type(const char *buf, size_t count,
259                         enum kobject_action *type)
260 { return -EINVAL; }
261 #endif
262
263 #endif /* __KERNEL__ */
264 #endif /* _KOBJECT_H_ */