file.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967
  1. /*
  2. * fs/kernfs/file.c - kernfs file implementation
  3. *
  4. * Copyright (c) 2001-3 Patrick Mochel
  5. * Copyright (c) 2007 SUSE Linux Products GmbH
  6. * Copyright (c) 2007, 2013 Tejun Heo <tj@kernel.org>
  7. *
  8. * This file is released under the GPLv2.
  9. */
  10. #include <linux/fs.h>
  11. #include <linux/seq_file.h>
  12. #include <linux/slab.h>
  13. #include <linux/poll.h>
  14. #include <linux/pagemap.h>
  15. #include <linux/sched.h>
  16. #include <linux/fsnotify.h>
  17. #include "kernfs-internal.h"
  18. /*
  19. * There's one kernfs_open_file for each open file and one kernfs_open_node
  20. * for each kernfs_node with one or more open files.
  21. *
  22. * kernfs_node->attr.open points to kernfs_open_node. attr.open is
  23. * protected by kernfs_open_node_lock.
  24. *
  25. * filp->private_data points to seq_file whose ->private points to
  26. * kernfs_open_file. kernfs_open_files are chained at
  27. * kernfs_open_node->files, which is protected by kernfs_open_file_mutex.
  28. */
  29. static DEFINE_SPINLOCK(kernfs_open_node_lock);
  30. static DEFINE_MUTEX(kernfs_open_file_mutex);
  31. struct kernfs_open_node {
  32. atomic_t refcnt;
  33. atomic_t event;
  34. wait_queue_head_t poll;
  35. struct list_head files; /* goes through kernfs_open_file.list */
  36. };
  37. /*
  38. * kernfs_notify() may be called from any context and bounces notifications
  39. * through a work item. To minimize space overhead in kernfs_node, the
  40. * pending queue is implemented as a singly linked list of kernfs_nodes.
  41. * The list is terminated with the self pointer so that whether a
  42. * kernfs_node is on the list or not can be determined by testing the next
  43. * pointer for NULL.
  44. */
  45. #define KERNFS_NOTIFY_EOL ((void *)&kernfs_notify_list)
  46. static DEFINE_SPINLOCK(kernfs_notify_lock);
  47. static struct kernfs_node *kernfs_notify_list = KERNFS_NOTIFY_EOL;
  48. static struct kernfs_open_file *kernfs_of(struct file *file)
  49. {
  50. return ((struct seq_file *)file->private_data)->private;
  51. }
  52. /*
  53. * Determine the kernfs_ops for the given kernfs_node. This function must
  54. * be called while holding an active reference.
  55. */
  56. static const struct kernfs_ops *kernfs_ops(struct kernfs_node *kn)
  57. {
  58. if (kn->flags & KERNFS_LOCKDEP)
  59. lockdep_assert_held(kn);
  60. return kn->attr.ops;
  61. }
  62. /*
  63. * As kernfs_seq_stop() is also called after kernfs_seq_start() or
  64. * kernfs_seq_next() failure, it needs to distinguish whether it's stopping
  65. * a seq_file iteration which is fully initialized with an active reference
  66. * or an aborted kernfs_seq_start() due to get_active failure. The
  67. * position pointer is the only context for each seq_file iteration and
  68. * thus the stop condition should be encoded in it. As the return value is
  69. * directly visible to userland, ERR_PTR(-ENODEV) is the only acceptable
  70. * choice to indicate get_active failure.
  71. *
  72. * Unfortunately, this is complicated due to the optional custom seq_file
  73. * operations which may return ERR_PTR(-ENODEV) too. kernfs_seq_stop()
  74. * can't distinguish whether ERR_PTR(-ENODEV) is from get_active failure or
  75. * custom seq_file operations and thus can't decide whether put_active
  76. * should be performed or not only on ERR_PTR(-ENODEV).
  77. *
  78. * This is worked around by factoring out the custom seq_stop() and
  79. * put_active part into kernfs_seq_stop_active(), skipping it from
  80. * kernfs_seq_stop() if ERR_PTR(-ENODEV) while invoking it directly after
  81. * custom seq_file operations fail with ERR_PTR(-ENODEV) - this ensures
  82. * that kernfs_seq_stop_active() is skipped only after get_active failure.
  83. */
  84. static void kernfs_seq_stop_active(struct seq_file *sf, void *v)
  85. {
  86. struct kernfs_open_file *of = sf->private;
  87. const struct kernfs_ops *ops = kernfs_ops(of->kn);
  88. if (ops->seq_stop)
  89. ops->seq_stop(sf, v);
  90. kernfs_put_active(of->kn);
  91. }
  92. static void *kernfs_seq_start(struct seq_file *sf, loff_t *ppos)
  93. {
  94. struct kernfs_open_file *of = sf->private;
  95. const struct kernfs_ops *ops;
  96. /*
  97. * @of->mutex nests outside active ref and is primarily to ensure that
  98. * the ops aren't called concurrently for the same open file.
  99. */
  100. mutex_lock(&of->mutex);
  101. if (!kernfs_get_active(of->kn))
  102. return ERR_PTR(-ENODEV);
  103. ops = kernfs_ops(of->kn);
  104. if (ops->seq_start) {
  105. void *next = ops->seq_start(sf, ppos);
  106. /* see the comment above kernfs_seq_stop_active() */
  107. if (next == ERR_PTR(-ENODEV))
  108. kernfs_seq_stop_active(sf, next);
  109. return next;
  110. } else {
  111. /*
  112. * The same behavior and code as single_open(). Returns
  113. * !NULL if pos is at the beginning; otherwise, NULL.
  114. */
  115. return NULL + !*ppos;
  116. }
  117. }
  118. static void *kernfs_seq_next(struct seq_file *sf, void *v, loff_t *ppos)
  119. {
  120. struct kernfs_open_file *of = sf->private;
  121. const struct kernfs_ops *ops = kernfs_ops(of->kn);
  122. if (ops->seq_next) {
  123. void *next = ops->seq_next(sf, v, ppos);
  124. /* see the comment above kernfs_seq_stop_active() */
  125. if (next == ERR_PTR(-ENODEV))
  126. kernfs_seq_stop_active(sf, next);
  127. return next;
  128. } else {
  129. /*
  130. * The same behavior and code as single_open(), always
  131. * terminate after the initial read.
  132. */
  133. ++*ppos;
  134. return NULL;
  135. }
  136. }
  137. static void kernfs_seq_stop(struct seq_file *sf, void *v)
  138. {
  139. struct kernfs_open_file *of = sf->private;
  140. if (v != ERR_PTR(-ENODEV))
  141. kernfs_seq_stop_active(sf, v);
  142. mutex_unlock(&of->mutex);
  143. }
  144. static int kernfs_seq_show(struct seq_file *sf, void *v)
  145. {
  146. struct kernfs_open_file *of = sf->private;
  147. of->event = atomic_read(&of->kn->attr.open->event);
  148. return of->kn->attr.ops->seq_show(sf, v);
  149. }
  150. static const struct seq_operations kernfs_seq_ops = {
  151. .start = kernfs_seq_start,
  152. .next = kernfs_seq_next,
  153. .stop = kernfs_seq_stop,
  154. .show = kernfs_seq_show,
  155. };
  156. /*
  157. * As reading a bin file can have side-effects, the exact offset and bytes
  158. * specified in read(2) call should be passed to the read callback making
  159. * it difficult to use seq_file. Implement simplistic custom buffering for
  160. * bin files.
  161. */
  162. static ssize_t kernfs_file_direct_read(struct kernfs_open_file *of,
  163. char __user *user_buf, size_t count,
  164. loff_t *ppos)
  165. {
  166. ssize_t len = min_t(size_t, count, PAGE_SIZE);
  167. const struct kernfs_ops *ops;
  168. char *buf;
  169. buf = kmalloc(len, GFP_KERNEL);
  170. if (!buf)
  171. return -ENOMEM;
  172. /*
  173. * @of->mutex nests outside active ref and is primarily to ensure that
  174. * the ops aren't called concurrently for the same open file.
  175. */
  176. mutex_lock(&of->mutex);
  177. if (!kernfs_get_active(of->kn)) {
  178. len = -ENODEV;
  179. mutex_unlock(&of->mutex);
  180. goto out_free;
  181. }
  182. ops = kernfs_ops(of->kn);
  183. if (ops->read)
  184. len = ops->read(of, buf, len, *ppos);
  185. else
  186. len = -EINVAL;
  187. kernfs_put_active(of->kn);
  188. mutex_unlock(&of->mutex);
  189. if (len < 0)
  190. goto out_free;
  191. if (copy_to_user(user_buf, buf, len)) {
  192. len = -EFAULT;
  193. goto out_free;
  194. }
  195. *ppos += len;
  196. out_free:
  197. kfree(buf);
  198. return len;
  199. }
  200. /**
  201. * kernfs_fop_read - kernfs vfs read callback
  202. * @file: file pointer
  203. * @user_buf: data to write
  204. * @count: number of bytes
  205. * @ppos: starting offset
  206. */
  207. static ssize_t kernfs_fop_read(struct file *file, char __user *user_buf,
  208. size_t count, loff_t *ppos)
  209. {
  210. struct kernfs_open_file *of = kernfs_of(file);
  211. if (of->kn->flags & KERNFS_HAS_SEQ_SHOW)
  212. return seq_read(file, user_buf, count, ppos);
  213. else
  214. return kernfs_file_direct_read(of, user_buf, count, ppos);
  215. }
  216. /**
  217. * kernfs_fop_write - kernfs vfs write callback
  218. * @file: file pointer
  219. * @user_buf: data to write
  220. * @count: number of bytes
  221. * @ppos: starting offset
  222. *
  223. * Copy data in from userland and pass it to the matching kernfs write
  224. * operation.
  225. *
  226. * There is no easy way for us to know if userspace is only doing a partial
  227. * write, so we don't support them. We expect the entire buffer to come on
  228. * the first write. Hint: if you're writing a value, first read the file,
  229. * modify only the the value you're changing, then write entire buffer
  230. * back.
  231. */
  232. static ssize_t kernfs_fop_write(struct file *file, const char __user *user_buf,
  233. size_t count, loff_t *ppos)
  234. {
  235. struct kernfs_open_file *of = kernfs_of(file);
  236. const struct kernfs_ops *ops;
  237. size_t len;
  238. char *buf;
  239. if (of->atomic_write_len) {
  240. len = count;
  241. if (len > of->atomic_write_len)
  242. return -E2BIG;
  243. } else {
  244. len = min_t(size_t, count, PAGE_SIZE);
  245. }
  246. buf = of->prealloc_buf;
  247. if (!buf)
  248. buf = kmalloc(len + 1, GFP_KERNEL);
  249. if (!buf)
  250. return -ENOMEM;
  251. /*
  252. * @of->mutex nests outside active ref and is used both to ensure that
  253. * the ops aren't called concurrently for the same open file, and
  254. * to provide exclusive access to ->prealloc_buf (when that exists).
  255. */
  256. mutex_lock(&of->mutex);
  257. if (!kernfs_get_active(of->kn)) {
  258. mutex_unlock(&of->mutex);
  259. len = -ENODEV;
  260. goto out_free;
  261. }
  262. if (copy_from_user(buf, user_buf, len)) {
  263. len = -EFAULT;
  264. goto out_unlock;
  265. }
  266. buf[len] = '\0'; /* guarantee string termination */
  267. ops = kernfs_ops(of->kn);
  268. if (ops->write)
  269. len = ops->write(of, buf, len, *ppos);
  270. else
  271. len = -EINVAL;
  272. if (len > 0)
  273. *ppos += len;
  274. out_unlock:
  275. kernfs_put_active(of->kn);
  276. mutex_unlock(&of->mutex);
  277. out_free:
  278. if (buf != of->prealloc_buf)
  279. kfree(buf);
  280. return len;
  281. }
  282. static void kernfs_vma_open(struct vm_area_struct *vma)
  283. {
  284. struct file *file = vma->vm_file;
  285. struct kernfs_open_file *of = kernfs_of(file);
  286. if (!of->vm_ops)
  287. return;
  288. if (!kernfs_get_active(of->kn))
  289. return;
  290. if (of->vm_ops->open)
  291. of->vm_ops->open(vma);
  292. kernfs_put_active(of->kn);
  293. }
  294. static int kernfs_vma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
  295. {
  296. struct file *file = vma->vm_file;
  297. struct kernfs_open_file *of = kernfs_of(file);
  298. int ret;
  299. if (!of->vm_ops)
  300. return VM_FAULT_SIGBUS;
  301. if (!kernfs_get_active(of->kn))
  302. return VM_FAULT_SIGBUS;
  303. ret = VM_FAULT_SIGBUS;
  304. if (of->vm_ops->fault)
  305. ret = of->vm_ops->fault(vma, vmf);
  306. kernfs_put_active(of->kn);
  307. return ret;
  308. }
  309. static int kernfs_vma_page_mkwrite(struct vm_area_struct *vma,
  310. struct vm_fault *vmf)
  311. {
  312. struct file *file = vma->vm_file;
  313. struct kernfs_open_file *of = kernfs_of(file);
  314. int ret;
  315. if (!of->vm_ops)
  316. return VM_FAULT_SIGBUS;
  317. if (!kernfs_get_active(of->kn))
  318. return VM_FAULT_SIGBUS;
  319. ret = 0;
  320. if (of->vm_ops->page_mkwrite)
  321. ret = of->vm_ops->page_mkwrite(vma, vmf);
  322. else
  323. file_update_time(file);
  324. kernfs_put_active(of->kn);
  325. return ret;
  326. }
  327. static int kernfs_vma_access(struct vm_area_struct *vma, unsigned long addr,
  328. void *buf, int len, int write)
  329. {
  330. struct file *file = vma->vm_file;
  331. struct kernfs_open_file *of = kernfs_of(file);
  332. int ret;
  333. if (!of->vm_ops)
  334. return -EINVAL;
  335. if (!kernfs_get_active(of->kn))
  336. return -EINVAL;
  337. ret = -EINVAL;
  338. if (of->vm_ops->access)
  339. ret = of->vm_ops->access(vma, addr, buf, len, write);
  340. kernfs_put_active(of->kn);
  341. return ret;
  342. }
  343. #ifdef CONFIG_NUMA
  344. static int kernfs_vma_set_policy(struct vm_area_struct *vma,
  345. struct mempolicy *new)
  346. {
  347. struct file *file = vma->vm_file;
  348. struct kernfs_open_file *of = kernfs_of(file);
  349. int ret;
  350. if (!of->vm_ops)
  351. return 0;
  352. if (!kernfs_get_active(of->kn))
  353. return -EINVAL;
  354. ret = 0;
  355. if (of->vm_ops->set_policy)
  356. ret = of->vm_ops->set_policy(vma, new);
  357. kernfs_put_active(of->kn);
  358. return ret;
  359. }
  360. static struct mempolicy *kernfs_vma_get_policy(struct vm_area_struct *vma,
  361. unsigned long addr)
  362. {
  363. struct file *file = vma->vm_file;
  364. struct kernfs_open_file *of = kernfs_of(file);
  365. struct mempolicy *pol;
  366. if (!of->vm_ops)
  367. return vma->vm_policy;
  368. if (!kernfs_get_active(of->kn))
  369. return vma->vm_policy;
  370. pol = vma->vm_policy;
  371. if (of->vm_ops->get_policy)
  372. pol = of->vm_ops->get_policy(vma, addr);
  373. kernfs_put_active(of->kn);
  374. return pol;
  375. }
  376. static int kernfs_vma_migrate(struct vm_area_struct *vma,
  377. const nodemask_t *from, const nodemask_t *to,
  378. unsigned long flags)
  379. {
  380. struct file *file = vma->vm_file;
  381. struct kernfs_open_file *of = kernfs_of(file);
  382. int ret;
  383. if (!of->vm_ops)
  384. return 0;
  385. if (!kernfs_get_active(of->kn))
  386. return 0;
  387. ret = 0;
  388. if (of->vm_ops->migrate)
  389. ret = of->vm_ops->migrate(vma, from, to, flags);
  390. kernfs_put_active(of->kn);
  391. return ret;
  392. }
  393. #endif
  394. static const struct vm_operations_struct kernfs_vm_ops = {
  395. .open = kernfs_vma_open,
  396. .fault = kernfs_vma_fault,
  397. .page_mkwrite = kernfs_vma_page_mkwrite,
  398. .access = kernfs_vma_access,
  399. #ifdef CONFIG_NUMA
  400. .set_policy = kernfs_vma_set_policy,
  401. .get_policy = kernfs_vma_get_policy,
  402. .migrate = kernfs_vma_migrate,
  403. #endif
  404. };
  405. static int kernfs_fop_mmap(struct file *file, struct vm_area_struct *vma)
  406. {
  407. struct kernfs_open_file *of = kernfs_of(file);
  408. const struct kernfs_ops *ops;
  409. int rc;
  410. /*
  411. * mmap path and of->mutex are prone to triggering spurious lockdep
  412. * warnings and we don't want to add spurious locking dependency
  413. * between the two. Check whether mmap is actually implemented
  414. * without grabbing @of->mutex by testing HAS_MMAP flag. See the
  415. * comment in kernfs_file_open() for more details.
  416. */
  417. if (!(of->kn->flags & KERNFS_HAS_MMAP))
  418. return -ENODEV;
  419. mutex_lock(&of->mutex);
  420. rc = -ENODEV;
  421. if (!kernfs_get_active(of->kn))
  422. goto out_unlock;
  423. ops = kernfs_ops(of->kn);
  424. rc = ops->mmap(of, vma);
  425. if (rc)
  426. goto out_put;
  427. /*
  428. * PowerPC's pci_mmap of legacy_mem uses shmem_zero_setup()
  429. * to satisfy versions of X which crash if the mmap fails: that
  430. * substitutes a new vm_file, and we don't then want bin_vm_ops.
  431. */
  432. if (vma->vm_file != file)
  433. goto out_put;
  434. rc = -EINVAL;
  435. if (of->mmapped && of->vm_ops != vma->vm_ops)
  436. goto out_put;
  437. /*
  438. * It is not possible to successfully wrap close.
  439. * So error if someone is trying to use close.
  440. */
  441. rc = -EINVAL;
  442. if (vma->vm_ops && vma->vm_ops->close)
  443. goto out_put;
  444. rc = 0;
  445. of->mmapped = 1;
  446. of->vm_ops = vma->vm_ops;
  447. vma->vm_ops = &kernfs_vm_ops;
  448. out_put:
  449. kernfs_put_active(of->kn);
  450. out_unlock:
  451. mutex_unlock(&of->mutex);
  452. return rc;
  453. }
  454. /**
  455. * kernfs_get_open_node - get or create kernfs_open_node
  456. * @kn: target kernfs_node
  457. * @of: kernfs_open_file for this instance of open
  458. *
  459. * If @kn->attr.open exists, increment its reference count; otherwise,
  460. * create one. @of is chained to the files list.
  461. *
  462. * LOCKING:
  463. * Kernel thread context (may sleep).
  464. *
  465. * RETURNS:
  466. * 0 on success, -errno on failure.
  467. */
  468. static int kernfs_get_open_node(struct kernfs_node *kn,
  469. struct kernfs_open_file *of)
  470. {
  471. struct kernfs_open_node *on, *new_on = NULL;
  472. retry:
  473. mutex_lock(&kernfs_open_file_mutex);
  474. spin_lock_irq(&kernfs_open_node_lock);
  475. if (!kn->attr.open && new_on) {
  476. kn->attr.open = new_on;
  477. new_on = NULL;
  478. }
  479. on = kn->attr.open;
  480. if (on) {
  481. atomic_inc(&on->refcnt);
  482. list_add_tail(&of->list, &on->files);
  483. }
  484. spin_unlock_irq(&kernfs_open_node_lock);
  485. mutex_unlock(&kernfs_open_file_mutex);
  486. if (on) {
  487. kfree(new_on);
  488. return 0;
  489. }
  490. /* not there, initialize a new one and retry */
  491. new_on = kmalloc(sizeof(*new_on), GFP_KERNEL);
  492. if (!new_on)
  493. return -ENOMEM;
  494. atomic_set(&new_on->refcnt, 0);
  495. atomic_set(&new_on->event, 1);
  496. init_waitqueue_head(&new_on->poll);
  497. INIT_LIST_HEAD(&new_on->files);
  498. goto retry;
  499. }
  500. /**
  501. * kernfs_put_open_node - put kernfs_open_node
  502. * @kn: target kernfs_nodet
  503. * @of: associated kernfs_open_file
  504. *
  505. * Put @kn->attr.open and unlink @of from the files list. If
  506. * reference count reaches zero, disassociate and free it.
  507. *
  508. * LOCKING:
  509. * None.
  510. */
  511. static void kernfs_put_open_node(struct kernfs_node *kn,
  512. struct kernfs_open_file *of)
  513. {
  514. struct kernfs_open_node *on = kn->attr.open;
  515. unsigned long flags;
  516. mutex_lock(&kernfs_open_file_mutex);
  517. spin_lock_irqsave(&kernfs_open_node_lock, flags);
  518. if (of)
  519. list_del(&of->list);
  520. if (atomic_dec_and_test(&on->refcnt))
  521. kn->attr.open = NULL;
  522. else
  523. on = NULL;
  524. spin_unlock_irqrestore(&kernfs_open_node_lock, flags);
  525. mutex_unlock(&kernfs_open_file_mutex);
  526. kfree(on);
  527. }
  528. static int kernfs_fop_open(struct inode *inode, struct file *file)
  529. {
  530. struct kernfs_node *kn = file->f_path.dentry->d_fsdata;
  531. struct kernfs_root *root = kernfs_root(kn);
  532. const struct kernfs_ops *ops;
  533. struct kernfs_open_file *of;
  534. bool has_read, has_write, has_mmap;
  535. int error = -EACCES;
  536. if (!kernfs_get_active(kn))
  537. return -ENODEV;
  538. ops = kernfs_ops(kn);
  539. has_read = ops->seq_show || ops->read || ops->mmap;
  540. has_write = ops->write || ops->mmap;
  541. has_mmap = ops->mmap;
  542. /* see the flag definition for details */
  543. if (root->flags & KERNFS_ROOT_EXTRA_OPEN_PERM_CHECK) {
  544. if ((file->f_mode & FMODE_WRITE) &&
  545. (!(inode->i_mode & S_IWUGO) || !has_write))
  546. goto err_out;
  547. if ((file->f_mode & FMODE_READ) &&
  548. (!(inode->i_mode & S_IRUGO) || !has_read))
  549. goto err_out;
  550. }
  551. /* allocate a kernfs_open_file for the file */
  552. error = -ENOMEM;
  553. of = kzalloc(sizeof(struct kernfs_open_file), GFP_KERNEL);
  554. if (!of)
  555. goto err_out;
  556. /*
  557. * The following is done to give a different lockdep key to
  558. * @of->mutex for files which implement mmap. This is a rather
  559. * crude way to avoid false positive lockdep warning around
  560. * mm->mmap_sem - mmap nests @of->mutex under mm->mmap_sem and
  561. * reading /sys/block/sda/trace/act_mask grabs sr_mutex, under
  562. * which mm->mmap_sem nests, while holding @of->mutex. As each
  563. * open file has a separate mutex, it's okay as long as those don't
  564. * happen on the same file. At this point, we can't easily give
  565. * each file a separate locking class. Let's differentiate on
  566. * whether the file has mmap or not for now.
  567. *
  568. * Both paths of the branch look the same. They're supposed to
  569. * look that way and give @of->mutex different static lockdep keys.
  570. */
  571. if (has_mmap)
  572. mutex_init(&of->mutex);
  573. else
  574. mutex_init(&of->mutex);
  575. of->kn = kn;
  576. of->file = file;
  577. /*
  578. * Write path needs to atomic_write_len outside active reference.
  579. * Cache it in open_file. See kernfs_fop_write() for details.
  580. */
  581. of->atomic_write_len = ops->atomic_write_len;
  582. if (ops->prealloc) {
  583. int len = of->atomic_write_len ?: PAGE_SIZE;
  584. of->prealloc_buf = kmalloc(len + 1, GFP_KERNEL);
  585. error = -ENOMEM;
  586. if (!of->prealloc_buf)
  587. goto err_free;
  588. }
  589. /*
  590. * Always instantiate seq_file even if read access doesn't use
  591. * seq_file or is not requested. This unifies private data access
  592. * and readable regular files are the vast majority anyway.
  593. */
  594. if (ops->seq_show)
  595. error = seq_open(file, &kernfs_seq_ops);
  596. else
  597. error = seq_open(file, NULL);
  598. if (error)
  599. goto err_free;
  600. ((struct seq_file *)file->private_data)->private = of;
  601. /* seq_file clears PWRITE unconditionally, restore it if WRITE */
  602. if (file->f_mode & FMODE_WRITE)
  603. file->f_mode |= FMODE_PWRITE;
  604. /* make sure we have open node struct */
  605. error = kernfs_get_open_node(kn, of);
  606. if (error)
  607. goto err_close;
  608. /* open succeeded, put active references */
  609. kernfs_put_active(kn);
  610. return 0;
  611. err_close:
  612. seq_release(inode, file);
  613. err_free:
  614. kfree(of->prealloc_buf);
  615. kfree(of);
  616. err_out:
  617. kernfs_put_active(kn);
  618. return error;
  619. }
  620. static int kernfs_fop_release(struct inode *inode, struct file *filp)
  621. {
  622. struct kernfs_node *kn = filp->f_path.dentry->d_fsdata;
  623. struct kernfs_open_file *of = kernfs_of(filp);
  624. kernfs_put_open_node(kn, of);
  625. seq_release(inode, filp);
  626. kfree(of->prealloc_buf);
  627. kfree(of);
  628. return 0;
  629. }
  630. void kernfs_unmap_bin_file(struct kernfs_node *kn)
  631. {
  632. struct kernfs_open_node *on;
  633. struct kernfs_open_file *of;
  634. if (!(kn->flags & KERNFS_HAS_MMAP))
  635. return;
  636. spin_lock_irq(&kernfs_open_node_lock);
  637. on = kn->attr.open;
  638. if (on)
  639. atomic_inc(&on->refcnt);
  640. spin_unlock_irq(&kernfs_open_node_lock);
  641. if (!on)
  642. return;
  643. mutex_lock(&kernfs_open_file_mutex);
  644. list_for_each_entry(of, &on->files, list) {
  645. struct inode *inode = file_inode(of->file);
  646. unmap_mapping_range(inode->i_mapping, 0, 0, 1);
  647. }
  648. mutex_unlock(&kernfs_open_file_mutex);
  649. kernfs_put_open_node(kn, NULL);
  650. }
  651. /*
  652. * Kernfs attribute files are pollable. The idea is that you read
  653. * the content and then you use 'poll' or 'select' to wait for
  654. * the content to change. When the content changes (assuming the
  655. * manager for the kobject supports notification), poll will
  656. * return POLLERR|POLLPRI, and select will return the fd whether
  657. * it is waiting for read, write, or exceptions.
  658. * Once poll/select indicates that the value has changed, you
  659. * need to close and re-open the file, or seek to 0 and read again.
  660. * Reminder: this only works for attributes which actively support
  661. * it, and it is not possible to test an attribute from userspace
  662. * to see if it supports poll (Neither 'poll' nor 'select' return
  663. * an appropriate error code). When in doubt, set a suitable timeout value.
  664. */
  665. static unsigned int kernfs_fop_poll(struct file *filp, poll_table *wait)
  666. {
  667. struct kernfs_open_file *of = kernfs_of(filp);
  668. struct kernfs_node *kn = filp->f_path.dentry->d_fsdata;
  669. struct kernfs_open_node *on = kn->attr.open;
  670. /* need parent for the kobj, grab both */
  671. if (!kernfs_get_active(kn))
  672. goto trigger;
  673. poll_wait(filp, &on->poll, wait);
  674. kernfs_put_active(kn);
  675. if (of->event != atomic_read(&on->event))
  676. goto trigger;
  677. return DEFAULT_POLLMASK;
  678. trigger:
  679. return DEFAULT_POLLMASK|POLLERR|POLLPRI;
  680. }
  681. static void kernfs_notify_workfn(struct work_struct *work)
  682. {
  683. struct kernfs_node *kn;
  684. struct kernfs_open_node *on;
  685. struct kernfs_super_info *info;
  686. repeat:
  687. /* pop one off the notify_list */
  688. spin_lock_irq(&kernfs_notify_lock);
  689. kn = kernfs_notify_list;
  690. if (kn == KERNFS_NOTIFY_EOL) {
  691. spin_unlock_irq(&kernfs_notify_lock);
  692. return;
  693. }
  694. kernfs_notify_list = kn->attr.notify_next;
  695. kn->attr.notify_next = NULL;
  696. spin_unlock_irq(&kernfs_notify_lock);
  697. /* kick poll */
  698. spin_lock_irq(&kernfs_open_node_lock);
  699. on = kn->attr.open;
  700. if (on) {
  701. atomic_inc(&on->event);
  702. wake_up_interruptible(&on->poll);
  703. }
  704. spin_unlock_irq(&kernfs_open_node_lock);
  705. /* kick fsnotify */
  706. mutex_lock(&kernfs_mutex);
  707. list_for_each_entry(info, &kernfs_root(kn)->supers, node) {
  708. struct inode *inode;
  709. struct dentry *dentry;
  710. inode = ilookup(info->sb, kn->ino);
  711. if (!inode)
  712. continue;
  713. dentry = d_find_any_alias(inode);
  714. if (dentry) {
  715. fsnotify_parent(NULL, dentry, FS_MODIFY);
  716. fsnotify(inode, FS_MODIFY, inode, FSNOTIFY_EVENT_INODE,
  717. NULL, 0);
  718. dput(dentry);
  719. }
  720. iput(inode);
  721. }
  722. mutex_unlock(&kernfs_mutex);
  723. kernfs_put(kn);
  724. goto repeat;
  725. }
  726. /**
  727. * kernfs_notify - notify a kernfs file
  728. * @kn: file to notify
  729. *
  730. * Notify @kn such that poll(2) on @kn wakes up. Maybe be called from any
  731. * context.
  732. */
  733. void kernfs_notify(struct kernfs_node *kn)
  734. {
  735. static DECLARE_WORK(kernfs_notify_work, kernfs_notify_workfn);
  736. unsigned long flags;
  737. if (WARN_ON(kernfs_type(kn) != KERNFS_FILE))
  738. return;
  739. spin_lock_irqsave(&kernfs_notify_lock, flags);
  740. if (!kn->attr.notify_next) {
  741. kernfs_get(kn);
  742. kn->attr.notify_next = kernfs_notify_list;
  743. kernfs_notify_list = kn;
  744. schedule_work(&kernfs_notify_work);
  745. }
  746. spin_unlock_irqrestore(&kernfs_notify_lock, flags);
  747. }
  748. EXPORT_SYMBOL_GPL(kernfs_notify);
  749. const struct file_operations kernfs_file_fops = {
  750. .read = kernfs_fop_read,
  751. .write = kernfs_fop_write,
  752. .llseek = generic_file_llseek,
  753. .mmap = kernfs_fop_mmap,
  754. .open = kernfs_fop_open,
  755. .release = kernfs_fop_release,
  756. .poll = kernfs_fop_poll,
  757. };
  758. /**
  759. * __kernfs_create_file - kernfs internal function to create a file
  760. * @parent: directory to create the file in
  761. * @name: name of the file
  762. * @mode: mode of the file
  763. * @size: size of the file
  764. * @ops: kernfs operations for the file
  765. * @priv: private data for the file
  766. * @ns: optional namespace tag of the file
  767. * @name_is_static: don't copy file name
  768. * @key: lockdep key for the file's active_ref, %NULL to disable lockdep
  769. *
  770. * Returns the created node on success, ERR_PTR() value on error.
  771. */
  772. struct kernfs_node *__kernfs_create_file(struct kernfs_node *parent,
  773. const char *name,
  774. umode_t mode, loff_t size,
  775. const struct kernfs_ops *ops,
  776. void *priv, const void *ns,
  777. bool name_is_static,
  778. struct lock_class_key *key)
  779. {
  780. struct kernfs_node *kn;
  781. unsigned flags;
  782. int rc;
  783. flags = KERNFS_FILE;
  784. if (name_is_static)
  785. flags |= KERNFS_STATIC_NAME;
  786. kn = kernfs_new_node(parent, name, (mode & S_IALLUGO) | S_IFREG, flags);
  787. if (!kn)
  788. return ERR_PTR(-ENOMEM);
  789. kn->attr.ops = ops;
  790. kn->attr.size = size;
  791. kn->ns = ns;
  792. kn->priv = priv;
  793. #ifdef CONFIG_DEBUG_LOCK_ALLOC
  794. if (key) {
  795. lockdep_init_map(&kn->dep_map, "s_active", key, 0);
  796. kn->flags |= KERNFS_LOCKDEP;
  797. }
  798. #endif
  799. /*
  800. * kn->attr.ops is accesible only while holding active ref. We
  801. * need to know whether some ops are implemented outside active
  802. * ref. Cache their existence in flags.
  803. */
  804. if (ops->seq_show)
  805. kn->flags |= KERNFS_HAS_SEQ_SHOW;
  806. if (ops->mmap)
  807. kn->flags |= KERNFS_HAS_MMAP;
  808. rc = kernfs_add_one(kn);
  809. if (rc) {
  810. kernfs_put(kn);
  811. return ERR_PTR(rc);
  812. }
  813. return kn;
  814. }