inode.c 24 KB

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