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