2 * kobject.c - library routines for handling generic kernel objects
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.
8 * This file is released under the GPLv2.
11 * Please see the file Documentation/kobject.txt for critical information
12 * about using the kobject interface.
15 #include <linux/kobject.h>
16 #include <linux/string.h>
17 #include <linux/module.h>
18 #include <linux/stat.h>
19 #include <linux/slab.h>
22 * populate_dir - populate directory with attributes.
23 * @kobj: object we're working on.
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.
30 static int populate_dir(struct kobject
*kobj
)
32 struct kobj_type
*t
= get_ktype(kobj
);
33 struct attribute
*attr
;
37 if (t
&& t
->default_attrs
) {
38 for (i
= 0; (attr
= t
->default_attrs
[i
]) != NULL
; i
++) {
39 error
= sysfs_create_file(kobj
, attr
);
47 static int create_dir(struct kobject
*kobj
)
50 if (kobject_name(kobj
)) {
51 error
= sysfs_create_dir(kobj
);
53 error
= populate_dir(kobj
);
55 sysfs_remove_dir(kobj
);
61 static inline struct kobject
*to_kobj(struct list_head
*entry
)
63 return container_of(entry
, struct kobject
, entry
);
66 static int get_kobj_path_length(struct kobject
*kobj
)
69 struct kobject
*parent
= kobj
;
71 /* walk up the ancestors until we hit the one pointing to the
73 * Add 1 to strlen for leading '/' of each level.
76 if (kobject_name(parent
) == NULL
)
78 length
+= strlen(kobject_name(parent
)) + 1;
79 parent
= parent
->parent
;
84 static void fill_kobj_path(struct kobject
*kobj
, char *path
, int length
)
86 struct kobject
*parent
;
89 for (parent
= kobj
; parent
; parent
= parent
->parent
) {
90 int cur
= strlen(kobject_name(parent
));
91 /* back up enough to print this name with '/' */
93 strncpy(path
+ length
, kobject_name(parent
), cur
);
94 *(path
+ --length
) = '/';
97 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj
),
98 kobj
, __FUNCTION__
, path
);
102 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
104 * @kobj: kobject in question, with which to build the path
105 * @gfp_mask: the allocation type used to allocate the path
107 * The result must be freed by the caller with kfree().
109 char *kobject_get_path(struct kobject
*kobj
, gfp_t gfp_mask
)
114 len
= get_kobj_path_length(kobj
);
117 path
= kzalloc(len
, gfp_mask
);
120 fill_kobj_path(kobj
, path
, len
);
124 EXPORT_SYMBOL_GPL(kobject_get_path
);
126 /* add the kobject to its kset's list */
127 static void kobj_kset_join(struct kobject
*kobj
)
132 kset_get(kobj
->kset
);
133 spin_lock(&kobj
->kset
->list_lock
);
134 list_add_tail(&kobj
->entry
, &kobj
->kset
->list
);
135 spin_unlock(&kobj
->kset
->list_lock
);
138 /* remove the kobject from its kset's list */
139 static void kobj_kset_leave(struct kobject
*kobj
)
144 spin_lock(&kobj
->kset
->list_lock
);
145 list_del_init(&kobj
->entry
);
146 spin_unlock(&kobj
->kset
->list_lock
);
147 kset_put(kobj
->kset
);
150 static void kobject_init_internal(struct kobject
*kobj
)
154 kref_init(&kobj
->kref
);
155 INIT_LIST_HEAD(&kobj
->entry
);
156 <<<<<<< HEAD
:lib
/kobject
.c
158 kobj
->state_in_sysfs
= 0;
159 kobj
->state_add_uevent_sent
= 0;
160 kobj
->state_remove_uevent_sent
= 0;
161 kobj
->state_initialized
= 1;
162 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a
:lib
/kobject
.c
166 static int kobject_add_internal(struct kobject
*kobj
)
169 struct kobject
*parent
;
174 if (!kobj
->name
|| !kobj
->name
[0]) {
175 pr_debug("kobject: (%p): attempted to be registered with empty "
181 parent
= kobject_get(kobj
->parent
);
183 /* join kset if set, use it as parent if we do not already have one */
186 parent
= kobject_get(&kobj
->kset
->kobj
);
187 kobj_kset_join(kobj
);
188 kobj
->parent
= parent
;
191 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
192 kobject_name(kobj
), kobj
, __FUNCTION__
,
193 parent
? kobject_name(parent
) : "<NULL>",
194 kobj
->kset
? kobject_name(&kobj
->kset
->kobj
) : "<NULL>");
196 error
= create_dir(kobj
);
198 kobj_kset_leave(kobj
);
202 /* be noisy on error issues */
203 if (error
== -EEXIST
)
204 printk(KERN_ERR
"%s failed for %s with "
205 "-EEXIST, don't try to register things with "
206 "the same name in the same directory.\n",
207 __FUNCTION__
, kobject_name(kobj
));
209 printk(KERN_ERR
"%s failed for %s (%d)\n",
210 __FUNCTION__
, kobject_name(kobj
), error
);
213 kobj
->state_in_sysfs
= 1;
219 * kobject_set_name_vargs - Set the name of an kobject
220 * @kobj: struct kobject to set the name of
221 * @fmt: format string used to build the name
222 * @vargs: vargs to format the string.
224 static int kobject_set_name_vargs(struct kobject
*kobj
, const char *fmt
,
231 name
= kvasprintf(GFP_KERNEL
, fmt
, vargs
);
237 /* Free the old name, if necessary. */
240 /* Now, set the new name */
247 * kobject_set_name - Set the name of a kobject
248 * @kobj: struct kobject to set the name of
249 * @fmt: format string used to build the name
251 * This sets the name of the kobject. If you have already added the
252 * kobject to the system, you must call kobject_rename() in order to
253 * change the name of the kobject.
255 int kobject_set_name(struct kobject
*kobj
, const char *fmt
, ...)
261 retval
= kobject_set_name_vargs(kobj
, fmt
, args
);
266 EXPORT_SYMBOL(kobject_set_name
);
269 * kobject_init - initialize a kobject structure
270 * @kobj: pointer to the kobject to initialize
271 * @ktype: pointer to the ktype for this kobject.
273 * This function will properly initialize a kobject such that it can then
274 * be passed to the kobject_add() call.
276 * After this function is called, the kobject MUST be cleaned up by a call
277 * to kobject_put(), not by a call to kfree directly to ensure that all of
278 * the memory is cleaned up properly.
280 void kobject_init(struct kobject
*kobj
, struct kobj_type
*ktype
)
285 err_str
= "invalid kobject pointer!";
289 err_str
= "must have a ktype to be initialized properly!\n";
292 if (kobj
->state_initialized
) {
293 /* do not error out as sometimes we can recover */
294 printk(KERN_ERR
"kobject (%p): tried to init an initialized "
295 "object, something is seriously wrong.\n", kobj
);
299 <<<<<<< HEAD
:lib
/kobject
.c
300 kref_init(&kobj
->kref
);
301 INIT_LIST_HEAD(&kobj
->entry
);
303 kobject_init_internal(kobj
);
304 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a
:lib
/kobject
.c
306 <<<<<<< HEAD
:lib
/kobject
.c
307 kobj
->state_in_sysfs
= 0;
308 kobj
->state_add_uevent_sent
= 0;
309 kobj
->state_remove_uevent_sent
= 0;
310 kobj
->state_initialized
= 1;
312 >>>>>>> 264e3e889d86e552b4191d69bb60f4f3b383135a
:lib
/kobject
.c
316 printk(KERN_ERR
"kobject (%p): %s\n", kobj
, err_str
);
319 EXPORT_SYMBOL(kobject_init
);
321 static int kobject_add_varg(struct kobject
*kobj
, struct kobject
*parent
,
322 const char *fmt
, va_list vargs
)
328 retval
= kobject_set_name_vargs(kobj
, fmt
, aq
);
331 printk(KERN_ERR
"kobject: can not set name properly!\n");
334 kobj
->parent
= parent
;
335 return kobject_add_internal(kobj
);
339 * kobject_add - the main kobject add function
340 * @kobj: the kobject to add
341 * @parent: pointer to the parent of the kobject.
342 * @fmt: format to name the kobject with.
344 * The kobject name is set and added to the kobject hierarchy in this
347 * If @parent is set, then the parent of the @kobj will be set to it.
348 * If @parent is NULL, then the parent of the @kobj will be set to the
349 * kobject associted with the kset assigned to this kobject. If no kset
350 * is assigned to the kobject, then the kobject will be located in the
351 * root of the sysfs tree.
353 * If this function returns an error, kobject_put() must be called to
354 * properly clean up the memory associated with the object.
355 * Under no instance should the kobject that is passed to this function
356 * be directly freed with a call to kfree(), that can leak memory.
358 * Note, no "add" uevent will be created with this call, the caller should set
359 * up all of the necessary sysfs files for the object and then call
360 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
361 * userspace is properly notified of this kobject's creation.
363 int kobject_add(struct kobject
*kobj
, struct kobject
*parent
,
364 const char *fmt
, ...)
372 if (!kobj
->state_initialized
) {
373 printk(KERN_ERR
"kobject '%s' (%p): tried to add an "
374 "uninitialized object, something is seriously wrong.\n",
375 kobject_name(kobj
), kobj
);
380 retval
= kobject_add_varg(kobj
, parent
, fmt
, args
);
385 EXPORT_SYMBOL(kobject_add
);
388 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
389 * @kobj: pointer to the kobject to initialize
390 * @ktype: pointer to the ktype for this kobject.
391 * @parent: pointer to the parent of this kobject.
392 * @fmt: the name of the kobject.
394 * This function combines the call to kobject_init() and
395 * kobject_add(). The same type of error handling after a call to
396 * kobject_add() and kobject lifetime rules are the same here.
398 int kobject_init_and_add(struct kobject
*kobj
, struct kobj_type
*ktype
,
399 struct kobject
*parent
, const char *fmt
, ...)
404 kobject_init(kobj
, ktype
);
407 retval
= kobject_add_varg(kobj
, parent
, fmt
, args
);
412 EXPORT_SYMBOL_GPL(kobject_init_and_add
);
415 * kobject_rename - change the name of an object
416 * @kobj: object in question.
417 * @new_name: object's new name
419 int kobject_rename(struct kobject
*kobj
, const char *new_name
)
422 const char *devpath
= NULL
;
423 char *devpath_string
= NULL
;
426 kobj
= kobject_get(kobj
);
432 /* see if this name is already in use */
434 struct kobject
*temp_kobj
;
435 temp_kobj
= kset_find_obj(kobj
->kset
, new_name
);
437 printk(KERN_WARNING
"kobject '%s' cannot be renamed "
438 "to '%s' as '%s' is already in existence.\n",
439 kobject_name(kobj
), new_name
, new_name
);
440 kobject_put(temp_kobj
);
445 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
450 devpath_string
= kmalloc(strlen(devpath
) + 15, GFP_KERNEL
);
451 if (!devpath_string
) {
455 sprintf(devpath_string
, "DEVPATH_OLD=%s", devpath
);
456 envp
[0] = devpath_string
;
459 error
= sysfs_rename_dir(kobj
, new_name
);
461 /* This function is mostly/only used for network interface.
462 * Some hotplug package track interfaces by their name and
463 * therefore want to know when the name is changed by the user. */
465 kobject_uevent_env(kobj
, KOBJ_MOVE
, envp
);
468 kfree(devpath_string
);
476 * kobject_move - move object to another parent
477 * @kobj: object in question.
478 * @new_parent: object's new parent (can be NULL)
480 int kobject_move(struct kobject
*kobj
, struct kobject
*new_parent
)
483 struct kobject
*old_parent
;
484 const char *devpath
= NULL
;
485 char *devpath_string
= NULL
;
488 kobj
= kobject_get(kobj
);
491 new_parent
= kobject_get(new_parent
);
494 new_parent
= kobject_get(&kobj
->kset
->kobj
);
496 /* old object path */
497 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
502 devpath_string
= kmalloc(strlen(devpath
) + 15, GFP_KERNEL
);
503 if (!devpath_string
) {
507 sprintf(devpath_string
, "DEVPATH_OLD=%s", devpath
);
508 envp
[0] = devpath_string
;
510 error
= sysfs_move_dir(kobj
, new_parent
);
513 old_parent
= kobj
->parent
;
514 kobj
->parent
= new_parent
;
516 kobject_put(old_parent
);
517 kobject_uevent_env(kobj
, KOBJ_MOVE
, envp
);
519 kobject_put(new_parent
);
521 kfree(devpath_string
);
527 * kobject_del - unlink kobject from hierarchy.
530 void kobject_del(struct kobject
*kobj
)
535 sysfs_remove_dir(kobj
);
536 kobj
->state_in_sysfs
= 0;
537 kobj_kset_leave(kobj
);
538 kobject_put(kobj
->parent
);
543 * kobject_get - increment refcount for object.
546 struct kobject
*kobject_get(struct kobject
*kobj
)
549 kref_get(&kobj
->kref
);
554 * kobject_cleanup - free kobject resources.
555 * @kobj: object to cleanup
557 static void kobject_cleanup(struct kobject
*kobj
)
559 struct kobj_type
*t
= get_ktype(kobj
);
560 const char *name
= kobj
->name
;
562 pr_debug("kobject: '%s' (%p): %s\n",
563 kobject_name(kobj
), kobj
, __FUNCTION__
);
565 if (t
&& !t
->release
)
566 pr_debug("kobject: '%s' (%p): does not have a release() "
567 "function, it is broken and must be fixed.\n",
568 kobject_name(kobj
), kobj
);
570 /* send "remove" if the caller did not do it but sent "add" */
571 if (kobj
->state_add_uevent_sent
&& !kobj
->state_remove_uevent_sent
) {
572 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
573 kobject_name(kobj
), kobj
);
574 kobject_uevent(kobj
, KOBJ_REMOVE
);
577 /* remove from sysfs if the caller did not do it */
578 if (kobj
->state_in_sysfs
) {
579 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
580 kobject_name(kobj
), kobj
);
584 if (t
&& t
->release
) {
585 pr_debug("kobject: '%s' (%p): calling ktype release\n",
586 kobject_name(kobj
), kobj
);
590 /* free name if we allocated it */
592 pr_debug("kobject: '%s': free name\n", name
);
597 static void kobject_release(struct kref
*kref
)
599 kobject_cleanup(container_of(kref
, struct kobject
, kref
));
603 * kobject_put - decrement refcount for object.
606 * Decrement the refcount, and if 0, call kobject_cleanup().
608 void kobject_put(struct kobject
*kobj
)
611 kref_put(&kobj
->kref
, kobject_release
);
614 static void dynamic_kobj_release(struct kobject
*kobj
)
616 pr_debug("kobject: (%p): %s\n", kobj
, __FUNCTION__
);
620 static struct kobj_type dynamic_kobj_ktype
= {
621 .release
= dynamic_kobj_release
,
622 .sysfs_ops
= &kobj_sysfs_ops
,
626 * kobject_create - create a struct kobject dynamically
628 * This function creates a kobject structure dynamically and sets it up
629 * to be a "dynamic" kobject with a default release function set up.
631 * If the kobject was not able to be created, NULL will be returned.
632 * The kobject structure returned from here must be cleaned up with a
633 * call to kobject_put() and not kfree(), as kobject_init() has
634 * already been called on this structure.
636 struct kobject
*kobject_create(void)
638 struct kobject
*kobj
;
640 kobj
= kzalloc(sizeof(*kobj
), GFP_KERNEL
);
644 kobject_init(kobj
, &dynamic_kobj_ktype
);
649 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
651 * @name: the name for the kset
652 * @parent: the parent kobject of this kobject, if any.
654 * This function creates a kobject structure dynamically and registers it
655 * with sysfs. When you are finished with this structure, call
656 * kobject_put() and the structure will be dynamically freed when
657 * it is no longer being used.
659 * If the kobject was not able to be created, NULL will be returned.
661 struct kobject
*kobject_create_and_add(const char *name
, struct kobject
*parent
)
663 struct kobject
*kobj
;
666 kobj
= kobject_create();
670 retval
= kobject_add(kobj
, parent
, "%s", name
);
672 printk(KERN_WARNING
"%s: kobject_add error: %d\n",
673 __FUNCTION__
, retval
);
679 EXPORT_SYMBOL_GPL(kobject_create_and_add
);
682 * kset_init - initialize a kset for use
685 void kset_init(struct kset
*k
)
687 kobject_init_internal(&k
->kobj
);
688 INIT_LIST_HEAD(&k
->list
);
689 spin_lock_init(&k
->list_lock
);
692 /* default kobject attribute operations */
693 static ssize_t
kobj_attr_show(struct kobject
*kobj
, struct attribute
*attr
,
696 struct kobj_attribute
*kattr
;
699 kattr
= container_of(attr
, struct kobj_attribute
, attr
);
701 ret
= kattr
->show(kobj
, kattr
, buf
);
705 static ssize_t
kobj_attr_store(struct kobject
*kobj
, struct attribute
*attr
,
706 const char *buf
, size_t count
)
708 struct kobj_attribute
*kattr
;
711 kattr
= container_of(attr
, struct kobj_attribute
, attr
);
713 ret
= kattr
->store(kobj
, kattr
, buf
, count
);
717 struct sysfs_ops kobj_sysfs_ops
= {
718 .show
= kobj_attr_show
,
719 .store
= kobj_attr_store
,
723 * kset_register - initialize and add a kset.
726 int kset_register(struct kset
*k
)
734 err
= kobject_add_internal(&k
->kobj
);
737 kobject_uevent(&k
->kobj
, KOBJ_ADD
);
742 * kset_unregister - remove a kset.
745 void kset_unregister(struct kset
*k
)
749 kobject_put(&k
->kobj
);
753 * kset_find_obj - search for object in kset.
754 * @kset: kset we're looking in.
755 * @name: object's name.
757 * Lock kset via @kset->subsys, and iterate over @kset->list,
758 * looking for a matching kobject. If matching object is found
759 * take a reference and return the object.
761 struct kobject
*kset_find_obj(struct kset
*kset
, const char *name
)
763 struct list_head
*entry
;
764 struct kobject
*ret
= NULL
;
766 spin_lock(&kset
->list_lock
);
767 list_for_each(entry
, &kset
->list
) {
768 struct kobject
*k
= to_kobj(entry
);
769 if (kobject_name(k
) && !strcmp(kobject_name(k
), name
)) {
770 ret
= kobject_get(k
);
774 spin_unlock(&kset
->list_lock
);
778 static void kset_release(struct kobject
*kobj
)
780 struct kset
*kset
= container_of(kobj
, struct kset
, kobj
);
781 pr_debug("kobject: '%s' (%p): %s\n",
782 kobject_name(kobj
), kobj
, __FUNCTION__
);
786 static struct kobj_type kset_ktype
= {
787 .sysfs_ops
= &kobj_sysfs_ops
,
788 .release
= kset_release
,
792 * kset_create - create a struct kset dynamically
794 * @name: the name for the kset
795 * @uevent_ops: a struct kset_uevent_ops for the kset
796 * @parent_kobj: the parent kobject of this kset, if any.
798 * This function creates a kset structure dynamically. This structure can
799 * then be registered with the system and show up in sysfs with a call to
800 * kset_register(). When you are finished with this structure, if
801 * kset_register() has been called, call kset_unregister() and the
802 * structure will be dynamically freed when it is no longer being used.
804 * If the kset was not able to be created, NULL will be returned.
806 static struct kset
*kset_create(const char *name
,
807 struct kset_uevent_ops
*uevent_ops
,
808 struct kobject
*parent_kobj
)
812 kset
= kzalloc(sizeof(*kset
), GFP_KERNEL
);
815 kobject_set_name(&kset
->kobj
, name
);
816 kset
->uevent_ops
= uevent_ops
;
817 kset
->kobj
.parent
= parent_kobj
;
820 * The kobject of this kset will have a type of kset_ktype and belong to
821 * no kset itself. That way we can properly free it when it is
822 * finished being used.
824 kset
->kobj
.ktype
= &kset_ktype
;
825 kset
->kobj
.kset
= NULL
;
831 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
833 * @name: the name for the kset
834 * @uevent_ops: a struct kset_uevent_ops for the kset
835 * @parent_kobj: the parent kobject of this kset, if any.
837 * This function creates a kset structure dynamically and registers it
838 * with sysfs. When you are finished with this structure, call
839 * kset_unregister() and the structure will be dynamically freed when it
840 * is no longer being used.
842 * If the kset was not able to be created, NULL will be returned.
844 struct kset
*kset_create_and_add(const char *name
,
845 struct kset_uevent_ops
*uevent_ops
,
846 struct kobject
*parent_kobj
)
851 kset
= kset_create(name
, uevent_ops
, parent_kobj
);
854 error
= kset_register(kset
);
861 EXPORT_SYMBOL_GPL(kset_create_and_add
);
863 EXPORT_SYMBOL(kobject_get
);
864 EXPORT_SYMBOL(kobject_put
);
865 EXPORT_SYMBOL(kobject_del
);
867 EXPORT_SYMBOL(kset_register
);
868 EXPORT_SYMBOL(kset_unregister
);