blob: e892ae7d89f8bc078848d8752affa1598a7e1e11 [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.
12 * See Documentation/DocBook/kernel-api for more details.
13 *
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 save_mount_options(sb, data);
207
208 fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
209 sb->s_fs_info = fsi;
210 if (!fsi) {
211 err = -ENOMEM;
212 goto fail;
213 }
214
215 err = debugfs_parse_options(data, &fsi->mount_opts);
216 if (err)
217 goto fail;
218
219 err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
220 if (err)
221 goto fail;
222
223 sb->s_op = &debugfs_super_operations;
Al Viro77b3da62015-01-25 15:10:32 -0500224 sb->s_d_op = &debugfs_dops;
Ludwig Nusseld6e48682012-01-25 11:52:28 +0100225
226 debugfs_apply_options(sb);
227
228 return 0;
229
230fail:
231 kfree(fsi);
232 sb->s_fs_info = NULL;
233 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234}
235
Al Virofc14f2f2010-07-25 01:48:30 +0400236static struct dentry *debug_mount(struct file_system_type *fs_type,
David Howells454e2392006-06-23 02:02:57 -0700237 int flags, const char *dev_name,
Al Virofc14f2f2010-07-25 01:48:30 +0400238 void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
Al Virofc14f2f2010-07-25 01:48:30 +0400240 return mount_single(fs_type, flags, data, debug_fill_super);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241}
242
243static struct file_system_type debug_fs_type = {
244 .owner = THIS_MODULE,
245 .name = "debugfs",
Al Virofc14f2f2010-07-25 01:48:30 +0400246 .mount = debug_mount,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 .kill_sb = kill_litter_super,
248};
Eric W. Biederman7f78e032013-03-02 19:39:14 -0800249MODULE_ALIAS_FS("debugfs");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Omar Sandovala7c54372017-01-31 14:53:17 -0800251/**
252 * debugfs_lookup() - look up an existing debugfs file
253 * @name: a pointer to a string containing the name of the file to look up.
254 * @parent: a pointer to the parent dentry of the file.
255 *
256 * This function will return a pointer to a dentry if it succeeds. If the file
257 * doesn't exist or an error occurs, %NULL will be returned. The returned
258 * dentry must be passed to dput() when it is no longer needed.
259 *
260 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
261 * returned.
262 */
263struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
264{
265 struct dentry *dentry;
266
267 if (IS_ERR(parent))
268 return NULL;
269
270 if (!parent)
271 parent = debugfs_mount->mnt_root;
272
273 inode_lock(d_inode(parent));
274 dentry = lookup_one_len(name, parent, strlen(name));
275 inode_unlock(d_inode(parent));
276
277 if (IS_ERR(dentry))
278 return NULL;
279 if (!d_really_is_positive(dentry)) {
280 dput(dentry);
281 return NULL;
282 }
283 return dentry;
284}
285EXPORT_SYMBOL_GPL(debugfs_lookup);
286
Al Viro190afd82015-01-25 13:55:55 -0500287static struct dentry *start_creating(const char *name, struct dentry *parent)
Al Viroc3b1a352012-06-09 20:28:22 -0400288{
Al Viro190afd82015-01-25 13:55:55 -0500289 struct dentry *dentry;
Al Viroc3b1a352012-06-09 20:28:22 -0400290 int error;
291
292 pr_debug("debugfs: creating file '%s'\n",name);
293
Greg KHc9e15f22015-03-30 14:59:15 +0200294 if (IS_ERR(parent))
295 return parent;
296
Al Viroc3b1a352012-06-09 20:28:22 -0400297 error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
298 &debugfs_mount_count);
299 if (error)
Al Viro190afd82015-01-25 13:55:55 -0500300 return ERR_PTR(error);
Al Viroc3b1a352012-06-09 20:28:22 -0400301
Al Virocfa57c12012-06-09 20:33:28 -0400302 /* If the parent is not specified, we create it in the root.
Rahul Bedarkar88e412e2014-06-06 23:12:04 +0530303 * We need the root dentry to do this, which is in the super
Al Virocfa57c12012-06-09 20:33:28 -0400304 * block. A pointer to that is in the struct vfsmount that we
305 * have around.
306 */
307 if (!parent)
308 parent = debugfs_mount->mnt_root;
309
Al Viro59551022016-01-22 15:40:57 -0500310 inode_lock(d_inode(parent));
Al Virocfa57c12012-06-09 20:33:28 -0400311 dentry = lookup_one_len(name, parent, strlen(name));
David Howells2b0143b2015-03-17 22:25:59 +0000312 if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
Al Virocfa57c12012-06-09 20:33:28 -0400313 dput(dentry);
Al Viro190afd82015-01-25 13:55:55 -0500314 dentry = ERR_PTR(-EEXIST);
315 }
Daniel Borkmann0ee96082015-11-05 00:01:51 +0100316
317 if (IS_ERR(dentry)) {
Al Viro59551022016-01-22 15:40:57 -0500318 inode_unlock(d_inode(parent));
Daniel Borkmann0ee96082015-11-05 00:01:51 +0100319 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
320 }
321
Al Viro190afd82015-01-25 13:55:55 -0500322 return dentry;
323}
324
Al Viro5233e312015-01-25 14:39:49 -0500325static struct dentry *failed_creating(struct dentry *dentry)
Al Viro190afd82015-01-25 13:55:55 -0500326{
Al Viro59551022016-01-22 15:40:57 -0500327 inode_unlock(d_inode(dentry->d_parent));
Al Viro190afd82015-01-25 13:55:55 -0500328 dput(dentry);
Al Viro5233e312015-01-25 14:39:49 -0500329 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
330 return NULL;
331}
Al Virocfa57c12012-06-09 20:33:28 -0400332
Al Viro5233e312015-01-25 14:39:49 -0500333static struct dentry *end_creating(struct dentry *dentry)
334{
Al Viro59551022016-01-22 15:40:57 -0500335 inode_unlock(d_inode(dentry->d_parent));
Al Viroc3b1a352012-06-09 20:28:22 -0400336 return dentry;
337}
338
Nicolai Stange49d200d2016-03-22 14:11:14 +0100339static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
340 struct dentry *parent, void *data,
341 const struct file_operations *proxy_fops,
342 const struct file_operations *real_fops)
343{
344 struct dentry *dentry;
345 struct inode *inode;
346
347 if (!(mode & S_IFMT))
348 mode |= S_IFREG;
349 BUG_ON(!S_ISREG(mode));
350 dentry = start_creating(name, parent);
351
352 if (IS_ERR(dentry))
353 return NULL;
354
355 inode = debugfs_get_inode(dentry->d_sb);
356 if (unlikely(!inode))
357 return failed_creating(dentry);
358
359 inode->i_mode = mode;
360 inode->i_private = data;
361
362 inode->i_fop = proxy_fops;
363 dentry->d_fsdata = (void *)real_fops;
364
365 d_instantiate(dentry, inode);
366 fsnotify_create(d_inode(dentry->d_parent), dentry);
367 return end_creating(dentry);
368}
369
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370/**
371 * debugfs_create_file - create a file in the debugfs filesystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 * @name: a pointer to a string containing the name of the file to create.
Alberto Bertoglibe030e62009-10-31 18:26:52 -0300373 * @mode: the permission that the file should have.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * @parent: a pointer to the parent dentry for this file. This should be a
Masanari Iidae2278672014-02-18 22:54:36 +0900375 * directory dentry if set. If this parameter is NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376 * file will be created in the root of the debugfs filesystem.
377 * @data: a pointer to something that the caller will want to get to later
Theodore Ts'o8e18e292006-09-27 01:50:46 -0700378 * on. The inode.i_private pointer will point to this value on
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 * the open() call.
380 * @fops: a pointer to a struct file_operations that should be used for
381 * this file.
382 *
383 * This is the basic "create a file" function for debugfs. It allows for a
Alberto Bertoglibe030e62009-10-31 18:26:52 -0300384 * wide range of flexibility in creating a file, or a directory (if you want
385 * to create a directory, the debugfs_create_dir() function is
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 * recommended to be used instead.)
387 *
388 * This function will return a pointer to a dentry if it succeeds. This
389 * pointer must be passed to the debugfs_remove() function when the file is
390 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700391 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700393 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100394 * returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 */
Al Virof4ae40a62011-07-24 04:33:43 -0400396struct dentry *debugfs_create_file(const char *name, umode_t mode,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 struct dentry *parent, void *data,
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800398 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
Al Viroc3b1a352012-06-09 20:28:22 -0400400
Nicolai Stange49d200d2016-03-22 14:11:14 +0100401 return __debugfs_create_file(name, mode, parent, data,
402 fops ? &debugfs_full_proxy_file_operations :
403 &debugfs_noop_file_operations,
404 fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405}
406EXPORT_SYMBOL_GPL(debugfs_create_file);
407
Nicolai Stangec6468802016-03-22 14:11:15 +0100408/**
409 * debugfs_create_file_unsafe - create a file in the debugfs filesystem
410 * @name: a pointer to a string containing the name of the file to create.
411 * @mode: the permission that the file should have.
412 * @parent: a pointer to the parent dentry for this file. This should be a
413 * directory dentry if set. If this parameter is NULL, then the
414 * file will be created in the root of the debugfs filesystem.
415 * @data: a pointer to something that the caller will want to get to later
416 * on. The inode.i_private pointer will point to this value on
417 * the open() call.
418 * @fops: a pointer to a struct file_operations that should be used for
419 * this file.
420 *
421 * debugfs_create_file_unsafe() is completely analogous to
422 * debugfs_create_file(), the only difference being that the fops
423 * handed it will not get protected against file removals by the
424 * debugfs core.
425 *
426 * It is your responsibility to protect your struct file_operation
427 * methods against file removals by means of debugfs_use_file_start()
428 * and debugfs_use_file_finish(). ->open() is still protected by
429 * debugfs though.
430 *
431 * Any struct file_operations defined by means of
432 * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
433 * thus, may be used here.
434 */
Nicolai Stange49d200d2016-03-22 14:11:14 +0100435struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
436 struct dentry *parent, void *data,
437 const struct file_operations *fops)
438{
439
440 return __debugfs_create_file(name, mode, parent, data,
441 fops ? &debugfs_open_proxy_file_operations :
442 &debugfs_noop_file_operations,
443 fops);
444}
Nicolai Stangec6468802016-03-22 14:11:15 +0100445EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447/**
David Howellse59b4e92015-01-21 20:03:40 +0000448 * debugfs_create_file_size - create a file in the debugfs filesystem
449 * @name: a pointer to a string containing the name of the file to create.
450 * @mode: the permission that the file should have.
451 * @parent: a pointer to the parent dentry for this file. This should be a
452 * directory dentry if set. If this parameter is NULL, then the
453 * file will be created in the root of the debugfs filesystem.
454 * @data: a pointer to something that the caller will want to get to later
455 * on. The inode.i_private pointer will point to this value on
456 * the open() call.
457 * @fops: a pointer to a struct file_operations that should be used for
458 * this file.
459 * @file_size: initial file size
460 *
461 * This is the basic "create a file" function for debugfs. It allows for a
462 * wide range of flexibility in creating a file, or a directory (if you want
463 * to create a directory, the debugfs_create_dir() function is
464 * recommended to be used instead.)
465 *
466 * This function will return a pointer to a dentry if it succeeds. This
467 * pointer must be passed to the debugfs_remove() function when the file is
468 * to be removed (no automatic cleanup happens if your module is unloaded,
469 * you are responsible here.) If an error occurs, %NULL will be returned.
470 *
471 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
472 * returned.
473 */
474struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
475 struct dentry *parent, void *data,
476 const struct file_operations *fops,
477 loff_t file_size)
478{
479 struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
480
481 if (de)
David Howells2b0143b2015-03-17 22:25:59 +0000482 d_inode(de)->i_size = file_size;
David Howellse59b4e92015-01-21 20:03:40 +0000483 return de;
484}
485EXPORT_SYMBOL_GPL(debugfs_create_file_size);
486
487/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 * debugfs_create_dir - create a directory in the debugfs filesystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 * @name: a pointer to a string containing the name of the directory to
490 * create.
491 * @parent: a pointer to the parent dentry for this file. This should be a
Masanari Iidae2278672014-02-18 22:54:36 +0900492 * directory dentry if set. If this parameter is NULL, then the
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 * directory will be created in the root of the debugfs filesystem.
494 *
495 * This function creates a directory in debugfs with the given name.
496 *
497 * This function will return a pointer to a dentry if it succeeds. This
498 * pointer must be passed to the debugfs_remove() function when the file is
499 * to be removed (no automatic cleanup happens if your module is unloaded,
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700500 * you are responsible here.) If an error occurs, %NULL will be returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 *
Randy Dunlap6468b3a2006-07-20 08:16:42 -0700502 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100503 * returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 */
505struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
506{
Al Viroad5abd52015-01-25 14:02:31 -0500507 struct dentry *dentry = start_creating(name, parent);
Al Viro680b3022015-01-25 14:31:32 -0500508 struct inode *inode;
Al Viroad5abd52015-01-25 14:02:31 -0500509
510 if (IS_ERR(dentry))
511 return NULL;
512
Al Viroedac65e2015-01-25 14:36:18 -0500513 inode = debugfs_get_inode(dentry->d_sb);
Al Viro680b3022015-01-25 14:31:32 -0500514 if (unlikely(!inode))
Al Viro5233e312015-01-25 14:39:49 -0500515 return failed_creating(dentry);
Al Viro680b3022015-01-25 14:31:32 -0500516
Al Viroedac65e2015-01-25 14:36:18 -0500517 inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
518 inode->i_op = &simple_dir_inode_operations;
519 inode->i_fop = &simple_dir_operations;
520
521 /* directory inodes start off with i_nlink == 2 (for "." entry) */
522 inc_nlink(inode);
Al Viro680b3022015-01-25 14:31:32 -0500523 d_instantiate(dentry, inode);
David Howells2b0143b2015-03-17 22:25:59 +0000524 inc_nlink(d_inode(dentry->d_parent));
525 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
Al Viro5233e312015-01-25 14:39:49 -0500526 return end_creating(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527}
528EXPORT_SYMBOL_GPL(debugfs_create_dir);
529
530/**
Al Viro77b3da62015-01-25 15:10:32 -0500531 * debugfs_create_automount - create automount point in the debugfs filesystem
532 * @name: a pointer to a string containing the name of the file to create.
533 * @parent: a pointer to the parent dentry for this file. This should be a
534 * directory dentry if set. If this parameter is NULL, then the
535 * file will be created in the root of the debugfs filesystem.
536 * @f: function to be called when pathname resolution steps on that one.
537 * @data: opaque argument to pass to f().
538 *
539 * @f should return what ->d_automount() would.
540 */
541struct dentry *debugfs_create_automount(const char *name,
542 struct dentry *parent,
Eric W. Biederman93faccbb2017-02-01 06:06:16 +1300543 debugfs_automount_t f,
Al Viro77b3da62015-01-25 15:10:32 -0500544 void *data)
545{
546 struct dentry *dentry = start_creating(name, parent);
547 struct inode *inode;
548
549 if (IS_ERR(dentry))
550 return NULL;
551
552 inode = debugfs_get_inode(dentry->d_sb);
553 if (unlikely(!inode))
554 return failed_creating(dentry);
555
Seth Forshee87243de2016-03-09 09:18:07 -0600556 make_empty_dir_inode(inode);
Al Viro77b3da62015-01-25 15:10:32 -0500557 inode->i_flags |= S_AUTOMOUNT;
558 inode->i_private = data;
559 dentry->d_fsdata = (void *)f;
Roman Pena8f324a2016-02-09 11:30:29 +0100560 /* directory inodes start off with i_nlink == 2 (for "." entry) */
561 inc_nlink(inode);
Al Viro77b3da62015-01-25 15:10:32 -0500562 d_instantiate(dentry, inode);
Roman Pena8f324a2016-02-09 11:30:29 +0100563 inc_nlink(d_inode(dentry->d_parent));
564 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
Al Viro77b3da62015-01-25 15:10:32 -0500565 return end_creating(dentry);
566}
567EXPORT_SYMBOL(debugfs_create_automount);
568
569/**
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100570 * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
571 * @name: a pointer to a string containing the name of the symbolic link to
572 * create.
573 * @parent: a pointer to the parent dentry for this symbolic link. This
Masanari Iidae2278672014-02-18 22:54:36 +0900574 * should be a directory dentry if set. If this parameter is NULL,
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100575 * then the symbolic link will be created in the root of the debugfs
576 * filesystem.
577 * @target: a pointer to a string containing the path to the target of the
578 * symbolic link.
579 *
580 * This function creates a symbolic link with the given name in debugfs that
581 * links to the given target path.
582 *
583 * This function will return a pointer to a dentry if it succeeds. This
584 * pointer must be passed to the debugfs_remove() function when the symbolic
585 * link is to be removed (no automatic cleanup happens if your module is
586 * unloaded, you are responsible here.) If an error occurs, %NULL will be
587 * returned.
588 *
589 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
Cornelia Huck873760f2007-02-14 07:57:47 +0100590 * returned.
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100591 */
592struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
593 const char *target)
594{
Al Viroad5abd52015-01-25 14:02:31 -0500595 struct dentry *dentry;
Al Viro680b3022015-01-25 14:31:32 -0500596 struct inode *inode;
597 char *link = kstrdup(target, GFP_KERNEL);
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100598 if (!link)
599 return NULL;
600
Al Viroad5abd52015-01-25 14:02:31 -0500601 dentry = start_creating(name, parent);
Al Viroad5abd52015-01-25 14:02:31 -0500602 if (IS_ERR(dentry)) {
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100603 kfree(link);
Al Viroad5abd52015-01-25 14:02:31 -0500604 return NULL;
605 }
606
Al Viroedac65e2015-01-25 14:36:18 -0500607 inode = debugfs_get_inode(dentry->d_sb);
Al Viro680b3022015-01-25 14:31:32 -0500608 if (unlikely(!inode)) {
Al Viroad5abd52015-01-25 14:02:31 -0500609 kfree(link);
Al Viro5233e312015-01-25 14:39:49 -0500610 return failed_creating(dentry);
Al Viro680b3022015-01-25 14:31:32 -0500611 }
Al Viroedac65e2015-01-25 14:36:18 -0500612 inode->i_mode = S_IFLNK | S_IRWXUGO;
Al Viro5723cb02015-05-02 10:27:18 -0400613 inode->i_op = &simple_symlink_inode_operations;
614 inode->i_link = link;
Al Viro680b3022015-01-25 14:31:32 -0500615 d_instantiate(dentry, inode);
Al Viro5233e312015-01-25 14:39:49 -0500616 return end_creating(dentry);
Peter Oberparleiter66f54962007-02-13 12:13:54 +0100617}
618EXPORT_SYMBOL_GPL(debugfs_create_symlink);
619
Jan Kara25d41d82011-02-07 15:00:27 +0100620static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621{
Mathieu Desnoyers65c33332006-11-24 13:50:09 -0500622 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Al Virodc3f4192015-05-18 10:10:34 -0400624 if (simple_positive(dentry)) {
Al Viro0db59e52015-02-21 22:05:11 -0500625 dget(dentry);
David Howells7ceab502015-03-05 12:46:49 +0000626 if (d_is_dir(dentry))
David Howells2b0143b2015-03-17 22:25:59 +0000627 ret = simple_rmdir(d_inode(parent), dentry);
Al Viro0db59e52015-02-21 22:05:11 -0500628 else
David Howells2b0143b2015-03-17 22:25:59 +0000629 simple_unlink(d_inode(parent), dentry);
Al Viro0db59e52015-02-21 22:05:11 -0500630 if (!ret)
631 d_delete(dentry);
632 dput(dentry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 }
Jan Kara25d41d82011-02-07 15:00:27 +0100634 return ret;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200635}
636
637/**
638 * debugfs_remove - removes a file or directory from the debugfs filesystem
639 * @dentry: a pointer to a the dentry of the file or directory to be
Ulf Magnusson398dc4a2015-09-07 19:03:15 +0200640 * removed. If this parameter is NULL or an error value, nothing
641 * will be done.
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200642 *
643 * This function removes a file or directory in debugfs that was previously
644 * created with a call to another debugfs function (like
645 * debugfs_create_file() or variants thereof.)
646 *
647 * This function is required to be called in order for the file to be
648 * removed, no automatic cleanup of files will happen when a module is
649 * removed, you are responsible here.
650 */
651void debugfs_remove(struct dentry *dentry)
652{
653 struct dentry *parent;
Jan Kara25d41d82011-02-07 15:00:27 +0100654 int ret;
655
Arend van Spriela59d6292012-05-23 15:13:07 +0200656 if (IS_ERR_OR_NULL(dentry))
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200657 return;
658
659 parent = dentry->d_parent;
Al Viro59551022016-01-22 15:40:57 -0500660 inode_lock(d_inode(parent));
Jan Kara25d41d82011-02-07 15:00:27 +0100661 ret = __debugfs_remove(dentry, parent);
Al Viro59551022016-01-22 15:40:57 -0500662 inode_unlock(d_inode(parent));
Jan Kara25d41d82011-02-07 15:00:27 +0100663 if (!ret)
664 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Nicolai Stange49d200d2016-03-22 14:11:14 +0100665
Nicolai Stange9fd4dce2016-03-22 14:11:13 +0100666 synchronize_srcu(&debugfs_srcu);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667}
668EXPORT_SYMBOL_GPL(debugfs_remove);
669
Jan Karacfc94cd2007-05-09 13:19:52 +0200670/**
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200671 * debugfs_remove_recursive - recursively removes a directory
Ulf Magnusson398dc4a2015-09-07 19:03:15 +0200672 * @dentry: a pointer to a the dentry of the directory to be removed. If this
673 * parameter is NULL or an error value, nothing will be done.
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200674 *
675 * This function recursively removes a directory tree in debugfs that
676 * was previously created with a call to another debugfs function
677 * (like debugfs_create_file() or variants thereof.)
678 *
679 * This function is required to be called in order for the file to be
680 * removed, no automatic cleanup of files will happen when a module is
681 * removed, you are responsible here.
682 */
683void debugfs_remove_recursive(struct dentry *dentry)
684{
Steven Rostedt485d4402014-06-09 14:06:07 -0400685 struct dentry *child, *parent;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200686
Arend van Spriela59d6292012-05-23 15:13:07 +0200687 if (IS_ERR_OR_NULL(dentry))
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200688 return;
689
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200690 parent = dentry;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200691 down:
Al Viro59551022016-01-22 15:40:57 -0500692 inode_lock(d_inode(parent));
Steven Rostedt485d4402014-06-09 14:06:07 -0400693 loop:
694 /*
695 * The parent->d_subdirs is protected by the d_lock. Outside that
696 * lock, the child can be unlinked and set to be freed which can
697 * use the d_u.d_child as the rcu head and corrupt this list.
698 */
699 spin_lock(&parent->d_lock);
Al Viro946e51f2014-10-26 19:19:16 -0400700 list_for_each_entry(child, &parent->d_subdirs, d_child) {
Al Virodc3f4192015-05-18 10:10:34 -0400701 if (!simple_positive(child))
Oleg Nesterov776164c2013-07-26 17:12:56 +0200702 continue;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200703
Oleg Nesterov776164c2013-07-26 17:12:56 +0200704 /* perhaps simple_empty(child) makes more sense */
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200705 if (!list_empty(&child->d_subdirs)) {
Steven Rostedt485d4402014-06-09 14:06:07 -0400706 spin_unlock(&parent->d_lock);
Al Viro59551022016-01-22 15:40:57 -0500707 inode_unlock(d_inode(parent));
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200708 parent = child;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200709 goto down;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200710 }
Steven Rostedt485d4402014-06-09 14:06:07 -0400711
712 spin_unlock(&parent->d_lock);
713
Oleg Nesterov776164c2013-07-26 17:12:56 +0200714 if (!__debugfs_remove(child, parent))
715 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Steven Rostedt485d4402014-06-09 14:06:07 -0400716
717 /*
718 * The parent->d_lock protects agaist child from unlinking
719 * from d_subdirs. When releasing the parent->d_lock we can
720 * no longer trust that the next pointer is valid.
721 * Restart the loop. We'll skip this one with the
Al Virodc3f4192015-05-18 10:10:34 -0400722 * simple_positive() check.
Steven Rostedt485d4402014-06-09 14:06:07 -0400723 */
724 goto loop;
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200725 }
Steven Rostedt485d4402014-06-09 14:06:07 -0400726 spin_unlock(&parent->d_lock);
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200727
Al Viro59551022016-01-22 15:40:57 -0500728 inode_unlock(d_inode(parent));
Oleg Nesterov776164c2013-07-26 17:12:56 +0200729 child = parent;
730 parent = parent->d_parent;
Al Viro59551022016-01-22 15:40:57 -0500731 inode_lock(d_inode(parent));
Oleg Nesterov776164c2013-07-26 17:12:56 +0200732
Steven Rostedt485d4402014-06-09 14:06:07 -0400733 if (child != dentry)
734 /* go up */
735 goto loop;
Oleg Nesterov776164c2013-07-26 17:12:56 +0200736
737 if (!__debugfs_remove(child, parent))
738 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
Al Viro59551022016-01-22 15:40:57 -0500739 inode_unlock(d_inode(parent));
Nicolai Stange49d200d2016-03-22 14:11:14 +0100740
Nicolai Stange9fd4dce2016-03-22 14:11:13 +0100741 synchronize_srcu(&debugfs_srcu);
Haavard Skinnemoen9505e632008-07-01 15:14:51 +0200742}
743EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
744
745/**
Jan Karacfc94cd2007-05-09 13:19:52 +0200746 * debugfs_rename - rename a file/directory in the debugfs filesystem
747 * @old_dir: a pointer to the parent dentry for the renamed object. This
748 * should be a directory dentry.
749 * @old_dentry: dentry of an object to be renamed.
750 * @new_dir: a pointer to the parent dentry where the object should be
751 * moved. This should be a directory dentry.
752 * @new_name: a pointer to a string containing the target name.
753 *
754 * This function renames a file/directory in debugfs. The target must not
755 * exist for rename to succeed.
756 *
757 * This function will return a pointer to old_dentry (which is updated to
758 * reflect renaming) if it succeeds. If an error occurs, %NULL will be
759 * returned.
760 *
761 * If debugfs is not enabled in the kernel, the value -%ENODEV will be
762 * returned.
763 */
764struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
765 struct dentry *new_dir, const char *new_name)
766{
767 int error;
768 struct dentry *dentry = NULL, *trap;
769 const char *old_name;
770
771 trap = lock_rename(new_dir, old_dir);
772 /* Source or destination directories don't exist? */
David Howells2b0143b2015-03-17 22:25:59 +0000773 if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
Jan Karacfc94cd2007-05-09 13:19:52 +0200774 goto exit;
775 /* Source does not exist, cyclic rename, or mountpoint? */
David Howells2b0143b2015-03-17 22:25:59 +0000776 if (d_really_is_negative(old_dentry) || old_dentry == trap ||
Jan Karacfc94cd2007-05-09 13:19:52 +0200777 d_mountpoint(old_dentry))
778 goto exit;
779 dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
780 /* Lookup failed, cyclic rename or target exists? */
David Howells2b0143b2015-03-17 22:25:59 +0000781 if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
Jan Karacfc94cd2007-05-09 13:19:52 +0200782 goto exit;
783
784 old_name = fsnotify_oldname_init(old_dentry->d_name.name);
785
David Howells2b0143b2015-03-17 22:25:59 +0000786 error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
Miklos Szeredie0e0be82016-09-27 11:03:57 +0200787 dentry, 0);
Jan Karacfc94cd2007-05-09 13:19:52 +0200788 if (error) {
789 fsnotify_oldname_free(old_name);
790 goto exit;
791 }
792 d_move(old_dentry, dentry);
David Howells2b0143b2015-03-17 22:25:59 +0000793 fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name,
David Howellse36cb0b2015-01-29 12:02:35 +0000794 d_is_dir(old_dentry),
Al Viro5a190ae2007-06-07 12:19:32 -0400795 NULL, old_dentry);
Jan Karacfc94cd2007-05-09 13:19:52 +0200796 fsnotify_oldname_free(old_name);
797 unlock_rename(new_dir, old_dir);
798 dput(dentry);
799 return old_dentry;
800exit:
801 if (dentry && !IS_ERR(dentry))
802 dput(dentry);
803 unlock_rename(new_dir, old_dir);
804 return NULL;
805}
806EXPORT_SYMBOL_GPL(debugfs_rename);
807
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +0100808/**
809 * debugfs_initialized - Tells whether debugfs has been registered
810 */
811bool debugfs_initialized(void)
812{
813 return debugfs_registered;
814}
815EXPORT_SYMBOL_GPL(debugfs_initialized);
816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817static int __init debugfs_init(void)
818{
819 int retval;
820
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500821 retval = sysfs_create_mount_point(kernel_kobj, "debug");
822 if (retval)
823 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824
825 retval = register_filesystem(&debug_fs_type);
826 if (retval)
Eric W. Biedermanf9bb4882015-05-13 17:35:41 -0500827 sysfs_remove_mount_point(kernel_kobj, "debug");
Frederic Weisbeckerc0f92ba2009-03-22 23:10:44 +0100828 else
829 debugfs_registered = true;
830
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831 return retval;
832}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833core_initcall(debugfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834