locking/refcounts: Include fewer headers in <linux/refcount.h>
[linux/fpc-iii.git] / fs / nfs / direct.c
blob621c517b325c664a81a609483ab7b9830f12e25a
1 /*
2 * linux/fs/nfs/direct.c
4 * Copyright (C) 2003 by Chuck Lever <cel@netapp.com>
6 * High-performance uncached I/O for the Linux NFS client
8 * There are important applications whose performance or correctness
9 * depends on uncached access to file data. Database clusters
10 * (multiple copies of the same instance running on separate hosts)
11 * implement their own cache coherency protocol that subsumes file
12 * system cache protocols. Applications that process datasets
13 * considerably larger than the client's memory do not always benefit
14 * from a local cache. A streaming video server, for instance, has no
15 * need to cache the contents of a file.
17 * When an application requests uncached I/O, all read and write requests
18 * are made directly to the server; data stored or fetched via these
19 * requests is not cached in the Linux page cache. The client does not
20 * correct unaligned requests from applications. All requested bytes are
21 * held on permanent storage before a direct write system call returns to
22 * an application.
24 * Solaris implements an uncached I/O facility called directio() that
25 * is used for backups and sequential I/O to very large files. Solaris
26 * also supports uncaching whole NFS partitions with "-o forcedirectio,"
27 * an undocumented mount option.
29 * Designed by Jeff Kimmel, Chuck Lever, and Trond Myklebust, with
30 * help from Andrew Morton.
32 * 18 Dec 2001 Initial implementation for 2.4 --cel
33 * 08 Jul 2002 Version for 2.4.19, with bug fixes --trondmy
34 * 08 Jun 2003 Port to 2.5 APIs --cel
35 * 31 Mar 2004 Handle direct I/O without VFS support --cel
36 * 15 Sep 2004 Parallel async reads --cel
37 * 04 May 2005 support O_DIRECT with aio --cel
41 #include <linux/errno.h>
42 #include <linux/sched.h>
43 #include <linux/kernel.h>
44 #include <linux/file.h>
45 #include <linux/pagemap.h>
46 #include <linux/kref.h>
47 #include <linux/slab.h>
48 #include <linux/task_io_accounting_ops.h>
49 #include <linux/module.h>
51 #include <linux/nfs_fs.h>
52 #include <linux/nfs_page.h>
53 #include <linux/sunrpc/clnt.h>
55 #include <linux/uaccess.h>
56 #include <linux/atomic.h>
58 #include "internal.h"
59 #include "iostat.h"
60 #include "pnfs.h"
62 #define NFSDBG_FACILITY NFSDBG_VFS
64 static struct kmem_cache *nfs_direct_cachep;
67 * This represents a set of asynchronous requests that we're waiting on
69 struct nfs_direct_mirror {
70 ssize_t count;
73 struct nfs_direct_req {
74 struct kref kref; /* release manager */
76 /* I/O parameters */
77 struct nfs_open_context *ctx; /* file open context info */
78 struct nfs_lock_context *l_ctx; /* Lock context info */
79 struct kiocb * iocb; /* controlling i/o request */
80 struct inode * inode; /* target file of i/o */
82 /* completion state */
83 atomic_t io_count; /* i/os we're waiting for */
84 spinlock_t lock; /* protect completion state */
86 struct nfs_direct_mirror mirrors[NFS_PAGEIO_DESCRIPTOR_MIRROR_MAX];
87 int mirror_count;
89 loff_t io_start; /* Start offset for I/O */
90 ssize_t count, /* bytes actually processed */
91 max_count, /* max expected count */
92 bytes_left, /* bytes left to be sent */
93 error; /* any reported error */
94 struct completion completion; /* wait for i/o completion */
96 /* commit state */
97 struct nfs_mds_commit_info mds_cinfo; /* Storage for cinfo */
98 struct pnfs_ds_commit_info ds_cinfo; /* Storage for cinfo */
99 struct work_struct work;
100 int flags;
101 #define NFS_ODIRECT_DO_COMMIT (1) /* an unstable reply was received */
102 #define NFS_ODIRECT_RESCHED_WRITES (2) /* write verification failed */
103 struct nfs_writeverf verf; /* unstable write verifier */
106 static const struct nfs_pgio_completion_ops nfs_direct_write_completion_ops;
107 static const struct nfs_commit_completion_ops nfs_direct_commit_completion_ops;
108 static void nfs_direct_write_complete(struct nfs_direct_req *dreq);
109 static void nfs_direct_write_schedule_work(struct work_struct *work);
111 static inline void get_dreq(struct nfs_direct_req *dreq)
113 atomic_inc(&dreq->io_count);
116 static inline int put_dreq(struct nfs_direct_req *dreq)
118 return atomic_dec_and_test(&dreq->io_count);
121 static void
122 nfs_direct_good_bytes(struct nfs_direct_req *dreq, struct nfs_pgio_header *hdr)
124 int i;
125 ssize_t count;
127 WARN_ON_ONCE(dreq->count >= dreq->max_count);
129 if (dreq->mirror_count == 1) {
130 dreq->mirrors[hdr->pgio_mirror_idx].count += hdr->good_bytes;
131 dreq->count += hdr->good_bytes;
132 } else {
133 /* mirrored writes */
134 count = dreq->mirrors[hdr->pgio_mirror_idx].count;
135 if (count + dreq->io_start < hdr->io_start + hdr->good_bytes) {
136 count = hdr->io_start + hdr->good_bytes - dreq->io_start;
137 dreq->mirrors[hdr->pgio_mirror_idx].count = count;
139 /* update the dreq->count by finding the minimum agreed count from all
140 * mirrors */
141 count = dreq->mirrors[0].count;
143 for (i = 1; i < dreq->mirror_count; i++)
144 count = min(count, dreq->mirrors[i].count);
146 dreq->count = count;
151 * nfs_direct_select_verf - select the right verifier
152 * @dreq - direct request possibly spanning multiple servers
153 * @ds_clp - nfs_client of data server or NULL if MDS / non-pnfs
154 * @commit_idx - commit bucket index for the DS
156 * returns the correct verifier to use given the role of the server
158 static struct nfs_writeverf *
159 nfs_direct_select_verf(struct nfs_direct_req *dreq,
160 struct nfs_client *ds_clp,
161 int commit_idx)
163 struct nfs_writeverf *verfp = &dreq->verf;
165 #ifdef CONFIG_NFS_V4_1
167 * pNFS is in use, use the DS verf except commit_through_mds is set
168 * for layout segment where nbuckets is zero.
170 if (ds_clp && dreq->ds_cinfo.nbuckets > 0) {
171 if (commit_idx >= 0 && commit_idx < dreq->ds_cinfo.nbuckets)
172 verfp = &dreq->ds_cinfo.buckets[commit_idx].direct_verf;
173 else
174 WARN_ON_ONCE(1);
176 #endif
177 return verfp;
182 * nfs_direct_set_hdr_verf - set the write/commit verifier
183 * @dreq - direct request possibly spanning multiple servers
184 * @hdr - pageio header to validate against previously seen verfs
186 * Set the server's (MDS or DS) "seen" verifier
188 static void nfs_direct_set_hdr_verf(struct nfs_direct_req *dreq,
189 struct nfs_pgio_header *hdr)
191 struct nfs_writeverf *verfp;
193 verfp = nfs_direct_select_verf(dreq, hdr->ds_clp, hdr->ds_commit_idx);
194 WARN_ON_ONCE(verfp->committed >= 0);
195 memcpy(verfp, &hdr->verf, sizeof(struct nfs_writeverf));
196 WARN_ON_ONCE(verfp->committed < 0);
199 static int nfs_direct_cmp_verf(const struct nfs_writeverf *v1,
200 const struct nfs_writeverf *v2)
202 return nfs_write_verifier_cmp(&v1->verifier, &v2->verifier);
206 * nfs_direct_cmp_hdr_verf - compare verifier for pgio header
207 * @dreq - direct request possibly spanning multiple servers
208 * @hdr - pageio header to validate against previously seen verf
210 * set the server's "seen" verf if not initialized.
211 * returns result of comparison between @hdr->verf and the "seen"
212 * verf of the server used by @hdr (DS or MDS)
214 static int nfs_direct_set_or_cmp_hdr_verf(struct nfs_direct_req *dreq,
215 struct nfs_pgio_header *hdr)
217 struct nfs_writeverf *verfp;
219 verfp = nfs_direct_select_verf(dreq, hdr->ds_clp, hdr->ds_commit_idx);
220 if (verfp->committed < 0) {
221 nfs_direct_set_hdr_verf(dreq, hdr);
222 return 0;
224 return nfs_direct_cmp_verf(verfp, &hdr->verf);
228 * nfs_direct_cmp_commit_data_verf - compare verifier for commit data
229 * @dreq - direct request possibly spanning multiple servers
230 * @data - commit data to validate against previously seen verf
232 * returns result of comparison between @data->verf and the verf of
233 * the server used by @data (DS or MDS)
235 static int nfs_direct_cmp_commit_data_verf(struct nfs_direct_req *dreq,
236 struct nfs_commit_data *data)
238 struct nfs_writeverf *verfp;
240 verfp = nfs_direct_select_verf(dreq, data->ds_clp,
241 data->ds_commit_index);
243 /* verifier not set so always fail */
244 if (verfp->committed < 0)
245 return 1;
247 return nfs_direct_cmp_verf(verfp, &data->verf);
251 * nfs_direct_IO - NFS address space operation for direct I/O
252 * @iocb: target I/O control block
253 * @iter: I/O buffer
255 * The presence of this routine in the address space ops vector means
256 * the NFS client supports direct I/O. However, for most direct IO, we
257 * shunt off direct read and write requests before the VFS gets them,
258 * so this method is only ever called for swap.
260 ssize_t nfs_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
262 struct inode *inode = iocb->ki_filp->f_mapping->host;
264 /* we only support swap file calling nfs_direct_IO */
265 if (!IS_SWAPFILE(inode))
266 return 0;
268 VM_BUG_ON(iov_iter_count(iter) != PAGE_SIZE);
270 if (iov_iter_rw(iter) == READ)
271 return nfs_file_direct_read(iocb, iter);
272 return nfs_file_direct_write(iocb, iter);
275 static void nfs_direct_release_pages(struct page **pages, unsigned int npages)
277 unsigned int i;
278 for (i = 0; i < npages; i++)
279 put_page(pages[i]);
282 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
283 struct nfs_direct_req *dreq)
285 cinfo->inode = dreq->inode;
286 cinfo->mds = &dreq->mds_cinfo;
287 cinfo->ds = &dreq->ds_cinfo;
288 cinfo->dreq = dreq;
289 cinfo->completion_ops = &nfs_direct_commit_completion_ops;
292 static inline void nfs_direct_setup_mirroring(struct nfs_direct_req *dreq,
293 struct nfs_pageio_descriptor *pgio,
294 struct nfs_page *req)
296 int mirror_count = 1;
298 if (pgio->pg_ops->pg_get_mirror_count)
299 mirror_count = pgio->pg_ops->pg_get_mirror_count(pgio, req);
301 dreq->mirror_count = mirror_count;
304 static inline struct nfs_direct_req *nfs_direct_req_alloc(void)
306 struct nfs_direct_req *dreq;
308 dreq = kmem_cache_zalloc(nfs_direct_cachep, GFP_KERNEL);
309 if (!dreq)
310 return NULL;
312 kref_init(&dreq->kref);
313 kref_get(&dreq->kref);
314 init_completion(&dreq->completion);
315 INIT_LIST_HEAD(&dreq->mds_cinfo.list);
316 dreq->verf.committed = NFS_INVALID_STABLE_HOW; /* not set yet */
317 INIT_WORK(&dreq->work, nfs_direct_write_schedule_work);
318 dreq->mirror_count = 1;
319 spin_lock_init(&dreq->lock);
321 return dreq;
324 static void nfs_direct_req_free(struct kref *kref)
326 struct nfs_direct_req *dreq = container_of(kref, struct nfs_direct_req, kref);
328 nfs_free_pnfs_ds_cinfo(&dreq->ds_cinfo);
329 if (dreq->l_ctx != NULL)
330 nfs_put_lock_context(dreq->l_ctx);
331 if (dreq->ctx != NULL)
332 put_nfs_open_context(dreq->ctx);
333 kmem_cache_free(nfs_direct_cachep, dreq);
336 static void nfs_direct_req_release(struct nfs_direct_req *dreq)
338 kref_put(&dreq->kref, nfs_direct_req_free);
341 ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq)
343 return dreq->bytes_left;
345 EXPORT_SYMBOL_GPL(nfs_dreq_bytes_left);
348 * Collects and returns the final error value/byte-count.
350 static ssize_t nfs_direct_wait(struct nfs_direct_req *dreq)
352 ssize_t result = -EIOCBQUEUED;
354 /* Async requests don't wait here */
355 if (dreq->iocb)
356 goto out;
358 result = wait_for_completion_killable(&dreq->completion);
360 if (!result) {
361 result = dreq->count;
362 WARN_ON_ONCE(dreq->count < 0);
364 if (!result)
365 result = dreq->error;
367 out:
368 return (ssize_t) result;
372 * Synchronous I/O uses a stack-allocated iocb. Thus we can't trust
373 * the iocb is still valid here if this is a synchronous request.
375 static void nfs_direct_complete(struct nfs_direct_req *dreq)
377 struct inode *inode = dreq->inode;
379 inode_dio_end(inode);
381 if (dreq->iocb) {
382 long res = (long) dreq->error;
383 if (dreq->count != 0) {
384 res = (long) dreq->count;
385 WARN_ON_ONCE(dreq->count < 0);
387 dreq->iocb->ki_complete(dreq->iocb, res, 0);
390 complete(&dreq->completion);
392 nfs_direct_req_release(dreq);
395 static void nfs_direct_read_completion(struct nfs_pgio_header *hdr)
397 unsigned long bytes = 0;
398 struct nfs_direct_req *dreq = hdr->dreq;
400 if (test_bit(NFS_IOHDR_REDO, &hdr->flags))
401 goto out_put;
403 spin_lock(&dreq->lock);
404 if (test_bit(NFS_IOHDR_ERROR, &hdr->flags) && (hdr->good_bytes == 0))
405 dreq->error = hdr->error;
406 else
407 nfs_direct_good_bytes(dreq, hdr);
409 spin_unlock(&dreq->lock);
411 while (!list_empty(&hdr->pages)) {
412 struct nfs_page *req = nfs_list_entry(hdr->pages.next);
413 struct page *page = req->wb_page;
415 if (!PageCompound(page) && bytes < hdr->good_bytes)
416 set_page_dirty(page);
417 bytes += req->wb_bytes;
418 nfs_list_remove_request(req);
419 nfs_release_request(req);
421 out_put:
422 if (put_dreq(dreq))
423 nfs_direct_complete(dreq);
424 hdr->release(hdr);
427 static void nfs_read_sync_pgio_error(struct list_head *head)
429 struct nfs_page *req;
431 while (!list_empty(head)) {
432 req = nfs_list_entry(head->next);
433 nfs_list_remove_request(req);
434 nfs_release_request(req);
438 static void nfs_direct_pgio_init(struct nfs_pgio_header *hdr)
440 get_dreq(hdr->dreq);
443 static const struct nfs_pgio_completion_ops nfs_direct_read_completion_ops = {
444 .error_cleanup = nfs_read_sync_pgio_error,
445 .init_hdr = nfs_direct_pgio_init,
446 .completion = nfs_direct_read_completion,
450 * For each rsize'd chunk of the user's buffer, dispatch an NFS READ
451 * operation. If nfs_readdata_alloc() or get_user_pages() fails,
452 * bail and stop sending more reads. Read length accounting is
453 * handled automatically by nfs_direct_read_result(). Otherwise, if
454 * no requests have been sent, just return an error.
457 static ssize_t nfs_direct_read_schedule_iovec(struct nfs_direct_req *dreq,
458 struct iov_iter *iter,
459 loff_t pos)
461 struct nfs_pageio_descriptor desc;
462 struct inode *inode = dreq->inode;
463 ssize_t result = -EINVAL;
464 size_t requested_bytes = 0;
465 size_t rsize = max_t(size_t, NFS_SERVER(inode)->rsize, PAGE_SIZE);
467 nfs_pageio_init_read(&desc, dreq->inode, false,
468 &nfs_direct_read_completion_ops);
469 get_dreq(dreq);
470 desc.pg_dreq = dreq;
471 inode_dio_begin(inode);
473 while (iov_iter_count(iter)) {
474 struct page **pagevec;
475 size_t bytes;
476 size_t pgbase;
477 unsigned npages, i;
479 result = iov_iter_get_pages_alloc(iter, &pagevec,
480 rsize, &pgbase);
481 if (result < 0)
482 break;
484 bytes = result;
485 iov_iter_advance(iter, bytes);
486 npages = (result + pgbase + PAGE_SIZE - 1) / PAGE_SIZE;
487 for (i = 0; i < npages; i++) {
488 struct nfs_page *req;
489 unsigned int req_len = min_t(size_t, bytes, PAGE_SIZE - pgbase);
490 /* XXX do we need to do the eof zeroing found in async_filler? */
491 req = nfs_create_request(dreq->ctx, pagevec[i], NULL,
492 pgbase, req_len);
493 if (IS_ERR(req)) {
494 result = PTR_ERR(req);
495 break;
497 req->wb_index = pos >> PAGE_SHIFT;
498 req->wb_offset = pos & ~PAGE_MASK;
499 if (!nfs_pageio_add_request(&desc, req)) {
500 result = desc.pg_error;
501 nfs_release_request(req);
502 break;
504 pgbase = 0;
505 bytes -= req_len;
506 requested_bytes += req_len;
507 pos += req_len;
508 dreq->bytes_left -= req_len;
510 nfs_direct_release_pages(pagevec, npages);
511 kvfree(pagevec);
512 if (result < 0)
513 break;
516 nfs_pageio_complete(&desc);
519 * If no bytes were started, return the error, and let the
520 * generic layer handle the completion.
522 if (requested_bytes == 0) {
523 inode_dio_end(inode);
524 nfs_direct_req_release(dreq);
525 return result < 0 ? result : -EIO;
528 if (put_dreq(dreq))
529 nfs_direct_complete(dreq);
530 return requested_bytes;
534 * nfs_file_direct_read - file direct read operation for NFS files
535 * @iocb: target I/O control block
536 * @iter: vector of user buffers into which to read data
538 * We use this function for direct reads instead of calling
539 * generic_file_aio_read() in order to avoid gfar's check to see if
540 * the request starts before the end of the file. For that check
541 * to work, we must generate a GETATTR before each direct read, and
542 * even then there is a window between the GETATTR and the subsequent
543 * READ where the file size could change. Our preference is simply
544 * to do all reads the application wants, and the server will take
545 * care of managing the end of file boundary.
547 * This function also eliminates unnecessarily updating the file's
548 * atime locally, as the NFS server sets the file's atime, and this
549 * client must read the updated atime from the server back into its
550 * cache.
552 ssize_t nfs_file_direct_read(struct kiocb *iocb, struct iov_iter *iter)
554 struct file *file = iocb->ki_filp;
555 struct address_space *mapping = file->f_mapping;
556 struct inode *inode = mapping->host;
557 struct nfs_direct_req *dreq;
558 struct nfs_lock_context *l_ctx;
559 ssize_t result = -EINVAL, requested;
560 size_t count = iov_iter_count(iter);
561 nfs_add_stats(mapping->host, NFSIOS_DIRECTREADBYTES, count);
563 dfprintk(FILE, "NFS: direct read(%pD2, %zd@%Ld)\n",
564 file, count, (long long) iocb->ki_pos);
566 result = 0;
567 if (!count)
568 goto out;
570 task_io_account_read(count);
572 result = -ENOMEM;
573 dreq = nfs_direct_req_alloc();
574 if (dreq == NULL)
575 goto out;
577 dreq->inode = inode;
578 dreq->bytes_left = dreq->max_count = count;
579 dreq->io_start = iocb->ki_pos;
580 dreq->ctx = get_nfs_open_context(nfs_file_open_context(iocb->ki_filp));
581 l_ctx = nfs_get_lock_context(dreq->ctx);
582 if (IS_ERR(l_ctx)) {
583 result = PTR_ERR(l_ctx);
584 goto out_release;
586 dreq->l_ctx = l_ctx;
587 if (!is_sync_kiocb(iocb))
588 dreq->iocb = iocb;
590 nfs_start_io_direct(inode);
592 NFS_I(inode)->read_io += count;
593 requested = nfs_direct_read_schedule_iovec(dreq, iter, iocb->ki_pos);
595 nfs_end_io_direct(inode);
597 if (requested > 0) {
598 result = nfs_direct_wait(dreq);
599 if (result > 0) {
600 requested -= result;
601 iocb->ki_pos += result;
603 iov_iter_revert(iter, requested);
604 } else {
605 result = requested;
608 out_release:
609 nfs_direct_req_release(dreq);
610 out:
611 return result;
614 static void
615 nfs_direct_write_scan_commit_list(struct inode *inode,
616 struct list_head *list,
617 struct nfs_commit_info *cinfo)
619 mutex_lock(&NFS_I(cinfo->inode)->commit_mutex);
620 #ifdef CONFIG_NFS_V4_1
621 if (cinfo->ds != NULL && cinfo->ds->nwritten != 0)
622 NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
623 #endif
624 nfs_scan_commit_list(&cinfo->mds->list, list, cinfo, 0);
625 mutex_unlock(&NFS_I(cinfo->inode)->commit_mutex);
628 static void nfs_direct_write_reschedule(struct nfs_direct_req *dreq)
630 struct nfs_pageio_descriptor desc;
631 struct nfs_page *req, *tmp;
632 LIST_HEAD(reqs);
633 struct nfs_commit_info cinfo;
634 LIST_HEAD(failed);
635 int i;
637 nfs_init_cinfo_from_dreq(&cinfo, dreq);
638 nfs_direct_write_scan_commit_list(dreq->inode, &reqs, &cinfo);
640 dreq->count = 0;
641 dreq->verf.committed = NFS_INVALID_STABLE_HOW;
642 nfs_clear_pnfs_ds_commit_verifiers(&dreq->ds_cinfo);
643 for (i = 0; i < dreq->mirror_count; i++)
644 dreq->mirrors[i].count = 0;
645 get_dreq(dreq);
647 nfs_pageio_init_write(&desc, dreq->inode, FLUSH_STABLE, false,
648 &nfs_direct_write_completion_ops);
649 desc.pg_dreq = dreq;
651 req = nfs_list_entry(reqs.next);
652 nfs_direct_setup_mirroring(dreq, &desc, req);
653 if (desc.pg_error < 0) {
654 list_splice_init(&reqs, &failed);
655 goto out_failed;
658 list_for_each_entry_safe(req, tmp, &reqs, wb_list) {
659 if (!nfs_pageio_add_request(&desc, req)) {
660 nfs_list_remove_request(req);
661 nfs_list_add_request(req, &failed);
662 spin_lock(&cinfo.inode->i_lock);
663 dreq->flags = 0;
664 if (desc.pg_error < 0)
665 dreq->error = desc.pg_error;
666 else
667 dreq->error = -EIO;
668 spin_unlock(&cinfo.inode->i_lock);
670 nfs_release_request(req);
672 nfs_pageio_complete(&desc);
674 out_failed:
675 while (!list_empty(&failed)) {
676 req = nfs_list_entry(failed.next);
677 nfs_list_remove_request(req);
678 nfs_unlock_and_release_request(req);
681 if (put_dreq(dreq))
682 nfs_direct_write_complete(dreq);
685 static void nfs_direct_commit_complete(struct nfs_commit_data *data)
687 struct nfs_direct_req *dreq = data->dreq;
688 struct nfs_commit_info cinfo;
689 struct nfs_page *req;
690 int status = data->task.tk_status;
692 nfs_init_cinfo_from_dreq(&cinfo, dreq);
693 if (status < 0 || nfs_direct_cmp_commit_data_verf(dreq, data))
694 dreq->flags = NFS_ODIRECT_RESCHED_WRITES;
696 while (!list_empty(&data->pages)) {
697 req = nfs_list_entry(data->pages.next);
698 nfs_list_remove_request(req);
699 if (dreq->flags == NFS_ODIRECT_RESCHED_WRITES) {
700 /* Note the rewrite will go through mds */
701 nfs_mark_request_commit(req, NULL, &cinfo, 0);
702 } else
703 nfs_release_request(req);
704 nfs_unlock_and_release_request(req);
707 if (atomic_dec_and_test(&cinfo.mds->rpcs_out))
708 nfs_direct_write_complete(dreq);
711 static void nfs_direct_resched_write(struct nfs_commit_info *cinfo,
712 struct nfs_page *req)
714 struct nfs_direct_req *dreq = cinfo->dreq;
716 spin_lock(&dreq->lock);
717 dreq->flags = NFS_ODIRECT_RESCHED_WRITES;
718 spin_unlock(&dreq->lock);
719 nfs_mark_request_commit(req, NULL, cinfo, 0);
722 static const struct nfs_commit_completion_ops nfs_direct_commit_completion_ops = {
723 .completion = nfs_direct_commit_complete,
724 .resched_write = nfs_direct_resched_write,
727 static void nfs_direct_commit_schedule(struct nfs_direct_req *dreq)
729 int res;
730 struct nfs_commit_info cinfo;
731 LIST_HEAD(mds_list);
733 nfs_init_cinfo_from_dreq(&cinfo, dreq);
734 nfs_scan_commit(dreq->inode, &mds_list, &cinfo);
735 res = nfs_generic_commit_list(dreq->inode, &mds_list, 0, &cinfo);
736 if (res < 0) /* res == -ENOMEM */
737 nfs_direct_write_reschedule(dreq);
740 static void nfs_direct_write_schedule_work(struct work_struct *work)
742 struct nfs_direct_req *dreq = container_of(work, struct nfs_direct_req, work);
743 int flags = dreq->flags;
745 dreq->flags = 0;
746 switch (flags) {
747 case NFS_ODIRECT_DO_COMMIT:
748 nfs_direct_commit_schedule(dreq);
749 break;
750 case NFS_ODIRECT_RESCHED_WRITES:
751 nfs_direct_write_reschedule(dreq);
752 break;
753 default:
754 nfs_zap_mapping(dreq->inode, dreq->inode->i_mapping);
755 nfs_direct_complete(dreq);
759 static void nfs_direct_write_complete(struct nfs_direct_req *dreq)
761 schedule_work(&dreq->work); /* Calls nfs_direct_write_schedule_work */
764 static void nfs_direct_write_completion(struct nfs_pgio_header *hdr)
766 struct nfs_direct_req *dreq = hdr->dreq;
767 struct nfs_commit_info cinfo;
768 bool request_commit = false;
769 struct nfs_page *req = nfs_list_entry(hdr->pages.next);
771 if (test_bit(NFS_IOHDR_REDO, &hdr->flags))
772 goto out_put;
774 nfs_init_cinfo_from_dreq(&cinfo, dreq);
776 spin_lock(&dreq->lock);
778 if (test_bit(NFS_IOHDR_ERROR, &hdr->flags))
779 dreq->error = hdr->error;
780 if (dreq->error == 0) {
781 nfs_direct_good_bytes(dreq, hdr);
782 if (nfs_write_need_commit(hdr)) {
783 if (dreq->flags == NFS_ODIRECT_RESCHED_WRITES)
784 request_commit = true;
785 else if (dreq->flags == 0) {
786 nfs_direct_set_hdr_verf(dreq, hdr);
787 request_commit = true;
788 dreq->flags = NFS_ODIRECT_DO_COMMIT;
789 } else if (dreq->flags == NFS_ODIRECT_DO_COMMIT) {
790 request_commit = true;
791 if (nfs_direct_set_or_cmp_hdr_verf(dreq, hdr))
792 dreq->flags =
793 NFS_ODIRECT_RESCHED_WRITES;
797 spin_unlock(&dreq->lock);
799 while (!list_empty(&hdr->pages)) {
801 req = nfs_list_entry(hdr->pages.next);
802 nfs_list_remove_request(req);
803 if (request_commit) {
804 kref_get(&req->wb_kref);
805 nfs_mark_request_commit(req, hdr->lseg, &cinfo,
806 hdr->ds_commit_idx);
808 nfs_unlock_and_release_request(req);
811 out_put:
812 if (put_dreq(dreq))
813 nfs_direct_write_complete(dreq);
814 hdr->release(hdr);
817 static void nfs_write_sync_pgio_error(struct list_head *head)
819 struct nfs_page *req;
821 while (!list_empty(head)) {
822 req = nfs_list_entry(head->next);
823 nfs_list_remove_request(req);
824 nfs_unlock_and_release_request(req);
828 static void nfs_direct_write_reschedule_io(struct nfs_pgio_header *hdr)
830 struct nfs_direct_req *dreq = hdr->dreq;
832 spin_lock(&dreq->lock);
833 if (dreq->error == 0) {
834 dreq->flags = NFS_ODIRECT_RESCHED_WRITES;
835 /* fake unstable write to let common nfs resend pages */
836 hdr->verf.committed = NFS_UNSTABLE;
837 hdr->good_bytes = hdr->args.count;
839 spin_unlock(&dreq->lock);
842 static const struct nfs_pgio_completion_ops nfs_direct_write_completion_ops = {
843 .error_cleanup = nfs_write_sync_pgio_error,
844 .init_hdr = nfs_direct_pgio_init,
845 .completion = nfs_direct_write_completion,
846 .reschedule_io = nfs_direct_write_reschedule_io,
851 * NB: Return the value of the first error return code. Subsequent
852 * errors after the first one are ignored.
855 * For each wsize'd chunk of the user's buffer, dispatch an NFS WRITE
856 * operation. If nfs_writedata_alloc() or get_user_pages() fails,
857 * bail and stop sending more writes. Write length accounting is
858 * handled automatically by nfs_direct_write_result(). Otherwise, if
859 * no requests have been sent, just return an error.
861 static ssize_t nfs_direct_write_schedule_iovec(struct nfs_direct_req *dreq,
862 struct iov_iter *iter,
863 loff_t pos)
865 struct nfs_pageio_descriptor desc;
866 struct inode *inode = dreq->inode;
867 ssize_t result = 0;
868 size_t requested_bytes = 0;
869 size_t wsize = max_t(size_t, NFS_SERVER(inode)->wsize, PAGE_SIZE);
871 nfs_pageio_init_write(&desc, inode, FLUSH_COND_STABLE, false,
872 &nfs_direct_write_completion_ops);
873 desc.pg_dreq = dreq;
874 get_dreq(dreq);
875 inode_dio_begin(inode);
877 NFS_I(inode)->write_io += iov_iter_count(iter);
878 while (iov_iter_count(iter)) {
879 struct page **pagevec;
880 size_t bytes;
881 size_t pgbase;
882 unsigned npages, i;
884 result = iov_iter_get_pages_alloc(iter, &pagevec,
885 wsize, &pgbase);
886 if (result < 0)
887 break;
889 bytes = result;
890 iov_iter_advance(iter, bytes);
891 npages = (result + pgbase + PAGE_SIZE - 1) / PAGE_SIZE;
892 for (i = 0; i < npages; i++) {
893 struct nfs_page *req;
894 unsigned int req_len = min_t(size_t, bytes, PAGE_SIZE - pgbase);
896 req = nfs_create_request(dreq->ctx, pagevec[i], NULL,
897 pgbase, req_len);
898 if (IS_ERR(req)) {
899 result = PTR_ERR(req);
900 break;
903 nfs_direct_setup_mirroring(dreq, &desc, req);
904 if (desc.pg_error < 0) {
905 nfs_free_request(req);
906 result = desc.pg_error;
907 break;
910 nfs_lock_request(req);
911 req->wb_index = pos >> PAGE_SHIFT;
912 req->wb_offset = pos & ~PAGE_MASK;
913 if (!nfs_pageio_add_request(&desc, req)) {
914 result = desc.pg_error;
915 nfs_unlock_and_release_request(req);
916 break;
918 pgbase = 0;
919 bytes -= req_len;
920 requested_bytes += req_len;
921 pos += req_len;
922 dreq->bytes_left -= req_len;
924 nfs_direct_release_pages(pagevec, npages);
925 kvfree(pagevec);
926 if (result < 0)
927 break;
929 nfs_pageio_complete(&desc);
932 * If no bytes were started, return the error, and let the
933 * generic layer handle the completion.
935 if (requested_bytes == 0) {
936 inode_dio_end(inode);
937 nfs_direct_req_release(dreq);
938 return result < 0 ? result : -EIO;
941 if (put_dreq(dreq))
942 nfs_direct_write_complete(dreq);
943 return requested_bytes;
947 * nfs_file_direct_write - file direct write operation for NFS files
948 * @iocb: target I/O control block
949 * @iter: vector of user buffers from which to write data
951 * We use this function for direct writes instead of calling
952 * generic_file_aio_write() in order to avoid taking the inode
953 * semaphore and updating the i_size. The NFS server will set
954 * the new i_size and this client must read the updated size
955 * back into its cache. We let the server do generic write
956 * parameter checking and report problems.
958 * We eliminate local atime updates, see direct read above.
960 * We avoid unnecessary page cache invalidations for normal cached
961 * readers of this file.
963 * Note that O_APPEND is not supported for NFS direct writes, as there
964 * is no atomic O_APPEND write facility in the NFS protocol.
966 ssize_t nfs_file_direct_write(struct kiocb *iocb, struct iov_iter *iter)
968 ssize_t result = -EINVAL, requested;
969 size_t count;
970 struct file *file = iocb->ki_filp;
971 struct address_space *mapping = file->f_mapping;
972 struct inode *inode = mapping->host;
973 struct nfs_direct_req *dreq;
974 struct nfs_lock_context *l_ctx;
975 loff_t pos, end;
977 dfprintk(FILE, "NFS: direct write(%pD2, %zd@%Ld)\n",
978 file, iov_iter_count(iter), (long long) iocb->ki_pos);
980 result = generic_write_checks(iocb, iter);
981 if (result <= 0)
982 return result;
983 count = result;
984 nfs_add_stats(mapping->host, NFSIOS_DIRECTWRITTENBYTES, count);
986 pos = iocb->ki_pos;
987 end = (pos + iov_iter_count(iter) - 1) >> PAGE_SHIFT;
989 task_io_account_write(count);
991 result = -ENOMEM;
992 dreq = nfs_direct_req_alloc();
993 if (!dreq)
994 goto out;
996 dreq->inode = inode;
997 dreq->bytes_left = dreq->max_count = count;
998 dreq->io_start = pos;
999 dreq->ctx = get_nfs_open_context(nfs_file_open_context(iocb->ki_filp));
1000 l_ctx = nfs_get_lock_context(dreq->ctx);
1001 if (IS_ERR(l_ctx)) {
1002 result = PTR_ERR(l_ctx);
1003 goto out_release;
1005 dreq->l_ctx = l_ctx;
1006 if (!is_sync_kiocb(iocb))
1007 dreq->iocb = iocb;
1009 nfs_start_io_direct(inode);
1011 requested = nfs_direct_write_schedule_iovec(dreq, iter, pos);
1013 if (mapping->nrpages) {
1014 invalidate_inode_pages2_range(mapping,
1015 pos >> PAGE_SHIFT, end);
1018 nfs_end_io_direct(inode);
1020 if (requested > 0) {
1021 result = nfs_direct_wait(dreq);
1022 if (result > 0) {
1023 requested -= result;
1024 iocb->ki_pos = pos + result;
1025 /* XXX: should check the generic_write_sync retval */
1026 generic_write_sync(iocb, result);
1028 iov_iter_revert(iter, requested);
1029 } else {
1030 result = requested;
1032 out_release:
1033 nfs_direct_req_release(dreq);
1034 out:
1035 return result;
1039 * nfs_init_directcache - create a slab cache for nfs_direct_req structures
1042 int __init nfs_init_directcache(void)
1044 nfs_direct_cachep = kmem_cache_create("nfs_direct_cache",
1045 sizeof(struct nfs_direct_req),
1046 0, (SLAB_RECLAIM_ACCOUNT|
1047 SLAB_MEM_SPREAD),
1048 NULL);
1049 if (nfs_direct_cachep == NULL)
1050 return -ENOMEM;
1052 return 0;
1056 * nfs_destroy_directcache - destroy the slab cache for nfs_direct_req structures
1059 void nfs_destroy_directcache(void)
1061 kmem_cache_destroy(nfs_direct_cachep);