10ae2ebeaf96d98a2348c4dbf68f53c96acd6c30
[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  *
6  * This file is released under the GPLv2.
7  *
8  *
9  * Please see the file Documentation/kobject.txt for critical information
10  * about using the kobject interface.
11  */
12
13 #include <linux/kobject.h>
14 #include <linux/string.h>
15 #include <linux/module.h>
16 #include <linux/stat.h>
17 #include <linux/slab.h>
18
19 /**
20  *      populate_dir - populate directory with attributes.
21  *      @kobj:  object we're working on.
22  *
23  *      Most subsystems have a set of default attributes that 
24  *      are associated with an object that registers with them.
25  *      This is a helper called during object registration that 
26  *      loops through the default attributes of the subsystem 
27  *      and creates attributes files for them in sysfs.
28  *
29  */
30
31 static int populate_dir(struct kobject * kobj)
32 {
33         struct kobj_type * t = get_ktype(kobj);
34         struct attribute * attr;
35         int error = 0;
36         int i;
37         
38         if (t && t->default_attrs) {
39                 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
40                         if ((error = sysfs_create_file(kobj,attr)))
41                                 break;
42                 }
43         }
44         return error;
45 }
46
47 static int create_dir(struct kobject *kobj, struct sysfs_dirent *shadow_parent)
48 {
49         int error = 0;
50         if (kobject_name(kobj)) {
51                 error = sysfs_create_dir(kobj, shadow_parent);
52                 if (!error) {
53                         if ((error = populate_dir(kobj)))
54                                 sysfs_remove_dir(kobj);
55                 }
56         }
57         return error;
58 }
59
60 static inline struct kobject * to_kobj(struct list_head * entry)
61 {
62         return container_of(entry,struct kobject,entry);
63 }
64
65 static int get_kobj_path_length(struct kobject *kobj)
66 {
67         int length = 1;
68         struct kobject * parent = kobj;
69
70         /* walk up the ancestors until we hit the one pointing to the 
71          * root.
72          * Add 1 to strlen for leading '/' of each level.
73          */
74         do {
75                 if (kobject_name(parent) == NULL)
76                         return 0;
77                 length += strlen(kobject_name(parent)) + 1;
78                 parent = parent->parent;
79         } while (parent);
80         return length;
81 }
82
83 static void fill_kobj_path(struct kobject *kobj, char *path, int length)
84 {
85         struct kobject * parent;
86
87         --length;
88         for (parent = kobj; parent; parent = parent->parent) {
89                 int cur = strlen(kobject_name(parent));
90                 /* back up enough to print this name with '/' */
91                 length -= cur;
92                 strncpy (path + length, kobject_name(parent), cur);
93                 *(path + --length) = '/';
94         }
95
96         pr_debug("%s: path = '%s'\n",__FUNCTION__,path);
97 }
98
99 /**
100  * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
101  *
102  * @kobj:       kobject in question, with which to build the path
103  * @gfp_mask:   the allocation type used to allocate the path
104  *
105  * The result must be freed by the caller with kfree().
106  */
107 char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
108 {
109         char *path;
110         int len;
111
112         len = get_kobj_path_length(kobj);
113         if (len == 0)
114                 return NULL;
115         path = kzalloc(len, gfp_mask);
116         if (!path)
117                 return NULL;
118         fill_kobj_path(kobj, path, len);
119
120         return path;
121 }
122 EXPORT_SYMBOL_GPL(kobject_get_path);
123
124 /**
125  *      kobject_init - initialize object.
126  *      @kobj:  object in question.
127  */
128 void kobject_init(struct kobject * kobj)
129 {
130         if (!kobj)
131                 return;
132         kref_init(&kobj->kref);
133         INIT_LIST_HEAD(&kobj->entry);
134         init_waitqueue_head(&kobj->poll);
135         kobj->kset = kset_get(kobj->kset);
136 }
137
138
139 /**
140  *      unlink - remove kobject from kset list.
141  *      @kobj:  kobject.
142  *
143  *      Remove the kobject from the kset list and decrement
144  *      its parent's refcount.
145  *      This is separated out, so we can use it in both 
146  *      kobject_del() and kobject_add() on error.
147  */
148
149 static void unlink(struct kobject * kobj)
150 {
151         if (kobj->kset) {
152                 spin_lock(&kobj->kset->list_lock);
153                 list_del_init(&kobj->entry);
154                 spin_unlock(&kobj->kset->list_lock);
155         }
156         kobject_put(kobj);
157 }
158
159 /**
160  *      kobject_shadow_add - add an object to the hierarchy.
161  *      @kobj:  object.
162  *      @shadow_parent: sysfs directory to add to.
163  */
164
165 int kobject_shadow_add(struct kobject *kobj, struct sysfs_dirent *shadow_parent)
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, shadow_parent);
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_add - add an object to the hierarchy.
220  *      @kobj:  object.
221  */
222 int kobject_add(struct kobject * kobj)
223 {
224         return kobject_shadow_add(kobj, NULL);
225 }
226
227
228 /**
229  *      kobject_register - initialize and add an object.
230  *      @kobj:  object in question.
231  */
232
233 int kobject_register(struct kobject * kobj)
234 {
235         int error = -EINVAL;
236         if (kobj) {
237                 kobject_init(kobj);
238                 error = kobject_add(kobj);
239                 if (!error)
240                         kobject_uevent(kobj, KOBJ_ADD);
241         }
242         return error;
243 }
244
245
246 /**
247  *      kobject_set_name - Set the name of an object
248  *      @kobj:  object.
249  *      @fmt:   format string used to build the name
250  *
251  *      If strlen(name) >= KOBJ_NAME_LEN, then use a dynamically allocated
252  *      string that @kobj->k_name points to. Otherwise, use the static 
253  *      @kobj->name array.
254  */
255 int kobject_set_name(struct kobject * kobj, const char * fmt, ...)
256 {
257         int error = 0;
258         int limit;
259         int need;
260         va_list args;
261         char *name;
262
263         /* find out how big a buffer we need */
264         name = kmalloc(1024, GFP_KERNEL);
265         if (!name) {
266                 error = -ENOMEM;
267                 goto done;
268         }
269         va_start(args, fmt);
270         need = vsnprintf(name, 1024, fmt, args);
271         va_end(args);
272         kfree(name);
273
274         /* Allocate the new space and copy the string in */
275         limit = need + 1;
276         name = kmalloc(limit, GFP_KERNEL);
277         if (!name) {
278                 error = -ENOMEM;
279                 goto done;
280         }
281         va_start(args, fmt);
282         need = vsnprintf(name, limit, fmt, args);
283         va_end(args);
284
285         /* something wrong with the string we copied? */
286         if (need >= limit) {
287                 kfree(name);
288                 error = -EFAULT;
289                 goto done;
290         }
291
292         /* Free the old name, if necessary. */
293         kfree(kobj->k_name);
294
295         /* Now, set the new name */
296         kobj->k_name = name;
297 done:
298         return error;
299 }
300 EXPORT_SYMBOL(kobject_set_name);
301
302 /**
303  *      kobject_rename - change the name of an object
304  *      @kobj:  object in question.
305  *      @new_name: object's new name
306  */
307
308 int kobject_rename(struct kobject * kobj, const char *new_name)
309 {
310         int error = 0;
311         const char *devpath = NULL;
312         char *devpath_string = NULL;
313         char *envp[2];
314
315         kobj = kobject_get(kobj);
316         if (!kobj)
317                 return -EINVAL;
318         if (!kobj->parent)
319                 return -EINVAL;
320
321         devpath = kobject_get_path(kobj, GFP_KERNEL);
322         if (!devpath) {
323                 error = -ENOMEM;
324                 goto out;
325         }
326         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
327         if (!devpath_string) {
328                 error = -ENOMEM;
329                 goto out;
330         }
331         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
332         envp[0] = devpath_string;
333         envp[1] = NULL;
334         /* Note : if we want to send the new name alone, not the full path,
335          * we could probably use kobject_name(kobj); */
336
337         error = sysfs_rename_dir(kobj, kobj->parent->sd, new_name);
338
339         /* This function is mostly/only used for network interface.
340          * Some hotplug package track interfaces by their name and
341          * therefore want to know when the name is changed by the user. */
342         if (!error)
343                 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
344
345 out:
346         kfree(devpath_string);
347         kfree(devpath);
348         kobject_put(kobj);
349
350         return error;
351 }
352
353 /**
354  *      kobject_rename - change the name of an object
355  *      @kobj:  object in question.
356  *      @new_parent: object's new parent
357  *      @new_name: object's new name
358  */
359
360 int kobject_shadow_rename(struct kobject *kobj,
361                           struct sysfs_dirent *new_parent, const char *new_name)
362 {
363         int error = 0;
364
365         kobj = kobject_get(kobj);
366         if (!kobj)
367                 return -EINVAL;
368         error = sysfs_rename_dir(kobj, new_parent, new_name);
369         kobject_put(kobj);
370
371         return error;
372 }
373
374 /**
375  *      kobject_move - move object to another parent
376  *      @kobj:  object in question.
377  *      @new_parent: object's new parent (can be NULL)
378  */
379
380 int kobject_move(struct kobject *kobj, struct kobject *new_parent)
381 {
382         int error;
383         struct kobject *old_parent;
384         const char *devpath = NULL;
385         char *devpath_string = NULL;
386         char *envp[2];
387
388         kobj = kobject_get(kobj);
389         if (!kobj)
390                 return -EINVAL;
391         new_parent = kobject_get(new_parent);
392         if (!new_parent) {
393                 if (kobj->kset)
394                         new_parent = kobject_get(&kobj->kset->kobj);
395         }
396         /* old object path */
397         devpath = kobject_get_path(kobj, GFP_KERNEL);
398         if (!devpath) {
399                 error = -ENOMEM;
400                 goto out;
401         }
402         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
403         if (!devpath_string) {
404                 error = -ENOMEM;
405                 goto out;
406         }
407         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
408         envp[0] = devpath_string;
409         envp[1] = NULL;
410         error = sysfs_move_dir(kobj, new_parent);
411         if (error)
412                 goto out;
413         old_parent = kobj->parent;
414         kobj->parent = new_parent;
415         new_parent = NULL;
416         kobject_put(old_parent);
417         kobject_uevent_env(kobj, KOBJ_MOVE, envp);
418 out:
419         kobject_put(new_parent);
420         kobject_put(kobj);
421         kfree(devpath_string);
422         kfree(devpath);
423         return error;
424 }
425
426 /**
427  *      kobject_del - unlink kobject from hierarchy.
428  *      @kobj:  object.
429  */
430
431 void kobject_del(struct kobject * kobj)
432 {
433         if (!kobj)
434                 return;
435         sysfs_remove_dir(kobj);
436         unlink(kobj);
437 }
438
439 /**
440  *      kobject_unregister - remove object from hierarchy and decrement refcount.
441  *      @kobj:  object going away.
442  */
443
444 void kobject_unregister(struct kobject * kobj)
445 {
446         if (!kobj)
447                 return;
448         pr_debug("kobject %s: unregistering\n",kobject_name(kobj));
449         kobject_uevent(kobj, KOBJ_REMOVE);
450         kobject_del(kobj);
451         kobject_put(kobj);
452 }
453
454 /**
455  *      kobject_get - increment refcount for object.
456  *      @kobj:  object.
457  */
458
459 struct kobject * kobject_get(struct kobject * kobj)
460 {
461         if (kobj)
462                 kref_get(&kobj->kref);
463         return kobj;
464 }
465
466 /**
467  *      kobject_cleanup - free kobject resources. 
468  *      @kobj:  object.
469  */
470
471 void kobject_cleanup(struct kobject * kobj)
472 {
473         struct kobj_type * t = get_ktype(kobj);
474         struct kset * s = kobj->kset;
475         struct kobject * parent = kobj->parent;
476         const char *name = kobj->k_name;
477
478         pr_debug("kobject %s: cleaning up\n",kobject_name(kobj));
479         if (t && t->release) {
480                 t->release(kobj);
481                 /* If we have a release function, we can guess that this was
482                  * not a statically allocated kobject, so we should be safe to
483                  * free the name */
484                 kfree(name);
485         }
486         if (s)
487                 kset_put(s);
488         kobject_put(parent);
489 }
490
491 static void kobject_release(struct kref *kref)
492 {
493         kobject_cleanup(container_of(kref, struct kobject, kref));
494 }
495
496 /**
497  *      kobject_put - decrement refcount for object.
498  *      @kobj:  object.
499  *
500  *      Decrement the refcount, and if 0, call kobject_cleanup().
501  */
502 void kobject_put(struct kobject * kobj)
503 {
504         if (kobj)
505                 kref_put(&kobj->kref, kobject_release);
506 }
507
508
509 static void dir_release(struct kobject *kobj)
510 {
511         kfree(kobj);
512 }
513
514 static struct kobj_type dir_ktype = {
515         .release        = dir_release,
516         .sysfs_ops      = NULL,
517         .default_attrs  = NULL,
518 };
519
520 /**
521  *      kobject_kset_add_dir - add sub directory of object.
522  *      @kset:          kset the directory is belongs to.
523  *      @parent:        object in which a directory is created.
524  *      @name:  directory name.
525  *
526  *      Add a plain directory object as child of given object.
527  */
528 struct kobject *kobject_kset_add_dir(struct kset *kset,
529                                      struct kobject *parent, const char *name)
530 {
531         struct kobject *k;
532         int ret;
533
534         if (!parent)
535                 return NULL;
536
537         k = kzalloc(sizeof(*k), GFP_KERNEL);
538         if (!k)
539                 return NULL;
540
541         k->kset = kset;
542         k->parent = parent;
543         k->ktype = &dir_ktype;
544         kobject_set_name(k, name);
545         ret = kobject_register(k);
546         if (ret < 0) {
547                 printk(KERN_WARNING "%s: kobject_register error: %d\n",
548                         __func__, ret);
549                 kobject_del(k);
550                 return NULL;
551         }
552
553         return k;
554 }
555
556 /**
557  *      kobject_add_dir - add sub directory of object.
558  *      @parent:        object in which a directory is created.
559  *      @name:  directory name.
560  *
561  *      Add a plain directory object as child of given object.
562  */
563 struct kobject *kobject_add_dir(struct kobject *parent, const char *name)
564 {
565         return kobject_kset_add_dir(NULL, parent, name);
566 }
567
568 /**
569  *      kset_init - initialize a kset for use
570  *      @k:     kset 
571  */
572
573 void kset_init(struct kset * k)
574 {
575         kobject_init(&k->kobj);
576         INIT_LIST_HEAD(&k->list);
577         spin_lock_init(&k->list_lock);
578 }
579
580
581 /**
582  *      kset_add - add a kset object to the hierarchy.
583  *      @k:     kset.
584  */
585
586 int kset_add(struct kset * k)
587 {
588         return kobject_add(&k->kobj);
589 }
590
591
592 /**
593  *      kset_register - initialize and add a kset.
594  *      @k:     kset.
595  */
596
597 int kset_register(struct kset * k)
598 {
599         int err;
600
601         if (!k)
602                 return -EINVAL;
603
604         kset_init(k);
605         err = kset_add(k);
606         if (err)
607                 return err;
608         kobject_uevent(&k->kobj, KOBJ_ADD);
609         return 0;
610 }
611
612
613 /**
614  *      kset_unregister - remove a kset.
615  *      @k:     kset.
616  */
617
618 void kset_unregister(struct kset * k)
619 {
620         if (!k)
621                 return;
622         kobject_unregister(&k->kobj);
623 }
624
625
626 /**
627  *      kset_find_obj - search for object in kset.
628  *      @kset:  kset we're looking in.
629  *      @name:  object's name.
630  *
631  *      Lock kset via @kset->subsys, and iterate over @kset->list,
632  *      looking for a matching kobject. If matching object is found
633  *      take a reference and return the object.
634  */
635
636 struct kobject * kset_find_obj(struct kset * kset, const char * name)
637 {
638         struct list_head * entry;
639         struct kobject * ret = NULL;
640
641         spin_lock(&kset->list_lock);
642         list_for_each(entry,&kset->list) {
643                 struct kobject * k = to_kobj(entry);
644                 if (kobject_name(k) && !strcmp(kobject_name(k),name)) {
645                         ret = kobject_get(k);
646                         break;
647                 }
648         }
649         spin_unlock(&kset->list_lock);
650         return ret;
651 }
652
653 void subsystem_init(struct kset *s)
654 {
655         kset_init(s);
656 }
657
658 int subsystem_register(struct kset *s)
659 {
660         return kset_register(s);
661 }
662
663 void subsystem_unregister(struct kset *s)
664 {
665         kset_unregister(s);
666 }
667
668 /**
669  *      subsystem_create_file - export sysfs attribute file.
670  *      @s:     subsystem.
671  *      @a:     subsystem attribute descriptor.
672  */
673
674 int subsys_create_file(struct kset *s, struct subsys_attribute *a)
675 {
676         int error = 0;
677
678         if (!s || !a)
679                 return -EINVAL;
680
681         if (kset_get(s)) {
682                 error = sysfs_create_file(&s->kobj, &a->attr);
683                 kset_put(s);
684         }
685         return error;
686 }
687
688 EXPORT_SYMBOL(kobject_init);
689 EXPORT_SYMBOL(kobject_register);
690 EXPORT_SYMBOL(kobject_unregister);
691 EXPORT_SYMBOL(kobject_get);
692 EXPORT_SYMBOL(kobject_put);
693 EXPORT_SYMBOL(kobject_add);
694 EXPORT_SYMBOL(kobject_del);
695
696 EXPORT_SYMBOL(kset_register);
697 EXPORT_SYMBOL(kset_unregister);
698
699 EXPORT_SYMBOL(subsystem_register);
700 EXPORT_SYMBOL(subsystem_unregister);
701 EXPORT_SYMBOL(subsys_create_file);