blob: bd732ffebc85f36cfc30e70fa124f0566701ecba [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-Hartman31b90252007-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 Sieversaf5ca3f2007-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 */
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500215static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
216 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217{
Kay Sievers9f255652008-05-06 22:24:04 +0200218 const char *old_name = kobj->name;
219 char *s;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Kay Sieversa4ca6612008-04-30 02:06:29 +0200221 kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
222 if (!kobj->name)
223 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500224
Kay Sievers9f255652008-05-06 22:24:04 +0200225 /* ewww... some of these buggers have '/' in the name ... */
226 s = strchr(kobj->name, '/');
227 if (s)
228 s[0] = '!';
229
230 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500231 return 0;
232}
233
234/**
235 * kobject_set_name - Set the name of a kobject
236 * @kobj: struct kobject to set the name of
237 * @fmt: format string used to build the name
238 *
239 * This sets the name of the kobject. If you have already added the
240 * kobject to the system, you must call kobject_rename() in order to
241 * change the name of the kobject.
242 */
243int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
244{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200245 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500246 int retval;
247
Kay Sieversa4ca6612008-04-30 02:06:29 +0200248 va_start(vargs, fmt);
249 retval = kobject_set_name_vargs(kobj, fmt, vargs);
250 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500251
252 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254EXPORT_SYMBOL(kobject_set_name);
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700257 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800258 * @kobj: pointer to the kobject to initialize
259 * @ktype: pointer to the ktype for this kobject.
260 *
261 * This function will properly initialize a kobject such that it can then
262 * be passed to the kobject_add() call.
263 *
264 * After this function is called, the kobject MUST be cleaned up by a call
265 * to kobject_put(), not by a call to kfree directly to ensure that all of
266 * the memory is cleaned up properly.
267 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700268void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800269{
270 char *err_str;
271
272 if (!kobj) {
273 err_str = "invalid kobject pointer!";
274 goto error;
275 }
276 if (!ktype) {
277 err_str = "must have a ktype to be initialized properly!\n";
278 goto error;
279 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100280 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800281 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100282 printk(KERN_ERR "kobject (%p): tried to init an initialized "
283 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800284 dump_stack();
285 }
286
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800287 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800288 kobj->ktype = ktype;
289 return;
290
291error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100292 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800293 dump_stack();
294}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700295EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800296
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800297static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
298 const char *fmt, va_list vargs)
299{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800300 int retval;
301
Kay Sieversa4ca6612008-04-30 02:06:29 +0200302 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800303 if (retval) {
304 printk(KERN_ERR "kobject: can not set name properly!\n");
305 return retval;
306 }
307 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700308 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800309}
310
311/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700312 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800313 * @kobj: the kobject to add
314 * @parent: pointer to the parent of the kobject.
315 * @fmt: format to name the kobject with.
316 *
317 * The kobject name is set and added to the kobject hierarchy in this
318 * function.
319 *
320 * If @parent is set, then the parent of the @kobj will be set to it.
321 * If @parent is NULL, then the parent of the @kobj will be set to the
322 * kobject associted with the kset assigned to this kobject. If no kset
323 * is assigned to the kobject, then the kobject will be located in the
324 * root of the sysfs tree.
325 *
326 * If this function returns an error, kobject_put() must be called to
327 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800328 * Under no instance should the kobject that is passed to this function
329 * be directly freed with a call to kfree(), that can leak memory.
330 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100331 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800332 * up all of the necessary sysfs files for the object and then call
333 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
334 * userspace is properly notified of this kobject's creation.
335 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700336int kobject_add(struct kobject *kobj, struct kobject *parent,
337 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800338{
339 va_list args;
340 int retval;
341
342 if (!kobj)
343 return -EINVAL;
344
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100345 if (!kobj->state_initialized) {
346 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
347 "uninitialized object, something is seriously wrong.\n",
348 kobject_name(kobj), kobj);
349 dump_stack();
350 return -EINVAL;
351 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800352 va_start(args, fmt);
353 retval = kobject_add_varg(kobj, parent, fmt, args);
354 va_end(args);
355
356 return retval;
357}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700358EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800359
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800360/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800361 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
362 * @kobj: pointer to the kobject to initialize
363 * @ktype: pointer to the ktype for this kobject.
364 * @parent: pointer to the parent of this kobject.
365 * @fmt: the name of the kobject.
366 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700367 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700368 * kobject_add(). The same type of error handling after a call to
369 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800370 */
371int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
372 struct kobject *parent, const char *fmt, ...)
373{
374 va_list args;
375 int retval;
376
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700377 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800378
379 va_start(args, fmt);
380 retval = kobject_add_varg(kobj, parent, fmt, args);
381 va_end(args);
382
383 return retval;
384}
385EXPORT_SYMBOL_GPL(kobject_init_and_add);
386
387/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800388 * kobject_rename - change the name of an object
389 * @kobj: object in question.
390 * @new_name: object's new name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800392int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393{
394 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800395 const char *devpath = NULL;
396 char *devpath_string = NULL;
397 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398
399 kobj = kobject_get(kobj);
400 if (!kobj)
401 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700402 if (!kobj->parent)
403 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800404
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700405 /* see if this name is already in use */
406 if (kobj->kset) {
407 struct kobject *temp_kobj;
408 temp_kobj = kset_find_obj(kobj->kset, new_name);
409 if (temp_kobj) {
Johannes Berg71409a42007-11-05 13:59:11 +0100410 printk(KERN_WARNING "kobject '%s' cannot be renamed "
411 "to '%s' as '%s' is already in existence.\n",
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700412 kobject_name(kobj), new_name, new_name);
413 kobject_put(temp_kobj);
414 return -EINVAL;
415 }
416 }
417
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800418 devpath = kobject_get_path(kobj, GFP_KERNEL);
419 if (!devpath) {
420 error = -ENOMEM;
421 goto out;
422 }
423 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
424 if (!devpath_string) {
425 error = -ENOMEM;
426 goto out;
427 }
428 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
429 envp[0] = devpath_string;
430 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800431
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900432 error = sysfs_rename_dir(kobj, new_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800433
434 /* This function is mostly/only used for network interface.
435 * Some hotplug package track interfaces by their name and
436 * therefore want to know when the name is changed by the user. */
437 if (!error)
438 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
439
440out:
441 kfree(devpath_string);
442 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700443 kobject_put(kobj);
444
445 return error;
446}
Alex Chiang8344b562008-06-10 15:30:42 -0600447EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700448
449/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800450 * kobject_move - move object to another parent
451 * @kobj: object in question.
452 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100453 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100454int kobject_move(struct kobject *kobj, struct kobject *new_parent)
455{
456 int error;
457 struct kobject *old_parent;
458 const char *devpath = NULL;
459 char *devpath_string = NULL;
460 char *envp[2];
461
462 kobj = kobject_get(kobj);
463 if (!kobj)
464 return -EINVAL;
465 new_parent = kobject_get(new_parent);
466 if (!new_parent) {
Cornelia Huckc744aea2007-01-08 20:16:44 +0100467 if (kobj->kset)
468 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100469 }
470 /* old object path */
471 devpath = kobject_get_path(kobj, GFP_KERNEL);
472 if (!devpath) {
473 error = -ENOMEM;
474 goto out;
475 }
476 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
477 if (!devpath_string) {
478 error = -ENOMEM;
479 goto out;
480 }
481 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
482 envp[0] = devpath_string;
483 envp[1] = NULL;
484 error = sysfs_move_dir(kobj, new_parent);
485 if (error)
486 goto out;
487 old_parent = kobj->parent;
488 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300489 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100490 kobject_put(old_parent);
491 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
492out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300493 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100494 kobject_put(kobj);
495 kfree(devpath_string);
496 kfree(devpath);
497 return error;
498}
499
500/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800501 * kobject_del - unlink kobject from hierarchy.
502 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800504void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800506 if (!kobj)
507 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 sysfs_remove_dir(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100510 kobj->state_in_sysfs = 0;
511 kobj_kset_leave(kobj);
512 kobject_put(kobj->parent);
513 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514}
515
516/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800517 * kobject_get - increment refcount for object.
518 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800520struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521{
522 if (kobj)
523 kref_get(&kobj->kref);
524 return kobj;
525}
526
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800527/*
528 * kobject_cleanup - free kobject resources.
529 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800531static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100533 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100534 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800536 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700537 kobject_name(kobj), kobj, __func__);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100538
539 if (t && !t->release)
540 pr_debug("kobject: '%s' (%p): does not have a release() "
541 "function, it is broken and must be fixed.\n",
542 kobject_name(kobj), kobj);
543
544 /* send "remove" if the caller did not do it but sent "add" */
545 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
546 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
547 kobject_name(kobj), kobj);
548 kobject_uevent(kobj, KOBJ_REMOVE);
549 }
550
551 /* remove from sysfs if the caller did not do it */
552 if (kobj->state_in_sysfs) {
553 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
554 kobject_name(kobj), kobj);
555 kobject_del(kobj);
556 }
557
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700558 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100559 pr_debug("kobject: '%s' (%p): calling ktype release\n",
560 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100562 }
563
564 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100565 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100566 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700567 kfree(name);
568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
570
571static void kobject_release(struct kref *kref)
572{
573 kobject_cleanup(container_of(kref, struct kobject, kref));
574}
575
576/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800577 * kobject_put - decrement refcount for object.
578 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800580 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800582void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800584 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700585 if (!kobj->state_initialized)
586 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800587 "initialized, yet kobject_put() is being "
588 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800590 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
592
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800593static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500594{
Harvey Harrison810304d2008-04-30 00:55:08 -0700595 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500596 kfree(kobj);
597}
598
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800599static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100600 .release = dynamic_kobj_release,
601 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500602};
603
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800604/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800605 * kobject_create - create a struct kobject dynamically
606 *
607 * This function creates a kobject structure dynamically and sets it up
608 * to be a "dynamic" kobject with a default release function set up.
609 *
610 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800611 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700612 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800613 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800614 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800615struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800616{
617 struct kobject *kobj;
618
619 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
620 if (!kobj)
621 return NULL;
622
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700623 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800624 return kobj;
625}
626
627/**
628 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
629 *
630 * @name: the name for the kset
631 * @parent: the parent kobject of this kobject, if any.
632 *
Dave Youngf70701a2008-01-28 16:58:00 +0800633 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800634 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800635 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800636 * it is no longer being used.
637 *
638 * If the kobject was not able to be created, NULL will be returned.
639 */
640struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
641{
642 struct kobject *kobj;
643 int retval;
644
645 kobj = kobject_create();
646 if (!kobj)
647 return NULL;
648
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700649 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800650 if (retval) {
651 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700652 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800653 kobject_put(kobj);
654 kobj = NULL;
655 }
656 return kobj;
657}
658EXPORT_SYMBOL_GPL(kobject_create_and_add);
659
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500660/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800661 * kset_init - initialize a kset for use
662 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800664void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700666 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 INIT_LIST_HEAD(&k->list);
668 spin_lock_init(&k->list_lock);
669}
670
Kay Sievers23b52122007-11-02 13:47:53 +0100671/* default kobject attribute operations */
672static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
673 char *buf)
674{
675 struct kobj_attribute *kattr;
676 ssize_t ret = -EIO;
677
678 kattr = container_of(attr, struct kobj_attribute, attr);
679 if (kattr->show)
680 ret = kattr->show(kobj, kattr, buf);
681 return ret;
682}
683
684static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
685 const char *buf, size_t count)
686{
687 struct kobj_attribute *kattr;
688 ssize_t ret = -EIO;
689
690 kattr = container_of(attr, struct kobj_attribute, attr);
691 if (kattr->store)
692 ret = kattr->store(kobj, kattr, buf, count);
693 return ret;
694}
695
696struct sysfs_ops kobj_sysfs_ops = {
697 .show = kobj_attr_show,
698 .store = kobj_attr_store,
699};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
701/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800702 * kset_register - initialize and add a kset.
703 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800705int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
Kay Sievers80f03e32007-05-26 11:21:36 +0200707 int err;
708
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800709 if (!k)
710 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700713 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200714 if (err)
715 return err;
716 kobject_uevent(&k->kobj, KOBJ_ADD);
717 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718}
719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800721 * kset_unregister - remove a kset.
722 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800724void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725{
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800726 if (!k)
727 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800728 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729}
730
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800732 * kset_find_obj - search for object in kset.
733 * @kset: kset we're looking in.
734 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800736 * Lock kset via @kset->subsys, and iterate over @kset->list,
737 * looking for a matching kobject. If matching object is found
738 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800740struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400742 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800743 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
745 spin_lock(&kset->list_lock);
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400746 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800747 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 ret = kobject_get(k);
749 break;
750 }
751 }
752 spin_unlock(&kset->list_lock);
753 return ret;
754}
755
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700756static void kset_release(struct kobject *kobj)
757{
758 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800759 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700760 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700761 kfree(kset);
762}
763
Kay Sievers386f2752007-11-02 13:47:53 +0100764static struct kobj_type kset_ktype = {
765 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700766 .release = kset_release,
767};
768
769/**
770 * kset_create - create a struct kset dynamically
771 *
772 * @name: the name for the kset
773 * @uevent_ops: a struct kset_uevent_ops for the kset
774 * @parent_kobj: the parent kobject of this kset, if any.
775 *
776 * This function creates a kset structure dynamically. This structure can
777 * then be registered with the system and show up in sysfs with a call to
778 * kset_register(). When you are finished with this structure, if
779 * kset_register() has been called, call kset_unregister() and the
780 * structure will be dynamically freed when it is no longer being used.
781 *
782 * If the kset was not able to be created, NULL will be returned.
783 */
784static struct kset *kset_create(const char *name,
785 struct kset_uevent_ops *uevent_ops,
786 struct kobject *parent_kobj)
787{
788 struct kset *kset;
789
790 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
791 if (!kset)
792 return NULL;
793 kobject_set_name(&kset->kobj, name);
794 kset->uevent_ops = uevent_ops;
795 kset->kobj.parent = parent_kobj;
796
797 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100798 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700799 * no kset itself. That way we can properly free it when it is
800 * finished being used.
801 */
Kay Sievers386f2752007-11-02 13:47:53 +0100802 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700803 kset->kobj.kset = NULL;
804
805 return kset;
806}
807
808/**
809 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
810 *
811 * @name: the name for the kset
812 * @uevent_ops: a struct kset_uevent_ops for the kset
813 * @parent_kobj: the parent kobject of this kset, if any.
814 *
815 * This function creates a kset structure dynamically and registers it
816 * with sysfs. When you are finished with this structure, call
817 * kset_unregister() and the structure will be dynamically freed when it
818 * is no longer being used.
819 *
820 * If the kset was not able to be created, NULL will be returned.
821 */
822struct kset *kset_create_and_add(const char *name,
823 struct kset_uevent_ops *uevent_ops,
824 struct kobject *parent_kobj)
825{
826 struct kset *kset;
827 int error;
828
829 kset = kset_create(name, uevent_ops, parent_kobj);
830 if (!kset)
831 return NULL;
832 error = kset_register(kset);
833 if (error) {
834 kfree(kset);
835 return NULL;
836 }
837 return kset;
838}
839EXPORT_SYMBOL_GPL(kset_create_and_add);
840
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841EXPORT_SYMBOL(kobject_get);
842EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843EXPORT_SYMBOL(kobject_del);
844
845EXPORT_SYMBOL(kset_register);
846EXPORT_SYMBOL(kset_unregister);