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