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