blob: 58751bb80a7cbbe905c7d4e752df641ae2240b51 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * kobject.c - library routines for handling generic kernel objects
3 *
4 * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org>
Greg Kroah-Hartmanf0e7e1b2007-09-27 14:48:53 -07005 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (c) 2006-2007 Novell Inc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 *
8 * This file is released under the GPLv2.
9 *
10 *
11 * Please see the file Documentation/kobject.txt for critical information
12 * about using the kobject interface.
13 */
14
15#include <linux/kobject.h>
16#include <linux/string.h>
Paul Gortmaker8bc3bcc2011-11-16 21:29:17 -050017#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/stat.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080019#include <linux/slab.h>
Bjorn Helgaas89c86a62013-12-05 17:37:51 -070020#include <linux/random.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Tejun Heoe34ff492013-09-11 22:29:05 -040022/**
23 * kobject_namespace - return @kobj's namespace tag
24 * @kobj: kobject in question
25 *
26 * Returns namespace tag of @kobj if its parent has namespace ops enabled
27 * and thus @kobj should have a namespace tag associated with it. Returns
28 * %NULL otherwise.
29 */
30const void *kobject_namespace(struct kobject *kobj)
31{
32 const struct kobj_ns_type_operations *ns_ops = kobj_ns_ops(kobj);
33
34 if (!ns_ops || ns_ops->type == KOBJ_NS_TYPE_NONE)
35 return NULL;
36
Linus Torvaldsa1212d22013-11-07 20:47:28 +090037 return kobj->ktype->namespace(kobj);
Tejun Heoe34ff492013-09-11 22:29:05 -040038}
39
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080040/*
41 * populate_dir - populate directory with attributes.
42 * @kobj: object we're working on.
Linus Torvalds1da177e2005-04-16 15:20:36 -070043 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080044 * Most subsystems have a set of default attributes that are associated
45 * with an object that registers with them. This is a helper called during
46 * object registration that loops through the default attributes of the
47 * subsystem and creates attributes files for them in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080049static int populate_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080051 struct kobj_type *t = get_ktype(kobj);
52 struct attribute *attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 int error = 0;
54 int i;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 if (t && t->default_attrs) {
57 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080058 error = sysfs_create_file(kobj, attr);
59 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060 break;
61 }
62 }
63 return error;
64}
65
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080066static int create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067{
Tejun Heoc84a3b22013-11-23 18:01:46 -050068 const struct kobj_ns_type_operations *ops;
Tejun Heoe34ff492013-09-11 22:29:05 -040069 int error;
70
71 error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
Tejun Heoc84a3b22013-11-23 18:01:46 -050072 if (error)
73 return error;
74
75 error = populate_dir(kobj);
76 if (error) {
77 sysfs_remove_dir(kobj);
78 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 }
Tejun Heo26ea12d2013-09-18 17:15:36 -040080
81 /*
82 * @kobj->sd may be deleted by an ancestor going away. Hold an
83 * extra reference so that it stays until @kobj is gone.
84 */
85 sysfs_get(kobj->sd);
86
Tejun Heoc84a3b22013-11-23 18:01:46 -050087 /*
88 * If @kobj has ns_ops, its children need to be filtered based on
89 * their namespace tags. Enable namespace support on @kobj->sd.
90 */
91 ops = kobj_child_ns_ops(kobj);
92 if (ops) {
93 BUG_ON(ops->type <= KOBJ_NS_TYPE_NONE);
94 BUG_ON(ops->type >= KOBJ_NS_TYPES);
95 BUG_ON(!kobj_ns_type_registered(ops->type));
96
Tejun Heofa4cd452014-02-07 13:32:07 -050097 sysfs_enable_ns(kobj->sd);
Tejun Heoc84a3b22013-11-23 18:01:46 -050098 }
99
100 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101}
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103static int get_kobj_path_length(struct kobject *kobj)
104{
105 int length = 1;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800106 struct kobject *parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800108 /* walk up the ancestors until we hit the one pointing to the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * root.
110 * Add 1 to strlen for leading '/' of each level.
111 */
112 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500113 if (kobject_name(parent) == NULL)
114 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 length += strlen(kobject_name(parent)) + 1;
116 parent = parent->parent;
117 } while (parent);
118 return length;
119}
120
121static void fill_kobj_path(struct kobject *kobj, char *path, int length)
122{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800123 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124
125 --length;
126 for (parent = kobj; parent; parent = parent->parent) {
127 int cur = strlen(kobject_name(parent));
128 /* back up enough to print this name with '/' */
129 length -= cur;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800130 strncpy(path + length, kobject_name(parent), cur);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 *(path + --length) = '/';
132 }
133
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800134 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
Harvey Harrison810304d2008-04-30 00:55:08 -0700135 kobj, __func__, path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136}
137
138/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800139 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 *
141 * @kobj: kobject in question, with which to build the path
142 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800143 *
144 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 */
Al Virofd4f2df2005-10-21 03:18:50 -0400146char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
148 char *path;
149 int len;
150
151 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500152 if (len == 0)
153 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800154 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 if (!path)
156 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 fill_kobj_path(kobj, path, len);
158
159 return path;
160}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400161EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100163/* add the kobject to its kset's list */
164static void kobj_kset_join(struct kobject *kobj)
165{
166 if (!kobj->kset)
167 return;
168
169 kset_get(kobj->kset);
170 spin_lock(&kobj->kset->list_lock);
171 list_add_tail(&kobj->entry, &kobj->kset->list);
172 spin_unlock(&kobj->kset->list_lock);
173}
174
175/* remove the kobject from its kset's list */
176static void kobj_kset_leave(struct kobject *kobj)
177{
178 if (!kobj->kset)
179 return;
180
181 spin_lock(&kobj->kset->list_lock);
182 list_del_init(&kobj->entry);
183 spin_unlock(&kobj->kset->list_lock);
184 kset_put(kobj->kset);
185}
186
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800187static void kobject_init_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800189 if (!kobj)
190 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 kref_init(&kobj->kref);
192 INIT_LIST_HEAD(&kobj->entry);
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800193 kobj->state_in_sysfs = 0;
194 kobj->state_add_uevent_sent = 0;
195 kobj->state_remove_uevent_sent = 0;
196 kobj->state_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197}
198
199
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700200static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
202 int error = 0;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800203 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100205 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100207
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100208 if (!kobj->name || !kobj->name[0]) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700209 WARN(1, "kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800210 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800211 return -EINVAL;
212 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100213
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 parent = kobject_get(kobj->parent);
215
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100216 /* join kset if set, use it as parent if we do not already have one */
217 if (kobj->kset) {
218 if (!parent)
219 parent = kobject_get(&kobj->kset->kobj);
220 kobj_kset_join(kobj);
221 kobj->parent = parent;
222 }
223
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800224 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700225 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800226 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800227 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900229 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100231 kobj_kset_leave(kobj);
232 kobject_put(parent);
233 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800234
235 /* be noisy on error issues */
236 if (error == -EEXIST)
Dan Williams282029c2012-04-06 13:41:15 -0700237 WARN(1, "%s failed for %s with "
238 "-EEXIST, don't try to register things with "
239 "the same name in the same directory.\n",
240 __func__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800241 else
Dan Williams282029c2012-04-06 13:41:15 -0700242 WARN(1, "%s failed for %s (error: %d parent: %s)\n",
243 __func__, kobject_name(kobj), error,
244 parent ? kobject_name(parent) : "'none'");
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100245 } else
246 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 return error;
249}
250
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700251/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500252 * kobject_set_name_vargs - Set the name of an kobject
253 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800254 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500255 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 */
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100257int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500258 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Kay Sievers9f255652008-05-06 22:24:04 +0200260 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);
Maurizio Lombardi020d30f2013-11-08 15:28:25 +0100267 if (!kobj->name) {
268 kobj->name = old_name;
Kay Sieversa4ca6612008-04-30 02:06:29 +0200269 return -ENOMEM;
Maurizio Lombardi020d30f2013-11-08 15:28:25 +0100270 }
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500271
Kay Sievers9f255652008-05-06 22:24:04 +0200272 /* ewww... some of these buggers have '/' in the name ... */
Ingo Oeser25fdeb32008-07-23 01:25:01 +0200273 while ((s = strchr(kobj->name, '/')))
Kay Sievers9f255652008-05-06 22:24:04 +0200274 s[0] = '!';
275
276 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500277 return 0;
278}
279
280/**
281 * kobject_set_name - Set the name of a kobject
282 * @kobj: struct kobject to set the name of
283 * @fmt: format string used to build the name
284 *
285 * This sets the name of the kobject. If you have already added the
286 * kobject to the system, you must call kobject_rename() in order to
287 * change the name of the kobject.
288 */
289int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
290{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200291 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500292 int retval;
293
Kay Sieversa4ca6612008-04-30 02:06:29 +0200294 va_start(vargs, fmt);
295 retval = kobject_set_name_vargs(kobj, fmt, vargs);
296 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500297
298 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300EXPORT_SYMBOL(kobject_set_name);
301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700303 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800304 * @kobj: pointer to the kobject to initialize
305 * @ktype: pointer to the ktype for this kobject.
306 *
307 * This function will properly initialize a kobject such that it can then
308 * be passed to the kobject_add() call.
309 *
310 * After this function is called, the kobject MUST be cleaned up by a call
311 * to kobject_put(), not by a call to kfree directly to ensure that all of
312 * the memory is cleaned up properly.
313 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700314void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800315{
316 char *err_str;
317
318 if (!kobj) {
319 err_str = "invalid kobject pointer!";
320 goto error;
321 }
322 if (!ktype) {
323 err_str = "must have a ktype to be initialized properly!\n";
324 goto error;
325 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100326 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800327 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100328 printk(KERN_ERR "kobject (%p): tried to init an initialized "
329 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800330 dump_stack();
331 }
332
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800333 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800334 kobj->ktype = ktype;
335 return;
336
337error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100338 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800339 dump_stack();
340}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700341EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800342
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800343static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
344 const char *fmt, va_list vargs)
345{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800346 int retval;
347
Kay Sieversa4ca6612008-04-30 02:06:29 +0200348 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800349 if (retval) {
350 printk(KERN_ERR "kobject: can not set name properly!\n");
351 return retval;
352 }
353 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700354 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800355}
356
357/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700358 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800359 * @kobj: the kobject to add
360 * @parent: pointer to the parent of the kobject.
361 * @fmt: format to name the kobject with.
362 *
363 * The kobject name is set and added to the kobject hierarchy in this
364 * function.
365 *
366 * If @parent is set, then the parent of the @kobj will be set to it.
367 * If @parent is NULL, then the parent of the @kobj will be set to the
Bart Van Assche97057102014-01-04 14:20:04 +0100368 * kobject associated with the kset assigned to this kobject. If no kset
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800369 * is assigned to the kobject, then the kobject will be located in the
370 * root of the sysfs tree.
371 *
372 * If this function returns an error, kobject_put() must be called to
373 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800374 * Under no instance should the kobject that is passed to this function
375 * be directly freed with a call to kfree(), that can leak memory.
376 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100377 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800378 * up all of the necessary sysfs files for the object and then call
379 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
380 * userspace is properly notified of this kobject's creation.
381 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700382int kobject_add(struct kobject *kobj, struct kobject *parent,
383 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800384{
385 va_list args;
386 int retval;
387
388 if (!kobj)
389 return -EINVAL;
390
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100391 if (!kobj->state_initialized) {
392 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
393 "uninitialized object, something is seriously wrong.\n",
394 kobject_name(kobj), kobj);
395 dump_stack();
396 return -EINVAL;
397 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800398 va_start(args, fmt);
399 retval = kobject_add_varg(kobj, parent, fmt, args);
400 va_end(args);
401
402 return retval;
403}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700404EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800405
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800406/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800407 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
408 * @kobj: pointer to the kobject to initialize
409 * @ktype: pointer to the ktype for this kobject.
410 * @parent: pointer to the parent of this kobject.
411 * @fmt: the name of the kobject.
412 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700413 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700414 * kobject_add(). The same type of error handling after a call to
415 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800416 */
417int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
418 struct kobject *parent, const char *fmt, ...)
419{
420 va_list args;
421 int retval;
422
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700423 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800424
425 va_start(args, fmt);
426 retval = kobject_add_varg(kobj, parent, fmt, args);
427 va_end(args);
428
429 return retval;
430}
431EXPORT_SYMBOL_GPL(kobject_init_and_add);
432
433/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800434 * kobject_rename - change the name of an object
435 * @kobj: object in question.
436 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700437 *
438 * It is the responsibility of the caller to provide mutual
439 * exclusion between two different calls of kobject_rename
440 * on the same kobject and to ensure that new_name is valid and
441 * won't conflict with other kobjects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800443int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
445 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800446 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700447 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800448 char *devpath_string = NULL;
449 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
451 kobj = kobject_get(kobj);
452 if (!kobj)
453 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700454 if (!kobj->parent)
455 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800456
457 devpath = kobject_get_path(kobj, GFP_KERNEL);
458 if (!devpath) {
459 error = -ENOMEM;
460 goto out;
461 }
462 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
463 if (!devpath_string) {
464 error = -ENOMEM;
465 goto out;
466 }
467 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
468 envp[0] = devpath_string;
469 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800470
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700471 name = dup_name = kstrdup(new_name, GFP_KERNEL);
472 if (!name) {
473 error = -ENOMEM;
474 goto out;
475 }
476
Tejun Heoe34ff492013-09-11 22:29:05 -0400477 error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700478 if (error)
479 goto out;
480
481 /* Install the new kobject name */
482 dup_name = kobj->name;
483 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800484
485 /* This function is mostly/only used for network interface.
486 * Some hotplug package track interfaces by their name and
487 * therefore want to know when the name is changed by the user. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700488 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800489
490out:
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700491 kfree(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800492 kfree(devpath_string);
493 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700494 kobject_put(kobj);
495
496 return error;
497}
Alex Chiang8344b562008-06-10 15:30:42 -0600498EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700499
500/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800501 * kobject_move - move object to another parent
502 * @kobj: object in question.
503 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100504 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100505int kobject_move(struct kobject *kobj, struct kobject *new_parent)
506{
507 int error;
508 struct kobject *old_parent;
509 const char *devpath = NULL;
510 char *devpath_string = NULL;
511 char *envp[2];
512
513 kobj = kobject_get(kobj);
514 if (!kobj)
515 return -EINVAL;
516 new_parent = kobject_get(new_parent);
517 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100518 if (kobj->kset)
519 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100520 }
Tejun Heoe34ff492013-09-11 22:29:05 -0400521
Cornelia Huck8a824722006-11-20 17:07:51 +0100522 /* old object path */
523 devpath = kobject_get_path(kobj, GFP_KERNEL);
524 if (!devpath) {
525 error = -ENOMEM;
526 goto out;
527 }
528 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
529 if (!devpath_string) {
530 error = -ENOMEM;
531 goto out;
532 }
533 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
534 envp[0] = devpath_string;
535 envp[1] = NULL;
Tejun Heoe34ff492013-09-11 22:29:05 -0400536 error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
Cornelia Huck8a824722006-11-20 17:07:51 +0100537 if (error)
538 goto out;
539 old_parent = kobj->parent;
540 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300541 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100542 kobject_put(old_parent);
543 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
544out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300545 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100546 kobject_put(kobj);
547 kfree(devpath_string);
548 kfree(devpath);
549 return error;
550}
551
552/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800553 * kobject_del - unlink kobject from hierarchy.
554 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800556void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557{
Tejun Heo324a56e2013-12-11 14:11:53 -0500558 struct kernfs_node *sd;
Tejun Heo26ea12d2013-09-18 17:15:36 -0400559
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800560 if (!kobj)
561 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100562
Tejun Heo26ea12d2013-09-18 17:15:36 -0400563 sd = kobj->sd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 sysfs_remove_dir(kobj);
Tejun Heo26ea12d2013-09-18 17:15:36 -0400565 sysfs_put(sd);
566
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100567 kobj->state_in_sysfs = 0;
568 kobj_kset_leave(kobj);
569 kobject_put(kobj->parent);
570 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
572
573/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800574 * kobject_get - increment refcount for object.
575 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800577struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
579 if (kobj)
580 kref_get(&kobj->kref);
581 return kobj;
582}
583
Anatol Pomozov2d864e42013-05-07 15:37:48 -0700584static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700585{
586 if (!kref_get_unless_zero(&kobj->kref))
587 kobj = NULL;
588 return kobj;
589}
590
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800591/*
592 * kobject_cleanup - free kobject resources.
593 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800595static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100597 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100598 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599
Russell Kingc817a672013-06-27 15:06:14 +0100600 pr_debug("kobject: '%s' (%p): %s, parent %p\n",
601 kobject_name(kobj), kobj, __func__, kobj->parent);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100602
603 if (t && !t->release)
604 pr_debug("kobject: '%s' (%p): does not have a release() "
605 "function, it is broken and must be fixed.\n",
606 kobject_name(kobj), kobj);
607
608 /* send "remove" if the caller did not do it but sent "add" */
609 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
610 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
611 kobject_name(kobj), kobj);
612 kobject_uevent(kobj, KOBJ_REMOVE);
613 }
614
615 /* remove from sysfs if the caller did not do it */
616 if (kobj->state_in_sysfs) {
617 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
618 kobject_name(kobj), kobj);
619 kobject_del(kobj);
620 }
621
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700622 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100623 pr_debug("kobject: '%s' (%p): calling ktype release\n",
624 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100626 }
627
628 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100629 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100630 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700631 kfree(name);
632 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
634
Russell Kingc817a672013-06-27 15:06:14 +0100635#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
636static void kobject_delayed_cleanup(struct work_struct *work)
637{
638 kobject_cleanup(container_of(to_delayed_work(work),
639 struct kobject, release));
640}
641#endif
642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643static void kobject_release(struct kref *kref)
644{
Russell Kingc817a672013-06-27 15:06:14 +0100645 struct kobject *kobj = container_of(kref, struct kobject, kref);
646#ifdef CONFIG_DEBUG_KOBJECT_RELEASE
Bjorn Helgaas89c86a62013-12-05 17:37:51 -0700647 unsigned long delay = HZ + HZ * (get_random_int() & 0x3);
648 pr_info("kobject: '%s' (%p): %s, parent %p (delayed %ld)\n",
649 kobject_name(kobj), kobj, __func__, kobj->parent, delay);
Russell Kingc817a672013-06-27 15:06:14 +0100650 INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
Bjorn Helgaas89c86a62013-12-05 17:37:51 -0700651
652 schedule_delayed_work(&kobj->release, delay);
Russell Kingc817a672013-06-27 15:06:14 +0100653#else
654 kobject_cleanup(kobj);
655#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656}
657
658/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800659 * kobject_put - decrement refcount for object.
660 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800662 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800664void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800666 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700667 if (!kobj->state_initialized)
668 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800669 "initialized, yet kobject_put() is being "
670 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800672 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673}
674
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800675static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500676{
Harvey Harrison810304d2008-04-30 00:55:08 -0700677 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500678 kfree(kobj);
679}
680
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800681static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100682 .release = dynamic_kobj_release,
683 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500684};
685
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800686/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800687 * kobject_create - create a struct kobject dynamically
688 *
689 * This function creates a kobject structure dynamically and sets it up
690 * to be a "dynamic" kobject with a default release function set up.
691 *
692 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800693 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700694 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800695 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800696 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800697struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800698{
699 struct kobject *kobj;
700
701 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
702 if (!kobj)
703 return NULL;
704
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700705 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800706 return kobj;
707}
708
709/**
710 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
711 *
Zhi Yong Wu9ff1f832012-05-07 10:48:25 +0800712 * @name: the name for the kobject
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800713 * @parent: the parent kobject of this kobject, if any.
714 *
Dave Youngf70701a2008-01-28 16:58:00 +0800715 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800716 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800717 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800718 * it is no longer being used.
719 *
720 * If the kobject was not able to be created, NULL will be returned.
721 */
722struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
723{
724 struct kobject *kobj;
725 int retval;
726
727 kobj = kobject_create();
728 if (!kobj)
729 return NULL;
730
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700731 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800732 if (retval) {
733 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700734 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800735 kobject_put(kobj);
736 kobj = NULL;
737 }
738 return kobj;
739}
740EXPORT_SYMBOL_GPL(kobject_create_and_add);
741
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500742/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800743 * kset_init - initialize a kset for use
744 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800746void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700748 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 INIT_LIST_HEAD(&k->list);
750 spin_lock_init(&k->list_lock);
751}
752
Kay Sievers23b52122007-11-02 13:47:53 +0100753/* default kobject attribute operations */
754static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
755 char *buf)
756{
757 struct kobj_attribute *kattr;
758 ssize_t ret = -EIO;
759
760 kattr = container_of(attr, struct kobj_attribute, attr);
761 if (kattr->show)
762 ret = kattr->show(kobj, kattr, buf);
763 return ret;
764}
765
766static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
767 const char *buf, size_t count)
768{
769 struct kobj_attribute *kattr;
770 ssize_t ret = -EIO;
771
772 kattr = container_of(attr, struct kobj_attribute, attr);
773 if (kattr->store)
774 ret = kattr->store(kobj, kattr, buf, count);
775 return ret;
776}
777
Emese Revfy52cf25d2010-01-19 02:58:23 +0100778const struct sysfs_ops kobj_sysfs_ops = {
Kay Sievers23b52122007-11-02 13:47:53 +0100779 .show = kobj_attr_show,
780 .store = kobj_attr_store,
781};
Jeff Mahoney29dfe2d2013-11-01 13:06:56 -0400782EXPORT_SYMBOL_GPL(kobj_sysfs_ops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783
784/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800785 * kset_register - initialize and add a kset.
786 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800788int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789{
Kay Sievers80f03e32007-05-26 11:21:36 +0200790 int err;
791
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800792 if (!k)
793 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200794
Linus Torvalds1da177e2005-04-16 15:20:36 -0700795 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700796 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200797 if (err)
798 return err;
799 kobject_uevent(&k->kobj, KOBJ_ADD);
800 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801}
802
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800804 * kset_unregister - remove a kset.
805 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800807void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800809 if (!k)
810 return;
Bjorn Helgaas35a5fe62013-12-05 17:38:00 -0700811 kobject_del(&k->kobj);
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800812 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813}
814
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800816 * kset_find_obj - search for object in kset.
817 * @kset: kset we're looking in.
818 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800820 * Lock kset via @kset->subsys, and iterate over @kset->list,
821 * looking for a matching kobject. If matching object is found
822 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800824struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400826 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800827 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828
829 spin_lock(&kset->list_lock);
Robin Holtc25d1df2010-09-29 14:00:54 -0500830
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400831 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800832 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvaldsa49b7e82013-04-13 15:15:30 -0700833 ret = kobject_get_unless_zero(k);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 break;
835 }
836 }
Robin Holtc25d1df2010-09-29 14:00:54 -0500837
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 spin_unlock(&kset->list_lock);
839 return ret;
840}
841
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700842static void kset_release(struct kobject *kobj)
843{
844 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800845 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700846 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700847 kfree(kset);
848}
849
Kay Sievers386f2752007-11-02 13:47:53 +0100850static struct kobj_type kset_ktype = {
851 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700852 .release = kset_release,
853};
854
855/**
856 * kset_create - create a struct kset dynamically
857 *
858 * @name: the name for the kset
859 * @uevent_ops: a struct kset_uevent_ops for the kset
860 * @parent_kobj: the parent kobject of this kset, if any.
861 *
862 * This function creates a kset structure dynamically. This structure can
863 * then be registered with the system and show up in sysfs with a call to
864 * kset_register(). When you are finished with this structure, if
865 * kset_register() has been called, call kset_unregister() and the
866 * structure will be dynamically freed when it is no longer being used.
867 *
868 * If the kset was not able to be created, NULL will be returned.
869 */
870static struct kset *kset_create(const char *name,
Emese Revfy9cd43612009-12-31 14:52:51 +0100871 const struct kset_uevent_ops *uevent_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700872 struct kobject *parent_kobj)
873{
874 struct kset *kset;
Dave Youngd9cd8f32009-05-11 14:17:45 +0800875 int retval;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700876
877 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
878 if (!kset)
879 return NULL;
Kees Cookb7165eb2013-06-06 13:52:19 -0700880 retval = kobject_set_name(&kset->kobj, "%s", name);
Dave Youngd9cd8f32009-05-11 14:17:45 +0800881 if (retval) {
882 kfree(kset);
883 return NULL;
884 }
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700885 kset->uevent_ops = uevent_ops;
886 kset->kobj.parent = parent_kobj;
887
888 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100889 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700890 * no kset itself. That way we can properly free it when it is
891 * finished being used.
892 */
Kay Sievers386f2752007-11-02 13:47:53 +0100893 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700894 kset->kobj.kset = NULL;
895
896 return kset;
897}
898
899/**
900 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
901 *
902 * @name: the name for the kset
903 * @uevent_ops: a struct kset_uevent_ops for the kset
904 * @parent_kobj: the parent kobject of this kset, if any.
905 *
906 * This function creates a kset structure dynamically and registers it
907 * with sysfs. When you are finished with this structure, call
908 * kset_unregister() and the structure will be dynamically freed when it
909 * is no longer being used.
910 *
911 * If the kset was not able to be created, NULL will be returned.
912 */
913struct kset *kset_create_and_add(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;
918 int error;
919
920 kset = kset_create(name, uevent_ops, parent_kobj);
921 if (!kset)
922 return NULL;
923 error = kset_register(kset);
924 if (error) {
925 kfree(kset);
926 return NULL;
927 }
928 return kset;
929}
930EXPORT_SYMBOL_GPL(kset_create_and_add);
931
Eric W. Biedermanbc451f22010-03-30 11:31:25 -0700932
933static DEFINE_SPINLOCK(kobj_ns_type_lock);
934static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
935
936int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
937{
938 enum kobj_ns_type type = ops->type;
939 int error;
940
941 spin_lock(&kobj_ns_type_lock);
942
943 error = -EINVAL;
944 if (type >= KOBJ_NS_TYPES)
945 goto out;
946
947 error = -EINVAL;
948 if (type <= KOBJ_NS_TYPE_NONE)
949 goto out;
950
951 error = -EBUSY;
952 if (kobj_ns_ops_tbl[type])
953 goto out;
954
955 error = 0;
956 kobj_ns_ops_tbl[type] = ops;
957
958out:
959 spin_unlock(&kobj_ns_type_lock);
960 return error;
961}
962
963int kobj_ns_type_registered(enum kobj_ns_type type)
964{
965 int registered = 0;
966
967 spin_lock(&kobj_ns_type_lock);
968 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
969 registered = kobj_ns_ops_tbl[type] != NULL;
970 spin_unlock(&kobj_ns_type_lock);
971
972 return registered;
973}
974
975const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
976{
977 const struct kobj_ns_type_operations *ops = NULL;
978
979 if (parent && parent->ktype->child_ns_type)
980 ops = parent->ktype->child_ns_type(parent);
981
982 return ops;
983}
984
985const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
986{
987 return kobj_child_ns_ops(kobj->parent);
988}
989
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -0700990bool kobj_ns_current_may_mount(enum kobj_ns_type type)
991{
Eric W. Biederman730d7d32013-09-23 14:41:17 -0700992 bool may_mount = true;
Eric W. Biederman7dc5dbc2013-03-25 20:07:01 -0700993
994 spin_lock(&kobj_ns_type_lock);
995 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
996 kobj_ns_ops_tbl[type])
997 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
998 spin_unlock(&kobj_ns_type_lock);
999
1000 return may_mount;
1001}
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001002
Al Viroa685e082011-06-08 21:13:01 -04001003void *kobj_ns_grab_current(enum kobj_ns_type type)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001004{
Al Viroa685e082011-06-08 21:13:01 -04001005 void *ns = NULL;
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001006
1007 spin_lock(&kobj_ns_type_lock);
1008 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1009 kobj_ns_ops_tbl[type])
Al Viroa685e082011-06-08 21:13:01 -04001010 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001011 spin_unlock(&kobj_ns_type_lock);
1012
1013 return ns;
1014}
1015
1016const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1017{
1018 const void *ns = NULL;
1019
1020 spin_lock(&kobj_ns_type_lock);
1021 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1022 kobj_ns_ops_tbl[type])
1023 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1024 spin_unlock(&kobj_ns_type_lock);
1025
1026 return ns;
1027}
1028
1029const void *kobj_ns_initial(enum kobj_ns_type type)
1030{
1031 const void *ns = NULL;
1032
1033 spin_lock(&kobj_ns_type_lock);
1034 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1035 kobj_ns_ops_tbl[type])
1036 ns = kobj_ns_ops_tbl[type]->initial_ns();
1037 spin_unlock(&kobj_ns_type_lock);
1038
1039 return ns;
1040}
1041
Al Viroa685e082011-06-08 21:13:01 -04001042void kobj_ns_drop(enum kobj_ns_type type, void *ns)
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001043{
Al Viroa685e082011-06-08 21:13:01 -04001044 spin_lock(&kobj_ns_type_lock);
1045 if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1046 kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1047 kobj_ns_ops_tbl[type]->drop_ns(ns);
1048 spin_unlock(&kobj_ns_type_lock);
Eric W. Biedermanbc451f22010-03-30 11:31:25 -07001049}
1050
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051EXPORT_SYMBOL(kobject_get);
1052EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053EXPORT_SYMBOL(kobject_del);
1054
1055EXPORT_SYMBOL(kset_register);
1056EXPORT_SYMBOL(kset_unregister);