inode.c 23 KB

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