blob: 4fce5ca42c2e7facb093784e06d46571b4a6ffb3 [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
21/**
22 * populate_dir - populate directory with attributes.
23 * @kobj: object we're working on.
24 *
25 * Most subsystems have a set of default attributes that
26 * are associated with an object that registers with them.
27 * This is a helper called during object registration that
28 * loops through the default attributes of the subsystem
29 * and creates attributes files for them in sysfs.
30 *
31 */
32
33static int populate_dir(struct kobject * kobj)
34{
35 struct kobj_type * t = get_ktype(kobj);
36 struct attribute * attr;
37 int error = 0;
38 int i;
39
40 if (t && t->default_attrs) {
41 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
42 if ((error = sysfs_create_file(kobj,attr)))
43 break;
44 }
45 }
46 return error;
47}
48
Eric W. Biederman90bc6132007-07-31 19:15:08 +090049static int create_dir(struct kobject * kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -070050{
51 int error = 0;
52 if (kobject_name(kobj)) {
Eric W. Biederman90bc6132007-07-31 19:15:08 +090053 error = sysfs_create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 if (!error) {
55 if ((error = populate_dir(kobj)))
56 sysfs_remove_dir(kobj);
57 }
58 }
59 return error;
60}
61
62static inline struct kobject * to_kobj(struct list_head * entry)
63{
64 return container_of(entry,struct kobject,entry);
65}
66
67static int get_kobj_path_length(struct kobject *kobj)
68{
69 int length = 1;
70 struct kobject * parent = kobj;
71
72 /* walk up the ancestors until we hit the one pointing to the
73 * root.
74 * Add 1 to strlen for leading '/' of each level.
75 */
76 do {
Chuck Ebbertb365b3d2006-01-12 20:02:00 -050077 if (kobject_name(parent) == NULL)
78 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 length += strlen(kobject_name(parent)) + 1;
80 parent = parent->parent;
81 } while (parent);
82 return length;
83}
84
85static void fill_kobj_path(struct kobject *kobj, char *path, int length)
86{
87 struct kobject * parent;
88
89 --length;
90 for (parent = kobj; parent; parent = parent->parent) {
91 int cur = strlen(kobject_name(parent));
92 /* back up enough to print this name with '/' */
93 length -= cur;
94 strncpy (path + length, kobject_name(parent), cur);
95 *(path + --length) = '/';
96 }
97
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -080098 pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
99 kobj, __FUNCTION__,path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100}
101
102/**
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800103 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 *
105 * @kobj: kobject in question, with which to build the path
106 * @gfp_mask: the allocation type used to allocate the path
Robert P. J. Day72fd4a32007-02-10 01:45:59 -0800107 *
108 * The result must be freed by the caller with kfree().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 */
Al Virofd4f2df2005-10-21 03:18:50 -0400110char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111{
112 char *path;
113 int len;
114
115 len = get_kobj_path_length(kobj);
Chuck Ebbertb365b3d2006-01-12 20:02:00 -0500116 if (len == 0)
117 return NULL;
Burman Yan4668edc2006-12-06 20:38:51 -0800118 path = kzalloc(len, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 if (!path)
120 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 fill_kobj_path(kobj, path, len);
122
123 return path;
124}
Dmitry Torokhov80fc9f52006-10-11 01:43:58 -0400125EXPORT_SYMBOL_GPL(kobject_get_path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100127/* add the kobject to its kset's list */
128static void kobj_kset_join(struct kobject *kobj)
129{
130 if (!kobj->kset)
131 return;
132
133 kset_get(kobj->kset);
134 spin_lock(&kobj->kset->list_lock);
135 list_add_tail(&kobj->entry, &kobj->kset->list);
136 spin_unlock(&kobj->kset->list_lock);
137}
138
139/* remove the kobject from its kset's list */
140static void kobj_kset_leave(struct kobject *kobj)
141{
142 if (!kobj->kset)
143 return;
144
145 spin_lock(&kobj->kset->list_lock);
146 list_del_init(&kobj->entry);
147 spin_unlock(&kobj->kset->list_lock);
148 kset_put(kobj->kset);
149}
150
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700151static void kobject_init_internal(struct kobject * kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800153 if (!kobj)
154 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 kref_init(&kobj->kref);
156 INIT_LIST_HEAD(&kobj->entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
159
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700160static int kobject_add_internal(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
162 int error = 0;
163 struct kobject * parent;
164
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100165 if (!kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 return -ENOENT;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100167
168 if (!kobj->k_name || !kobj->k_name[0]) {
169 pr_debug("kobject: (%p): attempted to be registered with empty "
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800170 "name!\n", kobj);
Greg Kroah-Hartmanc171fef2006-01-20 14:08:59 -0800171 WARN_ON(1);
172 return -EINVAL;
173 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100174
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 parent = kobject_get(kobj->parent);
176
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100177 /* join kset if set, use it as parent if we do not already have one */
178 if (kobj->kset) {
179 if (!parent)
180 parent = kobject_get(&kobj->kset->kobj);
181 kobj_kset_join(kobj);
182 kobj->parent = parent;
183 }
184
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800185 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
186 kobject_name(kobj), kobj, __FUNCTION__,
187 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700188 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>" );
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900190 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100192 kobj_kset_leave(kobj);
193 kobject_put(parent);
194 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800195
196 /* be noisy on error issues */
197 if (error == -EEXIST)
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700198 printk(KERN_ERR "%s failed for %s with "
Greg Kroah-Hartman5c73a3f2007-06-07 15:05:15 -0700199 "-EEXIST, don't try to register things with "
200 "the same name in the same directory.\n",
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700201 __FUNCTION__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800202 else
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700203 printk(KERN_ERR "%s failed for %s (%d)\n",
204 __FUNCTION__, kobject_name(kobj), error);
Greg Kroah-Hartman5c73a3f2007-06-07 15:05:15 -0700205 dump_stack();
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100206 } else
207 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209 return error;
210}
211
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700212/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500213 * kobject_set_name_vargs - Set the name of an kobject
214 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800215 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500216 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 */
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500218static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
219 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220{
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500221 va_list aq;
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700222 char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500224 va_copy(aq, vargs);
225 name = kvasprintf(GFP_KERNEL, fmt, vargs);
226 va_end(aq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500228 if (!name)
229 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 /* Free the old name, if necessary. */
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700233 kfree(kobj->k_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235 /* Now, set the new name */
236 kobj->k_name = name;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100237 kobj->state_name_set = 1;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500238
239 return 0;
240}
241
242/**
243 * kobject_set_name - Set the name of a kobject
244 * @kobj: struct kobject to set the name of
245 * @fmt: format string used to build the name
246 *
247 * This sets the name of the kobject. If you have already added the
248 * kobject to the system, you must call kobject_rename() in order to
249 * change the name of the kobject.
250 */
251int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
252{
253 va_list args;
254 int retval;
255
256 va_start(args, fmt);
257 retval = kobject_set_name_vargs(kobj, fmt, args);
258 va_end(args);
259
260 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262EXPORT_SYMBOL(kobject_set_name);
263
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700265 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800266 * @kobj: pointer to the kobject to initialize
267 * @ktype: pointer to the ktype for this kobject.
268 *
269 * This function will properly initialize a kobject such that it can then
270 * be passed to the kobject_add() call.
271 *
272 * After this function is called, the kobject MUST be cleaned up by a call
273 * to kobject_put(), not by a call to kfree directly to ensure that all of
274 * the memory is cleaned up properly.
275 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700276void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800277{
278 char *err_str;
279
280 if (!kobj) {
281 err_str = "invalid kobject pointer!";
282 goto error;
283 }
284 if (!ktype) {
285 err_str = "must have a ktype to be initialized properly!\n";
286 goto error;
287 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100288 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800289 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100290 printk(KERN_ERR "kobject (%p): tried to init an initialized "
291 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800292 dump_stack();
293 }
294
295 kref_init(&kobj->kref);
296 INIT_LIST_HEAD(&kobj->entry);
297 kobj->ktype = ktype;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100298 kobj->state_name_set = 0;
299 kobj->state_in_sysfs = 0;
300 kobj->state_add_uevent_sent = 0;
301 kobj->state_remove_uevent_sent = 0;
302 kobj->state_initialized = 1;
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800303 return;
304
305error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100306 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800307 dump_stack();
308}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700309EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800310
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800311static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
312 const char *fmt, va_list vargs)
313{
314 va_list aq;
315 int retval;
316
317 va_copy(aq, vargs);
318 retval = kobject_set_name_vargs(kobj, fmt, aq);
319 va_end(aq);
320 if (retval) {
321 printk(KERN_ERR "kobject: can not set name properly!\n");
322 return retval;
323 }
324 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700325 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800326}
327
328/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700329 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800330 * @kobj: the kobject to add
331 * @parent: pointer to the parent of the kobject.
332 * @fmt: format to name the kobject with.
333 *
334 * The kobject name is set and added to the kobject hierarchy in this
335 * function.
336 *
337 * If @parent is set, then the parent of the @kobj will be set to it.
338 * If @parent is NULL, then the parent of the @kobj will be set to the
339 * kobject associted with the kset assigned to this kobject. If no kset
340 * is assigned to the kobject, then the kobject will be located in the
341 * root of the sysfs tree.
342 *
343 * If this function returns an error, kobject_put() must be called to
344 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800345 * Under no instance should the kobject that is passed to this function
346 * be directly freed with a call to kfree(), that can leak memory.
347 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100348 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800349 * up all of the necessary sysfs files for the object and then call
350 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
351 * userspace is properly notified of this kobject's creation.
352 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700353int kobject_add(struct kobject *kobj, struct kobject *parent,
354 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800355{
356 va_list args;
357 int retval;
358
359 if (!kobj)
360 return -EINVAL;
361
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100362 if (!kobj->state_initialized) {
363 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
364 "uninitialized object, something is seriously wrong.\n",
365 kobject_name(kobj), kobj);
366 dump_stack();
367 return -EINVAL;
368 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800369 va_start(args, fmt);
370 retval = kobject_add_varg(kobj, parent, fmt, args);
371 va_end(args);
372
373 return retval;
374}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700375EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800376
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800377/**
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800378 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
379 * @kobj: pointer to the kobject to initialize
380 * @ktype: pointer to the ktype for this kobject.
381 * @parent: pointer to the parent of this kobject.
382 * @fmt: the name of the kobject.
383 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700384 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700385 * kobject_add(). The same type of error handling after a call to
386 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800387 */
388int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
389 struct kobject *parent, const char *fmt, ...)
390{
391 va_list args;
392 int retval;
393
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700394 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c41542007-12-03 21:31:08 -0800395
396 va_start(args, fmt);
397 retval = kobject_add_varg(kobj, parent, fmt, args);
398 va_end(args);
399
400 return retval;
401}
402EXPORT_SYMBOL_GPL(kobject_init_and_add);
403
404/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 * kobject_rename - change the name of an object
406 * @kobj: object in question.
407 * @new_name: object's new name
408 */
409
Dmitry Torokhovf3b4f3c2005-04-26 02:32:00 -0500410int kobject_rename(struct kobject * kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411{
412 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800413 const char *devpath = NULL;
414 char *devpath_string = NULL;
415 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
417 kobj = kobject_get(kobj);
418 if (!kobj)
419 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700420 if (!kobj->parent)
421 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800422
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700423 /* see if this name is already in use */
424 if (kobj->kset) {
425 struct kobject *temp_kobj;
426 temp_kobj = kset_find_obj(kobj->kset, new_name);
427 if (temp_kobj) {
Johannes Berg71409a42007-11-05 13:59:11 +0100428 printk(KERN_WARNING "kobject '%s' cannot be renamed "
429 "to '%s' as '%s' is already in existence.\n",
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700430 kobject_name(kobj), new_name, new_name);
431 kobject_put(temp_kobj);
432 return -EINVAL;
433 }
434 }
435
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800436 devpath = kobject_get_path(kobj, GFP_KERNEL);
437 if (!devpath) {
438 error = -ENOMEM;
439 goto out;
440 }
441 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
442 if (!devpath_string) {
443 error = -ENOMEM;
444 goto out;
445 }
446 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
447 envp[0] = devpath_string;
448 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800449
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900450 error = sysfs_rename_dir(kobj, new_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800451
452 /* This function is mostly/only used for network interface.
453 * Some hotplug package track interfaces by their name and
454 * therefore want to know when the name is changed by the user. */
455 if (!error)
456 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
457
458out:
459 kfree(devpath_string);
460 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700461 kobject_put(kobj);
462
463 return error;
464}
465
466/**
Cornelia Huck8a824722006-11-20 17:07:51 +0100467 * kobject_move - move object to another parent
468 * @kobj: object in question.
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100469 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100470 */
471
472int kobject_move(struct kobject *kobj, struct kobject *new_parent)
473{
474 int error;
475 struct kobject *old_parent;
476 const char *devpath = NULL;
477 char *devpath_string = NULL;
478 char *envp[2];
479
480 kobj = kobject_get(kobj);
481 if (!kobj)
482 return -EINVAL;
483 new_parent = kobject_get(new_parent);
484 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100485 if (kobj->kset)
486 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100487 }
488 /* old object path */
489 devpath = kobject_get_path(kobj, GFP_KERNEL);
490 if (!devpath) {
491 error = -ENOMEM;
492 goto out;
493 }
494 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
495 if (!devpath_string) {
496 error = -ENOMEM;
497 goto out;
498 }
499 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
500 envp[0] = devpath_string;
501 envp[1] = NULL;
502 error = sysfs_move_dir(kobj, new_parent);
503 if (error)
504 goto out;
505 old_parent = kobj->parent;
506 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300507 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100508 kobject_put(old_parent);
509 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
510out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300511 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100512 kobject_put(kobj);
513 kfree(devpath_string);
514 kfree(devpath);
515 return error;
516}
517
518/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 * kobject_del - unlink kobject from hierarchy.
520 * @kobj: object.
521 */
522
523void kobject_del(struct kobject * kobj)
524{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800525 if (!kobj)
526 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 sysfs_remove_dir(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100529 kobj->state_in_sysfs = 0;
530 kobj_kset_leave(kobj);
531 kobject_put(kobj->parent);
532 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533}
534
535/**
536 * kobject_unregister - remove object from hierarchy and decrement refcount.
537 * @kobj: object going away.
538 */
539
540void kobject_unregister(struct kobject * kobj)
541{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800542 if (!kobj)
543 return;
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800544 pr_debug("kobject: '%s' (%p): %s\n",
545 kobject_name(kobj), kobj, __FUNCTION__);
Kay Sievers312c0042005-11-16 09:00:00 +0100546 kobject_uevent(kobj, KOBJ_REMOVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 kobject_del(kobj);
548 kobject_put(kobj);
549}
550
551/**
552 * kobject_get - increment refcount for object.
553 * @kobj: object.
554 */
555
556struct kobject * kobject_get(struct kobject * kobj)
557{
558 if (kobj)
559 kref_get(&kobj->kref);
560 return kobj;
561}
562
Greg Kroah-Hartman18041f472007-12-03 21:31:08 -0800563/*
564 * kobject_cleanup - free kobject resources.
565 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 */
Greg Kroah-Hartman18041f472007-12-03 21:31:08 -0800567static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100569 struct kobj_type *t = get_ktype(kobj);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700570 const char *name = kobj->k_name;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100571 int name_set = kobj->state_name_set;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800573 pr_debug("kobject: '%s' (%p): %s\n",
574 kobject_name(kobj), kobj, __FUNCTION__);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100575
576 if (t && !t->release)
577 pr_debug("kobject: '%s' (%p): does not have a release() "
578 "function, it is broken and must be fixed.\n",
579 kobject_name(kobj), kobj);
580
581 /* send "remove" if the caller did not do it but sent "add" */
582 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
583 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
584 kobject_name(kobj), kobj);
585 kobject_uevent(kobj, KOBJ_REMOVE);
586 }
587
588 /* remove from sysfs if the caller did not do it */
589 if (kobj->state_in_sysfs) {
590 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
591 kobject_name(kobj), kobj);
592 kobject_del(kobj);
593 }
594
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700595 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100596 pr_debug("kobject: '%s' (%p): calling ktype release\n",
597 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100599 }
600
601 /* free name if we allocated it */
602 if (name_set && name) {
603 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700604 kfree(name);
605 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606}
607
608static void kobject_release(struct kref *kref)
609{
610 kobject_cleanup(container_of(kref, struct kobject, kref));
611}
612
613/**
614 * kobject_put - decrement refcount for object.
615 * @kobj: object.
616 *
617 * Decrement the refcount, and if 0, call kobject_cleanup().
618 */
619void kobject_put(struct kobject * kobj)
620{
621 if (kobj)
622 kref_put(&kobj->kref, kobject_release);
623}
624
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800625static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500626{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100627 pr_debug("kobject: (%p): %s\n", kobj, __FUNCTION__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500628 kfree(kobj);
629}
630
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800631static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100632 .release = dynamic_kobj_release,
633 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500634};
635
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800636/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800637 * kobject_create - create a struct kobject dynamically
638 *
639 * This function creates a kobject structure dynamically and sets it up
640 * to be a "dynamic" kobject with a default release function set up.
641 *
642 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800643 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700644 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800645 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800646 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800647struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800648{
649 struct kobject *kobj;
650
651 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
652 if (!kobj)
653 return NULL;
654
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700655 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800656 return kobj;
657}
658
659/**
660 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
661 *
662 * @name: the name for the kset
663 * @parent: the parent kobject of this kobject, if any.
664 *
665 * This function creates a kset structure dynamically and registers it
666 * with sysfs. When you are finished with this structure, call
667 * kobject_unregister() and the structure will be dynamically freed when
668 * it is no longer being used.
669 *
670 * If the kobject was not able to be created, NULL will be returned.
671 */
672struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
673{
674 struct kobject *kobj;
675 int retval;
676
677 kobj = kobject_create();
678 if (!kobj)
679 return NULL;
680
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700681 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800682 if (retval) {
683 printk(KERN_WARNING "%s: kobject_add error: %d\n",
684 __FUNCTION__, retval);
685 kobject_put(kobj);
686 kobj = NULL;
687 }
688 return kobj;
689}
690EXPORT_SYMBOL_GPL(kobject_create_and_add);
691
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500692/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 * kset_init - initialize a kset for use
694 * @k: kset
695 */
696
697void kset_init(struct kset * k)
698{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700699 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 INIT_LIST_HEAD(&k->list);
701 spin_lock_init(&k->list_lock);
702}
703
Kay Sievers23b52122007-11-02 13:47:53 +0100704/* default kobject attribute operations */
705static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
706 char *buf)
707{
708 struct kobj_attribute *kattr;
709 ssize_t ret = -EIO;
710
711 kattr = container_of(attr, struct kobj_attribute, attr);
712 if (kattr->show)
713 ret = kattr->show(kobj, kattr, buf);
714 return ret;
715}
716
717static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
718 const char *buf, size_t count)
719{
720 struct kobj_attribute *kattr;
721 ssize_t ret = -EIO;
722
723 kattr = container_of(attr, struct kobj_attribute, attr);
724 if (kattr->store)
725 ret = kattr->store(kobj, kattr, buf, count);
726 return ret;
727}
728
729struct sysfs_ops kobj_sysfs_ops = {
730 .show = kobj_attr_show,
731 .store = kobj_attr_store,
732};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
734/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 * kset_register - initialize and add a kset.
736 * @k: kset.
737 */
738
739int kset_register(struct kset * k)
740{
Kay Sievers80f03e32007-05-26 11:21:36 +0200741 int err;
742
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800743 if (!k)
744 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200745
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700747 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200748 if (err)
749 return err;
750 kobject_uevent(&k->kobj, KOBJ_ADD);
751 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752}
753
754
755/**
756 * kset_unregister - remove a kset.
757 * @k: kset.
758 */
759
760void kset_unregister(struct kset * k)
761{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800762 if (!k)
763 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 kobject_unregister(&k->kobj);
765}
766
767
768/**
769 * kset_find_obj - search for object in kset.
770 * @kset: kset we're looking in.
771 * @name: object's name.
772 *
773 * Lock kset via @kset->subsys, and iterate over @kset->list,
774 * looking for a matching kobject. If matching object is found
775 * take a reference and return the object.
776 */
777
778struct kobject * kset_find_obj(struct kset * kset, const char * name)
779{
780 struct list_head * entry;
781 struct kobject * ret = NULL;
782
783 spin_lock(&kset->list_lock);
784 list_for_each(entry,&kset->list) {
785 struct kobject * k = to_kobj(entry);
786 if (kobject_name(k) && !strcmp(kobject_name(k),name)) {
787 ret = kobject_get(k);
788 break;
789 }
790 }
791 spin_unlock(&kset->list_lock);
792 return ret;
793}
794
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700795static void kset_release(struct kobject *kobj)
796{
797 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800798 pr_debug("kobject: '%s' (%p): %s\n",
799 kobject_name(kobj), kobj, __FUNCTION__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700800 kfree(kset);
801}
802
Kay Sievers386f2752007-11-02 13:47:53 +0100803static struct kobj_type kset_ktype = {
804 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700805 .release = kset_release,
806};
807
808/**
809 * kset_create - create a struct kset dynamically
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. This structure can
816 * then be registered with the system and show up in sysfs with a call to
817 * kset_register(). When you are finished with this structure, if
818 * kset_register() has been called, call kset_unregister() and the
819 * structure will be dynamically freed when it is no longer being used.
820 *
821 * If the kset was not able to be created, NULL will be returned.
822 */
823static struct kset *kset_create(const char *name,
824 struct kset_uevent_ops *uevent_ops,
825 struct kobject *parent_kobj)
826{
827 struct kset *kset;
828
829 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
830 if (!kset)
831 return NULL;
832 kobject_set_name(&kset->kobj, name);
833 kset->uevent_ops = uevent_ops;
834 kset->kobj.parent = parent_kobj;
835
836 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100837 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700838 * no kset itself. That way we can properly free it when it is
839 * finished being used.
840 */
Kay Sievers386f2752007-11-02 13:47:53 +0100841 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700842 kset->kobj.kset = NULL;
843
844 return kset;
845}
846
847/**
848 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
849 *
850 * @name: the name for the kset
851 * @uevent_ops: a struct kset_uevent_ops for the kset
852 * @parent_kobj: the parent kobject of this kset, if any.
853 *
854 * This function creates a kset structure dynamically and registers it
855 * with sysfs. When you are finished with this structure, call
856 * kset_unregister() and the structure will be dynamically freed when it
857 * is no longer being used.
858 *
859 * If the kset was not able to be created, NULL will be returned.
860 */
861struct kset *kset_create_and_add(const char *name,
862 struct kset_uevent_ops *uevent_ops,
863 struct kobject *parent_kobj)
864{
865 struct kset *kset;
866 int error;
867
868 kset = kset_create(name, uevent_ops, parent_kobj);
869 if (!kset)
870 return NULL;
871 error = kset_register(kset);
872 if (error) {
873 kfree(kset);
874 return NULL;
875 }
876 return kset;
877}
878EXPORT_SYMBOL_GPL(kset_create_and_add);
879
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880EXPORT_SYMBOL(kobject_unregister);
881EXPORT_SYMBOL(kobject_get);
882EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883EXPORT_SYMBOL(kobject_del);
884
885EXPORT_SYMBOL(kset_register);
886EXPORT_SYMBOL(kset_unregister);