1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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>
21#include <linux/kobject.h>
22#include <linux/namei.h>
23#include <linux/debugfs.h>
24#include <linux/fsnotify.h>
25#include <linux/string.h>
26#include <linux/seq_file.h>
27#include <linux/parser.h>
28#include <linux/magic.h>
29#include <linux/slab.h>
30#include <linux/srcu.h>
31
32#include "internal.h"
33
34#define DEBUGFS_DEFAULT_MODE 0700
35
36DEFINE_SRCU(debugfs_srcu);
37
38static struct vfsmount *debugfs_mount;
39static int debugfs_mount_count;
40static bool debugfs_registered;
41
42static struct inode *debugfs_get_inode(struct super_block *sb)
43{
44 struct inode *inode = new_inode(sb);
45 if (inode) {
46 inode->i_ino = get_next_ino();
47 inode->i_atime = inode->i_mtime =
48 inode->i_ctime = current_fs_time(sb);
49 }
50 return inode;
51}
52
53struct debugfs_mount_opts {
54 kuid_t uid;
55 kgid_t gid;
56 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;
82 kuid_t uid;
83 kgid_t gid;
84 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;
97 uid = make_kuid(current_user_ns(), option);
98 if (!uid_valid(uid))
99 return -EINVAL;
100 opts->uid = uid;
101 break;
102 case Opt_gid:
103 if (match_int(&args[0], &option))
104 return -EINVAL;
105 gid = make_kgid(current_user_ns(), option);
106 if (!gid_valid(gid))
107 return -EINVAL;
108 opts->gid = gid;
109 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
117
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;
128 struct inode *inode = d_inode(sb->s_root);
129 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
145 sync_filesystem(sb);
146 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
161 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));
167 if (opts->mode != DEBUGFS_DEFAULT_MODE)
168 seq_printf(m, ",mode=%o", opts->mode);
169
170 return 0;
171}
172
173static 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))
178 kfree(inode->i_link);
179}
180
181static const struct super_operations debugfs_super_operations = {
182 .statfs = simple_statfs,
183 .remount_fs = debugfs_remount,
184 .show_options = debugfs_show_options,
185 .evict_inode = debugfs_evict_inode,
186};
187
188static struct vfsmount *debugfs_automount(struct path *path)
189{
190 struct vfsmount *(*f)(void *);
191 f = (struct vfsmount *(*)(void *))path->dentry->d_fsdata;
192 return f(d_inode(path->dentry)->i_private);
193}
194
195static const struct dentry_operations debugfs_dops = {
196 .d_delete = always_delete_dentry,
197 .d_automount = debugfs_automount,
198};
199
200static int debug_fill_super(struct super_block *sb, void *data, int silent)
201{
202 static struct tree_descr debug_files[] = {{""}};
203 struct debugfs_fs_info *fsi;
204 int err;
205
206 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;
224 sb->s_d_op = &debugfs_dops;
225
226 debugfs_apply_options(sb);
227
228 return 0;
229
230fail:
231 kfree(fsi);
232 sb->s_fs_info = NULL;
233 return err;
234}
235
236static struct dentry *debug_mount(struct file_system_type *fs_type,
237 int flags, const char *dev_name,
238 void *data)
239{
240 return mount_single(fs_type, flags, data, debug_fill_super);
241}
242
243static struct file_system_type debug_fs_type = {
244 .owner = THIS_MODULE,
245 .name = "debugfs",
246 .mount = debug_mount,
247 .kill_sb = kill_litter_super,
248};
249MODULE_ALIAS_FS("debugfs");
250
251static struct dentry *start_creating(const char *name, struct dentry *parent)
252{
253 struct dentry *dentry;
254 int error;
255
256 pr_debug("debugfs: creating file '%s'\n",name);
257
258 if (IS_ERR(parent))
259 return parent;
260
261 error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
262 &debugfs_mount_count);
263 if (error)
264 return ERR_PTR(error);
265
266
267
268
269
270
271 if (!parent)
272 parent = debugfs_mount->mnt_root;
273
274 inode_lock(d_inode(parent));
275 dentry = lookup_one_len(name, parent, strlen(name));
276 if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
277 dput(dentry);
278 dentry = ERR_PTR(-EEXIST);
279 }
280
281 if (IS_ERR(dentry)) {
282 inode_unlock(d_inode(parent));
283 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
284 }
285
286 return dentry;
287}
288
289static struct dentry *failed_creating(struct dentry *dentry)
290{
291 inode_unlock(d_inode(dentry->d_parent));
292 dput(dentry);
293 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
294 return NULL;
295}
296
297static struct dentry *end_creating(struct dentry *dentry)
298{
299 inode_unlock(d_inode(dentry->d_parent));
300 return dentry;
301}
302
303static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
304 struct dentry *parent, void *data,
305 const struct file_operations *proxy_fops,
306 const struct file_operations *real_fops)
307{
308 struct dentry *dentry;
309 struct inode *inode;
310
311 if (!(mode & S_IFMT))
312 mode |= S_IFREG;
313 BUG_ON(!S_ISREG(mode));
314 dentry = start_creating(name, parent);
315
316 if (IS_ERR(dentry))
317 return NULL;
318
319 inode = debugfs_get_inode(dentry->d_sb);
320 if (unlikely(!inode))
321 return failed_creating(dentry);
322
323 inode->i_mode = mode;
324 inode->i_private = data;
325
326 inode->i_fop = proxy_fops;
327 dentry->d_fsdata = (void *)real_fops;
328
329 d_instantiate(dentry, inode);
330 fsnotify_create(d_inode(dentry->d_parent), dentry);
331 return end_creating(dentry);
332}
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360struct dentry *debugfs_create_file(const char *name, umode_t mode,
361 struct dentry *parent, void *data,
362 const struct file_operations *fops)
363{
364
365 return __debugfs_create_file(name, mode, parent, data,
366 fops ? &debugfs_full_proxy_file_operations :
367 &debugfs_noop_file_operations,
368 fops);
369}
370EXPORT_SYMBOL_GPL(debugfs_create_file);
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
400 struct dentry *parent, void *data,
401 const struct file_operations *fops)
402{
403
404 return __debugfs_create_file(name, mode, parent, data,
405 fops ? &debugfs_open_proxy_file_operations :
406 &debugfs_noop_file_operations,
407 fops);
408}
409EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
439 struct dentry *parent, void *data,
440 const struct file_operations *fops,
441 loff_t file_size)
442{
443 struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
444
445 if (de)
446 d_inode(de)->i_size = file_size;
447 return de;
448}
449EXPORT_SYMBOL_GPL(debugfs_create_file_size);
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
470{
471 struct dentry *dentry = start_creating(name, parent);
472 struct inode *inode;
473
474 if (IS_ERR(dentry))
475 return NULL;
476
477 inode = debugfs_get_inode(dentry->d_sb);
478 if (unlikely(!inode))
479 return failed_creating(dentry);
480
481 inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
482 inode->i_op = &simple_dir_inode_operations;
483 inode->i_fop = &simple_dir_operations;
484
485
486 inc_nlink(inode);
487 d_instantiate(dentry, inode);
488 inc_nlink(d_inode(dentry->d_parent));
489 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
490 return end_creating(dentry);
491}
492EXPORT_SYMBOL_GPL(debugfs_create_dir);
493
494
495
496
497
498
499
500
501
502
503
504
505struct dentry *debugfs_create_automount(const char *name,
506 struct dentry *parent,
507 struct vfsmount *(*f)(void *),
508 void *data)
509{
510 struct dentry *dentry = start_creating(name, parent);
511 struct inode *inode;
512
513 if (IS_ERR(dentry))
514 return NULL;
515
516 inode = debugfs_get_inode(dentry->d_sb);
517 if (unlikely(!inode))
518 return failed_creating(dentry);
519
520 make_empty_dir_inode(inode);
521 inode->i_flags |= S_AUTOMOUNT;
522 inode->i_private = data;
523 dentry->d_fsdata = (void *)f;
524
525 inc_nlink(inode);
526 d_instantiate(dentry, inode);
527 inc_nlink(d_inode(dentry->d_parent));
528 fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
529 return end_creating(dentry);
530}
531EXPORT_SYMBOL(debugfs_create_automount);
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
557 const char *target)
558{
559 struct dentry *dentry;
560 struct inode *inode;
561 char *link = kstrdup(target, GFP_KERNEL);
562 if (!link)
563 return NULL;
564
565 dentry = start_creating(name, parent);
566 if (IS_ERR(dentry)) {
567 kfree(link);
568 return NULL;
569 }
570
571 inode = debugfs_get_inode(dentry->d_sb);
572 if (unlikely(!inode)) {
573 kfree(link);
574 return failed_creating(dentry);
575 }
576 inode->i_mode = S_IFLNK | S_IRWXUGO;
577 inode->i_op = &simple_symlink_inode_operations;
578 inode->i_link = link;
579 d_instantiate(dentry, inode);
580 return end_creating(dentry);
581}
582EXPORT_SYMBOL_GPL(debugfs_create_symlink);
583
584static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
585{
586 int ret = 0;
587
588 if (simple_positive(dentry)) {
589 dget(dentry);
590 if (d_is_dir(dentry))
591 ret = simple_rmdir(d_inode(parent), dentry);
592 else
593 simple_unlink(d_inode(parent), dentry);
594 if (!ret)
595 d_delete(dentry);
596 dput(dentry);
597 }
598 return ret;
599}
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615void debugfs_remove(struct dentry *dentry)
616{
617 struct dentry *parent;
618 int ret;
619
620 if (IS_ERR_OR_NULL(dentry))
621 return;
622
623 parent = dentry->d_parent;
624 inode_lock(d_inode(parent));
625 ret = __debugfs_remove(dentry, parent);
626 inode_unlock(d_inode(parent));
627 if (!ret)
628 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
629
630 synchronize_srcu(&debugfs_srcu);
631}
632EXPORT_SYMBOL_GPL(debugfs_remove);
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647void debugfs_remove_recursive(struct dentry *dentry)
648{
649 struct dentry *child, *parent;
650
651 if (IS_ERR_OR_NULL(dentry))
652 return;
653
654 parent = dentry;
655 down:
656 inode_lock(d_inode(parent));
657 loop:
658
659
660
661
662
663 spin_lock(&parent->d_lock);
664 list_for_each_entry(child, &parent->d_subdirs, d_child) {
665 if (!simple_positive(child))
666 continue;
667
668
669 if (!list_empty(&child->d_subdirs)) {
670 spin_unlock(&parent->d_lock);
671 inode_unlock(d_inode(parent));
672 parent = child;
673 goto down;
674 }
675
676 spin_unlock(&parent->d_lock);
677
678 if (!__debugfs_remove(child, parent))
679 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
680
681
682
683
684
685
686
687
688 goto loop;
689 }
690 spin_unlock(&parent->d_lock);
691
692 inode_unlock(d_inode(parent));
693 child = parent;
694 parent = parent->d_parent;
695 inode_lock(d_inode(parent));
696
697 if (child != dentry)
698
699 goto loop;
700
701 if (!__debugfs_remove(child, parent))
702 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
703 inode_unlock(d_inode(parent));
704
705 synchronize_srcu(&debugfs_srcu);
706}
707EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
729 struct dentry *new_dir, const char *new_name)
730{
731 int error;
732 struct dentry *dentry = NULL, *trap;
733 const char *old_name;
734
735 trap = lock_rename(new_dir, old_dir);
736
737 if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
738 goto exit;
739
740 if (d_really_is_negative(old_dentry) || old_dentry == trap ||
741 d_mountpoint(old_dentry))
742 goto exit;
743 dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
744
745 if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
746 goto exit;
747
748 old_name = fsnotify_oldname_init(old_dentry->d_name.name);
749
750 error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
751 dentry);
752 if (error) {
753 fsnotify_oldname_free(old_name);
754 goto exit;
755 }
756 d_move(old_dentry, dentry);
757 fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name,
758 d_is_dir(old_dentry),
759 NULL, old_dentry);
760 fsnotify_oldname_free(old_name);
761 unlock_rename(new_dir, old_dir);
762 dput(dentry);
763 return old_dentry;
764exit:
765 if (dentry && !IS_ERR(dentry))
766 dput(dentry);
767 unlock_rename(new_dir, old_dir);
768 return NULL;
769}
770EXPORT_SYMBOL_GPL(debugfs_rename);
771
772
773
774
775bool debugfs_initialized(void)
776{
777 return debugfs_registered;
778}
779EXPORT_SYMBOL_GPL(debugfs_initialized);
780
781static int __init debugfs_init(void)
782{
783 int retval;
784
785 retval = sysfs_create_mount_point(kernel_kobj, "debug");
786 if (retval)
787 return retval;
788
789 retval = register_filesystem(&debug_fs_type);
790 if (retval)
791 sysfs_remove_mount_point(kernel_kobj, "debug");
792 else
793 debugfs_registered = true;
794
795 return retval;
796}
797core_initcall(debugfs_init);
798
799