lib/kobject.c

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