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_evict_inode(struct inode *inode)
 167 {
 168         truncate_inode_pages_final(&inode->i_data);
 169         clear_inode(inode);
 170         if (S_ISLNK(inode->i_mode))
 171                 kfree(inode->i_link);
 172 }
 173
 174 static const struct super_operations debugfs_super_operations = {
 175         .statfs         = simple_statfs,
 176         .remount_fs     = debugfs_remount,
 177         .show_options   = debugfs_show_options,
 178         .evict_inode    = debugfs_evict_inode,
 179 };
 180
 181 static void debugfs_release_dentry(struct dentry *dentry)
 182 {
 183         void *fsd = dentry->d_fsdata;
 184
 185         if (!((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT))
 186                 kfree(dentry->d_fsdata);
 187 }
 188
 189 static struct vfsmount *debugfs_automount(struct path *path)
 190 {
 191         debugfs_automount_t f;
 192         f = (debugfs_automount_t)path->dentry->d_fsdata;
 193         return f(path->dentry, d_inode(path->dentry)->i_private);
 194 }
 195
 196 static const struct dentry_operations debugfs_dops = {
 197         .d_delete = always_delete_dentry,
 198         .d_release = debugfs_release_dentry,
 199         .d_automount = debugfs_automount,
 200 };
 201
 202 static int debug_fill_super(struct super_block *sb, void *data, int silent)
 203 {
 204         static const struct tree_descr debug_files[] = {{""}};
 205         struct debugfs_fs_info *fsi;
 206         int err;
 207
 208         fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
 209         sb->s_fs_info = fsi;
 210         if (!fsi) {
 211                 err = -ENOMEM;
 212                 goto fail;
 213         }
 214
 215         err = debugfs_parse_options(data, &fsi->mount_opts);
 216         if (err)
 217                 goto fail;
 218
 219         err  =  simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
 220         if (err)
 221                 goto fail;
 222
 223         sb->s_op = &debugfs_super_operations;
 224         sb->s_d_op = &debugfs_dops;
 225
 226         debugfs_apply_options(sb);
 227
 228         return 0;
 229
 230 fail:
 231         kfree(fsi);
 232         sb->s_fs_info = NULL;
 233         return err;
 234 }
 235
 236 static struct dentry *debug_mount(struct file_system_type *fs_type,
 237                         int flags, const char *dev_name,
 238                         void *data)
 239 {
 240         return mount_single(fs_type, flags, data, debug_fill_super);
 241 }
 242
 243 static struct file_system_type debug_fs_type = {
 244         .owner =        THIS_MODULE,
 245         .name =         "debugfs",
 246         .mount =        debug_mount,
 247         .kill_sb =      kill_litter_super,
 248 };
 249 MODULE_ALIAS_FS("debugfs");
 250
 251 /**
 252  * debugfs_lookup() - look up an existing debugfs file
 253  * @name: a pointer to a string containing the name of the file to look up.
 254  * @parent: a pointer to the parent dentry of the file.
 255  *
 256  * This function will return a pointer to a dentry if it succeeds.  If the file
 257  * doesn't exist or an error occurs, %NULL will be returned.  The returned
 258  * dentry must be passed to dput() when it is no longer needed.
 259  *
 260  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 261  * returned.
 262  */
 263 struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
 264 {
 265         struct dentry *dentry;
 266
 267         if (IS_ERR(parent))
 268                 return NULL;
 269
 270         if (!parent)
 271                 parent = debugfs_mount->mnt_root;
 272
 273         inode_lock(d_inode(parent));
 274         dentry = lookup_one_len(name, parent, strlen(name));
 275         inode_unlock(d_inode(parent));
 276
 277         if (IS_ERR(dentry))
 278                 return NULL;
 279         if (!d_really_is_positive(dentry)) {
 280                 dput(dentry);
 281                 return NULL;
 282         }
 283         return dentry;
 284 }
 285 EXPORT_SYMBOL_GPL(debugfs_lookup);
 286
 287 static struct dentry *start_creating(const char *name, struct dentry *parent)
 288 {
 289         struct dentry *dentry;
 290         int error;
 291
 292         pr_debug("debugfs: creating file '%s'\n",name);
 293
 294         if (IS_ERR(parent))
 295                 return parent;
 296
 297         error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
 298                               &debugfs_mount_count);
 299         if (error)
 300                 return ERR_PTR(error);
 301
 302         /* If the parent is not specified, we create it in the root.
 303          * We need the root dentry to do this, which is in the super
 304          * block. A pointer to that is in the struct vfsmount that we
 305          * have around.
 306          */
 307         if (!parent)
 308                 parent = debugfs_mount->mnt_root;
 309
 310         inode_lock(d_inode(parent));
 311         dentry = lookup_one_len(name, parent, strlen(name));
 312         if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
 313                 dput(dentry);
 314                 dentry = ERR_PTR(-EEXIST);
 315         }
 316
 317         if (IS_ERR(dentry)) {
 318                 inode_unlock(d_inode(parent));
 319                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 320         }
 321
 322         return dentry;
 323 }
 324
 325 static struct dentry *failed_creating(struct dentry *dentry)
 326 {
 327         inode_unlock(d_inode(dentry->d_parent));
 328         dput(dentry);
 329         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 330         return NULL;
 331 }
 332
 333 static struct dentry *end_creating(struct dentry *dentry)
 334 {
 335         inode_unlock(d_inode(dentry->d_parent));
 336         return dentry;
 337 }
 338
 339 static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
 340                                 struct dentry *parent, void *data,
 341                                 const struct file_operations *proxy_fops,
 342                                 const struct file_operations *real_fops)
 343 {
 344         struct dentry *dentry;
 345         struct inode *inode;
 346
 347         if (!(mode & S_IFMT))
 348                 mode |= S_IFREG;
 349         BUG_ON(!S_ISREG(mode));
 350         dentry = start_creating(name, parent);
 351
 352         if (IS_ERR(dentry))
 353                 return NULL;
 354
 355         inode = debugfs_get_inode(dentry->d_sb);
 356         if (unlikely(!inode))
 357                 return failed_creating(dentry);
 358
 359         inode->i_mode = mode;
 360         inode->i_private = data;
 361
 362         inode->i_fop = proxy_fops;
 363         dentry->d_fsdata = (void *)((unsigned long)real_fops |
 364                                 DEBUGFS_FSDATA_IS_REAL_FOPS_BIT);
 365
 366         d_instantiate(dentry, inode);
 367         fsnotify_create(d_inode(dentry->d_parent), dentry);
 368         return end_creating(dentry);
 369 }
 370
 371 /**
 372  * debugfs_create_file - create a file in the debugfs filesystem
 373  * @name: a pointer to a string containing the name of the file to create.
 374  * @mode: the permission that the file should have.
 375  * @parent: a pointer to the parent dentry for this file.  This should be a
 376  *          directory dentry if set.  If this parameter is NULL, then the
 377  *          file will be created in the root of the debugfs filesystem.
 378  * @data: a pointer to something that the caller will want to get to later
 379  *        on.  The inode.i_private pointer will point to this value on
 380  *        the open() call.
 381  * @fops: a pointer to a struct file_operations that should be used for
 382  *        this file.
 383  *
 384  * This is the basic "create a file" function for debugfs.  It allows for a
 385  * wide range of flexibility in creating a file, or a directory (if you want
 386  * to create a directory, the debugfs_create_dir() function is
 387  * recommended to be used instead.)
 388  *
 389  * This function will return a pointer to a dentry if it succeeds.  This
 390  * pointer must be passed to the debugfs_remove() function when the file is
 391  * to be removed (no automatic cleanup happens if your module is unloaded,
 392  * you are responsible here.)  If an error occurs, %NULL will be returned.
 393  *
 394  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 395  * returned.
 396  */
 397 struct dentry *debugfs_create_file(const char *name, umode_t mode,
 398                                    struct dentry *parent, void *data,
 399                                    const struct file_operations *fops)
 400 {
 401
 402         return __debugfs_create_file(name, mode, parent, data,
 403                                 fops ? &debugfs_full_proxy_file_operations :
 404                                         &debugfs_noop_file_operations,
 405                                 fops);
 406 }
 407 EXPORT_SYMBOL_GPL(debugfs_create_file);
 408
 409 /**
 410  * debugfs_create_file_unsafe - create a file in the debugfs filesystem
 411  * @name: a pointer to a string containing the name of the file to create.
 412  * @mode: the permission that the file should have.
 413  * @parent: a pointer to the parent dentry for this file.  This should be a
 414  *          directory dentry if set.  If this parameter is NULL, then the
 415  *          file will be created in the root of the debugfs filesystem.
 416  * @data: a pointer to something that the caller will want to get to later
 417  *        on.  The inode.i_private pointer will point to this value on
 418  *        the open() call.
 419  * @fops: a pointer to a struct file_operations that should be used for
 420  *        this file.
 421  *
 422  * debugfs_create_file_unsafe() is completely analogous to
 423  * debugfs_create_file(), the only difference being that the fops
 424  * handed it will not get protected against file removals by the
 425  * debugfs core.
 426  *
 427  * It is your responsibility to protect your struct file_operation
 428  * methods against file removals by means of debugfs_use_file_start()
 429  * and debugfs_use_file_finish(). ->open() is still protected by
 430  * debugfs though.
 431  *
 432  * Any struct file_operations defined by means of
 433  * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
 434  * thus, may be used here.
 435  */
 436 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
 437                                    struct dentry *parent, void *data,
 438                                    const struct file_operations *fops)
 439 {
 440
 441         return __debugfs_create_file(name, mode, parent, data,
 442                                 fops ? &debugfs_open_proxy_file_operations :
 443                                         &debugfs_noop_file_operations,
 444                                 fops);
 445 }
 446 EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
 447
 448 /**
 449  * debugfs_create_file_size - create a file in the debugfs filesystem
 450  * @name: a pointer to a string containing the name of the file to create.
 451  * @mode: the permission that the file should have.
 452  * @parent: a pointer to the parent dentry for this file.  This should be a
 453  *          directory dentry if set.  If this parameter is NULL, then the
 454  *          file will be created in the root of the debugfs filesystem.
 455  * @data: a pointer to something that the caller will want to get to later
 456  *        on.  The inode.i_private pointer will point to this value on
 457  *        the open() call.
 458  * @fops: a pointer to a struct file_operations that should be used for
 459  *        this file.
 460  * @file_size: initial file size
 461  *
 462  * This is the basic "create a file" function for debugfs.  It allows for a
 463  * wide range of flexibility in creating a file, or a directory (if you want
 464  * to create a directory, the debugfs_create_dir() function is
 465  * recommended to be used instead.)
 466  *
 467  * This function will return a pointer to a dentry if it succeeds.  This
 468  * pointer must be passed to the debugfs_remove() function when the file is
 469  * to be removed (no automatic cleanup happens if your module is unloaded,
 470  * you are responsible here.)  If an error occurs, %NULL will be returned.
 471  *
 472  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 473  * returned.
 474  */
 475 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
 476                                         struct dentry *parent, void *data,
 477                                         const struct file_operations *fops,
 478                                         loff_t file_size)
 479 {
 480         struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
 481
 482         if (de)
 483                 d_inode(de)->i_size = file_size;
 484         return de;
 485 }
 486 EXPORT_SYMBOL_GPL(debugfs_create_file_size);
 487
 488 /**
 489  * debugfs_create_dir - create a directory in the debugfs filesystem
 490  * @name: a pointer to a string containing the name of the directory to
 491  *        create.
 492  * @parent: a pointer to the parent dentry for this file.  This should be a
 493  *          directory dentry if set.  If this parameter is NULL, then the
 494  *          directory will be created in the root of the debugfs filesystem.
 495  *
 496  * This function creates a directory in debugfs with the given name.
 497  *
 498  * This function will return a pointer to a dentry if it succeeds.  This
 499  * pointer must be passed to the debugfs_remove() function when the file is
 500  * to be removed (no automatic cleanup happens if your module is unloaded,
 501  * you are responsible here.)  If an error occurs, %NULL will be returned.
 502  *
 503  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 504  * returned.
 505  */
 506 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
 507 {
 508         struct dentry *dentry = start_creating(name, parent);
 509         struct inode *inode;
 510
 511         if (IS_ERR(dentry))
 512                 return NULL;
 513
 514         inode = debugfs_get_inode(dentry->d_sb);
 515         if (unlikely(!inode))
 516                 return failed_creating(dentry);
 517
 518         inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
 519         inode->i_op = &simple_dir_inode_operations;
 520         inode->i_fop = &simple_dir_operations;
 521
 522         /* directory inodes start off with i_nlink == 2 (for "." entry) */
 523         inc_nlink(inode);
 524         d_instantiate(dentry, inode);
 525         inc_nlink(d_inode(dentry->d_parent));
 526         fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
 527         return end_creating(dentry);
 528 }
 529 EXPORT_SYMBOL_GPL(debugfs_create_dir);
 530
 531 /**
 532  * debugfs_create_automount - create automount point in the debugfs filesystem
 533  * @name: a pointer to a string containing the name of the file to create.
 534  * @parent: a pointer to the parent dentry for this file.  This should be a
 535  *          directory dentry if set.  If this parameter is NULL, then the
 536  *          file will be created in the root of the debugfs filesystem.
 537  * @f: function to be called when pathname resolution steps on that one.
 538  * @data: opaque argument to pass to f().
 539  *
 540  * @f should return what ->d_automount() would.
 541  */
 542 struct dentry *debugfs_create_automount(const char *name,
 543                                         struct dentry *parent,
 544                                         debugfs_automount_t f,
 545                                         void *data)
 546 {
 547         struct dentry *dentry = start_creating(name, parent);
 548         struct inode *inode;
 549
 550         if (IS_ERR(dentry))
 551                 return NULL;
 552
 553         inode = debugfs_get_inode(dentry->d_sb);
 554         if (unlikely(!inode))
 555                 return failed_creating(dentry);
 556
 557         make_empty_dir_inode(inode);
 558         inode->i_flags |= S_AUTOMOUNT;
 559         inode->i_private = data;
 560         dentry->d_fsdata = (void *)f;
 561         /* directory inodes start off with i_nlink == 2 (for "." entry) */
 562         inc_nlink(inode);
 563         d_instantiate(dentry, inode);
 564         inc_nlink(d_inode(dentry->d_parent));
 565         fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
 566         return end_creating(dentry);
 567 }
 568 EXPORT_SYMBOL(debugfs_create_automount);
 569
 570 /**
 571  * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
 572  * @name: a pointer to a string containing the name of the symbolic link to
 573  *        create.
 574  * @parent: a pointer to the parent dentry for this symbolic link.  This
 575  *          should be a directory dentry if set.  If this parameter is NULL,
 576  *          then the symbolic link will be created in the root of the debugfs
 577  *          filesystem.
 578  * @target: a pointer to a string containing the path to the target of the
 579  *          symbolic link.
 580  *
 581  * This function creates a symbolic link with the given name in debugfs that
 582  * links to the given target path.
 583  *
 584  * This function will return a pointer to a dentry if it succeeds.  This
 585  * pointer must be passed to the debugfs_remove() function when the symbolic
 586  * link is to be removed (no automatic cleanup happens if your module is
 587  * unloaded, you are responsible here.)  If an error occurs, %NULL will be
 588  * returned.
 589  *
 590  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 591  * returned.
 592  */
 593 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
 594                                       const char *target)
 595 {
 596         struct dentry *dentry;
 597         struct inode *inode;
 598         char *link = kstrdup(target, GFP_KERNEL);
 599         if (!link)
 600                 return NULL;
 601
 602         dentry = start_creating(name, parent);
 603         if (IS_ERR(dentry)) {
 604                 kfree(link);
 605                 return NULL;
 606         }
 607
 608         inode = debugfs_get_inode(dentry->d_sb);
 609         if (unlikely(!inode)) {
 610                 kfree(link);
 611                 return failed_creating(dentry);
 612         }
 613         inode->i_mode = S_IFLNK | S_IRWXUGO;
 614         inode->i_op = &simple_symlink_inode_operations;
 615         inode->i_link = link;
 616         d_instantiate(dentry, inode);
 617         return end_creating(dentry);
 618 }
 619 EXPORT_SYMBOL_GPL(debugfs_create_symlink);
 620
 621 static void __debugfs_remove_file(struct dentry *dentry, struct dentry *parent)
 622 {
 623         struct debugfs_fsdata *fsd;
 624
 625         simple_unlink(d_inode(parent), dentry);
 626         d_delete(dentry);
 627
 628         /*
 629          * Paired with the closing smp_mb() implied by a successful
 630          * cmpxchg() in debugfs_file_get(): either
 631          * debugfs_file_get() must see a dead dentry or we must see a
 632          * debugfs_fsdata instance at ->d_fsdata here (or both).
 633          */
 634         smp_mb();
 635         fsd = READ_ONCE(dentry->d_fsdata);
 636         if ((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT)
 637                 return;
 638         if (!refcount_dec_and_test(&fsd->active_users))
 639                 wait_for_completion(&fsd->active_users_drained);
 640 }
 641
 642 static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
 643 {
 644         int ret = 0;
 645
 646         if (simple_positive(dentry)) {
 647                 dget(dentry);
 648                 if (!d_is_reg(dentry)) {
 649                         if (d_is_dir(dentry))
 650                                 ret = simple_rmdir(d_inode(parent), dentry);
 651                         else
 652                                 simple_unlink(d_inode(parent), dentry);
 653                         if (!ret)
 654                                 d_delete(dentry);
 655                 } else {
 656                         __debugfs_remove_file(dentry, parent);
 657                 }
 658                 dput(dentry);
 659         }
 660         return ret;
 661 }
 662
 663 /**
 664  * debugfs_remove - removes a file or directory from the debugfs filesystem
 665  * @dentry: a pointer to a the dentry of the file or directory to be
 666  *          removed.  If this parameter is NULL or an error value, nothing
 667  *          will be done.
 668  *
 669  * This function removes a file or directory in debugfs that was previously
 670  * created with a call to another debugfs function (like
 671  * debugfs_create_file() or variants thereof.)
 672  *
 673  * This function is required to be called in order for the file to be
 674  * removed, no automatic cleanup of files will happen when a module is
 675  * removed, you are responsible here.
 676  */
 677 void debugfs_remove(struct dentry *dentry)
 678 {
 679         struct dentry *parent;
 680         int ret;
 681
 682         if (IS_ERR_OR_NULL(dentry))
 683                 return;
 684
 685         parent = dentry->d_parent;
 686         inode_lock(d_inode(parent));
 687         ret = __debugfs_remove(dentry, parent);
 688         inode_unlock(d_inode(parent));
 689         if (!ret)
 690                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 691 }
 692 EXPORT_SYMBOL_GPL(debugfs_remove);
 693
 694 /**
 695  * debugfs_remove_recursive - recursively removes a directory
 696  * @dentry: a pointer to a the dentry of the directory to be removed.  If this
 697  *          parameter is NULL or an error value, nothing will be done.
 698  *
 699  * This function recursively removes a directory tree in debugfs that
 700  * was previously created with a call to another debugfs function
 701  * (like debugfs_create_file() or variants thereof.)
 702  *
 703  * This function is required to be called in order for the file to be
 704  * removed, no automatic cleanup of files will happen when a module is
 705  * removed, you are responsible here.
 706  */
 707 void debugfs_remove_recursive(struct dentry *dentry)
 708 {
 709         struct dentry *child, *parent;
 710
 711         if (IS_ERR_OR_NULL(dentry))
 712                 return;
 713
 714         parent = dentry;
 715  down:
 716         inode_lock(d_inode(parent));
 717  loop:
 718         /*
 719          * The parent->d_subdirs is protected by the d_lock. Outside that
 720          * lock, the child can be unlinked and set to be freed which can
 721          * use the d_u.d_child as the rcu head and corrupt this list.
 722          */
 723         spin_lock(&parent->d_lock);
 724         list_for_each_entry(child, &parent->d_subdirs, d_child) {
 725                 if (!simple_positive(child))
 726                         continue;
 727
 728                 /* perhaps simple_empty(child) makes more sense */
 729                 if (!list_empty(&child->d_subdirs)) {
 730                         spin_unlock(&parent->d_lock);
 731                         inode_unlock(d_inode(parent));
 732                         parent = child;
 733                         goto down;
 734                 }
 735
 736                 spin_unlock(&parent->d_lock);
 737
 738                 if (!__debugfs_remove(child, parent))
 739                         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 740
 741                 /*
 742                  * The parent->d_lock protects agaist child from unlinking
 743                  * from d_subdirs. When releasing the parent->d_lock we can
 744                  * no longer trust that the next pointer is valid.
 745                  * Restart the loop. We'll skip this one with the
 746                  * simple_positive() check.
 747                  */
 748                 goto loop;
 749         }
 750         spin_unlock(&parent->d_lock);
 751
 752         inode_unlock(d_inode(parent));
 753         child = parent;
 754         parent = parent->d_parent;
 755         inode_lock(d_inode(parent));
 756
 757         if (child != dentry)
 758                 /* go up */
 759                 goto loop;
 760
 761         if (!__debugfs_remove(child, parent))
 762                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 763         inode_unlock(d_inode(parent));
 764 }
 765 EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
 766
 767 /**
 768  * debugfs_rename - rename a file/directory in the debugfs filesystem
 769  * @old_dir: a pointer to the parent dentry for the renamed object. This
 770  *          should be a directory dentry.
 771  * @old_dentry: dentry of an object to be renamed.
 772  * @new_dir: a pointer to the parent dentry where the object should be
 773  *          moved. This should be a directory dentry.
 774  * @new_name: a pointer to a string containing the target name.
 775  *
 776  * This function renames a file/directory in debugfs.  The target must not
 777  * exist for rename to succeed.
 778  *
 779  * This function will return a pointer to old_dentry (which is updated to
 780  * reflect renaming) if it succeeds. If an error occurs, %NULL will be
 781  * returned.
 782  *
 783  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 784  * returned.
 785  */
 786 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 787                 struct dentry *new_dir, const char *new_name)
 788 {
 789         int error;
 790         struct dentry *dentry = NULL, *trap;
 791         struct name_snapshot old_name;
 792
 793         trap = lock_rename(new_dir, old_dir);
 794         /* Source or destination directories don't exist? */
 795         if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
 796                 goto exit;
 797         /* Source does not exist, cyclic rename, or mountpoint? */
 798         if (d_really_is_negative(old_dentry) || old_dentry == trap ||
 799             d_mountpoint(old_dentry))
 800                 goto exit;
 801         dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
 802         /* Lookup failed, cyclic rename or target exists? */
 803         if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
 804                 goto exit;
 805
 806         take_dentry_name_snapshot(&old_name, old_dentry);
 807
 808         error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
 809                               dentry, 0);
 810         if (error) {
 811                 release_dentry_name_snapshot(&old_name);
 812                 goto exit;
 813         }
 814         d_move(old_dentry, dentry);
 815         fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name.name,
 816                 d_is_dir(old_dentry),
 817                 NULL, old_dentry);
 818         release_dentry_name_snapshot(&old_name);
 819         unlock_rename(new_dir, old_dir);
 820         dput(dentry);
 821         return old_dentry;
 822 exit:
 823         if (dentry && !IS_ERR(dentry))
 824                 dput(dentry);
 825         unlock_rename(new_dir, old_dir);
 826         return NULL;
 827 }
 828 EXPORT_SYMBOL_GPL(debugfs_rename);
 829
 830 /**
 831  * debugfs_initialized - Tells whether debugfs has been registered
 832  */
 833 bool debugfs_initialized(void)
 834 {
 835         return debugfs_registered;
 836 }
 837 EXPORT_SYMBOL_GPL(debugfs_initialized);
 838
 839 static int __init debugfs_init(void)
 840 {
 841         int retval;
 842
 843         retval = sysfs_create_mount_point(kernel_kobj, "debug");
 844         if (retval)
 845                 return retval;
 846
 847         retval = register_filesystem(&debug_fs_type);
 848         if (retval)
 849                 sysfs_remove_mount_point(kernel_kobj, "debug");
 850         else
 851                 debugfs_registered = true;
 852
 853         return retval;
 854 }
 855 core_initcall(debugfs_init);
 856