Merge branch 'work.dcache' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[sfrench/cifs-2.6.git] / fs / debugfs / inode.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  *  inode.c - part of debugfs, a tiny little debug file system
4  *
5  *  Copyright (C) 2004 Greg Kroah-Hartman <greg@kroah.com>
6  *  Copyright (C) 2004 IBM Inc.
7  *
8  *  debugfs is for people to use instead of /proc or /sys.
9  *  See ./Documentation/core-api/kernel-api.rst for more details.
10  */
11
12 #include <linux/module.h>
13 #include <linux/fs.h>
14 #include <linux/mount.h>
15 #include <linux/pagemap.h>
16 #include <linux/init.h>
17 #include <linux/kobject.h>
18 #include <linux/namei.h>
19 #include <linux/debugfs.h>
20 #include <linux/fsnotify.h>
21 #include <linux/string.h>
22 #include <linux/seq_file.h>
23 #include <linux/parser.h>
24 #include <linux/magic.h>
25 #include <linux/slab.h>
26
27 #include "internal.h"
28
29 #define DEBUGFS_DEFAULT_MODE    0700
30
31 static struct vfsmount *debugfs_mount;
32 static int debugfs_mount_count;
33 static bool debugfs_registered;
34
35 static struct inode *debugfs_get_inode(struct super_block *sb)
36 {
37         struct inode *inode = new_inode(sb);
38         if (inode) {
39                 inode->i_ino = get_next_ino();
40                 inode->i_atime = inode->i_mtime =
41                         inode->i_ctime = current_time(inode);
42         }
43         return inode;
44 }
45
46 struct debugfs_mount_opts {
47         kuid_t uid;
48         kgid_t gid;
49         umode_t mode;
50 };
51
52 enum {
53         Opt_uid,
54         Opt_gid,
55         Opt_mode,
56         Opt_err
57 };
58
59 static const match_table_t tokens = {
60         {Opt_uid, "uid=%u"},
61         {Opt_gid, "gid=%u"},
62         {Opt_mode, "mode=%o"},
63         {Opt_err, NULL}
64 };
65
66 struct debugfs_fs_info {
67         struct debugfs_mount_opts mount_opts;
68 };
69
70 static int debugfs_parse_options(char *data, struct debugfs_mount_opts *opts)
71 {
72         substring_t args[MAX_OPT_ARGS];
73         int option;
74         int token;
75         kuid_t uid;
76         kgid_t gid;
77         char *p;
78
79         opts->mode = DEBUGFS_DEFAULT_MODE;
80
81         while ((p = strsep(&data, ",")) != NULL) {
82                 if (!*p)
83                         continue;
84
85                 token = match_token(p, tokens, args);
86                 switch (token) {
87                 case Opt_uid:
88                         if (match_int(&args[0], &option))
89                                 return -EINVAL;
90                         uid = make_kuid(current_user_ns(), option);
91                         if (!uid_valid(uid))
92                                 return -EINVAL;
93                         opts->uid = uid;
94                         break;
95                 case Opt_gid:
96                         if (match_int(&args[0], &option))
97                                 return -EINVAL;
98                         gid = make_kgid(current_user_ns(), option);
99                         if (!gid_valid(gid))
100                                 return -EINVAL;
101                         opts->gid = gid;
102                         break;
103                 case Opt_mode:
104                         if (match_octal(&args[0], &option))
105                                 return -EINVAL;
106                         opts->mode = option & S_IALLUGO;
107                         break;
108                 /*
109                  * We might like to report bad mount options here;
110                  * but traditionally debugfs has ignored all mount options
111                  */
112                 }
113         }
114
115         return 0;
116 }
117
118 static int debugfs_apply_options(struct super_block *sb)
119 {
120         struct debugfs_fs_info *fsi = sb->s_fs_info;
121         struct inode *inode = d_inode(sb->s_root);
122         struct debugfs_mount_opts *opts = &fsi->mount_opts;
123
124         inode->i_mode &= ~S_IALLUGO;
125         inode->i_mode |= opts->mode;
126
127         inode->i_uid = opts->uid;
128         inode->i_gid = opts->gid;
129
130         return 0;
131 }
132
133 static int debugfs_remount(struct super_block *sb, int *flags, char *data)
134 {
135         int err;
136         struct debugfs_fs_info *fsi = sb->s_fs_info;
137
138         sync_filesystem(sb);
139         err = debugfs_parse_options(data, &fsi->mount_opts);
140         if (err)
141                 goto fail;
142
143         debugfs_apply_options(sb);
144
145 fail:
146         return err;
147 }
148
149 static int debugfs_show_options(struct seq_file *m, struct dentry *root)
150 {
151         struct debugfs_fs_info *fsi = root->d_sb->s_fs_info;
152         struct debugfs_mount_opts *opts = &fsi->mount_opts;
153
154         if (!uid_eq(opts->uid, GLOBAL_ROOT_UID))
155                 seq_printf(m, ",uid=%u",
156                            from_kuid_munged(&init_user_ns, opts->uid));
157         if (!gid_eq(opts->gid, GLOBAL_ROOT_GID))
158                 seq_printf(m, ",gid=%u",
159                            from_kgid_munged(&init_user_ns, opts->gid));
160         if (opts->mode != DEBUGFS_DEFAULT_MODE)
161                 seq_printf(m, ",mode=%o", opts->mode);
162
163         return 0;
164 }
165
166 static void debugfs_free_inode(struct inode *inode)
167 {
168         if (S_ISLNK(inode->i_mode))
169                 kfree(inode->i_link);
170         free_inode_nonrcu(inode);
171 }
172
173 static const struct super_operations debugfs_super_operations = {
174         .statfs         = simple_statfs,
175         .remount_fs     = debugfs_remount,
176         .show_options   = debugfs_show_options,
177         .free_inode     = debugfs_free_inode,
178 };
179
180 static void debugfs_release_dentry(struct dentry *dentry)
181 {
182         void *fsd = dentry->d_fsdata;
183
184         if (!((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT))
185                 kfree(dentry->d_fsdata);
186 }
187
188 static struct vfsmount *debugfs_automount(struct path *path)
189 {
190         debugfs_automount_t f;
191         f = (debugfs_automount_t)path->dentry->d_fsdata;
192         return f(path->dentry, d_inode(path->dentry)->i_private);
193 }
194
195 static const struct dentry_operations debugfs_dops = {
196         .d_delete = always_delete_dentry,
197         .d_release = debugfs_release_dentry,
198         .d_automount = debugfs_automount,
199 };
200
201 static int debug_fill_super(struct super_block *sb, void *data, int silent)
202 {
203         static const struct tree_descr debug_files[] = {{""}};
204         struct debugfs_fs_info *fsi;
205         int err;
206
207         fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
208         sb->s_fs_info = fsi;
209         if (!fsi) {
210                 err = -ENOMEM;
211                 goto fail;
212         }
213
214         err = debugfs_parse_options(data, &fsi->mount_opts);
215         if (err)
216                 goto fail;
217
218         err  =  simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
219         if (err)
220                 goto fail;
221
222         sb->s_op = &debugfs_super_operations;
223         sb->s_d_op = &debugfs_dops;
224
225         debugfs_apply_options(sb);
226
227         return 0;
228
229 fail:
230         kfree(fsi);
231         sb->s_fs_info = NULL;
232         return err;
233 }
234
235 static struct dentry *debug_mount(struct file_system_type *fs_type,
236                         int flags, const char *dev_name,
237                         void *data)
238 {
239         return mount_single(fs_type, flags, data, debug_fill_super);
240 }
241
242 static struct file_system_type debug_fs_type = {
243         .owner =        THIS_MODULE,
244         .name =         "debugfs",
245         .mount =        debug_mount,
246         .kill_sb =      kill_litter_super,
247 };
248 MODULE_ALIAS_FS("debugfs");
249
250 /**
251  * debugfs_lookup() - look up an existing debugfs file
252  * @name: a pointer to a string containing the name of the file to look up.
253  * @parent: a pointer to the parent dentry of the file.
254  *
255  * This function will return a pointer to a dentry if it succeeds.  If the file
256  * doesn't exist or an error occurs, %NULL will be returned.  The returned
257  * dentry must be passed to dput() when it is no longer needed.
258  *
259  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
260  * returned.
261  */
262 struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
263 {
264         struct dentry *dentry;
265
266         if (IS_ERR(parent))
267                 return NULL;
268
269         if (!parent)
270                 parent = debugfs_mount->mnt_root;
271
272         dentry = lookup_one_len_unlocked(name, parent, strlen(name));
273         if (IS_ERR(dentry))
274                 return NULL;
275         if (!d_really_is_positive(dentry)) {
276                 dput(dentry);
277                 return NULL;
278         }
279         return dentry;
280 }
281 EXPORT_SYMBOL_GPL(debugfs_lookup);
282
283 static struct dentry *start_creating(const char *name, struct dentry *parent)
284 {
285         struct dentry *dentry;
286         int error;
287
288         pr_debug("debugfs: creating file '%s'\n",name);
289
290         if (IS_ERR(parent))
291                 return parent;
292
293         error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
294                               &debugfs_mount_count);
295         if (error)
296                 return ERR_PTR(error);
297
298         /* If the parent is not specified, we create it in the root.
299          * We need the root dentry to do this, which is in the super
300          * block. A pointer to that is in the struct vfsmount that we
301          * have around.
302          */
303         if (!parent)
304                 parent = debugfs_mount->mnt_root;
305
306         inode_lock(d_inode(parent));
307         dentry = lookup_one_len(name, parent, strlen(name));
308         if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
309                 dput(dentry);
310                 dentry = ERR_PTR(-EEXIST);
311         }
312
313         if (IS_ERR(dentry)) {
314                 inode_unlock(d_inode(parent));
315                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
316         }
317
318         return dentry;
319 }
320
321 static struct dentry *failed_creating(struct dentry *dentry)
322 {
323         inode_unlock(d_inode(dentry->d_parent));
324         dput(dentry);
325         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
326         return ERR_PTR(-ENOMEM);
327 }
328
329 static struct dentry *end_creating(struct dentry *dentry)
330 {
331         inode_unlock(d_inode(dentry->d_parent));
332         return dentry;
333 }
334
335 static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
336                                 struct dentry *parent, void *data,
337                                 const struct file_operations *proxy_fops,
338                                 const struct file_operations *real_fops)
339 {
340         struct dentry *dentry;
341         struct inode *inode;
342
343         if (!(mode & S_IFMT))
344                 mode |= S_IFREG;
345         BUG_ON(!S_ISREG(mode));
346         dentry = start_creating(name, parent);
347
348         if (IS_ERR(dentry))
349                 return dentry;
350
351         inode = debugfs_get_inode(dentry->d_sb);
352         if (unlikely(!inode))
353                 return failed_creating(dentry);
354
355         inode->i_mode = mode;
356         inode->i_private = data;
357
358         inode->i_fop = proxy_fops;
359         dentry->d_fsdata = (void *)((unsigned long)real_fops |
360                                 DEBUGFS_FSDATA_IS_REAL_FOPS_BIT);
361
362         d_instantiate(dentry, inode);
363         fsnotify_create(d_inode(dentry->d_parent), dentry);
364         return end_creating(dentry);
365 }
366
367 /**
368  * debugfs_create_file - create a file in the debugfs filesystem
369  * @name: a pointer to a string containing the name of the file to create.
370  * @mode: the permission that the file should have.
371  * @parent: a pointer to the parent dentry for this file.  This should be a
372  *          directory dentry if set.  If this parameter is NULL, then the
373  *          file will be created in the root of the debugfs filesystem.
374  * @data: a pointer to something that the caller will want to get to later
375  *        on.  The inode.i_private pointer will point to this value on
376  *        the open() call.
377  * @fops: a pointer to a struct file_operations that should be used for
378  *        this file.
379  *
380  * This is the basic "create a file" function for debugfs.  It allows for a
381  * wide range of flexibility in creating a file, or a directory (if you want
382  * to create a directory, the debugfs_create_dir() function is
383  * recommended to be used instead.)
384  *
385  * This function will return a pointer to a dentry if it succeeds.  This
386  * pointer must be passed to the debugfs_remove() function when the file is
387  * to be removed (no automatic cleanup happens if your module is unloaded,
388  * you are responsible here.)  If an error occurs, %ERR_PTR(-ERROR) will be
389  * returned.
390  *
391  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
392  * returned.
393  */
394 struct dentry *debugfs_create_file(const char *name, umode_t mode,
395                                    struct dentry *parent, void *data,
396                                    const struct file_operations *fops)
397 {
398
399         return __debugfs_create_file(name, mode, parent, data,
400                                 fops ? &debugfs_full_proxy_file_operations :
401                                         &debugfs_noop_file_operations,
402                                 fops);
403 }
404 EXPORT_SYMBOL_GPL(debugfs_create_file);
405
406 /**
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_file_get()
426  * and debugfs_file_put(). ->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  */
433 struct 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 }
443 EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
444
445 /**
446  * 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, %ERR_PTR(-ERROR) will be
468  * returned.
469  *
470  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
471  * returned.
472  */
473 struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
474                                         struct dentry *parent, void *data,
475                                         const struct file_operations *fops,
476                                         loff_t file_size)
477 {
478         struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
479
480         if (de)
481                 d_inode(de)->i_size = file_size;
482         return de;
483 }
484 EXPORT_SYMBOL_GPL(debugfs_create_file_size);
485
486 /**
487  * debugfs_create_dir - create a directory in the debugfs filesystem
488  * @name: a pointer to a string containing the name of the directory to
489  *        create.
490  * @parent: a pointer to the parent dentry for this file.  This should be a
491  *          directory dentry if set.  If this parameter is NULL, then the
492  *          directory will be created in the root of the debugfs filesystem.
493  *
494  * This function creates a directory in debugfs with the given name.
495  *
496  * This function will return a pointer to a dentry if it succeeds.  This
497  * pointer must be passed to the debugfs_remove() function when the file is
498  * to be removed (no automatic cleanup happens if your module is unloaded,
499  * you are responsible here.)  If an error occurs, %ERR_PTR(-ERROR) will be
500  * returned.
501  *
502  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
503  * returned.
504  */
505 struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
506 {
507         struct dentry *dentry = start_creating(name, parent);
508         struct inode *inode;
509
510         if (IS_ERR(dentry))
511                 return dentry;
512
513         inode = debugfs_get_inode(dentry->d_sb);
514         if (unlikely(!inode))
515                 return failed_creating(dentry);
516
517         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);
523         d_instantiate(dentry, inode);
524         inc_nlink(d_inode(dentry->d_parent));
525         fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
526         return end_creating(dentry);
527 }
528 EXPORT_SYMBOL_GPL(debugfs_create_dir);
529
530 /**
531  * 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  */
541 struct dentry *debugfs_create_automount(const char *name,
542                                         struct dentry *parent,
543                                         debugfs_automount_t f,
544                                         void *data)
545 {
546         struct dentry *dentry = start_creating(name, parent);
547         struct inode *inode;
548
549         if (IS_ERR(dentry))
550                 return dentry;
551
552         inode = debugfs_get_inode(dentry->d_sb);
553         if (unlikely(!inode))
554                 return failed_creating(dentry);
555
556         make_empty_dir_inode(inode);
557         inode->i_flags |= S_AUTOMOUNT;
558         inode->i_private = data;
559         dentry->d_fsdata = (void *)f;
560         /* directory inodes start off with i_nlink == 2 (for "." entry) */
561         inc_nlink(inode);
562         d_instantiate(dentry, inode);
563         inc_nlink(d_inode(dentry->d_parent));
564         fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
565         return end_creating(dentry);
566 }
567 EXPORT_SYMBOL(debugfs_create_automount);
568
569 /**
570  * 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
574  *          should be a directory dentry if set.  If this parameter is NULL,
575  *          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, %ERR_PTR(-ERROR)
587  * will be returned.
588  *
589  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
590  * returned.
591  */
592 struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
593                                       const char *target)
594 {
595         struct dentry *dentry;
596         struct inode *inode;
597         char *link = kstrdup(target, GFP_KERNEL);
598         if (!link)
599                 return ERR_PTR(-ENOMEM);
600
601         dentry = start_creating(name, parent);
602         if (IS_ERR(dentry)) {
603                 kfree(link);
604                 return dentry;
605         }
606
607         inode = debugfs_get_inode(dentry->d_sb);
608         if (unlikely(!inode)) {
609                 kfree(link);
610                 return failed_creating(dentry);
611         }
612         inode->i_mode = S_IFLNK | S_IRWXUGO;
613         inode->i_op = &simple_symlink_inode_operations;
614         inode->i_link = link;
615         d_instantiate(dentry, inode);
616         return end_creating(dentry);
617 }
618 EXPORT_SYMBOL_GPL(debugfs_create_symlink);
619
620 static void __debugfs_remove_file(struct dentry *dentry, struct dentry *parent)
621 {
622         struct debugfs_fsdata *fsd;
623
624         simple_unlink(d_inode(parent), dentry);
625         d_delete(dentry);
626
627         /*
628          * Paired with the closing smp_mb() implied by a successful
629          * cmpxchg() in debugfs_file_get(): either
630          * debugfs_file_get() must see a dead dentry or we must see a
631          * debugfs_fsdata instance at ->d_fsdata here (or both).
632          */
633         smp_mb();
634         fsd = READ_ONCE(dentry->d_fsdata);
635         if ((unsigned long)fsd & DEBUGFS_FSDATA_IS_REAL_FOPS_BIT)
636                 return;
637         if (!refcount_dec_and_test(&fsd->active_users))
638                 wait_for_completion(&fsd->active_users_drained);
639 }
640
641 static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
642 {
643         int ret = 0;
644
645         if (simple_positive(dentry)) {
646                 dget(dentry);
647                 if (!d_is_reg(dentry)) {
648                         if (d_is_dir(dentry))
649                                 ret = simple_rmdir(d_inode(parent), dentry);
650                         else
651                                 simple_unlink(d_inode(parent), dentry);
652                         if (!ret)
653                                 d_delete(dentry);
654                 } else {
655                         __debugfs_remove_file(dentry, parent);
656                 }
657                 dput(dentry);
658         }
659         return ret;
660 }
661
662 /**
663  * debugfs_remove - removes a file or directory from the debugfs filesystem
664  * @dentry: a pointer to a the dentry of the file or directory to be
665  *          removed.  If this parameter is NULL or an error value, nothing
666  *          will be done.
667  *
668  * This function removes a file or directory in debugfs that was previously
669  * created with a call to another debugfs function (like
670  * debugfs_create_file() or variants thereof.)
671  *
672  * This function is required to be called in order for the file to be
673  * removed, no automatic cleanup of files will happen when a module is
674  * removed, you are responsible here.
675  */
676 void debugfs_remove(struct dentry *dentry)
677 {
678         struct dentry *parent;
679         int ret;
680
681         if (IS_ERR_OR_NULL(dentry))
682                 return;
683
684         parent = dentry->d_parent;
685         inode_lock(d_inode(parent));
686         ret = __debugfs_remove(dentry, parent);
687         inode_unlock(d_inode(parent));
688         if (!ret)
689                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
690 }
691 EXPORT_SYMBOL_GPL(debugfs_remove);
692
693 /**
694  * debugfs_remove_recursive - recursively removes a directory
695  * @dentry: a pointer to a the dentry of the directory to be removed.  If this
696  *          parameter is NULL or an error value, nothing will be done.
697  *
698  * This function recursively removes a directory tree in debugfs that
699  * was previously created with a call to another debugfs function
700  * (like debugfs_create_file() or variants thereof.)
701  *
702  * This function is required to be called in order for the file to be
703  * removed, no automatic cleanup of files will happen when a module is
704  * removed, you are responsible here.
705  */
706 void debugfs_remove_recursive(struct dentry *dentry)
707 {
708         struct dentry *child, *parent;
709
710         if (IS_ERR_OR_NULL(dentry))
711                 return;
712
713         parent = dentry;
714  down:
715         inode_lock(d_inode(parent));
716  loop:
717         /*
718          * The parent->d_subdirs is protected by the d_lock. Outside that
719          * lock, the child can be unlinked and set to be freed which can
720          * use the d_u.d_child as the rcu head and corrupt this list.
721          */
722         spin_lock(&parent->d_lock);
723         list_for_each_entry(child, &parent->d_subdirs, d_child) {
724                 if (!simple_positive(child))
725                         continue;
726
727                 /* perhaps simple_empty(child) makes more sense */
728                 if (!list_empty(&child->d_subdirs)) {
729                         spin_unlock(&parent->d_lock);
730                         inode_unlock(d_inode(parent));
731                         parent = child;
732                         goto down;
733                 }
734
735                 spin_unlock(&parent->d_lock);
736
737                 if (!__debugfs_remove(child, parent))
738                         simple_release_fs(&debugfs_mount, &debugfs_mount_count);
739
740                 /*
741                  * The parent->d_lock protects agaist child from unlinking
742                  * from d_subdirs. When releasing the parent->d_lock we can
743                  * no longer trust that the next pointer is valid.
744                  * Restart the loop. We'll skip this one with the
745                  * simple_positive() check.
746                  */
747                 goto loop;
748         }
749         spin_unlock(&parent->d_lock);
750
751         inode_unlock(d_inode(parent));
752         child = parent;
753         parent = parent->d_parent;
754         inode_lock(d_inode(parent));
755
756         if (child != dentry)
757                 /* go up */
758                 goto loop;
759
760         if (!__debugfs_remove(child, parent))
761                 simple_release_fs(&debugfs_mount, &debugfs_mount_count);
762         inode_unlock(d_inode(parent));
763 }
764 EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
765
766 /**
767  * debugfs_rename - rename a file/directory in the debugfs filesystem
768  * @old_dir: a pointer to the parent dentry for the renamed object. This
769  *          should be a directory dentry.
770  * @old_dentry: dentry of an object to be renamed.
771  * @new_dir: a pointer to the parent dentry where the object should be
772  *          moved. This should be a directory dentry.
773  * @new_name: a pointer to a string containing the target name.
774  *
775  * This function renames a file/directory in debugfs.  The target must not
776  * exist for rename to succeed.
777  *
778  * This function will return a pointer to old_dentry (which is updated to
779  * reflect renaming) if it succeeds. If an error occurs, %NULL will be
780  * returned.
781  *
782  * If debugfs is not enabled in the kernel, the value -%ENODEV will be
783  * returned.
784  */
785 struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
786                 struct dentry *new_dir, const char *new_name)
787 {
788         int error;
789         struct dentry *dentry = NULL, *trap;
790         struct name_snapshot old_name;
791
792         if (IS_ERR(old_dir))
793                 return old_dir;
794         if (IS_ERR(new_dir))
795                 return new_dir;
796         if (IS_ERR_OR_NULL(old_dentry))
797                 return old_dentry;
798
799         trap = lock_rename(new_dir, old_dir);
800         /* Source or destination directories don't exist? */
801         if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
802                 goto exit;
803         /* Source does not exist, cyclic rename, or mountpoint? */
804         if (d_really_is_negative(old_dentry) || old_dentry == trap ||
805             d_mountpoint(old_dentry))
806                 goto exit;
807         dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
808         /* Lookup failed, cyclic rename or target exists? */
809         if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
810                 goto exit;
811
812         take_dentry_name_snapshot(&old_name, old_dentry);
813
814         error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
815                               dentry, 0);
816         if (error) {
817                 release_dentry_name_snapshot(&old_name);
818                 goto exit;
819         }
820         d_move(old_dentry, dentry);
821         fsnotify_move(d_inode(old_dir), d_inode(new_dir), &old_name.name,
822                 d_is_dir(old_dentry),
823                 NULL, old_dentry);
824         release_dentry_name_snapshot(&old_name);
825         unlock_rename(new_dir, old_dir);
826         dput(dentry);
827         return old_dentry;
828 exit:
829         if (dentry && !IS_ERR(dentry))
830                 dput(dentry);
831         unlock_rename(new_dir, old_dir);
832         if (IS_ERR(dentry))
833                 return dentry;
834         return ERR_PTR(-EINVAL);
835 }
836 EXPORT_SYMBOL_GPL(debugfs_rename);
837
838 /**
839  * debugfs_initialized - Tells whether debugfs has been registered
840  */
841 bool debugfs_initialized(void)
842 {
843         return debugfs_registered;
844 }
845 EXPORT_SYMBOL_GPL(debugfs_initialized);
846
847 static int __init debugfs_init(void)
848 {
849         int retval;
850
851         retval = sysfs_create_mount_point(kernel_kobj, "debug");
852         if (retval)
853                 return retval;
854
855         retval = register_filesystem(&debug_fs_type);
856         if (retval)
857                 sysfs_remove_mount_point(kernel_kobj, "debug");
858         else
859                 debugfs_registered = true;
860
861         return retval;
862 }
863 core_initcall(debugfs_init);
864