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  * 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  * kobject_set_name_vargs - Set the name of an kobject
 237  * @kobj: struct kobject to set the name of
 238  * @fmt: format string used to build the name
 239  * @vargs: vargs to format the string.
 240  */
 241 static int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
 242                                   va_list vargs)
 243 {
 244         va_list aq;
 245         char *name;
 246
 247         va_copy(aq, vargs);
 248         name = kvasprintf(GFP_KERNEL, fmt, vargs);
 249         va_end(aq);
 250
 251         if (!name)
 252                 return -ENOMEM;
 253
 254         /* Free the old name, if necessary. */
 255         kfree(kobj->k_name);
 256
 257         /* Now, set the new name */
 258         kobj->k_name = name;
 259
 260         return 0;
 261 }
 262
 263 /**
 264  * kobject_set_name - Set the name of a kobject
 265  * @kobj: struct kobject to set the name of
 266  * @fmt: format string used to build the name
 267  *
 268  * This sets the name of the kobject.  If you have already added the
 269  * kobject to the system, you must call kobject_rename() in order to
 270  * change the name of the kobject.
 271  */
 272 int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
 273 {
 274         va_list args;
 275         int retval;
 276
 277         va_start(args, fmt);
 278         retval = kobject_set_name_vargs(kobj, fmt, args);
 279         va_end(args);
 280
 281         return retval;
 282 }
 283 EXPORT_SYMBOL(kobject_set_name);
 284
 285 /**
 286  * kobject_init_ng - initialize a kobject structure
 287  * @kobj: pointer to the kobject to initialize
 288  * @ktype: pointer to the ktype for this kobject.
 289  *
 290  * This function will properly initialize a kobject such that it can then
 291  * be passed to the kobject_add() call.
 292  *
 293  * After this function is called, the kobject MUST be cleaned up by a call
 294  * to kobject_put(), not by a call to kfree directly to ensure that all of
 295  * the memory is cleaned up properly.
 296  */
 297 void kobject_init_ng(struct kobject *kobj, struct kobj_type *ktype)
 298 {
 299         char *err_str;
 300
 301         if (!kobj) {
 302                 err_str = "invalid kobject pointer!";
 303                 goto error;
 304         }
 305         if (!ktype) {
 306                 err_str = "must have a ktype to be initialized properly!\n";
 307                 goto error;
 308         }
 309         if (atomic_read(&kobj->kref.refcount)) {
 310                 /* do not error out as sometimes we can recover */
 311                 printk(KERN_ERR "kobject: reference count is already set, "
 312                        "something is seriously wrong.\n");
 313                 dump_stack();
 314         }
 315
 316         kref_init(&kobj->kref);
 317         INIT_LIST_HEAD(&kobj->entry);
 318         kobj->ktype = ktype;
 319         return;
 320
 321 error:
 322         printk(KERN_ERR "kobject: %s\n", err_str);
 323         dump_stack();
 324 }
 325 EXPORT_SYMBOL(kobject_init_ng);
 326
 327 /**
 328  *      kobject_rename - change the name of an object
 329  *      @kobj:  object in question.
 330  *      @new_name: object's new name
 331  */
 332
 333 int kobject_rename(struct kobject * kobj, const char *new_name)
 334 {
 335         int error = 0;
 336         const char *devpath = NULL;
 337         char *devpath_string = NULL;
 338         char *envp[2];
 339
 340         kobj = kobject_get(kobj);
 341         if (!kobj)
 342                 return -EINVAL;
 343         if (!kobj->parent)
 344                 return -EINVAL;
 345
 346         /* see if this name is already in use */
 347         if (kobj->kset) {
 348                 struct kobject *temp_kobj;
 349                 temp_kobj = kset_find_obj(kobj->kset, new_name);
 350                 if (temp_kobj) {
 351                         printk(KERN_WARNING "kobject '%s' cannot be renamed "
 352                                "to '%s' as '%s' is already in existence.\n",
 353                                kobject_name(kobj), new_name, new_name);
 354                         kobject_put(temp_kobj);
 355                         return -EINVAL;
 356                 }
 357         }
 358
 359         devpath = kobject_get_path(kobj, GFP_KERNEL);
 360         if (!devpath) {
 361                 error = -ENOMEM;
 362                 goto out;
 363         }
 364         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
 365         if (!devpath_string) {
 366                 error = -ENOMEM;
 367                 goto out;
 368         }
 369         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
 370         envp[0] = devpath_string;
 371         envp[1] = NULL;
 372
 373         error = sysfs_rename_dir(kobj, new_name);
 374
 375         /* This function is mostly/only used for network interface.
 376          * Some hotplug package track interfaces by their name and
 377          * therefore want to know when the name is changed by the user. */
 378         if (!error)
 379                 kobject_uevent_env(kobj, KOBJ_MOVE, envp);
 380
 381 out:
 382         kfree(devpath_string);
 383         kfree(devpath);
 384         kobject_put(kobj);
 385
 386         return error;
 387 }
 388
 389 /**
 390  *      kobject_move - move object to another parent
 391  *      @kobj:  object in question.
 392  *      @new_parent: object's new parent (can be NULL)
 393  */
 394
 395 int kobject_move(struct kobject *kobj, struct kobject *new_parent)
 396 {
 397         int error;
 398         struct kobject *old_parent;
 399         const char *devpath = NULL;
 400         char *devpath_string = NULL;
 401         char *envp[2];
 402
 403         kobj = kobject_get(kobj);
 404         if (!kobj)
 405                 return -EINVAL;
 406         new_parent = kobject_get(new_parent);
 407         if (!new_parent) {
 408                 if (kobj->kset)
 409                         new_parent = kobject_get(&kobj->kset->kobj);
 410         }
 411         /* old object path */
 412         devpath = kobject_get_path(kobj, GFP_KERNEL);
 413         if (!devpath) {
 414                 error = -ENOMEM;
 415                 goto out;
 416         }
 417         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
 418         if (!devpath_string) {
 419                 error = -ENOMEM;
 420                 goto out;
 421         }
 422         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
 423         envp[0] = devpath_string;
 424         envp[1] = NULL;
 425         error = sysfs_move_dir(kobj, new_parent);
 426         if (error)
 427                 goto out;
 428         old_parent = kobj->parent;
 429         kobj->parent = new_parent;
 430         new_parent = NULL;
 431         kobject_put(old_parent);
 432         kobject_uevent_env(kobj, KOBJ_MOVE, envp);
 433 out:
 434         kobject_put(new_parent);
 435         kobject_put(kobj);
 436         kfree(devpath_string);
 437         kfree(devpath);
 438         return error;
 439 }
 440
 441 /**
 442  *      kobject_del - unlink kobject from hierarchy.
 443  *      @kobj:  object.
 444  */
 445
 446 void kobject_del(struct kobject * kobj)
 447 {
 448         if (!kobj)
 449                 return;
 450         sysfs_remove_dir(kobj);
 451         unlink(kobj);
 452 }
 453
 454 /**
 455  *      kobject_unregister - remove object from hierarchy and decrement refcount.
 456  *      @kobj:  object going away.
 457  */
 458
 459 void kobject_unregister(struct kobject * kobj)
 460 {
 461         if (!kobj)
 462                 return;
 463         pr_debug("kobject %s: unregistering\n",kobject_name(kobj));
 464         kobject_uevent(kobj, KOBJ_REMOVE);
 465         kobject_del(kobj);
 466         kobject_put(kobj);
 467 }
 468
 469 /**
 470  *      kobject_get - increment refcount for object.
 471  *      @kobj:  object.
 472  */
 473
 474 struct kobject * kobject_get(struct kobject * kobj)
 475 {
 476         if (kobj)
 477                 kref_get(&kobj->kref);
 478         return kobj;
 479 }
 480
 481 /*
 482  * kobject_cleanup - free kobject resources.
 483  * @kobj: object to cleanup
 484  */
 485 static void kobject_cleanup(struct kobject *kobj)
 486 {
 487         struct kobj_type * t = get_ktype(kobj);
 488         struct kset * s = kobj->kset;
 489         struct kobject * parent = kobj->parent;
 490         const char *name = kobj->k_name;
 491
 492         pr_debug("kobject %s: cleaning up\n",kobject_name(kobj));
 493         if (t && t->release) {
 494                 t->release(kobj);
 495                 /* If we have a release function, we can guess that this was
 496                  * not a statically allocated kobject, so we should be safe to
 497                  * free the name */
 498                 kfree(name);
 499         }
 500         if (s)
 501                 kset_put(s);
 502         kobject_put(parent);
 503 }
 504
 505 static void kobject_release(struct kref *kref)
 506 {
 507         kobject_cleanup(container_of(kref, struct kobject, kref));
 508 }
 509
 510 /**
 511  *      kobject_put - decrement refcount for object.
 512  *      @kobj:  object.
 513  *
 514  *      Decrement the refcount, and if 0, call kobject_cleanup().
 515  */
 516 void kobject_put(struct kobject * kobj)
 517 {
 518         if (kobj)
 519                 kref_put(&kobj->kref, kobject_release);
 520 }
 521
 522
 523 static void dir_release(struct kobject *kobj)
 524 {
 525         kfree(kobj);
 526 }
 527
 528 static struct kobj_type dir_ktype = {
 529         .release        = dir_release,
 530         .sysfs_ops      = NULL,
 531         .default_attrs  = NULL,
 532 };
 533
 534 /**
 535  *      kobject_kset_add_dir - add sub directory of object.
 536  *      @kset:          kset the directory is belongs to.
 537  *      @parent:        object in which a directory is created.
 538  *      @name:  directory name.
 539  *
 540  *      Add a plain directory object as child of given object.
 541  */
 542 struct kobject *kobject_kset_add_dir(struct kset *kset,
 543                                      struct kobject *parent, const char *name)
 544 {
 545         struct kobject *k;
 546         int ret;
 547
 548         if (!parent)
 549                 return NULL;
 550
 551         k = kzalloc(sizeof(*k), GFP_KERNEL);
 552         if (!k)
 553                 return NULL;
 554
 555         k->kset = kset;
 556         k->parent = parent;
 557         k->ktype = &dir_ktype;
 558         kobject_set_name(k, name);
 559         ret = kobject_register(k);
 560         if (ret < 0) {
 561                 printk(KERN_WARNING "%s: kobject_register error: %d\n",
 562                         __func__, ret);
 563                 kobject_del(k);
 564                 return NULL;
 565         }
 566
 567         return k;
 568 }
 569
 570 /**
 571  *      kobject_add_dir - add sub directory of object.
 572  *      @parent:        object in which a directory is created.
 573  *      @name:  directory name.
 574  *
 575  *      Add a plain directory object as child of given object.
 576  */
 577 struct kobject *kobject_add_dir(struct kobject *parent, const char *name)
 578 {
 579         return kobject_kset_add_dir(NULL, parent, name);
 580 }
 581
 582 /**
 583  *      kset_init - initialize a kset for use
 584  *      @k:     kset
 585  */
 586
 587 void kset_init(struct kset * k)
 588 {
 589         kobject_init(&k->kobj);
 590         INIT_LIST_HEAD(&k->list);
 591         spin_lock_init(&k->list_lock);
 592 }
 593
 594
 595 /**
 596  *      kset_add - add a kset object to the hierarchy.
 597  *      @k:     kset.
 598  */
 599
 600 int kset_add(struct kset * k)
 601 {
 602         return kobject_add(&k->kobj);
 603 }
 604
 605
 606 /**
 607  *      kset_register - initialize and add a kset.
 608  *      @k:     kset.
 609  */
 610
 611 int kset_register(struct kset * k)
 612 {
 613         int err;
 614
 615         if (!k)
 616                 return -EINVAL;
 617
 618         kset_init(k);
 619         err = kset_add(k);
 620         if (err)
 621                 return err;
 622         kobject_uevent(&k->kobj, KOBJ_ADD);
 623         return 0;
 624 }
 625
 626
 627 /**
 628  *      kset_unregister - remove a kset.
 629  *      @k:     kset.
 630  */
 631
 632 void kset_unregister(struct kset * k)
 633 {
 634         if (!k)
 635                 return;
 636         kobject_unregister(&k->kobj);
 637 }
 638
 639
 640 /**
 641  *      kset_find_obj - search for object in kset.
 642  *      @kset:  kset we're looking in.
 643  *      @name:  object's name.
 644  *
 645  *      Lock kset via @kset->subsys, and iterate over @kset->list,
 646  *      looking for a matching kobject. If matching object is found
 647  *      take a reference and return the object.
 648  */
 649
 650 struct kobject * kset_find_obj(struct kset * kset, const char * name)
 651 {
 652         struct list_head * entry;
 653         struct kobject * ret = NULL;
 654
 655         spin_lock(&kset->list_lock);
 656         list_for_each(entry,&kset->list) {
 657                 struct kobject * k = to_kobj(entry);
 658                 if (kobject_name(k) && !strcmp(kobject_name(k),name)) {
 659                         ret = kobject_get(k);
 660                         break;
 661                 }
 662         }
 663         spin_unlock(&kset->list_lock);
 664         return ret;
 665 }
 666
 667 int subsystem_register(struct kset *s)
 668 {
 669         return kset_register(s);
 670 }
 671
 672 void subsystem_unregister(struct kset *s)
 673 {
 674         kset_unregister(s);
 675 }
 676
 677 /**
 678  *      subsystem_create_file - export sysfs attribute file.
 679  *      @s:     subsystem.
 680  *      @a:     subsystem attribute descriptor.
 681  */
 682
 683 int subsys_create_file(struct kset *s, struct subsys_attribute *a)
 684 {
 685         int error = 0;
 686
 687         if (!s || !a)
 688                 return -EINVAL;
 689
 690         if (kset_get(s)) {
 691                 error = sysfs_create_file(&s->kobj, &a->attr);
 692                 kset_put(s);
 693         }
 694         return error;
 695 }
 696
 697 EXPORT_SYMBOL(kobject_init);
 698 EXPORT_SYMBOL(kobject_register);
 699 EXPORT_SYMBOL(kobject_unregister);
 700 EXPORT_SYMBOL(kobject_get);
 701 EXPORT_SYMBOL(kobject_put);
 702 EXPORT_SYMBOL(kobject_add);
 703 EXPORT_SYMBOL(kobject_del);
 704
 705 EXPORT_SYMBOL(kset_register);
 706 EXPORT_SYMBOL(kset_unregister);
 707
 708 EXPORT_SYMBOL(subsystem_register);
 709 EXPORT_SYMBOL(subsystem_unregister);
 710 EXPORT_SYMBOL(subsys_create_file);