fs/debugfs/inode.c

   1 /*
   2  *  inode.c - part of debugfs, a tiny little debug file system
   3  *
   4  *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
   5  *  Copyright (C) 2004 IBM Inc.
   6  *
   7  *      This program is free software; you can redistribute it and/or
   8  *      modify it under the terms of the GNU General Public License version
   9  *      2 as published by the Free Software Foundation.
  10  *
  11  *  debugfs is for people to use instead of /proc or /sys.
  12  *  See ./Documentation/core-api/kernel-api.rst for more details.
  13  *
  14  */
  15
  16 #include <linux/module.h>
  17 #include <linux/fs.h>
  18 #include <linux/mount.h>
  19 #include <linux/pagemap.h>
  20 #include <linux/init.h>
  21 #include <linux/kobject.h>
  22 #include <linux/namei.h>
  23 #include <linux/debugfs.h>
  24 #include <linux/fsnotify.h>
  25 #include <linux/string.h>
  26 #include <linux/seq_file.h>
  27 #include <linux/parser.h>
  28 #include <linux/magic.h>
  29 #include <linux/slab.h>
  30 #include <linux/srcu.h>
  31
  32 #include "internal.h"
  33
  34 #define DEBUGFS_DEFAULT_MODE    0700
  35
  36 DEFINE_SRCU(debugfs_srcu);
  37
  38 static struct vfsmount *debugfs_mount;
  39 static int debugfs_mount_count;
  40 static bool debugfs_registered;
  41
  42 static struct inode *debugfs_get_inode(struct super_block *sb)
  43 {
  44         struct inode *inode = new_inode(sb);
  45         if (inode) {
  46                 inode->i_ino = get_next_ino();
  47                 inode->i_atime = inode->i_mtime =
  48                         inode->i_ctime = current_time(inode);
  49         }
  50         return inode;
  51 }
  52
  53 struct debugfs_mount_opts {
  54         kuid_t uid;
  55         kgid_t gid;
  56         umode_t mode;
  57 };
  58
  59 enum {
  60         Opt_uid,
  61         Opt_gid,
  62         Opt_mode,
  63         Opt_err
  64 };
  65
  66 static const match_table_t tokens = {
  67         {Opt_uid, "uid=%u"},
  68         {Opt_gid, "gid=%u"},
  69         {Opt_mode, "mode=%o"},
  70         {Opt_err, NULL}
  71 };
  72
  73 struct debugfs_fs_info {
  74         struct debugfs_mount_opts mount_opts;
  75 };
  76
  77 static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
  78 {
  79         substring_t args[MAX_OPT_ARGS];
  80         int option;
  81         int token;
  82         kuid_t uid;
  83         kgid_t gid;
  84         char *p;
  85
  86         opts->mode = DEBUGFS_DEFAULT_MODE;
  87
  88         while ((p = strsep(&data, ",")) != NULL) {
  89                 if (!*p)
  90                         continue;
  91
  92                 token = match_token(p, tokens, args);
  93                 switch (token) {
  94                 case Opt_uid:
  95                         if (match_int(&args[0], &option))
  96                                 return -EINVAL;
  97                         uid = make_kuid(current_user_ns(), option);
  98                         if (!uid_valid(uid))
  99                                 return -EINVAL;
 100                         opts->uid = uid;
 101                         break;
 102                 case Opt_gid:
 103                         if (match_int(&args[0], &option))
 104                                 return -EINVAL;
 105                         gid = make_kgid(current_user_ns(), option);
 106                         if (!gid_valid(gid))
 107                                 return -EINVAL;
 108                         opts->gid = gid;
 109                         break;
 110                 case Opt_mode:
 111                         if (match_octal(&args[0], &option))
 112                                 return -EINVAL;
 113                         opts->mode = option & S_IALLUGO;
 114                         break;
 115                 /*
 116                  * We might like to report bad mount options here;
 117                  * but traditionally debugfs has ignored all mount options
 118                  */
 119                 }
 120         }
 121
 122         return 0;
 123 }
 124
 125 static int debugfs_apply_options(struct super_block *sb)
 126 {
 127         struct debugfs_fs_info *fsi = sb->s_fs_info;
 128         struct inode *inode = d_inode(sb->s_root);
 129         struct debugfs_mount_opts *opts = &fsi->mount_opts;
 130
 131         inode->i_mode &= ~S_IALLUGO;
 132         inode->i_mode |= opts->mode;
 133
 134         inode->i_uid = opts->uid;
 135         inode->i_gid = opts->gid;
 136
 137         return 0;
 138 }
 139
 140 static int debugfs_remount(struct super_block *sb, int *flags, char *data)
 141 {
 142         int err;
 143         struct debugfs_fs_info *fsi = sb->s_fs_info;
 144
 145         sync_filesystem(sb);
 146         err = debugfs_parse_options(data, &fsi->mount_opts);
 147         if (err)
 148                 goto fail;
 149
 150         debugfs_apply_options(sb);
 151
 152 fail:
 153         return err;
 154 }
 155
 156 static int debugfs_show_options(struct seq_file *m, struct dentry *root)
 157 {
 158         struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
 159         struct debugfs_mount_opts *opts = &fsi->mount_opts;
 160
 161         if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
 162                 seq_printf(m, ",uid=%u",
 163                            from_kuid_munged(&init_user_ns, opts->uid));
 164         if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
 165                 seq_printf(m, ",gid=%u",
 166                            from_kgid_munged(&init_user_ns, opts->gid));
 167         if (opts->mode != DEBUGFS_DEFAULT_MODE)
 168                 seq_printf(m, ",mode=%o", opts->mode);
 169
 170         return 0;
 171 }
 172
 173 static void debugfs_i_callback(struct rcu_head *head)
 174 {
 175         struct inode *inode = container_of(head, struct inode, i_rcu);
 176         if (S_ISLNK(inode->i_mode))
 177                 kfree(inode->i_link);
 178         free_inode_nonrcu(inode);
 179 }
 180
 181 static void debugfs_destroy_inode(struct inode *inode)
 182 {
 183         call_rcu(&inode->i_rcu, debugfs_i_callback);
 184 }
 185
 186 static const struct super_operations debugfs_super_operations = {
 187         .statfs         = simple_statfs,
 188         .remount_fs     = debugfs_remount,
 189         .show_options   = debugfs_show_options,
 190         .destroy_inode  = debugfs_destroy_inode,
 191 };
 192
 193 static struct vfsmount *debugfs_automount(struct path *path)
 194 {
 195         debugfs_automount_t f;
 196         f = (debugfs_automount_t)path->dentry->d_fsdata;
 197         return f(path->dentry, d_inode(path->dentry)->i_private);
 198 }
 199
 200 static const struct dentry_operations debugfs_dops = {
 201         .d_delete = always_delete_dentry,
 202         .d_automount = debugfs_automount,
 203 };
 204
 205 static int debug_fill_super(struct super_block *sb, void *data, int silent)
 206 {
 207         static const struct tree_descr debug_files[] = {{""}};
 208         struct debugfs_fs_info *fsi;
 209         int err;
 210
 211         fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
 212         sb->s_fs_info = fsi;
 213         if (!fsi) {
 214                 err = -ENOMEM;
 215                 goto fail;
 216         }
 217
 218         err = debugfs_parse_options(data, &fsi->mount_opts);
 219         if (err)
 220                 goto fail;
 221
 222         err  =  simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
 223         if (err)
 224                 goto fail;
 225
 226         sb->s_op = &debugfs_super_operations;
 227         sb->s_d_op = &debugfs_dops;
 228
 229         debugfs_apply_options(sb);
 230
 231         return 0;
 232
 233 fail:
 234         kfree(fsi);
 235         sb->s_fs_info = NULL;
 236         return err;
 237 }
 238
 239 static struct dentry *debug_mount(struct file_system_type *fs_type,
 240                         int flags, const char *dev_name,
 241                         void *data)
 242 {
 243         return mount_single(fs_type, flags, data, debug_fill_super);
 244 }
 245
 246 static struct file_system_type debug_fs_type = {
 247         .owner =        THIS_MODULE,
 248         .name =         "debugfs",
 249         .mount =        debug_mount,
 250         .kill_sb =      kill_litter_super,
 251 };
 252 MODULE_ALIAS_FS("debugfs");
 253
 254 /**
 255  * debugfs_lookup() - look up an existing debugfs file
 256  * @name: a pointer to a string containing the name of the file to look up.
 257  * @parent: a pointer to the parent dentry of the file.
 258  *
 259  * This function will return a pointer to a dentry if it succeeds.  If the file
 260  * doesn't exist or an error occurs, %NULL will be returned.  The returned
 261  * dentry must be passed to dput() when it is no longer needed.
 262  *
 263  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 264  * returned.
 265  */
 266 struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
 267 {
 268         struct dentry *dentry;
 269
 270         if (IS_ERR(parent))
 271                 return NULL;
 272
 273         if (!parent)
 274                 parent = debugfs_mount->mnt_root;
 275
 276         inode_lock(d_inode(parent));
 277         dentry = lookup_one_len(name, parent, strlen(name));
 278         inode_unlock(d_inode(parent));
 279
 280         if (IS_ERR(dentry))
 281                 return NULL;
 282         if (!d_really_is_positive(dentry)) {
 283                 dput(dentry);
 284                 return NULL;
 285         }
 286         return dentry;
 287 }
 288 EXPORT_SYMBOL_GPL(debugfs_lookup);
 289
 290 static struct dentry *start_creating(const char *name, struct dentry *parent)
 291 {
 292         struct dentry *dentry;
 293         int error;
 294
 295         pr_debug("debugfs: creating file '%s'\n",name);
 296
 297         if (IS_ERR(parent))
 298                 return parent;
 299
 300         error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
 301                               &debugfs_mount_count);
 302         if (error)
 303                 return ERR_PTR(error);
 304
 305         /* If the parent is not specified, we create it in the root.
 306          * We need the root dentry to do this, which is in the super
 307          * block. A pointer to that is in the struct vfsmount that we
 308          * have around.
 309          */
 310         if (!parent)
 311                 parent = debugfs_mount->mnt_root;
 312
 313         inode_lock(d_inode(parent));
 314         dentry = lookup_one_len(name, parent, strlen(name));
 315         if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
 316                 dput(dentry);
 317                 dentry = ERR_PTR(-EEXIST);
 318         }
 319
 320         if (IS_ERR(dentry)) {
 321                 inode_unlock(d_inode(parent));
 322                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 323         }
 324
 325         return dentry;
 326 }
 327
 328 static struct dentry *failed_creating(struct dentry *dentry)
 329 {
 330         inode_unlock(d_inode(dentry->d_parent));
 331         dput(dentry);
 332         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 333         return NULL;
 334 }
 335
 336 static struct dentry *end_creating(struct dentry *dentry)
 337 {
 338         inode_unlock(d_inode(dentry->d_parent));
 339         return dentry;
 340 }
 341
 342 static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
 343                                 struct dentry *parent, void *data,
 344                                 const struct file_operations *proxy_fops,
 345                                 const struct file_operations *real_fops)
 346 {
 347         struct dentry *dentry;
 348         struct inode *inode;
 349
 350         if (!(mode & S_IFMT))
 351                 mode |= S_IFREG;
 352         BUG_ON(!S_ISREG(mode));
 353         dentry = start_creating(name, parent);
 354
 355         if (IS_ERR(dentry))
 356                 return NULL;
 357
 358         inode = debugfs_get_inode(dentry->d_sb);
 359         if (unlikely(!inode))
 360                 return failed_creating(dentry);
 361
 362         inode->i_mode = mode;
 363         inode->i_private = data;
 364
 365         inode->i_fop = proxy_fops;
 366         dentry->d_fsdata = (void *)real_fops;
 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 int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
 624 {
 625         int ret = 0;
 626
 627         if (simple_positive(dentry)) {
 628                 dget(dentry);
 629                 if (d_is_dir(dentry))
 630                         ret = simple_rmdir(d_inode(parent), dentry);
 631                 else
 632                         simple_unlink(d_inode(parent), dentry);
 633                 if (!ret)
 634                         d_delete(dentry);
 635                 dput(dentry);
 636         }
 637         return ret;
 638 }
 639
 640 /**
 641  * debugfs_remove - removes a file or directory from the debugfs filesystem
 642  * @dentry: a pointer to a the dentry of the file or directory to be
 643  *          removed.  If this parameter is NULL or an error value, nothing
 644  *          will be done.
 645  *
 646  * This function removes a file or directory in debugfs that was previously
 647  * created with a call to another debugfs function (like
 648  * debugfs_create_file() or variants thereof.)
 649  *
 650  * This function is required to be called in order for the file to be
 651  * removed, no automatic cleanup of files will happen when a module is
 652  * removed, you are responsible here.
 653  */
 654 void debugfs_remove(struct dentry *dentry)
 655 {
 656         struct dentry *parent;
 657         int ret;
 658
 659         if (IS_ERR_OR_NULL(dentry))
 660                 return;
 661
 662         parent = dentry->d_parent;
 663         inode_lock(d_inode(parent));
 664         ret = __debugfs_remove(dentry, parent);
 665         inode_unlock(d_inode(parent));
 666         if (!ret)
 667                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 668
 669         synchronize_srcu(&debugfs_srcu);
 670 }
 671 EXPORT_SYMBOL_GPL(debugfs_remove);
 672
 673 /**
 674  * debugfs_remove_recursive - recursively removes a directory
 675  * @dentry: a pointer to a the dentry of the directory to be removed.  If this
 676  *          parameter is NULL or an error value, nothing will be done.
 677  *
 678  * This function recursively removes a directory tree in debugfs that
 679  * was previously created with a call to another debugfs function
 680  * (like debugfs_create_file() or variants thereof.)
 681  *
 682  * This function is required to be called in order for the file to be
 683  * removed, no automatic cleanup of files will happen when a module is
 684  * removed, you are responsible here.
 685  */
 686 void debugfs_remove_recursive(struct dentry *dentry)
 687 {
 688         struct dentry *child, *parent;
 689
 690         if (IS_ERR_OR_NULL(dentry))
 691                 return;
 692
 693         parent = dentry;
 694  down:
 695         inode_lock(d_inode(parent));
 696  loop:
 697         /*
 698          * The parent->d_subdirs is protected by the d_lock. Outside that
 699          * lock, the child can be unlinked and set to be freed which can
 700          * use the d_u.d_child as the rcu head and corrupt this list.
 701          */
 702         spin_lock(&parent->d_lock);
 703         list_for_each_entry(child, &parent->d_subdirs, d_child) {
 704                 if (!simple_positive(child))
 705                         continue;
 706
 707                 /* perhaps simple_empty(child) makes more sense */
 708                 if (!list_empty(&child->d_subdirs)) {
 709                         spin_unlock(&parent->d_lock);
 710                         inode_unlock(d_inode(parent));
 711                         parent = child;
 712                         goto down;
 713                 }
 714
 715                 spin_unlock(&parent->d_lock);
 716
 717                 if (!__debugfs_remove(child, parent))
 718                         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 719
 720                 /*
 721                  * The parent->d_lock protects agaist child from unlinking
 722                  * from d_subdirs. When releasing the parent->d_lock we can
 723                  * no longer trust that the next pointer is valid.
 724                  * Restart the loop. We'll skip this one with the
 725                  * simple_positive() check.
 726                  */
 727                 goto loop;
 728         }
 729         spin_unlock(&parent->d_lock);
 730
 731         inode_unlock(d_inode(parent));
 732         child = parent;
 733         parent = parent->d_parent;
 734         inode_lock(d_inode(parent));
 735
 736         if (child != dentry)
 737                 /* go up */
 738                 goto loop;
 739
 740         if (!__debugfs_remove(child, parent))
 741                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
 742         inode_unlock(d_inode(parent));
 743
 744         synchronize_srcu(&debugfs_srcu);
 745 }
 746 EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
 747
 748 /**
 749  * debugfs_rename - rename a file/directory in the debugfs filesystem
 750  * @old_dir: a pointer to the parent dentry for the renamed object. This
 751  *          should be a directory dentry.
 752  * @old_dentry: dentry of an object to be renamed.
 753  * @new_dir: a pointer to the parent dentry where the object should be
 754  *          moved. This should be a directory dentry.
 755  * @new_name: a pointer to a string containing the target name.
 756  *
 757  * This function renames a file/directory in debugfs.  The target must not
 758  * exist for rename to succeed.
 759  *
 760  * This function will return a pointer to old_dentry (which is updated to
 761  * reflect renaming) if it succeeds. If an error occurs, %NULL will be
 762  * returned.
 763  *
 764  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
 765  * returned.
 766  */
 767 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
 768                 struct dentry *new_dir, const char *new_name)
 769 {
 770         int error;
 771         struct dentry *dentry = NULL, *trap;
 772         struct name_snapshot old_name;
 773
 774         if (IS_ERR(old_dir))
 775                 return old_dir;
 776         if (IS_ERR(new_dir))
 777                 return new_dir;
 778         if (IS_ERR_OR_NULL(old_dentry))
 779                 return old_dentry;
 780
 781         trap = lock_rename(new_dir, old_dir);
 782         /* Source or destination directories don't exist? */
 783         if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
 784                 goto exit;
 785         /* Source does not exist, cyclic rename, or mountpoint? */
 786         if (d_really_is_negative(old_dentry) || old_dentry == trap ||
 787             d_mountpoint(old_dentry))
 788                 goto exit;
 789         dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
 790         /* Lookup failed, cyclic rename or target exists? */
 791         if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
 792                 goto exit;
 793
 794         take_dentry_name_snapshot(&old_name, old_dentry);
 795
 796         error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
 797                               dentry, 0);
 798         if (error) {
 799                 release_dentry_name_snapshot(&old_name);
 800                 goto exit;
 801         }
 802         d_move(old_dentry, dentry);
 803         fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name.name,
 804                 d_is_dir(old_dentry),
 805                 NULL, old_dentry);
 806         release_dentry_name_snapshot(&old_name);
 807         unlock_rename(new_dir, old_dir);
 808         dput(dentry);
 809         return old_dentry;
 810 exit:
 811         if (dentry && !IS_ERR(dentry))
 812                 dput(dentry);
 813         unlock_rename(new_dir, old_dir);
 814         return NULL;
 815 }
 816 EXPORT_SYMBOL_GPL(debugfs_rename);
 817
 818 /**
 819  * debugfs_initialized - Tells whether debugfs has been registered
 820  */
 821 bool debugfs_initialized(void)
 822 {
 823         return debugfs_registered;
 824 }
 825 EXPORT_SYMBOL_GPL(debugfs_initialized);
 826
 827 static int __init debugfs_init(void)
 828 {
 829         int retval;
 830
 831         retval = sysfs_create_mount_point(kernel_kobj, "debug");
 832         if (retval)
 833                 return retval;
 834
 835         retval = register_filesystem(&debug_fs_type);
 836         if (retval)
 837                 sysfs_remove_mount_point(kernel_kobj, "debug");
 838         else
 839                 debugfs_registered = true;
 840
 841         return retval;
 842 }
 843 core_initcall(debugfs_init);
 844