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 "sysfs.h"
  26
  27 DEFINE_MUTEX(sysfs_mutex);
  28 DEFINE_SPINLOCK(sysfs_assoc_lock);
  29
  30 static DEFINE_SPINLOCK(sysfs_ino_lock);
  31 static DEFINE_IDA(sysfs_ino_ida);
  32
  33 /**
  34  *      sysfs_link_sibling - link sysfs_dirent into sibling list
  35  *      @sd: sysfs_dirent of interest
  36  *
  37  *      Link @sd into its sibling list which starts from
  38  *      sd->s_parent->s_dir.children.
  39  *
  40  *      Locking:
  41  *      mutex_lock(sysfs_mutex)
  42  */
  43 static void sysfs_link_sibling(struct sysfs_dirent *sd)
  44 {
  45         struct sysfs_dirent *parent_sd = sd->s_parent;
  46         struct sysfs_dirent **pos;
  47
  48         BUG_ON(sd->s_sibling);
  49
  50         /* Store directory entries in order by ino.  This allows
  51          * readdir to properly restart without having to add a
  52          * cursor into the s_dir.children list.
  53          */
  54         for (pos = &parent_sd->s_dir.children; *pos; pos = &(*pos)->s_sibling) {
  55                 if (sd->s_ino < (*pos)->s_ino)
  56                         break;
  57         }
  58         sd->s_sibling = *pos;
  59         *pos = sd;
  60 }
  61
  62 /**
  63  *      sysfs_unlink_sibling - unlink sysfs_dirent from sibling list
  64  *      @sd: sysfs_dirent of interest
  65  *
  66  *      Unlink @sd from its sibling list which starts from
  67  *      sd->s_parent->s_dir.children.
  68  *
  69  *      Locking:
  70  *      mutex_lock(sysfs_mutex)
  71  */
  72 static void sysfs_unlink_sibling(struct sysfs_dirent *sd)
  73 {
  74         struct sysfs_dirent **pos;
  75
  76         for (pos = &sd->s_parent->s_dir.children; *pos;
  77              pos = &(*pos)->s_sibling) {
  78                 if (*pos == sd) {
  79                         *pos = sd->s_sibling;
  80                         sd->s_sibling = NULL;
  81                         break;
  82                 }
  83         }
  84 }
  85
  86 /**
  87  *      sysfs_get_active - get an active reference to sysfs_dirent
  88  *      @sd: sysfs_dirent to get an active reference to
  89  *
  90  *      Get an active reference of @sd.  This function is noop if @sd
  91  *      is NULL.
  92  *
  93  *      RETURNS:
  94  *      Pointer to @sd on success, NULL on failure.
  95  */
  96 struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd)
  97 {
  98         if (unlikely(!sd))
  99                 return NULL;
 100
 101         while (1) {
 102                 int v, t;
 103
 104                 v = atomic_read(&sd->s_active);
 105                 if (unlikely(v < 0))
 106                         return NULL;
 107
 108                 t = atomic_cmpxchg(&sd->s_active, v, v + 1);
 109                 if (likely(t == v)) {
 110                         rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_);
 111                         return sd;
 112                 }
 113                 if (t < 0)
 114                         return NULL;
 115
 116                 cpu_relax();
 117         }
 118 }
 119
 120 /**
 121  *      sysfs_put_active - put an active reference to sysfs_dirent
 122  *      @sd: sysfs_dirent to put an active reference to
 123  *
 124  *      Put an active reference to @sd.  This function is noop if @sd
 125  *      is NULL.
 126  */
 127 void sysfs_put_active(struct sysfs_dirent *sd)
 128 {
 129         struct completion *cmpl;
 130         int v;
 131
 132         if (unlikely(!sd))
 133                 return;
 134
 135         rwsem_release(&sd->dep_map, 1, _RET_IP_);
 136         v = atomic_dec_return(&sd->s_active);
 137         if (likely(v != SD_DEACTIVATED_BIAS))
 138                 return;
 139
 140         /* atomic_dec_return() is a mb(), we'll always see the updated
 141          * sd->s_sibling.
 142          */
 143         cmpl = (void *)sd->s_sibling;
 144         complete(cmpl);
 145 }
 146
 147 /**
 148  *      sysfs_deactivate - deactivate sysfs_dirent
 149  *      @sd: sysfs_dirent to deactivate
 150  *
 151  *      Deny new active references and drain existing ones.
 152  */
 153 static void sysfs_deactivate(struct sysfs_dirent *sd)
 154 {
 155         DECLARE_COMPLETION_ONSTACK(wait);
 156         int v;
 157
 158         BUG_ON(sd->s_sibling || !(sd->s_flags & SYSFS_FLAG_REMOVED));
 159
 160         if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF))
 161                 return;
 162
 163         sd->s_sibling = (void *)&wait;
 164
 165         rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_);
 166         /* atomic_add_return() is a mb(), put_active() will always see
 167          * the updated sd->s_sibling.
 168          */
 169         v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active);
 170
 171         if (v != SD_DEACTIVATED_BIAS) {
 172                 lock_contended(&sd->dep_map, _RET_IP_);
 173                 wait_for_completion(&wait);
 174         }
 175
 176         sd->s_sibling = NULL;
 177
 178         lock_acquired(&sd->dep_map, _RET_IP_);
 179         rwsem_release(&sd->dep_map, 1, _RET_IP_);
 180 }
 181
 182 static int sysfs_alloc_ino(ino_t *pino)
 183 {
 184         int ino, rc;
 185
 186  retry:
 187         spin_lock(&sysfs_ino_lock);
 188         rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino);
 189         spin_unlock(&sysfs_ino_lock);
 190
 191         if (rc == -EAGAIN) {
 192                 if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL))
 193                         goto retry;
 194                 rc = -ENOMEM;
 195         }
 196
 197         *pino = ino;
 198         return rc;
 199 }
 200
 201 static void sysfs_free_ino(ino_t ino)
 202 {
 203         spin_lock(&sysfs_ino_lock);
 204         ida_remove(&sysfs_ino_ida, ino);
 205         spin_unlock(&sysfs_ino_lock);
 206 }
 207
 208 void release_sysfs_dirent(struct sysfs_dirent * sd)
 209 {
 210         struct sysfs_dirent *parent_sd;
 211
 212  repeat:
 213         /* Moving/renaming is always done while holding reference.
 214          * sd->s_parent won't change beneath us.
 215          */
 216         parent_sd = sd->s_parent;
 217
 218         if (sysfs_type(sd) == SYSFS_KOBJ_LINK)
 219                 sysfs_put(sd->s_symlink.target_sd);
 220         if (sysfs_type(sd) & SYSFS_COPY_NAME)
 221                 kfree(sd->s_name);
 222         if (sd->s_iattr && sd->s_iattr->ia_secdata)
 223                 security_release_secctx(sd->s_iattr->ia_secdata,
 224                                         sd->s_iattr->ia_secdata_len);
 225         kfree(sd->s_iattr);
 226         sysfs_free_ino(sd->s_ino);
 227         kmem_cache_free(sysfs_dir_cachep, sd);
 228
 229         sd = parent_sd;
 230         if (sd && atomic_dec_and_test(&sd->s_count))
 231                 goto repeat;
 232 }
 233
 234 static int sysfs_dentry_delete(const struct dentry *dentry)
 235 {
 236         struct sysfs_dirent *sd = dentry->d_fsdata;
 237         return !!(sd->s_flags & SYSFS_FLAG_REMOVED);
 238 }
 239
 240 static int sysfs_dentry_revalidate(struct dentry *dentry, struct nameidata *nd)
 241 {
 242         struct sysfs_dirent *sd;
 243         int is_dir;
 244
 245         if (nd->flags & LOOKUP_RCU)
 246                 return -ECHILD;
 247
 248         sd = dentry->d_fsdata;
 249         mutex_lock(&sysfs_mutex);
 250
 251         /* The sysfs dirent has been deleted */
 252         if (sd->s_flags & SYSFS_FLAG_REMOVED)
 253                 goto out_bad;
 254
 255         /* The sysfs dirent has been moved? */
 256         if (dentry->d_parent->d_fsdata != sd->s_parent)
 257                 goto out_bad;
 258
 259         /* The sysfs dirent has been renamed */
 260         if (strcmp(dentry->d_name.name, sd->s_name) != 0)
 261                 goto out_bad;
 262
 263         mutex_unlock(&sysfs_mutex);
 264 out_valid:
 265         return 1;
 266 out_bad:
 267         /* Remove the dentry from the dcache hashes.
 268          * If this is a deleted dentry we use d_drop instead of d_delete
 269          * so sysfs doesn't need to cope with negative dentries.
 270          *
 271          * If this is a dentry that has simply been renamed we
 272          * use d_drop to remove it from the dcache lookup on its
 273          * old parent.  If this dentry persists later when a lookup
 274          * is performed at its new name the dentry will be readded
 275          * to the dcache hashes.
 276          */
 277         is_dir = (sysfs_type(sd) == SYSFS_DIR);
 278         mutex_unlock(&sysfs_mutex);
 279         if (is_dir) {
 280                 /* If we have submounts we must allow the vfs caches
 281                  * to lie about the state of the filesystem to prevent
 282                  * leaks and other nasty things.
 283                  */
 284                 if (have_submounts(dentry))
 285                         goto out_valid;
 286                 shrink_dcache_parent(dentry);
 287         }
 288         d_drop(dentry);
 289         return 0;
 290 }
 291
 292 static void sysfs_dentry_iput(struct dentry *dentry, struct inode *inode)
 293 {
 294         struct sysfs_dirent * sd = dentry->d_fsdata;
 295
 296         sysfs_put(sd);
 297         iput(inode);
 298 }
 299
 300 static const struct dentry_operations sysfs_dentry_ops = {
 301         .d_revalidate   = sysfs_dentry_revalidate,
 302         .d_delete       = sysfs_dentry_delete,
 303         .d_iput         = sysfs_dentry_iput,
 304 };
 305
 306 struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type)
 307 {
 308         char *dup_name = NULL;
 309         struct sysfs_dirent *sd;
 310
 311         if (type & SYSFS_COPY_NAME) {
 312                 name = dup_name = kstrdup(name, GFP_KERNEL);
 313                 if (!name)
 314                         return NULL;
 315         }
 316
 317         sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL);
 318         if (!sd)
 319                 goto err_out1;
 320
 321         if (sysfs_alloc_ino(&sd->s_ino))
 322                 goto err_out2;
 323
 324         atomic_set(&sd->s_count, 1);
 325         atomic_set(&sd->s_active, 0);
 326
 327         sd->s_name = name;
 328         sd->s_mode = mode;
 329         sd->s_flags = type;
 330
 331         return sd;
 332
 333  err_out2:
 334         kmem_cache_free(sysfs_dir_cachep, sd);
 335  err_out1:
 336         kfree(dup_name);
 337         return NULL;
 338 }
 339
 340 /**
 341  *      sysfs_addrm_start - prepare for sysfs_dirent add/remove
 342  *      @acxt: pointer to sysfs_addrm_cxt to be used
 343  *      @parent_sd: parent sysfs_dirent
 344  *
 345  *      This function is called when the caller is about to add or
 346  *      remove sysfs_dirent under @parent_sd.  This function acquires
 347  *      sysfs_mutex.  @acxt is used to keep and pass context to
 348  *      other addrm functions.
 349  *
 350  *      LOCKING:
 351  *      Kernel thread context (may sleep).  sysfs_mutex is locked on
 352  *      return.
 353  */
 354 void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt,
 355                        struct sysfs_dirent *parent_sd)
 356 {
 357         memset(acxt, 0, sizeof(*acxt));
 358         acxt->parent_sd = parent_sd;
 359
 360         mutex_lock(&sysfs_mutex);
 361 }
 362
 363 /**
 364  *      __sysfs_add_one - add sysfs_dirent to parent without warning
 365  *      @acxt: addrm context to use
 366  *      @sd: sysfs_dirent to be added
 367  *
 368  *      Get @acxt->parent_sd and set sd->s_parent to it and increment
 369  *      nlink of parent inode if @sd is a directory and link into the
 370  *      children list of the parent.
 371  *
 372  *      This function should be called between calls to
 373  *      sysfs_addrm_start() and sysfs_addrm_finish() and should be
 374  *      passed the same @acxt as passed to sysfs_addrm_start().
 375  *
 376  *      LOCKING:
 377  *      Determined by sysfs_addrm_start().
 378  *
 379  *      RETURNS:
 380  *      0 on success, -EEXIST if entry with the given name already
 381  *      exists.
 382  */
 383 int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
 384 {
 385         struct sysfs_inode_attrs *ps_iattr;
 386
 387         if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) {
 388                 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
 389                         sysfs_ns_type(acxt->parent_sd)? "required": "invalid",
 390                         acxt->parent_sd->s_name, sd->s_name);
 391                 return -EINVAL;
 392         }
 393
 394         if (sysfs_find_dirent(acxt->parent_sd, sd->s_ns, sd->s_name))
 395                 return -EEXIST;
 396
 397         sd->s_parent = sysfs_get(acxt->parent_sd);
 398
 399         sysfs_link_sibling(sd);
 400
 401         /* Update timestamps on the parent */
 402         ps_iattr = acxt->parent_sd->s_iattr;
 403         if (ps_iattr) {
 404                 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
 405                 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
 406         }
 407
 408         return 0;
 409 }
 410
 411 /**
 412  *      sysfs_pathname - return full path to sysfs dirent
 413  *      @sd: sysfs_dirent whose path we want
 414  *      @path: caller allocated buffer
 415  *
 416  *      Gives the name "/" to the sysfs_root entry; any path returned
 417  *      is relative to wherever sysfs is mounted.
 418  *
 419  *      XXX: does no error checking on @path size
 420  */
 421 static char *sysfs_pathname(struct sysfs_dirent *sd, char *path)
 422 {
 423         if (sd->s_parent) {
 424                 sysfs_pathname(sd->s_parent, path);
 425                 strcat(path, "/");
 426         }
 427         strcat(path, sd->s_name);
 428         return path;
 429 }
 430
 431 /**
 432  *      sysfs_add_one - add sysfs_dirent to parent
 433  *      @acxt: addrm context to use
 434  *      @sd: sysfs_dirent to be added
 435  *
 436  *      Get @acxt->parent_sd and set sd->s_parent to it and increment
 437  *      nlink of parent inode if @sd is a directory and link into the
 438  *      children list of the parent.
 439  *
 440  *      This function should be called between calls to
 441  *      sysfs_addrm_start() and sysfs_addrm_finish() and should be
 442  *      passed the same @acxt as passed to sysfs_addrm_start().
 443  *
 444  *      LOCKING:
 445  *      Determined by sysfs_addrm_start().
 446  *
 447  *      RETURNS:
 448  *      0 on success, -EEXIST if entry with the given name already
 449  *      exists.
 450  */
 451 int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
 452 {
 453         int ret;
 454
 455         ret = __sysfs_add_one(acxt, sd);
 456         if (ret == -EEXIST) {
 457                 char *path = kzalloc(PATH_MAX, GFP_KERNEL);
 458                 WARN(1, KERN_WARNING
 459                      "sysfs: cannot create duplicate filename '%s'\n",
 460                      (path == NULL) ? sd->s_name :
 461                      strcat(strcat(sysfs_pathname(acxt->parent_sd, path), "/"),
 462                             sd->s_name));
 463                 kfree(path);
 464         }
 465
 466         return ret;
 467 }
 468
 469 /**
 470  *      sysfs_remove_one - remove sysfs_dirent from parent
 471  *      @acxt: addrm context to use
 472  *      @sd: sysfs_dirent to be removed
 473  *
 474  *      Mark @sd removed and drop nlink of parent inode if @sd is a
 475  *      directory.  @sd is unlinked from the children list.
 476  *
 477  *      This function should be called between calls to
 478  *      sysfs_addrm_start() and sysfs_addrm_finish() and should be
 479  *      passed the same @acxt as passed to sysfs_addrm_start().
 480  *
 481  *      LOCKING:
 482  *      Determined by sysfs_addrm_start().
 483  */
 484 void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd)
 485 {
 486         struct sysfs_inode_attrs *ps_iattr;
 487
 488         BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED);
 489
 490         sysfs_unlink_sibling(sd);
 491
 492         /* Update timestamps on the parent */
 493         ps_iattr = acxt->parent_sd->s_iattr;
 494         if (ps_iattr) {
 495                 struct iattr *ps_iattrs = &ps_iattr->ia_iattr;
 496                 ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME;
 497         }
 498
 499         sd->s_flags |= SYSFS_FLAG_REMOVED;
 500         sd->s_sibling = acxt->removed;
 501         acxt->removed = sd;
 502 }
 503
 504 /**
 505  *      sysfs_addrm_finish - finish up sysfs_dirent add/remove
 506  *      @acxt: addrm context to finish up
 507  *
 508  *      Finish up sysfs_dirent add/remove.  Resources acquired by
 509  *      sysfs_addrm_start() are released and removed sysfs_dirents are
 510  *      cleaned up.
 511  *
 512  *      LOCKING:
 513  *      sysfs_mutex is released.
 514  */
 515 void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt)
 516 {
 517         /* release resources acquired by sysfs_addrm_start() */
 518         mutex_unlock(&sysfs_mutex);
 519
 520         /* kill removed sysfs_dirents */
 521         while (acxt->removed) {
 522                 struct sysfs_dirent *sd = acxt->removed;
 523
 524                 acxt->removed = sd->s_sibling;
 525                 sd->s_sibling = NULL;
 526
 527                 sysfs_deactivate(sd);
 528                 unmap_bin_file(sd);
 529                 sysfs_put(sd);
 530         }
 531 }
 532
 533 /**
 534  *      sysfs_find_dirent - find sysfs_dirent with the given name
 535  *      @parent_sd: sysfs_dirent to search under
 536  *      @name: name to look for
 537  *
 538  *      Look for sysfs_dirent with name @name under @parent_sd.
 539  *
 540  *      LOCKING:
 541  *      mutex_lock(sysfs_mutex)
 542  *
 543  *      RETURNS:
 544  *      Pointer to sysfs_dirent if found, NULL if not.
 545  */
 546 struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd,
 547                                        const void *ns,
 548                                        const unsigned char *name)
 549 {
 550         struct sysfs_dirent *sd;
 551
 552         if (!!sysfs_ns_type(parent_sd) != !!ns) {
 553                 WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n",
 554                         sysfs_ns_type(parent_sd)? "required": "invalid",
 555                         parent_sd->s_name, name);
 556                 return NULL;
 557         }
 558
 559         for (sd = parent_sd->s_dir.children; sd; sd = sd->s_sibling) {
 560                 if (sd->s_ns != ns)
 561                         continue;
 562                 if (!strcmp(sd->s_name, name))
 563                         return sd;
 564         }
 565         return NULL;
 566 }
 567
 568 /**
 569  *      sysfs_get_dirent - find and get sysfs_dirent with the given name
 570  *      @parent_sd: sysfs_dirent to search under
 571  *      @name: name to look for
 572  *
 573  *      Look for sysfs_dirent with name @name under @parent_sd and get
 574  *      it if found.
 575  *
 576  *      LOCKING:
 577  *      Kernel thread context (may sleep).  Grabs sysfs_mutex.
 578  *
 579  *      RETURNS:
 580  *      Pointer to sysfs_dirent if found, NULL if not.
 581  */
 582 struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd,
 583                                       const void *ns,
 584                                       const unsigned char *name)
 585 {
 586         struct sysfs_dirent *sd;
 587
 588         mutex_lock(&sysfs_mutex);
 589         sd = sysfs_find_dirent(parent_sd, ns, name);
 590         sysfs_get(sd);
 591         mutex_unlock(&sysfs_mutex);
 592
 593         return sd;
 594 }
 595 EXPORT_SYMBOL_GPL(sysfs_get_dirent);
 596
 597 static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd,
 598         enum kobj_ns_type type, const void *ns, const char *name,
 599         struct sysfs_dirent **p_sd)
 600 {
 601         umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO;
 602         struct sysfs_addrm_cxt acxt;
 603         struct sysfs_dirent *sd;
 604         int rc;
 605
 606         /* allocate */
 607         sd = sysfs_new_dirent(name, mode, SYSFS_DIR);
 608         if (!sd)
 609                 return -ENOMEM;
 610
 611         sd->s_flags |= (type << SYSFS_NS_TYPE_SHIFT);
 612         sd->s_ns = ns;
 613         sd->s_dir.kobj = kobj;
 614
 615         /* link in */
 616         sysfs_addrm_start(&acxt, parent_sd);
 617         rc = sysfs_add_one(&acxt, sd);
 618         sysfs_addrm_finish(&acxt);
 619
 620         if (rc == 0)
 621                 *p_sd = sd;
 622         else
 623                 sysfs_put(sd);
 624
 625         return rc;
 626 }
 627
 628 int sysfs_create_subdir(struct kobject *kobj, const char *name,
 629                         struct sysfs_dirent **p_sd)
 630 {
 631         return create_dir(kobj, kobj->sd,
 632                           KOBJ_NS_TYPE_NONE, NULL, name, p_sd);
 633 }
 634
 635 /**
 636  *      sysfs_read_ns_type: return associated ns_type
 637  *      @kobj: the kobject being queried
 638  *
 639  *      Each kobject can be tagged with exactly one namespace type
 640  *      (i.e. network or user).  Return the ns_type associated with
 641  *      this object if any
 642  */
 643 static enum kobj_ns_type sysfs_read_ns_type(struct kobject *kobj)
 644 {
 645         const struct kobj_ns_type_operations *ops;
 646         enum kobj_ns_type type;
 647
 648         ops = kobj_child_ns_ops(kobj);
 649         if (!ops)
 650                 return KOBJ_NS_TYPE_NONE;
 651
 652         type = ops->type;
 653         BUG_ON(type <= KOBJ_NS_TYPE_NONE);
 654         BUG_ON(type >= KOBJ_NS_TYPES);
 655         BUG_ON(!kobj_ns_type_registered(type));
 656
 657         return type;
 658 }
 659
 660 /**
 661  *      sysfs_create_dir - create a directory for an object.
 662  *      @kobj:          object we're creating directory for.
 663  */
 664 int sysfs_create_dir(struct kobject * kobj)
 665 {
 666         enum kobj_ns_type type;
 667         struct sysfs_dirent *parent_sd, *sd;
 668         const void *ns = NULL;
 669         int error = 0;
 670
 671         BUG_ON(!kobj);
 672
 673         if (kobj->parent)
 674                 parent_sd = kobj->parent->sd;
 675         else
 676                 parent_sd = &sysfs_root;
 677
 678         if (sysfs_ns_type(parent_sd))
 679                 ns = kobj->ktype->namespace(kobj);
 680         type = sysfs_read_ns_type(kobj);
 681
 682         error = create_dir(kobj, parent_sd, type, ns, kobject_name(kobj), &sd);
 683         if (!error)
 684                 kobj->sd = sd;
 685         return error;
 686 }
 687
 688 static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry,
 689                                 struct nameidata *nd)
 690 {
 691         struct dentry *ret = NULL;
 692         struct dentry *parent = dentry->d_parent;
 693         struct sysfs_dirent *parent_sd = parent->d_fsdata;
 694         struct sysfs_dirent *sd;
 695         struct inode *inode;
 696         enum kobj_ns_type type;
 697         const void *ns;
 698
 699         mutex_lock(&sysfs_mutex);
 700
 701         type = sysfs_ns_type(parent_sd);
 702         ns = sysfs_info(dir->i_sb)->ns[type];
 703
 704         sd = sysfs_find_dirent(parent_sd, ns, dentry->d_name.name);
 705
 706         /* no such entry */
 707         if (!sd) {
 708                 ret = ERR_PTR(-ENOENT);
 709                 goto out_unlock;
 710         }
 711
 712         /* attach dentry and inode */
 713         inode = sysfs_get_inode(dir->i_sb, sd);
 714         if (!inode) {
 715                 ret = ERR_PTR(-ENOMEM);
 716                 goto out_unlock;
 717         }
 718
 719         /* instantiate and hash dentry */
 720         ret = d_find_alias(inode);
 721         if (!ret) {
 722                 d_set_d_op(dentry, &sysfs_dentry_ops);
 723                 dentry->d_fsdata = sysfs_get(sd);
 724                 d_add(dentry, inode);
 725         } else {
 726                 d_move(ret, dentry);
 727                 iput(inode);
 728         }
 729
 730  out_unlock:
 731         mutex_unlock(&sysfs_mutex);
 732         return ret;
 733 }
 734
 735 const struct inode_operations sysfs_dir_inode_operations = {
 736         .lookup         = sysfs_lookup,
 737         .permission     = sysfs_permission,
 738         .setattr        = sysfs_setattr,
 739         .getattr        = sysfs_getattr,
 740         .setxattr       = sysfs_setxattr,
 741 };
 742
 743 static void remove_dir(struct sysfs_dirent *sd)
 744 {
 745         struct sysfs_addrm_cxt acxt;
 746
 747         sysfs_addrm_start(&acxt, sd->s_parent);
 748         sysfs_remove_one(&acxt, sd);
 749         sysfs_addrm_finish(&acxt);
 750 }
 751
 752 void sysfs_remove_subdir(struct sysfs_dirent *sd)
 753 {
 754         remove_dir(sd);
 755 }
 756
 757
 758 static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd)
 759 {
 760         struct sysfs_addrm_cxt acxt;
 761         struct sysfs_dirent **pos;
 762
 763         if (!dir_sd)
 764                 return;
 765
 766         pr_debug("sysfs %s: removing dir\n", dir_sd->s_name);
 767         sysfs_addrm_start(&acxt, dir_sd);
 768         pos = &dir_sd->s_dir.children;
 769         while (*pos) {
 770                 struct sysfs_dirent *sd = *pos;
 771
 772                 if (sysfs_type(sd) != SYSFS_DIR)
 773                         sysfs_remove_one(&acxt, sd);
 774                 else
 775                         pos = &(*pos)->s_sibling;
 776         }
 777         sysfs_addrm_finish(&acxt);
 778
 779         remove_dir(dir_sd);
 780 }
 781
 782 /**
 783  *      sysfs_remove_dir - remove an object's directory.
 784  *      @kobj:  object.
 785  *
 786  *      The only thing special about this is that we remove any files in
 787  *      the directory before we remove the directory, and we've inlined
 788  *      what used to be sysfs_rmdir() below, instead of calling separately.
 789  */
 790
 791 void sysfs_remove_dir(struct kobject * kobj)
 792 {
 793         struct sysfs_dirent *sd = kobj->sd;
 794
 795         spin_lock(&sysfs_assoc_lock);
 796         kobj->sd = NULL;
 797         spin_unlock(&sysfs_assoc_lock);
 798
 799         __sysfs_remove_dir(sd);
 800 }
 801
 802 int sysfs_rename(struct sysfs_dirent *sd,
 803         struct sysfs_dirent *new_parent_sd, const void *new_ns,
 804         const char *new_name)
 805 {
 806         const char *dup_name = NULL;
 807         int error;
 808
 809         mutex_lock(&sysfs_mutex);
 810
 811         error = 0;
 812         if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) &&
 813             (strcmp(sd->s_name, new_name) == 0))
 814                 goto out;       /* nothing to rename */
 815
 816         error = -EEXIST;
 817         if (sysfs_find_dirent(new_parent_sd, new_ns, new_name))
 818                 goto out;
 819
 820         /* rename sysfs_dirent */
 821         if (strcmp(sd->s_name, new_name) != 0) {
 822                 error = -ENOMEM;
 823                 new_name = dup_name = kstrdup(new_name, GFP_KERNEL);
 824                 if (!new_name)
 825                         goto out;
 826
 827                 dup_name = sd->s_name;
 828                 sd->s_name = new_name;
 829         }
 830
 831         /* Remove from old parent's list and insert into new parent's list. */
 832         if (sd->s_parent != new_parent_sd) {
 833                 sysfs_unlink_sibling(sd);
 834                 sysfs_get(new_parent_sd);
 835                 sysfs_put(sd->s_parent);
 836                 sd->s_parent = new_parent_sd;
 837                 sysfs_link_sibling(sd);
 838         }
 839         sd->s_ns = new_ns;
 840
 841         error = 0;
 842  out:
 843         mutex_unlock(&sysfs_mutex);
 844         kfree(dup_name);
 845         return error;
 846 }
 847
 848 int sysfs_rename_dir(struct kobject *kobj, const char *new_name)
 849 {
 850         struct sysfs_dirent *parent_sd = kobj->sd->s_parent;
 851         const void *new_ns = NULL;
 852
 853         if (sysfs_ns_type(parent_sd))
 854                 new_ns = kobj->ktype->namespace(kobj);
 855
 856         return sysfs_rename(kobj->sd, parent_sd, new_ns, new_name);
 857 }
 858
 859 int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj)
 860 {
 861         struct sysfs_dirent *sd = kobj->sd;
 862         struct sysfs_dirent *new_parent_sd;
 863         const void *new_ns = NULL;
 864
 865         BUG_ON(!sd->s_parent);
 866         if (sysfs_ns_type(sd->s_parent))
 867                 new_ns = kobj->ktype->namespace(kobj);
 868         new_parent_sd = new_parent_kobj && new_parent_kobj->sd ?
 869                 new_parent_kobj->sd : &sysfs_root;
 870
 871         return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name);
 872 }
 873
 874 /* Relationship between s_mode and the DT_xxx types */
 875 static inline unsigned char dt_type(struct sysfs_dirent *sd)
 876 {
 877         return (sd->s_mode >> 12) & 15;
 878 }
 879
 880 static int sysfs_dir_release(struct inode *inode, struct file *filp)
 881 {
 882         sysfs_put(filp->private_data);
 883         return 0;
 884 }
 885
 886 static struct sysfs_dirent *sysfs_dir_pos(const void *ns,
 887         struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos)
 888 {
 889         if (pos) {
 890                 int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) &&
 891                         pos->s_parent == parent_sd &&
 892                         ino == pos->s_ino;
 893                 sysfs_put(pos);
 894                 if (!valid)
 895                         pos = NULL;
 896         }
 897         if (!pos && (ino > 1) && (ino < INT_MAX)) {
 898                 pos = parent_sd->s_dir.children;
 899                 while (pos && (ino > pos->s_ino))
 900                         pos = pos->s_sibling;
 901         }
 902         while (pos && pos->s_ns != ns)
 903                 pos = pos->s_sibling;
 904         return pos;
 905 }
 906
 907 static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns,
 908         struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos)
 909 {
 910         pos = sysfs_dir_pos(ns, parent_sd, ino, pos);
 911         if (pos)
 912                 pos = pos->s_sibling;
 913         while (pos && pos->s_ns != ns)
 914                 pos = pos->s_sibling;
 915         return pos;
 916 }
 917
 918 static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir)
 919 {
 920         struct dentry *dentry = filp->f_path.dentry;
 921         struct sysfs_dirent * parent_sd = dentry->d_fsdata;
 922         struct sysfs_dirent *pos = filp->private_data;
 923         enum kobj_ns_type type;
 924         const void *ns;
 925         ino_t ino;
 926
 927         type = sysfs_ns_type(parent_sd);
 928         ns = sysfs_info(dentry->d_sb)->ns[type];
 929
 930         if (filp->f_pos == 0) {
 931                 ino = parent_sd->s_ino;
 932                 if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0)
 933                         filp->f_pos++;
 934         }
 935         if (filp->f_pos == 1) {
 936                 if (parent_sd->s_parent)
 937                         ino = parent_sd->s_parent->s_ino;
 938                 else
 939                         ino = parent_sd->s_ino;
 940                 if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0)
 941                         filp->f_pos++;
 942         }
 943         mutex_lock(&sysfs_mutex);
 944         for (pos = sysfs_dir_pos(ns, parent_sd, filp->f_pos, pos);
 945              pos;
 946              pos = sysfs_dir_next_pos(ns, parent_sd, filp->f_pos, pos)) {
 947                 const char * name;
 948                 unsigned int type;
 949                 int len, ret;
 950
 951                 name = pos->s_name;
 952                 len = strlen(name);
 953                 ino = pos->s_ino;
 954                 type = dt_type(pos);
 955                 filp->f_pos = ino;
 956                 filp->private_data = sysfs_get(pos);
 957
 958                 mutex_unlock(&sysfs_mutex);
 959                 ret = filldir(dirent, name, len, filp->f_pos, ino, type);
 960                 mutex_lock(&sysfs_mutex);
 961                 if (ret < 0)
 962                         break;
 963         }
 964         mutex_unlock(&sysfs_mutex);
 965         if ((filp->f_pos > 1) && !pos) { /* EOF */
 966                 filp->f_pos = INT_MAX;
 967                 filp->private_data = NULL;
 968         }
 969         return 0;
 970 }
 971
 972
 973 const struct file_operations sysfs_dir_operations = {
 974         .read           = generic_read_dir,
 975         .readdir        = sysfs_readdir,
 976         .release        = sysfs_dir_release,
 977         .llseek         = generic_file_llseek,
 978 };