blob: a9c3d3e9af397d724ec3014ee287d1eaf3ffe261 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Harry Weibd33d122011-07-16 16:45:13 +08002 * inode.c - part of debugfs, a tiny little debug file system
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
5 * Copyright (C) 2004 IBM Inc.
6 *
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.
10 *
11 * debugfs is for people to use instead of /proc or /sys.
Mauro Carvalho Chehabe1511a82017-05-14 12:09:53 -030012 * See ./Documentation/core-api/kernel-api.rst for more details.
Linus Torvalds1da177e2005-04-16 15:20:36 -070013 *
14 */
15
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/module.h>
17#include <linux/fs.h>
18#include <linux/mount.h>
19#include <linux/pagemap.h>
20#include <linux/init.h>
Randy Dunlap4d8ebdd2006-11-25 11:09:26 -080021#include <linux/kobject.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/namei.h>
23#include <linux/debugfs.h>
Mathieu Desnoyers4f365572006-11-24 13:45:37 -050024#include <linux/fsnotify.h>
Peter Oberparleiter66f54962007-02-13 12:13:54 +010025#include <linux/string.h>
Ludwig Nusseld6e48682012-01-25 11:52:28 +010026#include <linux/seq_file.h>
27#include <linux/parser.h>
Mimi Zohar92562922008-10-07 14:00:12 -040028#include <linux/magic.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090029#include <linux/slab.h>
Nicolai Stange9fd4dce2016-03-22 14:11:13 +010030#include <linux/srcu.h>
31
32#include "internal.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
Kees Cook82aceae42012-08-27 13:32:15 -070034#define DEBUGFS_DEFAULT_MODE 0700
Ludwig Nusseld6e48682012-01-25 11:52:28 +010035
Nicolai Stange9fd4dce2016-03-22 14:11:13 +010036DEFINE_SRCU(debugfs_srcu);
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038static struct vfsmount *debugfs_mount;
39static int debugfs_mount_count;
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +010040static bool debugfs_registered;
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Al Viroedac65e2015-01-25 14:36:18 -050042static struct inode *debugfs_get_inode(struct super_block *sb)
Linus Torvalds1da177e2005-04-16 15:20:36 -070043{
44 struct inode *inode = new_inode(sb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 if (inode) {
Christoph Hellwig85fe4022010-10-23 11:19:54 -040046 inode->i_ino = get_next_ino();
Deepa Dinamani1b48b532016-02-22 07:17:47 -080047 inode->i_atime = inode->i_mtime =
Deepa Dinamanic2050a42016-09-14 07:48:06 -070048 inode->i_ctime = current_time(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 }
Rahul Bedarkar88e412e2014-06-06 23:12:04 +053050 return inode;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051}
52
Ludwig Nusseld6e48682012-01-25 11:52:28 +010053struct debugfs_mount_opts {
Eric W. Biederman7dc05882012-04-03 14:01:31 -070054 kuid_t uid;
55 kgid_t gid;
Ludwig Nusseld6e48682012-01-25 11:52:28 +010056 umode_t mode;
57};
58
59enum {
60 Opt_uid,
61 Opt_gid,
62 Opt_mode,
63 Opt_err
64};
65
66static const match_table_t tokens = {
67 {Opt_uid, "uid=%u"},
68 {Opt_gid, "gid=%u"},
69 {Opt_mode, "mode=%o"},
70 {Opt_err, NULL}
71};
72
73struct debugfs_fs_info {
74 struct debugfs_mount_opts mount_opts;
75};
76
77static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
78{
79 substring_t args[MAX_OPT_ARGS];
80 int option;
81 int token;
Eric W. Biederman7dc05882012-04-03 14:01:31 -070082 kuid_t uid;
83 kgid_t gid;
Ludwig Nusseld6e48682012-01-25 11:52:28 +010084 char *p;
85
86 opts->mode = DEBUGFS_DEFAULT_MODE;
87
88 while ((p = strsep(&data, ",")) != NULL) {
89 if (!*p)
90 continue;
91
92 token = match_token(p, tokens, args);
93 switch (token) {
94 case Opt_uid:
95 if (match_int(&args[0], &option))
96 return -EINVAL;
Eric W. Biederman7dc05882012-04-03 14:01:31 -070097 uid = make_kuid(current_user_ns(), option);
98 if (!uid_valid(uid))
99 return -EINVAL;
100 opts->uid = uid;
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100101 break;
102 case Opt_gid:
Dave Reisnerf1688e02013-01-02 08:54:37 -0500103 if (match_int(&args[0], &option))
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100104 return -EINVAL;
Eric W. Biederman7dc05882012-04-03 14:01:31 -0700105 gid = make_kgid(current_user_ns(), option);
106 if (!gid_valid(gid))
107 return -EINVAL;
108 opts->gid = gid;
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100109 break;
110 case Opt_mode:
111 if (match_octal(&args[0], &option))
112 return -EINVAL;
113 opts->mode = option & S_IALLUGO;
114 break;
115 /*
116 * We might like to report bad mount options here;
117 * but traditionally debugfs has ignored all mount options
118 */
119 }
120 }
121
122 return 0;
123}
124
125static int debugfs_apply_options(struct super_block *sb)
126{
127 struct debugfs_fs_info *fsi = sb->s_fs_info;
David Howells2b0143b2015-03-17 22:25:59 +0000128 struct inode *inode = d_inode(sb->s_root);
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100129 struct debugfs_mount_opts *opts = &fsi->mount_opts;
130
131 inode->i_mode &= ~S_IALLUGO;
132 inode->i_mode |= opts->mode;
133
134 inode->i_uid = opts->uid;
135 inode->i_gid = opts->gid;
136
137 return 0;
138}
139
140static int debugfs_remount(struct super_block *sb, int *flags, char *data)
141{
142 int err;
143 struct debugfs_fs_info *fsi = sb->s_fs_info;
144
Theodore Ts'o02b99842014-03-13 10:14:33 -0400145 sync_filesystem(sb);
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100146 err = debugfs_parse_options(data, &fsi->mount_opts);
147 if (err)
148 goto fail;
149
150 debugfs_apply_options(sb);
151
152fail:
153 return err;
154}
155
156static int debugfs_show_options(struct seq_file *m, struct dentry *root)
157{
158 struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
159 struct debugfs_mount_opts *opts = &fsi->mount_opts;
160
Eric W. Biederman7dc05882012-04-03 14:01:31 -0700161 if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
162 seq_printf(m, ",uid=%u",
163 from_kuid_munged(&init_user_ns, opts->uid));
164 if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
165 seq_printf(m, ",gid=%u",
166 from_kgid_munged(&init_user_ns, opts->gid));
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100167 if (opts->mode != DEBUGFS_DEFAULT_MODE)
168 seq_printf(m, ",mode=%o", opts->mode);
169
170 return 0;
171}
172
Al Viro0db59e52015-02-21 22:05:11 -0500173static void debugfs_evict_inode(struct inode *inode)
174{
175 truncate_inode_pages_final(&inode->i_data);
176 clear_inode(inode);
177 if (S_ISLNK(inode->i_mode))
Al Viro5723cb02015-05-02 10:27:18 -0400178 kfree(inode->i_link);
Al Viro0db59e52015-02-21 22:05:11 -0500179}
180
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100181static const struct super_operations debugfs_super_operations = {
182 .statfs = simple_statfs,
183 .remount_fs = debugfs_remount,
184 .show_options = debugfs_show_options,
Al Viro0db59e52015-02-21 22:05:11 -0500185 .evict_inode = debugfs_evict_inode,
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100186};
187
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100188static void debugfs_release_dentry(struct dentry *dentry)
189{
190 kfree(dentry->d_fsdata);
191}
192
Al Viro77b3da62015-01-25 15:10:32 -0500193static struct vfsmount *debugfs_automount(struct path *path)
194{
Eric W. Biederman93faccbb2017-02-01 06:06:16 +1300195 debugfs_automount_t f;
196 f = (debugfs_automount_t)path->dentry->d_fsdata;
197 return f(path->dentry, d_inode(path->dentry)->i_private);
Al Viro77b3da62015-01-25 15:10:32 -0500198}
199
200static const struct dentry_operations debugfs_dops = {
201 .d_delete = always_delete_dentry,
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100202 .d_release = debugfs_release_dentry,
Al Viro77b3da62015-01-25 15:10:32 -0500203 .d_automount = debugfs_automount,
204};
205
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206static int debug_fill_super(struct super_block *sb, void *data, int silent)
207{
Eric Biggerscda37122017-03-25 21:15:37 -0700208 static const struct tree_descr debug_files[] = {{""}};
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100209 struct debugfs_fs_info *fsi;
210 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100212 fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
213 sb->s_fs_info = fsi;
214 if (!fsi) {
215 err = -ENOMEM;
216 goto fail;
217 }
218
219 err = debugfs_parse_options(data, &fsi->mount_opts);
220 if (err)
221 goto fail;
222
223 err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
224 if (err)
225 goto fail;
226
227 sb->s_op = &debugfs_super_operations;
Al Viro77b3da62015-01-25 15:10:32 -0500228 sb->s_d_op = &debugfs_dops;
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100229
230 debugfs_apply_options(sb);
231
232 return 0;
233
234fail:
235 kfree(fsi);
236 sb->s_fs_info = NULL;
237 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238}
239
Al Virofc14f2f2010-07-25 01:48:30 +0400240static struct dentry *debug_mount(struct file_system_type *fs_type,
David Howells454e2392006-06-23 02:02:57 -0700241 int flags, const char *dev_name,
Al Virofc14f2f2010-07-25 01:48:30 +0400242 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
Al Virofc14f2f2010-07-25 01:48:30 +0400244 return mount_single(fs_type, flags, data, debug_fill_super);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245}
246
247static struct file_system_type debug_fs_type = {
248 .owner = THIS_MODULE,
249 .name = "debugfs",
Al Virofc14f2f2010-07-25 01:48:30 +0400250 .mount = debug_mount,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 .kill_sb = kill_litter_super,
252};
Eric W. Biederman7f78e032013-03-02 19:39:14 -0800253MODULE_ALIAS_FS("debugfs");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254
Omar Sandovala7c54372017-01-31 14:53:17 -0800255/**
256 * debugfs_lookup() - look up an existing debugfs file
257 * @name: a pointer to a string containing the name of the file to look up.
258 * @parent: a pointer to the parent dentry of the file.
259 *
260 * This function will return a pointer to a dentry if it succeeds. If the file
261 * doesn't exist or an error occurs, %NULL will be returned. The returned
262 * dentry must be passed to dput() when it is no longer needed.
263 *
264 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
265 * returned.
266 */
267struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
268{
269 struct dentry *dentry;
270
271 if (IS_ERR(parent))
272 return NULL;
273
274 if (!parent)
275 parent = debugfs_mount->mnt_root;
276
277 inode_lock(d_inode(parent));
278 dentry = lookup_one_len(name, parent, strlen(name));
279 inode_unlock(d_inode(parent));
280
281 if (IS_ERR(dentry))
282 return NULL;
283 if (!d_really_is_positive(dentry)) {
284 dput(dentry);
285 return NULL;
286 }
287 return dentry;
288}
289EXPORT_SYMBOL_GPL(debugfs_lookup);
290
Al Viro190afd82015-01-25 13:55:55 -0500291static struct dentry *start_creating(const char *name, struct dentry *parent)
Al Viroc3b1a352012-06-09 20:28:22 -0400292{
Al Viro190afd82015-01-25 13:55:55 -0500293 struct dentry *dentry;
Al Viroc3b1a352012-06-09 20:28:22 -0400294 int error;
295
296 pr_debug("debugfs: creating file '%s'\n",name);
297
Greg KHc9e15f22015-03-30 14:59:15 +0200298 if (IS_ERR(parent))
299 return parent;
300
Al Viroc3b1a352012-06-09 20:28:22 -0400301 error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
302 &debugfs_mount_count);
303 if (error)
Al Viro190afd82015-01-25 13:55:55 -0500304 return ERR_PTR(error);
Al Viroc3b1a352012-06-09 20:28:22 -0400305
Al Virocfa57c12012-06-09 20:33:28 -0400306 /* If the parent is not specified, we create it in the root.
Rahul Bedarkar88e412e2014-06-06 23:12:04 +0530307 * We need the root dentry to do this, which is in the super
Al Virocfa57c12012-06-09 20:33:28 -0400308 * block. A pointer to that is in the struct vfsmount that we
309 * have around.
310 */
311 if (!parent)
312 parent = debugfs_mount->mnt_root;
313
Al Viro59551022016-01-22 15:40:57 -0500314 inode_lock(d_inode(parent));
Al Virocfa57c12012-06-09 20:33:28 -0400315 dentry = lookup_one_len(name, parent, strlen(name));
David Howells2b0143b2015-03-17 22:25:59 +0000316 if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
Al Virocfa57c12012-06-09 20:33:28 -0400317 dput(dentry);
Al Viro190afd82015-01-25 13:55:55 -0500318 dentry = ERR_PTR(-EEXIST);
319 }
Daniel Borkmann0ee96082015-11-05 00:01:51 +0100320
321 if (IS_ERR(dentry)) {
Al Viro59551022016-01-22 15:40:57 -0500322 inode_unlock(d_inode(parent));
Daniel Borkmann0ee96082015-11-05 00:01:51 +0100323 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
324 }
325
Al Viro190afd82015-01-25 13:55:55 -0500326 return dentry;
327}
328
Al Viro5233e312015-01-25 14:39:49 -0500329static struct dentry *failed_creating(struct dentry *dentry)
Al Viro190afd82015-01-25 13:55:55 -0500330{
Al Viro59551022016-01-22 15:40:57 -0500331 inode_unlock(d_inode(dentry->d_parent));
Al Viro190afd82015-01-25 13:55:55 -0500332 dput(dentry);
Al Viro5233e312015-01-25 14:39:49 -0500333 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
334 return NULL;
335}
Al Virocfa57c12012-06-09 20:33:28 -0400336
Al Viro5233e312015-01-25 14:39:49 -0500337static struct dentry *end_creating(struct dentry *dentry)
338{
Al Viro59551022016-01-22 15:40:57 -0500339 inode_unlock(d_inode(dentry->d_parent));
Al Viroc3b1a352012-06-09 20:28:22 -0400340 return dentry;
341}
342
Nicolai Stange49d200d2016-03-22 14:11:14 +0100343static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
344 struct dentry *parent, void *data,
345 const struct file_operations *proxy_fops,
346 const struct file_operations *real_fops)
347{
348 struct dentry *dentry;
349 struct inode *inode;
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100350 struct debugfs_fsdata *fsd;
351
352 fsd = kmalloc(sizeof(*fsd), GFP_KERNEL);
353 if (!fsd)
354 return NULL;
Nicolai Stange49d200d2016-03-22 14:11:14 +0100355
356 if (!(mode & S_IFMT))
357 mode |= S_IFREG;
358 BUG_ON(!S_ISREG(mode));
359 dentry = start_creating(name, parent);
360
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100361 if (IS_ERR(dentry)) {
362 kfree(fsd);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100363 return NULL;
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100364 }
Nicolai Stange49d200d2016-03-22 14:11:14 +0100365
366 inode = debugfs_get_inode(dentry->d_sb);
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100367 if (unlikely(!inode)) {
368 kfree(fsd);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100369 return failed_creating(dentry);
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100370 }
Nicolai Stange49d200d2016-03-22 14:11:14 +0100371
372 inode->i_mode = mode;
373 inode->i_private = data;
374
375 inode->i_fop = proxy_fops;
Nicolai Stange7c8d4692017-10-31 00:15:47 +0100376 fsd->real_fops = real_fops;
377 dentry->d_fsdata = fsd;
Nicolai Stange49d200d2016-03-22 14:11:14 +0100378
379 d_instantiate(dentry, inode);
380 fsnotify_create(d_inode(dentry->d_parent), dentry);
381 return end_creating(dentry);
382}
383
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384/**
385 * debugfs_create_file - create a file in the debugfs filesystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 * @name: a pointer to a string containing the name of the file to create.
Alberto Bertoglibe030e62009-10-31 18:26:52 -0300387 * @mode: the permission that the file should have.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 * @parent: a pointer to the parent dentry for this file. This should be a
Masanari Iidae2278672014-02-18 22:54:36 +0900389 * directory dentry if set. If this parameter is NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 * file will be created in the root of the debugfs filesystem.
391 * @data: a pointer to something that the caller will want to get to later
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700392 * on. The inode.i_private pointer will point to this value on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 * the open() call.
394 * @fops: a pointer to a struct file_operations that should be used for
395 * this file.
396 *
397 * This is the basic "create a file" function for debugfs. It allows for a
Alberto Bertoglibe030e62009-10-31 18:26:52 -0300398 * wide range of flexibility in creating a file, or a directory (if you want
399 * to create a directory, the debugfs_create_dir() function is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 * recommended to be used instead.)
401 *
402 * This function will return a pointer to a dentry if it succeeds. This
403 * pointer must be passed to the debugfs_remove() function when the file is
404 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700405 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700407 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100408 * returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 */
Al Virof4ae40a62011-07-24 04:33:43 -0400410struct dentry *debugfs_create_file(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 struct dentry *parent, void *data,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800412 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413{
Al Viroc3b1a352012-06-09 20:28:22 -0400414
Nicolai Stange49d200d2016-03-22 14:11:14 +0100415 return __debugfs_create_file(name, mode, parent, data,
416 fops ? &debugfs_full_proxy_file_operations :
417 &debugfs_noop_file_operations,
418 fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419}
420EXPORT_SYMBOL_GPL(debugfs_create_file);
421
Nicolai Stangec6468802016-03-22 14:11:15 +0100422/**
423 * debugfs_create_file_unsafe - create a file in the debugfs filesystem
424 * @name: a pointer to a string containing the name of the file to create.
425 * @mode: the permission that the file should have.
426 * @parent: a pointer to the parent dentry for this file. This should be a
427 * directory dentry if set. If this parameter is NULL, then the
428 * file will be created in the root of the debugfs filesystem.
429 * @data: a pointer to something that the caller will want to get to later
430 * on. The inode.i_private pointer will point to this value on
431 * the open() call.
432 * @fops: a pointer to a struct file_operations that should be used for
433 * this file.
434 *
435 * debugfs_create_file_unsafe() is completely analogous to
436 * debugfs_create_file(), the only difference being that the fops
437 * handed it will not get protected against file removals by the
438 * debugfs core.
439 *
440 * It is your responsibility to protect your struct file_operation
441 * methods against file removals by means of debugfs_use_file_start()
442 * and debugfs_use_file_finish(). ->open() is still protected by
443 * debugfs though.
444 *
445 * Any struct file_operations defined by means of
446 * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
447 * thus, may be used here.
448 */
Nicolai Stange49d200d2016-03-22 14:11:14 +0100449struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
450 struct dentry *parent, void *data,
451 const struct file_operations *fops)
452{
453
454 return __debugfs_create_file(name, mode, parent, data,
455 fops ? &debugfs_open_proxy_file_operations :
456 &debugfs_noop_file_operations,
457 fops);
458}
Nicolai Stangec6468802016-03-22 14:11:15 +0100459EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100460
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461/**
David Howellse59b4e92015-01-21 20:03:40 +0000462 * debugfs_create_file_size - create a file in the debugfs filesystem
463 * @name: a pointer to a string containing the name of the file to create.
464 * @mode: the permission that the file should have.
465 * @parent: a pointer to the parent dentry for this file. This should be a
466 * directory dentry if set. If this parameter is NULL, then the
467 * file will be created in the root of the debugfs filesystem.
468 * @data: a pointer to something that the caller will want to get to later
469 * on. The inode.i_private pointer will point to this value on
470 * the open() call.
471 * @fops: a pointer to a struct file_operations that should be used for
472 * this file.
473 * @file_size: initial file size
474 *
475 * This is the basic "create a file" function for debugfs. It allows for a
476 * wide range of flexibility in creating a file, or a directory (if you want
477 * to create a directory, the debugfs_create_dir() function is
478 * recommended to be used instead.)
479 *
480 * This function will return a pointer to a dentry if it succeeds. This
481 * pointer must be passed to the debugfs_remove() function when the file is
482 * to be removed (no automatic cleanup happens if your module is unloaded,
483 * you are responsible here.) If an error occurs, %NULL will be returned.
484 *
485 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
486 * returned.
487 */
488struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
489 struct dentry *parent, void *data,
490 const struct file_operations *fops,
491 loff_t file_size)
492{
493 struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
494
495 if (de)
David Howells2b0143b2015-03-17 22:25:59 +0000496 d_inode(de)->i_size = file_size;
David Howellse59b4e92015-01-21 20:03:40 +0000497 return de;
498}
499EXPORT_SYMBOL_GPL(debugfs_create_file_size);
500
501/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 * debugfs_create_dir - create a directory in the debugfs filesystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 * @name: a pointer to a string containing the name of the directory to
504 * create.
505 * @parent: a pointer to the parent dentry for this file. This should be a
Masanari Iidae2278672014-02-18 22:54:36 +0900506 * directory dentry if set. If this parameter is NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 * directory will be created in the root of the debugfs filesystem.
508 *
509 * This function creates a directory in debugfs with the given name.
510 *
511 * This function will return a pointer to a dentry if it succeeds. This
512 * pointer must be passed to the debugfs_remove() function when the file is
513 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700514 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700516 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100517 * returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 */
519struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
520{
Al Viroad5abd52015-01-25 14:02:31 -0500521 struct dentry *dentry = start_creating(name, parent);
Al Viro680b3022015-01-25 14:31:32 -0500522 struct inode *inode;
Al Viroad5abd52015-01-25 14:02:31 -0500523
524 if (IS_ERR(dentry))
525 return NULL;
526
Al Viroedac65e2015-01-25 14:36:18 -0500527 inode = debugfs_get_inode(dentry->d_sb);
Al Viro680b3022015-01-25 14:31:32 -0500528 if (unlikely(!inode))
Al Viro5233e312015-01-25 14:39:49 -0500529 return failed_creating(dentry);
Al Viro680b3022015-01-25 14:31:32 -0500530
Al Viroedac65e2015-01-25 14:36:18 -0500531 inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
532 inode->i_op = &simple_dir_inode_operations;
533 inode->i_fop = &simple_dir_operations;
534
535 /* directory inodes start off with i_nlink == 2 (for "." entry) */
536 inc_nlink(inode);
Al Viro680b3022015-01-25 14:31:32 -0500537 d_instantiate(dentry, inode);
David Howells2b0143b2015-03-17 22:25:59 +0000538 inc_nlink(d_inode(dentry->d_parent));
539 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
Al Viro5233e312015-01-25 14:39:49 -0500540 return end_creating(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541}
542EXPORT_SYMBOL_GPL(debugfs_create_dir);
543
544/**
Al Viro77b3da62015-01-25 15:10:32 -0500545 * debugfs_create_automount - create automount point in the debugfs filesystem
546 * @name: a pointer to a string containing the name of the file to create.
547 * @parent: a pointer to the parent dentry for this file. This should be a
548 * directory dentry if set. If this parameter is NULL, then the
549 * file will be created in the root of the debugfs filesystem.
550 * @f: function to be called when pathname resolution steps on that one.
551 * @data: opaque argument to pass to f().
552 *
553 * @f should return what ->d_automount() would.
554 */
555struct dentry *debugfs_create_automount(const char *name,
556 struct dentry *parent,
Eric W. Biederman93faccbb2017-02-01 06:06:16 +1300557 debugfs_automount_t f,
Al Viro77b3da62015-01-25 15:10:32 -0500558 void *data)
559{
560 struct dentry *dentry = start_creating(name, parent);
561 struct inode *inode;
562
563 if (IS_ERR(dentry))
564 return NULL;
565
566 inode = debugfs_get_inode(dentry->d_sb);
567 if (unlikely(!inode))
568 return failed_creating(dentry);
569
Seth Forshee87243de2016-03-09 09:18:07 -0600570 make_empty_dir_inode(inode);
Al Viro77b3da62015-01-25 15:10:32 -0500571 inode->i_flags |= S_AUTOMOUNT;
572 inode->i_private = data;
573 dentry->d_fsdata = (void *)f;
Roman Pena8f324a2016-02-09 11:30:29 +0100574 /* directory inodes start off with i_nlink == 2 (for "." entry) */
575 inc_nlink(inode);
Al Viro77b3da62015-01-25 15:10:32 -0500576 d_instantiate(dentry, inode);
Roman Pena8f324a2016-02-09 11:30:29 +0100577 inc_nlink(d_inode(dentry->d_parent));
578 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
Al Viro77b3da62015-01-25 15:10:32 -0500579 return end_creating(dentry);
580}
581EXPORT_SYMBOL(debugfs_create_automount);
582
583/**
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100584 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
585 * @name: a pointer to a string containing the name of the symbolic link to
586 * create.
587 * @parent: a pointer to the parent dentry for this symbolic link. This
Masanari Iidae2278672014-02-18 22:54:36 +0900588 * should be a directory dentry if set. If this parameter is NULL,
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100589 * then the symbolic link will be created in the root of the debugfs
590 * filesystem.
591 * @target: a pointer to a string containing the path to the target of the
592 * symbolic link.
593 *
594 * This function creates a symbolic link with the given name in debugfs that
595 * links to the given target path.
596 *
597 * This function will return a pointer to a dentry if it succeeds. This
598 * pointer must be passed to the debugfs_remove() function when the symbolic
599 * link is to be removed (no automatic cleanup happens if your module is
600 * unloaded, you are responsible here.) If an error occurs, %NULL will be
601 * returned.
602 *
603 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100604 * returned.
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100605 */
606struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
607 const char *target)
608{
Al Viroad5abd52015-01-25 14:02:31 -0500609 struct dentry *dentry;
Al Viro680b3022015-01-25 14:31:32 -0500610 struct inode *inode;
611 char *link = kstrdup(target, GFP_KERNEL);
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100612 if (!link)
613 return NULL;
614
Al Viroad5abd52015-01-25 14:02:31 -0500615 dentry = start_creating(name, parent);
Al Viroad5abd52015-01-25 14:02:31 -0500616 if (IS_ERR(dentry)) {
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100617 kfree(link);
Al Viroad5abd52015-01-25 14:02:31 -0500618 return NULL;
619 }
620
Al Viroedac65e2015-01-25 14:36:18 -0500621 inode = debugfs_get_inode(dentry->d_sb);
Al Viro680b3022015-01-25 14:31:32 -0500622 if (unlikely(!inode)) {
Al Viroad5abd52015-01-25 14:02:31 -0500623 kfree(link);
Al Viro5233e312015-01-25 14:39:49 -0500624 return failed_creating(dentry);
Al Viro680b3022015-01-25 14:31:32 -0500625 }
Al Viroedac65e2015-01-25 14:36:18 -0500626 inode->i_mode = S_IFLNK | S_IRWXUGO;
Al Viro5723cb02015-05-02 10:27:18 -0400627 inode->i_op = &simple_symlink_inode_operations;
628 inode->i_link = link;
Al Viro680b3022015-01-25 14:31:32 -0500629 d_instantiate(dentry, inode);
Al Viro5233e312015-01-25 14:39:49 -0500630 return end_creating(dentry);
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100631}
632EXPORT_SYMBOL_GPL(debugfs_create_symlink);
633
Jan Kara25d41d82011-02-07 15:00:27 +0100634static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635{
Mathieu Desnoyers65c33332006-11-24 13:50:09 -0500636 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Al Virodc3f4192015-05-18 10:10:34 -0400638 if (simple_positive(dentry)) {
Al Viro0db59e52015-02-21 22:05:11 -0500639 dget(dentry);
David Howells7ceab502015-03-05 12:46:49 +0000640 if (d_is_dir(dentry))
David Howells2b0143b2015-03-17 22:25:59 +0000641 ret = simple_rmdir(d_inode(parent), dentry);
Al Viro0db59e52015-02-21 22:05:11 -0500642 else
David Howells2b0143b2015-03-17 22:25:59 +0000643 simple_unlink(d_inode(parent), dentry);
Al Viro0db59e52015-02-21 22:05:11 -0500644 if (!ret)
645 d_delete(dentry);
646 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 }
Jan Kara25d41d82011-02-07 15:00:27 +0100648 return ret;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200649}
650
651/**
652 * debugfs_remove - removes a file or directory from the debugfs filesystem
653 * @dentry: a pointer to a the dentry of the file or directory to be
Ulf Magnusson398dc4a2015-09-07 19:03:15 +0200654 * removed. If this parameter is NULL or an error value, nothing
655 * will be done.
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200656 *
657 * This function removes a file or directory in debugfs that was previously
658 * created with a call to another debugfs function (like
659 * debugfs_create_file() or variants thereof.)
660 *
661 * This function is required to be called in order for the file to be
662 * removed, no automatic cleanup of files will happen when a module is
663 * removed, you are responsible here.
664 */
665void debugfs_remove(struct dentry *dentry)
666{
667 struct dentry *parent;
Jan Kara25d41d82011-02-07 15:00:27 +0100668 int ret;
669
Arend van Spriela59d6292012-05-23 15:13:07 +0200670 if (IS_ERR_OR_NULL(dentry))
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200671 return;
672
673 parent = dentry->d_parent;
Al Viro59551022016-01-22 15:40:57 -0500674 inode_lock(d_inode(parent));
Jan Kara25d41d82011-02-07 15:00:27 +0100675 ret = __debugfs_remove(dentry, parent);
Al Viro59551022016-01-22 15:40:57 -0500676 inode_unlock(d_inode(parent));
Jan Kara25d41d82011-02-07 15:00:27 +0100677 if (!ret)
678 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100679
Nicolai Stange9fd4dce2016-03-22 14:11:13 +0100680 synchronize_srcu(&debugfs_srcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681}
682EXPORT_SYMBOL_GPL(debugfs_remove);
683
Jan Karacfc94cd2007-05-09 13:19:52 +0200684/**
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200685 * debugfs_remove_recursive - recursively removes a directory
Ulf Magnusson398dc4a2015-09-07 19:03:15 +0200686 * @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.
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200688 *
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.)
692 *
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.
696 */
697void debugfs_remove_recursive(struct dentry *dentry)
698{
Steven Rostedt485d4402014-06-09 14:06:07 -0400699 struct dentry *child, *parent;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200700
Arend van Spriela59d6292012-05-23 15:13:07 +0200701 if (IS_ERR_OR_NULL(dentry))
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200702 return;
703
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200704 parent = dentry;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200705 down:
Al Viro59551022016-01-22 15:40:57 -0500706 inode_lock(d_inode(parent));
Steven Rostedt485d4402014-06-09 14:06:07 -0400707 loop:
708 /*
709 * The parent->d_subdirs is protected by the d_lock. Outside that
710 * lock, the child can be unlinked and set to be freed which can
711 * use the d_u.d_child as the rcu head and corrupt this list.
712 */
713 spin_lock(&parent->d_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400714 list_for_each_entry(child, &parent->d_subdirs, d_child) {
Al Virodc3f4192015-05-18 10:10:34 -0400715 if (!simple_positive(child))
Oleg Nesterov776164c2013-07-26 17:12:56 +0200716 continue;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200717
Oleg Nesterov776164c2013-07-26 17:12:56 +0200718 /* perhaps simple_empty(child) makes more sense */
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200719 if (!list_empty(&child->d_subdirs)) {
Steven Rostedt485d4402014-06-09 14:06:07 -0400720 spin_unlock(&parent->d_lock);
Al Viro59551022016-01-22 15:40:57 -0500721 inode_unlock(d_inode(parent));
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200722 parent = child;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200723 goto down;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200724 }
Steven Rostedt485d4402014-06-09 14:06:07 -0400725
726 spin_unlock(&parent->d_lock);
727
Oleg Nesterov776164c2013-07-26 17:12:56 +0200728 if (!__debugfs_remove(child, parent))
729 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Steven Rostedt485d4402014-06-09 14:06:07 -0400730
731 /*
732 * The parent->d_lock protects agaist child from unlinking
733 * from d_subdirs. When releasing the parent->d_lock we can
734 * no longer trust that the next pointer is valid.
735 * Restart the loop. We'll skip this one with the
Al Virodc3f4192015-05-18 10:10:34 -0400736 * simple_positive() check.
Steven Rostedt485d4402014-06-09 14:06:07 -0400737 */
738 goto loop;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200739 }
Steven Rostedt485d4402014-06-09 14:06:07 -0400740 spin_unlock(&parent->d_lock);
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200741
Al Viro59551022016-01-22 15:40:57 -0500742 inode_unlock(d_inode(parent));
Oleg Nesterov776164c2013-07-26 17:12:56 +0200743 child = parent;
744 parent = parent->d_parent;
Al Viro59551022016-01-22 15:40:57 -0500745 inode_lock(d_inode(parent));
Oleg Nesterov776164c2013-07-26 17:12:56 +0200746
Steven Rostedt485d4402014-06-09 14:06:07 -0400747 if (child != dentry)
748 /* go up */
749 goto loop;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200750
751 if (!__debugfs_remove(child, parent))
752 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Al Viro59551022016-01-22 15:40:57 -0500753 inode_unlock(d_inode(parent));
Nicolai Stange49d200d2016-03-22 14:11:14 +0100754
Nicolai Stange9fd4dce2016-03-22 14:11:13 +0100755 synchronize_srcu(&debugfs_srcu);
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200756}
757EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
758
759/**
Jan Karacfc94cd2007-05-09 13:19:52 +0200760 * debugfs_rename - rename a file/directory in the debugfs filesystem
761 * @old_dir: a pointer to the parent dentry for the renamed object. This
762 * should be a directory dentry.
763 * @old_dentry: dentry of an object to be renamed.
764 * @new_dir: a pointer to the parent dentry where the object should be
765 * moved. This should be a directory dentry.
766 * @new_name: a pointer to a string containing the target name.
767 *
768 * This function renames a file/directory in debugfs. The target must not
769 * exist for rename to succeed.
770 *
771 * This function will return a pointer to old_dentry (which is updated to
772 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
773 * returned.
774 *
775 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
776 * returned.
777 */
778struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
779 struct dentry *new_dir, const char *new_name)
780{
781 int error;
782 struct dentry *dentry = NULL, *trap;
Al Viro49d31c22017-07-07 14:51:19 -0400783 struct name_snapshot old_name;
Jan Karacfc94cd2007-05-09 13:19:52 +0200784
785 trap = lock_rename(new_dir, old_dir);
786 /* Source or destination directories don't exist? */
David Howells2b0143b2015-03-17 22:25:59 +0000787 if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
Jan Karacfc94cd2007-05-09 13:19:52 +0200788 goto exit;
789 /* Source does not exist, cyclic rename, or mountpoint? */
David Howells2b0143b2015-03-17 22:25:59 +0000790 if (d_really_is_negative(old_dentry) || old_dentry == trap ||
Jan Karacfc94cd2007-05-09 13:19:52 +0200791 d_mountpoint(old_dentry))
792 goto exit;
793 dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
794 /* Lookup failed, cyclic rename or target exists? */
David Howells2b0143b2015-03-17 22:25:59 +0000795 if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
Jan Karacfc94cd2007-05-09 13:19:52 +0200796 goto exit;
797
Al Viro49d31c22017-07-07 14:51:19 -0400798 take_dentry_name_snapshot(&old_name, old_dentry);
Jan Karacfc94cd2007-05-09 13:19:52 +0200799
David Howells2b0143b2015-03-17 22:25:59 +0000800 error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
Miklos Szeredie0e0be82016-09-27 11:03:57 +0200801 dentry, 0);
Jan Karacfc94cd2007-05-09 13:19:52 +0200802 if (error) {
Al Viro49d31c22017-07-07 14:51:19 -0400803 release_dentry_name_snapshot(&old_name);
Jan Karacfc94cd2007-05-09 13:19:52 +0200804 goto exit;
805 }
806 d_move(old_dentry, dentry);
Al Viro49d31c22017-07-07 14:51:19 -0400807 fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name.name,
David Howellse36cb0b2015-01-29 12:02:35 +0000808 d_is_dir(old_dentry),
Al Viro5a190ae2007-06-07 12:19:32 -0400809 NULL, old_dentry);
Al Viro49d31c22017-07-07 14:51:19 -0400810 release_dentry_name_snapshot(&old_name);
Jan Karacfc94cd2007-05-09 13:19:52 +0200811 unlock_rename(new_dir, old_dir);
812 dput(dentry);
813 return old_dentry;
814exit:
815 if (dentry && !IS_ERR(dentry))
816 dput(dentry);
817 unlock_rename(new_dir, old_dir);
818 return NULL;
819}
820EXPORT_SYMBOL_GPL(debugfs_rename);
821
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +0100822/**
823 * debugfs_initialized - Tells whether debugfs has been registered
824 */
825bool debugfs_initialized(void)
826{
827 return debugfs_registered;
828}
829EXPORT_SYMBOL_GPL(debugfs_initialized);
830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831static int __init debugfs_init(void)
832{
833 int retval;
834
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500835 retval = sysfs_create_mount_point(kernel_kobj, "debug");
836 if (retval)
837 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
839 retval = register_filesystem(&debug_fs_type);
840 if (retval)
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500841 sysfs_remove_mount_point(kernel_kobj, "debug");
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +0100842 else
843 debugfs_registered = true;
844
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 return retval;
846}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847core_initcall(debugfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848