Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * kobject.c - library routines for handling generic kernel objects |
| 3 | * |
| 4 | * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org> |
Greg Kroah-Hartman | f0e7e1b | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 5 | * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com> |
| 6 | * Copyright (c) 2006-2007 Novell Inc. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 7 | * |
| 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 Schmielau | 4e57b68 | 2005-10-30 15:03:48 -0800 | [diff] [blame] | 19 | #include <linux/slab.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | |
| 21 | /** |
| 22 | * populate_dir - populate directory with attributes. |
| 23 | * @kobj: object we're working on. |
| 24 | * |
| 25 | * Most subsystems have a set of default attributes that |
| 26 | * are associated with an object that registers with them. |
| 27 | * This is a helper called during object registration that |
| 28 | * loops through the default attributes of the subsystem |
| 29 | * and creates attributes files for them in sysfs. |
| 30 | * |
| 31 | */ |
| 32 | |
| 33 | static int populate_dir(struct kobject * kobj) |
| 34 | { |
| 35 | struct kobj_type * t = get_ktype(kobj); |
| 36 | struct attribute * attr; |
| 37 | int error = 0; |
| 38 | int i; |
| 39 | |
| 40 | if (t && t->default_attrs) { |
| 41 | for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) { |
| 42 | if ((error = sysfs_create_file(kobj,attr))) |
| 43 | break; |
| 44 | } |
| 45 | } |
| 46 | return error; |
| 47 | } |
| 48 | |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 49 | static int create_dir(struct kobject * kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | { |
| 51 | int error = 0; |
| 52 | if (kobject_name(kobj)) { |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 53 | error = sysfs_create_dir(kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 54 | if (!error) { |
| 55 | if ((error = populate_dir(kobj))) |
| 56 | sysfs_remove_dir(kobj); |
| 57 | } |
| 58 | } |
| 59 | return error; |
| 60 | } |
| 61 | |
| 62 | static inline struct kobject * to_kobj(struct list_head * entry) |
| 63 | { |
| 64 | return container_of(entry,struct kobject,entry); |
| 65 | } |
| 66 | |
| 67 | static int get_kobj_path_length(struct kobject *kobj) |
| 68 | { |
| 69 | int length = 1; |
| 70 | struct kobject * parent = kobj; |
| 71 | |
| 72 | /* walk up the ancestors until we hit the one pointing to the |
| 73 | * root. |
| 74 | * Add 1 to strlen for leading '/' of each level. |
| 75 | */ |
| 76 | do { |
Chuck Ebbert | b365b3d | 2006-01-12 20:02:00 -0500 | [diff] [blame] | 77 | if (kobject_name(parent) == NULL) |
| 78 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | length += strlen(kobject_name(parent)) + 1; |
| 80 | parent = parent->parent; |
| 81 | } while (parent); |
| 82 | return length; |
| 83 | } |
| 84 | |
| 85 | static void fill_kobj_path(struct kobject *kobj, char *path, int length) |
| 86 | { |
| 87 | struct kobject * parent; |
| 88 | |
| 89 | --length; |
| 90 | for (parent = kobj; parent; parent = parent->parent) { |
| 91 | int cur = strlen(kobject_name(parent)); |
| 92 | /* back up enough to print this name with '/' */ |
| 93 | length -= cur; |
| 94 | strncpy (path + length, kobject_name(parent), cur); |
| 95 | *(path + --length) = '/'; |
| 96 | } |
| 97 | |
| 98 | pr_debug("%s: path = '%s'\n",__FUNCTION__,path); |
| 99 | } |
| 100 | |
| 101 | /** |
Robert P. J. Day | 72fd4a3 | 2007-02-10 01:45:59 -0800 | [diff] [blame] | 102 | * kobject_get_path - generate and return the path associated with a given kobj and kset pair. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 103 | * |
| 104 | * @kobj: kobject in question, with which to build the path |
| 105 | * @gfp_mask: the allocation type used to allocate the path |
Robert P. J. Day | 72fd4a3 | 2007-02-10 01:45:59 -0800 | [diff] [blame] | 106 | * |
| 107 | * The result must be freed by the caller with kfree(). |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 108 | */ |
Al Viro | fd4f2df | 2005-10-21 03:18:50 -0400 | [diff] [blame] | 109 | char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | { |
| 111 | char *path; |
| 112 | int len; |
| 113 | |
| 114 | len = get_kobj_path_length(kobj); |
Chuck Ebbert | b365b3d | 2006-01-12 20:02:00 -0500 | [diff] [blame] | 115 | if (len == 0) |
| 116 | return NULL; |
Burman Yan | 4668edc | 2006-12-06 20:38:51 -0800 | [diff] [blame] | 117 | path = kzalloc(len, gfp_mask); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 118 | if (!path) |
| 119 | return NULL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 120 | fill_kobj_path(kobj, path, len); |
| 121 | |
| 122 | return path; |
| 123 | } |
Dmitry Torokhov | 80fc9f5 | 2006-10-11 01:43:58 -0400 | [diff] [blame] | 124 | EXPORT_SYMBOL_GPL(kobject_get_path); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | |
| 126 | /** |
| 127 | * kobject_init - initialize object. |
| 128 | * @kobj: object in question. |
| 129 | */ |
| 130 | void kobject_init(struct kobject * kobj) |
| 131 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 132 | if (!kobj) |
| 133 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | kref_init(&kobj->kref); |
| 135 | INIT_LIST_HEAD(&kobj->entry); |
| 136 | kobj->kset = kset_get(kobj->kset); |
| 137 | } |
| 138 | |
| 139 | |
| 140 | /** |
| 141 | * unlink - remove kobject from kset list. |
| 142 | * @kobj: kobject. |
| 143 | * |
| 144 | * Remove the kobject from the kset list and decrement |
| 145 | * its parent's refcount. |
| 146 | * This is separated out, so we can use it in both |
| 147 | * kobject_del() and kobject_add() on error. |
| 148 | */ |
| 149 | |
| 150 | static void unlink(struct kobject * kobj) |
| 151 | { |
| 152 | if (kobj->kset) { |
| 153 | spin_lock(&kobj->kset->list_lock); |
| 154 | list_del_init(&kobj->entry); |
| 155 | spin_unlock(&kobj->kset->list_lock); |
| 156 | } |
| 157 | kobject_put(kobj); |
| 158 | } |
| 159 | |
| 160 | /** |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 161 | * kobject_add - add an object to the hierarchy. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 162 | * @kobj: object. |
| 163 | */ |
| 164 | |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 165 | int kobject_add(struct kobject * kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 166 | { |
| 167 | int error = 0; |
| 168 | struct kobject * parent; |
| 169 | |
| 170 | if (!(kobj = kobject_get(kobj))) |
| 171 | return -ENOENT; |
| 172 | if (!kobj->k_name) |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 173 | kobject_set_name(kobj, "NO_NAME"); |
Martin Stoilov | 1350770 | 2007-02-05 16:15:23 -0800 | [diff] [blame] | 174 | if (!*kobj->k_name) { |
Greg Kroah-Hartman | c171fef | 2006-01-20 14:08:59 -0800 | [diff] [blame] | 175 | pr_debug("kobject attempted to be registered with no name!\n"); |
| 176 | WARN_ON(1); |
Cornelia Huck | 88db472 | 2007-04-10 14:35:27 +0200 | [diff] [blame] | 177 | kobject_put(kobj); |
Greg Kroah-Hartman | c171fef | 2006-01-20 14:08:59 -0800 | [diff] [blame] | 178 | return -EINVAL; |
| 179 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 180 | parent = kobject_get(kobj->parent); |
| 181 | |
| 182 | pr_debug("kobject %s: registering. parent: %s, set: %s\n", |
| 183 | kobject_name(kobj), parent ? kobject_name(parent) : "<NULL>", |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 184 | kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>" ); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 185 | |
| 186 | if (kobj->kset) { |
| 187 | spin_lock(&kobj->kset->list_lock); |
| 188 | |
| 189 | if (!parent) |
| 190 | parent = kobject_get(&kobj->kset->kobj); |
| 191 | |
| 192 | list_add_tail(&kobj->entry,&kobj->kset->list); |
| 193 | spin_unlock(&kobj->kset->list_lock); |
Dmitriy Monakhov | 460f7e9 | 2007-03-10 14:00:10 +0300 | [diff] [blame] | 194 | kobj->parent = parent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 195 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 196 | |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 197 | error = create_dir(kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 198 | if (error) { |
| 199 | /* unlink does the kobject_put() for us */ |
| 200 | unlink(kobj); |
Mariusz Kozlowski | b067db4 | 2007-01-02 13:44:44 +0100 | [diff] [blame] | 201 | kobject_put(parent); |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 202 | |
| 203 | /* be noisy on error issues */ |
| 204 | if (error == -EEXIST) |
Greg Kroah-Hartman | 5c73a3f | 2007-06-07 15:05:15 -0700 | [diff] [blame] | 205 | printk(KERN_ERR "kobject_add failed for %s with " |
| 206 | "-EEXIST, don't try to register things with " |
| 207 | "the same name in the same directory.\n", |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 208 | kobject_name(kobj)); |
| 209 | else |
Greg Kroah-Hartman | 5c73a3f | 2007-06-07 15:05:15 -0700 | [diff] [blame] | 210 | printk(KERN_ERR "kobject_add failed for %s (%d)\n", |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 211 | kobject_name(kobj), error); |
Greg Kroah-Hartman | 5c73a3f | 2007-06-07 15:05:15 -0700 | [diff] [blame] | 212 | dump_stack(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 213 | } |
| 214 | |
| 215 | return error; |
| 216 | } |
| 217 | |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 218 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 219 | * kobject_register - initialize and add an object. |
| 220 | * @kobj: object in question. |
| 221 | */ |
| 222 | |
| 223 | int kobject_register(struct kobject * kobj) |
| 224 | { |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 225 | int error = -EINVAL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 226 | if (kobj) { |
| 227 | kobject_init(kobj); |
| 228 | error = kobject_add(kobj); |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 229 | if (!error) |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 230 | kobject_uevent(kobj, KOBJ_ADD); |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 231 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | return error; |
| 233 | } |
| 234 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 235 | /** |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 236 | * kobject_set_name_vargs - Set the name of an kobject |
| 237 | * @kobj: struct kobject to set the name of |
Greg Kroah-Hartman | 8c4606b | 2007-12-04 14:45:47 +0800 | [diff] [blame] | 238 | * @fmt: format string used to build the name |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 239 | * @vargs: vargs to format the string. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | */ |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 241 | static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, |
| 242 | va_list vargs) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 243 | { |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 244 | va_list aq; |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 245 | char *name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 246 | |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 247 | va_copy(aq, vargs); |
| 248 | name = kvasprintf(GFP_KERNEL, fmt, vargs); |
| 249 | va_end(aq); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 250 | |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 251 | if (!name) |
| 252 | return -ENOMEM; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 253 | |
| 254 | /* Free the old name, if necessary. */ |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 255 | kfree(kobj->k_name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 256 | |
| 257 | /* Now, set the new name */ |
| 258 | kobj->k_name = name; |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 259 | |
| 260 | return 0; |
| 261 | } |
| 262 | |
| 263 | /** |
| 264 | * kobject_set_name - Set the name of a kobject |
| 265 | * @kobj: struct kobject to set the name of |
| 266 | * @fmt: format string used to build the name |
| 267 | * |
| 268 | * This sets the name of the kobject. If you have already added the |
| 269 | * kobject to the system, you must call kobject_rename() in order to |
| 270 | * change the name of the kobject. |
| 271 | */ |
| 272 | int kobject_set_name(struct kobject *kobj, const char *fmt, ...) |
| 273 | { |
| 274 | va_list args; |
| 275 | int retval; |
| 276 | |
| 277 | va_start(args, fmt); |
| 278 | retval = kobject_set_name_vargs(kobj, fmt, args); |
| 279 | va_end(args); |
| 280 | |
| 281 | return retval; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 282 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 283 | EXPORT_SYMBOL(kobject_set_name); |
| 284 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 285 | /** |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 286 | * kobject_init_ng - initialize a kobject structure |
| 287 | * @kobj: pointer to the kobject to initialize |
| 288 | * @ktype: pointer to the ktype for this kobject. |
| 289 | * |
| 290 | * This function will properly initialize a kobject such that it can then |
| 291 | * be passed to the kobject_add() call. |
| 292 | * |
| 293 | * After this function is called, the kobject MUST be cleaned up by a call |
| 294 | * to kobject_put(), not by a call to kfree directly to ensure that all of |
| 295 | * the memory is cleaned up properly. |
| 296 | */ |
| 297 | void kobject_init_ng(struct kobject *kobj, struct kobj_type *ktype) |
| 298 | { |
| 299 | char *err_str; |
| 300 | |
| 301 | if (!kobj) { |
| 302 | err_str = "invalid kobject pointer!"; |
| 303 | goto error; |
| 304 | } |
| 305 | if (!ktype) { |
| 306 | err_str = "must have a ktype to be initialized properly!\n"; |
| 307 | goto error; |
| 308 | } |
| 309 | if (atomic_read(&kobj->kref.refcount)) { |
| 310 | /* do not error out as sometimes we can recover */ |
| 311 | printk(KERN_ERR "kobject: reference count is already set, " |
| 312 | "something is seriously wrong.\n"); |
| 313 | dump_stack(); |
| 314 | } |
| 315 | |
| 316 | kref_init(&kobj->kref); |
| 317 | INIT_LIST_HEAD(&kobj->entry); |
| 318 | kobj->ktype = ktype; |
| 319 | return; |
| 320 | |
| 321 | error: |
| 322 | printk(KERN_ERR "kobject: %s\n", err_str); |
| 323 | dump_stack(); |
| 324 | } |
| 325 | EXPORT_SYMBOL(kobject_init_ng); |
| 326 | |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame^] | 327 | static int kobject_add_varg(struct kobject *kobj, struct kobject *parent, |
| 328 | const char *fmt, va_list vargs) |
| 329 | { |
| 330 | va_list aq; |
| 331 | int retval; |
| 332 | |
| 333 | va_copy(aq, vargs); |
| 334 | retval = kobject_set_name_vargs(kobj, fmt, aq); |
| 335 | va_end(aq); |
| 336 | if (retval) { |
| 337 | printk(KERN_ERR "kobject: can not set name properly!\n"); |
| 338 | return retval; |
| 339 | } |
| 340 | kobj->parent = parent; |
| 341 | return kobject_add(kobj); |
| 342 | } |
| 343 | |
| 344 | /** |
| 345 | * kobject_add_ng - the main kobject add function |
| 346 | * @kobj: the kobject to add |
| 347 | * @parent: pointer to the parent of the kobject. |
| 348 | * @fmt: format to name the kobject with. |
| 349 | * |
| 350 | * The kobject name is set and added to the kobject hierarchy in this |
| 351 | * function. |
| 352 | * |
| 353 | * If @parent is set, then the parent of the @kobj will be set to it. |
| 354 | * If @parent is NULL, then the parent of the @kobj will be set to the |
| 355 | * kobject associted with the kset assigned to this kobject. If no kset |
| 356 | * is assigned to the kobject, then the kobject will be located in the |
| 357 | * root of the sysfs tree. |
| 358 | * |
| 359 | * If this function returns an error, kobject_put() must be called to |
| 360 | * properly clean up the memory associated with the object. |
| 361 | * |
| 362 | * If the function is successful, the only way to properly clean up the |
| 363 | * memory is with a call to kobject_del(), in which case, a call to |
| 364 | * kobject_put() is not necessary (kobject_del() does the final |
| 365 | * kobject_put() to call the release function in the ktype's release |
| 366 | * pointer.) |
| 367 | * |
| 368 | * Under no instance should the kobject that is passed to this function |
| 369 | * be directly freed with a call to kfree(), that can leak memory. |
| 370 | * |
| 371 | * Note, no uevent will be created with this call, the caller should set |
| 372 | * up all of the necessary sysfs files for the object and then call |
| 373 | * kobject_uevent() with the UEVENT_ADD parameter to ensure that |
| 374 | * userspace is properly notified of this kobject's creation. |
| 375 | */ |
| 376 | int kobject_add_ng(struct kobject *kobj, struct kobject *parent, |
| 377 | const char *fmt, ...) |
| 378 | { |
| 379 | va_list args; |
| 380 | int retval; |
| 381 | |
| 382 | if (!kobj) |
| 383 | return -EINVAL; |
| 384 | |
| 385 | va_start(args, fmt); |
| 386 | retval = kobject_add_varg(kobj, parent, fmt, args); |
| 387 | va_end(args); |
| 388 | |
| 389 | return retval; |
| 390 | } |
| 391 | EXPORT_SYMBOL(kobject_add_ng); |
| 392 | |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 393 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 394 | * kobject_rename - change the name of an object |
| 395 | * @kobj: object in question. |
| 396 | * @new_name: object's new name |
| 397 | */ |
| 398 | |
Dmitry Torokhov | f3b4f3c | 2005-04-26 02:32:00 -0500 | [diff] [blame] | 399 | int kobject_rename(struct kobject * kobj, const char *new_name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 400 | { |
| 401 | int error = 0; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 402 | const char *devpath = NULL; |
| 403 | char *devpath_string = NULL; |
| 404 | char *envp[2]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 405 | |
| 406 | kobj = kobject_get(kobj); |
| 407 | if (!kobj) |
| 408 | return -EINVAL; |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 409 | if (!kobj->parent) |
| 410 | return -EINVAL; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 411 | |
Greg Kroah-Hartman | 34358c2 | 2007-10-24 16:52:31 -0700 | [diff] [blame] | 412 | /* 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 Berg | 71409a4 | 2007-11-05 13:59:11 +0100 | [diff] [blame] | 417 | printk(KERN_WARNING "kobject '%s' cannot be renamed " |
| 418 | "to '%s' as '%s' is already in existence.\n", |
Greg Kroah-Hartman | 34358c2 | 2007-10-24 16:52:31 -0700 | [diff] [blame] | 419 | kobject_name(kobj), new_name, new_name); |
| 420 | kobject_put(temp_kobj); |
| 421 | return -EINVAL; |
| 422 | } |
| 423 | } |
| 424 | |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 425 | 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 Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 438 | |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 439 | error = sysfs_rename_dir(kobj, new_name); |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 440 | |
| 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 | |
| 447 | out: |
| 448 | kfree(devpath_string); |
| 449 | kfree(devpath); |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 450 | kobject_put(kobj); |
| 451 | |
| 452 | return error; |
| 453 | } |
| 454 | |
| 455 | /** |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 456 | * kobject_move - move object to another parent |
| 457 | * @kobj: object in question. |
Cornelia Huck | c744aeae | 2007-01-08 20:16:44 +0100 | [diff] [blame] | 458 | * @new_parent: object's new parent (can be NULL) |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 459 | */ |
| 460 | |
| 461 | int kobject_move(struct kobject *kobj, struct kobject *new_parent) |
| 462 | { |
| 463 | int error; |
| 464 | struct kobject *old_parent; |
| 465 | const char *devpath = NULL; |
| 466 | char *devpath_string = NULL; |
| 467 | char *envp[2]; |
| 468 | |
| 469 | kobj = kobject_get(kobj); |
| 470 | if (!kobj) |
| 471 | return -EINVAL; |
| 472 | new_parent = kobject_get(new_parent); |
| 473 | if (!new_parent) { |
Cornelia Huck | c744aeae | 2007-01-08 20:16:44 +0100 | [diff] [blame] | 474 | if (kobj->kset) |
| 475 | new_parent = kobject_get(&kobj->kset->kobj); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 476 | } |
| 477 | /* old object path */ |
| 478 | devpath = kobject_get_path(kobj, GFP_KERNEL); |
| 479 | if (!devpath) { |
| 480 | error = -ENOMEM; |
| 481 | goto out; |
| 482 | } |
| 483 | devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL); |
| 484 | if (!devpath_string) { |
| 485 | error = -ENOMEM; |
| 486 | goto out; |
| 487 | } |
| 488 | sprintf(devpath_string, "DEVPATH_OLD=%s", devpath); |
| 489 | envp[0] = devpath_string; |
| 490 | envp[1] = NULL; |
| 491 | error = sysfs_move_dir(kobj, new_parent); |
| 492 | if (error) |
| 493 | goto out; |
| 494 | old_parent = kobj->parent; |
| 495 | kobj->parent = new_parent; |
Dmitriy Monakhov | 9e993ef | 2007-03-03 16:11:21 +0300 | [diff] [blame] | 496 | new_parent = NULL; |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 497 | kobject_put(old_parent); |
| 498 | kobject_uevent_env(kobj, KOBJ_MOVE, envp); |
| 499 | out: |
Dmitriy Monakhov | 9e993ef | 2007-03-03 16:11:21 +0300 | [diff] [blame] | 500 | kobject_put(new_parent); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 501 | kobject_put(kobj); |
| 502 | kfree(devpath_string); |
| 503 | kfree(devpath); |
| 504 | return error; |
| 505 | } |
| 506 | |
| 507 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 508 | * kobject_del - unlink kobject from hierarchy. |
| 509 | * @kobj: object. |
| 510 | */ |
| 511 | |
| 512 | void kobject_del(struct kobject * kobj) |
| 513 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 514 | if (!kobj) |
| 515 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 516 | sysfs_remove_dir(kobj); |
| 517 | unlink(kobj); |
| 518 | } |
| 519 | |
| 520 | /** |
| 521 | * kobject_unregister - remove object from hierarchy and decrement refcount. |
| 522 | * @kobj: object going away. |
| 523 | */ |
| 524 | |
| 525 | void kobject_unregister(struct kobject * kobj) |
| 526 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 527 | if (!kobj) |
| 528 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 529 | pr_debug("kobject %s: unregistering\n",kobject_name(kobj)); |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 530 | kobject_uevent(kobj, KOBJ_REMOVE); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 531 | kobject_del(kobj); |
| 532 | kobject_put(kobj); |
| 533 | } |
| 534 | |
| 535 | /** |
| 536 | * kobject_get - increment refcount for object. |
| 537 | * @kobj: object. |
| 538 | */ |
| 539 | |
| 540 | struct kobject * kobject_get(struct kobject * kobj) |
| 541 | { |
| 542 | if (kobj) |
| 543 | kref_get(&kobj->kref); |
| 544 | return kobj; |
| 545 | } |
| 546 | |
Greg Kroah-Hartman | 18041f47 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 547 | /* |
| 548 | * kobject_cleanup - free kobject resources. |
| 549 | * @kobj: object to cleanup |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 550 | */ |
Greg Kroah-Hartman | 18041f47 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 551 | static void kobject_cleanup(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 552 | { |
| 553 | struct kobj_type * t = get_ktype(kobj); |
| 554 | struct kset * s = kobj->kset; |
| 555 | struct kobject * parent = kobj->parent; |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 556 | const char *name = kobj->k_name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 557 | |
| 558 | pr_debug("kobject %s: cleaning up\n",kobject_name(kobj)); |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 559 | if (t && t->release) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 560 | t->release(kobj); |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 561 | /* If we have a release function, we can guess that this was |
| 562 | * not a statically allocated kobject, so we should be safe to |
| 563 | * free the name */ |
| 564 | kfree(name); |
| 565 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 566 | if (s) |
| 567 | kset_put(s); |
Mariusz Kozlowski | b067db4 | 2007-01-02 13:44:44 +0100 | [diff] [blame] | 568 | kobject_put(parent); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 569 | } |
| 570 | |
| 571 | static void kobject_release(struct kref *kref) |
| 572 | { |
| 573 | kobject_cleanup(container_of(kref, struct kobject, kref)); |
| 574 | } |
| 575 | |
| 576 | /** |
| 577 | * kobject_put - decrement refcount for object. |
| 578 | * @kobj: object. |
| 579 | * |
| 580 | * Decrement the refcount, and if 0, call kobject_cleanup(). |
| 581 | */ |
| 582 | void kobject_put(struct kobject * kobj) |
| 583 | { |
| 584 | if (kobj) |
| 585 | kref_put(&kobj->kref, kobject_release); |
| 586 | } |
| 587 | |
| 588 | |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 589 | static void dir_release(struct kobject *kobj) |
| 590 | { |
| 591 | kfree(kobj); |
| 592 | } |
| 593 | |
| 594 | static struct kobj_type dir_ktype = { |
| 595 | .release = dir_release, |
| 596 | .sysfs_ops = NULL, |
| 597 | .default_attrs = NULL, |
| 598 | }; |
| 599 | |
| 600 | /** |
Eric W. Biederman | 2753133 | 2007-04-06 10:47:11 -0600 | [diff] [blame] | 601 | * kobject_kset_add_dir - add sub directory of object. |
Kay Sievers | 8640624 | 2007-03-14 03:25:56 +0100 | [diff] [blame] | 602 | * @kset: kset the directory is belongs to. |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 603 | * @parent: object in which a directory is created. |
| 604 | * @name: directory name. |
| 605 | * |
| 606 | * Add a plain directory object as child of given object. |
| 607 | */ |
Kay Sievers | 8640624 | 2007-03-14 03:25:56 +0100 | [diff] [blame] | 608 | struct kobject *kobject_kset_add_dir(struct kset *kset, |
| 609 | struct kobject *parent, const char *name) |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 610 | { |
| 611 | struct kobject *k; |
Randy Dunlap | 1018801 | 2006-07-11 20:49:41 -0700 | [diff] [blame] | 612 | int ret; |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 613 | |
| 614 | if (!parent) |
| 615 | return NULL; |
| 616 | |
| 617 | k = kzalloc(sizeof(*k), GFP_KERNEL); |
| 618 | if (!k) |
| 619 | return NULL; |
| 620 | |
Kay Sievers | 8640624 | 2007-03-14 03:25:56 +0100 | [diff] [blame] | 621 | k->kset = kset; |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 622 | k->parent = parent; |
| 623 | k->ktype = &dir_ktype; |
| 624 | kobject_set_name(k, name); |
Randy Dunlap | 1018801 | 2006-07-11 20:49:41 -0700 | [diff] [blame] | 625 | ret = kobject_register(k); |
| 626 | if (ret < 0) { |
Eric W. Biederman | 2753133 | 2007-04-06 10:47:11 -0600 | [diff] [blame] | 627 | printk(KERN_WARNING "%s: kobject_register error: %d\n", |
| 628 | __func__, ret); |
Randy Dunlap | 1018801 | 2006-07-11 20:49:41 -0700 | [diff] [blame] | 629 | kobject_del(k); |
| 630 | return NULL; |
| 631 | } |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 632 | |
| 633 | return k; |
| 634 | } |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 635 | |
Eric W. Biederman | 2753133 | 2007-04-06 10:47:11 -0600 | [diff] [blame] | 636 | /** |
| 637 | * kobject_add_dir - add sub directory of object. |
| 638 | * @parent: object in which a directory is created. |
| 639 | * @name: directory name. |
| 640 | * |
| 641 | * Add a plain directory object as child of given object. |
| 642 | */ |
Kay Sievers | 8640624 | 2007-03-14 03:25:56 +0100 | [diff] [blame] | 643 | struct kobject *kobject_add_dir(struct kobject *parent, const char *name) |
| 644 | { |
| 645 | return kobject_kset_add_dir(NULL, parent, name); |
| 646 | } |
| 647 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 648 | /** |
| 649 | * kset_init - initialize a kset for use |
| 650 | * @k: kset |
| 651 | */ |
| 652 | |
| 653 | void kset_init(struct kset * k) |
| 654 | { |
| 655 | kobject_init(&k->kobj); |
| 656 | INIT_LIST_HEAD(&k->list); |
| 657 | spin_lock_init(&k->list_lock); |
| 658 | } |
| 659 | |
| 660 | |
| 661 | /** |
| 662 | * kset_add - add a kset object to the hierarchy. |
| 663 | * @k: kset. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 664 | */ |
| 665 | |
| 666 | int kset_add(struct kset * k) |
| 667 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 668 | return kobject_add(&k->kobj); |
| 669 | } |
| 670 | |
| 671 | |
| 672 | /** |
| 673 | * kset_register - initialize and add a kset. |
| 674 | * @k: kset. |
| 675 | */ |
| 676 | |
| 677 | int kset_register(struct kset * k) |
| 678 | { |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 679 | int err; |
| 680 | |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 681 | if (!k) |
| 682 | return -EINVAL; |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 683 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 684 | kset_init(k); |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 685 | err = kset_add(k); |
| 686 | if (err) |
| 687 | return err; |
| 688 | kobject_uevent(&k->kobj, KOBJ_ADD); |
| 689 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 690 | } |
| 691 | |
| 692 | |
| 693 | /** |
| 694 | * kset_unregister - remove a kset. |
| 695 | * @k: kset. |
| 696 | */ |
| 697 | |
| 698 | void kset_unregister(struct kset * k) |
| 699 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 700 | if (!k) |
| 701 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 702 | kobject_unregister(&k->kobj); |
| 703 | } |
| 704 | |
| 705 | |
| 706 | /** |
| 707 | * kset_find_obj - search for object in kset. |
| 708 | * @kset: kset we're looking in. |
| 709 | * @name: object's name. |
| 710 | * |
| 711 | * Lock kset via @kset->subsys, and iterate over @kset->list, |
| 712 | * looking for a matching kobject. If matching object is found |
| 713 | * take a reference and return the object. |
| 714 | */ |
| 715 | |
| 716 | struct kobject * kset_find_obj(struct kset * kset, const char * name) |
| 717 | { |
| 718 | struct list_head * entry; |
| 719 | struct kobject * ret = NULL; |
| 720 | |
| 721 | spin_lock(&kset->list_lock); |
| 722 | list_for_each(entry,&kset->list) { |
| 723 | struct kobject * k = to_kobj(entry); |
| 724 | if (kobject_name(k) && !strcmp(kobject_name(k),name)) { |
| 725 | ret = kobject_get(k); |
| 726 | break; |
| 727 | } |
| 728 | } |
| 729 | spin_unlock(&kset->list_lock); |
| 730 | return ret; |
| 731 | } |
| 732 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 733 | int subsystem_register(struct kset *s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 734 | { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 735 | return kset_register(s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 736 | } |
| 737 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 738 | void subsystem_unregister(struct kset *s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 739 | { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 740 | kset_unregister(s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 741 | } |
| 742 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 743 | /** |
| 744 | * subsystem_create_file - export sysfs attribute file. |
| 745 | * @s: subsystem. |
| 746 | * @a: subsystem attribute descriptor. |
| 747 | */ |
| 748 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 749 | int subsys_create_file(struct kset *s, struct subsys_attribute *a) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 750 | { |
| 751 | int error = 0; |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 752 | |
| 753 | if (!s || !a) |
| 754 | return -EINVAL; |
| 755 | |
Greg Kroah-Hartman | 1ef4cfa | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 756 | if (kset_get(s)) { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 757 | error = sysfs_create_file(&s->kobj, &a->attr); |
Greg Kroah-Hartman | 6e9d930 | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 758 | kset_put(s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 759 | } |
| 760 | return error; |
| 761 | } |
| 762 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 763 | EXPORT_SYMBOL(kobject_init); |
| 764 | EXPORT_SYMBOL(kobject_register); |
| 765 | EXPORT_SYMBOL(kobject_unregister); |
| 766 | EXPORT_SYMBOL(kobject_get); |
| 767 | EXPORT_SYMBOL(kobject_put); |
| 768 | EXPORT_SYMBOL(kobject_add); |
| 769 | EXPORT_SYMBOL(kobject_del); |
| 770 | |
| 771 | EXPORT_SYMBOL(kset_register); |
| 772 | EXPORT_SYMBOL(kset_unregister); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 773 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 774 | EXPORT_SYMBOL(subsystem_register); |
| 775 | EXPORT_SYMBOL(subsystem_unregister); |
| 776 | EXPORT_SYMBOL(subsys_create_file); |