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/export.h>
  18 #include <linux/stat.h>
  19 #include <linux/slab.h>
  20 #include <linux/random.h>
  21
  22 /**
  23  * kobject_namespace - return @kobj's namespace tag
  24  * @kobj: kobject in question
  25  *
  26  * Returns namespace tag of @kobj if its parent has namespace ops enabled
  27  * and thus @kobj should have a namespace tag associated with it.  Returns
  28  * %NULL otherwise.
  29  */
  30 const void *kobject_namespace(struct kobject *kobj)
  31 {
  32         const struct kobj_ns_type_operations *ns_ops = kobj_ns_ops(kobj);
  33
  34         if (!ns_ops || ns_ops->type == KOBJ_NS_TYPE_NONE)
  35                 return NULL;
  36
  37         return kobj->ktype->namespace(kobj);
  38 }
  39
  40 /*
  41  * populate_dir - populate directory with attributes.
  42  * @kobj: object we're working on.
  43  *
  44  * Most subsystems have a set of default attributes that are associated
  45  * with an object that registers with them.  This is a helper called during
  46  * object registration that loops through the default attributes of the
  47  * subsystem and creates attributes files for them in sysfs.
  48  */
  49 static int populate_dir(struct kobject *kobj)
  50 {
  51         struct kobj_type *t = get_ktype(kobj);
  52         struct attribute *attr;
  53         int error = 0;
  54         int i;
  55
  56         if (t && t->default_attrs) {
  57                 for (i = 0; (attr = t->default_attrs[i]) != NULL; i++) {
  58                         error = sysfs_create_file(kobj, attr);
  59                         if (error)
  60                                 break;
  61                 }
  62         }
  63         return error;
  64 }
  65
  66 static int create_dir(struct kobject *kobj)
  67 {
  68         const struct kobj_ns_type_operations *ops;
  69         int error;
  70
  71         error = sysfs_create_dir_ns(kobj, kobject_namespace(kobj));
  72         if (error)
  73                 return error;
  74
  75         error = populate_dir(kobj);
  76         if (error) {
  77                 sysfs_remove_dir(kobj);
  78                 return error;
  79         }
  80
  81         /*
  82          * @kobj->sd may be deleted by an ancestor going away.  Hold an
  83          * extra reference so that it stays until @kobj is gone.
  84          */
  85         sysfs_get(kobj->sd);
  86
  87         /*
  88          * If @kobj has ns_ops, its children need to be filtered based on
  89          * their namespace tags.  Enable namespace support on @kobj->sd.
  90          */
  91         ops = kobj_child_ns_ops(kobj);
  92         if (ops) {
  93                 BUG_ON(ops->type <= KOBJ_NS_TYPE_NONE);
  94                 BUG_ON(ops->type >= KOBJ_NS_TYPES);
  95                 BUG_ON(!kobj_ns_type_registered(ops->type));
  96
  97                 sysfs_enable_ns(kobj->sd);
  98         }
  99
 100         return 0;
 101 }
 102
 103 static int get_kobj_path_length(struct kobject *kobj)
 104 {
 105         int length = 1;
 106         struct kobject *parent = kobj;
 107
 108         /* walk up the ancestors until we hit the one pointing to the
 109          * root.
 110          * Add 1 to strlen for leading '/' of each level.
 111          */
 112         do {
 113                 if (kobject_name(parent) == NULL)
 114                         return 0;
 115                 length += strlen(kobject_name(parent)) + 1;
 116                 parent = parent->parent;
 117         } while (parent);
 118         return length;
 119 }
 120
 121 static void fill_kobj_path(struct kobject *kobj, char *path, int length)
 122 {
 123         struct kobject *parent;
 124
 125         --length;
 126         for (parent = kobj; parent; parent = parent->parent) {
 127                 int cur = strlen(kobject_name(parent));
 128                 /* back up enough to print this name with '/' */
 129                 length -= cur;
 130                 strncpy(path + length, kobject_name(parent), cur);
 131                 *(path + --length) = '/';
 132         }
 133
 134         pr_debug("kobject: '%s' (%p): %s: path = '%s'\n", kobject_name(kobj),
 135                  kobj, __func__, path);
 136 }
 137
 138 /**
 139  * kobject_get_path - generate and return the path associated with a given kobj and kset pair.
 140  *
 141  * @kobj:       kobject in question, with which to build the path
 142  * @gfp_mask:   the allocation type used to allocate the path
 143  *
 144  * The result must be freed by the caller with kfree().
 145  */
 146 char *kobject_get_path(struct kobject *kobj, gfp_t gfp_mask)
 147 {
 148         char *path;
 149         int len;
 150
 151         len = get_kobj_path_length(kobj);
 152         if (len == 0)
 153                 return NULL;
 154         path = kzalloc(len, gfp_mask);
 155         if (!path)
 156                 return NULL;
 157         fill_kobj_path(kobj, path, len);
 158
 159         return path;
 160 }
 161 EXPORT_SYMBOL_GPL(kobject_get_path);
 162
 163 /* add the kobject to its kset's list */
 164 static void kobj_kset_join(struct kobject *kobj)
 165 {
 166         if (!kobj->kset)
 167                 return;
 168
 169         kset_get(kobj->kset);
 170         spin_lock(&kobj->kset->list_lock);
 171         list_add_tail(&kobj->entry, &kobj->kset->list);
 172         spin_unlock(&kobj->kset->list_lock);
 173 }
 174
 175 /* remove the kobject from its kset's list */
 176 static void kobj_kset_leave(struct kobject *kobj)
 177 {
 178         if (!kobj->kset)
 179                 return;
 180
 181         spin_lock(&kobj->kset->list_lock);
 182         list_del_init(&kobj->entry);
 183         spin_unlock(&kobj->kset->list_lock);
 184         kset_put(kobj->kset);
 185 }
 186
 187 static void kobject_init_internal(struct kobject *kobj)
 188 {
 189         if (!kobj)
 190                 return;
 191         kref_init(&kobj->kref);
 192         INIT_LIST_HEAD(&kobj->entry);
 193         kobj->state_in_sysfs = 0;
 194         kobj->state_add_uevent_sent = 0;
 195         kobj->state_remove_uevent_sent = 0;
 196         kobj->state_initialized = 1;
 197 }
 198
 199
 200 static int kobject_add_internal(struct kobject *kobj)
 201 {
 202         int error = 0;
 203         struct kobject *parent;
 204
 205         if (!kobj)
 206                 return -ENOENT;
 207
 208         if (!kobj->name || !kobj->name[0]) {
 209                 WARN(1, "kobject: (%p): attempted to be registered with empty "
 210                          "name!\n", kobj);
 211                 return -EINVAL;
 212         }
 213
 214         parent = kobject_get(kobj->parent);
 215
 216         /* join kset if set, use it as parent if we do not already have one */
 217         if (kobj->kset) {
 218                 if (!parent)
 219                         parent = kobject_get(&kobj->kset->kobj);
 220                 kobj_kset_join(kobj);
 221                 kobj->parent = parent;
 222         }
 223
 224         pr_debug("kobject: '%s' (%p): %s: parent: '%s', set: '%s'\n",
 225                  kobject_name(kobj), kobj, __func__,
 226                  parent ? kobject_name(parent) : "<NULL>",
 227                  kobj->kset ? kobject_name(&kobj->kset->kobj) : "<NULL>");
 228
 229         error = create_dir(kobj);
 230         if (error) {
 231                 kobj_kset_leave(kobj);
 232                 kobject_put(parent);
 233                 kobj->parent = NULL;
 234
 235                 /* be noisy on error issues */
 236                 if (error == -EEXIST)
 237                         WARN(1, "%s failed for %s with "
 238                              "-EEXIST, don't try to register things with "
 239                              "the same name in the same directory.\n",
 240                              __func__, kobject_name(kobj));
 241                 else
 242                         WARN(1, "%s failed for %s (error: %d parent: %s)\n",
 243                              __func__, kobject_name(kobj), error,
 244                              parent ? kobject_name(parent) : "'none'");
 245         } else
 246                 kobj->state_in_sysfs = 1;
 247
 248         return error;
 249 }
 250
 251 /**
 252  * kobject_set_name_vargs - Set the name of an kobject
 253  * @kobj: struct kobject to set the name of
 254  * @fmt: format string used to build the name
 255  * @vargs: vargs to format the string.
 256  */
 257 int kobject_set_name_vargs(struct kobject *kobj, const char *fmt,
 258                                   va_list vargs)
 259 {
 260         const char *old_name = kobj->name;
 261         char *s;
 262
 263         if (kobj->name && !fmt)
 264                 return 0;
 265
 266         kobj->name = kvasprintf(GFP_KERNEL, fmt, vargs);
 267         if (!kobj->name) {
 268                 kobj->name = old_name;
 269                 return -ENOMEM;
 270         }
 271
 272         /* ewww... some of these buggers have '/' in the name ... */
 273         while ((s = strchr(kobj->name, '/')))
 274                 s[0] = '!';
 275
 276         kfree(old_name);
 277         return 0;
 278 }
 279
 280 /**
 281  * kobject_set_name - Set the name of a kobject
 282  * @kobj: struct kobject to set the name of
 283  * @fmt: format string used to build the name
 284  *
 285  * This sets the name of the kobject.  If you have already added the
 286  * kobject to the system, you must call kobject_rename() in order to
 287  * change the name of the kobject.
 288  */
 289 int kobject_set_name(struct kobject *kobj, const char *fmt, ...)
 290 {
 291         va_list vargs;
 292         int retval;
 293
 294         va_start(vargs, fmt);
 295         retval = kobject_set_name_vargs(kobj, fmt, vargs);
 296         va_end(vargs);
 297
 298         return retval;
 299 }
 300 EXPORT_SYMBOL(kobject_set_name);
 301
 302 /**
 303  * kobject_init - initialize a kobject structure
 304  * @kobj: pointer to the kobject to initialize
 305  * @ktype: pointer to the ktype for this kobject.
 306  *
 307  * This function will properly initialize a kobject such that it can then
 308  * be passed to the kobject_add() call.
 309  *
 310  * After this function is called, the kobject MUST be cleaned up by a call
 311  * to kobject_put(), not by a call to kfree directly to ensure that all of
 312  * the memory is cleaned up properly.
 313  */
 314 void kobject_init(struct kobject *kobj, struct kobj_type *ktype)
 315 {
 316         char *err_str;
 317
 318         if (!kobj) {
 319                 err_str = "invalid kobject pointer!";
 320                 goto error;
 321         }
 322         if (!ktype) {
 323                 err_str = "must have a ktype to be initialized properly!\n";
 324                 goto error;
 325         }
 326         if (kobj->state_initialized) {
 327                 /* do not error out as sometimes we can recover */
 328                 printk(KERN_ERR "kobject (%p): tried to init an initialized "
 329                        "object, something is seriously wrong.\n", kobj);
 330                 dump_stack();
 331         }
 332
 333         kobject_init_internal(kobj);
 334         kobj->ktype = ktype;
 335         return;
 336
 337 error:
 338         printk(KERN_ERR "kobject (%p): %s\n", kobj, err_str);
 339         dump_stack();
 340 }
 341 EXPORT_SYMBOL(kobject_init);
 342
 343 static int kobject_add_varg(struct kobject *kobj, struct kobject *parent,
 344                             const char *fmt, va_list vargs)
 345 {
 346         int retval;
 347
 348         retval = kobject_set_name_vargs(kobj, fmt, vargs);
 349         if (retval) {
 350                 printk(KERN_ERR "kobject: can not set name properly!\n");
 351                 return retval;
 352         }
 353         kobj->parent = parent;
 354         return kobject_add_internal(kobj);
 355 }
 356
 357 /**
 358  * kobject_add - the main kobject add function
 359  * @kobj: the kobject to add
 360  * @parent: pointer to the parent of the kobject.
 361  * @fmt: format to name the kobject with.
 362  *
 363  * The kobject name is set and added to the kobject hierarchy in this
 364  * function.
 365  *
 366  * If @parent is set, then the parent of the @kobj will be set to it.
 367  * If @parent is NULL, then the parent of the @kobj will be set to the
 368  * kobject associated with the kset assigned to this kobject.  If no kset
 369  * is assigned to the kobject, then the kobject will be located in the
 370  * root of the sysfs tree.
 371  *
 372  * If this function returns an error, kobject_put() must be called to
 373  * properly clean up the memory associated with the object.
 374  * Under no instance should the kobject that is passed to this function
 375  * be directly freed with a call to kfree(), that can leak memory.
 376  *
 377  * Note, no "add" uevent will be created with this call, the caller should set
 378  * up all of the necessary sysfs files for the object and then call
 379  * kobject_uevent() with the UEVENT_ADD parameter to ensure that
 380  * userspace is properly notified of this kobject's creation.
 381  */
 382 int kobject_add(struct kobject *kobj, struct kobject *parent,
 383                 const char *fmt, ...)
 384 {
 385         va_list args;
 386         int retval;
 387
 388         if (!kobj)
 389                 return -EINVAL;
 390
 391         if (!kobj->state_initialized) {
 392                 printk(KERN_ERR "kobject '%s' (%p): tried to add an "
 393                        "uninitialized object, something is seriously wrong.\n",
 394                        kobject_name(kobj), kobj);
 395                 dump_stack();
 396                 return -EINVAL;
 397         }
 398         va_start(args, fmt);
 399         retval = kobject_add_varg(kobj, parent, fmt, args);
 400         va_end(args);
 401
 402         return retval;
 403 }
 404 EXPORT_SYMBOL(kobject_add);
 405
 406 /**
 407  * kobject_init_and_add - initialize a kobject structure and add it to the kobject hierarchy
 408  * @kobj: pointer to the kobject to initialize
 409  * @ktype: pointer to the ktype for this kobject.
 410  * @parent: pointer to the parent of this kobject.
 411  * @fmt: the name of the kobject.
 412  *
 413  * This function combines the call to kobject_init() and
 414  * kobject_add().  The same type of error handling after a call to
 415  * kobject_add() and kobject lifetime rules are the same here.
 416  */
 417 int kobject_init_and_add(struct kobject *kobj, struct kobj_type *ktype,
 418                          struct kobject *parent, const char *fmt, ...)
 419 {
 420         va_list args;
 421         int retval;
 422
 423         kobject_init(kobj, ktype);
 424
 425         va_start(args, fmt);
 426         retval = kobject_add_varg(kobj, parent, fmt, args);
 427         va_end(args);
 428
 429         return retval;
 430 }
 431 EXPORT_SYMBOL_GPL(kobject_init_and_add);
 432
 433 /**
 434  * kobject_rename - change the name of an object
 435  * @kobj: object in question.
 436  * @new_name: object's new name
 437  *
 438  * It is the responsibility of the caller to provide mutual
 439  * exclusion between two different calls of kobject_rename
 440  * on the same kobject and to ensure that new_name is valid and
 441  * won't conflict with other kobjects.
 442  */
 443 int kobject_rename(struct kobject *kobj, const char *new_name)
 444 {
 445         int error = 0;
 446         const char *devpath = NULL;
 447         const char *dup_name = NULL, *name;
 448         char *devpath_string = NULL;
 449         char *envp[2];
 450
 451         kobj = kobject_get(kobj);
 452         if (!kobj)
 453                 return -EINVAL;
 454         if (!kobj->parent)
 455                 return -EINVAL;
 456
 457         devpath = kobject_get_path(kobj, GFP_KERNEL);
 458         if (!devpath) {
 459                 error = -ENOMEM;
 460                 goto out;
 461         }
 462         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
 463         if (!devpath_string) {
 464                 error = -ENOMEM;
 465                 goto out;
 466         }
 467         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
 468         envp[0] = devpath_string;
 469         envp[1] = NULL;
 470
 471         name = dup_name = kstrdup(new_name, GFP_KERNEL);
 472         if (!name) {
 473                 error = -ENOMEM;
 474                 goto out;
 475         }
 476
 477         error = sysfs_rename_dir_ns(kobj, new_name, kobject_namespace(kobj));
 478         if (error)
 479                 goto out;
 480
 481         /* Install the new kobject name */
 482         dup_name = kobj->name;
 483         kobj->name = name;
 484
 485         /* This function is mostly/only used for network interface.
 486          * Some hotplug package track interfaces by their name and
 487          * therefore want to know when the name is changed by the user. */
 488         kobject_uevent_env(kobj, KOBJ_MOVE, envp);
 489
 490 out:
 491         kfree(dup_name);
 492         kfree(devpath_string);
 493         kfree(devpath);
 494         kobject_put(kobj);
 495
 496         return error;
 497 }
 498 EXPORT_SYMBOL_GPL(kobject_rename);
 499
 500 /**
 501  * kobject_move - move object to another parent
 502  * @kobj: object in question.
 503  * @new_parent: object's new parent (can be NULL)
 504  */
 505 int kobject_move(struct kobject *kobj, struct kobject *new_parent)
 506 {
 507         int error;
 508         struct kobject *old_parent;
 509         const char *devpath = NULL;
 510         char *devpath_string = NULL;
 511         char *envp[2];
 512
 513         kobj = kobject_get(kobj);
 514         if (!kobj)
 515                 return -EINVAL;
 516         new_parent = kobject_get(new_parent);
 517         if (!new_parent) {
 518                 if (kobj->kset)
 519                         new_parent = kobject_get(&kobj->kset->kobj);
 520         }
 521
 522         /* old object path */
 523         devpath = kobject_get_path(kobj, GFP_KERNEL);
 524         if (!devpath) {
 525                 error = -ENOMEM;
 526                 goto out;
 527         }
 528         devpath_string = kmalloc(strlen(devpath) + 15, GFP_KERNEL);
 529         if (!devpath_string) {
 530                 error = -ENOMEM;
 531                 goto out;
 532         }
 533         sprintf(devpath_string, "DEVPATH_OLD=%s", devpath);
 534         envp[0] = devpath_string;
 535         envp[1] = NULL;
 536         error = sysfs_move_dir_ns(kobj, new_parent, kobject_namespace(kobj));
 537         if (error)
 538                 goto out;
 539         old_parent = kobj->parent;
 540         kobj->parent = new_parent;
 541         new_parent = NULL;
 542         kobject_put(old_parent);
 543         kobject_uevent_env(kobj, KOBJ_MOVE, envp);
 544 out:
 545         kobject_put(new_parent);
 546         kobject_put(kobj);
 547         kfree(devpath_string);
 548         kfree(devpath);
 549         return error;
 550 }
 551 EXPORT_SYMBOL_GPL(kobject_move);
 552
 553 /**
 554  * kobject_del - unlink kobject from hierarchy.
 555  * @kobj: object.
 556  */
 557 void kobject_del(struct kobject *kobj)
 558 {
 559         struct kernfs_node *sd;
 560
 561         if (!kobj)
 562                 return;
 563
 564         sd = kobj->sd;
 565         sysfs_remove_dir(kobj);
 566         sysfs_put(sd);
 567
 568         kobj->state_in_sysfs = 0;
 569         kobj_kset_leave(kobj);
 570         kobject_put(kobj->parent);
 571         kobj->parent = NULL;
 572 }
 573
 574 /**
 575  * kobject_get - increment refcount for object.
 576  * @kobj: object.
 577  */
 578 struct kobject *kobject_get(struct kobject *kobj)
 579 {
 580         if (kobj) {
 581                 if (!kobj->state_initialized)
 582                         WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
 583                                "initialized, yet kobject_get() is being "
 584                                "called.\n", kobject_name(kobj), kobj);
 585                 kref_get(&kobj->kref);
 586         }
 587         return kobj;
 588 }
 589
 590 static struct kobject * __must_check kobject_get_unless_zero(struct kobject *kobj)
 591 {
 592         if (!kref_get_unless_zero(&kobj->kref))
 593                 kobj = NULL;
 594         return kobj;
 595 }
 596
 597 /*
 598  * kobject_cleanup - free kobject resources.
 599  * @kobj: object to cleanup
 600  */
 601 static void kobject_cleanup(struct kobject *kobj)
 602 {
 603         struct kobj_type *t = get_ktype(kobj);
 604         const char *name = kobj->name;
 605
 606         pr_debug("kobject: '%s' (%p): %s, parent %p\n",
 607                  kobject_name(kobj), kobj, __func__, kobj->parent);
 608
 609         if (t && !t->release)
 610                 pr_debug("kobject: '%s' (%p): does not have a release() "
 611                          "function, it is broken and must be fixed.\n",
 612                          kobject_name(kobj), kobj);
 613
 614         /* send "remove" if the caller did not do it but sent "add" */
 615         if (kobj->state_add_uevent_sent && !kobj->state_remove_uevent_sent) {
 616                 pr_debug("kobject: '%s' (%p): auto cleanup 'remove' event\n",
 617                          kobject_name(kobj), kobj);
 618                 kobject_uevent(kobj, KOBJ_REMOVE);
 619         }
 620
 621         /* remove from sysfs if the caller did not do it */
 622         if (kobj->state_in_sysfs) {
 623                 pr_debug("kobject: '%s' (%p): auto cleanup kobject_del\n",
 624                          kobject_name(kobj), kobj);
 625                 kobject_del(kobj);
 626         }
 627
 628         if (t && t->release) {
 629                 pr_debug("kobject: '%s' (%p): calling ktype release\n",
 630                          kobject_name(kobj), kobj);
 631                 t->release(kobj);
 632         }
 633
 634         /* free name if we allocated it */
 635         if (name) {
 636                 pr_debug("kobject: '%s': free name\n", name);
 637                 kfree(name);
 638         }
 639 }
 640
 641 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
 642 static void kobject_delayed_cleanup(struct work_struct *work)
 643 {
 644         kobject_cleanup(container_of(to_delayed_work(work),
 645                                      struct kobject, release));
 646 }
 647 #endif
 648
 649 static void kobject_release(struct kref *kref)
 650 {
 651         struct kobject *kobj = container_of(kref, struct kobject, kref);
 652 #ifdef CONFIG_DEBUG_KOBJECT_RELEASE
 653         unsigned long delay = HZ + HZ * (get_random_int() & 0x3);
 654         pr_info("kobject: '%s' (%p): %s, parent %p (delayed %ld)\n",
 655                  kobject_name(kobj), kobj, __func__, kobj->parent, delay);
 656         INIT_DELAYED_WORK(&kobj->release, kobject_delayed_cleanup);
 657
 658         schedule_delayed_work(&kobj->release, delay);
 659 #else
 660         kobject_cleanup(kobj);
 661 #endif
 662 }
 663
 664 /**
 665  * kobject_put - decrement refcount for object.
 666  * @kobj: object.
 667  *
 668  * Decrement the refcount, and if 0, call kobject_cleanup().
 669  */
 670 void kobject_put(struct kobject *kobj)
 671 {
 672         if (kobj) {
 673                 if (!kobj->state_initialized)
 674                         WARN(1, KERN_WARNING "kobject: '%s' (%p): is not "
 675                                "initialized, yet kobject_put() is being "
 676                                "called.\n", kobject_name(kobj), kobj);
 677                 kref_put(&kobj->kref, kobject_release);
 678         }
 679 }
 680
 681 static void dynamic_kobj_release(struct kobject *kobj)
 682 {
 683         pr_debug("kobject: (%p): %s\n", kobj, __func__);
 684         kfree(kobj);
 685 }
 686
 687 static struct kobj_type dynamic_kobj_ktype = {
 688         .release        = dynamic_kobj_release,
 689         .sysfs_ops      = &kobj_sysfs_ops,
 690 };
 691
 692 /**
 693  * kobject_create - create a struct kobject dynamically
 694  *
 695  * This function creates a kobject structure dynamically and sets it up
 696  * to be a "dynamic" kobject with a default release function set up.
 697  *
 698  * If the kobject was not able to be created, NULL will be returned.
 699  * The kobject structure returned from here must be cleaned up with a
 700  * call to kobject_put() and not kfree(), as kobject_init() has
 701  * already been called on this structure.
 702  */
 703 struct kobject *kobject_create(void)
 704 {
 705         struct kobject *kobj;
 706
 707         kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
 708         if (!kobj)
 709                 return NULL;
 710
 711         kobject_init(kobj, &dynamic_kobj_ktype);
 712         return kobj;
 713 }
 714
 715 /**
 716  * kobject_create_and_add - create a struct kobject dynamically and register it with sysfs
 717  *
 718  * @name: the name for the kobject
 719  * @parent: the parent kobject of this kobject, if any.
 720  *
 721  * This function creates a kobject structure dynamically and registers it
 722  * with sysfs.  When you are finished with this structure, call
 723  * kobject_put() and the structure will be dynamically freed when
 724  * it is no longer being used.
 725  *
 726  * If the kobject was not able to be created, NULL will be returned.
 727  */
 728 struct kobject *kobject_create_and_add(const char *name, struct kobject *parent)
 729 {
 730         struct kobject *kobj;
 731         int retval;
 732
 733         kobj = kobject_create();
 734         if (!kobj)
 735                 return NULL;
 736
 737         retval = kobject_add(kobj, parent, "%s", name);
 738         if (retval) {
 739                 printk(KERN_WARNING "%s: kobject_add error: %d\n",
 740                        __func__, retval);
 741                 kobject_put(kobj);
 742                 kobj = NULL;
 743         }
 744         return kobj;
 745 }
 746 EXPORT_SYMBOL_GPL(kobject_create_and_add);
 747
 748 /**
 749  * kset_init - initialize a kset for use
 750  * @k: kset
 751  */
 752 void kset_init(struct kset *k)
 753 {
 754         kobject_init_internal(&k->kobj);
 755         INIT_LIST_HEAD(&k->list);
 756         spin_lock_init(&k->list_lock);
 757 }
 758
 759 /* default kobject attribute operations */
 760 static ssize_t kobj_attr_show(struct kobject *kobj, struct attribute *attr,
 761                               char *buf)
 762 {
 763         struct kobj_attribute *kattr;
 764         ssize_t ret = -EIO;
 765
 766         kattr = container_of(attr, struct kobj_attribute, attr);
 767         if (kattr->show)
 768                 ret = kattr->show(kobj, kattr, buf);
 769         return ret;
 770 }
 771
 772 static ssize_t kobj_attr_store(struct kobject *kobj, struct attribute *attr,
 773                                const char *buf, size_t count)
 774 {
 775         struct kobj_attribute *kattr;
 776         ssize_t ret = -EIO;
 777
 778         kattr = container_of(attr, struct kobj_attribute, attr);
 779         if (kattr->store)
 780                 ret = kattr->store(kobj, kattr, buf, count);
 781         return ret;
 782 }
 783
 784 const struct sysfs_ops kobj_sysfs_ops = {
 785         .show   = kobj_attr_show,
 786         .store  = kobj_attr_store,
 787 };
 788 EXPORT_SYMBOL_GPL(kobj_sysfs_ops);
 789
 790 /**
 791  * kset_register - initialize and add a kset.
 792  * @k: kset.
 793  */
 794 int kset_register(struct kset *k)
 795 {
 796         int err;
 797
 798         if (!k)
 799                 return -EINVAL;
 800
 801         kset_init(k);
 802         err = kobject_add_internal(&k->kobj);
 803         if (err)
 804                 return err;
 805         kobject_uevent(&k->kobj, KOBJ_ADD);
 806         return 0;
 807 }
 808
 809 /**
 810  * kset_unregister - remove a kset.
 811  * @k: kset.
 812  */
 813 void kset_unregister(struct kset *k)
 814 {
 815         if (!k)
 816                 return;
 817         kobject_del(&k->kobj);
 818         kobject_put(&k->kobj);
 819 }
 820
 821 /**
 822  * kset_find_obj - search for object in kset.
 823  * @kset: kset we're looking in.
 824  * @name: object's name.
 825  *
 826  * Lock kset via @kset->subsys, and iterate over @kset->list,
 827  * looking for a matching kobject. If matching object is found
 828  * take a reference and return the object.
 829  */
 830 struct kobject *kset_find_obj(struct kset *kset, const char *name)
 831 {
 832         struct kobject *k;
 833         struct kobject *ret = NULL;
 834
 835         spin_lock(&kset->list_lock);
 836
 837         list_for_each_entry(k, &kset->list, entry) {
 838                 if (kobject_name(k) && !strcmp(kobject_name(k), name)) {
 839                         ret = kobject_get_unless_zero(k);
 840                         break;
 841                 }
 842         }
 843
 844         spin_unlock(&kset->list_lock);
 845         return ret;
 846 }
 847
 848 static void kset_release(struct kobject *kobj)
 849 {
 850         struct kset *kset = container_of(kobj, struct kset, kobj);
 851         pr_debug("kobject: '%s' (%p): %s\n",
 852                  kobject_name(kobj), kobj, __func__);
 853         kfree(kset);
 854 }
 855
 856 static struct kobj_type kset_ktype = {
 857         .sysfs_ops      = &kobj_sysfs_ops,
 858         .release = kset_release,
 859 };
 860
 861 /**
 862  * kset_create - create a struct kset dynamically
 863  *
 864  * @name: the name for the kset
 865  * @uevent_ops: a struct kset_uevent_ops for the kset
 866  * @parent_kobj: the parent kobject of this kset, if any.
 867  *
 868  * This function creates a kset structure dynamically.  This structure can
 869  * then be registered with the system and show up in sysfs with a call to
 870  * kset_register().  When you are finished with this structure, if
 871  * kset_register() has been called, call kset_unregister() and the
 872  * structure will be dynamically freed when it is no longer being used.
 873  *
 874  * If the kset was not able to be created, NULL will be returned.
 875  */
 876 static struct kset *kset_create(const char *name,
 877                                 const struct kset_uevent_ops *uevent_ops,
 878                                 struct kobject *parent_kobj)
 879 {
 880         struct kset *kset;
 881         int retval;
 882
 883         kset = kzalloc(sizeof(*kset), GFP_KERNEL);
 884         if (!kset)
 885                 return NULL;
 886         retval = kobject_set_name(&kset->kobj, "%s", name);
 887         if (retval) {
 888                 kfree(kset);
 889                 return NULL;
 890         }
 891         kset->uevent_ops = uevent_ops;
 892         kset->kobj.parent = parent_kobj;
 893
 894         /*
 895          * The kobject of this kset will have a type of kset_ktype and belong to
 896          * no kset itself.  That way we can properly free it when it is
 897          * finished being used.
 898          */
 899         kset->kobj.ktype = &kset_ktype;
 900         kset->kobj.kset = NULL;
 901
 902         return kset;
 903 }
 904
 905 /**
 906  * kset_create_and_add - create a struct kset dynamically and add it to sysfs
 907  *
 908  * @name: the name for the kset
 909  * @uevent_ops: a struct kset_uevent_ops for the kset
 910  * @parent_kobj: the parent kobject of this kset, if any.
 911  *
 912  * This function creates a kset structure dynamically and registers it
 913  * with sysfs.  When you are finished with this structure, call
 914  * kset_unregister() and the structure will be dynamically freed when it
 915  * is no longer being used.
 916  *
 917  * If the kset was not able to be created, NULL will be returned.
 918  */
 919 struct kset *kset_create_and_add(const char *name,
 920                                  const struct kset_uevent_ops *uevent_ops,
 921                                  struct kobject *parent_kobj)
 922 {
 923         struct kset *kset;
 924         int error;
 925
 926         kset = kset_create(name, uevent_ops, parent_kobj);
 927         if (!kset)
 928                 return NULL;
 929         error = kset_register(kset);
 930         if (error) {
 931                 kfree(kset);
 932                 return NULL;
 933         }
 934         return kset;
 935 }
 936 EXPORT_SYMBOL_GPL(kset_create_and_add);
 937
 938
 939 static DEFINE_SPINLOCK(kobj_ns_type_lock);
 940 static const struct kobj_ns_type_operations *kobj_ns_ops_tbl[KOBJ_NS_TYPES];
 941
 942 int kobj_ns_type_register(const struct kobj_ns_type_operations *ops)
 943 {
 944         enum kobj_ns_type type = ops->type;
 945         int error;
 946
 947         spin_lock(&kobj_ns_type_lock);
 948
 949         error = -EINVAL;
 950         if (type >= KOBJ_NS_TYPES)
 951                 goto out;
 952
 953         error = -EINVAL;
 954         if (type <= KOBJ_NS_TYPE_NONE)
 955                 goto out;
 956
 957         error = -EBUSY;
 958         if (kobj_ns_ops_tbl[type])
 959                 goto out;
 960
 961         error = 0;
 962         kobj_ns_ops_tbl[type] = ops;
 963
 964 out:
 965         spin_unlock(&kobj_ns_type_lock);
 966         return error;
 967 }
 968
 969 int kobj_ns_type_registered(enum kobj_ns_type type)
 970 {
 971         int registered = 0;
 972
 973         spin_lock(&kobj_ns_type_lock);
 974         if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES))
 975                 registered = kobj_ns_ops_tbl[type] != NULL;
 976         spin_unlock(&kobj_ns_type_lock);
 977
 978         return registered;
 979 }
 980
 981 const struct kobj_ns_type_operations *kobj_child_ns_ops(struct kobject *parent)
 982 {
 983         const struct kobj_ns_type_operations *ops = NULL;
 984
 985         if (parent && parent->ktype && parent->ktype->child_ns_type)
 986                 ops = parent->ktype->child_ns_type(parent);
 987
 988         return ops;
 989 }
 990
 991 const struct kobj_ns_type_operations *kobj_ns_ops(struct kobject *kobj)
 992 {
 993         return kobj_child_ns_ops(kobj->parent);
 994 }
 995
 996 bool kobj_ns_current_may_mount(enum kobj_ns_type type)
 997 {
 998         bool may_mount = true;
 999
1000         spin_lock(&kobj_ns_type_lock);
1001         if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1002             kobj_ns_ops_tbl[type])
1003                 may_mount = kobj_ns_ops_tbl[type]->current_may_mount();
1004         spin_unlock(&kobj_ns_type_lock);
1005
1006         return may_mount;
1007 }
1008
1009 void *kobj_ns_grab_current(enum kobj_ns_type type)
1010 {
1011         void *ns = NULL;
1012
1013         spin_lock(&kobj_ns_type_lock);
1014         if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1015             kobj_ns_ops_tbl[type])
1016                 ns = kobj_ns_ops_tbl[type]->grab_current_ns();
1017         spin_unlock(&kobj_ns_type_lock);
1018
1019         return ns;
1020 }
1021
1022 const void *kobj_ns_netlink(enum kobj_ns_type type, struct sock *sk)
1023 {
1024         const void *ns = NULL;
1025
1026         spin_lock(&kobj_ns_type_lock);
1027         if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1028             kobj_ns_ops_tbl[type])
1029                 ns = kobj_ns_ops_tbl[type]->netlink_ns(sk);
1030         spin_unlock(&kobj_ns_type_lock);
1031
1032         return ns;
1033 }
1034
1035 const void *kobj_ns_initial(enum kobj_ns_type type)
1036 {
1037         const void *ns = NULL;
1038
1039         spin_lock(&kobj_ns_type_lock);
1040         if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1041             kobj_ns_ops_tbl[type])
1042                 ns = kobj_ns_ops_tbl[type]->initial_ns();
1043         spin_unlock(&kobj_ns_type_lock);
1044
1045         return ns;
1046 }
1047
1048 void kobj_ns_drop(enum kobj_ns_type type, void *ns)
1049 {
1050         spin_lock(&kobj_ns_type_lock);
1051         if ((type > KOBJ_NS_TYPE_NONE) && (type < KOBJ_NS_TYPES) &&
1052             kobj_ns_ops_tbl[type] && kobj_ns_ops_tbl[type]->drop_ns)
1053                 kobj_ns_ops_tbl[type]->drop_ns(ns);
1054         spin_unlock(&kobj_ns_type_lock);
1055 }
1056
1057 EXPORT_SYMBOL(kobject_get);
1058 EXPORT_SYMBOL(kobject_put);
1059 EXPORT_SYMBOL(kobject_del);
1060
1061 EXPORT_SYMBOL(kset_register);
1062 EXPORT_SYMBOL(kset_unregister);