GNU Linux-libre 4.14.290-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;
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 };
146
147 enum {
148         Opt_uid,
149         Opt_gid,
150         Opt_mode,
151         Opt_err
152 };
153
154 static const match_table_t tokens = {
155         {Opt_uid, "uid=%u"},
156         {Opt_gid, "gid=%u"},
157         {Opt_mode, "mode=%o"},
158         {Opt_err, NULL}
159 };
160
161 struct tracefs_fs_info {
162         struct tracefs_mount_opts mount_opts;
163 };
164
165 static void change_gid(struct dentry *dentry, kgid_t gid)
166 {
167         if (!dentry->d_inode)
168                 return;
169         dentry->d_inode->i_gid = gid;
170 }
171
172 /*
173  * Taken from d_walk, but without he need for handling renames.
174  * Nothing can be renamed while walking the list, as tracefs
175  * does not support renames. This is only called when mounting
176  * or remounting the file system, to set all the files to
177  * the given gid.
178  */
179 static void set_gid(struct dentry *parent, kgid_t gid)
180 {
181         struct dentry *this_parent;
182         struct list_head *next;
183
184         this_parent = parent;
185         spin_lock(&this_parent->d_lock);
186
187         change_gid(this_parent, gid);
188 repeat:
189         next = this_parent->d_subdirs.next;
190 resume:
191         while (next != &this_parent->d_subdirs) {
192                 struct list_head *tmp = next;
193                 struct dentry *dentry = list_entry(tmp, struct dentry, d_child);
194                 next = tmp->next;
195
196                 spin_lock_nested(&dentry->d_lock, DENTRY_D_LOCK_NESTED);
197
198                 change_gid(dentry, gid);
199
200                 if (!list_empty(&dentry->d_subdirs)) {
201                         spin_unlock(&this_parent->d_lock);
202                         spin_release(&dentry->d_lock.dep_map, 1, _RET_IP_);
203                         this_parent = dentry;
204                         spin_acquire(&this_parent->d_lock.dep_map, 0, 1, _RET_IP_);
205                         goto repeat;
206                 }
207                 spin_unlock(&dentry->d_lock);
208         }
209         /*
210          * All done at this level ... ascend and resume the search.
211          */
212         rcu_read_lock();
213 ascend:
214         if (this_parent != parent) {
215                 struct dentry *child = this_parent;
216                 this_parent = child->d_parent;
217
218                 spin_unlock(&child->d_lock);
219                 spin_lock(&this_parent->d_lock);
220
221                 /* go into the first sibling still alive */
222                 do {
223                         next = child->d_child.next;
224                         if (next == &this_parent->d_subdirs)
225                                 goto ascend;
226                         child = list_entry(next, struct dentry, d_child);
227                 } while (unlikely(child->d_flags & DCACHE_DENTRY_KILLED));
228                 rcu_read_unlock();
229                 goto resume;
230         }
231         rcu_read_unlock();
232         spin_unlock(&this_parent->d_lock);
233         return;
234 }
235
236 static int tracefs_parse_options(char *data, struct tracefs_mount_opts *opts)
237 {
238         substring_t args[MAX_OPT_ARGS];
239         int option;
240         int token;
241         kuid_t uid;
242         kgid_t gid;
243         char *p;
244
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
281         return 0;
282 }
283
284 static int tracefs_apply_options(struct super_block *sb)
285 {
286         struct tracefs_fs_info *fsi = sb->s_fs_info;
287         struct inode *inode = sb->s_root->d_inode;
288         struct tracefs_mount_opts *opts = &fsi->mount_opts;
289
290         inode->i_mode &= ~S_IALLUGO;
291         inode->i_mode |= opts->mode;
292
293         inode->i_uid = opts->uid;
294
295         /* Set all the group ids to the mount option */
296         set_gid(sb->s_root, opts->gid);
297
298         return 0;
299 }
300
301 static int tracefs_remount(struct super_block *sb, int *flags, char *data)
302 {
303         int err;
304         struct tracefs_fs_info *fsi = sb->s_fs_info;
305
306         sync_filesystem(sb);
307         err = tracefs_parse_options(data, &fsi->mount_opts);
308         if (err)
309                 goto fail;
310
311         tracefs_apply_options(sb);
312
313 fail:
314         return err;
315 }
316
317 static int tracefs_show_options(struct seq_file *m, struct dentry *root)
318 {
319         struct tracefs_fs_info *fsi = root->d_sb->s_fs_info;
320         struct tracefs_mount_opts *opts = &fsi->mount_opts;
321
322         if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
323                 seq_printf(m, ",uid=%u",
324                            from_kuid_munged(&init_user_ns, opts->uid));
325         if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
326                 seq_printf(m, ",gid=%u",
327                            from_kgid_munged(&init_user_ns, opts->gid));
328         if (opts->mode != TRACEFS_DEFAULT_MODE)
329                 seq_printf(m, ",mode=%o", opts->mode);
330
331         return 0;
332 }
333
334 static const struct super_operations tracefs_super_operations = {
335         .statfs         = simple_statfs,
336         .remount_fs     = tracefs_remount,
337         .show_options   = tracefs_show_options,
338 };
339
340 static int trace_fill_super(struct super_block *sb, void *data, int silent)
341 {
342         static const struct tree_descr trace_files[] = {{""}};
343         struct tracefs_fs_info *fsi;
344         int err;
345
346         fsi = kzalloc(sizeof(struct tracefs_fs_info), GFP_KERNEL);
347         sb->s_fs_info = fsi;
348         if (!fsi) {
349                 err = -ENOMEM;
350                 goto fail;
351         }
352
353         err = tracefs_parse_options(data, &fsi->mount_opts);
354         if (err)
355                 goto fail;
356
357         err  =  simple_fill_super(sb, TRACEFS_MAGIC, trace_files);
358         if (err)
359                 goto fail;
360
361         sb->s_op = &tracefs_super_operations;
362
363         tracefs_apply_options(sb);
364
365         return 0;
366
367 fail:
368         kfree(fsi);
369         sb->s_fs_info = NULL;
370         return err;
371 }
372
373 static struct dentry *trace_mount(struct file_system_type *fs_type,
374                         int flags, const char *dev_name,
375                         void *data)
376 {
377         return mount_single(fs_type, flags, data, trace_fill_super);
378 }
379
380 static struct file_system_type trace_fs_type = {
381         .owner =        THIS_MODULE,
382         .name =         "tracefs",
383         .mount =        trace_mount,
384         .kill_sb =      kill_litter_super,
385 };
386 MODULE_ALIAS_FS("tracefs");
387
388 static struct dentry *start_creating(const char *name, struct dentry *parent)
389 {
390         struct dentry *dentry;
391         int error;
392
393         pr_debug("tracefs: creating file '%s'\n",name);
394
395         error = simple_pin_fs(&trace_fs_type, &tracefs_mount,
396                               &tracefs_mount_count);
397         if (error)
398                 return ERR_PTR(error);
399
400         /* If the parent is not specified, we create it in the root.
401          * We need the root dentry to do this, which is in the super
402          * block. A pointer to that is in the struct vfsmount that we
403          * have around.
404          */
405         if (!parent)
406                 parent = tracefs_mount->mnt_root;
407
408         inode_lock(parent->d_inode);
409         dentry = lookup_one_len(name, parent, strlen(name));
410         if (!IS_ERR(dentry) && dentry->d_inode) {
411                 dput(dentry);
412                 dentry = ERR_PTR(-EEXIST);
413         }
414
415         if (IS_ERR(dentry)) {
416                 inode_unlock(parent->d_inode);
417                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
418         }
419
420         return dentry;
421 }
422
423 static struct dentry *failed_creating(struct dentry *dentry)
424 {
425         inode_unlock(dentry->d_parent->d_inode);
426         dput(dentry);
427         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
428         return NULL;
429 }
430
431 static struct dentry *end_creating(struct dentry *dentry)
432 {
433         inode_unlock(dentry->d_parent->d_inode);
434         return dentry;
435 }
436
437 /**
438  * tracefs_create_file - create a file in the tracefs filesystem
439  * @name: a pointer to a string containing the name of the file to create.
440  * @mode: the permission that the file should have.
441  * @parent: a pointer to the parent dentry for this file.  This should be a
442  *          directory dentry if set.  If this parameter is NULL, then the
443  *          file will be created in the root of the tracefs filesystem.
444  * @data: a pointer to something that the caller will want to get to later
445  *        on.  The inode.i_private pointer will point to this value on
446  *        the open() call.
447  * @fops: a pointer to a struct file_operations that should be used for
448  *        this file.
449  *
450  * This is the basic "create a file" function for tracefs.  It allows for a
451  * wide range of flexibility in creating a file, or a directory (if you want
452  * to create a directory, the tracefs_create_dir() function is
453  * recommended to be used instead.)
454  *
455  * This function will return a pointer to a dentry if it succeeds.  This
456  * pointer must be passed to the tracefs_remove() function when the file is
457  * to be removed (no automatic cleanup happens if your module is unloaded,
458  * you are responsible here.)  If an error occurs, %NULL will be returned.
459  *
460  * If tracefs is not enabled in the kernel, the value -%ENODEV will be
461  * returned.
462  */
463 struct dentry *tracefs_create_file(const char *name, umode_t mode,
464                                    struct dentry *parent, void *data,
465                                    const struct file_operations *fops)
466 {
467         struct dentry *dentry;
468         struct inode *inode;
469
470         if (!(mode & S_IFMT))
471                 mode |= S_IFREG;
472         BUG_ON(!S_ISREG(mode));
473         dentry = start_creating(name, parent);
474
475         if (IS_ERR(dentry))
476                 return NULL;
477
478         inode = tracefs_get_inode(dentry->d_sb);
479         if (unlikely(!inode))
480                 return failed_creating(dentry);
481
482         inode->i_mode = mode;
483         inode->i_fop = fops ? fops : &tracefs_file_operations;
484         inode->i_private = data;
485         inode->i_uid = d_inode(dentry->d_parent)->i_uid;
486         inode->i_gid = d_inode(dentry->d_parent)->i_gid;
487         d_instantiate(dentry, inode);
488         fsnotify_create(dentry->d_parent->d_inode, dentry);
489         return end_creating(dentry);
490 }
491
492 static struct dentry *__create_dir(const char *name, struct dentry *parent,
493                                    const struct inode_operations *ops)
494 {
495         struct dentry *dentry = start_creating(name, parent);
496         struct inode *inode;
497
498         if (IS_ERR(dentry))
499                 return NULL;
500
501         inode = tracefs_get_inode(dentry->d_sb);
502         if (unlikely(!inode))
503                 return failed_creating(dentry);
504
505         /* Do not set bits for OTH */
506         inode->i_mode = S_IFDIR | S_IRWXU | S_IRUSR| S_IRGRP | S_IXUSR | S_IXGRP;
507         inode->i_op = ops;
508         inode->i_fop = &simple_dir_operations;
509         inode->i_uid = d_inode(dentry->d_parent)->i_uid;
510         inode->i_gid = d_inode(dentry->d_parent)->i_gid;
511
512         /* directory inodes start off with i_nlink == 2 (for "." entry) */
513         inc_nlink(inode);
514         d_instantiate(dentry, inode);
515         inc_nlink(dentry->d_parent->d_inode);
516         fsnotify_mkdir(dentry->d_parent->d_inode, dentry);
517         return end_creating(dentry);
518 }
519
520 /**
521  * tracefs_create_dir - create a directory in the tracefs filesystem
522  * @name: a pointer to a string containing the name of the directory to
523  *        create.
524  * @parent: a pointer to the parent dentry for this file.  This should be a
525  *          directory dentry if set.  If this parameter is NULL, then the
526  *          directory will be created in the root of the tracefs filesystem.
527  *
528  * This function creates a directory in tracefs with the given name.
529  *
530  * This function will return a pointer to a dentry if it succeeds.  This
531  * pointer must be passed to the tracefs_remove() function when the file is
532  * to be removed. If an error occurs, %NULL will be returned.
533  *
534  * If tracing is not enabled in the kernel, the value -%ENODEV will be
535  * returned.
536  */
537 struct dentry *tracefs_create_dir(const char *name, struct dentry *parent)
538 {
539         return __create_dir(name, parent, &simple_dir_inode_operations);
540 }
541
542 /**
543  * tracefs_create_instance_dir - create the tracing instances directory
544  * @name: The name of the instances directory to create
545  * @parent: The parent directory that the instances directory will exist
546  * @mkdir: The function to call when a mkdir is performed.
547  * @rmdir: The function to call when a rmdir is performed.
548  *
549  * Only one instances directory is allowed.
550  *
551  * The instances directory is special as it allows for mkdir and rmdir to
552  * to be done by userspace. When a mkdir or rmdir is performed, the inode
553  * locks are released and the methhods passed in (@mkdir and @rmdir) are
554  * called without locks and with the name of the directory being created
555  * within the instances directory.
556  *
557  * Returns the dentry of the instances directory.
558  */
559 struct dentry *tracefs_create_instance_dir(const char *name, struct dentry *parent,
560                                           int (*mkdir)(const char *name),
561                                           int (*rmdir)(const char *name))
562 {
563         struct dentry *dentry;
564
565         /* Only allow one instance of the instances directory. */
566         if (WARN_ON(tracefs_ops.mkdir || tracefs_ops.rmdir))
567                 return NULL;
568
569         dentry = __create_dir(name, parent, &tracefs_dir_inode_operations);
570         if (!dentry)
571                 return NULL;
572
573         tracefs_ops.mkdir = mkdir;
574         tracefs_ops.rmdir = rmdir;
575
576         return dentry;
577 }
578
579 static int __tracefs_remove(struct dentry *dentry, struct dentry *parent)
580 {
581         int ret = 0;
582
583         if (simple_positive(dentry)) {
584                 if (dentry->d_inode) {
585                         dget(dentry);
586                         switch (dentry->d_inode->i_mode & S_IFMT) {
587                         case S_IFDIR:
588                                 ret = simple_rmdir(parent->d_inode, dentry);
589                                 break;
590                         default:
591                                 simple_unlink(parent->d_inode, dentry);
592                                 break;
593                         }
594                         if (!ret)
595                                 d_delete(dentry);
596                         dput(dentry);
597                 }
598         }
599         return ret;
600 }
601
602 /**
603  * tracefs_remove - removes a file or directory from the tracefs filesystem
604  * @dentry: a pointer to a the dentry of the file or directory to be
605  *          removed.
606  *
607  * This function removes a file or directory in tracefs that was previously
608  * created with a call to another tracefs function (like
609  * tracefs_create_file() or variants thereof.)
610  */
611 void tracefs_remove(struct dentry *dentry)
612 {
613         struct dentry *parent;
614         int ret;
615
616         if (IS_ERR_OR_NULL(dentry))
617                 return;
618
619         parent = dentry->d_parent;
620         inode_lock(parent->d_inode);
621         ret = __tracefs_remove(dentry, parent);
622         inode_unlock(parent->d_inode);
623         if (!ret)
624                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
625 }
626
627 /**
628  * tracefs_remove_recursive - recursively removes a directory
629  * @dentry: a pointer to a the dentry of the directory to be removed.
630  *
631  * This function recursively removes a directory tree in tracefs that
632  * was previously created with a call to another tracefs function
633  * (like tracefs_create_file() or variants thereof.)
634  */
635 void tracefs_remove_recursive(struct dentry *dentry)
636 {
637         struct dentry *child, *parent;
638
639         if (IS_ERR_OR_NULL(dentry))
640                 return;
641
642         parent = dentry;
643  down:
644         inode_lock(parent->d_inode);
645  loop:
646         /*
647          * The parent->d_subdirs is protected by the d_lock. Outside that
648          * lock, the child can be unlinked and set to be freed which can
649          * use the d_u.d_child as the rcu head and corrupt this list.
650          */
651         spin_lock(&parent->d_lock);
652         list_for_each_entry(child, &parent->d_subdirs, d_child) {
653                 if (!simple_positive(child))
654                         continue;
655
656                 /* perhaps simple_empty(child) makes more sense */
657                 if (!list_empty(&child->d_subdirs)) {
658                         spin_unlock(&parent->d_lock);
659                         inode_unlock(parent->d_inode);
660                         parent = child;
661                         goto down;
662                 }
663
664                 spin_unlock(&parent->d_lock);
665
666                 if (!__tracefs_remove(child, parent))
667                         simple_release_fs(&tracefs_mount, &tracefs_mount_count);
668
669                 /*
670                  * The parent->d_lock protects agaist child from unlinking
671                  * from d_subdirs. When releasing the parent->d_lock we can
672                  * no longer trust that the next pointer is valid.
673                  * Restart the loop. We'll skip this one with the
674                  * simple_positive() check.
675                  */
676                 goto loop;
677         }
678         spin_unlock(&parent->d_lock);
679
680         inode_unlock(parent->d_inode);
681         child = parent;
682         parent = parent->d_parent;
683         inode_lock(parent->d_inode);
684
685         if (child != dentry)
686                 /* go up */
687                 goto loop;
688
689         if (!__tracefs_remove(child, parent))
690                 simple_release_fs(&tracefs_mount, &tracefs_mount_count);
691         inode_unlock(parent->d_inode);
692 }
693
694 /**
695  * tracefs_initialized - Tells whether tracefs has been registered
696  */
697 bool tracefs_initialized(void)
698 {
699         return tracefs_registered;
700 }
701
702 static int __init tracefs_init(void)
703 {
704         int retval;
705
706         retval = sysfs_create_mount_point(kernel_kobj, "tracing");
707         if (retval)
708                 return -EINVAL;
709
710         retval = register_filesystem(&trace_fs_type);
711         if (!retval)
712                 tracefs_registered = true;
713
714         return retval;
715 }
716 core_initcall(tracefs_init);