xref: /linux-6.15/fs/debugfs/inode.c (revision a7c5437b)
11da177e4SLinus Torvalds /*
2bd33d12fSHarry Wei  *  inode.c - part of debugfs, a tiny little debug file system
31da177e4SLinus Torvalds  *
41da177e4SLinus Torvalds  *  Copyright (C) 2004 Greg Kroah-Hartman <[email protected]>
51da177e4SLinus Torvalds  *  Copyright (C) 2004 IBM Inc.
61da177e4SLinus Torvalds  *
71da177e4SLinus Torvalds  *	This program is free software; you can redistribute it and/or
81da177e4SLinus Torvalds  *	modify it under the terms of the GNU General Public License version
91da177e4SLinus Torvalds  *	2 as published by the Free Software Foundation.
101da177e4SLinus Torvalds  *
111da177e4SLinus Torvalds  *  debugfs is for people to use instead of /proc or /sys.
121da177e4SLinus Torvalds  *  See Documentation/DocBook/kernel-api for more details.
131da177e4SLinus Torvalds  *
141da177e4SLinus Torvalds  */
151da177e4SLinus Torvalds 
161da177e4SLinus Torvalds #include <linux/module.h>
171da177e4SLinus Torvalds #include <linux/fs.h>
181da177e4SLinus Torvalds #include <linux/mount.h>
191da177e4SLinus Torvalds #include <linux/pagemap.h>
201da177e4SLinus Torvalds #include <linux/init.h>
214d8ebddcSRandy Dunlap #include <linux/kobject.h>
221da177e4SLinus Torvalds #include <linux/namei.h>
231da177e4SLinus Torvalds #include <linux/debugfs.h>
244f36557fSMathieu Desnoyers #include <linux/fsnotify.h>
2566f54963SPeter Oberparleiter #include <linux/string.h>
26d6e48686SLudwig Nussel #include <linux/seq_file.h>
27d6e48686SLudwig Nussel #include <linux/parser.h>
2892562927SMimi Zohar #include <linux/magic.h>
295a0e3ad6STejun Heo #include <linux/slab.h>
309fd4dcecSNicolai Stange #include <linux/srcu.h>
319fd4dcecSNicolai Stange 
329fd4dcecSNicolai Stange #include "internal.h"
331da177e4SLinus Torvalds 
3482aceae4SKees Cook #define DEBUGFS_DEFAULT_MODE	0700
35d6e48686SLudwig Nussel 
369fd4dcecSNicolai Stange DEFINE_SRCU(debugfs_srcu);
379fd4dcecSNicolai Stange 
381da177e4SLinus Torvalds static struct vfsmount *debugfs_mount;
391da177e4SLinus Torvalds static int debugfs_mount_count;
40c0f92ba9SFrederic Weisbecker static bool debugfs_registered;
411da177e4SLinus Torvalds 
42edac65eaSAl Viro static struct inode *debugfs_get_inode(struct super_block *sb)
431da177e4SLinus Torvalds {
441da177e4SLinus Torvalds 	struct inode *inode = new_inode(sb);
451da177e4SLinus Torvalds 	if (inode) {
4685fe4025SChristoph Hellwig 		inode->i_ino = get_next_ino();
471b48b530SDeepa Dinamani 		inode->i_atime = inode->i_mtime =
48c2050a45SDeepa Dinamani 			inode->i_ctime = current_time(inode);
491da177e4SLinus Torvalds 	}
501da177e4SLinus Torvalds 	return inode;
511da177e4SLinus Torvalds }
521da177e4SLinus Torvalds 
53d6e48686SLudwig Nussel struct debugfs_mount_opts {
547dc05881SEric W. Biederman 	kuid_t uid;
557dc05881SEric W. Biederman 	kgid_t gid;
56d6e48686SLudwig Nussel 	umode_t mode;
57d6e48686SLudwig Nussel };
58d6e48686SLudwig Nussel 
59d6e48686SLudwig Nussel enum {
60d6e48686SLudwig Nussel 	Opt_uid,
61d6e48686SLudwig Nussel 	Opt_gid,
62d6e48686SLudwig Nussel 	Opt_mode,
63d6e48686SLudwig Nussel 	Opt_err
64d6e48686SLudwig Nussel };
65d6e48686SLudwig Nussel 
66d6e48686SLudwig Nussel static const match_table_t tokens = {
67d6e48686SLudwig Nussel 	{Opt_uid, "uid=%u"},
68d6e48686SLudwig Nussel 	{Opt_gid, "gid=%u"},
69d6e48686SLudwig Nussel 	{Opt_mode, "mode=%o"},
70d6e48686SLudwig Nussel 	{Opt_err, NULL}
71d6e48686SLudwig Nussel };
72d6e48686SLudwig Nussel 
73d6e48686SLudwig Nussel struct debugfs_fs_info {
74d6e48686SLudwig Nussel 	struct debugfs_mount_opts mount_opts;
75d6e48686SLudwig Nussel };
76d6e48686SLudwig Nussel 
77d6e48686SLudwig Nussel static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
78d6e48686SLudwig Nussel {
79d6e48686SLudwig Nussel 	substring_t args[MAX_OPT_ARGS];
80d6e48686SLudwig Nussel 	int option;
81d6e48686SLudwig Nussel 	int token;
827dc05881SEric W. Biederman 	kuid_t uid;
837dc05881SEric W. Biederman 	kgid_t gid;
84d6e48686SLudwig Nussel 	char *p;
85d6e48686SLudwig Nussel 
86d6e48686SLudwig Nussel 	opts->mode = DEBUGFS_DEFAULT_MODE;
87d6e48686SLudwig Nussel 
88d6e48686SLudwig Nussel 	while ((p = strsep(&data, ",")) != NULL) {
89d6e48686SLudwig Nussel 		if (!*p)
90d6e48686SLudwig Nussel 			continue;
91d6e48686SLudwig Nussel 
92d6e48686SLudwig Nussel 		token = match_token(p, tokens, args);
93d6e48686SLudwig Nussel 		switch (token) {
94d6e48686SLudwig Nussel 		case Opt_uid:
95d6e48686SLudwig Nussel 			if (match_int(&args[0], &option))
96d6e48686SLudwig Nussel 				return -EINVAL;
977dc05881SEric W. Biederman 			uid = make_kuid(current_user_ns(), option);
987dc05881SEric W. Biederman 			if (!uid_valid(uid))
997dc05881SEric W. Biederman 				return -EINVAL;
1007dc05881SEric W. Biederman 			opts->uid = uid;
101d6e48686SLudwig Nussel 			break;
102d6e48686SLudwig Nussel 		case Opt_gid:
103f1688e04SDave Reisner 			if (match_int(&args[0], &option))
104d6e48686SLudwig Nussel 				return -EINVAL;
1057dc05881SEric W. Biederman 			gid = make_kgid(current_user_ns(), option);
1067dc05881SEric W. Biederman 			if (!gid_valid(gid))
1077dc05881SEric W. Biederman 				return -EINVAL;
1087dc05881SEric W. Biederman 			opts->gid = gid;
109d6e48686SLudwig Nussel 			break;
110d6e48686SLudwig Nussel 		case Opt_mode:
111d6e48686SLudwig Nussel 			if (match_octal(&args[0], &option))
112d6e48686SLudwig Nussel 				return -EINVAL;
113d6e48686SLudwig Nussel 			opts->mode = option & S_IALLUGO;
114d6e48686SLudwig Nussel 			break;
115d6e48686SLudwig Nussel 		/*
116d6e48686SLudwig Nussel 		 * We might like to report bad mount options here;
117d6e48686SLudwig Nussel 		 * but traditionally debugfs has ignored all mount options
118d6e48686SLudwig Nussel 		 */
119d6e48686SLudwig Nussel 		}
120d6e48686SLudwig Nussel 	}
121d6e48686SLudwig Nussel 
122d6e48686SLudwig Nussel 	return 0;
123d6e48686SLudwig Nussel }
124d6e48686SLudwig Nussel 
125d6e48686SLudwig Nussel static int debugfs_apply_options(struct super_block *sb)
126d6e48686SLudwig Nussel {
127d6e48686SLudwig Nussel 	struct debugfs_fs_info *fsi = sb->s_fs_info;
1282b0143b5SDavid Howells 	struct inode *inode = d_inode(sb->s_root);
129d6e48686SLudwig Nussel 	struct debugfs_mount_opts *opts = &fsi->mount_opts;
130d6e48686SLudwig Nussel 
131d6e48686SLudwig Nussel 	inode->i_mode &= ~S_IALLUGO;
132d6e48686SLudwig Nussel 	inode->i_mode |= opts->mode;
133d6e48686SLudwig Nussel 
134d6e48686SLudwig Nussel 	inode->i_uid = opts->uid;
135d6e48686SLudwig Nussel 	inode->i_gid = opts->gid;
136d6e48686SLudwig Nussel 
137d6e48686SLudwig Nussel 	return 0;
138d6e48686SLudwig Nussel }
139d6e48686SLudwig Nussel 
140d6e48686SLudwig Nussel static int debugfs_remount(struct super_block *sb, int *flags, char *data)
141d6e48686SLudwig Nussel {
142d6e48686SLudwig Nussel 	int err;
143d6e48686SLudwig Nussel 	struct debugfs_fs_info *fsi = sb->s_fs_info;
144d6e48686SLudwig Nussel 
14502b9984dSTheodore Ts'o 	sync_filesystem(sb);
146d6e48686SLudwig Nussel 	err = debugfs_parse_options(data, &fsi->mount_opts);
147d6e48686SLudwig Nussel 	if (err)
148d6e48686SLudwig Nussel 		goto fail;
149d6e48686SLudwig Nussel 
150d6e48686SLudwig Nussel 	debugfs_apply_options(sb);
151d6e48686SLudwig Nussel 
152d6e48686SLudwig Nussel fail:
153d6e48686SLudwig Nussel 	return err;
154d6e48686SLudwig Nussel }
155d6e48686SLudwig Nussel 
156d6e48686SLudwig Nussel static int debugfs_show_options(struct seq_file *m, struct dentry *root)
157d6e48686SLudwig Nussel {
158d6e48686SLudwig Nussel 	struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
159d6e48686SLudwig Nussel 	struct debugfs_mount_opts *opts = &fsi->mount_opts;
160d6e48686SLudwig Nussel 
1617dc05881SEric W. Biederman 	if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
1627dc05881SEric W. Biederman 		seq_printf(m, ",uid=%u",
1637dc05881SEric W. Biederman 			   from_kuid_munged(&init_user_ns, opts->uid));
1647dc05881SEric W. Biederman 	if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
1657dc05881SEric W. Biederman 		seq_printf(m, ",gid=%u",
1667dc05881SEric W. Biederman 			   from_kgid_munged(&init_user_ns, opts->gid));
167d6e48686SLudwig Nussel 	if (opts->mode != DEBUGFS_DEFAULT_MODE)
168d6e48686SLudwig Nussel 		seq_printf(m, ",mode=%o", opts->mode);
169d6e48686SLudwig Nussel 
170d6e48686SLudwig Nussel 	return 0;
171d6e48686SLudwig Nussel }
172d6e48686SLudwig Nussel 
1730db59e59SAl Viro static void debugfs_evict_inode(struct inode *inode)
1740db59e59SAl Viro {
1750db59e59SAl Viro 	truncate_inode_pages_final(&inode->i_data);
1760db59e59SAl Viro 	clear_inode(inode);
1770db59e59SAl Viro 	if (S_ISLNK(inode->i_mode))
1785723cb01SAl Viro 		kfree(inode->i_link);
1790db59e59SAl Viro }
1800db59e59SAl Viro 
181d6e48686SLudwig Nussel static const struct super_operations debugfs_super_operations = {
182d6e48686SLudwig Nussel 	.statfs		= simple_statfs,
183d6e48686SLudwig Nussel 	.remount_fs	= debugfs_remount,
184d6e48686SLudwig Nussel 	.show_options	= debugfs_show_options,
1850db59e59SAl Viro 	.evict_inode	= debugfs_evict_inode,
186d6e48686SLudwig Nussel };
187d6e48686SLudwig Nussel 
18877b3da6eSAl Viro static struct vfsmount *debugfs_automount(struct path *path)
18977b3da6eSAl Viro {
19077b3da6eSAl Viro 	struct vfsmount *(*f)(void *);
19177b3da6eSAl Viro 	f = (struct vfsmount *(*)(void *))path->dentry->d_fsdata;
1922b0143b5SDavid Howells 	return f(d_inode(path->dentry)->i_private);
19377b3da6eSAl Viro }
19477b3da6eSAl Viro 
19577b3da6eSAl Viro static const struct dentry_operations debugfs_dops = {
19677b3da6eSAl Viro 	.d_delete = always_delete_dentry,
19777b3da6eSAl Viro 	.d_automount = debugfs_automount,
19877b3da6eSAl Viro };
19977b3da6eSAl Viro 
2001da177e4SLinus Torvalds static int debug_fill_super(struct super_block *sb, void *data, int silent)
2011da177e4SLinus Torvalds {
2021da177e4SLinus Torvalds 	static struct tree_descr debug_files[] = {{""}};
203d6e48686SLudwig Nussel 	struct debugfs_fs_info *fsi;
204d6e48686SLudwig Nussel 	int err;
2051da177e4SLinus Torvalds 
206d6e48686SLudwig Nussel 	save_mount_options(sb, data);
207d6e48686SLudwig Nussel 
208d6e48686SLudwig Nussel 	fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
209d6e48686SLudwig Nussel 	sb->s_fs_info = fsi;
210d6e48686SLudwig Nussel 	if (!fsi) {
211d6e48686SLudwig Nussel 		err = -ENOMEM;
212d6e48686SLudwig Nussel 		goto fail;
213d6e48686SLudwig Nussel 	}
214d6e48686SLudwig Nussel 
215d6e48686SLudwig Nussel 	err = debugfs_parse_options(data, &fsi->mount_opts);
216d6e48686SLudwig Nussel 	if (err)
217d6e48686SLudwig Nussel 		goto fail;
218d6e48686SLudwig Nussel 
219d6e48686SLudwig Nussel 	err  =  simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
220d6e48686SLudwig Nussel 	if (err)
221d6e48686SLudwig Nussel 		goto fail;
222d6e48686SLudwig Nussel 
223d6e48686SLudwig Nussel 	sb->s_op = &debugfs_super_operations;
22477b3da6eSAl Viro 	sb->s_d_op = &debugfs_dops;
225d6e48686SLudwig Nussel 
226d6e48686SLudwig Nussel 	debugfs_apply_options(sb);
227d6e48686SLudwig Nussel 
228d6e48686SLudwig Nussel 	return 0;
229d6e48686SLudwig Nussel 
230d6e48686SLudwig Nussel fail:
231d6e48686SLudwig Nussel 	kfree(fsi);
232d6e48686SLudwig Nussel 	sb->s_fs_info = NULL;
233d6e48686SLudwig Nussel 	return err;
2341da177e4SLinus Torvalds }
2351da177e4SLinus Torvalds 
236fc14f2feSAl Viro static struct dentry *debug_mount(struct file_system_type *fs_type,
2371da177e4SLinus Torvalds 			int flags, const char *dev_name,
238fc14f2feSAl Viro 			void *data)
2391da177e4SLinus Torvalds {
240fc14f2feSAl Viro 	return mount_single(fs_type, flags, data, debug_fill_super);
2411da177e4SLinus Torvalds }
2421da177e4SLinus Torvalds 
2431da177e4SLinus Torvalds static struct file_system_type debug_fs_type = {
2441da177e4SLinus Torvalds 	.owner =	THIS_MODULE,
2451da177e4SLinus Torvalds 	.name =		"debugfs",
246fc14f2feSAl Viro 	.mount =	debug_mount,
2471da177e4SLinus Torvalds 	.kill_sb =	kill_litter_super,
2481da177e4SLinus Torvalds };
2497f78e035SEric W. Biederman MODULE_ALIAS_FS("debugfs");
2501da177e4SLinus Torvalds 
251*a7c5437bSOmar Sandoval /**
252*a7c5437bSOmar Sandoval  * debugfs_lookup() - look up an existing debugfs file
253*a7c5437bSOmar Sandoval  * @name: a pointer to a string containing the name of the file to look up.
254*a7c5437bSOmar Sandoval  * @parent: a pointer to the parent dentry of the file.
255*a7c5437bSOmar Sandoval  *
256*a7c5437bSOmar Sandoval  * This function will return a pointer to a dentry if it succeeds.  If the file
257*a7c5437bSOmar Sandoval  * doesn't exist or an error occurs, %NULL will be returned.  The returned
258*a7c5437bSOmar Sandoval  * dentry must be passed to dput() when it is no longer needed.
259*a7c5437bSOmar Sandoval  *
260*a7c5437bSOmar Sandoval  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
261*a7c5437bSOmar Sandoval  * returned.
262*a7c5437bSOmar Sandoval  */
263*a7c5437bSOmar Sandoval struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
264*a7c5437bSOmar Sandoval {
265*a7c5437bSOmar Sandoval 	struct dentry *dentry;
266*a7c5437bSOmar Sandoval 
267*a7c5437bSOmar Sandoval 	if (IS_ERR(parent))
268*a7c5437bSOmar Sandoval 		return NULL;
269*a7c5437bSOmar Sandoval 
270*a7c5437bSOmar Sandoval 	if (!parent)
271*a7c5437bSOmar Sandoval 		parent = debugfs_mount->mnt_root;
272*a7c5437bSOmar Sandoval 
273*a7c5437bSOmar Sandoval 	inode_lock(d_inode(parent));
274*a7c5437bSOmar Sandoval 	dentry = lookup_one_len(name, parent, strlen(name));
275*a7c5437bSOmar Sandoval 	inode_unlock(d_inode(parent));
276*a7c5437bSOmar Sandoval 
277*a7c5437bSOmar Sandoval 	if (IS_ERR(dentry))
278*a7c5437bSOmar Sandoval 		return NULL;
279*a7c5437bSOmar Sandoval 	if (!d_really_is_positive(dentry)) {
280*a7c5437bSOmar Sandoval 		dput(dentry);
281*a7c5437bSOmar Sandoval 		return NULL;
282*a7c5437bSOmar Sandoval 	}
283*a7c5437bSOmar Sandoval 	return dentry;
284*a7c5437bSOmar Sandoval }
285*a7c5437bSOmar Sandoval EXPORT_SYMBOL_GPL(debugfs_lookup);
286*a7c5437bSOmar Sandoval 
287190afd81SAl Viro static struct dentry *start_creating(const char *name, struct dentry *parent)
288c3b1a350SAl Viro {
289190afd81SAl Viro 	struct dentry *dentry;
290c3b1a350SAl Viro 	int error;
291c3b1a350SAl Viro 
292c3b1a350SAl Viro 	pr_debug("debugfs: creating file '%s'\n",name);
293c3b1a350SAl Viro 
294c9e15f25SGreg KH 	if (IS_ERR(parent))
295c9e15f25SGreg KH 		return parent;
296c9e15f25SGreg KH 
297c3b1a350SAl Viro 	error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
298c3b1a350SAl Viro 			      &debugfs_mount_count);
299c3b1a350SAl Viro 	if (error)
300190afd81SAl Viro 		return ERR_PTR(error);
301c3b1a350SAl Viro 
302cfa57c11SAl Viro 	/* If the parent is not specified, we create it in the root.
303cfa57c11SAl Viro 	 * We need the root dentry to do this, which is in the super
304cfa57c11SAl Viro 	 * block. A pointer to that is in the struct vfsmount that we
305cfa57c11SAl Viro 	 * have around.
306cfa57c11SAl Viro 	 */
307cfa57c11SAl Viro 	if (!parent)
308cfa57c11SAl Viro 		parent = debugfs_mount->mnt_root;
309cfa57c11SAl Viro 
3105955102cSAl Viro 	inode_lock(d_inode(parent));
311cfa57c11SAl Viro 	dentry = lookup_one_len(name, parent, strlen(name));
3122b0143b5SDavid Howells 	if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
313190afd81SAl Viro 		dput(dentry);
314190afd81SAl Viro 		dentry = ERR_PTR(-EEXIST);
315190afd81SAl Viro 	}
3160ee9608cSDaniel Borkmann 
3170ee9608cSDaniel Borkmann 	if (IS_ERR(dentry)) {
3185955102cSAl Viro 		inode_unlock(d_inode(parent));
3190ee9608cSDaniel Borkmann 		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
3200ee9608cSDaniel Borkmann 	}
3210ee9608cSDaniel Borkmann 
322190afd81SAl Viro 	return dentry;
323190afd81SAl Viro }
324190afd81SAl Viro 
3255233e311SAl Viro static struct dentry *failed_creating(struct dentry *dentry)
326190afd81SAl Viro {
3275955102cSAl Viro 	inode_unlock(d_inode(dentry->d_parent));
328190afd81SAl Viro 	dput(dentry);
329190afd81SAl Viro 	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
3305233e311SAl Viro 	return NULL;
331190afd81SAl Viro }
3325233e311SAl Viro 
3335233e311SAl Viro static struct dentry *end_creating(struct dentry *dentry)
3345233e311SAl Viro {
3355955102cSAl Viro 	inode_unlock(d_inode(dentry->d_parent));
336190afd81SAl Viro 	return dentry;
337190afd81SAl Viro }
338190afd81SAl Viro 
33949d200deSNicolai Stange static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
34049d200deSNicolai Stange 				struct dentry *parent, void *data,
34149d200deSNicolai Stange 				const struct file_operations *proxy_fops,
34249d200deSNicolai Stange 				const struct file_operations *real_fops)
34349d200deSNicolai Stange {
34449d200deSNicolai Stange 	struct dentry *dentry;
34549d200deSNicolai Stange 	struct inode *inode;
34649d200deSNicolai Stange 
34749d200deSNicolai Stange 	if (!(mode & S_IFMT))
34849d200deSNicolai Stange 		mode |= S_IFREG;
34949d200deSNicolai Stange 	BUG_ON(!S_ISREG(mode));
35049d200deSNicolai Stange 	dentry = start_creating(name, parent);
35149d200deSNicolai Stange 
35249d200deSNicolai Stange 	if (IS_ERR(dentry))
35349d200deSNicolai Stange 		return NULL;
35449d200deSNicolai Stange 
35549d200deSNicolai Stange 	inode = debugfs_get_inode(dentry->d_sb);
35649d200deSNicolai Stange 	if (unlikely(!inode))
35749d200deSNicolai Stange 		return failed_creating(dentry);
35849d200deSNicolai Stange 
35949d200deSNicolai Stange 	inode->i_mode = mode;
36049d200deSNicolai Stange 	inode->i_private = data;
36149d200deSNicolai Stange 
36249d200deSNicolai Stange 	inode->i_fop = proxy_fops;
36349d200deSNicolai Stange 	dentry->d_fsdata = (void *)real_fops;
36449d200deSNicolai Stange 
36549d200deSNicolai Stange 	d_instantiate(dentry, inode);
36649d200deSNicolai Stange 	fsnotify_create(d_inode(dentry->d_parent), dentry);
36749d200deSNicolai Stange 	return end_creating(dentry);
36849d200deSNicolai Stange }
36949d200deSNicolai Stange 
3701da177e4SLinus Torvalds /**
3711da177e4SLinus Torvalds  * debugfs_create_file - create a file in the debugfs filesystem
3721da177e4SLinus Torvalds  * @name: a pointer to a string containing the name of the file to create.
373be030e65SAlberto Bertogli  * @mode: the permission that the file should have.
3741da177e4SLinus Torvalds  * @parent: a pointer to the parent dentry for this file.  This should be a
375e227867fSMasanari Iida  *          directory dentry if set.  If this parameter is NULL, then the
3761da177e4SLinus Torvalds  *          file will be created in the root of the debugfs filesystem.
3771da177e4SLinus Torvalds  * @data: a pointer to something that the caller will want to get to later
3788e18e294STheodore Ts'o  *        on.  The inode.i_private pointer will point to this value on
3791da177e4SLinus Torvalds  *        the open() call.
3801da177e4SLinus Torvalds  * @fops: a pointer to a struct file_operations that should be used for
3811da177e4SLinus Torvalds  *        this file.
3821da177e4SLinus Torvalds  *
3831da177e4SLinus Torvalds  * This is the basic "create a file" function for debugfs.  It allows for a
384be030e65SAlberto Bertogli  * wide range of flexibility in creating a file, or a directory (if you want
385be030e65SAlberto Bertogli  * to create a directory, the debugfs_create_dir() function is
3861da177e4SLinus Torvalds  * recommended to be used instead.)
3871da177e4SLinus Torvalds  *
3881da177e4SLinus Torvalds  * This function will return a pointer to a dentry if it succeeds.  This
3891da177e4SLinus Torvalds  * pointer must be passed to the debugfs_remove() function when the file is
3901da177e4SLinus Torvalds  * to be removed (no automatic cleanup happens if your module is unloaded,
3916468b3afSRandy Dunlap  * you are responsible here.)  If an error occurs, %NULL will be returned.
3921da177e4SLinus Torvalds  *
3936468b3afSRandy Dunlap  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
394873760fbSCornelia Huck  * returned.
3951da177e4SLinus Torvalds  */
396f4ae40a6SAl Viro struct dentry *debugfs_create_file(const char *name, umode_t mode,
3971da177e4SLinus Torvalds 				   struct dentry *parent, void *data,
39899ac48f5SArjan van de Ven 				   const struct file_operations *fops)
3991da177e4SLinus Torvalds {
400c3b1a350SAl Viro 
40149d200deSNicolai Stange 	return __debugfs_create_file(name, mode, parent, data,
40249d200deSNicolai Stange 				fops ? &debugfs_full_proxy_file_operations :
40349d200deSNicolai Stange 					&debugfs_noop_file_operations,
40449d200deSNicolai Stange 				fops);
4051da177e4SLinus Torvalds }
4061da177e4SLinus Torvalds EXPORT_SYMBOL_GPL(debugfs_create_file);
4071da177e4SLinus Torvalds 
408c6468808SNicolai Stange /**
409c6468808SNicolai Stange  * debugfs_create_file_unsafe - create a file in the debugfs filesystem
410c6468808SNicolai Stange  * @name: a pointer to a string containing the name of the file to create.
411c6468808SNicolai Stange  * @mode: the permission that the file should have.
412c6468808SNicolai Stange  * @parent: a pointer to the parent dentry for this file.  This should be a
413c6468808SNicolai Stange  *          directory dentry if set.  If this parameter is NULL, then the
414c6468808SNicolai Stange  *          file will be created in the root of the debugfs filesystem.
415c6468808SNicolai Stange  * @data: a pointer to something that the caller will want to get to later
416c6468808SNicolai Stange  *        on.  The inode.i_private pointer will point to this value on
417c6468808SNicolai Stange  *        the open() call.
418c6468808SNicolai Stange  * @fops: a pointer to a struct file_operations that should be used for
419c6468808SNicolai Stange  *        this file.
420c6468808SNicolai Stange  *
421c6468808SNicolai Stange  * debugfs_create_file_unsafe() is completely analogous to
422c6468808SNicolai Stange  * debugfs_create_file(), the only difference being that the fops
423c6468808SNicolai Stange  * handed it will not get protected against file removals by the
424c6468808SNicolai Stange  * debugfs core.
425c6468808SNicolai Stange  *
426c6468808SNicolai Stange  * It is your responsibility to protect your struct file_operation
427c6468808SNicolai Stange  * methods against file removals by means of debugfs_use_file_start()
428c6468808SNicolai Stange  * and debugfs_use_file_finish(). ->open() is still protected by
429c6468808SNicolai Stange  * debugfs though.
430c6468808SNicolai Stange  *
431c6468808SNicolai Stange  * Any struct file_operations defined by means of
432c6468808SNicolai Stange  * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
433c6468808SNicolai Stange  * thus, may be used here.
434c6468808SNicolai Stange  */
43549d200deSNicolai Stange struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
43649d200deSNicolai Stange 				   struct dentry *parent, void *data,
43749d200deSNicolai Stange 				   const struct file_operations *fops)
43849d200deSNicolai Stange {
43949d200deSNicolai Stange 
44049d200deSNicolai Stange 	return __debugfs_create_file(name, mode, parent, data,
44149d200deSNicolai Stange 				fops ? &debugfs_open_proxy_file_operations :
44249d200deSNicolai Stange 					&debugfs_noop_file_operations,
44349d200deSNicolai Stange 				fops);
44449d200deSNicolai Stange }
445c6468808SNicolai Stange EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
44649d200deSNicolai Stange 
4471da177e4SLinus Torvalds /**
448e59b4e91SDavid Howells  * debugfs_create_file_size - create a file in the debugfs filesystem
449e59b4e91SDavid Howells  * @name: a pointer to a string containing the name of the file to create.
450e59b4e91SDavid Howells  * @mode: the permission that the file should have.
451e59b4e91SDavid Howells  * @parent: a pointer to the parent dentry for this file.  This should be a
452e59b4e91SDavid Howells  *          directory dentry if set.  If this parameter is NULL, then the
453e59b4e91SDavid Howells  *          file will be created in the root of the debugfs filesystem.
454e59b4e91SDavid Howells  * @data: a pointer to something that the caller will want to get to later
455e59b4e91SDavid Howells  *        on.  The inode.i_private pointer will point to this value on
456e59b4e91SDavid Howells  *        the open() call.
457e59b4e91SDavid Howells  * @fops: a pointer to a struct file_operations that should be used for
458e59b4e91SDavid Howells  *        this file.
459e59b4e91SDavid Howells  * @file_size: initial file size
460e59b4e91SDavid Howells  *
461e59b4e91SDavid Howells  * This is the basic "create a file" function for debugfs.  It allows for a
462e59b4e91SDavid Howells  * wide range of flexibility in creating a file, or a directory (if you want
463e59b4e91SDavid Howells  * to create a directory, the debugfs_create_dir() function is
464e59b4e91SDavid Howells  * recommended to be used instead.)
465e59b4e91SDavid Howells  *
466e59b4e91SDavid Howells  * This function will return a pointer to a dentry if it succeeds.  This
467e59b4e91SDavid Howells  * pointer must be passed to the debugfs_remove() function when the file is
468e59b4e91SDavid Howells  * to be removed (no automatic cleanup happens if your module is unloaded,
469e59b4e91SDavid Howells  * you are responsible here.)  If an error occurs, %NULL will be returned.
470e59b4e91SDavid Howells  *
471e59b4e91SDavid Howells  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
472e59b4e91SDavid Howells  * returned.
473e59b4e91SDavid Howells  */
474e59b4e91SDavid Howells struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
475e59b4e91SDavid Howells 					struct dentry *parent, void *data,
476e59b4e91SDavid Howells 					const struct file_operations *fops,
477e59b4e91SDavid Howells 					loff_t file_size)
478e59b4e91SDavid Howells {
479e59b4e91SDavid Howells 	struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
480e59b4e91SDavid Howells 
481e59b4e91SDavid Howells 	if (de)
4822b0143b5SDavid Howells 		d_inode(de)->i_size = file_size;
483e59b4e91SDavid Howells 	return de;
484e59b4e91SDavid Howells }
485e59b4e91SDavid Howells EXPORT_SYMBOL_GPL(debugfs_create_file_size);
486e59b4e91SDavid Howells 
487e59b4e91SDavid Howells /**
4881da177e4SLinus Torvalds  * debugfs_create_dir - create a directory in the debugfs filesystem
4891da177e4SLinus Torvalds  * @name: a pointer to a string containing the name of the directory to
4901da177e4SLinus Torvalds  *        create.
4911da177e4SLinus Torvalds  * @parent: a pointer to the parent dentry for this file.  This should be a
492e227867fSMasanari Iida  *          directory dentry if set.  If this parameter is NULL, then the
4931da177e4SLinus Torvalds  *          directory will be created in the root of the debugfs filesystem.
4941da177e4SLinus Torvalds  *
4951da177e4SLinus Torvalds  * This function creates a directory in debugfs with the given name.
4961da177e4SLinus Torvalds  *
4971da177e4SLinus Torvalds  * This function will return a pointer to a dentry if it succeeds.  This
4981da177e4SLinus Torvalds  * pointer must be passed to the debugfs_remove() function when the file is
4991da177e4SLinus Torvalds  * to be removed (no automatic cleanup happens if your module is unloaded,
5006468b3afSRandy Dunlap  * you are responsible here.)  If an error occurs, %NULL will be returned.
5011da177e4SLinus Torvalds  *
5026468b3afSRandy Dunlap  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
503873760fbSCornelia Huck  * returned.
5041da177e4SLinus Torvalds  */
5051da177e4SLinus Torvalds struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
5061da177e4SLinus Torvalds {
507ad5abd5bSAl Viro 	struct dentry *dentry = start_creating(name, parent);
508680b3024SAl Viro 	struct inode *inode;
509ad5abd5bSAl Viro 
510ad5abd5bSAl Viro 	if (IS_ERR(dentry))
511ad5abd5bSAl Viro 		return NULL;
512ad5abd5bSAl Viro 
513edac65eaSAl Viro 	inode = debugfs_get_inode(dentry->d_sb);
514680b3024SAl Viro 	if (unlikely(!inode))
5155233e311SAl Viro 		return failed_creating(dentry);
516680b3024SAl Viro 
517edac65eaSAl Viro 	inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
518edac65eaSAl Viro 	inode->i_op = &simple_dir_inode_operations;
519edac65eaSAl Viro 	inode->i_fop = &simple_dir_operations;
520edac65eaSAl Viro 
521edac65eaSAl Viro 	/* directory inodes start off with i_nlink == 2 (for "." entry) */
522edac65eaSAl Viro 	inc_nlink(inode);
523680b3024SAl Viro 	d_instantiate(dentry, inode);
5242b0143b5SDavid Howells 	inc_nlink(d_inode(dentry->d_parent));
5252b0143b5SDavid Howells 	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
5265233e311SAl Viro 	return end_creating(dentry);
5271da177e4SLinus Torvalds }
5281da177e4SLinus Torvalds EXPORT_SYMBOL_GPL(debugfs_create_dir);
5291da177e4SLinus Torvalds 
5301da177e4SLinus Torvalds /**
53177b3da6eSAl Viro  * debugfs_create_automount - create automount point in the debugfs filesystem
53277b3da6eSAl Viro  * @name: a pointer to a string containing the name of the file to create.
53377b3da6eSAl Viro  * @parent: a pointer to the parent dentry for this file.  This should be a
53477b3da6eSAl Viro  *          directory dentry if set.  If this parameter is NULL, then the
53577b3da6eSAl Viro  *          file will be created in the root of the debugfs filesystem.
53677b3da6eSAl Viro  * @f: function to be called when pathname resolution steps on that one.
53777b3da6eSAl Viro  * @data: opaque argument to pass to f().
53877b3da6eSAl Viro  *
53977b3da6eSAl Viro  * @f should return what ->d_automount() would.
54077b3da6eSAl Viro  */
54177b3da6eSAl Viro struct dentry *debugfs_create_automount(const char *name,
54277b3da6eSAl Viro 					struct dentry *parent,
54377b3da6eSAl Viro 					struct vfsmount *(*f)(void *),
54477b3da6eSAl Viro 					void *data)
54577b3da6eSAl Viro {
54677b3da6eSAl Viro 	struct dentry *dentry = start_creating(name, parent);
54777b3da6eSAl Viro 	struct inode *inode;
54877b3da6eSAl Viro 
54977b3da6eSAl Viro 	if (IS_ERR(dentry))
55077b3da6eSAl Viro 		return NULL;
55177b3da6eSAl Viro 
55277b3da6eSAl Viro 	inode = debugfs_get_inode(dentry->d_sb);
55377b3da6eSAl Viro 	if (unlikely(!inode))
55477b3da6eSAl Viro 		return failed_creating(dentry);
55577b3da6eSAl Viro 
55687243debSSeth Forshee 	make_empty_dir_inode(inode);
55777b3da6eSAl Viro 	inode->i_flags |= S_AUTOMOUNT;
55877b3da6eSAl Viro 	inode->i_private = data;
55977b3da6eSAl Viro 	dentry->d_fsdata = (void *)f;
560a8f324a4SRoman Pen 	/* directory inodes start off with i_nlink == 2 (for "." entry) */
561a8f324a4SRoman Pen 	inc_nlink(inode);
56277b3da6eSAl Viro 	d_instantiate(dentry, inode);
563a8f324a4SRoman Pen 	inc_nlink(d_inode(dentry->d_parent));
564a8f324a4SRoman Pen 	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
56577b3da6eSAl Viro 	return end_creating(dentry);
56677b3da6eSAl Viro }
56777b3da6eSAl Viro EXPORT_SYMBOL(debugfs_create_automount);
56877b3da6eSAl Viro 
56977b3da6eSAl Viro /**
57066f54963SPeter Oberparleiter  * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
57166f54963SPeter Oberparleiter  * @name: a pointer to a string containing the name of the symbolic link to
57266f54963SPeter Oberparleiter  *        create.
57366f54963SPeter Oberparleiter  * @parent: a pointer to the parent dentry for this symbolic link.  This
574e227867fSMasanari Iida  *          should be a directory dentry if set.  If this parameter is NULL,
57566f54963SPeter Oberparleiter  *          then the symbolic link will be created in the root of the debugfs
57666f54963SPeter Oberparleiter  *          filesystem.
57766f54963SPeter Oberparleiter  * @target: a pointer to a string containing the path to the target of the
57866f54963SPeter Oberparleiter  *          symbolic link.
57966f54963SPeter Oberparleiter  *
58066f54963SPeter Oberparleiter  * This function creates a symbolic link with the given name in debugfs that
58166f54963SPeter Oberparleiter  * links to the given target path.
58266f54963SPeter Oberparleiter  *
58366f54963SPeter Oberparleiter  * This function will return a pointer to a dentry if it succeeds.  This
58466f54963SPeter Oberparleiter  * pointer must be passed to the debugfs_remove() function when the symbolic
58566f54963SPeter Oberparleiter  * link is to be removed (no automatic cleanup happens if your module is
58666f54963SPeter Oberparleiter  * unloaded, you are responsible here.)  If an error occurs, %NULL will be
58766f54963SPeter Oberparleiter  * returned.
58866f54963SPeter Oberparleiter  *
58966f54963SPeter Oberparleiter  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
590873760fbSCornelia Huck  * returned.
59166f54963SPeter Oberparleiter  */
59266f54963SPeter Oberparleiter struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
59366f54963SPeter Oberparleiter 				      const char *target)
59466f54963SPeter Oberparleiter {
595ad5abd5bSAl Viro 	struct dentry *dentry;
596680b3024SAl Viro 	struct inode *inode;
597680b3024SAl Viro 	char *link = kstrdup(target, GFP_KERNEL);
59866f54963SPeter Oberparleiter 	if (!link)
59966f54963SPeter Oberparleiter 		return NULL;
60066f54963SPeter Oberparleiter 
601ad5abd5bSAl Viro 	dentry = start_creating(name, parent);
602ad5abd5bSAl Viro 	if (IS_ERR(dentry)) {
60366f54963SPeter Oberparleiter 		kfree(link);
604ad5abd5bSAl Viro 		return NULL;
605ad5abd5bSAl Viro 	}
606ad5abd5bSAl Viro 
607edac65eaSAl Viro 	inode = debugfs_get_inode(dentry->d_sb);
608680b3024SAl Viro 	if (unlikely(!inode)) {
609ad5abd5bSAl Viro 		kfree(link);
6105233e311SAl Viro 		return failed_creating(dentry);
611680b3024SAl Viro 	}
612edac65eaSAl Viro 	inode->i_mode = S_IFLNK | S_IRWXUGO;
6135723cb01SAl Viro 	inode->i_op = &simple_symlink_inode_operations;
6145723cb01SAl Viro 	inode->i_link = link;
615680b3024SAl Viro 	d_instantiate(dentry, inode);
6165233e311SAl Viro 	return end_creating(dentry);
61766f54963SPeter Oberparleiter }
61866f54963SPeter Oberparleiter EXPORT_SYMBOL_GPL(debugfs_create_symlink);
61966f54963SPeter Oberparleiter 
62025d41d84SJan Kara static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
6211da177e4SLinus Torvalds {
62265c33336SMathieu Desnoyers 	int ret = 0;
6231da177e4SLinus Torvalds 
624dc3f4198SAl Viro 	if (simple_positive(dentry)) {
62529a7f3adSMathieu Desnoyers 		dget(dentry);
6267ceab50cSDavid Howells 		if (d_is_dir(dentry))
6272b0143b5SDavid Howells 			ret = simple_rmdir(d_inode(parent), dentry);
6280db59e59SAl Viro 		else
6292b0143b5SDavid Howells 			simple_unlink(d_inode(parent), dentry);
63029a7f3adSMathieu Desnoyers 		if (!ret)
63129a7f3adSMathieu Desnoyers 			d_delete(dentry);
63229a7f3adSMathieu Desnoyers 		dput(dentry);
6331da177e4SLinus Torvalds 	}
63425d41d84SJan Kara 	return ret;
6359505e637SHaavard Skinnemoen }
6369505e637SHaavard Skinnemoen 
6379505e637SHaavard Skinnemoen /**
6389505e637SHaavard Skinnemoen  * debugfs_remove - removes a file or directory from the debugfs filesystem
6399505e637SHaavard Skinnemoen  * @dentry: a pointer to a the dentry of the file or directory to be
640398dc4adSUlf Magnusson  *          removed.  If this parameter is NULL or an error value, nothing
641398dc4adSUlf Magnusson  *          will be done.
6429505e637SHaavard Skinnemoen  *
6439505e637SHaavard Skinnemoen  * This function removes a file or directory in debugfs that was previously
6449505e637SHaavard Skinnemoen  * created with a call to another debugfs function (like
6459505e637SHaavard Skinnemoen  * debugfs_create_file() or variants thereof.)
6469505e637SHaavard Skinnemoen  *
6479505e637SHaavard Skinnemoen  * This function is required to be called in order for the file to be
6489505e637SHaavard Skinnemoen  * removed, no automatic cleanup of files will happen when a module is
6499505e637SHaavard Skinnemoen  * removed, you are responsible here.
6509505e637SHaavard Skinnemoen  */
6519505e637SHaavard Skinnemoen void debugfs_remove(struct dentry *dentry)
6529505e637SHaavard Skinnemoen {
6539505e637SHaavard Skinnemoen 	struct dentry *parent;
65425d41d84SJan Kara 	int ret;
6559505e637SHaavard Skinnemoen 
656a59d6293SArend van Spriel 	if (IS_ERR_OR_NULL(dentry))
6579505e637SHaavard Skinnemoen 		return;
6589505e637SHaavard Skinnemoen 
6599505e637SHaavard Skinnemoen 	parent = dentry->d_parent;
6605955102cSAl Viro 	inode_lock(d_inode(parent));
66125d41d84SJan Kara 	ret = __debugfs_remove(dentry, parent);
6625955102cSAl Viro 	inode_unlock(d_inode(parent));
66325d41d84SJan Kara 	if (!ret)
6641da177e4SLinus Torvalds 		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
66549d200deSNicolai Stange 
6669fd4dcecSNicolai Stange 	synchronize_srcu(&debugfs_srcu);
6671da177e4SLinus Torvalds }
6681da177e4SLinus Torvalds EXPORT_SYMBOL_GPL(debugfs_remove);
6691da177e4SLinus Torvalds 
670cfc94cdfSJan Kara /**
6719505e637SHaavard Skinnemoen  * debugfs_remove_recursive - recursively removes a directory
672398dc4adSUlf Magnusson  * @dentry: a pointer to a the dentry of the directory to be removed.  If this
673398dc4adSUlf Magnusson  *          parameter is NULL or an error value, nothing will be done.
6749505e637SHaavard Skinnemoen  *
6759505e637SHaavard Skinnemoen  * This function recursively removes a directory tree in debugfs that
6769505e637SHaavard Skinnemoen  * was previously created with a call to another debugfs function
6779505e637SHaavard Skinnemoen  * (like debugfs_create_file() or variants thereof.)
6789505e637SHaavard Skinnemoen  *
6799505e637SHaavard Skinnemoen  * This function is required to be called in order for the file to be
6809505e637SHaavard Skinnemoen  * removed, no automatic cleanup of files will happen when a module is
6819505e637SHaavard Skinnemoen  * removed, you are responsible here.
6829505e637SHaavard Skinnemoen  */
6839505e637SHaavard Skinnemoen void debugfs_remove_recursive(struct dentry *dentry)
6849505e637SHaavard Skinnemoen {
685485d4402SSteven Rostedt 	struct dentry *child, *parent;
6869505e637SHaavard Skinnemoen 
687a59d6293SArend van Spriel 	if (IS_ERR_OR_NULL(dentry))
6889505e637SHaavard Skinnemoen 		return;
6899505e637SHaavard Skinnemoen 
6909505e637SHaavard Skinnemoen 	parent = dentry;
691776164c1SOleg Nesterov  down:
6925955102cSAl Viro 	inode_lock(d_inode(parent));
693485d4402SSteven Rostedt  loop:
694485d4402SSteven Rostedt 	/*
695485d4402SSteven Rostedt 	 * The parent->d_subdirs is protected by the d_lock. Outside that
696485d4402SSteven Rostedt 	 * lock, the child can be unlinked and set to be freed which can
697485d4402SSteven Rostedt 	 * use the d_u.d_child as the rcu head and corrupt this list.
698485d4402SSteven Rostedt 	 */
699485d4402SSteven Rostedt 	spin_lock(&parent->d_lock);
700946e51f2SAl Viro 	list_for_each_entry(child, &parent->d_subdirs, d_child) {
701dc3f4198SAl Viro 		if (!simple_positive(child))
702776164c1SOleg Nesterov 			continue;
7039505e637SHaavard Skinnemoen 
704776164c1SOleg Nesterov 		/* perhaps simple_empty(child) makes more sense */
7059505e637SHaavard Skinnemoen 		if (!list_empty(&child->d_subdirs)) {
706485d4402SSteven Rostedt 			spin_unlock(&parent->d_lock);
7075955102cSAl Viro 			inode_unlock(d_inode(parent));
7089505e637SHaavard Skinnemoen 			parent = child;
709776164c1SOleg Nesterov 			goto down;
7109505e637SHaavard Skinnemoen 		}
711485d4402SSteven Rostedt 
712485d4402SSteven Rostedt 		spin_unlock(&parent->d_lock);
713485d4402SSteven Rostedt 
714776164c1SOleg Nesterov 		if (!__debugfs_remove(child, parent))
715776164c1SOleg Nesterov 			simple_release_fs(&debugfs_mount, &debugfs_mount_count);
716485d4402SSteven Rostedt 
717485d4402SSteven Rostedt 		/*
718485d4402SSteven Rostedt 		 * The parent->d_lock protects agaist child from unlinking
719485d4402SSteven Rostedt 		 * from d_subdirs. When releasing the parent->d_lock we can
720485d4402SSteven Rostedt 		 * no longer trust that the next pointer is valid.
721485d4402SSteven Rostedt 		 * Restart the loop. We'll skip this one with the
722dc3f4198SAl Viro 		 * simple_positive() check.
723485d4402SSteven Rostedt 		 */
724485d4402SSteven Rostedt 		goto loop;
725776164c1SOleg Nesterov 	}
726485d4402SSteven Rostedt 	spin_unlock(&parent->d_lock);
727776164c1SOleg Nesterov 
7285955102cSAl Viro 	inode_unlock(d_inode(parent));
729776164c1SOleg Nesterov 	child = parent;
730776164c1SOleg Nesterov 	parent = parent->d_parent;
7315955102cSAl Viro 	inode_lock(d_inode(parent));
732776164c1SOleg Nesterov 
733485d4402SSteven Rostedt 	if (child != dentry)
734485d4402SSteven Rostedt 		/* go up */
735485d4402SSteven Rostedt 		goto loop;
73656a83cc9SSteven Rostedt 
737776164c1SOleg Nesterov 	if (!__debugfs_remove(child, parent))
7389505e637SHaavard Skinnemoen 		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
7395955102cSAl Viro 	inode_unlock(d_inode(parent));
74049d200deSNicolai Stange 
7419fd4dcecSNicolai Stange 	synchronize_srcu(&debugfs_srcu);
7429505e637SHaavard Skinnemoen }
7439505e637SHaavard Skinnemoen EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
7449505e637SHaavard Skinnemoen 
7459505e637SHaavard Skinnemoen /**
746cfc94cdfSJan Kara  * debugfs_rename - rename a file/directory in the debugfs filesystem
747cfc94cdfSJan Kara  * @old_dir: a pointer to the parent dentry for the renamed object. This
748cfc94cdfSJan Kara  *          should be a directory dentry.
749cfc94cdfSJan Kara  * @old_dentry: dentry of an object to be renamed.
750cfc94cdfSJan Kara  * @new_dir: a pointer to the parent dentry where the object should be
751cfc94cdfSJan Kara  *          moved. This should be a directory dentry.
752cfc94cdfSJan Kara  * @new_name: a pointer to a string containing the target name.
753cfc94cdfSJan Kara  *
754cfc94cdfSJan Kara  * This function renames a file/directory in debugfs.  The target must not
755cfc94cdfSJan Kara  * exist for rename to succeed.
756cfc94cdfSJan Kara  *
757cfc94cdfSJan Kara  * This function will return a pointer to old_dentry (which is updated to
758cfc94cdfSJan Kara  * reflect renaming) if it succeeds. If an error occurs, %NULL will be
759cfc94cdfSJan Kara  * returned.
760cfc94cdfSJan Kara  *
761cfc94cdfSJan Kara  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
762cfc94cdfSJan Kara  * returned.
763cfc94cdfSJan Kara  */
764cfc94cdfSJan Kara struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
765cfc94cdfSJan Kara 		struct dentry *new_dir, const char *new_name)
766cfc94cdfSJan Kara {
767cfc94cdfSJan Kara 	int error;
768cfc94cdfSJan Kara 	struct dentry *dentry = NULL, *trap;
769cfc94cdfSJan Kara 	const char *old_name;
770cfc94cdfSJan Kara 
771cfc94cdfSJan Kara 	trap = lock_rename(new_dir, old_dir);
772cfc94cdfSJan Kara 	/* Source or destination directories don't exist? */
7732b0143b5SDavid Howells 	if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
774cfc94cdfSJan Kara 		goto exit;
775cfc94cdfSJan Kara 	/* Source does not exist, cyclic rename, or mountpoint? */
7762b0143b5SDavid Howells 	if (d_really_is_negative(old_dentry) || old_dentry == trap ||
777cfc94cdfSJan Kara 	    d_mountpoint(old_dentry))
778cfc94cdfSJan Kara 		goto exit;
779cfc94cdfSJan Kara 	dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
780cfc94cdfSJan Kara 	/* Lookup failed, cyclic rename or target exists? */
7812b0143b5SDavid Howells 	if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
782cfc94cdfSJan Kara 		goto exit;
783cfc94cdfSJan Kara 
784cfc94cdfSJan Kara 	old_name = fsnotify_oldname_init(old_dentry->d_name.name);
785cfc94cdfSJan Kara 
7862b0143b5SDavid Howells 	error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
787e0e0be8aSMiklos Szeredi 			      dentry, 0);
788cfc94cdfSJan Kara 	if (error) {
789cfc94cdfSJan Kara 		fsnotify_oldname_free(old_name);
790cfc94cdfSJan Kara 		goto exit;
791cfc94cdfSJan Kara 	}
792cfc94cdfSJan Kara 	d_move(old_dentry, dentry);
7932b0143b5SDavid Howells 	fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name,
794e36cb0b8SDavid Howells 		d_is_dir(old_dentry),
7955a190ae6SAl Viro 		NULL, old_dentry);
796cfc94cdfSJan Kara 	fsnotify_oldname_free(old_name);
797cfc94cdfSJan Kara 	unlock_rename(new_dir, old_dir);
798cfc94cdfSJan Kara 	dput(dentry);
799cfc94cdfSJan Kara 	return old_dentry;
800cfc94cdfSJan Kara exit:
801cfc94cdfSJan Kara 	if (dentry && !IS_ERR(dentry))
802cfc94cdfSJan Kara 		dput(dentry);
803cfc94cdfSJan Kara 	unlock_rename(new_dir, old_dir);
804cfc94cdfSJan Kara 	return NULL;
805cfc94cdfSJan Kara }
806cfc94cdfSJan Kara EXPORT_SYMBOL_GPL(debugfs_rename);
807cfc94cdfSJan Kara 
808c0f92ba9SFrederic Weisbecker /**
809c0f92ba9SFrederic Weisbecker  * debugfs_initialized - Tells whether debugfs has been registered
810c0f92ba9SFrederic Weisbecker  */
811c0f92ba9SFrederic Weisbecker bool debugfs_initialized(void)
812c0f92ba9SFrederic Weisbecker {
813c0f92ba9SFrederic Weisbecker 	return debugfs_registered;
814c0f92ba9SFrederic Weisbecker }
815c0f92ba9SFrederic Weisbecker EXPORT_SYMBOL_GPL(debugfs_initialized);
816c0f92ba9SFrederic Weisbecker 
8171da177e4SLinus Torvalds static int __init debugfs_init(void)
8181da177e4SLinus Torvalds {
8191da177e4SLinus Torvalds 	int retval;
8201da177e4SLinus Torvalds 
821f9bb4882SEric W. Biederman 	retval = sysfs_create_mount_point(kernel_kobj, "debug");
822f9bb4882SEric W. Biederman 	if (retval)
823f9bb4882SEric W. Biederman 		return retval;
8241da177e4SLinus Torvalds 
8251da177e4SLinus Torvalds 	retval = register_filesystem(&debug_fs_type);
8261da177e4SLinus Torvalds 	if (retval)
827f9bb4882SEric W. Biederman 		sysfs_remove_mount_point(kernel_kobj, "debug");
828c0f92ba9SFrederic Weisbecker 	else
829c0f92ba9SFrederic Weisbecker 		debugfs_registered = true;
830c0f92ba9SFrederic Weisbecker 
8311da177e4SLinus Torvalds 	return retval;
8321da177e4SLinus Torvalds }
8331da177e4SLinus Torvalds core_initcall(debugfs_init);
8341da177e4SLinus Torvalds 
835