kobject: get rid of kobject_add_dir
[linux-2.6-block.git] / lib / kobject.c
CommitLineData
1da177e4
LT
1/*
2 * kobject.c - library routines for handling generic kernel objects
3 *
4 * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org>
f0e7e1bd
GKH
5 * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (c) 2006-2007 Novell Inc.
1da177e4
LT
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>
4e57b681 19#include <linux/slab.h>
1da177e4
LT
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
33static 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
90bc6135 49static int create_dir(struct kobject * kobj)
1da177e4
LT
50{
51 int error = 0;
52 if (kobject_name(kobj)) {
90bc6135 53 error = sysfs_create_dir(kobj);
1da177e4
LT
54 if (!error) {
55 if ((error = populate_dir(kobj)))
56 sysfs_remove_dir(kobj);
57 }
58 }
59 return error;
60}
61
62static inline struct kobject * to_kobj(struct list_head * entry)
63{
64 return container_of(entry,struct kobject,entry);
65}
66
67static 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 {
b365b3da
CE
77 if (kobject_name(parent) == NULL)
78 return 0;
1da177e4
LT
79 length += strlen(kobject_name(parent)) + 1;
80 parent = parent->parent;
81 } while (parent);
82 return length;
83}
84
85static 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/**
72fd4a35 102 * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
1da177e4
LT
103 *
104 * @kobj: kobject in question, with which to build the path
105 * @gfp_mask: the allocation type used to allocate the path
72fd4a35
RD
106 *
107 * The result must be freed by the caller with kfree().
1da177e4 108 */
fd4f2df2 109char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
1da177e4
LT
110{
111 char *path;
112 int len;
113
114 len = get_kobj_path_length(kobj);
b365b3da
CE
115 if (len == 0)
116 return NULL;
4668edc3 117 path = kzalloc(len, gfp_mask);
1da177e4
LT
118 if (!path)
119 return NULL;
1da177e4
LT
120 fill_kobj_path(kobj, path, len);
121
122 return path;
123}
80fc9f53 124EXPORT_SYMBOL_GPL(kobject_get_path);
1da177e4
LT
125
126/**
127 * kobject_init - initialize object.
128 * @kobj: object in question.
129 */
130void kobject_init(struct kobject * kobj)
131{
31b9025a
GKH
132 if (!kobj)
133 return;
1da177e4
LT
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
150static 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/**
90bc6135 161 * kobject_add - add an object to the hierarchy.
1da177e4
LT
162 * @kobj: object.
163 */
164
90bc6135 165int kobject_add(struct kobject * kobj)
1da177e4
LT
166{
167 int error = 0;
168 struct kobject * parent;
169
170 if (!(kobj = kobject_get(kobj)))
171 return -ENOENT;
172 if (!kobj->k_name)
ce2c9cb0 173 kobject_set_name(kobj, "NO_NAME");
13507701 174 if (!*kobj->k_name) {
c171fef5
GKH
175 pr_debug("kobject attempted to be registered with no name!\n");
176 WARN_ON(1);
88db4721 177 kobject_put(kobj);
c171fef5
GKH
178 return -EINVAL;
179 }
1da177e4
LT
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>",
ce2c9cb0 184 kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>" );
1da177e4
LT
185
186 if (kobj->kset) {
187 spin_lock(&kobj->kset->list_lock);
188
b727c702 189 if (!parent) {
1da177e4 190 parent = kobject_get(&kobj->kset->kobj);
b727c702
GKH
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 }
1da177e4
LT
198
199 list_add_tail(&kobj->entry,&kobj->kset->list);
200 spin_unlock(&kobj->kset->list_lock);
460f7e9a 201 kobj->parent = parent;
1da177e4 202 }
1da177e4 203
90bc6135 204 error = create_dir(kobj);
1da177e4
LT
205 if (error) {
206 /* unlink does the kobject_put() for us */
207 unlink(kobj);
b067db49 208 kobject_put(parent);
dcd0da00
GKH
209
210 /* be noisy on error issues */
211 if (error == -EEXIST)
5c73a3fb
GKH
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",
dcd0da00
GKH
215 kobject_name(kobj));
216 else
5c73a3fb 217 printk(KERN_ERR "kobject_add failed for %s (%d)\n",
dcd0da00 218 kobject_name(kobj), error);
5c73a3fb 219 dump_stack();
1da177e4
LT
220 }
221
222 return error;
223}
224
1da177e4
LT
225/**
226 * kobject_register - initialize and add an object.
227 * @kobj: object in question.
228 */
229
230int kobject_register(struct kobject * kobj)
231{
dcd0da00 232 int error = -EINVAL;
1da177e4
LT
233 if (kobj) {
234 kobject_init(kobj);
235 error = kobject_add(kobj);
dcd0da00 236 if (!error)
312c004d 237 kobject_uevent(kobj, KOBJ_ADD);
dcd0da00 238 }
1da177e4
LT
239 return error;
240}
241
663a4743
GKH
242/**
243 * kobject_set_name_vargs - Set the name of an kobject
244 * @kobj: struct kobject to set the name of
245 * @fmt: format string used to build the name
246 * @vargs: vargs to format the string.
247 */
248static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
249 va_list vargs)
250{
251 va_list aq;
252 char *name;
253
254 va_copy(aq, vargs);
255 name = kvasprintf(GFP_KERNEL, fmt, vargs);
256 va_end(aq);
257
258 if (!name)
259 return -ENOMEM;
260
261 /* Free the old name, if necessary. */
262 kfree(kobj->k_name);
263
264 /* Now, set the new name */
265 kobj->k_name = name;
266
267 return 0;
268}
1da177e4
LT
269
270/**
8c4606b1 271 * kobject_set_name - Set the name of a kobject
663a4743 272 * @kobj: struct kobject to set the name of
8c4606b1 273 * @fmt: format string used to build the name
1da177e4 274 *
8c4606b1
GKH
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.
1da177e4 278 */
663a4743 279int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
1da177e4 280{
1da177e4 281 va_list args;
663a4743 282 int retval;
1da177e4 283
ce2c9cb0 284 va_start(args, fmt);
663a4743 285 retval = kobject_set_name_vargs(kobj, fmt, args);
1da177e4 286 va_end(args);
1da177e4 287
663a4743 288 return retval;
1da177e4 289}
1da177e4
LT
290EXPORT_SYMBOL(kobject_set_name);
291
e86000d0
GKH
292/**
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 */
304void 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
328error:
329 printk(KERN_ERR "kobject: %s\n", err_str);
330 dump_stack();
331}
332EXPORT_SYMBOL(kobject_init_ng);
333
244f6cee
GKH
334static 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 */
383int 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}
398EXPORT_SYMBOL(kobject_add_ng);
399
c11c4154
GKH
400/**
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 */
411int 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}
425EXPORT_SYMBOL_GPL(kobject_init_and_add);
426
1da177e4
LT
427/**
428 * kobject_rename - change the name of an object
429 * @kobj: object in question.
430 * @new_name: object's new name
431 */
432
f3b4f3c6 433int kobject_rename(struct kobject * kobj, const char *new_name)
1da177e4
LT
434{
435 int error = 0;
ca2f37db
JT
436 const char *devpath = NULL;
437 char *devpath_string = NULL;
438 char *envp[2];
1da177e4
LT
439
440 kobj = kobject_get(kobj);
441 if (!kobj)
442 return -EINVAL;
b592fcfe
EB
443 if (!kobj->parent)
444 return -EINVAL;
ca2f37db 445
34358c26
GKH
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) {
71409a49
JB
451 printk(KERN_WARNING "kobject '%s' cannot be renamed "
452 "to '%s' as '%s' is already in existence.\n",
34358c26
GKH
453 kobject_name(kobj), new_name, new_name);
454 kobject_put(temp_kobj);
455 return -EINVAL;
456 }
457 }
458
ca2f37db
JT
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;
ca2f37db 472
90bc6135 473 error = sysfs_rename_dir(kobj, new_name);
ca2f37db
JT
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
481out:
482 kfree(devpath_string);
483 kfree(devpath);
b592fcfe
EB
484 kobject_put(kobj);
485
486 return error;
487}
488
8a82472f
CH
489/**
490 * kobject_move - move object to another parent
491 * @kobj: object in question.
c744aeae 492 * @new_parent: object's new parent (can be NULL)
8a82472f
CH
493 */
494
495int 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) {
c744aeae
CH
508 if (kobj->kset)
509 new_parent = kobject_get(&kobj->kset->kobj);
8a82472f
CH
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;
9e993efb 530 new_parent = NULL;
8a82472f
CH
531 kobject_put(old_parent);
532 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
533out:
9e993efb 534 kobject_put(new_parent);
8a82472f
CH
535 kobject_put(kobj);
536 kfree(devpath_string);
537 kfree(devpath);
538 return error;
539}
540
1da177e4
LT
541/**
542 * kobject_del - unlink kobject from hierarchy.
543 * @kobj: object.
544 */
545
546void kobject_del(struct kobject * kobj)
547{
31b9025a
GKH
548 if (!kobj)
549 return;
1da177e4
LT
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
559void kobject_unregister(struct kobject * kobj)
560{
31b9025a
GKH
561 if (!kobj)
562 return;
1da177e4 563 pr_debug("kobject %s: unregistering\n",kobject_name(kobj));
312c004d 564 kobject_uevent(kobj, KOBJ_REMOVE);
1da177e4
LT
565 kobject_del(kobj);
566 kobject_put(kobj);
567}
568
569/**
570 * kobject_get - increment refcount for object.
571 * @kobj: object.
572 */
573
574struct kobject * kobject_get(struct kobject * kobj)
575{
576 if (kobj)
577 kref_get(&kobj->kref);
578 return kobj;
579}
580
18041f47
GKH
581/*
582 * kobject_cleanup - free kobject resources.
583 * @kobj: object to cleanup
1da177e4 584 */
18041f47 585static void kobject_cleanup(struct kobject *kobj)
1da177e4
LT
586{
587 struct kobj_type * t = get_ktype(kobj);
588 struct kset * s = kobj->kset;
589 struct kobject * parent = kobj->parent;
ce2c9cb0 590 const char *name = kobj->k_name;
1da177e4
LT
591
592 pr_debug("kobject %s: cleaning up\n",kobject_name(kobj));
ce2c9cb0 593 if (t && t->release) {
1da177e4 594 t->release(kobj);
ce2c9cb0
GKH
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 }
1da177e4
LT
600 if (s)
601 kset_put(s);
b067db49 602 kobject_put(parent);
1da177e4
LT
603}
604
605static 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 */
616void kobject_put(struct kobject * kobj)
617{
618 if (kobj)
619 kref_put(&kobj->kref, kobject_release);
620}
621
3f9e3ee9 622static void dynamic_kobj_release(struct kobject *kobj)
7423172a 623{
3f9e3ee9 624 pr_debug("%s: freeing %s\n", __FUNCTION__, kobject_name(kobj));
7423172a
JN
625 kfree(kobj);
626}
627
3f9e3ee9
GKH
628static struct kobj_type dynamic_kobj_ktype = {
629 .release = dynamic_kobj_release,
7423172a
JN
630};
631
3f9e3ee9
GKH
632/*
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.
639 */
640static struct kobject *kobject_create(void)
641{
642 struct kobject *kobj;
643
644 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
645 if (!kobj)
646 return NULL;
647
648 kobject_init_ng(kobj, &dynamic_kobj_ktype);
649 return kobj;
650}
651
652/**
653 * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
654 *
655 * @name: the name for the kset
656 * @parent: the parent kobject of this kobject, if any.
657 *
658 * This function creates a kset structure dynamically and registers it
659 * with sysfs. When you are finished with this structure, call
660 * kobject_unregister() and the structure will be dynamically freed when
661 * it is no longer being used.
662 *
663 * If the kobject was not able to be created, NULL will be returned.
664 */
665struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
666{
667 struct kobject *kobj;
668 int retval;
669
670 kobj = kobject_create();
671 if (!kobj)
672 return NULL;
673
674 retval = kobject_add_ng(kobj, parent, "%s", name);
675 if (retval) {
676 printk(KERN_WARNING "%s: kobject_add error: %d\n",
677 __FUNCTION__, retval);
678 kobject_put(kobj);
679 kobj = NULL;
680 }
681 return kobj;
682}
683EXPORT_SYMBOL_GPL(kobject_create_and_add);
684
7423172a 685/**
2753133e 686 * kobject_kset_add_dir - add sub directory of object.
86406245 687 * @kset: kset the directory is belongs to.
7423172a
JN
688 * @parent: object in which a directory is created.
689 * @name: directory name.
690 *
691 * Add a plain directory object as child of given object.
692 */
86406245
KS
693struct kobject *kobject_kset_add_dir(struct kset *kset,
694 struct kobject *parent, const char *name)
7423172a
JN
695{
696 struct kobject *k;
10188012 697 int ret;
7423172a 698
3f9e3ee9 699 k = kobject_create();
7423172a
JN
700 if (!k)
701 return NULL;
702
86406245 703 k->kset = kset;
3f9e3ee9 704 ret = kobject_add_ng(k, parent, "%s", name);
10188012 705 if (ret < 0) {
3f9e3ee9 706 printk(KERN_WARNING "%s: kobject_add error: %d\n",
2753133e 707 __func__, ret);
3f9e3ee9
GKH
708 kobject_put(k);
709 k = NULL;
10188012 710 }
7423172a
JN
711
712 return k;
713}
7423172a 714
1da177e4
LT
715/**
716 * kset_init - initialize a kset for use
717 * @k: kset
718 */
719
720void kset_init(struct kset * k)
721{
722 kobject_init(&k->kobj);
723 INIT_LIST_HEAD(&k->list);
724 spin_lock_init(&k->list_lock);
725}
726
727
728/**
729 * kset_add - add a kset object to the hierarchy.
730 * @k: kset.
1da177e4
LT
731 */
732
733int kset_add(struct kset * k)
734{
1da177e4
LT
735 return kobject_add(&k->kobj);
736}
737
738
739/**
740 * kset_register - initialize and add a kset.
741 * @k: kset.
742 */
743
744int kset_register(struct kset * k)
745{
80f03e34
KS
746 int err;
747
31b9025a
GKH
748 if (!k)
749 return -EINVAL;
80f03e34 750
1da177e4 751 kset_init(k);
80f03e34
KS
752 err = kset_add(k);
753 if (err)
754 return err;
755 kobject_uevent(&k->kobj, KOBJ_ADD);
756 return 0;
1da177e4
LT
757}
758
759
760/**
761 * kset_unregister - remove a kset.
762 * @k: kset.
763 */
764
765void kset_unregister(struct kset * k)
766{
31b9025a
GKH
767 if (!k)
768 return;
1da177e4
LT
769 kobject_unregister(&k->kobj);
770}
771
772
773/**
774 * kset_find_obj - search for object in kset.
775 * @kset: kset we're looking in.
776 * @name: object's name.
777 *
778 * Lock kset via @kset->subsys, and iterate over @kset->list,
779 * looking for a matching kobject. If matching object is found
780 * take a reference and return the object.
781 */
782
783struct kobject * kset_find_obj(struct kset * kset, const char * name)
784{
785 struct list_head * entry;
786 struct kobject * ret = NULL;
787
788 spin_lock(&kset->list_lock);
789 list_for_each(entry,&kset->list) {
790 struct kobject * k = to_kobj(entry);
791 if (kobject_name(k) && !strcmp(kobject_name(k),name)) {
792 ret = kobject_get(k);
793 break;
794 }
795 }
796 spin_unlock(&kset->list_lock);
797 return ret;
798}
799
823bccfc 800int subsystem_register(struct kset *s)
1da177e4 801{
823bccfc 802 return kset_register(s);
1da177e4
LT
803}
804
823bccfc 805void subsystem_unregister(struct kset *s)
1da177e4 806{
823bccfc 807 kset_unregister(s);
1da177e4
LT
808}
809
1da177e4
LT
810/**
811 * subsystem_create_file - export sysfs attribute file.
812 * @s: subsystem.
813 * @a: subsystem attribute descriptor.
814 */
815
823bccfc 816int subsys_create_file(struct kset *s, struct subsys_attribute *a)
1da177e4
LT
817{
818 int error = 0;
31b9025a
GKH
819
820 if (!s || !a)
821 return -EINVAL;
822
1ef4cfac 823 if (kset_get(s)) {
823bccfc 824 error = sysfs_create_file(&s->kobj, &a->attr);
6e9d930d 825 kset_put(s);
1da177e4
LT
826 }
827 return error;
828}
829
b727c702
GKH
830static void kset_release(struct kobject *kobj)
831{
832 struct kset *kset = container_of(kobj, struct kset, kobj);
833 pr_debug("kset %s: now freed\n", kobject_name(kobj));
834 kfree(kset);
835}
836
837static struct kobj_type kset_type = {
838 .release = kset_release,
839};
840
841/**
842 * kset_create - create a struct kset dynamically
843 *
844 * @name: the name for the kset
845 * @uevent_ops: a struct kset_uevent_ops for the kset
846 * @parent_kobj: the parent kobject of this kset, if any.
847 *
848 * This function creates a kset structure dynamically. This structure can
849 * then be registered with the system and show up in sysfs with a call to
850 * kset_register(). When you are finished with this structure, if
851 * kset_register() has been called, call kset_unregister() and the
852 * structure will be dynamically freed when it is no longer being used.
853 *
854 * If the kset was not able to be created, NULL will be returned.
855 */
856static struct kset *kset_create(const char *name,
857 struct kset_uevent_ops *uevent_ops,
858 struct kobject *parent_kobj)
859{
860 struct kset *kset;
861
862 kset = kzalloc(sizeof(*kset), GFP_KERNEL);
863 if (!kset)
864 return NULL;
865 kobject_set_name(&kset->kobj, name);
866 kset->uevent_ops = uevent_ops;
867 kset->kobj.parent = parent_kobj;
868
869 /*
870 * The kobject of this kset will have a type of kset_type and belong to
871 * no kset itself. That way we can properly free it when it is
872 * finished being used.
873 */
874 kset->kobj.ktype = &kset_type;
875 kset->kobj.kset = NULL;
876
877 return kset;
878}
879
880/**
881 * kset_create_and_add - create a struct kset dynamically and add it to sysfs
882 *
883 * @name: the name for the kset
884 * @uevent_ops: a struct kset_uevent_ops for the kset
885 * @parent_kobj: the parent kobject of this kset, if any.
886 *
887 * This function creates a kset structure dynamically and registers it
888 * with sysfs. When you are finished with this structure, call
889 * kset_unregister() and the structure will be dynamically freed when it
890 * is no longer being used.
891 *
892 * If the kset was not able to be created, NULL will be returned.
893 */
894struct kset *kset_create_and_add(const char *name,
895 struct kset_uevent_ops *uevent_ops,
896 struct kobject *parent_kobj)
897{
898 struct kset *kset;
899 int error;
900
901 kset = kset_create(name, uevent_ops, parent_kobj);
902 if (!kset)
903 return NULL;
904 error = kset_register(kset);
905 if (error) {
906 kfree(kset);
907 return NULL;
908 }
909 return kset;
910}
911EXPORT_SYMBOL_GPL(kset_create_and_add);
912
1da177e4
LT
913EXPORT_SYMBOL(kobject_init);
914EXPORT_SYMBOL(kobject_register);
915EXPORT_SYMBOL(kobject_unregister);
916EXPORT_SYMBOL(kobject_get);
917EXPORT_SYMBOL(kobject_put);
918EXPORT_SYMBOL(kobject_add);
919EXPORT_SYMBOL(kobject_del);
920
921EXPORT_SYMBOL(kset_register);
922EXPORT_SYMBOL(kset_unregister);
1da177e4 923
1da177e4
LT
924EXPORT_SYMBOL(subsystem_register);
925EXPORT_SYMBOL(subsystem_unregister);
926EXPORT_SYMBOL(subsys_create_file);