blob: 16e9335b32d392c4690d4ae81f95914e0565b732 [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 Heoc84a3b22013-11-23 18:01:46 -050068 const struct kobj_ns_type_operations *ops;
Tejun Heoe34ff492013-09-11 22:29:05 -040069 int error;
70
71 error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
Tejun Heoc84a3b22013-11-23 18:01:46 -050072 if (error)
73 return error;
74
75 error = populate_dir(kobj);
76 if (error) {
77 sysfs_remove_dir(kobj);
78 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 }
Tejun Heo26ea12d2013-09-18 17:15:36 -040080
81 /*
82 * @kobj->sd may be deleted by an ancestor going away. Hold an
83 * extra reference so that it stays until @kobj is gone.
84 */
85 sysfs_get(kobj->sd);
86
Tejun Heoc84a3b22013-11-23 18:01:46 -050087 /*
88 * If @kobj has ns_ops, its children need to be filtered based on
89 * their namespace tags. Enable namespace support on @kobj->sd.
90 */
91 ops = kobj_child_ns_ops(kobj);
92 if (ops) {
93 BUG_ON(ops->type <= KOBJ_NS_TYPE_NONE);
94 BUG_ON(ops->type >= KOBJ_NS_TYPES);
95 BUG_ON(!kobj_ns_type_registered(ops->type));
96
97 sysfs_enable_ns(kobj->sd);
98 }
99
100 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103static int get_kobj_path_length(struct kobject *kobj)
104{
105 int length = 1;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800106 struct kobject *parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800108 /* walk up the ancestors until we hit the one pointing to the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * root.
110 * Add 1 to strlen for leading '/' of each level.
111 */
112 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500113 if (kobject_name(parent) == NULL)
114 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 length += strlen(kobject_name(parent)) + 1;
116 parent = parent->parent;
117 } while (parent);
118 return length;
119}
120
121static void fill_kobj_path(struct kobject *kobj, char *path, int length)
122{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800123 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125 --length;
126 for (parent = kobj; parent; parent = parent->parent) {
127 int cur = strlen(kobject_name(parent));
128 /* back up enough to print this name with '/' */
129 length -= cur;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800130 strncpy(path + length, kobject_name(parent), cur);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 *(path + --length) = '/';
132 }
133
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800134 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
Harvey Harrison810304d2008-04-30 00:55:08 -0700135 kobj, __func__, path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136}
137
138/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800139 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 *
141 * @kobj: kobject in question, with which to build the path
142 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800143 *
144 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 */
Al Virofd4f2df2005-10-21 03:18:50 -0400146char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
148 char *path;
149 int len;
150
151 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500152 if (len == 0)
153 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800154 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 if (!path)
156 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 fill_kobj_path(kobj, path, len);
158
159 return path;
160}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400161EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100163/* add the kobject to its kset's list */
164static void kobj_kset_join(struct kobject *kobj)
165{
166 if (!kobj->kset)
167 return;
168
169 kset_get(kobj->kset);
170 spin_lock(&kobj->kset->list_lock);
171 list_add_tail(&kobj->entry, &kobj->kset->list);
172 spin_unlock(&kobj->kset->list_lock);
173}
174
175/* remove the kobject from its kset's list */
176static void kobj_kset_leave(struct kobject *kobj)
177{
178 if (!kobj->kset)
179 return;
180
181 spin_lock(&kobj->kset->list_lock);
182 list_del_init(&kobj->entry);
183 spin_unlock(&kobj->kset->list_lock);
184 kset_put(kobj->kset);
185}
186
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800187static void kobject_init_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800189 if (!kobj)
190 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 kref_init(&kobj->kref);
192 INIT_LIST_HEAD(&kobj->entry);
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800193 kobj->state_in_sysfs = 0;
194 kobj->state_add_uevent_sent = 0;
195 kobj->state_remove_uevent_sent = 0;
196 kobj->state_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197}
198
199
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700200static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
202 int error = 0;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800203 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100205 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100207
Kay Sieversaf5ca3f42007-12-20 02:09:39 +0100208 if (!kobj->name || !kobj->name[0]) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700209 WARN(1, "kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800210 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800211 return -EINVAL;
212 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 parent = kobject_get(kobj->parent);
215
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100216 /* join kset if set, use it as parent if we do not already have one */
217 if (kobj->kset) {
218 if (!parent)
219 parent = kobject_get(&kobj->kset->kobj);
220 kobj_kset_join(kobj);
221 kobj->parent = parent;
222 }
223
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800224 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700225 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800226 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800227 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900229 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100231 kobj_kset_leave(kobj);
232 kobject_put(parent);
233 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800234
235 /* be noisy on error issues */
236 if (error == -EEXIST)
Dan Williams282029c2012-04-06 13:41:15 -0700237 WARN(1, "%s failed for %s with "
238 "-EEXIST, don't try to register things with "
239 "the same name in the same directory.\n",
240 __func__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800241 else
Dan Williams282029c2012-04-06 13:41:15 -0700242 WARN(1, "%s failed for %s (error: %d parent: %s)\n",
243 __func__, kobject_name(kobj), error,
244 parent ? kobject_name(parent) : "'none'");
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100245 } else
246 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 return error;
249}
250
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700251/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500252 * kobject_set_name_vargs - Set the name of an kobject
253 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800254 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500255 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 */
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100257int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500258 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Kay Sievers9f255652008-05-06 22:24:04 +0200260 const char *old_name = kobj->name;
261 char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Kay Sievers8a577ff2009-04-18 15:05:45 -0700263 if (kobj->name && !fmt)
264 return 0;
265
Kay Sieversa4ca6612008-04-30 02:06:29 +0200266 kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
267 if (!kobj->name)
268 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500269
Kay Sievers9f255652008-05-06 22:24:04 +0200270 /* ewww... some of these buggers have '/' in the name ... */
Ingo Oeser25fdeb32008-07-23 01:25:01 +0200271 while ((s = strchr(kobj->name, '/')))
Kay Sievers9f255652008-05-06 22:24:04 +0200272 s[0] = '!';
273
274 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500275 return 0;
276}
277
278/**
279 * kobject_set_name - Set the name of a kobject
280 * @kobj: struct kobject to set the name of
281 * @fmt: format string used to build the name
282 *
283 * This sets the name of the kobject. If you have already added the
284 * kobject to the system, you must call kobject_rename() in order to
285 * change the name of the kobject.
286 */
287int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
288{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200289 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500290 int retval;
291
Kay Sieversa4ca6612008-04-30 02:06:29 +0200292 va_start(vargs, fmt);
293 retval = kobject_set_name_vargs(kobj, fmt, vargs);
294 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500295
296 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298EXPORT_SYMBOL(kobject_set_name);
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700301 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800302 * @kobj: pointer to the kobject to initialize
303 * @ktype: pointer to the ktype for this kobject.
304 *
305 * This function will properly initialize a kobject such that it can then
306 * be passed to the kobject_add() call.
307 *
308 * After this function is called, the kobject MUST be cleaned up by a call
309 * to kobject_put(), not by a call to kfree directly to ensure that all of
310 * the memory is cleaned up properly.
311 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700312void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800313{
314 char *err_str;
315
316 if (!kobj) {
317 err_str = "invalid kobject pointer!";
318 goto error;
319 }
320 if (!ktype) {
321 err_str = "must have a ktype to be initialized properly!\n";
322 goto error;
323 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100324 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800325 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100326 printk(KERN_ERR "kobject (%p): tried to init an initialized "
327 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800328 dump_stack();
329 }
330
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800331 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800332 kobj->ktype = ktype;
333 return;
334
335error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100336 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800337 dump_stack();
338}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700339EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800340
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800341static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
342 const char *fmt, va_list vargs)
343{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800344 int retval;
345
Kay Sieversa4ca6612008-04-30 02:06:29 +0200346 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800347 if (retval) {
348 printk(KERN_ERR "kobject: can not set name properly!\n");
349 return retval;
350 }
351 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700352 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800353}
354
355/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700356 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800357 * @kobj: the kobject to add
358 * @parent: pointer to the parent of the kobject.
359 * @fmt: format to name the kobject with.
360 *
361 * The kobject name is set and added to the kobject hierarchy in this
362 * function.
363 *
364 * If @parent is set, then the parent of the @kobj will be set to it.
365 * If @parent is NULL, then the parent of the @kobj will be set to the
366 * kobject associted with the kset assigned to this kobject. If no kset
367 * is assigned to the kobject, then the kobject will be located in the
368 * root of the sysfs tree.
369 *
370 * If this function returns an error, kobject_put() must be called to
371 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800372 * Under no instance should the kobject that is passed to this function
373 * be directly freed with a call to kfree(), that can leak memory.
374 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100375 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800376 * up all of the necessary sysfs files for the object and then call
377 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
378 * userspace is properly notified of this kobject's creation.
379 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700380int kobject_add(struct kobject *kobj, struct kobject *parent,
381 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800382{
383 va_list args;
384 int retval;
385
386 if (!kobj)
387 return -EINVAL;
388
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100389 if (!kobj->state_initialized) {
390 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
391 "uninitialized object, something is seriously wrong.\n",
392 kobject_name(kobj), kobj);
393 dump_stack();
394 return -EINVAL;
395 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800396 va_start(args, fmt);
397 retval = kobject_add_varg(kobj, parent, fmt, args);
398 va_end(args);
399
400 return retval;
401}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700402EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800403
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800404/**
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800405 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
406 * @kobj: pointer to the kobject to initialize
407 * @ktype: pointer to the ktype for this kobject.
408 * @parent: pointer to the parent of this kobject.
409 * @fmt: the name of the kobject.
410 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700411 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700412 * kobject_add(). The same type of error handling after a call to
413 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800414 */
415int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
416 struct kobject *parent, const char *fmt, ...)
417{
418 va_list args;
419 int retval;
420
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700421 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800422
423 va_start(args, fmt);
424 retval = kobject_add_varg(kobj, parent, fmt, args);
425 va_end(args);
426
427 return retval;
428}
429EXPORT_SYMBOL_GPL(kobject_init_and_add);
430
431/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800432 * kobject_rename - change the name of an object
433 * @kobj: object in question.
434 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700435 *
436 * It is the responsibility of the caller to provide mutual
437 * exclusion between two different calls of kobject_rename
438 * on the same kobject and to ensure that new_name is valid and
439 * won't conflict with other kobjects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800441int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
443 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800444 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700445 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800446 char *devpath_string = NULL;
447 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
449 kobj = kobject_get(kobj);
450 if (!kobj)
451 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700452 if (!kobj->parent)
453 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800454
455 devpath = kobject_get_path(kobj, GFP_KERNEL);
456 if (!devpath) {
457 error = -ENOMEM;
458 goto out;
459 }
460 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
461 if (!devpath_string) {
462 error = -ENOMEM;
463 goto out;
464 }
465 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
466 envp[0] = devpath_string;
467 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800468
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700469 name = dup_name = kstrdup(new_name, GFP_KERNEL);
470 if (!name) {
471 error = -ENOMEM;
472 goto out;
473 }
474
Tejun Heoe34ff492013-09-11 22:29:05 -0400475 error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700476 if (error)
477 goto out;
478
479 /* Install the new kobject name */
480 dup_name = kobj->name;
481 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800482
483 /* This function is mostly/only used for network interface.
484 * Some hotplug package track interfaces by their name and
485 * therefore want to know when the name is changed by the user. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700486 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800487
488out:
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700489 kfree(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800490 kfree(devpath_string);
491 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700492 kobject_put(kobj);
493
494 return error;
495}
Alex Chiang8344b562008-06-10 15:30:42 -0600496EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700497
498/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800499 * kobject_move - move object to another parent
500 * @kobj: object in question.
501 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100502 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100503int kobject_move(struct kobject *kobj, struct kobject *new_parent)
504{
505 int error;
506 struct kobject *old_parent;
507 const char *devpath = NULL;
508 char *devpath_string = NULL;
509 char *envp[2];
510
511 kobj = kobject_get(kobj);
512 if (!kobj)
513 return -EINVAL;
514 new_parent = kobject_get(new_parent);
515 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100516 if (kobj->kset)
517 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100518 }
Tejun Heoe34ff492013-09-11 22:29:05 -0400519
Cornelia Huck8a824722006-11-20 17:07:51 +0100520 /* old object path */
521 devpath = kobject_get_path(kobj, GFP_KERNEL);
522 if (!devpath) {
523 error = -ENOMEM;
524 goto out;
525 }
526 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
527 if (!devpath_string) {
528 error = -ENOMEM;
529 goto out;
530 }
531 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
532 envp[0] = devpath_string;
533 envp[1] = NULL;
Tejun Heoe34ff492013-09-11 22:29:05 -0400534 error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
Cornelia Huck8a824722006-11-20 17:07:51 +0100535 if (error)
536 goto out;
537 old_parent = kobj->parent;
538 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300539 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100540 kobject_put(old_parent);
541 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
542out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300543 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100544 kobject_put(kobj);
545 kfree(devpath_string);
546 kfree(devpath);
547 return error;
548}
549
550/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800551 * kobject_del - unlink kobject from hierarchy.
552 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800554void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
Tejun Heo26ea12d2013-09-18 17:15:36 -0400556 struct sysfs_dirent *sd;
557
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800558 if (!kobj)
559 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100560
Tejun Heo26ea12d2013-09-18 17:15:36 -0400561 sd = kobj->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 sysfs_remove_dir(kobj);
Tejun Heo26ea12d2013-09-18 17:15:36 -0400563 sysfs_put(sd);
564
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100565 kobj->state_in_sysfs = 0;
566 kobj_kset_leave(kobj);
567 kobject_put(kobj->parent);
568 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
570
571/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800572 * kobject_get - increment refcount for object.
573 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800575struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576{
577 if (kobj)
578 kref_get(&kobj->kref);
579 return kobj;
580}
581
Anatol Pomozov2d864e42013-05-07 15:37:48 -0700582static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700583{
584 if (!kref_get_unless_zero(&kobj->kref))
585 kobj = NULL;
586 return kobj;
587}
588
Greg Kroah-Hartman18041f472007-12-03 21:31:08 -0800589/*
590 * kobject_cleanup - free kobject resources.
591 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 */
Greg Kroah-Hartman18041f472007-12-03 21:31:08 -0800593static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100595 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f42007-12-20 02:09:39 +0100596 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
Russell Kingc817a672013-06-27 15:06:14 +0100598 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
599 kobject_name(kobj), kobj, __func__, kobj->parent);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100600
601 if (t && !t->release)
602 pr_debug("kobject: '%s' (%p): does not have a release() "
603 "function, it is broken and must be fixed.\n",
604 kobject_name(kobj), kobj);
605
606 /* send "remove" if the caller did not do it but sent "add" */
607 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
608 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
609 kobject_name(kobj), kobj);
610 kobject_uevent(kobj, KOBJ_REMOVE);
611 }
612
613 /* remove from sysfs if the caller did not do it */
614 if (kobj->state_in_sysfs) {
615 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
616 kobject_name(kobj), kobj);
617 kobject_del(kobj);
618 }
619
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700620 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100621 pr_debug("kobject: '%s' (%p): calling ktype release\n",
622 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100624 }
625
626 /* free name if we allocated it */
Kay Sieversaf5ca3f42007-12-20 02:09:39 +0100627 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100628 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700629 kfree(name);
630 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631}
632
Russell Kingc817a672013-06-27 15:06:14 +0100633#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
634static void kobject_delayed_cleanup(struct work_struct *work)
635{
636 kobject_cleanup(container_of(to_delayed_work(work),
637 struct kobject, release));
638}
639#endif
640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641static void kobject_release(struct kref *kref)
642{
Russell Kingc817a672013-06-27 15:06:14 +0100643 struct kobject *kobj = container_of(kref, struct kobject, kref);
644#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
Fengguang Wu1461c5b2013-10-09 09:26:21 +0800645 pr_info("kobject: '%s' (%p): %s, parent %p (delayed)\n",
Russell Kingc817a672013-06-27 15:06:14 +0100646 kobject_name(kobj), kobj, __func__, kobj->parent);
647 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
648 schedule_delayed_work(&kobj->release, HZ);
649#else
650 kobject_cleanup(kobj);
651#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652}
653
654/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800655 * kobject_put - decrement refcount for object.
656 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800658 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800660void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800662 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700663 if (!kobj->state_initialized)
664 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800665 "initialized, yet kobject_put() is being "
666 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800668 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669}
670
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800671static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500672{
Harvey Harrison810304d2008-04-30 00:55:08 -0700673 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500674 kfree(kobj);
675}
676
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800677static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100678 .release = dynamic_kobj_release,
679 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500680};
681
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800682/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800683 * kobject_create - create a struct kobject dynamically
684 *
685 * This function creates a kobject structure dynamically and sets it up
686 * to be a "dynamic" kobject with a default release function set up.
687 *
688 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800689 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700690 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800691 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800692 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800693struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800694{
695 struct kobject *kobj;
696
697 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
698 if (!kobj)
699 return NULL;
700
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700701 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800702 return kobj;
703}
704
705/**
706 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
707 *
Zhi Yong Wu9ff1f832012-05-07 10:48:25 +0800708 * @name: the name for the kobject
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800709 * @parent: the parent kobject of this kobject, if any.
710 *
Dave Youngf70701a2008-01-28 16:58:00 +0800711 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800712 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800713 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800714 * it is no longer being used.
715 *
716 * If the kobject was not able to be created, NULL will be returned.
717 */
718struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
719{
720 struct kobject *kobj;
721 int retval;
722
723 kobj = kobject_create();
724 if (!kobj)
725 return NULL;
726
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700727 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800728 if (retval) {
729 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700730 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800731 kobject_put(kobj);
732 kobj = NULL;
733 }
734 return kobj;
735}
736EXPORT_SYMBOL_GPL(kobject_create_and_add);
737
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500738/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800739 * kset_init - initialize a kset for use
740 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800742void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700744 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 INIT_LIST_HEAD(&k->list);
746 spin_lock_init(&k->list_lock);
747}
748
Kay Sievers23b52122007-11-02 13:47:53 +0100749/* default kobject attribute operations */
750static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
751 char *buf)
752{
753 struct kobj_attribute *kattr;
754 ssize_t ret = -EIO;
755
756 kattr = container_of(attr, struct kobj_attribute, attr);
757 if (kattr->show)
758 ret = kattr->show(kobj, kattr, buf);
759 return ret;
760}
761
762static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
763 const char *buf, size_t count)
764{
765 struct kobj_attribute *kattr;
766 ssize_t ret = -EIO;
767
768 kattr = container_of(attr, struct kobj_attribute, attr);
769 if (kattr->store)
770 ret = kattr->store(kobj, kattr, buf, count);
771 return ret;
772}
773
Emese Revfy52cf25d2010-01-19 02:58:23 +0100774const struct sysfs_ops kobj_sysfs_ops = {
Kay Sievers23b52122007-11-02 13:47:53 +0100775 .show = kobj_attr_show,
776 .store = kobj_attr_store,
777};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778
779/**
Jeff Mahoneyeee03162013-09-11 13:00:30 -0400780 * kobj_completion_init - initialize a kobj_completion object.
781 * @kc: kobj_completion
782 * @ktype: type of kobject to initialize
783 *
784 * kobj_completion structures can be embedded within structures with different
785 * lifetime rules. During the release of the enclosing object, we can
786 * wait on the release of the kobject so that we don't free it while it's
787 * still busy.
788 */
789void kobj_completion_init(struct kobj_completion *kc, struct kobj_type *ktype)
790{
791 init_completion(&kc->kc_unregister);
792 kobject_init(&kc->kc_kobj, ktype);
793}
794EXPORT_SYMBOL_GPL(kobj_completion_init);
795
796/**
797 * kobj_completion_release - release a kobj_completion object
798 * @kobj: kobject embedded in kobj_completion
799 *
800 * Used with kobject_release to notify waiters that the kobject has been
801 * released.
802 */
803void kobj_completion_release(struct kobject *kobj)
804{
805 struct kobj_completion *kc = kobj_to_kobj_completion(kobj);
806 complete(&kc->kc_unregister);
807}
808EXPORT_SYMBOL_GPL(kobj_completion_release);
809
810/**
811 * kobj_completion_del_and_wait - release the kobject and wait for it
812 * @kc: kobj_completion object to release
813 *
814 * Delete the kobject from sysfs and drop the reference count. Then wait
815 * until any other outstanding references are also dropped. This routine
816 * is only necessary once other references may have been taken on the
817 * kobject. Typically this happens when the kobject has been published
818 * to sysfs via kobject_add.
819 */
820void kobj_completion_del_and_wait(struct kobj_completion *kc)
821{
822 kobject_del(&kc->kc_kobj);
823 kobject_put(&kc->kc_kobj);
824 wait_for_completion(&kc->kc_unregister);
825}
826EXPORT_SYMBOL_GPL(kobj_completion_del_and_wait);
827
828/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800829 * kset_register - initialize and add a kset.
830 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800832int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833{
Kay Sievers80f03e32007-05-26 11:21:36 +0200834 int err;
835
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800836 if (!k)
837 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200838
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700840 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200841 if (err)
842 return err;
843 kobject_uevent(&k->kobj, KOBJ_ADD);
844 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845}
846
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800848 * kset_unregister - remove a kset.
849 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800851void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800853 if (!k)
854 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800855 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856}
857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800859 * kset_find_obj - search for object in kset.
860 * @kset: kset we're looking in.
861 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800863 * Lock kset via @kset->subsys, and iterate over @kset->list,
864 * looking for a matching kobject. If matching object is found
865 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800867struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400869 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800870 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
872 spin_lock(&kset->list_lock);
Robin Holtc25d1df2010-09-29 14:00:54 -0500873
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400874 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800875 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700876 ret = kobject_get_unless_zero(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877 break;
878 }
879 }
Robin Holtc25d1df2010-09-29 14:00:54 -0500880
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881 spin_unlock(&kset->list_lock);
882 return ret;
883}
884
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700885static void kset_release(struct kobject *kobj)
886{
887 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800888 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700889 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700890 kfree(kset);
891}
892
Kay Sievers386f2752007-11-02 13:47:53 +0100893static struct kobj_type kset_ktype = {
894 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700895 .release = kset_release,
896};
897
898/**
899 * kset_create - create a struct kset dynamically
900 *
901 * @name: the name for the kset
902 * @uevent_ops: a struct kset_uevent_ops for the kset
903 * @parent_kobj: the parent kobject of this kset, if any.
904 *
905 * This function creates a kset structure dynamically. This structure can
906 * then be registered with the system and show up in sysfs with a call to
907 * kset_register(). When you are finished with this structure, if
908 * kset_register() has been called, call kset_unregister() and the
909 * structure will be dynamically freed when it is no longer being used.
910 *
911 * If the kset was not able to be created, NULL will be returned.
912 */
913static struct kset *kset_create(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100914 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700915 struct kobject *parent_kobj)
916{
917 struct kset *kset;
Dave Youngd9cd8f32009-05-11 14:17:45 +0800918 int retval;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700919
920 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
921 if (!kset)
922 return NULL;
Kees Cookb7165eb2013-06-06 13:52:19 -0700923 retval = kobject_set_name(&kset->kobj, "%s", name);
Dave Youngd9cd8f32009-05-11 14:17:45 +0800924 if (retval) {
925 kfree(kset);
926 return NULL;
927 }
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700928 kset->uevent_ops = uevent_ops;
929 kset->kobj.parent = parent_kobj;
930
931 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100932 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700933 * no kset itself. That way we can properly free it when it is
934 * finished being used.
935 */
Kay Sievers386f2752007-11-02 13:47:53 +0100936 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700937 kset->kobj.kset = NULL;
938
939 return kset;
940}
941
942/**
943 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
944 *
945 * @name: the name for the kset
946 * @uevent_ops: a struct kset_uevent_ops for the kset
947 * @parent_kobj: the parent kobject of this kset, if any.
948 *
949 * This function creates a kset structure dynamically and registers it
950 * with sysfs. When you are finished with this structure, call
951 * kset_unregister() and the structure will be dynamically freed when it
952 * is no longer being used.
953 *
954 * If the kset was not able to be created, NULL will be returned.
955 */
956struct kset *kset_create_and_add(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100957 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700958 struct kobject *parent_kobj)
959{
960 struct kset *kset;
961 int error;
962
963 kset = kset_create(name, uevent_ops, parent_kobj);
964 if (!kset)
965 return NULL;
966 error = kset_register(kset);
967 if (error) {
968 kfree(kset);
969 return NULL;
970 }
971 return kset;
972}
973EXPORT_SYMBOL_GPL(kset_create_and_add);
974
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700975
976static DEFINE_SPINLOCK(kobj_ns_type_lock);
977static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
978
979int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
980{
981 enum kobj_ns_type type = ops->type;
982 int error;
983
984 spin_lock(&kobj_ns_type_lock);
985
986 error = -EINVAL;
987 if (type >= KOBJ_NS_TYPES)
988 goto out;
989
990 error = -EINVAL;
991 if (type <= KOBJ_NS_TYPE_NONE)
992 goto out;
993
994 error = -EBUSY;
995 if (kobj_ns_ops_tbl[type])
996 goto out;
997
998 error = 0;
999 kobj_ns_ops_tbl[type] = ops;
1000
1001out:
1002 spin_unlock(&kobj_ns_type_lock);
1003 return error;
1004}
1005
1006int kobj_ns_type_registered(enum kobj_ns_type type)
1007{
1008 int registered = 0;
1009
1010 spin_lock(&kobj_ns_type_lock);
1011 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
1012 registered = kobj_ns_ops_tbl[type] != NULL;
1013 spin_unlock(&kobj_ns_type_lock);
1014
1015 return registered;
1016}
1017
1018const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
1019{
1020 const struct kobj_ns_type_operations *ops = NULL;
1021
1022 if (parent && parent->ktype->child_ns_type)
1023 ops = parent->ktype->child_ns_type(parent);
1024
1025 return ops;
1026}
1027
1028const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
1029{
1030 return kobj_child_ns_ops(kobj->parent);
1031}
1032
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001033bool kobj_ns_current_may_mount(enum kobj_ns_type type)
1034{
Eric W. Biederman730d7d32013-09-23 14:41:17 -07001035 bool may_mount = true;
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -07001036
1037 spin_lock(&kobj_ns_type_lock);
1038 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1039 kobj_ns_ops_tbl[type])
1040 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
1041 spin_unlock(&kobj_ns_type_lock);
1042
1043 return may_mount;
1044}
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001045
Al Viroa685e082011-06-08 21:13:01 -04001046void *kobj_ns_grab_current(enum kobj_ns_type type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001047{
Al Viroa685e082011-06-08 21:13:01 -04001048 void *ns = NULL;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001049
1050 spin_lock(&kobj_ns_type_lock);
1051 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1052 kobj_ns_ops_tbl[type])
Al Viroa685e082011-06-08 21:13:01 -04001053 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001054 spin_unlock(&kobj_ns_type_lock);
1055
1056 return ns;
1057}
1058
1059const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1060{
1061 const void *ns = NULL;
1062
1063 spin_lock(&kobj_ns_type_lock);
1064 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1065 kobj_ns_ops_tbl[type])
1066 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1067 spin_unlock(&kobj_ns_type_lock);
1068
1069 return ns;
1070}
1071
1072const void *kobj_ns_initial(enum kobj_ns_type type)
1073{
1074 const void *ns = NULL;
1075
1076 spin_lock(&kobj_ns_type_lock);
1077 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1078 kobj_ns_ops_tbl[type])
1079 ns = kobj_ns_ops_tbl[type]->initial_ns();
1080 spin_unlock(&kobj_ns_type_lock);
1081
1082 return ns;
1083}
1084
Al Viroa685e082011-06-08 21:13:01 -04001085void kobj_ns_drop(enum kobj_ns_type type, void *ns)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001086{
Al Viroa685e082011-06-08 21:13:01 -04001087 spin_lock(&kobj_ns_type_lock);
1088 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1089 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1090 kobj_ns_ops_tbl[type]->drop_ns(ns);
1091 spin_unlock(&kobj_ns_type_lock);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001092}
1093
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094EXPORT_SYMBOL(kobject_get);
1095EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096EXPORT_SYMBOL(kobject_del);
1097
1098EXPORT_SYMBOL(kset_register);
1099EXPORT_SYMBOL(kset_unregister);