fs/tracefs/inode.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  inode.c - part of tracefs, a pseudo file system for activating tracing
   4  *
   5  * Based on debugfs by: Greg Kroah-Hartman <greg@kroah.com>
   6  *
   7  *  Copyright (C) 2014 Red Hat Inc, author: Steven Rostedt <srostedt@redhat.com>
   8  *
   9  * tracefs is the file system that is used by the tracing infrastructure.
  10  */
  11
  12 #include <linux/module.h>
  13 #include <linux/fs.h>
  14 #include <linux/mount.h>
  15 #include <linux/kobject.h>
  16 #include <linux/namei.h>
  17 #include <linux/tracefs.h>
  18 #include <linux/fsnotify.h>
  19 #include <linux/security.h>
  20 #include <linux/seq_file.h>
  21 #include <linux/parser.h>
  22 #include <linux/magic.h>
  23 #include <linux/slab.h>
  24 #include "internal.h"
  25
  26 #define TRACEFS_DEFAULT_MODE    0700
  27 static struct kmem_cache *tracefs_inode_cachep __ro_after_init;
  28
  29 static struct vfsmount *tracefs_mount;
  30 static int tracefs_mount_count;
  31 static bool tracefs_registered;
  32
  33 static struct inode *tracefs_alloc_inode(struct super_block *sb)
  34 {
  35         struct tracefs_inode *ti;
  36
  37         ti = kmem_cache_alloc(tracefs_inode_cachep, GFP_KERNEL);
  38         if (!ti)
  39                 return NULL;
  40
  41         return &ti->vfs_inode;
  42 }
  43
  44 static void tracefs_free_inode(struct inode *inode)
  45 {
  46         kmem_cache_free(tracefs_inode_cachep, get_tracefs(inode));
  47 }
  48
  49 static ssize_t default_read_file(struct file *file, char __user *buf,
  50                                  size_t count, loff_t *ppos)
  51 {
  52         return 0;
  53 }
  54
  55 static ssize_t default_write_file(struct file *file, const char __user *buf,
  56                                    size_t count, loff_t *ppos)
  57 {
  58         return count;
  59 }
  60
  61 static const struct file_operations tracefs_file_operations = {
  62         .read =         default_read_file,
  63         .write =        default_write_file,
  64         .open =         simple_open,
  65         .llseek =       noop_llseek,
  66 };
  67
  68 static struct tracefs_dir_ops {
  69         int (*mkdir)(const char *name);
  70         int (*rmdir)(const char *name);
  71 } tracefs_ops __ro_after_init;
  72
  73 static char *get_dname(struct dentry *dentry)
  74 {
  75         const char *dname;
  76         char *name;
  77         int len = dentry->d_name.len;
  78
  79         dname = dentry->d_name.name;
  80         name = kmalloc(len + 1, GFP_KERNEL);
  81         if (!name)
  82                 return NULL;
  83         memcpy(name, dname, len);
  84         name[len] = 0;
  85         return name;
  86 }
  87
  88 static int tracefs_syscall_mkdir(struct mnt_idmap *idmap,
  89                                  struct inode *inode, struct dentry *dentry,
  90                                  umode_t mode)
  91 {
  92         struct tracefs_inode *ti;
  93         char *name;
  94         int ret;
  95
  96         name = get_dname(dentry);
  97         if (!name)
  98                 return -ENOMEM;
  99
 100         /*
 101          * This is a new directory that does not take the default of
 102          * the rootfs. It becomes the default permissions for all the
 103          * files and directories underneath it.
 104          */
 105         ti = get_tracefs(inode);
 106         ti->flags |= TRACEFS_INSTANCE_INODE;
 107         ti->private = inode;
 108
 109         /*
 110          * The mkdir call can call the generic functions that create
 111          * the files within the tracefs system. It is up to the individual
 112          * mkdir routine to handle races.
 113          */
 114         inode_unlock(inode);
 115         ret = tracefs_ops.mkdir(name);
 116         inode_lock(inode);
 117
 118         kfree(name);
 119
 120         return ret;
 121 }
 122
 123 static int tracefs_syscall_rmdir(struct inode *inode, struct dentry *dentry)
 124 {
 125         char *name;
 126         int ret;
 127
 128         name = get_dname(dentry);
 129         if (!name)
 130                 return -ENOMEM;
 131
 132         /*
 133          * The rmdir call can call the generic functions that create
 134          * the files within the tracefs system. It is up to the individual
 135          * rmdir routine to handle races.
 136          * This time we need to unlock not only the parent (inode) but
 137          * also the directory that is being deleted.
 138          */
 139         inode_unlock(inode);
 140         inode_unlock(d_inode(dentry));
 141
 142         ret = tracefs_ops.rmdir(name);
 143
 144         inode_lock_nested(inode, I_MUTEX_PARENT);
 145         inode_lock(d_inode(dentry));
 146
 147         kfree(name);
 148
 149         return ret;
 150 }
 151
 152 static void set_tracefs_inode_owner(struct inode *inode)
 153 {
 154         struct tracefs_inode *ti = get_tracefs(inode);
 155         struct inode *root_inode = ti->private;
 156
 157         /*
 158          * If this inode has never been referenced, then update
 159          * the permissions to the superblock.
 160          */
 161         if (!(ti->flags & TRACEFS_UID_PERM_SET))
 162                 inode->i_uid = root_inode->i_uid;
 163
 164         if (!(ti->flags & TRACEFS_GID_PERM_SET))
 165                 inode->i_gid = root_inode->i_gid;
 166 }
 167
 168 static int tracefs_permission(struct mnt_idmap *idmap,
 169                               struct inode *inode, int mask)
 170 {
 171         set_tracefs_inode_owner(inode);
 172         return generic_permission(idmap, inode, mask);
 173 }
 174
 175 static int tracefs_getattr(struct mnt_idmap *idmap,
 176                            const struct path *path, struct kstat *stat,
 177                            u32 request_mask, unsigned int flags)
 178 {
 179         struct inode *inode = d_backing_inode(path->dentry);
 180
 181         set_tracefs_inode_owner(inode);
 182         generic_fillattr(idmap, request_mask, inode, stat);
 183         return 0;
 184 }
 185
 186 static int tracefs_setattr(struct mnt_idmap *idmap, struct dentry *dentry,
 187                            struct iattr *attr)
 188 {
 189         unsigned int ia_valid = attr->ia_valid;
 190         struct inode *inode = d_inode(dentry);
 191         struct tracefs_inode *ti = get_tracefs(inode);
 192
 193         if (ia_valid & ATTR_UID)
 194                 ti->flags |= TRACEFS_UID_PERM_SET;
 195
 196         if (ia_valid & ATTR_GID)
 197                 ti->flags |= TRACEFS_GID_PERM_SET;
 198
 199         return simple_setattr(idmap, dentry, attr);
 200 }
 201
 202 static const struct inode_operations tracefs_instance_dir_inode_operations = {
 203         .lookup         = simple_lookup,
 204         .mkdir          = tracefs_syscall_mkdir,
 205         .rmdir          = tracefs_syscall_rmdir,
 206         .permission     = tracefs_permission,
 207         .getattr        = tracefs_getattr,
 208         .setattr        = tracefs_setattr,
 209 };
 210
 211 static const struct inode_operations tracefs_dir_inode_operations = {
 212         .lookup         = simple_lookup,
 213         .permission     = tracefs_permission,
 214         .getattr        = tracefs_getattr,
 215         .setattr        = tracefs_setattr,
 216 };
 217
 218 static const struct inode_operations tracefs_file_inode_operations = {
 219         .permission     = tracefs_permission,
 220         .getattr        = tracefs_getattr,
 221         .setattr        = tracefs_setattr,
 222 };
 223
 224 struct inode *tracefs_get_inode(struct super_block *sb)
 225 {
 226         struct inode *inode = new_inode(sb);
 227         if (inode) {
 228                 inode->i_ino = get_next_ino();
 229                 simple_inode_init_ts(inode);
 230         }
 231         return inode;
 232 }
 233
 234 struct tracefs_mount_opts {
 235         kuid_t uid;
 236         kgid_t gid;
 237         umode_t mode;
 238         /* Opt_* bitfield. */
 239         unsigned int opts;
 240 };
 241
 242 enum {
 243         Opt_uid,
 244         Opt_gid,
 245         Opt_mode,
 246         Opt_err
 247 };
 248
 249 static const match_table_t tokens = {
 250         {Opt_uid, "uid=%u"},
 251         {Opt_gid, "gid=%u"},
 252         {Opt_mode, "mode=%o"},
 253         {Opt_err, NULL}
 254 };
 255
 256 struct tracefs_fs_info {
 257         struct tracefs_mount_opts mount_opts;
 258 };
 259
 260 static int tracefs_parse_options(char *data, struct tracefs_mount_opts *opts)
 261 {
 262         substring_t args[MAX_OPT_ARGS];
 263         int option;
 264         int token;
 265         kuid_t uid;
 266         kgid_t gid;
 267         char *p;
 268
 269         opts->opts = 0;
 270         opts->mode = TRACEFS_DEFAULT_MODE;
 271
 272         while ((p = strsep(&data, ",")) != NULL) {
 273                 if (!*p)
 274                         continue;
 275
 276                 token = match_token(p, tokens, args);
 277                 switch (token) {
 278                 case Opt_uid:
 279                         if (match_int(&args[0], &option))
 280                                 return -EINVAL;
 281                         uid = make_kuid(current_user_ns(), option);
 282                         if (!uid_valid(uid))
 283                                 return -EINVAL;
 284                         opts->uid = uid;
 285                         break;
 286                 case Opt_gid:
 287                         if (match_int(&args[0], &option))
 288                                 return -EINVAL;
 289                         gid = make_kgid(current_user_ns(), option);
 290                         if (!gid_valid(gid))
 291                                 return -EINVAL;
 292                         opts->gid = gid;
 293                         break;
 294                 case Opt_mode:
 295                         if (match_octal(&args[0], &option))
 296                                 return -EINVAL;
 297                         opts->mode = option & S_IALLUGO;
 298                         break;
 299                 /*
 300                  * We might like to report bad mount options here;
 301                  * but traditionally tracefs has ignored all mount options
 302                  */
 303                 }
 304
 305                 opts->opts |= BIT(token);
 306         }
 307
 308         return 0;
 309 }
 310
 311 static int tracefs_apply_options(struct super_block *sb, bool remount)
 312 {
 313         struct tracefs_fs_info *fsi = sb->s_fs_info;
 314         struct inode *inode = d_inode(sb->s_root);
 315         struct tracefs_mount_opts *opts = &fsi->mount_opts;
 316         umode_t tmp_mode;
 317
 318         /*
 319          * On remount, only reset mode/uid/gid if they were provided as mount
 320          * options.
 321          */
 322
 323         if (!remount || opts->opts & BIT(Opt_mode)) {
 324                 tmp_mode = READ_ONCE(inode->i_mode) & ~S_IALLUGO;
 325                 tmp_mode |= opts->mode;
 326                 WRITE_ONCE(inode->i_mode, tmp_mode);
 327         }
 328
 329         if (!remount || opts->opts & BIT(Opt_uid))
 330                 inode->i_uid = opts->uid;
 331
 332         if (!remount || opts->opts & BIT(Opt_gid))
 333                 inode->i_gid = opts->gid;
 334
 335         return 0;
 336 }
 337
 338 static int tracefs_remount(struct super_block *sb, int *flags, char *data)
 339 {
 340         int err;
 341         struct tracefs_fs_info *fsi = sb->s_fs_info;
 342
 343         sync_filesystem(sb);
 344         err = tracefs_parse_options(data, &fsi->mount_opts);
 345         if (err)
 346                 goto fail;
 347
 348         tracefs_apply_options(sb, true);
 349
 350 fail:
 351         return err;
 352 }
 353
 354 static int tracefs_show_options(struct seq_file *m, struct dentry *root)
 355 {
 356         struct tracefs_fs_info *fsi = root->d_sb->s_fs_info;
 357         struct tracefs_mount_opts *opts = &fsi->mount_opts;
 358
 359         if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
 360                 seq_printf(m, ",uid=%u",
 361                            from_kuid_munged(&init_user_ns, opts->uid));
 362         if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
 363                 seq_printf(m, ",gid=%u",
 364                            from_kgid_munged(&init_user_ns, opts->gid));
 365         if (opts->mode != TRACEFS_DEFAULT_MODE)
 366                 seq_printf(m, ",mode=%o", opts->mode);
 367
 368         return 0;
 369 }
 370
 371 static const struct super_operations tracefs_super_operations = {
 372         .alloc_inode    = tracefs_alloc_inode,
 373         .free_inode     = tracefs_free_inode,
 374         .drop_inode     = generic_delete_inode,
 375         .statfs         = simple_statfs,
 376         .remount_fs     = tracefs_remount,
 377         .show_options   = tracefs_show_options,
 378 };
 379
 380 static void tracefs_dentry_iput(struct dentry *dentry, struct inode *inode)
 381 {
 382         struct tracefs_inode *ti;
 383
 384         if (!dentry || !inode)
 385                 return;
 386
 387         ti = get_tracefs(inode);
 388         if (ti && ti->flags & TRACEFS_EVENT_INODE)
 389                 eventfs_set_ei_status_free(ti, dentry);
 390         iput(inode);
 391 }
 392
 393 static const struct dentry_operations tracefs_dentry_operations = {
 394         .d_iput = tracefs_dentry_iput,
 395 };
 396
 397 static int trace_fill_super(struct super_block *sb, void *data, int silent)
 398 {
 399         static const struct tree_descr trace_files[] = {{""}};
 400         struct tracefs_fs_info *fsi;
 401         int err;
 402
 403         fsi = kzalloc(sizeof(struct tracefs_fs_info), GFP_KERNEL);
 404         sb->s_fs_info = fsi;
 405         if (!fsi) {
 406                 err = -ENOMEM;
 407                 goto fail;
 408         }
 409
 410         err = tracefs_parse_options(data, &fsi->mount_opts);
 411         if (err)
 412                 goto fail;
 413
 414         err  =  simple_fill_super(sb, TRACEFS_MAGIC, trace_files);
 415         if (err)
 416                 goto fail;
 417
 418         sb->s_op = &tracefs_super_operations;
 419         sb->s_d_op = &tracefs_dentry_operations;
 420
 421         tracefs_apply_options(sb, false);
 422
 423         return 0;
 424
 425 fail:
 426         kfree(fsi);
 427         sb->s_fs_info = NULL;
 428         return err;
 429 }
 430
 431 static struct dentry *trace_mount(struct file_system_type *fs_type,
 432                         int flags, const char *dev_name,
 433                         void *data)
 434 {
 435         return mount_single(fs_type, flags, data, trace_fill_super);
 436 }
 437
 438 static struct file_system_type trace_fs_type = {
 439         .owner =        THIS_MODULE,
 440         .name =         "tracefs",
 441         .mount =        trace_mount,
 442         .kill_sb =      kill_litter_super,
 443 };
 444 MODULE_ALIAS_FS("tracefs");
 445
 446 struct dentry *tracefs_start_creating(const char *name, struct dentry *parent)
 447 {
 448         struct dentry *dentry;
 449         int error;
 450
 451         pr_debug("tracefs: creating file '%s'\n",name);
 452
 453         error = simple_pin_fs(&trace_fs_type, &tracefs_mount,
 454                               &tracefs_mount_count);
 455         if (error)
 456                 return ERR_PTR(error);
 457
 458         /* If the parent is not specified, we create it in the root.
 459          * We need the root dentry to do this, which is in the super
 460          * block. A pointer to that is in the struct vfsmount that we
 461          * have around.
 462          */
 463         if (!parent)
 464                 parent = tracefs_mount->mnt_root;
 465
 466         inode_lock(d_inode(parent));
 467         if (unlikely(IS_DEADDIR(d_inode(parent))))
 468                 dentry = ERR_PTR(-ENOENT);
 469         else
 470                 dentry = lookup_one_len(name, parent, strlen(name));
 471         if (!IS_ERR(dentry) && d_inode(dentry)) {
 472                 dput(dentry);
 473                 dentry = ERR_PTR(-EEXIST);
 474         }
 475
 476         if (IS_ERR(dentry)) {
 477                 inode_unlock(d_inode(parent));
 478                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
 479         }
 480
 481         return dentry;
 482 }
 483
 484 struct dentry *tracefs_failed_creating(struct dentry *dentry)
 485 {
 486         inode_unlock(d_inode(dentry->d_parent));
 487         dput(dentry);
 488         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
 489         return NULL;
 490 }
 491
 492 struct dentry *tracefs_end_creating(struct dentry *dentry)
 493 {
 494         inode_unlock(d_inode(dentry->d_parent));
 495         return dentry;
 496 }
 497
 498 /**
 499  * eventfs_start_creating - start the process of creating a dentry
 500  * @name: Name of the file created for the dentry
 501  * @parent: The parent dentry where this dentry will be created
 502  *
 503  * This is a simple helper function for the dynamically created eventfs
 504  * files. When the directory of the eventfs files are accessed, their
 505  * dentries are created on the fly. This function is used to start that
 506  * process.
 507  */
 508 struct dentry *eventfs_start_creating(const char *name, struct dentry *parent)
 509 {
 510         struct dentry *dentry;
 511         int error;
 512
 513         /* Must always have a parent. */
 514         if (WARN_ON_ONCE(!parent))
 515                 return ERR_PTR(-EINVAL);
 516
 517         error = simple_pin_fs(&trace_fs_type, &tracefs_mount,
 518                               &tracefs_mount_count);
 519         if (error)
 520                 return ERR_PTR(error);
 521
 522         if (unlikely(IS_DEADDIR(parent->d_inode)))
 523                 dentry = ERR_PTR(-ENOENT);
 524         else
 525                 dentry = lookup_one_len(name, parent, strlen(name));
 526
 527         if (!IS_ERR(dentry) && dentry->d_inode) {
 528                 dput(dentry);
 529                 dentry = ERR_PTR(-EEXIST);
 530         }
 531
 532         if (IS_ERR(dentry))
 533                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
 534
 535         return dentry;
 536 }
 537
 538 /**
 539  * eventfs_failed_creating - clean up a failed eventfs dentry creation
 540  * @dentry: The dentry to clean up
 541  *
 542  * If after calling eventfs_start_creating(), a failure is detected, the
 543  * resources created by eventfs_start_creating() needs to be cleaned up. In
 544  * that case, this function should be called to perform that clean up.
 545  */
 546 struct dentry *eventfs_failed_creating(struct dentry *dentry)
 547 {
 548         dput(dentry);
 549         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
 550         return NULL;
 551 }
 552
 553 /**
 554  * eventfs_end_creating - Finish the process of creating a eventfs dentry
 555  * @dentry: The dentry that has successfully been created.
 556  *
 557  * This function is currently just a place holder to match
 558  * eventfs_start_creating(). In case any synchronization needs to be added,
 559  * this function will be used to implement that without having to modify
 560  * the callers of eventfs_start_creating().
 561  */
 562 struct dentry *eventfs_end_creating(struct dentry *dentry)
 563 {
 564         return dentry;
 565 }
 566
 567 /* Find the inode that this will use for default */
 568 static struct inode *instance_inode(struct dentry *parent, struct inode *inode)
 569 {
 570         struct tracefs_inode *ti;
 571
 572         /* If parent is NULL then use root inode */
 573         if (!parent)
 574                 return d_inode(inode->i_sb->s_root);
 575
 576         /* Find the inode that is flagged as an instance or the root inode */
 577         while (!IS_ROOT(parent)) {
 578                 ti = get_tracefs(d_inode(parent));
 579                 if (ti->flags & TRACEFS_INSTANCE_INODE)
 580                         break;
 581                 parent = parent->d_parent;
 582         }
 583
 584         return d_inode(parent);
 585 }
 586
 587 /**
 588  * tracefs_create_file - create a file in the tracefs filesystem
 589  * @name: a pointer to a string containing the name of the file to create.
 590  * @mode: the permission that the file should have.
 591  * @parent: a pointer to the parent dentry for this file.  This should be a
 592  *          directory dentry if set.  If this parameter is NULL, then the
 593  *          file will be created in the root of the tracefs filesystem.
 594  * @data: a pointer to something that the caller will want to get to later
 595  *        on.  The inode.i_private pointer will point to this value on
 596  *        the open() call.
 597  * @fops: a pointer to a struct file_operations that should be used for
 598  *        this file.
 599  *
 600  * This is the basic "create a file" function for tracefs.  It allows for a
 601  * wide range of flexibility in creating a file, or a directory (if you want
 602  * to create a directory, the tracefs_create_dir() function is
 603  * recommended to be used instead.)
 604  *
 605  * This function will return a pointer to a dentry if it succeeds.  This
 606  * pointer must be passed to the tracefs_remove() function when the file is
 607  * to be removed (no automatic cleanup happens if your module is unloaded,
 608  * you are responsible here.)  If an error occurs, %NULL will be returned.
 609  *
 610  * If tracefs is not enabled in the kernel, the value -%ENODEV will be
 611  * returned.
 612  */
 613 struct dentry *tracefs_create_file(const char *name, umode_t mode,
 614                                    struct dentry *parent, void *data,
 615                                    const struct file_operations *fops)
 616 {
 617         struct tracefs_inode *ti;
 618         struct dentry *dentry;
 619         struct inode *inode;
 620
 621         if (security_locked_down(LOCKDOWN_TRACEFS))
 622                 return NULL;
 623
 624         if (!(mode & S_IFMT))
 625                 mode |= S_IFREG;
 626         BUG_ON(!S_ISREG(mode));
 627         dentry = tracefs_start_creating(name, parent);
 628
 629         if (IS_ERR(dentry))
 630                 return NULL;
 631
 632         inode = tracefs_get_inode(dentry->d_sb);
 633         if (unlikely(!inode))
 634                 return tracefs_failed_creating(dentry);
 635
 636         ti = get_tracefs(inode);
 637         ti->private = instance_inode(parent, inode);
 638
 639         inode->i_mode = mode;
 640         inode->i_op = &tracefs_file_inode_operations;
 641         inode->i_fop = fops ? fops : &tracefs_file_operations;
 642         inode->i_private = data;
 643         inode->i_uid = d_inode(dentry->d_parent)->i_uid;
 644         inode->i_gid = d_inode(dentry->d_parent)->i_gid;
 645         d_instantiate(dentry, inode);
 646         fsnotify_create(d_inode(dentry->d_parent), dentry);
 647         return tracefs_end_creating(dentry);
 648 }
 649
 650 static struct dentry *__create_dir(const char *name, struct dentry *parent,
 651                                    const struct inode_operations *ops)
 652 {
 653         struct tracefs_inode *ti;
 654         struct dentry *dentry = tracefs_start_creating(name, parent);
 655         struct inode *inode;
 656
 657         if (IS_ERR(dentry))
 658                 return NULL;
 659
 660         inode = tracefs_get_inode(dentry->d_sb);
 661         if (unlikely(!inode))
 662                 return tracefs_failed_creating(dentry);
 663
 664         /* Do not set bits for OTH */
 665         inode->i_mode = S_IFDIR | S_IRWXU | S_IRUSR| S_IRGRP | S_IXUSR | S_IXGRP;
 666         inode->i_op = ops;
 667         inode->i_fop = &simple_dir_operations;
 668         inode->i_uid = d_inode(dentry->d_parent)->i_uid;
 669         inode->i_gid = d_inode(dentry->d_parent)->i_gid;
 670
 671         ti = get_tracefs(inode);
 672         ti->private = instance_inode(parent, inode);
 673
 674         /* directory inodes start off with i_nlink == 2 (for "." entry) */
 675         inc_nlink(inode);
 676         d_instantiate(dentry, inode);
 677         inc_nlink(d_inode(dentry->d_parent));
 678         fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
 679         return tracefs_end_creating(dentry);
 680 }
 681
 682 /**
 683  * tracefs_create_dir - create a directory in the tracefs filesystem
 684  * @name: a pointer to a string containing the name of the directory to
 685  *        create.
 686  * @parent: a pointer to the parent dentry for this file.  This should be a
 687  *          directory dentry if set.  If this parameter is NULL, then the
 688  *          directory will be created in the root of the tracefs filesystem.
 689  *
 690  * This function creates a directory in tracefs with the given name.
 691  *
 692  * This function will return a pointer to a dentry if it succeeds.  This
 693  * pointer must be passed to the tracefs_remove() function when the file is
 694  * to be removed. If an error occurs, %NULL will be returned.
 695  *
 696  * If tracing is not enabled in the kernel, the value -%ENODEV will be
 697  * returned.
 698  */
 699 struct dentry *tracefs_create_dir(const char *name, struct dentry *parent)
 700 {
 701         if (security_locked_down(LOCKDOWN_TRACEFS))
 702                 return NULL;
 703
 704         return __create_dir(name, parent, &tracefs_dir_inode_operations);
 705 }
 706
 707 /**
 708  * tracefs_create_instance_dir - create the tracing instances directory
 709  * @name: The name of the instances directory to create
 710  * @parent: The parent directory that the instances directory will exist
 711  * @mkdir: The function to call when a mkdir is performed.
 712  * @rmdir: The function to call when a rmdir is performed.
 713  *
 714  * Only one instances directory is allowed.
 715  *
 716  * The instances directory is special as it allows for mkdir and rmdir
 717  * to be done by userspace. When a mkdir or rmdir is performed, the inode
 718  * locks are released and the methods passed in (@mkdir and @rmdir) are
 719  * called without locks and with the name of the directory being created
 720  * within the instances directory.
 721  *
 722  * Returns the dentry of the instances directory.
 723  */
 724 __init struct dentry *tracefs_create_instance_dir(const char *name,
 725                                           struct dentry *parent,
 726                                           int (*mkdir)(const char *name),
 727                                           int (*rmdir)(const char *name))
 728 {
 729         struct dentry *dentry;
 730
 731         /* Only allow one instance of the instances directory. */
 732         if (WARN_ON(tracefs_ops.mkdir || tracefs_ops.rmdir))
 733                 return NULL;
 734
 735         dentry = __create_dir(name, parent, &tracefs_instance_dir_inode_operations);
 736         if (!dentry)
 737                 return NULL;
 738
 739         tracefs_ops.mkdir = mkdir;
 740         tracefs_ops.rmdir = rmdir;
 741
 742         return dentry;
 743 }
 744
 745 static void remove_one(struct dentry *victim)
 746 {
 747         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
 748 }
 749
 750 /**
 751  * tracefs_remove - recursively removes a directory
 752  * @dentry: a pointer to a the dentry of the directory to be removed.
 753  *
 754  * This function recursively removes a directory tree in tracefs that
 755  * was previously created with a call to another tracefs function
 756  * (like tracefs_create_file() or variants thereof.)
 757  */
 758 void tracefs_remove(struct dentry *dentry)
 759 {
 760         if (IS_ERR_OR_NULL(dentry))
 761                 return;
 762
 763         simple_pin_fs(&trace_fs_type, &tracefs_mount, &tracefs_mount_count);
 764         simple_recursive_removal(dentry, remove_one);
 765         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
 766 }
 767
 768 /**
 769  * tracefs_initialized - Tells whether tracefs has been registered
 770  */
 771 bool tracefs_initialized(void)
 772 {
 773         return tracefs_registered;
 774 }
 775
 776 static void init_once(void *foo)
 777 {
 778         struct tracefs_inode *ti = (struct tracefs_inode *) foo;
 779
 780         /* inode_init_once() calls memset() on the vfs_inode portion */
 781         inode_init_once(&ti->vfs_inode);
 782
 783         /* Zero out the rest */
 784         memset_after(ti, 0, vfs_inode);
 785 }
 786
 787 static int __init tracefs_init(void)
 788 {
 789         int retval;
 790
 791         tracefs_inode_cachep = kmem_cache_create("tracefs_inode_cache",
 792                                                  sizeof(struct tracefs_inode),
 793                                                  0, (SLAB_RECLAIM_ACCOUNT|
 794                                                      SLAB_MEM_SPREAD|
 795                                                      SLAB_ACCOUNT),
 796                                                  init_once);
 797         if (!tracefs_inode_cachep)
 798                 return -ENOMEM;
 799
 800         retval = sysfs_create_mount_point(kernel_kobj, "tracing");
 801         if (retval)
 802                 return -EINVAL;
 803
 804         retval = register_filesystem(&trace_fs_type);
 805         if (!retval)
 806                 tracefs_registered = true;
 807
 808         return retval;
 809 }
 810 core_initcall(tracefs_init);