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/magic.h>
27 #include <linux/slab.h>
29 static struct vfsmount
*debugfs_mount
;
30 static int debugfs_mount_count
;
31 static bool debugfs_registered
;
33 static struct inode
*debugfs_get_inode(struct super_block
*sb
, int mode
, dev_t dev
,
34 void *data
, const struct file_operations
*fops
)
37 struct inode
*inode
= new_inode(sb
);
40 inode
->i_ino
= get_next_ino();
42 inode
->i_atime
= inode
->i_mtime
= inode
->i_ctime
= CURRENT_TIME
;
43 switch (mode
& S_IFMT
) {
45 init_special_inode(inode
, mode
, dev
);
48 inode
->i_fop
= fops
? fops
: &debugfs_file_operations
;
49 inode
->i_private
= data
;
52 inode
->i_op
= &debugfs_link_operations
;
54 inode
->i_private
= data
;
57 inode
->i_op
= &simple_dir_inode_operations
;
58 inode
->i_fop
= fops
? fops
: &simple_dir_operations
;
59 inode
->i_private
= data
;
61 /* directory inodes start off with i_nlink == 2
71 static int debugfs_mknod(struct inode
*dir
, struct dentry
*dentry
,
72 int mode
, dev_t dev
, void *data
,
73 const struct file_operations
*fops
)
81 inode
= debugfs_get_inode(dir
->i_sb
, mode
, dev
, data
, fops
);
83 d_instantiate(dentry
, inode
);
90 static int debugfs_mkdir(struct inode
*dir
, struct dentry
*dentry
, int mode
,
91 void *data
, const struct file_operations
*fops
)
95 mode
= (mode
& (S_IRWXUGO
| S_ISVTX
)) | S_IFDIR
;
96 res
= debugfs_mknod(dir
, dentry
, mode
, 0, data
, fops
);
99 fsnotify_mkdir(dir
, dentry
);
104 static int debugfs_link(struct inode
*dir
, struct dentry
*dentry
, int mode
,
105 void *data
, const struct file_operations
*fops
)
107 mode
= (mode
& S_IALLUGO
) | S_IFLNK
;
108 return debugfs_mknod(dir
, dentry
, mode
, 0, data
, fops
);
111 static int debugfs_create(struct inode
*dir
, struct dentry
*dentry
, int mode
,
112 void *data
, const struct file_operations
*fops
)
116 mode
= (mode
& S_IALLUGO
) | S_IFREG
;
117 res
= debugfs_mknod(dir
, dentry
, mode
, 0, data
, fops
);
119 fsnotify_create(dir
, dentry
);
123 static inline int debugfs_positive(struct dentry
*dentry
)
125 return dentry
->d_inode
&& !d_unhashed(dentry
);
128 static int debug_fill_super(struct super_block
*sb
, void *data
, int silent
)
130 static struct tree_descr debug_files
[] = {{""}};
132 return simple_fill_super(sb
, DEBUGFS_MAGIC
, debug_files
);
135 static struct dentry
*debug_mount(struct file_system_type
*fs_type
,
136 int flags
, const char *dev_name
,
139 return mount_single(fs_type
, flags
, data
, debug_fill_super
);
142 static struct file_system_type debug_fs_type
= {
143 .owner
= THIS_MODULE
,
145 .mount
= debug_mount
,
146 .kill_sb
= kill_litter_super
,
149 static int debugfs_create_by_name(const char *name
, mode_t mode
,
150 struct dentry
*parent
,
151 struct dentry
**dentry
,
153 const struct file_operations
*fops
)
157 /* If the parent is not specified, we create it in the root.
158 * We need the root dentry to do this, which is in the super
159 * block. A pointer to that is in the struct vfsmount that we
163 parent
= debugfs_mount
->mnt_sb
->s_root
;
166 mutex_lock(&parent
->d_inode
->i_mutex
);
167 *dentry
= lookup_one_len(name
, parent
, strlen(name
));
168 if (!IS_ERR(*dentry
)) {
169 switch (mode
& S_IFMT
) {
171 error
= debugfs_mkdir(parent
->d_inode
, *dentry
, mode
,
175 error
= debugfs_link(parent
->d_inode
, *dentry
, mode
,
179 error
= debugfs_create(parent
->d_inode
, *dentry
, mode
,
185 error
= PTR_ERR(*dentry
);
186 mutex_unlock(&parent
->d_inode
->i_mutex
);
192 * debugfs_create_file - create a file in the debugfs filesystem
193 * @name: a pointer to a string containing the name of the file to create.
194 * @mode: the permission that the file should have.
195 * @parent: a pointer to the parent dentry for this file. This should be a
196 * directory dentry if set. If this paramater is NULL, then the
197 * file will be created in the root of the debugfs filesystem.
198 * @data: a pointer to something that the caller will want to get to later
199 * on. The inode.i_private pointer will point to this value on
201 * @fops: a pointer to a struct file_operations that should be used for
204 * This is the basic "create a file" function for debugfs. It allows for a
205 * wide range of flexibility in creating a file, or a directory (if you want
206 * to create a directory, the debugfs_create_dir() function is
207 * recommended to be used instead.)
209 * This function will return a pointer to a dentry if it succeeds. This
210 * pointer must be passed to the debugfs_remove() function when the file is
211 * to be removed (no automatic cleanup happens if your module is unloaded,
212 * you are responsible here.) If an error occurs, %NULL will be returned.
214 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
217 struct dentry
*debugfs_create_file(const char *name
, mode_t mode
,
218 struct dentry
*parent
, void *data
,
219 const struct file_operations
*fops
)
221 struct dentry
*dentry
= NULL
;
224 pr_debug("debugfs: creating file '%s'\n",name
);
226 error
= simple_pin_fs(&debug_fs_type
, &debugfs_mount
,
227 &debugfs_mount_count
);
231 error
= debugfs_create_by_name(name
, mode
, parent
, &dentry
,
235 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
241 EXPORT_SYMBOL_GPL(debugfs_create_file
);
244 * debugfs_create_dir - create a directory in the debugfs filesystem
245 * @name: a pointer to a string containing the name of the directory to
247 * @parent: a pointer to the parent dentry for this file. This should be a
248 * directory dentry if set. If this paramater is NULL, then the
249 * directory will be created in the root of the debugfs filesystem.
251 * This function creates a directory in debugfs with the given name.
253 * This function will return a pointer to a dentry if it succeeds. This
254 * pointer must be passed to the debugfs_remove() function when the file is
255 * to be removed (no automatic cleanup happens if your module is unloaded,
256 * you are responsible here.) If an error occurs, %NULL will be returned.
258 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
261 struct dentry
*debugfs_create_dir(const char *name
, struct dentry
*parent
)
263 return debugfs_create_file(name
,
264 S_IFDIR
| S_IRWXU
| S_IRUGO
| S_IXUGO
,
267 EXPORT_SYMBOL_GPL(debugfs_create_dir
);
270 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
271 * @name: a pointer to a string containing the name of the symbolic link to
273 * @parent: a pointer to the parent dentry for this symbolic link. This
274 * should be a directory dentry if set. If this paramater is NULL,
275 * then the symbolic link will be created in the root of the debugfs
277 * @target: a pointer to a string containing the path to the target of the
280 * This function creates a symbolic link with the given name in debugfs that
281 * links to the given target path.
283 * This function will return a pointer to a dentry if it succeeds. This
284 * pointer must be passed to the debugfs_remove() function when the symbolic
285 * link is to be removed (no automatic cleanup happens if your module is
286 * unloaded, you are responsible here.) If an error occurs, %NULL will be
289 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
292 struct dentry
*debugfs_create_symlink(const char *name
, struct dentry
*parent
,
295 struct dentry
*result
;
298 link
= kstrdup(target
, GFP_KERNEL
);
302 result
= debugfs_create_file(name
, S_IFLNK
| S_IRWXUGO
, parent
, link
,
308 EXPORT_SYMBOL_GPL(debugfs_create_symlink
);
310 static int __debugfs_remove(struct dentry
*dentry
, struct dentry
*parent
)
314 if (debugfs_positive(dentry
)) {
315 if (dentry
->d_inode
) {
317 switch (dentry
->d_inode
->i_mode
& S_IFMT
) {
319 ret
= simple_rmdir(parent
->d_inode
, dentry
);
322 kfree(dentry
->d_inode
->i_private
);
325 simple_unlink(parent
->d_inode
, dentry
);
337 * debugfs_remove - removes a file or directory from the debugfs filesystem
338 * @dentry: a pointer to a the dentry of the file or directory to be
341 * This function removes a file or directory in debugfs that was previously
342 * created with a call to another debugfs function (like
343 * debugfs_create_file() or variants thereof.)
345 * This function is required to be called in order for the file to be
346 * removed, no automatic cleanup of files will happen when a module is
347 * removed, you are responsible here.
349 void debugfs_remove(struct dentry
*dentry
)
351 struct dentry
*parent
;
357 parent
= dentry
->d_parent
;
358 if (!parent
|| !parent
->d_inode
)
361 mutex_lock(&parent
->d_inode
->i_mutex
);
362 ret
= __debugfs_remove(dentry
, parent
);
363 mutex_unlock(&parent
->d_inode
->i_mutex
);
365 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
367 EXPORT_SYMBOL_GPL(debugfs_remove
);
370 * debugfs_remove_recursive - recursively removes a directory
371 * @dentry: a pointer to a the dentry of the directory to be removed.
373 * This function recursively removes a directory tree in debugfs that
374 * was previously created with a call to another debugfs function
375 * (like debugfs_create_file() or variants thereof.)
377 * This function is required to be called in order for the file to be
378 * removed, no automatic cleanup of files will happen when a module is
379 * removed, you are responsible here.
381 void debugfs_remove_recursive(struct dentry
*dentry
)
383 struct dentry
*child
;
384 struct dentry
*parent
;
389 parent
= dentry
->d_parent
;
390 if (!parent
|| !parent
->d_inode
)
394 mutex_lock(&parent
->d_inode
->i_mutex
);
398 * When all dentries under "parent" has been removed,
399 * walk up the tree until we reach our starting point.
401 if (list_empty(&parent
->d_subdirs
)) {
402 mutex_unlock(&parent
->d_inode
->i_mutex
);
403 if (parent
== dentry
)
405 parent
= parent
->d_parent
;
406 mutex_lock(&parent
->d_inode
->i_mutex
);
408 child
= list_entry(parent
->d_subdirs
.next
, struct dentry
,
413 * If "child" isn't empty, walk down the tree and
414 * remove all its descendants first.
416 if (!list_empty(&child
->d_subdirs
)) {
417 mutex_unlock(&parent
->d_inode
->i_mutex
);
419 mutex_lock(&parent
->d_inode
->i_mutex
);
422 __debugfs_remove(child
, parent
);
423 if (parent
->d_subdirs
.next
== &child
->d_u
.d_child
) {
425 * Try the next sibling.
427 if (child
->d_u
.d_child
.next
!= &parent
->d_subdirs
) {
428 child
= list_entry(child
->d_u
.d_child
.next
,
435 * Avoid infinite loop if we fail to remove
438 mutex_unlock(&parent
->d_inode
->i_mutex
);
441 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
444 parent
= dentry
->d_parent
;
445 mutex_lock(&parent
->d_inode
->i_mutex
);
446 __debugfs_remove(dentry
, parent
);
447 mutex_unlock(&parent
->d_inode
->i_mutex
);
448 simple_release_fs(&debugfs_mount
, &debugfs_mount_count
);
450 EXPORT_SYMBOL_GPL(debugfs_remove_recursive
);
453 * debugfs_rename - rename a file/directory in the debugfs filesystem
454 * @old_dir: a pointer to the parent dentry for the renamed object. This
455 * should be a directory dentry.
456 * @old_dentry: dentry of an object to be renamed.
457 * @new_dir: a pointer to the parent dentry where the object should be
458 * moved. This should be a directory dentry.
459 * @new_name: a pointer to a string containing the target name.
461 * This function renames a file/directory in debugfs. The target must not
462 * exist for rename to succeed.
464 * This function will return a pointer to old_dentry (which is updated to
465 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
468 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
471 struct dentry
*debugfs_rename(struct dentry
*old_dir
, struct dentry
*old_dentry
,
472 struct dentry
*new_dir
, const char *new_name
)
475 struct dentry
*dentry
= NULL
, *trap
;
476 const char *old_name
;
478 trap
= lock_rename(new_dir
, old_dir
);
479 /* Source or destination directories don't exist? */
480 if (!old_dir
->d_inode
|| !new_dir
->d_inode
)
482 /* Source does not exist, cyclic rename, or mountpoint? */
483 if (!old_dentry
->d_inode
|| old_dentry
== trap
||
484 d_mountpoint(old_dentry
))
486 dentry
= lookup_one_len(new_name
, new_dir
, strlen(new_name
));
487 /* Lookup failed, cyclic rename or target exists? */
488 if (IS_ERR(dentry
) || dentry
== trap
|| dentry
->d_inode
)
491 old_name
= fsnotify_oldname_init(old_dentry
->d_name
.name
);
493 error
= simple_rename(old_dir
->d_inode
, old_dentry
, new_dir
->d_inode
,
496 fsnotify_oldname_free(old_name
);
499 d_move(old_dentry
, dentry
);
500 fsnotify_move(old_dir
->d_inode
, new_dir
->d_inode
, old_name
,
501 S_ISDIR(old_dentry
->d_inode
->i_mode
),
503 fsnotify_oldname_free(old_name
);
504 unlock_rename(new_dir
, old_dir
);
508 if (dentry
&& !IS_ERR(dentry
))
510 unlock_rename(new_dir
, old_dir
);
513 EXPORT_SYMBOL_GPL(debugfs_rename
);
516 * debugfs_initialized - Tells whether debugfs has been registered
518 bool debugfs_initialized(void)
520 return debugfs_registered
;
522 EXPORT_SYMBOL_GPL(debugfs_initialized
);
525 static struct kobject
*debug_kobj
;
527 static int __init
debugfs_init(void)
531 debug_kobj
= kobject_create_and_add("debug", kernel_kobj
);
535 retval
= register_filesystem(&debug_fs_type
);
537 kobject_put(debug_kobj
);
539 debugfs_registered
= true;
543 core_initcall(debugfs_init
);