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