2 * inode.c - part of debugfs, a tiny little debug file system
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)
39 struct inode *inode = new_inode(sb);
41 inode->i_ino = get_next_ino();
42 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
47 struct debugfs_mount_opts {
60 static const match_table_t tokens = {
63 {Opt_mode, "mode=%o"},
67 struct debugfs_fs_info {
68 struct debugfs_mount_opts mount_opts;
71 static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
73 substring_t args[MAX_OPT_ARGS];
80 opts->mode = DEBUGFS_DEFAULT_MODE;
82 while ((p = strsep(&data, ",")) != NULL) {
86 token = match_token(p, tokens, args);
89 if (match_int(&args[0], &option))
91 uid = make_kuid(current_user_ns(), option);
97 if (match_int(&args[0], &option))
99 gid = make_kgid(current_user_ns(), option);
105 if (match_octal(&args[0], &option))
107 opts->mode = option & S_IALLUGO;
110 * We might like to report bad mount options here;
111 * but traditionally debugfs has ignored all mount options
119 static int debugfs_apply_options(struct super_block *sb)
121 struct debugfs_fs_info *fsi = sb->s_fs_info;
122 struct inode *inode = d_inode(sb->s_root);
123 struct debugfs_mount_opts *opts = &fsi->mount_opts;
125 inode->i_mode &= ~S_IALLUGO;
126 inode->i_mode |= opts->mode;
128 inode->i_uid = opts->uid;
129 inode->i_gid = opts->gid;
134 static int debugfs_remount(struct super_block *sb, int *flags, char *data)
137 struct debugfs_fs_info *fsi = sb->s_fs_info;
140 err = debugfs_parse_options(data, &fsi->mount_opts);
144 debugfs_apply_options(sb);
150 static int debugfs_show_options(struct seq_file *m, struct dentry *root)
152 struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
153 struct debugfs_mount_opts *opts = &fsi->mount_opts;
155 if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
156 seq_printf(m, ",uid=%u",
157 from_kuid_munged(&init_user_ns, opts->uid));
158 if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
159 seq_printf(m, ",gid=%u",
160 from_kgid_munged(&init_user_ns, opts->gid));
161 if (opts->mode != DEBUGFS_DEFAULT_MODE)
162 seq_printf(m, ",mode=%o", opts->mode);
167 static void debugfs_evict_inode(struct inode *inode)
169 truncate_inode_pages_final(&inode->i_data);
171 if (S_ISLNK(inode->i_mode))
172 kfree(inode->i_link);
175 static const struct super_operations debugfs_super_operations = {
176 .statfs = simple_statfs,
177 .remount_fs = debugfs_remount,
178 .show_options = debugfs_show_options,
179 .evict_inode = debugfs_evict_inode,
182 static struct vfsmount *debugfs_automount(struct path *path)
184 struct vfsmount *(*f)(void *);
185 f = (struct vfsmount *(*)(void *))path->dentry->d_fsdata;
186 return f(d_inode(path->dentry)->i_private);
189 static const struct dentry_operations debugfs_dops = {
190 .d_delete = always_delete_dentry,
191 .d_automount = debugfs_automount,
194 static int debug_fill_super(struct super_block *sb, void *data, int silent)
196 static struct tree_descr debug_files[] = {{""}};
197 struct debugfs_fs_info *fsi;
200 save_mount_options(sb, data);
202 fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
209 err = debugfs_parse_options(data, &fsi->mount_opts);
213 err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
217 sb->s_op = &debugfs_super_operations;
218 sb->s_d_op = &debugfs_dops;
220 debugfs_apply_options(sb);
226 sb->s_fs_info = NULL;
230 static struct dentry *debug_mount(struct file_system_type *fs_type,
231 int flags, const char *dev_name,
234 return mount_single(fs_type, flags, data, debug_fill_super);
237 static struct file_system_type debug_fs_type = {
238 .owner = THIS_MODULE,
240 .mount = debug_mount,
241 .kill_sb = kill_litter_super,
243 MODULE_ALIAS_FS("debugfs");
245 static struct dentry *start_creating(const char *name, struct dentry *parent)
247 struct dentry *dentry;
250 pr_debug("debugfs: creating file '%s'\n",name);
255 error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
256 &debugfs_mount_count);
258 return ERR_PTR(error);
260 /* If the parent is not specified, we create it in the root.
261 * We need the root dentry to do this, which is in the super
262 * block. A pointer to that is in the struct vfsmount that we
266 parent = debugfs_mount->mnt_root;
268 inode_lock(d_inode(parent));
269 dentry = lookup_one_len(name, parent, strlen(name));
270 if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
272 dentry = ERR_PTR(-EEXIST);
275 if (IS_ERR(dentry)) {
276 inode_unlock(d_inode(parent));
277 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
283 static struct dentry *failed_creating(struct dentry *dentry)
285 inode_unlock(d_inode(dentry->d_parent));
287 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
291 static struct dentry *end_creating(struct dentry *dentry)
293 inode_unlock(d_inode(dentry->d_parent));
298 * debugfs_create_file - create a file in the debugfs filesystem
299 * @name: a pointer to a string containing the name of the file to create.
300 * @mode: the permission that the file should have.
301 * @parent: a pointer to the parent dentry for this file. This should be a
302 * directory dentry if set. If this parameter is NULL, then the
303 * file will be created in the root of the debugfs filesystem.
304 * @data: a pointer to something that the caller will want to get to later
305 * on. The inode.i_private pointer will point to this value on
307 * @fops: a pointer to a struct file_operations that should be used for
310 * This is the basic "create a file" function for debugfs. It allows for a
311 * wide range of flexibility in creating a file, or a directory (if you want
312 * to create a directory, the debugfs_create_dir() function is
313 * recommended to be used instead.)
315 * This function will return a pointer to a dentry if it succeeds. This
316 * pointer must be passed to the debugfs_remove() function when the file is
317 * to be removed (no automatic cleanup happens if your module is unloaded,
318 * you are responsible here.) If an error occurs, %NULL will be returned.
320 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
323 struct dentry *debugfs_create_file(const char *name, umode_t mode,
324 struct dentry *parent, void *data,
325 const struct file_operations *fops)
327 struct dentry *dentry;
330 if (!(mode & S_IFMT))
332 BUG_ON(!S_ISREG(mode));
333 dentry = start_creating(name, parent);
338 inode = debugfs_get_inode(dentry->d_sb);
339 if (unlikely(!inode))
340 return failed_creating(dentry);
342 inode->i_mode = mode;
343 inode->i_fop = fops ? fops : &debugfs_file_operations;
344 inode->i_private = data;
345 d_instantiate(dentry, inode);
346 fsnotify_create(d_inode(dentry->d_parent), dentry);
347 return end_creating(dentry);
349 EXPORT_SYMBOL_GPL(debugfs_create_file);
352 * debugfs_create_file_size - create a file in the debugfs filesystem
353 * @name: a pointer to a string containing the name of the file to create.
354 * @mode: the permission that the file should have.
355 * @parent: a pointer to the parent dentry for this file. This should be a
356 * directory dentry if set. If this parameter is NULL, then the
357 * file will be created in the root of the debugfs filesystem.
358 * @data: a pointer to something that the caller will want to get to later
359 * on. The inode.i_private pointer will point to this value on
361 * @fops: a pointer to a struct file_operations that should be used for
363 * @file_size: initial file size
365 * This is the basic "create a file" function for debugfs. It allows for a
366 * wide range of flexibility in creating a file, or a directory (if you want
367 * to create a directory, the debugfs_create_dir() function is
368 * recommended to be used instead.)
370 * This function will return a pointer to a dentry if it succeeds. This
371 * pointer must be passed to the debugfs_remove() function when the file is
372 * to be removed (no automatic cleanup happens if your module is unloaded,
373 * you are responsible here.) If an error occurs, %NULL will be returned.
375 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
378 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
379 struct dentry *parent, void *data,
380 const struct file_operations *fops,
383 struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
386 d_inode(de)->i_size = file_size;
389 EXPORT_SYMBOL_GPL(debugfs_create_file_size);
392 * debugfs_create_dir - create a directory in the debugfs filesystem
393 * @name: a pointer to a string containing the name of the directory to
395 * @parent: a pointer to the parent dentry for this file. This should be a
396 * directory dentry if set. If this parameter is NULL, then the
397 * directory will be created in the root of the debugfs filesystem.
399 * This function creates a directory in debugfs with the given name.
401 * This function will return a pointer to a dentry if it succeeds. This
402 * pointer must be passed to the debugfs_remove() function when the file is
403 * to be removed (no automatic cleanup happens if your module is unloaded,
404 * you are responsible here.) If an error occurs, %NULL will be returned.
406 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
409 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
411 struct dentry *dentry = start_creating(name, parent);
417 inode = debugfs_get_inode(dentry->d_sb);
418 if (unlikely(!inode))
419 return failed_creating(dentry);
421 inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
422 inode->i_op = &simple_dir_inode_operations;
423 inode->i_fop = &simple_dir_operations;
425 /* directory inodes start off with i_nlink == 2 (for "." entry) */
427 d_instantiate(dentry, inode);
428 inc_nlink(d_inode(dentry->d_parent));
429 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
430 return end_creating(dentry);
432 EXPORT_SYMBOL_GPL(debugfs_create_dir);
435 * debugfs_create_automount - create automount point in the debugfs filesystem
436 * @name: a pointer to a string containing the name of the file to create.
437 * @parent: a pointer to the parent dentry for this file. This should be a
438 * directory dentry if set. If this parameter is NULL, then the
439 * file will be created in the root of the debugfs filesystem.
440 * @f: function to be called when pathname resolution steps on that one.
441 * @data: opaque argument to pass to f().
443 * @f should return what ->d_automount() would.
445 struct dentry *debugfs_create_automount(const char *name,
446 struct dentry *parent,
447 struct vfsmount *(*f)(void *),
450 struct dentry *dentry = start_creating(name, parent);
456 inode = debugfs_get_inode(dentry->d_sb);
457 if (unlikely(!inode))
458 return failed_creating(dentry);
460 inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
461 inode->i_flags |= S_AUTOMOUNT;
462 inode->i_private = data;
463 dentry->d_fsdata = (void *)f;
464 d_instantiate(dentry, inode);
465 return end_creating(dentry);
467 EXPORT_SYMBOL(debugfs_create_automount);
470 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
471 * @name: a pointer to a string containing the name of the symbolic link to
473 * @parent: a pointer to the parent dentry for this symbolic link. This
474 * should be a directory dentry if set. If this parameter is NULL,
475 * then the symbolic link will be created in the root of the debugfs
477 * @target: a pointer to a string containing the path to the target of the
480 * This function creates a symbolic link with the given name in debugfs that
481 * links to the given target path.
483 * This function will return a pointer to a dentry if it succeeds. This
484 * pointer must be passed to the debugfs_remove() function when the symbolic
485 * link is to be removed (no automatic cleanup happens if your module is
486 * unloaded, you are responsible here.) If an error occurs, %NULL will be
489 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
492 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
495 struct dentry *dentry;
497 char *link = kstrdup(target, GFP_KERNEL);
501 dentry = start_creating(name, parent);
502 if (IS_ERR(dentry)) {
507 inode = debugfs_get_inode(dentry->d_sb);
508 if (unlikely(!inode)) {
510 return failed_creating(dentry);
512 inode->i_mode = S_IFLNK | S_IRWXUGO;
513 inode->i_op = &simple_symlink_inode_operations;
514 inode->i_link = link;
515 d_instantiate(dentry, inode);
516 return end_creating(dentry);
518 EXPORT_SYMBOL_GPL(debugfs_create_symlink);
520 static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
524 if (simple_positive(dentry)) {
526 if (d_is_dir(dentry))
527 ret = simple_rmdir(d_inode(parent), dentry);
529 simple_unlink(d_inode(parent), dentry);
538 * debugfs_remove - removes a file or directory from the debugfs filesystem
539 * @dentry: a pointer to a the dentry of the file or directory to be
540 * removed. If this parameter is NULL or an error value, nothing
543 * This function removes a file or directory in debugfs that was previously
544 * created with a call to another debugfs function (like
545 * debugfs_create_file() or variants thereof.)
547 * This function is required to be called in order for the file to be
548 * removed, no automatic cleanup of files will happen when a module is
549 * removed, you are responsible here.
551 void debugfs_remove(struct dentry *dentry)
553 struct dentry *parent;
556 if (IS_ERR_OR_NULL(dentry))
559 parent = dentry->d_parent;
560 if (!parent || d_really_is_negative(parent))
563 inode_lock(d_inode(parent));
564 ret = __debugfs_remove(dentry, parent);
565 inode_unlock(d_inode(parent));
567 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
569 EXPORT_SYMBOL_GPL(debugfs_remove);
572 * debugfs_remove_recursive - recursively removes a directory
573 * @dentry: a pointer to a the dentry of the directory to be removed. If this
574 * parameter is NULL or an error value, nothing will be done.
576 * This function recursively removes a directory tree in debugfs that
577 * was previously created with a call to another debugfs function
578 * (like debugfs_create_file() or variants thereof.)
580 * This function is required to be called in order for the file to be
581 * removed, no automatic cleanup of files will happen when a module is
582 * removed, you are responsible here.
584 void debugfs_remove_recursive(struct dentry *dentry)
586 struct dentry *child, *parent;
588 if (IS_ERR_OR_NULL(dentry))
591 parent = dentry->d_parent;
592 if (!parent || d_really_is_negative(parent))
597 inode_lock(d_inode(parent));
600 * The parent->d_subdirs is protected by the d_lock. Outside that
601 * lock, the child can be unlinked and set to be freed which can
602 * use the d_u.d_child as the rcu head and corrupt this list.
604 spin_lock(&parent->d_lock);
605 list_for_each_entry(child, &parent->d_subdirs, d_child) {
606 if (!simple_positive(child))
609 /* perhaps simple_empty(child) makes more sense */
610 if (!list_empty(&child->d_subdirs)) {
611 spin_unlock(&parent->d_lock);
612 inode_unlock(d_inode(parent));
617 spin_unlock(&parent->d_lock);
619 if (!__debugfs_remove(child, parent))
620 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
623 * The parent->d_lock protects agaist child from unlinking
624 * from d_subdirs. When releasing the parent->d_lock we can
625 * no longer trust that the next pointer is valid.
626 * Restart the loop. We'll skip this one with the
627 * simple_positive() check.
631 spin_unlock(&parent->d_lock);
633 inode_unlock(d_inode(parent));
635 parent = parent->d_parent;
636 inode_lock(d_inode(parent));
642 if (!__debugfs_remove(child, parent))
643 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
644 inode_unlock(d_inode(parent));
646 EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
649 * debugfs_rename - rename a file/directory in the debugfs filesystem
650 * @old_dir: a pointer to the parent dentry for the renamed object. This
651 * should be a directory dentry.
652 * @old_dentry: dentry of an object to be renamed.
653 * @new_dir: a pointer to the parent dentry where the object should be
654 * moved. This should be a directory dentry.
655 * @new_name: a pointer to a string containing the target name.
657 * This function renames a file/directory in debugfs. The target must not
658 * exist for rename to succeed.
660 * This function will return a pointer to old_dentry (which is updated to
661 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
664 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
667 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
668 struct dentry *new_dir, const char *new_name)
671 struct dentry *dentry = NULL, *trap;
672 const char *old_name;
674 trap = lock_rename(new_dir, old_dir);
675 /* Source or destination directories don't exist? */
676 if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
678 /* Source does not exist, cyclic rename, or mountpoint? */
679 if (d_really_is_negative(old_dentry) || old_dentry == trap ||
680 d_mountpoint(old_dentry))
682 dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
683 /* Lookup failed, cyclic rename or target exists? */
684 if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
687 old_name = fsnotify_oldname_init(old_dentry->d_name.name);
689 error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
692 fsnotify_oldname_free(old_name);
695 d_move(old_dentry, dentry);
696 fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name,
697 d_is_dir(old_dentry),
699 fsnotify_oldname_free(old_name);
700 unlock_rename(new_dir, old_dir);
704 if (dentry && !IS_ERR(dentry))
706 unlock_rename(new_dir, old_dir);
709 EXPORT_SYMBOL_GPL(debugfs_rename);
712 * debugfs_initialized - Tells whether debugfs has been registered
714 bool debugfs_initialized(void)
716 return debugfs_registered;
718 EXPORT_SYMBOL_GPL(debugfs_initialized);
720 static int __init debugfs_init(void)
724 retval = sysfs_create_mount_point(kernel_kobj, "debug");
728 retval = register_filesystem(&debug_fs_type);
730 sysfs_remove_mount_point(kernel_kobj, "debug");
732 debugfs_registered = true;
736 core_initcall(debugfs_init);