blob: 718e5101c263596224f7f35b523cea27e093ecd6 [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]) {
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",
Harvey Harrison810304d2008-04-30 00:55:08 -0700184 kobject_name(kobj), kobj, __func__,
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800185 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",
Harvey Harrison810304d2008-04-30 00:55:08 -0700199 __func__, 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",
Harvey Harrison810304d2008-04-30 00:55:08 -0700202 __func__, 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{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 /* Free the old name, if necessary. */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100220 kfree(kobj->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Kay Sieversa4ca6612008-04-30 02:06:29 +0200222 kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
223 if (!kobj->name)
224 return -ENOMEM;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500225
226 return 0;
227}
228
229/**
230 * kobject_set_name - Set the name of a kobject
231 * @kobj: struct kobject to set the name of
232 * @fmt: format string used to build the name
233 *
234 * This sets the name of the kobject. If you have already added the
235 * kobject to the system, you must call kobject_rename() in order to
236 * change the name of the kobject.
237 */
238int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
239{
Kay Sieversa4ca6612008-04-30 02:06:29 +0200240 va_list vargs;
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500241 int retval;
242
Kay Sieversa4ca6612008-04-30 02:06:29 +0200243 va_start(vargs, fmt);
244 retval = kobject_set_name_vargs(kobj, fmt, vargs);
245 va_end(vargs);
Greg Kroah-Hartman663a4742007-11-29 18:32:47 -0500246
247 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249EXPORT_SYMBOL(kobject_set_name);
250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251/**
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700252 * kobject_init - initialize a kobject structure
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800253 * @kobj: pointer to the kobject to initialize
254 * @ktype: pointer to the ktype for this kobject.
255 *
256 * This function will properly initialize a kobject such that it can then
257 * be passed to the kobject_add() call.
258 *
259 * After this function is called, the kobject MUST be cleaned up by a call
260 * to kobject_put(), not by a call to kfree directly to ensure that all of
261 * the memory is cleaned up properly.
262 */
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700263void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800264{
265 char *err_str;
266
267 if (!kobj) {
268 err_str = "invalid kobject pointer!";
269 goto error;
270 }
271 if (!ktype) {
272 err_str = "must have a ktype to be initialized properly!\n";
273 goto error;
274 }
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100275 if (kobj->state_initialized) {
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800276 /* do not error out as sometimes we can recover */
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100277 printk(KERN_ERR "kobject (%p): tried to init an initialized "
278 "object, something is seriously wrong.\n", kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800279 dump_stack();
280 }
281
Greg Kroah-Hartmana4573c42008-02-26 09:36:38 -0800282 kobject_init_internal(kobj);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800283 kobj->ktype = ktype;
284 return;
285
286error:
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100287 printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800288 dump_stack();
289}
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700290EXPORT_SYMBOL(kobject_init);
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800291
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800292static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
293 const char *fmt, va_list vargs)
294{
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800295 int retval;
296
Kay Sieversa4ca6612008-04-30 02:06:29 +0200297 retval = kobject_set_name_vargs(kobj, fmt, vargs);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800298 if (retval) {
299 printk(KERN_ERR "kobject: can not set name properly!\n");
300 return retval;
301 }
302 kobj->parent = parent;
Greg Kroah-Hartman9e7bbcc2007-12-17 23:05:35 -0700303 return kobject_add_internal(kobj);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800304}
305
306/**
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700307 * kobject_add - the main kobject add function
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800308 * @kobj: the kobject to add
309 * @parent: pointer to the parent of the kobject.
310 * @fmt: format to name the kobject with.
311 *
312 * The kobject name is set and added to the kobject hierarchy in this
313 * function.
314 *
315 * If @parent is set, then the parent of the @kobj will be set to it.
316 * If @parent is NULL, then the parent of the @kobj will be set to the
317 * kobject associted with the kset assigned to this kobject. If no kset
318 * is assigned to the kobject, then the kobject will be located in the
319 * root of the sysfs tree.
320 *
321 * If this function returns an error, kobject_put() must be called to
322 * properly clean up the memory associated with the object.
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800323 * Under no instance should the kobject that is passed to this function
324 * be directly freed with a call to kfree(), that can leak memory.
325 *
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100326 * Note, no "add" uevent will be created with this call, the caller should set
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800327 * up all of the necessary sysfs files for the object and then call
328 * kobject_uevent() with the UEVENT_ADD parameter to ensure that
329 * userspace is properly notified of this kobject's creation.
330 */
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700331int kobject_add(struct kobject *kobj, struct kobject *parent,
332 const char *fmt, ...)
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800333{
334 va_list args;
335 int retval;
336
337 if (!kobj)
338 return -EINVAL;
339
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100340 if (!kobj->state_initialized) {
341 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
342 "uninitialized object, something is seriously wrong.\n",
343 kobject_name(kobj), kobj);
344 dump_stack();
345 return -EINVAL;
346 }
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800347 va_start(args, fmt);
348 retval = kobject_add_varg(kobj, parent, fmt, args);
349 va_end(args);
350
351 return retval;
352}
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700353EXPORT_SYMBOL(kobject_add);
Greg Kroah-Hartman244f6ce2007-12-03 21:31:08 -0800354
Greg Kroah-Hartmane86000d2007-12-03 21:31:08 -0800355/**
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800356 * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
357 * @kobj: pointer to the kobject to initialize
358 * @ktype: pointer to the ktype for this kobject.
359 * @parent: pointer to the parent of this kobject.
360 * @fmt: the name of the kobject.
361 *
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700362 * This function combines the call to kobject_init() and
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700363 * kobject_add(). The same type of error handling after a call to
364 * kobject_add() and kobject lifetime rules are the same here.
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800365 */
366int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
367 struct kobject *parent, const char *fmt, ...)
368{
369 va_list args;
370 int retval;
371
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700372 kobject_init(kobj, ktype);
Greg Kroah-Hartmanc11c4152007-12-03 21:31:08 -0800373
374 va_start(args, fmt);
375 retval = kobject_add_varg(kobj, parent, fmt, args);
376 va_end(args);
377
378 return retval;
379}
380EXPORT_SYMBOL_GPL(kobject_init_and_add);
381
382/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800383 * kobject_rename - change the name of an object
384 * @kobj: object in question.
385 * @new_name: object's new name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800387int kobject_rename(struct kobject *kobj, const char *new_name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388{
389 int error = 0;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800390 const char *devpath = NULL;
391 char *devpath_string = NULL;
392 char *envp[2];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
394 kobj = kobject_get(kobj);
395 if (!kobj)
396 return -EINVAL;
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700397 if (!kobj->parent)
398 return -EINVAL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800399
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700400 /* see if this name is already in use */
401 if (kobj->kset) {
402 struct kobject *temp_kobj;
403 temp_kobj = kset_find_obj(kobj->kset, new_name);
404 if (temp_kobj) {
Johannes Berg71409a42007-11-05 13:59:11 +0100405 printk(KERN_WARNING "kobject '%s' cannot be renamed "
406 "to '%s' as '%s' is already in existence.\n",
Greg Kroah-Hartman34358c22007-10-24 16:52:31 -0700407 kobject_name(kobj), new_name, new_name);
408 kobject_put(temp_kobj);
409 return -EINVAL;
410 }
411 }
412
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800413 devpath = kobject_get_path(kobj, GFP_KERNEL);
414 if (!devpath) {
415 error = -ENOMEM;
416 goto out;
417 }
418 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
419 if (!devpath_string) {
420 error = -ENOMEM;
421 goto out;
422 }
423 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
424 envp[0] = devpath_string;
425 envp[1] = NULL;
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800426
Eric W. Biederman90bc6132007-07-31 19:15:08 +0900427 error = sysfs_rename_dir(kobj, new_name);
Jean Tourrilhesca2f37d2007-03-07 10:49:30 -0800428
429 /* This function is mostly/only used for network interface.
430 * Some hotplug package track interfaces by their name and
431 * therefore want to know when the name is changed by the user. */
432 if (!error)
433 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
434
435out:
436 kfree(devpath_string);
437 kfree(devpath);
Eric W. Biedermanb592fcf2007-01-24 12:35:52 -0700438 kobject_put(kobj);
439
440 return error;
441}
442
443/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800444 * kobject_move - move object to another parent
445 * @kobj: object in question.
446 * @new_parent: object's new parent (can be NULL)
Cornelia Huck8a824722006-11-20 17:07:51 +0100447 */
Cornelia Huck8a824722006-11-20 17:07:51 +0100448int kobject_move(struct kobject *kobj, struct kobject *new_parent)
449{
450 int error;
451 struct kobject *old_parent;
452 const char *devpath = NULL;
453 char *devpath_string = NULL;
454 char *envp[2];
455
456 kobj = kobject_get(kobj);
457 if (!kobj)
458 return -EINVAL;
459 new_parent = kobject_get(new_parent);
460 if (!new_parent) {
Cornelia Huckc744aea2007-01-08 20:16:44 +0100461 if (kobj->kset)
462 new_parent = kobject_get(&kobj->kset->kobj);
Cornelia Huck8a824722006-11-20 17:07:51 +0100463 }
464 /* old object path */
465 devpath = kobject_get_path(kobj, GFP_KERNEL);
466 if (!devpath) {
467 error = -ENOMEM;
468 goto out;
469 }
470 devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
471 if (!devpath_string) {
472 error = -ENOMEM;
473 goto out;
474 }
475 sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
476 envp[0] = devpath_string;
477 envp[1] = NULL;
478 error = sysfs_move_dir(kobj, new_parent);
479 if (error)
480 goto out;
481 old_parent = kobj->parent;
482 kobj->parent = new_parent;
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300483 new_parent = NULL;
Cornelia Huck8a824722006-11-20 17:07:51 +0100484 kobject_put(old_parent);
485 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
486out:
Dmitriy Monakhov9e993ef2007-03-03 16:11:21 +0300487 kobject_put(new_parent);
Cornelia Huck8a824722006-11-20 17:07:51 +0100488 kobject_put(kobj);
489 kfree(devpath_string);
490 kfree(devpath);
491 return error;
492}
493
494/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800495 * kobject_del - unlink kobject from hierarchy.
496 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800498void kobject_del(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499{
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800500 if (!kobj)
501 return;
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100502
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 sysfs_remove_dir(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100504 kobj->state_in_sysfs = 0;
505 kobj_kset_leave(kobj);
506 kobject_put(kobj->parent);
507 kobj->parent = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508}
509
510/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800511 * kobject_get - increment refcount for object.
512 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800514struct kobject *kobject_get(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515{
516 if (kobj)
517 kref_get(&kobj->kref);
518 return kobj;
519}
520
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800521/*
522 * kobject_cleanup - free kobject resources.
523 * @kobj: object to cleanup
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 */
Greg Kroah-Hartman18041f42007-12-03 21:31:08 -0800525static void kobject_cleanup(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100527 struct kobj_type *t = get_ktype(kobj);
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100528 const char *name = kobj->name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800530 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700531 kobject_name(kobj), kobj, __func__);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100532
533 if (t && !t->release)
534 pr_debug("kobject: '%s' (%p): does not have a release() "
535 "function, it is broken and must be fixed.\n",
536 kobject_name(kobj), kobj);
537
538 /* send "remove" if the caller did not do it but sent "add" */
539 if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
540 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
541 kobject_name(kobj), kobj);
542 kobject_uevent(kobj, KOBJ_REMOVE);
543 }
544
545 /* remove from sysfs if the caller did not do it */
546 if (kobj->state_in_sysfs) {
547 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
548 kobject_name(kobj), kobj);
549 kobject_del(kobj);
550 }
551
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700552 if (t && t->release) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100553 pr_debug("kobject: '%s' (%p): calling ktype release\n",
554 kobject_name(kobj), kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 t->release(kobj);
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100556 }
557
558 /* free name if we allocated it */
Kay Sieversaf5ca3f2007-12-20 02:09:39 +0100559 if (name) {
Kay Sievers0f4dafc2007-12-19 01:40:42 +0100560 pr_debug("kobject: '%s': free name\n", name);
Greg Kroah-Hartmance2c9cb2007-09-12 15:06:57 -0700561 kfree(name);
562 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563}
564
565static void kobject_release(struct kref *kref)
566{
567 kobject_cleanup(container_of(kref, struct kobject, kref));
568}
569
570/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800571 * kobject_put - decrement refcount for object.
572 * @kobj: object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800574 * Decrement the refcount, and if 0, call kobject_cleanup().
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800576void kobject_put(struct kobject *kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577{
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800578 if (kobj) {
579 if (!kobj->state_initialized) {
580 printk(KERN_WARNING "kobject: '%s' (%p): is not "
581 "initialized, yet kobject_put() is being "
582 "called.\n", kobject_name(kobj), kobj);
583 WARN_ON(1);
584 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 kref_put(&kobj->kref, kobject_release);
Greg Kroah-Hartmanc1ebdae2008-02-26 09:36:38 -0800586 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587}
588
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800589static void dynamic_kobj_release(struct kobject *kobj)
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500590{
Harvey Harrison810304d2008-04-30 00:55:08 -0700591 pr_debug("kobject: (%p): %s\n", kobj, __func__);
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500592 kfree(kobj);
593}
594
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800595static struct kobj_type dynamic_kobj_ktype = {
Kay Sievers386f2752007-11-02 13:47:53 +0100596 .release = dynamic_kobj_release,
597 .sysfs_ops = &kobj_sysfs_ops,
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500598};
599
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800600/**
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800601 * kobject_create - create a struct kobject dynamically
602 *
603 * This function creates a kobject structure dynamically and sets it up
604 * to be a "dynamic" kobject with a default release function set up.
605 *
606 * If the kobject was not able to be created, NULL will be returned.
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800607 * The kobject structure returned from here must be cleaned up with a
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700608 * call to kobject_put() and not kfree(), as kobject_init() has
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800609 * already been called on this structure.
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800610 */
Greg Kroah-Hartman43968d22007-11-05 22:24:43 -0800611struct kobject *kobject_create(void)
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800612{
613 struct kobject *kobj;
614
615 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
616 if (!kobj)
617 return NULL;
618
Greg Kroah-Hartmanf9cb0742007-12-17 23:05:35 -0700619 kobject_init(kobj, &dynamic_kobj_ktype);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800620 return kobj;
621}
622
623/**
624 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
625 *
626 * @name: the name for the kset
627 * @parent: the parent kobject of this kobject, if any.
628 *
Dave Youngf70701a2008-01-28 16:58:00 +0800629 * This function creates a kobject structure dynamically and registers it
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800630 * with sysfs. When you are finished with this structure, call
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800631 * kobject_put() and the structure will be dynamically freed when
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800632 * it is no longer being used.
633 *
634 * If the kobject was not able to be created, NULL will be returned.
635 */
636struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
637{
638 struct kobject *kobj;
639 int retval;
640
641 kobj = kobject_create();
642 if (!kobj)
643 return NULL;
644
Greg Kroah-Hartmanb2d6db52007-12-17 23:05:35 -0700645 retval = kobject_add(kobj, parent, "%s", name);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800646 if (retval) {
647 printk(KERN_WARNING "%s: kobject_add error: %d\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700648 __func__, retval);
Greg Kroah-Hartman3f9e3ee2007-11-05 13:16:15 -0800649 kobject_put(kobj);
650 kobj = NULL;
651 }
652 return kobj;
653}
654EXPORT_SYMBOL_GPL(kobject_create_and_add);
655
Jun'ichi Nomura74231722006-03-13 17:14:25 -0500656/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800657 * kset_init - initialize a kset for use
658 * @k: kset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800660void kset_init(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661{
Greg Kroah-Hartmane1543dd2007-12-17 23:05:35 -0700662 kobject_init_internal(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 INIT_LIST_HEAD(&k->list);
664 spin_lock_init(&k->list_lock);
665}
666
Kay Sievers23b52122007-11-02 13:47:53 +0100667/* default kobject attribute operations */
668static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
669 char *buf)
670{
671 struct kobj_attribute *kattr;
672 ssize_t ret = -EIO;
673
674 kattr = container_of(attr, struct kobj_attribute, attr);
675 if (kattr->show)
676 ret = kattr->show(kobj, kattr, buf);
677 return ret;
678}
679
680static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
681 const char *buf, size_t count)
682{
683 struct kobj_attribute *kattr;
684 ssize_t ret = -EIO;
685
686 kattr = container_of(attr, struct kobj_attribute, attr);
687 if (kattr->store)
688 ret = kattr->store(kobj, kattr, buf, count);
689 return ret;
690}
691
692struct sysfs_ops kobj_sysfs_ops = {
693 .show = kobj_attr_show,
694 .store = kobj_attr_store,
695};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696
697/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800698 * kset_register - initialize and add a kset.
699 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800701int kset_register(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
Kay Sievers80f03e32007-05-26 11:21:36 +0200703 int err;
704
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800705 if (!k)
706 return -EINVAL;
Kay Sievers80f03e32007-05-26 11:21:36 +0200707
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 kset_init(k);
Greg Kroah-Hartman12e339a2002-04-09 12:14:34 -0700709 err = kobject_add_internal(&k->kobj);
Kay Sievers80f03e32007-05-26 11:21:36 +0200710 if (err)
711 return err;
712 kobject_uevent(&k->kobj, KOBJ_ADD);
713 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714}
715
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800717 * kset_unregister - remove a kset.
718 * @k: kset.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800720void kset_unregister(struct kset *k)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721{
Greg Kroah-Hartman31b90252007-01-18 12:23:51 -0800722 if (!k)
723 return;
Greg Kroah-Hartman78a2d902007-12-20 08:13:05 -0800724 kobject_put(&k->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725}
726
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727/**
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800728 * kset_find_obj - search for object in kset.
729 * @kset: kset we're looking in.
730 * @name: object's name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 *
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800732 * Lock kset via @kset->subsys, and iterate over @kset->list,
733 * looking for a matching kobject. If matching object is found
734 * take a reference and return the object.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 */
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800736struct kobject *kset_find_obj(struct kset *kset, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737{
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400738 struct kobject *k;
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800739 struct kobject *ret = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
741 spin_lock(&kset->list_lock);
Robert P. J. Dayc6a2a3d2008-03-27 01:13:34 -0400742 list_for_each_entry(k, &kset->list, entry) {
Greg Kroah-Hartmane374a2b2008-01-24 21:59:04 -0800743 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 ret = kobject_get(k);
745 break;
746 }
747 }
748 spin_unlock(&kset->list_lock);
749 return ret;
750}
751
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700752static void kset_release(struct kobject *kobj)
753{
754 struct kset *kset = container_of(kobj, struct kset, kobj);
Greg Kroah-Hartman9f66fa22007-11-28 23:49:41 -0800755 pr_debug("kobject: '%s' (%p): %s\n",
Harvey Harrison810304d2008-04-30 00:55:08 -0700756 kobject_name(kobj), kobj, __func__);
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700757 kfree(kset);
758}
759
Kay Sievers386f2752007-11-02 13:47:53 +0100760static struct kobj_type kset_ktype = {
761 .sysfs_ops = &kobj_sysfs_ops,
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700762 .release = kset_release,
763};
764
765/**
766 * kset_create - create a struct kset dynamically
767 *
768 * @name: the name for the kset
769 * @uevent_ops: a struct kset_uevent_ops for the kset
770 * @parent_kobj: the parent kobject of this kset, if any.
771 *
772 * This function creates a kset structure dynamically. This structure can
773 * then be registered with the system and show up in sysfs with a call to
774 * kset_register(). When you are finished with this structure, if
775 * kset_register() has been called, call kset_unregister() and the
776 * structure will be dynamically freed when it is no longer being used.
777 *
778 * If the kset was not able to be created, NULL will be returned.
779 */
780static struct kset *kset_create(const char *name,
781 struct kset_uevent_ops *uevent_ops,
782 struct kobject *parent_kobj)
783{
784 struct kset *kset;
785
786 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
787 if (!kset)
788 return NULL;
789 kobject_set_name(&kset->kobj, name);
790 kset->uevent_ops = uevent_ops;
791 kset->kobj.parent = parent_kobj;
792
793 /*
Kay Sievers386f2752007-11-02 13:47:53 +0100794 * The kobject of this kset will have a type of kset_ktype and belong to
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700795 * no kset itself. That way we can properly free it when it is
796 * finished being used.
797 */
Kay Sievers386f2752007-11-02 13:47:53 +0100798 kset->kobj.ktype = &kset_ktype;
Greg Kroah-Hartmanb727c702007-09-27 14:48:53 -0700799 kset->kobj.kset = NULL;
800
801 return kset;
802}
803
804/**
805 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
806 *
807 * @name: the name for the kset
808 * @uevent_ops: a struct kset_uevent_ops for the kset
809 * @parent_kobj: the parent kobject of this kset, if any.
810 *
811 * This function creates a kset structure dynamically and registers it
812 * with sysfs. When you are finished with this structure, call
813 * kset_unregister() and the structure will be dynamically freed when it
814 * is no longer being used.
815 *
816 * If the kset was not able to be created, NULL will be returned.
817 */
818struct kset *kset_create_and_add(const char *name,
819 struct kset_uevent_ops *uevent_ops,
820 struct kobject *parent_kobj)
821{
822 struct kset *kset;
823 int error;
824
825 kset = kset_create(name, uevent_ops, parent_kobj);
826 if (!kset)
827 return NULL;
828 error = kset_register(kset);
829 if (error) {
830 kfree(kset);
831 return NULL;
832 }
833 return kset;
834}
835EXPORT_SYMBOL_GPL(kset_create_and_add);
836
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837EXPORT_SYMBOL(kobject_get);
838EXPORT_SYMBOL(kobject_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839EXPORT_SYMBOL(kobject_del);
840
841EXPORT_SYMBOL(kset_register);
842EXPORT_SYMBOL(kset_unregister);