blob: c59f015f386eba1e58b4cba397e1b4910e62ace9 [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
Al Viro77b3da62015-01-25 15:10:32 -0500188static struct vfsmount *debugfs_automount(struct path *path)
189{
Eric W. Biederman93faccbb2017-02-01 06:06:16 +1300190 debugfs_automount_t f;
191 f = (debugfs_automount_t)path->dentry->d_fsdata;
192 return f(path->dentry, d_inode(path->dentry)->i_private);
Al Viro77b3da62015-01-25 15:10:32 -0500193}
194
195static const struct dentry_operations debugfs_dops = {
196 .d_delete = always_delete_dentry,
197 .d_automount = debugfs_automount,
198};
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200static int debug_fill_super(struct super_block *sb, void *data, int silent)
201{
Eric Biggerscda37122017-03-25 21:15:37 -0700202 static const struct tree_descr debug_files[] = {{""}};
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100203 struct debugfs_fs_info *fsi;
204 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100206 fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
207 sb->s_fs_info = fsi;
208 if (!fsi) {
209 err = -ENOMEM;
210 goto fail;
211 }
212
213 err = debugfs_parse_options(data, &fsi->mount_opts);
214 if (err)
215 goto fail;
216
217 err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
218 if (err)
219 goto fail;
220
221 sb->s_op = &debugfs_super_operations;
Al Viro77b3da62015-01-25 15:10:32 -0500222 sb->s_d_op = &debugfs_dops;
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100223
224 debugfs_apply_options(sb);
225
226 return 0;
227
228fail:
229 kfree(fsi);
230 sb->s_fs_info = NULL;
231 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232}
233
Al Virofc14f2f2010-07-25 01:48:30 +0400234static struct dentry *debug_mount(struct file_system_type *fs_type,
David Howells454e2392006-06-23 02:02:57 -0700235 int flags, const char *dev_name,
Al Virofc14f2f2010-07-25 01:48:30 +0400236 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
Al Virofc14f2f2010-07-25 01:48:30 +0400238 return mount_single(fs_type, flags, data, debug_fill_super);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239}
240
241static struct file_system_type debug_fs_type = {
242 .owner = THIS_MODULE,
243 .name = "debugfs",
Al Virofc14f2f2010-07-25 01:48:30 +0400244 .mount = debug_mount,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 .kill_sb = kill_litter_super,
246};
Eric W. Biederman7f78e032013-03-02 19:39:14 -0800247MODULE_ALIAS_FS("debugfs");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
Omar Sandovala7c54372017-01-31 14:53:17 -0800249/**
250 * debugfs_lookup() - look up an existing debugfs file
251 * @name: a pointer to a string containing the name of the file to look up.
252 * @parent: a pointer to the parent dentry of the file.
253 *
254 * This function will return a pointer to a dentry if it succeeds. If the file
255 * doesn't exist or an error occurs, %NULL will be returned. The returned
256 * dentry must be passed to dput() when it is no longer needed.
257 *
258 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
259 * returned.
260 */
261struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
262{
263 struct dentry *dentry;
264
265 if (IS_ERR(parent))
266 return NULL;
267
268 if (!parent)
269 parent = debugfs_mount->mnt_root;
270
271 inode_lock(d_inode(parent));
272 dentry = lookup_one_len(name, parent, strlen(name));
273 inode_unlock(d_inode(parent));
274
275 if (IS_ERR(dentry))
276 return NULL;
277 if (!d_really_is_positive(dentry)) {
278 dput(dentry);
279 return NULL;
280 }
281 return dentry;
282}
283EXPORT_SYMBOL_GPL(debugfs_lookup);
284
Al Viro190afd82015-01-25 13:55:55 -0500285static struct dentry *start_creating(const char *name, struct dentry *parent)
Al Viroc3b1a352012-06-09 20:28:22 -0400286{
Al Viro190afd82015-01-25 13:55:55 -0500287 struct dentry *dentry;
Al Viroc3b1a352012-06-09 20:28:22 -0400288 int error;
289
290 pr_debug("debugfs: creating file '%s'\n",name);
291
Greg KHc9e15f22015-03-30 14:59:15 +0200292 if (IS_ERR(parent))
293 return parent;
294
Al Viroc3b1a352012-06-09 20:28:22 -0400295 error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
296 &debugfs_mount_count);
297 if (error)
Al Viro190afd82015-01-25 13:55:55 -0500298 return ERR_PTR(error);
Al Viroc3b1a352012-06-09 20:28:22 -0400299
Al Virocfa57c12012-06-09 20:33:28 -0400300 /* If the parent is not specified, we create it in the root.
Rahul Bedarkar88e412e2014-06-06 23:12:04 +0530301 * We need the root dentry to do this, which is in the super
Al Virocfa57c12012-06-09 20:33:28 -0400302 * block. A pointer to that is in the struct vfsmount that we
303 * have around.
304 */
305 if (!parent)
306 parent = debugfs_mount->mnt_root;
307
Al Viro59551022016-01-22 15:40:57 -0500308 inode_lock(d_inode(parent));
Al Virocfa57c12012-06-09 20:33:28 -0400309 dentry = lookup_one_len(name, parent, strlen(name));
David Howells2b0143b2015-03-17 22:25:59 +0000310 if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
Al Virocfa57c12012-06-09 20:33:28 -0400311 dput(dentry);
Al Viro190afd82015-01-25 13:55:55 -0500312 dentry = ERR_PTR(-EEXIST);
313 }
Daniel Borkmann0ee96082015-11-05 00:01:51 +0100314
315 if (IS_ERR(dentry)) {
Al Viro59551022016-01-22 15:40:57 -0500316 inode_unlock(d_inode(parent));
Daniel Borkmann0ee96082015-11-05 00:01:51 +0100317 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
318 }
319
Al Viro190afd82015-01-25 13:55:55 -0500320 return dentry;
321}
322
Al Viro5233e312015-01-25 14:39:49 -0500323static struct dentry *failed_creating(struct dentry *dentry)
Al Viro190afd82015-01-25 13:55:55 -0500324{
Al Viro59551022016-01-22 15:40:57 -0500325 inode_unlock(d_inode(dentry->d_parent));
Al Viro190afd82015-01-25 13:55:55 -0500326 dput(dentry);
Al Viro5233e312015-01-25 14:39:49 -0500327 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
328 return NULL;
329}
Al Virocfa57c12012-06-09 20:33:28 -0400330
Al Viro5233e312015-01-25 14:39:49 -0500331static struct dentry *end_creating(struct dentry *dentry)
332{
Al Viro59551022016-01-22 15:40:57 -0500333 inode_unlock(d_inode(dentry->d_parent));
Al Viroc3b1a352012-06-09 20:28:22 -0400334 return dentry;
335}
336
Nicolai Stange49d200d2016-03-22 14:11:14 +0100337static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
338 struct dentry *parent, void *data,
339 const struct file_operations *proxy_fops,
340 const struct file_operations *real_fops)
341{
342 struct dentry *dentry;
343 struct inode *inode;
344
345 if (!(mode & S_IFMT))
346 mode |= S_IFREG;
347 BUG_ON(!S_ISREG(mode));
348 dentry = start_creating(name, parent);
349
350 if (IS_ERR(dentry))
351 return NULL;
352
353 inode = debugfs_get_inode(dentry->d_sb);
354 if (unlikely(!inode))
355 return failed_creating(dentry);
356
357 inode->i_mode = mode;
358 inode->i_private = data;
359
360 inode->i_fop = proxy_fops;
361 dentry->d_fsdata = (void *)real_fops;
362
363 d_instantiate(dentry, inode);
364 fsnotify_create(d_inode(dentry->d_parent), dentry);
365 return end_creating(dentry);
366}
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/**
369 * debugfs_create_file - create a file in the debugfs filesystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 * @name: a pointer to a string containing the name of the file to create.
Alberto Bertoglibe030e62009-10-31 18:26:52 -0300371 * @mode: the permission that the file should have.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 * @parent: a pointer to the parent dentry for this file. This should be a
Masanari Iidae2278672014-02-18 22:54:36 +0900373 * directory dentry if set. If this parameter is NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * file will be created in the root of the debugfs filesystem.
375 * @data: a pointer to something that the caller will want to get to later
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700376 * on. The inode.i_private pointer will point to this value on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 * the open() call.
378 * @fops: a pointer to a struct file_operations that should be used for
379 * this file.
380 *
381 * This is the basic "create a file" function for debugfs. It allows for a
Alberto Bertoglibe030e62009-10-31 18:26:52 -0300382 * wide range of flexibility in creating a file, or a directory (if you want
383 * to create a directory, the debugfs_create_dir() function is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 * recommended to be used instead.)
385 *
386 * This function will return a pointer to a dentry if it succeeds. This
387 * pointer must be passed to the debugfs_remove() function when the file is
388 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700389 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700391 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100392 * returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 */
Al Virof4ae40a62011-07-24 04:33:43 -0400394struct dentry *debugfs_create_file(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 struct dentry *parent, void *data,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800396 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
Al Viroc3b1a352012-06-09 20:28:22 -0400398
Nicolai Stange49d200d2016-03-22 14:11:14 +0100399 return __debugfs_create_file(name, mode, parent, data,
400 fops ? &debugfs_full_proxy_file_operations :
401 &debugfs_noop_file_operations,
402 fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403}
404EXPORT_SYMBOL_GPL(debugfs_create_file);
405
Nicolai Stangec6468802016-03-22 14:11:15 +0100406/**
407 * debugfs_create_file_unsafe - create a file in the debugfs filesystem
408 * @name: a pointer to a string containing the name of the file to create.
409 * @mode: the permission that the file should have.
410 * @parent: a pointer to the parent dentry for this file. This should be a
411 * directory dentry if set. If this parameter is NULL, then the
412 * file will be created in the root of the debugfs filesystem.
413 * @data: a pointer to something that the caller will want to get to later
414 * on. The inode.i_private pointer will point to this value on
415 * the open() call.
416 * @fops: a pointer to a struct file_operations that should be used for
417 * this file.
418 *
419 * debugfs_create_file_unsafe() is completely analogous to
420 * debugfs_create_file(), the only difference being that the fops
421 * handed it will not get protected against file removals by the
422 * debugfs core.
423 *
424 * It is your responsibility to protect your struct file_operation
425 * methods against file removals by means of debugfs_use_file_start()
426 * and debugfs_use_file_finish(). ->open() is still protected by
427 * debugfs though.
428 *
429 * Any struct file_operations defined by means of
430 * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
431 * thus, may be used here.
432 */
Nicolai Stange49d200d2016-03-22 14:11:14 +0100433struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
434 struct dentry *parent, void *data,
435 const struct file_operations *fops)
436{
437
438 return __debugfs_create_file(name, mode, parent, data,
439 fops ? &debugfs_open_proxy_file_operations :
440 &debugfs_noop_file_operations,
441 fops);
442}
Nicolai Stangec6468802016-03-22 14:11:15 +0100443EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100444
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445/**
David Howellse59b4e92015-01-21 20:03:40 +0000446 * debugfs_create_file_size - create a file in the debugfs filesystem
447 * @name: a pointer to a string containing the name of the file to create.
448 * @mode: the permission that the file should have.
449 * @parent: a pointer to the parent dentry for this file. This should be a
450 * directory dentry if set. If this parameter is NULL, then the
451 * file will be created in the root of the debugfs filesystem.
452 * @data: a pointer to something that the caller will want to get to later
453 * on. The inode.i_private pointer will point to this value on
454 * the open() call.
455 * @fops: a pointer to a struct file_operations that should be used for
456 * this file.
457 * @file_size: initial file size
458 *
459 * This is the basic "create a file" function for debugfs. It allows for a
460 * wide range of flexibility in creating a file, or a directory (if you want
461 * to create a directory, the debugfs_create_dir() function is
462 * recommended to be used instead.)
463 *
464 * This function will return a pointer to a dentry if it succeeds. This
465 * pointer must be passed to the debugfs_remove() function when the file is
466 * to be removed (no automatic cleanup happens if your module is unloaded,
467 * you are responsible here.) If an error occurs, %NULL will be returned.
468 *
469 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
470 * returned.
471 */
472struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
473 struct dentry *parent, void *data,
474 const struct file_operations *fops,
475 loff_t file_size)
476{
477 struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
478
479 if (de)
David Howells2b0143b2015-03-17 22:25:59 +0000480 d_inode(de)->i_size = file_size;
David Howellse59b4e92015-01-21 20:03:40 +0000481 return de;
482}
483EXPORT_SYMBOL_GPL(debugfs_create_file_size);
484
485/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486 * debugfs_create_dir - create a directory in the debugfs filesystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 * @name: a pointer to a string containing the name of the directory to
488 * create.
489 * @parent: a pointer to the parent dentry for this file. This should be a
Masanari Iidae2278672014-02-18 22:54:36 +0900490 * directory dentry if set. If this parameter is NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 * directory will be created in the root of the debugfs filesystem.
492 *
493 * This function creates a directory in debugfs with the given name.
494 *
495 * This function will return a pointer to a dentry if it succeeds. This
496 * pointer must be passed to the debugfs_remove() function when the file is
497 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700498 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700500 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100501 * returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 */
503struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
504{
Al Viroad5abd52015-01-25 14:02:31 -0500505 struct dentry *dentry = start_creating(name, parent);
Al Viro680b3022015-01-25 14:31:32 -0500506 struct inode *inode;
Al Viroad5abd52015-01-25 14:02:31 -0500507
508 if (IS_ERR(dentry))
509 return NULL;
510
Al Viroedac65e2015-01-25 14:36:18 -0500511 inode = debugfs_get_inode(dentry->d_sb);
Al Viro680b3022015-01-25 14:31:32 -0500512 if (unlikely(!inode))
Al Viro5233e312015-01-25 14:39:49 -0500513 return failed_creating(dentry);
Al Viro680b3022015-01-25 14:31:32 -0500514
Al Viroedac65e2015-01-25 14:36:18 -0500515 inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
516 inode->i_op = &simple_dir_inode_operations;
517 inode->i_fop = &simple_dir_operations;
518
519 /* directory inodes start off with i_nlink == 2 (for "." entry) */
520 inc_nlink(inode);
Al Viro680b3022015-01-25 14:31:32 -0500521 d_instantiate(dentry, inode);
David Howells2b0143b2015-03-17 22:25:59 +0000522 inc_nlink(d_inode(dentry->d_parent));
523 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
Al Viro5233e312015-01-25 14:39:49 -0500524 return end_creating(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525}
526EXPORT_SYMBOL_GPL(debugfs_create_dir);
527
528/**
Al Viro77b3da62015-01-25 15:10:32 -0500529 * debugfs_create_automount - create automount point in the debugfs filesystem
530 * @name: a pointer to a string containing the name of the file to create.
531 * @parent: a pointer to the parent dentry for this file. This should be a
532 * directory dentry if set. If this parameter is NULL, then the
533 * file will be created in the root of the debugfs filesystem.
534 * @f: function to be called when pathname resolution steps on that one.
535 * @data: opaque argument to pass to f().
536 *
537 * @f should return what ->d_automount() would.
538 */
539struct dentry *debugfs_create_automount(const char *name,
540 struct dentry *parent,
Eric W. Biederman93faccbb2017-02-01 06:06:16 +1300541 debugfs_automount_t f,
Al Viro77b3da62015-01-25 15:10:32 -0500542 void *data)
543{
544 struct dentry *dentry = start_creating(name, parent);
545 struct inode *inode;
546
547 if (IS_ERR(dentry))
548 return NULL;
549
550 inode = debugfs_get_inode(dentry->d_sb);
551 if (unlikely(!inode))
552 return failed_creating(dentry);
553
Seth Forshee87243de2016-03-09 09:18:07 -0600554 make_empty_dir_inode(inode);
Al Viro77b3da62015-01-25 15:10:32 -0500555 inode->i_flags |= S_AUTOMOUNT;
556 inode->i_private = data;
557 dentry->d_fsdata = (void *)f;
Roman Pena8f324a2016-02-09 11:30:29 +0100558 /* directory inodes start off with i_nlink == 2 (for "." entry) */
559 inc_nlink(inode);
Al Viro77b3da62015-01-25 15:10:32 -0500560 d_instantiate(dentry, inode);
Roman Pena8f324a2016-02-09 11:30:29 +0100561 inc_nlink(d_inode(dentry->d_parent));
562 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
Al Viro77b3da62015-01-25 15:10:32 -0500563 return end_creating(dentry);
564}
565EXPORT_SYMBOL(debugfs_create_automount);
566
567/**
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100568 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
569 * @name: a pointer to a string containing the name of the symbolic link to
570 * create.
571 * @parent: a pointer to the parent dentry for this symbolic link. This
Masanari Iidae2278672014-02-18 22:54:36 +0900572 * should be a directory dentry if set. If this parameter is NULL,
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100573 * then the symbolic link will be created in the root of the debugfs
574 * filesystem.
575 * @target: a pointer to a string containing the path to the target of the
576 * symbolic link.
577 *
578 * This function creates a symbolic link with the given name in debugfs that
579 * links to the given target path.
580 *
581 * This function will return a pointer to a dentry if it succeeds. This
582 * pointer must be passed to the debugfs_remove() function when the symbolic
583 * link is to be removed (no automatic cleanup happens if your module is
584 * unloaded, you are responsible here.) If an error occurs, %NULL will be
585 * returned.
586 *
587 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100588 * returned.
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100589 */
590struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
591 const char *target)
592{
Al Viroad5abd52015-01-25 14:02:31 -0500593 struct dentry *dentry;
Al Viro680b3022015-01-25 14:31:32 -0500594 struct inode *inode;
595 char *link = kstrdup(target, GFP_KERNEL);
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100596 if (!link)
597 return NULL;
598
Al Viroad5abd52015-01-25 14:02:31 -0500599 dentry = start_creating(name, parent);
Al Viroad5abd52015-01-25 14:02:31 -0500600 if (IS_ERR(dentry)) {
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100601 kfree(link);
Al Viroad5abd52015-01-25 14:02:31 -0500602 return NULL;
603 }
604
Al Viroedac65e2015-01-25 14:36:18 -0500605 inode = debugfs_get_inode(dentry->d_sb);
Al Viro680b3022015-01-25 14:31:32 -0500606 if (unlikely(!inode)) {
Al Viroad5abd52015-01-25 14:02:31 -0500607 kfree(link);
Al Viro5233e312015-01-25 14:39:49 -0500608 return failed_creating(dentry);
Al Viro680b3022015-01-25 14:31:32 -0500609 }
Al Viroedac65e2015-01-25 14:36:18 -0500610 inode->i_mode = S_IFLNK | S_IRWXUGO;
Al Viro5723cb02015-05-02 10:27:18 -0400611 inode->i_op = &simple_symlink_inode_operations;
612 inode->i_link = link;
Al Viro680b3022015-01-25 14:31:32 -0500613 d_instantiate(dentry, inode);
Al Viro5233e312015-01-25 14:39:49 -0500614 return end_creating(dentry);
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100615}
616EXPORT_SYMBOL_GPL(debugfs_create_symlink);
617
Jan Kara25d41d82011-02-07 15:00:27 +0100618static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619{
Mathieu Desnoyers65c33332006-11-24 13:50:09 -0500620 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Al Virodc3f4192015-05-18 10:10:34 -0400622 if (simple_positive(dentry)) {
Al Viro0db59e52015-02-21 22:05:11 -0500623 dget(dentry);
David Howells7ceab502015-03-05 12:46:49 +0000624 if (d_is_dir(dentry))
David Howells2b0143b2015-03-17 22:25:59 +0000625 ret = simple_rmdir(d_inode(parent), dentry);
Al Viro0db59e52015-02-21 22:05:11 -0500626 else
David Howells2b0143b2015-03-17 22:25:59 +0000627 simple_unlink(d_inode(parent), dentry);
Al Viro0db59e52015-02-21 22:05:11 -0500628 if (!ret)
629 d_delete(dentry);
630 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631 }
Jan Kara25d41d82011-02-07 15:00:27 +0100632 return ret;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200633}
634
635/**
636 * debugfs_remove - removes a file or directory from the debugfs filesystem
637 * @dentry: a pointer to a the dentry of the file or directory to be
Ulf Magnusson398dc4a2015-09-07 19:03:15 +0200638 * removed. If this parameter is NULL or an error value, nothing
639 * will be done.
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200640 *
641 * This function removes a file or directory in debugfs that was previously
642 * created with a call to another debugfs function (like
643 * debugfs_create_file() or variants thereof.)
644 *
645 * This function is required to be called in order for the file to be
646 * removed, no automatic cleanup of files will happen when a module is
647 * removed, you are responsible here.
648 */
649void debugfs_remove(struct dentry *dentry)
650{
651 struct dentry *parent;
Jan Kara25d41d82011-02-07 15:00:27 +0100652 int ret;
653
Arend van Spriela59d6292012-05-23 15:13:07 +0200654 if (IS_ERR_OR_NULL(dentry))
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200655 return;
656
657 parent = dentry->d_parent;
Al Viro59551022016-01-22 15:40:57 -0500658 inode_lock(d_inode(parent));
Jan Kara25d41d82011-02-07 15:00:27 +0100659 ret = __debugfs_remove(dentry, parent);
Al Viro59551022016-01-22 15:40:57 -0500660 inode_unlock(d_inode(parent));
Jan Kara25d41d82011-02-07 15:00:27 +0100661 if (!ret)
662 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100663
Nicolai Stange9fd4dce2016-03-22 14:11:13 +0100664 synchronize_srcu(&debugfs_srcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665}
666EXPORT_SYMBOL_GPL(debugfs_remove);
667
Jan Karacfc94cd2007-05-09 13:19:52 +0200668/**
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200669 * debugfs_remove_recursive - recursively removes a directory
Ulf Magnusson398dc4a2015-09-07 19:03:15 +0200670 * @dentry: a pointer to a the dentry of the directory to be removed. If this
671 * parameter is NULL or an error value, nothing will be done.
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200672 *
673 * This function recursively removes a directory tree in debugfs that
674 * was previously created with a call to another debugfs function
675 * (like debugfs_create_file() or variants thereof.)
676 *
677 * This function is required to be called in order for the file to be
678 * removed, no automatic cleanup of files will happen when a module is
679 * removed, you are responsible here.
680 */
681void debugfs_remove_recursive(struct dentry *dentry)
682{
Steven Rostedt485d4402014-06-09 14:06:07 -0400683 struct dentry *child, *parent;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200684
Arend van Spriela59d6292012-05-23 15:13:07 +0200685 if (IS_ERR_OR_NULL(dentry))
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200686 return;
687
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200688 parent = dentry;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200689 down:
Al Viro59551022016-01-22 15:40:57 -0500690 inode_lock(d_inode(parent));
Steven Rostedt485d4402014-06-09 14:06:07 -0400691 loop:
692 /*
693 * The parent->d_subdirs is protected by the d_lock. Outside that
694 * lock, the child can be unlinked and set to be freed which can
695 * use the d_u.d_child as the rcu head and corrupt this list.
696 */
697 spin_lock(&parent->d_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400698 list_for_each_entry(child, &parent->d_subdirs, d_child) {
Al Virodc3f4192015-05-18 10:10:34 -0400699 if (!simple_positive(child))
Oleg Nesterov776164c2013-07-26 17:12:56 +0200700 continue;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200701
Oleg Nesterov776164c2013-07-26 17:12:56 +0200702 /* perhaps simple_empty(child) makes more sense */
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200703 if (!list_empty(&child->d_subdirs)) {
Steven Rostedt485d4402014-06-09 14:06:07 -0400704 spin_unlock(&parent->d_lock);
Al Viro59551022016-01-22 15:40:57 -0500705 inode_unlock(d_inode(parent));
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200706 parent = child;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200707 goto down;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200708 }
Steven Rostedt485d4402014-06-09 14:06:07 -0400709
710 spin_unlock(&parent->d_lock);
711
Oleg Nesterov776164c2013-07-26 17:12:56 +0200712 if (!__debugfs_remove(child, parent))
713 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Steven Rostedt485d4402014-06-09 14:06:07 -0400714
715 /*
716 * The parent->d_lock protects agaist child from unlinking
717 * from d_subdirs. When releasing the parent->d_lock we can
718 * no longer trust that the next pointer is valid.
719 * Restart the loop. We'll skip this one with the
Al Virodc3f4192015-05-18 10:10:34 -0400720 * simple_positive() check.
Steven Rostedt485d4402014-06-09 14:06:07 -0400721 */
722 goto loop;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200723 }
Steven Rostedt485d4402014-06-09 14:06:07 -0400724 spin_unlock(&parent->d_lock);
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200725
Al Viro59551022016-01-22 15:40:57 -0500726 inode_unlock(d_inode(parent));
Oleg Nesterov776164c2013-07-26 17:12:56 +0200727 child = parent;
728 parent = parent->d_parent;
Al Viro59551022016-01-22 15:40:57 -0500729 inode_lock(d_inode(parent));
Oleg Nesterov776164c2013-07-26 17:12:56 +0200730
Steven Rostedt485d4402014-06-09 14:06:07 -0400731 if (child != dentry)
732 /* go up */
733 goto loop;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200734
735 if (!__debugfs_remove(child, parent))
736 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Al Viro59551022016-01-22 15:40:57 -0500737 inode_unlock(d_inode(parent));
Nicolai Stange49d200d2016-03-22 14:11:14 +0100738
Nicolai Stange9fd4dce2016-03-22 14:11:13 +0100739 synchronize_srcu(&debugfs_srcu);
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200740}
741EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
742
743/**
Jan Karacfc94cd2007-05-09 13:19:52 +0200744 * debugfs_rename - rename a file/directory in the debugfs filesystem
745 * @old_dir: a pointer to the parent dentry for the renamed object. This
746 * should be a directory dentry.
747 * @old_dentry: dentry of an object to be renamed.
748 * @new_dir: a pointer to the parent dentry where the object should be
749 * moved. This should be a directory dentry.
750 * @new_name: a pointer to a string containing the target name.
751 *
752 * This function renames a file/directory in debugfs. The target must not
753 * exist for rename to succeed.
754 *
755 * This function will return a pointer to old_dentry (which is updated to
756 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
757 * returned.
758 *
759 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
760 * returned.
761 */
762struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
763 struct dentry *new_dir, const char *new_name)
764{
765 int error;
766 struct dentry *dentry = NULL, *trap;
Al Viro49d31c22017-07-07 14:51:19 -0400767 struct name_snapshot old_name;
Jan Karacfc94cd2007-05-09 13:19:52 +0200768
769 trap = lock_rename(new_dir, old_dir);
770 /* Source or destination directories don't exist? */
David Howells2b0143b2015-03-17 22:25:59 +0000771 if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
Jan Karacfc94cd2007-05-09 13:19:52 +0200772 goto exit;
773 /* Source does not exist, cyclic rename, or mountpoint? */
David Howells2b0143b2015-03-17 22:25:59 +0000774 if (d_really_is_negative(old_dentry) || old_dentry == trap ||
Jan Karacfc94cd2007-05-09 13:19:52 +0200775 d_mountpoint(old_dentry))
776 goto exit;
777 dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
778 /* Lookup failed, cyclic rename or target exists? */
David Howells2b0143b2015-03-17 22:25:59 +0000779 if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
Jan Karacfc94cd2007-05-09 13:19:52 +0200780 goto exit;
781
Al Viro49d31c22017-07-07 14:51:19 -0400782 take_dentry_name_snapshot(&old_name, old_dentry);
Jan Karacfc94cd2007-05-09 13:19:52 +0200783
David Howells2b0143b2015-03-17 22:25:59 +0000784 error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
Miklos Szeredie0e0be82016-09-27 11:03:57 +0200785 dentry, 0);
Jan Karacfc94cd2007-05-09 13:19:52 +0200786 if (error) {
Al Viro49d31c22017-07-07 14:51:19 -0400787 release_dentry_name_snapshot(&old_name);
Jan Karacfc94cd2007-05-09 13:19:52 +0200788 goto exit;
789 }
790 d_move(old_dentry, dentry);
Al Viro49d31c22017-07-07 14:51:19 -0400791 fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name.name,
David Howellse36cb0b2015-01-29 12:02:35 +0000792 d_is_dir(old_dentry),
Al Viro5a190ae2007-06-07 12:19:32 -0400793 NULL, old_dentry);
Al Viro49d31c22017-07-07 14:51:19 -0400794 release_dentry_name_snapshot(&old_name);
Jan Karacfc94cd2007-05-09 13:19:52 +0200795 unlock_rename(new_dir, old_dir);
796 dput(dentry);
797 return old_dentry;
798exit:
799 if (dentry && !IS_ERR(dentry))
800 dput(dentry);
801 unlock_rename(new_dir, old_dir);
802 return NULL;
803}
804EXPORT_SYMBOL_GPL(debugfs_rename);
805
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +0100806/**
807 * debugfs_initialized - Tells whether debugfs has been registered
808 */
809bool debugfs_initialized(void)
810{
811 return debugfs_registered;
812}
813EXPORT_SYMBOL_GPL(debugfs_initialized);
814
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815static int __init debugfs_init(void)
816{
817 int retval;
818
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500819 retval = sysfs_create_mount_point(kernel_kobj, "debug");
820 if (retval)
821 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823 retval = register_filesystem(&debug_fs_type);
824 if (retval)
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500825 sysfs_remove_mount_point(kernel_kobj, "debug");
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +0100826 else
827 debugfs_registered = true;
828
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 return retval;
830}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831core_initcall(debugfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832