blob: 2fdf7fa9e9bded620f5634fbd976f84da6a099b5 [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);
Tejun Heocb26a312013-09-11 22:29:07 -040033 const void *ns;
Tejun Heoe34ff492013-09-11 22:29:05 -040034
35 if (!ns_ops || ns_ops->type == KOBJ_NS_TYPE_NONE)
36 return NULL;
37
Tejun Heocb26a312013-09-11 22:29:07 -040038 ns = kobj->ktype->namespace(kobj);
39 WARN_ON(!ns); /* @kobj in a namespace is required to have !NULL tag */
40 return ns;
Tejun Heoe34ff492013-09-11 22:29:05 -040041}
42
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080043/*
44 * populate_dir - populate directory with attributes.
45 * @kobj: object we're working on.
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080047 * Most subsystems have a set of default attributes that are associated
48 * with an object that registers with them. This is a helper called during
49 * object registration that loops through the default attributes of the
50 * subsystem and creates attributes files for them in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080052static int populate_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070053{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080054 struct kobj_type *t = get_ktype(kobj);
55 struct attribute *attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 int error = 0;
57 int i;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080058
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 if (t && t->default_attrs) {
60 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080061 error = sysfs_create_file(kobj, attr);
62 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 break;
64 }
65 }
66 return error;
67}
68
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080069static int create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070070{
Tejun Heoe34ff492013-09-11 22:29:05 -040071 int error;
72
73 error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
yan6b960612012-04-20 21:25:53 +080074 if (!error) {
75 error = populate_dir(kobj);
76 if (error)
77 sysfs_remove_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 }
Tejun Heo26ea12d2013-09-18 17:15:36 -040079
80 /*
81 * @kobj->sd may be deleted by an ancestor going away. Hold an
82 * extra reference so that it stays until @kobj is gone.
83 */
84 sysfs_get(kobj->sd);
85
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 return error;
87}
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089static int get_kobj_path_length(struct kobject *kobj)
90{
91 int length = 1;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080092 struct kobject *parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080094 /* walk up the ancestors until we hit the one pointing to the
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * root.
96 * Add 1 to strlen for leading '/' of each level.
97 */
98 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -050099 if (kobject_name(parent) == NULL)
100 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 length += strlen(kobject_name(parent)) + 1;
102 parent = parent->parent;
103 } while (parent);
104 return length;
105}
106
107static void fill_kobj_path(struct kobject *kobj, char *path, int length)
108{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800109 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
111 --length;
112 for (parent = kobj; parent; parent = parent->parent) {
113 int cur = strlen(kobject_name(parent));
114 /* back up enough to print this name with '/' */
115 length -= cur;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800116 strncpy(path + length, kobject_name(parent), cur);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 *(path + --length) = '/';
118 }
119
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800120 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
Harvey Harrison810304d2008-04-30 00:55:08 -0700121 kobj, __func__, path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122}
123
124/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800125 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 *
127 * @kobj: kobject in question, with which to build the path
128 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800129 *
130 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 */
Al Virofd4f2df2005-10-21 03:18:50 -0400132char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133{
134 char *path;
135 int len;
136
137 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500138 if (len == 0)
139 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800140 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 if (!path)
142 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 fill_kobj_path(kobj, path, len);
144
145 return path;
146}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400147EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100149/* add the kobject to its kset's list */
150static void kobj_kset_join(struct kobject *kobj)
151{
152 if (!kobj->kset)
153 return;
154
155 kset_get(kobj->kset);
156 spin_lock(&kobj->kset->list_lock);
157 list_add_tail(&kobj->entry, &kobj->kset->list);
158 spin_unlock(&kobj->kset->list_lock);
159}
160
161/* remove the kobject from its kset's list */
162static void kobj_kset_leave(struct kobject *kobj)
163{
164 if (!kobj->kset)
165 return;
166
167 spin_lock(&kobj->kset->list_lock);
168 list_del_init(&kobj->entry);
169 spin_unlock(&kobj->kset->list_lock);
170 kset_put(kobj->kset);
171}
172
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800173static void kobject_init_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800175 if (!kobj)
176 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 kref_init(&kobj->kref);
178 INIT_LIST_HEAD(&kobj->entry);
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800179 kobj->state_in_sysfs = 0;
180 kobj->state_add_uevent_sent = 0;
181 kobj->state_remove_uevent_sent = 0;
182 kobj->state_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183}
184
185
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700186static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187{
188 int error = 0;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800189 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100191 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100193
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100194 if (!kobj->name || !kobj->name[0]) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700195 WARN(1, "kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800196 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800197 return -EINVAL;
198 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 parent = kobject_get(kobj->parent);
201
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100202 /* join kset if set, use it as parent if we do not already have one */
203 if (kobj->kset) {
204 if (!parent)
205 parent = kobject_get(&kobj->kset->kobj);
206 kobj_kset_join(kobj);
207 kobj->parent = parent;
208 }
209
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800210 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700211 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800212 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800213 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900215 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100217 kobj_kset_leave(kobj);
218 kobject_put(parent);
219 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800220
221 /* be noisy on error issues */
222 if (error == -EEXIST)
Dan Williams282029c2012-04-06 13:41:15 -0700223 WARN(1, "%s failed for %s with "
224 "-EEXIST, don't try to register things with "
225 "the same name in the same directory.\n",
226 __func__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800227 else
Dan Williams282029c2012-04-06 13:41:15 -0700228 WARN(1, "%s failed for %s (error: %d parent: %s)\n",
229 __func__, kobject_name(kobj), error,
230 parent ? kobject_name(parent) : "'none'");
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100231 } else
232 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
234 return error;
235}
236
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700237/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500238 * kobject_set_name_vargs - Set the name of an kobject
239 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800240 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500241 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 */
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100243int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500244 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
Kay Sievers9f255652008-05-06 22:24:04 +0200246 const char *old_name = kobj->name;
247 char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Kay Sievers8a577ff2009-04-18 15:05:45 -0700249 if (kobj->name && !fmt)
250 return 0;
251
Kay Sieversa4ca6612008-04-30 02:06:29 +0200252 kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
253 if (!kobj->name)
254 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500255
Kay Sievers9f255652008-05-06 22:24:04 +0200256 /* ewww... some of these buggers have '/' in the name ... */
Ingo Oeser25fdeb32008-07-23 01:25:01 +0200257 while ((s = strchr(kobj->name, '/')))
Kay Sievers9f255652008-05-06 22:24:04 +0200258 s[0] = '!';
259
260 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500261 return 0;
262}
263
264/**
265 * kobject_set_name - Set the name of a kobject
266 * @kobj: struct kobject to set the name of
267 * @fmt: format string used to build the name
268 *
269 * This sets the name of the kobject. If you have already added the
270 * kobject to the system, you must call kobject_rename() in order to
271 * change the name of the kobject.
272 */
273int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
274{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200275 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500276 int retval;
277
Kay Sieversa4ca6612008-04-30 02:06:29 +0200278 va_start(vargs, fmt);
279 retval = kobject_set_name_vargs(kobj, fmt, vargs);
280 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500281
282 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284EXPORT_SYMBOL(kobject_set_name);
285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700287 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800288 * @kobj: pointer to the kobject to initialize
289 * @ktype: pointer to the ktype for this kobject.
290 *
291 * This function will properly initialize a kobject such that it can then
292 * be passed to the kobject_add() call.
293 *
294 * After this function is called, the kobject MUST be cleaned up by a call
295 * to kobject_put(), not by a call to kfree directly to ensure that all of
296 * the memory is cleaned up properly.
297 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700298void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800299{
300 char *err_str;
301
302 if (!kobj) {
303 err_str = "invalid kobject pointer!";
304 goto error;
305 }
306 if (!ktype) {
307 err_str = "must have a ktype to be initialized properly!\n";
308 goto error;
309 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100310 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800311 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100312 printk(KERN_ERR "kobject (%p): tried to init an initialized "
313 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800314 dump_stack();
315 }
316
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800317 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800318 kobj->ktype = ktype;
319 return;
320
321error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100322 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800323 dump_stack();
324}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700325EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800326
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800327static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
328 const char *fmt, va_list vargs)
329{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800330 int retval;
331
Kay Sieversa4ca6612008-04-30 02:06:29 +0200332 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800333 if (retval) {
334 printk(KERN_ERR "kobject: can not set name properly!\n");
335 return retval;
336 }
337 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700338 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800339}
340
341/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700342 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800343 * @kobj: the kobject to add
344 * @parent: pointer to the parent of the kobject.
345 * @fmt: format to name the kobject with.
346 *
347 * The kobject name is set and added to the kobject hierarchy in this
348 * function.
349 *
350 * If @parent is set, then the parent of the @kobj will be set to it.
351 * If @parent is NULL, then the parent of the @kobj will be set to the
352 * kobject associted with the kset assigned to this kobject. If no kset
353 * is assigned to the kobject, then the kobject will be located in the
354 * root of the sysfs tree.
355 *
356 * If this function returns an error, kobject_put() must be called to
357 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800358 * Under no instance should the kobject that is passed to this function
359 * be directly freed with a call to kfree(), that can leak memory.
360 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100361 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800362 * up all of the necessary sysfs files for the object and then call
363 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
364 * userspace is properly notified of this kobject's creation.
365 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700366int kobject_add(struct kobject *kobj, struct kobject *parent,
367 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800368{
369 va_list args;
370 int retval;
371
372 if (!kobj)
373 return -EINVAL;
374
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100375 if (!kobj->state_initialized) {
376 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
377 "uninitialized object, something is seriously wrong.\n",
378 kobject_name(kobj), kobj);
379 dump_stack();
380 return -EINVAL;
381 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800382 va_start(args, fmt);
383 retval = kobject_add_varg(kobj, parent, fmt, args);
384 va_end(args);
385
386 return retval;
387}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700388EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800389
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800390/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800391 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
392 * @kobj: pointer to the kobject to initialize
393 * @ktype: pointer to the ktype for this kobject.
394 * @parent: pointer to the parent of this kobject.
395 * @fmt: the name of the kobject.
396 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700397 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700398 * kobject_add(). The same type of error handling after a call to
399 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800400 */
401int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
402 struct kobject *parent, const char *fmt, ...)
403{
404 va_list args;
405 int retval;
406
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700407 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800408
409 va_start(args, fmt);
410 retval = kobject_add_varg(kobj, parent, fmt, args);
411 va_end(args);
412
413 return retval;
414}
415EXPORT_SYMBOL_GPL(kobject_init_and_add);
416
417/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800418 * kobject_rename - change the name of an object
419 * @kobj: object in question.
420 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700421 *
422 * It is the responsibility of the caller to provide mutual
423 * exclusion between two different calls of kobject_rename
424 * on the same kobject and to ensure that new_name is valid and
425 * won't conflict with other kobjects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800427int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428{
429 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800430 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700431 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800432 char *devpath_string = NULL;
433 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
435 kobj = kobject_get(kobj);
436 if (!kobj)
437 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700438 if (!kobj->parent)
439 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800440
441 devpath = kobject_get_path(kobj, GFP_KERNEL);
442 if (!devpath) {
443 error = -ENOMEM;
444 goto out;
445 }
446 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
447 if (!devpath_string) {
448 error = -ENOMEM;
449 goto out;
450 }
451 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
452 envp[0] = devpath_string;
453 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800454
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700455 name = dup_name = kstrdup(new_name, GFP_KERNEL);
456 if (!name) {
457 error = -ENOMEM;
458 goto out;
459 }
460
Tejun Heoe34ff492013-09-11 22:29:05 -0400461 error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700462 if (error)
463 goto out;
464
465 /* Install the new kobject name */
466 dup_name = kobj->name;
467 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800468
469 /* This function is mostly/only used for network interface.
470 * Some hotplug package track interfaces by their name and
471 * therefore want to know when the name is changed by the user. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700472 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800473
474out:
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700475 kfree(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800476 kfree(devpath_string);
477 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700478 kobject_put(kobj);
479
480 return error;
481}
Alex Chiang8344b562008-06-10 15:30:42 -0600482EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700483
484/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800485 * kobject_move - move object to another parent
486 * @kobj: object in question.
487 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100488 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100489int kobject_move(struct kobject *kobj, struct kobject *new_parent)
490{
491 int error;
492 struct kobject *old_parent;
493 const char *devpath = NULL;
494 char *devpath_string = NULL;
495 char *envp[2];
496
497 kobj = kobject_get(kobj);
498 if (!kobj)
499 return -EINVAL;
500 new_parent = kobject_get(new_parent);
501 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100502 if (kobj->kset)
503 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100504 }
Tejun Heoe34ff492013-09-11 22:29:05 -0400505
Cornelia Huck8a824722006-11-20 17:07:51 +0100506 /* old object path */
507 devpath = kobject_get_path(kobj, GFP_KERNEL);
508 if (!devpath) {
509 error = -ENOMEM;
510 goto out;
511 }
512 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
513 if (!devpath_string) {
514 error = -ENOMEM;
515 goto out;
516 }
517 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
518 envp[0] = devpath_string;
519 envp[1] = NULL;
Tejun Heoe34ff492013-09-11 22:29:05 -0400520 error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
Cornelia Huck8a824722006-11-20 17:07:51 +0100521 if (error)
522 goto out;
523 old_parent = kobj->parent;
524 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300525 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100526 kobject_put(old_parent);
527 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
528out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300529 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100530 kobject_put(kobj);
531 kfree(devpath_string);
532 kfree(devpath);
533 return error;
534}
535
536/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800537 * kobject_del - unlink kobject from hierarchy.
538 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800540void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Tejun Heo26ea12d2013-09-18 17:15:36 -0400542 struct sysfs_dirent *sd;
543
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800544 if (!kobj)
545 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100546
Tejun Heo26ea12d2013-09-18 17:15:36 -0400547 sd = kobj->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 sysfs_remove_dir(kobj);
Tejun Heo26ea12d2013-09-18 17:15:36 -0400549 sysfs_put(sd);
550
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100551 kobj->state_in_sysfs = 0;
552 kobj_kset_leave(kobj);
553 kobject_put(kobj->parent);
554 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
556
557/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800558 * kobject_get - increment refcount for object.
559 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800561struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562{
563 if (kobj)
564 kref_get(&kobj->kref);
565 return kobj;
566}
567
Anatol Pomozov2d864e42013-05-07 15:37:48 -0700568static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700569{
570 if (!kref_get_unless_zero(&kobj->kref))
571 kobj = NULL;
572 return kobj;
573}
574
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800575/*
576 * kobject_cleanup - free kobject resources.
577 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800579static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100581 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100582 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583
Russell Kingc817a672013-06-27 15:06:14 +0100584 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
585 kobject_name(kobj), kobj, __func__, kobj->parent);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100586
587 if (t && !t->release)
588 pr_debug("kobject: '%s' (%p): does not have a release() "
589 "function, it is broken and must be fixed.\n",
590 kobject_name(kobj), kobj);
591
592 /* send "remove" if the caller did not do it but sent "add" */
593 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
594 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
595 kobject_name(kobj), kobj);
596 kobject_uevent(kobj, KOBJ_REMOVE);
597 }
598
599 /* remove from sysfs if the caller did not do it */
600 if (kobj->state_in_sysfs) {
601 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
602 kobject_name(kobj), kobj);
603 kobject_del(kobj);
604 }
605
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700606 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100607 pr_debug("kobject: '%s' (%p): calling ktype release\n",
608 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100610 }
611
612 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100613 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100614 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700615 kfree(name);
616 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617}
618
Russell Kingc817a672013-06-27 15:06:14 +0100619#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
620static void kobject_delayed_cleanup(struct work_struct *work)
621{
622 kobject_cleanup(container_of(to_delayed_work(work),
623 struct kobject, release));
624}
625#endif
626
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627static void kobject_release(struct kref *kref)
628{
Russell Kingc817a672013-06-27 15:06:14 +0100629 struct kobject *kobj = container_of(kref, struct kobject, kref);
630#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
631 pr_debug("kobject: '%s' (%p): %s, parent %p (delayed)\n",
632 kobject_name(kobj), kobj, __func__, kobj->parent);
633 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
634 schedule_delayed_work(&kobj->release, HZ);
635#else
636 kobject_cleanup(kobj);
637#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638}
639
640/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800641 * kobject_put - decrement refcount for object.
642 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800644 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800646void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800648 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700649 if (!kobj->state_initialized)
650 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800651 "initialized, yet kobject_put() is being "
652 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800654 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655}
656
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800657static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500658{
Harvey Harrison810304d2008-04-30 00:55:08 -0700659 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500660 kfree(kobj);
661}
662
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800663static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100664 .release = dynamic_kobj_release,
665 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500666};
667
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800668/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800669 * kobject_create - create a struct kobject dynamically
670 *
671 * This function creates a kobject structure dynamically and sets it up
672 * to be a "dynamic" kobject with a default release function set up.
673 *
674 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800675 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700676 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800677 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800678 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800679struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800680{
681 struct kobject *kobj;
682
683 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
684 if (!kobj)
685 return NULL;
686
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700687 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800688 return kobj;
689}
690
691/**
692 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
693 *
Zhi Yong Wu9ff1f832012-05-07 10:48:25 +0800694 * @name: the name for the kobject
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800695 * @parent: the parent kobject of this kobject, if any.
696 *
Dave Youngf70701a2008-01-28 16:58:00 +0800697 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800698 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800699 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800700 * it is no longer being used.
701 *
702 * If the kobject was not able to be created, NULL will be returned.
703 */
704struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
705{
706 struct kobject *kobj;
707 int retval;
708
709 kobj = kobject_create();
710 if (!kobj)
711 return NULL;
712
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700713 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800714 if (retval) {
715 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700716 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800717 kobject_put(kobj);
718 kobj = NULL;
719 }
720 return kobj;
721}
722EXPORT_SYMBOL_GPL(kobject_create_and_add);
723
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500724/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800725 * kset_init - initialize a kset for use
726 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800728void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700730 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 INIT_LIST_HEAD(&k->list);
732 spin_lock_init(&k->list_lock);
733}
734
Kay Sievers23b52122007-11-02 13:47:53 +0100735/* default kobject attribute operations */
736static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
737 char *buf)
738{
739 struct kobj_attribute *kattr;
740 ssize_t ret = -EIO;
741
742 kattr = container_of(attr, struct kobj_attribute, attr);
743 if (kattr->show)
744 ret = kattr->show(kobj, kattr, buf);
745 return ret;
746}
747
748static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
749 const char *buf, size_t count)
750{
751 struct kobj_attribute *kattr;
752 ssize_t ret = -EIO;
753
754 kattr = container_of(attr, struct kobj_attribute, attr);
755 if (kattr->store)
756 ret = kattr->store(kobj, kattr, buf, count);
757 return ret;
758}
759
Emese Revfy52cf25d2010-01-19 02:58:23 +0100760const struct sysfs_ops kobj_sysfs_ops = {
Kay Sievers23b52122007-11-02 13:47:53 +0100761 .show = kobj_attr_show,
762 .store = kobj_attr_store,
763};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764
765/**
Jeff Mahoneyeee03162013-09-11 13:00:30 -0400766 * kobj_completion_init - initialize a kobj_completion object.
767 * @kc: kobj_completion
768 * @ktype: type of kobject to initialize
769 *
770 * kobj_completion structures can be embedded within structures with different
771 * lifetime rules. During the release of the enclosing object, we can
772 * wait on the release of the kobject so that we don't free it while it's
773 * still busy.
774 */
775void kobj_completion_init(struct kobj_completion *kc, struct kobj_type *ktype)
776{
777 init_completion(&kc->kc_unregister);
778 kobject_init(&kc->kc_kobj, ktype);
779}
780EXPORT_SYMBOL_GPL(kobj_completion_init);
781
782/**
783 * kobj_completion_release - release a kobj_completion object
784 * @kobj: kobject embedded in kobj_completion
785 *
786 * Used with kobject_release to notify waiters that the kobject has been
787 * released.
788 */
789void kobj_completion_release(struct kobject *kobj)
790{
791 struct kobj_completion *kc = kobj_to_kobj_completion(kobj);
792 complete(&kc->kc_unregister);
793}
794EXPORT_SYMBOL_GPL(kobj_completion_release);
795
796/**
797 * kobj_completion_del_and_wait - release the kobject and wait for it
798 * @kc: kobj_completion object to release
799 *
800 * Delete the kobject from sysfs and drop the reference count. Then wait
801 * until any other outstanding references are also dropped. This routine
802 * is only necessary once other references may have been taken on the
803 * kobject. Typically this happens when the kobject has been published
804 * to sysfs via kobject_add.
805 */
806void kobj_completion_del_and_wait(struct kobj_completion *kc)
807{
808 kobject_del(&kc->kc_kobj);
809 kobject_put(&kc->kc_kobj);
810 wait_for_completion(&kc->kc_unregister);
811}
812EXPORT_SYMBOL_GPL(kobj_completion_del_and_wait);
813
814/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800815 * kset_register - initialize and add a kset.
816 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800818int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819{
Kay Sievers80f03e32007-05-26 11:21:36 +0200820 int err;
821
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800822 if (!k)
823 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200824
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700826 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200827 if (err)
828 return err;
829 kobject_uevent(&k->kobj, KOBJ_ADD);
830 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831}
832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800834 * kset_unregister - remove a kset.
835 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800837void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800839 if (!k)
840 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800841 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842}
843
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800845 * kset_find_obj - search for object in kset.
846 * @kset: kset we're looking in.
847 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800849 * Lock kset via @kset->subsys, and iterate over @kset->list,
850 * looking for a matching kobject. If matching object is found
851 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800853struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400855 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800856 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
858 spin_lock(&kset->list_lock);
Robin Holtc25d1df2010-09-29 14:00:54 -0500859
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400860 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800861 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700862 ret = kobject_get_unless_zero(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 break;
864 }
865 }
Robin Holtc25d1df2010-09-29 14:00:54 -0500866
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867 spin_unlock(&kset->list_lock);
868 return ret;
869}
870
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700871static void kset_release(struct kobject *kobj)
872{
873 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800874 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700875 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700876 kfree(kset);
877}
878
Kay Sievers386f2752007-11-02 13:47:53 +0100879static struct kobj_type kset_ktype = {
880 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700881 .release = kset_release,
882};
883
884/**
885 * kset_create - create a struct kset dynamically
886 *
887 * @name: the name for the kset
888 * @uevent_ops: a struct kset_uevent_ops for the kset
889 * @parent_kobj: the parent kobject of this kset, if any.
890 *
891 * This function creates a kset structure dynamically. This structure can
892 * then be registered with the system and show up in sysfs with a call to
893 * kset_register(). When you are finished with this structure, if
894 * kset_register() has been called, call kset_unregister() and the
895 * structure will be dynamically freed when it is no longer being used.
896 *
897 * If the kset was not able to be created, NULL will be returned.
898 */
899static struct kset *kset_create(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100900 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700901 struct kobject *parent_kobj)
902{
903 struct kset *kset;
Dave Youngd9cd8f32009-05-11 14:17:45 +0800904 int retval;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700905
906 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
907 if (!kset)
908 return NULL;
Kees Cookb7165eb2013-06-06 13:52:19 -0700909 retval = kobject_set_name(&kset->kobj, "%s", name);
Dave Youngd9cd8f32009-05-11 14:17:45 +0800910 if (retval) {
911 kfree(kset);
912 return NULL;
913 }
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700914 kset->uevent_ops = uevent_ops;
915 kset->kobj.parent = parent_kobj;
916
917 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100918 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700919 * no kset itself. That way we can properly free it when it is
920 * finished being used.
921 */
Kay Sievers386f2752007-11-02 13:47:53 +0100922 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700923 kset->kobj.kset = NULL;
924
925 return kset;
926}
927
928/**
929 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
930 *
931 * @name: the name for the kset
932 * @uevent_ops: a struct kset_uevent_ops for the kset
933 * @parent_kobj: the parent kobject of this kset, if any.
934 *
935 * This function creates a kset structure dynamically and registers it
936 * with sysfs. When you are finished with this structure, call
937 * kset_unregister() and the structure will be dynamically freed when it
938 * is no longer being used.
939 *
940 * If the kset was not able to be created, NULL will be returned.
941 */
942struct kset *kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100943 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700944 struct kobject *parent_kobj)
945{
946 struct kset *kset;
947 int error;
948
949 kset = kset_create(name, uevent_ops, parent_kobj);
950 if (!kset)
951 return NULL;
952 error = kset_register(kset);
953 if (error) {
954 kfree(kset);
955 return NULL;
956 }
957 return kset;
958}
959EXPORT_SYMBOL_GPL(kset_create_and_add);
960
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700961
962static DEFINE_SPINLOCK(kobj_ns_type_lock);
963static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
964
965int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
966{
967 enum kobj_ns_type type = ops->type;
968 int error;
969
970 spin_lock(&kobj_ns_type_lock);
971
972 error = -EINVAL;
973 if (type >= KOBJ_NS_TYPES)
974 goto out;
975
976 error = -EINVAL;
977 if (type <= KOBJ_NS_TYPE_NONE)
978 goto out;
979
980 error = -EBUSY;
981 if (kobj_ns_ops_tbl[type])
982 goto out;
983
984 error = 0;
985 kobj_ns_ops_tbl[type] = ops;
986
987out:
988 spin_unlock(&kobj_ns_type_lock);
989 return error;
990}
991
992int kobj_ns_type_registered(enum kobj_ns_type type)
993{
994 int registered = 0;
995
996 spin_lock(&kobj_ns_type_lock);
997 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
998 registered = kobj_ns_ops_tbl[type] != NULL;
999 spin_unlock(&kobj_ns_type_lock);
1000
1001 return registered;
1002}
1003
1004const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
1005{
1006 const struct kobj_ns_type_operations *ops = NULL;
1007
1008 if (parent && parent->ktype->child_ns_type)
1009 ops = parent->ktype->child_ns_type(parent);
1010
1011 return ops;
1012}
1013
1014const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
1015{
1016 return kobj_child_ns_ops(kobj->parent);
1017}
1018
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001019bool kobj_ns_current_may_mount(enum kobj_ns_type type)
1020{
Eric W. Biederman730d7d32013-09-23 14:41:17 -07001021 bool may_mount = true;
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001022
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 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
1027 spin_unlock(&kobj_ns_type_lock);
1028
1029 return may_mount;
1030}
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001031
Al Viroa685e082011-06-08 21:13:01 -04001032void *kobj_ns_grab_current(enum kobj_ns_type type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001033{
Al Viroa685e082011-06-08 21:13:01 -04001034 void *ns = NULL;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001035
1036 spin_lock(&kobj_ns_type_lock);
1037 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1038 kobj_ns_ops_tbl[type])
Al Viroa685e082011-06-08 21:13:01 -04001039 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001040 spin_unlock(&kobj_ns_type_lock);
1041
1042 return ns;
1043}
1044
1045const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1046{
1047 const void *ns = NULL;
1048
1049 spin_lock(&kobj_ns_type_lock);
1050 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1051 kobj_ns_ops_tbl[type])
1052 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1053 spin_unlock(&kobj_ns_type_lock);
1054
1055 return ns;
1056}
1057
1058const void *kobj_ns_initial(enum kobj_ns_type type)
1059{
1060 const void *ns = NULL;
1061
1062 spin_lock(&kobj_ns_type_lock);
1063 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1064 kobj_ns_ops_tbl[type])
1065 ns = kobj_ns_ops_tbl[type]->initial_ns();
1066 spin_unlock(&kobj_ns_type_lock);
1067
1068 return ns;
1069}
1070
Al Viroa685e082011-06-08 21:13:01 -04001071void kobj_ns_drop(enum kobj_ns_type type, void *ns)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001072{
Al Viroa685e082011-06-08 21:13:01 -04001073 spin_lock(&kobj_ns_type_lock);
1074 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1075 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1076 kobj_ns_ops_tbl[type]->drop_ns(ns);
1077 spin_unlock(&kobj_ns_type_lock);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001078}
1079
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080EXPORT_SYMBOL(kobject_get);
1081EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082EXPORT_SYMBOL(kobject_del);
1083
1084EXPORT_SYMBOL(kset_register);
1085EXPORT_SYMBOL(kset_unregister);