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