GNU Linux-libre 5.4.257-gnu1
[releases.git] / 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
25 #define TRACEFS_DEFAULT_MODE    0700
26
27 static struct vfsmount *tracefs_mount;
28 static int tracefs_mount_count;
29 static bool tracefs_registered;
30
31 static ssize_t default_read_file(struct file *file, char __user *buf,
32                                  size_t count, loff_t *ppos)
33 {
34         return 0;
35 }
36
37 static ssize_t default_write_file(struct file *file, const char __user *buf,
38                                    size_t count, loff_t *ppos)
39 {
40         return count;
41 }
42
43 static const struct file_operations tracefs_file_operations = {
44         .read =         default_read_file,
45         .write =        default_write_file,
46         .open =         simple_open,
47         .llseek =       noop_llseek,
48 };
49
50 static struct tracefs_dir_ops {
51         int (*mkdir)(const char *name);
52         int (*rmdir)(const char *name);
53 } tracefs_ops __ro_after_init;
54
55 static char *get_dname(struct dentry *dentry)
56 {
57         const char *dname;
58         char *name;
59         int len = dentry->d_name.len;
60
61         dname = dentry->d_name.name;
62         name = kmalloc(len + 1, GFP_KERNEL);
63         if (!name)
64                 return NULL;
65         memcpy(name, dname, len);
66         name[len] = 0;
67         return name;
68 }
69
70 static int tracefs_syscall_mkdir(struct inode *inode, struct dentry *dentry, umode_t mode)
71 {
72         char *name;
73         int ret;
74
75         name = get_dname(dentry);
76         if (!name)
77                 return -ENOMEM;
78
79         /*
80          * The mkdir call can call the generic functions that create
81          * the files within the tracefs system. It is up to the individual
82          * mkdir routine to handle races.
83          */
84         inode_unlock(inode);
85         ret = tracefs_ops.mkdir(name);
86         inode_lock(inode);
87
88         kfree(name);
89
90         return ret;
91 }
92
93 static int tracefs_syscall_rmdir(struct inode *inode, struct dentry *dentry)
94 {
95         char *name;
96         int ret;
97
98         name = get_dname(dentry);
99         if (!name)
100                 return -ENOMEM;
101
102         /*
103          * The rmdir call can call the generic functions that create
104          * the files within the tracefs system. It is up to the individual
105          * rmdir routine to handle races.
106          * This time we need to unlock not only the parent (inode) but
107          * also the directory that is being deleted.
108          */
109         inode_unlock(inode);
110         inode_unlock(dentry->d_inode);
111
112         ret = tracefs_ops.rmdir(name);
113
114         inode_lock_nested(inode, I_MUTEX_PARENT);
115         inode_lock(dentry->d_inode);
116
117         kfree(name);
118
119         return ret;
120 }
121
122 static const struct inode_operations tracefs_dir_inode_operations = {
123         .lookup         = simple_lookup,
124         .mkdir          = tracefs_syscall_mkdir,
125         .rmdir          = tracefs_syscall_rmdir,
126 };
127
128 static struct inode *tracefs_get_inode(struct super_block *sb)
129 {
130         struct inode *inode = new_inode(sb);
131         if (inode) {
132                 inode->i_ino = get_next_ino();
133                 inode->i_atime = inode->i_mtime = inode->i_ctime = current_time(inode);
134         }
135         return inode;
136 }
137
138 struct tracefs_mount_opts {
139         kuid_t uid;
140         kgid_t gid;
141         umode_t mode;
142         /* Opt_* bitfield. */
143         unsigned int opts;
144 };
145
146 enum {
147         Opt_uid,
148         Opt_gid,
149         Opt_mode,
150         Opt_err
151 };
152
153 static const match_table_t tokens = {
154         {Opt_uid, "uid=%u"},
155         {Opt_gid, "gid=%u"},
156         {Opt_mode, "mode=%o"},
157         {Opt_err, NULL}
158 };
159
160 struct tracefs_fs_info {
161         struct tracefs_mount_opts mount_opts;
162 };
163
164 static void change_gid(struct dentry *dentry, kgid_t gid)
165 {
166         if (!dentry->d_inode)
167                 return;
168         dentry->d_inode->i_gid = gid;
169 }
170
171 /*
172  * Taken from d_walk, but without he need for handling renames.
173  * Nothing can be renamed while walking the list, as tracefs
174  * does not support renames. This is only called when mounting
175  * or remounting the file system, to set all the files to
176  * the given gid.
177  */
178 static void set_gid(struct dentry *parent, kgid_t gid)
179 {
180         struct dentry *this_parent;
181         struct list_head *next;
182
183         this_parent = parent;
184         spin_lock(&this_parent->d_lock);
185
186         change_gid(this_parent, gid);
187 repeat:
188         next = this_parent->d_subdirs.next;
189 resume:
190         while (next != &this_parent->d_subdirs) {
191                 struct list_head *tmp = next;
192                 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
193                 next = tmp->next;
194
195                 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
196
197                 change_gid(dentry, gid);
198
199                 if (!list_empty(&dentry->d_subdirs)) {
200                         spin_unlock(&this_parent->d_lock);
201                         spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
202                         this_parent = dentry;
203                         spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
204                         goto repeat;
205                 }
206                 spin_unlock(&dentry->d_lock);
207         }
208         /*
209          * All done at this level ... ascend and resume the search.
210          */
211         rcu_read_lock();
212 ascend:
213         if (this_parent != parent) {
214                 struct dentry *child = this_parent;
215                 this_parent = child->d_parent;
216
217                 spin_unlock(&child->d_lock);
218                 spin_lock(&this_parent->d_lock);
219
220                 /* go into the first sibling still alive */
221                 do {
222                         next = child->d_child.next;
223                         if (next == &this_parent->d_subdirs)
224                                 goto ascend;
225                         child = list_entry(next, struct dentry, d_child);
226                 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
227                 rcu_read_unlock();
228                 goto resume;
229         }
230         rcu_read_unlock();
231         spin_unlock(&this_parent->d_lock);
232         return;
233 }
234
235 static int tracefs_parse_options(char *data, struct tracefs_mount_opts *opts)
236 {
237         substring_t args[MAX_OPT_ARGS];
238         int option;
239         int token;
240         kuid_t uid;
241         kgid_t gid;
242         char *p;
243
244         opts->opts = 0;
245         opts->mode = TRACEFS_DEFAULT_MODE;
246
247         while ((p = strsep(&data, ",")) != NULL) {
248                 if (!*p)
249                         continue;
250
251                 token = match_token(p, tokens, args);
252                 switch (token) {
253                 case Opt_uid:
254                         if (match_int(&args[0], &option))
255                                 return -EINVAL;
256                         uid = make_kuid(current_user_ns(), option);
257                         if (!uid_valid(uid))
258                                 return -EINVAL;
259                         opts->uid = uid;
260                         break;
261                 case Opt_gid:
262                         if (match_int(&args[0], &option))
263                                 return -EINVAL;
264                         gid = make_kgid(current_user_ns(), option);
265                         if (!gid_valid(gid))
266                                 return -EINVAL;
267                         opts->gid = gid;
268                         break;
269                 case Opt_mode:
270                         if (match_octal(&args[0], &option))
271                                 return -EINVAL;
272                         opts->mode = option & S_IALLUGO;
273                         break;
274                 /*
275                  * We might like to report bad mount options here;
276                  * but traditionally tracefs has ignored all mount options
277                  */
278                 }
279
280                 opts->opts |= BIT(token);
281         }
282
283         return 0;
284 }
285
286 static int tracefs_apply_options(struct super_block *sb, bool remount)
287 {
288         struct tracefs_fs_info *fsi = sb->s_fs_info;
289         struct inode *inode = sb->s_root->d_inode;
290         struct tracefs_mount_opts *opts = &fsi->mount_opts;
291
292         /*
293          * On remount, only reset mode/uid/gid if they were provided as mount
294          * options.
295          */
296
297         if (!remount || opts->opts & BIT(Opt_mode)) {
298                 inode->i_mode &= ~S_IALLUGO;
299                 inode->i_mode |= opts->mode;
300         }
301
302         if (!remount || opts->opts & BIT(Opt_uid))
303                 inode->i_uid = opts->uid;
304
305         if (!remount || opts->opts & BIT(Opt_gid)) {
306                 /* Set all the group ids to the mount option */
307                 set_gid(sb->s_root, opts->gid);
308         }
309
310         return 0;
311 }
312
313 static int tracefs_remount(struct super_block *sb, int *flags, char *data)
314 {
315         int err;
316         struct tracefs_fs_info *fsi = sb->s_fs_info;
317
318         sync_filesystem(sb);
319         err = tracefs_parse_options(data, &fsi->mount_opts);
320         if (err)
321                 goto fail;
322
323         tracefs_apply_options(sb, true);
324
325 fail:
326         return err;
327 }
328
329 static int tracefs_show_options(struct seq_file *m, struct dentry *root)
330 {
331         struct tracefs_fs_info *fsi = root->d_sb->s_fs_info;
332         struct tracefs_mount_opts *opts = &fsi->mount_opts;
333
334         if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
335                 seq_printf(m, ",uid=%u",
336                            from_kuid_munged(&init_user_ns, opts->uid));
337         if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
338                 seq_printf(m, ",gid=%u",
339                            from_kgid_munged(&init_user_ns, opts->gid));
340         if (opts->mode != TRACEFS_DEFAULT_MODE)
341                 seq_printf(m, ",mode=%o", opts->mode);
342
343         return 0;
344 }
345
346 static const struct super_operations tracefs_super_operations = {
347         .statfs         = simple_statfs,
348         .remount_fs     = tracefs_remount,
349         .show_options   = tracefs_show_options,
350 };
351
352 static int trace_fill_super(struct super_block *sb, void *data, int silent)
353 {
354         static const struct tree_descr trace_files[] = {{""}};
355         struct tracefs_fs_info *fsi;
356         int err;
357
358         fsi = kzalloc(sizeof(struct tracefs_fs_info), GFP_KERNEL);
359         sb->s_fs_info = fsi;
360         if (!fsi) {
361                 err = -ENOMEM;
362                 goto fail;
363         }
364
365         err = tracefs_parse_options(data, &fsi->mount_opts);
366         if (err)
367                 goto fail;
368
369         err  =  simple_fill_super(sb, TRACEFS_MAGIC, trace_files);
370         if (err)
371                 goto fail;
372
373         sb->s_op = &tracefs_super_operations;
374
375         tracefs_apply_options(sb, false);
376
377         return 0;
378
379 fail:
380         kfree(fsi);
381         sb->s_fs_info = NULL;
382         return err;
383 }
384
385 static struct dentry *trace_mount(struct file_system_type *fs_type,
386                         int flags, const char *dev_name,
387                         void *data)
388 {
389         return mount_single(fs_type, flags, data, trace_fill_super);
390 }
391
392 static struct file_system_type trace_fs_type = {
393         .owner =        THIS_MODULE,
394         .name =         "tracefs",
395         .mount =        trace_mount,
396         .kill_sb =      kill_litter_super,
397 };
398 MODULE_ALIAS_FS("tracefs");
399
400 static struct dentry *start_creating(const char *name, struct dentry *parent)
401 {
402         struct dentry *dentry;
403         int error;
404
405         pr_debug("tracefs: creating file '%s'\n",name);
406
407         error = simple_pin_fs(&trace_fs_type, &tracefs_mount,
408                               &tracefs_mount_count);
409         if (error)
410                 return ERR_PTR(error);
411
412         /* If the parent is not specified, we create it in the root.
413          * We need the root dentry to do this, which is in the super
414          * block. A pointer to that is in the struct vfsmount that we
415          * have around.
416          */
417         if (!parent)
418                 parent = tracefs_mount->mnt_root;
419
420         inode_lock(parent->d_inode);
421         dentry = lookup_one_len(name, parent, strlen(name));
422         if (!IS_ERR(dentry) && dentry->d_inode) {
423                 dput(dentry);
424                 dentry = ERR_PTR(-EEXIST);
425         }
426
427         if (IS_ERR(dentry)) {
428                 inode_unlock(parent->d_inode);
429                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
430         }
431
432         return dentry;
433 }
434
435 static struct dentry *failed_creating(struct dentry *dentry)
436 {
437         inode_unlock(dentry->d_parent->d_inode);
438         dput(dentry);
439         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
440         return NULL;
441 }
442
443 static struct dentry *end_creating(struct dentry *dentry)
444 {
445         inode_unlock(dentry->d_parent->d_inode);
446         return dentry;
447 }
448
449 /**
450  * tracefs_create_file - create a file in the tracefs filesystem
451  * @name: a pointer to a string containing the name of the file to create.
452  * @mode: the permission that the file should have.
453  * @parent: a pointer to the parent dentry for this file.  This should be a
454  *          directory dentry if set.  If this parameter is NULL, then the
455  *          file will be created in the root of the tracefs filesystem.
456  * @data: a pointer to something that the caller will want to get to later
457  *        on.  The inode.i_private pointer will point to this value on
458  *        the open() call.
459  * @fops: a pointer to a struct file_operations that should be used for
460  *        this file.
461  *
462  * This is the basic "create a file" function for tracefs.  It allows for a
463  * wide range of flexibility in creating a file, or a directory (if you want
464  * to create a directory, the tracefs_create_dir() function is
465  * recommended to be used instead.)
466  *
467  * This function will return a pointer to a dentry if it succeeds.  This
468  * pointer must be passed to the tracefs_remove() function when the file is
469  * to be removed (no automatic cleanup happens if your module is unloaded,
470  * you are responsible here.)  If an error occurs, %NULL will be returned.
471  *
472  * If tracefs is not enabled in the kernel, the value -%ENODEV will be
473  * returned.
474  */
475 struct dentry *tracefs_create_file(const char *name, umode_t mode,
476                                    struct dentry *parent, void *data,
477                                    const struct file_operations *fops)
478 {
479         struct dentry *dentry;
480         struct inode *inode;
481
482         if (security_locked_down(LOCKDOWN_TRACEFS))
483                 return NULL;
484
485         if (!(mode & S_IFMT))
486                 mode |= S_IFREG;
487         BUG_ON(!S_ISREG(mode));
488         dentry = start_creating(name, parent);
489
490         if (IS_ERR(dentry))
491                 return NULL;
492
493         inode = tracefs_get_inode(dentry->d_sb);
494         if (unlikely(!inode))
495                 return failed_creating(dentry);
496
497         inode->i_mode = mode;
498         inode->i_fop = fops ? fops : &tracefs_file_operations;
499         inode->i_private = data;
500         inode->i_uid = d_inode(dentry->d_parent)->i_uid;
501         inode->i_gid = d_inode(dentry->d_parent)->i_gid;
502         d_instantiate(dentry, inode);
503         fsnotify_create(dentry->d_parent->d_inode, dentry);
504         return end_creating(dentry);
505 }
506
507 static struct dentry *__create_dir(const char *name, struct dentry *parent,
508                                    const struct inode_operations *ops)
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 = tracefs_get_inode(dentry->d_sb);
517         if (unlikely(!inode))
518                 return failed_creating(dentry);
519
520         /* Do not set bits for OTH */
521         inode->i_mode = S_IFDIR | S_IRWXU | S_IRUSR| S_IRGRP | S_IXUSR | S_IXGRP;
522         inode->i_op = ops;
523         inode->i_fop = &simple_dir_operations;
524         inode->i_uid = d_inode(dentry->d_parent)->i_uid;
525         inode->i_gid = d_inode(dentry->d_parent)->i_gid;
526
527         /* directory inodes start off with i_nlink == 2 (for "." entry) */
528         inc_nlink(inode);
529         d_instantiate(dentry, inode);
530         inc_nlink(dentry->d_parent->d_inode);
531         fsnotify_mkdir(dentry->d_parent->d_inode, dentry);
532         return end_creating(dentry);
533 }
534
535 /**
536  * tracefs_create_dir - create a directory in the tracefs filesystem
537  * @name: a pointer to a string containing the name of the directory to
538  *        create.
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  *          directory will be created in the root of the tracefs filesystem.
542  *
543  * This function creates a directory in tracefs with the given name.
544  *
545  * This function will return a pointer to a dentry if it succeeds.  This
546  * pointer must be passed to the tracefs_remove() function when the file is
547  * to be removed. If an error occurs, %NULL will be returned.
548  *
549  * If tracing is not enabled in the kernel, the value -%ENODEV will be
550  * returned.
551  */
552 struct dentry *tracefs_create_dir(const char *name, struct dentry *parent)
553 {
554         if (security_locked_down(LOCKDOWN_TRACEFS))
555                 return NULL;
556
557         return __create_dir(name, parent, &simple_dir_inode_operations);
558 }
559
560 /**
561  * tracefs_create_instance_dir - create the tracing instances directory
562  * @name: The name of the instances directory to create
563  * @parent: The parent directory that the instances directory will exist
564  * @mkdir: The function to call when a mkdir is performed.
565  * @rmdir: The function to call when a rmdir is performed.
566  *
567  * Only one instances directory is allowed.
568  *
569  * The instances directory is special as it allows for mkdir and rmdir to
570  * to be done by userspace. When a mkdir or rmdir is performed, the inode
571  * locks are released and the methhods passed in (@mkdir and @rmdir) are
572  * called without locks and with the name of the directory being created
573  * within the instances directory.
574  *
575  * Returns the dentry of the instances directory.
576  */
577 __init struct dentry *tracefs_create_instance_dir(const char *name,
578                                           struct dentry *parent,
579                                           int (*mkdir)(const char *name),
580                                           int (*rmdir)(const char *name))
581 {
582         struct dentry *dentry;
583
584         /* Only allow one instance of the instances directory. */
585         if (WARN_ON(tracefs_ops.mkdir || tracefs_ops.rmdir))
586                 return NULL;
587
588         dentry = __create_dir(name, parent, &tracefs_dir_inode_operations);
589         if (!dentry)
590                 return NULL;
591
592         tracefs_ops.mkdir = mkdir;
593         tracefs_ops.rmdir = rmdir;
594
595         return dentry;
596 }
597
598 static int __tracefs_remove(struct dentry *dentry, struct dentry *parent)
599 {
600         int ret = 0;
601
602         if (simple_positive(dentry)) {
603                 if (dentry->d_inode) {
604                         dget(dentry);
605                         switch (dentry->d_inode->i_mode & S_IFMT) {
606                         case S_IFDIR:
607                                 ret = simple_rmdir(parent->d_inode, dentry);
608                                 if (!ret)
609                                         fsnotify_rmdir(parent->d_inode, dentry);
610                                 break;
611                         default:
612                                 simple_unlink(parent->d_inode, dentry);
613                                 fsnotify_unlink(parent->d_inode, dentry);
614                                 break;
615                         }
616                         if (!ret)
617                                 d_delete(dentry);
618                         dput(dentry);
619                 }
620         }
621         return ret;
622 }
623
624 /**
625  * tracefs_remove - removes a file or directory from the tracefs filesystem
626  * @dentry: a pointer to a the dentry of the file or directory to be
627  *          removed.
628  *
629  * This function removes a file or directory in tracefs that was previously
630  * created with a call to another tracefs function (like
631  * tracefs_create_file() or variants thereof.)
632  */
633 void tracefs_remove(struct dentry *dentry)
634 {
635         struct dentry *parent;
636         int ret;
637
638         if (IS_ERR_OR_NULL(dentry))
639                 return;
640
641         parent = dentry->d_parent;
642         inode_lock(parent->d_inode);
643         ret = __tracefs_remove(dentry, parent);
644         inode_unlock(parent->d_inode);
645         if (!ret)
646                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
647 }
648
649 /**
650  * tracefs_remove_recursive - recursively removes a directory
651  * @dentry: a pointer to a the dentry of the directory to be removed.
652  *
653  * This function recursively removes a directory tree in tracefs that
654  * was previously created with a call to another tracefs function
655  * (like tracefs_create_file() or variants thereof.)
656  */
657 void tracefs_remove_recursive(struct dentry *dentry)
658 {
659         struct dentry *child, *parent;
660
661         if (IS_ERR_OR_NULL(dentry))
662                 return;
663
664         parent = dentry;
665  down:
666         inode_lock(parent->d_inode);
667  loop:
668         /*
669          * The parent->d_subdirs is protected by the d_lock. Outside that
670          * lock, the child can be unlinked and set to be freed which can
671          * use the d_u.d_child as the rcu head and corrupt this list.
672          */
673         spin_lock(&parent->d_lock);
674         list_for_each_entry(child, &parent->d_subdirs, d_child) {
675                 if (!simple_positive(child))
676                         continue;
677
678                 /* perhaps simple_empty(child) makes more sense */
679                 if (!list_empty(&child->d_subdirs)) {
680                         spin_unlock(&parent->d_lock);
681                         inode_unlock(parent->d_inode);
682                         parent = child;
683                         goto down;
684                 }
685
686                 spin_unlock(&parent->d_lock);
687
688                 if (!__tracefs_remove(child, parent))
689                         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
690
691                 /*
692                  * The parent->d_lock protects agaist child from unlinking
693                  * from d_subdirs. When releasing the parent->d_lock we can
694                  * no longer trust that the next pointer is valid.
695                  * Restart the loop. We'll skip this one with the
696                  * simple_positive() check.
697                  */
698                 goto loop;
699         }
700         spin_unlock(&parent->d_lock);
701
702         inode_unlock(parent->d_inode);
703         child = parent;
704         parent = parent->d_parent;
705         inode_lock(parent->d_inode);
706
707         if (child != dentry)
708                 /* go up */
709                 goto loop;
710
711         if (!__tracefs_remove(child, parent))
712                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
713         inode_unlock(parent->d_inode);
714 }
715
716 /**
717  * tracefs_initialized - Tells whether tracefs has been registered
718  */
719 bool tracefs_initialized(void)
720 {
721         return tracefs_registered;
722 }
723
724 static int __init tracefs_init(void)
725 {
726         int retval;
727
728         retval = sysfs_create_mount_point(kernel_kobj, "tracing");
729         if (retval)
730                 return -EINVAL;
731
732         retval = register_filesystem(&trace_fs_type);
733         if (!retval)
734                 tracefs_registered = true;
735
736         return retval;
737 }
738 core_initcall(tracefs_init);