xref: /openbmc/linux/fs/tracefs/inode.c (revision e5104cbb)
1d2912cb1SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
24282d606SSteven Rostedt (Red Hat) /*
34282d606SSteven Rostedt (Red Hat)  *  inode.c - part of tracefs, a pseudo file system for activating tracing
44282d606SSteven Rostedt (Red Hat)  *
54282d606SSteven Rostedt (Red Hat)  * Based on debugfs by: Greg Kroah-Hartman <greg@kroah.com>
64282d606SSteven Rostedt (Red Hat)  *
74282d606SSteven Rostedt (Red Hat)  *  Copyright (C) 2014 Red Hat Inc, author: Steven Rostedt <srostedt@redhat.com>
84282d606SSteven Rostedt (Red Hat)  *
94282d606SSteven Rostedt (Red Hat)  * tracefs is the file system that is used by the tracing infrastructure.
104282d606SSteven Rostedt (Red Hat)  */
114282d606SSteven Rostedt (Red Hat) 
124282d606SSteven Rostedt (Red Hat) #include <linux/module.h>
134282d606SSteven Rostedt (Red Hat) #include <linux/fs.h>
144282d606SSteven Rostedt (Red Hat) #include <linux/mount.h>
15cc31004aSSteven Rostedt (Red Hat) #include <linux/kobject.h>
164282d606SSteven Rostedt (Red Hat) #include <linux/namei.h>
174282d606SSteven Rostedt (Red Hat) #include <linux/tracefs.h>
184282d606SSteven Rostedt (Red Hat) #include <linux/fsnotify.h>
19bf8e6021SSteven Rostedt (VMware) #include <linux/security.h>
204282d606SSteven Rostedt (Red Hat) #include <linux/seq_file.h>
214282d606SSteven Rostedt (Red Hat) #include <linux/parser.h>
224282d606SSteven Rostedt (Red Hat) #include <linux/magic.h>
234282d606SSteven Rostedt (Red Hat) #include <linux/slab.h>
24ba37ff75SAjay Kaher #include "internal.h"
254282d606SSteven Rostedt (Red Hat) 
264282d606SSteven Rostedt (Red Hat) #define TRACEFS_DEFAULT_MODE	0700
27ba37ff75SAjay Kaher static struct kmem_cache *tracefs_inode_cachep __ro_after_init;
284282d606SSteven Rostedt (Red Hat) 
294282d606SSteven Rostedt (Red Hat) static struct vfsmount *tracefs_mount;
304282d606SSteven Rostedt (Red Hat) static int tracefs_mount_count;
314282d606SSteven Rostedt (Red Hat) static bool tracefs_registered;
324282d606SSteven Rostedt (Red Hat) 
335f91fc82SSteven Rostedt (Google) /*
345f91fc82SSteven Rostedt (Google)  * Keep track of all tracefs_inodes in order to update their
355f91fc82SSteven Rostedt (Google)  * flags if necessary on a remount.
365f91fc82SSteven Rostedt (Google)  */
375f91fc82SSteven Rostedt (Google) static DEFINE_SPINLOCK(tracefs_inode_lock);
385f91fc82SSteven Rostedt (Google) static LIST_HEAD(tracefs_inodes);
395f91fc82SSteven Rostedt (Google) 
tracefs_alloc_inode(struct super_block * sb)40ba37ff75SAjay Kaher static struct inode *tracefs_alloc_inode(struct super_block *sb)
41ba37ff75SAjay Kaher {
42ba37ff75SAjay Kaher 	struct tracefs_inode *ti;
435f91fc82SSteven Rostedt (Google) 	unsigned long flags;
44ba37ff75SAjay Kaher 
45ba37ff75SAjay Kaher 	ti = kmem_cache_alloc(tracefs_inode_cachep, GFP_KERNEL);
46ba37ff75SAjay Kaher 	if (!ti)
47ba37ff75SAjay Kaher 		return NULL;
48ba37ff75SAjay Kaher 
495f91fc82SSteven Rostedt (Google) 	spin_lock_irqsave(&tracefs_inode_lock, flags);
505f91fc82SSteven Rostedt (Google) 	list_add_rcu(&ti->list, &tracefs_inodes);
515f91fc82SSteven Rostedt (Google) 	spin_unlock_irqrestore(&tracefs_inode_lock, flags);
525f91fc82SSteven Rostedt (Google) 
53ba37ff75SAjay Kaher 	return &ti->vfs_inode;
54ba37ff75SAjay Kaher }
55ba37ff75SAjay Kaher 
tracefs_free_inode_rcu(struct rcu_head * rcu)565f91fc82SSteven Rostedt (Google) static void tracefs_free_inode_rcu(struct rcu_head *rcu)
575f91fc82SSteven Rostedt (Google) {
585f91fc82SSteven Rostedt (Google) 	struct tracefs_inode *ti;
595f91fc82SSteven Rostedt (Google) 
605f91fc82SSteven Rostedt (Google) 	ti = container_of(rcu, struct tracefs_inode, rcu);
615f91fc82SSteven Rostedt (Google) 	kmem_cache_free(tracefs_inode_cachep, ti);
625f91fc82SSteven Rostedt (Google) }
635f91fc82SSteven Rostedt (Google) 
tracefs_free_inode(struct inode * inode)64ba37ff75SAjay Kaher static void tracefs_free_inode(struct inode *inode)
65ba37ff75SAjay Kaher {
665f91fc82SSteven Rostedt (Google) 	struct tracefs_inode *ti = get_tracefs(inode);
675f91fc82SSteven Rostedt (Google) 	unsigned long flags;
685f91fc82SSteven Rostedt (Google) 
695f91fc82SSteven Rostedt (Google) 	spin_lock_irqsave(&tracefs_inode_lock, flags);
705f91fc82SSteven Rostedt (Google) 	list_del_rcu(&ti->list);
715f91fc82SSteven Rostedt (Google) 	spin_unlock_irqrestore(&tracefs_inode_lock, flags);
725f91fc82SSteven Rostedt (Google) 
735f91fc82SSteven Rostedt (Google) 	call_rcu(&ti->rcu, tracefs_free_inode_rcu);
74ba37ff75SAjay Kaher }
75ba37ff75SAjay Kaher 
default_read_file(struct file * file,char __user * buf,size_t count,loff_t * ppos)764282d606SSteven Rostedt (Red Hat) static ssize_t default_read_file(struct file *file, char __user *buf,
774282d606SSteven Rostedt (Red Hat) 				 size_t count, loff_t *ppos)
784282d606SSteven Rostedt (Red Hat) {
794282d606SSteven Rostedt (Red Hat) 	return 0;
804282d606SSteven Rostedt (Red Hat) }
814282d606SSteven Rostedt (Red Hat) 
default_write_file(struct file * file,const char __user * buf,size_t count,loff_t * ppos)824282d606SSteven Rostedt (Red Hat) static ssize_t default_write_file(struct file *file, const char __user *buf,
834282d606SSteven Rostedt (Red Hat) 				   size_t count, loff_t *ppos)
844282d606SSteven Rostedt (Red Hat) {
854282d606SSteven Rostedt (Red Hat) 	return count;
864282d606SSteven Rostedt (Red Hat) }
874282d606SSteven Rostedt (Red Hat) 
884282d606SSteven Rostedt (Red Hat) static const struct file_operations tracefs_file_operations = {
894282d606SSteven Rostedt (Red Hat) 	.read =		default_read_file,
904282d606SSteven Rostedt (Red Hat) 	.write =	default_write_file,
914282d606SSteven Rostedt (Red Hat) 	.open =		simple_open,
924282d606SSteven Rostedt (Red Hat) 	.llseek =	noop_llseek,
934282d606SSteven Rostedt (Red Hat) };
944282d606SSteven Rostedt (Red Hat) 
95eae47358SSteven Rostedt (Red Hat) static struct tracefs_dir_ops {
96eae47358SSteven Rostedt (Red Hat) 	int (*mkdir)(const char *name);
97eae47358SSteven Rostedt (Red Hat) 	int (*rmdir)(const char *name);
985248ee85SZubin Mithra } tracefs_ops __ro_after_init;
99eae47358SSteven Rostedt (Red Hat) 
get_dname(struct dentry * dentry)100eae47358SSteven Rostedt (Red Hat) static char *get_dname(struct dentry *dentry)
101eae47358SSteven Rostedt (Red Hat) {
102eae47358SSteven Rostedt (Red Hat) 	const char *dname;
103eae47358SSteven Rostedt (Red Hat) 	char *name;
104eae47358SSteven Rostedt (Red Hat) 	int len = dentry->d_name.len;
105eae47358SSteven Rostedt (Red Hat) 
106eae47358SSteven Rostedt (Red Hat) 	dname = dentry->d_name.name;
107eae47358SSteven Rostedt (Red Hat) 	name = kmalloc(len + 1, GFP_KERNEL);
108eae47358SSteven Rostedt (Red Hat) 	if (!name)
109eae47358SSteven Rostedt (Red Hat) 		return NULL;
110eae47358SSteven Rostedt (Red Hat) 	memcpy(name, dname, len);
111eae47358SSteven Rostedt (Red Hat) 	name[len] = 0;
112eae47358SSteven Rostedt (Red Hat) 	return name;
113eae47358SSteven Rostedt (Red Hat) }
114eae47358SSteven Rostedt (Red Hat) 
tracefs_syscall_mkdir(struct mnt_idmap * idmap,struct inode * inode,struct dentry * dentry,umode_t mode)115c54bd91eSChristian Brauner static int tracefs_syscall_mkdir(struct mnt_idmap *idmap,
116549c7297SChristian Brauner 				 struct inode *inode, struct dentry *dentry,
117549c7297SChristian Brauner 				 umode_t mode)
118eae47358SSteven Rostedt (Red Hat) {
119628adb84SSteven Rostedt (Google) 	struct tracefs_inode *ti;
120eae47358SSteven Rostedt (Red Hat) 	char *name;
121eae47358SSteven Rostedt (Red Hat) 	int ret;
122eae47358SSteven Rostedt (Red Hat) 
123eae47358SSteven Rostedt (Red Hat) 	name = get_dname(dentry);
124eae47358SSteven Rostedt (Red Hat) 	if (!name)
125eae47358SSteven Rostedt (Red Hat) 		return -ENOMEM;
126eae47358SSteven Rostedt (Red Hat) 
127eae47358SSteven Rostedt (Red Hat) 	/*
128628adb84SSteven Rostedt (Google) 	 * This is a new directory that does not take the default of
129628adb84SSteven Rostedt (Google) 	 * the rootfs. It becomes the default permissions for all the
130628adb84SSteven Rostedt (Google) 	 * files and directories underneath it.
131628adb84SSteven Rostedt (Google) 	 */
132628adb84SSteven Rostedt (Google) 	ti = get_tracefs(inode);
133628adb84SSteven Rostedt (Google) 	ti->flags |= TRACEFS_INSTANCE_INODE;
134628adb84SSteven Rostedt (Google) 	ti->private = inode;
135628adb84SSteven Rostedt (Google) 
136628adb84SSteven Rostedt (Google) 	/*
137eae47358SSteven Rostedt (Red Hat) 	 * The mkdir call can call the generic functions that create
138eae47358SSteven Rostedt (Red Hat) 	 * the files within the tracefs system. It is up to the individual
139eae47358SSteven Rostedt (Red Hat) 	 * mkdir routine to handle races.
140eae47358SSteven Rostedt (Red Hat) 	 */
1415955102cSAl Viro 	inode_unlock(inode);
142eae47358SSteven Rostedt (Red Hat) 	ret = tracefs_ops.mkdir(name);
1435955102cSAl Viro 	inode_lock(inode);
144eae47358SSteven Rostedt (Red Hat) 
145eae47358SSteven Rostedt (Red Hat) 	kfree(name);
146eae47358SSteven Rostedt (Red Hat) 
147eae47358SSteven Rostedt (Red Hat) 	return ret;
148eae47358SSteven Rostedt (Red Hat) }
149eae47358SSteven Rostedt (Red Hat) 
tracefs_syscall_rmdir(struct inode * inode,struct dentry * dentry)150eae47358SSteven Rostedt (Red Hat) static int tracefs_syscall_rmdir(struct inode *inode, struct dentry *dentry)
151eae47358SSteven Rostedt (Red Hat) {
152eae47358SSteven Rostedt (Red Hat) 	char *name;
153eae47358SSteven Rostedt (Red Hat) 	int ret;
154eae47358SSteven Rostedt (Red Hat) 
155eae47358SSteven Rostedt (Red Hat) 	name = get_dname(dentry);
156eae47358SSteven Rostedt (Red Hat) 	if (!name)
157eae47358SSteven Rostedt (Red Hat) 		return -ENOMEM;
158eae47358SSteven Rostedt (Red Hat) 
159eae47358SSteven Rostedt (Red Hat) 	/*
160eae47358SSteven Rostedt (Red Hat) 	 * The rmdir call can call the generic functions that create
161eae47358SSteven Rostedt (Red Hat) 	 * the files within the tracefs system. It is up to the individual
162eae47358SSteven Rostedt (Red Hat) 	 * rmdir routine to handle races.
163eae47358SSteven Rostedt (Red Hat) 	 * This time we need to unlock not only the parent (inode) but
164eae47358SSteven Rostedt (Red Hat) 	 * also the directory that is being deleted.
165eae47358SSteven Rostedt (Red Hat) 	 */
1665955102cSAl Viro 	inode_unlock(inode);
167ee34c52cSSteven Rostedt (VMware) 	inode_unlock(d_inode(dentry));
168eae47358SSteven Rostedt (Red Hat) 
169eae47358SSteven Rostedt (Red Hat) 	ret = tracefs_ops.rmdir(name);
170eae47358SSteven Rostedt (Red Hat) 
1715955102cSAl Viro 	inode_lock_nested(inode, I_MUTEX_PARENT);
172ee34c52cSSteven Rostedt (VMware) 	inode_lock(d_inode(dentry));
173eae47358SSteven Rostedt (Red Hat) 
174eae47358SSteven Rostedt (Red Hat) 	kfree(name);
175eae47358SSteven Rostedt (Red Hat) 
176eae47358SSteven Rostedt (Red Hat) 	return ret;
177eae47358SSteven Rostedt (Red Hat) }
178eae47358SSteven Rostedt (Red Hat) 
set_tracefs_inode_owner(struct inode * inode)179628adb84SSteven Rostedt (Google) static void set_tracefs_inode_owner(struct inode *inode)
180628adb84SSteven Rostedt (Google) {
181628adb84SSteven Rostedt (Google) 	struct tracefs_inode *ti = get_tracefs(inode);
182628adb84SSteven Rostedt (Google) 	struct inode *root_inode = ti->private;
1830c56915cSSteven Rostedt (Google) 	kuid_t uid;
1840c56915cSSteven Rostedt (Google) 	kgid_t gid;
1850c56915cSSteven Rostedt (Google) 
1860c56915cSSteven Rostedt (Google) 	uid = root_inode->i_uid;
1870c56915cSSteven Rostedt (Google) 	gid = root_inode->i_gid;
1880c56915cSSteven Rostedt (Google) 
1890c56915cSSteven Rostedt (Google) 	/*
1900c56915cSSteven Rostedt (Google) 	 * If the root is not the mount point, then check the root's
1910c56915cSSteven Rostedt (Google) 	 * permissions. If it was never set, then default to the
1920c56915cSSteven Rostedt (Google) 	 * mount point.
1930c56915cSSteven Rostedt (Google) 	 */
1940c56915cSSteven Rostedt (Google) 	if (root_inode != d_inode(root_inode->i_sb->s_root)) {
1950c56915cSSteven Rostedt (Google) 		struct tracefs_inode *rti;
1960c56915cSSteven Rostedt (Google) 
1970c56915cSSteven Rostedt (Google) 		rti = get_tracefs(root_inode);
1980c56915cSSteven Rostedt (Google) 		root_inode = d_inode(root_inode->i_sb->s_root);
1990c56915cSSteven Rostedt (Google) 
2000c56915cSSteven Rostedt (Google) 		if (!(rti->flags & TRACEFS_UID_PERM_SET))
2010c56915cSSteven Rostedt (Google) 			uid = root_inode->i_uid;
2020c56915cSSteven Rostedt (Google) 
2030c56915cSSteven Rostedt (Google) 		if (!(rti->flags & TRACEFS_GID_PERM_SET))
2040c56915cSSteven Rostedt (Google) 			gid = root_inode->i_gid;
2050c56915cSSteven Rostedt (Google) 	}
206628adb84SSteven Rostedt (Google) 
207628adb84SSteven Rostedt (Google) 	/*
208628adb84SSteven Rostedt (Google) 	 * If this inode has never been referenced, then update
209628adb84SSteven Rostedt (Google) 	 * the permissions to the superblock.
210628adb84SSteven Rostedt (Google) 	 */
211628adb84SSteven Rostedt (Google) 	if (!(ti->flags & TRACEFS_UID_PERM_SET))
2120c56915cSSteven Rostedt (Google) 		inode->i_uid = uid;
213628adb84SSteven Rostedt (Google) 
214628adb84SSteven Rostedt (Google) 	if (!(ti->flags & TRACEFS_GID_PERM_SET))
2150c56915cSSteven Rostedt (Google) 		inode->i_gid = gid;
216628adb84SSteven Rostedt (Google) }
217628adb84SSteven Rostedt (Google) 
tracefs_permission(struct mnt_idmap * idmap,struct inode * inode,int mask)218628adb84SSteven Rostedt (Google) static int tracefs_permission(struct mnt_idmap *idmap,
219628adb84SSteven Rostedt (Google) 			      struct inode *inode, int mask)
220628adb84SSteven Rostedt (Google) {
221628adb84SSteven Rostedt (Google) 	set_tracefs_inode_owner(inode);
222628adb84SSteven Rostedt (Google) 	return generic_permission(idmap, inode, mask);
223628adb84SSteven Rostedt (Google) }
224628adb84SSteven Rostedt (Google) 
tracefs_getattr(struct mnt_idmap * idmap,const struct path * path,struct kstat * stat,u32 request_mask,unsigned int flags)225628adb84SSteven Rostedt (Google) static int tracefs_getattr(struct mnt_idmap *idmap,
226628adb84SSteven Rostedt (Google) 			   const struct path *path, struct kstat *stat,
227628adb84SSteven Rostedt (Google) 			   u32 request_mask, unsigned int flags)
228628adb84SSteven Rostedt (Google) {
229628adb84SSteven Rostedt (Google) 	struct inode *inode = d_backing_inode(path->dentry);
230628adb84SSteven Rostedt (Google) 
231628adb84SSteven Rostedt (Google) 	set_tracefs_inode_owner(inode);
232628adb84SSteven Rostedt (Google) 	generic_fillattr(idmap, request_mask, inode, stat);
233628adb84SSteven Rostedt (Google) 	return 0;
234628adb84SSteven Rostedt (Google) }
235628adb84SSteven Rostedt (Google) 
tracefs_setattr(struct mnt_idmap * idmap,struct dentry * dentry,struct iattr * attr)236628adb84SSteven Rostedt (Google) static int tracefs_setattr(struct mnt_idmap *idmap, struct dentry *dentry,
237628adb84SSteven Rostedt (Google) 			   struct iattr *attr)
238628adb84SSteven Rostedt (Google) {
239628adb84SSteven Rostedt (Google) 	unsigned int ia_valid = attr->ia_valid;
240628adb84SSteven Rostedt (Google) 	struct inode *inode = d_inode(dentry);
241628adb84SSteven Rostedt (Google) 	struct tracefs_inode *ti = get_tracefs(inode);
242628adb84SSteven Rostedt (Google) 
243628adb84SSteven Rostedt (Google) 	if (ia_valid & ATTR_UID)
244628adb84SSteven Rostedt (Google) 		ti->flags |= TRACEFS_UID_PERM_SET;
245628adb84SSteven Rostedt (Google) 
246628adb84SSteven Rostedt (Google) 	if (ia_valid & ATTR_GID)
247628adb84SSteven Rostedt (Google) 		ti->flags |= TRACEFS_GID_PERM_SET;
248628adb84SSteven Rostedt (Google) 
249628adb84SSteven Rostedt (Google) 	return simple_setattr(idmap, dentry, attr);
250628adb84SSteven Rostedt (Google) }
251628adb84SSteven Rostedt (Google) 
252628adb84SSteven Rostedt (Google) static const struct inode_operations tracefs_instance_dir_inode_operations = {
253eae47358SSteven Rostedt (Red Hat) 	.lookup		= simple_lookup,
254eae47358SSteven Rostedt (Red Hat) 	.mkdir		= tracefs_syscall_mkdir,
255eae47358SSteven Rostedt (Red Hat) 	.rmdir		= tracefs_syscall_rmdir,
256628adb84SSteven Rostedt (Google) 	.permission	= tracefs_permission,
257628adb84SSteven Rostedt (Google) 	.getattr	= tracefs_getattr,
258628adb84SSteven Rostedt (Google) 	.setattr	= tracefs_setattr,
259628adb84SSteven Rostedt (Google) };
260628adb84SSteven Rostedt (Google) 
261628adb84SSteven Rostedt (Google) static const struct inode_operations tracefs_dir_inode_operations = {
262628adb84SSteven Rostedt (Google) 	.lookup		= simple_lookup,
263628adb84SSteven Rostedt (Google) 	.permission	= tracefs_permission,
264628adb84SSteven Rostedt (Google) 	.getattr	= tracefs_getattr,
265628adb84SSteven Rostedt (Google) 	.setattr	= tracefs_setattr,
266628adb84SSteven Rostedt (Google) };
267628adb84SSteven Rostedt (Google) 
268628adb84SSteven Rostedt (Google) static const struct inode_operations tracefs_file_inode_operations = {
269628adb84SSteven Rostedt (Google) 	.permission	= tracefs_permission,
270628adb84SSteven Rostedt (Google) 	.getattr	= tracefs_getattr,
271628adb84SSteven Rostedt (Google) 	.setattr	= tracefs_setattr,
272eae47358SSteven Rostedt (Red Hat) };
273eae47358SSteven Rostedt (Red Hat) 
tracefs_get_inode(struct super_block * sb)2742c6b6b10SAjay Kaher struct inode *tracefs_get_inode(struct super_block *sb)
2754282d606SSteven Rostedt (Red Hat) {
2764282d606SSteven Rostedt (Red Hat) 	struct inode *inode = new_inode(sb);
2774282d606SSteven Rostedt (Red Hat) 	if (inode) {
2784282d606SSteven Rostedt (Red Hat) 		inode->i_ino = get_next_ino();
279bb9c40e6SJeff Layton 		inode->i_atime = inode->i_mtime = inode_set_ctime_current(inode);
2804282d606SSteven Rostedt (Red Hat) 	}
2814282d606SSteven Rostedt (Red Hat) 	return inode;
2824282d606SSteven Rostedt (Red Hat) }
2834282d606SSteven Rostedt (Red Hat) 
2844282d606SSteven Rostedt (Red Hat) struct tracefs_mount_opts {
2854282d606SSteven Rostedt (Red Hat) 	kuid_t uid;
2864282d606SSteven Rostedt (Red Hat) 	kgid_t gid;
2874282d606SSteven Rostedt (Red Hat) 	umode_t mode;
28847311db8SBrian Norris 	/* Opt_* bitfield. */
28947311db8SBrian Norris 	unsigned int opts;
2904282d606SSteven Rostedt (Red Hat) };
2914282d606SSteven Rostedt (Red Hat) 
2924282d606SSteven Rostedt (Red Hat) enum {
2934282d606SSteven Rostedt (Red Hat) 	Opt_uid,
2944282d606SSteven Rostedt (Red Hat) 	Opt_gid,
2954282d606SSteven Rostedt (Red Hat) 	Opt_mode,
2964282d606SSteven Rostedt (Red Hat) 	Opt_err
2974282d606SSteven Rostedt (Red Hat) };
2984282d606SSteven Rostedt (Red Hat) 
2994282d606SSteven Rostedt (Red Hat) static const match_table_t tokens = {
3004282d606SSteven Rostedt (Red Hat) 	{Opt_uid, "uid=%u"},
3014282d606SSteven Rostedt (Red Hat) 	{Opt_gid, "gid=%u"},
3024282d606SSteven Rostedt (Red Hat) 	{Opt_mode, "mode=%o"},
3034282d606SSteven Rostedt (Red Hat) 	{Opt_err, NULL}
3044282d606SSteven Rostedt (Red Hat) };
3054282d606SSteven Rostedt (Red Hat) 
3064282d606SSteven Rostedt (Red Hat) struct tracefs_fs_info {
3074282d606SSteven Rostedt (Red Hat) 	struct tracefs_mount_opts mount_opts;
3084282d606SSteven Rostedt (Red Hat) };
3094282d606SSteven Rostedt (Red Hat) 
tracefs_parse_options(char * data,struct tracefs_mount_opts * opts)3104282d606SSteven Rostedt (Red Hat) static int tracefs_parse_options(char *data, struct tracefs_mount_opts *opts)
3114282d606SSteven Rostedt (Red Hat) {
3124282d606SSteven Rostedt (Red Hat) 	substring_t args[MAX_OPT_ARGS];
3134282d606SSteven Rostedt (Red Hat) 	int option;
3144282d606SSteven Rostedt (Red Hat) 	int token;
3154282d606SSteven Rostedt (Red Hat) 	kuid_t uid;
3164282d606SSteven Rostedt (Red Hat) 	kgid_t gid;
3174282d606SSteven Rostedt (Red Hat) 	char *p;
3184282d606SSteven Rostedt (Red Hat) 
31947311db8SBrian Norris 	opts->opts = 0;
3204282d606SSteven Rostedt (Red Hat) 	opts->mode = TRACEFS_DEFAULT_MODE;
3214282d606SSteven Rostedt (Red Hat) 
3224282d606SSteven Rostedt (Red Hat) 	while ((p = strsep(&data, ",")) != NULL) {
3234282d606SSteven Rostedt (Red Hat) 		if (!*p)
3244282d606SSteven Rostedt (Red Hat) 			continue;
3254282d606SSteven Rostedt (Red Hat) 
3264282d606SSteven Rostedt (Red Hat) 		token = match_token(p, tokens, args);
3274282d606SSteven Rostedt (Red Hat) 		switch (token) {
3284282d606SSteven Rostedt (Red Hat) 		case Opt_uid:
3294282d606SSteven Rostedt (Red Hat) 			if (match_int(&args[0], &option))
3304282d606SSteven Rostedt (Red Hat) 				return -EINVAL;
3314282d606SSteven Rostedt (Red Hat) 			uid = make_kuid(current_user_ns(), option);
3324282d606SSteven Rostedt (Red Hat) 			if (!uid_valid(uid))
3334282d606SSteven Rostedt (Red Hat) 				return -EINVAL;
3344282d606SSteven Rostedt (Red Hat) 			opts->uid = uid;
3354282d606SSteven Rostedt (Red Hat) 			break;
3364282d606SSteven Rostedt (Red Hat) 		case Opt_gid:
3374282d606SSteven Rostedt (Red Hat) 			if (match_int(&args[0], &option))
3384282d606SSteven Rostedt (Red Hat) 				return -EINVAL;
3394282d606SSteven Rostedt (Red Hat) 			gid = make_kgid(current_user_ns(), option);
3404282d606SSteven Rostedt (Red Hat) 			if (!gid_valid(gid))
3414282d606SSteven Rostedt (Red Hat) 				return -EINVAL;
3424282d606SSteven Rostedt (Red Hat) 			opts->gid = gid;
3434282d606SSteven Rostedt (Red Hat) 			break;
3444282d606SSteven Rostedt (Red Hat) 		case Opt_mode:
3454282d606SSteven Rostedt (Red Hat) 			if (match_octal(&args[0], &option))
3464282d606SSteven Rostedt (Red Hat) 				return -EINVAL;
3474282d606SSteven Rostedt (Red Hat) 			opts->mode = option & S_IALLUGO;
3484282d606SSteven Rostedt (Red Hat) 			break;
3494282d606SSteven Rostedt (Red Hat) 		/*
3504282d606SSteven Rostedt (Red Hat) 		 * We might like to report bad mount options here;
3514282d606SSteven Rostedt (Red Hat) 		 * but traditionally tracefs has ignored all mount options
3524282d606SSteven Rostedt (Red Hat) 		 */
3534282d606SSteven Rostedt (Red Hat) 		}
35447311db8SBrian Norris 
35547311db8SBrian Norris 		opts->opts |= BIT(token);
3564282d606SSteven Rostedt (Red Hat) 	}
3574282d606SSteven Rostedt (Red Hat) 
3584282d606SSteven Rostedt (Red Hat) 	return 0;
3594282d606SSteven Rostedt (Red Hat) }
3604282d606SSteven Rostedt (Red Hat) 
tracefs_apply_options(struct super_block * sb,bool remount)36147311db8SBrian Norris static int tracefs_apply_options(struct super_block *sb, bool remount)
3624282d606SSteven Rostedt (Red Hat) {
3634282d606SSteven Rostedt (Red Hat) 	struct tracefs_fs_info *fsi = sb->s_fs_info;
364ee34c52cSSteven Rostedt (VMware) 	struct inode *inode = d_inode(sb->s_root);
3654282d606SSteven Rostedt (Red Hat) 	struct tracefs_mount_opts *opts = &fsi->mount_opts;
3665f91fc82SSteven Rostedt (Google) 	struct tracefs_inode *ti;
3675f91fc82SSteven Rostedt (Google) 	bool update_uid, update_gid;
36808662977SSishuai Gong 	umode_t tmp_mode;
3694282d606SSteven Rostedt (Red Hat) 
37047311db8SBrian Norris 	/*
37147311db8SBrian Norris 	 * On remount, only reset mode/uid/gid if they were provided as mount
37247311db8SBrian Norris 	 * options.
37347311db8SBrian Norris 	 */
37447311db8SBrian Norris 
37547311db8SBrian Norris 	if (!remount || opts->opts & BIT(Opt_mode)) {
37608662977SSishuai Gong 		tmp_mode = READ_ONCE(inode->i_mode) & ~S_IALLUGO;
37708662977SSishuai Gong 		tmp_mode |= opts->mode;
37808662977SSishuai Gong 		WRITE_ONCE(inode->i_mode, tmp_mode);
37947311db8SBrian Norris 	}
3804282d606SSteven Rostedt (Red Hat) 
38147311db8SBrian Norris 	if (!remount || opts->opts & BIT(Opt_uid))
3824282d606SSteven Rostedt (Red Hat) 		inode->i_uid = opts->uid;
383851e99ebSSteven Rostedt (Google) 
384628adb84SSteven Rostedt (Google) 	if (!remount || opts->opts & BIT(Opt_gid))
385628adb84SSteven Rostedt (Google) 		inode->i_gid = opts->gid;
3864282d606SSteven Rostedt (Red Hat) 
3875f91fc82SSteven Rostedt (Google) 	if (remount && (opts->opts & BIT(Opt_uid) || opts->opts & BIT(Opt_gid))) {
3885f91fc82SSteven Rostedt (Google) 
3895f91fc82SSteven Rostedt (Google) 		update_uid = opts->opts & BIT(Opt_uid);
3905f91fc82SSteven Rostedt (Google) 		update_gid = opts->opts & BIT(Opt_gid);
3915f91fc82SSteven Rostedt (Google) 
3925f91fc82SSteven Rostedt (Google) 		rcu_read_lock();
3935f91fc82SSteven Rostedt (Google) 		list_for_each_entry_rcu(ti, &tracefs_inodes, list) {
3945f91fc82SSteven Rostedt (Google) 			if (update_uid)
3955f91fc82SSteven Rostedt (Google) 				ti->flags &= ~TRACEFS_UID_PERM_SET;
3965f91fc82SSteven Rostedt (Google) 
3975f91fc82SSteven Rostedt (Google) 			if (update_gid)
3985f91fc82SSteven Rostedt (Google) 				ti->flags &= ~TRACEFS_GID_PERM_SET;
3995f91fc82SSteven Rostedt (Google) 
4005f91fc82SSteven Rostedt (Google) 			if (ti->flags & TRACEFS_EVENT_INODE)
4015f91fc82SSteven Rostedt (Google) 				eventfs_remount(ti, update_uid, update_gid);
4025f91fc82SSteven Rostedt (Google) 		}
4035f91fc82SSteven Rostedt (Google) 		rcu_read_unlock();
4045f91fc82SSteven Rostedt (Google) 	}
4055f91fc82SSteven Rostedt (Google) 
4064282d606SSteven Rostedt (Red Hat) 	return 0;
4074282d606SSteven Rostedt (Red Hat) }
4084282d606SSteven Rostedt (Red Hat) 
tracefs_remount(struct super_block * sb,int * flags,char * data)4094282d606SSteven Rostedt (Red Hat) static int tracefs_remount(struct super_block *sb, int *flags, char *data)
4104282d606SSteven Rostedt (Red Hat) {
4114282d606SSteven Rostedt (Red Hat) 	int err;
4124282d606SSteven Rostedt (Red Hat) 	struct tracefs_fs_info *fsi = sb->s_fs_info;
4134282d606SSteven Rostedt (Red Hat) 
4144282d606SSteven Rostedt (Red Hat) 	sync_filesystem(sb);
4154282d606SSteven Rostedt (Red Hat) 	err = tracefs_parse_options(data, &fsi->mount_opts);
4164282d606SSteven Rostedt (Red Hat) 	if (err)
4174282d606SSteven Rostedt (Red Hat) 		goto fail;
4184282d606SSteven Rostedt (Red Hat) 
41947311db8SBrian Norris 	tracefs_apply_options(sb, true);
4204282d606SSteven Rostedt (Red Hat) 
4214282d606SSteven Rostedt (Red Hat) fail:
4224282d606SSteven Rostedt (Red Hat) 	return err;
4234282d606SSteven Rostedt (Red Hat) }
4244282d606SSteven Rostedt (Red Hat) 
tracefs_show_options(struct seq_file * m,struct dentry * root)4254282d606SSteven Rostedt (Red Hat) static int tracefs_show_options(struct seq_file *m, struct dentry *root)
4264282d606SSteven Rostedt (Red Hat) {
4274282d606SSteven Rostedt (Red Hat) 	struct tracefs_fs_info *fsi = root->d_sb->s_fs_info;
4284282d606SSteven Rostedt (Red Hat) 	struct tracefs_mount_opts *opts = &fsi->mount_opts;
4294282d606SSteven Rostedt (Red Hat) 
4304282d606SSteven Rostedt (Red Hat) 	if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
4314282d606SSteven Rostedt (Red Hat) 		seq_printf(m, ",uid=%u",
4324282d606SSteven Rostedt (Red Hat) 			   from_kuid_munged(&init_user_ns, opts->uid));
4334282d606SSteven Rostedt (Red Hat) 	if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
4344282d606SSteven Rostedt (Red Hat) 		seq_printf(m, ",gid=%u",
4354282d606SSteven Rostedt (Red Hat) 			   from_kgid_munged(&init_user_ns, opts->gid));
4364282d606SSteven Rostedt (Red Hat) 	if (opts->mode != TRACEFS_DEFAULT_MODE)
4374282d606SSteven Rostedt (Red Hat) 		seq_printf(m, ",mode=%o", opts->mode);
4384282d606SSteven Rostedt (Red Hat) 
4394282d606SSteven Rostedt (Red Hat) 	return 0;
4404282d606SSteven Rostedt (Red Hat) }
4414282d606SSteven Rostedt (Red Hat) 
tracefs_drop_inode(struct inode * inode)442e5104cbbSSteven Rostedt (Google) static int tracefs_drop_inode(struct inode *inode)
443e5104cbbSSteven Rostedt (Google) {
444e5104cbbSSteven Rostedt (Google) 	struct tracefs_inode *ti = get_tracefs(inode);
445e5104cbbSSteven Rostedt (Google) 
446e5104cbbSSteven Rostedt (Google) 	/*
447e5104cbbSSteven Rostedt (Google) 	 * This inode is being freed and cannot be used for
448e5104cbbSSteven Rostedt (Google) 	 * eventfs. Clear the flag so that it doesn't call into
449e5104cbbSSteven Rostedt (Google) 	 * eventfs during the remount flag updates. The eventfs_inode
450e5104cbbSSteven Rostedt (Google) 	 * gets freed after an RCU cycle, so the content will still
451e5104cbbSSteven Rostedt (Google) 	 * be safe if the iteration is going on now.
452e5104cbbSSteven Rostedt (Google) 	 */
453e5104cbbSSteven Rostedt (Google) 	ti->flags &= ~TRACEFS_EVENT_INODE;
454e5104cbbSSteven Rostedt (Google) 
455e5104cbbSSteven Rostedt (Google) 	return 1;
456e5104cbbSSteven Rostedt (Google) }
457e5104cbbSSteven Rostedt (Google) 
4584282d606SSteven Rostedt (Red Hat) static const struct super_operations tracefs_super_operations = {
459ba37ff75SAjay Kaher 	.alloc_inode    = tracefs_alloc_inode,
460ba37ff75SAjay Kaher 	.free_inode     = tracefs_free_inode,
461e5104cbbSSteven Rostedt (Google) 	.drop_inode     = tracefs_drop_inode,
4624282d606SSteven Rostedt (Red Hat) 	.statfs		= simple_statfs,
4634282d606SSteven Rostedt (Red Hat) 	.remount_fs	= tracefs_remount,
4644282d606SSteven Rostedt (Red Hat) 	.show_options	= tracefs_show_options,
4654282d606SSteven Rostedt (Red Hat) };
4664282d606SSteven Rostedt (Red Hat) 
467c4619205SLinus Torvalds /*
468c4619205SLinus Torvalds  * It would be cleaner if eventfs had its own dentry ops.
469c4619205SLinus Torvalds  *
470c4619205SLinus Torvalds  * Note that d_revalidate is called potentially under RCU,
471c4619205SLinus Torvalds  * so it can't take the eventfs mutex etc. It's fine - if
472c4619205SLinus Torvalds  * we open a file just as it's marked dead, things will
473c4619205SLinus Torvalds  * still work just fine, and just see the old stale case.
474c4619205SLinus Torvalds  */
tracefs_d_release(struct dentry * dentry)475c4619205SLinus Torvalds static void tracefs_d_release(struct dentry *dentry)
47627152bceSAjay Kaher {
477c4619205SLinus Torvalds 	if (dentry->d_fsdata)
478c4619205SLinus Torvalds 		eventfs_d_release(dentry);
479c4619205SLinus Torvalds }
48027152bceSAjay Kaher 
tracefs_d_revalidate(struct dentry * dentry,unsigned int flags)481c4619205SLinus Torvalds static int tracefs_d_revalidate(struct dentry *dentry, unsigned int flags)
482c4619205SLinus Torvalds {
483c4619205SLinus Torvalds 	struct eventfs_inode *ei = dentry->d_fsdata;
48427152bceSAjay Kaher 
485c4619205SLinus Torvalds 	return !(ei && ei->is_freed);
48627152bceSAjay Kaher }
48727152bceSAjay Kaher 
48827152bceSAjay Kaher static const struct dentry_operations tracefs_dentry_operations = {
489c4619205SLinus Torvalds 	.d_revalidate = tracefs_d_revalidate,
490c4619205SLinus Torvalds 	.d_release = tracefs_d_release,
49127152bceSAjay Kaher };
49227152bceSAjay Kaher 
trace_fill_super(struct super_block * sb,void * data,int silent)4934282d606SSteven Rostedt (Red Hat) static int trace_fill_super(struct super_block *sb, void *data, int silent)
4944282d606SSteven Rostedt (Red Hat) {
495cda37124SEric Biggers 	static const struct tree_descr trace_files[] = {{""}};
4964282d606SSteven Rostedt (Red Hat) 	struct tracefs_fs_info *fsi;
4974282d606SSteven Rostedt (Red Hat) 	int err;
4984282d606SSteven Rostedt (Red Hat) 
4994282d606SSteven Rostedt (Red Hat) 	fsi = kzalloc(sizeof(struct tracefs_fs_info), GFP_KERNEL);
5004282d606SSteven Rostedt (Red Hat) 	sb->s_fs_info = fsi;
5014282d606SSteven Rostedt (Red Hat) 	if (!fsi) {
5024282d606SSteven Rostedt (Red Hat) 		err = -ENOMEM;
5034282d606SSteven Rostedt (Red Hat) 		goto fail;
5044282d606SSteven Rostedt (Red Hat) 	}
5054282d606SSteven Rostedt (Red Hat) 
5064282d606SSteven Rostedt (Red Hat) 	err = tracefs_parse_options(data, &fsi->mount_opts);
5074282d606SSteven Rostedt (Red Hat) 	if (err)
5084282d606SSteven Rostedt (Red Hat) 		goto fail;
5094282d606SSteven Rostedt (Red Hat) 
5104282d606SSteven Rostedt (Red Hat) 	err  =  simple_fill_super(sb, TRACEFS_MAGIC, trace_files);
5114282d606SSteven Rostedt (Red Hat) 	if (err)
5124282d606SSteven Rostedt (Red Hat) 		goto fail;
5134282d606SSteven Rostedt (Red Hat) 
5144282d606SSteven Rostedt (Red Hat) 	sb->s_op = &tracefs_super_operations;
51527152bceSAjay Kaher 	sb->s_d_op = &tracefs_dentry_operations;
5164282d606SSteven Rostedt (Red Hat) 
51747311db8SBrian Norris 	tracefs_apply_options(sb, false);
5184282d606SSteven Rostedt (Red Hat) 
5194282d606SSteven Rostedt (Red Hat) 	return 0;
5204282d606SSteven Rostedt (Red Hat) 
5214282d606SSteven Rostedt (Red Hat) fail:
5224282d606SSteven Rostedt (Red Hat) 	kfree(fsi);
5234282d606SSteven Rostedt (Red Hat) 	sb->s_fs_info = NULL;
5244282d606SSteven Rostedt (Red Hat) 	return err;
5254282d606SSteven Rostedt (Red Hat) }
5264282d606SSteven Rostedt (Red Hat) 
trace_mount(struct file_system_type * fs_type,int flags,const char * dev_name,void * data)5274282d606SSteven Rostedt (Red Hat) static struct dentry *trace_mount(struct file_system_type *fs_type,
5284282d606SSteven Rostedt (Red Hat) 			int flags, const char *dev_name,
5294282d606SSteven Rostedt (Red Hat) 			void *data)
5304282d606SSteven Rostedt (Red Hat) {
5314282d606SSteven Rostedt (Red Hat) 	return mount_single(fs_type, flags, data, trace_fill_super);
5324282d606SSteven Rostedt (Red Hat) }
5334282d606SSteven Rostedt (Red Hat) 
5344282d606SSteven Rostedt (Red Hat) static struct file_system_type trace_fs_type = {
5354282d606SSteven Rostedt (Red Hat) 	.owner =	THIS_MODULE,
5364282d606SSteven Rostedt (Red Hat) 	.name =		"tracefs",
5374282d606SSteven Rostedt (Red Hat) 	.mount =	trace_mount,
5384282d606SSteven Rostedt (Red Hat) 	.kill_sb =	kill_litter_super,
5394282d606SSteven Rostedt (Red Hat) };
5404282d606SSteven Rostedt (Red Hat) MODULE_ALIAS_FS("tracefs");
5414282d606SSteven Rostedt (Red Hat) 
tracefs_start_creating(const char * name,struct dentry * parent)5422c6b6b10SAjay Kaher struct dentry *tracefs_start_creating(const char *name, struct dentry *parent)
5434282d606SSteven Rostedt (Red Hat) {
5444282d606SSteven Rostedt (Red Hat) 	struct dentry *dentry;
5454282d606SSteven Rostedt (Red Hat) 	int error;
5464282d606SSteven Rostedt (Red Hat) 
5474282d606SSteven Rostedt (Red Hat) 	pr_debug("tracefs: creating file '%s'\n",name);
5484282d606SSteven Rostedt (Red Hat) 
5494282d606SSteven Rostedt (Red Hat) 	error = simple_pin_fs(&trace_fs_type, &tracefs_mount,
5504282d606SSteven Rostedt (Red Hat) 			      &tracefs_mount_count);
5514282d606SSteven Rostedt (Red Hat) 	if (error)
5524282d606SSteven Rostedt (Red Hat) 		return ERR_PTR(error);
5534282d606SSteven Rostedt (Red Hat) 
5544282d606SSteven Rostedt (Red Hat) 	/* If the parent is not specified, we create it in the root.
5554282d606SSteven Rostedt (Red Hat) 	 * We need the root dentry to do this, which is in the super
5564282d606SSteven Rostedt (Red Hat) 	 * block. A pointer to that is in the struct vfsmount that we
5574282d606SSteven Rostedt (Red Hat) 	 * have around.
5584282d606SSteven Rostedt (Red Hat) 	 */
5594282d606SSteven Rostedt (Red Hat) 	if (!parent)
5604282d606SSteven Rostedt (Red Hat) 		parent = tracefs_mount->mnt_root;
5614282d606SSteven Rostedt (Red Hat) 
562ee34c52cSSteven Rostedt (VMware) 	inode_lock(d_inode(parent));
563ee34c52cSSteven Rostedt (VMware) 	if (unlikely(IS_DEADDIR(d_inode(parent))))
564a3d1e7ebSAl Viro 		dentry = ERR_PTR(-ENOENT);
565a3d1e7ebSAl Viro 	else
5664282d606SSteven Rostedt (Red Hat) 		dentry = lookup_one_len(name, parent, strlen(name));
567ee34c52cSSteven Rostedt (VMware) 	if (!IS_ERR(dentry) && d_inode(dentry)) {
5684282d606SSteven Rostedt (Red Hat) 		dput(dentry);
5694282d606SSteven Rostedt (Red Hat) 		dentry = ERR_PTR(-EEXIST);
5704282d606SSteven Rostedt (Red Hat) 	}
571d227c3aeSDaniel Borkmann 
572d227c3aeSDaniel Borkmann 	if (IS_ERR(dentry)) {
573ee34c52cSSteven Rostedt (VMware) 		inode_unlock(d_inode(parent));
574d227c3aeSDaniel Borkmann 		simple_release_fs(&tracefs_mount, &tracefs_mount_count);
575d227c3aeSDaniel Borkmann 	}
576d227c3aeSDaniel Borkmann 
5774282d606SSteven Rostedt (Red Hat) 	return dentry;
5784282d606SSteven Rostedt (Red Hat) }
5794282d606SSteven Rostedt (Red Hat) 
tracefs_failed_creating(struct dentry * dentry)5802c6b6b10SAjay Kaher struct dentry *tracefs_failed_creating(struct dentry *dentry)
5814282d606SSteven Rostedt (Red Hat) {
582ee34c52cSSteven Rostedt (VMware) 	inode_unlock(d_inode(dentry->d_parent));
5834282d606SSteven Rostedt (Red Hat) 	dput(dentry);
5844282d606SSteven Rostedt (Red Hat) 	simple_release_fs(&tracefs_mount, &tracefs_mount_count);
5854282d606SSteven Rostedt (Red Hat) 	return NULL;
5864282d606SSteven Rostedt (Red Hat) }
5874282d606SSteven Rostedt (Red Hat) 
tracefs_end_creating(struct dentry * dentry)5882c6b6b10SAjay Kaher struct dentry *tracefs_end_creating(struct dentry *dentry)
5894282d606SSteven Rostedt (Red Hat) {
590ee34c52cSSteven Rostedt (VMware) 	inode_unlock(d_inode(dentry->d_parent));
5914282d606SSteven Rostedt (Red Hat) 	return dentry;
5924282d606SSteven Rostedt (Red Hat) }
5934282d606SSteven Rostedt (Red Hat) 
594628adb84SSteven Rostedt (Google) /* Find the inode that this will use for default */
instance_inode(struct dentry * parent,struct inode * inode)595628adb84SSteven Rostedt (Google) static struct inode *instance_inode(struct dentry *parent, struct inode *inode)
596628adb84SSteven Rostedt (Google) {
597628adb84SSteven Rostedt (Google) 	struct tracefs_inode *ti;
598628adb84SSteven Rostedt (Google) 
599628adb84SSteven Rostedt (Google) 	/* If parent is NULL then use root inode */
600628adb84SSteven Rostedt (Google) 	if (!parent)
601628adb84SSteven Rostedt (Google) 		return d_inode(inode->i_sb->s_root);
602628adb84SSteven Rostedt (Google) 
603628adb84SSteven Rostedt (Google) 	/* Find the inode that is flagged as an instance or the root inode */
604628adb84SSteven Rostedt (Google) 	while (!IS_ROOT(parent)) {
605628adb84SSteven Rostedt (Google) 		ti = get_tracefs(d_inode(parent));
606628adb84SSteven Rostedt (Google) 		if (ti->flags & TRACEFS_INSTANCE_INODE)
607628adb84SSteven Rostedt (Google) 			break;
608628adb84SSteven Rostedt (Google) 		parent = parent->d_parent;
609628adb84SSteven Rostedt (Google) 	}
610628adb84SSteven Rostedt (Google) 
611628adb84SSteven Rostedt (Google) 	return d_inode(parent);
612628adb84SSteven Rostedt (Google) }
613628adb84SSteven Rostedt (Google) 
614a3760079SAjay Kaher /**
6154282d606SSteven Rostedt (Red Hat)  * tracefs_create_file - create a file in the tracefs filesystem
6164282d606SSteven Rostedt (Red Hat)  * @name: a pointer to a string containing the name of the file to create.
6174282d606SSteven Rostedt (Red Hat)  * @mode: the permission that the file should have.
6184282d606SSteven Rostedt (Red Hat)  * @parent: a pointer to the parent dentry for this file.  This should be a
6194282d606SSteven Rostedt (Red Hat)  *          directory dentry if set.  If this parameter is NULL, then the
6204282d606SSteven Rostedt (Red Hat)  *          file will be created in the root of the tracefs filesystem.
6214282d606SSteven Rostedt (Red Hat)  * @data: a pointer to something that the caller will want to get to later
6224282d606SSteven Rostedt (Red Hat)  *        on.  The inode.i_private pointer will point to this value on
6234282d606SSteven Rostedt (Red Hat)  *        the open() call.
6244282d606SSteven Rostedt (Red Hat)  * @fops: a pointer to a struct file_operations that should be used for
6254282d606SSteven Rostedt (Red Hat)  *        this file.
6264282d606SSteven Rostedt (Red Hat)  *
6274282d606SSteven Rostedt (Red Hat)  * This is the basic "create a file" function for tracefs.  It allows for a
6284282d606SSteven Rostedt (Red Hat)  * wide range of flexibility in creating a file, or a directory (if you want
6294282d606SSteven Rostedt (Red Hat)  * to create a directory, the tracefs_create_dir() function is
6304282d606SSteven Rostedt (Red Hat)  * recommended to be used instead.)
6314282d606SSteven Rostedt (Red Hat)  *
6324282d606SSteven Rostedt (Red Hat)  * This function will return a pointer to a dentry if it succeeds.  This
6334282d606SSteven Rostedt (Red Hat)  * pointer must be passed to the tracefs_remove() function when the file is
6344282d606SSteven Rostedt (Red Hat)  * to be removed (no automatic cleanup happens if your module is unloaded,
6354282d606SSteven Rostedt (Red Hat)  * you are responsible here.)  If an error occurs, %NULL will be returned.
6364282d606SSteven Rostedt (Red Hat)  *
6374282d606SSteven Rostedt (Red Hat)  * If tracefs is not enabled in the kernel, the value -%ENODEV will be
6384282d606SSteven Rostedt (Red Hat)  * returned.
6394282d606SSteven Rostedt (Red Hat)  */
tracefs_create_file(const char * name,umode_t mode,struct dentry * parent,void * data,const struct file_operations * fops)6404282d606SSteven Rostedt (Red Hat) struct dentry *tracefs_create_file(const char *name, umode_t mode,
6414282d606SSteven Rostedt (Red Hat) 				   struct dentry *parent, void *data,
6424282d606SSteven Rostedt (Red Hat) 				   const struct file_operations *fops)
6434282d606SSteven Rostedt (Red Hat) {
644628adb84SSteven Rostedt (Google) 	struct tracefs_inode *ti;
6454282d606SSteven Rostedt (Red Hat) 	struct dentry *dentry;
6464282d606SSteven Rostedt (Red Hat) 	struct inode *inode;
6474282d606SSteven Rostedt (Red Hat) 
648bf8e6021SSteven Rostedt (VMware) 	if (security_locked_down(LOCKDOWN_TRACEFS))
649bf8e6021SSteven Rostedt (VMware) 		return NULL;
650bf8e6021SSteven Rostedt (VMware) 
6514282d606SSteven Rostedt (Red Hat) 	if (!(mode & S_IFMT))
6524282d606SSteven Rostedt (Red Hat) 		mode |= S_IFREG;
6534282d606SSteven Rostedt (Red Hat) 	BUG_ON(!S_ISREG(mode));
6542c6b6b10SAjay Kaher 	dentry = tracefs_start_creating(name, parent);
6554282d606SSteven Rostedt (Red Hat) 
6564282d606SSteven Rostedt (Red Hat) 	if (IS_ERR(dentry))
6574282d606SSteven Rostedt (Red Hat) 		return NULL;
6584282d606SSteven Rostedt (Red Hat) 
6594282d606SSteven Rostedt (Red Hat) 	inode = tracefs_get_inode(dentry->d_sb);
6604282d606SSteven Rostedt (Red Hat) 	if (unlikely(!inode))
6612c6b6b10SAjay Kaher 		return tracefs_failed_creating(dentry);
6624282d606SSteven Rostedt (Red Hat) 
663628adb84SSteven Rostedt (Google) 	ti = get_tracefs(inode);
664628adb84SSteven Rostedt (Google) 	ti->private = instance_inode(parent, inode);
665628adb84SSteven Rostedt (Google) 
6664282d606SSteven Rostedt (Red Hat) 	inode->i_mode = mode;
667628adb84SSteven Rostedt (Google) 	inode->i_op = &tracefs_file_inode_operations;
6683ed270b1SSteven Rostedt (VMware) 	inode->i_fop = fops ? fops : &tracefs_file_operations;
6694282d606SSteven Rostedt (Red Hat) 	inode->i_private = data;
670ee7f3666SSteven Rostedt (VMware) 	inode->i_uid = d_inode(dentry->d_parent)->i_uid;
671ee7f3666SSteven Rostedt (VMware) 	inode->i_gid = d_inode(dentry->d_parent)->i_gid;
6724282d606SSteven Rostedt (Red Hat) 	d_instantiate(dentry, inode);
673ee34c52cSSteven Rostedt (VMware) 	fsnotify_create(d_inode(dentry->d_parent), dentry);
6742c6b6b10SAjay Kaher 	return tracefs_end_creating(dentry);
6754282d606SSteven Rostedt (Red Hat) }
6764282d606SSteven Rostedt (Red Hat) 
__create_dir(const char * name,struct dentry * parent,const struct inode_operations * ops)677eae47358SSteven Rostedt (Red Hat) static struct dentry *__create_dir(const char *name, struct dentry *parent,
678eae47358SSteven Rostedt (Red Hat) 				   const struct inode_operations *ops)
679eae47358SSteven Rostedt (Red Hat) {
680628adb84SSteven Rostedt (Google) 	struct tracefs_inode *ti;
6812c6b6b10SAjay Kaher 	struct dentry *dentry = tracefs_start_creating(name, parent);
682eae47358SSteven Rostedt (Red Hat) 	struct inode *inode;
683eae47358SSteven Rostedt (Red Hat) 
684eae47358SSteven Rostedt (Red Hat) 	if (IS_ERR(dentry))
685eae47358SSteven Rostedt (Red Hat) 		return NULL;
686eae47358SSteven Rostedt (Red Hat) 
687eae47358SSteven Rostedt (Red Hat) 	inode = tracefs_get_inode(dentry->d_sb);
688eae47358SSteven Rostedt (Red Hat) 	if (unlikely(!inode))
6892c6b6b10SAjay Kaher 		return tracefs_failed_creating(dentry);
690eae47358SSteven Rostedt (Red Hat) 
69149d67e44SSteven Rostedt (VMware) 	/* Do not set bits for OTH */
69249d67e44SSteven Rostedt (VMware) 	inode->i_mode = S_IFDIR | S_IRWXU | S_IRUSR| S_IRGRP | S_IXUSR | S_IXGRP;
693eae47358SSteven Rostedt (Red Hat) 	inode->i_op = ops;
694eae47358SSteven Rostedt (Red Hat) 	inode->i_fop = &simple_dir_operations;
695ee7f3666SSteven Rostedt (VMware) 	inode->i_uid = d_inode(dentry->d_parent)->i_uid;
696ee7f3666SSteven Rostedt (VMware) 	inode->i_gid = d_inode(dentry->d_parent)->i_gid;
697eae47358SSteven Rostedt (Red Hat) 
698628adb84SSteven Rostedt (Google) 	ti = get_tracefs(inode);
699628adb84SSteven Rostedt (Google) 	ti->private = instance_inode(parent, inode);
700628adb84SSteven Rostedt (Google) 
701eae47358SSteven Rostedt (Red Hat) 	/* directory inodes start off with i_nlink == 2 (for "." entry) */
702eae47358SSteven Rostedt (Red Hat) 	inc_nlink(inode);
703eae47358SSteven Rostedt (Red Hat) 	d_instantiate(dentry, inode);
704ee34c52cSSteven Rostedt (VMware) 	inc_nlink(d_inode(dentry->d_parent));
705ee34c52cSSteven Rostedt (VMware) 	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
7062c6b6b10SAjay Kaher 	return tracefs_end_creating(dentry);
707eae47358SSteven Rostedt (Red Hat) }
708eae47358SSteven Rostedt (Red Hat) 
7094282d606SSteven Rostedt (Red Hat) /**
7104282d606SSteven Rostedt (Red Hat)  * tracefs_create_dir - create a directory in the tracefs filesystem
7114282d606SSteven Rostedt (Red Hat)  * @name: a pointer to a string containing the name of the directory to
7124282d606SSteven Rostedt (Red Hat)  *        create.
7134282d606SSteven Rostedt (Red Hat)  * @parent: a pointer to the parent dentry for this file.  This should be a
7144282d606SSteven Rostedt (Red Hat)  *          directory dentry if set.  If this parameter is NULL, then the
7154282d606SSteven Rostedt (Red Hat)  *          directory will be created in the root of the tracefs filesystem.
7164282d606SSteven Rostedt (Red Hat)  *
7174282d606SSteven Rostedt (Red Hat)  * This function creates a directory in tracefs with the given name.
7184282d606SSteven Rostedt (Red Hat)  *
7194282d606SSteven Rostedt (Red Hat)  * This function will return a pointer to a dentry if it succeeds.  This
7204282d606SSteven Rostedt (Red Hat)  * pointer must be passed to the tracefs_remove() function when the file is
7214282d606SSteven Rostedt (Red Hat)  * to be removed. If an error occurs, %NULL will be returned.
7224282d606SSteven Rostedt (Red Hat)  *
7234282d606SSteven Rostedt (Red Hat)  * If tracing is not enabled in the kernel, the value -%ENODEV will be
7244282d606SSteven Rostedt (Red Hat)  * returned.
7254282d606SSteven Rostedt (Red Hat)  */
tracefs_create_dir(const char * name,struct dentry * parent)7264282d606SSteven Rostedt (Red Hat) struct dentry *tracefs_create_dir(const char *name, struct dentry *parent)
7274282d606SSteven Rostedt (Red Hat) {
72851aab5ffSSteven Rostedt (Google) 	if (security_locked_down(LOCKDOWN_TRACEFS))
72951aab5ffSSteven Rostedt (Google) 		return NULL;
73051aab5ffSSteven Rostedt (Google) 
731628adb84SSteven Rostedt (Google) 	return __create_dir(name, parent, &tracefs_dir_inode_operations);
732eae47358SSteven Rostedt (Red Hat) }
7334282d606SSteven Rostedt (Red Hat) 
734eae47358SSteven Rostedt (Red Hat) /**
735eae47358SSteven Rostedt (Red Hat)  * tracefs_create_instance_dir - create the tracing instances directory
736eae47358SSteven Rostedt (Red Hat)  * @name: The name of the instances directory to create
737eae47358SSteven Rostedt (Red Hat)  * @parent: The parent directory that the instances directory will exist
738eae47358SSteven Rostedt (Red Hat)  * @mkdir: The function to call when a mkdir is performed.
739eae47358SSteven Rostedt (Red Hat)  * @rmdir: The function to call when a rmdir is performed.
740eae47358SSteven Rostedt (Red Hat)  *
741eae47358SSteven Rostedt (Red Hat)  * Only one instances directory is allowed.
742eae47358SSteven Rostedt (Red Hat)  *
74393a8c044SXiang wangx  * The instances directory is special as it allows for mkdir and rmdir
744eae47358SSteven Rostedt (Red Hat)  * to be done by userspace. When a mkdir or rmdir is performed, the inode
745f2cc020dSIngo Molnar  * locks are released and the methods passed in (@mkdir and @rmdir) are
746eae47358SSteven Rostedt (Red Hat)  * called without locks and with the name of the directory being created
747eae47358SSteven Rostedt (Red Hat)  * within the instances directory.
748eae47358SSteven Rostedt (Red Hat)  *
749eae47358SSteven Rostedt (Red Hat)  * Returns the dentry of the instances directory.
750eae47358SSteven Rostedt (Red Hat)  */
tracefs_create_instance_dir(const char * name,struct dentry * parent,int (* mkdir)(const char * name),int (* rmdir)(const char * name))7515248ee85SZubin Mithra __init struct dentry *tracefs_create_instance_dir(const char *name,
7525248ee85SZubin Mithra 					  struct dentry *parent,
753eae47358SSteven Rostedt (Red Hat) 					  int (*mkdir)(const char *name),
754eae47358SSteven Rostedt (Red Hat) 					  int (*rmdir)(const char *name))
755eae47358SSteven Rostedt (Red Hat) {
756eae47358SSteven Rostedt (Red Hat) 	struct dentry *dentry;
757eae47358SSteven Rostedt (Red Hat) 
758eae47358SSteven Rostedt (Red Hat) 	/* Only allow one instance of the instances directory. */
759eae47358SSteven Rostedt (Red Hat) 	if (WARN_ON(tracefs_ops.mkdir || tracefs_ops.rmdir))
7604282d606SSteven Rostedt (Red Hat) 		return NULL;
7614282d606SSteven Rostedt (Red Hat) 
762628adb84SSteven Rostedt (Google) 	dentry = __create_dir(name, parent, &tracefs_instance_dir_inode_operations);
763eae47358SSteven Rostedt (Red Hat) 	if (!dentry)
764eae47358SSteven Rostedt (Red Hat) 		return NULL;
7654282d606SSteven Rostedt (Red Hat) 
766eae47358SSteven Rostedt (Red Hat) 	tracefs_ops.mkdir = mkdir;
767eae47358SSteven Rostedt (Red Hat) 	tracefs_ops.rmdir = rmdir;
7684282d606SSteven Rostedt (Red Hat) 
769eae47358SSteven Rostedt (Red Hat) 	return dentry;
7704282d606SSteven Rostedt (Red Hat) }
7714282d606SSteven Rostedt (Red Hat) 
remove_one(struct dentry * victim)772a3d1e7ebSAl Viro static void remove_one(struct dentry *victim)
7734282d606SSteven Rostedt (Red Hat) {
7744282d606SSteven Rostedt (Red Hat) 	simple_release_fs(&tracefs_mount, &tracefs_mount_count);
7754282d606SSteven Rostedt (Red Hat) }
7764282d606SSteven Rostedt (Red Hat) 
7774282d606SSteven Rostedt (Red Hat) /**
778a3d1e7ebSAl Viro  * tracefs_remove - recursively removes a directory
7794282d606SSteven Rostedt (Red Hat)  * @dentry: a pointer to a the dentry of the directory to be removed.
7804282d606SSteven Rostedt (Red Hat)  *
7814282d606SSteven Rostedt (Red Hat)  * This function recursively removes a directory tree in tracefs that
7824282d606SSteven Rostedt (Red Hat)  * was previously created with a call to another tracefs function
7834282d606SSteven Rostedt (Red Hat)  * (like tracefs_create_file() or variants thereof.)
7844282d606SSteven Rostedt (Red Hat)  */
tracefs_remove(struct dentry * dentry)785a3d1e7ebSAl Viro void tracefs_remove(struct dentry *dentry)
7864282d606SSteven Rostedt (Red Hat) {
7874282d606SSteven Rostedt (Red Hat) 	if (IS_ERR_OR_NULL(dentry))
7884282d606SSteven Rostedt (Red Hat) 		return;
7894282d606SSteven Rostedt (Red Hat) 
790a3d1e7ebSAl Viro 	simple_pin_fs(&trace_fs_type, &tracefs_mount, &tracefs_mount_count);
791a3d1e7ebSAl Viro 	simple_recursive_removal(dentry, remove_one);
7924282d606SSteven Rostedt (Red Hat) 	simple_release_fs(&tracefs_mount, &tracefs_mount_count);
7934282d606SSteven Rostedt (Red Hat) }
7944282d606SSteven Rostedt (Red Hat) 
7954282d606SSteven Rostedt (Red Hat) /**
7964282d606SSteven Rostedt (Red Hat)  * tracefs_initialized - Tells whether tracefs has been registered
7974282d606SSteven Rostedt (Red Hat)  */
tracefs_initialized(void)7984282d606SSteven Rostedt (Red Hat) bool tracefs_initialized(void)
7994282d606SSteven Rostedt (Red Hat) {
8004282d606SSteven Rostedt (Red Hat) 	return tracefs_registered;
8014282d606SSteven Rostedt (Red Hat) }
8024282d606SSteven Rostedt (Red Hat) 
init_once(void * foo)803ba37ff75SAjay Kaher static void init_once(void *foo)
804ba37ff75SAjay Kaher {
805ba37ff75SAjay Kaher 	struct tracefs_inode *ti = (struct tracefs_inode *) foo;
806ba37ff75SAjay Kaher 
807f0686a19SSteven Rostedt (Google) 	/* inode_init_once() calls memset() on the vfs_inode portion */
808ba37ff75SAjay Kaher 	inode_init_once(&ti->vfs_inode);
809f0686a19SSteven Rostedt (Google) 
810f0686a19SSteven Rostedt (Google) 	/* Zero out the rest */
811f0686a19SSteven Rostedt (Google) 	memset_after(ti, 0, vfs_inode);
812ba37ff75SAjay Kaher }
813ba37ff75SAjay Kaher 
tracefs_init(void)8144282d606SSteven Rostedt (Red Hat) static int __init tracefs_init(void)
8154282d606SSteven Rostedt (Red Hat) {
8164282d606SSteven Rostedt (Red Hat) 	int retval;
8174282d606SSteven Rostedt (Red Hat) 
818ba37ff75SAjay Kaher 	tracefs_inode_cachep = kmem_cache_create("tracefs_inode_cache",
819ba37ff75SAjay Kaher 						 sizeof(struct tracefs_inode),
820ba37ff75SAjay Kaher 						 0, (SLAB_RECLAIM_ACCOUNT|
821ba37ff75SAjay Kaher 						     SLAB_MEM_SPREAD|
822ba37ff75SAjay Kaher 						     SLAB_ACCOUNT),
823ba37ff75SAjay Kaher 						 init_once);
824ba37ff75SAjay Kaher 	if (!tracefs_inode_cachep)
825ba37ff75SAjay Kaher 		return -ENOMEM;
826ba37ff75SAjay Kaher 
827f9bb4882SEric W. Biederman 	retval = sysfs_create_mount_point(kernel_kobj, "tracing");
828f9bb4882SEric W. Biederman 	if (retval)
829cc31004aSSteven Rostedt (Red Hat) 		return -EINVAL;
830cc31004aSSteven Rostedt (Red Hat) 
8314282d606SSteven Rostedt (Red Hat) 	retval = register_filesystem(&trace_fs_type);
8324282d606SSteven Rostedt (Red Hat) 	if (!retval)
8334282d606SSteven Rostedt (Red Hat) 		tracefs_registered = true;
8344282d606SSteven Rostedt (Red Hat) 
8354282d606SSteven Rostedt (Red Hat) 	return retval;
8364282d606SSteven Rostedt (Red Hat) }
8374282d606SSteven Rostedt (Red Hat) core_initcall(tracefs_init);
838