Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * kobject.c - library routines for handling generic kernel objects | |
3 | * | |
4 | * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org> | |
f0e7e1bd GKH |
5 | * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com> |
6 | * Copyright (c) 2006-2007 Novell Inc. | |
1da177e4 LT |
7 | * |
8 | * This file is released under the GPLv2. | |
9 | * | |
10 | * | |
11 | * Please see the file Documentation/kobject.txt for critical information | |
12 | * about using the kobject interface. | |
13 | */ | |
14 | ||
15 | #include <linux/kobject.h> | |
16 | #include <linux/string.h> | |
17 | #include <linux/module.h> | |
18 | #include <linux/stat.h> | |
4e57b681 | 19 | #include <linux/slab.h> |
1da177e4 | 20 | |
e374a2bf GKH |
21 | /* |
22 | * populate_dir - populate directory with attributes. | |
23 | * @kobj: object we're working on. | |
1da177e4 | 24 | * |
e374a2bf GKH |
25 | * Most subsystems have a set of default attributes that are associated |
26 | * with an object that registers with them. This is a helper called during | |
27 | * object registration that loops through the default attributes of the | |
28 | * subsystem and creates attributes files for them in sysfs. | |
1da177e4 | 29 | */ |
e374a2bf | 30 | static int populate_dir(struct kobject *kobj) |
1da177e4 | 31 | { |
e374a2bf GKH |
32 | struct kobj_type *t = get_ktype(kobj); |
33 | struct attribute *attr; | |
1da177e4 LT |
34 | int error = 0; |
35 | int i; | |
e374a2bf | 36 | |
1da177e4 LT |
37 | if (t && t->default_attrs) { |
38 | for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) { | |
e374a2bf GKH |
39 | error = sysfs_create_file(kobj, attr); |
40 | if (error) | |
1da177e4 LT |
41 | break; |
42 | } | |
43 | } | |
44 | return error; | |
45 | } | |
46 | ||
e374a2bf | 47 | static int create_dir(struct kobject *kobj) |
1da177e4 LT |
48 | { |
49 | int error = 0; | |
50 | if (kobject_name(kobj)) { | |
90bc6135 | 51 | error = sysfs_create_dir(kobj); |
1da177e4 | 52 | if (!error) { |
e374a2bf GKH |
53 | error = populate_dir(kobj); |
54 | if (error) | |
1da177e4 LT |
55 | sysfs_remove_dir(kobj); |
56 | } | |
57 | } | |
58 | return error; | |
59 | } | |
60 | ||
1da177e4 LT |
61 | static int get_kobj_path_length(struct kobject *kobj) |
62 | { | |
63 | int length = 1; | |
e374a2bf | 64 | struct kobject *parent = kobj; |
1da177e4 | 65 | |
e374a2bf | 66 | /* walk up the ancestors until we hit the one pointing to the |
1da177e4 LT |
67 | * root. |
68 | * Add 1 to strlen for leading '/' of each level. | |
69 | */ | |
70 | do { | |
b365b3da CE |
71 | if (kobject_name(parent) == NULL) |
72 | return 0; | |
1da177e4 LT |
73 | length += strlen(kobject_name(parent)) + 1; |
74 | parent = parent->parent; | |
75 | } while (parent); | |
76 | return length; | |
77 | } | |
78 | ||
79 | static void fill_kobj_path(struct kobject *kobj, char *path, int length) | |
80 | { | |
e374a2bf | 81 | struct kobject *parent; |
1da177e4 LT |
82 | |
83 | --length; | |
84 | for (parent = kobj; parent; parent = parent->parent) { | |
85 | int cur = strlen(kobject_name(parent)); | |
86 | /* back up enough to print this name with '/' */ | |
87 | length -= cur; | |
e374a2bf | 88 | strncpy(path + length, kobject_name(parent), cur); |
1da177e4 LT |
89 | *(path + --length) = '/'; |
90 | } | |
91 | ||
9f66fa2a | 92 | pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj), |
810304db | 93 | kobj, __func__, path); |
1da177e4 LT |
94 | } |
95 | ||
96 | /** | |
72fd4a35 | 97 | * kobject_get_path - generate and return the path associated with a given kobj and kset pair. |
1da177e4 LT |
98 | * |
99 | * @kobj: kobject in question, with which to build the path | |
100 | * @gfp_mask: the allocation type used to allocate the path | |
72fd4a35 RD |
101 | * |
102 | * The result must be freed by the caller with kfree(). | |
1da177e4 | 103 | */ |
fd4f2df2 | 104 | char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask) |
1da177e4 LT |
105 | { |
106 | char *path; | |
107 | int len; | |
108 | ||
109 | len = get_kobj_path_length(kobj); | |
b365b3da CE |
110 | if (len == 0) |
111 | return NULL; | |
4668edc3 | 112 | path = kzalloc(len, gfp_mask); |
1da177e4 LT |
113 | if (!path) |
114 | return NULL; | |
1da177e4 LT |
115 | fill_kobj_path(kobj, path, len); |
116 | ||
117 | return path; | |
118 | } | |
80fc9f53 | 119 | EXPORT_SYMBOL_GPL(kobject_get_path); |
1da177e4 | 120 | |
0f4dafc0 KS |
121 | /* add the kobject to its kset's list */ |
122 | static void kobj_kset_join(struct kobject *kobj) | |
1da177e4 | 123 | { |
0f4dafc0 | 124 | if (!kobj->kset) |
31b9025a | 125 | return; |
0f4dafc0 KS |
126 | |
127 | kset_get(kobj->kset); | |
128 | spin_lock(&kobj->kset->list_lock); | |
129 | list_add_tail(&kobj->entry, &kobj->kset->list); | |
130 | spin_unlock(&kobj->kset->list_lock); | |
1da177e4 LT |
131 | } |
132 | ||
0f4dafc0 KS |
133 | /* remove the kobject from its kset's list */ |
134 | static void kobj_kset_leave(struct kobject *kobj) | |
135 | { | |
136 | if (!kobj->kset) | |
137 | return; | |
1da177e4 | 138 | |
0f4dafc0 KS |
139 | spin_lock(&kobj->kset->list_lock); |
140 | list_del_init(&kobj->entry); | |
141 | spin_unlock(&kobj->kset->list_lock); | |
142 | kset_put(kobj->kset); | |
143 | } | |
1da177e4 | 144 | |
e374a2bf | 145 | static void kobject_init_internal(struct kobject *kobj) |
1da177e4 | 146 | { |
0f4dafc0 KS |
147 | if (!kobj) |
148 | return; | |
149 | kref_init(&kobj->kref); | |
150 | INIT_LIST_HEAD(&kobj->entry); | |
a4573c48 GKH |
151 | kobj->state_in_sysfs = 0; |
152 | kobj->state_add_uevent_sent = 0; | |
153 | kobj->state_remove_uevent_sent = 0; | |
154 | kobj->state_initialized = 1; | |
1da177e4 LT |
155 | } |
156 | ||
0f4dafc0 | 157 | |
9e7bbccd | 158 | static int kobject_add_internal(struct kobject *kobj) |
1da177e4 LT |
159 | { |
160 | int error = 0; | |
e374a2bf | 161 | struct kobject *parent; |
1da177e4 | 162 | |
0f4dafc0 | 163 | if (!kobj) |
1da177e4 | 164 | return -ENOENT; |
0f4dafc0 | 165 | |
af5ca3f4 | 166 | if (!kobj->name || !kobj->name[0]) { |
0f4dafc0 | 167 | pr_debug("kobject: (%p): attempted to be registered with empty " |
9f66fa2a | 168 | "name!\n", kobj); |
c171fef5 GKH |
169 | WARN_ON(1); |
170 | return -EINVAL; | |
171 | } | |
1da177e4 | 172 | |
0f4dafc0 | 173 | parent = kobject_get(kobj->parent); |
1da177e4 | 174 | |
0f4dafc0 | 175 | /* join kset if set, use it as parent if we do not already have one */ |
1da177e4 | 176 | if (kobj->kset) { |
0f4dafc0 | 177 | if (!parent) |
1da177e4 | 178 | parent = kobject_get(&kobj->kset->kobj); |
0f4dafc0 | 179 | kobj_kset_join(kobj); |
460f7e9a | 180 | kobj->parent = parent; |
1da177e4 | 181 | } |
1da177e4 | 182 | |
0f4dafc0 | 183 | pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n", |
810304db | 184 | kobject_name(kobj), kobj, __func__, |
0f4dafc0 | 185 | parent ? kobject_name(parent) : "<NULL>", |
e374a2bf | 186 | kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>"); |
0f4dafc0 | 187 | |
90bc6135 | 188 | error = create_dir(kobj); |
1da177e4 | 189 | if (error) { |
0f4dafc0 KS |
190 | kobj_kset_leave(kobj); |
191 | kobject_put(parent); | |
192 | kobj->parent = NULL; | |
dcd0da00 GKH |
193 | |
194 | /* be noisy on error issues */ | |
195 | if (error == -EEXIST) | |
9e7bbccd | 196 | printk(KERN_ERR "%s failed for %s with " |
5c73a3fb GKH |
197 | "-EEXIST, don't try to register things with " |
198 | "the same name in the same directory.\n", | |
810304db | 199 | __func__, kobject_name(kobj)); |
dcd0da00 | 200 | else |
9e7bbccd | 201 | printk(KERN_ERR "%s failed for %s (%d)\n", |
810304db | 202 | __func__, kobject_name(kobj), error); |
5c73a3fb | 203 | dump_stack(); |
0f4dafc0 KS |
204 | } else |
205 | kobj->state_in_sysfs = 1; | |
1da177e4 LT |
206 | |
207 | return error; | |
208 | } | |
209 | ||
663a4743 GKH |
210 | /** |
211 | * kobject_set_name_vargs - Set the name of an kobject | |
212 | * @kobj: struct kobject to set the name of | |
213 | * @fmt: format string used to build the name | |
214 | * @vargs: vargs to format the string. | |
215 | */ | |
216 | static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, | |
217 | va_list vargs) | |
218 | { | |
9f255651 KS |
219 | const char *old_name = kobj->name; |
220 | char *s; | |
663a4743 | 221 | |
a4ca6617 KS |
222 | kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs); |
223 | if (!kobj->name) | |
224 | return -ENOMEM; | |
663a4743 | 225 | |
9f255651 KS |
226 | /* ewww... some of these buggers have '/' in the name ... */ |
227 | s = strchr(kobj->name, '/'); | |
228 | if (s) | |
229 | s[0] = '!'; | |
230 | ||
231 | kfree(old_name); | |
663a4743 GKH |
232 | return 0; |
233 | } | |
1da177e4 LT |
234 | |
235 | /** | |
8c4606b1 | 236 | * kobject_set_name - Set the name of a kobject |
663a4743 | 237 | * @kobj: struct kobject to set the name of |
8c4606b1 | 238 | * @fmt: format string used to build the name |
1da177e4 | 239 | * |
8c4606b1 GKH |
240 | * This sets the name of the kobject. If you have already added the |
241 | * kobject to the system, you must call kobject_rename() in order to | |
242 | * change the name of the kobject. | |
1da177e4 | 243 | */ |
663a4743 | 244 | int kobject_set_name(struct kobject *kobj, const char *fmt, ...) |
1da177e4 | 245 | { |
a4ca6617 | 246 | va_list vargs; |
663a4743 | 247 | int retval; |
1da177e4 | 248 | |
a4ca6617 KS |
249 | va_start(vargs, fmt); |
250 | retval = kobject_set_name_vargs(kobj, fmt, vargs); | |
251 | va_end(vargs); | |
1da177e4 | 252 | |
663a4743 | 253 | return retval; |
1da177e4 | 254 | } |
1da177e4 LT |
255 | EXPORT_SYMBOL(kobject_set_name); |
256 | ||
e86000d0 | 257 | /** |
f9cb074b | 258 | * kobject_init - initialize a kobject structure |
e86000d0 GKH |
259 | * @kobj: pointer to the kobject to initialize |
260 | * @ktype: pointer to the ktype for this kobject. | |
261 | * | |
262 | * This function will properly initialize a kobject such that it can then | |
263 | * be passed to the kobject_add() call. | |
264 | * | |
265 | * After this function is called, the kobject MUST be cleaned up by a call | |
266 | * to kobject_put(), not by a call to kfree directly to ensure that all of | |
267 | * the memory is cleaned up properly. | |
268 | */ | |
f9cb074b | 269 | void kobject_init(struct kobject *kobj, struct kobj_type *ktype) |
e86000d0 GKH |
270 | { |
271 | char *err_str; | |
272 | ||
273 | if (!kobj) { | |
274 | err_str = "invalid kobject pointer!"; | |
275 | goto error; | |
276 | } | |
277 | if (!ktype) { | |
278 | err_str = "must have a ktype to be initialized properly!\n"; | |
279 | goto error; | |
280 | } | |
0f4dafc0 | 281 | if (kobj->state_initialized) { |
e86000d0 | 282 | /* do not error out as sometimes we can recover */ |
0f4dafc0 KS |
283 | printk(KERN_ERR "kobject (%p): tried to init an initialized " |
284 | "object, something is seriously wrong.\n", kobj); | |
e86000d0 GKH |
285 | dump_stack(); |
286 | } | |
287 | ||
a4573c48 | 288 | kobject_init_internal(kobj); |
e86000d0 GKH |
289 | kobj->ktype = ktype; |
290 | return; | |
291 | ||
292 | error: | |
0f4dafc0 | 293 | printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str); |
e86000d0 GKH |
294 | dump_stack(); |
295 | } | |
f9cb074b | 296 | EXPORT_SYMBOL(kobject_init); |
e86000d0 | 297 | |
244f6cee GKH |
298 | static int kobject_add_varg(struct kobject *kobj, struct kobject *parent, |
299 | const char *fmt, va_list vargs) | |
300 | { | |
244f6cee GKH |
301 | int retval; |
302 | ||
a4ca6617 | 303 | retval = kobject_set_name_vargs(kobj, fmt, vargs); |
244f6cee GKH |
304 | if (retval) { |
305 | printk(KERN_ERR "kobject: can not set name properly!\n"); | |
306 | return retval; | |
307 | } | |
308 | kobj->parent = parent; | |
9e7bbccd | 309 | return kobject_add_internal(kobj); |
244f6cee GKH |
310 | } |
311 | ||
312 | /** | |
b2d6db58 | 313 | * kobject_add - the main kobject add function |
244f6cee GKH |
314 | * @kobj: the kobject to add |
315 | * @parent: pointer to the parent of the kobject. | |
316 | * @fmt: format to name the kobject with. | |
317 | * | |
318 | * The kobject name is set and added to the kobject hierarchy in this | |
319 | * function. | |
320 | * | |
321 | * If @parent is set, then the parent of the @kobj will be set to it. | |
322 | * If @parent is NULL, then the parent of the @kobj will be set to the | |
323 | * kobject associted with the kset assigned to this kobject. If no kset | |
324 | * is assigned to the kobject, then the kobject will be located in the | |
325 | * root of the sysfs tree. | |
326 | * | |
327 | * If this function returns an error, kobject_put() must be called to | |
328 | * properly clean up the memory associated with the object. | |
244f6cee GKH |
329 | * Under no instance should the kobject that is passed to this function |
330 | * be directly freed with a call to kfree(), that can leak memory. | |
331 | * | |
0f4dafc0 | 332 | * Note, no "add" uevent will be created with this call, the caller should set |
244f6cee GKH |
333 | * up all of the necessary sysfs files for the object and then call |
334 | * kobject_uevent() with the UEVENT_ADD parameter to ensure that | |
335 | * userspace is properly notified of this kobject's creation. | |
336 | */ | |
b2d6db58 GKH |
337 | int kobject_add(struct kobject *kobj, struct kobject *parent, |
338 | const char *fmt, ...) | |
244f6cee GKH |
339 | { |
340 | va_list args; | |
341 | int retval; | |
342 | ||
343 | if (!kobj) | |
344 | return -EINVAL; | |
345 | ||
0f4dafc0 KS |
346 | if (!kobj->state_initialized) { |
347 | printk(KERN_ERR "kobject '%s' (%p): tried to add an " | |
348 | "uninitialized object, something is seriously wrong.\n", | |
349 | kobject_name(kobj), kobj); | |
350 | dump_stack(); | |
351 | return -EINVAL; | |
352 | } | |
244f6cee GKH |
353 | va_start(args, fmt); |
354 | retval = kobject_add_varg(kobj, parent, fmt, args); | |
355 | va_end(args); | |
356 | ||
357 | return retval; | |
358 | } | |
b2d6db58 | 359 | EXPORT_SYMBOL(kobject_add); |
244f6cee | 360 | |
c11c4154 GKH |
361 | /** |
362 | * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy | |
363 | * @kobj: pointer to the kobject to initialize | |
364 | * @ktype: pointer to the ktype for this kobject. | |
365 | * @parent: pointer to the parent of this kobject. | |
366 | * @fmt: the name of the kobject. | |
367 | * | |
f9cb074b | 368 | * This function combines the call to kobject_init() and |
b2d6db58 GKH |
369 | * kobject_add(). The same type of error handling after a call to |
370 | * kobject_add() and kobject lifetime rules are the same here. | |
c11c4154 GKH |
371 | */ |
372 | int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype, | |
373 | struct kobject *parent, const char *fmt, ...) | |
374 | { | |
375 | va_list args; | |
376 | int retval; | |
377 | ||
f9cb074b | 378 | kobject_init(kobj, ktype); |
c11c4154 GKH |
379 | |
380 | va_start(args, fmt); | |
381 | retval = kobject_add_varg(kobj, parent, fmt, args); | |
382 | va_end(args); | |
383 | ||
384 | return retval; | |
385 | } | |
386 | EXPORT_SYMBOL_GPL(kobject_init_and_add); | |
387 | ||
1da177e4 | 388 | /** |
e374a2bf GKH |
389 | * kobject_rename - change the name of an object |
390 | * @kobj: object in question. | |
391 | * @new_name: object's new name | |
1da177e4 | 392 | */ |
e374a2bf | 393 | int kobject_rename(struct kobject *kobj, const char *new_name) |
1da177e4 LT |
394 | { |
395 | int error = 0; | |
ca2f37db JT |
396 | const char *devpath = NULL; |
397 | char *devpath_string = NULL; | |
398 | char *envp[2]; | |
1da177e4 LT |
399 | |
400 | kobj = kobject_get(kobj); | |
401 | if (!kobj) | |
402 | return -EINVAL; | |
b592fcfe EB |
403 | if (!kobj->parent) |
404 | return -EINVAL; | |
ca2f37db | 405 | |
34358c26 GKH |
406 | /* see if this name is already in use */ |
407 | if (kobj->kset) { | |
408 | struct kobject *temp_kobj; | |
409 | temp_kobj = kset_find_obj(kobj->kset, new_name); | |
410 | if (temp_kobj) { | |
71409a49 JB |
411 | printk(KERN_WARNING "kobject '%s' cannot be renamed " |
412 | "to '%s' as '%s' is already in existence.\n", | |
34358c26 GKH |
413 | kobject_name(kobj), new_name, new_name); |
414 | kobject_put(temp_kobj); | |
415 | return -EINVAL; | |
416 | } | |
417 | } | |
418 | ||
ca2f37db JT |
419 | devpath = kobject_get_path(kobj, GFP_KERNEL); |
420 | if (!devpath) { | |
421 | error = -ENOMEM; | |
422 | goto out; | |
423 | } | |
424 | devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL); | |
425 | if (!devpath_string) { | |
426 | error = -ENOMEM; | |
427 | goto out; | |
428 | } | |
429 | sprintf(devpath_string, "DEVPATH_OLD=%s", devpath); | |
430 | envp[0] = devpath_string; | |
431 | envp[1] = NULL; | |
ca2f37db | 432 | |
90bc6135 | 433 | error = sysfs_rename_dir(kobj, new_name); |
ca2f37db JT |
434 | |
435 | /* This function is mostly/only used for network interface. | |
436 | * Some hotplug package track interfaces by their name and | |
437 | * therefore want to know when the name is changed by the user. */ | |
438 | if (!error) | |
439 | kobject_uevent_env(kobj, KOBJ_MOVE, envp); | |
440 | ||
441 | out: | |
442 | kfree(devpath_string); | |
443 | kfree(devpath); | |
b592fcfe EB |
444 | kobject_put(kobj); |
445 | ||
446 | return error; | |
447 | } | |
8344b568 | 448 | EXPORT_SYMBOL_GPL(kobject_rename); |
b592fcfe | 449 | |
8a82472f | 450 | /** |
e374a2bf GKH |
451 | * kobject_move - move object to another parent |
452 | * @kobj: object in question. | |
453 | * @new_parent: object's new parent (can be NULL) | |
8a82472f | 454 | */ |
8a82472f CH |
455 | int kobject_move(struct kobject *kobj, struct kobject *new_parent) |
456 | { | |
457 | int error; | |
458 | struct kobject *old_parent; | |
459 | const char *devpath = NULL; | |
460 | char *devpath_string = NULL; | |
461 | char *envp[2]; | |
462 | ||
463 | kobj = kobject_get(kobj); | |
464 | if (!kobj) | |
465 | return -EINVAL; | |
466 | new_parent = kobject_get(new_parent); | |
467 | if (!new_parent) { | |
c744aeae CH |
468 | if (kobj->kset) |
469 | new_parent = kobject_get(&kobj->kset->kobj); | |
8a82472f CH |
470 | } |
471 | /* old object path */ | |
472 | devpath = kobject_get_path(kobj, GFP_KERNEL); | |
473 | if (!devpath) { | |
474 | error = -ENOMEM; | |
475 | goto out; | |
476 | } | |
477 | devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL); | |
478 | if (!devpath_string) { | |
479 | error = -ENOMEM; | |
480 | goto out; | |
481 | } | |
482 | sprintf(devpath_string, "DEVPATH_OLD=%s", devpath); | |
483 | envp[0] = devpath_string; | |
484 | envp[1] = NULL; | |
485 | error = sysfs_move_dir(kobj, new_parent); | |
486 | if (error) | |
487 | goto out; | |
488 | old_parent = kobj->parent; | |
489 | kobj->parent = new_parent; | |
9e993efb | 490 | new_parent = NULL; |
8a82472f CH |
491 | kobject_put(old_parent); |
492 | kobject_uevent_env(kobj, KOBJ_MOVE, envp); | |
493 | out: | |
9e993efb | 494 | kobject_put(new_parent); |
8a82472f CH |
495 | kobject_put(kobj); |
496 | kfree(devpath_string); | |
497 | kfree(devpath); | |
498 | return error; | |
499 | } | |
500 | ||
1da177e4 | 501 | /** |
e374a2bf GKH |
502 | * kobject_del - unlink kobject from hierarchy. |
503 | * @kobj: object. | |
1da177e4 | 504 | */ |
e374a2bf | 505 | void kobject_del(struct kobject *kobj) |
1da177e4 | 506 | { |
31b9025a GKH |
507 | if (!kobj) |
508 | return; | |
0f4dafc0 | 509 | |
1da177e4 | 510 | sysfs_remove_dir(kobj); |
0f4dafc0 KS |
511 | kobj->state_in_sysfs = 0; |
512 | kobj_kset_leave(kobj); | |
513 | kobject_put(kobj->parent); | |
514 | kobj->parent = NULL; | |
1da177e4 LT |
515 | } |
516 | ||
1da177e4 | 517 | /** |
e374a2bf GKH |
518 | * kobject_get - increment refcount for object. |
519 | * @kobj: object. | |
1da177e4 | 520 | */ |
e374a2bf | 521 | struct kobject *kobject_get(struct kobject *kobj) |
1da177e4 LT |
522 | { |
523 | if (kobj) | |
524 | kref_get(&kobj->kref); | |
525 | return kobj; | |
526 | } | |
527 | ||
18041f47 GKH |
528 | /* |
529 | * kobject_cleanup - free kobject resources. | |
530 | * @kobj: object to cleanup | |
1da177e4 | 531 | */ |
18041f47 | 532 | static void kobject_cleanup(struct kobject *kobj) |
1da177e4 | 533 | { |
0f4dafc0 | 534 | struct kobj_type *t = get_ktype(kobj); |
af5ca3f4 | 535 | const char *name = kobj->name; |
1da177e4 | 536 | |
9f66fa2a | 537 | pr_debug("kobject: '%s' (%p): %s\n", |
810304db | 538 | kobject_name(kobj), kobj, __func__); |
0f4dafc0 KS |
539 | |
540 | if (t && !t->release) | |
541 | pr_debug("kobject: '%s' (%p): does not have a release() " | |
542 | "function, it is broken and must be fixed.\n", | |
543 | kobject_name(kobj), kobj); | |
544 | ||
545 | /* send "remove" if the caller did not do it but sent "add" */ | |
546 | if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) { | |
547 | pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n", | |
548 | kobject_name(kobj), kobj); | |
549 | kobject_uevent(kobj, KOBJ_REMOVE); | |
550 | } | |
551 | ||
552 | /* remove from sysfs if the caller did not do it */ | |
553 | if (kobj->state_in_sysfs) { | |
554 | pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n", | |
555 | kobject_name(kobj), kobj); | |
556 | kobject_del(kobj); | |
557 | } | |
558 | ||
ce2c9cb0 | 559 | if (t && t->release) { |
0f4dafc0 KS |
560 | pr_debug("kobject: '%s' (%p): calling ktype release\n", |
561 | kobject_name(kobj), kobj); | |
1da177e4 | 562 | t->release(kobj); |
0f4dafc0 KS |
563 | } |
564 | ||
565 | /* free name if we allocated it */ | |
af5ca3f4 | 566 | if (name) { |
0f4dafc0 | 567 | pr_debug("kobject: '%s': free name\n", name); |
ce2c9cb0 GKH |
568 | kfree(name); |
569 | } | |
1da177e4 LT |
570 | } |
571 | ||
572 | static void kobject_release(struct kref *kref) | |
573 | { | |
574 | kobject_cleanup(container_of(kref, struct kobject, kref)); | |
575 | } | |
576 | ||
577 | /** | |
e374a2bf GKH |
578 | * kobject_put - decrement refcount for object. |
579 | * @kobj: object. | |
1da177e4 | 580 | * |
e374a2bf | 581 | * Decrement the refcount, and if 0, call kobject_cleanup(). |
1da177e4 | 582 | */ |
e374a2bf | 583 | void kobject_put(struct kobject *kobj) |
1da177e4 | 584 | { |
c1ebdae5 GKH |
585 | if (kobj) { |
586 | if (!kobj->state_initialized) { | |
587 | printk(KERN_WARNING "kobject: '%s' (%p): is not " | |
588 | "initialized, yet kobject_put() is being " | |
589 | "called.\n", kobject_name(kobj), kobj); | |
590 | WARN_ON(1); | |
591 | } | |
1da177e4 | 592 | kref_put(&kobj->kref, kobject_release); |
c1ebdae5 | 593 | } |
1da177e4 LT |
594 | } |
595 | ||
3f9e3ee9 | 596 | static void dynamic_kobj_release(struct kobject *kobj) |
7423172a | 597 | { |
810304db | 598 | pr_debug("kobject: (%p): %s\n", kobj, __func__); |
7423172a JN |
599 | kfree(kobj); |
600 | } | |
601 | ||
3f9e3ee9 | 602 | static struct kobj_type dynamic_kobj_ktype = { |
386f275f KS |
603 | .release = dynamic_kobj_release, |
604 | .sysfs_ops = &kobj_sysfs_ops, | |
7423172a JN |
605 | }; |
606 | ||
43968d2f | 607 | /** |
3f9e3ee9 GKH |
608 | * kobject_create - create a struct kobject dynamically |
609 | * | |
610 | * This function creates a kobject structure dynamically and sets it up | |
611 | * to be a "dynamic" kobject with a default release function set up. | |
612 | * | |
613 | * If the kobject was not able to be created, NULL will be returned. | |
43968d2f | 614 | * The kobject structure returned from here must be cleaned up with a |
f9cb074b | 615 | * call to kobject_put() and not kfree(), as kobject_init() has |
43968d2f | 616 | * already been called on this structure. |
3f9e3ee9 | 617 | */ |
43968d2f | 618 | struct kobject *kobject_create(void) |
3f9e3ee9 GKH |
619 | { |
620 | struct kobject *kobj; | |
621 | ||
622 | kobj = kzalloc(sizeof(*kobj), GFP_KERNEL); | |
623 | if (!kobj) | |
624 | return NULL; | |
625 | ||
f9cb074b | 626 | kobject_init(kobj, &dynamic_kobj_ktype); |
3f9e3ee9 GKH |
627 | return kobj; |
628 | } | |
629 | ||
630 | /** | |
631 | * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs | |
632 | * | |
633 | * @name: the name for the kset | |
634 | * @parent: the parent kobject of this kobject, if any. | |
635 | * | |
f70701a3 | 636 | * This function creates a kobject structure dynamically and registers it |
3f9e3ee9 | 637 | * with sysfs. When you are finished with this structure, call |
78a2d906 | 638 | * kobject_put() and the structure will be dynamically freed when |
3f9e3ee9 GKH |
639 | * it is no longer being used. |
640 | * | |
641 | * If the kobject was not able to be created, NULL will be returned. | |
642 | */ | |
643 | struct kobject *kobject_create_and_add(const char *name, struct kobject *parent) | |
644 | { | |
645 | struct kobject *kobj; | |
646 | int retval; | |
647 | ||
648 | kobj = kobject_create(); | |
649 | if (!kobj) | |
650 | return NULL; | |
651 | ||
b2d6db58 | 652 | retval = kobject_add(kobj, parent, "%s", name); |
3f9e3ee9 GKH |
653 | if (retval) { |
654 | printk(KERN_WARNING "%s: kobject_add error: %d\n", | |
810304db | 655 | __func__, retval); |
3f9e3ee9 GKH |
656 | kobject_put(kobj); |
657 | kobj = NULL; | |
658 | } | |
659 | return kobj; | |
660 | } | |
661 | EXPORT_SYMBOL_GPL(kobject_create_and_add); | |
662 | ||
1da177e4 | 663 | /** |
e374a2bf GKH |
664 | * kset_init - initialize a kset for use |
665 | * @k: kset | |
1da177e4 | 666 | */ |
e374a2bf | 667 | void kset_init(struct kset *k) |
1da177e4 | 668 | { |
e1543ddf | 669 | kobject_init_internal(&k->kobj); |
1da177e4 LT |
670 | INIT_LIST_HEAD(&k->list); |
671 | spin_lock_init(&k->list_lock); | |
672 | } | |
673 | ||
23b5212c KS |
674 | /* default kobject attribute operations */ |
675 | static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr, | |
676 | char *buf) | |
677 | { | |
678 | struct kobj_attribute *kattr; | |
679 | ssize_t ret = -EIO; | |
680 | ||
681 | kattr = container_of(attr, struct kobj_attribute, attr); | |
682 | if (kattr->show) | |
683 | ret = kattr->show(kobj, kattr, buf); | |
684 | return ret; | |
685 | } | |
686 | ||
687 | static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr, | |
688 | const char *buf, size_t count) | |
689 | { | |
690 | struct kobj_attribute *kattr; | |
691 | ssize_t ret = -EIO; | |
692 | ||
693 | kattr = container_of(attr, struct kobj_attribute, attr); | |
694 | if (kattr->store) | |
695 | ret = kattr->store(kobj, kattr, buf, count); | |
696 | return ret; | |
697 | } | |
698 | ||
699 | struct sysfs_ops kobj_sysfs_ops = { | |
700 | .show = kobj_attr_show, | |
701 | .store = kobj_attr_store, | |
702 | }; | |
1da177e4 | 703 | |
1da177e4 | 704 | /** |
e374a2bf GKH |
705 | * kset_register - initialize and add a kset. |
706 | * @k: kset. | |
1da177e4 | 707 | */ |
e374a2bf | 708 | int kset_register(struct kset *k) |
1da177e4 | 709 | { |
80f03e34 KS |
710 | int err; |
711 | ||
31b9025a GKH |
712 | if (!k) |
713 | return -EINVAL; | |
80f03e34 | 714 | |
1da177e4 | 715 | kset_init(k); |
12e339ac | 716 | err = kobject_add_internal(&k->kobj); |
80f03e34 KS |
717 | if (err) |
718 | return err; | |
719 | kobject_uevent(&k->kobj, KOBJ_ADD); | |
720 | return 0; | |
1da177e4 LT |
721 | } |
722 | ||
1da177e4 | 723 | /** |
e374a2bf GKH |
724 | * kset_unregister - remove a kset. |
725 | * @k: kset. | |
1da177e4 | 726 | */ |
e374a2bf | 727 | void kset_unregister(struct kset *k) |
1da177e4 | 728 | { |
31b9025a GKH |
729 | if (!k) |
730 | return; | |
78a2d906 | 731 | kobject_put(&k->kobj); |
1da177e4 LT |
732 | } |
733 | ||
1da177e4 | 734 | /** |
e374a2bf GKH |
735 | * kset_find_obj - search for object in kset. |
736 | * @kset: kset we're looking in. | |
737 | * @name: object's name. | |
1da177e4 | 738 | * |
e374a2bf GKH |
739 | * Lock kset via @kset->subsys, and iterate over @kset->list, |
740 | * looking for a matching kobject. If matching object is found | |
741 | * take a reference and return the object. | |
1da177e4 | 742 | */ |
e374a2bf | 743 | struct kobject *kset_find_obj(struct kset *kset, const char *name) |
1da177e4 | 744 | { |
c6a2a3dc | 745 | struct kobject *k; |
e374a2bf | 746 | struct kobject *ret = NULL; |
1da177e4 LT |
747 | |
748 | spin_lock(&kset->list_lock); | |
c6a2a3dc | 749 | list_for_each_entry(k, &kset->list, entry) { |
e374a2bf | 750 | if (kobject_name(k) && !strcmp(kobject_name(k), name)) { |
1da177e4 LT |
751 | ret = kobject_get(k); |
752 | break; | |
753 | } | |
754 | } | |
755 | spin_unlock(&kset->list_lock); | |
756 | return ret; | |
757 | } | |
758 | ||
b727c702 GKH |
759 | static void kset_release(struct kobject *kobj) |
760 | { | |
761 | struct kset *kset = container_of(kobj, struct kset, kobj); | |
9f66fa2a | 762 | pr_debug("kobject: '%s' (%p): %s\n", |
810304db | 763 | kobject_name(kobj), kobj, __func__); |
b727c702 GKH |
764 | kfree(kset); |
765 | } | |
766 | ||
386f275f KS |
767 | static struct kobj_type kset_ktype = { |
768 | .sysfs_ops = &kobj_sysfs_ops, | |
b727c702 GKH |
769 | .release = kset_release, |
770 | }; | |
771 | ||
772 | /** | |
773 | * kset_create - create a struct kset dynamically | |
774 | * | |
775 | * @name: the name for the kset | |
776 | * @uevent_ops: a struct kset_uevent_ops for the kset | |
777 | * @parent_kobj: the parent kobject of this kset, if any. | |
778 | * | |
779 | * This function creates a kset structure dynamically. This structure can | |
780 | * then be registered with the system and show up in sysfs with a call to | |
781 | * kset_register(). When you are finished with this structure, if | |
782 | * kset_register() has been called, call kset_unregister() and the | |
783 | * structure will be dynamically freed when it is no longer being used. | |
784 | * | |
785 | * If the kset was not able to be created, NULL will be returned. | |
786 | */ | |
787 | static struct kset *kset_create(const char *name, | |
788 | struct kset_uevent_ops *uevent_ops, | |
789 | struct kobject *parent_kobj) | |
790 | { | |
791 | struct kset *kset; | |
792 | ||
793 | kset = kzalloc(sizeof(*kset), GFP_KERNEL); | |
794 | if (!kset) | |
795 | return NULL; | |
796 | kobject_set_name(&kset->kobj, name); | |
797 | kset->uevent_ops = uevent_ops; | |
798 | kset->kobj.parent = parent_kobj; | |
799 | ||
800 | /* | |
386f275f | 801 | * The kobject of this kset will have a type of kset_ktype and belong to |
b727c702 GKH |
802 | * no kset itself. That way we can properly free it when it is |
803 | * finished being used. | |
804 | */ | |
386f275f | 805 | kset->kobj.ktype = &kset_ktype; |
b727c702 GKH |
806 | kset->kobj.kset = NULL; |
807 | ||
808 | return kset; | |
809 | } | |
810 | ||
811 | /** | |
812 | * kset_create_and_add - create a struct kset dynamically and add it to sysfs | |
813 | * | |
814 | * @name: the name for the kset | |
815 | * @uevent_ops: a struct kset_uevent_ops for the kset | |
816 | * @parent_kobj: the parent kobject of this kset, if any. | |
817 | * | |
818 | * This function creates a kset structure dynamically and registers it | |
819 | * with sysfs. When you are finished with this structure, call | |
820 | * kset_unregister() and the structure will be dynamically freed when it | |
821 | * is no longer being used. | |
822 | * | |
823 | * If the kset was not able to be created, NULL will be returned. | |
824 | */ | |
825 | struct kset *kset_create_and_add(const char *name, | |
826 | struct kset_uevent_ops *uevent_ops, | |
827 | struct kobject *parent_kobj) | |
828 | { | |
829 | struct kset *kset; | |
830 | int error; | |
831 | ||
832 | kset = kset_create(name, uevent_ops, parent_kobj); | |
833 | if (!kset) | |
834 | return NULL; | |
835 | error = kset_register(kset); | |
836 | if (error) { | |
837 | kfree(kset); | |
838 | return NULL; | |
839 | } | |
840 | return kset; | |
841 | } | |
842 | EXPORT_SYMBOL_GPL(kset_create_and_add); | |
843 | ||
1da177e4 LT |
844 | EXPORT_SYMBOL(kobject_get); |
845 | EXPORT_SYMBOL(kobject_put); | |
1da177e4 LT |
846 | EXPORT_SYMBOL(kobject_del); |
847 | ||
848 | EXPORT_SYMBOL(kset_register); | |
849 | EXPORT_SYMBOL(kset_unregister); |