blob: bacf6fe4f7a0347bb958ebc85a059ab582eb93b4 [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>
17#include <linux/module.h>
18#include <linux/stat.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080019#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080021/*
22 * populate_dir - populate directory with attributes.
23 * @kobj: object we're working on.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080025 * Most subsystems have a set of default attributes that are associated
26 * with an object that registers with them. This is a helper called during
27 * object registration that loops through the default attributes of the
28 * subsystem and creates attributes files for them in sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080030static int populate_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070031{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080032 struct kobj_type *t = get_ktype(kobj);
33 struct attribute *attr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 int error = 0;
35 int i;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080036
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 if (t && t->default_attrs) {
38 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080039 error = sysfs_create_file(kobj, attr);
40 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 break;
42 }
43 }
44 return error;
45}
46
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080047static int create_dir(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048{
49 int error = 0;
50 if (kobject_name(kobj)) {
Eric W. Biederman90bc6132007-07-31 19:15:08 +090051 error = sysfs_create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 if (!error) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080053 error = populate_dir(kobj);
54 if (error)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 sysfs_remove_dir(kobj);
56 }
57 }
58 return error;
59}
60
Linus Torvalds1da177e2005-04-16 15:20:36 -070061static int get_kobj_path_length(struct kobject *kobj)
62{
63 int length = 1;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080064 struct kobject *parent = kobj;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080066 /* walk up the ancestors until we hit the one pointing to the
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * root.
68 * Add 1 to strlen for leading '/' of each level.
69 */
70 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -050071 if (kobject_name(parent) == NULL)
72 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 length += strlen(kobject_name(parent)) + 1;
74 parent = parent->parent;
75 } while (parent);
76 return length;
77}
78
79static void fill_kobj_path(struct kobject *kobj, char *path, int length)
80{
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080081 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
83 --length;
84 for (parent = kobj; parent; parent = parent->parent) {
85 int cur = strlen(kobject_name(parent));
86 /* back up enough to print this name with '/' */
87 length -= cur;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080088 strncpy(path + length, kobject_name(parent), cur);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 *(path + --length) = '/';
90 }
91
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -080092 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
Harvey Harrison810304d2008-04-30 00:55:08 -070093 kobj, __func__, path);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094}
95
96/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -080097 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 *
99 * @kobj: kobject in question, with which to build the path
100 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800101 *
102 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 */
Al Virofd4f2df2005-10-21 03:18:50 -0400104char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 char *path;
107 int len;
108
109 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500110 if (len == 0)
111 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800112 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 if (!path)
114 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 fill_kobj_path(kobj, path, len);
116
117 return path;
118}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400119EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100121/* add the kobject to its kset's list */
122static void kobj_kset_join(struct kobject *kobj)
123{
124 if (!kobj->kset)
125 return;
126
127 kset_get(kobj->kset);
128 spin_lock(&kobj->kset->list_lock);
129 list_add_tail(&kobj->entry, &kobj->kset->list);
130 spin_unlock(&kobj->kset->list_lock);
131}
132
133/* remove the kobject from its kset's list */
134static void kobj_kset_leave(struct kobject *kobj)
135{
136 if (!kobj->kset)
137 return;
138
139 spin_lock(&kobj->kset->list_lock);
140 list_del_init(&kobj->entry);
141 spin_unlock(&kobj->kset->list_lock);
142 kset_put(kobj->kset);
143}
144
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800145static void kobject_init_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800147 if (!kobj)
148 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 kref_init(&kobj->kref);
150 INIT_LIST_HEAD(&kobj->entry);
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800151 kobj->state_in_sysfs = 0;
152 kobj->state_add_uevent_sent = 0;
153 kobj->state_remove_uevent_sent = 0;
154 kobj->state_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155}
156
157
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700158static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
160 int error = 0;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800161 struct kobject *parent;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100163 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100165
Kay Sieversaf5ca3f42007-12-20 02:09:39 +0100166 if (!kobj->name || !kobj->name[0]) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700167 WARN(1, "kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800168 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800169 return -EINVAL;
170 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100171
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 parent = kobject_get(kobj->parent);
173
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100174 /* join kset if set, use it as parent if we do not already have one */
175 if (kobj->kset) {
176 if (!parent)
177 parent = kobject_get(&kobj->kset->kobj);
178 kobj_kset_join(kobj);
179 kobj->parent = parent;
180 }
181
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800182 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700183 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800184 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800185 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900187 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100189 kobj_kset_leave(kobj);
190 kobject_put(parent);
191 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800192
193 /* be noisy on error issues */
194 if (error == -EEXIST)
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700195 printk(KERN_ERR "%s failed for %s with "
Greg Kroah-Hartman5c73a3f2007-06-07 15:05:15 -0700196 "-EEXIST, don't try to register things with "
197 "the same name in the same directory.\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700198 __func__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800199 else
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700200 printk(KERN_ERR "%s failed for %s (%d)\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700201 __func__, kobject_name(kobj), error);
Greg Kroah-Hartman5c73a3f2007-06-07 15:05:15 -0700202 dump_stack();
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100203 } else
204 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
206 return error;
207}
208
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700209/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500210 * kobject_set_name_vargs - Set the name of an kobject
211 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800212 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500213 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 */
Kay Sievers1fa5ae82009-01-25 15:17:37 +0100215int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500216 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
Kay Sievers9f2556512008-05-06 22:24:04 +0200218 const char *old_name = kobj->name;
219 char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Kay Sievers8a577ff2009-04-18 15:05:45 -0700221 if (kobj->name && !fmt)
222 return 0;
223
Kay Sieversa4ca6612008-04-30 02:06:29 +0200224 kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
225 if (!kobj->name)
226 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500227
Kay Sievers9f2556512008-05-06 22:24:04 +0200228 /* ewww... some of these buggers have '/' in the name ... */
Ingo Oeser25fdeb32008-07-23 01:25:01 +0200229 while ((s = strchr(kobj->name, '/')))
Kay Sievers9f2556512008-05-06 22:24:04 +0200230 s[0] = '!';
231
232 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500233 return 0;
234}
235
236/**
237 * kobject_set_name - Set the name of a kobject
238 * @kobj: struct kobject to set the name of
239 * @fmt: format string used to build the name
240 *
241 * This sets the name of the kobject. If you have already added the
242 * kobject to the system, you must call kobject_rename() in order to
243 * change the name of the kobject.
244 */
245int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
246{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200247 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500248 int retval;
249
Kay Sieversa4ca6612008-04-30 02:06:29 +0200250 va_start(vargs, fmt);
251 retval = kobject_set_name_vargs(kobj, fmt, vargs);
252 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500253
254 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256EXPORT_SYMBOL(kobject_set_name);
257
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700259 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800260 * @kobj: pointer to the kobject to initialize
261 * @ktype: pointer to the ktype for this kobject.
262 *
263 * This function will properly initialize a kobject such that it can then
264 * be passed to the kobject_add() call.
265 *
266 * After this function is called, the kobject MUST be cleaned up by a call
267 * to kobject_put(), not by a call to kfree directly to ensure that all of
268 * the memory is cleaned up properly.
269 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700270void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800271{
272 char *err_str;
273
274 if (!kobj) {
275 err_str = "invalid kobject pointer!";
276 goto error;
277 }
278 if (!ktype) {
279 err_str = "must have a ktype to be initialized properly!\n";
280 goto error;
281 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100282 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800283 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100284 printk(KERN_ERR "kobject (%p): tried to init an initialized "
285 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800286 dump_stack();
287 }
288
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800289 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800290 kobj->ktype = ktype;
291 return;
292
293error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100294 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800295 dump_stack();
296}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700297EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800298
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800299static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
300 const char *fmt, va_list vargs)
301{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800302 int retval;
303
Kay Sieversa4ca6612008-04-30 02:06:29 +0200304 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800305 if (retval) {
306 printk(KERN_ERR "kobject: can not set name properly!\n");
307 return retval;
308 }
309 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700310 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800311}
312
313/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700314 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800315 * @kobj: the kobject to add
316 * @parent: pointer to the parent of the kobject.
317 * @fmt: format to name the kobject with.
318 *
319 * The kobject name is set and added to the kobject hierarchy in this
320 * function.
321 *
322 * If @parent is set, then the parent of the @kobj will be set to it.
323 * If @parent is NULL, then the parent of the @kobj will be set to the
324 * kobject associted with the kset assigned to this kobject. If no kset
325 * is assigned to the kobject, then the kobject will be located in the
326 * root of the sysfs tree.
327 *
328 * If this function returns an error, kobject_put() must be called to
329 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800330 * Under no instance should the kobject that is passed to this function
331 * be directly freed with a call to kfree(), that can leak memory.
332 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100333 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800334 * up all of the necessary sysfs files for the object and then call
335 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
336 * userspace is properly notified of this kobject's creation.
337 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700338int kobject_add(struct kobject *kobj, struct kobject *parent,
339 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800340{
341 va_list args;
342 int retval;
343
344 if (!kobj)
345 return -EINVAL;
346
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100347 if (!kobj->state_initialized) {
348 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
349 "uninitialized object, something is seriously wrong.\n",
350 kobject_name(kobj), kobj);
351 dump_stack();
352 return -EINVAL;
353 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800354 va_start(args, fmt);
355 retval = kobject_add_varg(kobj, parent, fmt, args);
356 va_end(args);
357
358 return retval;
359}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700360EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800361
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800362/**
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800363 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
364 * @kobj: pointer to the kobject to initialize
365 * @ktype: pointer to the ktype for this kobject.
366 * @parent: pointer to the parent of this kobject.
367 * @fmt: the name of the kobject.
368 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700369 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700370 * kobject_add(). The same type of error handling after a call to
371 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800372 */
373int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
374 struct kobject *parent, const char *fmt, ...)
375{
376 va_list args;
377 int retval;
378
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700379 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800380
381 va_start(args, fmt);
382 retval = kobject_add_varg(kobj, parent, fmt, args);
383 va_end(args);
384
385 return retval;
386}
387EXPORT_SYMBOL_GPL(kobject_init_and_add);
388
389/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800390 * kobject_rename - change the name of an object
391 * @kobj: object in question.
392 * @new_name: object's new name
Eric W. Biederman030c1d22008-05-08 14:41:00 -0700393 *
394 * It is the responsibility of the caller to provide mutual
395 * exclusion between two different calls of kobject_rename
396 * on the same kobject and to ensure that new_name is valid and
397 * won't conflict with other kobjects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800399int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
401 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800402 const char *devpath = NULL;
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700403 const char *dup_name = NULL, *name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800404 char *devpath_string = NULL;
405 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406
407 kobj = kobject_get(kobj);
408 if (!kobj)
409 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700410 if (!kobj->parent)
411 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800412
413 devpath = kobject_get_path(kobj, GFP_KERNEL);
414 if (!devpath) {
415 error = -ENOMEM;
416 goto out;
417 }
418 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
419 if (!devpath_string) {
420 error = -ENOMEM;
421 goto out;
422 }
423 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
424 envp[0] = devpath_string;
425 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800426
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700427 name = dup_name = kstrdup(new_name, GFP_KERNEL);
428 if (!name) {
429 error = -ENOMEM;
430 goto out;
431 }
432
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900433 error = sysfs_rename_dir(kobj, new_name);
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700434 if (error)
435 goto out;
436
437 /* Install the new kobject name */
438 dup_name = kobj->name;
439 kobj->name = name;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800440
441 /* This function is mostly/only used for network interface.
442 * Some hotplug package track interfaces by their name and
443 * therefore want to know when the name is changed by the user. */
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700444 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800445
446out:
Eric W. Biederman0b4a4fe2008-07-03 18:05:28 -0700447 kfree(dup_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800448 kfree(devpath_string);
449 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700450 kobject_put(kobj);
451
452 return error;
453}
Alex Chiang8344b562008-06-10 15:30:42 -0600454EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700455
456/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800457 * kobject_move - move object to another parent
458 * @kobj: object in question.
459 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100460 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100461int kobject_move(struct kobject *kobj, struct kobject *new_parent)
462{
463 int error;
464 struct kobject *old_parent;
465 const char *devpath = NULL;
466 char *devpath_string = NULL;
467 char *envp[2];
468
469 kobj = kobject_get(kobj);
470 if (!kobj)
471 return -EINVAL;
472 new_parent = kobject_get(new_parent);
473 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100474 if (kobj->kset)
475 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100476 }
477 /* old object path */
478 devpath = kobject_get_path(kobj, GFP_KERNEL);
479 if (!devpath) {
480 error = -ENOMEM;
481 goto out;
482 }
483 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
484 if (!devpath_string) {
485 error = -ENOMEM;
486 goto out;
487 }
488 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
489 envp[0] = devpath_string;
490 envp[1] = NULL;
491 error = sysfs_move_dir(kobj, new_parent);
492 if (error)
493 goto out;
494 old_parent = kobj->parent;
495 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300496 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100497 kobject_put(old_parent);
498 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
499out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300500 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100501 kobject_put(kobj);
502 kfree(devpath_string);
503 kfree(devpath);
504 return error;
505}
506
507/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800508 * kobject_del - unlink kobject from hierarchy.
509 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800511void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800513 if (!kobj)
514 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 sysfs_remove_dir(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100517 kobj->state_in_sysfs = 0;
518 kobj_kset_leave(kobj);
519 kobject_put(kobj->parent);
520 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521}
522
523/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800524 * kobject_get - increment refcount for object.
525 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800527struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528{
529 if (kobj)
530 kref_get(&kobj->kref);
531 return kobj;
532}
533
Greg Kroah-Hartman18041f472007-12-03 21:31:08 -0800534/*
535 * kobject_cleanup - free kobject resources.
536 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 */
Greg Kroah-Hartman18041f472007-12-03 21:31:08 -0800538static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100540 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f42007-12-20 02:09:39 +0100541 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800543 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700544 kobject_name(kobj), kobj, __func__);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100545
546 if (t && !t->release)
547 pr_debug("kobject: '%s' (%p): does not have a release() "
548 "function, it is broken and must be fixed.\n",
549 kobject_name(kobj), kobj);
550
551 /* send "remove" if the caller did not do it but sent "add" */
552 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
553 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
554 kobject_name(kobj), kobj);
555 kobject_uevent(kobj, KOBJ_REMOVE);
556 }
557
558 /* remove from sysfs if the caller did not do it */
559 if (kobj->state_in_sysfs) {
560 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
561 kobject_name(kobj), kobj);
562 kobject_del(kobj);
563 }
564
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700565 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100566 pr_debug("kobject: '%s' (%p): calling ktype release\n",
567 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100569 }
570
571 /* free name if we allocated it */
Kay Sieversaf5ca3f42007-12-20 02:09:39 +0100572 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100573 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700574 kfree(name);
575 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576}
577
578static void kobject_release(struct kref *kref)
579{
580 kobject_cleanup(container_of(kref, struct kobject, kref));
581}
582
583/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800584 * kobject_put - decrement refcount for object.
585 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800587 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800589void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800591 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700592 if (!kobj->state_initialized)
593 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800594 "initialized, yet kobject_put() is being "
595 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800597 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598}
599
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800600static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500601{
Harvey Harrison810304d2008-04-30 00:55:08 -0700602 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500603 kfree(kobj);
604}
605
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800606static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100607 .release = dynamic_kobj_release,
608 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500609};
610
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800611/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800612 * kobject_create - create a struct kobject dynamically
613 *
614 * This function creates a kobject structure dynamically and sets it up
615 * to be a "dynamic" kobject with a default release function set up.
616 *
617 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800618 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700619 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800620 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800621 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800622struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800623{
624 struct kobject *kobj;
625
626 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
627 if (!kobj)
628 return NULL;
629
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700630 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800631 return kobj;
632}
633
634/**
635 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
636 *
637 * @name: the name for the kset
638 * @parent: the parent kobject of this kobject, if any.
639 *
Dave Youngf70701a2008-01-28 16:58:00 +0800640 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800641 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800642 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800643 * it is no longer being used.
644 *
645 * If the kobject was not able to be created, NULL will be returned.
646 */
647struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
648{
649 struct kobject *kobj;
650 int retval;
651
652 kobj = kobject_create();
653 if (!kobj)
654 return NULL;
655
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700656 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800657 if (retval) {
658 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700659 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800660 kobject_put(kobj);
661 kobj = NULL;
662 }
663 return kobj;
664}
665EXPORT_SYMBOL_GPL(kobject_create_and_add);
666
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500667/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800668 * kset_init - initialize a kset for use
669 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800671void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700673 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 INIT_LIST_HEAD(&k->list);
675 spin_lock_init(&k->list_lock);
676}
677
Kay Sievers23b52122007-11-02 13:47:53 +0100678/* default kobject attribute operations */
679static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
680 char *buf)
681{
682 struct kobj_attribute *kattr;
683 ssize_t ret = -EIO;
684
685 kattr = container_of(attr, struct kobj_attribute, attr);
686 if (kattr->show)
687 ret = kattr->show(kobj, kattr, buf);
688 return ret;
689}
690
691static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
692 const char *buf, size_t count)
693{
694 struct kobj_attribute *kattr;
695 ssize_t ret = -EIO;
696
697 kattr = container_of(attr, struct kobj_attribute, attr);
698 if (kattr->store)
699 ret = kattr->store(kobj, kattr, buf, count);
700 return ret;
701}
702
703struct sysfs_ops kobj_sysfs_ops = {
704 .show = kobj_attr_show,
705 .store = kobj_attr_store,
706};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800709 * kset_register - initialize and add a kset.
710 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800712int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713{
Kay Sievers80f03e32007-05-26 11:21:36 +0200714 int err;
715
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800716 if (!k)
717 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700720 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200721 if (err)
722 return err;
723 kobject_uevent(&k->kobj, KOBJ_ADD);
724 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725}
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800728 * kset_unregister - remove a kset.
729 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800731void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800733 if (!k)
734 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800735 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736}
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800739 * kset_find_obj - search for object in kset.
740 * @kset: kset we're looking in.
741 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800743 * Lock kset via @kset->subsys, and iterate over @kset->list,
744 * looking for a matching kobject. If matching object is found
745 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800747struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400749 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800750 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
752 spin_lock(&kset->list_lock);
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400753 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800754 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 ret = kobject_get(k);
756 break;
757 }
758 }
759 spin_unlock(&kset->list_lock);
760 return ret;
761}
762
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700763static void kset_release(struct kobject *kobj)
764{
765 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800766 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700767 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700768 kfree(kset);
769}
770
Kay Sievers386f2752007-11-02 13:47:53 +0100771static struct kobj_type kset_ktype = {
772 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700773 .release = kset_release,
774};
775
776/**
777 * kset_create - create a struct kset dynamically
778 *
779 * @name: the name for the kset
780 * @uevent_ops: a struct kset_uevent_ops for the kset
781 * @parent_kobj: the parent kobject of this kset, if any.
782 *
783 * This function creates a kset structure dynamically. This structure can
784 * then be registered with the system and show up in sysfs with a call to
785 * kset_register(). When you are finished with this structure, if
786 * kset_register() has been called, call kset_unregister() and the
787 * structure will be dynamically freed when it is no longer being used.
788 *
789 * If the kset was not able to be created, NULL will be returned.
790 */
791static struct kset *kset_create(const char *name,
792 struct kset_uevent_ops *uevent_ops,
793 struct kobject *parent_kobj)
794{
795 struct kset *kset;
796
797 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
798 if (!kset)
799 return NULL;
800 kobject_set_name(&kset->kobj, name);
801 kset->uevent_ops = uevent_ops;
802 kset->kobj.parent = parent_kobj;
803
804 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100805 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700806 * no kset itself. That way we can properly free it when it is
807 * finished being used.
808 */
Kay Sievers386f2752007-11-02 13:47:53 +0100809 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700810 kset->kobj.kset = NULL;
811
812 return kset;
813}
814
815/**
816 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
817 *
818 * @name: the name for the kset
819 * @uevent_ops: a struct kset_uevent_ops for the kset
820 * @parent_kobj: the parent kobject of this kset, if any.
821 *
822 * This function creates a kset structure dynamically and registers it
823 * with sysfs. When you are finished with this structure, call
824 * kset_unregister() and the structure will be dynamically freed when it
825 * is no longer being used.
826 *
827 * If the kset was not able to be created, NULL will be returned.
828 */
829struct kset *kset_create_and_add(const char *name,
830 struct kset_uevent_ops *uevent_ops,
831 struct kobject *parent_kobj)
832{
833 struct kset *kset;
834 int error;
835
836 kset = kset_create(name, uevent_ops, parent_kobj);
837 if (!kset)
838 return NULL;
839 error = kset_register(kset);
840 if (error) {
841 kfree(kset);
842 return NULL;
843 }
844 return kset;
845}
846EXPORT_SYMBOL_GPL(kset_create_and_add);
847
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848EXPORT_SYMBOL(kobject_get);
849EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850EXPORT_SYMBOL(kobject_del);
851
852EXPORT_SYMBOL(kset_register);
853EXPORT_SYMBOL(kset_unregister);