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