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