Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | * | |
7 | * This file is released under the GPLv2. | |
8 | * | |
9 | * | |
10 | * Please read Documentation/kobject.txt before using the kobject | |
11 | * interface, ESPECIALLY the parts about reference counts and object | |
12 | * destructors. | |
13 | */ | |
14 | ||
15 | #ifndef _KOBJECT_H_ | |
16 | #define _KOBJECT_H_ | |
17 | ||
18 | #ifdef __KERNEL__ | |
19 | ||
20 | #include <linux/types.h> | |
21 | #include <linux/list.h> | |
22 | #include <linux/sysfs.h> | |
4a7fb636 | 23 | #include <linux/compiler.h> |
1da177e4 | 24 | #include <linux/spinlock.h> |
1da177e4 | 25 | #include <linux/kref.h> |
1da177e4 | 26 | #include <linux/kernel.h> |
4508a7a7 | 27 | #include <linux/wait.h> |
1da177e4 LT |
28 | #include <asm/atomic.h> |
29 | ||
312c004d KS |
30 | #define KOBJ_NAME_LEN 20 |
31 | #define UEVENT_HELPER_PATH_LEN 256 | |
0296b228 KS |
32 | |
33 | /* path to the userspace helper executed on an event */ | |
312c004d | 34 | extern char uevent_helper[]; |
0296b228 | 35 | |
312c004d KS |
36 | /* counter to tag the uevent, read only except for the kobject core */ |
37 | extern u64 uevent_seqnum; | |
1da177e4 | 38 | |
0296b228 KS |
39 | /* the actions here must match the proper string in lib/kobject_uevent.c */ |
40 | typedef int __bitwise kobject_action_t; | |
41 | enum kobject_action { | |
5f123fbd KS |
42 | KOBJ_ADD = (__force kobject_action_t) 0x01, /* exclusive to core */ |
43 | KOBJ_REMOVE = (__force kobject_action_t) 0x02, /* exclusive to core */ | |
44 | KOBJ_CHANGE = (__force kobject_action_t) 0x03, /* device state change */ | |
3106d46f AB |
45 | KOBJ_OFFLINE = (__force kobject_action_t) 0x04, /* device offline */ |
46 | KOBJ_ONLINE = (__force kobject_action_t) 0x05, /* device online */ | |
47 | KOBJ_MOVE = (__force kobject_action_t) 0x06, /* device move */ | |
0296b228 KS |
48 | }; |
49 | ||
1da177e4 | 50 | struct kobject { |
f3b4f3c6 | 51 | const char * k_name; |
1da177e4 LT |
52 | char name[KOBJ_NAME_LEN]; |
53 | struct kref kref; | |
54 | struct list_head entry; | |
55 | struct kobject * parent; | |
56 | struct kset * kset; | |
57 | struct kobj_type * ktype; | |
58 | struct dentry * dentry; | |
4508a7a7 | 59 | wait_queue_head_t poll; |
1da177e4 LT |
60 | }; |
61 | ||
62 | extern int kobject_set_name(struct kobject *, const char *, ...) | |
63 | __attribute__((format(printf,2,3))); | |
64 | ||
f3b4f3c6 | 65 | static inline const char * kobject_name(const struct kobject * kobj) |
1da177e4 LT |
66 | { |
67 | return kobj->k_name; | |
68 | } | |
69 | ||
70 | extern void kobject_init(struct kobject *); | |
71 | extern void kobject_cleanup(struct kobject *); | |
72 | ||
4a7fb636 | 73 | extern int __must_check kobject_add(struct kobject *); |
b592fcfe | 74 | extern int __must_check kobject_shadow_add(struct kobject *, struct dentry *); |
1da177e4 LT |
75 | extern void kobject_del(struct kobject *); |
76 | ||
4a7fb636 | 77 | extern int __must_check kobject_rename(struct kobject *, const char *new_name); |
b592fcfe EB |
78 | extern int __must_check kobject_shadow_rename(struct kobject *kobj, |
79 | struct dentry *new_parent, | |
80 | const char *new_name); | |
8a82472f | 81 | extern int __must_check kobject_move(struct kobject *, struct kobject *); |
1da177e4 | 82 | |
4a7fb636 | 83 | extern int __must_check kobject_register(struct kobject *); |
1da177e4 LT |
84 | extern void kobject_unregister(struct kobject *); |
85 | ||
86 | extern struct kobject * kobject_get(struct kobject *); | |
87 | extern void kobject_put(struct kobject *); | |
88 | ||
86406245 KS |
89 | extern struct kobject *kobject_kset_add_dir(struct kset *kset, |
90 | struct kobject *, const char *); | |
7423172a JN |
91 | extern struct kobject *kobject_add_dir(struct kobject *, const char *); |
92 | ||
fd4f2df2 | 93 | extern char * kobject_get_path(struct kobject *, gfp_t); |
1da177e4 LT |
94 | |
95 | struct kobj_type { | |
96 | void (*release)(struct kobject *); | |
97 | struct sysfs_ops * sysfs_ops; | |
98 | struct attribute ** default_attrs; | |
99 | }; | |
100 | ||
101 | ||
102 | /** | |
103 | * kset - a set of kobjects of a specific type, belonging | |
104 | * to a specific subsystem. | |
105 | * | |
106 | * All kobjects of a kset should be embedded in an identical | |
107 | * type. This type may have a descriptor, which the kset points | |
108 | * to. This allows there to exist sets of objects of the same | |
109 | * type in different subsystems. | |
110 | * | |
111 | * A subsystem does not have to be a list of only one type | |
112 | * of object; multiple ksets can belong to one subsystem. All | |
113 | * ksets of a subsystem share the subsystem's lock. | |
114 | * | |
312c004d KS |
115 | * Each kset can support specific event variables; it can |
116 | * supress the event generation or add subsystem specific | |
117 | * variables carried with the event. | |
1da177e4 | 118 | */ |
312c004d | 119 | struct kset_uevent_ops { |
1da177e4 | 120 | int (*filter)(struct kset *kset, struct kobject *kobj); |
419cab3f | 121 | const char *(*name)(struct kset *kset, struct kobject *kobj); |
312c004d | 122 | int (*uevent)(struct kset *kset, struct kobject *kobj, char **envp, |
1da177e4 LT |
123 | int num_envp, char *buffer, int buffer_size); |
124 | }; | |
125 | ||
126 | struct kset { | |
1da177e4 LT |
127 | struct kobj_type * ktype; |
128 | struct list_head list; | |
129 | spinlock_t list_lock; | |
130 | struct kobject kobj; | |
312c004d | 131 | struct kset_uevent_ops * uevent_ops; |
1da177e4 LT |
132 | }; |
133 | ||
134 | ||
135 | extern void kset_init(struct kset * k); | |
4a7fb636 AM |
136 | extern int __must_check kset_add(struct kset * k); |
137 | extern int __must_check kset_register(struct kset * k); | |
1da177e4 LT |
138 | extern void kset_unregister(struct kset * k); |
139 | ||
140 | static inline struct kset * to_kset(struct kobject * kobj) | |
141 | { | |
142 | return kobj ? container_of(kobj,struct kset,kobj) : NULL; | |
143 | } | |
144 | ||
145 | static inline struct kset * kset_get(struct kset * k) | |
146 | { | |
147 | return k ? to_kset(kobject_get(&k->kobj)) : NULL; | |
148 | } | |
149 | ||
150 | static inline void kset_put(struct kset * k) | |
151 | { | |
152 | kobject_put(&k->kobj); | |
153 | } | |
154 | ||
155 | static inline struct kobj_type * get_ktype(struct kobject * k) | |
156 | { | |
157 | if (k->kset && k->kset->ktype) | |
158 | return k->kset->ktype; | |
159 | else | |
160 | return k->ktype; | |
161 | } | |
162 | ||
163 | extern struct kobject * kset_find_obj(struct kset *, const char *); | |
164 | ||
165 | ||
166 | /** | |
167 | * Use this when initializing an embedded kset with no other | |
168 | * fields to initialize. | |
169 | */ | |
170 | #define set_kset_name(str) .kset = { .kobj = { .name = str } } | |
171 | ||
172 | ||
312c004d | 173 | #define decl_subsys(_name,_type,_uevent_ops) \ |
823bccfc GKH |
174 | struct kset _name##_subsys = { \ |
175 | .kobj = { .name = __stringify(_name) }, \ | |
176 | .ktype = _type, \ | |
177 | .uevent_ops =_uevent_ops, \ | |
1da177e4 | 178 | } |
312c004d | 179 | #define decl_subsys_name(_varname,_name,_type,_uevent_ops) \ |
823bccfc GKH |
180 | struct kset _varname##_subsys = { \ |
181 | .kobj = { .name = __stringify(_name) }, \ | |
182 | .ktype = _type, \ | |
183 | .uevent_ops =_uevent_ops, \ | |
1da177e4 LT |
184 | } |
185 | ||
186 | /* The global /sys/kernel/ subsystem for people to chain off of */ | |
823bccfc | 187 | extern struct kset kernel_subsys; |
4039483f | 188 | /* The global /sys/hypervisor/ subsystem */ |
823bccfc | 189 | extern struct kset hypervisor_subsys; |
1da177e4 LT |
190 | |
191 | /** | |
192 | * Helpers for setting the kset of registered objects. | |
193 | * Often, a registered object belongs to a kset embedded in a | |
194 | * subsystem. These do no magic, just make the resulting code | |
195 | * easier to follow. | |
196 | */ | |
197 | ||
198 | /** | |
199 | * kobj_set_kset_s(obj,subsys) - set kset for embedded kobject. | |
200 | * @obj: ptr to some object type. | |
201 | * @subsys: a subsystem object (not a ptr). | |
202 | * | |
203 | * Can be used for any object type with an embedded ->kobj. | |
204 | */ | |
205 | ||
206 | #define kobj_set_kset_s(obj,subsys) \ | |
823bccfc | 207 | (obj)->kobj.kset = &(subsys) |
1da177e4 LT |
208 | |
209 | /** | |
210 | * kset_set_kset_s(obj,subsys) - set kset for embedded kset. | |
211 | * @obj: ptr to some object type. | |
212 | * @subsys: a subsystem object (not a ptr). | |
213 | * | |
214 | * Can be used for any object type with an embedded ->kset. | |
215 | * Sets the kset of @obj's embedded kobject (via its embedded | |
216 | * kset) to @subsys.kset. This makes @obj a member of that | |
217 | * kset. | |
218 | */ | |
219 | ||
220 | #define kset_set_kset_s(obj,subsys) \ | |
823bccfc | 221 | (obj)->kset.kobj.kset = &(subsys) |
1da177e4 LT |
222 | |
223 | /** | |
224 | * subsys_set_kset(obj,subsys) - set kset for subsystem | |
225 | * @obj: ptr to some object type. | |
226 | * @subsys: a subsystem object (not a ptr). | |
227 | * | |
228 | * Can be used for any object type with an embedded ->subsys. | |
229 | * Sets the kset of @obj's kobject to @subsys.kset. This makes | |
230 | * the object a member of that kset. | |
231 | */ | |
232 | ||
233 | #define subsys_set_kset(obj,_subsys) \ | |
823bccfc | 234 | (obj)->subsys.kobj.kset = &(_subsys) |
1da177e4 | 235 | |
823bccfc GKH |
236 | extern void subsystem_init(struct kset *); |
237 | extern int __must_check subsystem_register(struct kset *); | |
238 | extern void subsystem_unregister(struct kset *); | |
1da177e4 | 239 | |
823bccfc | 240 | static inline struct kset *subsys_get(struct kset *s) |
1da177e4 | 241 | { |
823bccfc GKH |
242 | if (s) |
243 | return kset_get(s); | |
244 | return NULL; | |
1da177e4 LT |
245 | } |
246 | ||
823bccfc | 247 | static inline void subsys_put(struct kset *s) |
1da177e4 | 248 | { |
823bccfc | 249 | kset_put(s); |
1da177e4 LT |
250 | } |
251 | ||
252 | struct subsys_attribute { | |
253 | struct attribute attr; | |
823bccfc GKH |
254 | ssize_t (*show)(struct kset *, char *); |
255 | ssize_t (*store)(struct kset *, const char *, size_t); | |
1da177e4 LT |
256 | }; |
257 | ||
823bccfc | 258 | extern int __must_check subsys_create_file(struct kset *, |
4a7fb636 | 259 | struct subsys_attribute *); |
1da177e4 | 260 | |
4d17ffda | 261 | #if defined(CONFIG_HOTPLUG) |
542cfce6 AK |
262 | int kobject_uevent(struct kobject *kobj, enum kobject_action action); |
263 | int kobject_uevent_env(struct kobject *kobj, enum kobject_action action, | |
8a82472f | 264 | char *envp[]); |
0296b228 | 265 | |
312c004d | 266 | int add_uevent_var(char **envp, int num_envp, int *cur_index, |
1da177e4 LT |
267 | char *buffer, int buffer_size, int *cur_len, |
268 | const char *format, ...) | |
269 | __attribute__((format (printf, 7, 8))); | |
270 | #else | |
542cfce6 AK |
271 | static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action) |
272 | { return 0; } | |
273 | static inline int kobject_uevent_env(struct kobject *kobj, | |
8a82472f CH |
274 | enum kobject_action action, |
275 | char *envp[]) | |
542cfce6 | 276 | { return 0; } |
5f123fbd | 277 | |
312c004d | 278 | static inline int add_uevent_var(char **envp, int num_envp, int *cur_index, |
1da177e4 LT |
279 | char *buffer, int buffer_size, int *cur_len, |
280 | const char *format, ...) | |
281 | { return 0; } | |
282 | #endif | |
283 | ||
284 | #endif /* __KERNEL__ */ | |
285 | #endif /* _KOBJECT_H_ */ |