fs/sysfs/dir.c

   1 /*
   2  * fs/sysfs/dir.c - sysfs core and dir operation implementation
   3  *
   4  * Copyright (c) 2001-3 Patrick Mochel
   5  * Copyright (c) 2007 SUSE Linux Products GmbH
   6  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   7  *
   8  * This file is released under the GPLv2.
   9  *
  10  * Please see Documentation/filesystems/sysfs.txt for more information.
  11  */
  12
  13 #undef DEBUG
  14
  15 #include <linux/fs.h>
  16 #include <linux/mount.h>
  17 #include <linux/module.h>
  18 #include <linux/kobject.h>
  19 #include <linux/namei.h>
  20 #include <linux/idr.h>
  21 #include <linux/completion.h>
  22 #include <linux/mutex.h>
  23 #include <linux/slab.h>
  24 #include <linux/security.h>
  25 #include <linux/hash.h>
  26 #include "sysfs.h"
  27
  28 DEFINE_MUTEX(sysfs_mutex);
  29 DEFINE_SPINLOCK(sysfs_symlink_target_lock);
  30
  31 #define to_sysfs_dirent(X) rb_entry((X), struct sysfs_dirent, s_rb)
  32
  33 static DEFINE_SPINLOCK(sysfs_ino_lock);
  34 static DEFINE_IDA(sysfs_ino_ida);
  35
  36 /**
  37  *      sysfs_name_hash
  38  *      @name: Null terminated string to hash
  39  *      @ns:   Namespace tag to hash
  40  *
  41  *      Returns 31 bit hash of ns + name (so it fits in an off_t )
  42  */
  43 static unsigned int sysfs_name_hash(const char *name, const void *ns)
  44 {
  45         unsigned long hash = init_name_hash();
  46         unsigned int len = strlen(name);
  47         while (len--)
  48                 hash = partial_name_hash(*name++, hash);
  49         hash = (end_name_hash(hash) ^ hash_ptr((void *)ns, 31));
  50         hash &= 0x7fffffffU;
  51         /* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */
  52         if (hash < 1)
  53                 hash += 2;
  54         if (hash >= INT_MAX)
  55                 hash = INT_MAX - 1;
  56         return hash;
  57 }
  58
  59 static int sysfs_name_compare(unsigned int hash, const char *name,
  60                               const void *ns, const struct sysfs_dirent *sd)
  61 {
  62         if (hash != sd->s_hash)
  63                 return hash - sd->s_hash;
  64         if (ns != sd->s_ns)
  65                 return ns - sd->s_ns;
  66         return strcmp(name, sd->s_name);
  67 }
  68
  69 static int sysfs_sd_compare(const struct sysfs_dirent *left,
  70                             const struct sysfs_dirent *right)
  71 {
  72         return sysfs_name_compare(left->s_hash, left->s_name, left->s_ns,
  73                                   right);
  74 }
  75
  76 /**
  77  *      sysfs_link_sibling - link sysfs_dirent into sibling rbtree
  78  *      @sd: sysfs_dirent of interest
  79  *
  80  *      Link @sd into its sibling rbtree which starts from
  81  *      sd->s_parent->s_dir.children.
  82  *
  83  *      Locking:
  84  *      mutex_lock(sysfs_mutex)
  85  *
  86  *      RETURNS:
  87  *      0 on susccess -EEXIST on failure.
  88  */
  89 static int sysfs_link_sibling(struct sysfs_dirent *sd)
  90 {
  91         struct rb_node **node = &sd->s_parent->s_dir.children.rb_node;
  92         struct rb_node *parent = NULL;
  93
  94         if (sysfs_type(sd) == SYSFS_DIR)
  95                 sd->s_parent->s_dir.subdirs++;
  96
  97         while (*node) {
  98                 struct sysfs_dirent *pos;
  99                 int result;
 100
 101                 pos = to_sysfs_dirent(*node);
 102                 parent = *node;
 103                 result = sysfs_sd_compare(sd, pos);
 104                 if (result < 0)
 105                         node = &pos->s_rb.rb_left;
 106                 else if (result > 0)
 107                         node = &pos->s_rb.rb_right;
 108                 else
 109                         return -EEXIST;
 110         }
 111         /* add new node and rebalance the tree */
 112         rb_link_node(&sd->s_rb, parent, node);
 113         rb_insert_color(&sd->s_rb, &sd->s_parent->s_dir.children);
 114         return 0;
 115 }
 116
 117 /**
 118  *      sysfs_unlink_sibling - unlink sysfs_dirent from sibling rbtree
 119  *      @sd: sysfs_dirent of interest
 120  *
 121  *      Unlink @sd from its sibling rbtree which starts from
 122  *      sd->s_parent->s_dir.children.
 123  *
 124  *      Locking:
 125  *      mutex_lock(sysfs_mutex)
 126  */
 127 static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
 128 {
 129         if (sysfs_type(sd) == SYSFS_DIR)
 130                 sd->s_parent->s_dir.subdirs--;
 131
 132         rb_erase(&sd->s_rb, &sd->s_parent->s_dir.children);
 133 }
 134
 135 /**
 136  *      sysfs_get_active - get an active reference to sysfs_dirent
 137  *      @sd: sysfs_dirent to get an active reference to
 138  *
 139  *      Get an active reference of @sd.  This function is noop if @sd
 140  *      is NULL.
 141  *
 142  *      RETURNS:
 143  *      Pointer to @sd on success, NULL on failure.
 144  */
 145 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
 146 {
 147         if (unlikely(!sd))
 148                 return NULL;
 149
 150         if (!atomic_inc_unless_negative(&sd->s_active))
 151                 return NULL;
 152
 153         if (likely(!sysfs_ignore_lockdep(sd)))
 154                 rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
 155         return sd;
 156 }
 157
 158 /**
 159  *      sysfs_put_active - put an active reference to sysfs_dirent
 160  *      @sd: sysfs_dirent to put an active reference to
 161  *
 162  *      Put an active reference to @sd.  This function is noop if @sd
 163  *      is NULL.
 164  */
 165 void sysfs_put_active(struct sysfs_dirent *sd)
 166 {
 167         int v;
 168
 169         if (unlikely(!sd))
 170                 return;
 171
 172         if (likely(!sysfs_ignore_lockdep(sd)))
 173                 rwsem_release(&sd->dep_map, 1, _RET_IP_);
 174         v = atomic_dec_return(&sd->s_active);
 175         if (likely(v != SD_DEACTIVATED_BIAS))
 176                 return;
 177
 178         /* atomic_dec_return() is a mb(), we'll always see the updated
 179          * sd->u.completion.
 180          */
 181         complete(sd->u.completion);
 182 }
 183
 184 /**
 185  *      sysfs_deactivate - deactivate sysfs_dirent
 186  *      @sd: sysfs_dirent to deactivate
 187  *
 188  *      Deny new active references and drain existing ones.
 189  */
 190 static void sysfs_deactivate(struct sysfs_dirent *sd)
 191 {
 192         DECLARE_COMPLETION_ONSTACK(wait);
 193         int v;
 194
 195         BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED));
 196
 197         if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
 198                 return;
 199
 200         sd->u.completion = (void *)&wait;
 201
 202         rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
 203         /* atomic_add_return() is a mb(), put_active() will always see
 204          * the updated sd->u.completion.
 205          */
 206         v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
 207
 208         if (v != SD_DEACTIVATED_BIAS) {
 209                 lock_contended(&sd->dep_map, _RET_IP_);
 210                 wait_for_completion(&wait);
 211         }
 212
 213         lock_acquired(&sd->dep_map, _RET_IP_);
 214         rwsem_release(&sd->dep_map, 1, _RET_IP_);
 215 }
 216
 217 static int sysfs_alloc_ino(unsigned int *pino)
 218 {
 219         int ino, rc;
 220
 221  retry:
 222         spin_lock(&sysfs_ino_lock);
 223         rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
 224         spin_unlock(&sysfs_ino_lock);
 225
 226         if (rc == -EAGAIN) {
 227                 if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
 228                         goto retry;
 229                 rc = -ENOMEM;
 230         }
 231
 232         *pino = ino;
 233         return rc;
 234 }
 235
 236 static void sysfs_free_ino(unsigned int ino)
 237 {
 238         spin_lock(&sysfs_ino_lock);
 239         ida_remove(&sysfs_ino_ida, ino);
 240         spin_unlock(&sysfs_ino_lock);
 241 }
 242
 243 void release_sysfs_dirent(struct sysfs_dirent *sd)
 244 {
 245         struct sysfs_dirent *parent_sd;
 246
 247  repeat:
 248         /* Moving/renaming is always done while holding reference.
 249          * sd->s_parent won't change beneath us.
 250          */
 251         parent_sd = sd->s_parent;
 252
 253         WARN(!(sd->s_flags & SYSFS_FLAG_REMOVED),
 254                 "sysfs: free using entry: %s/%s\n",
 255                 parent_sd ? parent_sd->s_name : "", sd->s_name);
 256
 257         if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
 258                 sysfs_put(sd->s_symlink.target_sd);
 259         if (sysfs_type(sd) & SYSFS_COPY_NAME)
 260                 kfree(sd->s_name);
 261         if (sd->s_iattr && sd->s_iattr->ia_secdata)
 262                 security_release_secctx(sd->s_iattr->ia_secdata,
 263                                         sd->s_iattr->ia_secdata_len);
 264         kfree(sd->s_iattr);
 265         sysfs_free_ino(sd->s_ino);
 266         kmem_cache_free(sysfs_dir_cachep, sd);
 267
 268         sd = parent_sd;
 269         if (sd && atomic_dec_and_test(&sd->s_count))
 270                 goto repeat;
 271 }
 272
 273 static int sysfs_dentry_delete(const struct dentry *dentry)
 274 {
 275         struct sysfs_dirent *sd = dentry->d_fsdata;
 276         return !(sd && !(sd->s_flags & SYSFS_FLAG_REMOVED));
 277 }
 278
 279 static int sysfs_dentry_revalidate(struct dentry *dentry, unsigned int flags)
 280 {
 281         struct sysfs_dirent *sd;
 282
 283         if (flags & LOOKUP_RCU)
 284                 return -ECHILD;
 285
 286         sd = dentry->d_fsdata;
 287         mutex_lock(&sysfs_mutex);
 288
 289         /* The sysfs dirent has been deleted */
 290         if (sd->s_flags & SYSFS_FLAG_REMOVED)
 291                 goto out_bad;
 292
 293         /* The sysfs dirent has been moved? */
 294         if (dentry->d_parent->d_fsdata != sd->s_parent)
 295                 goto out_bad;
 296
 297         /* The sysfs dirent has been renamed */
 298         if (strcmp(dentry->d_name.name, sd->s_name) != 0)
 299                 goto out_bad;
 300
 301         /* The sysfs dirent has been moved to a different namespace */
 302         if (sd->s_parent && (sd->s_parent->s_flags & SYSFS_FLAG_NS) &&
 303             sysfs_info(dentry->d_sb)->ns != sd->s_ns)
 304                 goto out_bad;
 305
 306         mutex_unlock(&sysfs_mutex);
 307 out_valid:
 308         return 1;
 309 out_bad:
 310         /* Remove the dentry from the dcache hashes.
 311          * If this is a deleted dentry we use d_drop instead of d_delete
 312          * so sysfs doesn't need to cope with negative dentries.
 313          *
 314          * If this is a dentry that has simply been renamed we
 315          * use d_drop to remove it from the dcache lookup on its
 316          * old parent.  If this dentry persists later when a lookup
 317          * is performed at its new name the dentry will be readded
 318          * to the dcache hashes.
 319          */
 320         mutex_unlock(&sysfs_mutex);
 321
 322         /* If we have submounts we must allow the vfs caches
 323          * to lie about the state of the filesystem to prevent
 324          * leaks and other nasty things.
 325          */
 326         if (check_submounts_and_drop(dentry) != 0)
 327                 goto out_valid;
 328
 329         return 0;
 330 }
 331
 332 static void sysfs_dentry_release(struct dentry *dentry)
 333 {
 334         sysfs_put(dentry->d_fsdata);
 335 }
 336
 337 const struct dentry_operations sysfs_dentry_ops = {
 338         .d_revalidate   = sysfs_dentry_revalidate,
 339         .d_delete       = sysfs_dentry_delete,
 340         .d_release      = sysfs_dentry_release,
 341 };
 342
 343 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
 344 {
 345         char *dup_name = NULL;
 346         struct sysfs_dirent *sd;
 347
 348         if (type & SYSFS_COPY_NAME) {
 349                 name = dup_name = kstrdup(name, GFP_KERNEL);
 350                 if (!name)
 351                         return NULL;
 352         }
 353
 354         sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
 355         if (!sd)
 356                 goto err_out1;
 357
 358         if (sysfs_alloc_ino(&sd->s_ino))
 359                 goto err_out2;
 360
 361         atomic_set(&sd->s_count, 1);
 362         atomic_set(&sd->s_active, 0);
 363
 364         sd->s_name = name;
 365         sd->s_mode = mode;
 366         sd->s_flags = type | SYSFS_FLAG_REMOVED;
 367
 368         return sd;
 369
 370  err_out2:
 371         kmem_cache_free(sysfs_dir_cachep, sd);
 372  err_out1:
 373         kfree(dup_name);
 374         return NULL;
 375 }
 376
 377 /**
 378  *      sysfs_addrm_start - prepare for sysfs_dirent add/remove
 379  *      @acxt: pointer to sysfs_addrm_cxt to be used
 380  *
 381  *      This function is called when the caller is about to add or remove
 382  *      sysfs_dirent.  This function acquires sysfs_mutex.  @acxt is used
 383  *      to keep and pass context to other addrm functions.
 384  *
 385  *      LOCKING:
 386  *      Kernel thread context (may sleep).  sysfs_mutex is locked on
 387  *      return.
 388  */
 389 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt)
 390         __acquires(sysfs_mutex)
 391 {
 392         memset(acxt, 0, sizeof(*acxt));
 393
 394         mutex_lock(&sysfs_mutex);
 395 }
 396
 397 /**
 398  *      __sysfs_add_one - add sysfs_dirent to parent without warning
 399  *      @acxt: addrm context to use
 400  *      @sd: sysfs_dirent to be added
 401  *      @parent_sd: the parent sysfs_dirent to add @sd to
 402  *
 403  *      Get @parent_sd and set @sd->s_parent to it and increment nlink of
 404  *      the parent inode if @sd is a directory and link into the children
 405  *      list of the parent.
 406  *
 407  *      This function should be called between calls to
 408  *      sysfs_addrm_start() and sysfs_addrm_finish() and should be
 409  *      passed the same @acxt as passed to sysfs_addrm_start().
 410  *
 411  *      LOCKING:
 412  *      Determined by sysfs_addrm_start().
 413  *
 414  *      RETURNS:
 415  *      0 on success, -EEXIST if entry with the given name already
 416  *      exists.
 417  */
 418 int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
 419                     struct sysfs_dirent *parent_sd)
 420 {
 421         bool has_ns = parent_sd->s_flags & SYSFS_FLAG_NS;
 422         struct sysfs_inode_attrs *ps_iattr;
 423         int ret;
 424
 425         if (has_ns != (bool)sd->s_ns) {
 426                 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
 427                      has_ns ? "required" : "invalid",
 428                      parent_sd->s_name, sd->s_name);
 429                 return -EINVAL;
 430         }
 431
 432         if (sysfs_type(parent_sd) != SYSFS_DIR)
 433                 return -EINVAL;
 434
 435         sd->s_hash = sysfs_name_hash(sd->s_name, sd->s_ns);
 436         sd->s_parent = sysfs_get(parent_sd);
 437
 438         ret = sysfs_link_sibling(sd);
 439         if (ret)
 440                 return ret;
 441
 442         /* Update timestamps on the parent */
 443         ps_iattr = parent_sd->s_iattr;
 444         if (ps_iattr) {
 445                 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
 446                 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
 447         }
 448
 449         /* Mark the entry added into directory tree */
 450         sd->s_flags &= ~SYSFS_FLAG_REMOVED;
 451
 452         return 0;
 453 }
 454
 455 /**
 456  *      sysfs_pathname - return full path to sysfs dirent
 457  *      @sd: sysfs_dirent whose path we want
 458  *      @path: caller allocated buffer of size PATH_MAX
 459  *
 460  *      Gives the name "/" to the sysfs_root entry; any path returned
 461  *      is relative to wherever sysfs is mounted.
 462  */
 463 static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
 464 {
 465         if (sd->s_parent) {
 466                 sysfs_pathname(sd->s_parent, path);
 467                 strlcat(path, "/", PATH_MAX);
 468         }
 469         strlcat(path, sd->s_name, PATH_MAX);
 470         return path;
 471 }
 472
 473 void sysfs_warn_dup(struct sysfs_dirent *parent, const char *name)
 474 {
 475         char *path;
 476
 477         path = kzalloc(PATH_MAX, GFP_KERNEL);
 478         if (path) {
 479                 sysfs_pathname(parent, path);
 480                 strlcat(path, "/", PATH_MAX);
 481                 strlcat(path, name, PATH_MAX);
 482         }
 483
 484         WARN(1, KERN_WARNING "sysfs: cannot create duplicate filename '%s'\n",
 485              path ? path : name);
 486
 487         kfree(path);
 488 }
 489
 490 /**
 491  *      sysfs_add_one - add sysfs_dirent to parent
 492  *      @acxt: addrm context to use
 493  *      @sd: sysfs_dirent to be added
 494  *      @parent_sd: the parent sysfs_dirent to add @sd to
 495  *
 496  *      Get @parent_sd and set @sd->s_parent to it and increment nlink of
 497  *      the parent inode if @sd is a directory and link into the children
 498  *      list of the parent.
 499  *
 500  *      This function should be called between calls to
 501  *      sysfs_addrm_start() and sysfs_addrm_finish() and should be
 502  *      passed the same @acxt as passed to sysfs_addrm_start().
 503  *
 504  *      LOCKING:
 505  *      Determined by sysfs_addrm_start().
 506  *
 507  *      RETURNS:
 508  *      0 on success, -EEXIST if entry with the given name already
 509  *      exists.
 510  */
 511 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd,
 512                   struct sysfs_dirent *parent_sd)
 513 {
 514         int ret;
 515
 516         ret = __sysfs_add_one(acxt, sd, parent_sd);
 517
 518         if (ret == -EEXIST)
 519                 sysfs_warn_dup(parent_sd, sd->s_name);
 520         return ret;
 521 }
 522
 523 /**
 524  *      sysfs_remove_one - remove sysfs_dirent from parent
 525  *      @acxt: addrm context to use
 526  *      @sd: sysfs_dirent to be removed
 527  *
 528  *      Mark @sd removed and drop nlink of parent inode if @sd is a
 529  *      directory.  @sd is unlinked from the children list.
 530  *
 531  *      This function should be called between calls to
 532  *      sysfs_addrm_start() and sysfs_addrm_finish() and should be
 533  *      passed the same @acxt as passed to sysfs_addrm_start().
 534  *
 535  *      LOCKING:
 536  *      Determined by sysfs_addrm_start().
 537  */
 538 static void sysfs_remove_one(struct sysfs_addrm_cxt *acxt,
 539                              struct sysfs_dirent *sd)
 540 {
 541         struct sysfs_inode_attrs *ps_iattr;
 542
 543         /*
 544          * Removal can be called multiple times on the same node.  Only the
 545          * first invocation is effective and puts the base ref.
 546          */
 547         if (sd->s_flags & SYSFS_FLAG_REMOVED)
 548                 return;
 549
 550         sysfs_unlink_sibling(sd);
 551
 552         /* Update timestamps on the parent */
 553         ps_iattr = sd->s_parent->s_iattr;
 554         if (ps_iattr) {
 555                 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
 556                 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
 557         }
 558
 559         sd->s_flags |= SYSFS_FLAG_REMOVED;
 560         sd->u.removed_list = acxt->removed;
 561         acxt->removed = sd;
 562 }
 563
 564 /**
 565  *      sysfs_addrm_finish - finish up sysfs_dirent add/remove
 566  *      @acxt: addrm context to finish up
 567  *
 568  *      Finish up sysfs_dirent add/remove.  Resources acquired by
 569  *      sysfs_addrm_start() are released and removed sysfs_dirents are
 570  *      cleaned up.
 571  *
 572  *      LOCKING:
 573  *      sysfs_mutex is released.
 574  */
 575 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
 576         __releases(sysfs_mutex)
 577 {
 578         /* release resources acquired by sysfs_addrm_start() */
 579         mutex_unlock(&sysfs_mutex);
 580
 581         /* kill removed sysfs_dirents */
 582         while (acxt->removed) {
 583                 struct sysfs_dirent *sd = acxt->removed;
 584
 585                 acxt->removed = sd->u.removed_list;
 586
 587                 sysfs_deactivate(sd);
 588                 sysfs_unmap_bin_file(sd);
 589                 sysfs_put(sd);
 590         }
 591 }
 592
 593 /**
 594  *      sysfs_find_dirent - find sysfs_dirent with the given name
 595  *      @parent_sd: sysfs_dirent to search under
 596  *      @name: name to look for
 597  *      @ns: the namespace tag to use
 598  *
 599  *      Look for sysfs_dirent with name @name under @parent_sd.
 600  *
 601  *      LOCKING:
 602  *      mutex_lock(sysfs_mutex)
 603  *
 604  *      RETURNS:
 605  *      Pointer to sysfs_dirent if found, NULL if not.
 606  */
 607 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
 608                                        const unsigned char *name,
 609                                        const void *ns)
 610 {
 611         struct rb_node *node = parent_sd->s_dir.children.rb_node;
 612         bool has_ns = parent_sd->s_flags & SYSFS_FLAG_NS;
 613         unsigned int hash;
 614
 615         if (has_ns != (bool)ns) {
 616                 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
 617                      has_ns ? "required" : "invalid",
 618                      parent_sd->s_name, name);
 619                 return NULL;
 620         }
 621
 622         hash = sysfs_name_hash(name, ns);
 623         while (node) {
 624                 struct sysfs_dirent *sd;
 625                 int result;
 626
 627                 sd = to_sysfs_dirent(node);
 628                 result = sysfs_name_compare(hash, name, ns, sd);
 629                 if (result < 0)
 630                         node = node->rb_left;
 631                 else if (result > 0)
 632                         node = node->rb_right;
 633                 else
 634                         return sd;
 635         }
 636         return NULL;
 637 }
 638
 639 /**
 640  *      sysfs_get_dirent_ns - find and get sysfs_dirent with the given name
 641  *      @parent_sd: sysfs_dirent to search under
 642  *      @name: name to look for
 643  *      @ns: the namespace tag to use
 644  *
 645  *      Look for sysfs_dirent with name @name under @parent_sd and get
 646  *      it if found.
 647  *
 648  *      LOCKING:
 649  *      Kernel thread context (may sleep).  Grabs sysfs_mutex.
 650  *
 651  *      RETURNS:
 652  *      Pointer to sysfs_dirent if found, NULL if not.
 653  */
 654 struct sysfs_dirent *sysfs_get_dirent_ns(struct sysfs_dirent *parent_sd,
 655                                          const unsigned char *name,
 656                                          const void *ns)
 657 {
 658         struct sysfs_dirent *sd;
 659
 660         mutex_lock(&sysfs_mutex);
 661         sd = sysfs_find_dirent(parent_sd, name, ns);
 662         sysfs_get(sd);
 663         mutex_unlock(&sysfs_mutex);
 664
 665         return sd;
 666 }
 667 EXPORT_SYMBOL_GPL(sysfs_get_dirent_ns);
 668
 669 static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
 670                       const char *name, const void *ns,
 671                       struct sysfs_dirent **p_sd)
 672 {
 673         umode_t mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
 674         struct sysfs_addrm_cxt acxt;
 675         struct sysfs_dirent *sd;
 676         int rc;
 677
 678         /* allocate */
 679         sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
 680         if (!sd)
 681                 return -ENOMEM;
 682
 683         sd->s_ns = ns;
 684         sd->s_dir.kobj = kobj;
 685
 686         /* link in */
 687         sysfs_addrm_start(&acxt);
 688         rc = sysfs_add_one(&acxt, sd, parent_sd);
 689         sysfs_addrm_finish(&acxt);
 690
 691         if (rc == 0)
 692                 *p_sd = sd;
 693         else
 694                 sysfs_put(sd);
 695
 696         return rc;
 697 }
 698
 699 int sysfs_create_subdir(struct kobject *kobj, const char *name,
 700                         struct sysfs_dirent **p_sd)
 701 {
 702         return create_dir(kobj, kobj->sd, name, NULL, p_sd);
 703 }
 704
 705 /**
 706  * sysfs_create_dir_ns - create a directory for an object with a namespace tag
 707  * @kobj: object we're creating directory for
 708  * @ns: the namespace tag to use
 709  */
 710 int sysfs_create_dir_ns(struct kobject *kobj, const void *ns)
 711 {
 712         struct sysfs_dirent *parent_sd, *sd;
 713         int error = 0;
 714
 715         BUG_ON(!kobj);
 716
 717         if (kobj->parent)
 718                 parent_sd = kobj->parent->sd;
 719         else
 720                 parent_sd = &sysfs_root;
 721
 722         if (!parent_sd)
 723                 return -ENOENT;
 724
 725         error = create_dir(kobj, parent_sd, kobject_name(kobj), ns, &sd);
 726         if (!error)
 727                 kobj->sd = sd;
 728         return error;
 729 }
 730
 731 static struct dentry *sysfs_lookup(struct inode *dir, struct dentry *dentry,
 732                                    unsigned int flags)
 733 {
 734         struct dentry *ret = NULL;
 735         struct dentry *parent = dentry->d_parent;
 736         struct sysfs_dirent *parent_sd = parent->d_fsdata;
 737         struct sysfs_dirent *sd;
 738         struct inode *inode;
 739         const void *ns = NULL;
 740
 741         mutex_lock(&sysfs_mutex);
 742
 743         if (parent_sd->s_flags & SYSFS_FLAG_NS)
 744                 ns = sysfs_info(dir->i_sb)->ns;
 745
 746         sd = sysfs_find_dirent(parent_sd, dentry->d_name.name, ns);
 747
 748         /* no such entry */
 749         if (!sd) {
 750                 ret = ERR_PTR(-ENOENT);
 751                 goto out_unlock;
 752         }
 753         dentry->d_fsdata = sysfs_get(sd);
 754
 755         /* attach dentry and inode */
 756         inode = sysfs_get_inode(dir->i_sb, sd);
 757         if (!inode) {
 758                 ret = ERR_PTR(-ENOMEM);
 759                 goto out_unlock;
 760         }
 761
 762         /* instantiate and hash dentry */
 763         ret = d_materialise_unique(dentry, inode);
 764  out_unlock:
 765         mutex_unlock(&sysfs_mutex);
 766         return ret;
 767 }
 768
 769 const struct inode_operations sysfs_dir_inode_operations = {
 770         .lookup         = sysfs_lookup,
 771         .permission     = sysfs_permission,
 772         .setattr        = sysfs_setattr,
 773         .getattr        = sysfs_getattr,
 774         .setxattr       = sysfs_setxattr,
 775 };
 776
 777 static struct sysfs_dirent *sysfs_leftmost_descendant(struct sysfs_dirent *pos)
 778 {
 779         struct sysfs_dirent *last;
 780
 781         while (true) {
 782                 struct rb_node *rbn;
 783
 784                 last = pos;
 785
 786                 if (sysfs_type(pos) != SYSFS_DIR)
 787                         break;
 788
 789                 rbn = rb_first(&pos->s_dir.children);
 790                 if (!rbn)
 791                         break;
 792
 793                 pos = to_sysfs_dirent(rbn);
 794         }
 795
 796         return last;
 797 }
 798
 799 /**
 800  * sysfs_next_descendant_post - find the next descendant for post-order walk
 801  * @pos: the current position (%NULL to initiate traversal)
 802  * @root: sysfs_dirent whose descendants to walk
 803  *
 804  * Find the next descendant to visit for post-order traversal of @root's
 805  * descendants.  @root is included in the iteration and the last node to be
 806  * visited.
 807  */
 808 static struct sysfs_dirent *sysfs_next_descendant_post(struct sysfs_dirent *pos,
 809                                                        struct sysfs_dirent *root)
 810 {
 811         struct rb_node *rbn;
 812
 813         lockdep_assert_held(&sysfs_mutex);
 814
 815         /* if first iteration, visit leftmost descendant which may be root */
 816         if (!pos)
 817                 return sysfs_leftmost_descendant(root);
 818
 819         /* if we visited @root, we're done */
 820         if (pos == root)
 821                 return NULL;
 822
 823         /* if there's an unvisited sibling, visit its leftmost descendant */
 824         rbn = rb_next(&pos->s_rb);
 825         if (rbn)
 826                 return sysfs_leftmost_descendant(to_sysfs_dirent(rbn));
 827
 828         /* no sibling left, visit parent */
 829         return pos->s_parent;
 830 }
 831
 832 static void __kernfs_remove(struct sysfs_addrm_cxt *acxt,
 833                             struct sysfs_dirent *sd)
 834 {
 835         struct sysfs_dirent *pos, *next;
 836
 837         if (!sd)
 838                 return;
 839
 840         pr_debug("sysfs %s: removing\n", sd->s_name);
 841
 842         next = NULL;
 843         do {
 844                 pos = next;
 845                 next = sysfs_next_descendant_post(pos, sd);
 846                 if (pos)
 847                         sysfs_remove_one(acxt, pos);
 848         } while (next);
 849 }
 850
 851 /**
 852  * kernfs_remove - remove a sysfs_dirent recursively
 853  * @sd: the sysfs_dirent to remove
 854  *
 855  * Remove @sd along with all its subdirectories and files.
 856  */
 857 void kernfs_remove(struct sysfs_dirent *sd)
 858 {
 859         struct sysfs_addrm_cxt acxt;
 860
 861         sysfs_addrm_start(&acxt);
 862         __kernfs_remove(&acxt, sd);
 863         sysfs_addrm_finish(&acxt);
 864 }
 865
 866 /**
 867  * kernfs_remove_by_name_ns - find a sysfs_dirent by name and remove it
 868  * @dir_sd: parent of the target
 869  * @name: name of the sysfs_dirent to remove
 870  * @ns: namespace tag of the sysfs_dirent to remove
 871  *
 872  * Look for the sysfs_dirent with @name and @ns under @dir_sd and remove
 873  * it.  Returns 0 on success, -ENOENT if such entry doesn't exist.
 874  */
 875 int kernfs_remove_by_name_ns(struct sysfs_dirent *dir_sd, const char *name,
 876                              const void *ns)
 877 {
 878         struct sysfs_addrm_cxt acxt;
 879         struct sysfs_dirent *sd;
 880
 881         if (!dir_sd) {
 882                 WARN(1, KERN_WARNING "sysfs: can not remove '%s', no directory\n",
 883                         name);
 884                 return -ENOENT;
 885         }
 886
 887         sysfs_addrm_start(&acxt);
 888
 889         sd = sysfs_find_dirent(dir_sd, name, ns);
 890         if (sd)
 891                 __kernfs_remove(&acxt, sd);
 892
 893         sysfs_addrm_finish(&acxt);
 894
 895         if (sd)
 896                 return 0;
 897         else
 898                 return -ENOENT;
 899 }
 900
 901 /**
 902  *      sysfs_remove_dir - remove an object's directory.
 903  *      @kobj:  object.
 904  *
 905  *      The only thing special about this is that we remove any files in
 906  *      the directory before we remove the directory, and we've inlined
 907  *      what used to be sysfs_rmdir() below, instead of calling separately.
 908  */
 909 void sysfs_remove_dir(struct kobject *kobj)
 910 {
 911         struct sysfs_dirent *sd = kobj->sd;
 912
 913         /*
 914          * In general, kboject owner is responsible for ensuring removal
 915          * doesn't race with other operations and sysfs doesn't provide any
 916          * protection; however, when @kobj is used as a symlink target, the
 917          * symlinking entity usually doesn't own @kobj and thus has no
 918          * control over removal.  @kobj->sd may be removed anytime and
 919          * symlink code may end up dereferencing an already freed sd.
 920          *
 921          * sysfs_symlink_target_lock synchronizes @kobj->sd disassociation
 922          * against symlink operations so that symlink code can safely
 923          * dereference @kobj->sd.
 924          */
 925         spin_lock(&sysfs_symlink_target_lock);
 926         kobj->sd = NULL;
 927         spin_unlock(&sysfs_symlink_target_lock);
 928
 929         if (sd) {
 930                 WARN_ON_ONCE(sysfs_type(sd) != SYSFS_DIR);
 931                 kernfs_remove(sd);
 932         }
 933 }
 934
 935 /**
 936  * kernfs_rename_ns - move and rename a kernfs_node
 937  * @sd: target node
 938  * @new_parent: new parent to put @sd under
 939  * @new_name: new name
 940  * @new_ns: new namespace tag
 941  */
 942 int kernfs_rename_ns(struct sysfs_dirent *sd, struct sysfs_dirent *new_parent,
 943                      const char *new_name, const void *new_ns)
 944 {
 945         int error;
 946
 947         mutex_lock(&sysfs_mutex);
 948
 949         error = 0;
 950         if ((sd->s_parent == new_parent) && (sd->s_ns == new_ns) &&
 951             (strcmp(sd->s_name, new_name) == 0))
 952                 goto out;       /* nothing to rename */
 953
 954         error = -EEXIST;
 955         if (sysfs_find_dirent(new_parent, new_name, new_ns))
 956                 goto out;
 957
 958         /* rename sysfs_dirent */
 959         if (strcmp(sd->s_name, new_name) != 0) {
 960                 error = -ENOMEM;
 961                 new_name = kstrdup(new_name, GFP_KERNEL);
 962                 if (!new_name)
 963                         goto out;
 964
 965                 kfree(sd->s_name);
 966                 sd->s_name = new_name;
 967         }
 968
 969         /*
 970          * Move to the appropriate place in the appropriate directories rbtree.
 971          */
 972         sysfs_unlink_sibling(sd);
 973         sysfs_get(new_parent);
 974         sysfs_put(sd->s_parent);
 975         sd->s_ns = new_ns;
 976         sd->s_hash = sysfs_name_hash(sd->s_name, sd->s_ns);
 977         sd->s_parent = new_parent;
 978         sysfs_link_sibling(sd);
 979
 980         error = 0;
 981  out:
 982         mutex_unlock(&sysfs_mutex);
 983         return error;
 984 }
 985
 986 int sysfs_rename_dir_ns(struct kobject *kobj, const char *new_name,
 987                         const void *new_ns)
 988 {
 989         struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
 990
 991         return kernfs_rename_ns(kobj->sd, parent_sd, new_name, new_ns);
 992 }
 993
 994 int sysfs_move_dir_ns(struct kobject *kobj, struct kobject *new_parent_kobj,
 995                       const void *new_ns)
 996 {
 997         struct sysfs_dirent *sd = kobj->sd;
 998         struct sysfs_dirent *new_parent_sd;
 999
1000         BUG_ON(!sd->s_parent);
1001         new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
1002                 new_parent_kobj->sd : &sysfs_root;
1003
1004         return kernfs_rename_ns(sd, new_parent_sd, sd->s_name, new_ns);
1005 }
1006
1007 /**
1008  * sysfs_enable_ns - enable namespace under a directory
1009  * @sd: directory of interest, should be empty
1010  *
1011  * This is to be called right after @sd is created to enable namespace
1012  * under it.  All children of @sd must have non-NULL namespace tags and
1013  * only the ones which match the super_block's tag will be visible.
1014  */
1015 void sysfs_enable_ns(struct sysfs_dirent *sd)
1016 {
1017         WARN_ON_ONCE(sysfs_type(sd) != SYSFS_DIR);
1018         WARN_ON_ONCE(!RB_EMPTY_ROOT(&sd->s_dir.children));
1019         sd->s_flags |= SYSFS_FLAG_NS;
1020 }
1021
1022 /* Relationship between s_mode and the DT_xxx types */
1023 static inline unsigned char dt_type(struct sysfs_dirent *sd)
1024 {
1025         return (sd->s_mode >> 12) & 15;
1026 }
1027
1028 static int sysfs_dir_release(struct inode *inode, struct file *filp)
1029 {
1030         sysfs_put(filp->private_data);
1031         return 0;
1032 }
1033
1034 static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
1035         struct sysfs_dirent *parent_sd, loff_t hash, struct sysfs_dirent *pos)
1036 {
1037         if (pos) {
1038                 int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
1039                         pos->s_parent == parent_sd &&
1040                         hash == pos->s_hash;
1041                 sysfs_put(pos);
1042                 if (!valid)
1043                         pos = NULL;
1044         }
1045         if (!pos && (hash > 1) && (hash < INT_MAX)) {
1046                 struct rb_node *node = parent_sd->s_dir.children.rb_node;
1047                 while (node) {
1048                         pos = to_sysfs_dirent(node);
1049
1050                         if (hash < pos->s_hash)
1051                                 node = node->rb_left;
1052                         else if (hash > pos->s_hash)
1053                                 node = node->rb_right;
1054                         else
1055                                 break;
1056                 }
1057         }
1058         /* Skip over entries in the wrong namespace */
1059         while (pos && pos->s_ns != ns) {
1060                 struct rb_node *node = rb_next(&pos->s_rb);
1061                 if (!node)
1062                         pos = NULL;
1063                 else
1064                         pos = to_sysfs_dirent(node);
1065         }
1066         return pos;
1067 }
1068
1069 static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
1070         struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos)
1071 {
1072         pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
1073         if (pos)
1074                 do {
1075                         struct rb_node *node = rb_next(&pos->s_rb);
1076                         if (!node)
1077                                 pos = NULL;
1078                         else
1079                                 pos = to_sysfs_dirent(node);
1080                 } while (pos && pos->s_ns != ns);
1081         return pos;
1082 }
1083
1084 static int sysfs_readdir(struct file *file, struct dir_context *ctx)
1085 {
1086         struct dentry *dentry = file->f_path.dentry;
1087         struct sysfs_dirent *parent_sd = dentry->d_fsdata;
1088         struct sysfs_dirent *pos = file->private_data;
1089         const void *ns = NULL;
1090
1091         if (!dir_emit_dots(file, ctx))
1092                 return 0;
1093         mutex_lock(&sysfs_mutex);
1094
1095         if (parent_sd->s_flags & SYSFS_FLAG_NS)
1096                 ns = sysfs_info(dentry->d_sb)->ns;
1097
1098         for (pos = sysfs_dir_pos(ns, parent_sd, ctx->pos, pos);
1099              pos;
1100              pos = sysfs_dir_next_pos(ns, parent_sd, ctx->pos, pos)) {
1101                 const char *name = pos->s_name;
1102                 unsigned int type = dt_type(pos);
1103                 int len = strlen(name);
1104                 ino_t ino = pos->s_ino;
1105                 ctx->pos = pos->s_hash;
1106                 file->private_data = sysfs_get(pos);
1107
1108                 mutex_unlock(&sysfs_mutex);
1109                 if (!dir_emit(ctx, name, len, ino, type))
1110                         return 0;
1111                 mutex_lock(&sysfs_mutex);
1112         }
1113         mutex_unlock(&sysfs_mutex);
1114         file->private_data = NULL;
1115         ctx->pos = INT_MAX;
1116         return 0;
1117 }
1118
1119 static loff_t sysfs_dir_llseek(struct file *file, loff_t offset, int whence)
1120 {
1121         struct inode *inode = file_inode(file);
1122         loff_t ret;
1123
1124         mutex_lock(&inode->i_mutex);
1125         ret = generic_file_llseek(file, offset, whence);
1126         mutex_unlock(&inode->i_mutex);
1127
1128         return ret;
1129 }
1130
1131 const struct file_operations sysfs_dir_operations = {
1132         .read           = generic_read_dir,
1133         .iterate        = sysfs_readdir,
1134         .release        = sysfs_dir_release,
1135         .llseek         = sysfs_dir_llseek,
1136 };