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 | |
7eff2e7a KS |
32 | #define UEVENT_NUM_ENVP 32 /* number of env pointers */ |
33 | #define UEVENT_BUFFER_SIZE 2048 /* buffer for the variables */ | |
0296b228 KS |
34 | |
35 | /* path to the userspace helper executed on an event */ | |
312c004d | 36 | extern char uevent_helper[]; |
0296b228 | 37 | |
312c004d KS |
38 | /* counter to tag the uevent, read only except for the kobject core */ |
39 | extern u64 uevent_seqnum; | |
1da177e4 | 40 | |
60a96a59 KS |
41 | /* |
42 | * The actions here must match the index to the string array | |
43 | * in lib/kobject_uevent.c | |
44 | * | |
45 | * Do not add new actions here without checking with the driver-core | |
46 | * maintainers. Action strings are not meant to express subsystem | |
47 | * or device specific properties. In most cases you want to send a | |
48 | * kobject_uevent_env(kobj, KOBJ_CHANGE, env) with additional event | |
49 | * specific variables added to the event environment. | |
50 | */ | |
0296b228 | 51 | enum kobject_action { |
60a96a59 KS |
52 | KOBJ_ADD, |
53 | KOBJ_REMOVE, | |
54 | KOBJ_CHANGE, | |
55 | KOBJ_MOVE, | |
56 | KOBJ_ONLINE, | |
57 | KOBJ_OFFLINE, | |
58 | KOBJ_MAX | |
0296b228 KS |
59 | }; |
60 | ||
ff2ee8cf GKH |
61 | /* The list of strings defining the valid kobject actions as specified above */ |
62 | extern const char *kobject_actions[]; | |
63 | ||
1da177e4 | 64 | struct kobject { |
f3b4f3c6 | 65 | const char * k_name; |
1da177e4 LT |
66 | struct kref kref; |
67 | struct list_head entry; | |
68 | struct kobject * parent; | |
69 | struct kset * kset; | |
70 | struct kobj_type * ktype; | |
608e266a | 71 | struct sysfs_dirent * sd; |
4508a7a7 | 72 | wait_queue_head_t poll; |
1da177e4 LT |
73 | }; |
74 | ||
75 | extern int kobject_set_name(struct kobject *, const char *, ...) | |
76 | __attribute__((format(printf,2,3))); | |
77 | ||
f3b4f3c6 | 78 | static inline const char * kobject_name(const struct kobject * kobj) |
1da177e4 LT |
79 | { |
80 | return kobj->k_name; | |
81 | } | |
82 | ||
83 | extern void kobject_init(struct kobject *); | |
84 | extern void kobject_cleanup(struct kobject *); | |
85 | ||
4a7fb636 | 86 | extern int __must_check kobject_add(struct kobject *); |
1da177e4 LT |
87 | extern void kobject_del(struct kobject *); |
88 | ||
4a7fb636 | 89 | extern int __must_check kobject_rename(struct kobject *, const char *new_name); |
8a82472f | 90 | extern int __must_check kobject_move(struct kobject *, struct kobject *); |
1da177e4 | 91 | |
4a7fb636 | 92 | extern int __must_check kobject_register(struct kobject *); |
1da177e4 LT |
93 | extern void kobject_unregister(struct kobject *); |
94 | ||
95 | extern struct kobject * kobject_get(struct kobject *); | |
96 | extern void kobject_put(struct kobject *); | |
97 | ||
86406245 KS |
98 | extern struct kobject *kobject_kset_add_dir(struct kset *kset, |
99 | struct kobject *, const char *); | |
7423172a JN |
100 | extern struct kobject *kobject_add_dir(struct kobject *, const char *); |
101 | ||
fd4f2df2 | 102 | extern char * kobject_get_path(struct kobject *, gfp_t); |
1da177e4 LT |
103 | |
104 | struct kobj_type { | |
105 | void (*release)(struct kobject *); | |
106 | struct sysfs_ops * sysfs_ops; | |
107 | struct attribute ** default_attrs; | |
108 | }; | |
109 | ||
7eff2e7a KS |
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 | ||
a5615648 RD |
117 | struct kset_uevent_ops { |
118 | int (*filter)(struct kset *kset, struct kobject *kobj); | |
119 | const char *(*name)(struct kset *kset, struct kobject *kobj); | |
7eff2e7a KS |
120 | int (*uevent)(struct kset *kset, struct kobject *kobj, |
121 | struct kobj_uevent_env *env); | |
a5615648 | 122 | }; |
1da177e4 | 123 | |
a5615648 RD |
124 | /* |
125 | * struct kset - a set of kobjects of a specific type, belonging | |
1da177e4 LT |
126 | * to a specific subsystem. |
127 | * | |
128 | * All kobjects of a kset should be embedded in an identical | |
129 | * type. This type may have a descriptor, which the kset points | |
130 | * to. This allows there to exist sets of objects of the same | |
131 | * type in different subsystems. | |
132 | * | |
133 | * A subsystem does not have to be a list of only one type | |
134 | * of object; multiple ksets can belong to one subsystem. All | |
135 | * ksets of a subsystem share the subsystem's lock. | |
136 | * | |
312c004d KS |
137 | * Each kset can support specific event variables; it can |
138 | * supress the event generation or add subsystem specific | |
139 | * variables carried with the event. | |
1da177e4 | 140 | */ |
1da177e4 | 141 | struct kset { |
1da177e4 LT |
142 | struct kobj_type * ktype; |
143 | struct list_head list; | |
144 | spinlock_t list_lock; | |
145 | struct kobject kobj; | |
312c004d | 146 | struct kset_uevent_ops * uevent_ops; |
1da177e4 LT |
147 | }; |
148 | ||
149 | ||
150 | extern void kset_init(struct kset * k); | |
4a7fb636 AM |
151 | extern int __must_check kset_add(struct kset * k); |
152 | extern int __must_check kset_register(struct kset * k); | |
1da177e4 LT |
153 | extern void kset_unregister(struct kset * k); |
154 | ||
155 | static inline struct kset * to_kset(struct kobject * kobj) | |
156 | { | |
157 | return kobj ? container_of(kobj,struct kset,kobj) : NULL; | |
158 | } | |
159 | ||
160 | static inline struct kset * kset_get(struct kset * k) | |
161 | { | |
162 | return k ? to_kset(kobject_get(&k->kobj)) : NULL; | |
163 | } | |
164 | ||
165 | static inline void kset_put(struct kset * k) | |
166 | { | |
167 | kobject_put(&k->kobj); | |
168 | } | |
169 | ||
170 | static inline struct kobj_type * get_ktype(struct kobject * k) | |
171 | { | |
172 | if (k->kset && k->kset->ktype) | |
173 | return k->kset->ktype; | |
174 | else | |
175 | return k->ktype; | |
176 | } | |
177 | ||
178 | extern struct kobject * kset_find_obj(struct kset *, const char *); | |
179 | ||
180 | ||
a5615648 | 181 | /* |
1da177e4 LT |
182 | * Use this when initializing an embedded kset with no other |
183 | * fields to initialize. | |
184 | */ | |
ce2c9cb0 | 185 | #define set_kset_name(str) .kset = { .kobj = { .k_name = str } } |
1da177e4 LT |
186 | |
187 | ||
312c004d | 188 | #define decl_subsys(_name,_type,_uevent_ops) \ |
823bccfc | 189 | struct kset _name##_subsys = { \ |
ce2c9cb0 | 190 | .kobj = { .k_name = __stringify(_name) }, \ |
823bccfc GKH |
191 | .ktype = _type, \ |
192 | .uevent_ops =_uevent_ops, \ | |
1da177e4 | 193 | } |
312c004d | 194 | #define decl_subsys_name(_varname,_name,_type,_uevent_ops) \ |
823bccfc | 195 | struct kset _varname##_subsys = { \ |
ce2c9cb0 | 196 | .kobj = { .k_name = __stringify(_name) }, \ |
823bccfc GKH |
197 | .ktype = _type, \ |
198 | .uevent_ops =_uevent_ops, \ | |
1da177e4 LT |
199 | } |
200 | ||
201 | /* The global /sys/kernel/ subsystem for people to chain off of */ | |
823bccfc | 202 | extern struct kset kernel_subsys; |
4039483f | 203 | /* The global /sys/hypervisor/ subsystem */ |
823bccfc | 204 | extern struct kset hypervisor_subsys; |
1da177e4 | 205 | |
a5615648 | 206 | /* |
1da177e4 LT |
207 | * Helpers for setting the kset of registered objects. |
208 | * Often, a registered object belongs to a kset embedded in a | |
209 | * subsystem. These do no magic, just make the resulting code | |
210 | * easier to follow. | |
211 | */ | |
212 | ||
213 | /** | |
214 | * kobj_set_kset_s(obj,subsys) - set kset for embedded kobject. | |
215 | * @obj: ptr to some object type. | |
216 | * @subsys: a subsystem object (not a ptr). | |
217 | * | |
218 | * Can be used for any object type with an embedded ->kobj. | |
219 | */ | |
220 | ||
221 | #define kobj_set_kset_s(obj,subsys) \ | |
823bccfc | 222 | (obj)->kobj.kset = &(subsys) |
1da177e4 | 223 | |
823bccfc GKH |
224 | extern void subsystem_init(struct kset *); |
225 | extern int __must_check subsystem_register(struct kset *); | |
226 | extern void subsystem_unregister(struct kset *); | |
1da177e4 | 227 | |
1da177e4 LT |
228 | struct subsys_attribute { |
229 | struct attribute attr; | |
823bccfc GKH |
230 | ssize_t (*show)(struct kset *, char *); |
231 | ssize_t (*store)(struct kset *, const char *, size_t); | |
1da177e4 LT |
232 | }; |
233 | ||
823bccfc | 234 | extern int __must_check subsys_create_file(struct kset *, |
4a7fb636 | 235 | struct subsys_attribute *); |
1da177e4 | 236 | |
4d17ffda | 237 | #if defined(CONFIG_HOTPLUG) |
542cfce6 AK |
238 | int kobject_uevent(struct kobject *kobj, enum kobject_action action); |
239 | int kobject_uevent_env(struct kobject *kobj, enum kobject_action action, | |
8a82472f | 240 | char *envp[]); |
0296b228 | 241 | |
7eff2e7a KS |
242 | int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...) |
243 | __attribute__((format (printf, 2, 3))); | |
1da177e4 | 244 | #else |
542cfce6 AK |
245 | static inline int kobject_uevent(struct kobject *kobj, enum kobject_action action) |
246 | { return 0; } | |
247 | static inline int kobject_uevent_env(struct kobject *kobj, | |
8a82472f CH |
248 | enum kobject_action action, |
249 | char *envp[]) | |
542cfce6 | 250 | { return 0; } |
5f123fbd | 251 | |
7eff2e7a | 252 | static inline int add_uevent_var(struct kobj_uevent_env *env, const char *format, ...) |
1da177e4 LT |
253 | { return 0; } |
254 | #endif | |
255 | ||
256 | #endif /* __KERNEL__ */ | |
257 | #endif /* _KOBJECT_H_ */ |