blob: 7cbccd2b4c72042595484e32c2e11906948414b7 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * kobject.c - library routines for handling generic kernel objects
3 *
4 * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org>
Greg Kroah-Hartmanf0e7e1b2007-09-27 14:48:53 -07005 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (c) 2006-2007 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
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>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050017#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/stat.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080019#include <linux/slab.h>
Bjorn Helgaas89c86a62013-12-05 17:37:51 -070020#include <linux/random.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Tejun Heoe34ff492013-09-11 22:29:05 -040022/**
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
Linus Torvaldsa1212d22013-11-07 20:47:28 +090037 return kobj->ktype->namespace(kobj);
Tejun Heoe34ff492013-09-11 22:29:05 -040038}
39
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080040/*
41 * populate_dir - populate directory with attributes.
42 * @kobj: object we're working on.
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080044 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080049static int populate_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080051 struct kobj_type *t = get_ktype(kobj);
52 struct attribute *attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 int error = 0;
54 int i;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 if (t && t->default_attrs) {
57 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080058 error = sysfs_create_file(kobj, attr);
59 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 break;
61 }
62 }
63 return error;
64}
65
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080066static int create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067{
Tejun Heoc84a3b22013-11-23 18:01:46 -050068 const struct kobj_ns_type_operations *ops;
Tejun Heoe34ff492013-09-11 22:29:05 -040069 int error;
70
71 error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
Tejun Heoc84a3b22013-11-23 18:01:46 -050072 if (error)
73 return error;
74
75 error = populate_dir(kobj);
76 if (error) {
77 sysfs_remove_dir(kobj);
78 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 }
Tejun Heo26ea12d2013-09-18 17:15:36 -040080
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
Tejun Heoc84a3b22013-11-23 18:01:46 -050087 /*
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
Tejun Heofa4cd452014-02-07 13:32:07 -050097 sysfs_enable_ns(kobj->sd);
Tejun Heoc84a3b22013-11-23 18:01:46 -050098 }
99
100 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103static int get_kobj_path_length(struct kobject *kobj)
104{
105 int length = 1;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800106 struct kobject *parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800108 /* walk up the ancestors until we hit the one pointing to the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * root.
110 * Add 1 to strlen for leading '/' of each level.
111 */
112 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500113 if (kobject_name(parent) == NULL)
114 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 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{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800123 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
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;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800130 strncpy(path + length, kobject_name(parent), cur);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 *(path + --length) = '/';
132 }
133
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800134 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
Harvey Harrison810304d2008-04-30 00:55:08 -0700135 kobj, __func__, path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136}
137
138/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800139 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 *
141 * @kobj: kobject in question, with which to build the path
142 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800143 *
144 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 */
Al Virofd4f2df2005-10-21 03:18:50 -0400146char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
148 char *path;
149 int len;
150
151 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500152 if (len == 0)
153 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800154 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 if (!path)
156 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 fill_kobj_path(kobj, path, len);
158
159 return path;
160}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400161EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100163/* 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
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800187static void kobject_init_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800189 if (!kobj)
190 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 kref_init(&kobj->kref);
192 INIT_LIST_HEAD(&kobj->entry);
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800193 kobj->state_in_sysfs = 0;
194 kobj->state_add_uevent_sent = 0;
195 kobj->state_remove_uevent_sent = 0;
196 kobj->state_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197}
198
199
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700200static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
202 int error = 0;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800203 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100205 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100207
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100208 if (!kobj->name || !kobj->name[0]) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700209 WARN(1, "kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800210 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800211 return -EINVAL;
212 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 parent = kobject_get(kobj->parent);
215
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100216 /* 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
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800224 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700225 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800226 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800227 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900229 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100231 kobj_kset_leave(kobj);
232 kobject_put(parent);
233 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800234
235 /* be noisy on error issues */
236 if (error == -EEXIST)
Dan Williams282029c2012-04-06 13:41:15 -0700237 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));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800241 else
Dan Williams282029c2012-04-06 13:41:15 -0700242 WARN(1, "%s failed for %s (error: %d parent: %s)\n",
243 __func__, kobject_name(kobj), error,
244 parent ? kobject_name(parent) : "'none'");
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100245 } else
246 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 return error;
249}
250
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700251/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500252 * kobject_set_name_vargs - Set the name of an kobject
253 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800254 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500255 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 */
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100257int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500258 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Rasmus Villemoesf773f322015-11-06 16:31:23 -0800260 const char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Kay Sievers8a577ff2009-04-18 15:05:45 -0700262 if (kobj->name && !fmt)
263 return 0;
264
Rasmus Villemoesf773f322015-11-06 16:31:23 -0800265 s = kvasprintf_const(GFP_KERNEL, fmt, vargs);
Rasmus Villemoes2abf1142015-06-25 15:02:30 -0700266 if (!s)
Kay Sieversa4ca6612008-04-30 02:06:29 +0200267 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500268
Rasmus Villemoesf773f322015-11-06 16:31:23 -0800269 /*
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);
Rasmus Villemoes2abf1142015-06-25 15:02:30 -0700286 kobj->name = s;
Kay Sievers9f255652008-05-06 22:24:04 +0200287
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500288 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{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200302 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500303 int retval;
304
Kay Sieversa4ca6612008-04-30 02:06:29 +0200305 va_start(vargs, fmt);
306 retval = kobject_set_name_vargs(kobj, fmt, vargs);
307 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500308
309 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311EXPORT_SYMBOL(kobject_set_name);
312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700314 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800315 * @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 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700325void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800326{
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 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100337 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800338 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100339 printk(KERN_ERR "kobject (%p): tried to init an initialized "
340 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800341 dump_stack();
342 }
343
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800344 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800345 kobj->ktype = ktype;
346 return;
347
348error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100349 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800350 dump_stack();
351}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700352EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800353
Nicolas Iooss8db14862015-07-17 16:23:42 -0700354static __printf(3, 0) int kobject_add_varg(struct kobject *kobj,
355 struct kobject *parent,
356 const char *fmt, va_list vargs)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800357{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800358 int retval;
359
Kay Sieversa4ca6612008-04-30 02:06:29 +0200360 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800361 if (retval) {
362 printk(KERN_ERR "kobject: can not set name properly!\n");
363 return retval;
364 }
365 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700366 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800367}
368
369/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700370 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800371 * @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
Bart Van Assche97057102014-01-04 14:20:04 +0100380 * kobject associated with the kset assigned to this kobject. If no kset
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800381 * 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.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800386 * 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 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100389 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800390 * 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 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700394int kobject_add(struct kobject *kobj, struct kobject *parent,
395 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800396{
397 va_list args;
398 int retval;
399
400 if (!kobj)
401 return -EINVAL;
402
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100403 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 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800410 va_start(args, fmt);
411 retval = kobject_add_varg(kobj, parent, fmt, args);
412 va_end(args);
413
414 return retval;
415}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700416EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800417
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800418/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800419 * 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 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700425 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700426 * kobject_add(). The same type of error handling after a call to
427 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800428 */
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
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700435 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800436
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/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800446 * kobject_rename - change the name of an object
447 * @kobj: object in question.
448 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700449 *
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800455int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800458 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700459 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800460 char *devpath_string = NULL;
461 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462
463 kobj = kobject_get(kobj);
464 if (!kobj)
465 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700466 if (!kobj->parent)
467 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800468
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;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800482
Rasmus Villemoesf773f322015-11-06 16:31:23 -0800483 name = dup_name = kstrdup_const(new_name, GFP_KERNEL);
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700484 if (!name) {
485 error = -ENOMEM;
486 goto out;
487 }
488
Tejun Heoe34ff492013-09-11 22:29:05 -0400489 error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700490 if (error)
491 goto out;
492
493 /* Install the new kobject name */
494 dup_name = kobj->name;
495 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800496
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. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700500 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800501
502out:
Rasmus Villemoesf773f322015-11-06 16:31:23 -0800503 kfree_const(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800504 kfree(devpath_string);
505 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700506 kobject_put(kobj);
507
508 return error;
509}
Alex Chiang8344b562008-06-10 15:30:42 -0600510EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700511
512/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800513 * kobject_move - move object to another parent
514 * @kobj: object in question.
515 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100516 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100517int 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) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100530 if (kobj->kset)
531 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100532 }
Tejun Heoe34ff492013-09-11 22:29:05 -0400533
Cornelia Huck8a824722006-11-20 17:07:51 +0100534 /* 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;
Tejun Heoe34ff492013-09-11 22:29:05 -0400548 error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
Cornelia Huck8a824722006-11-20 17:07:51 +0100549 if (error)
550 goto out;
551 old_parent = kobj->parent;
552 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300553 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100554 kobject_put(old_parent);
555 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
556out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300557 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100558 kobject_put(kobj);
559 kfree(devpath_string);
560 kfree(devpath);
561 return error;
562}
Anand Jain24199d22015-02-12 07:03:37 +0800563EXPORT_SYMBOL_GPL(kobject_move);
Cornelia Huck8a824722006-11-20 17:07:51 +0100564
565/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800566 * kobject_del - unlink kobject from hierarchy.
567 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800569void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
Tejun Heo324a56e2013-12-11 14:11:53 -0500571 struct kernfs_node *sd;
Tejun Heo26ea12d2013-09-18 17:15:36 -0400572
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800573 if (!kobj)
574 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100575
Tejun Heo26ea12d2013-09-18 17:15:36 -0400576 sd = kobj->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577 sysfs_remove_dir(kobj);
Tejun Heo26ea12d2013-09-18 17:15:36 -0400578 sysfs_put(sd);
579
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100580 kobj->state_in_sysfs = 0;
581 kobj_kset_leave(kobj);
582 kobject_put(kobj->parent);
583 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584}
Gabriel Somlofa40ae32015-08-10 15:51:43 -0400585EXPORT_SYMBOL(kobject_del);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
587/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800588 * kobject_get - increment refcount for object.
589 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800591struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592{
Ethan Zhaod82d54a2015-03-12 13:04:16 +0900593 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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 kref_get(&kobj->kref);
Ethan Zhaod82d54a2015-03-12 13:04:16 +0900599 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return kobj;
601}
Gabriel Somlofa40ae32015-08-10 15:51:43 -0400602EXPORT_SYMBOL(kobject_get);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Anatol Pomozov2d864e42013-05-07 15:37:48 -0700604static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700605{
606 if (!kref_get_unless_zero(&kobj->kref))
607 kobj = NULL;
608 return kobj;
609}
610
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800611/*
612 * kobject_cleanup - free kobject resources.
613 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800615static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100617 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100618 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619
Russell Kingc817a672013-06-27 15:06:14 +0100620 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
621 kobject_name(kobj), kobj, __func__, kobj->parent);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100622
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
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700642 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100643 pr_debug("kobject: '%s' (%p): calling ktype release\n",
644 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100646 }
647
648 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100649 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100650 pr_debug("kobject: '%s': free name\n", name);
Rasmus Villemoesf773f322015-11-06 16:31:23 -0800651 kfree_const(name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700652 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653}
654
Russell Kingc817a672013-06-27 15:06:14 +0100655#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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663static void kobject_release(struct kref *kref)
664{
Russell Kingc817a672013-06-27 15:06:14 +0100665 struct kobject *kobj = container_of(kref, struct kobject, kref);
666#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
Bjorn Helgaas89c86a62013-12-05 17:37:51 -0700667 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);
Russell Kingc817a672013-06-27 15:06:14 +0100670 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
Bjorn Helgaas89c86a62013-12-05 17:37:51 -0700671
672 schedule_delayed_work(&kobj->release, delay);
Russell Kingc817a672013-06-27 15:06:14 +0100673#else
674 kobject_cleanup(kobj);
675#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
677
678/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800679 * kobject_put - decrement refcount for object.
680 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800682 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800684void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800686 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700687 if (!kobj->state_initialized)
688 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800689 "initialized, yet kobject_put() is being "
690 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800692 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693}
Gabriel Somlofa40ae32015-08-10 15:51:43 -0400694EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800696static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500697{
Harvey Harrison810304d2008-04-30 00:55:08 -0700698 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500699 kfree(kobj);
700}
701
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800702static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100703 .release = dynamic_kobj_release,
704 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500705};
706
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800707/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800708 * 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.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800714 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700715 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800716 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800717 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800718struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800719{
720 struct kobject *kobj;
721
722 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
723 if (!kobj)
724 return NULL;
725
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700726 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800727 return kobj;
728}
729
730/**
731 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
732 *
Zhi Yong Wu9ff1f832012-05-07 10:48:25 +0800733 * @name: the name for the kobject
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800734 * @parent: the parent kobject of this kobject, if any.
735 *
Dave Youngf70701a2008-01-28 16:58:00 +0800736 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800737 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800738 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800739 * 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
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700752 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800753 if (retval) {
754 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700755 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800756 kobject_put(kobj);
757 kobj = NULL;
758 }
759 return kobj;
760}
761EXPORT_SYMBOL_GPL(kobject_create_and_add);
762
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500763/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800764 * kset_init - initialize a kset for use
765 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800767void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700769 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 INIT_LIST_HEAD(&k->list);
771 spin_lock_init(&k->list_lock);
772}
773
Kay Sievers23b52122007-11-02 13:47:53 +0100774/* 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
Emese Revfy52cf25d2010-01-19 02:58:23 +0100799const struct sysfs_ops kobj_sysfs_ops = {
Kay Sievers23b52122007-11-02 13:47:53 +0100800 .show = kobj_attr_show,
801 .store = kobj_attr_store,
802};
Jeff Mahoney29dfe2d2013-11-01 13:06:56 -0400803EXPORT_SYMBOL_GPL(kobj_sysfs_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804
805/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800806 * kset_register - initialize and add a kset.
807 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800809int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810{
Kay Sievers80f03e32007-05-26 11:21:36 +0200811 int err;
812
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800813 if (!k)
814 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200815
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700817 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200818 if (err)
819 return err;
820 kobject_uevent(&k->kobj, KOBJ_ADD);
821 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822}
Gabriel Somlofa40ae32015-08-10 15:51:43 -0400823EXPORT_SYMBOL(kset_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800826 * kset_unregister - remove a kset.
827 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800829void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800831 if (!k)
832 return;
Bjorn Helgaas35a5fe62013-12-05 17:38:00 -0700833 kobject_del(&k->kobj);
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800834 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
Gabriel Somlofa40ae32015-08-10 15:51:43 -0400836EXPORT_SYMBOL(kset_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800839 * kset_find_obj - search for object in kset.
840 * @kset: kset we're looking in.
841 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800843 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800847struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400849 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800850 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851
852 spin_lock(&kset->list_lock);
Robin Holtc25d1df2010-09-29 14:00:54 -0500853
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400854 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800855 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700856 ret = kobject_get_unless_zero(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 break;
858 }
859 }
Robin Holtc25d1df2010-09-29 14:00:54 -0500860
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 spin_unlock(&kset->list_lock);
862 return ret;
863}
864
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700865static void kset_release(struct kobject *kobj)
866{
867 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800868 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700869 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700870 kfree(kset);
871}
872
Kay Sievers386f2752007-11-02 13:47:53 +0100873static struct kobj_type kset_ktype = {
874 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700875 .release = kset_release,
876};
877
878/**
879 * kset_create - create a struct kset dynamically
880 *
881 * @name: the name for the kset
882 * @uevent_ops: a struct kset_uevent_ops for the kset
883 * @parent_kobj: the parent kobject of this kset, if any.
884 *
885 * This function creates a kset structure dynamically. This structure can
886 * then be registered with the system and show up in sysfs with a call to
887 * kset_register(). When you are finished with this structure, if
888 * kset_register() has been called, call kset_unregister() and the
889 * structure will be dynamically freed when it is no longer being used.
890 *
891 * If the kset was not able to be created, NULL will be returned.
892 */
893static struct kset *kset_create(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100894 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700895 struct kobject *parent_kobj)
896{
897 struct kset *kset;
Dave Youngd9cd8f32009-05-11 14:17:45 +0800898 int retval;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700899
900 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
901 if (!kset)
902 return NULL;
Kees Cookb7165eb2013-06-06 13:52:19 -0700903 retval = kobject_set_name(&kset->kobj, "%s", name);
Dave Youngd9cd8f32009-05-11 14:17:45 +0800904 if (retval) {
905 kfree(kset);
906 return NULL;
907 }
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700908 kset->uevent_ops = uevent_ops;
909 kset->kobj.parent = parent_kobj;
910
911 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100912 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700913 * no kset itself. That way we can properly free it when it is
914 * finished being used.
915 */
Kay Sievers386f2752007-11-02 13:47:53 +0100916 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700917 kset->kobj.kset = NULL;
918
919 return kset;
920}
921
922/**
923 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
924 *
925 * @name: the name for the kset
926 * @uevent_ops: a struct kset_uevent_ops for the kset
927 * @parent_kobj: the parent kobject of this kset, if any.
928 *
929 * This function creates a kset structure dynamically and registers it
930 * with sysfs. When you are finished with this structure, call
931 * kset_unregister() and the structure will be dynamically freed when it
932 * is no longer being used.
933 *
934 * If the kset was not able to be created, NULL will be returned.
935 */
936struct kset *kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100937 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700938 struct kobject *parent_kobj)
939{
940 struct kset *kset;
941 int error;
942
943 kset = kset_create(name, uevent_ops, parent_kobj);
944 if (!kset)
945 return NULL;
946 error = kset_register(kset);
947 if (error) {
948 kfree(kset);
949 return NULL;
950 }
951 return kset;
952}
953EXPORT_SYMBOL_GPL(kset_create_and_add);
954
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700955
956static DEFINE_SPINLOCK(kobj_ns_type_lock);
957static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
958
959int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
960{
961 enum kobj_ns_type type = ops->type;
962 int error;
963
964 spin_lock(&kobj_ns_type_lock);
965
966 error = -EINVAL;
967 if (type >= KOBJ_NS_TYPES)
968 goto out;
969
970 error = -EINVAL;
971 if (type <= KOBJ_NS_TYPE_NONE)
972 goto out;
973
974 error = -EBUSY;
975 if (kobj_ns_ops_tbl[type])
976 goto out;
977
978 error = 0;
979 kobj_ns_ops_tbl[type] = ops;
980
981out:
982 spin_unlock(&kobj_ns_type_lock);
983 return error;
984}
985
986int kobj_ns_type_registered(enum kobj_ns_type type)
987{
988 int registered = 0;
989
990 spin_lock(&kobj_ns_type_lock);
991 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
992 registered = kobj_ns_ops_tbl[type] != NULL;
993 spin_unlock(&kobj_ns_type_lock);
994
995 return registered;
996}
997
998const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
999{
1000 const struct kobj_ns_type_operations *ops = NULL;
1001
Pankaj Dubey41fb96a2014-09-24 16:25:54 +05301002 if (parent && parent->ktype && parent->ktype->child_ns_type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001003 ops = parent->ktype->child_ns_type(parent);
1004
1005 return ops;
1006}
1007
1008const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
1009{
1010 return kobj_child_ns_ops(kobj->parent);
1011}
1012
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001013bool kobj_ns_current_may_mount(enum kobj_ns_type type)
1014{
Eric W. Biederman730d7d32013-09-23 14:41:17 -07001015 bool may_mount = true;
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001016
1017 spin_lock(&kobj_ns_type_lock);
1018 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1019 kobj_ns_ops_tbl[type])
1020 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
1021 spin_unlock(&kobj_ns_type_lock);
1022
1023 return may_mount;
1024}
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001025
Al Viroa685e082011-06-08 21:13:01 -04001026void *kobj_ns_grab_current(enum kobj_ns_type type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001027{
Al Viroa685e082011-06-08 21:13:01 -04001028 void *ns = NULL;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001029
1030 spin_lock(&kobj_ns_type_lock);
1031 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1032 kobj_ns_ops_tbl[type])
Al Viroa685e082011-06-08 21:13:01 -04001033 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001034 spin_unlock(&kobj_ns_type_lock);
1035
1036 return ns;
1037}
1038
1039const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1040{
1041 const void *ns = NULL;
1042
1043 spin_lock(&kobj_ns_type_lock);
1044 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1045 kobj_ns_ops_tbl[type])
1046 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1047 spin_unlock(&kobj_ns_type_lock);
1048
1049 return ns;
1050}
1051
1052const void *kobj_ns_initial(enum kobj_ns_type type)
1053{
1054 const void *ns = NULL;
1055
1056 spin_lock(&kobj_ns_type_lock);
1057 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1058 kobj_ns_ops_tbl[type])
1059 ns = kobj_ns_ops_tbl[type]->initial_ns();
1060 spin_unlock(&kobj_ns_type_lock);
1061
1062 return ns;
1063}
1064
Al Viroa685e082011-06-08 21:13:01 -04001065void kobj_ns_drop(enum kobj_ns_type type, void *ns)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001066{
Al Viroa685e082011-06-08 21:13:01 -04001067 spin_lock(&kobj_ns_type_lock);
1068 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1069 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1070 kobj_ns_ops_tbl[type]->drop_ns(ns);
1071 spin_unlock(&kobj_ns_type_lock);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001072}