1 // SPDX-License-Identifier: GPL-2.0
3 * inode.c - part of debugfs, a tiny little debug file system
5 * Copyright (C) 2004,2019 Greg Kroah-Hartman <greg@kroah.com>
6 * Copyright (C) 2004 IBM Inc.
7 * Copyright (C) 2019 Linux Foundation <gregkh@linuxfoundation.org>
9 * debugfs is for people to use instead of /proc or /sys.
10 * See ./Documentation/core-api/kernel-api.rst for more details.
13 #define pr_fmt(fmt) "debugfs: " fmt
15 #include <linux/module.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>
33 #define DEBUGFS_DEFAULT_MODE 0700
35 static struct vfsmount
*debugfs_mount
;
36 static int debugfs_mount_count
;
37 static bool debugfs_registered
;
40 * Don't allow access attributes to be changed whilst the kernel is locked down
41 * so that we can use the file mode as part of a heuristic to determine whether
42 * to lock down individual files.
44 static int debugfs_setattr(struct dentry
*dentry
, struct iattr
*ia
)
46 int ret
= security_locked_down(LOCKDOWN_DEBUGFS
);
48 if (ret
&& (ia
->ia_valid
& (ATTR_MODE
| ATTR_UID
| ATTR_GID
)))
50 return simple_setattr(dentry
, ia
);
53 static const struct inode_operations debugfs_file_inode_operations
= {
54 .setattr
= debugfs_setattr
,
56 static const struct inode_operations debugfs_dir_inode_operations
= {
57 .lookup
= simple_lookup
,
58 .setattr
= debugfs_setattr
,
60 static const struct inode_operations debugfs_symlink_inode_operations
= {
61 .get_link
= simple_get_link
,
62 .setattr
= debugfs_setattr
,
65 static struct inode
*debugfs_get_inode(struct super_block
*sb
)
67 struct inode
*inode
= new_inode(sb
);
69 inode
->i_ino
= get_next_ino();
70 inode
->i_atime
= inode
->i_mtime
=
71 inode
->i_ctime
= current_time(inode
);
76 struct debugfs_mount_opts
{
89 static const match_table_t tokens
= {
92 {Opt_mode
, "mode=%o"},
96 struct debugfs_fs_info
{
97 struct debugfs_mount_opts mount_opts
;
100 static int debugfs_parse_options(char *data
, struct debugfs_mount_opts
*opts
)
102 substring_t args
[MAX_OPT_ARGS
];
109 opts
->mode
= DEBUGFS_DEFAULT_MODE
;
111 while ((p
= strsep(&data
, ",")) != NULL
) {
115 token
= match_token(p
, tokens
, args
);
118 if (match_int(&args
[0], &option
))
120 uid
= make_kuid(current_user_ns(), option
);
126 if (match_int(&args
[0], &option
))
128 gid
= make_kgid(current_user_ns(), option
);
134 if (match_octal(&args
[0], &option
))
136 opts
->mode
= option
& S_IALLUGO
;
139 * We might like to report bad mount options here;
140 * but traditionally debugfs has ignored all mount options
148 static int debugfs_apply_options(struct super_block
*sb
)
150 struct debugfs_fs_info
*fsi
= sb
->s_fs_info
;
151 struct inode
*inode
= d_inode(sb
->s_root
);
152 struct debugfs_mount_opts
*opts
= &fsi
->mount_opts
;
154 inode
->i_mode
&= ~S_IALLUGO
;
155 inode
->i_mode
|= opts
->mode
;
157 inode
->i_uid
= opts
->uid
;
158 inode
->i_gid
= opts
->gid
;
163 static int debugfs_remount(struct super_block
*sb
, int *flags
, char *data
)
166 struct debugfs_fs_info
*fsi
= sb
->s_fs_info
;
169 err
= debugfs_parse_options(data
, &fsi
->mount_opts
);
173 debugfs_apply_options(sb
);
179 static int debugfs_show_options(struct seq_file
*m
, struct dentry
*root
)
181 struct debugfs_fs_info
*fsi
= root
->d_sb
->s_fs_info
;
182 struct debugfs_mount_opts
*opts
= &fsi
->mount_opts
;
184 if (!uid_eq(opts
->uid
, GLOBAL_ROOT_UID
))
185 seq_printf(m
, ",uid=%u",
186 from_kuid_munged(&init_user_ns
, opts
->uid
));
187 if (!gid_eq(opts
->gid
, GLOBAL_ROOT_GID
))
188 seq_printf(m
, ",gid=%u",
189 from_kgid_munged(&init_user_ns
, opts
->gid
));
190 if (opts
->mode
!= DEBUGFS_DEFAULT_MODE
)
191 seq_printf(m
, ",mode=%o", opts
->mode
);
196 static void debugfs_free_inode(struct inode
*inode
)
198 if (S_ISLNK(inode
->i_mode
))
199 kfree(inode
->i_link
);
200 free_inode_nonrcu(inode
);
203 static const struct super_operations debugfs_super_operations
= {
204 .statfs
= simple_statfs
,
205 .remount_fs
= debugfs_remount
,
206 .show_options
= debugfs_show_options
,
207 .free_inode
= debugfs_free_inode
,
210 static void debugfs_release_dentry(struct dentry
*dentry
)
212 void *fsd
= dentry
->d_fsdata
;
214 if (!((unsigned long)fsd
& DEBUGFS_FSDATA_IS_REAL_FOPS_BIT
))
215 kfree(dentry
->d_fsdata
);
218 static struct vfsmount
*debugfs_automount(struct path
*path
)
220 debugfs_automount_t f
;
221 f
= (debugfs_automount_t
)path
->dentry
->d_fsdata
;
222 return f(path
->dentry
, d_inode(path
->dentry
)->i_private
);
225 static const struct dentry_operations debugfs_dops
= {
226 .d_delete
= always_delete_dentry
,
227 .d_release
= debugfs_release_dentry
,
228 .d_automount
= debugfs_automount
,
231 static int debug_fill_super(struct super_block
*sb
, void *data
, int silent
)
233 static const struct tree_descr debug_files
[] = {{""}};
234 struct debugfs_fs_info
*fsi
;
237 fsi
= kzalloc(sizeof(struct debugfs_fs_info
), GFP_KERNEL
);
244 err
= debugfs_parse_options(data
, &fsi
->mount_opts
);
248 err
= simple_fill_super(sb
, DEBUGFS_MAGIC
, debug_files
);
252 sb
->s_op
= &debugfs_super_operations
;
253 sb
->s_d_op
= &debugfs_dops
;
255 debugfs_apply_options(sb
);
261 sb
->s_fs_info
= NULL
;
265 static struct dentry
*debug_mount(struct file_system_type
*fs_type
,
266 int flags
, const char *dev_name
,
269 return mount_single(fs_type
, flags
, data
, debug_fill_super
);
272 static struct file_system_type debug_fs_type
= {
273 .owner
= THIS_MODULE
,
275 .mount
= debug_mount
,
276 .kill_sb
= kill_litter_super
,
278 MODULE_ALIAS_FS("debugfs");
281 * debugfs_lookup() - look up an existing debugfs file
282 * @name: a pointer to a string containing the name of the file to look up.
283 * @parent: a pointer to the parent dentry of the file.
285 * This function will return a pointer to a dentry if it succeeds. If the file
286 * doesn't exist or an error occurs, %NULL will be returned. The returned
287 * dentry must be passed to dput() when it is no longer needed.
289 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
292 struct dentry
*debugfs_lookup(const char *name
, struct dentry
*parent
)
294 struct dentry
*dentry
;
300 parent
= debugfs_mount
->mnt_root
;
302 dentry
= lookup_positive_unlocked(name
, parent
, strlen(name
));
307 EXPORT_SYMBOL_GPL(debugfs_lookup
);
309 static struct dentry
*start_creating(const char *name
, struct dentry
*parent
)
311 struct dentry
*dentry
;
314 pr_debug("creating file '%s'\n", name
);
319 error
= simple_pin_fs(&debug_fs_type
, &debugfs_mount
,
320 &debugfs_mount_count
);
322 pr_err("Unable to pin filesystem for file '%s'\n", name
);
323 return ERR_PTR(error
);
326 /* If the parent is not specified, we create it in the root.
327 * We need the root dentry to do this, which is in the super
328 * block. A pointer to that is in the struct vfsmount that we
332 parent
= debugfs_mount
->mnt_root
;
334 inode_lock(d_inode(parent
));
335 if (unlikely(IS_DEADDIR(d_inode(parent
))))
336 dentry
= ERR_PTR(-ENOENT
);
338 dentry
= lookup_one_len(name
, parent
, strlen(name
));
339 if (!IS_ERR(dentry
) && d_really_is_positive(dentry
)) {
340 if (d_is_dir(dentry
))
341 pr_err("Directory '%s' with parent '%s' already present!\n",
342 name
, parent
->d_name
.name
);
344 pr_err("File '%s' in directory '%s' already present!\n",
345 name
, parent
->d_name
.name
);
347 dentry
= ERR_PTR(-EEXIST
);
350 if (IS_ERR(dentry
)) {
351 inode_unlock(d_inode(parent
));
352 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
358 static struct dentry
*failed_creating(struct dentry
*dentry
)
360 inode_unlock(d_inode(dentry
->d_parent
));
362 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
363 return ERR_PTR(-ENOMEM
);
366 static struct dentry
*end_creating(struct dentry
*dentry
)
368 inode_unlock(d_inode(dentry
->d_parent
));
372 static struct dentry
*__debugfs_create_file(const char *name
, umode_t mode
,
373 struct dentry
*parent
, void *data
,
374 const struct file_operations
*proxy_fops
,
375 const struct file_operations
*real_fops
)
377 struct dentry
*dentry
;
380 if (!(mode
& S_IFMT
))
382 BUG_ON(!S_ISREG(mode
));
383 dentry
= start_creating(name
, parent
);
388 inode
= debugfs_get_inode(dentry
->d_sb
);
389 if (unlikely(!inode
)) {
390 pr_err("out of free dentries, can not create file '%s'\n",
392 return failed_creating(dentry
);
395 inode
->i_mode
= mode
;
396 inode
->i_private
= data
;
398 inode
->i_op
= &debugfs_file_inode_operations
;
399 inode
->i_fop
= proxy_fops
;
400 dentry
->d_fsdata
= (void *)((unsigned long)real_fops
|
401 DEBUGFS_FSDATA_IS_REAL_FOPS_BIT
);
403 d_instantiate(dentry
, inode
);
404 fsnotify_create(d_inode(dentry
->d_parent
), dentry
);
405 return end_creating(dentry
);
409 * debugfs_create_file - create a file in the debugfs filesystem
410 * @name: a pointer to a string containing the name of the file to create.
411 * @mode: the permission that the file should have.
412 * @parent: a pointer to the parent dentry for this file. This should be a
413 * directory dentry if set. If this parameter is NULL, then the
414 * file will be created in the root of the debugfs filesystem.
415 * @data: a pointer to something that the caller will want to get to later
416 * on. The inode.i_private pointer will point to this value on
418 * @fops: a pointer to a struct file_operations that should be used for
421 * This is the basic "create a file" function for debugfs. It allows for a
422 * wide range of flexibility in creating a file, or a directory (if you want
423 * to create a directory, the debugfs_create_dir() function is
424 * recommended to be used instead.)
426 * This function will return a pointer to a dentry if it succeeds. This
427 * pointer must be passed to the debugfs_remove() function when the file is
428 * to be removed (no automatic cleanup happens if your module is unloaded,
429 * you are responsible here.) If an error occurs, ERR_PTR(-ERROR) will be
432 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
435 struct dentry
*debugfs_create_file(const char *name
, umode_t mode
,
436 struct dentry
*parent
, void *data
,
437 const struct file_operations
*fops
)
440 return __debugfs_create_file(name
, mode
, parent
, data
,
441 fops
? &debugfs_full_proxy_file_operations
:
442 &debugfs_noop_file_operations
,
445 EXPORT_SYMBOL_GPL(debugfs_create_file
);
448 * debugfs_create_file_unsafe - create a file in the debugfs filesystem
449 * @name: a pointer to a string containing the name of the file to create.
450 * @mode: the permission that the file should have.
451 * @parent: a pointer to the parent dentry for this file. This should be a
452 * directory dentry if set. If this parameter is NULL, then the
453 * file will be created in the root of the debugfs filesystem.
454 * @data: a pointer to something that the caller will want to get to later
455 * on. The inode.i_private pointer will point to this value on
457 * @fops: a pointer to a struct file_operations that should be used for
460 * debugfs_create_file_unsafe() is completely analogous to
461 * debugfs_create_file(), the only difference being that the fops
462 * handed it will not get protected against file removals by the
465 * It is your responsibility to protect your struct file_operation
466 * methods against file removals by means of debugfs_file_get()
467 * and debugfs_file_put(). ->open() is still protected by
470 * Any struct file_operations defined by means of
471 * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
472 * thus, may be used here.
474 struct dentry
*debugfs_create_file_unsafe(const char *name
, umode_t mode
,
475 struct dentry
*parent
, void *data
,
476 const struct file_operations
*fops
)
479 return __debugfs_create_file(name
, mode
, parent
, data
,
480 fops
? &debugfs_open_proxy_file_operations
:
481 &debugfs_noop_file_operations
,
484 EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe
);
487 * debugfs_create_file_size - create a file in the debugfs filesystem
488 * @name: a pointer to a string containing the name of the file to create.
489 * @mode: the permission that the file should have.
490 * @parent: a pointer to the parent dentry for this file. This should be a
491 * directory dentry if set. If this parameter is NULL, then the
492 * file will be created in the root of the debugfs filesystem.
493 * @data: a pointer to something that the caller will want to get to later
494 * on. The inode.i_private pointer will point to this value on
496 * @fops: a pointer to a struct file_operations that should be used for
498 * @file_size: initial file size
500 * This is the basic "create a file" function for debugfs. It allows for a
501 * wide range of flexibility in creating a file, or a directory (if you want
502 * to create a directory, the debugfs_create_dir() function is
503 * recommended to be used instead.)
505 void debugfs_create_file_size(const char *name
, umode_t mode
,
506 struct dentry
*parent
, void *data
,
507 const struct file_operations
*fops
,
510 struct dentry
*de
= debugfs_create_file(name
, mode
, parent
, data
, fops
);
513 d_inode(de
)->i_size
= file_size
;
515 EXPORT_SYMBOL_GPL(debugfs_create_file_size
);
518 * debugfs_create_dir - create a directory in the debugfs filesystem
519 * @name: a pointer to a string containing the name of the directory to
521 * @parent: a pointer to the parent dentry for this file. This should be a
522 * directory dentry if set. If this parameter is NULL, then the
523 * directory will be created in the root of the debugfs filesystem.
525 * This function creates a directory in debugfs with the given name.
527 * This function will return a pointer to a dentry if it succeeds. This
528 * pointer must be passed to the debugfs_remove() function when the file is
529 * to be removed (no automatic cleanup happens if your module is unloaded,
530 * you are responsible here.) If an error occurs, ERR_PTR(-ERROR) will be
533 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
536 struct dentry
*debugfs_create_dir(const char *name
, struct dentry
*parent
)
538 struct dentry
*dentry
= start_creating(name
, parent
);
544 inode
= debugfs_get_inode(dentry
->d_sb
);
545 if (unlikely(!inode
)) {
546 pr_err("out of free dentries, can not create directory '%s'\n",
548 return failed_creating(dentry
);
551 inode
->i_mode
= S_IFDIR
| S_IRWXU
| S_IRUGO
| S_IXUGO
;
552 inode
->i_op
= &debugfs_dir_inode_operations
;
553 inode
->i_fop
= &simple_dir_operations
;
555 /* directory inodes start off with i_nlink == 2 (for "." entry) */
557 d_instantiate(dentry
, inode
);
558 inc_nlink(d_inode(dentry
->d_parent
));
559 fsnotify_mkdir(d_inode(dentry
->d_parent
), dentry
);
560 return end_creating(dentry
);
562 EXPORT_SYMBOL_GPL(debugfs_create_dir
);
565 * debugfs_create_automount - create automount point in the debugfs filesystem
566 * @name: a pointer to a string containing the name of the file to create.
567 * @parent: a pointer to the parent dentry for this file. This should be a
568 * directory dentry if set. If this parameter is NULL, then the
569 * file will be created in the root of the debugfs filesystem.
570 * @f: function to be called when pathname resolution steps on that one.
571 * @data: opaque argument to pass to f().
573 * @f should return what ->d_automount() would.
575 struct dentry
*debugfs_create_automount(const char *name
,
576 struct dentry
*parent
,
577 debugfs_automount_t f
,
580 struct dentry
*dentry
= start_creating(name
, parent
);
586 inode
= debugfs_get_inode(dentry
->d_sb
);
587 if (unlikely(!inode
)) {
588 pr_err("out of free dentries, can not create automount '%s'\n",
590 return failed_creating(dentry
);
593 make_empty_dir_inode(inode
);
594 inode
->i_flags
|= S_AUTOMOUNT
;
595 inode
->i_private
= data
;
596 dentry
->d_fsdata
= (void *)f
;
597 /* directory inodes start off with i_nlink == 2 (for "." entry) */
599 d_instantiate(dentry
, inode
);
600 inc_nlink(d_inode(dentry
->d_parent
));
601 fsnotify_mkdir(d_inode(dentry
->d_parent
), dentry
);
602 return end_creating(dentry
);
604 EXPORT_SYMBOL(debugfs_create_automount
);
607 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
608 * @name: a pointer to a string containing the name of the symbolic link to
610 * @parent: a pointer to the parent dentry for this symbolic link. This
611 * should be a directory dentry if set. If this parameter is NULL,
612 * then the symbolic link will be created in the root of the debugfs
614 * @target: a pointer to a string containing the path to the target of the
617 * This function creates a symbolic link with the given name in debugfs that
618 * links to the given target path.
620 * This function will return a pointer to a dentry if it succeeds. This
621 * pointer must be passed to the debugfs_remove() function when the symbolic
622 * link is to be removed (no automatic cleanup happens if your module is
623 * unloaded, you are responsible here.) If an error occurs, ERR_PTR(-ERROR)
626 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
629 struct dentry
*debugfs_create_symlink(const char *name
, struct dentry
*parent
,
632 struct dentry
*dentry
;
634 char *link
= kstrdup(target
, GFP_KERNEL
);
636 return ERR_PTR(-ENOMEM
);
638 dentry
= start_creating(name
, parent
);
639 if (IS_ERR(dentry
)) {
644 inode
= debugfs_get_inode(dentry
->d_sb
);
645 if (unlikely(!inode
)) {
646 pr_err("out of free dentries, can not create symlink '%s'\n",
649 return failed_creating(dentry
);
651 inode
->i_mode
= S_IFLNK
| S_IRWXUGO
;
652 inode
->i_op
= &debugfs_symlink_inode_operations
;
653 inode
->i_link
= link
;
654 d_instantiate(dentry
, inode
);
655 return end_creating(dentry
);
657 EXPORT_SYMBOL_GPL(debugfs_create_symlink
);
659 static void __debugfs_file_removed(struct dentry
*dentry
)
661 struct debugfs_fsdata
*fsd
;
664 * Paired with the closing smp_mb() implied by a successful
665 * cmpxchg() in debugfs_file_get(): either
666 * debugfs_file_get() must see a dead dentry or we must see a
667 * debugfs_fsdata instance at ->d_fsdata here (or both).
670 fsd
= READ_ONCE(dentry
->d_fsdata
);
671 if ((unsigned long)fsd
& DEBUGFS_FSDATA_IS_REAL_FOPS_BIT
)
673 if (!refcount_dec_and_test(&fsd
->active_users
))
674 wait_for_completion(&fsd
->active_users_drained
);
677 static void remove_one(struct dentry
*victim
)
679 if (d_is_reg(victim
))
680 __debugfs_file_removed(victim
);
681 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
685 * debugfs_remove - recursively removes a directory
686 * @dentry: a pointer to a the dentry of the directory to be removed. If this
687 * parameter is NULL or an error value, nothing will be done.
689 * This function recursively removes a directory tree in debugfs that
690 * was previously created with a call to another debugfs function
691 * (like debugfs_create_file() or variants thereof.)
693 * This function is required to be called in order for the file to be
694 * removed, no automatic cleanup of files will happen when a module is
695 * removed, you are responsible here.
697 void debugfs_remove(struct dentry
*dentry
)
699 if (IS_ERR_OR_NULL(dentry
))
702 simple_pin_fs(&debug_fs_type
, &debugfs_mount
, &debugfs_mount_count
);
703 simple_recursive_removal(dentry
, remove_one
);
704 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
706 EXPORT_SYMBOL_GPL(debugfs_remove
);
709 * debugfs_rename - rename a file/directory in the debugfs filesystem
710 * @old_dir: a pointer to the parent dentry for the renamed object. This
711 * should be a directory dentry.
712 * @old_dentry: dentry of an object to be renamed.
713 * @new_dir: a pointer to the parent dentry where the object should be
714 * moved. This should be a directory dentry.
715 * @new_name: a pointer to a string containing the target name.
717 * This function renames a file/directory in debugfs. The target must not
718 * exist for rename to succeed.
720 * This function will return a pointer to old_dentry (which is updated to
721 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
724 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
727 struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
728 struct dentry
*new_dir
, const char *new_name
)
731 struct dentry
*dentry
= NULL
, *trap
;
732 struct name_snapshot old_name
;
738 if (IS_ERR_OR_NULL(old_dentry
))
741 trap
= lock_rename(new_dir
, old_dir
);
742 /* Source or destination directories don't exist? */
743 if (d_really_is_negative(old_dir
) || d_really_is_negative(new_dir
))
745 /* Source does not exist, cyclic rename, or mountpoint? */
746 if (d_really_is_negative(old_dentry
) || old_dentry
== trap
||
747 d_mountpoint(old_dentry
))
749 dentry
= lookup_one_len(new_name
, new_dir
, strlen(new_name
));
750 /* Lookup failed, cyclic rename or target exists? */
751 if (IS_ERR(dentry
) || dentry
== trap
|| d_really_is_positive(dentry
))
754 take_dentry_name_snapshot(&old_name
, old_dentry
);
756 error
= simple_rename(d_inode(old_dir
), old_dentry
, d_inode(new_dir
),
759 release_dentry_name_snapshot(&old_name
);
762 d_move(old_dentry
, dentry
);
763 fsnotify_move(d_inode(old_dir
), d_inode(new_dir
), &old_name
.name
,
764 d_is_dir(old_dentry
),
766 release_dentry_name_snapshot(&old_name
);
767 unlock_rename(new_dir
, old_dir
);
771 if (dentry
&& !IS_ERR(dentry
))
773 unlock_rename(new_dir
, old_dir
);
776 return ERR_PTR(-EINVAL
);
778 EXPORT_SYMBOL_GPL(debugfs_rename
);
781 * debugfs_initialized - Tells whether debugfs has been registered
783 bool debugfs_initialized(void)
785 return debugfs_registered
;
787 EXPORT_SYMBOL_GPL(debugfs_initialized
);
789 static int __init
debugfs_init(void)
793 retval
= sysfs_create_mount_point(kernel_kobj
, "debug");
797 retval
= register_filesystem(&debug_fs_type
);
799 sysfs_remove_mount_point(kernel_kobj
, "debug");
801 debugfs_registered
= true;
805 core_initcall(debugfs_init
);