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 | |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 189 | if (!parent) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 190 | parent = kobject_get(&kobj->kset->kobj); |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 191 | /* |
| 192 | * If the kset is our parent, get a second |
| 193 | * reference, we drop both the kset and the |
| 194 | * parent ref on cleanup |
| 195 | */ |
| 196 | kobject_get(parent); |
| 197 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 198 | |
| 199 | list_add_tail(&kobj->entry,&kobj->kset->list); |
| 200 | spin_unlock(&kobj->kset->list_lock); |
Dmitriy Monakhov | 460f7e9 | 2007-03-10 14:00:10 +0300 | [diff] [blame] | 201 | kobj->parent = parent; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 203 | |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 204 | error = create_dir(kobj); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 205 | if (error) { |
| 206 | /* unlink does the kobject_put() for us */ |
| 207 | unlink(kobj); |
Mariusz Kozlowski | b067db4 | 2007-01-02 13:44:44 +0100 | [diff] [blame] | 208 | kobject_put(parent); |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 209 | |
| 210 | /* be noisy on error issues */ |
| 211 | if (error == -EEXIST) |
Greg Kroah-Hartman | 5c73a3f | 2007-06-07 15:05:15 -0700 | [diff] [blame] | 212 | printk(KERN_ERR "kobject_add failed for %s with " |
| 213 | "-EEXIST, don't try to register things with " |
| 214 | "the same name in the same directory.\n", |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 215 | kobject_name(kobj)); |
| 216 | else |
Greg Kroah-Hartman | 5c73a3f | 2007-06-07 15:05:15 -0700 | [diff] [blame] | 217 | printk(KERN_ERR "kobject_add failed for %s (%d)\n", |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 218 | kobject_name(kobj), error); |
Greg Kroah-Hartman | 5c73a3f | 2007-06-07 15:05:15 -0700 | [diff] [blame] | 219 | dump_stack(); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | return error; |
| 223 | } |
| 224 | |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 225 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 226 | * kobject_register - initialize and add an object. |
| 227 | * @kobj: object in question. |
| 228 | */ |
| 229 | |
| 230 | int kobject_register(struct kobject * kobj) |
| 231 | { |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 232 | int error = -EINVAL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 233 | if (kobj) { |
| 234 | kobject_init(kobj); |
| 235 | error = kobject_add(kobj); |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 236 | if (!error) |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 237 | kobject_uevent(kobj, KOBJ_ADD); |
Greg Kroah-Hartman | dcd0da0 | 2006-03-20 13:17:13 -0800 | [diff] [blame] | 238 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 239 | return error; |
| 240 | } |
| 241 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | /** |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 243 | * kobject_set_name_vargs - Set the name of an kobject |
| 244 | * @kobj: struct kobject to set the name of |
Greg Kroah-Hartman | 8c4606b | 2007-12-04 14:45:47 +0800 | [diff] [blame] | 245 | * @fmt: format string used to build the name |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 246 | * @vargs: vargs to format the string. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 247 | */ |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 248 | static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt, |
| 249 | va_list vargs) |
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 | va_list aq; |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 252 | char *name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 253 | |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 254 | va_copy(aq, vargs); |
| 255 | name = kvasprintf(GFP_KERNEL, fmt, vargs); |
| 256 | va_end(aq); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 257 | |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 258 | if (!name) |
| 259 | return -ENOMEM; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 260 | |
| 261 | /* Free the old name, if necessary. */ |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 262 | kfree(kobj->k_name); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 263 | |
| 264 | /* Now, set the new name */ |
| 265 | kobj->k_name = name; |
Greg Kroah-Hartman | 663a474 | 2007-11-29 18:32:47 -0500 | [diff] [blame] | 266 | |
| 267 | return 0; |
| 268 | } |
| 269 | |
| 270 | /** |
| 271 | * kobject_set_name - Set the name of a kobject |
| 272 | * @kobj: struct kobject to set the name of |
| 273 | * @fmt: format string used to build the name |
| 274 | * |
| 275 | * This sets the name of the kobject. If you have already added the |
| 276 | * kobject to the system, you must call kobject_rename() in order to |
| 277 | * change the name of the kobject. |
| 278 | */ |
| 279 | int kobject_set_name(struct kobject *kobj, const char *fmt, ...) |
| 280 | { |
| 281 | va_list args; |
| 282 | int retval; |
| 283 | |
| 284 | va_start(args, fmt); |
| 285 | retval = kobject_set_name_vargs(kobj, fmt, args); |
| 286 | va_end(args); |
| 287 | |
| 288 | return retval; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 289 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 290 | EXPORT_SYMBOL(kobject_set_name); |
| 291 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 292 | /** |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 293 | * kobject_init_ng - initialize a kobject structure |
| 294 | * @kobj: pointer to the kobject to initialize |
| 295 | * @ktype: pointer to the ktype for this kobject. |
| 296 | * |
| 297 | * This function will properly initialize a kobject such that it can then |
| 298 | * be passed to the kobject_add() call. |
| 299 | * |
| 300 | * After this function is called, the kobject MUST be cleaned up by a call |
| 301 | * to kobject_put(), not by a call to kfree directly to ensure that all of |
| 302 | * the memory is cleaned up properly. |
| 303 | */ |
| 304 | void kobject_init_ng(struct kobject *kobj, struct kobj_type *ktype) |
| 305 | { |
| 306 | char *err_str; |
| 307 | |
| 308 | if (!kobj) { |
| 309 | err_str = "invalid kobject pointer!"; |
| 310 | goto error; |
| 311 | } |
| 312 | if (!ktype) { |
| 313 | err_str = "must have a ktype to be initialized properly!\n"; |
| 314 | goto error; |
| 315 | } |
| 316 | if (atomic_read(&kobj->kref.refcount)) { |
| 317 | /* do not error out as sometimes we can recover */ |
| 318 | printk(KERN_ERR "kobject: reference count is already set, " |
| 319 | "something is seriously wrong.\n"); |
| 320 | dump_stack(); |
| 321 | } |
| 322 | |
| 323 | kref_init(&kobj->kref); |
| 324 | INIT_LIST_HEAD(&kobj->entry); |
| 325 | kobj->ktype = ktype; |
| 326 | return; |
| 327 | |
| 328 | error: |
| 329 | printk(KERN_ERR "kobject: %s\n", err_str); |
| 330 | dump_stack(); |
| 331 | } |
| 332 | EXPORT_SYMBOL(kobject_init_ng); |
| 333 | |
Greg Kroah-Hartman | 244f6ce | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 334 | static int kobject_add_varg(struct kobject *kobj, struct kobject *parent, |
| 335 | const char *fmt, va_list vargs) |
| 336 | { |
| 337 | va_list aq; |
| 338 | int retval; |
| 339 | |
| 340 | va_copy(aq, vargs); |
| 341 | retval = kobject_set_name_vargs(kobj, fmt, aq); |
| 342 | va_end(aq); |
| 343 | if (retval) { |
| 344 | printk(KERN_ERR "kobject: can not set name properly!\n"); |
| 345 | return retval; |
| 346 | } |
| 347 | kobj->parent = parent; |
| 348 | return kobject_add(kobj); |
| 349 | } |
| 350 | |
| 351 | /** |
| 352 | * kobject_add_ng - the main kobject add function |
| 353 | * @kobj: the kobject to add |
| 354 | * @parent: pointer to the parent of the kobject. |
| 355 | * @fmt: format to name the kobject with. |
| 356 | * |
| 357 | * The kobject name is set and added to the kobject hierarchy in this |
| 358 | * function. |
| 359 | * |
| 360 | * If @parent is set, then the parent of the @kobj will be set to it. |
| 361 | * If @parent is NULL, then the parent of the @kobj will be set to the |
| 362 | * kobject associted with the kset assigned to this kobject. If no kset |
| 363 | * is assigned to the kobject, then the kobject will be located in the |
| 364 | * root of the sysfs tree. |
| 365 | * |
| 366 | * If this function returns an error, kobject_put() must be called to |
| 367 | * properly clean up the memory associated with the object. |
| 368 | * |
| 369 | * If the function is successful, the only way to properly clean up the |
| 370 | * memory is with a call to kobject_del(), in which case, a call to |
| 371 | * kobject_put() is not necessary (kobject_del() does the final |
| 372 | * kobject_put() to call the release function in the ktype's release |
| 373 | * pointer.) |
| 374 | * |
| 375 | * Under no instance should the kobject that is passed to this function |
| 376 | * be directly freed with a call to kfree(), that can leak memory. |
| 377 | * |
| 378 | * Note, no uevent will be created with this call, the caller should set |
| 379 | * up all of the necessary sysfs files for the object and then call |
| 380 | * kobject_uevent() with the UEVENT_ADD parameter to ensure that |
| 381 | * userspace is properly notified of this kobject's creation. |
| 382 | */ |
| 383 | int kobject_add_ng(struct kobject *kobj, struct kobject *parent, |
| 384 | const char *fmt, ...) |
| 385 | { |
| 386 | va_list args; |
| 387 | int retval; |
| 388 | |
| 389 | if (!kobj) |
| 390 | return -EINVAL; |
| 391 | |
| 392 | va_start(args, fmt); |
| 393 | retval = kobject_add_varg(kobj, parent, fmt, args); |
| 394 | va_end(args); |
| 395 | |
| 396 | return retval; |
| 397 | } |
| 398 | EXPORT_SYMBOL(kobject_add_ng); |
| 399 | |
Greg Kroah-Hartman | e86000d | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 400 | /** |
Greg Kroah-Hartman | c11c4154 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 401 | * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy |
| 402 | * @kobj: pointer to the kobject to initialize |
| 403 | * @ktype: pointer to the ktype for this kobject. |
| 404 | * @parent: pointer to the parent of this kobject. |
| 405 | * @fmt: the name of the kobject. |
| 406 | * |
| 407 | * This function combines the call to kobject_init_ng() and |
| 408 | * kobject_add_ng(). The same type of error handling after a call to |
| 409 | * kobject_add_ng() and kobject lifetime rules are the same here. |
| 410 | */ |
| 411 | int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype, |
| 412 | struct kobject *parent, const char *fmt, ...) |
| 413 | { |
| 414 | va_list args; |
| 415 | int retval; |
| 416 | |
| 417 | kobject_init_ng(kobj, ktype); |
| 418 | |
| 419 | va_start(args, fmt); |
| 420 | retval = kobject_add_varg(kobj, parent, fmt, args); |
| 421 | va_end(args); |
| 422 | |
| 423 | return retval; |
| 424 | } |
| 425 | EXPORT_SYMBOL_GPL(kobject_init_and_add); |
| 426 | |
| 427 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 428 | * kobject_rename - change the name of an object |
| 429 | * @kobj: object in question. |
| 430 | * @new_name: object's new name |
| 431 | */ |
| 432 | |
Dmitry Torokhov | f3b4f3c | 2005-04-26 02:32:00 -0500 | [diff] [blame] | 433 | int kobject_rename(struct kobject * kobj, const char *new_name) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 434 | { |
| 435 | int error = 0; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 436 | const char *devpath = NULL; |
| 437 | char *devpath_string = NULL; |
| 438 | char *envp[2]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 439 | |
| 440 | kobj = kobject_get(kobj); |
| 441 | if (!kobj) |
| 442 | return -EINVAL; |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 443 | if (!kobj->parent) |
| 444 | return -EINVAL; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 445 | |
Greg Kroah-Hartman | 34358c2 | 2007-10-24 16:52:31 -0700 | [diff] [blame] | 446 | /* see if this name is already in use */ |
| 447 | if (kobj->kset) { |
| 448 | struct kobject *temp_kobj; |
| 449 | temp_kobj = kset_find_obj(kobj->kset, new_name); |
| 450 | if (temp_kobj) { |
Johannes Berg | 71409a4 | 2007-11-05 13:59:11 +0100 | [diff] [blame] | 451 | printk(KERN_WARNING "kobject '%s' cannot be renamed " |
| 452 | "to '%s' as '%s' is already in existence.\n", |
Greg Kroah-Hartman | 34358c2 | 2007-10-24 16:52:31 -0700 | [diff] [blame] | 453 | kobject_name(kobj), new_name, new_name); |
| 454 | kobject_put(temp_kobj); |
| 455 | return -EINVAL; |
| 456 | } |
| 457 | } |
| 458 | |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 459 | devpath = kobject_get_path(kobj, GFP_KERNEL); |
| 460 | if (!devpath) { |
| 461 | error = -ENOMEM; |
| 462 | goto out; |
| 463 | } |
| 464 | devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL); |
| 465 | if (!devpath_string) { |
| 466 | error = -ENOMEM; |
| 467 | goto out; |
| 468 | } |
| 469 | sprintf(devpath_string, "DEVPATH_OLD=%s", devpath); |
| 470 | envp[0] = devpath_string; |
| 471 | envp[1] = NULL; |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 472 | |
Eric W. Biederman | 90bc613 | 2007-07-31 19:15:08 +0900 | [diff] [blame] | 473 | error = sysfs_rename_dir(kobj, new_name); |
Jean Tourrilhes | ca2f37d | 2007-03-07 10:49:30 -0800 | [diff] [blame] | 474 | |
| 475 | /* This function is mostly/only used for network interface. |
| 476 | * Some hotplug package track interfaces by their name and |
| 477 | * therefore want to know when the name is changed by the user. */ |
| 478 | if (!error) |
| 479 | kobject_uevent_env(kobj, KOBJ_MOVE, envp); |
| 480 | |
| 481 | out: |
| 482 | kfree(devpath_string); |
| 483 | kfree(devpath); |
Eric W. Biederman | b592fcf | 2007-01-24 12:35:52 -0700 | [diff] [blame] | 484 | kobject_put(kobj); |
| 485 | |
| 486 | return error; |
| 487 | } |
| 488 | |
| 489 | /** |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 490 | * kobject_move - move object to another parent |
| 491 | * @kobj: object in question. |
Cornelia Huck | c744aeae | 2007-01-08 20:16:44 +0100 | [diff] [blame] | 492 | * @new_parent: object's new parent (can be NULL) |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 493 | */ |
| 494 | |
| 495 | int kobject_move(struct kobject *kobj, struct kobject *new_parent) |
| 496 | { |
| 497 | int error; |
| 498 | struct kobject *old_parent; |
| 499 | const char *devpath = NULL; |
| 500 | char *devpath_string = NULL; |
| 501 | char *envp[2]; |
| 502 | |
| 503 | kobj = kobject_get(kobj); |
| 504 | if (!kobj) |
| 505 | return -EINVAL; |
| 506 | new_parent = kobject_get(new_parent); |
| 507 | if (!new_parent) { |
Cornelia Huck | c744aeae | 2007-01-08 20:16:44 +0100 | [diff] [blame] | 508 | if (kobj->kset) |
| 509 | new_parent = kobject_get(&kobj->kset->kobj); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 510 | } |
| 511 | /* old object path */ |
| 512 | devpath = kobject_get_path(kobj, GFP_KERNEL); |
| 513 | if (!devpath) { |
| 514 | error = -ENOMEM; |
| 515 | goto out; |
| 516 | } |
| 517 | devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL); |
| 518 | if (!devpath_string) { |
| 519 | error = -ENOMEM; |
| 520 | goto out; |
| 521 | } |
| 522 | sprintf(devpath_string, "DEVPATH_OLD=%s", devpath); |
| 523 | envp[0] = devpath_string; |
| 524 | envp[1] = NULL; |
| 525 | error = sysfs_move_dir(kobj, new_parent); |
| 526 | if (error) |
| 527 | goto out; |
| 528 | old_parent = kobj->parent; |
| 529 | kobj->parent = new_parent; |
Dmitriy Monakhov | 9e993ef | 2007-03-03 16:11:21 +0300 | [diff] [blame] | 530 | new_parent = NULL; |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 531 | kobject_put(old_parent); |
| 532 | kobject_uevent_env(kobj, KOBJ_MOVE, envp); |
| 533 | out: |
Dmitriy Monakhov | 9e993ef | 2007-03-03 16:11:21 +0300 | [diff] [blame] | 534 | kobject_put(new_parent); |
Cornelia Huck | 8a82472 | 2006-11-20 17:07:51 +0100 | [diff] [blame] | 535 | kobject_put(kobj); |
| 536 | kfree(devpath_string); |
| 537 | kfree(devpath); |
| 538 | return error; |
| 539 | } |
| 540 | |
| 541 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 542 | * kobject_del - unlink kobject from hierarchy. |
| 543 | * @kobj: object. |
| 544 | */ |
| 545 | |
| 546 | void kobject_del(struct kobject * kobj) |
| 547 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 548 | if (!kobj) |
| 549 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 550 | sysfs_remove_dir(kobj); |
| 551 | unlink(kobj); |
| 552 | } |
| 553 | |
| 554 | /** |
| 555 | * kobject_unregister - remove object from hierarchy and decrement refcount. |
| 556 | * @kobj: object going away. |
| 557 | */ |
| 558 | |
| 559 | void kobject_unregister(struct kobject * kobj) |
| 560 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 561 | if (!kobj) |
| 562 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 563 | pr_debug("kobject %s: unregistering\n",kobject_name(kobj)); |
Kay Sievers | 312c004 | 2005-11-16 09:00:00 +0100 | [diff] [blame] | 564 | kobject_uevent(kobj, KOBJ_REMOVE); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 565 | kobject_del(kobj); |
| 566 | kobject_put(kobj); |
| 567 | } |
| 568 | |
| 569 | /** |
| 570 | * kobject_get - increment refcount for object. |
| 571 | * @kobj: object. |
| 572 | */ |
| 573 | |
| 574 | struct kobject * kobject_get(struct kobject * kobj) |
| 575 | { |
| 576 | if (kobj) |
| 577 | kref_get(&kobj->kref); |
| 578 | return kobj; |
| 579 | } |
| 580 | |
Greg Kroah-Hartman | 18041f47 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 581 | /* |
| 582 | * kobject_cleanup - free kobject resources. |
| 583 | * @kobj: object to cleanup |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 584 | */ |
Greg Kroah-Hartman | 18041f47 | 2007-12-03 21:31:08 -0800 | [diff] [blame] | 585 | static void kobject_cleanup(struct kobject *kobj) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 586 | { |
| 587 | struct kobj_type * t = get_ktype(kobj); |
| 588 | struct kset * s = kobj->kset; |
| 589 | struct kobject * parent = kobj->parent; |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 590 | const char *name = kobj->k_name; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 591 | |
| 592 | pr_debug("kobject %s: cleaning up\n",kobject_name(kobj)); |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 593 | if (t && t->release) { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 594 | t->release(kobj); |
Greg Kroah-Hartman | ce2c9cb | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 595 | /* If we have a release function, we can guess that this was |
| 596 | * not a statically allocated kobject, so we should be safe to |
| 597 | * free the name */ |
| 598 | kfree(name); |
| 599 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 600 | if (s) |
| 601 | kset_put(s); |
Mariusz Kozlowski | b067db4 | 2007-01-02 13:44:44 +0100 | [diff] [blame] | 602 | kobject_put(parent); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 603 | } |
| 604 | |
| 605 | static void kobject_release(struct kref *kref) |
| 606 | { |
| 607 | kobject_cleanup(container_of(kref, struct kobject, kref)); |
| 608 | } |
| 609 | |
| 610 | /** |
| 611 | * kobject_put - decrement refcount for object. |
| 612 | * @kobj: object. |
| 613 | * |
| 614 | * Decrement the refcount, and if 0, call kobject_cleanup(). |
| 615 | */ |
| 616 | void kobject_put(struct kobject * kobj) |
| 617 | { |
| 618 | if (kobj) |
| 619 | kref_put(&kobj->kref, kobject_release); |
| 620 | } |
| 621 | |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 622 | static void dynamic_kobj_release(struct kobject *kobj) |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 623 | { |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 624 | pr_debug("%s: freeing %s\n", __FUNCTION__, kobject_name(kobj)); |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 625 | kfree(kobj); |
| 626 | } |
| 627 | |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 628 | static struct kobj_type dynamic_kobj_ktype = { |
| 629 | .release = dynamic_kobj_release, |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 630 | }; |
| 631 | |
Greg Kroah-Hartman | 43968d2 | 2007-11-05 22:24:43 -0800 | [diff] [blame] | 632 | /** |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 633 | * kobject_create - create a struct kobject dynamically |
| 634 | * |
| 635 | * This function creates a kobject structure dynamically and sets it up |
| 636 | * to be a "dynamic" kobject with a default release function set up. |
| 637 | * |
| 638 | * If the kobject was not able to be created, NULL will be returned. |
Greg Kroah-Hartman | 43968d2 | 2007-11-05 22:24:43 -0800 | [diff] [blame] | 639 | * The kobject structure returned from here must be cleaned up with a |
| 640 | * call to kobject_put() and not kfree(), as kobject_init_ng() has |
| 641 | * already been called on this structure. |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 642 | */ |
Greg Kroah-Hartman | 43968d2 | 2007-11-05 22:24:43 -0800 | [diff] [blame] | 643 | struct kobject *kobject_create(void) |
Greg Kroah-Hartman | 3f9e3ee | 2007-11-05 13:16:15 -0800 | [diff] [blame] | 644 | { |
| 645 | struct kobject *kobj; |
| 646 | |
| 647 | kobj = kzalloc(sizeof(*kobj), GFP_KERNEL); |
| 648 | if (!kobj) |
| 649 | return NULL; |
| 650 | |
| 651 | kobject_init_ng(kobj, &dynamic_kobj_ktype); |
| 652 | return kobj; |
| 653 | } |
| 654 | |
| 655 | /** |
| 656 | * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs |
| 657 | * |
| 658 | * @name: the name for the kset |
| 659 | * @parent: the parent kobject of this kobject, if any. |
| 660 | * |
| 661 | * This function creates a kset structure dynamically and registers it |
| 662 | * with sysfs. When you are finished with this structure, call |
| 663 | * kobject_unregister() and the structure will be dynamically freed when |
| 664 | * it is no longer being used. |
| 665 | * |
| 666 | * If the kobject was not able to be created, NULL will be returned. |
| 667 | */ |
| 668 | struct kobject *kobject_create_and_add(const char *name, struct kobject *parent) |
| 669 | { |
| 670 | struct kobject *kobj; |
| 671 | int retval; |
| 672 | |
| 673 | kobj = kobject_create(); |
| 674 | if (!kobj) |
| 675 | return NULL; |
| 676 | |
| 677 | retval = kobject_add_ng(kobj, parent, "%s", name); |
| 678 | if (retval) { |
| 679 | printk(KERN_WARNING "%s: kobject_add error: %d\n", |
| 680 | __FUNCTION__, retval); |
| 681 | kobject_put(kobj); |
| 682 | kobj = NULL; |
| 683 | } |
| 684 | return kobj; |
| 685 | } |
| 686 | EXPORT_SYMBOL_GPL(kobject_create_and_add); |
| 687 | |
Jun'ichi Nomura | 7423172 | 2006-03-13 17:14:25 -0500 | [diff] [blame] | 688 | /** |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 689 | * kset_init - initialize a kset for use |
| 690 | * @k: kset |
| 691 | */ |
| 692 | |
| 693 | void kset_init(struct kset * k) |
| 694 | { |
| 695 | kobject_init(&k->kobj); |
| 696 | INIT_LIST_HEAD(&k->list); |
| 697 | spin_lock_init(&k->list_lock); |
| 698 | } |
| 699 | |
Kay Sievers | 23b5212 | 2007-11-02 13:47:53 +0100 | [diff] [blame^] | 700 | /* default kobject attribute operations */ |
| 701 | static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr, |
| 702 | char *buf) |
| 703 | { |
| 704 | struct kobj_attribute *kattr; |
| 705 | ssize_t ret = -EIO; |
| 706 | |
| 707 | kattr = container_of(attr, struct kobj_attribute, attr); |
| 708 | if (kattr->show) |
| 709 | ret = kattr->show(kobj, kattr, buf); |
| 710 | return ret; |
| 711 | } |
| 712 | |
| 713 | static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr, |
| 714 | const char *buf, size_t count) |
| 715 | { |
| 716 | struct kobj_attribute *kattr; |
| 717 | ssize_t ret = -EIO; |
| 718 | |
| 719 | kattr = container_of(attr, struct kobj_attribute, attr); |
| 720 | if (kattr->store) |
| 721 | ret = kattr->store(kobj, kattr, buf, count); |
| 722 | return ret; |
| 723 | } |
| 724 | |
| 725 | struct sysfs_ops kobj_sysfs_ops = { |
| 726 | .show = kobj_attr_show, |
| 727 | .store = kobj_attr_store, |
| 728 | }; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 729 | |
| 730 | /** |
| 731 | * kset_add - add a kset object to the hierarchy. |
| 732 | * @k: kset. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 733 | */ |
| 734 | |
| 735 | int kset_add(struct kset * k) |
| 736 | { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 737 | return kobject_add(&k->kobj); |
| 738 | } |
| 739 | |
| 740 | |
| 741 | /** |
| 742 | * kset_register - initialize and add a kset. |
| 743 | * @k: kset. |
| 744 | */ |
| 745 | |
| 746 | int kset_register(struct kset * k) |
| 747 | { |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 748 | int err; |
| 749 | |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 750 | if (!k) |
| 751 | return -EINVAL; |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 752 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 753 | kset_init(k); |
Kay Sievers | 80f03e3 | 2007-05-26 11:21:36 +0200 | [diff] [blame] | 754 | err = kset_add(k); |
| 755 | if (err) |
| 756 | return err; |
| 757 | kobject_uevent(&k->kobj, KOBJ_ADD); |
| 758 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 759 | } |
| 760 | |
| 761 | |
| 762 | /** |
| 763 | * kset_unregister - remove a kset. |
| 764 | * @k: kset. |
| 765 | */ |
| 766 | |
| 767 | void kset_unregister(struct kset * k) |
| 768 | { |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 769 | if (!k) |
| 770 | return; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 771 | kobject_unregister(&k->kobj); |
| 772 | } |
| 773 | |
| 774 | |
| 775 | /** |
| 776 | * kset_find_obj - search for object in kset. |
| 777 | * @kset: kset we're looking in. |
| 778 | * @name: object's name. |
| 779 | * |
| 780 | * Lock kset via @kset->subsys, and iterate over @kset->list, |
| 781 | * looking for a matching kobject. If matching object is found |
| 782 | * take a reference and return the object. |
| 783 | */ |
| 784 | |
| 785 | struct kobject * kset_find_obj(struct kset * kset, const char * name) |
| 786 | { |
| 787 | struct list_head * entry; |
| 788 | struct kobject * ret = NULL; |
| 789 | |
| 790 | spin_lock(&kset->list_lock); |
| 791 | list_for_each(entry,&kset->list) { |
| 792 | struct kobject * k = to_kobj(entry); |
| 793 | if (kobject_name(k) && !strcmp(kobject_name(k),name)) { |
| 794 | ret = kobject_get(k); |
| 795 | break; |
| 796 | } |
| 797 | } |
| 798 | spin_unlock(&kset->list_lock); |
| 799 | return ret; |
| 800 | } |
| 801 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 802 | int subsystem_register(struct kset *s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 803 | { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 804 | return kset_register(s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 805 | } |
| 806 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 807 | void subsystem_unregister(struct kset *s) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 808 | { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 809 | kset_unregister(s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 810 | } |
| 811 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 812 | /** |
| 813 | * subsystem_create_file - export sysfs attribute file. |
| 814 | * @s: subsystem. |
| 815 | * @a: subsystem attribute descriptor. |
| 816 | */ |
| 817 | |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 818 | int subsys_create_file(struct kset *s, struct subsys_attribute *a) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 819 | { |
| 820 | int error = 0; |
Greg Kroah-Hartman | 31b9025a | 2007-01-18 12:23:51 -0800 | [diff] [blame] | 821 | |
| 822 | if (!s || !a) |
| 823 | return -EINVAL; |
| 824 | |
Greg Kroah-Hartman | 1ef4cfa | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 825 | if (kset_get(s)) { |
Greg Kroah-Hartman | 823bccf | 2007-04-13 13:15:19 -0700 | [diff] [blame] | 826 | error = sysfs_create_file(&s->kobj, &a->attr); |
Greg Kroah-Hartman | 6e9d930 | 2007-09-12 15:06:57 -0700 | [diff] [blame] | 827 | kset_put(s); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 828 | } |
| 829 | return error; |
| 830 | } |
| 831 | |
Greg Kroah-Hartman | b727c70 | 2007-09-27 14:48:53 -0700 | [diff] [blame] | 832 | static void kset_release(struct kobject *kobj) |
| 833 | { |
| 834 | struct kset *kset = container_of(kobj, struct kset, kobj); |
| 835 | pr_debug("kset %s: now freed\n", kobject_name(kobj)); |
| 836 | kfree(kset); |
| 837 | } |
| 838 | |
| 839 | static struct kobj_type kset_type = { |
| 840 | .release = kset_release, |
| 841 | }; |
| 842 | |
| 843 | /** |
| 844 | * kset_create - create a struct kset dynamically |
| 845 | * |
| 846 | * @name: the name for the kset |
| 847 | * @uevent_ops: a struct kset_uevent_ops for the kset |
| 848 | * @parent_kobj: the parent kobject of this kset, if any. |
| 849 | * |
| 850 | * This function creates a kset structure dynamically. This structure can |
| 851 | * then be registered with the system and show up in sysfs with a call to |
| 852 | * kset_register(). When you are finished with this structure, if |
| 853 | * kset_register() has been called, call kset_unregister() and the |
| 854 | * structure will be dynamically freed when it is no longer being used. |
| 855 | * |
| 856 | * If the kset was not able to be created, NULL will be returned. |
| 857 | */ |
| 858 | static struct kset *kset_create(const char *name, |
| 859 | struct kset_uevent_ops *uevent_ops, |
| 860 | struct kobject *parent_kobj) |
| 861 | { |
| 862 | struct kset *kset; |
| 863 | |
| 864 | kset = kzalloc(sizeof(*kset), GFP_KERNEL); |
| 865 | if (!kset) |
| 866 | return NULL; |
| 867 | kobject_set_name(&kset->kobj, name); |
| 868 | kset->uevent_ops = uevent_ops; |
| 869 | kset->kobj.parent = parent_kobj; |
| 870 | |
| 871 | /* |
| 872 | * The kobject of this kset will have a type of kset_type and belong to |
| 873 | * no kset itself. That way we can properly free it when it is |
| 874 | * finished being used. |
| 875 | */ |
| 876 | kset->kobj.ktype = &kset_type; |
| 877 | kset->kobj.kset = NULL; |
| 878 | |
| 879 | return kset; |
| 880 | } |
| 881 | |
| 882 | /** |
| 883 | * kset_create_and_add - create a struct kset dynamically and add it to sysfs |
| 884 | * |
| 885 | * @name: the name for the kset |
| 886 | * @uevent_ops: a struct kset_uevent_ops for the kset |
| 887 | * @parent_kobj: the parent kobject of this kset, if any. |
| 888 | * |
| 889 | * This function creates a kset structure dynamically and registers it |
| 890 | * with sysfs. When you are finished with this structure, call |
| 891 | * kset_unregister() and the structure will be dynamically freed when it |
| 892 | * is no longer being used. |
| 893 | * |
| 894 | * If the kset was not able to be created, NULL will be returned. |
| 895 | */ |
| 896 | struct kset *kset_create_and_add(const char *name, |
| 897 | struct kset_uevent_ops *uevent_ops, |
| 898 | struct kobject *parent_kobj) |
| 899 | { |
| 900 | struct kset *kset; |
| 901 | int error; |
| 902 | |
| 903 | kset = kset_create(name, uevent_ops, parent_kobj); |
| 904 | if (!kset) |
| 905 | return NULL; |
| 906 | error = kset_register(kset); |
| 907 | if (error) { |
| 908 | kfree(kset); |
| 909 | return NULL; |
| 910 | } |
| 911 | return kset; |
| 912 | } |
| 913 | EXPORT_SYMBOL_GPL(kset_create_and_add); |
| 914 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 915 | EXPORT_SYMBOL(kobject_init); |
| 916 | EXPORT_SYMBOL(kobject_register); |
| 917 | EXPORT_SYMBOL(kobject_unregister); |
| 918 | EXPORT_SYMBOL(kobject_get); |
| 919 | EXPORT_SYMBOL(kobject_put); |
| 920 | EXPORT_SYMBOL(kobject_add); |
| 921 | EXPORT_SYMBOL(kobject_del); |
| 922 | |
| 923 | EXPORT_SYMBOL(kset_register); |
| 924 | EXPORT_SYMBOL(kset_unregister); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 925 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 926 | EXPORT_SYMBOL(subsystem_register); |
| 927 | EXPORT_SYMBOL(subsystem_unregister); |
| 928 | EXPORT_SYMBOL(subsys_create_file); |