inode.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832
  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/core-api/kernel-api.rst 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 const struct tree_descr debug_files[] = {{""}};
  172. struct debugfs_fs_info *fsi;
  173. int err;
  174. fsi = kzalloc(sizeof(struct debugfs_fs_info), GFP_KERNEL);
  175. sb->s_fs_info = fsi;
  176. if (!fsi) {
  177. err = -ENOMEM;
  178. goto fail;
  179. }
  180. err = debugfs_parse_options(data, &fsi->mount_opts);
  181. if (err)
  182. goto fail;
  183. err = simple_fill_super(sb, DEBUGFS_MAGIC, debug_files);
  184. if (err)
  185. goto fail;
  186. sb->s_op = &debugfs_super_operations;
  187. sb->s_d_op = &debugfs_dops;
  188. debugfs_apply_options(sb);
  189. return 0;
  190. fail:
  191. kfree(fsi);
  192. sb->s_fs_info = NULL;
  193. return err;
  194. }
  195. static struct dentry *debug_mount(struct file_system_type *fs_type,
  196. int flags, const char *dev_name,
  197. void *data)
  198. {
  199. return mount_single(fs_type, flags, data, debug_fill_super);
  200. }
  201. static struct file_system_type debug_fs_type = {
  202. .owner = THIS_MODULE,
  203. .name = "debugfs",
  204. .mount = debug_mount,
  205. .kill_sb = kill_litter_super,
  206. };
  207. MODULE_ALIAS_FS("debugfs");
  208. /**
  209. * debugfs_lookup() - look up an existing debugfs file
  210. * @name: a pointer to a string containing the name of the file to look up.
  211. * @parent: a pointer to the parent dentry of the file.
  212. *
  213. * This function will return a pointer to a dentry if it succeeds. If the file
  214. * doesn't exist or an error occurs, %NULL will be returned. The returned
  215. * dentry must be passed to dput() when it is no longer needed.
  216. *
  217. * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  218. * returned.
  219. */
  220. struct dentry *debugfs_lookup(const char *name, struct dentry *parent)
  221. {
  222. struct dentry *dentry;
  223. if (IS_ERR(parent))
  224. return NULL;
  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. inode_unlock(d_inode(parent));
  230. if (IS_ERR(dentry))
  231. return NULL;
  232. if (!d_really_is_positive(dentry)) {
  233. dput(dentry);
  234. return NULL;
  235. }
  236. return dentry;
  237. }
  238. EXPORT_SYMBOL_GPL(debugfs_lookup);
  239. static struct dentry *start_creating(const char *name, struct dentry *parent)
  240. {
  241. struct dentry *dentry;
  242. int error;
  243. pr_debug("debugfs: creating file '%s'\n",name);
  244. if (IS_ERR(parent))
  245. return parent;
  246. error = simple_pin_fs(&debug_fs_type, &debugfs_mount,
  247. &debugfs_mount_count);
  248. if (error)
  249. return ERR_PTR(error);
  250. /* If the parent is not specified, we create it in the root.
  251. * We need the root dentry to do this, which is in the super
  252. * block. A pointer to that is in the struct vfsmount that we
  253. * have around.
  254. */
  255. if (!parent)
  256. parent = debugfs_mount->mnt_root;
  257. inode_lock(d_inode(parent));
  258. dentry = lookup_one_len(name, parent, strlen(name));
  259. if (!IS_ERR(dentry) && d_really_is_positive(dentry)) {
  260. dput(dentry);
  261. dentry = ERR_PTR(-EEXIST);
  262. }
  263. if (IS_ERR(dentry)) {
  264. inode_unlock(d_inode(parent));
  265. simple_release_fs(&debugfs_mount, &debugfs_mount_count);
  266. }
  267. return dentry;
  268. }
  269. static struct dentry *failed_creating(struct dentry *dentry)
  270. {
  271. inode_unlock(d_inode(dentry->d_parent));
  272. dput(dentry);
  273. simple_release_fs(&debugfs_mount, &debugfs_mount_count);
  274. return NULL;
  275. }
  276. static struct dentry *end_creating(struct dentry *dentry)
  277. {
  278. inode_unlock(d_inode(dentry->d_parent));
  279. return dentry;
  280. }
  281. static struct dentry *__debugfs_create_file(const char *name, umode_t mode,
  282. struct dentry *parent, void *data,
  283. const struct file_operations *proxy_fops,
  284. const struct file_operations *real_fops)
  285. {
  286. struct dentry *dentry;
  287. struct inode *inode;
  288. if (!(mode & S_IFMT))
  289. mode |= S_IFREG;
  290. BUG_ON(!S_ISREG(mode));
  291. dentry = start_creating(name, parent);
  292. if (IS_ERR(dentry))
  293. return NULL;
  294. inode = debugfs_get_inode(dentry->d_sb);
  295. if (unlikely(!inode))
  296. return failed_creating(dentry);
  297. inode->i_mode = mode;
  298. inode->i_private = data;
  299. inode->i_fop = proxy_fops;
  300. dentry->d_fsdata = (void *)real_fops;
  301. d_instantiate(dentry, inode);
  302. fsnotify_create(d_inode(dentry->d_parent), dentry);
  303. return end_creating(dentry);
  304. }
  305. /**
  306. * debugfs_create_file - create a file in the debugfs filesystem
  307. * @name: a pointer to a string containing the name of the file to create.
  308. * @mode: the permission that the file should have.
  309. * @parent: a pointer to the parent dentry for this file. This should be a
  310. * directory dentry if set. If this parameter is NULL, then the
  311. * file will be created in the root of the debugfs filesystem.
  312. * @data: a pointer to something that the caller will want to get to later
  313. * on. The inode.i_private pointer will point to this value on
  314. * the open() call.
  315. * @fops: a pointer to a struct file_operations that should be used for
  316. * this file.
  317. *
  318. * This is the basic "create a file" function for debugfs. It allows for a
  319. * wide range of flexibility in creating a file, or a directory (if you want
  320. * to create a directory, the debugfs_create_dir() function is
  321. * recommended to be used instead.)
  322. *
  323. * This function will return a pointer to a dentry if it succeeds. This
  324. * pointer must be passed to the debugfs_remove() function when the file is
  325. * to be removed (no automatic cleanup happens if your module is unloaded,
  326. * you are responsible here.) If an error occurs, %NULL will be returned.
  327. *
  328. * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  329. * returned.
  330. */
  331. struct dentry *debugfs_create_file(const char *name, umode_t mode,
  332. struct dentry *parent, void *data,
  333. const struct file_operations *fops)
  334. {
  335. return __debugfs_create_file(name, mode, parent, data,
  336. fops ? &debugfs_full_proxy_file_operations :
  337. &debugfs_noop_file_operations,
  338. fops);
  339. }
  340. EXPORT_SYMBOL_GPL(debugfs_create_file);
  341. /**
  342. * debugfs_create_file_unsafe - create a file in the debugfs filesystem
  343. * @name: a pointer to a string containing the name of the file to create.
  344. * @mode: the permission that the file should have.
  345. * @parent: a pointer to the parent dentry for this file. This should be a
  346. * directory dentry if set. If this parameter is NULL, then the
  347. * file will be created in the root of the debugfs filesystem.
  348. * @data: a pointer to something that the caller will want to get to later
  349. * on. The inode.i_private pointer will point to this value on
  350. * the open() call.
  351. * @fops: a pointer to a struct file_operations that should be used for
  352. * this file.
  353. *
  354. * debugfs_create_file_unsafe() is completely analogous to
  355. * debugfs_create_file(), the only difference being that the fops
  356. * handed it will not get protected against file removals by the
  357. * debugfs core.
  358. *
  359. * It is your responsibility to protect your struct file_operation
  360. * methods against file removals by means of debugfs_use_file_start()
  361. * and debugfs_use_file_finish(). ->open() is still protected by
  362. * debugfs though.
  363. *
  364. * Any struct file_operations defined by means of
  365. * DEFINE_DEBUGFS_ATTRIBUTE() is protected against file removals and
  366. * thus, may be used here.
  367. */
  368. struct dentry *debugfs_create_file_unsafe(const char *name, umode_t mode,
  369. struct dentry *parent, void *data,
  370. const struct file_operations *fops)
  371. {
  372. return __debugfs_create_file(name, mode, parent, data,
  373. fops ? &debugfs_open_proxy_file_operations :
  374. &debugfs_noop_file_operations,
  375. fops);
  376. }
  377. EXPORT_SYMBOL_GPL(debugfs_create_file_unsafe);
  378. /**
  379. * debugfs_create_file_size - create a file in the debugfs filesystem
  380. * @name: a pointer to a string containing the name of the file to create.
  381. * @mode: the permission that the file should have.
  382. * @parent: a pointer to the parent dentry for this file. This should be a
  383. * directory dentry if set. If this parameter is NULL, then the
  384. * file will be created in the root of the debugfs filesystem.
  385. * @data: a pointer to something that the caller will want to get to later
  386. * on. The inode.i_private pointer will point to this value on
  387. * the open() call.
  388. * @fops: a pointer to a struct file_operations that should be used for
  389. * this file.
  390. * @file_size: initial file size
  391. *
  392. * This is the basic "create a file" function for debugfs. It allows for a
  393. * wide range of flexibility in creating a file, or a directory (if you want
  394. * to create a directory, the debugfs_create_dir() function is
  395. * recommended to be used instead.)
  396. *
  397. * This function will return a pointer to a dentry if it succeeds. This
  398. * pointer must be passed to the debugfs_remove() function when the file is
  399. * to be removed (no automatic cleanup happens if your module is unloaded,
  400. * you are responsible here.) If an error occurs, %NULL will be returned.
  401. *
  402. * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  403. * returned.
  404. */
  405. struct dentry *debugfs_create_file_size(const char *name, umode_t mode,
  406. struct dentry *parent, void *data,
  407. const struct file_operations *fops,
  408. loff_t file_size)
  409. {
  410. struct dentry *de = debugfs_create_file(name, mode, parent, data, fops);
  411. if (de)
  412. d_inode(de)->i_size = file_size;
  413. return de;
  414. }
  415. EXPORT_SYMBOL_GPL(debugfs_create_file_size);
  416. /**
  417. * debugfs_create_dir - create a directory in the debugfs filesystem
  418. * @name: a pointer to a string containing the name of the directory to
  419. * create.
  420. * @parent: a pointer to the parent dentry for this file. This should be a
  421. * directory dentry if set. If this parameter is NULL, then the
  422. * directory will be created in the root of the debugfs filesystem.
  423. *
  424. * This function creates a directory in debugfs with the given name.
  425. *
  426. * This function will return a pointer to a dentry if it succeeds. This
  427. * pointer must be passed to the debugfs_remove() function when the file is
  428. * to be removed (no automatic cleanup happens if your module is unloaded,
  429. * you are responsible here.) If an error occurs, %NULL will be returned.
  430. *
  431. * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  432. * returned.
  433. */
  434. struct dentry *debugfs_create_dir(const char *name, struct dentry *parent)
  435. {
  436. struct dentry *dentry = start_creating(name, parent);
  437. struct inode *inode;
  438. if (IS_ERR(dentry))
  439. return NULL;
  440. inode = debugfs_get_inode(dentry->d_sb);
  441. if (unlikely(!inode))
  442. return failed_creating(dentry);
  443. inode->i_mode = S_IFDIR | S_IRWXU | S_IRUGO | S_IXUGO;
  444. inode->i_op = &simple_dir_inode_operations;
  445. inode->i_fop = &simple_dir_operations;
  446. /* directory inodes start off with i_nlink == 2 (for "." entry) */
  447. inc_nlink(inode);
  448. d_instantiate(dentry, inode);
  449. inc_nlink(d_inode(dentry->d_parent));
  450. fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
  451. return end_creating(dentry);
  452. }
  453. EXPORT_SYMBOL_GPL(debugfs_create_dir);
  454. /**
  455. * debugfs_create_automount - create automount point in the debugfs filesystem
  456. * @name: a pointer to a string containing the name of the file to create.
  457. * @parent: a pointer to the parent dentry for this file. This should be a
  458. * directory dentry if set. If this parameter is NULL, then the
  459. * file will be created in the root of the debugfs filesystem.
  460. * @f: function to be called when pathname resolution steps on that one.
  461. * @data: opaque argument to pass to f().
  462. *
  463. * @f should return what ->d_automount() would.
  464. */
  465. struct dentry *debugfs_create_automount(const char *name,
  466. struct dentry *parent,
  467. debugfs_automount_t f,
  468. void *data)
  469. {
  470. struct dentry *dentry = start_creating(name, parent);
  471. struct inode *inode;
  472. if (IS_ERR(dentry))
  473. return NULL;
  474. inode = debugfs_get_inode(dentry->d_sb);
  475. if (unlikely(!inode))
  476. return failed_creating(dentry);
  477. make_empty_dir_inode(inode);
  478. inode->i_flags |= S_AUTOMOUNT;
  479. inode->i_private = data;
  480. dentry->d_fsdata = (void *)f;
  481. /* directory inodes start off with i_nlink == 2 (for "." entry) */
  482. inc_nlink(inode);
  483. d_instantiate(dentry, inode);
  484. inc_nlink(d_inode(dentry->d_parent));
  485. fsnotify_mkdir(d_inode(dentry->d_parent), dentry);
  486. return end_creating(dentry);
  487. }
  488. EXPORT_SYMBOL(debugfs_create_automount);
  489. /**
  490. * debugfs_create_symlink- create a symbolic link in the debugfs filesystem
  491. * @name: a pointer to a string containing the name of the symbolic link to
  492. * create.
  493. * @parent: a pointer to the parent dentry for this symbolic link. This
  494. * should be a directory dentry if set. If this parameter is NULL,
  495. * then the symbolic link will be created in the root of the debugfs
  496. * filesystem.
  497. * @target: a pointer to a string containing the path to the target of the
  498. * symbolic link.
  499. *
  500. * This function creates a symbolic link with the given name in debugfs that
  501. * links to the given target path.
  502. *
  503. * This function will return a pointer to a dentry if it succeeds. This
  504. * pointer must be passed to the debugfs_remove() function when the symbolic
  505. * link is to be removed (no automatic cleanup happens if your module is
  506. * unloaded, you are responsible here.) If an error occurs, %NULL will be
  507. * returned.
  508. *
  509. * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  510. * returned.
  511. */
  512. struct dentry *debugfs_create_symlink(const char *name, struct dentry *parent,
  513. const char *target)
  514. {
  515. struct dentry *dentry;
  516. struct inode *inode;
  517. char *link = kstrdup(target, GFP_KERNEL);
  518. if (!link)
  519. return NULL;
  520. dentry = start_creating(name, parent);
  521. if (IS_ERR(dentry)) {
  522. kfree(link);
  523. return NULL;
  524. }
  525. inode = debugfs_get_inode(dentry->d_sb);
  526. if (unlikely(!inode)) {
  527. kfree(link);
  528. return failed_creating(dentry);
  529. }
  530. inode->i_mode = S_IFLNK | S_IRWXUGO;
  531. inode->i_op = &simple_symlink_inode_operations;
  532. inode->i_link = link;
  533. d_instantiate(dentry, inode);
  534. return end_creating(dentry);
  535. }
  536. EXPORT_SYMBOL_GPL(debugfs_create_symlink);
  537. static int __debugfs_remove(struct dentry *dentry, struct dentry *parent)
  538. {
  539. int ret = 0;
  540. if (simple_positive(dentry)) {
  541. dget(dentry);
  542. if (d_is_dir(dentry))
  543. ret = simple_rmdir(d_inode(parent), dentry);
  544. else
  545. simple_unlink(d_inode(parent), dentry);
  546. if (!ret)
  547. d_delete(dentry);
  548. dput(dentry);
  549. }
  550. return ret;
  551. }
  552. /**
  553. * debugfs_remove - removes a file or directory from the debugfs filesystem
  554. * @dentry: a pointer to a the dentry of the file or directory to be
  555. * removed. If this parameter is NULL or an error value, nothing
  556. * will be done.
  557. *
  558. * This function removes a file or directory in debugfs that was previously
  559. * created with a call to another debugfs function (like
  560. * debugfs_create_file() or variants thereof.)
  561. *
  562. * This function is required to be called in order for the file to be
  563. * removed, no automatic cleanup of files will happen when a module is
  564. * removed, you are responsible here.
  565. */
  566. void debugfs_remove(struct dentry *dentry)
  567. {
  568. struct dentry *parent;
  569. int ret;
  570. if (IS_ERR_OR_NULL(dentry))
  571. return;
  572. parent = dentry->d_parent;
  573. inode_lock(d_inode(parent));
  574. ret = __debugfs_remove(dentry, parent);
  575. inode_unlock(d_inode(parent));
  576. if (!ret)
  577. simple_release_fs(&debugfs_mount, &debugfs_mount_count);
  578. synchronize_srcu(&debugfs_srcu);
  579. }
  580. EXPORT_SYMBOL_GPL(debugfs_remove);
  581. /**
  582. * debugfs_remove_recursive - recursively removes a directory
  583. * @dentry: a pointer to a the dentry of the directory to be removed. If this
  584. * parameter is NULL or an error value, nothing will be done.
  585. *
  586. * This function recursively removes a directory tree in debugfs that
  587. * was previously created with a call to another debugfs function
  588. * (like debugfs_create_file() or variants thereof.)
  589. *
  590. * This function is required to be called in order for the file to be
  591. * removed, no automatic cleanup of files will happen when a module is
  592. * removed, you are responsible here.
  593. */
  594. void debugfs_remove_recursive(struct dentry *dentry)
  595. {
  596. struct dentry *child, *parent;
  597. if (IS_ERR_OR_NULL(dentry))
  598. return;
  599. parent = dentry;
  600. down:
  601. inode_lock(d_inode(parent));
  602. loop:
  603. /*
  604. * The parent->d_subdirs is protected by the d_lock. Outside that
  605. * lock, the child can be unlinked and set to be freed which can
  606. * use the d_u.d_child as the rcu head and corrupt this list.
  607. */
  608. spin_lock(&parent->d_lock);
  609. list_for_each_entry(child, &parent->d_subdirs, d_child) {
  610. if (!simple_positive(child))
  611. continue;
  612. /* perhaps simple_empty(child) makes more sense */
  613. if (!list_empty(&child->d_subdirs)) {
  614. spin_unlock(&parent->d_lock);
  615. inode_unlock(d_inode(parent));
  616. parent = child;
  617. goto down;
  618. }
  619. spin_unlock(&parent->d_lock);
  620. if (!__debugfs_remove(child, parent))
  621. simple_release_fs(&debugfs_mount, &debugfs_mount_count);
  622. /*
  623. * The parent->d_lock protects agaist child from unlinking
  624. * from d_subdirs. When releasing the parent->d_lock we can
  625. * no longer trust that the next pointer is valid.
  626. * Restart the loop. We'll skip this one with the
  627. * simple_positive() check.
  628. */
  629. goto loop;
  630. }
  631. spin_unlock(&parent->d_lock);
  632. inode_unlock(d_inode(parent));
  633. child = parent;
  634. parent = parent->d_parent;
  635. inode_lock(d_inode(parent));
  636. if (child != dentry)
  637. /* go up */
  638. goto loop;
  639. if (!__debugfs_remove(child, parent))
  640. simple_release_fs(&debugfs_mount, &debugfs_mount_count);
  641. inode_unlock(d_inode(parent));
  642. synchronize_srcu(&debugfs_srcu);
  643. }
  644. EXPORT_SYMBOL_GPL(debugfs_remove_recursive);
  645. /**
  646. * debugfs_rename - rename a file/directory in the debugfs filesystem
  647. * @old_dir: a pointer to the parent dentry for the renamed object. This
  648. * should be a directory dentry.
  649. * @old_dentry: dentry of an object to be renamed.
  650. * @new_dir: a pointer to the parent dentry where the object should be
  651. * moved. This should be a directory dentry.
  652. * @new_name: a pointer to a string containing the target name.
  653. *
  654. * This function renames a file/directory in debugfs. The target must not
  655. * exist for rename to succeed.
  656. *
  657. * This function will return a pointer to old_dentry (which is updated to
  658. * reflect renaming) if it succeeds. If an error occurs, %NULL will be
  659. * returned.
  660. *
  661. * If debugfs is not enabled in the kernel, the value -%ENODEV will be
  662. * returned.
  663. */
  664. struct dentry *debugfs_rename(struct dentry *old_dir, struct dentry *old_dentry,
  665. struct dentry *new_dir, const char *new_name)
  666. {
  667. int error;
  668. struct dentry *dentry = NULL, *trap;
  669. struct name_snapshot old_name;
  670. trap = lock_rename(new_dir, old_dir);
  671. /* Source or destination directories don't exist? */
  672. if (d_really_is_negative(old_dir) || d_really_is_negative(new_dir))
  673. goto exit;
  674. /* Source does not exist, cyclic rename, or mountpoint? */
  675. if (d_really_is_negative(old_dentry) || old_dentry == trap ||
  676. d_mountpoint(old_dentry))
  677. goto exit;
  678. dentry = lookup_one_len(new_name, new_dir, strlen(new_name));
  679. /* Lookup failed, cyclic rename or target exists? */
  680. if (IS_ERR(dentry) || dentry == trap || d_really_is_positive(dentry))
  681. goto exit;
  682. take_dentry_name_snapshot(&old_name, old_dentry);
  683. error = simple_rename(d_inode(old_dir), old_dentry, d_inode(new_dir),
  684. dentry, 0);
  685. if (error) {
  686. release_dentry_name_snapshot(&old_name);
  687. goto exit;
  688. }
  689. d_move(old_dentry, dentry);
  690. fsnotify_move(d_inode(old_dir), d_inode(new_dir), old_name.name,
  691. d_is_dir(old_dentry),
  692. NULL, old_dentry);
  693. release_dentry_name_snapshot(&old_name);
  694. unlock_rename(new_dir, old_dir);
  695. dput(dentry);
  696. return old_dentry;
  697. exit:
  698. if (dentry && !IS_ERR(dentry))
  699. dput(dentry);
  700. unlock_rename(new_dir, old_dir);
  701. return NULL;
  702. }
  703. EXPORT_SYMBOL_GPL(debugfs_rename);
  704. /**
  705. * debugfs_initialized - Tells whether debugfs has been registered
  706. */
  707. bool debugfs_initialized(void)
  708. {
  709. return debugfs_registered;
  710. }
  711. EXPORT_SYMBOL_GPL(debugfs_initialized);
  712. static int __init debugfs_init(void)
  713. {
  714. int retval;
  715. retval = sysfs_create_mount_point(kernel_kobj, "debug");
  716. if (retval)
  717. return retval;
  718. retval = register_filesystem(&debug_fs_type);
  719. if (retval)
  720. sysfs_remove_mount_point(kernel_kobj, "debug");
  721. else
  722. debugfs_registered = true;
  723. return retval;
  724. }
  725. core_initcall(debugfs_init);