xref: /openbmc/linux/fs/nfs/direct.c (revision b03afaa8)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * linux/fs/nfs/direct.c
4  *
5  * Copyright (C) 2003 by Chuck Lever <cel@netapp.com>
6  *
7  * High-performance uncached I/O for the Linux NFS client
8  *
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.
17  *
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
23  * an application.
24  *
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.
29  *
30  * Designed by Jeff Kimmel, Chuck Lever, and Trond Myklebust, with
31  * help from Andrew Morton.
32  *
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
39  *
40  */
41 
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>
51 
52 #include <linux/nfs_fs.h>
53 #include <linux/nfs_page.h>
54 #include <linux/sunrpc/clnt.h>
55 
56 #include <linux/uaccess.h>
57 #include <linux/atomic.h>
58 
59 #include "internal.h"
60 #include "iostat.h"
61 #include "pnfs.h"
62 
63 #define NFSDBG_FACILITY		NFSDBG_VFS
64 
65 static struct kmem_cache *nfs_direct_cachep;
66 
67 struct nfs_direct_req {
68 	struct kref		kref;		/* release manager */
69 
70 	/* I/O parameters */
71 	struct nfs_open_context	*ctx;		/* file open context info */
72 	struct nfs_lock_context *l_ctx;		/* Lock context info */
73 	struct kiocb *		iocb;		/* controlling i/o request */
74 	struct inode *		inode;		/* target file of i/o */
75 
76 	/* completion state */
77 	atomic_t		io_count;	/* i/os we're waiting for */
78 	spinlock_t		lock;		/* protect completion state */
79 
80 	loff_t			io_start;	/* Start offset for I/O */
81 	ssize_t			count,		/* bytes actually processed */
82 				max_count,	/* max expected count */
83 				bytes_left,	/* bytes left to be sent */
84 				error;		/* any reported error */
85 	struct completion	completion;	/* wait for i/o completion */
86 
87 	/* commit state */
88 	struct nfs_mds_commit_info mds_cinfo;	/* Storage for cinfo */
89 	struct pnfs_ds_commit_info ds_cinfo;	/* Storage for cinfo */
90 	struct work_struct	work;
91 	int			flags;
92 	/* for write */
93 #define NFS_ODIRECT_DO_COMMIT		(1)	/* an unstable reply was received */
94 #define NFS_ODIRECT_RESCHED_WRITES	(2)	/* write verification failed */
95 	/* for read */
96 #define NFS_ODIRECT_SHOULD_DIRTY	(3)	/* dirty user-space page after read */
97 #define NFS_ODIRECT_DONE		INT_MAX	/* write verification failed */
98 };
99 
100 static const struct nfs_pgio_completion_ops nfs_direct_write_completion_ops;
101 static const struct nfs_commit_completion_ops nfs_direct_commit_completion_ops;
102 static void nfs_direct_write_complete(struct nfs_direct_req *dreq);
103 static void nfs_direct_write_schedule_work(struct work_struct *work);
104 
105 static inline void get_dreq(struct nfs_direct_req *dreq)
106 {
107 	atomic_inc(&dreq->io_count);
108 }
109 
110 static inline int put_dreq(struct nfs_direct_req *dreq)
111 {
112 	return atomic_dec_and_test(&dreq->io_count);
113 }
114 
115 static void
116 nfs_direct_handle_truncated(struct nfs_direct_req *dreq,
117 			    const struct nfs_pgio_header *hdr,
118 			    ssize_t dreq_len)
119 {
120 	if (!(test_bit(NFS_IOHDR_ERROR, &hdr->flags) ||
121 	      test_bit(NFS_IOHDR_EOF, &hdr->flags)))
122 		return;
123 	if (dreq->max_count >= dreq_len) {
124 		dreq->max_count = dreq_len;
125 		if (dreq->count > dreq_len)
126 			dreq->count = dreq_len;
127 
128 		if (test_bit(NFS_IOHDR_ERROR, &hdr->flags))
129 			dreq->error = hdr->error;
130 		else /* Clear outstanding error if this is EOF */
131 			dreq->error = 0;
132 	}
133 }
134 
135 static void
136 nfs_direct_count_bytes(struct nfs_direct_req *dreq,
137 		       const struct nfs_pgio_header *hdr)
138 {
139 	loff_t hdr_end = hdr->io_start + hdr->good_bytes;
140 	ssize_t dreq_len = 0;
141 
142 	if (hdr_end > dreq->io_start)
143 		dreq_len = hdr_end - dreq->io_start;
144 
145 	nfs_direct_handle_truncated(dreq, hdr, dreq_len);
146 
147 	if (dreq_len > dreq->max_count)
148 		dreq_len = dreq->max_count;
149 
150 	if (dreq->count < dreq_len)
151 		dreq->count = dreq_len;
152 }
153 
154 /**
155  * nfs_direct_IO - NFS address space operation for direct I/O
156  * @iocb: target I/O control block
157  * @iter: I/O buffer
158  *
159  * The presence of this routine in the address space ops vector means
160  * the NFS client supports direct I/O. However, for most direct IO, we
161  * shunt off direct read and write requests before the VFS gets them,
162  * so this method is only ever called for swap.
163  */
164 ssize_t nfs_direct_IO(struct kiocb *iocb, struct iov_iter *iter)
165 {
166 	struct inode *inode = iocb->ki_filp->f_mapping->host;
167 
168 	/* we only support swap file calling nfs_direct_IO */
169 	if (!IS_SWAPFILE(inode))
170 		return 0;
171 
172 	VM_BUG_ON(iov_iter_count(iter) != PAGE_SIZE);
173 
174 	if (iov_iter_rw(iter) == READ)
175 		return nfs_file_direct_read(iocb, iter);
176 	return nfs_file_direct_write(iocb, iter);
177 }
178 
179 static void nfs_direct_release_pages(struct page **pages, unsigned int npages)
180 {
181 	unsigned int i;
182 	for (i = 0; i < npages; i++)
183 		put_page(pages[i]);
184 }
185 
186 void nfs_init_cinfo_from_dreq(struct nfs_commit_info *cinfo,
187 			      struct nfs_direct_req *dreq)
188 {
189 	cinfo->inode = dreq->inode;
190 	cinfo->mds = &dreq->mds_cinfo;
191 	cinfo->ds = &dreq->ds_cinfo;
192 	cinfo->dreq = dreq;
193 	cinfo->completion_ops = &nfs_direct_commit_completion_ops;
194 }
195 
196 static inline struct nfs_direct_req *nfs_direct_req_alloc(void)
197 {
198 	struct nfs_direct_req *dreq;
199 
200 	dreq = kmem_cache_zalloc(nfs_direct_cachep, GFP_KERNEL);
201 	if (!dreq)
202 		return NULL;
203 
204 	kref_init(&dreq->kref);
205 	kref_get(&dreq->kref);
206 	init_completion(&dreq->completion);
207 	INIT_LIST_HEAD(&dreq->mds_cinfo.list);
208 	pnfs_init_ds_commit_info(&dreq->ds_cinfo);
209 	INIT_WORK(&dreq->work, nfs_direct_write_schedule_work);
210 	spin_lock_init(&dreq->lock);
211 
212 	return dreq;
213 }
214 
215 static void nfs_direct_req_free(struct kref *kref)
216 {
217 	struct nfs_direct_req *dreq = container_of(kref, struct nfs_direct_req, kref);
218 
219 	pnfs_release_ds_info(&dreq->ds_cinfo, dreq->inode);
220 	if (dreq->l_ctx != NULL)
221 		nfs_put_lock_context(dreq->l_ctx);
222 	if (dreq->ctx != NULL)
223 		put_nfs_open_context(dreq->ctx);
224 	kmem_cache_free(nfs_direct_cachep, dreq);
225 }
226 
227 static void nfs_direct_req_release(struct nfs_direct_req *dreq)
228 {
229 	kref_put(&dreq->kref, nfs_direct_req_free);
230 }
231 
232 ssize_t nfs_dreq_bytes_left(struct nfs_direct_req *dreq)
233 {
234 	return dreq->bytes_left;
235 }
236 EXPORT_SYMBOL_GPL(nfs_dreq_bytes_left);
237 
238 /*
239  * Collects and returns the final error value/byte-count.
240  */
241 static ssize_t nfs_direct_wait(struct nfs_direct_req *dreq)
242 {
243 	ssize_t result = -EIOCBQUEUED;
244 
245 	/* Async requests don't wait here */
246 	if (dreq->iocb)
247 		goto out;
248 
249 	result = wait_for_completion_killable(&dreq->completion);
250 
251 	if (!result) {
252 		result = dreq->count;
253 		WARN_ON_ONCE(dreq->count < 0);
254 	}
255 	if (!result)
256 		result = dreq->error;
257 
258 out:
259 	return (ssize_t) result;
260 }
261 
262 /*
263  * Synchronous I/O uses a stack-allocated iocb.  Thus we can't trust
264  * the iocb is still valid here if this is a synchronous request.
265  */
266 static void nfs_direct_complete(struct nfs_direct_req *dreq)
267 {
268 	struct inode *inode = dreq->inode;
269 
270 	if (dreq->iocb) {
271 		long res = (long) dreq->error;
272 		if (dreq->count != 0) {
273 			res = (long) dreq->count;
274 			WARN_ON_ONCE(dreq->count < 0);
275 		}
276 		dreq->iocb->ki_complete(dreq->iocb, res, 0);
277 	}
278 
279 	complete(&dreq->completion);
280 
281 	igrab(inode);
282 	nfs_direct_req_release(dreq);
283 	inode_dio_end(inode);
284 	iput(inode);
285 }
286 
287 static void nfs_direct_read_completion(struct nfs_pgio_header *hdr)
288 {
289 	unsigned long bytes = 0;
290 	struct nfs_direct_req *dreq = hdr->dreq;
291 
292 	spin_lock(&dreq->lock);
293 	if (test_bit(NFS_IOHDR_REDO, &hdr->flags)) {
294 		spin_unlock(&dreq->lock);
295 		goto out_put;
296 	}
297 
298 	nfs_direct_count_bytes(dreq, hdr);
299 	spin_unlock(&dreq->lock);
300 
301 	while (!list_empty(&hdr->pages)) {
302 		struct nfs_page *req = nfs_list_entry(hdr->pages.next);
303 		struct page *page = req->wb_page;
304 
305 		if (!PageCompound(page) && bytes < hdr->good_bytes &&
306 		    (dreq->flags == NFS_ODIRECT_SHOULD_DIRTY))
307 			set_page_dirty(page);
308 		bytes += req->wb_bytes;
309 		nfs_list_remove_request(req);
310 		nfs_release_request(req);
311 	}
312 out_put:
313 	if (put_dreq(dreq))
314 		nfs_direct_complete(dreq);
315 	hdr->release(hdr);
316 }
317 
318 static void nfs_read_sync_pgio_error(struct list_head *head, int error)
319 {
320 	struct nfs_page *req;
321 
322 	while (!list_empty(head)) {
323 		req = nfs_list_entry(head->next);
324 		nfs_list_remove_request(req);
325 		nfs_release_request(req);
326 	}
327 }
328 
329 static void nfs_direct_pgio_init(struct nfs_pgio_header *hdr)
330 {
331 	get_dreq(hdr->dreq);
332 }
333 
334 static const struct nfs_pgio_completion_ops nfs_direct_read_completion_ops = {
335 	.error_cleanup = nfs_read_sync_pgio_error,
336 	.init_hdr = nfs_direct_pgio_init,
337 	.completion = nfs_direct_read_completion,
338 };
339 
340 /*
341  * For each rsize'd chunk of the user's buffer, dispatch an NFS READ
342  * operation.  If nfs_readdata_alloc() or get_user_pages() fails,
343  * bail and stop sending more reads.  Read length accounting is
344  * handled automatically by nfs_direct_read_result().  Otherwise, if
345  * no requests have been sent, just return an error.
346  */
347 
348 static ssize_t nfs_direct_read_schedule_iovec(struct nfs_direct_req *dreq,
349 					      struct iov_iter *iter,
350 					      loff_t pos)
351 {
352 	struct nfs_pageio_descriptor desc;
353 	struct inode *inode = dreq->inode;
354 	ssize_t result = -EINVAL;
355 	size_t requested_bytes = 0;
356 	size_t rsize = max_t(size_t, NFS_SERVER(inode)->rsize, PAGE_SIZE);
357 
358 	nfs_pageio_init_read(&desc, dreq->inode, false,
359 			     &nfs_direct_read_completion_ops);
360 	get_dreq(dreq);
361 	desc.pg_dreq = dreq;
362 	inode_dio_begin(inode);
363 
364 	while (iov_iter_count(iter)) {
365 		struct page **pagevec;
366 		size_t bytes;
367 		size_t pgbase;
368 		unsigned npages, i;
369 
370 		result = iov_iter_get_pages_alloc(iter, &pagevec,
371 						  rsize, &pgbase);
372 		if (result < 0)
373 			break;
374 
375 		bytes = result;
376 		iov_iter_advance(iter, bytes);
377 		npages = (result + pgbase + PAGE_SIZE - 1) / PAGE_SIZE;
378 		for (i = 0; i < npages; i++) {
379 			struct nfs_page *req;
380 			unsigned int req_len = min_t(size_t, bytes, PAGE_SIZE - pgbase);
381 			/* XXX do we need to do the eof zeroing found in async_filler? */
382 			req = nfs_create_request(dreq->ctx, pagevec[i],
383 						 pgbase, req_len);
384 			if (IS_ERR(req)) {
385 				result = PTR_ERR(req);
386 				break;
387 			}
388 			req->wb_index = pos >> PAGE_SHIFT;
389 			req->wb_offset = pos & ~PAGE_MASK;
390 			if (!nfs_pageio_add_request(&desc, req)) {
391 				result = desc.pg_error;
392 				nfs_release_request(req);
393 				break;
394 			}
395 			pgbase = 0;
396 			bytes -= req_len;
397 			requested_bytes += req_len;
398 			pos += req_len;
399 			dreq->bytes_left -= req_len;
400 		}
401 		nfs_direct_release_pages(pagevec, npages);
402 		kvfree(pagevec);
403 		if (result < 0)
404 			break;
405 	}
406 
407 	nfs_pageio_complete(&desc);
408 
409 	/*
410 	 * If no bytes were started, return the error, and let the
411 	 * generic layer handle the completion.
412 	 */
413 	if (requested_bytes == 0) {
414 		igrab(inode);
415 		nfs_direct_req_release(dreq);
416 		inode_dio_end(inode);
417 		iput(inode);
418 		return result < 0 ? result : -EIO;
419 	}
420 
421 	if (put_dreq(dreq))
422 		nfs_direct_complete(dreq);
423 	return requested_bytes;
424 }
425 
426 /**
427  * nfs_file_direct_read - file direct read operation for NFS files
428  * @iocb: target I/O control block
429  * @iter: vector of user buffers into which to read data
430  *
431  * We use this function for direct reads instead of calling
432  * generic_file_aio_read() in order to avoid gfar's check to see if
433  * the request starts before the end of the file.  For that check
434  * to work, we must generate a GETATTR before each direct read, and
435  * even then there is a window between the GETATTR and the subsequent
436  * READ where the file size could change.  Our preference is simply
437  * to do all reads the application wants, and the server will take
438  * care of managing the end of file boundary.
439  *
440  * This function also eliminates unnecessarily updating the file's
441  * atime locally, as the NFS server sets the file's atime, and this
442  * client must read the updated atime from the server back into its
443  * cache.
444  */
445 ssize_t nfs_file_direct_read(struct kiocb *iocb, struct iov_iter *iter)
446 {
447 	struct file *file = iocb->ki_filp;
448 	struct address_space *mapping = file->f_mapping;
449 	struct inode *inode = mapping->host;
450 	struct nfs_direct_req *dreq;
451 	struct nfs_lock_context *l_ctx;
452 	ssize_t result, requested;
453 	size_t count = iov_iter_count(iter);
454 	nfs_add_stats(mapping->host, NFSIOS_DIRECTREADBYTES, count);
455 
456 	dfprintk(FILE, "NFS: direct read(%pD2, %zd@%Ld)\n",
457 		file, count, (long long) iocb->ki_pos);
458 
459 	result = 0;
460 	if (!count)
461 		goto out;
462 
463 	task_io_account_read(count);
464 
465 	result = -ENOMEM;
466 	dreq = nfs_direct_req_alloc();
467 	if (dreq == NULL)
468 		goto out;
469 
470 	dreq->inode = inode;
471 	dreq->bytes_left = dreq->max_count = count;
472 	dreq->io_start = iocb->ki_pos;
473 	dreq->ctx = get_nfs_open_context(nfs_file_open_context(iocb->ki_filp));
474 	l_ctx = nfs_get_lock_context(dreq->ctx);
475 	if (IS_ERR(l_ctx)) {
476 		result = PTR_ERR(l_ctx);
477 		nfs_direct_req_release(dreq);
478 		goto out_release;
479 	}
480 	dreq->l_ctx = l_ctx;
481 	if (!is_sync_kiocb(iocb))
482 		dreq->iocb = iocb;
483 
484 	if (iter_is_iovec(iter))
485 		dreq->flags = NFS_ODIRECT_SHOULD_DIRTY;
486 
487 	nfs_start_io_direct(inode);
488 
489 	NFS_I(inode)->read_io += count;
490 	requested = nfs_direct_read_schedule_iovec(dreq, iter, iocb->ki_pos);
491 
492 	nfs_end_io_direct(inode);
493 
494 	if (requested > 0) {
495 		result = nfs_direct_wait(dreq);
496 		if (result > 0) {
497 			requested -= result;
498 			iocb->ki_pos += result;
499 		}
500 		iov_iter_revert(iter, requested);
501 	} else {
502 		result = requested;
503 	}
504 
505 out_release:
506 	nfs_direct_req_release(dreq);
507 out:
508 	return result;
509 }
510 
511 static void
512 nfs_direct_join_group(struct list_head *list, struct inode *inode)
513 {
514 	struct nfs_page *req, *next;
515 
516 	list_for_each_entry(req, list, wb_list) {
517 		if (req->wb_head != req || req->wb_this_page == req)
518 			continue;
519 		for (next = req->wb_this_page;
520 				next != req->wb_head;
521 				next = next->wb_this_page) {
522 			nfs_list_remove_request(next);
523 			nfs_release_request(next);
524 		}
525 		nfs_join_page_group(req, inode);
526 	}
527 }
528 
529 static void
530 nfs_direct_write_scan_commit_list(struct inode *inode,
531 				  struct list_head *list,
532 				  struct nfs_commit_info *cinfo)
533 {
534 	mutex_lock(&NFS_I(cinfo->inode)->commit_mutex);
535 	pnfs_recover_commit_reqs(list, cinfo);
536 	nfs_scan_commit_list(&cinfo->mds->list, list, cinfo, 0);
537 	mutex_unlock(&NFS_I(cinfo->inode)->commit_mutex);
538 }
539 
540 static void nfs_direct_write_reschedule(struct nfs_direct_req *dreq)
541 {
542 	struct nfs_pageio_descriptor desc;
543 	struct nfs_page *req, *tmp;
544 	LIST_HEAD(reqs);
545 	struct nfs_commit_info cinfo;
546 	LIST_HEAD(failed);
547 
548 	nfs_init_cinfo_from_dreq(&cinfo, dreq);
549 	nfs_direct_write_scan_commit_list(dreq->inode, &reqs, &cinfo);
550 
551 	nfs_direct_join_group(&reqs, dreq->inode);
552 
553 	dreq->count = 0;
554 	dreq->max_count = 0;
555 	list_for_each_entry(req, &reqs, wb_list)
556 		dreq->max_count += req->wb_bytes;
557 	nfs_clear_pnfs_ds_commit_verifiers(&dreq->ds_cinfo);
558 	get_dreq(dreq);
559 
560 	nfs_pageio_init_write(&desc, dreq->inode, FLUSH_STABLE, false,
561 			      &nfs_direct_write_completion_ops);
562 	desc.pg_dreq = dreq;
563 
564 	list_for_each_entry_safe(req, tmp, &reqs, wb_list) {
565 		/* Bump the transmission count */
566 		req->wb_nio++;
567 		if (!nfs_pageio_add_request(&desc, req)) {
568 			nfs_list_move_request(req, &failed);
569 			spin_lock(&cinfo.inode->i_lock);
570 			dreq->flags = 0;
571 			if (desc.pg_error < 0)
572 				dreq->error = desc.pg_error;
573 			else
574 				dreq->error = -EIO;
575 			spin_unlock(&cinfo.inode->i_lock);
576 		}
577 		nfs_release_request(req);
578 	}
579 	nfs_pageio_complete(&desc);
580 
581 	while (!list_empty(&failed)) {
582 		req = nfs_list_entry(failed.next);
583 		nfs_list_remove_request(req);
584 		nfs_unlock_and_release_request(req);
585 	}
586 
587 	if (put_dreq(dreq))
588 		nfs_direct_write_complete(dreq);
589 }
590 
591 static void nfs_direct_commit_complete(struct nfs_commit_data *data)
592 {
593 	const struct nfs_writeverf *verf = data->res.verf;
594 	struct nfs_direct_req *dreq = data->dreq;
595 	struct nfs_commit_info cinfo;
596 	struct nfs_page *req;
597 	int status = data->task.tk_status;
598 
599 	if (status < 0) {
600 		/* Errors in commit are fatal */
601 		dreq->error = status;
602 		dreq->max_count = 0;
603 		dreq->count = 0;
604 		dreq->flags = NFS_ODIRECT_DONE;
605 	} else if (dreq->flags == NFS_ODIRECT_DONE)
606 		status = dreq->error;
607 
608 	nfs_init_cinfo_from_dreq(&cinfo, dreq);
609 
610 	while (!list_empty(&data->pages)) {
611 		req = nfs_list_entry(data->pages.next);
612 		nfs_list_remove_request(req);
613 		if (status >= 0 && !nfs_write_match_verf(verf, req)) {
614 			dreq->flags = NFS_ODIRECT_RESCHED_WRITES;
615 			/*
616 			 * Despite the reboot, the write was successful,
617 			 * so reset wb_nio.
618 			 */
619 			req->wb_nio = 0;
620 			nfs_mark_request_commit(req, NULL, &cinfo, 0);
621 		} else /* Error or match */
622 			nfs_release_request(req);
623 		nfs_unlock_and_release_request(req);
624 	}
625 
626 	if (atomic_dec_and_test(&cinfo.mds->rpcs_out))
627 		nfs_direct_write_complete(dreq);
628 }
629 
630 static void nfs_direct_resched_write(struct nfs_commit_info *cinfo,
631 		struct nfs_page *req)
632 {
633 	struct nfs_direct_req *dreq = cinfo->dreq;
634 
635 	spin_lock(&dreq->lock);
636 	if (dreq->flags != NFS_ODIRECT_DONE)
637 		dreq->flags = NFS_ODIRECT_RESCHED_WRITES;
638 	spin_unlock(&dreq->lock);
639 	nfs_mark_request_commit(req, NULL, cinfo, 0);
640 }
641 
642 static const struct nfs_commit_completion_ops nfs_direct_commit_completion_ops = {
643 	.completion = nfs_direct_commit_complete,
644 	.resched_write = nfs_direct_resched_write,
645 };
646 
647 static void nfs_direct_commit_schedule(struct nfs_direct_req *dreq)
648 {
649 	int res;
650 	struct nfs_commit_info cinfo;
651 	LIST_HEAD(mds_list);
652 
653 	nfs_init_cinfo_from_dreq(&cinfo, dreq);
654 	nfs_scan_commit(dreq->inode, &mds_list, &cinfo);
655 	res = nfs_generic_commit_list(dreq->inode, &mds_list, 0, &cinfo);
656 	if (res < 0) /* res == -ENOMEM */
657 		nfs_direct_write_reschedule(dreq);
658 }
659 
660 static void nfs_direct_write_clear_reqs(struct nfs_direct_req *dreq)
661 {
662 	struct nfs_commit_info cinfo;
663 	struct nfs_page *req;
664 	LIST_HEAD(reqs);
665 
666 	nfs_init_cinfo_from_dreq(&cinfo, dreq);
667 	nfs_direct_write_scan_commit_list(dreq->inode, &reqs, &cinfo);
668 
669 	while (!list_empty(&reqs)) {
670 		req = nfs_list_entry(reqs.next);
671 		nfs_list_remove_request(req);
672 		nfs_release_request(req);
673 		nfs_unlock_and_release_request(req);
674 	}
675 }
676 
677 static void nfs_direct_write_schedule_work(struct work_struct *work)
678 {
679 	struct nfs_direct_req *dreq = container_of(work, struct nfs_direct_req, work);
680 	int flags = dreq->flags;
681 
682 	dreq->flags = 0;
683 	switch (flags) {
684 		case NFS_ODIRECT_DO_COMMIT:
685 			nfs_direct_commit_schedule(dreq);
686 			break;
687 		case NFS_ODIRECT_RESCHED_WRITES:
688 			nfs_direct_write_reschedule(dreq);
689 			break;
690 		default:
691 			nfs_direct_write_clear_reqs(dreq);
692 			nfs_zap_mapping(dreq->inode, dreq->inode->i_mapping);
693 			nfs_direct_complete(dreq);
694 	}
695 }
696 
697 static void nfs_direct_write_complete(struct nfs_direct_req *dreq)
698 {
699 	queue_work(nfsiod_workqueue, &dreq->work); /* Calls nfs_direct_write_schedule_work */
700 }
701 
702 static void nfs_direct_write_completion(struct nfs_pgio_header *hdr)
703 {
704 	struct nfs_direct_req *dreq = hdr->dreq;
705 	struct nfs_commit_info cinfo;
706 	bool request_commit = false;
707 	struct nfs_page *req = nfs_list_entry(hdr->pages.next);
708 
709 	nfs_init_cinfo_from_dreq(&cinfo, dreq);
710 
711 	spin_lock(&dreq->lock);
712 	if (test_bit(NFS_IOHDR_REDO, &hdr->flags)) {
713 		spin_unlock(&dreq->lock);
714 		goto out_put;
715 	}
716 
717 	nfs_direct_count_bytes(dreq, hdr);
718 	if (hdr->good_bytes != 0 && nfs_write_need_commit(hdr)) {
719 		switch (dreq->flags) {
720 		case 0:
721 			dreq->flags = NFS_ODIRECT_DO_COMMIT;
722 			request_commit = true;
723 			break;
724 		case NFS_ODIRECT_RESCHED_WRITES:
725 		case NFS_ODIRECT_DO_COMMIT:
726 			request_commit = true;
727 		}
728 	}
729 	spin_unlock(&dreq->lock);
730 
731 	while (!list_empty(&hdr->pages)) {
732 
733 		req = nfs_list_entry(hdr->pages.next);
734 		nfs_list_remove_request(req);
735 		if (request_commit) {
736 			kref_get(&req->wb_kref);
737 			memcpy(&req->wb_verf, &hdr->verf.verifier,
738 			       sizeof(req->wb_verf));
739 			nfs_mark_request_commit(req, hdr->lseg, &cinfo,
740 				hdr->ds_commit_idx);
741 		}
742 		nfs_unlock_and_release_request(req);
743 	}
744 
745 out_put:
746 	if (put_dreq(dreq))
747 		nfs_direct_write_complete(dreq);
748 	hdr->release(hdr);
749 }
750 
751 static void nfs_write_sync_pgio_error(struct list_head *head, int error)
752 {
753 	struct nfs_page *req;
754 
755 	while (!list_empty(head)) {
756 		req = nfs_list_entry(head->next);
757 		nfs_list_remove_request(req);
758 		nfs_unlock_and_release_request(req);
759 	}
760 }
761 
762 static void nfs_direct_write_reschedule_io(struct nfs_pgio_header *hdr)
763 {
764 	struct nfs_direct_req *dreq = hdr->dreq;
765 
766 	spin_lock(&dreq->lock);
767 	if (dreq->error == 0) {
768 		dreq->flags = NFS_ODIRECT_RESCHED_WRITES;
769 		/* fake unstable write to let common nfs resend pages */
770 		hdr->verf.committed = NFS_UNSTABLE;
771 		hdr->good_bytes = hdr->args.offset + hdr->args.count -
772 			hdr->io_start;
773 	}
774 	spin_unlock(&dreq->lock);
775 }
776 
777 static const struct nfs_pgio_completion_ops nfs_direct_write_completion_ops = {
778 	.error_cleanup = nfs_write_sync_pgio_error,
779 	.init_hdr = nfs_direct_pgio_init,
780 	.completion = nfs_direct_write_completion,
781 	.reschedule_io = nfs_direct_write_reschedule_io,
782 };
783 
784 
785 /*
786  * NB: Return the value of the first error return code.  Subsequent
787  *     errors after the first one are ignored.
788  */
789 /*
790  * For each wsize'd chunk of the user's buffer, dispatch an NFS WRITE
791  * operation.  If nfs_writedata_alloc() or get_user_pages() fails,
792  * bail and stop sending more writes.  Write length accounting is
793  * handled automatically by nfs_direct_write_result().  Otherwise, if
794  * no requests have been sent, just return an error.
795  */
796 static ssize_t nfs_direct_write_schedule_iovec(struct nfs_direct_req *dreq,
797 					       struct iov_iter *iter,
798 					       loff_t pos)
799 {
800 	struct nfs_pageio_descriptor desc;
801 	struct inode *inode = dreq->inode;
802 	ssize_t result = 0;
803 	size_t requested_bytes = 0;
804 	size_t wsize = max_t(size_t, NFS_SERVER(inode)->wsize, PAGE_SIZE);
805 
806 	nfs_pageio_init_write(&desc, inode, FLUSH_COND_STABLE, false,
807 			      &nfs_direct_write_completion_ops);
808 	desc.pg_dreq = dreq;
809 	get_dreq(dreq);
810 	inode_dio_begin(inode);
811 
812 	NFS_I(inode)->write_io += iov_iter_count(iter);
813 	while (iov_iter_count(iter)) {
814 		struct page **pagevec;
815 		size_t bytes;
816 		size_t pgbase;
817 		unsigned npages, i;
818 
819 		result = iov_iter_get_pages_alloc(iter, &pagevec,
820 						  wsize, &pgbase);
821 		if (result < 0)
822 			break;
823 
824 		bytes = result;
825 		iov_iter_advance(iter, bytes);
826 		npages = (result + pgbase + PAGE_SIZE - 1) / PAGE_SIZE;
827 		for (i = 0; i < npages; i++) {
828 			struct nfs_page *req;
829 			unsigned int req_len = min_t(size_t, bytes, PAGE_SIZE - pgbase);
830 
831 			req = nfs_create_request(dreq->ctx, pagevec[i],
832 						 pgbase, req_len);
833 			if (IS_ERR(req)) {
834 				result = PTR_ERR(req);
835 				break;
836 			}
837 
838 			if (desc.pg_error < 0) {
839 				nfs_free_request(req);
840 				result = desc.pg_error;
841 				break;
842 			}
843 
844 			nfs_lock_request(req);
845 			req->wb_index = pos >> PAGE_SHIFT;
846 			req->wb_offset = pos & ~PAGE_MASK;
847 			if (!nfs_pageio_add_request(&desc, req)) {
848 				result = desc.pg_error;
849 				nfs_unlock_and_release_request(req);
850 				break;
851 			}
852 			pgbase = 0;
853 			bytes -= req_len;
854 			requested_bytes += req_len;
855 			pos += req_len;
856 			dreq->bytes_left -= req_len;
857 		}
858 		nfs_direct_release_pages(pagevec, npages);
859 		kvfree(pagevec);
860 		if (result < 0)
861 			break;
862 	}
863 	nfs_pageio_complete(&desc);
864 
865 	/*
866 	 * If no bytes were started, return the error, and let the
867 	 * generic layer handle the completion.
868 	 */
869 	if (requested_bytes == 0) {
870 		igrab(inode);
871 		nfs_direct_req_release(dreq);
872 		inode_dio_end(inode);
873 		iput(inode);
874 		return result < 0 ? result : -EIO;
875 	}
876 
877 	if (put_dreq(dreq))
878 		nfs_direct_write_complete(dreq);
879 	return requested_bytes;
880 }
881 
882 /**
883  * nfs_file_direct_write - file direct write operation for NFS files
884  * @iocb: target I/O control block
885  * @iter: vector of user buffers from which to write data
886  *
887  * We use this function for direct writes instead of calling
888  * generic_file_aio_write() in order to avoid taking the inode
889  * semaphore and updating the i_size.  The NFS server will set
890  * the new i_size and this client must read the updated size
891  * back into its cache.  We let the server do generic write
892  * parameter checking and report problems.
893  *
894  * We eliminate local atime updates, see direct read above.
895  *
896  * We avoid unnecessary page cache invalidations for normal cached
897  * readers of this file.
898  *
899  * Note that O_APPEND is not supported for NFS direct writes, as there
900  * is no atomic O_APPEND write facility in the NFS protocol.
901  */
902 ssize_t nfs_file_direct_write(struct kiocb *iocb, struct iov_iter *iter)
903 {
904 	ssize_t result = -EINVAL, requested;
905 	size_t count;
906 	struct file *file = iocb->ki_filp;
907 	struct address_space *mapping = file->f_mapping;
908 	struct inode *inode = mapping->host;
909 	struct nfs_direct_req *dreq;
910 	struct nfs_lock_context *l_ctx;
911 	loff_t pos, end;
912 
913 	dfprintk(FILE, "NFS: direct write(%pD2, %zd@%Ld)\n",
914 		file, iov_iter_count(iter), (long long) iocb->ki_pos);
915 
916 	result = generic_write_checks(iocb, iter);
917 	if (result <= 0)
918 		return result;
919 	count = result;
920 	nfs_add_stats(mapping->host, NFSIOS_DIRECTWRITTENBYTES, count);
921 
922 	pos = iocb->ki_pos;
923 	end = (pos + iov_iter_count(iter) - 1) >> PAGE_SHIFT;
924 
925 	task_io_account_write(count);
926 
927 	result = -ENOMEM;
928 	dreq = nfs_direct_req_alloc();
929 	if (!dreq)
930 		goto out;
931 
932 	dreq->inode = inode;
933 	dreq->bytes_left = dreq->max_count = count;
934 	dreq->io_start = pos;
935 	dreq->ctx = get_nfs_open_context(nfs_file_open_context(iocb->ki_filp));
936 	l_ctx = nfs_get_lock_context(dreq->ctx);
937 	if (IS_ERR(l_ctx)) {
938 		result = PTR_ERR(l_ctx);
939 		nfs_direct_req_release(dreq);
940 		goto out_release;
941 	}
942 	dreq->l_ctx = l_ctx;
943 	if (!is_sync_kiocb(iocb))
944 		dreq->iocb = iocb;
945 	pnfs_init_ds_commit_info_ops(&dreq->ds_cinfo, inode);
946 
947 	nfs_start_io_direct(inode);
948 
949 	requested = nfs_direct_write_schedule_iovec(dreq, iter, pos);
950 
951 	if (mapping->nrpages) {
952 		invalidate_inode_pages2_range(mapping,
953 					      pos >> PAGE_SHIFT, end);
954 	}
955 
956 	nfs_end_io_direct(inode);
957 
958 	if (requested > 0) {
959 		result = nfs_direct_wait(dreq);
960 		if (result > 0) {
961 			requested -= result;
962 			iocb->ki_pos = pos + result;
963 			/* XXX: should check the generic_write_sync retval */
964 			generic_write_sync(iocb, result);
965 		}
966 		iov_iter_revert(iter, requested);
967 	} else {
968 		result = requested;
969 	}
970 out_release:
971 	nfs_direct_req_release(dreq);
972 out:
973 	return result;
974 }
975 
976 /**
977  * nfs_init_directcache - create a slab cache for nfs_direct_req structures
978  *
979  */
980 int __init nfs_init_directcache(void)
981 {
982 	nfs_direct_cachep = kmem_cache_create("nfs_direct_cache",
983 						sizeof(struct nfs_direct_req),
984 						0, (SLAB_RECLAIM_ACCOUNT|
985 							SLAB_MEM_SPREAD),
986 						NULL);
987 	if (nfs_direct_cachep == NULL)
988 		return -ENOMEM;
989 
990 	return 0;
991 }
992 
993 /**
994  * nfs_destroy_directcache - destroy the slab cache for nfs_direct_req structures
995  *
996  */
997 void nfs_destroy_directcache(void)
998 {
999 	kmem_cache_destroy(nfs_direct_cachep);
1000 }
1001