]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - lib/kobject.c
lib/kasprintf.c: introduce kvasprintf_const
[mirror_ubuntu-artful-kernel.git] / lib / kobject.c
CommitLineData
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>
8bc3bcc9 17#include <linux/export.h>
1da177e4 18#include <linux/stat.h>
4e57b681 19#include <linux/slab.h>
89c86a64 20#include <linux/random.h>
1da177e4 21
e34ff490
TH
22/**
23 * kobject_namespace - return @kobj's namespace tag
24 * @kobj: kobject in question
25 *
26 * Returns namespace tag of @kobj if its parent has namespace ops enabled
27 * and thus @kobj should have a namespace tag associated with it. Returns
28 * %NULL otherwise.
29 */
30const void *kobject_namespace(struct kobject *kobj)
31{
32 const struct kobj_ns_type_operations *ns_ops = kobj_ns_ops(kobj);
33
34 if (!ns_ops || ns_ops->type == KOBJ_NS_TYPE_NONE)
35 return NULL;
36
a1212d27 37 return kobj->ktype->namespace(kobj);
e34ff490
TH
38}
39
e374a2bf
GKH
40/*
41 * populate_dir - populate directory with attributes.
42 * @kobj: object we're working on.
1da177e4 43 *
e374a2bf
GKH
44 * Most subsystems have a set of default attributes that are associated
45 * with an object that registers with them. This is a helper called during
46 * object registration that loops through the default attributes of the
47 * subsystem and creates attributes files for them in sysfs.
1da177e4 48 */
e374a2bf 49static int populate_dir(struct kobject *kobj)
1da177e4 50{
e374a2bf
GKH
51 struct kobj_type *t = get_ktype(kobj);
52 struct attribute *attr;
1da177e4
LT
53 int error = 0;
54 int i;
e374a2bf 55
1da177e4
LT
56 if (t && t->default_attrs) {
57 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
e374a2bf
GKH
58 error = sysfs_create_file(kobj, attr);
59 if (error)
1da177e4
LT
60 break;
61 }
62 }
63 return error;
64}
65
e374a2bf 66static int create_dir(struct kobject *kobj)
1da177e4 67{
c84a3b27 68 const struct kobj_ns_type_operations *ops;
e34ff490
TH
69 int error;
70
71 error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
c84a3b27
TH
72 if (error)
73 return error;
74
75 error = populate_dir(kobj);
76 if (error) {
77 sysfs_remove_dir(kobj);
78 return error;
1da177e4 79 }
26ea12de
TH
80
81 /*
82 * @kobj->sd may be deleted by an ancestor going away. Hold an
83 * extra reference so that it stays until @kobj is gone.
84 */
85 sysfs_get(kobj->sd);
86
c84a3b27
TH
87 /*
88 * If @kobj has ns_ops, its children need to be filtered based on
89 * their namespace tags. Enable namespace support on @kobj->sd.
90 */
91 ops = kobj_child_ns_ops(kobj);
92 if (ops) {
93 BUG_ON(ops->type <= KOBJ_NS_TYPE_NONE);
94 BUG_ON(ops->type >= KOBJ_NS_TYPES);
95 BUG_ON(!kobj_ns_type_registered(ops->type));
96
fa4cd451 97 sysfs_enable_ns(kobj->sd);
c84a3b27
TH
98 }
99
100 return 0;
1da177e4
LT
101}
102
1da177e4
LT
103static int get_kobj_path_length(struct kobject *kobj)
104{
105 int length = 1;
e374a2bf 106 struct kobject *parent = kobj;
1da177e4 107
e374a2bf 108 /* walk up the ancestors until we hit the one pointing to the
1da177e4
LT
109 * root.
110 * Add 1 to strlen for leading '/' of each level.
111 */
112 do {
b365b3da
CE
113 if (kobject_name(parent) == NULL)
114 return 0;
1da177e4
LT
115 length += strlen(kobject_name(parent)) + 1;
116 parent = parent->parent;
117 } while (parent);
118 return length;
119}
120
121static void fill_kobj_path(struct kobject *kobj, char *path, int length)
122{
e374a2bf 123 struct kobject *parent;
1da177e4
LT
124
125 --length;
126 for (parent = kobj; parent; parent = parent->parent) {
127 int cur = strlen(kobject_name(parent));
128 /* back up enough to print this name with '/' */
129 length -= cur;
e374a2bf 130 strncpy(path + length, kobject_name(parent), cur);
1da177e4
LT
131 *(path + --length) = '/';
132 }
133
9f66fa2a 134 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
810304db 135 kobj, __func__, path);
1da177e4
LT
136}
137
138/**
72fd4a35 139 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
1da177e4
LT
140 *
141 * @kobj: kobject in question, with which to build the path
142 * @gfp_mask: the allocation type used to allocate the path
72fd4a35
RD
143 *
144 * The result must be freed by the caller with kfree().
1da177e4 145 */
fd4f2df2 146char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
1da177e4
LT
147{
148 char *path;
149 int len;
150
151 len = get_kobj_path_length(kobj);
b365b3da
CE
152 if (len == 0)
153 return NULL;
4668edc3 154 path = kzalloc(len, gfp_mask);
1da177e4
LT
155 if (!path)
156 return NULL;
1da177e4
LT
157 fill_kobj_path(kobj, path, len);
158
159 return path;
160}
80fc9f53 161EXPORT_SYMBOL_GPL(kobject_get_path);
1da177e4 162
0f4dafc0
KS
163/* add the kobject to its kset's list */
164static void kobj_kset_join(struct kobject *kobj)
1da177e4 165{
0f4dafc0 166 if (!kobj->kset)
31b9025a 167 return;
0f4dafc0
KS
168
169 kset_get(kobj->kset);
170 spin_lock(&kobj->kset->list_lock);
171 list_add_tail(&kobj->entry, &kobj->kset->list);
172 spin_unlock(&kobj->kset->list_lock);
1da177e4
LT
173}
174
0f4dafc0
KS
175/* remove the kobject from its kset's list */
176static void kobj_kset_leave(struct kobject *kobj)
177{
178 if (!kobj->kset)
179 return;
1da177e4 180
0f4dafc0
KS
181 spin_lock(&kobj->kset->list_lock);
182 list_del_init(&kobj->entry);
183 spin_unlock(&kobj->kset->list_lock);
184 kset_put(kobj->kset);
185}
1da177e4 186
e374a2bf 187static void kobject_init_internal(struct kobject *kobj)
1da177e4 188{
0f4dafc0
KS
189 if (!kobj)
190 return;
191 kref_init(&kobj->kref);
192 INIT_LIST_HEAD(&kobj->entry);
a4573c48
GKH
193 kobj->state_in_sysfs = 0;
194 kobj->state_add_uevent_sent = 0;
195 kobj->state_remove_uevent_sent = 0;
196 kobj->state_initialized = 1;
1da177e4
LT
197}
198
0f4dafc0 199
9e7bbccd 200static int kobject_add_internal(struct kobject *kobj)
1da177e4
LT
201{
202 int error = 0;
e374a2bf 203 struct kobject *parent;
1da177e4 204
0f4dafc0 205 if (!kobj)
1da177e4 206 return -ENOENT;
0f4dafc0 207
af5ca3f4 208 if (!kobj->name || !kobj->name[0]) {
d955c78a 209 WARN(1, "kobject: (%p): attempted to be registered with empty "
9f66fa2a 210 "name!\n", kobj);
c171fef5
GKH
211 return -EINVAL;
212 }
1da177e4 213
0f4dafc0 214 parent = kobject_get(kobj->parent);
1da177e4 215
0f4dafc0 216 /* join kset if set, use it as parent if we do not already have one */
1da177e4 217 if (kobj->kset) {
0f4dafc0 218 if (!parent)
1da177e4 219 parent = kobject_get(&kobj->kset->kobj);
0f4dafc0 220 kobj_kset_join(kobj);
460f7e9a 221 kobj->parent = parent;
1da177e4 222 }
1da177e4 223
0f4dafc0 224 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
810304db 225 kobject_name(kobj), kobj, __func__,
0f4dafc0 226 parent ? kobject_name(parent) : "<NULL>",
e374a2bf 227 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
0f4dafc0 228
90bc6135 229 error = create_dir(kobj);
1da177e4 230 if (error) {
0f4dafc0
KS
231 kobj_kset_leave(kobj);
232 kobject_put(parent);
233 kobj->parent = NULL;
dcd0da00
GKH
234
235 /* be noisy on error issues */
236 if (error == -EEXIST)
282029c0
DW
237 WARN(1, "%s failed for %s with "
238 "-EEXIST, don't try to register things with "
239 "the same name in the same directory.\n",
240 __func__, kobject_name(kobj));
dcd0da00 241 else
282029c0
DW
242 WARN(1, "%s failed for %s (error: %d parent: %s)\n",
243 __func__, kobject_name(kobj), error,
244 parent ? kobject_name(parent) : "'none'");
0f4dafc0
KS
245 } else
246 kobj->state_in_sysfs = 1;
1da177e4
LT
247
248 return error;
249}
250
663a4743
GKH
251/**
252 * kobject_set_name_vargs - Set the name of an kobject
253 * @kobj: struct kobject to set the name of
254 * @fmt: format string used to build the name
255 * @vargs: vargs to format the string.
256 */
1fa5ae85 257int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
663a4743
GKH
258 va_list vargs)
259{
9f255651 260 char *s;
663a4743 261
8a577ffc
KS
262 if (kobj->name && !fmt)
263 return 0;
264
2abf114f
RV
265 s = kvasprintf(GFP_KERNEL, fmt, vargs);
266 if (!s)
a4ca6617 267 return -ENOMEM;
663a4743 268
9f255651 269 /* ewww... some of these buggers have '/' in the name ... */
2abf114f
RV
270 strreplace(s, '/', '!');
271 kfree(kobj->name);
272 kobj->name = s;
9f255651 273
663a4743
GKH
274 return 0;
275}
1da177e4
LT
276
277/**
8c4606b1 278 * kobject_set_name - Set the name of a kobject
663a4743 279 * @kobj: struct kobject to set the name of
8c4606b1 280 * @fmt: format string used to build the name
1da177e4 281 *
8c4606b1
GKH
282 * This sets the name of the kobject. If you have already added the
283 * kobject to the system, you must call kobject_rename() in order to
284 * change the name of the kobject.
1da177e4 285 */
663a4743 286int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
1da177e4 287{
a4ca6617 288 va_list vargs;
663a4743 289 int retval;
1da177e4 290
a4ca6617
KS
291 va_start(vargs, fmt);
292 retval = kobject_set_name_vargs(kobj, fmt, vargs);
293 va_end(vargs);
1da177e4 294
663a4743 295 return retval;
1da177e4 296}
1da177e4
LT
297EXPORT_SYMBOL(kobject_set_name);
298
e86000d0 299/**
f9cb074b 300 * kobject_init - initialize a kobject structure
e86000d0
GKH
301 * @kobj: pointer to the kobject to initialize
302 * @ktype: pointer to the ktype for this kobject.
303 *
304 * This function will properly initialize a kobject such that it can then
305 * be passed to the kobject_add() call.
306 *
307 * After this function is called, the kobject MUST be cleaned up by a call
308 * to kobject_put(), not by a call to kfree directly to ensure that all of
309 * the memory is cleaned up properly.
310 */
f9cb074b 311void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
e86000d0
GKH
312{
313 char *err_str;
314
315 if (!kobj) {
316 err_str = "invalid kobject pointer!";
317 goto error;
318 }
319 if (!ktype) {
320 err_str = "must have a ktype to be initialized properly!\n";
321 goto error;
322 }
0f4dafc0 323 if (kobj->state_initialized) {
e86000d0 324 /* do not error out as sometimes we can recover */
0f4dafc0
KS
325 printk(KERN_ERR "kobject (%p): tried to init an initialized "
326 "object, something is seriously wrong.\n", kobj);
e86000d0
GKH
327 dump_stack();
328 }
329
a4573c48 330 kobject_init_internal(kobj);
e86000d0
GKH
331 kobj->ktype = ktype;
332 return;
333
334error:
0f4dafc0 335 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
e86000d0
GKH
336 dump_stack();
337}
f9cb074b 338EXPORT_SYMBOL(kobject_init);
e86000d0 339
8db14860
NI
340static __printf(3, 0) int kobject_add_varg(struct kobject *kobj,
341 struct kobject *parent,
342 const char *fmt, va_list vargs)
244f6cee 343{
244f6cee
GKH
344 int retval;
345
a4ca6617 346 retval = kobject_set_name_vargs(kobj, fmt, vargs);
244f6cee
GKH
347 if (retval) {
348 printk(KERN_ERR "kobject: can not set name properly!\n");
349 return retval;
350 }
351 kobj->parent = parent;
9e7bbccd 352 return kobject_add_internal(kobj);
244f6cee
GKH
353}
354
355/**
b2d6db58 356 * kobject_add - the main kobject add function
244f6cee
GKH
357 * @kobj: the kobject to add
358 * @parent: pointer to the parent of the kobject.
359 * @fmt: format to name the kobject with.
360 *
361 * The kobject name is set and added to the kobject hierarchy in this
362 * function.
363 *
364 * If @parent is set, then the parent of the @kobj will be set to it.
365 * If @parent is NULL, then the parent of the @kobj will be set to the
9705710e 366 * kobject associated with the kset assigned to this kobject. If no kset
244f6cee
GKH
367 * is assigned to the kobject, then the kobject will be located in the
368 * root of the sysfs tree.
369 *
370 * If this function returns an error, kobject_put() must be called to
371 * properly clean up the memory associated with the object.
244f6cee
GKH
372 * Under no instance should the kobject that is passed to this function
373 * be directly freed with a call to kfree(), that can leak memory.
374 *
0f4dafc0 375 * Note, no "add" uevent will be created with this call, the caller should set
244f6cee
GKH
376 * up all of the necessary sysfs files for the object and then call
377 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
378 * userspace is properly notified of this kobject's creation.
379 */
b2d6db58
GKH
380int kobject_add(struct kobject *kobj, struct kobject *parent,
381 const char *fmt, ...)
244f6cee
GKH
382{
383 va_list args;
384 int retval;
385
386 if (!kobj)
387 return -EINVAL;
388
0f4dafc0
KS
389 if (!kobj->state_initialized) {
390 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
391 "uninitialized object, something is seriously wrong.\n",
392 kobject_name(kobj), kobj);
393 dump_stack();
394 return -EINVAL;
395 }
244f6cee
GKH
396 va_start(args, fmt);
397 retval = kobject_add_varg(kobj, parent, fmt, args);
398 va_end(args);
399
400 return retval;
401}
b2d6db58 402EXPORT_SYMBOL(kobject_add);
244f6cee 403
c11c4154
GKH
404/**
405 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
406 * @kobj: pointer to the kobject to initialize
407 * @ktype: pointer to the ktype for this kobject.
408 * @parent: pointer to the parent of this kobject.
409 * @fmt: the name of the kobject.
410 *
f9cb074b 411 * This function combines the call to kobject_init() and
b2d6db58
GKH
412 * kobject_add(). The same type of error handling after a call to
413 * kobject_add() and kobject lifetime rules are the same here.
c11c4154
GKH
414 */
415int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
416 struct kobject *parent, const char *fmt, ...)
417{
418 va_list args;
419 int retval;
420
f9cb074b 421 kobject_init(kobj, ktype);
c11c4154
GKH
422
423 va_start(args, fmt);
424 retval = kobject_add_varg(kobj, parent, fmt, args);
425 va_end(args);
426
427 return retval;
428}
429EXPORT_SYMBOL_GPL(kobject_init_and_add);
430
1da177e4 431/**
e374a2bf
GKH
432 * kobject_rename - change the name of an object
433 * @kobj: object in question.
434 * @new_name: object's new name
030c1d2b
EB
435 *
436 * It is the responsibility of the caller to provide mutual
437 * exclusion between two different calls of kobject_rename
438 * on the same kobject and to ensure that new_name is valid and
439 * won't conflict with other kobjects.
1da177e4 440 */
e374a2bf 441int kobject_rename(struct kobject *kobj, const char *new_name)
1da177e4
LT
442{
443 int error = 0;
ca2f37db 444 const char *devpath = NULL;
0b4a4fea 445 const char *dup_name = NULL, *name;
ca2f37db
JT
446 char *devpath_string = NULL;
447 char *envp[2];
1da177e4
LT
448
449 kobj = kobject_get(kobj);
450 if (!kobj)
451 return -EINVAL;
b592fcfe
EB
452 if (!kobj->parent)
453 return -EINVAL;
ca2f37db
JT
454
455 devpath = kobject_get_path(kobj, GFP_KERNEL);
456 if (!devpath) {
457 error = -ENOMEM;
458 goto out;
459 }
460 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
461 if (!devpath_string) {
462 error = -ENOMEM;
463 goto out;
464 }
465 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
466 envp[0] = devpath_string;
467 envp[1] = NULL;
ca2f37db 468
0b4a4fea
EB
469 name = dup_name = kstrdup(new_name, GFP_KERNEL);
470 if (!name) {
471 error = -ENOMEM;
472 goto out;
473 }
474
e34ff490 475 error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
0b4a4fea
EB
476 if (error)
477 goto out;
478
479 /* Install the new kobject name */
480 dup_name = kobj->name;
481 kobj->name = name;
ca2f37db
JT
482
483 /* This function is mostly/only used for network interface.
484 * Some hotplug package track interfaces by their name and
485 * therefore want to know when the name is changed by the user. */
0b4a4fea 486 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
ca2f37db
JT
487
488out:
0b4a4fea 489 kfree(dup_name);
ca2f37db
JT
490 kfree(devpath_string);
491 kfree(devpath);
b592fcfe
EB
492 kobject_put(kobj);
493
494 return error;
495}
8344b568 496EXPORT_SYMBOL_GPL(kobject_rename);
b592fcfe 497
8a82472f 498/**
e374a2bf
GKH
499 * kobject_move - move object to another parent
500 * @kobj: object in question.
501 * @new_parent: object's new parent (can be NULL)
8a82472f 502 */
8a82472f
CH
503int kobject_move(struct kobject *kobj, struct kobject *new_parent)
504{
505 int error;
506 struct kobject *old_parent;
507 const char *devpath = NULL;
508 char *devpath_string = NULL;
509 char *envp[2];
510
511 kobj = kobject_get(kobj);
512 if (!kobj)
513 return -EINVAL;
514 new_parent = kobject_get(new_parent);
515 if (!new_parent) {
c744aeae
CH
516 if (kobj->kset)
517 new_parent = kobject_get(&kobj->kset->kobj);
8a82472f 518 }
e34ff490 519
8a82472f
CH
520 /* old object path */
521 devpath = kobject_get_path(kobj, GFP_KERNEL);
522 if (!devpath) {
523 error = -ENOMEM;
524 goto out;
525 }
526 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
527 if (!devpath_string) {
528 error = -ENOMEM;
529 goto out;
530 }
531 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
532 envp[0] = devpath_string;
533 envp[1] = NULL;
e34ff490 534 error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
8a82472f
CH
535 if (error)
536 goto out;
537 old_parent = kobj->parent;
538 kobj->parent = new_parent;
9e993efb 539 new_parent = NULL;
8a82472f
CH
540 kobject_put(old_parent);
541 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
542out:
9e993efb 543 kobject_put(new_parent);
8a82472f
CH
544 kobject_put(kobj);
545 kfree(devpath_string);
546 kfree(devpath);
547 return error;
548}
24199d20 549EXPORT_SYMBOL_GPL(kobject_move);
8a82472f 550
1da177e4 551/**
e374a2bf
GKH
552 * kobject_del - unlink kobject from hierarchy.
553 * @kobj: object.
1da177e4 554 */
e374a2bf 555void kobject_del(struct kobject *kobj)
1da177e4 556{
324a56e1 557 struct kernfs_node *sd;
26ea12de 558
31b9025a
GKH
559 if (!kobj)
560 return;
0f4dafc0 561
26ea12de 562 sd = kobj->sd;
1da177e4 563 sysfs_remove_dir(kobj);
26ea12de
TH
564 sysfs_put(sd);
565
0f4dafc0
KS
566 kobj->state_in_sysfs = 0;
567 kobj_kset_leave(kobj);
568 kobject_put(kobj->parent);
569 kobj->parent = NULL;
1da177e4 570}
fa40ae34 571EXPORT_SYMBOL(kobject_del);
1da177e4 572
1da177e4 573/**
e374a2bf
GKH
574 * kobject_get - increment refcount for object.
575 * @kobj: object.
1da177e4 576 */
e374a2bf 577struct kobject *kobject_get(struct kobject *kobj)
1da177e4 578{
d82d54af
EZ
579 if (kobj) {
580 if (!kobj->state_initialized)
581 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
582 "initialized, yet kobject_get() is being "
583 "called.\n", kobject_name(kobj), kobj);
1da177e4 584 kref_get(&kobj->kref);
d82d54af 585 }
1da177e4
LT
586 return kobj;
587}
fa40ae34 588EXPORT_SYMBOL(kobject_get);
1da177e4 589
2d864e41 590static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
a49b7e82
LT
591{
592 if (!kref_get_unless_zero(&kobj->kref))
593 kobj = NULL;
594 return kobj;
595}
596
18041f47
GKH
597/*
598 * kobject_cleanup - free kobject resources.
599 * @kobj: object to cleanup
1da177e4 600 */
18041f47 601static void kobject_cleanup(struct kobject *kobj)
1da177e4 602{
0f4dafc0 603 struct kobj_type *t = get_ktype(kobj);
af5ca3f4 604 const char *name = kobj->name;
1da177e4 605
c817a67e
RK
606 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
607 kobject_name(kobj), kobj, __func__, kobj->parent);
0f4dafc0
KS
608
609 if (t && !t->release)
610 pr_debug("kobject: '%s' (%p): does not have a release() "
611 "function, it is broken and must be fixed.\n",
612 kobject_name(kobj), kobj);
613
614 /* send "remove" if the caller did not do it but sent "add" */
615 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
616 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
617 kobject_name(kobj), kobj);
618 kobject_uevent(kobj, KOBJ_REMOVE);
619 }
620
621 /* remove from sysfs if the caller did not do it */
622 if (kobj->state_in_sysfs) {
623 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
624 kobject_name(kobj), kobj);
625 kobject_del(kobj);
626 }
627
ce2c9cb0 628 if (t && t->release) {
0f4dafc0
KS
629 pr_debug("kobject: '%s' (%p): calling ktype release\n",
630 kobject_name(kobj), kobj);
1da177e4 631 t->release(kobj);
0f4dafc0
KS
632 }
633
634 /* free name if we allocated it */
af5ca3f4 635 if (name) {
0f4dafc0 636 pr_debug("kobject: '%s': free name\n", name);
ce2c9cb0
GKH
637 kfree(name);
638 }
1da177e4
LT
639}
640
c817a67e
RK
641#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
642static void kobject_delayed_cleanup(struct work_struct *work)
643{
644 kobject_cleanup(container_of(to_delayed_work(work),
645 struct kobject, release));
646}
647#endif
648
1da177e4
LT
649static void kobject_release(struct kref *kref)
650{
c817a67e
RK
651 struct kobject *kobj = container_of(kref, struct kobject, kref);
652#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
89c86a64
BH
653 unsigned long delay = HZ + HZ * (get_random_int() & 0x3);
654 pr_info("kobject: '%s' (%p): %s, parent %p (delayed %ld)\n",
655 kobject_name(kobj), kobj, __func__, kobj->parent, delay);
c817a67e 656 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
89c86a64
BH
657
658 schedule_delayed_work(&kobj->release, delay);
c817a67e
RK
659#else
660 kobject_cleanup(kobj);
661#endif
1da177e4
LT
662}
663
664/**
e374a2bf
GKH
665 * kobject_put - decrement refcount for object.
666 * @kobj: object.
1da177e4 667 *
e374a2bf 668 * Decrement the refcount, and if 0, call kobject_cleanup().
1da177e4 669 */
e374a2bf 670void kobject_put(struct kobject *kobj)
1da177e4 671{
c1ebdae5 672 if (kobj) {
d955c78a
AV
673 if (!kobj->state_initialized)
674 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
c1ebdae5
GKH
675 "initialized, yet kobject_put() is being "
676 "called.\n", kobject_name(kobj), kobj);
1da177e4 677 kref_put(&kobj->kref, kobject_release);
c1ebdae5 678 }
1da177e4 679}
fa40ae34 680EXPORT_SYMBOL(kobject_put);
1da177e4 681
3f9e3ee9 682static void dynamic_kobj_release(struct kobject *kobj)
7423172a 683{
810304db 684 pr_debug("kobject: (%p): %s\n", kobj, __func__);
7423172a
JN
685 kfree(kobj);
686}
687
3f9e3ee9 688static struct kobj_type dynamic_kobj_ktype = {
386f275f
KS
689 .release = dynamic_kobj_release,
690 .sysfs_ops = &kobj_sysfs_ops,
7423172a
JN
691};
692
43968d2f 693/**
3f9e3ee9
GKH
694 * kobject_create - create a struct kobject dynamically
695 *
696 * This function creates a kobject structure dynamically and sets it up
697 * to be a "dynamic" kobject with a default release function set up.
698 *
699 * If the kobject was not able to be created, NULL will be returned.
43968d2f 700 * The kobject structure returned from here must be cleaned up with a
f9cb074b 701 * call to kobject_put() and not kfree(), as kobject_init() has
43968d2f 702 * already been called on this structure.
3f9e3ee9 703 */
43968d2f 704struct kobject *kobject_create(void)
3f9e3ee9
GKH
705{
706 struct kobject *kobj;
707
708 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
709 if (!kobj)
710 return NULL;
711
f9cb074b 712 kobject_init(kobj, &dynamic_kobj_ktype);
3f9e3ee9
GKH
713 return kobj;
714}
715
716/**
717 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
718 *
9ff1f838 719 * @name: the name for the kobject
3f9e3ee9
GKH
720 * @parent: the parent kobject of this kobject, if any.
721 *
f70701a3 722 * This function creates a kobject structure dynamically and registers it
3f9e3ee9 723 * with sysfs. When you are finished with this structure, call
78a2d906 724 * kobject_put() and the structure will be dynamically freed when
3f9e3ee9
GKH
725 * it is no longer being used.
726 *
727 * If the kobject was not able to be created, NULL will be returned.
728 */
729struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
730{
731 struct kobject *kobj;
732 int retval;
733
734 kobj = kobject_create();
735 if (!kobj)
736 return NULL;
737
b2d6db58 738 retval = kobject_add(kobj, parent, "%s", name);
3f9e3ee9
GKH
739 if (retval) {
740 printk(KERN_WARNING "%s: kobject_add error: %d\n",
810304db 741 __func__, retval);
3f9e3ee9
GKH
742 kobject_put(kobj);
743 kobj = NULL;
744 }
745 return kobj;
746}
747EXPORT_SYMBOL_GPL(kobject_create_and_add);
748
1da177e4 749/**
e374a2bf
GKH
750 * kset_init - initialize a kset for use
751 * @k: kset
1da177e4 752 */
e374a2bf 753void kset_init(struct kset *k)
1da177e4 754{
e1543ddf 755 kobject_init_internal(&k->kobj);
1da177e4
LT
756 INIT_LIST_HEAD(&k->list);
757 spin_lock_init(&k->list_lock);
758}
759
23b5212c
KS
760/* default kobject attribute operations */
761static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
762 char *buf)
763{
764 struct kobj_attribute *kattr;
765 ssize_t ret = -EIO;
766
767 kattr = container_of(attr, struct kobj_attribute, attr);
768 if (kattr->show)
769 ret = kattr->show(kobj, kattr, buf);
770 return ret;
771}
772
773static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
774 const char *buf, size_t count)
775{
776 struct kobj_attribute *kattr;
777 ssize_t ret = -EIO;
778
779 kattr = container_of(attr, struct kobj_attribute, attr);
780 if (kattr->store)
781 ret = kattr->store(kobj, kattr, buf, count);
782 return ret;
783}
784
52cf25d0 785const struct sysfs_ops kobj_sysfs_ops = {
23b5212c
KS
786 .show = kobj_attr_show,
787 .store = kobj_attr_store,
788};
29dfe2dc 789EXPORT_SYMBOL_GPL(kobj_sysfs_ops);
1da177e4 790
1da177e4 791/**
e374a2bf
GKH
792 * kset_register - initialize and add a kset.
793 * @k: kset.
1da177e4 794 */
e374a2bf 795int kset_register(struct kset *k)
1da177e4 796{
80f03e34
KS
797 int err;
798
31b9025a
GKH
799 if (!k)
800 return -EINVAL;
80f03e34 801
1da177e4 802 kset_init(k);
12e339ac 803 err = kobject_add_internal(&k->kobj);
80f03e34
KS
804 if (err)
805 return err;
806 kobject_uevent(&k->kobj, KOBJ_ADD);
807 return 0;
1da177e4 808}
fa40ae34 809EXPORT_SYMBOL(kset_register);
1da177e4 810
1da177e4 811/**
e374a2bf
GKH
812 * kset_unregister - remove a kset.
813 * @k: kset.
1da177e4 814 */
e374a2bf 815void kset_unregister(struct kset *k)
1da177e4 816{
31b9025a
GKH
817 if (!k)
818 return;
35a5fe69 819 kobject_del(&k->kobj);
78a2d906 820 kobject_put(&k->kobj);
1da177e4 821}
fa40ae34 822EXPORT_SYMBOL(kset_unregister);
1da177e4 823
1da177e4 824/**
e374a2bf
GKH
825 * kset_find_obj - search for object in kset.
826 * @kset: kset we're looking in.
827 * @name: object's name.
1da177e4 828 *
e374a2bf
GKH
829 * Lock kset via @kset->subsys, and iterate over @kset->list,
830 * looking for a matching kobject. If matching object is found
831 * take a reference and return the object.
1da177e4 832 */
e374a2bf 833struct kobject *kset_find_obj(struct kset *kset, const char *name)
1da177e4 834{
c6a2a3dc 835 struct kobject *k;
e374a2bf 836 struct kobject *ret = NULL;
1da177e4
LT
837
838 spin_lock(&kset->list_lock);
c25d1dfb 839
c6a2a3dc 840 list_for_each_entry(k, &kset->list, entry) {
e374a2bf 841 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
a49b7e82 842 ret = kobject_get_unless_zero(k);
1da177e4
LT
843 break;
844 }
845 }
c25d1dfb 846
1da177e4
LT
847 spin_unlock(&kset->list_lock);
848 return ret;
849}
850
b727c702
GKH
851static void kset_release(struct kobject *kobj)
852{
853 struct kset *kset = container_of(kobj, struct kset, kobj);
9f66fa2a 854 pr_debug("kobject: '%s' (%p): %s\n",
810304db 855 kobject_name(kobj), kobj, __func__);
b727c702
GKH
856 kfree(kset);
857}
858
386f275f
KS
859static struct kobj_type kset_ktype = {
860 .sysfs_ops = &kobj_sysfs_ops,
b727c702
GKH
861 .release = kset_release,
862};
863
864/**
865 * kset_create - create a struct kset dynamically
866 *
867 * @name: the name for the kset
868 * @uevent_ops: a struct kset_uevent_ops for the kset
869 * @parent_kobj: the parent kobject of this kset, if any.
870 *
871 * This function creates a kset structure dynamically. This structure can
872 * then be registered with the system and show up in sysfs with a call to
873 * kset_register(). When you are finished with this structure, if
874 * kset_register() has been called, call kset_unregister() and the
875 * structure will be dynamically freed when it is no longer being used.
876 *
877 * If the kset was not able to be created, NULL will be returned.
878 */
879static struct kset *kset_create(const char *name,
9cd43611 880 const struct kset_uevent_ops *uevent_ops,
b727c702
GKH
881 struct kobject *parent_kobj)
882{
883 struct kset *kset;
d9cd8f37 884 int retval;
b727c702
GKH
885
886 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
887 if (!kset)
888 return NULL;
b7165ebb 889 retval = kobject_set_name(&kset->kobj, "%s", name);
d9cd8f37
DY
890 if (retval) {
891 kfree(kset);
892 return NULL;
893 }
b727c702
GKH
894 kset->uevent_ops = uevent_ops;
895 kset->kobj.parent = parent_kobj;
896
897 /*
386f275f 898 * The kobject of this kset will have a type of kset_ktype and belong to
b727c702
GKH
899 * no kset itself. That way we can properly free it when it is
900 * finished being used.
901 */
386f275f 902 kset->kobj.ktype = &kset_ktype;
b727c702
GKH
903 kset->kobj.kset = NULL;
904
905 return kset;
906}
907
908/**
909 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
910 *
911 * @name: the name for the kset
912 * @uevent_ops: a struct kset_uevent_ops for the kset
913 * @parent_kobj: the parent kobject of this kset, if any.
914 *
915 * This function creates a kset structure dynamically and registers it
916 * with sysfs. When you are finished with this structure, call
917 * kset_unregister() and the structure will be dynamically freed when it
918 * is no longer being used.
919 *
920 * If the kset was not able to be created, NULL will be returned.
921 */
922struct kset *kset_create_and_add(const char *name,
9cd43611 923 const struct kset_uevent_ops *uevent_ops,
b727c702
GKH
924 struct kobject *parent_kobj)
925{
926 struct kset *kset;
927 int error;
928
929 kset = kset_create(name, uevent_ops, parent_kobj);
930 if (!kset)
931 return NULL;
932 error = kset_register(kset);
933 if (error) {
934 kfree(kset);
935 return NULL;
936 }
937 return kset;
938}
939EXPORT_SYMBOL_GPL(kset_create_and_add);
940
bc451f20
EB
941
942static DEFINE_SPINLOCK(kobj_ns_type_lock);
943static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
944
945int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
946{
947 enum kobj_ns_type type = ops->type;
948 int error;
949
950 spin_lock(&kobj_ns_type_lock);
951
952 error = -EINVAL;
953 if (type >= KOBJ_NS_TYPES)
954 goto out;
955
956 error = -EINVAL;
957 if (type <= KOBJ_NS_TYPE_NONE)
958 goto out;
959
960 error = -EBUSY;
961 if (kobj_ns_ops_tbl[type])
962 goto out;
963
964 error = 0;
965 kobj_ns_ops_tbl[type] = ops;
966
967out:
968 spin_unlock(&kobj_ns_type_lock);
969 return error;
970}
971
972int kobj_ns_type_registered(enum kobj_ns_type type)
973{
974 int registered = 0;
975
976 spin_lock(&kobj_ns_type_lock);
977 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
978 registered = kobj_ns_ops_tbl[type] != NULL;
979 spin_unlock(&kobj_ns_type_lock);
980
981 return registered;
982}
983
984const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
985{
986 const struct kobj_ns_type_operations *ops = NULL;
987
41fb96a4 988 if (parent && parent->ktype && parent->ktype->child_ns_type)
bc451f20
EB
989 ops = parent->ktype->child_ns_type(parent);
990
991 return ops;
992}
993
994const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
995{
996 return kobj_child_ns_ops(kobj->parent);
997}
998
7dc5dbc8
EB
999bool kobj_ns_current_may_mount(enum kobj_ns_type type)
1000{
730d7d33 1001 bool may_mount = true;
7dc5dbc8
EB
1002
1003 spin_lock(&kobj_ns_type_lock);
1004 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1005 kobj_ns_ops_tbl[type])
1006 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
1007 spin_unlock(&kobj_ns_type_lock);
1008
1009 return may_mount;
1010}
bc451f20 1011
a685e089 1012void *kobj_ns_grab_current(enum kobj_ns_type type)
bc451f20 1013{
a685e089 1014 void *ns = NULL;
bc451f20
EB
1015
1016 spin_lock(&kobj_ns_type_lock);
1017 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1018 kobj_ns_ops_tbl[type])
a685e089 1019 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
bc451f20
EB
1020 spin_unlock(&kobj_ns_type_lock);
1021
1022 return ns;
1023}
1024
1025const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1026{
1027 const void *ns = NULL;
1028
1029 spin_lock(&kobj_ns_type_lock);
1030 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1031 kobj_ns_ops_tbl[type])
1032 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1033 spin_unlock(&kobj_ns_type_lock);
1034
1035 return ns;
1036}
1037
1038const void *kobj_ns_initial(enum kobj_ns_type type)
1039{
1040 const void *ns = NULL;
1041
1042 spin_lock(&kobj_ns_type_lock);
1043 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1044 kobj_ns_ops_tbl[type])
1045 ns = kobj_ns_ops_tbl[type]->initial_ns();
1046 spin_unlock(&kobj_ns_type_lock);
1047
1048 return ns;
1049}
1050
a685e089 1051void kobj_ns_drop(enum kobj_ns_type type, void *ns)
bc451f20 1052{
a685e089
AV
1053 spin_lock(&kobj_ns_type_lock);
1054 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1055 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1056 kobj_ns_ops_tbl[type]->drop_ns(ns);
1057 spin_unlock(&kobj_ns_type_lock);
bc451f20 1058}