blob: 2e3bd01964a9047f481862c2323be8c4ea42db9c [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{
Kay Sievers9f255652008-05-06 22:24:04 +0200260 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 Villemoes2abf1142015-06-25 15:02:30 -0700265 s = kvasprintf(GFP_KERNEL, fmt, vargs);
266 if (!s)
Kay Sieversa4ca6612008-04-30 02:06:29 +0200267 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500268
Kay Sievers9f255652008-05-06 22:24:04 +0200269 /* ewww... some of these buggers have '/' in the name ... */
Rasmus Villemoes2abf1142015-06-25 15:02:30 -0700270 strreplace(s, '/', '!');
271 kfree(kobj->name);
272 kobj->name = s;
Kay Sievers9f255652008-05-06 22:24:04 +0200273
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500274 return 0;
275}
276
277/**
278 * kobject_set_name - Set the name of a kobject
279 * @kobj: struct kobject to set the name of
280 * @fmt: format string used to build the name
281 *
282 * This sets the name of the kobject. If you have already added the
283 * kobject to the system, you must call kobject_rename() in order to
284 * change the name of the kobject.
285 */
286int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
287{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200288 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500289 int retval;
290
Kay Sieversa4ca6612008-04-30 02:06:29 +0200291 va_start(vargs, fmt);
292 retval = kobject_set_name_vargs(kobj, fmt, vargs);
293 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500294
295 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297EXPORT_SYMBOL(kobject_set_name);
298
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700300 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800301 * @kobj: pointer to the kobject to initialize
302 * @ktype: pointer to the ktype for this kobject.
303 *
304 * This function will properly initialize a kobject such that it can then
305 * be passed to the kobject_add() call.
306 *
307 * After this function is called, the kobject MUST be cleaned up by a call
308 * to kobject_put(), not by a call to kfree directly to ensure that all of
309 * the memory is cleaned up properly.
310 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700311void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800312{
313 char *err_str;
314
315 if (!kobj) {
316 err_str = "invalid kobject pointer!";
317 goto error;
318 }
319 if (!ktype) {
320 err_str = "must have a ktype to be initialized properly!\n";
321 goto error;
322 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100323 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800324 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100325 printk(KERN_ERR "kobject (%p): tried to init an initialized "
326 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800327 dump_stack();
328 }
329
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800330 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800331 kobj->ktype = ktype;
332 return;
333
334error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100335 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800336 dump_stack();
337}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700338EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800339
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800340static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
341 const char *fmt, va_list vargs)
342{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800343 int retval;
344
Kay Sieversa4ca6612008-04-30 02:06:29 +0200345 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800346 if (retval) {
347 printk(KERN_ERR "kobject: can not set name properly!\n");
348 return retval;
349 }
350 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700351 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800352}
353
354/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700355 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800356 * @kobj: the kobject to add
357 * @parent: pointer to the parent of the kobject.
358 * @fmt: format to name the kobject with.
359 *
360 * The kobject name is set and added to the kobject hierarchy in this
361 * function.
362 *
363 * If @parent is set, then the parent of the @kobj will be set to it.
364 * If @parent is NULL, then the parent of the @kobj will be set to the
Bart Van Assche97057102014-01-04 14:20:04 +0100365 * kobject associated with the kset assigned to this kobject. If no kset
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800366 * is assigned to the kobject, then the kobject will be located in the
367 * root of the sysfs tree.
368 *
369 * If this function returns an error, kobject_put() must be called to
370 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800371 * Under no instance should the kobject that is passed to this function
372 * be directly freed with a call to kfree(), that can leak memory.
373 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100374 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800375 * up all of the necessary sysfs files for the object and then call
376 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
377 * userspace is properly notified of this kobject's creation.
378 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700379int kobject_add(struct kobject *kobj, struct kobject *parent,
380 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800381{
382 va_list args;
383 int retval;
384
385 if (!kobj)
386 return -EINVAL;
387
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100388 if (!kobj->state_initialized) {
389 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
390 "uninitialized object, something is seriously wrong.\n",
391 kobject_name(kobj), kobj);
392 dump_stack();
393 return -EINVAL;
394 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800395 va_start(args, fmt);
396 retval = kobject_add_varg(kobj, parent, fmt, args);
397 va_end(args);
398
399 return retval;
400}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700401EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800402
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800403/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800404 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
405 * @kobj: pointer to the kobject to initialize
406 * @ktype: pointer to the ktype for this kobject.
407 * @parent: pointer to the parent of this kobject.
408 * @fmt: the name of the kobject.
409 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700410 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700411 * kobject_add(). The same type of error handling after a call to
412 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800413 */
414int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
415 struct kobject *parent, const char *fmt, ...)
416{
417 va_list args;
418 int retval;
419
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700420 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800421
422 va_start(args, fmt);
423 retval = kobject_add_varg(kobj, parent, fmt, args);
424 va_end(args);
425
426 return retval;
427}
428EXPORT_SYMBOL_GPL(kobject_init_and_add);
429
430/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800431 * kobject_rename - change the name of an object
432 * @kobj: object in question.
433 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700434 *
435 * It is the responsibility of the caller to provide mutual
436 * exclusion between two different calls of kobject_rename
437 * on the same kobject and to ensure that new_name is valid and
438 * won't conflict with other kobjects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800440int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800443 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700444 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800445 char *devpath_string = NULL;
446 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
448 kobj = kobject_get(kobj);
449 if (!kobj)
450 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700451 if (!kobj->parent)
452 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800453
454 devpath = kobject_get_path(kobj, GFP_KERNEL);
455 if (!devpath) {
456 error = -ENOMEM;
457 goto out;
458 }
459 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
460 if (!devpath_string) {
461 error = -ENOMEM;
462 goto out;
463 }
464 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
465 envp[0] = devpath_string;
466 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800467
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700468 name = dup_name = kstrdup(new_name, GFP_KERNEL);
469 if (!name) {
470 error = -ENOMEM;
471 goto out;
472 }
473
Tejun Heoe34ff492013-09-11 22:29:05 -0400474 error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700475 if (error)
476 goto out;
477
478 /* Install the new kobject name */
479 dup_name = kobj->name;
480 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800481
482 /* This function is mostly/only used for network interface.
483 * Some hotplug package track interfaces by their name and
484 * therefore want to know when the name is changed by the user. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700485 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800486
487out:
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700488 kfree(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800489 kfree(devpath_string);
490 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700491 kobject_put(kobj);
492
493 return error;
494}
Alex Chiang8344b562008-06-10 15:30:42 -0600495EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700496
497/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800498 * kobject_move - move object to another parent
499 * @kobj: object in question.
500 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100501 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100502int kobject_move(struct kobject *kobj, struct kobject *new_parent)
503{
504 int error;
505 struct kobject *old_parent;
506 const char *devpath = NULL;
507 char *devpath_string = NULL;
508 char *envp[2];
509
510 kobj = kobject_get(kobj);
511 if (!kobj)
512 return -EINVAL;
513 new_parent = kobject_get(new_parent);
514 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100515 if (kobj->kset)
516 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100517 }
Tejun Heoe34ff492013-09-11 22:29:05 -0400518
Cornelia Huck8a824722006-11-20 17:07:51 +0100519 /* old object path */
520 devpath = kobject_get_path(kobj, GFP_KERNEL);
521 if (!devpath) {
522 error = -ENOMEM;
523 goto out;
524 }
525 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
526 if (!devpath_string) {
527 error = -ENOMEM;
528 goto out;
529 }
530 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
531 envp[0] = devpath_string;
532 envp[1] = NULL;
Tejun Heoe34ff492013-09-11 22:29:05 -0400533 error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
Cornelia Huck8a824722006-11-20 17:07:51 +0100534 if (error)
535 goto out;
536 old_parent = kobj->parent;
537 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300538 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100539 kobject_put(old_parent);
540 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
541out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300542 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100543 kobject_put(kobj);
544 kfree(devpath_string);
545 kfree(devpath);
546 return error;
547}
Anand Jain24199d22015-02-12 07:03:37 +0800548EXPORT_SYMBOL_GPL(kobject_move);
Cornelia Huck8a824722006-11-20 17:07:51 +0100549
550/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800551 * kobject_del - unlink kobject from hierarchy.
552 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800554void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
Tejun Heo324a56e2013-12-11 14:11:53 -0500556 struct kernfs_node *sd;
Tejun Heo26ea12d2013-09-18 17:15:36 -0400557
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800558 if (!kobj)
559 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100560
Tejun Heo26ea12d2013-09-18 17:15:36 -0400561 sd = kobj->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 sysfs_remove_dir(kobj);
Tejun Heo26ea12d2013-09-18 17:15:36 -0400563 sysfs_put(sd);
564
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100565 kobj->state_in_sysfs = 0;
566 kobj_kset_leave(kobj);
567 kobject_put(kobj->parent);
568 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
570
571/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800572 * kobject_get - increment refcount for object.
573 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800575struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
Ethan Zhaod82d54a2015-03-12 13:04:16 +0900577 if (kobj) {
578 if (!kobj->state_initialized)
579 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
580 "initialized, yet kobject_get() is being "
581 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 kref_get(&kobj->kref);
Ethan Zhaod82d54a2015-03-12 13:04:16 +0900583 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 return kobj;
585}
586
Anatol Pomozov2d864e42013-05-07 15:37:48 -0700587static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700588{
589 if (!kref_get_unless_zero(&kobj->kref))
590 kobj = NULL;
591 return kobj;
592}
593
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800594/*
595 * kobject_cleanup - free kobject resources.
596 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800598static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100600 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100601 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Russell Kingc817a672013-06-27 15:06:14 +0100603 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
604 kobject_name(kobj), kobj, __func__, kobj->parent);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100605
606 if (t && !t->release)
607 pr_debug("kobject: '%s' (%p): does not have a release() "
608 "function, it is broken and must be fixed.\n",
609 kobject_name(kobj), kobj);
610
611 /* send "remove" if the caller did not do it but sent "add" */
612 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
613 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
614 kobject_name(kobj), kobj);
615 kobject_uevent(kobj, KOBJ_REMOVE);
616 }
617
618 /* remove from sysfs if the caller did not do it */
619 if (kobj->state_in_sysfs) {
620 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
621 kobject_name(kobj), kobj);
622 kobject_del(kobj);
623 }
624
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700625 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100626 pr_debug("kobject: '%s' (%p): calling ktype release\n",
627 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100629 }
630
631 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100632 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100633 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700634 kfree(name);
635 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
637
Russell Kingc817a672013-06-27 15:06:14 +0100638#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
639static void kobject_delayed_cleanup(struct work_struct *work)
640{
641 kobject_cleanup(container_of(to_delayed_work(work),
642 struct kobject, release));
643}
644#endif
645
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646static void kobject_release(struct kref *kref)
647{
Russell Kingc817a672013-06-27 15:06:14 +0100648 struct kobject *kobj = container_of(kref, struct kobject, kref);
649#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
Bjorn Helgaas89c86a62013-12-05 17:37:51 -0700650 unsigned long delay = HZ + HZ * (get_random_int() & 0x3);
651 pr_info("kobject: '%s' (%p): %s, parent %p (delayed %ld)\n",
652 kobject_name(kobj), kobj, __func__, kobj->parent, delay);
Russell Kingc817a672013-06-27 15:06:14 +0100653 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
Bjorn Helgaas89c86a62013-12-05 17:37:51 -0700654
655 schedule_delayed_work(&kobj->release, delay);
Russell Kingc817a672013-06-27 15:06:14 +0100656#else
657 kobject_cleanup(kobj);
658#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659}
660
661/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800662 * kobject_put - decrement refcount for object.
663 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800665 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800667void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800669 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700670 if (!kobj->state_initialized)
671 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800672 "initialized, yet kobject_put() is being "
673 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800675 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
677
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800678static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500679{
Harvey Harrison810304d2008-04-30 00:55:08 -0700680 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500681 kfree(kobj);
682}
683
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800684static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100685 .release = dynamic_kobj_release,
686 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500687};
688
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800689/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800690 * kobject_create - create a struct kobject dynamically
691 *
692 * This function creates a kobject structure dynamically and sets it up
693 * to be a "dynamic" kobject with a default release function set up.
694 *
695 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800696 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700697 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800698 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800699 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800700struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800701{
702 struct kobject *kobj;
703
704 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
705 if (!kobj)
706 return NULL;
707
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700708 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800709 return kobj;
710}
711
712/**
713 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
714 *
Zhi Yong Wu9ff1f832012-05-07 10:48:25 +0800715 * @name: the name for the kobject
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800716 * @parent: the parent kobject of this kobject, if any.
717 *
Dave Youngf70701a2008-01-28 16:58:00 +0800718 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800719 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800720 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800721 * it is no longer being used.
722 *
723 * If the kobject was not able to be created, NULL will be returned.
724 */
725struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
726{
727 struct kobject *kobj;
728 int retval;
729
730 kobj = kobject_create();
731 if (!kobj)
732 return NULL;
733
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700734 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800735 if (retval) {
736 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700737 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800738 kobject_put(kobj);
739 kobj = NULL;
740 }
741 return kobj;
742}
743EXPORT_SYMBOL_GPL(kobject_create_and_add);
744
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500745/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800746 * kset_init - initialize a kset for use
747 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800749void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700751 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 INIT_LIST_HEAD(&k->list);
753 spin_lock_init(&k->list_lock);
754}
755
Kay Sievers23b52122007-11-02 13:47:53 +0100756/* default kobject attribute operations */
757static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
758 char *buf)
759{
760 struct kobj_attribute *kattr;
761 ssize_t ret = -EIO;
762
763 kattr = container_of(attr, struct kobj_attribute, attr);
764 if (kattr->show)
765 ret = kattr->show(kobj, kattr, buf);
766 return ret;
767}
768
769static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
770 const char *buf, size_t count)
771{
772 struct kobj_attribute *kattr;
773 ssize_t ret = -EIO;
774
775 kattr = container_of(attr, struct kobj_attribute, attr);
776 if (kattr->store)
777 ret = kattr->store(kobj, kattr, buf, count);
778 return ret;
779}
780
Emese Revfy52cf25d2010-01-19 02:58:23 +0100781const struct sysfs_ops kobj_sysfs_ops = {
Kay Sievers23b52122007-11-02 13:47:53 +0100782 .show = kobj_attr_show,
783 .store = kobj_attr_store,
784};
Jeff Mahoney29dfe2d2013-11-01 13:06:56 -0400785EXPORT_SYMBOL_GPL(kobj_sysfs_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786
787/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800788 * kset_register - initialize and add a kset.
789 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800791int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792{
Kay Sievers80f03e32007-05-26 11:21:36 +0200793 int err;
794
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800795 if (!k)
796 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200797
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700799 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200800 if (err)
801 return err;
802 kobject_uevent(&k->kobj, KOBJ_ADD);
803 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804}
805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800807 * kset_unregister - remove a kset.
808 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800810void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800812 if (!k)
813 return;
Bjorn Helgaas35a5fe62013-12-05 17:38:00 -0700814 kobject_del(&k->kobj);
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800815 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816}
817
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800819 * kset_find_obj - search for object in kset.
820 * @kset: kset we're looking in.
821 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800823 * Lock kset via @kset->subsys, and iterate over @kset->list,
824 * looking for a matching kobject. If matching object is found
825 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800827struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400829 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800830 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
832 spin_lock(&kset->list_lock);
Robin Holtc25d1df2010-09-29 14:00:54 -0500833
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400834 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800835 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700836 ret = kobject_get_unless_zero(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 break;
838 }
839 }
Robin Holtc25d1df2010-09-29 14:00:54 -0500840
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 spin_unlock(&kset->list_lock);
842 return ret;
843}
844
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700845static void kset_release(struct kobject *kobj)
846{
847 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800848 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700849 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700850 kfree(kset);
851}
852
Kay Sievers386f2752007-11-02 13:47:53 +0100853static struct kobj_type kset_ktype = {
854 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700855 .release = kset_release,
856};
857
858/**
859 * kset_create - create a struct kset dynamically
860 *
861 * @name: the name for the kset
862 * @uevent_ops: a struct kset_uevent_ops for the kset
863 * @parent_kobj: the parent kobject of this kset, if any.
864 *
865 * This function creates a kset structure dynamically. This structure can
866 * then be registered with the system and show up in sysfs with a call to
867 * kset_register(). When you are finished with this structure, if
868 * kset_register() has been called, call kset_unregister() and the
869 * structure will be dynamically freed when it is no longer being used.
870 *
871 * If the kset was not able to be created, NULL will be returned.
872 */
873static struct kset *kset_create(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100874 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700875 struct kobject *parent_kobj)
876{
877 struct kset *kset;
Dave Youngd9cd8f32009-05-11 14:17:45 +0800878 int retval;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700879
880 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
881 if (!kset)
882 return NULL;
Kees Cookb7165eb2013-06-06 13:52:19 -0700883 retval = kobject_set_name(&kset->kobj, "%s", name);
Dave Youngd9cd8f32009-05-11 14:17:45 +0800884 if (retval) {
885 kfree(kset);
886 return NULL;
887 }
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700888 kset->uevent_ops = uevent_ops;
889 kset->kobj.parent = parent_kobj;
890
891 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100892 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700893 * no kset itself. That way we can properly free it when it is
894 * finished being used.
895 */
Kay Sievers386f2752007-11-02 13:47:53 +0100896 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700897 kset->kobj.kset = NULL;
898
899 return kset;
900}
901
902/**
903 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
904 *
905 * @name: the name for the kset
906 * @uevent_ops: a struct kset_uevent_ops for the kset
907 * @parent_kobj: the parent kobject of this kset, if any.
908 *
909 * This function creates a kset structure dynamically and registers it
910 * with sysfs. When you are finished with this structure, call
911 * kset_unregister() and the structure will be dynamically freed when it
912 * is no longer being used.
913 *
914 * If the kset was not able to be created, NULL will be returned.
915 */
916struct kset *kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100917 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700918 struct kobject *parent_kobj)
919{
920 struct kset *kset;
921 int error;
922
923 kset = kset_create(name, uevent_ops, parent_kobj);
924 if (!kset)
925 return NULL;
926 error = kset_register(kset);
927 if (error) {
928 kfree(kset);
929 return NULL;
930 }
931 return kset;
932}
933EXPORT_SYMBOL_GPL(kset_create_and_add);
934
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700935
936static DEFINE_SPINLOCK(kobj_ns_type_lock);
937static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
938
939int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
940{
941 enum kobj_ns_type type = ops->type;
942 int error;
943
944 spin_lock(&kobj_ns_type_lock);
945
946 error = -EINVAL;
947 if (type >= KOBJ_NS_TYPES)
948 goto out;
949
950 error = -EINVAL;
951 if (type <= KOBJ_NS_TYPE_NONE)
952 goto out;
953
954 error = -EBUSY;
955 if (kobj_ns_ops_tbl[type])
956 goto out;
957
958 error = 0;
959 kobj_ns_ops_tbl[type] = ops;
960
961out:
962 spin_unlock(&kobj_ns_type_lock);
963 return error;
964}
965
966int kobj_ns_type_registered(enum kobj_ns_type type)
967{
968 int registered = 0;
969
970 spin_lock(&kobj_ns_type_lock);
971 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
972 registered = kobj_ns_ops_tbl[type] != NULL;
973 spin_unlock(&kobj_ns_type_lock);
974
975 return registered;
976}
977
978const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
979{
980 const struct kobj_ns_type_operations *ops = NULL;
981
Pankaj Dubey41fb96a2014-09-24 16:25:54 +0530982 if (parent && parent->ktype && parent->ktype->child_ns_type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700983 ops = parent->ktype->child_ns_type(parent);
984
985 return ops;
986}
987
988const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
989{
990 return kobj_child_ns_ops(kobj->parent);
991}
992
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -0700993bool kobj_ns_current_may_mount(enum kobj_ns_type type)
994{
Eric W. Biederman730d7d32013-09-23 14:41:17 -0700995 bool may_mount = true;
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -0700996
997 spin_lock(&kobj_ns_type_lock);
998 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
999 kobj_ns_ops_tbl[type])
1000 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
1001 spin_unlock(&kobj_ns_type_lock);
1002
1003 return may_mount;
1004}
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001005
Al Viroa685e082011-06-08 21:13:01 -04001006void *kobj_ns_grab_current(enum kobj_ns_type type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001007{
Al Viroa685e082011-06-08 21:13:01 -04001008 void *ns = NULL;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001009
1010 spin_lock(&kobj_ns_type_lock);
1011 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1012 kobj_ns_ops_tbl[type])
Al Viroa685e082011-06-08 21:13:01 -04001013 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001014 spin_unlock(&kobj_ns_type_lock);
1015
1016 return ns;
1017}
1018
1019const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1020{
1021 const void *ns = NULL;
1022
1023 spin_lock(&kobj_ns_type_lock);
1024 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1025 kobj_ns_ops_tbl[type])
1026 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1027 spin_unlock(&kobj_ns_type_lock);
1028
1029 return ns;
1030}
1031
1032const void *kobj_ns_initial(enum kobj_ns_type type)
1033{
1034 const void *ns = NULL;
1035
1036 spin_lock(&kobj_ns_type_lock);
1037 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1038 kobj_ns_ops_tbl[type])
1039 ns = kobj_ns_ops_tbl[type]->initial_ns();
1040 spin_unlock(&kobj_ns_type_lock);
1041
1042 return ns;
1043}
1044
Al Viroa685e082011-06-08 21:13:01 -04001045void kobj_ns_drop(enum kobj_ns_type type, void *ns)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001046{
Al Viroa685e082011-06-08 21:13:01 -04001047 spin_lock(&kobj_ns_type_lock);
1048 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1049 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1050 kobj_ns_ops_tbl[type]->drop_ns(ns);
1051 spin_unlock(&kobj_ns_type_lock);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001052}
1053
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054EXPORT_SYMBOL(kobject_get);
1055EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056EXPORT_SYMBOL(kobject_del);
1057
1058EXPORT_SYMBOL(kset_register);
1059EXPORT_SYMBOL(kset_unregister);