blob: 03512a40a3ef9e93387a3217617bc8f9927ebcbe [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>
Jeff Mahoneyeee03162013-09-11 13:00:30 -040016#include <linux/kobj_completion.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/string.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050018#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/stat.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080020#include <linux/slab.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 Heoe34ff492013-09-11 22:29:05 -040068 int error;
69
70 error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
yan6b960612012-04-20 21:25:53 +080071 if (!error) {
72 error = populate_dir(kobj);
73 if (error)
74 sysfs_remove_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 }
Tejun Heo26ea12d2013-09-18 17:15:36 -040076
77 /*
78 * @kobj->sd may be deleted by an ancestor going away. Hold an
79 * extra reference so that it stays until @kobj is gone.
80 */
81 sysfs_get(kobj->sd);
82
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 return error;
84}
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086static int get_kobj_path_length(struct kobject *kobj)
87{
88 int length = 1;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080089 struct kobject *parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080091 /* walk up the ancestors until we hit the one pointing to the
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 * root.
93 * Add 1 to strlen for leading '/' of each level.
94 */
95 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -050096 if (kobject_name(parent) == NULL)
97 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 length += strlen(kobject_name(parent)) + 1;
99 parent = parent->parent;
100 } while (parent);
101 return length;
102}
103
104static void fill_kobj_path(struct kobject *kobj, char *path, int length)
105{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800106 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
108 --length;
109 for (parent = kobj; parent; parent = parent->parent) {
110 int cur = strlen(kobject_name(parent));
111 /* back up enough to print this name with '/' */
112 length -= cur;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800113 strncpy(path + length, kobject_name(parent), cur);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 *(path + --length) = '/';
115 }
116
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800117 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
Harvey Harrison810304d2008-04-30 00:55:08 -0700118 kobj, __func__, path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119}
120
121/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800122 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 *
124 * @kobj: kobject in question, with which to build the path
125 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800126 *
127 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128 */
Al Virofd4f2df2005-10-21 03:18:50 -0400129char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
131 char *path;
132 int len;
133
134 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500135 if (len == 0)
136 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800137 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 if (!path)
139 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 fill_kobj_path(kobj, path, len);
141
142 return path;
143}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400144EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100146/* add the kobject to its kset's list */
147static void kobj_kset_join(struct kobject *kobj)
148{
149 if (!kobj->kset)
150 return;
151
152 kset_get(kobj->kset);
153 spin_lock(&kobj->kset->list_lock);
154 list_add_tail(&kobj->entry, &kobj->kset->list);
155 spin_unlock(&kobj->kset->list_lock);
156}
157
158/* remove the kobject from its kset's list */
159static void kobj_kset_leave(struct kobject *kobj)
160{
161 if (!kobj->kset)
162 return;
163
164 spin_lock(&kobj->kset->list_lock);
165 list_del_init(&kobj->entry);
166 spin_unlock(&kobj->kset->list_lock);
167 kset_put(kobj->kset);
168}
169
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800170static void kobject_init_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800172 if (!kobj)
173 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 kref_init(&kobj->kref);
175 INIT_LIST_HEAD(&kobj->entry);
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800176 kobj->state_in_sysfs = 0;
177 kobj->state_add_uevent_sent = 0;
178 kobj->state_remove_uevent_sent = 0;
179 kobj->state_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180}
181
182
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700183static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
185 int error = 0;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800186 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100188 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100190
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100191 if (!kobj->name || !kobj->name[0]) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700192 WARN(1, "kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800193 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800194 return -EINVAL;
195 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 parent = kobject_get(kobj->parent);
198
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100199 /* join kset if set, use it as parent if we do not already have one */
200 if (kobj->kset) {
201 if (!parent)
202 parent = kobject_get(&kobj->kset->kobj);
203 kobj_kset_join(kobj);
204 kobj->parent = parent;
205 }
206
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800207 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700208 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800209 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800210 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900212 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100214 kobj_kset_leave(kobj);
215 kobject_put(parent);
216 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800217
218 /* be noisy on error issues */
219 if (error == -EEXIST)
Dan Williams282029c2012-04-06 13:41:15 -0700220 WARN(1, "%s failed for %s with "
221 "-EEXIST, don't try to register things with "
222 "the same name in the same directory.\n",
223 __func__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800224 else
Dan Williams282029c2012-04-06 13:41:15 -0700225 WARN(1, "%s failed for %s (error: %d parent: %s)\n",
226 __func__, kobject_name(kobj), error,
227 parent ? kobject_name(parent) : "'none'");
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100228 } else
229 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231 return error;
232}
233
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700234/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500235 * kobject_set_name_vargs - Set the name of an kobject
236 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800237 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500238 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 */
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100240int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500241 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242{
Kay Sievers9f255652008-05-06 22:24:04 +0200243 const char *old_name = kobj->name;
244 char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
Kay Sievers8a577ff2009-04-18 15:05:45 -0700246 if (kobj->name && !fmt)
247 return 0;
248
Kay Sieversa4ca6612008-04-30 02:06:29 +0200249 kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
250 if (!kobj->name)
251 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500252
Kay Sievers9f255652008-05-06 22:24:04 +0200253 /* ewww... some of these buggers have '/' in the name ... */
Ingo Oeser25fdeb32008-07-23 01:25:01 +0200254 while ((s = strchr(kobj->name, '/')))
Kay Sievers9f255652008-05-06 22:24:04 +0200255 s[0] = '!';
256
257 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500258 return 0;
259}
260
261/**
262 * kobject_set_name - Set the name of a kobject
263 * @kobj: struct kobject to set the name of
264 * @fmt: format string used to build the name
265 *
266 * This sets the name of the kobject. If you have already added the
267 * kobject to the system, you must call kobject_rename() in order to
268 * change the name of the kobject.
269 */
270int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
271{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200272 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500273 int retval;
274
Kay Sieversa4ca6612008-04-30 02:06:29 +0200275 va_start(vargs, fmt);
276 retval = kobject_set_name_vargs(kobj, fmt, vargs);
277 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500278
279 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281EXPORT_SYMBOL(kobject_set_name);
282
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700284 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800285 * @kobj: pointer to the kobject to initialize
286 * @ktype: pointer to the ktype for this kobject.
287 *
288 * This function will properly initialize a kobject such that it can then
289 * be passed to the kobject_add() call.
290 *
291 * After this function is called, the kobject MUST be cleaned up by a call
292 * to kobject_put(), not by a call to kfree directly to ensure that all of
293 * the memory is cleaned up properly.
294 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700295void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800296{
297 char *err_str;
298
299 if (!kobj) {
300 err_str = "invalid kobject pointer!";
301 goto error;
302 }
303 if (!ktype) {
304 err_str = "must have a ktype to be initialized properly!\n";
305 goto error;
306 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100307 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800308 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100309 printk(KERN_ERR "kobject (%p): tried to init an initialized "
310 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800311 dump_stack();
312 }
313
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800314 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800315 kobj->ktype = ktype;
316 return;
317
318error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100319 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800320 dump_stack();
321}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700322EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800323
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800324static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
325 const char *fmt, va_list vargs)
326{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800327 int retval;
328
Kay Sieversa4ca6612008-04-30 02:06:29 +0200329 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800330 if (retval) {
331 printk(KERN_ERR "kobject: can not set name properly!\n");
332 return retval;
333 }
334 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700335 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800336}
337
338/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700339 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800340 * @kobj: the kobject to add
341 * @parent: pointer to the parent of the kobject.
342 * @fmt: format to name the kobject with.
343 *
344 * The kobject name is set and added to the kobject hierarchy in this
345 * function.
346 *
347 * If @parent is set, then the parent of the @kobj will be set to it.
348 * If @parent is NULL, then the parent of the @kobj will be set to the
349 * kobject associted with the kset assigned to this kobject. If no kset
350 * is assigned to the kobject, then the kobject will be located in the
351 * root of the sysfs tree.
352 *
353 * If this function returns an error, kobject_put() must be called to
354 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800355 * Under no instance should the kobject that is passed to this function
356 * be directly freed with a call to kfree(), that can leak memory.
357 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100358 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800359 * up all of the necessary sysfs files for the object and then call
360 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
361 * userspace is properly notified of this kobject's creation.
362 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700363int kobject_add(struct kobject *kobj, struct kobject *parent,
364 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800365{
366 va_list args;
367 int retval;
368
369 if (!kobj)
370 return -EINVAL;
371
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100372 if (!kobj->state_initialized) {
373 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
374 "uninitialized object, something is seriously wrong.\n",
375 kobject_name(kobj), kobj);
376 dump_stack();
377 return -EINVAL;
378 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800379 va_start(args, fmt);
380 retval = kobject_add_varg(kobj, parent, fmt, args);
381 va_end(args);
382
383 return retval;
384}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700385EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800386
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800387/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800388 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
389 * @kobj: pointer to the kobject to initialize
390 * @ktype: pointer to the ktype for this kobject.
391 * @parent: pointer to the parent of this kobject.
392 * @fmt: the name of the kobject.
393 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700394 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700395 * kobject_add(). The same type of error handling after a call to
396 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800397 */
398int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
399 struct kobject *parent, const char *fmt, ...)
400{
401 va_list args;
402 int retval;
403
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700404 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800405
406 va_start(args, fmt);
407 retval = kobject_add_varg(kobj, parent, fmt, args);
408 va_end(args);
409
410 return retval;
411}
412EXPORT_SYMBOL_GPL(kobject_init_and_add);
413
414/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800415 * kobject_rename - change the name of an object
416 * @kobj: object in question.
417 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700418 *
419 * It is the responsibility of the caller to provide mutual
420 * exclusion between two different calls of kobject_rename
421 * on the same kobject and to ensure that new_name is valid and
422 * won't conflict with other kobjects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800424int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425{
426 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800427 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700428 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800429 char *devpath_string = NULL;
430 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
432 kobj = kobject_get(kobj);
433 if (!kobj)
434 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700435 if (!kobj->parent)
436 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800437
438 devpath = kobject_get_path(kobj, GFP_KERNEL);
439 if (!devpath) {
440 error = -ENOMEM;
441 goto out;
442 }
443 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
444 if (!devpath_string) {
445 error = -ENOMEM;
446 goto out;
447 }
448 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
449 envp[0] = devpath_string;
450 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800451
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700452 name = dup_name = kstrdup(new_name, GFP_KERNEL);
453 if (!name) {
454 error = -ENOMEM;
455 goto out;
456 }
457
Tejun Heoe34ff492013-09-11 22:29:05 -0400458 error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700459 if (error)
460 goto out;
461
462 /* Install the new kobject name */
463 dup_name = kobj->name;
464 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800465
466 /* This function is mostly/only used for network interface.
467 * Some hotplug package track interfaces by their name and
468 * therefore want to know when the name is changed by the user. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700469 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800470
471out:
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700472 kfree(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800473 kfree(devpath_string);
474 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700475 kobject_put(kobj);
476
477 return error;
478}
Alex Chiang8344b562008-06-10 15:30:42 -0600479EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700480
481/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800482 * kobject_move - move object to another parent
483 * @kobj: object in question.
484 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100485 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100486int kobject_move(struct kobject *kobj, struct kobject *new_parent)
487{
488 int error;
489 struct kobject *old_parent;
490 const char *devpath = NULL;
491 char *devpath_string = NULL;
492 char *envp[2];
493
494 kobj = kobject_get(kobj);
495 if (!kobj)
496 return -EINVAL;
497 new_parent = kobject_get(new_parent);
498 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100499 if (kobj->kset)
500 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100501 }
Tejun Heoe34ff492013-09-11 22:29:05 -0400502
Cornelia Huck8a824722006-11-20 17:07:51 +0100503 /* old object path */
504 devpath = kobject_get_path(kobj, GFP_KERNEL);
505 if (!devpath) {
506 error = -ENOMEM;
507 goto out;
508 }
509 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
510 if (!devpath_string) {
511 error = -ENOMEM;
512 goto out;
513 }
514 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
515 envp[0] = devpath_string;
516 envp[1] = NULL;
Tejun Heoe34ff492013-09-11 22:29:05 -0400517 error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
Cornelia Huck8a824722006-11-20 17:07:51 +0100518 if (error)
519 goto out;
520 old_parent = kobj->parent;
521 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300522 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100523 kobject_put(old_parent);
524 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
525out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300526 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100527 kobject_put(kobj);
528 kfree(devpath_string);
529 kfree(devpath);
530 return error;
531}
532
533/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800534 * kobject_del - unlink kobject from hierarchy.
535 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800537void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Tejun Heo26ea12d2013-09-18 17:15:36 -0400539 struct sysfs_dirent *sd;
540
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800541 if (!kobj)
542 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100543
Tejun Heo26ea12d2013-09-18 17:15:36 -0400544 sd = kobj->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 sysfs_remove_dir(kobj);
Tejun Heo26ea12d2013-09-18 17:15:36 -0400546 sysfs_put(sd);
547
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100548 kobj->state_in_sysfs = 0;
549 kobj_kset_leave(kobj);
550 kobject_put(kobj->parent);
551 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552}
553
554/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800555 * kobject_get - increment refcount for object.
556 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800558struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
560 if (kobj)
561 kref_get(&kobj->kref);
562 return kobj;
563}
564
Anatol Pomozov2d864e42013-05-07 15:37:48 -0700565static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700566{
567 if (!kref_get_unless_zero(&kobj->kref))
568 kobj = NULL;
569 return kobj;
570}
571
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800572/*
573 * kobject_cleanup - free kobject resources.
574 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800576static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100578 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100579 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Russell Kingc817a672013-06-27 15:06:14 +0100581 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
582 kobject_name(kobj), kobj, __func__, kobj->parent);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100583
584 if (t && !t->release)
585 pr_debug("kobject: '%s' (%p): does not have a release() "
586 "function, it is broken and must be fixed.\n",
587 kobject_name(kobj), kobj);
588
589 /* send "remove" if the caller did not do it but sent "add" */
590 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
591 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
592 kobject_name(kobj), kobj);
593 kobject_uevent(kobj, KOBJ_REMOVE);
594 }
595
596 /* remove from sysfs if the caller did not do it */
597 if (kobj->state_in_sysfs) {
598 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
599 kobject_name(kobj), kobj);
600 kobject_del(kobj);
601 }
602
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700603 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100604 pr_debug("kobject: '%s' (%p): calling ktype release\n",
605 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100607 }
608
609 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100610 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100611 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700612 kfree(name);
613 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614}
615
Russell Kingc817a672013-06-27 15:06:14 +0100616#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
617static void kobject_delayed_cleanup(struct work_struct *work)
618{
619 kobject_cleanup(container_of(to_delayed_work(work),
620 struct kobject, release));
621}
622#endif
623
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624static void kobject_release(struct kref *kref)
625{
Russell Kingc817a672013-06-27 15:06:14 +0100626 struct kobject *kobj = container_of(kref, struct kobject, kref);
627#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
Fengguang Wu1461c5b2013-10-09 09:26:21 +0800628 pr_info("kobject: '%s' (%p): %s, parent %p (delayed)\n",
Russell Kingc817a672013-06-27 15:06:14 +0100629 kobject_name(kobj), kobj, __func__, kobj->parent);
630 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
631 schedule_delayed_work(&kobj->release, HZ);
632#else
633 kobject_cleanup(kobj);
634#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
636
637/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800638 * kobject_put - decrement refcount for object.
639 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800641 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800643void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800645 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700646 if (!kobj->state_initialized)
647 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800648 "initialized, yet kobject_put() is being "
649 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800651 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
653
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800654static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500655{
Harvey Harrison810304d2008-04-30 00:55:08 -0700656 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500657 kfree(kobj);
658}
659
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800660static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100661 .release = dynamic_kobj_release,
662 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500663};
664
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800665/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800666 * kobject_create - create a struct kobject dynamically
667 *
668 * This function creates a kobject structure dynamically and sets it up
669 * to be a "dynamic" kobject with a default release function set up.
670 *
671 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800672 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700673 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800674 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800675 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800676struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800677{
678 struct kobject *kobj;
679
680 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
681 if (!kobj)
682 return NULL;
683
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700684 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800685 return kobj;
686}
687
688/**
689 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
690 *
Zhi Yong Wu9ff1f832012-05-07 10:48:25 +0800691 * @name: the name for the kobject
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800692 * @parent: the parent kobject of this kobject, if any.
693 *
Dave Youngf70701a2008-01-28 16:58:00 +0800694 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800695 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800696 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800697 * it is no longer being used.
698 *
699 * If the kobject was not able to be created, NULL will be returned.
700 */
701struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
702{
703 struct kobject *kobj;
704 int retval;
705
706 kobj = kobject_create();
707 if (!kobj)
708 return NULL;
709
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700710 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800711 if (retval) {
712 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700713 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800714 kobject_put(kobj);
715 kobj = NULL;
716 }
717 return kobj;
718}
719EXPORT_SYMBOL_GPL(kobject_create_and_add);
720
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500721/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800722 * kset_init - initialize a kset for use
723 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800725void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700727 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 INIT_LIST_HEAD(&k->list);
729 spin_lock_init(&k->list_lock);
730}
731
Kay Sievers23b52122007-11-02 13:47:53 +0100732/* default kobject attribute operations */
733static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
734 char *buf)
735{
736 struct kobj_attribute *kattr;
737 ssize_t ret = -EIO;
738
739 kattr = container_of(attr, struct kobj_attribute, attr);
740 if (kattr->show)
741 ret = kattr->show(kobj, kattr, buf);
742 return ret;
743}
744
745static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
746 const char *buf, size_t count)
747{
748 struct kobj_attribute *kattr;
749 ssize_t ret = -EIO;
750
751 kattr = container_of(attr, struct kobj_attribute, attr);
752 if (kattr->store)
753 ret = kattr->store(kobj, kattr, buf, count);
754 return ret;
755}
756
Emese Revfy52cf25d2010-01-19 02:58:23 +0100757const struct sysfs_ops kobj_sysfs_ops = {
Kay Sievers23b52122007-11-02 13:47:53 +0100758 .show = kobj_attr_show,
759 .store = kobj_attr_store,
760};
Jeff Mahoney29dfe2d2013-11-01 13:06:56 -0400761EXPORT_SYMBOL_GPL(kobj_sysfs_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762
763/**
Jeff Mahoneyeee03162013-09-11 13:00:30 -0400764 * kobj_completion_init - initialize a kobj_completion object.
765 * @kc: kobj_completion
766 * @ktype: type of kobject to initialize
767 *
768 * kobj_completion structures can be embedded within structures with different
769 * lifetime rules. During the release of the enclosing object, we can
770 * wait on the release of the kobject so that we don't free it while it's
771 * still busy.
772 */
773void kobj_completion_init(struct kobj_completion *kc, struct kobj_type *ktype)
774{
775 init_completion(&kc->kc_unregister);
776 kobject_init(&kc->kc_kobj, ktype);
777}
778EXPORT_SYMBOL_GPL(kobj_completion_init);
779
780/**
781 * kobj_completion_release - release a kobj_completion object
782 * @kobj: kobject embedded in kobj_completion
783 *
784 * Used with kobject_release to notify waiters that the kobject has been
785 * released.
786 */
787void kobj_completion_release(struct kobject *kobj)
788{
789 struct kobj_completion *kc = kobj_to_kobj_completion(kobj);
790 complete(&kc->kc_unregister);
791}
792EXPORT_SYMBOL_GPL(kobj_completion_release);
793
794/**
795 * kobj_completion_del_and_wait - release the kobject and wait for it
796 * @kc: kobj_completion object to release
797 *
798 * Delete the kobject from sysfs and drop the reference count. Then wait
799 * until any other outstanding references are also dropped. This routine
800 * is only necessary once other references may have been taken on the
801 * kobject. Typically this happens when the kobject has been published
802 * to sysfs via kobject_add.
803 */
804void kobj_completion_del_and_wait(struct kobj_completion *kc)
805{
806 kobject_del(&kc->kc_kobj);
807 kobject_put(&kc->kc_kobj);
808 wait_for_completion(&kc->kc_unregister);
809}
810EXPORT_SYMBOL_GPL(kobj_completion_del_and_wait);
811
812/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800813 * kset_register - initialize and add a kset.
814 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800816int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817{
Kay Sievers80f03e32007-05-26 11:21:36 +0200818 int err;
819
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800820 if (!k)
821 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200822
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700824 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200825 if (err)
826 return err;
827 kobject_uevent(&k->kobj, KOBJ_ADD);
828 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829}
830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800832 * kset_unregister - remove a kset.
833 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800835void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800837 if (!k)
838 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800839 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840}
841
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800843 * kset_find_obj - search for object in kset.
844 * @kset: kset we're looking in.
845 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800847 * Lock kset via @kset->subsys, and iterate over @kset->list,
848 * looking for a matching kobject. If matching object is found
849 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800851struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400853 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800854 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
856 spin_lock(&kset->list_lock);
Robin Holtc25d1df2010-09-29 14:00:54 -0500857
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400858 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800859 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700860 ret = kobject_get_unless_zero(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 break;
862 }
863 }
Robin Holtc25d1df2010-09-29 14:00:54 -0500864
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 spin_unlock(&kset->list_lock);
866 return ret;
867}
868
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700869static void kset_release(struct kobject *kobj)
870{
871 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800872 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700873 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700874 kfree(kset);
875}
876
Kay Sievers386f2752007-11-02 13:47:53 +0100877static struct kobj_type kset_ktype = {
878 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700879 .release = kset_release,
880};
881
882/**
883 * kset_create - create a struct kset dynamically
884 *
885 * @name: the name for the kset
886 * @uevent_ops: a struct kset_uevent_ops for the kset
887 * @parent_kobj: the parent kobject of this kset, if any.
888 *
889 * This function creates a kset structure dynamically. This structure can
890 * then be registered with the system and show up in sysfs with a call to
891 * kset_register(). When you are finished with this structure, if
892 * kset_register() has been called, call kset_unregister() and the
893 * structure will be dynamically freed when it is no longer being used.
894 *
895 * If the kset was not able to be created, NULL will be returned.
896 */
897static struct kset *kset_create(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100898 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700899 struct kobject *parent_kobj)
900{
901 struct kset *kset;
Dave Youngd9cd8f32009-05-11 14:17:45 +0800902 int retval;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700903
904 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
905 if (!kset)
906 return NULL;
Kees Cookb7165eb2013-06-06 13:52:19 -0700907 retval = kobject_set_name(&kset->kobj, "%s", name);
Dave Youngd9cd8f32009-05-11 14:17:45 +0800908 if (retval) {
909 kfree(kset);
910 return NULL;
911 }
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700912 kset->uevent_ops = uevent_ops;
913 kset->kobj.parent = parent_kobj;
914
915 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100916 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700917 * no kset itself. That way we can properly free it when it is
918 * finished being used.
919 */
Kay Sievers386f2752007-11-02 13:47:53 +0100920 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700921 kset->kobj.kset = NULL;
922
923 return kset;
924}
925
926/**
927 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
928 *
929 * @name: the name for the kset
930 * @uevent_ops: a struct kset_uevent_ops for the kset
931 * @parent_kobj: the parent kobject of this kset, if any.
932 *
933 * This function creates a kset structure dynamically and registers it
934 * with sysfs. When you are finished with this structure, call
935 * kset_unregister() and the structure will be dynamically freed when it
936 * is no longer being used.
937 *
938 * If the kset was not able to be created, NULL will be returned.
939 */
940struct kset *kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100941 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700942 struct kobject *parent_kobj)
943{
944 struct kset *kset;
945 int error;
946
947 kset = kset_create(name, uevent_ops, parent_kobj);
948 if (!kset)
949 return NULL;
950 error = kset_register(kset);
951 if (error) {
952 kfree(kset);
953 return NULL;
954 }
955 return kset;
956}
957EXPORT_SYMBOL_GPL(kset_create_and_add);
958
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700959
960static DEFINE_SPINLOCK(kobj_ns_type_lock);
961static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
962
963int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
964{
965 enum kobj_ns_type type = ops->type;
966 int error;
967
968 spin_lock(&kobj_ns_type_lock);
969
970 error = -EINVAL;
971 if (type >= KOBJ_NS_TYPES)
972 goto out;
973
974 error = -EINVAL;
975 if (type <= KOBJ_NS_TYPE_NONE)
976 goto out;
977
978 error = -EBUSY;
979 if (kobj_ns_ops_tbl[type])
980 goto out;
981
982 error = 0;
983 kobj_ns_ops_tbl[type] = ops;
984
985out:
986 spin_unlock(&kobj_ns_type_lock);
987 return error;
988}
989
990int kobj_ns_type_registered(enum kobj_ns_type type)
991{
992 int registered = 0;
993
994 spin_lock(&kobj_ns_type_lock);
995 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
996 registered = kobj_ns_ops_tbl[type] != NULL;
997 spin_unlock(&kobj_ns_type_lock);
998
999 return registered;
1000}
1001
1002const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
1003{
1004 const struct kobj_ns_type_operations *ops = NULL;
1005
1006 if (parent && parent->ktype->child_ns_type)
1007 ops = parent->ktype->child_ns_type(parent);
1008
1009 return ops;
1010}
1011
1012const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
1013{
1014 return kobj_child_ns_ops(kobj->parent);
1015}
1016
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001017bool kobj_ns_current_may_mount(enum kobj_ns_type type)
1018{
Eric W. Biederman730d7d32013-09-23 14:41:17 -07001019 bool may_mount = true;
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001020
1021 spin_lock(&kobj_ns_type_lock);
1022 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1023 kobj_ns_ops_tbl[type])
1024 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
1025 spin_unlock(&kobj_ns_type_lock);
1026
1027 return may_mount;
1028}
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001029
Al Viroa685e082011-06-08 21:13:01 -04001030void *kobj_ns_grab_current(enum kobj_ns_type type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001031{
Al Viroa685e082011-06-08 21:13:01 -04001032 void *ns = NULL;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001033
1034 spin_lock(&kobj_ns_type_lock);
1035 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1036 kobj_ns_ops_tbl[type])
Al Viroa685e082011-06-08 21:13:01 -04001037 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001038 spin_unlock(&kobj_ns_type_lock);
1039
1040 return ns;
1041}
1042
1043const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1044{
1045 const void *ns = NULL;
1046
1047 spin_lock(&kobj_ns_type_lock);
1048 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1049 kobj_ns_ops_tbl[type])
1050 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1051 spin_unlock(&kobj_ns_type_lock);
1052
1053 return ns;
1054}
1055
1056const void *kobj_ns_initial(enum kobj_ns_type type)
1057{
1058 const void *ns = NULL;
1059
1060 spin_lock(&kobj_ns_type_lock);
1061 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1062 kobj_ns_ops_tbl[type])
1063 ns = kobj_ns_ops_tbl[type]->initial_ns();
1064 spin_unlock(&kobj_ns_type_lock);
1065
1066 return ns;
1067}
1068
Al Viroa685e082011-06-08 21:13:01 -04001069void kobj_ns_drop(enum kobj_ns_type type, void *ns)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001070{
Al Viroa685e082011-06-08 21:13:01 -04001071 spin_lock(&kobj_ns_type_lock);
1072 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1073 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1074 kobj_ns_ops_tbl[type]->drop_ns(ns);
1075 spin_unlock(&kobj_ns_type_lock);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001076}
1077
Linus Torvalds1da177e2005-04-16 15:20:36 -07001078EXPORT_SYMBOL(kobject_get);
1079EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080EXPORT_SYMBOL(kobject_del);
1081
1082EXPORT_SYMBOL(kset_register);
1083EXPORT_SYMBOL(kset_unregister);