9500339ae0249d29163261bb489475e90a924a09
[linux-2.6.git] / lib / kobject.c
1 /*
2  * kobject.c - library routines for handling generic kernel objects
3  *
4  * Copyright (c) 2002-2003 Patrick Mochel <mochel@osdl.org>
5  * Copyright (c) 2006-2007 Greg Kroah-Hartman <greg@kroah.com>
6  * Copyright (c) 2006-2007 Novell Inc.
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>
19 #include <linux/slab.h>
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
49 static int create_dir(struct kobject * kobj)
50 {
51         int error = 0;
52         if (kobject_name(kobj)) {
53                 error = sysfs_create_dir(kobj);
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 {
77                 if (kobject_name(parent) == NULL)
78                         return 0;
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 /**
102  * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
103  *
104  * @kobj:       kobject in question, with which to build the path
105  * @gfp_mask:   the allocation type used to allocate the path
106  *
107  * The result must be freed by the caller with kfree().
108  */
109 char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
110 {
111         char *path;
112         int len;
113
114         len = get_kobj_path_length(kobj);
115         if (len == 0)
116                 return NULL;
117         path = kzalloc(len, gfp_mask);
118         if (!path)
119                 return NULL;
120         fill_kobj_path(kobj, path, len);
121
122         return path;
123 }
124 EXPORT_SYMBOL_GPL(kobject_get_path);
125
126 /**
127  *      kobject_init - initialize object.
128  *      @kobj:  object in question.
129  */
130 void kobject_init(struct kobject * kobj)
131 {
132         if (!kobj)
133                 return;
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 /**
161  *      kobject_add - add an object to the hierarchy.
162  *      @kobj:  object.
163  */
164
165 int kobject_add(struct kobject * kobj)
166 {
167         int error = 0;
168         struct kobject * parent;
169
170         if (!(kobj = kobject_get(kobj)))
171                 return -ENOENT;
172         if (!kobj->k_name)
173                 kobject_set_name(kobj, "NO_NAME");
174         if (!*kobj->k_name) {
175                 pr_debug("kobject attempted to be registered with no name!\n");
176                 WARN_ON(1);
177                 kobject_put(kobj);
178                 return -EINVAL;
179         }
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>", 
184                  kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>" );
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);
194                 kobj->parent = parent;
195         }
196
197         error = create_dir(kobj);
198         if (error) {
199                 /* unlink does the kobject_put() for us */
200                 unlink(kobj);
201                 kobject_put(parent);
202
203                 /* be noisy on error issues */
204                 if (error == -EEXIST)
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",
208                                kobject_name(kobj));
209                 else
210                         printk(KERN_ERR "kobject_add failed for %s (%d)\n",
211                                kobject_name(kobj), error);
212                 dump_stack();
213         }
214
215         return error;
216 }
217
218 /**
219  *      kobject_register - initialize and add an object.
220  *      @kobj:  object in question.
221  */
222
223 int kobject_register(struct kobject * kobj)
224 {
225         int error = -EINVAL;
226         if (kobj) {
227                 kobject_init(kobj);
228                 error = kobject_add(kobj);
229                 if (!error)
230                         kobject_uevent(kobj, KOBJ_ADD);
231         }
232         return error;
233 }
234
235
236 /**
237  * kobject_set_name - Set the name of a kobject
238  * @kobj: kobject to name
239  * @fmt: format string used to build the name
240  *
241  * This sets the name of the kobject.  If you have already added the
242  * kobject to the system, you must call kobject_rename() in order to
243  * change the name of the kobject.
244  */
245 int kobject_set_name(struct kobject * kobj, const char * fmt, ...)
246 {
247         int error = 0;
248         int limit;
249         int need;
250         va_list args;
251         char *name;
252
253         /* find out how big a buffer we need */
254         name = kmalloc(1024, GFP_KERNEL);
255         if (!name) {
256                 error = -ENOMEM;
257                 goto done;
258         }
259         va_start(args, fmt);
260         need = vsnprintf(name, 1024, fmt, args);
261         va_end(args);
262         kfree(name);
263
264         /* Allocate the new space and copy the string in */
265         limit = need + 1;
266         name = kmalloc(limit, GFP_KERNEL);
267         if (!name) {
268                 error = -ENOMEM;
269                 goto done;
270         }
271         va_start(args, fmt);
272         need = vsnprintf(name, limit, fmt, args);
273         va_end(args);
274
275         /* something wrong with the string we copied? */
276         if (need >= limit) {
277                 kfree(name);
278                 error = -EFAULT;
279                 goto done;
280         }
281
282         /* Free the old name, if necessary. */
283         kfree(kobj->k_name);
284
285         /* Now, set the new name */
286         kobj->k_name = name;
287 done:
288         return error;
289 }
290 EXPORT_SYMBOL(kobject_set_name);
291
292 /**
293  *      kobject_rename - change the name of an object
294  *      @kobj:  object in question.
295  *      @new_name: object's new name
296  */
297
298 int kobject_rename(struct kobject * kobj, const char *new_name)
299 {
300         int error = 0;
301         const char *devpath = NULL;
302         char *devpath_string = NULL;
303         char *envp[2];
304
305         kobj = kobject_get(kobj);
306         if (!kobj)
307                 return -EINVAL;
308         if (!kobj->parent)
309                 return -EINVAL;
310
311         /* see if this name is already in use */
312         if (kobj->kset) {
313                 struct kobject *temp_kobj;
314                 temp_kobj = kset_find_obj(kobj->kset, new_name);
315                 if (temp_kobj) {
316                         printk(KERN_WARNING "kobject '%s' cannot be renamed "
317                                "to '%s' as '%s' is already in existence.\n",
318                                kobject_name(kobj), new_name, new_name);
319                         kobject_put(temp_kobj);
320                         return -EINVAL;
321                 }
322         }
323
324         devpath = kobject_get_path(kobj, GFP_KERNEL);
325         if (!devpath) {
326                 error = -ENOMEM;
327                 goto out;
328         }
329         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
330         if (!devpath_string) {
331                 error = -ENOMEM;
332                 goto out;
333         }
334         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
335         envp[0] = devpath_string;
336         envp[1] = NULL;
337
338         error = sysfs_rename_dir(kobj, new_name);
339
340         /* This function is mostly/only used for network interface.
341          * Some hotplug package track interfaces by their name and
342          * therefore want to know when the name is changed by the user. */
343         if (!error)
344                 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
345
346 out:
347         kfree(devpath_string);
348         kfree(devpath);
349         kobject_put(kobj);
350
351         return error;
352 }
353
354 /**
355  *      kobject_move - move object to another parent
356  *      @kobj:  object in question.
357  *      @new_parent: object's new parent (can be NULL)
358  */
359
360 int kobject_move(struct kobject *kobj, struct kobject *new_parent)
361 {
362         int error;
363         struct kobject *old_parent;
364         const char *devpath = NULL;
365         char *devpath_string = NULL;
366         char *envp[2];
367
368         kobj = kobject_get(kobj);
369         if (!kobj)
370                 return -EINVAL;
371         new_parent = kobject_get(new_parent);
372         if (!new_parent) {
373                 if (kobj->kset)
374                         new_parent = kobject_get(&kobj->kset->kobj);
375         }
376         /* old object path */
377         devpath = kobject_get_path(kobj, GFP_KERNEL);
378         if (!devpath) {
379                 error = -ENOMEM;
380                 goto out;
381         }
382         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
383         if (!devpath_string) {
384                 error = -ENOMEM;
385                 goto out;
386         }
387         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
388         envp[0] = devpath_string;
389         envp[1] = NULL;
390         error = sysfs_move_dir(kobj, new_parent);
391         if (error)
392                 goto out;
393         old_parent = kobj->parent;
394         kobj->parent = new_parent;
395         new_parent = NULL;
396         kobject_put(old_parent);
397         kobject_uevent_env(kobj, KOBJ_MOVE, envp);
398 out:
399         kobject_put(new_parent);
400         kobject_put(kobj);
401         kfree(devpath_string);
402         kfree(devpath);
403         return error;
404 }
405
406 /**
407  *      kobject_del - unlink kobject from hierarchy.
408  *      @kobj:  object.
409  */
410
411 void kobject_del(struct kobject * kobj)
412 {
413         if (!kobj)
414                 return;
415         sysfs_remove_dir(kobj);
416         unlink(kobj);
417 }
418
419 /**
420  *      kobject_unregister - remove object from hierarchy and decrement refcount.
421  *      @kobj:  object going away.
422  */
423
424 void kobject_unregister(struct kobject * kobj)
425 {
426         if (!kobj)
427                 return;
428         pr_debug("kobject %s: unregistering\n",kobject_name(kobj));
429         kobject_uevent(kobj, KOBJ_REMOVE);
430         kobject_del(kobj);
431         kobject_put(kobj);
432 }
433
434 /**
435  *      kobject_get - increment refcount for object.
436  *      @kobj:  object.
437  */
438
439 struct kobject * kobject_get(struct kobject * kobj)
440 {
441         if (kobj)
442                 kref_get(&kobj->kref);
443         return kobj;
444 }
445
446 /**
447  *      kobject_cleanup - free kobject resources. 
448  *      @kobj:  object.
449  */
450
451 void kobject_cleanup(struct kobject * kobj)
452 {
453         struct kobj_type * t = get_ktype(kobj);
454         struct kset * s = kobj->kset;
455         struct kobject * parent = kobj->parent;
456         const char *name = kobj->k_name;
457
458         pr_debug("kobject %s: cleaning up\n",kobject_name(kobj));
459         if (t && t->release) {
460                 t->release(kobj);
461                 /* If we have a release function, we can guess that this was
462                  * not a statically allocated kobject, so we should be safe to
463                  * free the name */
464                 kfree(name);
465         }
466         if (s)
467                 kset_put(s);
468         kobject_put(parent);
469 }
470
471 static void kobject_release(struct kref *kref)
472 {
473         kobject_cleanup(container_of(kref, struct kobject, kref));
474 }
475
476 /**
477  *      kobject_put - decrement refcount for object.
478  *      @kobj:  object.
479  *
480  *      Decrement the refcount, and if 0, call kobject_cleanup().
481  */
482 void kobject_put(struct kobject * kobj)
483 {
484         if (kobj)
485                 kref_put(&kobj->kref, kobject_release);
486 }
487
488
489 static void dir_release(struct kobject *kobj)
490 {
491         kfree(kobj);
492 }
493
494 static struct kobj_type dir_ktype = {
495         .release        = dir_release,
496         .sysfs_ops      = NULL,
497         .default_attrs  = NULL,
498 };
499
500 /**
501  *      kobject_kset_add_dir - add sub directory of object.
502  *      @kset:          kset the directory is belongs to.
503  *      @parent:        object in which a directory is created.
504  *      @name:  directory name.
505  *
506  *      Add a plain directory object as child of given object.
507  */
508 struct kobject *kobject_kset_add_dir(struct kset *kset,
509                                      struct kobject *parent, const char *name)
510 {
511         struct kobject *k;
512         int ret;
513
514         if (!parent)
515                 return NULL;
516
517         k = kzalloc(sizeof(*k), GFP_KERNEL);
518         if (!k)
519                 return NULL;
520
521         k->kset = kset;
522         k->parent = parent;
523         k->ktype = &dir_ktype;
524         kobject_set_name(k, name);
525         ret = kobject_register(k);
526         if (ret < 0) {
527                 printk(KERN_WARNING "%s: kobject_register error: %d\n",
528                         __func__, ret);
529                 kobject_del(k);
530                 return NULL;
531         }
532
533         return k;
534 }
535
536 /**
537  *      kobject_add_dir - add sub directory of object.
538  *      @parent:        object in which a directory is created.
539  *      @name:  directory name.
540  *
541  *      Add a plain directory object as child of given object.
542  */
543 struct kobject *kobject_add_dir(struct kobject *parent, const char *name)
544 {
545         return kobject_kset_add_dir(NULL, parent, name);
546 }
547
548 /**
549  *      kset_init - initialize a kset for use
550  *      @k:     kset 
551  */
552
553 void kset_init(struct kset * k)
554 {
555         kobject_init(&k->kobj);
556         INIT_LIST_HEAD(&k->list);
557         spin_lock_init(&k->list_lock);
558 }
559
560
561 /**
562  *      kset_add - add a kset object to the hierarchy.
563  *      @k:     kset.
564  */
565
566 int kset_add(struct kset * k)
567 {
568         return kobject_add(&k->kobj);
569 }
570
571
572 /**
573  *      kset_register - initialize and add a kset.
574  *      @k:     kset.
575  */
576
577 int kset_register(struct kset * k)
578 {
579         int err;
580
581         if (!k)
582                 return -EINVAL;
583
584         kset_init(k);
585         err = kset_add(k);
586         if (err)
587                 return err;
588         kobject_uevent(&k->kobj, KOBJ_ADD);
589         return 0;
590 }
591
592
593 /**
594  *      kset_unregister - remove a kset.
595  *      @k:     kset.
596  */
597
598 void kset_unregister(struct kset * k)
599 {
600         if (!k)
601                 return;
602         kobject_unregister(&k->kobj);
603 }
604
605
606 /**
607  *      kset_find_obj - search for object in kset.
608  *      @kset:  kset we're looking in.
609  *      @name:  object's name.
610  *
611  *      Lock kset via @kset->subsys, and iterate over @kset->list,
612  *      looking for a matching kobject. If matching object is found
613  *      take a reference and return the object.
614  */
615
616 struct kobject * kset_find_obj(struct kset * kset, const char * name)
617 {
618         struct list_head * entry;
619         struct kobject * ret = NULL;
620
621         spin_lock(&kset->list_lock);
622         list_for_each(entry,&kset->list) {
623                 struct kobject * k = to_kobj(entry);
624                 if (kobject_name(k) && !strcmp(kobject_name(k),name)) {
625                         ret = kobject_get(k);
626                         break;
627                 }
628         }
629         spin_unlock(&kset->list_lock);
630         return ret;
631 }
632
633 int subsystem_register(struct kset *s)
634 {
635         return kset_register(s);
636 }
637
638 void subsystem_unregister(struct kset *s)
639 {
640         kset_unregister(s);
641 }
642
643 /**
644  *      subsystem_create_file - export sysfs attribute file.
645  *      @s:     subsystem.
646  *      @a:     subsystem attribute descriptor.
647  */
648
649 int subsys_create_file(struct kset *s, struct subsys_attribute *a)
650 {
651         int error = 0;
652
653         if (!s || !a)
654                 return -EINVAL;
655
656         if (kset_get(s)) {
657                 error = sysfs_create_file(&s->kobj, &a->attr);
658                 kset_put(s);
659         }
660         return error;
661 }
662
663 EXPORT_SYMBOL(kobject_init);
664 EXPORT_SYMBOL(kobject_register);
665 EXPORT_SYMBOL(kobject_unregister);
666 EXPORT_SYMBOL(kobject_get);
667 EXPORT_SYMBOL(kobject_put);
668 EXPORT_SYMBOL(kobject_add);
669 EXPORT_SYMBOL(kobject_del);
670
671 EXPORT_SYMBOL(kset_register);
672 EXPORT_SYMBOL(kset_unregister);
673
674 EXPORT_SYMBOL(subsystem_register);
675 EXPORT_SYMBOL(subsystem_unregister);
676 EXPORT_SYMBOL(subsys_create_file);