1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/fs/nfs/direct.c
5 * Copyright (C) 2003 by Chuck Lever <cel@netapp.com>
7 * High-performance uncached I/O for the Linux NFS client
9 * There are important applications whose performance or correctness
10 * depends on uncached access to file data. Database clusters
11 * (multiple copies of the same instance running on separate hosts)
12 * implement their own cache coherency protocol that subsumes file
13 * system cache protocols. Applications that process datasets
14 * considerably larger than the client's memory do not always benefit
15 * from a local cache. A streaming video server, for instance, has no
16 * need to cache the contents of a file.
18 * When an application requests uncached I/O, all read and write requests
19 * are made directly to the server; data stored or fetched via these
20 * requests is not cached in the Linux page cache. The client does not
21 * correct unaligned requests from applications. All requested bytes are
22 * held on permanent storage before a direct write system call returns to
25 * Solaris implements an uncached I/O facility called directio() that
26 * is used for backups and sequential I/O to very large files. Solaris
27 * also supports uncaching whole NFS partitions with "-o forcedirectio,"
28 * an undocumented mount option.
30 * Designed by Jeff Kimmel, Chuck Lever, and Trond Myklebust, with
31 * help from Andrew Morton.
33 * 18 Dec 2001 Initial implementation for 2.4 --cel
34 * 08 Jul 2002 Version for 2.4.19, with bug fixes --trondmy
35 * 08 Jun 2003 Port to 2.5 APIs --cel
36 * 31 Mar 2004 Handle direct I/O without VFS support --cel
37 * 15 Sep 2004 Parallel async reads --cel
38 * 04 May 2005 support O_DIRECT with aio --cel
42 #include <linux/errno.h>
43 #include <linux/sched.h>
44 #include <linux/kernel.h>
45 #include <linux/file.h>
46 #include <linux/pagemap.h>
47 #include <linux/kref.h>
48 #include <linux/slab.h>
49 #include <linux/task_io_accounting_ops.h>
50 #include <linux/module.h>
52 #include <linux/nfs_fs.h>
53 #include <linux/nfs_page.h>
54 #include <linux/sunrpc/clnt.h>
56 #include <linux/uaccess.h>
57 #include <linux/atomic.h>
65 #define NFSDBG_FACILITY NFSDBG_VFS
67 static struct kmem_cache
*nfs_direct_cachep
;
69 static const struct nfs_pgio_completion_ops nfs_direct_write_completion_ops
;
70 static const struct nfs_commit_completion_ops nfs_direct_commit_completion_ops
;
71 static void nfs_direct_write_complete(struct nfs_direct_req
*dreq
);
72 static void nfs_direct_write_schedule_work(struct work_struct
*work
);
74 static inline void get_dreq(struct nfs_direct_req
*dreq
)
76 atomic_inc(&dreq
->io_count
);
79 static inline int put_dreq(struct nfs_direct_req
*dreq
)
81 return atomic_dec_and_test(&dreq
->io_count
);
85 nfs_direct_handle_truncated(struct nfs_direct_req
*dreq
,
86 const struct nfs_pgio_header
*hdr
,
89 if (!(test_bit(NFS_IOHDR_ERROR
, &hdr
->flags
) ||
90 test_bit(NFS_IOHDR_EOF
, &hdr
->flags
)))
92 if (dreq
->max_count
>= dreq_len
) {
93 dreq
->max_count
= dreq_len
;
94 if (dreq
->count
> dreq_len
)
95 dreq
->count
= dreq_len
;
98 if (test_bit(NFS_IOHDR_ERROR
, &hdr
->flags
) && !dreq
->error
)
99 dreq
->error
= hdr
->error
;
103 nfs_direct_count_bytes(struct nfs_direct_req
*dreq
,
104 const struct nfs_pgio_header
*hdr
)
106 loff_t hdr_end
= hdr
->io_start
+ hdr
->good_bytes
;
107 ssize_t dreq_len
= 0;
109 if (hdr_end
> dreq
->io_start
)
110 dreq_len
= hdr_end
- dreq
->io_start
;
112 nfs_direct_handle_truncated(dreq
, hdr
, dreq_len
);
114 if (dreq_len
> dreq
->max_count
)
115 dreq_len
= dreq
->max_count
;
117 if (dreq
->count
< dreq_len
)
118 dreq
->count
= dreq_len
;
121 static void nfs_direct_truncate_request(struct nfs_direct_req
*dreq
,
122 struct nfs_page
*req
)
124 loff_t offs
= req_offset(req
);
125 size_t req_start
= (size_t)(offs
- dreq
->io_start
);
127 if (req_start
< dreq
->max_count
)
128 dreq
->max_count
= req_start
;
129 if (req_start
< dreq
->count
)
130 dreq
->count
= req_start
;
134 * nfs_swap_rw - NFS address space operation for swap I/O
135 * @iocb: target I/O control block
138 * Perform IO to the swap-file. This is much like direct IO.
140 int nfs_swap_rw(struct kiocb
*iocb
, struct iov_iter
*iter
)
144 if (iov_iter_rw(iter
) == READ
)
145 ret
= nfs_file_direct_read(iocb
, iter
, true);
147 ret
= nfs_file_direct_write(iocb
, iter
, true);
153 static void nfs_direct_release_pages(struct page
**pages
, unsigned int npages
)
156 for (i
= 0; i
< npages
; i
++)
160 void nfs_init_cinfo_from_dreq(struct nfs_commit_info
*cinfo
,
161 struct nfs_direct_req
*dreq
)
163 cinfo
->inode
= dreq
->inode
;
164 cinfo
->mds
= &dreq
->mds_cinfo
;
165 cinfo
->ds
= &dreq
->ds_cinfo
;
167 cinfo
->completion_ops
= &nfs_direct_commit_completion_ops
;
170 static inline struct nfs_direct_req
*nfs_direct_req_alloc(void)
172 struct nfs_direct_req
*dreq
;
174 dreq
= kmem_cache_zalloc(nfs_direct_cachep
, GFP_KERNEL
);
178 kref_init(&dreq
->kref
);
179 kref_get(&dreq
->kref
);
180 init_completion(&dreq
->completion
);
181 INIT_LIST_HEAD(&dreq
->mds_cinfo
.list
);
182 pnfs_init_ds_commit_info(&dreq
->ds_cinfo
);
183 INIT_WORK(&dreq
->work
, nfs_direct_write_schedule_work
);
184 spin_lock_init(&dreq
->lock
);
189 static void nfs_direct_req_free(struct kref
*kref
)
191 struct nfs_direct_req
*dreq
= container_of(kref
, struct nfs_direct_req
, kref
);
193 pnfs_release_ds_info(&dreq
->ds_cinfo
, dreq
->inode
);
194 if (dreq
->l_ctx
!= NULL
)
195 nfs_put_lock_context(dreq
->l_ctx
);
196 if (dreq
->ctx
!= NULL
)
197 put_nfs_open_context(dreq
->ctx
);
198 kmem_cache_free(nfs_direct_cachep
, dreq
);
201 static void nfs_direct_req_release(struct nfs_direct_req
*dreq
)
203 kref_put(&dreq
->kref
, nfs_direct_req_free
);
206 ssize_t
nfs_dreq_bytes_left(struct nfs_direct_req
*dreq
, loff_t offset
)
208 loff_t start
= offset
- dreq
->io_start
;
209 return dreq
->max_count
- start
;
211 EXPORT_SYMBOL_GPL(nfs_dreq_bytes_left
);
214 * Collects and returns the final error value/byte-count.
216 static ssize_t
nfs_direct_wait(struct nfs_direct_req
*dreq
)
218 ssize_t result
= -EIOCBQUEUED
;
220 /* Async requests don't wait here */
224 result
= wait_for_completion_killable(&dreq
->completion
);
227 result
= dreq
->count
;
228 WARN_ON_ONCE(dreq
->count
< 0);
231 result
= dreq
->error
;
234 return (ssize_t
) result
;
238 * Synchronous I/O uses a stack-allocated iocb. Thus we can't trust
239 * the iocb is still valid here if this is a synchronous request.
241 static void nfs_direct_complete(struct nfs_direct_req
*dreq
)
243 struct inode
*inode
= dreq
->inode
;
245 inode_dio_end(inode
);
248 long res
= (long) dreq
->error
;
249 if (dreq
->count
!= 0) {
250 res
= (long) dreq
->count
;
251 WARN_ON_ONCE(dreq
->count
< 0);
253 dreq
->iocb
->ki_complete(dreq
->iocb
, res
);
256 complete(&dreq
->completion
);
258 nfs_direct_req_release(dreq
);
261 static void nfs_direct_read_completion(struct nfs_pgio_header
*hdr
)
263 unsigned long bytes
= 0;
264 struct nfs_direct_req
*dreq
= hdr
->dreq
;
266 spin_lock(&dreq
->lock
);
267 if (test_bit(NFS_IOHDR_REDO
, &hdr
->flags
)) {
268 spin_unlock(&dreq
->lock
);
272 nfs_direct_count_bytes(dreq
, hdr
);
273 spin_unlock(&dreq
->lock
);
275 while (!list_empty(&hdr
->pages
)) {
276 struct nfs_page
*req
= nfs_list_entry(hdr
->pages
.next
);
277 struct page
*page
= req
->wb_page
;
279 if (!PageCompound(page
) && bytes
< hdr
->good_bytes
&&
280 (dreq
->flags
== NFS_ODIRECT_SHOULD_DIRTY
))
281 set_page_dirty(page
);
282 bytes
+= req
->wb_bytes
;
283 nfs_list_remove_request(req
);
284 nfs_release_request(req
);
288 nfs_direct_complete(dreq
);
292 static void nfs_read_sync_pgio_error(struct list_head
*head
, int error
)
294 struct nfs_page
*req
;
296 while (!list_empty(head
)) {
297 req
= nfs_list_entry(head
->next
);
298 nfs_list_remove_request(req
);
299 nfs_release_request(req
);
303 static void nfs_direct_pgio_init(struct nfs_pgio_header
*hdr
)
308 static const struct nfs_pgio_completion_ops nfs_direct_read_completion_ops
= {
309 .error_cleanup
= nfs_read_sync_pgio_error
,
310 .init_hdr
= nfs_direct_pgio_init
,
311 .completion
= nfs_direct_read_completion
,
315 * For each rsize'd chunk of the user's buffer, dispatch an NFS READ
316 * operation. If nfs_readdata_alloc() or get_user_pages() fails,
317 * bail and stop sending more reads. Read length accounting is
318 * handled automatically by nfs_direct_read_result(). Otherwise, if
319 * no requests have been sent, just return an error.
322 static ssize_t
nfs_direct_read_schedule_iovec(struct nfs_direct_req
*dreq
,
323 struct iov_iter
*iter
,
326 struct nfs_pageio_descriptor desc
;
327 struct inode
*inode
= dreq
->inode
;
328 ssize_t result
= -EINVAL
;
329 size_t requested_bytes
= 0;
330 size_t rsize
= max_t(size_t, NFS_SERVER(inode
)->rsize
, PAGE_SIZE
);
332 nfs_pageio_init_read(&desc
, dreq
->inode
, false,
333 &nfs_direct_read_completion_ops
);
336 inode_dio_begin(inode
);
338 while (iov_iter_count(iter
)) {
339 struct page
**pagevec
;
344 result
= iov_iter_get_pages_alloc2(iter
, &pagevec
,
350 npages
= (result
+ pgbase
+ PAGE_SIZE
- 1) / PAGE_SIZE
;
351 for (i
= 0; i
< npages
; i
++) {
352 struct nfs_page
*req
;
353 unsigned int req_len
= min_t(size_t, bytes
, PAGE_SIZE
- pgbase
);
354 /* XXX do we need to do the eof zeroing found in async_filler? */
355 req
= nfs_page_create_from_page(dreq
->ctx
, pagevec
[i
],
356 pgbase
, pos
, req_len
);
358 result
= PTR_ERR(req
);
361 if (!nfs_pageio_add_request(&desc
, req
)) {
362 result
= desc
.pg_error
;
363 nfs_release_request(req
);
368 requested_bytes
+= req_len
;
371 nfs_direct_release_pages(pagevec
, npages
);
377 nfs_pageio_complete(&desc
);
380 * If no bytes were started, return the error, and let the
381 * generic layer handle the completion.
383 if (requested_bytes
== 0) {
384 inode_dio_end(inode
);
385 nfs_direct_req_release(dreq
);
386 return result
< 0 ? result
: -EIO
;
390 nfs_direct_complete(dreq
);
391 return requested_bytes
;
395 * nfs_file_direct_read - file direct read operation for NFS files
396 * @iocb: target I/O control block
397 * @iter: vector of user buffers into which to read data
398 * @swap: flag indicating this is swap IO, not O_DIRECT IO
400 * We use this function for direct reads instead of calling
401 * generic_file_aio_read() in order to avoid gfar's check to see if
402 * the request starts before the end of the file. For that check
403 * to work, we must generate a GETATTR before each direct read, and
404 * even then there is a window between the GETATTR and the subsequent
405 * READ where the file size could change. Our preference is simply
406 * to do all reads the application wants, and the server will take
407 * care of managing the end of file boundary.
409 * This function also eliminates unnecessarily updating the file's
410 * atime locally, as the NFS server sets the file's atime, and this
411 * client must read the updated atime from the server back into its
414 ssize_t
nfs_file_direct_read(struct kiocb
*iocb
, struct iov_iter
*iter
,
417 struct file
*file
= iocb
->ki_filp
;
418 struct address_space
*mapping
= file
->f_mapping
;
419 struct inode
*inode
= mapping
->host
;
420 struct nfs_direct_req
*dreq
;
421 struct nfs_lock_context
*l_ctx
;
422 ssize_t result
, requested
;
423 size_t count
= iov_iter_count(iter
);
424 nfs_add_stats(mapping
->host
, NFSIOS_DIRECTREADBYTES
, count
);
426 dfprintk(FILE, "NFS: direct read(%pD2, %zd@%Ld)\n",
427 file
, count
, (long long) iocb
->ki_pos
);
433 task_io_account_read(count
);
436 dreq
= nfs_direct_req_alloc();
441 dreq
->max_count
= count
;
442 dreq
->io_start
= iocb
->ki_pos
;
443 dreq
->ctx
= get_nfs_open_context(nfs_file_open_context(iocb
->ki_filp
));
444 l_ctx
= nfs_get_lock_context(dreq
->ctx
);
446 result
= PTR_ERR(l_ctx
);
447 nfs_direct_req_release(dreq
);
451 if (!is_sync_kiocb(iocb
))
454 if (user_backed_iter(iter
))
455 dreq
->flags
= NFS_ODIRECT_SHOULD_DIRTY
;
458 result
= nfs_start_io_direct(inode
);
460 /* release the reference that would usually be
461 * consumed by nfs_direct_read_schedule_iovec()
463 nfs_direct_req_release(dreq
);
468 NFS_I(inode
)->read_io
+= count
;
469 requested
= nfs_direct_read_schedule_iovec(dreq
, iter
, iocb
->ki_pos
);
472 nfs_end_io_direct(inode
);
475 result
= nfs_direct_wait(dreq
);
478 iocb
->ki_pos
+= result
;
480 iov_iter_revert(iter
, requested
);
486 nfs_direct_req_release(dreq
);
491 static void nfs_direct_add_page_head(struct list_head
*list
,
492 struct nfs_page
*req
)
494 struct nfs_page
*head
= req
->wb_head
;
496 if (!list_empty(&head
->wb_list
) || !nfs_lock_request(head
))
498 if (!list_empty(&head
->wb_list
)) {
499 nfs_unlock_request(head
);
502 list_add(&head
->wb_list
, list
);
503 kref_get(&head
->wb_kref
);
504 kref_get(&head
->wb_kref
);
507 static void nfs_direct_join_group(struct list_head
*list
,
508 struct nfs_commit_info
*cinfo
,
511 struct nfs_page
*req
, *subreq
;
513 list_for_each_entry(req
, list
, wb_list
) {
514 if (req
->wb_head
!= req
) {
515 nfs_direct_add_page_head(&req
->wb_list
, req
);
518 subreq
= req
->wb_this_page
;
523 * Remove subrequests from this list before freeing
524 * them in the call to nfs_join_page_group().
526 if (!list_empty(&subreq
->wb_list
)) {
527 nfs_list_remove_request(subreq
);
528 nfs_release_request(subreq
);
530 } while ((subreq
= subreq
->wb_this_page
) != req
);
531 nfs_join_page_group(req
, cinfo
, inode
);
536 nfs_direct_write_scan_commit_list(struct inode
*inode
,
537 struct list_head
*list
,
538 struct nfs_commit_info
*cinfo
)
540 mutex_lock(&NFS_I(cinfo
->inode
)->commit_mutex
);
541 pnfs_recover_commit_reqs(list
, cinfo
);
542 nfs_scan_commit_list(&cinfo
->mds
->list
, list
, cinfo
, 0);
543 mutex_unlock(&NFS_I(cinfo
->inode
)->commit_mutex
);
546 static void nfs_direct_write_reschedule(struct nfs_direct_req
*dreq
)
548 struct nfs_pageio_descriptor desc
;
549 struct nfs_page
*req
;
551 struct nfs_commit_info cinfo
;
553 nfs_init_cinfo_from_dreq(&cinfo
, dreq
);
554 nfs_direct_write_scan_commit_list(dreq
->inode
, &reqs
, &cinfo
);
556 nfs_direct_join_group(&reqs
, &cinfo
, dreq
->inode
);
558 nfs_clear_pnfs_ds_commit_verifiers(&dreq
->ds_cinfo
);
561 nfs_pageio_init_write(&desc
, dreq
->inode
, FLUSH_STABLE
, false,
562 &nfs_direct_write_completion_ops
);
565 while (!list_empty(&reqs
)) {
566 req
= nfs_list_entry(reqs
.next
);
567 /* Bump the transmission count */
569 if (!nfs_pageio_add_request(&desc
, req
)) {
570 spin_lock(&dreq
->lock
);
571 if (dreq
->error
< 0) {
572 desc
.pg_error
= dreq
->error
;
573 } else if (desc
.pg_error
!= -EAGAIN
) {
576 desc
.pg_error
= -EIO
;
577 dreq
->error
= desc
.pg_error
;
579 dreq
->flags
= NFS_ODIRECT_RESCHED_WRITES
;
580 spin_unlock(&dreq
->lock
);
583 nfs_release_request(req
);
585 nfs_pageio_complete(&desc
);
587 while (!list_empty(&reqs
)) {
588 req
= nfs_list_entry(reqs
.next
);
589 nfs_list_remove_request(req
);
590 nfs_unlock_and_release_request(req
);
591 if (desc
.pg_error
== -EAGAIN
) {
592 nfs_mark_request_commit(req
, NULL
, &cinfo
, 0);
594 spin_lock(&dreq
->lock
);
595 nfs_direct_truncate_request(dreq
, req
);
596 spin_unlock(&dreq
->lock
);
597 nfs_release_request(req
);
602 nfs_direct_write_complete(dreq
);
605 static void nfs_direct_commit_complete(struct nfs_commit_data
*data
)
607 const struct nfs_writeverf
*verf
= data
->res
.verf
;
608 struct nfs_direct_req
*dreq
= data
->dreq
;
609 struct nfs_commit_info cinfo
;
610 struct nfs_page
*req
;
611 int status
= data
->task
.tk_status
;
613 trace_nfs_direct_commit_complete(dreq
);
615 spin_lock(&dreq
->lock
);
617 /* Errors in commit are fatal */
618 dreq
->error
= status
;
619 dreq
->flags
= NFS_ODIRECT_DONE
;
621 status
= dreq
->error
;
623 spin_unlock(&dreq
->lock
);
625 nfs_init_cinfo_from_dreq(&cinfo
, dreq
);
627 while (!list_empty(&data
->pages
)) {
628 req
= nfs_list_entry(data
->pages
.next
);
629 nfs_list_remove_request(req
);
631 spin_lock(&dreq
->lock
);
632 nfs_direct_truncate_request(dreq
, req
);
633 spin_unlock(&dreq
->lock
);
634 nfs_release_request(req
);
635 } else if (!nfs_write_match_verf(verf
, req
)) {
636 spin_lock(&dreq
->lock
);
637 if (dreq
->flags
== 0)
638 dreq
->flags
= NFS_ODIRECT_RESCHED_WRITES
;
639 spin_unlock(&dreq
->lock
);
641 * Despite the reboot, the write was successful,
645 nfs_mark_request_commit(req
, NULL
, &cinfo
, 0);
647 nfs_release_request(req
);
648 nfs_unlock_and_release_request(req
);
651 if (nfs_commit_end(cinfo
.mds
))
652 nfs_direct_write_complete(dreq
);
655 static void nfs_direct_resched_write(struct nfs_commit_info
*cinfo
,
656 struct nfs_page
*req
)
658 struct nfs_direct_req
*dreq
= cinfo
->dreq
;
660 trace_nfs_direct_resched_write(dreq
);
662 spin_lock(&dreq
->lock
);
663 if (dreq
->flags
!= NFS_ODIRECT_DONE
)
664 dreq
->flags
= NFS_ODIRECT_RESCHED_WRITES
;
665 spin_unlock(&dreq
->lock
);
666 nfs_mark_request_commit(req
, NULL
, cinfo
, 0);
669 static const struct nfs_commit_completion_ops nfs_direct_commit_completion_ops
= {
670 .completion
= nfs_direct_commit_complete
,
671 .resched_write
= nfs_direct_resched_write
,
674 static void nfs_direct_commit_schedule(struct nfs_direct_req
*dreq
)
677 struct nfs_commit_info cinfo
;
680 nfs_init_cinfo_from_dreq(&cinfo
, dreq
);
681 nfs_commit_begin(cinfo
.mds
);
682 nfs_scan_commit(dreq
->inode
, &mds_list
, &cinfo
);
683 res
= nfs_generic_commit_list(dreq
->inode
, &mds_list
, 0, &cinfo
);
684 if (res
< 0) { /* res == -ENOMEM */
685 spin_lock(&dreq
->lock
);
686 if (dreq
->flags
== 0)
687 dreq
->flags
= NFS_ODIRECT_RESCHED_WRITES
;
688 spin_unlock(&dreq
->lock
);
690 if (nfs_commit_end(cinfo
.mds
))
691 nfs_direct_write_complete(dreq
);
694 static void nfs_direct_write_clear_reqs(struct nfs_direct_req
*dreq
)
696 struct nfs_commit_info cinfo
;
697 struct nfs_page
*req
;
700 nfs_init_cinfo_from_dreq(&cinfo
, dreq
);
701 nfs_direct_write_scan_commit_list(dreq
->inode
, &reqs
, &cinfo
);
703 while (!list_empty(&reqs
)) {
704 req
= nfs_list_entry(reqs
.next
);
705 nfs_list_remove_request(req
);
706 nfs_direct_truncate_request(dreq
, req
);
707 nfs_release_request(req
);
708 nfs_unlock_and_release_request(req
);
712 static void nfs_direct_write_schedule_work(struct work_struct
*work
)
714 struct nfs_direct_req
*dreq
= container_of(work
, struct nfs_direct_req
, work
);
715 int flags
= dreq
->flags
;
719 case NFS_ODIRECT_DO_COMMIT
:
720 nfs_direct_commit_schedule(dreq
);
722 case NFS_ODIRECT_RESCHED_WRITES
:
723 nfs_direct_write_reschedule(dreq
);
726 nfs_direct_write_clear_reqs(dreq
);
727 nfs_zap_mapping(dreq
->inode
, dreq
->inode
->i_mapping
);
728 nfs_direct_complete(dreq
);
732 static void nfs_direct_write_complete(struct nfs_direct_req
*dreq
)
734 trace_nfs_direct_write_complete(dreq
);
735 queue_work(nfsiod_workqueue
, &dreq
->work
); /* Calls nfs_direct_write_schedule_work */
738 static void nfs_direct_write_completion(struct nfs_pgio_header
*hdr
)
740 struct nfs_direct_req
*dreq
= hdr
->dreq
;
741 struct nfs_commit_info cinfo
;
742 struct nfs_page
*req
= nfs_list_entry(hdr
->pages
.next
);
743 int flags
= NFS_ODIRECT_DONE
;
745 trace_nfs_direct_write_completion(dreq
);
747 nfs_init_cinfo_from_dreq(&cinfo
, dreq
);
749 spin_lock(&dreq
->lock
);
750 if (test_bit(NFS_IOHDR_REDO
, &hdr
->flags
)) {
751 spin_unlock(&dreq
->lock
);
755 nfs_direct_count_bytes(dreq
, hdr
);
756 if (test_bit(NFS_IOHDR_UNSTABLE_WRITES
, &hdr
->flags
) &&
757 !test_bit(NFS_IOHDR_ERROR
, &hdr
->flags
)) {
759 dreq
->flags
= NFS_ODIRECT_DO_COMMIT
;
762 spin_unlock(&dreq
->lock
);
764 while (!list_empty(&hdr
->pages
)) {
766 req
= nfs_list_entry(hdr
->pages
.next
);
767 nfs_list_remove_request(req
);
768 if (flags
== NFS_ODIRECT_DO_COMMIT
) {
769 kref_get(&req
->wb_kref
);
770 memcpy(&req
->wb_verf
, &hdr
->verf
.verifier
,
771 sizeof(req
->wb_verf
));
772 nfs_mark_request_commit(req
, hdr
->lseg
, &cinfo
,
774 } else if (flags
== NFS_ODIRECT_RESCHED_WRITES
) {
775 kref_get(&req
->wb_kref
);
776 nfs_mark_request_commit(req
, NULL
, &cinfo
, 0);
778 nfs_unlock_and_release_request(req
);
783 nfs_direct_write_complete(dreq
);
787 static void nfs_write_sync_pgio_error(struct list_head
*head
, int error
)
789 struct nfs_page
*req
;
791 while (!list_empty(head
)) {
792 req
= nfs_list_entry(head
->next
);
793 nfs_list_remove_request(req
);
794 nfs_unlock_and_release_request(req
);
798 static void nfs_direct_write_reschedule_io(struct nfs_pgio_header
*hdr
)
800 struct nfs_direct_req
*dreq
= hdr
->dreq
;
801 struct nfs_page
*req
;
802 struct nfs_commit_info cinfo
;
804 trace_nfs_direct_write_reschedule_io(dreq
);
806 nfs_init_cinfo_from_dreq(&cinfo
, dreq
);
807 spin_lock(&dreq
->lock
);
808 if (dreq
->error
== 0)
809 dreq
->flags
= NFS_ODIRECT_RESCHED_WRITES
;
810 set_bit(NFS_IOHDR_REDO
, &hdr
->flags
);
811 spin_unlock(&dreq
->lock
);
812 while (!list_empty(&hdr
->pages
)) {
813 req
= nfs_list_entry(hdr
->pages
.next
);
814 nfs_list_remove_request(req
);
815 nfs_unlock_request(req
);
816 nfs_mark_request_commit(req
, NULL
, &cinfo
, 0);
820 static const struct nfs_pgio_completion_ops nfs_direct_write_completion_ops
= {
821 .error_cleanup
= nfs_write_sync_pgio_error
,
822 .init_hdr
= nfs_direct_pgio_init
,
823 .completion
= nfs_direct_write_completion
,
824 .reschedule_io
= nfs_direct_write_reschedule_io
,
829 * NB: Return the value of the first error return code. Subsequent
830 * errors after the first one are ignored.
833 * For each wsize'd chunk of the user's buffer, dispatch an NFS WRITE
834 * operation. If nfs_writedata_alloc() or get_user_pages() fails,
835 * bail and stop sending more writes. Write length accounting is
836 * handled automatically by nfs_direct_write_result(). Otherwise, if
837 * no requests have been sent, just return an error.
839 static ssize_t
nfs_direct_write_schedule_iovec(struct nfs_direct_req
*dreq
,
840 struct iov_iter
*iter
,
841 loff_t pos
, int ioflags
)
843 struct nfs_pageio_descriptor desc
;
844 struct inode
*inode
= dreq
->inode
;
845 struct nfs_commit_info cinfo
;
847 size_t requested_bytes
= 0;
848 size_t wsize
= max_t(size_t, NFS_SERVER(inode
)->wsize
, PAGE_SIZE
);
851 trace_nfs_direct_write_schedule_iovec(dreq
);
853 nfs_pageio_init_write(&desc
, inode
, ioflags
, false,
854 &nfs_direct_write_completion_ops
);
857 inode_dio_begin(inode
);
859 NFS_I(inode
)->write_io
+= iov_iter_count(iter
);
860 while (iov_iter_count(iter
)) {
861 struct page
**pagevec
;
866 result
= iov_iter_get_pages_alloc2(iter
, &pagevec
,
872 npages
= (result
+ pgbase
+ PAGE_SIZE
- 1) / PAGE_SIZE
;
873 for (i
= 0; i
< npages
; i
++) {
874 struct nfs_page
*req
;
875 unsigned int req_len
= min_t(size_t, bytes
, PAGE_SIZE
- pgbase
);
877 req
= nfs_page_create_from_page(dreq
->ctx
, pagevec
[i
],
878 pgbase
, pos
, req_len
);
880 result
= PTR_ERR(req
);
884 if (desc
.pg_error
< 0) {
885 nfs_free_request(req
);
886 result
= desc
.pg_error
;
892 requested_bytes
+= req_len
;
896 nfs_mark_request_commit(req
, NULL
, &cinfo
, 0);
900 nfs_lock_request(req
);
901 if (nfs_pageio_add_request(&desc
, req
))
904 /* Exit on hard errors */
905 if (desc
.pg_error
< 0 && desc
.pg_error
!= -EAGAIN
) {
906 result
= desc
.pg_error
;
907 nfs_unlock_and_release_request(req
);
911 /* If the error is soft, defer remaining requests */
912 nfs_init_cinfo_from_dreq(&cinfo
, dreq
);
913 spin_lock(&dreq
->lock
);
914 dreq
->flags
= NFS_ODIRECT_RESCHED_WRITES
;
915 spin_unlock(&dreq
->lock
);
916 nfs_unlock_request(req
);
917 nfs_mark_request_commit(req
, NULL
, &cinfo
, 0);
921 nfs_direct_release_pages(pagevec
, npages
);
926 nfs_pageio_complete(&desc
);
929 * If no bytes were started, return the error, and let the
930 * generic layer handle the completion.
932 if (requested_bytes
== 0) {
933 inode_dio_end(inode
);
934 nfs_direct_req_release(dreq
);
935 return result
< 0 ? result
: -EIO
;
939 nfs_direct_write_complete(dreq
);
940 return requested_bytes
;
944 * nfs_file_direct_write - file direct write operation for NFS files
945 * @iocb: target I/O control block
946 * @iter: vector of user buffers from which to write data
947 * @swap: flag indicating this is swap IO, not O_DIRECT IO
949 * We use this function for direct writes instead of calling
950 * generic_file_aio_write() in order to avoid taking the inode
951 * semaphore and updating the i_size. The NFS server will set
952 * the new i_size and this client must read the updated size
953 * back into its cache. We let the server do generic write
954 * parameter checking and report problems.
956 * We eliminate local atime updates, see direct read above.
958 * We avoid unnecessary page cache invalidations for normal cached
959 * readers of this file.
961 * Note that O_APPEND is not supported for NFS direct writes, as there
962 * is no atomic O_APPEND write facility in the NFS protocol.
964 ssize_t
nfs_file_direct_write(struct kiocb
*iocb
, struct iov_iter
*iter
,
967 ssize_t result
, requested
;
969 struct file
*file
= iocb
->ki_filp
;
970 struct address_space
*mapping
= file
->f_mapping
;
971 struct inode
*inode
= mapping
->host
;
972 struct nfs_direct_req
*dreq
;
973 struct nfs_lock_context
*l_ctx
;
976 dfprintk(FILE, "NFS: direct write(%pD2, %zd@%Ld)\n",
977 file
, iov_iter_count(iter
), (long long) iocb
->ki_pos
);
980 /* bypass generic checks */
981 result
= iov_iter_count(iter
);
983 result
= generic_write_checks(iocb
, iter
);
987 nfs_add_stats(mapping
->host
, NFSIOS_DIRECTWRITTENBYTES
, count
);
990 end
= (pos
+ iov_iter_count(iter
) - 1) >> PAGE_SHIFT
;
992 task_io_account_write(count
);
995 dreq
= nfs_direct_req_alloc();
1000 dreq
->max_count
= count
;
1001 dreq
->io_start
= pos
;
1002 dreq
->ctx
= get_nfs_open_context(nfs_file_open_context(iocb
->ki_filp
));
1003 l_ctx
= nfs_get_lock_context(dreq
->ctx
);
1004 if (IS_ERR(l_ctx
)) {
1005 result
= PTR_ERR(l_ctx
);
1006 nfs_direct_req_release(dreq
);
1009 dreq
->l_ctx
= l_ctx
;
1010 if (!is_sync_kiocb(iocb
))
1012 pnfs_init_ds_commit_info_ops(&dreq
->ds_cinfo
, inode
);
1015 requested
= nfs_direct_write_schedule_iovec(dreq
, iter
, pos
,
1018 result
= nfs_start_io_direct(inode
);
1020 /* release the reference that would usually be
1021 * consumed by nfs_direct_write_schedule_iovec()
1023 nfs_direct_req_release(dreq
);
1027 requested
= nfs_direct_write_schedule_iovec(dreq
, iter
, pos
,
1030 if (mapping
->nrpages
) {
1031 invalidate_inode_pages2_range(mapping
,
1032 pos
>> PAGE_SHIFT
, end
);
1035 nfs_end_io_direct(inode
);
1038 if (requested
> 0) {
1039 result
= nfs_direct_wait(dreq
);
1041 requested
-= result
;
1042 iocb
->ki_pos
= pos
+ result
;
1043 /* XXX: should check the generic_write_sync retval */
1044 generic_write_sync(iocb
, result
);
1046 iov_iter_revert(iter
, requested
);
1050 nfs_fscache_invalidate(inode
, FSCACHE_INVAL_DIO_WRITE
);
1052 nfs_direct_req_release(dreq
);
1058 * nfs_init_directcache - create a slab cache for nfs_direct_req structures
1061 int __init
nfs_init_directcache(void)
1063 nfs_direct_cachep
= kmem_cache_create("nfs_direct_cache",
1064 sizeof(struct nfs_direct_req
),
1065 0, SLAB_RECLAIM_ACCOUNT
,
1067 if (nfs_direct_cachep
== NULL
)
1074 * nfs_destroy_directcache - destroy the slab cache for nfs_direct_req structures
1077 void nfs_destroy_directcache(void)
1079 kmem_cache_destroy(nfs_direct_cachep
);