2 * inode.c - part of debugfs, a tiny little debug file system
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 2004 IBM Inc.
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
11 * debugfs is for people to use instead of /proc or /sys.
12 * See Documentation/DocBook/kernel-api for more details.
16 #include <linux/module.h>
18 #include <linux/mount.h>
19 #include <linux/pagemap.h>
20 #include <linux/init.h>
21 #include <linux/kobject.h>
22 #include <linux/namei.h>
23 #include <linux/debugfs.h>
24 #include <linux/fsnotify.h>
25 #include <linux/string.h>
26 #include <linux/seq_file.h>
27 #include <linux/parser.h>
28 #include <linux/magic.h>
29 #include <linux/slab.h>
31 #define DEBUGFS_DEFAULT_MODE 0700
33 static struct vfsmount *debugfs_mount;
34 static int debugfs_mount_count;
35 static bool debugfs_registered;
37 static struct inode *debugfs_get_inode(struct super_block *sb, umode_t mode, dev_t dev,
38 void *data, const struct file_operations *fops)
41 struct inode *inode = new_inode(sb);
44 inode->i_ino = get_next_ino();
46 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
47 switch (mode & S_IFMT) {
49 init_special_inode(inode, mode, dev);
52 inode->i_fop = fops ? fops : &debugfs_file_operations;
53 inode->i_private = data;
56 inode->i_op = &debugfs_link_operations;
57 inode->i_private = data;
60 inode->i_op = &simple_dir_inode_operations;
61 inode->i_fop = &simple_dir_operations;
63 /* directory inodes start off with i_nlink == 2
73 static int debugfs_mknod(struct inode *dir, struct dentry *dentry,
74 umode_t mode, dev_t dev, void *data,
75 const struct file_operations *fops)
83 inode = debugfs_get_inode(dir->i_sb, mode, dev, data, fops);
85 d_instantiate(dentry, inode);
92 static int debugfs_mkdir(struct inode *dir, struct dentry *dentry, umode_t mode)
96 mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR;
97 res = debugfs_mknod(dir, dentry, mode, 0, NULL, NULL);
100 fsnotify_mkdir(dir, dentry);
105 static int debugfs_link(struct inode *dir, struct dentry *dentry, umode_t mode,
108 mode = (mode & S_IALLUGO) | S_IFLNK;
109 return debugfs_mknod(dir, dentry, mode, 0, data, NULL);
112 static int debugfs_create(struct inode *dir, struct dentry *dentry, umode_t mode,
113 void *data, const struct file_operations *fops)
117 mode = (mode & S_IALLUGO) | S_IFREG;
118 res = debugfs_mknod(dir, dentry, mode, 0, data, fops);
120 fsnotify_create(dir, dentry);
124 static inline int debugfs_positive(struct dentry *dentry)
126 return dentry->d_inode && !d_unhashed(dentry);
129 struct debugfs_mount_opts {
142 static const match_table_t tokens = {
145 {Opt_mode, "mode=%o"},
149 struct debugfs_fs_info {
150 struct debugfs_mount_opts mount_opts;
153 static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
155 substring_t args[MAX_OPT_ARGS];
162 opts->mode = DEBUGFS_DEFAULT_MODE;
164 while ((p = strsep(&data, ",")) != NULL) {
168 token = match_token(p, tokens, args);
171 if (match_int(&args[0], &option))
173 uid = make_kuid(current_user_ns(), option);
179 if (match_octal(&args[0], &option))
181 gid = make_kgid(current_user_ns(), option);
187 if (match_octal(&args[0], &option))
189 opts->mode = option & S_IALLUGO;
192 * We might like to report bad mount options here;
193 * but traditionally debugfs has ignored all mount options
201 static int debugfs_apply_options(struct super_block *sb)
203 struct debugfs_fs_info *fsi = sb->s_fs_info;
204 struct inode *inode = sb->s_root->d_inode;
205 struct debugfs_mount_opts *opts = &fsi->mount_opts;
207 inode->i_mode &= ~S_IALLUGO;
208 inode->i_mode |= opts->mode;
210 inode->i_uid = opts->uid;
211 inode->i_gid = opts->gid;
216 static int debugfs_remount(struct super_block *sb, int *flags, char *data)
219 struct debugfs_fs_info *fsi = sb->s_fs_info;
221 err = debugfs_parse_options(data, &fsi->mount_opts);
225 debugfs_apply_options(sb);
231 static int debugfs_show_options(struct seq_file *m, struct dentry *root)
233 struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
234 struct debugfs_mount_opts *opts = &fsi->mount_opts;
236 if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
237 seq_printf(m, ",uid=%u",
238 from_kuid_munged(&init_user_ns, opts->uid));
239 if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
240 seq_printf(m, ",gid=%u",
241 from_kgid_munged(&init_user_ns, opts->gid));
242 if (opts->mode != DEBUGFS_DEFAULT_MODE)
243 seq_printf(m, ",mode=%o", opts->mode);
248 static const struct super_operations debugfs_super_operations = {
249 .statfs = simple_statfs,
250 .remount_fs = debugfs_remount,
251 .show_options = debugfs_show_options,
254 static int debug_fill_super(struct super_block *sb, void *data, int silent)
256 static struct tree_descr debug_files[] = {{""}};
257 struct debugfs_fs_info *fsi;
260 save_mount_options(sb, data);
262 fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
269 err = debugfs_parse_options(data, &fsi->mount_opts);
273 err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
277 sb->s_op = &debugfs_super_operations;
279 debugfs_apply_options(sb);
285 sb->s_fs_info = NULL;
289 static struct dentry *debug_mount(struct file_system_type *fs_type,
290 int flags, const char *dev_name,
293 return mount_single(fs_type, flags, data, debug_fill_super);
296 static struct file_system_type debug_fs_type = {
297 .owner = THIS_MODULE,
299 .mount = debug_mount,
300 .kill_sb = kill_litter_super,
303 static struct dentry *__create_file(const char *name, umode_t mode,
304 struct dentry *parent, void *data,
305 const struct file_operations *fops)
307 struct dentry *dentry = NULL;
310 pr_debug("debugfs: creating file '%s'\n",name);
312 error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
313 &debugfs_mount_count);
317 /* If the parent is not specified, we create it in the root.
318 * We need the root dentry to do this, which is in the super
319 * block. A pointer to that is in the struct vfsmount that we
323 parent = debugfs_mount->mnt_root;
326 mutex_lock(&parent->d_inode->i_mutex);
327 dentry = lookup_one_len(name, parent, strlen(name));
328 if (!IS_ERR(dentry)) {
329 switch (mode & S_IFMT) {
331 error = debugfs_mkdir(parent->d_inode, dentry, mode);
335 error = debugfs_link(parent->d_inode, dentry, mode,
339 error = debugfs_create(parent->d_inode, dentry, mode,
345 error = PTR_ERR(dentry);
346 mutex_unlock(&parent->d_inode->i_mutex);
350 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
357 * debugfs_create_file - create a file in the debugfs filesystem
358 * @name: a pointer to a string containing the name of the file to create.
359 * @mode: the permission that the file should have.
360 * @parent: a pointer to the parent dentry for this file. This should be a
361 * directory dentry if set. If this paramater is NULL, then the
362 * file will be created in the root of the debugfs filesystem.
363 * @data: a pointer to something that the caller will want to get to later
364 * on. The inode.i_private pointer will point to this value on
366 * @fops: a pointer to a struct file_operations that should be used for
369 * This is the basic "create a file" function for debugfs. It allows for a
370 * wide range of flexibility in creating a file, or a directory (if you want
371 * to create a directory, the debugfs_create_dir() function is
372 * recommended to be used instead.)
374 * This function will return a pointer to a dentry if it succeeds. This
375 * pointer must be passed to the debugfs_remove() function when the file is
376 * to be removed (no automatic cleanup happens if your module is unloaded,
377 * you are responsible here.) If an error occurs, %NULL will be returned.
379 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
382 struct dentry *debugfs_create_file(const char *name, umode_t mode,
383 struct dentry *parent, void *data,
384 const struct file_operations *fops)
386 switch (mode & S_IFMT) {
394 return __create_file(name, mode, parent, data, fops);
396 EXPORT_SYMBOL_GPL(debugfs_create_file);
399 * debugfs_create_dir - create a directory in the debugfs filesystem
400 * @name: a pointer to a string containing the name of the directory to
402 * @parent: a pointer to the parent dentry for this file. This should be a
403 * directory dentry if set. If this paramater is NULL, then the
404 * directory will be created in the root of the debugfs filesystem.
406 * This function creates a directory in debugfs with the given name.
408 * This function will return a pointer to a dentry if it succeeds. This
409 * pointer must be passed to the debugfs_remove() function when the file is
410 * to be removed (no automatic cleanup happens if your module is unloaded,
411 * you are responsible here.) If an error occurs, %NULL will be returned.
413 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
416 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
418 return __create_file(name, S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO,
421 EXPORT_SYMBOL_GPL(debugfs_create_dir);
424 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
425 * @name: a pointer to a string containing the name of the symbolic link to
427 * @parent: a pointer to the parent dentry for this symbolic link. This
428 * should be a directory dentry if set. If this paramater is NULL,
429 * then the symbolic link will be created in the root of the debugfs
431 * @target: a pointer to a string containing the path to the target of the
434 * This function creates a symbolic link with the given name in debugfs that
435 * links to the given target path.
437 * This function will return a pointer to a dentry if it succeeds. This
438 * pointer must be passed to the debugfs_remove() function when the symbolic
439 * link is to be removed (no automatic cleanup happens if your module is
440 * unloaded, you are responsible here.) If an error occurs, %NULL will be
443 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
446 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
449 struct dentry *result;
452 link = kstrdup(target, GFP_KERNEL);
456 result = __create_file(name, S_IFLNK | S_IRWXUGO, parent, link, NULL);
461 EXPORT_SYMBOL_GPL(debugfs_create_symlink);
463 static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
467 if (debugfs_positive(dentry)) {
468 if (dentry->d_inode) {
470 switch (dentry->d_inode->i_mode & S_IFMT) {
472 ret = simple_rmdir(parent->d_inode, dentry);
475 kfree(dentry->d_inode->i_private);
478 simple_unlink(parent->d_inode, dentry);
490 * debugfs_remove - removes a file or directory from the debugfs filesystem
491 * @dentry: a pointer to a the dentry of the file or directory to be
494 * This function removes a file or directory in debugfs that was previously
495 * created with a call to another debugfs function (like
496 * debugfs_create_file() or variants thereof.)
498 * This function is required to be called in order for the file to be
499 * removed, no automatic cleanup of files will happen when a module is
500 * removed, you are responsible here.
502 void debugfs_remove(struct dentry *dentry)
504 struct dentry *parent;
507 if (IS_ERR_OR_NULL(dentry))
510 parent = dentry->d_parent;
511 if (!parent || !parent->d_inode)
514 mutex_lock(&parent->d_inode->i_mutex);
515 ret = __debugfs_remove(dentry, parent);
516 mutex_unlock(&parent->d_inode->i_mutex);
518 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
520 EXPORT_SYMBOL_GPL(debugfs_remove);
523 * debugfs_remove_recursive - recursively removes a directory
524 * @dentry: a pointer to a the dentry of the directory to be removed.
526 * This function recursively removes a directory tree in debugfs that
527 * was previously created with a call to another debugfs function
528 * (like debugfs_create_file() or variants thereof.)
530 * This function is required to be called in order for the file to be
531 * removed, no automatic cleanup of files will happen when a module is
532 * removed, you are responsible here.
534 void debugfs_remove_recursive(struct dentry *dentry)
536 struct dentry *child;
537 struct dentry *parent;
539 if (IS_ERR_OR_NULL(dentry))
542 parent = dentry->d_parent;
543 if (!parent || !parent->d_inode)
547 mutex_lock(&parent->d_inode->i_mutex);
551 * When all dentries under "parent" has been removed,
552 * walk up the tree until we reach our starting point.
554 if (list_empty(&parent->d_subdirs)) {
555 mutex_unlock(&parent->d_inode->i_mutex);
556 if (parent == dentry)
558 parent = parent->d_parent;
559 mutex_lock(&parent->d_inode->i_mutex);
561 child = list_entry(parent->d_subdirs.next, struct dentry,
566 * If "child" isn't empty, walk down the tree and
567 * remove all its descendants first.
569 if (!list_empty(&child->d_subdirs)) {
570 mutex_unlock(&parent->d_inode->i_mutex);
572 mutex_lock(&parent->d_inode->i_mutex);
575 __debugfs_remove(child, parent);
576 if (parent->d_subdirs.next == &child->d_u.d_child) {
578 * Try the next sibling.
580 if (child->d_u.d_child.next != &parent->d_subdirs) {
581 child = list_entry(child->d_u.d_child.next,
588 * Avoid infinite loop if we fail to remove
591 mutex_unlock(&parent->d_inode->i_mutex);
594 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
597 parent = dentry->d_parent;
598 mutex_lock(&parent->d_inode->i_mutex);
599 __debugfs_remove(dentry, parent);
600 mutex_unlock(&parent->d_inode->i_mutex);
601 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
603 EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
606 * debugfs_rename - rename a file/directory in the debugfs filesystem
607 * @old_dir: a pointer to the parent dentry for the renamed object. This
608 * should be a directory dentry.
609 * @old_dentry: dentry of an object to be renamed.
610 * @new_dir: a pointer to the parent dentry where the object should be
611 * moved. This should be a directory dentry.
612 * @new_name: a pointer to a string containing the target name.
614 * This function renames a file/directory in debugfs. The target must not
615 * exist for rename to succeed.
617 * This function will return a pointer to old_dentry (which is updated to
618 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
621 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
624 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
625 struct dentry *new_dir, const char *new_name)
628 struct dentry *dentry = NULL, *trap;
629 const char *old_name;
631 trap = lock_rename(new_dir, old_dir);
632 /* Source or destination directories don't exist? */
633 if (!old_dir->d_inode || !new_dir->d_inode)
635 /* Source does not exist, cyclic rename, or mountpoint? */
636 if (!old_dentry->d_inode || old_dentry == trap ||
637 d_mountpoint(old_dentry))
639 dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
640 /* Lookup failed, cyclic rename or target exists? */
641 if (IS_ERR(dentry) || dentry == trap || dentry->d_inode)
644 old_name = fsnotify_oldname_init(old_dentry->d_name.name);
646 error = simple_rename(old_dir->d_inode, old_dentry, new_dir->d_inode,
649 fsnotify_oldname_free(old_name);
652 d_move(old_dentry, dentry);
653 fsnotify_move(old_dir->d_inode, new_dir->d_inode, old_name,
654 S_ISDIR(old_dentry->d_inode->i_mode),
656 fsnotify_oldname_free(old_name);
657 unlock_rename(new_dir, old_dir);
661 if (dentry && !IS_ERR(dentry))
663 unlock_rename(new_dir, old_dir);
666 EXPORT_SYMBOL_GPL(debugfs_rename);
669 * debugfs_initialized - Tells whether debugfs has been registered
671 bool debugfs_initialized(void)
673 return debugfs_registered;
675 EXPORT_SYMBOL_GPL(debugfs_initialized);
678 static struct kobject *debug_kobj;
680 static int __init debugfs_init(void)
684 debug_kobj = kobject_create_and_add("debug", kernel_kobj);
688 retval = register_filesystem(&debug_fs_type);
690 kobject_put(debug_kobj);
692 debugfs_registered = true;
696 core_initcall(debugfs_init);