fs/debugfs/inode.c

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