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