1 // SPDX-License-Identifier: GPL-2.0
3 * kobject.c - library routines for handling generic kernel objects
5 * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org>
6 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
7 * Copyright (c) 2006-2007 Novell Inc.
9 * Please see the file Documentation/kobject.txt for critical information
10 * about using the kobject interface.
13 #include <linux/kobject.h>
14 #include <linux/string.h>
15 #include <linux/export.h>
16 #include <linux/stat.h>
17 #include <linux/slab.h>
18 #include <linux/random.h>
21 * kobject_namespace() - Return @kobj's namespace tag.
22 * @kobj: kobject in question
24 * Returns namespace tag of @kobj if its parent has namespace ops enabled
25 * and thus @kobj should have a namespace tag associated with it. Returns
28 const void *kobject_namespace(struct kobject
*kobj
)
30 const struct kobj_ns_type_operations
*ns_ops
= kobj_ns_ops(kobj
);
32 if (!ns_ops
|| ns_ops
->type
== KOBJ_NS_TYPE_NONE
)
35 return kobj
->ktype
->namespace(kobj
);
39 * kobject_get_ownership() - Get sysfs ownership data for @kobj.
40 * @kobj: kobject in question
41 * @uid: kernel user ID for sysfs objects
42 * @gid: kernel group ID for sysfs objects
44 * Returns initial uid/gid pair that should be used when creating sysfs
45 * representation of given kobject. Normally used to adjust ownership of
46 * objects in a container.
48 void kobject_get_ownership(struct kobject
*kobj
, kuid_t
*uid
, kgid_t
*gid
)
50 *uid
= GLOBAL_ROOT_UID
;
51 *gid
= GLOBAL_ROOT_GID
;
53 if (kobj
->ktype
->get_ownership
)
54 kobj
->ktype
->get_ownership(kobj
, uid
, gid
);
58 * populate_dir - populate directory with attributes.
59 * @kobj: object we're working on.
61 * Most subsystems have a set of default attributes that are associated
62 * with an object that registers with them. This is a helper called during
63 * object registration that loops through the default attributes of the
64 * subsystem and creates attributes files for them in sysfs.
66 static int populate_dir(struct kobject
*kobj
)
68 struct kobj_type
*t
= get_ktype(kobj
);
69 struct attribute
*attr
;
73 if (t
&& t
->default_attrs
) {
74 for (i
= 0; (attr
= t
->default_attrs
[i
]) != NULL
; i
++) {
75 error
= sysfs_create_file(kobj
, attr
);
83 static int create_dir(struct kobject
*kobj
)
85 const struct kobj_type
*ktype
= get_ktype(kobj
);
86 const struct kobj_ns_type_operations
*ops
;
89 error
= sysfs_create_dir_ns(kobj
, kobject_namespace(kobj
));
93 error
= populate_dir(kobj
);
95 sysfs_remove_dir(kobj
);
100 error
= sysfs_create_groups(kobj
, ktype
->default_groups
);
102 sysfs_remove_dir(kobj
);
108 * @kobj->sd may be deleted by an ancestor going away. Hold an
109 * extra reference so that it stays until @kobj is gone.
114 * If @kobj has ns_ops, its children need to be filtered based on
115 * their namespace tags. Enable namespace support on @kobj->sd.
117 ops
= kobj_child_ns_ops(kobj
);
119 BUG_ON(ops
->type
<= KOBJ_NS_TYPE_NONE
);
120 BUG_ON(ops
->type
>= KOBJ_NS_TYPES
);
121 BUG_ON(!kobj_ns_type_registered(ops
->type
));
123 sysfs_enable_ns(kobj
->sd
);
129 static int get_kobj_path_length(struct kobject
*kobj
)
132 struct kobject
*parent
= kobj
;
134 /* walk up the ancestors until we hit the one pointing to the
136 * Add 1 to strlen for leading '/' of each level.
139 if (kobject_name(parent
) == NULL
)
141 length
+= strlen(kobject_name(parent
)) + 1;
142 parent
= parent
->parent
;
147 static void fill_kobj_path(struct kobject
*kobj
, char *path
, int length
)
149 struct kobject
*parent
;
152 for (parent
= kobj
; parent
; parent
= parent
->parent
) {
153 int cur
= strlen(kobject_name(parent
));
154 /* back up enough to print this name with '/' */
156 memcpy(path
+ length
, kobject_name(parent
), cur
);
157 *(path
+ --length
) = '/';
160 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj
),
161 kobj
, __func__
, path
);
165 * kobject_get_path() - Allocate memory and fill in the path for @kobj.
166 * @kobj: kobject in question, with which to build the path
167 * @gfp_mask: the allocation type used to allocate the path
169 * Return: The newly allocated memory, caller must free with kfree().
171 char *kobject_get_path(struct kobject
*kobj
, gfp_t gfp_mask
)
176 len
= get_kobj_path_length(kobj
);
179 path
= kzalloc(len
, gfp_mask
);
182 fill_kobj_path(kobj
, path
, len
);
186 EXPORT_SYMBOL_GPL(kobject_get_path
);
188 /* add the kobject to its kset's list */
189 static void kobj_kset_join(struct kobject
*kobj
)
194 kset_get(kobj
->kset
);
195 spin_lock(&kobj
->kset
->list_lock
);
196 list_add_tail(&kobj
->entry
, &kobj
->kset
->list
);
197 spin_unlock(&kobj
->kset
->list_lock
);
200 /* remove the kobject from its kset's list */
201 static void kobj_kset_leave(struct kobject
*kobj
)
206 spin_lock(&kobj
->kset
->list_lock
);
207 list_del_init(&kobj
->entry
);
208 spin_unlock(&kobj
->kset
->list_lock
);
209 kset_put(kobj
->kset
);
212 static void kobject_init_internal(struct kobject
*kobj
)
216 kref_init(&kobj
->kref
);
217 INIT_LIST_HEAD(&kobj
->entry
);
218 kobj
->state_in_sysfs
= 0;
219 kobj
->state_add_uevent_sent
= 0;
220 kobj
->state_remove_uevent_sent
= 0;
221 kobj
->state_initialized
= 1;
225 static int kobject_add_internal(struct kobject
*kobj
)
228 struct kobject
*parent
;
233 if (!kobj
->name
|| !kobj
->name
[0]) {
235 "kobject: (%p): attempted to be registered with empty name!\n",
240 parent
= kobject_get(kobj
->parent
);
242 /* join kset if set, use it as parent if we do not already have one */
245 parent
= kobject_get(&kobj
->kset
->kobj
);
246 kobj_kset_join(kobj
);
247 kobj
->parent
= parent
;
250 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
251 kobject_name(kobj
), kobj
, __func__
,
252 parent
? kobject_name(parent
) : "<NULL>",
253 kobj
->kset
? kobject_name(&kobj
->kset
->kobj
) : "<NULL>");
255 error
= create_dir(kobj
);
257 kobj_kset_leave(kobj
);
261 /* be noisy on error issues */
262 if (error
== -EEXIST
)
263 pr_err("%s failed for %s with -EEXIST, don't try to register things with the same name in the same directory.\n",
264 __func__
, kobject_name(kobj
));
266 pr_err("%s failed for %s (error: %d parent: %s)\n",
267 __func__
, kobject_name(kobj
), error
,
268 parent
? kobject_name(parent
) : "'none'");
270 kobj
->state_in_sysfs
= 1;
276 * kobject_set_name_vargs() - Set the name of a kobject.
277 * @kobj: struct kobject to set the name of
278 * @fmt: format string used to build the name
279 * @vargs: vargs to format the string.
281 int kobject_set_name_vargs(struct kobject
*kobj
, const char *fmt
,
286 if (kobj
->name
&& !fmt
)
289 s
= kvasprintf_const(GFP_KERNEL
, fmt
, vargs
);
294 * ewww... some of these buggers have '/' in the name ... If
295 * that's the case, we need to make sure we have an actual
296 * allocated copy to modify, since kvasprintf_const may have
297 * returned something from .rodata.
299 if (strchr(s
, '/')) {
302 t
= kstrdup(s
, GFP_KERNEL
);
306 strreplace(t
, '/', '!');
309 kfree_const(kobj
->name
);
316 * kobject_set_name() - Set the name of a kobject.
317 * @kobj: struct kobject to set the name of
318 * @fmt: format string used to build the name
320 * This sets the name of the kobject. If you have already added the
321 * kobject to the system, you must call kobject_rename() in order to
322 * change the name of the kobject.
324 int kobject_set_name(struct kobject
*kobj
, const char *fmt
, ...)
329 va_start(vargs
, fmt
);
330 retval
= kobject_set_name_vargs(kobj
, fmt
, vargs
);
335 EXPORT_SYMBOL(kobject_set_name
);
338 * kobject_init() - Initialize a kobject structure.
339 * @kobj: pointer to the kobject to initialize
340 * @ktype: pointer to the ktype for this kobject.
342 * This function will properly initialize a kobject such that it can then
343 * be passed to the kobject_add() call.
345 * After this function is called, the kobject MUST be cleaned up by a call
346 * to kobject_put(), not by a call to kfree directly to ensure that all of
347 * the memory is cleaned up properly.
349 void kobject_init(struct kobject
*kobj
, struct kobj_type
*ktype
)
354 err_str
= "invalid kobject pointer!";
358 err_str
= "must have a ktype to be initialized properly!\n";
361 if (kobj
->state_initialized
) {
362 /* do not error out as sometimes we can recover */
363 pr_err("kobject (%p): tried to init an initialized object, something is seriously wrong.\n",
368 kobject_init_internal(kobj
);
373 pr_err("kobject (%p): %s\n", kobj
, err_str
);
376 EXPORT_SYMBOL(kobject_init
);
378 static __printf(3, 0) int kobject_add_varg(struct kobject
*kobj
,
379 struct kobject
*parent
,
380 const char *fmt
, va_list vargs
)
384 retval
= kobject_set_name_vargs(kobj
, fmt
, vargs
);
386 pr_err("kobject: can not set name properly!\n");
389 kobj
->parent
= parent
;
390 return kobject_add_internal(kobj
);
394 * kobject_add() - The main kobject add function.
395 * @kobj: the kobject to add
396 * @parent: pointer to the parent of the kobject.
397 * @fmt: format to name the kobject with.
399 * The kobject name is set and added to the kobject hierarchy in this
402 * If @parent is set, then the parent of the @kobj will be set to it.
403 * If @parent is NULL, then the parent of the @kobj will be set to the
404 * kobject associated with the kset assigned to this kobject. If no kset
405 * is assigned to the kobject, then the kobject will be located in the
406 * root of the sysfs tree.
408 * Note, no "add" uevent will be created with this call, the caller should set
409 * up all of the necessary sysfs files for the object and then call
410 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
411 * userspace is properly notified of this kobject's creation.
413 * Return: If this function returns an error, kobject_put() must be
414 * called to properly clean up the memory associated with the
415 * object. Under no instance should the kobject that is passed
416 * to this function be directly freed with a call to kfree(),
417 * that can leak memory.
419 * If this function returns success, kobject_put() must also be called
420 * in order to properly clean up the memory associated with the object.
422 * In short, once this function is called, kobject_put() MUST be called
423 * when the use of the object is finished in order to properly free
426 int kobject_add(struct kobject
*kobj
, struct kobject
*parent
,
427 const char *fmt
, ...)
435 if (!kobj
->state_initialized
) {
436 pr_err("kobject '%s' (%p): tried to add an uninitialized object, something is seriously wrong.\n",
437 kobject_name(kobj
), kobj
);
442 retval
= kobject_add_varg(kobj
, parent
, fmt
, args
);
447 EXPORT_SYMBOL(kobject_add
);
450 * kobject_init_and_add() - Initialize a kobject structure and add it to
451 * the kobject hierarchy.
452 * @kobj: pointer to the kobject to initialize
453 * @ktype: pointer to the ktype for this kobject.
454 * @parent: pointer to the parent of this kobject.
455 * @fmt: the name of the kobject.
457 * This function combines the call to kobject_init() and kobject_add().
459 * If this function returns an error, kobject_put() must be called to
460 * properly clean up the memory associated with the object. This is the
461 * same type of error handling after a call to kobject_add() and kobject
462 * lifetime rules are the same here.
464 int kobject_init_and_add(struct kobject
*kobj
, struct kobj_type
*ktype
,
465 struct kobject
*parent
, const char *fmt
, ...)
470 kobject_init(kobj
, ktype
);
473 retval
= kobject_add_varg(kobj
, parent
, fmt
, args
);
478 EXPORT_SYMBOL_GPL(kobject_init_and_add
);
481 * kobject_rename() - Change the name of an object.
482 * @kobj: object in question.
483 * @new_name: object's new name
485 * It is the responsibility of the caller to provide mutual
486 * exclusion between two different calls of kobject_rename
487 * on the same kobject and to ensure that new_name is valid and
488 * won't conflict with other kobjects.
490 int kobject_rename(struct kobject
*kobj
, const char *new_name
)
493 const char *devpath
= NULL
;
494 const char *dup_name
= NULL
, *name
;
495 char *devpath_string
= NULL
;
498 kobj
= kobject_get(kobj
);
506 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
511 devpath_string
= kmalloc(strlen(devpath
) + 15, GFP_KERNEL
);
512 if (!devpath_string
) {
516 sprintf(devpath_string
, "DEVPATH_OLD=%s", devpath
);
517 envp
[0] = devpath_string
;
520 name
= dup_name
= kstrdup_const(new_name
, GFP_KERNEL
);
526 error
= sysfs_rename_dir_ns(kobj
, new_name
, kobject_namespace(kobj
));
530 /* Install the new kobject name */
531 dup_name
= kobj
->name
;
534 /* This function is mostly/only used for network interface.
535 * Some hotplug package track interfaces by their name and
536 * therefore want to know when the name is changed by the user. */
537 kobject_uevent_env(kobj
, KOBJ_MOVE
, envp
);
540 kfree_const(dup_name
);
541 kfree(devpath_string
);
547 EXPORT_SYMBOL_GPL(kobject_rename
);
550 * kobject_move() - Move object to another parent.
551 * @kobj: object in question.
552 * @new_parent: object's new parent (can be NULL)
554 int kobject_move(struct kobject
*kobj
, struct kobject
*new_parent
)
557 struct kobject
*old_parent
;
558 const char *devpath
= NULL
;
559 char *devpath_string
= NULL
;
562 kobj
= kobject_get(kobj
);
565 new_parent
= kobject_get(new_parent
);
568 new_parent
= kobject_get(&kobj
->kset
->kobj
);
571 /* old object path */
572 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
577 devpath_string
= kmalloc(strlen(devpath
) + 15, GFP_KERNEL
);
578 if (!devpath_string
) {
582 sprintf(devpath_string
, "DEVPATH_OLD=%s", devpath
);
583 envp
[0] = devpath_string
;
585 error
= sysfs_move_dir_ns(kobj
, new_parent
, kobject_namespace(kobj
));
588 old_parent
= kobj
->parent
;
589 kobj
->parent
= new_parent
;
591 kobject_put(old_parent
);
592 kobject_uevent_env(kobj
, KOBJ_MOVE
, envp
);
594 kobject_put(new_parent
);
596 kfree(devpath_string
);
600 EXPORT_SYMBOL_GPL(kobject_move
);
603 * kobject_del() - Unlink kobject from hierarchy.
606 * This is the function that should be called to delete an object
607 * successfully added via kobject_add().
609 void kobject_del(struct kobject
*kobj
)
611 struct kernfs_node
*sd
;
612 const struct kobj_type
*ktype
;
618 ktype
= get_ktype(kobj
);
621 sysfs_remove_groups(kobj
, ktype
->default_groups
);
623 sysfs_remove_dir(kobj
);
626 kobj
->state_in_sysfs
= 0;
627 kobj_kset_leave(kobj
);
628 kobject_put(kobj
->parent
);
631 EXPORT_SYMBOL(kobject_del
);
634 * kobject_get() - Increment refcount for object.
637 struct kobject
*kobject_get(struct kobject
*kobj
)
640 if (!kobj
->state_initialized
)
642 "kobject: '%s' (%p): is not initialized, yet kobject_get() is being called.\n",
643 kobject_name(kobj
), kobj
);
644 kref_get(&kobj
->kref
);
648 EXPORT_SYMBOL(kobject_get
);
650 struct kobject
* __must_check
kobject_get_unless_zero(struct kobject
*kobj
)
654 if (!kref_get_unless_zero(&kobj
->kref
))
658 EXPORT_SYMBOL(kobject_get_unless_zero
);
661 * kobject_cleanup - free kobject resources.
662 * @kobj: object to cleanup
664 static void kobject_cleanup(struct kobject
*kobj
)
666 struct kobj_type
*t
= get_ktype(kobj
);
667 const char *name
= kobj
->name
;
669 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
670 kobject_name(kobj
), kobj
, __func__
, kobj
->parent
);
672 if (t
&& !t
->release
)
673 pr_debug("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/kobject.txt.\n",
674 kobject_name(kobj
), kobj
);
676 /* send "remove" if the caller did not do it but sent "add" */
677 if (kobj
->state_add_uevent_sent
&& !kobj
->state_remove_uevent_sent
) {
678 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
679 kobject_name(kobj
), kobj
);
680 kobject_uevent(kobj
, KOBJ_REMOVE
);
683 /* remove from sysfs if the caller did not do it */
684 if (kobj
->state_in_sysfs
) {
685 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
686 kobject_name(kobj
), kobj
);
690 if (t
&& t
->release
) {
691 pr_debug("kobject: '%s' (%p): calling ktype release\n",
692 kobject_name(kobj
), kobj
);
696 /* free name if we allocated it */
698 pr_debug("kobject: '%s': free name\n", name
);
703 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
704 static void kobject_delayed_cleanup(struct work_struct
*work
)
706 kobject_cleanup(container_of(to_delayed_work(work
),
707 struct kobject
, release
));
711 static void kobject_release(struct kref
*kref
)
713 struct kobject
*kobj
= container_of(kref
, struct kobject
, kref
);
714 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
715 unsigned long delay
= HZ
+ HZ
* (get_random_int() & 0x3);
716 pr_info("kobject: '%s' (%p): %s, parent %p (delayed %ld)\n",
717 kobject_name(kobj
), kobj
, __func__
, kobj
->parent
, delay
);
718 INIT_DELAYED_WORK(&kobj
->release
, kobject_delayed_cleanup
);
720 schedule_delayed_work(&kobj
->release
, delay
);
722 kobject_cleanup(kobj
);
727 * kobject_put() - Decrement refcount for object.
730 * Decrement the refcount, and if 0, call kobject_cleanup().
732 void kobject_put(struct kobject
*kobj
)
735 if (!kobj
->state_initialized
)
737 "kobject: '%s' (%p): is not initialized, yet kobject_put() is being called.\n",
738 kobject_name(kobj
), kobj
);
739 kref_put(&kobj
->kref
, kobject_release
);
742 EXPORT_SYMBOL(kobject_put
);
744 static void dynamic_kobj_release(struct kobject
*kobj
)
746 pr_debug("kobject: (%p): %s\n", kobj
, __func__
);
750 static struct kobj_type dynamic_kobj_ktype
= {
751 .release
= dynamic_kobj_release
,
752 .sysfs_ops
= &kobj_sysfs_ops
,
756 * kobject_create() - Create a struct kobject dynamically.
758 * This function creates a kobject structure dynamically and sets it up
759 * to be a "dynamic" kobject with a default release function set up.
761 * If the kobject was not able to be created, NULL will be returned.
762 * The kobject structure returned from here must be cleaned up with a
763 * call to kobject_put() and not kfree(), as kobject_init() has
764 * already been called on this structure.
766 struct kobject
*kobject_create(void)
768 struct kobject
*kobj
;
770 kobj
= kzalloc(sizeof(*kobj
), GFP_KERNEL
);
774 kobject_init(kobj
, &dynamic_kobj_ktype
);
779 * kobject_create_and_add() - Create a struct kobject dynamically and
780 * register it with sysfs.
781 * @name: the name for the kobject
782 * @parent: the parent kobject of this kobject, if any.
784 * This function creates a kobject structure dynamically and registers it
785 * with sysfs. When you are finished with this structure, call
786 * kobject_put() and the structure will be dynamically freed when
787 * it is no longer being used.
789 * If the kobject was not able to be created, NULL will be returned.
791 struct kobject
*kobject_create_and_add(const char *name
, struct kobject
*parent
)
793 struct kobject
*kobj
;
796 kobj
= kobject_create();
800 retval
= kobject_add(kobj
, parent
, "%s", name
);
802 pr_warn("%s: kobject_add error: %d\n", __func__
, retval
);
808 EXPORT_SYMBOL_GPL(kobject_create_and_add
);
811 * kset_init() - Initialize a kset for use.
814 void kset_init(struct kset
*k
)
816 kobject_init_internal(&k
->kobj
);
817 INIT_LIST_HEAD(&k
->list
);
818 spin_lock_init(&k
->list_lock
);
821 /* default kobject attribute operations */
822 static ssize_t
kobj_attr_show(struct kobject
*kobj
, struct attribute
*attr
,
825 struct kobj_attribute
*kattr
;
828 kattr
= container_of(attr
, struct kobj_attribute
, attr
);
830 ret
= kattr
->show(kobj
, kattr
, buf
);
834 static ssize_t
kobj_attr_store(struct kobject
*kobj
, struct attribute
*attr
,
835 const char *buf
, size_t count
)
837 struct kobj_attribute
*kattr
;
840 kattr
= container_of(attr
, struct kobj_attribute
, attr
);
842 ret
= kattr
->store(kobj
, kattr
, buf
, count
);
846 const struct sysfs_ops kobj_sysfs_ops
= {
847 .show
= kobj_attr_show
,
848 .store
= kobj_attr_store
,
850 EXPORT_SYMBOL_GPL(kobj_sysfs_ops
);
853 * kset_register() - Initialize and add a kset.
856 int kset_register(struct kset
*k
)
864 err
= kobject_add_internal(&k
->kobj
);
867 kobject_uevent(&k
->kobj
, KOBJ_ADD
);
870 EXPORT_SYMBOL(kset_register
);
873 * kset_unregister() - Remove a kset.
876 void kset_unregister(struct kset
*k
)
880 kobject_del(&k
->kobj
);
881 kobject_put(&k
->kobj
);
883 EXPORT_SYMBOL(kset_unregister
);
886 * kset_find_obj() - Search for object in kset.
887 * @kset: kset we're looking in.
888 * @name: object's name.
890 * Lock kset via @kset->subsys, and iterate over @kset->list,
891 * looking for a matching kobject. If matching object is found
892 * take a reference and return the object.
894 struct kobject
*kset_find_obj(struct kset
*kset
, const char *name
)
897 struct kobject
*ret
= NULL
;
899 spin_lock(&kset
->list_lock
);
901 list_for_each_entry(k
, &kset
->list
, entry
) {
902 if (kobject_name(k
) && !strcmp(kobject_name(k
), name
)) {
903 ret
= kobject_get_unless_zero(k
);
908 spin_unlock(&kset
->list_lock
);
911 EXPORT_SYMBOL_GPL(kset_find_obj
);
913 static void kset_release(struct kobject
*kobj
)
915 struct kset
*kset
= container_of(kobj
, struct kset
, kobj
);
916 pr_debug("kobject: '%s' (%p): %s\n",
917 kobject_name(kobj
), kobj
, __func__
);
921 static void kset_get_ownership(struct kobject
*kobj
, kuid_t
*uid
, kgid_t
*gid
)
924 kobject_get_ownership(kobj
->parent
, uid
, gid
);
927 static struct kobj_type kset_ktype
= {
928 .sysfs_ops
= &kobj_sysfs_ops
,
929 .release
= kset_release
,
930 .get_ownership
= kset_get_ownership
,
934 * kset_create() - Create a struct kset dynamically.
936 * @name: the name for the kset
937 * @uevent_ops: a struct kset_uevent_ops for the kset
938 * @parent_kobj: the parent kobject of this kset, if any.
940 * This function creates a kset structure dynamically. This structure can
941 * then be registered with the system and show up in sysfs with a call to
942 * kset_register(). When you are finished with this structure, if
943 * kset_register() has been called, call kset_unregister() and the
944 * structure will be dynamically freed when it is no longer being used.
946 * If the kset was not able to be created, NULL will be returned.
948 static struct kset
*kset_create(const char *name
,
949 const struct kset_uevent_ops
*uevent_ops
,
950 struct kobject
*parent_kobj
)
955 kset
= kzalloc(sizeof(*kset
), GFP_KERNEL
);
958 retval
= kobject_set_name(&kset
->kobj
, "%s", name
);
963 kset
->uevent_ops
= uevent_ops
;
964 kset
->kobj
.parent
= parent_kobj
;
967 * The kobject of this kset will have a type of kset_ktype and belong to
968 * no kset itself. That way we can properly free it when it is
969 * finished being used.
971 kset
->kobj
.ktype
= &kset_ktype
;
972 kset
->kobj
.kset
= NULL
;
978 * kset_create_and_add() - Create a struct kset dynamically and add it to sysfs.
980 * @name: the name for the kset
981 * @uevent_ops: a struct kset_uevent_ops for the kset
982 * @parent_kobj: the parent kobject of this kset, if any.
984 * This function creates a kset structure dynamically and registers it
985 * with sysfs. When you are finished with this structure, call
986 * kset_unregister() and the structure will be dynamically freed when it
987 * is no longer being used.
989 * If the kset was not able to be created, NULL will be returned.
991 struct kset
*kset_create_and_add(const char *name
,
992 const struct kset_uevent_ops
*uevent_ops
,
993 struct kobject
*parent_kobj
)
998 kset
= kset_create(name
, uevent_ops
, parent_kobj
);
1001 error
= kset_register(kset
);
1008 EXPORT_SYMBOL_GPL(kset_create_and_add
);
1011 static DEFINE_SPINLOCK(kobj_ns_type_lock
);
1012 static const struct kobj_ns_type_operations
*kobj_ns_ops_tbl
[KOBJ_NS_TYPES
];
1014 int kobj_ns_type_register(const struct kobj_ns_type_operations
*ops
)
1016 enum kobj_ns_type type
= ops
->type
;
1019 spin_lock(&kobj_ns_type_lock
);
1022 if (type
>= KOBJ_NS_TYPES
)
1026 if (type
<= KOBJ_NS_TYPE_NONE
)
1030 if (kobj_ns_ops_tbl
[type
])
1034 kobj_ns_ops_tbl
[type
] = ops
;
1037 spin_unlock(&kobj_ns_type_lock
);
1041 int kobj_ns_type_registered(enum kobj_ns_type type
)
1045 spin_lock(&kobj_ns_type_lock
);
1046 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
))
1047 registered
= kobj_ns_ops_tbl
[type
] != NULL
;
1048 spin_unlock(&kobj_ns_type_lock
);
1053 const struct kobj_ns_type_operations
*kobj_child_ns_ops(struct kobject
*parent
)
1055 const struct kobj_ns_type_operations
*ops
= NULL
;
1057 if (parent
&& parent
->ktype
&& parent
->ktype
->child_ns_type
)
1058 ops
= parent
->ktype
->child_ns_type(parent
);
1063 const struct kobj_ns_type_operations
*kobj_ns_ops(struct kobject
*kobj
)
1065 return kobj_child_ns_ops(kobj
->parent
);
1068 bool kobj_ns_current_may_mount(enum kobj_ns_type type
)
1070 bool may_mount
= true;
1072 spin_lock(&kobj_ns_type_lock
);
1073 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1074 kobj_ns_ops_tbl
[type
])
1075 may_mount
= kobj_ns_ops_tbl
[type
]->current_may_mount();
1076 spin_unlock(&kobj_ns_type_lock
);
1081 void *kobj_ns_grab_current(enum kobj_ns_type type
)
1085 spin_lock(&kobj_ns_type_lock
);
1086 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1087 kobj_ns_ops_tbl
[type
])
1088 ns
= kobj_ns_ops_tbl
[type
]->grab_current_ns();
1089 spin_unlock(&kobj_ns_type_lock
);
1093 EXPORT_SYMBOL_GPL(kobj_ns_grab_current
);
1095 const void *kobj_ns_netlink(enum kobj_ns_type type
, struct sock
*sk
)
1097 const void *ns
= NULL
;
1099 spin_lock(&kobj_ns_type_lock
);
1100 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1101 kobj_ns_ops_tbl
[type
])
1102 ns
= kobj_ns_ops_tbl
[type
]->netlink_ns(sk
);
1103 spin_unlock(&kobj_ns_type_lock
);
1108 const void *kobj_ns_initial(enum kobj_ns_type type
)
1110 const void *ns
= NULL
;
1112 spin_lock(&kobj_ns_type_lock
);
1113 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1114 kobj_ns_ops_tbl
[type
])
1115 ns
= kobj_ns_ops_tbl
[type
]->initial_ns();
1116 spin_unlock(&kobj_ns_type_lock
);
1121 void kobj_ns_drop(enum kobj_ns_type type
, void *ns
)
1123 spin_lock(&kobj_ns_type_lock
);
1124 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1125 kobj_ns_ops_tbl
[type
] && kobj_ns_ops_tbl
[type
]->drop_ns
)
1126 kobj_ns_ops_tbl
[type
]->drop_ns(ns
);
1127 spin_unlock(&kobj_ns_type_lock
);
1129 EXPORT_SYMBOL_GPL(kobj_ns_drop
);