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