xref: /linux-6.15/fs/debugfs/inode.c (revision 01eadc8d)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  inode.c - part of debugfs, a tiny little debug file system
4  *
5  *  Copyright (C) 2004,2019 Greg Kroah-Hartman <[email protected]>
6  *  Copyright (C) 2004 IBM Inc.
7  *  Copyright (C) 2019 Linux Foundation <[email protected]>
8  *
9  *  debugfs is for people to use instead of /proc or /sys.
10  *  See ./Documentation/core-api/kernel-api.rst for more details.
11  */
12 
13 #define pr_fmt(fmt)	"debugfs: " fmt
14 
15 #include <linux/module.h>
16 #include <linux/fs.h>
17 #include <linux/mount.h>
18 #include <linux/pagemap.h>
19 #include <linux/init.h>
20 #include <linux/kobject.h>
21 #include <linux/namei.h>
22 #include <linux/debugfs.h>
23 #include <linux/fsnotify.h>
24 #include <linux/string.h>
25 #include <linux/seq_file.h>
26 #include <linux/parser.h>
27 #include <linux/magic.h>
28 #include <linux/slab.h>
29 #include <linux/security.h>
30 
31 #include "internal.h"
32 
33 #define DEBUGFS_DEFAULT_MODE	0700
34 
35 static struct vfsmount *debugfs_mount;
36 static int debugfs_mount_count;
37 static bool debugfs_registered;
38 static unsigned int debugfs_allow = DEFAULT_DEBUGFS_ALLOW_BITS;
39 
40 /*
41  * Don't allow access attributes to be changed whilst the kernel is locked down
42  * so that we can use the file mode as part of a heuristic to determine whether
43  * to lock down individual files.
44  */
45 static int debugfs_setattr(struct user_namespace *mnt_userns,
46 			   struct dentry *dentry, struct iattr *ia)
47 {
48 	int ret = security_locked_down(LOCKDOWN_DEBUGFS);
49 
50 	if (ret && (ia->ia_valid & (ATTR_MODE | ATTR_UID | ATTR_GID)))
51 		return ret;
52 	return simple_setattr(&init_user_ns, dentry, ia);
53 }
54 
55 static const struct inode_operations debugfs_file_inode_operations = {
56 	.setattr	= debugfs_setattr,
57 };
58 static const struct inode_operations debugfs_dir_inode_operations = {
59 	.lookup		= simple_lookup,
60 	.setattr	= debugfs_setattr,
61 };
62 static const struct inode_operations debugfs_symlink_inode_operations = {
63 	.get_link	= simple_get_link,
64 	.setattr	= debugfs_setattr,
65 };
66 
67 static struct inode *debugfs_get_inode(struct super_block *sb)
68 {
69 	struct inode *inode = new_inode(sb);
70 	if (inode) {
71 		inode->i_ino = get_next_ino();
72 		inode->i_atime = inode->i_mtime =
73 			inode->i_ctime = current_time(inode);
74 	}
75 	return inode;
76 }
77 
78 struct debugfs_mount_opts {
79 	kuid_t uid;
80 	kgid_t gid;
81 	umode_t mode;
82 };
83 
84 enum {
85 	Opt_uid,
86 	Opt_gid,
87 	Opt_mode,
88 	Opt_err
89 };
90 
91 static const match_table_t tokens = {
92 	{Opt_uid, "uid=%u"},
93 	{Opt_gid, "gid=%u"},
94 	{Opt_mode, "mode=%o"},
95 	{Opt_err, NULL}
96 };
97 
98 struct debugfs_fs_info {
99 	struct debugfs_mount_opts mount_opts;
100 };
101 
102 static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
103 {
104 	substring_t args[MAX_OPT_ARGS];
105 	int option;
106 	int token;
107 	kuid_t uid;
108 	kgid_t gid;
109 	char *p;
110 
111 	opts->mode = DEBUGFS_DEFAULT_MODE;
112 
113 	while ((p = strsep(&data, ",")) != NULL) {
114 		if (!*p)
115 			continue;
116 
117 		token = match_token(p, tokens, args);
118 		switch (token) {
119 		case Opt_uid:
120 			if (match_int(&args[0], &option))
121 				return -EINVAL;
122 			uid = make_kuid(current_user_ns(), option);
123 			if (!uid_valid(uid))
124 				return -EINVAL;
125 			opts->uid = uid;
126 			break;
127 		case Opt_gid:
128 			if (match_int(&args[0], &option))
129 				return -EINVAL;
130 			gid = make_kgid(current_user_ns(), option);
131 			if (!gid_valid(gid))
132 				return -EINVAL;
133 			opts->gid = gid;
134 			break;
135 		case Opt_mode:
136 			if (match_octal(&args[0], &option))
137 				return -EINVAL;
138 			opts->mode = option & S_IALLUGO;
139 			break;
140 		/*
141 		 * We might like to report bad mount options here;
142 		 * but traditionally debugfs has ignored all mount options
143 		 */
144 		}
145 	}
146 
147 	return 0;
148 }
149 
150 static int debugfs_apply_options(struct super_block *sb)
151 {
152 	struct debugfs_fs_info *fsi = sb->s_fs_info;
153 	struct inode *inode = d_inode(sb->s_root);
154 	struct debugfs_mount_opts *opts = &fsi->mount_opts;
155 
156 	inode->i_mode &= ~S_IALLUGO;
157 	inode->i_mode |= opts->mode;
158 
159 	inode->i_uid = opts->uid;
160 	inode->i_gid = opts->gid;
161 
162 	return 0;
163 }
164 
165 static int debugfs_remount(struct super_block *sb, int *flags, char *data)
166 {
167 	int err;
168 	struct debugfs_fs_info *fsi = sb->s_fs_info;
169 
170 	sync_filesystem(sb);
171 	err = debugfs_parse_options(data, &fsi->mount_opts);
172 	if (err)
173 		goto fail;
174 
175 	debugfs_apply_options(sb);
176 
177 fail:
178 	return err;
179 }
180 
181 static int debugfs_show_options(struct seq_file *m, struct dentry *root)
182 {
183 	struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
184 	struct debugfs_mount_opts *opts = &fsi->mount_opts;
185 
186 	if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
187 		seq_printf(m, ",uid=%u",
188 			   from_kuid_munged(&init_user_ns, opts->uid));
189 	if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
190 		seq_printf(m, ",gid=%u",
191 			   from_kgid_munged(&init_user_ns, opts->gid));
192 	if (opts->mode != DEBUGFS_DEFAULT_MODE)
193 		seq_printf(m, ",mode=%o", opts->mode);
194 
195 	return 0;
196 }
197 
198 static void debugfs_free_inode(struct inode *inode)
199 {
200 	if (S_ISLNK(inode->i_mode))
201 		kfree(inode->i_link);
202 	free_inode_nonrcu(inode);
203 }
204 
205 static const struct super_operations debugfs_super_operations = {
206 	.statfs		= simple_statfs,
207 	.remount_fs	= debugfs_remount,
208 	.show_options	= debugfs_show_options,
209 	.free_inode	= debugfs_free_inode,
210 };
211 
212 static void debugfs_release_dentry(struct dentry *dentry)
213 {
214 	void *fsd = dentry->d_fsdata;
215 
216 	if (!((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT))
217 		kfree(dentry->d_fsdata);
218 }
219 
220 static struct vfsmount *debugfs_automount(struct path *path)
221 {
222 	debugfs_automount_t f;
223 	f = (debugfs_automount_t)path->dentry->d_fsdata;
224 	return f(path->dentry, d_inode(path->dentry)->i_private);
225 }
226 
227 static const struct dentry_operations debugfs_dops = {
228 	.d_delete = always_delete_dentry,
229 	.d_release = debugfs_release_dentry,
230 	.d_automount = debugfs_automount,
231 };
232 
233 static int debug_fill_super(struct super_block *sb, void *data, int silent)
234 {
235 	static const struct tree_descr debug_files[] = {{""}};
236 	struct debugfs_fs_info *fsi;
237 	int err;
238 
239 	fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
240 	sb->s_fs_info = fsi;
241 	if (!fsi) {
242 		err = -ENOMEM;
243 		goto fail;
244 	}
245 
246 	err = debugfs_parse_options(data, &fsi->mount_opts);
247 	if (err)
248 		goto fail;
249 
250 	err  =  simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
251 	if (err)
252 		goto fail;
253 
254 	sb->s_op = &debugfs_super_operations;
255 	sb->s_d_op = &debugfs_dops;
256 
257 	debugfs_apply_options(sb);
258 
259 	return 0;
260 
261 fail:
262 	kfree(fsi);
263 	sb->s_fs_info = NULL;
264 	return err;
265 }
266 
267 static struct dentry *debug_mount(struct file_system_type *fs_type,
268 			int flags, const char *dev_name,
269 			void *data)
270 {
271 	if (!(debugfs_allow & DEBUGFS_ALLOW_API))
272 		return ERR_PTR(-EPERM);
273 
274 	return mount_single(fs_type, flags, data, debug_fill_super);
275 }
276 
277 static struct file_system_type debug_fs_type = {
278 	.owner =	THIS_MODULE,
279 	.name =		"debugfs",
280 	.mount =	debug_mount,
281 	.kill_sb =	kill_litter_super,
282 };
283 MODULE_ALIAS_FS("debugfs");
284 
285 /**
286  * debugfs_lookup() - look up an existing debugfs file
287  * @name: a pointer to a string containing the name of the file to look up.
288  * @parent: a pointer to the parent dentry of the file.
289  *
290  * This function will return a pointer to a dentry if it succeeds.  If the file
291  * doesn't exist or an error occurs, %NULL will be returned.  The returned
292  * dentry must be passed to dput() when it is no longer needed.
293  *
294  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
295  * returned.
296  */
297 struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
298 {
299 	struct dentry *dentry;
300 
301 	if (IS_ERR(parent))
302 		return NULL;
303 
304 	if (!parent)
305 		parent = debugfs_mount->mnt_root;
306 
307 	dentry = lookup_positive_unlocked(name, parent, strlen(name));
308 	if (IS_ERR(dentry))
309 		return NULL;
310 	return dentry;
311 }
312 EXPORT_SYMBOL_GPL(debugfs_lookup);
313 
314 static struct dentry *start_creating(const char *name, struct dentry *parent)
315 {
316 	struct dentry *dentry;
317 	int error;
318 
319 	if (!(debugfs_allow & DEBUGFS_ALLOW_API))
320 		return ERR_PTR(-EPERM);
321 
322 	pr_debug("creating file '%s'\n", name);
323 
324 	if (IS_ERR(parent))
325 		return parent;
326 
327 	error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
328 			      &debugfs_mount_count);
329 	if (error) {
330 		pr_err("Unable to pin filesystem for file '%s'\n", name);
331 		return ERR_PTR(error);
332 	}
333 
334 	/* If the parent is not specified, we create it in the root.
335 	 * We need the root dentry to do this, which is in the super
336 	 * block. A pointer to that is in the struct vfsmount that we
337 	 * have around.
338 	 */
339 	if (!parent)
340 		parent = debugfs_mount->mnt_root;
341 
342 	inode_lock(d_inode(parent));
343 	if (unlikely(IS_DEADDIR(d_inode(parent))))
344 		dentry = ERR_PTR(-ENOENT);
345 	else
346 		dentry = lookup_one_len(name, parent, strlen(name));
347 	if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
348 		if (d_is_dir(dentry))
349 			pr_err("Directory '%s' with parent '%s' already present!\n",
350 			       name, parent->d_name.name);
351 		else
352 			pr_err("File '%s' in directory '%s' already present!\n",
353 			       name, parent->d_name.name);
354 		dput(dentry);
355 		dentry = ERR_PTR(-EEXIST);
356 	}
357 
358 	if (IS_ERR(dentry)) {
359 		inode_unlock(d_inode(parent));
360 		simple_release_fs(&debugfs_mount, &debugfs_mount_count);
361 	}
362 
363 	return dentry;
364 }
365 
366 static struct dentry *failed_creating(struct dentry *dentry)
367 {
368 	inode_unlock(d_inode(dentry->d_parent));
369 	dput(dentry);
370 	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
371 	return ERR_PTR(-ENOMEM);
372 }
373 
374 static struct dentry *end_creating(struct dentry *dentry)
375 {
376 	inode_unlock(d_inode(dentry->d_parent));
377 	return dentry;
378 }
379 
380 static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
381 				struct dentry *parent, void *data,
382 				const struct file_operations *proxy_fops,
383 				const struct file_operations *real_fops)
384 {
385 	struct dentry *dentry;
386 	struct inode *inode;
387 
388 	if (!(mode & S_IFMT))
389 		mode |= S_IFREG;
390 	BUG_ON(!S_ISREG(mode));
391 	dentry = start_creating(name, parent);
392 
393 	if (IS_ERR(dentry))
394 		return dentry;
395 
396 	if (!(debugfs_allow & DEBUGFS_ALLOW_API)) {
397 		failed_creating(dentry);
398 		return ERR_PTR(-EPERM);
399 	}
400 
401 	inode = debugfs_get_inode(dentry->d_sb);
402 	if (unlikely(!inode)) {
403 		pr_err("out of free dentries, can not create file '%s'\n",
404 		       name);
405 		return failed_creating(dentry);
406 	}
407 
408 	inode->i_mode = mode;
409 	inode->i_private = data;
410 
411 	inode->i_op = &debugfs_file_inode_operations;
412 	inode->i_fop = proxy_fops;
413 	dentry->d_fsdata = (void *)((unsigned long)real_fops |
414 				DEBUGFS_FSDATA_IS_REAL_FOPS_BIT);
415 
416 	d_instantiate(dentry, inode);
417 	fsnotify_create(d_inode(dentry->d_parent), dentry);
418 	return end_creating(dentry);
419 }
420 
421 /**
422  * debugfs_create_file - create a file in the debugfs filesystem
423  * @name: a pointer to a string containing the name of the file to create.
424  * @mode: the permission that the file should have.
425  * @parent: a pointer to the parent dentry for this file.  This should be a
426  *          directory dentry if set.  If this parameter is NULL, then the
427  *          file will be created in the root of the debugfs filesystem.
428  * @data: a pointer to something that the caller will want to get to later
429  *        on.  The inode.i_private pointer will point to this value on
430  *        the open() call.
431  * @fops: a pointer to a struct file_operations that should be used for
432  *        this file.
433  *
434  * This is the basic "create a file" function for debugfs.  It allows for a
435  * wide range of flexibility in creating a file, or a directory (if you want
436  * to create a directory, the debugfs_create_dir() function is
437  * recommended to be used instead.)
438  *
439  * This function will return a pointer to a dentry if it succeeds.  This
440  * pointer must be passed to the debugfs_remove() function when the file is
441  * to be removed (no automatic cleanup happens if your module is unloaded,
442  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
443  * returned.
444  *
445  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
446  * returned.
447  */
448 struct dentry *debugfs_create_file(const char *name, umode_t mode,
449 				   struct dentry *parent, void *data,
450 				   const struct file_operations *fops)
451 {
452 
453 	return __debugfs_create_file(name, mode, parent, data,
454 				fops ? &debugfs_full_proxy_file_operations :
455 					&debugfs_noop_file_operations,
456 				fops);
457 }
458 EXPORT_SYMBOL_GPL(debugfs_create_file);
459 
460 /**
461  * debugfs_create_file_unsafe - create a file in the debugfs filesystem
462  * @name: a pointer to a string containing the name of the file to create.
463  * @mode: the permission that the file should have.
464  * @parent: a pointer to the parent dentry for this file.  This should be a
465  *          directory dentry if set.  If this parameter is NULL, then the
466  *          file will be created in the root of the debugfs filesystem.
467  * @data: a pointer to something that the caller will want to get to later
468  *        on.  The inode.i_private pointer will point to this value on
469  *        the open() call.
470  * @fops: a pointer to a struct file_operations that should be used for
471  *        this file.
472  *
473  * debugfs_create_file_unsafe() is completely analogous to
474  * debugfs_create_file(), the only difference being that the fops
475  * handed it will not get protected against file removals by the
476  * debugfs core.
477  *
478  * It is your responsibility to protect your struct file_operation
479  * methods against file removals by means of debugfs_file_get()
480  * and debugfs_file_put(). ->open() is still protected by
481  * debugfs though.
482  *
483  * Any struct file_operations defined by means of
484  * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
485  * thus, may be used here.
486  */
487 struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
488 				   struct dentry *parent, void *data,
489 				   const struct file_operations *fops)
490 {
491 
492 	return __debugfs_create_file(name, mode, parent, data,
493 				fops ? &debugfs_open_proxy_file_operations :
494 					&debugfs_noop_file_operations,
495 				fops);
496 }
497 EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
498 
499 /**
500  * debugfs_create_file_size - create a file in the debugfs filesystem
501  * @name: a pointer to a string containing the name of the file to create.
502  * @mode: the permission that the file should have.
503  * @parent: a pointer to the parent dentry for this file.  This should be a
504  *          directory dentry if set.  If this parameter is NULL, then the
505  *          file will be created in the root of the debugfs filesystem.
506  * @data: a pointer to something that the caller will want to get to later
507  *        on.  The inode.i_private pointer will point to this value on
508  *        the open() call.
509  * @fops: a pointer to a struct file_operations that should be used for
510  *        this file.
511  * @file_size: initial file size
512  *
513  * This is the basic "create a file" function for debugfs.  It allows for a
514  * wide range of flexibility in creating a file, or a directory (if you want
515  * to create a directory, the debugfs_create_dir() function is
516  * recommended to be used instead.)
517  */
518 void debugfs_create_file_size(const char *name, umode_t mode,
519 			      struct dentry *parent, void *data,
520 			      const struct file_operations *fops,
521 			      loff_t file_size)
522 {
523 	struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
524 
525 	if (de)
526 		d_inode(de)->i_size = file_size;
527 }
528 EXPORT_SYMBOL_GPL(debugfs_create_file_size);
529 
530 /**
531  * debugfs_create_dir - create a directory in the debugfs filesystem
532  * @name: a pointer to a string containing the name of the directory to
533  *        create.
534  * @parent: a pointer to the parent dentry for this file.  This should be a
535  *          directory dentry if set.  If this parameter is NULL, then the
536  *          directory will be created in the root of the debugfs filesystem.
537  *
538  * This function creates a directory in debugfs with the given name.
539  *
540  * This function will return a pointer to a dentry if it succeeds.  This
541  * pointer must be passed to the debugfs_remove() function when the file is
542  * to be removed (no automatic cleanup happens if your module is unloaded,
543  * you are responsible here.)  If an error occurs, ERR_PTR(-ERROR) will be
544  * returned.
545  *
546  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
547  * returned.
548  */
549 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
550 {
551 	struct dentry *dentry = start_creating(name, parent);
552 	struct inode *inode;
553 
554 	if (IS_ERR(dentry))
555 		return dentry;
556 
557 	if (!(debugfs_allow & DEBUGFS_ALLOW_API)) {
558 		failed_creating(dentry);
559 		return ERR_PTR(-EPERM);
560 	}
561 
562 	inode = debugfs_get_inode(dentry->d_sb);
563 	if (unlikely(!inode)) {
564 		pr_err("out of free dentries, can not create directory '%s'\n",
565 		       name);
566 		return failed_creating(dentry);
567 	}
568 
569 	inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
570 	inode->i_op = &debugfs_dir_inode_operations;
571 	inode->i_fop = &simple_dir_operations;
572 
573 	/* directory inodes start off with i_nlink == 2 (for "." entry) */
574 	inc_nlink(inode);
575 	d_instantiate(dentry, inode);
576 	inc_nlink(d_inode(dentry->d_parent));
577 	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
578 	return end_creating(dentry);
579 }
580 EXPORT_SYMBOL_GPL(debugfs_create_dir);
581 
582 /**
583  * debugfs_create_automount - create automount point in the debugfs filesystem
584  * @name: a pointer to a string containing the name of the file to create.
585  * @parent: a pointer to the parent dentry for this file.  This should be a
586  *          directory dentry if set.  If this parameter is NULL, then the
587  *          file will be created in the root of the debugfs filesystem.
588  * @f: function to be called when pathname resolution steps on that one.
589  * @data: opaque argument to pass to f().
590  *
591  * @f should return what ->d_automount() would.
592  */
593 struct dentry *debugfs_create_automount(const char *name,
594 					struct dentry *parent,
595 					debugfs_automount_t f,
596 					void *data)
597 {
598 	struct dentry *dentry = start_creating(name, parent);
599 	struct inode *inode;
600 
601 	if (IS_ERR(dentry))
602 		return dentry;
603 
604 	if (!(debugfs_allow & DEBUGFS_ALLOW_API)) {
605 		failed_creating(dentry);
606 		return ERR_PTR(-EPERM);
607 	}
608 
609 	inode = debugfs_get_inode(dentry->d_sb);
610 	if (unlikely(!inode)) {
611 		pr_err("out of free dentries, can not create automount '%s'\n",
612 		       name);
613 		return failed_creating(dentry);
614 	}
615 
616 	make_empty_dir_inode(inode);
617 	inode->i_flags |= S_AUTOMOUNT;
618 	inode->i_private = data;
619 	dentry->d_fsdata = (void *)f;
620 	/* directory inodes start off with i_nlink == 2 (for "." entry) */
621 	inc_nlink(inode);
622 	d_instantiate(dentry, inode);
623 	inc_nlink(d_inode(dentry->d_parent));
624 	fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
625 	return end_creating(dentry);
626 }
627 EXPORT_SYMBOL(debugfs_create_automount);
628 
629 /**
630  * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
631  * @name: a pointer to a string containing the name of the symbolic link to
632  *        create.
633  * @parent: a pointer to the parent dentry for this symbolic link.  This
634  *          should be a directory dentry if set.  If this parameter is NULL,
635  *          then the symbolic link will be created in the root of the debugfs
636  *          filesystem.
637  * @target: a pointer to a string containing the path to the target of the
638  *          symbolic link.
639  *
640  * This function creates a symbolic link with the given name in debugfs that
641  * links to the given target path.
642  *
643  * This function will return a pointer to a dentry if it succeeds.  This
644  * pointer must be passed to the debugfs_remove() function when the symbolic
645  * link is to be removed (no automatic cleanup happens if your module is
646  * unloaded, you are responsible here.)  If an error occurs, ERR_PTR(-ERROR)
647  * will be returned.
648  *
649  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
650  * returned.
651  */
652 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
653 				      const char *target)
654 {
655 	struct dentry *dentry;
656 	struct inode *inode;
657 	char *link = kstrdup(target, GFP_KERNEL);
658 	if (!link)
659 		return ERR_PTR(-ENOMEM);
660 
661 	dentry = start_creating(name, parent);
662 	if (IS_ERR(dentry)) {
663 		kfree(link);
664 		return dentry;
665 	}
666 
667 	inode = debugfs_get_inode(dentry->d_sb);
668 	if (unlikely(!inode)) {
669 		pr_err("out of free dentries, can not create symlink '%s'\n",
670 		       name);
671 		kfree(link);
672 		return failed_creating(dentry);
673 	}
674 	inode->i_mode = S_IFLNK | S_IRWXUGO;
675 	inode->i_op = &debugfs_symlink_inode_operations;
676 	inode->i_link = link;
677 	d_instantiate(dentry, inode);
678 	return end_creating(dentry);
679 }
680 EXPORT_SYMBOL_GPL(debugfs_create_symlink);
681 
682 static void __debugfs_file_removed(struct dentry *dentry)
683 {
684 	struct debugfs_fsdata *fsd;
685 
686 	/*
687 	 * Paired with the closing smp_mb() implied by a successful
688 	 * cmpxchg() in debugfs_file_get(): either
689 	 * debugfs_file_get() must see a dead dentry or we must see a
690 	 * debugfs_fsdata instance at ->d_fsdata here (or both).
691 	 */
692 	smp_mb();
693 	fsd = READ_ONCE(dentry->d_fsdata);
694 	if ((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT)
695 		return;
696 	if (!refcount_dec_and_test(&fsd->active_users))
697 		wait_for_completion(&fsd->active_users_drained);
698 }
699 
700 static void remove_one(struct dentry *victim)
701 {
702         if (d_is_reg(victim))
703 		__debugfs_file_removed(victim);
704 	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
705 }
706 
707 /**
708  * debugfs_remove - recursively removes a directory
709  * @dentry: a pointer to a the dentry of the directory to be removed.  If this
710  *          parameter is NULL or an error value, nothing will be done.
711  *
712  * This function recursively removes a directory tree in debugfs that
713  * was previously created with a call to another debugfs function
714  * (like debugfs_create_file() or variants thereof.)
715  *
716  * This function is required to be called in order for the file to be
717  * removed, no automatic cleanup of files will happen when a module is
718  * removed, you are responsible here.
719  */
720 void debugfs_remove(struct dentry *dentry)
721 {
722 	if (IS_ERR_OR_NULL(dentry))
723 		return;
724 
725 	simple_pin_fs(&debug_fs_type, &debugfs_mount, &debugfs_mount_count);
726 	simple_recursive_removal(dentry, remove_one);
727 	simple_release_fs(&debugfs_mount, &debugfs_mount_count);
728 }
729 EXPORT_SYMBOL_GPL(debugfs_remove);
730 
731 /**
732  * debugfs_rename - rename a file/directory in the debugfs filesystem
733  * @old_dir: a pointer to the parent dentry for the renamed object. This
734  *          should be a directory dentry.
735  * @old_dentry: dentry of an object to be renamed.
736  * @new_dir: a pointer to the parent dentry where the object should be
737  *          moved. This should be a directory dentry.
738  * @new_name: a pointer to a string containing the target name.
739  *
740  * This function renames a file/directory in debugfs.  The target must not
741  * exist for rename to succeed.
742  *
743  * This function will return a pointer to old_dentry (which is updated to
744  * reflect renaming) if it succeeds. If an error occurs, %NULL will be
745  * returned.
746  *
747  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
748  * returned.
749  */
750 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
751 		struct dentry *new_dir, const char *new_name)
752 {
753 	int error;
754 	struct dentry *dentry = NULL, *trap;
755 	struct name_snapshot old_name;
756 
757 	if (IS_ERR(old_dir))
758 		return old_dir;
759 	if (IS_ERR(new_dir))
760 		return new_dir;
761 	if (IS_ERR_OR_NULL(old_dentry))
762 		return old_dentry;
763 
764 	trap = lock_rename(new_dir, old_dir);
765 	/* Source or destination directories don't exist? */
766 	if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
767 		goto exit;
768 	/* Source does not exist, cyclic rename, or mountpoint? */
769 	if (d_really_is_negative(old_dentry) || old_dentry == trap ||
770 	    d_mountpoint(old_dentry))
771 		goto exit;
772 	dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
773 	/* Lookup failed, cyclic rename or target exists? */
774 	if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
775 		goto exit;
776 
777 	take_dentry_name_snapshot(&old_name, old_dentry);
778 
779 	error = simple_rename(&init_user_ns, d_inode(old_dir), old_dentry,
780 			      d_inode(new_dir), dentry, 0);
781 	if (error) {
782 		release_dentry_name_snapshot(&old_name);
783 		goto exit;
784 	}
785 	d_move(old_dentry, dentry);
786 	fsnotify_move(d_inode(old_dir), d_inode(new_dir), &old_name.name,
787 		d_is_dir(old_dentry),
788 		NULL, old_dentry);
789 	release_dentry_name_snapshot(&old_name);
790 	unlock_rename(new_dir, old_dir);
791 	dput(dentry);
792 	return old_dentry;
793 exit:
794 	if (dentry && !IS_ERR(dentry))
795 		dput(dentry);
796 	unlock_rename(new_dir, old_dir);
797 	if (IS_ERR(dentry))
798 		return dentry;
799 	return ERR_PTR(-EINVAL);
800 }
801 EXPORT_SYMBOL_GPL(debugfs_rename);
802 
803 /**
804  * debugfs_initialized - Tells whether debugfs has been registered
805  */
806 bool debugfs_initialized(void)
807 {
808 	return debugfs_registered;
809 }
810 EXPORT_SYMBOL_GPL(debugfs_initialized);
811 
812 static int __init debugfs_kernel(char *str)
813 {
814 	if (str) {
815 		if (!strcmp(str, "on"))
816 			debugfs_allow = DEBUGFS_ALLOW_API | DEBUGFS_ALLOW_MOUNT;
817 		else if (!strcmp(str, "no-mount"))
818 			debugfs_allow = DEBUGFS_ALLOW_API;
819 		else if (!strcmp(str, "off"))
820 			debugfs_allow = 0;
821 	}
822 
823 	return 0;
824 }
825 early_param("debugfs", debugfs_kernel);
826 static int __init debugfs_init(void)
827 {
828 	int retval;
829 
830 	if (!(debugfs_allow & DEBUGFS_ALLOW_MOUNT))
831 		return -EPERM;
832 
833 	retval = sysfs_create_mount_point(kernel_kobj, "debug");
834 	if (retval)
835 		return retval;
836 
837 	retval = register_filesystem(&debug_fs_type);
838 	if (retval)
839 		sysfs_remove_mount_point(kernel_kobj, "debug");
840 	else
841 		debugfs_registered = true;
842 
843 	return retval;
844 }
845 core_initcall(debugfs_init);
846