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