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
);
504 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
509 devpath_string
= kmalloc(strlen(devpath
) + 15, GFP_KERNEL
);
510 if (!devpath_string
) {
514 sprintf(devpath_string
, "DEVPATH_OLD=%s", devpath
);
515 envp
[0] = devpath_string
;
518 name
= dup_name
= kstrdup_const(new_name
, GFP_KERNEL
);
524 error
= sysfs_rename_dir_ns(kobj
, new_name
, kobject_namespace(kobj
));
528 /* Install the new kobject name */
529 dup_name
= kobj
->name
;
532 /* This function is mostly/only used for network interface.
533 * Some hotplug package track interfaces by their name and
534 * therefore want to know when the name is changed by the user. */
535 kobject_uevent_env(kobj
, KOBJ_MOVE
, envp
);
538 kfree_const(dup_name
);
539 kfree(devpath_string
);
545 EXPORT_SYMBOL_GPL(kobject_rename
);
548 * kobject_move() - Move object to another parent.
549 * @kobj: object in question.
550 * @new_parent: object's new parent (can be NULL)
552 int kobject_move(struct kobject
*kobj
, struct kobject
*new_parent
)
555 struct kobject
*old_parent
;
556 const char *devpath
= NULL
;
557 char *devpath_string
= NULL
;
560 kobj
= kobject_get(kobj
);
563 new_parent
= kobject_get(new_parent
);
566 new_parent
= kobject_get(&kobj
->kset
->kobj
);
569 /* old object path */
570 devpath
= kobject_get_path(kobj
, GFP_KERNEL
);
575 devpath_string
= kmalloc(strlen(devpath
) + 15, GFP_KERNEL
);
576 if (!devpath_string
) {
580 sprintf(devpath_string
, "DEVPATH_OLD=%s", devpath
);
581 envp
[0] = devpath_string
;
583 error
= sysfs_move_dir_ns(kobj
, new_parent
, kobject_namespace(kobj
));
586 old_parent
= kobj
->parent
;
587 kobj
->parent
= new_parent
;
589 kobject_put(old_parent
);
590 kobject_uevent_env(kobj
, KOBJ_MOVE
, envp
);
592 kobject_put(new_parent
);
594 kfree(devpath_string
);
598 EXPORT_SYMBOL_GPL(kobject_move
);
601 * kobject_del() - Unlink kobject from hierarchy.
604 * This is the function that should be called to delete an object
605 * successfully added via kobject_add().
607 void kobject_del(struct kobject
*kobj
)
609 struct kernfs_node
*sd
;
610 const struct kobj_type
*ktype
;
616 ktype
= get_ktype(kobj
);
619 sysfs_remove_groups(kobj
, ktype
->default_groups
);
621 sysfs_remove_dir(kobj
);
624 kobj
->state_in_sysfs
= 0;
625 kobj_kset_leave(kobj
);
626 kobject_put(kobj
->parent
);
629 EXPORT_SYMBOL(kobject_del
);
632 * kobject_get() - Increment refcount for object.
635 struct kobject
*kobject_get(struct kobject
*kobj
)
638 if (!kobj
->state_initialized
)
640 "kobject: '%s' (%p): is not initialized, yet kobject_get() is being called.\n",
641 kobject_name(kobj
), kobj
);
642 kref_get(&kobj
->kref
);
646 EXPORT_SYMBOL(kobject_get
);
648 struct kobject
* __must_check
kobject_get_unless_zero(struct kobject
*kobj
)
652 if (!kref_get_unless_zero(&kobj
->kref
))
656 EXPORT_SYMBOL(kobject_get_unless_zero
);
659 * kobject_cleanup - free kobject resources.
660 * @kobj: object to cleanup
662 static void kobject_cleanup(struct kobject
*kobj
)
664 struct kobj_type
*t
= get_ktype(kobj
);
665 const char *name
= kobj
->name
;
667 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
668 kobject_name(kobj
), kobj
, __func__
, kobj
->parent
);
670 if (t
&& !t
->release
)
671 pr_debug("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/kobject.txt.\n",
672 kobject_name(kobj
), kobj
);
674 /* send "remove" if the caller did not do it but sent "add" */
675 if (kobj
->state_add_uevent_sent
&& !kobj
->state_remove_uevent_sent
) {
676 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
677 kobject_name(kobj
), kobj
);
678 kobject_uevent(kobj
, KOBJ_REMOVE
);
681 /* remove from sysfs if the caller did not do it */
682 if (kobj
->state_in_sysfs
) {
683 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
684 kobject_name(kobj
), kobj
);
688 if (t
&& t
->release
) {
689 pr_debug("kobject: '%s' (%p): calling ktype release\n",
690 kobject_name(kobj
), kobj
);
694 /* free name if we allocated it */
696 pr_debug("kobject: '%s': free name\n", name
);
701 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
702 static void kobject_delayed_cleanup(struct work_struct
*work
)
704 kobject_cleanup(container_of(to_delayed_work(work
),
705 struct kobject
, release
));
709 static void kobject_release(struct kref
*kref
)
711 struct kobject
*kobj
= container_of(kref
, struct kobject
, kref
);
712 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
713 unsigned long delay
= HZ
+ HZ
* (get_random_int() & 0x3);
714 pr_info("kobject: '%s' (%p): %s, parent %p (delayed %ld)\n",
715 kobject_name(kobj
), kobj
, __func__
, kobj
->parent
, delay
);
716 INIT_DELAYED_WORK(&kobj
->release
, kobject_delayed_cleanup
);
718 schedule_delayed_work(&kobj
->release
, delay
);
720 kobject_cleanup(kobj
);
725 * kobject_put() - Decrement refcount for object.
728 * Decrement the refcount, and if 0, call kobject_cleanup().
730 void kobject_put(struct kobject
*kobj
)
733 if (!kobj
->state_initialized
)
735 "kobject: '%s' (%p): is not initialized, yet kobject_put() is being called.\n",
736 kobject_name(kobj
), kobj
);
737 kref_put(&kobj
->kref
, kobject_release
);
740 EXPORT_SYMBOL(kobject_put
);
742 static void dynamic_kobj_release(struct kobject
*kobj
)
744 pr_debug("kobject: (%p): %s\n", kobj
, __func__
);
748 static struct kobj_type dynamic_kobj_ktype
= {
749 .release
= dynamic_kobj_release
,
750 .sysfs_ops
= &kobj_sysfs_ops
,
754 * kobject_create() - Create a struct kobject dynamically.
756 * This function creates a kobject structure dynamically and sets it up
757 * to be a "dynamic" kobject with a default release function set up.
759 * If the kobject was not able to be created, NULL will be returned.
760 * The kobject structure returned from here must be cleaned up with a
761 * call to kobject_put() and not kfree(), as kobject_init() has
762 * already been called on this structure.
764 struct kobject
*kobject_create(void)
766 struct kobject
*kobj
;
768 kobj
= kzalloc(sizeof(*kobj
), GFP_KERNEL
);
772 kobject_init(kobj
, &dynamic_kobj_ktype
);
777 * kobject_create_and_add() - Create a struct kobject dynamically and
778 * register it with sysfs.
779 * @name: the name for the kobject
780 * @parent: the parent kobject of this kobject, if any.
782 * This function creates a kobject structure dynamically and registers it
783 * with sysfs. When you are finished with this structure, call
784 * kobject_put() and the structure will be dynamically freed when
785 * it is no longer being used.
787 * If the kobject was not able to be created, NULL will be returned.
789 struct kobject
*kobject_create_and_add(const char *name
, struct kobject
*parent
)
791 struct kobject
*kobj
;
794 kobj
= kobject_create();
798 retval
= kobject_add(kobj
, parent
, "%s", name
);
800 pr_warn("%s: kobject_add error: %d\n", __func__
, retval
);
806 EXPORT_SYMBOL_GPL(kobject_create_and_add
);
809 * kset_init() - Initialize a kset for use.
812 void kset_init(struct kset
*k
)
814 kobject_init_internal(&k
->kobj
);
815 INIT_LIST_HEAD(&k
->list
);
816 spin_lock_init(&k
->list_lock
);
819 /* default kobject attribute operations */
820 static ssize_t
kobj_attr_show(struct kobject
*kobj
, struct attribute
*attr
,
823 struct kobj_attribute
*kattr
;
826 kattr
= container_of(attr
, struct kobj_attribute
, attr
);
828 ret
= kattr
->show(kobj
, kattr
, buf
);
832 static ssize_t
kobj_attr_store(struct kobject
*kobj
, struct attribute
*attr
,
833 const char *buf
, size_t count
)
835 struct kobj_attribute
*kattr
;
838 kattr
= container_of(attr
, struct kobj_attribute
, attr
);
840 ret
= kattr
->store(kobj
, kattr
, buf
, count
);
844 const struct sysfs_ops kobj_sysfs_ops
= {
845 .show
= kobj_attr_show
,
846 .store
= kobj_attr_store
,
848 EXPORT_SYMBOL_GPL(kobj_sysfs_ops
);
851 * kset_register() - Initialize and add a kset.
854 int kset_register(struct kset
*k
)
862 err
= kobject_add_internal(&k
->kobj
);
865 kobject_uevent(&k
->kobj
, KOBJ_ADD
);
868 EXPORT_SYMBOL(kset_register
);
871 * kset_unregister() - Remove a kset.
874 void kset_unregister(struct kset
*k
)
878 kobject_del(&k
->kobj
);
879 kobject_put(&k
->kobj
);
881 EXPORT_SYMBOL(kset_unregister
);
884 * kset_find_obj() - Search for object in kset.
885 * @kset: kset we're looking in.
886 * @name: object's name.
888 * Lock kset via @kset->subsys, and iterate over @kset->list,
889 * looking for a matching kobject. If matching object is found
890 * take a reference and return the object.
892 struct kobject
*kset_find_obj(struct kset
*kset
, const char *name
)
895 struct kobject
*ret
= NULL
;
897 spin_lock(&kset
->list_lock
);
899 list_for_each_entry(k
, &kset
->list
, entry
) {
900 if (kobject_name(k
) && !strcmp(kobject_name(k
), name
)) {
901 ret
= kobject_get_unless_zero(k
);
906 spin_unlock(&kset
->list_lock
);
909 EXPORT_SYMBOL_GPL(kset_find_obj
);
911 static void kset_release(struct kobject
*kobj
)
913 struct kset
*kset
= container_of(kobj
, struct kset
, kobj
);
914 pr_debug("kobject: '%s' (%p): %s\n",
915 kobject_name(kobj
), kobj
, __func__
);
919 static void kset_get_ownership(struct kobject
*kobj
, kuid_t
*uid
, kgid_t
*gid
)
922 kobject_get_ownership(kobj
->parent
, uid
, gid
);
925 static struct kobj_type kset_ktype
= {
926 .sysfs_ops
= &kobj_sysfs_ops
,
927 .release
= kset_release
,
928 .get_ownership
= kset_get_ownership
,
932 * kset_create() - Create a struct kset dynamically.
934 * @name: the name for the kset
935 * @uevent_ops: a struct kset_uevent_ops for the kset
936 * @parent_kobj: the parent kobject of this kset, if any.
938 * This function creates a kset structure dynamically. This structure can
939 * then be registered with the system and show up in sysfs with a call to
940 * kset_register(). When you are finished with this structure, if
941 * kset_register() has been called, call kset_unregister() and the
942 * structure will be dynamically freed when it is no longer being used.
944 * If the kset was not able to be created, NULL will be returned.
946 static struct kset
*kset_create(const char *name
,
947 const struct kset_uevent_ops
*uevent_ops
,
948 struct kobject
*parent_kobj
)
953 kset
= kzalloc(sizeof(*kset
), GFP_KERNEL
);
956 retval
= kobject_set_name(&kset
->kobj
, "%s", name
);
961 kset
->uevent_ops
= uevent_ops
;
962 kset
->kobj
.parent
= parent_kobj
;
965 * The kobject of this kset will have a type of kset_ktype and belong to
966 * no kset itself. That way we can properly free it when it is
967 * finished being used.
969 kset
->kobj
.ktype
= &kset_ktype
;
970 kset
->kobj
.kset
= NULL
;
976 * kset_create_and_add() - Create a struct kset dynamically and add it to sysfs.
978 * @name: the name for the kset
979 * @uevent_ops: a struct kset_uevent_ops for the kset
980 * @parent_kobj: the parent kobject of this kset, if any.
982 * This function creates a kset structure dynamically and registers it
983 * with sysfs. When you are finished with this structure, call
984 * kset_unregister() and the structure will be dynamically freed when it
985 * is no longer being used.
987 * If the kset was not able to be created, NULL will be returned.
989 struct kset
*kset_create_and_add(const char *name
,
990 const struct kset_uevent_ops
*uevent_ops
,
991 struct kobject
*parent_kobj
)
996 kset
= kset_create(name
, uevent_ops
, parent_kobj
);
999 error
= kset_register(kset
);
1006 EXPORT_SYMBOL_GPL(kset_create_and_add
);
1009 static DEFINE_SPINLOCK(kobj_ns_type_lock
);
1010 static const struct kobj_ns_type_operations
*kobj_ns_ops_tbl
[KOBJ_NS_TYPES
];
1012 int kobj_ns_type_register(const struct kobj_ns_type_operations
*ops
)
1014 enum kobj_ns_type type
= ops
->type
;
1017 spin_lock(&kobj_ns_type_lock
);
1020 if (type
>= KOBJ_NS_TYPES
)
1024 if (type
<= KOBJ_NS_TYPE_NONE
)
1028 if (kobj_ns_ops_tbl
[type
])
1032 kobj_ns_ops_tbl
[type
] = ops
;
1035 spin_unlock(&kobj_ns_type_lock
);
1039 int kobj_ns_type_registered(enum kobj_ns_type type
)
1043 spin_lock(&kobj_ns_type_lock
);
1044 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
))
1045 registered
= kobj_ns_ops_tbl
[type
] != NULL
;
1046 spin_unlock(&kobj_ns_type_lock
);
1051 const struct kobj_ns_type_operations
*kobj_child_ns_ops(struct kobject
*parent
)
1053 const struct kobj_ns_type_operations
*ops
= NULL
;
1055 if (parent
&& parent
->ktype
&& parent
->ktype
->child_ns_type
)
1056 ops
= parent
->ktype
->child_ns_type(parent
);
1061 const struct kobj_ns_type_operations
*kobj_ns_ops(struct kobject
*kobj
)
1063 return kobj_child_ns_ops(kobj
->parent
);
1066 bool kobj_ns_current_may_mount(enum kobj_ns_type type
)
1068 bool may_mount
= true;
1070 spin_lock(&kobj_ns_type_lock
);
1071 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1072 kobj_ns_ops_tbl
[type
])
1073 may_mount
= kobj_ns_ops_tbl
[type
]->current_may_mount();
1074 spin_unlock(&kobj_ns_type_lock
);
1079 void *kobj_ns_grab_current(enum kobj_ns_type type
)
1083 spin_lock(&kobj_ns_type_lock
);
1084 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1085 kobj_ns_ops_tbl
[type
])
1086 ns
= kobj_ns_ops_tbl
[type
]->grab_current_ns();
1087 spin_unlock(&kobj_ns_type_lock
);
1091 EXPORT_SYMBOL_GPL(kobj_ns_grab_current
);
1093 const void *kobj_ns_netlink(enum kobj_ns_type type
, struct sock
*sk
)
1095 const void *ns
= NULL
;
1097 spin_lock(&kobj_ns_type_lock
);
1098 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1099 kobj_ns_ops_tbl
[type
])
1100 ns
= kobj_ns_ops_tbl
[type
]->netlink_ns(sk
);
1101 spin_unlock(&kobj_ns_type_lock
);
1106 const void *kobj_ns_initial(enum kobj_ns_type type
)
1108 const void *ns
= NULL
;
1110 spin_lock(&kobj_ns_type_lock
);
1111 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1112 kobj_ns_ops_tbl
[type
])
1113 ns
= kobj_ns_ops_tbl
[type
]->initial_ns();
1114 spin_unlock(&kobj_ns_type_lock
);
1119 void kobj_ns_drop(enum kobj_ns_type type
, void *ns
)
1121 spin_lock(&kobj_ns_type_lock
);
1122 if ((type
> KOBJ_NS_TYPE_NONE
) && (type
< KOBJ_NS_TYPES
) &&
1123 kobj_ns_ops_tbl
[type
] && kobj_ns_ops_tbl
[type
]->drop_ns
)
1124 kobj_ns_ops_tbl
[type
]->drop_ns(ns
);
1125 spin_unlock(&kobj_ns_type_lock
);
1127 EXPORT_SYMBOL_GPL(kobj_ns_drop
);