blob: fbf0ae28237672a6fafdbbf29e481d76c45ddd11 [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 ... */
Ingo Oeser25fdeb32008-07-23 01:25:01 +0200226 while ((s = strchr(kobj->name, '/')))
Kay Sievers9f255652008-05-06 22:24:04 +0200227 s[0] = '!';
228
229 kfree(old_name);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500230 return 0;
231}
232
233/**
234 * kobject_set_name - Set the name of a kobject
235 * @kobj: struct kobject to set the name of
236 * @fmt: format string used to build the name
237 *
238 * This sets the name of the kobject. If you have already added the
239 * kobject to the system, you must call kobject_rename() in order to
240 * change the name of the kobject.
241 */
242int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
243{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200244 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500245 int retval;
246
Kay Sieversa4ca6612008-04-30 02:06:29 +0200247 va_start(vargs, fmt);
248 retval = kobject_set_name_vargs(kobj, fmt, vargs);
249 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500250
251 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253EXPORT_SYMBOL(kobject_set_name);
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700256 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800257 * @kobj: pointer to the kobject to initialize
258 * @ktype: pointer to the ktype for this kobject.
259 *
260 * This function will properly initialize a kobject such that it can then
261 * be passed to the kobject_add() call.
262 *
263 * After this function is called, the kobject MUST be cleaned up by a call
264 * to kobject_put(), not by a call to kfree directly to ensure that all of
265 * the memory is cleaned up properly.
266 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700267void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800268{
269 char *err_str;
270
271 if (!kobj) {
272 err_str = "invalid kobject pointer!";
273 goto error;
274 }
275 if (!ktype) {
276 err_str = "must have a ktype to be initialized properly!\n";
277 goto error;
278 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100279 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800280 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100281 printk(KERN_ERR "kobject (%p): tried to init an initialized "
282 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800283 dump_stack();
284 }
285
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800286 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800287 kobj->ktype = ktype;
288 return;
289
290error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100291 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800292 dump_stack();
293}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700294EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800295
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800296static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
297 const char *fmt, va_list vargs)
298{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800299 int retval;
300
Kay Sieversa4ca6612008-04-30 02:06:29 +0200301 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800302 if (retval) {
303 printk(KERN_ERR "kobject: can not set name properly!\n");
304 return retval;
305 }
306 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700307 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800308}
309
310/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700311 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800312 * @kobj: the kobject to add
313 * @parent: pointer to the parent of the kobject.
314 * @fmt: format to name the kobject with.
315 *
316 * The kobject name is set and added to the kobject hierarchy in this
317 * function.
318 *
319 * If @parent is set, then the parent of the @kobj will be set to it.
320 * If @parent is NULL, then the parent of the @kobj will be set to the
321 * kobject associted with the kset assigned to this kobject. If no kset
322 * is assigned to the kobject, then the kobject will be located in the
323 * root of the sysfs tree.
324 *
325 * If this function returns an error, kobject_put() must be called to
326 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800327 * Under no instance should the kobject that is passed to this function
328 * be directly freed with a call to kfree(), that can leak memory.
329 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100330 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800331 * up all of the necessary sysfs files for the object and then call
332 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
333 * userspace is properly notified of this kobject's creation.
334 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700335int kobject_add(struct kobject *kobj, struct kobject *parent,
336 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800337{
338 va_list args;
339 int retval;
340
341 if (!kobj)
342 return -EINVAL;
343
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100344 if (!kobj->state_initialized) {
345 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
346 "uninitialized object, something is seriously wrong.\n",
347 kobject_name(kobj), kobj);
348 dump_stack();
349 return -EINVAL;
350 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800351 va_start(args, fmt);
352 retval = kobject_add_varg(kobj, parent, fmt, args);
353 va_end(args);
354
355 return retval;
356}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700357EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800358
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800359/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800360 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
361 * @kobj: pointer to the kobject to initialize
362 * @ktype: pointer to the ktype for this kobject.
363 * @parent: pointer to the parent of this kobject.
364 * @fmt: the name of the kobject.
365 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700366 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700367 * kobject_add(). The same type of error handling after a call to
368 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800369 */
370int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
371 struct kobject *parent, const char *fmt, ...)
372{
373 va_list args;
374 int retval;
375
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700376 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800377
378 va_start(args, fmt);
379 retval = kobject_add_varg(kobj, parent, fmt, args);
380 va_end(args);
381
382 return retval;
383}
384EXPORT_SYMBOL_GPL(kobject_init_and_add);
385
386/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800387 * kobject_rename - change the name of an object
388 * @kobj: object in question.
389 * @new_name: object's new name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800391int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392{
393 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800394 const char *devpath = NULL;
395 char *devpath_string = NULL;
396 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398 kobj = kobject_get(kobj);
399 if (!kobj)
400 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700401 if (!kobj->parent)
402 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800403
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700404 /* see if this name is already in use */
405 if (kobj->kset) {
406 struct kobject *temp_kobj;
407 temp_kobj = kset_find_obj(kobj->kset, new_name);
408 if (temp_kobj) {
Johannes Berg71409a42007-11-05 13:59:11 +0100409 printk(KERN_WARNING "kobject '%s' cannot be renamed "
410 "to '%s' as '%s' is already in existence.\n",
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700411 kobject_name(kobj), new_name, new_name);
412 kobject_put(temp_kobj);
413 return -EINVAL;
414 }
415 }
416
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800417 devpath = kobject_get_path(kobj, GFP_KERNEL);
418 if (!devpath) {
419 error = -ENOMEM;
420 goto out;
421 }
422 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
423 if (!devpath_string) {
424 error = -ENOMEM;
425 goto out;
426 }
427 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
428 envp[0] = devpath_string;
429 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800430
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900431 error = sysfs_rename_dir(kobj, new_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800432
433 /* This function is mostly/only used for network interface.
434 * Some hotplug package track interfaces by their name and
435 * therefore want to know when the name is changed by the user. */
436 if (!error)
437 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
438
439out:
440 kfree(devpath_string);
441 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700442 kobject_put(kobj);
443
444 return error;
445}
Alex Chiang8344b562008-06-10 15:30:42 -0600446EXPORT_SYMBOL_GPL(kobject_rename);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700447
448/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800449 * kobject_move - move object to another parent
450 * @kobj: object in question.
451 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100452 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100453int kobject_move(struct kobject *kobj, struct kobject *new_parent)
454{
455 int error;
456 struct kobject *old_parent;
457 const char *devpath = NULL;
458 char *devpath_string = NULL;
459 char *envp[2];
460
461 kobj = kobject_get(kobj);
462 if (!kobj)
463 return -EINVAL;
464 new_parent = kobject_get(new_parent);
465 if (!new_parent) {
Cornelia Huckc744aea2007-01-08 20:16:44 +0100466 if (kobj->kset)
467 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100468 }
469 /* old object path */
470 devpath = kobject_get_path(kobj, GFP_KERNEL);
471 if (!devpath) {
472 error = -ENOMEM;
473 goto out;
474 }
475 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
476 if (!devpath_string) {
477 error = -ENOMEM;
478 goto out;
479 }
480 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
481 envp[0] = devpath_string;
482 envp[1] = NULL;
483 error = sysfs_move_dir(kobj, new_parent);
484 if (error)
485 goto out;
486 old_parent = kobj->parent;
487 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300488 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100489 kobject_put(old_parent);
490 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
491out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300492 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100493 kobject_put(kobj);
494 kfree(devpath_string);
495 kfree(devpath);
496 return error;
497}
498
499/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800500 * kobject_del - unlink kobject from hierarchy.
501 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800503void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800505 if (!kobj)
506 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100507
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 sysfs_remove_dir(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100509 kobj->state_in_sysfs = 0;
510 kobj_kset_leave(kobj);
511 kobject_put(kobj->parent);
512 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513}
514
515/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800516 * kobject_get - increment refcount for object.
517 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800519struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520{
521 if (kobj)
522 kref_get(&kobj->kref);
523 return kobj;
524}
525
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800526/*
527 * kobject_cleanup - free kobject resources.
528 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800530static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100532 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100533 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800535 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700536 kobject_name(kobj), kobj, __func__);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100537
538 if (t && !t->release)
539 pr_debug("kobject: '%s' (%p): does not have a release() "
540 "function, it is broken and must be fixed.\n",
541 kobject_name(kobj), kobj);
542
543 /* send "remove" if the caller did not do it but sent "add" */
544 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
545 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
546 kobject_name(kobj), kobj);
547 kobject_uevent(kobj, KOBJ_REMOVE);
548 }
549
550 /* remove from sysfs if the caller did not do it */
551 if (kobj->state_in_sysfs) {
552 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
553 kobject_name(kobj), kobj);
554 kobject_del(kobj);
555 }
556
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700557 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100558 pr_debug("kobject: '%s' (%p): calling ktype release\n",
559 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100561 }
562
563 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100564 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100565 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700566 kfree(name);
567 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
569
570static void kobject_release(struct kref *kref)
571{
572 kobject_cleanup(container_of(kref, struct kobject, kref));
573}
574
575/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800576 * kobject_put - decrement refcount for object.
577 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800579 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800581void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800583 if (kobj) {
Arjan van de Vend955c782008-07-25 01:45:55 -0700584 if (!kobj->state_initialized)
585 WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800586 "initialized, yet kobject_put() is being "
587 "called.\n", kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800589 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590}
591
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800592static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500593{
Harvey Harrison810304d2008-04-30 00:55:08 -0700594 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500595 kfree(kobj);
596}
597
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800598static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100599 .release = dynamic_kobj_release,
600 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500601};
602
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800603/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800604 * kobject_create - create a struct kobject dynamically
605 *
606 * This function creates a kobject structure dynamically and sets it up
607 * to be a "dynamic" kobject with a default release function set up.
608 *
609 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800610 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700611 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800612 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800613 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800614struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800615{
616 struct kobject *kobj;
617
618 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
619 if (!kobj)
620 return NULL;
621
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700622 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800623 return kobj;
624}
625
626/**
627 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
628 *
629 * @name: the name for the kset
630 * @parent: the parent kobject of this kobject, if any.
631 *
Dave Youngf70701a2008-01-28 16:58:00 +0800632 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800633 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800634 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800635 * it is no longer being used.
636 *
637 * If the kobject was not able to be created, NULL will be returned.
638 */
639struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
640{
641 struct kobject *kobj;
642 int retval;
643
644 kobj = kobject_create();
645 if (!kobj)
646 return NULL;
647
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700648 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800649 if (retval) {
650 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700651 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800652 kobject_put(kobj);
653 kobj = NULL;
654 }
655 return kobj;
656}
657EXPORT_SYMBOL_GPL(kobject_create_and_add);
658
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500659/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800660 * kset_init - initialize a kset for use
661 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800663void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700665 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 INIT_LIST_HEAD(&k->list);
667 spin_lock_init(&k->list_lock);
668}
669
Kay Sievers23b52122007-11-02 13:47:53 +0100670/* default kobject attribute operations */
671static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
672 char *buf)
673{
674 struct kobj_attribute *kattr;
675 ssize_t ret = -EIO;
676
677 kattr = container_of(attr, struct kobj_attribute, attr);
678 if (kattr->show)
679 ret = kattr->show(kobj, kattr, buf);
680 return ret;
681}
682
683static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
684 const char *buf, size_t count)
685{
686 struct kobj_attribute *kattr;
687 ssize_t ret = -EIO;
688
689 kattr = container_of(attr, struct kobj_attribute, attr);
690 if (kattr->store)
691 ret = kattr->store(kobj, kattr, buf, count);
692 return ret;
693}
694
695struct sysfs_ops kobj_sysfs_ops = {
696 .show = kobj_attr_show,
697 .store = kobj_attr_store,
698};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800701 * kset_register - initialize and add a kset.
702 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800704int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705{
Kay Sievers80f03e32007-05-26 11:21:36 +0200706 int err;
707
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800708 if (!k)
709 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200710
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700712 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200713 if (err)
714 return err;
715 kobject_uevent(&k->kobj, KOBJ_ADD);
716 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717}
718
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800720 * kset_unregister - remove a kset.
721 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800723void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724{
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800725 if (!k)
726 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800727 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
729
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800731 * kset_find_obj - search for object in kset.
732 * @kset: kset we're looking in.
733 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800735 * Lock kset via @kset->subsys, and iterate over @kset->list,
736 * looking for a matching kobject. If matching object is found
737 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800739struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400741 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800742 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
744 spin_lock(&kset->list_lock);
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400745 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800746 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 ret = kobject_get(k);
748 break;
749 }
750 }
751 spin_unlock(&kset->list_lock);
752 return ret;
753}
754
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700755static void kset_release(struct kobject *kobj)
756{
757 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800758 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700759 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700760 kfree(kset);
761}
762
Kay Sievers386f2752007-11-02 13:47:53 +0100763static struct kobj_type kset_ktype = {
764 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700765 .release = kset_release,
766};
767
768/**
769 * kset_create - create a struct kset dynamically
770 *
771 * @name: the name for the kset
772 * @uevent_ops: a struct kset_uevent_ops for the kset
773 * @parent_kobj: the parent kobject of this kset, if any.
774 *
775 * This function creates a kset structure dynamically. This structure can
776 * then be registered with the system and show up in sysfs with a call to
777 * kset_register(). When you are finished with this structure, if
778 * kset_register() has been called, call kset_unregister() and the
779 * structure will be dynamically freed when it is no longer being used.
780 *
781 * If the kset was not able to be created, NULL will be returned.
782 */
783static struct kset *kset_create(const char *name,
784 struct kset_uevent_ops *uevent_ops,
785 struct kobject *parent_kobj)
786{
787 struct kset *kset;
788
789 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
790 if (!kset)
791 return NULL;
792 kobject_set_name(&kset->kobj, name);
793 kset->uevent_ops = uevent_ops;
794 kset->kobj.parent = parent_kobj;
795
796 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100797 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700798 * no kset itself. That way we can properly free it when it is
799 * finished being used.
800 */
Kay Sievers386f2752007-11-02 13:47:53 +0100801 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700802 kset->kobj.kset = NULL;
803
804 return kset;
805}
806
807/**
808 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
809 *
810 * @name: the name for the kset
811 * @uevent_ops: a struct kset_uevent_ops for the kset
812 * @parent_kobj: the parent kobject of this kset, if any.
813 *
814 * This function creates a kset structure dynamically and registers it
815 * with sysfs. When you are finished with this structure, call
816 * kset_unregister() and the structure will be dynamically freed when it
817 * is no longer being used.
818 *
819 * If the kset was not able to be created, NULL will be returned.
820 */
821struct kset *kset_create_and_add(const char *name,
822 struct kset_uevent_ops *uevent_ops,
823 struct kobject *parent_kobj)
824{
825 struct kset *kset;
826 int error;
827
828 kset = kset_create(name, uevent_ops, parent_kobj);
829 if (!kset)
830 return NULL;
831 error = kset_register(kset);
832 if (error) {
833 kfree(kset);
834 return NULL;
835 }
836 return kset;
837}
838EXPORT_SYMBOL_GPL(kset_create_and_add);
839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840EXPORT_SYMBOL(kobject_get);
841EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700842EXPORT_SYMBOL(kobject_del);
843
844EXPORT_SYMBOL(kset_register);
845EXPORT_SYMBOL(kset_unregister);