blob: 2c6490370922ccddf939db20e6bf0b71fcbf9526 [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),
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -080093 kobj, __FUNCTION__, 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 Sieversaf5ca3f2007-12-20 02:09:39 +0100166 if (!kobj->name || !kobj->name[0]) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100167 pr_debug("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 WARN_ON(1);
170 return -EINVAL;
171 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100172
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 parent = kobject_get(kobj->parent);
174
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100175 /* join kset if set, use it as parent if we do not already have one */
176 if (kobj->kset) {
177 if (!parent)
178 parent = kobject_get(&kobj->kset->kobj);
179 kobj_kset_join(kobj);
180 kobj->parent = parent;
181 }
182
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800183 pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
184 kobject_name(kobj), kobj, __FUNCTION__,
185 parent ? kobject_name(parent) : "<NULL>",
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800186 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900188 error = create_dir(kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 if (error) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100190 kobj_kset_leave(kobj);
191 kobject_put(parent);
192 kobj->parent = NULL;
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800193
194 /* be noisy on error issues */
195 if (error == -EEXIST)
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700196 printk(KERN_ERR "%s failed for %s with "
Greg Kroah-Hartman5c73a3f2007-06-07 15:05:15 -0700197 "-EEXIST, don't try to register things with "
198 "the same name in the same directory.\n",
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700199 __FUNCTION__, kobject_name(kobj));
Greg Kroah-Hartmandcd0da02006-03-20 13:17:13 -0800200 else
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700201 printk(KERN_ERR "%s failed for %s (%d)\n",
202 __FUNCTION__, kobject_name(kobj), error);
Greg Kroah-Hartman5c73a3f2007-06-07 15:05:15 -0700203 dump_stack();
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100204 } else
205 kobj->state_in_sysfs = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206
207 return error;
208}
209
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700210/**
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500211 * kobject_set_name_vargs - Set the name of an kobject
212 * @kobj: struct kobject to set the name of
Greg Kroah-Hartman8c4606b2007-12-04 14:45:47 +0800213 * @fmt: format string used to build the name
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500214 * @vargs: vargs to format the string.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 */
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500216static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
217 va_list vargs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218{
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500219 va_list aq;
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700220 char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500222 va_copy(aq, vargs);
223 name = kvasprintf(GFP_KERNEL, fmt, vargs);
224 va_end(aq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500226 if (!name)
227 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229 /* Free the old name, if necessary. */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100230 kfree(kobj->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
232 /* Now, set the new name */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100233 kobj->name = name;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500234
235 return 0;
236}
237
238/**
239 * kobject_set_name - Set the name of a kobject
240 * @kobj: struct kobject to set the name of
241 * @fmt: format string used to build the name
242 *
243 * This sets the name of the kobject. If you have already added the
244 * kobject to the system, you must call kobject_rename() in order to
245 * change the name of the kobject.
246 */
247int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
248{
249 va_list args;
250 int retval;
251
252 va_start(args, fmt);
253 retval = kobject_set_name_vargs(kobj, fmt, args);
254 va_end(args);
255
256 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258EXPORT_SYMBOL(kobject_set_name);
259
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700261 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800262 * @kobj: pointer to the kobject to initialize
263 * @ktype: pointer to the ktype for this kobject.
264 *
265 * This function will properly initialize a kobject such that it can then
266 * be passed to the kobject_add() call.
267 *
268 * After this function is called, the kobject MUST be cleaned up by a call
269 * to kobject_put(), not by a call to kfree directly to ensure that all of
270 * the memory is cleaned up properly.
271 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700272void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800273{
274 char *err_str;
275
276 if (!kobj) {
277 err_str = "invalid kobject pointer!";
278 goto error;
279 }
280 if (!ktype) {
281 err_str = "must have a ktype to be initialized properly!\n";
282 goto error;
283 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100284 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800285 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100286 printk(KERN_ERR "kobject (%p): tried to init an initialized "
287 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800288 dump_stack();
289 }
290
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800291 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800292 kobj->ktype = ktype;
293 return;
294
295error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100296 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800297 dump_stack();
298}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700299EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800300
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800301static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
302 const char *fmt, va_list vargs)
303{
304 va_list aq;
305 int retval;
306
307 va_copy(aq, vargs);
308 retval = kobject_set_name_vargs(kobj, fmt, aq);
309 va_end(aq);
310 if (retval) {
311 printk(KERN_ERR "kobject: can not set name properly!\n");
312 return retval;
313 }
314 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700315 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800316}
317
318/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700319 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800320 * @kobj: the kobject to add
321 * @parent: pointer to the parent of the kobject.
322 * @fmt: format to name the kobject with.
323 *
324 * The kobject name is set and added to the kobject hierarchy in this
325 * function.
326 *
327 * If @parent is set, then the parent of the @kobj will be set to it.
328 * If @parent is NULL, then the parent of the @kobj will be set to the
329 * kobject associted with the kset assigned to this kobject. If no kset
330 * is assigned to the kobject, then the kobject will be located in the
331 * root of the sysfs tree.
332 *
333 * If this function returns an error, kobject_put() must be called to
334 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800335 * Under no instance should the kobject that is passed to this function
336 * be directly freed with a call to kfree(), that can leak memory.
337 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100338 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800339 * up all of the necessary sysfs files for the object and then call
340 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
341 * userspace is properly notified of this kobject's creation.
342 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700343int kobject_add(struct kobject *kobj, struct kobject *parent,
344 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800345{
346 va_list args;
347 int retval;
348
349 if (!kobj)
350 return -EINVAL;
351
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100352 if (!kobj->state_initialized) {
353 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
354 "uninitialized object, something is seriously wrong.\n",
355 kobject_name(kobj), kobj);
356 dump_stack();
357 return -EINVAL;
358 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800359 va_start(args, fmt);
360 retval = kobject_add_varg(kobj, parent, fmt, args);
361 va_end(args);
362
363 return retval;
364}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700365EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800366
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800367/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800368 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
369 * @kobj: pointer to the kobject to initialize
370 * @ktype: pointer to the ktype for this kobject.
371 * @parent: pointer to the parent of this kobject.
372 * @fmt: the name of the kobject.
373 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700374 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700375 * kobject_add(). The same type of error handling after a call to
376 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800377 */
378int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
379 struct kobject *parent, const char *fmt, ...)
380{
381 va_list args;
382 int retval;
383
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700384 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800385
386 va_start(args, fmt);
387 retval = kobject_add_varg(kobj, parent, fmt, args);
388 va_end(args);
389
390 return retval;
391}
392EXPORT_SYMBOL_GPL(kobject_init_and_add);
393
394/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800395 * kobject_rename - change the name of an object
396 * @kobj: object in question.
397 * @new_name: object's new name
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;
403 char *devpath_string = NULL;
404 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405
406 kobj = kobject_get(kobj);
407 if (!kobj)
408 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700409 if (!kobj->parent)
410 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800411
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700412 /* see if this name is already in use */
413 if (kobj->kset) {
414 struct kobject *temp_kobj;
415 temp_kobj = kset_find_obj(kobj->kset, new_name);
416 if (temp_kobj) {
Johannes Berg71409a42007-11-05 13:59:11 +0100417 printk(KERN_WARNING "kobject '%s' cannot be renamed "
418 "to '%s' as '%s' is already in existence.\n",
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700419 kobject_name(kobj), new_name, new_name);
420 kobject_put(temp_kobj);
421 return -EINVAL;
422 }
423 }
424
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800425 devpath = kobject_get_path(kobj, GFP_KERNEL);
426 if (!devpath) {
427 error = -ENOMEM;
428 goto out;
429 }
430 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
431 if (!devpath_string) {
432 error = -ENOMEM;
433 goto out;
434 }
435 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
436 envp[0] = devpath_string;
437 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800438
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900439 error = sysfs_rename_dir(kobj, new_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. */
444 if (!error)
445 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
446
447out:
448 kfree(devpath_string);
449 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700450 kobject_put(kobj);
451
452 return error;
453}
454
455/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800456 * kobject_move - move object to another parent
457 * @kobj: object in question.
458 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100459 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100460int kobject_move(struct kobject *kobj, struct kobject *new_parent)
461{
462 int error;
463 struct kobject *old_parent;
464 const char *devpath = NULL;
465 char *devpath_string = NULL;
466 char *envp[2];
467
468 kobj = kobject_get(kobj);
469 if (!kobj)
470 return -EINVAL;
471 new_parent = kobject_get(new_parent);
472 if (!new_parent) {
Cornelia Huckc744aeae2007-01-08 20:16:44 +0100473 if (kobj->kset)
474 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100475 }
476 /* old object path */
477 devpath = kobject_get_path(kobj, GFP_KERNEL);
478 if (!devpath) {
479 error = -ENOMEM;
480 goto out;
481 }
482 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
483 if (!devpath_string) {
484 error = -ENOMEM;
485 goto out;
486 }
487 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
488 envp[0] = devpath_string;
489 envp[1] = NULL;
490 error = sysfs_move_dir(kobj, new_parent);
491 if (error)
492 goto out;
493 old_parent = kobj->parent;
494 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300495 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100496 kobject_put(old_parent);
497 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
498out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300499 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100500 kobject_put(kobj);
501 kfree(devpath_string);
502 kfree(devpath);
503 return error;
504}
505
506/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800507 * kobject_del - unlink kobject from hierarchy.
508 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800510void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800512 if (!kobj)
513 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 sysfs_remove_dir(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100516 kobj->state_in_sysfs = 0;
517 kobj_kset_leave(kobj);
518 kobject_put(kobj->parent);
519 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520}
521
522/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800523 * kobject_get - increment refcount for object.
524 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800526struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
528 if (kobj)
529 kref_get(&kobj->kref);
530 return kobj;
531}
532
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800533/*
534 * kobject_cleanup - free kobject resources.
535 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800537static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100539 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100540 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800542 pr_debug("kobject: '%s' (%p): %s\n",
543 kobject_name(kobj), kobj, __FUNCTION__);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100544
545 if (t && !t->release)
546 pr_debug("kobject: '%s' (%p): does not have a release() "
547 "function, it is broken and must be fixed.\n",
548 kobject_name(kobj), kobj);
549
550 /* send "remove" if the caller did not do it but sent "add" */
551 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
552 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
553 kobject_name(kobj), kobj);
554 kobject_uevent(kobj, KOBJ_REMOVE);
555 }
556
557 /* remove from sysfs if the caller did not do it */
558 if (kobj->state_in_sysfs) {
559 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
560 kobject_name(kobj), kobj);
561 kobject_del(kobj);
562 }
563
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700564 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100565 pr_debug("kobject: '%s' (%p): calling ktype release\n",
566 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100568 }
569
570 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100571 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100572 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700573 kfree(name);
574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575}
576
577static void kobject_release(struct kref *kref)
578{
579 kobject_cleanup(container_of(kref, struct kobject, kref));
580}
581
582/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800583 * kobject_put - decrement refcount for object.
584 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800586 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800588void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800590 if (kobj) {
591 if (!kobj->state_initialized) {
592 printk(KERN_WARNING "kobject: '%s' (%p): is not "
593 "initialized, yet kobject_put() is being "
594 "called.\n", kobject_name(kobj), kobj);
595 WARN_ON(1);
596 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800598 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599}
600
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800601static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500602{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100603 pr_debug("kobject: (%p): %s\n", kobj, __FUNCTION__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500604 kfree(kobj);
605}
606
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800607static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100608 .release = dynamic_kobj_release,
609 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500610};
611
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800612/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800613 * kobject_create - create a struct kobject dynamically
614 *
615 * This function creates a kobject structure dynamically and sets it up
616 * to be a "dynamic" kobject with a default release function set up.
617 *
618 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800619 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700620 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800621 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800622 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800623struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800624{
625 struct kobject *kobj;
626
627 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
628 if (!kobj)
629 return NULL;
630
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700631 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800632 return kobj;
633}
634
635/**
636 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
637 *
638 * @name: the name for the kset
639 * @parent: the parent kobject of this kobject, if any.
640 *
Dave Youngf70701a2008-01-28 16:58:00 +0800641 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800642 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800643 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800644 * it is no longer being used.
645 *
646 * If the kobject was not able to be created, NULL will be returned.
647 */
648struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
649{
650 struct kobject *kobj;
651 int retval;
652
653 kobj = kobject_create();
654 if (!kobj)
655 return NULL;
656
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700657 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800658 if (retval) {
659 printk(KERN_WARNING "%s: kobject_add error: %d\n",
660 __FUNCTION__, retval);
661 kobject_put(kobj);
662 kobj = NULL;
663 }
664 return kobj;
665}
666EXPORT_SYMBOL_GPL(kobject_create_and_add);
667
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500668/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800669 * kset_init - initialize a kset for use
670 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800672void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700674 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 INIT_LIST_HEAD(&k->list);
676 spin_lock_init(&k->list_lock);
677}
678
Kay Sievers23b52122007-11-02 13:47:53 +0100679/* default kobject attribute operations */
680static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
681 char *buf)
682{
683 struct kobj_attribute *kattr;
684 ssize_t ret = -EIO;
685
686 kattr = container_of(attr, struct kobj_attribute, attr);
687 if (kattr->show)
688 ret = kattr->show(kobj, kattr, buf);
689 return ret;
690}
691
692static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
693 const char *buf, size_t count)
694{
695 struct kobj_attribute *kattr;
696 ssize_t ret = -EIO;
697
698 kattr = container_of(attr, struct kobj_attribute, attr);
699 if (kattr->store)
700 ret = kattr->store(kobj, kattr, buf, count);
701 return ret;
702}
703
704struct sysfs_ops kobj_sysfs_ops = {
705 .show = kobj_attr_show,
706 .store = kobj_attr_store,
707};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
709/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800710 * kset_register - initialize and add a kset.
711 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800713int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714{
Kay Sievers80f03e32007-05-26 11:21:36 +0200715 int err;
716
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800717 if (!k)
718 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200719
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700721 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200722 if (err)
723 return err;
724 kobject_uevent(&k->kobj, KOBJ_ADD);
725 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726}
727
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800729 * kset_unregister - remove a kset.
730 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800732void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733{
Greg Kroah-Hartman31b9025a2007-01-18 12:23:51 -0800734 if (!k)
735 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800736 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737}
738
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800740 * kset_find_obj - search for object in kset.
741 * @kset: kset we're looking in.
742 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800744 * Lock kset via @kset->subsys, and iterate over @kset->list,
745 * looking for a matching kobject. If matching object is found
746 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800748struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400750 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800751 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752
753 spin_lock(&kset->list_lock);
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400754 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800755 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 ret = kobject_get(k);
757 break;
758 }
759 }
760 spin_unlock(&kset->list_lock);
761 return ret;
762}
763
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700764static void kset_release(struct kobject *kobj)
765{
766 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800767 pr_debug("kobject: '%s' (%p): %s\n",
768 kobject_name(kobj), kobj, __FUNCTION__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700769 kfree(kset);
770}
771
Kay Sievers386f2752007-11-02 13:47:53 +0100772static struct kobj_type kset_ktype = {
773 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700774 .release = kset_release,
775};
776
777/**
778 * kset_create - create a struct kset dynamically
779 *
780 * @name: the name for the kset
781 * @uevent_ops: a struct kset_uevent_ops for the kset
782 * @parent_kobj: the parent kobject of this kset, if any.
783 *
784 * This function creates a kset structure dynamically. This structure can
785 * then be registered with the system and show up in sysfs with a call to
786 * kset_register(). When you are finished with this structure, if
787 * kset_register() has been called, call kset_unregister() and the
788 * structure will be dynamically freed when it is no longer being used.
789 *
790 * If the kset was not able to be created, NULL will be returned.
791 */
792static struct kset *kset_create(const char *name,
793 struct kset_uevent_ops *uevent_ops,
794 struct kobject *parent_kobj)
795{
796 struct kset *kset;
797
798 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
799 if (!kset)
800 return NULL;
801 kobject_set_name(&kset->kobj, name);
802 kset->uevent_ops = uevent_ops;
803 kset->kobj.parent = parent_kobj;
804
805 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100806 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700807 * no kset itself. That way we can properly free it when it is
808 * finished being used.
809 */
Kay Sievers386f2752007-11-02 13:47:53 +0100810 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700811 kset->kobj.kset = NULL;
812
813 return kset;
814}
815
816/**
817 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
818 *
819 * @name: the name for the kset
820 * @uevent_ops: a struct kset_uevent_ops for the kset
821 * @parent_kobj: the parent kobject of this kset, if any.
822 *
823 * This function creates a kset structure dynamically and registers it
824 * with sysfs. When you are finished with this structure, call
825 * kset_unregister() and the structure will be dynamically freed when it
826 * is no longer being used.
827 *
828 * If the kset was not able to be created, NULL will be returned.
829 */
830struct kset *kset_create_and_add(const char *name,
831 struct kset_uevent_ops *uevent_ops,
832 struct kobject *parent_kobj)
833{
834 struct kset *kset;
835 int error;
836
837 kset = kset_create(name, uevent_ops, parent_kobj);
838 if (!kset)
839 return NULL;
840 error = kset_register(kset);
841 if (error) {
842 kfree(kset);
843 return NULL;
844 }
845 return kset;
846}
847EXPORT_SYMBOL_GPL(kset_create_and_add);
848
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849EXPORT_SYMBOL(kobject_get);
850EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851EXPORT_SYMBOL(kobject_del);
852
853EXPORT_SYMBOL(kset_register);
854EXPORT_SYMBOL(kset_unregister);