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