fs/debugfs/inode.c

   1 /*
   2  *  inode.c - part of debugfs, a tiny little debug file system
   3  *
   4  *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
   5  *  Copyright (C) 2004 IBM Inc.
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License version
   9  *      2 as published by the Free Software Foundation.
  10  *
  11  *  debugfs is for people to use instead of /proc or /sys.
  12  *  See Documentation/DocBook/kernel-api for more details.
  13  *
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/fs.h>
  18 #include <linux/mount.h>
  19 #include <linux/pagemap.h>
  20 #include <linux/init.h>
  21 #include <linux/kobject.h>
  22 #include <linux/namei.h>
  23 #include <linux/debugfs.h>
  24 #include <linux/fsnotify.h>
  25 #include <linux/string.h>
  26 #include <linux/seq_file.h>
  27 #include <linux/parser.h>
  28 #include <linux/magic.h>
  29 #include <linux/slab.h>
  30 #include <linux/srcu.h>
  31
  32 #include "internal.h"
  33
  34 #define DEBUGFS_DEFAULT_MODE    0700
  35
  36 DEFINE_SRCU(debugfs_srcu);
  37
  38 static struct vfsmount *debugfs_mount;
  39 static int debugfs_mount_count;
  40 static bool debugfs_registered;
  41
  42 static struct inode *debugfs_get_inode(struct super_block *sb)
  43 {
  44         struct inode *inode = new_inode(sb);
  45         if (inode) {
  46                 inode->i_ino = get_next_ino();
  47                 inode->i_atime = inode->i_mtime =
  48                         inode->i_ctime = current_time(inode);
  49         }
  50         return inode;
  51 }
  52
  53 struct debugfs_mount_opts {
  54         kuid_t uid;
  55         kgid_t gid;
  56         umode_t mode;
  57 };
  58
  59 enum {
  60         Opt_uid,
  61         Opt_gid,
  62         Opt_mode,
  63         Opt_err
  64 };
  65
  66 static const match_table_t tokens = {
  67         {Opt_uid, "uid=%u"},
  68         {Opt_gid, "gid=%u"},
  69         {Opt_mode, "mode=%o"},
  70         {Opt_err, NULL}
  71 };
  72
  73 struct debugfs_fs_info {
  74         struct debugfs_mount_opts mount_opts;
  75 };
  76
  77 static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
  78 {
  79         substring_t args[MAX_OPT_ARGS];
  80         int option;
  81         int token;
  82         kuid_t uid;
  83         kgid_t gid;
  84         char *p;
  85
  86         opts->mode = DEBUGFS_DEFAULT_MODE;
  87
  88         while ((p = strsep(&data, ",")) != NULL) {
  89                 if (!*p)
  90                         continue;
  91
  92                 token = match_token(p, tokens, args);
  93                 switch (token) {
  94                 case Opt_uid:
  95                         if (match_int(&args[0], &option))
  96                                 return -EINVAL;
  97                         uid = make_kuid(current_user_ns(), option);
  98                         if (!uid_valid(uid))
  99                                 return -EINVAL;
 100                         opts->uid = uid;
 101                         break;
 102                 case Opt_gid:
 103                         if (match_int(&args[0], &option))
 104                                 return -EINVAL;
 105                         gid = make_kgid(current_user_ns(), option);
 106                         if (!gid_valid(gid))
 107                                 return -EINVAL;
 108                         opts->gid = gid;
 109                         break;
 110                 case Opt_mode:
 111                         if (match_octal(&args[0], &option))
 112                                 return -EINVAL;
 113                         opts->mode = option & S_IALLUGO;
 114                         break;
 115                 /*
 116                  * We might like to report bad mount options here;
 117                  * but traditionally debugfs has ignored all mount options
 118                  */
 119                 }
 120         }
 121
 122         return 0;
 123 }
 124
 125 static int debugfs_apply_options(struct super_block *sb)
 126 {
 127         struct debugfs_fs_info *fsi = sb->s_fs_info;
 128         struct inode *inode = d_inode(sb->s_root);
 129         struct debugfs_mount_opts *opts = &fsi->mount_opts;
 130
 131         inode->i_mode &= ~S_IALLUGO;
 132         inode->i_mode |= opts->mode;
 133
 134         inode->i_uid = opts->uid;
 135         inode->i_gid = opts->gid;
 136
 137         return 0;
 138 }
 139
 140 static int debugfs_remount(struct super_block *sb, int *flags, char *data)
 141 {
 142         int err;
 143         struct debugfs_fs_info *fsi = sb->s_fs_info;
 144
 145         sync_filesystem(sb);
 146         err = debugfs_parse_options(data, &fsi->mount_opts);
 147         if (err)
 148                 goto fail;
 149
 150         debugfs_apply_options(sb);
 151
 152 fail:
 153         return err;
 154 }
 155
 156 static int debugfs_show_options(struct seq_file *m, struct dentry *root)
 157 {
 158         struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
 159         struct debugfs_mount_opts *opts = &fsi->mount_opts;
 160
 161         if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
 162                 seq_printf(m, ",uid=%u",
 163                            from_kuid_munged(&init_user_ns, opts->uid));
 164         if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
 165                 seq_printf(m, ",gid=%u",
 166                            from_kgid_munged(&init_user_ns, opts->gid));
 167         if (opts->mode != DEBUGFS_DEFAULT_MODE)
 168                 seq_printf(m, ",mode=%o", opts->mode);
 169
 170         return 0;
 171 }
 172
 173 static void debugfs_i_callback(struct rcu_head *head)
 174 {
 175         struct inode *inode = container_of(head, struct inode, i_rcu);
 176         if (S_ISLNK(inode->i_mode))
 177                 kfree(inode->i_link);
 178         free_inode_nonrcu(inode);
 179 }
 180
 181 static void debugfs_destroy_inode(struct inode *inode)
 182 {
 183         call_rcu(&inode->i_rcu, debugfs_i_callback);
 184 }
 185
 186 static const struct super_operations debugfs_super_operations = {
 187         .statfs         = simple_statfs,
 188         .remount_fs     = debugfs_remount,
 189         .show_options   = debugfs_show_options,
 190         .destroy_inode  = debugfs_destroy_inode,
 191 };
 192
 193 static struct vfsmount *debugfs_automount(struct path *path)
 194 {
 195         debugfs_automount_t f;
 196         f = (debugfs_automount_t)path->dentry->d_fsdata;
 197         return f(path->dentry, d_inode(path->dentry)->i_private);
 198 }
 199
 200 static const struct dentry_operations debugfs_dops = {
 201         .d_delete = always_delete_dentry,
 202         .d_automount = debugfs_automount,
 203 };
 204
 205 static int debug_fill_super(struct super_block *sb, void *data, int silent)
 206 {
 207         static struct tree_descr debug_files[] = {{""}};
 208         struct debugfs_fs_info *fsi;
 209         int err;
 210
 211         save_mount_options(sb, data);
 212
 213         fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
 214         sb->s_fs_info = fsi;
 215         if (!fsi) {
 216                 err = -ENOMEM;
 217                 goto fail;
 218         }
 219
 220         err = debugfs_parse_options(data, &fsi->mount_opts);
 221         if (err)
 222                 goto fail;
 223
 224         err  =  simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
 225         if (err)
 226                 goto fail;
 227
 228         sb->s_op = &debugfs_super_operations;
 229         sb->s_d_op = &debugfs_dops;
 230
 231         debugfs_apply_options(sb);
 232
 233         return 0;
 234
 235 fail:
 236         kfree(fsi);
 237         sb->s_fs_info = NULL;
 238         return err;
 239 }
 240
 241 static struct dentry *debug_mount(struct file_system_type *fs_type,
 242                         int flags, const char *dev_name,
 243                         void *data)
 244 {
 245         return mount_single(fs_type, flags, data, debug_fill_super);
 246 }
 247
 248 static struct file_system_type debug_fs_type = {
 249         .owner =        THIS_MODULE,
 250         .name =         "debugfs",
 251         .mount =        debug_mount,
 252         .kill_sb =      kill_litter_super,
 253 };
 254 MODULE_ALIAS_FS("debugfs");
 255
 256 static struct dentry *start_creating(const char *name, struct dentry *parent)
 257 {
 258         struct dentry *dentry;
 259         int error;
 260
 261         pr_debug("debugfs: creating file '%s'\n",name);
 262
 263         if (IS_ERR(parent))
 264                 return parent;
 265
 266         error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
 267                               &debugfs_mount_count);
 268         if (error)
 269                 return ERR_PTR(error);
 270
 271         /* If the parent is not specified, we create it in the root.
 272          * We need the root dentry to do this, which is in the super
 273          * block. A pointer to that is in the struct vfsmount that we
 274          * have around.
 275          */
 276         if (!parent)
 277                 parent = debugfs_mount->mnt_root;
 278
 279         inode_lock(d_inode(parent));
 280         dentry = lookup_one_len(name, parent, strlen(name));
 281         if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
 282                 dput(dentry);
 283                 dentry = ERR_PTR(-EEXIST);
 284         }
 285
 286         if (IS_ERR(dentry)) {
 287                 inode_unlock(d_inode(parent));
 288                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 289         }
 290
 291         return dentry;
 292 }
 293
 294 static struct dentry *failed_creating(struct dentry *dentry)
 295 {
 296         inode_unlock(d_inode(dentry->d_parent));
 297         dput(dentry);
 298         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 299         return NULL;
 300 }
 301
 302 static struct dentry *end_creating(struct dentry *dentry)
 303 {
 304         inode_unlock(d_inode(dentry->d_parent));
 305         return dentry;
 306 }
 307
 308 static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
 309                                 struct dentry *parent, void *data,
 310                                 const struct file_operations *proxy_fops,
 311                                 const struct file_operations *real_fops)
 312 {
 313         struct dentry *dentry;
 314         struct inode *inode;
 315
 316         if (!(mode & S_IFMT))
 317                 mode |= S_IFREG;
 318         BUG_ON(!S_ISREG(mode));
 319         dentry = start_creating(name, parent);
 320
 321         if (IS_ERR(dentry))
 322                 return NULL;
 323
 324         inode = debugfs_get_inode(dentry->d_sb);
 325         if (unlikely(!inode))
 326                 return failed_creating(dentry);
 327
 328         inode->i_mode = mode;
 329         inode->i_private = data;
 330
 331         inode->i_fop = proxy_fops;
 332         dentry->d_fsdata = (void *)real_fops;
 333
 334         d_instantiate(dentry, inode);
 335         fsnotify_create(d_inode(dentry->d_parent), dentry);
 336         return end_creating(dentry);
 337 }
 338
 339 /**
 340  * debugfs_create_file - create a file in the debugfs filesystem
 341  * @name: a pointer to a string containing the name of the file to create.
 342  * @mode: the permission that the file should have.
 343  * @parent: a pointer to the parent dentry for this file.  This should be a
 344  *          directory dentry if set.  If this parameter is NULL, then the
 345  *          file will be created in the root of the debugfs filesystem.
 346  * @data: a pointer to something that the caller will want to get to later
 347  *        on.  The inode.i_private pointer will point to this value on
 348  *        the open() call.
 349  * @fops: a pointer to a struct file_operations that should be used for
 350  *        this file.
 351  *
 352  * This is the basic "create a file" function for debugfs.  It allows for a
 353  * wide range of flexibility in creating a file, or a directory (if you want
 354  * to create a directory, the debugfs_create_dir() function is
 355  * recommended to be used instead.)
 356  *
 357  * This function will return a pointer to a dentry if it succeeds.  This
 358  * pointer must be passed to the debugfs_remove() function when the file is
 359  * to be removed (no automatic cleanup happens if your module is unloaded,
 360  * you are responsible here.)  If an error occurs, %NULL will be returned.
 361  *
 362  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 363  * returned.
 364  */
 365 struct dentry *debugfs_create_file(const char *name, umode_t mode,
 366                                    struct dentry *parent, void *data,
 367                                    const struct file_operations *fops)
 368 {
 369
 370         return __debugfs_create_file(name, mode, parent, data,
 371                                 fops ? &debugfs_full_proxy_file_operations :
 372                                         &debugfs_noop_file_operations,
 373                                 fops);
 374 }
 375 EXPORT_SYMBOL_GPL(debugfs_create_file);
 376
 377 /**
 378  * debugfs_create_file_unsafe - create a file in the debugfs filesystem
 379  * @name: a pointer to a string containing the name of the file to create.
 380  * @mode: the permission that the file should have.
 381  * @parent: a pointer to the parent dentry for this file.  This should be a
 382  *          directory dentry if set.  If this parameter is NULL, then the
 383  *          file will be created in the root of the debugfs filesystem.
 384  * @data: a pointer to something that the caller will want to get to later
 385  *        on.  The inode.i_private pointer will point to this value on
 386  *        the open() call.
 387  * @fops: a pointer to a struct file_operations that should be used for
 388  *        this file.
 389  *
 390  * debugfs_create_file_unsafe() is completely analogous to
 391  * debugfs_create_file(), the only difference being that the fops
 392  * handed it will not get protected against file removals by the
 393  * debugfs core.
 394  *
 395  * It is your responsibility to protect your struct file_operation
 396  * methods against file removals by means of debugfs_use_file_start()
 397  * and debugfs_use_file_finish(). ->open() is still protected by
 398  * debugfs though.
 399  *
 400  * Any struct file_operations defined by means of
 401  * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
 402  * thus, may be used here.
 403  */
 404 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
 405                                    struct dentry *parent, void *data,
 406                                    const struct file_operations *fops)
 407 {
 408
 409         return __debugfs_create_file(name, mode, parent, data,
 410                                 fops ? &debugfs_open_proxy_file_operations :
 411                                         &debugfs_noop_file_operations,
 412                                 fops);
 413 }
 414 EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
 415
 416 /**
 417  * debugfs_create_file_size - create a file in the debugfs filesystem
 418  * @name: a pointer to a string containing the name of the file to create.
 419  * @mode: the permission that the file should have.
 420  * @parent: a pointer to the parent dentry for this file.  This should be a
 421  *          directory dentry if set.  If this parameter is NULL, then the
 422  *          file will be created in the root of the debugfs filesystem.
 423  * @data: a pointer to something that the caller will want to get to later
 424  *        on.  The inode.i_private pointer will point to this value on
 425  *        the open() call.
 426  * @fops: a pointer to a struct file_operations that should be used for
 427  *        this file.
 428  * @file_size: initial file size
 429  *
 430  * This is the basic "create a file" function for debugfs.  It allows for a
 431  * wide range of flexibility in creating a file, or a directory (if you want
 432  * to create a directory, the debugfs_create_dir() function is
 433  * recommended to be used instead.)
 434  *
 435  * This function will return a pointer to a dentry if it succeeds.  This
 436  * pointer must be passed to the debugfs_remove() function when the file is
 437  * to be removed (no automatic cleanup happens if your module is unloaded,
 438  * you are responsible here.)  If an error occurs, %NULL will be returned.
 439  *
 440  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 441  * returned.
 442  */
 443 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
 444                                         struct dentry *parent, void *data,
 445                                         const struct file_operations *fops,
 446                                         loff_t file_size)
 447 {
 448         struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
 449
 450         if (de)
 451                 d_inode(de)->i_size = file_size;
 452         return de;
 453 }
 454 EXPORT_SYMBOL_GPL(debugfs_create_file_size);
 455
 456 /**
 457  * debugfs_create_dir - create a directory in the debugfs filesystem
 458  * @name: a pointer to a string containing the name of the directory to
 459  *        create.
 460  * @parent: a pointer to the parent dentry for this file.  This should be a
 461  *          directory dentry if set.  If this parameter is NULL, then the
 462  *          directory will be created in the root of the debugfs filesystem.
 463  *
 464  * This function creates a directory in debugfs with the given name.
 465  *
 466  * This function will return a pointer to a dentry if it succeeds.  This
 467  * pointer must be passed to the debugfs_remove() function when the file is
 468  * to be removed (no automatic cleanup happens if your module is unloaded,
 469  * you are responsible here.)  If an error occurs, %NULL will be returned.
 470  *
 471  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 472  * returned.
 473  */
 474 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
 475 {
 476         struct dentry *dentry = start_creating(name, parent);
 477         struct inode *inode;
 478
 479         if (IS_ERR(dentry))
 480                 return NULL;
 481
 482         inode = debugfs_get_inode(dentry->d_sb);
 483         if (unlikely(!inode))
 484                 return failed_creating(dentry);
 485
 486         inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
 487         inode->i_op = &simple_dir_inode_operations;
 488         inode->i_fop = &simple_dir_operations;
 489
 490         /* directory inodes start off with i_nlink == 2 (for "." entry) */
 491         inc_nlink(inode);
 492         d_instantiate(dentry, inode);
 493         inc_nlink(d_inode(dentry->d_parent));
 494         fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
 495         return end_creating(dentry);
 496 }
 497 EXPORT_SYMBOL_GPL(debugfs_create_dir);
 498
 499 /**
 500  * debugfs_create_automount - create automount point in the debugfs filesystem
 501  * @name: a pointer to a string containing the name of the file to create.
 502  * @parent: a pointer to the parent dentry for this file.  This should be a
 503  *          directory dentry if set.  If this parameter is NULL, then the
 504  *          file will be created in the root of the debugfs filesystem.
 505  * @f: function to be called when pathname resolution steps on that one.
 506  * @data: opaque argument to pass to f().
 507  *
 508  * @f should return what ->d_automount() would.
 509  */
 510 struct dentry *debugfs_create_automount(const char *name,
 511                                         struct dentry *parent,
 512                                         debugfs_automount_t f,
 513                                         void *data)
 514 {
 515         struct dentry *dentry = start_creating(name, parent);
 516         struct inode *inode;
 517
 518         if (IS_ERR(dentry))
 519                 return NULL;
 520
 521         inode = debugfs_get_inode(dentry->d_sb);
 522         if (unlikely(!inode))
 523                 return failed_creating(dentry);
 524
 525         make_empty_dir_inode(inode);
 526         inode->i_flags |= S_AUTOMOUNT;
 527         inode->i_private = data;
 528         dentry->d_fsdata = (void *)f;
 529         /* directory inodes start off with i_nlink == 2 (for "." entry) */
 530         inc_nlink(inode);
 531         d_instantiate(dentry, inode);
 532         inc_nlink(d_inode(dentry->d_parent));
 533         fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
 534         return end_creating(dentry);
 535 }
 536 EXPORT_SYMBOL(debugfs_create_automount);
 537
 538 /**
 539  * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
 540  * @name: a pointer to a string containing the name of the symbolic link to
 541  *        create.
 542  * @parent: a pointer to the parent dentry for this symbolic link.  This
 543  *          should be a directory dentry if set.  If this parameter is NULL,
 544  *          then the symbolic link will be created in the root of the debugfs
 545  *          filesystem.
 546  * @target: a pointer to a string containing the path to the target of the
 547  *          symbolic link.
 548  *
 549  * This function creates a symbolic link with the given name in debugfs that
 550  * links to the given target path.
 551  *
 552  * This function will return a pointer to a dentry if it succeeds.  This
 553  * pointer must be passed to the debugfs_remove() function when the symbolic
 554  * link is to be removed (no automatic cleanup happens if your module is
 555  * unloaded, you are responsible here.)  If an error occurs, %NULL will be
 556  * returned.
 557  *
 558  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 559  * returned.
 560  */
 561 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 562                                       const char *target)
 563 {
 564         struct dentry *dentry;
 565         struct inode *inode;
 566         char *link = kstrdup(target, GFP_KERNEL);
 567         if (!link)
 568                 return NULL;
 569
 570         dentry = start_creating(name, parent);
 571         if (IS_ERR(dentry)) {
 572                 kfree(link);
 573                 return NULL;
 574         }
 575
 576         inode = debugfs_get_inode(dentry->d_sb);
 577         if (unlikely(!inode)) {
 578                 kfree(link);
 579                 return failed_creating(dentry);
 580         }
 581         inode->i_mode = S_IFLNK | S_IRWXUGO;
 582         inode->i_op = &simple_symlink_inode_operations;
 583         inode->i_link = link;
 584         d_instantiate(dentry, inode);
 585         return end_creating(dentry);
 586 }
 587 EXPORT_SYMBOL_GPL(debugfs_create_symlink);
 588
 589 static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
 590 {
 591         int ret = 0;
 592
 593         if (simple_positive(dentry)) {
 594                 dget(dentry);
 595                 if (d_is_dir(dentry))
 596                         ret = simple_rmdir(d_inode(parent), dentry);
 597                 else
 598                         simple_unlink(d_inode(parent), dentry);
 599                 if (!ret)
 600                         d_delete(dentry);
 601                 dput(dentry);
 602         }
 603         return ret;
 604 }
 605
 606 /**
 607  * debugfs_remove - removes a file or directory from the debugfs filesystem
 608  * @dentry: a pointer to a the dentry of the file or directory to be
 609  *          removed.  If this parameter is NULL or an error value, nothing
 610  *          will be done.
 611  *
 612  * This function removes a file or directory in debugfs that was previously
 613  * created with a call to another debugfs function (like
 614  * debugfs_create_file() or variants thereof.)
 615  *
 616  * This function is required to be called in order for the file to be
 617  * removed, no automatic cleanup of files will happen when a module is
 618  * removed, you are responsible here.
 619  */
 620 void debugfs_remove(struct dentry *dentry)
 621 {
 622         struct dentry *parent;
 623         int ret;
 624
 625         if (IS_ERR_OR_NULL(dentry))
 626                 return;
 627
 628         parent = dentry->d_parent;
 629         inode_lock(d_inode(parent));
 630         ret = __debugfs_remove(dentry, parent);
 631         inode_unlock(d_inode(parent));
 632         if (!ret)
 633                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 634
 635         synchronize_srcu(&debugfs_srcu);
 636 }
 637 EXPORT_SYMBOL_GPL(debugfs_remove);
 638
 639 /**
 640  * debugfs_remove_recursive - recursively removes a directory
 641  * @dentry: a pointer to a the dentry of the directory to be removed.  If this
 642  *          parameter is NULL or an error value, nothing will be done.
 643  *
 644  * This function recursively removes a directory tree in debugfs that
 645  * was previously created with a call to another debugfs function
 646  * (like debugfs_create_file() or variants thereof.)
 647  *
 648  * This function is required to be called in order for the file to be
 649  * removed, no automatic cleanup of files will happen when a module is
 650  * removed, you are responsible here.
 651  */
 652 void debugfs_remove_recursive(struct dentry *dentry)
 653 {
 654         struct dentry *child, *parent;
 655
 656         if (IS_ERR_OR_NULL(dentry))
 657                 return;
 658
 659         parent = dentry;
 660  down:
 661         inode_lock(d_inode(parent));
 662  loop:
 663         /*
 664          * The parent->d_subdirs is protected by the d_lock. Outside that
 665          * lock, the child can be unlinked and set to be freed which can
 666          * use the d_u.d_child as the rcu head and corrupt this list.
 667          */
 668         spin_lock(&parent->d_lock);
 669         list_for_each_entry(child, &parent->d_subdirs, d_child) {
 670                 if (!simple_positive(child))
 671                         continue;
 672
 673                 /* perhaps simple_empty(child) makes more sense */
 674                 if (!list_empty(&child->d_subdirs)) {
 675                         spin_unlock(&parent->d_lock);
 676                         inode_unlock(d_inode(parent));
 677                         parent = child;
 678                         goto down;
 679                 }
 680
 681                 spin_unlock(&parent->d_lock);
 682
 683                 if (!__debugfs_remove(child, parent))
 684                         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 685
 686                 /*
 687                  * The parent->d_lock protects agaist child from unlinking
 688                  * from d_subdirs. When releasing the parent->d_lock we can
 689                  * no longer trust that the next pointer is valid.
 690                  * Restart the loop. We'll skip this one with the
 691                  * simple_positive() check.
 692                  */
 693                 goto loop;
 694         }
 695         spin_unlock(&parent->d_lock);
 696
 697         inode_unlock(d_inode(parent));
 698         child = parent;
 699         parent = parent->d_parent;
 700         inode_lock(d_inode(parent));
 701
 702         if (child != dentry)
 703                 /* go up */
 704                 goto loop;
 705
 706         if (!__debugfs_remove(child, parent))
 707                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 708         inode_unlock(d_inode(parent));
 709
 710         synchronize_srcu(&debugfs_srcu);
 711 }
 712 EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
 713
 714 /**
 715  * debugfs_rename - rename a file/directory in the debugfs filesystem
 716  * @old_dir: a pointer to the parent dentry for the renamed object. This
 717  *          should be a directory dentry.
 718  * @old_dentry: dentry of an object to be renamed.
 719  * @new_dir: a pointer to the parent dentry where the object should be
 720  *          moved. This should be a directory dentry.
 721  * @new_name: a pointer to a string containing the target name.
 722  *
 723  * This function renames a file/directory in debugfs.  The target must not
 724  * exist for rename to succeed.
 725  *
 726  * This function will return a pointer to old_dentry (which is updated to
 727  * reflect renaming) if it succeeds. If an error occurs, %NULL will be
 728  * returned.
 729  *
 730  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 731  * returned.
 732  */
 733 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 734                 struct dentry *new_dir, const char *new_name)
 735 {
 736         int error;
 737         struct dentry *dentry = NULL, *trap;
 738         struct name_snapshot old_name;
 739
 740         if (IS_ERR(old_dir))
 741                 return old_dir;
 742         if (IS_ERR(new_dir))
 743                 return new_dir;
 744         if (IS_ERR_OR_NULL(old_dentry))
 745                 return old_dentry;
 746
 747         trap = lock_rename(new_dir, old_dir);
 748         /* Source or destination directories don't exist? */
 749         if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
 750                 goto exit;
 751         /* Source does not exist, cyclic rename, or mountpoint? */
 752         if (d_really_is_negative(old_dentry) || old_dentry == trap ||
 753             d_mountpoint(old_dentry))
 754                 goto exit;
 755         dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
 756         /* Lookup failed, cyclic rename or target exists? */
 757         if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
 758                 goto exit;
 759
 760         take_dentry_name_snapshot(&old_name, old_dentry);
 761
 762         error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
 763                               dentry, 0);
 764         if (error) {
 765                 release_dentry_name_snapshot(&old_name);
 766                 goto exit;
 767         }
 768         d_move(old_dentry, dentry);
 769         fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name.name,
 770                 d_is_dir(old_dentry),
 771                 NULL, old_dentry);
 772         release_dentry_name_snapshot(&old_name);
 773         unlock_rename(new_dir, old_dir);
 774         dput(dentry);
 775         return old_dentry;
 776 exit:
 777         if (dentry && !IS_ERR(dentry))
 778                 dput(dentry);
 779         unlock_rename(new_dir, old_dir);
 780         return NULL;
 781 }
 782 EXPORT_SYMBOL_GPL(debugfs_rename);
 783
 784 /**
 785  * debugfs_initialized - Tells whether debugfs has been registered
 786  */
 787 bool debugfs_initialized(void)
 788 {
 789         return debugfs_registered;
 790 }
 791 EXPORT_SYMBOL_GPL(debugfs_initialized);
 792
 793 static int __init debugfs_init(void)
 794 {
 795         int retval;
 796
 797         retval = sysfs_create_mount_point(kernel_kobj, "debug");
 798         if (retval)
 799                 return retval;
 800
 801         retval = register_filesystem(&debug_fs_type);
 802         if (retval)
 803                 sysfs_remove_mount_point(kernel_kobj, "debug");
 804         else
 805                 debugfs_registered = true;
 806
 807         return retval;
 808 }
 809 core_initcall(debugfs_init);
 810