Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
bd33d12f | 2 | * inode.c - part of debugfs, a tiny little debug file system |
1da177e4 LT |
3 | * |
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 | ||
1da177e4 LT |
16 | #include <linux/module.h> |
17 | #include <linux/fs.h> | |
18 | #include <linux/mount.h> | |
19 | #include <linux/pagemap.h> | |
20 | #include <linux/init.h> | |
4d8ebddc | 21 | #include <linux/kobject.h> |
1da177e4 LT |
22 | #include <linux/namei.h> |
23 | #include <linux/debugfs.h> | |
4f36557f | 24 | #include <linux/fsnotify.h> |
66f54963 | 25 | #include <linux/string.h> |
d6e48686 LN |
26 | #include <linux/seq_file.h> |
27 | #include <linux/parser.h> | |
92562927 | 28 | #include <linux/magic.h> |
5a0e3ad6 | 29 | #include <linux/slab.h> |
1da177e4 | 30 | |
82aceae4 | 31 | #define DEBUGFS_DEFAULT_MODE 0700 |
d6e48686 | 32 | |
1da177e4 LT |
33 | static struct vfsmount *debugfs_mount; |
34 | static int debugfs_mount_count; | |
c0f92ba9 | 35 | static bool debugfs_registered; |
1da177e4 | 36 | |
f4ae40a6 | 37 | static struct inode *debugfs_get_inode(struct super_block *sb, umode_t mode, dev_t dev, |
d3a3b0ad MD |
38 | void *data, const struct file_operations *fops) |
39 | ||
1da177e4 LT |
40 | { |
41 | struct inode *inode = new_inode(sb); | |
42 | ||
43 | if (inode) { | |
85fe4025 | 44 | inode->i_ino = get_next_ino(); |
1da177e4 | 45 | inode->i_mode = mode; |
1da177e4 LT |
46 | inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME; |
47 | switch (mode & S_IFMT) { | |
48 | default: | |
49 | init_special_inode(inode, mode, dev); | |
50 | break; | |
51 | case S_IFREG: | |
d3a3b0ad MD |
52 | inode->i_fop = fops ? fops : &debugfs_file_operations; |
53 | inode->i_private = data; | |
1da177e4 | 54 | break; |
66f54963 PO |
55 | case S_IFLNK: |
56 | inode->i_op = &debugfs_link_operations; | |
d3a3b0ad | 57 | inode->i_private = data; |
66f54963 | 58 | break; |
1da177e4 LT |
59 | case S_IFDIR: |
60 | inode->i_op = &simple_dir_inode_operations; | |
ac481d6c | 61 | inode->i_fop = &simple_dir_operations; |
1da177e4 | 62 | |
bafb232e MD |
63 | /* directory inodes start off with i_nlink == 2 |
64 | * (for "." entry) */ | |
d8c76e6f | 65 | inc_nlink(inode); |
1da177e4 LT |
66 | break; |
67 | } | |
68 | } | |
88e412ea | 69 | return inode; |
1da177e4 LT |
70 | } |
71 | ||
72 | /* SMP-safe */ | |
73 | static int debugfs_mknod(struct inode *dir, struct dentry *dentry, | |
f4ae40a6 | 74 | umode_t mode, dev_t dev, void *data, |
d3a3b0ad | 75 | const struct file_operations *fops) |
1da177e4 | 76 | { |
71601e2b | 77 | struct inode *inode; |
1da177e4 LT |
78 | int error = -EPERM; |
79 | ||
80 | if (dentry->d_inode) | |
81 | return -EEXIST; | |
82 | ||
d3a3b0ad | 83 | inode = debugfs_get_inode(dir->i_sb, mode, dev, data, fops); |
1da177e4 LT |
84 | if (inode) { |
85 | d_instantiate(dentry, inode); | |
86 | dget(dentry); | |
87 | error = 0; | |
88 | } | |
89 | return error; | |
90 | } | |
91 | ||
e09ddf36 | 92 | static int debugfs_mkdir(struct dentry *dentry, umode_t mode) |
1da177e4 | 93 | { |
e09ddf36 | 94 | struct inode *dir = dentry->d_parent->d_inode; |
1da177e4 LT |
95 | int res; |
96 | ||
97 | mode = (mode & (S_IRWXUGO | S_ISVTX)) | S_IFDIR; | |
ac481d6c | 98 | res = debugfs_mknod(dir, dentry, mode, 0, NULL, NULL); |
4f36557f | 99 | if (!res) { |
d8c76e6f | 100 | inc_nlink(dir); |
4f36557f MD |
101 | fsnotify_mkdir(dir, dentry); |
102 | } | |
1da177e4 LT |
103 | return res; |
104 | } | |
105 | ||
e09ddf36 | 106 | static int debugfs_link(struct dentry *dentry, umode_t mode, |
ac481d6c | 107 | void *data) |
66f54963 | 108 | { |
e09ddf36 | 109 | struct inode *dir = dentry->d_parent->d_inode; |
66f54963 | 110 | mode = (mode & S_IALLUGO) | S_IFLNK; |
ac481d6c | 111 | return debugfs_mknod(dir, dentry, mode, 0, data, NULL); |
66f54963 PO |
112 | } |
113 | ||
e09ddf36 | 114 | static int debugfs_create(struct dentry *dentry, umode_t mode, |
d3a3b0ad | 115 | void *data, const struct file_operations *fops) |
1da177e4 | 116 | { |
e09ddf36 | 117 | struct inode *dir = dentry->d_parent->d_inode; |
4f36557f MD |
118 | int res; |
119 | ||
1da177e4 | 120 | mode = (mode & S_IALLUGO) | S_IFREG; |
d3a3b0ad | 121 | res = debugfs_mknod(dir, dentry, mode, 0, data, fops); |
4f36557f MD |
122 | if (!res) |
123 | fsnotify_create(dir, dentry); | |
124 | return res; | |
1da177e4 LT |
125 | } |
126 | ||
127 | static inline int debugfs_positive(struct dentry *dentry) | |
128 | { | |
129 | return dentry->d_inode && !d_unhashed(dentry); | |
130 | } | |
131 | ||
d6e48686 | 132 | struct debugfs_mount_opts { |
7dc05881 EB |
133 | kuid_t uid; |
134 | kgid_t gid; | |
d6e48686 LN |
135 | umode_t mode; |
136 | }; | |
137 | ||
138 | enum { | |
139 | Opt_uid, | |
140 | Opt_gid, | |
141 | Opt_mode, | |
142 | Opt_err | |
143 | }; | |
144 | ||
145 | static const match_table_t tokens = { | |
146 | {Opt_uid, "uid=%u"}, | |
147 | {Opt_gid, "gid=%u"}, | |
148 | {Opt_mode, "mode=%o"}, | |
149 | {Opt_err, NULL} | |
150 | }; | |
151 | ||
152 | struct debugfs_fs_info { | |
153 | struct debugfs_mount_opts mount_opts; | |
154 | }; | |
155 | ||
156 | static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts) | |
157 | { | |
158 | substring_t args[MAX_OPT_ARGS]; | |
159 | int option; | |
160 | int token; | |
7dc05881 EB |
161 | kuid_t uid; |
162 | kgid_t gid; | |
d6e48686 LN |
163 | char *p; |
164 | ||
165 | opts->mode = DEBUGFS_DEFAULT_MODE; | |
166 | ||
167 | while ((p = strsep(&data, ",")) != NULL) { | |
168 | if (!*p) | |
169 | continue; | |
170 | ||
171 | token = match_token(p, tokens, args); | |
172 | switch (token) { | |
173 | case Opt_uid: | |
174 | if (match_int(&args[0], &option)) | |
175 | return -EINVAL; | |
7dc05881 EB |
176 | uid = make_kuid(current_user_ns(), option); |
177 | if (!uid_valid(uid)) | |
178 | return -EINVAL; | |
179 | opts->uid = uid; | |
d6e48686 LN |
180 | break; |
181 | case Opt_gid: | |
f1688e04 | 182 | if (match_int(&args[0], &option)) |
d6e48686 | 183 | return -EINVAL; |
7dc05881 EB |
184 | gid = make_kgid(current_user_ns(), option); |
185 | if (!gid_valid(gid)) | |
186 | return -EINVAL; | |
187 | opts->gid = gid; | |
d6e48686 LN |
188 | break; |
189 | case Opt_mode: | |
190 | if (match_octal(&args[0], &option)) | |
191 | return -EINVAL; | |
192 | opts->mode = option & S_IALLUGO; | |
193 | break; | |
194 | /* | |
195 | * We might like to report bad mount options here; | |
196 | * but traditionally debugfs has ignored all mount options | |
197 | */ | |
198 | } | |
199 | } | |
200 | ||
201 | return 0; | |
202 | } | |
203 | ||
204 | static int debugfs_apply_options(struct super_block *sb) | |
205 | { | |
206 | struct debugfs_fs_info *fsi = sb->s_fs_info; | |
207 | struct inode *inode = sb->s_root->d_inode; | |
208 | struct debugfs_mount_opts *opts = &fsi->mount_opts; | |
209 | ||
210 | inode->i_mode &= ~S_IALLUGO; | |
211 | inode->i_mode |= opts->mode; | |
212 | ||
213 | inode->i_uid = opts->uid; | |
214 | inode->i_gid = opts->gid; | |
215 | ||
216 | return 0; | |
217 | } | |
218 | ||
219 | static int debugfs_remount(struct super_block *sb, int *flags, char *data) | |
220 | { | |
221 | int err; | |
222 | struct debugfs_fs_info *fsi = sb->s_fs_info; | |
223 | ||
02b9984d | 224 | sync_filesystem(sb); |
d6e48686 LN |
225 | err = debugfs_parse_options(data, &fsi->mount_opts); |
226 | if (err) | |
227 | goto fail; | |
228 | ||
229 | debugfs_apply_options(sb); | |
230 | ||
231 | fail: | |
232 | return err; | |
233 | } | |
234 | ||
235 | static int debugfs_show_options(struct seq_file *m, struct dentry *root) | |
236 | { | |
237 | struct debugfs_fs_info *fsi = root->d_sb->s_fs_info; | |
238 | struct debugfs_mount_opts *opts = &fsi->mount_opts; | |
239 | ||
7dc05881 EB |
240 | if (!uid_eq(opts->uid, GLOBAL_ROOT_UID)) |
241 | seq_printf(m, ",uid=%u", | |
242 | from_kuid_munged(&init_user_ns, opts->uid)); | |
243 | if (!gid_eq(opts->gid, GLOBAL_ROOT_GID)) | |
244 | seq_printf(m, ",gid=%u", | |
245 | from_kgid_munged(&init_user_ns, opts->gid)); | |
d6e48686 LN |
246 | if (opts->mode != DEBUGFS_DEFAULT_MODE) |
247 | seq_printf(m, ",mode=%o", opts->mode); | |
248 | ||
249 | return 0; | |
250 | } | |
251 | ||
252 | static const struct super_operations debugfs_super_operations = { | |
253 | .statfs = simple_statfs, | |
254 | .remount_fs = debugfs_remount, | |
255 | .show_options = debugfs_show_options, | |
256 | }; | |
257 | ||
1da177e4 LT |
258 | static int debug_fill_super(struct super_block *sb, void *data, int silent) |
259 | { | |
260 | static struct tree_descr debug_files[] = {{""}}; | |
d6e48686 LN |
261 | struct debugfs_fs_info *fsi; |
262 | int err; | |
263 | ||
264 | save_mount_options(sb, data); | |
265 | ||
266 | fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL); | |
267 | sb->s_fs_info = fsi; | |
268 | if (!fsi) { | |
269 | err = -ENOMEM; | |
270 | goto fail; | |
271 | } | |
272 | ||
273 | err = debugfs_parse_options(data, &fsi->mount_opts); | |
274 | if (err) | |
275 | goto fail; | |
276 | ||
277 | err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files); | |
278 | if (err) | |
279 | goto fail; | |
280 | ||
281 | sb->s_op = &debugfs_super_operations; | |
282 | ||
283 | debugfs_apply_options(sb); | |
284 | ||
285 | return 0; | |
1da177e4 | 286 | |
d6e48686 LN |
287 | fail: |
288 | kfree(fsi); | |
289 | sb->s_fs_info = NULL; | |
290 | return err; | |
1da177e4 LT |
291 | } |
292 | ||
fc14f2fe | 293 | static struct dentry *debug_mount(struct file_system_type *fs_type, |
454e2398 | 294 | int flags, const char *dev_name, |
fc14f2fe | 295 | void *data) |
1da177e4 | 296 | { |
fc14f2fe | 297 | return mount_single(fs_type, flags, data, debug_fill_super); |
1da177e4 LT |
298 | } |
299 | ||
300 | static struct file_system_type debug_fs_type = { | |
301 | .owner = THIS_MODULE, | |
302 | .name = "debugfs", | |
fc14f2fe | 303 | .mount = debug_mount, |
1da177e4 LT |
304 | .kill_sb = kill_litter_super, |
305 | }; | |
7f78e035 | 306 | MODULE_ALIAS_FS("debugfs"); |
1da177e4 | 307 | |
3cd52ab6 CW |
308 | static struct dentry *__create_file(const char *name, umode_t mode, |
309 | struct dentry *parent, void *data, | |
310 | const struct file_operations *fops) | |
1da177e4 | 311 | { |
cfa57c11 AV |
312 | struct dentry *dentry = NULL; |
313 | int error; | |
314 | ||
315 | pr_debug("debugfs: creating file '%s'\n",name); | |
316 | ||
317 | error = simple_pin_fs(&debug_fs_type, &debugfs_mount, | |
318 | &debugfs_mount_count); | |
319 | if (error) | |
320 | goto exit; | |
1da177e4 LT |
321 | |
322 | /* If the parent is not specified, we create it in the root. | |
88e412ea | 323 | * We need the root dentry to do this, which is in the super |
1da177e4 LT |
324 | * block. A pointer to that is in the struct vfsmount that we |
325 | * have around. | |
326 | */ | |
ef52c75e | 327 | if (!parent) |
4c1d5a64 | 328 | parent = debugfs_mount->mnt_root; |
1da177e4 | 329 | |
1b1dcc1b | 330 | mutex_lock(&parent->d_inode->i_mutex); |
cfa57c11 AV |
331 | dentry = lookup_one_len(name, parent, strlen(name)); |
332 | if (!IS_ERR(dentry)) { | |
66f54963 PO |
333 | switch (mode & S_IFMT) { |
334 | case S_IFDIR: | |
e09ddf36 | 335 | error = debugfs_mkdir(dentry, mode); |
88e412ea | 336 | |
66f54963 PO |
337 | break; |
338 | case S_IFLNK: | |
e09ddf36 | 339 | error = debugfs_link(dentry, mode, data); |
66f54963 PO |
340 | break; |
341 | default: | |
e09ddf36 | 342 | error = debugfs_create(dentry, mode, data, fops); |
66f54963 PO |
343 | break; |
344 | } | |
cfa57c11 | 345 | dput(dentry); |
1da177e4 | 346 | } else |
cfa57c11 | 347 | error = PTR_ERR(dentry); |
1b1dcc1b | 348 | mutex_unlock(&parent->d_inode->i_mutex); |
1da177e4 | 349 | |
c3b1a350 AV |
350 | if (error) { |
351 | dentry = NULL; | |
352 | simple_release_fs(&debugfs_mount, &debugfs_mount_count); | |
353 | } | |
354 | exit: | |
355 | return dentry; | |
356 | } | |
357 | ||
1da177e4 LT |
358 | /** |
359 | * debugfs_create_file - create a file in the debugfs filesystem | |
1da177e4 | 360 | * @name: a pointer to a string containing the name of the file to create. |
be030e65 | 361 | * @mode: the permission that the file should have. |
1da177e4 | 362 | * @parent: a pointer to the parent dentry for this file. This should be a |
e227867f | 363 | * directory dentry if set. If this parameter is NULL, then the |
1da177e4 LT |
364 | * file will be created in the root of the debugfs filesystem. |
365 | * @data: a pointer to something that the caller will want to get to later | |
8e18e294 | 366 | * on. The inode.i_private pointer will point to this value on |
1da177e4 LT |
367 | * the open() call. |
368 | * @fops: a pointer to a struct file_operations that should be used for | |
369 | * this file. | |
370 | * | |
371 | * This is the basic "create a file" function for debugfs. It allows for a | |
be030e65 AB |
372 | * wide range of flexibility in creating a file, or a directory (if you want |
373 | * to create a directory, the debugfs_create_dir() function is | |
1da177e4 LT |
374 | * recommended to be used instead.) |
375 | * | |
376 | * This function will return a pointer to a dentry if it succeeds. This | |
377 | * pointer must be passed to the debugfs_remove() function when the file is | |
378 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 379 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 380 | * |
6468b3af | 381 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
873760fb | 382 | * returned. |
1da177e4 | 383 | */ |
f4ae40a6 | 384 | struct dentry *debugfs_create_file(const char *name, umode_t mode, |
1da177e4 | 385 | struct dentry *parent, void *data, |
99ac48f5 | 386 | const struct file_operations *fops) |
1da177e4 | 387 | { |
c3b1a350 AV |
388 | switch (mode & S_IFMT) { |
389 | case S_IFREG: | |
390 | case 0: | |
391 | break; | |
392 | default: | |
393 | BUG(); | |
1da177e4 | 394 | } |
c3b1a350 AV |
395 | |
396 | return __create_file(name, mode, parent, data, fops); | |
1da177e4 LT |
397 | } |
398 | EXPORT_SYMBOL_GPL(debugfs_create_file); | |
399 | ||
400 | /** | |
401 | * debugfs_create_dir - create a directory in the debugfs filesystem | |
1da177e4 LT |
402 | * @name: a pointer to a string containing the name of the directory to |
403 | * create. | |
404 | * @parent: a pointer to the parent dentry for this file. This should be a | |
e227867f | 405 | * directory dentry if set. If this parameter is NULL, then the |
1da177e4 LT |
406 | * directory will be created in the root of the debugfs filesystem. |
407 | * | |
408 | * This function creates a directory in debugfs with the given name. | |
409 | * | |
410 | * This function will return a pointer to a dentry if it succeeds. This | |
411 | * pointer must be passed to the debugfs_remove() function when the file is | |
412 | * to be removed (no automatic cleanup happens if your module is unloaded, | |
6468b3af | 413 | * you are responsible here.) If an error occurs, %NULL will be returned. |
1da177e4 | 414 | * |
6468b3af | 415 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be |
873760fb | 416 | * returned. |
1da177e4 LT |
417 | */ |
418 | struct dentry *debugfs_create_dir(const char *name, struct dentry *parent) | |
419 | { | |
c3b1a350 | 420 | return __create_file(name, S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO, |
1da177e4 LT |
421 | parent, NULL, NULL); |
422 | } | |
423 | EXPORT_SYMBOL_GPL(debugfs_create_dir); | |
424 | ||
66f54963 PO |
425 | /** |
426 | * debugfs_create_symlink- create a symbolic link in the debugfs filesystem | |
427 | * @name: a pointer to a string containing the name of the symbolic link to | |
428 | * create. | |
429 | * @parent: a pointer to the parent dentry for this symbolic link. This | |
e227867f | 430 | * should be a directory dentry if set. If this parameter is NULL, |
66f54963 PO |
431 | * then the symbolic link will be created in the root of the debugfs |
432 | * filesystem. | |
433 | * @target: a pointer to a string containing the path to the target of the | |
434 | * symbolic link. | |
435 | * | |
436 | * This function creates a symbolic link with the given name in debugfs that | |
437 | * links to the given target path. | |
438 | * | |
439 | * This function will return a pointer to a dentry if it succeeds. This | |
440 | * pointer must be passed to the debugfs_remove() function when the symbolic | |
441 | * link is to be removed (no automatic cleanup happens if your module is | |
442 | * unloaded, you are responsible here.) If an error occurs, %NULL will be | |
443 | * returned. | |
444 | * | |
445 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be | |
873760fb | 446 | * returned. |
66f54963 PO |
447 | */ |
448 | struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent, | |
449 | const char *target) | |
450 | { | |
451 | struct dentry *result; | |
452 | char *link; | |
453 | ||
454 | link = kstrdup(target, GFP_KERNEL); | |
455 | if (!link) | |
456 | return NULL; | |
457 | ||
c3b1a350 | 458 | result = __create_file(name, S_IFLNK | S_IRWXUGO, parent, link, NULL); |
66f54963 PO |
459 | if (!result) |
460 | kfree(link); | |
461 | return result; | |
462 | } | |
463 | EXPORT_SYMBOL_GPL(debugfs_create_symlink); | |
464 | ||
25d41d84 | 465 | static int __debugfs_remove(struct dentry *dentry, struct dentry *parent) |
9505e637 HS |
466 | { |
467 | int ret = 0; | |
468 | ||
469 | if (debugfs_positive(dentry)) { | |
470 | if (dentry->d_inode) { | |
471 | dget(dentry); | |
472 | switch (dentry->d_inode->i_mode & S_IFMT) { | |
473 | case S_IFDIR: | |
474 | ret = simple_rmdir(parent->d_inode, dentry); | |
475 | break; | |
476 | case S_IFLNK: | |
477 | kfree(dentry->d_inode->i_private); | |
478 | /* fall through */ | |
479 | default: | |
480 | simple_unlink(parent->d_inode, dentry); | |
481 | break; | |
482 | } | |
483 | if (!ret) | |
484 | d_delete(dentry); | |
485 | dput(dentry); | |
486 | } | |
487 | } | |
25d41d84 | 488 | return ret; |
9505e637 HS |
489 | } |
490 | ||
1da177e4 LT |
491 | /** |
492 | * debugfs_remove - removes a file or directory from the debugfs filesystem | |
1da177e4 LT |
493 | * @dentry: a pointer to a the dentry of the file or directory to be |
494 | * removed. | |
495 | * | |
496 | * This function removes a file or directory in debugfs that was previously | |
497 | * created with a call to another debugfs function (like | |
5a65980e | 498 | * debugfs_create_file() or variants thereof.) |
1da177e4 LT |
499 | * |
500 | * This function is required to be called in order for the file to be | |
501 | * removed, no automatic cleanup of files will happen when a module is | |
502 | * removed, you are responsible here. | |
503 | */ | |
504 | void debugfs_remove(struct dentry *dentry) | |
505 | { | |
506 | struct dentry *parent; | |
25d41d84 JK |
507 | int ret; |
508 | ||
a59d6293 | 509 | if (IS_ERR_OR_NULL(dentry)) |
1da177e4 LT |
510 | return; |
511 | ||
512 | parent = dentry->d_parent; | |
513 | if (!parent || !parent->d_inode) | |
514 | return; | |
515 | ||
1b1dcc1b | 516 | mutex_lock(&parent->d_inode->i_mutex); |
25d41d84 | 517 | ret = __debugfs_remove(dentry, parent); |
9505e637 | 518 | mutex_unlock(&parent->d_inode->i_mutex); |
25d41d84 JK |
519 | if (!ret) |
520 | simple_release_fs(&debugfs_mount, &debugfs_mount_count); | |
9505e637 HS |
521 | } |
522 | EXPORT_SYMBOL_GPL(debugfs_remove); | |
523 | ||
524 | /** | |
525 | * debugfs_remove_recursive - recursively removes a directory | |
526 | * @dentry: a pointer to a the dentry of the directory to be removed. | |
527 | * | |
528 | * This function recursively removes a directory tree in debugfs that | |
529 | * was previously created with a call to another debugfs function | |
530 | * (like debugfs_create_file() or variants thereof.) | |
531 | * | |
532 | * This function is required to be called in order for the file to be | |
533 | * removed, no automatic cleanup of files will happen when a module is | |
534 | * removed, you are responsible here. | |
535 | */ | |
536 | void debugfs_remove_recursive(struct dentry *dentry) | |
537 | { | |
485d4402 | 538 | struct dentry *child, *parent; |
9505e637 | 539 | |
a59d6293 | 540 | if (IS_ERR_OR_NULL(dentry)) |
9505e637 HS |
541 | return; |
542 | ||
543 | parent = dentry->d_parent; | |
544 | if (!parent || !parent->d_inode) | |
545 | return; | |
546 | ||
547 | parent = dentry; | |
776164c1 | 548 | down: |
9505e637 | 549 | mutex_lock(&parent->d_inode->i_mutex); |
485d4402 SR |
550 | loop: |
551 | /* | |
552 | * The parent->d_subdirs is protected by the d_lock. Outside that | |
553 | * lock, the child can be unlinked and set to be freed which can | |
554 | * use the d_u.d_child as the rcu head and corrupt this list. | |
555 | */ | |
556 | spin_lock(&parent->d_lock); | |
946e51f2 | 557 | list_for_each_entry(child, &parent->d_subdirs, d_child) { |
776164c1 ON |
558 | if (!debugfs_positive(child)) |
559 | continue; | |
9505e637 | 560 | |
776164c1 | 561 | /* perhaps simple_empty(child) makes more sense */ |
9505e637 | 562 | if (!list_empty(&child->d_subdirs)) { |
485d4402 | 563 | spin_unlock(&parent->d_lock); |
9505e637 HS |
564 | mutex_unlock(&parent->d_inode->i_mutex); |
565 | parent = child; | |
776164c1 | 566 | goto down; |
1da177e4 | 567 | } |
485d4402 SR |
568 | |
569 | spin_unlock(&parent->d_lock); | |
570 | ||
776164c1 ON |
571 | if (!__debugfs_remove(child, parent)) |
572 | simple_release_fs(&debugfs_mount, &debugfs_mount_count); | |
485d4402 SR |
573 | |
574 | /* | |
575 | * The parent->d_lock protects agaist child from unlinking | |
576 | * from d_subdirs. When releasing the parent->d_lock we can | |
577 | * no longer trust that the next pointer is valid. | |
578 | * Restart the loop. We'll skip this one with the | |
579 | * debugfs_positive() check. | |
580 | */ | |
581 | goto loop; | |
1da177e4 | 582 | } |
485d4402 | 583 | spin_unlock(&parent->d_lock); |
9505e637 | 584 | |
776164c1 ON |
585 | mutex_unlock(&parent->d_inode->i_mutex); |
586 | child = parent; | |
587 | parent = parent->d_parent; | |
9505e637 | 588 | mutex_lock(&parent->d_inode->i_mutex); |
776164c1 | 589 | |
485d4402 SR |
590 | if (child != dentry) |
591 | /* go up */ | |
592 | goto loop; | |
776164c1 ON |
593 | |
594 | if (!__debugfs_remove(child, parent)) | |
595 | simple_release_fs(&debugfs_mount, &debugfs_mount_count); | |
1b1dcc1b | 596 | mutex_unlock(&parent->d_inode->i_mutex); |
1da177e4 | 597 | } |
9505e637 | 598 | EXPORT_SYMBOL_GPL(debugfs_remove_recursive); |
1da177e4 | 599 | |
cfc94cdf JK |
600 | /** |
601 | * debugfs_rename - rename a file/directory in the debugfs filesystem | |
602 | * @old_dir: a pointer to the parent dentry for the renamed object. This | |
603 | * should be a directory dentry. | |
604 | * @old_dentry: dentry of an object to be renamed. | |
605 | * @new_dir: a pointer to the parent dentry where the object should be | |
606 | * moved. This should be a directory dentry. | |
607 | * @new_name: a pointer to a string containing the target name. | |
608 | * | |
609 | * This function renames a file/directory in debugfs. The target must not | |
610 | * exist for rename to succeed. | |
611 | * | |
612 | * This function will return a pointer to old_dentry (which is updated to | |
613 | * reflect renaming) if it succeeds. If an error occurs, %NULL will be | |
614 | * returned. | |
615 | * | |
616 | * If debugfs is not enabled in the kernel, the value -%ENODEV will be | |
617 | * returned. | |
618 | */ | |
619 | struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry, | |
620 | struct dentry *new_dir, const char *new_name) | |
621 | { | |
622 | int error; | |
623 | struct dentry *dentry = NULL, *trap; | |
624 | const char *old_name; | |
625 | ||
626 | trap = lock_rename(new_dir, old_dir); | |
627 | /* Source or destination directories don't exist? */ | |
628 | if (!old_dir->d_inode || !new_dir->d_inode) | |
629 | goto exit; | |
630 | /* Source does not exist, cyclic rename, or mountpoint? */ | |
631 | if (!old_dentry->d_inode || old_dentry == trap || | |
632 | d_mountpoint(old_dentry)) | |
633 | goto exit; | |
634 | dentry = lookup_one_len(new_name, new_dir, strlen(new_name)); | |
635 | /* Lookup failed, cyclic rename or target exists? */ | |
636 | if (IS_ERR(dentry) || dentry == trap || dentry->d_inode) | |
637 | goto exit; | |
638 | ||
639 | old_name = fsnotify_oldname_init(old_dentry->d_name.name); | |
640 | ||
641 | error = simple_rename(old_dir->d_inode, old_dentry, new_dir->d_inode, | |
642 | dentry); | |
643 | if (error) { | |
644 | fsnotify_oldname_free(old_name); | |
645 | goto exit; | |
646 | } | |
647 | d_move(old_dentry, dentry); | |
648 | fsnotify_move(old_dir->d_inode, new_dir->d_inode, old_name, | |
123df294 | 649 | S_ISDIR(old_dentry->d_inode->i_mode), |
5a190ae6 | 650 | NULL, old_dentry); |
cfc94cdf JK |
651 | fsnotify_oldname_free(old_name); |
652 | unlock_rename(new_dir, old_dir); | |
653 | dput(dentry); | |
654 | return old_dentry; | |
655 | exit: | |
656 | if (dentry && !IS_ERR(dentry)) | |
657 | dput(dentry); | |
658 | unlock_rename(new_dir, old_dir); | |
659 | return NULL; | |
660 | } | |
661 | EXPORT_SYMBOL_GPL(debugfs_rename); | |
662 | ||
c0f92ba9 FW |
663 | /** |
664 | * debugfs_initialized - Tells whether debugfs has been registered | |
665 | */ | |
666 | bool debugfs_initialized(void) | |
667 | { | |
668 | return debugfs_registered; | |
669 | } | |
670 | EXPORT_SYMBOL_GPL(debugfs_initialized); | |
671 | ||
672 | ||
191e186b | 673 | static struct kobject *debug_kobj; |
1da177e4 LT |
674 | |
675 | static int __init debugfs_init(void) | |
676 | { | |
677 | int retval; | |
678 | ||
0ff21e46 | 679 | debug_kobj = kobject_create_and_add("debug", kernel_kobj); |
191e186b GKH |
680 | if (!debug_kobj) |
681 | return -EINVAL; | |
1da177e4 LT |
682 | |
683 | retval = register_filesystem(&debug_fs_type); | |
684 | if (retval) | |
197b12d6 | 685 | kobject_put(debug_kobj); |
c0f92ba9 FW |
686 | else |
687 | debugfs_registered = true; | |
688 | ||
1da177e4 LT |
689 | return retval; |
690 | } | |
1da177e4 | 691 | core_initcall(debugfs_init); |
1da177e4 | 692 |