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