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