blob: 084f7b18d0c0a722e215dce8d14dcda0e6ba78d8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * kobject.c - library routines for handling generic kernel objects
3 *
4 * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org>
Greg Kroah-Hartmanf0e7e1b2007-09-27 14:48:53 -07005 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (c) 2006-2007 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * This file is released under the GPLv2.
9 *
10 *
11 * Please see the file Documentation/kobject.txt for critical information
12 * about using the kobject interface.
13 */
14
15#include <linux/kobject.h>
16#include <linux/string.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050017#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/stat.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080019#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080021/*
22 * populate_dir - populate directory with attributes.
23 * @kobj: object we're working on.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080025 * Most subsystems have a set of default attributes that are associated
26 * with an object that registers with them. This is a helper called during
27 * object registration that loops through the default attributes of the
28 * subsystem and creates attributes files for them in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080030static int populate_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070031{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080032 struct kobj_type *t = get_ktype(kobj);
33 struct attribute *attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 int error = 0;
35 int i;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080036
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 if (t && t->default_attrs) {
38 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080039 error = sysfs_create_file(kobj, attr);
40 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 break;
42 }
43 }
44 return error;
45}
46
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080047static int create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048{
49 int error = 0;
yan6b960612012-04-20 21:25:53 +080050 error = sysfs_create_dir(kobj);
51 if (!error) {
52 error = populate_dir(kobj);
53 if (error)
54 sysfs_remove_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 }
56 return error;
57}
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059static int get_kobj_path_length(struct kobject *kobj)
60{
61 int length = 1;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080062 struct kobject *parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080064 /* walk up the ancestors until we hit the one pointing to the
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 * root.
66 * Add 1 to strlen for leading '/' of each level.
67 */
68 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -050069 if (kobject_name(parent) == NULL)
70 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 length += strlen(kobject_name(parent)) + 1;
72 parent = parent->parent;
73 } while (parent);
74 return length;
75}
76
77static void fill_kobj_path(struct kobject *kobj, char *path, int length)
78{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080079 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81 --length;
82 for (parent = kobj; parent; parent = parent->parent) {
83 int cur = strlen(kobject_name(parent));
84 /* back up enough to print this name with '/' */
85 length -= cur;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080086 strncpy(path + length, kobject_name(parent), cur);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 *(path + --length) = '/';
88 }
89
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -080090 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
Harvey Harrison810304d2008-04-30 00:55:08 -070091 kobj, __func__, path);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092}
93
94/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -080095 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 *
97 * @kobj: kobject in question, with which to build the path
98 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -080099 *
100 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 */
Al Virofd4f2df2005-10-21 03:18:50 -0400102char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103{
104 char *path;
105 int len;
106
107 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500108 if (len == 0)
109 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800110 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 if (!path)
112 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 fill_kobj_path(kobj, path, len);
114
115 return path;
116}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400117EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100119/* add the kobject to its kset's list */
120static void kobj_kset_join(struct kobject *kobj)
121{
122 if (!kobj->kset)
123 return;
124
125 kset_get(kobj->kset);
126 spin_lock(&kobj->kset->list_lock);
127 list_add_tail(&kobj->entry, &kobj->kset->list);
128 spin_unlock(&kobj->kset->list_lock);
129}
130
131/* remove the kobject from its kset's list */
132static void kobj_kset_leave(struct kobject *kobj)
133{
134 if (!kobj->kset)
135 return;
136
137 spin_lock(&kobj->kset->list_lock);
138 list_del_init(&kobj->entry);
139 spin_unlock(&kobj->kset->list_lock);
140 kset_put(kobj->kset);
141}
142
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800143static void kobject_init_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800145 if (!kobj)
146 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 kref_init(&kobj->kref);
148 INIT_LIST_HEAD(&kobj->entry);
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800149 kobj->state_in_sysfs = 0;
150 kobj->state_add_uevent_sent = 0;
151 kobj->state_remove_uevent_sent = 0;
152 kobj->state_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153}
154
155
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700156static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
158 int error = 0;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800159 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100161 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100163
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100164 if (!kobj->name || !kobj->name[0]) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700165 WARN(1, "kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800166 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800167 return -EINVAL;
168 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 parent = kobject_get(kobj->parent);
171
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100172 /* join kset if set, use it as parent if we do not already have one */
173 if (kobj->kset) {
174 if (!parent)
175 parent = kobject_get(&kobj->kset->kobj);
176 kobj_kset_join(kobj);
177 kobj->parent = parent;
178 }
179
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800180 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700181 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800182 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800183 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900185 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100187 kobj_kset_leave(kobj);
188 kobject_put(parent);
189 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800190
191 /* be noisy on error issues */
192 if (error == -EEXIST)
Dan Williams282029c2012-04-06 13:41:15 -0700193 WARN(1, "%s failed for %s with "
194 "-EEXIST, don't try to register things with "
195 "the same name in the same directory.\n",
196 __func__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800197 else
Dan Williams282029c2012-04-06 13:41:15 -0700198 WARN(1, "%s failed for %s (error: %d parent: %s)\n",
199 __func__, kobject_name(kobj), error,
200 parent ? kobject_name(parent) : "'none'");
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100201 } else
202 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204 return error;
205}
206
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700207/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500208 * kobject_set_name_vargs - Set the name of an kobject
209 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800210 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500211 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 */
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100213int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500214 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215{
Kay Sievers9f255652008-05-06 22:24:04 +0200216 const char *old_name = kobj->name;
217 char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
Kay Sievers8a577ff2009-04-18 15:05:45 -0700219 if (kobj->name && !fmt)
220 return 0;
221
Kay Sieversa4ca6612008-04-30 02:06:29 +0200222 kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
223 if (!kobj->name)
224 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500225
Kay Sievers9f255652008-05-06 22:24:04 +0200226 /* ewww... some of these buggers have '/' in the name ... */
Ingo Oeser25fdeb32008-07-23 01:25:01 +0200227 while ((s = strchr(kobj->name, '/')))
Kay Sievers9f255652008-05-06 22:24:04 +0200228 s[0] = '!';
229
230 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500231 return 0;
232}
233
234/**
235 * kobject_set_name - Set the name of a kobject
236 * @kobj: struct kobject to set the name of
237 * @fmt: format string used to build the name
238 *
239 * This sets the name of the kobject. If you have already added the
240 * kobject to the system, you must call kobject_rename() in order to
241 * change the name of the kobject.
242 */
243int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
244{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200245 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500246 int retval;
247
Kay Sieversa4ca6612008-04-30 02:06:29 +0200248 va_start(vargs, fmt);
249 retval = kobject_set_name_vargs(kobj, fmt, vargs);
250 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500251
252 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254EXPORT_SYMBOL(kobject_set_name);
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700257 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800258 * @kobj: pointer to the kobject to initialize
259 * @ktype: pointer to the ktype for this kobject.
260 *
261 * This function will properly initialize a kobject such that it can then
262 * be passed to the kobject_add() call.
263 *
264 * After this function is called, the kobject MUST be cleaned up by a call
265 * to kobject_put(), not by a call to kfree directly to ensure that all of
266 * the memory is cleaned up properly.
267 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700268void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800269{
270 char *err_str;
271
272 if (!kobj) {
273 err_str = "invalid kobject pointer!";
274 goto error;
275 }
276 if (!ktype) {
277 err_str = "must have a ktype to be initialized properly!\n";
278 goto error;
279 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100280 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800281 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100282 printk(KERN_ERR "kobject (%p): tried to init an initialized "
283 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800284 dump_stack();
285 }
286
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800287 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800288 kobj->ktype = ktype;
289 return;
290
291error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100292 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800293 dump_stack();
294}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700295EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800296
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800297static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
298 const char *fmt, va_list vargs)
299{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800300 int retval;
301
Kay Sieversa4ca6612008-04-30 02:06:29 +0200302 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800303 if (retval) {
304 printk(KERN_ERR "kobject: can not set name properly!\n");
305 return retval;
306 }
307 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700308 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800309}
310
311/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700312 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800313 * @kobj: the kobject to add
314 * @parent: pointer to the parent of the kobject.
315 * @fmt: format to name the kobject with.
316 *
317 * The kobject name is set and added to the kobject hierarchy in this
318 * function.
319 *
320 * If @parent is set, then the parent of the @kobj will be set to it.
321 * If @parent is NULL, then the parent of the @kobj will be set to the
322 * kobject associted with the kset assigned to this kobject. If no kset
323 * is assigned to the kobject, then the kobject will be located in the
324 * root of the sysfs tree.
325 *
326 * If this function returns an error, kobject_put() must be called to
327 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800328 * Under no instance should the kobject that is passed to this function
329 * be directly freed with a call to kfree(), that can leak memory.
330 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100331 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800332 * up all of the necessary sysfs files for the object and then call
333 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
334 * userspace is properly notified of this kobject's creation.
335 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700336int kobject_add(struct kobject *kobj, struct kobject *parent,
337 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800338{
339 va_list args;
340 int retval;
341
342 if (!kobj)
343 return -EINVAL;
344
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100345 if (!kobj->state_initialized) {
346 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
347 "uninitialized object, something is seriously wrong.\n",
348 kobject_name(kobj), kobj);
349 dump_stack();
350 return -EINVAL;
351 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800352 va_start(args, fmt);
353 retval = kobject_add_varg(kobj, parent, fmt, args);
354 va_end(args);
355
356 return retval;
357}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700358EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800359
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800360/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800361 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
362 * @kobj: pointer to the kobject to initialize
363 * @ktype: pointer to the ktype for this kobject.
364 * @parent: pointer to the parent of this kobject.
365 * @fmt: the name of the kobject.
366 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700367 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700368 * kobject_add(). The same type of error handling after a call to
369 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800370 */
371int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
372 struct kobject *parent, const char *fmt, ...)
373{
374 va_list args;
375 int retval;
376
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700377 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800378
379 va_start(args, fmt);
380 retval = kobject_add_varg(kobj, parent, fmt, args);
381 va_end(args);
382
383 return retval;
384}
385EXPORT_SYMBOL_GPL(kobject_init_and_add);
386
387/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800388 * kobject_rename - change the name of an object
389 * @kobj: object in question.
390 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700391 *
392 * It is the responsibility of the caller to provide mutual
393 * exclusion between two different calls of kobject_rename
394 * on the same kobject and to ensure that new_name is valid and
395 * won't conflict with other kobjects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800397int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
399 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800400 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700401 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800402 char *devpath_string = NULL;
403 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405 kobj = kobject_get(kobj);
406 if (!kobj)
407 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700408 if (!kobj->parent)
409 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800410
411 devpath = kobject_get_path(kobj, GFP_KERNEL);
412 if (!devpath) {
413 error = -ENOMEM;
414 goto out;
415 }
416 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
417 if (!devpath_string) {
418 error = -ENOMEM;
419 goto out;
420 }
421 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
422 envp[0] = devpath_string;
423 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800424
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700425 name = dup_name = kstrdup(new_name, GFP_KERNEL);
426 if (!name) {
427 error = -ENOMEM;
428 goto out;
429 }
430
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900431 error = sysfs_rename_dir(kobj, new_name);
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700432 if (error)
433 goto out;
434
435 /* Install the new kobject name */
436 dup_name = kobj->name;
437 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800438
439 /* This function is mostly/only used for network interface.
440 * Some hotplug package track interfaces by their name and
441 * therefore want to know when the name is changed by the user. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700442 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800443
444out:
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700445 kfree(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800446 kfree(devpath_string);
447 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700448 kobject_put(kobj);
449
450 return error;
451}
Alex Chiang8344b562008-06-10 15:30:42 -0600452EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700453
454/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800455 * kobject_move - move object to another parent
456 * @kobj: object in question.
457 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100458 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100459int kobject_move(struct kobject *kobj, struct kobject *new_parent)
460{
461 int error;
462 struct kobject *old_parent;
463 const char *devpath = NULL;
464 char *devpath_string = NULL;
465 char *envp[2];
466
467 kobj = kobject_get(kobj);
468 if (!kobj)
469 return -EINVAL;
470 new_parent = kobject_get(new_parent);
471 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100472 if (kobj->kset)
473 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100474 }
475 /* old object path */
476 devpath = kobject_get_path(kobj, GFP_KERNEL);
477 if (!devpath) {
478 error = -ENOMEM;
479 goto out;
480 }
481 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
482 if (!devpath_string) {
483 error = -ENOMEM;
484 goto out;
485 }
486 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
487 envp[0] = devpath_string;
488 envp[1] = NULL;
489 error = sysfs_move_dir(kobj, new_parent);
490 if (error)
491 goto out;
492 old_parent = kobj->parent;
493 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300494 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100495 kobject_put(old_parent);
496 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
497out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300498 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100499 kobject_put(kobj);
500 kfree(devpath_string);
501 kfree(devpath);
502 return error;
503}
504
505/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800506 * kobject_del - unlink kobject from hierarchy.
507 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800509void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800511 if (!kobj)
512 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 sysfs_remove_dir(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100515 kobj->state_in_sysfs = 0;
516 kobj_kset_leave(kobj);
517 kobject_put(kobj->parent);
518 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519}
520
521/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800522 * kobject_get - increment refcount for object.
523 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800525struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{
527 if (kobj)
528 kref_get(&kobj->kref);
529 return kobj;
530}
531
Anatol Pomozov2d864e42013-05-07 15:37:48 -0700532static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700533{
534 if (!kref_get_unless_zero(&kobj->kref))
535 kobj = NULL;
536 return kobj;
537}
538
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800539/*
540 * kobject_cleanup - free kobject resources.
541 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800543static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100545 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100546 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Russell Kingc817a672013-06-27 15:06:14 +0100548 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
549 kobject_name(kobj), kobj, __func__, kobj->parent);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100550
551 if (t && !t->release)
552 pr_debug("kobject: '%s' (%p): does not have a release() "
553 "function, it is broken and must be fixed.\n",
554 kobject_name(kobj), kobj);
555
556 /* send "remove" if the caller did not do it but sent "add" */
557 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
558 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
559 kobject_name(kobj), kobj);
560 kobject_uevent(kobj, KOBJ_REMOVE);
561 }
562
563 /* remove from sysfs if the caller did not do it */
564 if (kobj->state_in_sysfs) {
565 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
566 kobject_name(kobj), kobj);
567 kobject_del(kobj);
568 }
569
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700570 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100571 pr_debug("kobject: '%s' (%p): calling ktype release\n",
572 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100574 }
575
576 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100577 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100578 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700579 kfree(name);
580 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581}
582
Russell Kingc817a672013-06-27 15:06:14 +0100583#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
584static void kobject_delayed_cleanup(struct work_struct *work)
585{
586 kobject_cleanup(container_of(to_delayed_work(work),
587 struct kobject, release));
588}
589#endif
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591static void kobject_release(struct kref *kref)
592{
Russell Kingc817a672013-06-27 15:06:14 +0100593 struct kobject *kobj = container_of(kref, struct kobject, kref);
594#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
Fengguang Wu0ff18e372013-10-09 09:26:21 +0800595 pr_info("kobject: '%s' (%p): %s, parent %p (delayed)\n",
Russell Kingc817a672013-06-27 15:06:14 +0100596 kobject_name(kobj), kobj, __func__, kobj->parent);
597 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
598 schedule_delayed_work(&kobj->release, HZ);
599#else
600 kobject_cleanup(kobj);
601#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602}
603
604/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800605 * kobject_put - decrement refcount for object.
606 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800608 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800610void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800612 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700613 if (!kobj->state_initialized)
614 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800615 "initialized, yet kobject_put() is being "
616 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800618 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619}
620
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800621static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500622{
Harvey Harrison810304d2008-04-30 00:55:08 -0700623 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500624 kfree(kobj);
625}
626
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800627static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100628 .release = dynamic_kobj_release,
629 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500630};
631
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800632/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800633 * kobject_create - create a struct kobject dynamically
634 *
635 * This function creates a kobject structure dynamically and sets it up
636 * to be a "dynamic" kobject with a default release function set up.
637 *
638 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800639 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700640 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800641 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800642 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800643struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800644{
645 struct kobject *kobj;
646
647 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
648 if (!kobj)
649 return NULL;
650
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700651 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800652 return kobj;
653}
654
655/**
656 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
657 *
Zhi Yong Wu9ff1f832012-05-07 10:48:25 +0800658 * @name: the name for the kobject
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800659 * @parent: the parent kobject of this kobject, if any.
660 *
Dave Youngf70701a2008-01-28 16:58:00 +0800661 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800662 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800663 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800664 * it is no longer being used.
665 *
666 * If the kobject was not able to be created, NULL will be returned.
667 */
668struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
669{
670 struct kobject *kobj;
671 int retval;
672
673 kobj = kobject_create();
674 if (!kobj)
675 return NULL;
676
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700677 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800678 if (retval) {
679 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700680 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800681 kobject_put(kobj);
682 kobj = NULL;
683 }
684 return kobj;
685}
686EXPORT_SYMBOL_GPL(kobject_create_and_add);
687
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500688/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800689 * kset_init - initialize a kset for use
690 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800692void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700694 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 INIT_LIST_HEAD(&k->list);
696 spin_lock_init(&k->list_lock);
697}
698
Kay Sievers23b52122007-11-02 13:47:53 +0100699/* default kobject attribute operations */
700static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
701 char *buf)
702{
703 struct kobj_attribute *kattr;
704 ssize_t ret = -EIO;
705
706 kattr = container_of(attr, struct kobj_attribute, attr);
707 if (kattr->show)
708 ret = kattr->show(kobj, kattr, buf);
709 return ret;
710}
711
712static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
713 const char *buf, size_t count)
714{
715 struct kobj_attribute *kattr;
716 ssize_t ret = -EIO;
717
718 kattr = container_of(attr, struct kobj_attribute, attr);
719 if (kattr->store)
720 ret = kattr->store(kobj, kattr, buf, count);
721 return ret;
722}
723
Emese Revfy52cf25d2010-01-19 02:58:23 +0100724const struct sysfs_ops kobj_sysfs_ops = {
Kay Sievers23b52122007-11-02 13:47:53 +0100725 .show = kobj_attr_show,
726 .store = kobj_attr_store,
727};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728
729/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800730 * kset_register - initialize and add a kset.
731 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800733int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734{
Kay Sievers80f03e32007-05-26 11:21:36 +0200735 int err;
736
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800737 if (!k)
738 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200739
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700741 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200742 if (err)
743 return err;
744 kobject_uevent(&k->kobj, KOBJ_ADD);
745 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746}
747
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800749 * kset_unregister - remove a kset.
750 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800752void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800754 if (!k)
755 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800756 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757}
758
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800760 * kset_find_obj - search for object in kset.
761 * @kset: kset we're looking in.
762 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800764 * Lock kset via @kset->subsys, and iterate over @kset->list,
765 * looking for a matching kobject. If matching object is found
766 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800768struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400770 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800771 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
773 spin_lock(&kset->list_lock);
Robin Holtc25d1df2010-09-29 14:00:54 -0500774
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400775 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800776 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700777 ret = kobject_get_unless_zero(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 break;
779 }
780 }
Robin Holtc25d1df2010-09-29 14:00:54 -0500781
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 spin_unlock(&kset->list_lock);
783 return ret;
784}
785
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700786static void kset_release(struct kobject *kobj)
787{
788 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800789 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700790 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700791 kfree(kset);
792}
793
Kay Sievers386f2752007-11-02 13:47:53 +0100794static struct kobj_type kset_ktype = {
795 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700796 .release = kset_release,
797};
798
799/**
800 * kset_create - create a struct kset dynamically
801 *
802 * @name: the name for the kset
803 * @uevent_ops: a struct kset_uevent_ops for the kset
804 * @parent_kobj: the parent kobject of this kset, if any.
805 *
806 * This function creates a kset structure dynamically. This structure can
807 * then be registered with the system and show up in sysfs with a call to
808 * kset_register(). When you are finished with this structure, if
809 * kset_register() has been called, call kset_unregister() and the
810 * structure will be dynamically freed when it is no longer being used.
811 *
812 * If the kset was not able to be created, NULL will be returned.
813 */
814static struct kset *kset_create(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100815 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700816 struct kobject *parent_kobj)
817{
818 struct kset *kset;
Dave Youngd9cd8f32009-05-11 14:17:45 +0800819 int retval;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700820
821 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
822 if (!kset)
823 return NULL;
Kees Cookb7165eb2013-06-06 13:52:19 -0700824 retval = kobject_set_name(&kset->kobj, "%s", name);
Dave Youngd9cd8f32009-05-11 14:17:45 +0800825 if (retval) {
826 kfree(kset);
827 return NULL;
828 }
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700829 kset->uevent_ops = uevent_ops;
830 kset->kobj.parent = parent_kobj;
831
832 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100833 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700834 * no kset itself. That way we can properly free it when it is
835 * finished being used.
836 */
Kay Sievers386f2752007-11-02 13:47:53 +0100837 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700838 kset->kobj.kset = NULL;
839
840 return kset;
841}
842
843/**
844 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
845 *
846 * @name: the name for the kset
847 * @uevent_ops: a struct kset_uevent_ops for the kset
848 * @parent_kobj: the parent kobject of this kset, if any.
849 *
850 * This function creates a kset structure dynamically and registers it
851 * with sysfs. When you are finished with this structure, call
852 * kset_unregister() and the structure will be dynamically freed when it
853 * is no longer being used.
854 *
855 * If the kset was not able to be created, NULL will be returned.
856 */
857struct kset *kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100858 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700859 struct kobject *parent_kobj)
860{
861 struct kset *kset;
862 int error;
863
864 kset = kset_create(name, uevent_ops, parent_kobj);
865 if (!kset)
866 return NULL;
867 error = kset_register(kset);
868 if (error) {
869 kfree(kset);
870 return NULL;
871 }
872 return kset;
873}
874EXPORT_SYMBOL_GPL(kset_create_and_add);
875
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700876
877static DEFINE_SPINLOCK(kobj_ns_type_lock);
878static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
879
880int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
881{
882 enum kobj_ns_type type = ops->type;
883 int error;
884
885 spin_lock(&kobj_ns_type_lock);
886
887 error = -EINVAL;
888 if (type >= KOBJ_NS_TYPES)
889 goto out;
890
891 error = -EINVAL;
892 if (type <= KOBJ_NS_TYPE_NONE)
893 goto out;
894
895 error = -EBUSY;
896 if (kobj_ns_ops_tbl[type])
897 goto out;
898
899 error = 0;
900 kobj_ns_ops_tbl[type] = ops;
901
902out:
903 spin_unlock(&kobj_ns_type_lock);
904 return error;
905}
906
907int kobj_ns_type_registered(enum kobj_ns_type type)
908{
909 int registered = 0;
910
911 spin_lock(&kobj_ns_type_lock);
912 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
913 registered = kobj_ns_ops_tbl[type] != NULL;
914 spin_unlock(&kobj_ns_type_lock);
915
916 return registered;
917}
918
919const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
920{
921 const struct kobj_ns_type_operations *ops = NULL;
922
923 if (parent && parent->ktype->child_ns_type)
924 ops = parent->ktype->child_ns_type(parent);
925
926 return ops;
927}
928
929const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
930{
931 return kobj_child_ns_ops(kobj->parent);
932}
933
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -0700934bool kobj_ns_current_may_mount(enum kobj_ns_type type)
935{
Eric W. Biederman730d7d32013-09-23 14:41:17 -0700936 bool may_mount = true;
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -0700937
938 spin_lock(&kobj_ns_type_lock);
939 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
940 kobj_ns_ops_tbl[type])
941 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
942 spin_unlock(&kobj_ns_type_lock);
943
944 return may_mount;
945}
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700946
Al Viroa685e082011-06-08 21:13:01 -0400947void *kobj_ns_grab_current(enum kobj_ns_type type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700948{
Al Viroa685e082011-06-08 21:13:01 -0400949 void *ns = NULL;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700950
951 spin_lock(&kobj_ns_type_lock);
952 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
953 kobj_ns_ops_tbl[type])
Al Viroa685e082011-06-08 21:13:01 -0400954 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700955 spin_unlock(&kobj_ns_type_lock);
956
957 return ns;
958}
959
960const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
961{
962 const void *ns = NULL;
963
964 spin_lock(&kobj_ns_type_lock);
965 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
966 kobj_ns_ops_tbl[type])
967 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
968 spin_unlock(&kobj_ns_type_lock);
969
970 return ns;
971}
972
973const void *kobj_ns_initial(enum kobj_ns_type type)
974{
975 const void *ns = NULL;
976
977 spin_lock(&kobj_ns_type_lock);
978 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
979 kobj_ns_ops_tbl[type])
980 ns = kobj_ns_ops_tbl[type]->initial_ns();
981 spin_unlock(&kobj_ns_type_lock);
982
983 return ns;
984}
985
Al Viroa685e082011-06-08 21:13:01 -0400986void kobj_ns_drop(enum kobj_ns_type type, void *ns)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700987{
Al Viroa685e082011-06-08 21:13:01 -0400988 spin_lock(&kobj_ns_type_lock);
989 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
990 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
991 kobj_ns_ops_tbl[type]->drop_ns(ns);
992 spin_unlock(&kobj_ns_type_lock);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700993}
994
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995EXPORT_SYMBOL(kobject_get);
996EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997EXPORT_SYMBOL(kobject_del);
998
999EXPORT_SYMBOL(kset_register);
1000EXPORT_SYMBOL(kset_unregister);