1 // SPDX-License-Identifier: GPL-2.0-only
3 * linux/fs/nfs/pagelist.c
5 * A set of helper functions for managing NFS read and write requests.
6 * The main purpose of these routines is to provide support for the
7 * coalescing of several requests into a single RPC call.
13 #include <linux/slab.h>
14 #include <linux/file.h>
15 #include <linux/sched.h>
16 #include <linux/sunrpc/clnt.h>
17 #include <linux/nfs.h>
18 #include <linux/nfs3.h>
19 #include <linux/nfs4.h>
20 #include <linux/nfs_fs.h>
21 #include <linux/nfs_page.h>
22 #include <linux/nfs_mount.h>
23 #include <linux/export.h>
29 #define NFSDBG_FACILITY NFSDBG_PAGECACHE
31 static struct kmem_cache *nfs_page_cachep;
32 static const struct rpc_call_ops nfs_pgio_common_ops;
34 struct nfs_pgio_mirror *
35 nfs_pgio_current_mirror(struct nfs_pageio_descriptor *desc)
37 return &desc->pg_mirrors[desc->pg_mirror_idx];
39 EXPORT_SYMBOL_GPL(nfs_pgio_current_mirror);
41 void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
42 struct nfs_pgio_header *hdr,
43 void (*release)(struct nfs_pgio_header *hdr))
45 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
48 hdr->req = nfs_list_entry(mirror->pg_list.next);
49 hdr->inode = desc->pg_inode;
50 hdr->cred = nfs_req_openctx(hdr->req)->cred;
51 hdr->io_start = req_offset(hdr->req);
52 hdr->good_bytes = mirror->pg_count;
53 hdr->io_completion = desc->pg_io_completion;
54 hdr->dreq = desc->pg_dreq;
55 hdr->release = release;
56 hdr->completion_ops = desc->pg_completion_ops;
57 if (hdr->completion_ops->init_hdr)
58 hdr->completion_ops->init_hdr(hdr);
60 hdr->pgio_mirror_idx = desc->pg_mirror_idx;
62 EXPORT_SYMBOL_GPL(nfs_pgheader_init);
64 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos)
66 unsigned int new = pos - hdr->io_start;
68 trace_nfs_pgio_error(hdr, error, pos);
69 if (hdr->good_bytes > new) {
70 hdr->good_bytes = new;
71 clear_bit(NFS_IOHDR_EOF, &hdr->flags);
72 if (!test_and_set_bit(NFS_IOHDR_ERROR, &hdr->flags))
77 static inline struct nfs_page *
80 struct nfs_page *p = kmem_cache_zalloc(nfs_page_cachep, GFP_KERNEL);
82 INIT_LIST_HEAD(&p->wb_list);
87 nfs_page_free(struct nfs_page *p)
89 kmem_cache_free(nfs_page_cachep, p);
93 * nfs_iocounter_wait - wait for i/o to complete
94 * @l_ctx: nfs_lock_context with io_counter to use
96 * returns -ERESTARTSYS if interrupted by a fatal signal.
97 * Otherwise returns 0 once the io_count hits 0.
100 nfs_iocounter_wait(struct nfs_lock_context *l_ctx)
102 return wait_var_event_killable(&l_ctx->io_count,
103 !atomic_read(&l_ctx->io_count));
107 * nfs_async_iocounter_wait - wait on a rpc_waitqueue for I/O
109 * @task: the rpc_task that should wait
110 * @l_ctx: nfs_lock_context with io_counter to check
112 * Returns true if there is outstanding I/O to wait on and the
113 * task has been put to sleep.
116 nfs_async_iocounter_wait(struct rpc_task *task, struct nfs_lock_context *l_ctx)
118 struct inode *inode = d_inode(l_ctx->open_context->dentry);
121 if (atomic_read(&l_ctx->io_count) > 0) {
122 rpc_sleep_on(&NFS_SERVER(inode)->uoc_rpcwaitq, task, NULL);
126 if (atomic_read(&l_ctx->io_count) == 0) {
127 rpc_wake_up_queued_task(&NFS_SERVER(inode)->uoc_rpcwaitq, task);
133 EXPORT_SYMBOL_GPL(nfs_async_iocounter_wait);
136 * nfs_page_lock_head_request - page lock the head of the page group
137 * @req: any member of the page group
140 nfs_page_group_lock_head(struct nfs_page *req)
142 struct nfs_page *head = req->wb_head;
144 while (!nfs_lock_request(head)) {
145 int ret = nfs_wait_on_request(head);
150 kref_get(&head->wb_kref);
155 * nfs_unroll_locks - unlock all newly locked reqs and wait on @req
156 * @head: head request of page group, must be holding head lock
157 * @req: request that couldn't lock and needs to wait on the req bit lock
159 * This is a helper function for nfs_lock_and_join_requests
160 * returns 0 on success, < 0 on error.
163 nfs_unroll_locks(struct nfs_page *head, struct nfs_page *req)
165 struct nfs_page *tmp;
167 /* relinquish all the locks successfully grabbed this run */
168 for (tmp = head->wb_this_page ; tmp != req; tmp = tmp->wb_this_page) {
169 if (!kref_read(&tmp->wb_kref))
171 nfs_unlock_and_release_request(tmp);
176 * nfs_page_group_lock_subreq - try to lock a subrequest
177 * @head: head request of page group
178 * @subreq: request to lock
180 * This is a helper function for nfs_lock_and_join_requests which
181 * must be called with the head request and page group both locked.
182 * On error, it returns with the page group unlocked.
185 nfs_page_group_lock_subreq(struct nfs_page *head, struct nfs_page *subreq)
189 if (!kref_get_unless_zero(&subreq->wb_kref))
191 while (!nfs_lock_request(subreq)) {
192 nfs_page_group_unlock(head);
193 ret = nfs_wait_on_request(subreq);
195 ret = nfs_page_group_lock(head);
197 nfs_unroll_locks(head, subreq);
198 nfs_release_request(subreq);
206 * nfs_page_group_lock_subrequests - try to lock the subrequests
207 * @head: head request of page group
209 * This is a helper function for nfs_lock_and_join_requests which
210 * must be called with the head request locked.
212 int nfs_page_group_lock_subrequests(struct nfs_page *head)
214 struct nfs_page *subreq;
217 ret = nfs_page_group_lock(head);
220 /* lock each request in the page group */
221 for (subreq = head->wb_this_page; subreq != head;
222 subreq = subreq->wb_this_page) {
223 ret = nfs_page_group_lock_subreq(head, subreq);
227 nfs_page_group_unlock(head);
232 * nfs_page_set_headlock - set the request PG_HEADLOCK
233 * @req: request that is to be locked
235 * this lock must be held when modifying req->wb_head
237 * return 0 on success, < 0 on error
240 nfs_page_set_headlock(struct nfs_page *req)
242 if (!test_and_set_bit(PG_HEADLOCK, &req->wb_flags))
245 set_bit(PG_CONTENDED1, &req->wb_flags);
246 smp_mb__after_atomic();
247 return wait_on_bit_lock(&req->wb_flags, PG_HEADLOCK,
248 TASK_UNINTERRUPTIBLE);
252 * nfs_page_clear_headlock - clear the request PG_HEADLOCK
253 * @req: request that is to be locked
256 nfs_page_clear_headlock(struct nfs_page *req)
258 smp_mb__before_atomic();
259 clear_bit(PG_HEADLOCK, &req->wb_flags);
260 smp_mb__after_atomic();
261 if (!test_bit(PG_CONTENDED1, &req->wb_flags))
263 wake_up_bit(&req->wb_flags, PG_HEADLOCK);
267 * nfs_page_group_lock - lock the head of the page group
268 * @req: request in group that is to be locked
270 * this lock must be held when traversing or modifying the page
273 * return 0 on success, < 0 on error
276 nfs_page_group_lock(struct nfs_page *req)
280 ret = nfs_page_set_headlock(req);
281 if (ret || req->wb_head == req)
283 return nfs_page_set_headlock(req->wb_head);
287 * nfs_page_group_unlock - unlock the head of the page group
288 * @req: request in group that is to be unlocked
291 nfs_page_group_unlock(struct nfs_page *req)
293 if (req != req->wb_head)
294 nfs_page_clear_headlock(req->wb_head);
295 nfs_page_clear_headlock(req);
299 * nfs_page_group_sync_on_bit_locked
301 * must be called with page group lock held
304 nfs_page_group_sync_on_bit_locked(struct nfs_page *req, unsigned int bit)
306 struct nfs_page *head = req->wb_head;
307 struct nfs_page *tmp;
309 WARN_ON_ONCE(!test_bit(PG_HEADLOCK, &head->wb_flags));
310 WARN_ON_ONCE(test_and_set_bit(bit, &req->wb_flags));
312 tmp = req->wb_this_page;
314 if (!test_bit(bit, &tmp->wb_flags))
316 tmp = tmp->wb_this_page;
319 /* true! reset all bits */
322 clear_bit(bit, &tmp->wb_flags);
323 tmp = tmp->wb_this_page;
324 } while (tmp != req);
330 * nfs_page_group_sync_on_bit - set bit on current request, but only
331 * return true if the bit is set for all requests in page group
332 * @req - request in page group
333 * @bit - PG_* bit that is used to sync page group
335 bool nfs_page_group_sync_on_bit(struct nfs_page *req, unsigned int bit)
339 nfs_page_group_lock(req);
340 ret = nfs_page_group_sync_on_bit_locked(req, bit);
341 nfs_page_group_unlock(req);
347 * nfs_page_group_init - Initialize the page group linkage for @req
348 * @req - a new nfs request
349 * @prev - the previous request in page group, or NULL if @req is the first
350 * or only request in the group (the head).
353 nfs_page_group_init(struct nfs_page *req, struct nfs_page *prev)
356 WARN_ON_ONCE(prev == req);
361 req->wb_this_page = req;
364 WARN_ON_ONCE(prev->wb_this_page != prev->wb_head);
365 WARN_ON_ONCE(!test_bit(PG_HEADLOCK, &prev->wb_head->wb_flags));
366 req->wb_head = prev->wb_head;
367 req->wb_this_page = prev->wb_this_page;
368 prev->wb_this_page = req;
370 /* All subrequests take a ref on the head request until
371 * nfs_page_group_destroy is called */
372 kref_get(&req->wb_head->wb_kref);
374 /* grab extra ref and bump the request count if head request
375 * has extra ref from the write/commit path to handle handoff
376 * between write and commit lists. */
377 if (test_bit(PG_INODE_REF, &prev->wb_head->wb_flags)) {
378 inode = page_file_mapping(req->wb_page)->host;
379 set_bit(PG_INODE_REF, &req->wb_flags);
380 kref_get(&req->wb_kref);
381 atomic_long_inc(&NFS_I(inode)->nrequests);
387 * nfs_page_group_destroy - sync the destruction of page groups
388 * @req - request that no longer needs the page group
390 * releases the page group reference from each member once all
391 * members have called this function.
394 nfs_page_group_destroy(struct kref *kref)
396 struct nfs_page *req = container_of(kref, struct nfs_page, wb_kref);
397 struct nfs_page *head = req->wb_head;
398 struct nfs_page *tmp, *next;
400 if (!nfs_page_group_sync_on_bit(req, PG_TEARDOWN))
405 next = tmp->wb_this_page;
406 /* unlink and free */
407 tmp->wb_this_page = tmp;
409 nfs_free_request(tmp);
411 } while (tmp != req);
413 /* subrequests must release the ref on the head request */
415 nfs_release_request(head);
418 static struct nfs_page *
419 __nfs_create_request(struct nfs_lock_context *l_ctx, struct page *page,
420 unsigned int pgbase, unsigned int offset,
423 struct nfs_page *req;
424 struct nfs_open_context *ctx = l_ctx->open_context;
426 if (test_bit(NFS_CONTEXT_BAD, &ctx->flags))
427 return ERR_PTR(-EBADF);
428 /* try to allocate the request struct */
429 req = nfs_page_alloc();
431 return ERR_PTR(-ENOMEM);
433 req->wb_lock_context = l_ctx;
434 refcount_inc(&l_ctx->count);
435 atomic_inc(&l_ctx->io_count);
437 /* Initialize the request struct. Initially, we assume a
438 * long write-back delay. This will be adjusted in
439 * update_nfs_request below if the region is not locked. */
442 req->wb_index = page_index(page);
445 req->wb_offset = offset;
446 req->wb_pgbase = pgbase;
447 req->wb_bytes = count;
448 kref_init(&req->wb_kref);
454 * nfs_create_request - Create an NFS read/write request.
455 * @ctx: open context to use
456 * @page: page to write
457 * @offset: starting offset within the page for the write
458 * @count: number of bytes to read/write
460 * The page must be locked by the caller. This makes sure we never
461 * create two different requests for the same page.
462 * User should ensure it is safe to sleep in this function.
465 nfs_create_request(struct nfs_open_context *ctx, struct page *page,
466 unsigned int offset, unsigned int count)
468 struct nfs_lock_context *l_ctx = nfs_get_lock_context(ctx);
469 struct nfs_page *ret;
472 return ERR_CAST(l_ctx);
473 ret = __nfs_create_request(l_ctx, page, offset, offset, count);
475 nfs_page_group_init(ret, NULL);
476 nfs_put_lock_context(l_ctx);
480 static struct nfs_page *
481 nfs_create_subreq(struct nfs_page *req,
486 struct nfs_page *last;
487 struct nfs_page *ret;
489 ret = __nfs_create_request(req->wb_lock_context, req->wb_page,
490 pgbase, offset, count);
492 /* find the last request */
493 for (last = req->wb_head;
494 last->wb_this_page != req->wb_head;
495 last = last->wb_this_page)
498 nfs_lock_request(ret);
499 ret->wb_index = req->wb_index;
500 nfs_page_group_init(ret, last);
501 ret->wb_nio = req->wb_nio;
507 * nfs_unlock_request - Unlock request and wake up sleepers.
508 * @req: pointer to request
510 void nfs_unlock_request(struct nfs_page *req)
512 if (!NFS_WBACK_BUSY(req)) {
513 printk(KERN_ERR "NFS: Invalid unlock attempted\n");
516 smp_mb__before_atomic();
517 clear_bit(PG_BUSY, &req->wb_flags);
518 smp_mb__after_atomic();
519 if (!test_bit(PG_CONTENDED2, &req->wb_flags))
521 wake_up_bit(&req->wb_flags, PG_BUSY);
525 * nfs_unlock_and_release_request - Unlock request and release the nfs_page
526 * @req: pointer to request
528 void nfs_unlock_and_release_request(struct nfs_page *req)
530 nfs_unlock_request(req);
531 nfs_release_request(req);
535 * nfs_clear_request - Free up all resources allocated to the request
538 * Release page and open context resources associated with a read/write
539 * request after it has completed.
541 static void nfs_clear_request(struct nfs_page *req)
543 struct page *page = req->wb_page;
544 struct nfs_lock_context *l_ctx = req->wb_lock_context;
545 struct nfs_open_context *ctx;
552 if (atomic_dec_and_test(&l_ctx->io_count)) {
553 wake_up_var(&l_ctx->io_count);
554 ctx = l_ctx->open_context;
555 if (test_bit(NFS_CONTEXT_UNLOCK, &ctx->flags))
556 rpc_wake_up(&NFS_SERVER(d_inode(ctx->dentry))->uoc_rpcwaitq);
558 nfs_put_lock_context(l_ctx);
559 req->wb_lock_context = NULL;
564 * nfs_release_request - Release the count on an NFS read/write request
565 * @req: request to release
567 * Note: Should never be called with the spinlock held!
569 void nfs_free_request(struct nfs_page *req)
571 WARN_ON_ONCE(req->wb_this_page != req);
573 /* extra debug: make sure no sync bits are still set */
574 WARN_ON_ONCE(test_bit(PG_TEARDOWN, &req->wb_flags));
575 WARN_ON_ONCE(test_bit(PG_UNLOCKPAGE, &req->wb_flags));
576 WARN_ON_ONCE(test_bit(PG_UPTODATE, &req->wb_flags));
577 WARN_ON_ONCE(test_bit(PG_WB_END, &req->wb_flags));
578 WARN_ON_ONCE(test_bit(PG_REMOVE, &req->wb_flags));
580 /* Release struct file and open context */
581 nfs_clear_request(req);
585 void nfs_release_request(struct nfs_page *req)
587 kref_put(&req->wb_kref, nfs_page_group_destroy);
589 EXPORT_SYMBOL_GPL(nfs_release_request);
592 * nfs_wait_on_request - Wait for a request to complete.
593 * @req: request to wait upon.
595 * Interruptible by fatal signals only.
596 * The user is responsible for holding a count on the request.
599 nfs_wait_on_request(struct nfs_page *req)
601 if (!test_bit(PG_BUSY, &req->wb_flags))
603 set_bit(PG_CONTENDED2, &req->wb_flags);
604 smp_mb__after_atomic();
605 return wait_on_bit_io(&req->wb_flags, PG_BUSY,
606 TASK_UNINTERRUPTIBLE);
608 EXPORT_SYMBOL_GPL(nfs_wait_on_request);
611 * nfs_generic_pg_test - determine if requests can be coalesced
612 * @desc: pointer to descriptor
613 * @prev: previous request in desc, or NULL
616 * Returns zero if @req cannot be coalesced into @desc, otherwise it returns
617 * the size of the request.
619 size_t nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
620 struct nfs_page *prev, struct nfs_page *req)
622 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
625 if (mirror->pg_count > mirror->pg_bsize) {
626 /* should never happen */
632 * Limit the request size so that we can still allocate a page array
633 * for it without upsetting the slab allocator.
635 if (((mirror->pg_count + req->wb_bytes) >> PAGE_SHIFT) *
636 sizeof(struct page *) > PAGE_SIZE)
639 return min(mirror->pg_bsize - mirror->pg_count, (size_t)req->wb_bytes);
641 EXPORT_SYMBOL_GPL(nfs_generic_pg_test);
643 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *ops)
645 struct nfs_pgio_header *hdr = ops->rw_alloc_header();
648 INIT_LIST_HEAD(&hdr->pages);
653 EXPORT_SYMBOL_GPL(nfs_pgio_header_alloc);
656 * nfs_pgio_data_destroy - make @hdr suitable for reuse
658 * Frees memory and releases refs from nfs_generic_pgio, so that it may
661 * @hdr: A header that has had nfs_generic_pgio called
663 static void nfs_pgio_data_destroy(struct nfs_pgio_header *hdr)
665 if (hdr->args.context)
666 put_nfs_open_context(hdr->args.context);
667 if (hdr->page_array.pagevec != hdr->page_array.page_array)
668 kfree(hdr->page_array.pagevec);
672 * nfs_pgio_header_free - Free a read or write header
673 * @hdr: The header to free
675 void nfs_pgio_header_free(struct nfs_pgio_header *hdr)
677 nfs_pgio_data_destroy(hdr);
678 hdr->rw_ops->rw_free_header(hdr);
680 EXPORT_SYMBOL_GPL(nfs_pgio_header_free);
683 * nfs_pgio_rpcsetup - Set up arguments for a pageio call
684 * @hdr: The pageio hdr
685 * @count: Number of bytes to read
686 * @how: How to commit data (writes only)
687 * @cinfo: Commit information for the call (writes only)
689 static void nfs_pgio_rpcsetup(struct nfs_pgio_header *hdr,
691 int how, struct nfs_commit_info *cinfo)
693 struct nfs_page *req = hdr->req;
695 /* Set up the RPC argument and reply structs
696 * NB: take care not to mess about with hdr->commit et al. */
698 hdr->args.fh = NFS_FH(hdr->inode);
699 hdr->args.offset = req_offset(req);
700 /* pnfs_set_layoutcommit needs this */
701 hdr->mds_offset = hdr->args.offset;
702 hdr->args.pgbase = req->wb_pgbase;
703 hdr->args.pages = hdr->page_array.pagevec;
704 hdr->args.count = count;
705 hdr->args.context = get_nfs_open_context(nfs_req_openctx(req));
706 hdr->args.lock_context = req->wb_lock_context;
707 hdr->args.stable = NFS_UNSTABLE;
708 switch (how & (FLUSH_STABLE | FLUSH_COND_STABLE)) {
711 case FLUSH_COND_STABLE:
712 if (nfs_reqs_to_commit(cinfo))
716 hdr->args.stable = NFS_FILE_SYNC;
719 hdr->res.fattr = &hdr->fattr;
722 hdr->res.verf = &hdr->verf;
723 nfs_fattr_init(&hdr->fattr);
727 * nfs_pgio_prepare - Prepare pageio hdr to go over the wire
728 * @task: The current task
729 * @calldata: pageio header to prepare
731 static void nfs_pgio_prepare(struct rpc_task *task, void *calldata)
733 struct nfs_pgio_header *hdr = calldata;
735 err = NFS_PROTO(hdr->inode)->pgio_rpc_prepare(task, hdr);
740 int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr,
741 const struct cred *cred, const struct nfs_rpc_ops *rpc_ops,
742 const struct rpc_call_ops *call_ops, int how, int flags)
744 struct rpc_task *task;
745 struct rpc_message msg = {
746 .rpc_argp = &hdr->args,
747 .rpc_resp = &hdr->res,
750 struct rpc_task_setup task_setup_data = {
754 .callback_ops = call_ops,
755 .callback_data = hdr,
756 .workqueue = nfsiod_workqueue,
757 .flags = RPC_TASK_ASYNC | flags,
760 hdr->rw_ops->rw_initiate(hdr, &msg, rpc_ops, &task_setup_data, how);
762 dprintk("NFS: initiated pgio call "
763 "(req %s/%llu, %u bytes @ offset %llu)\n",
764 hdr->inode->i_sb->s_id,
765 (unsigned long long)NFS_FILEID(hdr->inode),
767 (unsigned long long)hdr->args.offset);
769 task = rpc_run_task(&task_setup_data);
771 return PTR_ERR(task);
775 EXPORT_SYMBOL_GPL(nfs_initiate_pgio);
778 * nfs_pgio_error - Clean up from a pageio error
779 * @hdr: pageio header
781 static void nfs_pgio_error(struct nfs_pgio_header *hdr)
783 set_bit(NFS_IOHDR_REDO, &hdr->flags);
784 hdr->completion_ops->completion(hdr);
788 * nfs_pgio_release - Release pageio data
789 * @calldata: The pageio header to release
791 static void nfs_pgio_release(void *calldata)
793 struct nfs_pgio_header *hdr = calldata;
794 hdr->completion_ops->completion(hdr);
797 static void nfs_pageio_mirror_init(struct nfs_pgio_mirror *mirror,
800 INIT_LIST_HEAD(&mirror->pg_list);
801 mirror->pg_bytes_written = 0;
802 mirror->pg_count = 0;
803 mirror->pg_bsize = bsize;
805 mirror->pg_recoalesce = 0;
809 * nfs_pageio_init - initialise a page io descriptor
810 * @desc: pointer to descriptor
811 * @inode: pointer to inode
812 * @pg_ops: pointer to pageio operations
813 * @compl_ops: pointer to pageio completion operations
814 * @rw_ops: pointer to nfs read/write operations
815 * @bsize: io block size
816 * @io_flags: extra parameters for the io function
818 void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
820 const struct nfs_pageio_ops *pg_ops,
821 const struct nfs_pgio_completion_ops *compl_ops,
822 const struct nfs_rw_ops *rw_ops,
827 desc->pg_inode = inode;
828 desc->pg_ops = pg_ops;
829 desc->pg_completion_ops = compl_ops;
830 desc->pg_rw_ops = rw_ops;
831 desc->pg_ioflags = io_flags;
833 desc->pg_lseg = NULL;
834 desc->pg_io_completion = NULL;
835 desc->pg_dreq = NULL;
836 desc->pg_bsize = bsize;
838 desc->pg_mirror_count = 1;
839 desc->pg_mirror_idx = 0;
841 desc->pg_mirrors_dynamic = NULL;
842 desc->pg_mirrors = desc->pg_mirrors_static;
843 nfs_pageio_mirror_init(&desc->pg_mirrors[0], bsize);
844 desc->pg_maxretrans = 0;
848 * nfs_pgio_result - Basic pageio error handling
849 * @task: The task that ran
850 * @calldata: Pageio header to check
852 static void nfs_pgio_result(struct rpc_task *task, void *calldata)
854 struct nfs_pgio_header *hdr = calldata;
855 struct inode *inode = hdr->inode;
857 dprintk("NFS: %s: %5u, (status %d)\n", __func__,
858 task->tk_pid, task->tk_status);
860 if (hdr->rw_ops->rw_done(task, hdr, inode) != 0)
862 if (task->tk_status < 0)
863 nfs_set_pgio_error(hdr, task->tk_status, hdr->args.offset);
865 hdr->rw_ops->rw_result(task, hdr);
869 * Create an RPC task for the given read or write request and kick it.
870 * The page must have been locked by the caller.
872 * It may happen that the page we're passed is not marked dirty.
873 * This is the case if nfs_updatepage detects a conflicting request
874 * that has been written but not committed.
876 int nfs_generic_pgio(struct nfs_pageio_descriptor *desc,
877 struct nfs_pgio_header *hdr)
879 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
881 struct nfs_page *req;
884 struct list_head *head = &mirror->pg_list;
885 struct nfs_commit_info cinfo;
886 struct nfs_page_array *pg_array = &hdr->page_array;
887 unsigned int pagecount, pageused;
888 gfp_t gfp_flags = GFP_KERNEL;
890 pagecount = nfs_page_array_len(mirror->pg_base, mirror->pg_count);
891 pg_array->npages = pagecount;
893 if (pagecount <= ARRAY_SIZE(pg_array->page_array))
894 pg_array->pagevec = pg_array->page_array;
896 pg_array->pagevec = kcalloc(pagecount, sizeof(struct page *), gfp_flags);
897 if (!pg_array->pagevec) {
898 pg_array->npages = 0;
900 desc->pg_error = -ENOMEM;
901 return desc->pg_error;
905 nfs_init_cinfo(&cinfo, desc->pg_inode, desc->pg_dreq);
906 pages = hdr->page_array.pagevec;
909 while (!list_empty(head)) {
910 req = nfs_list_entry(head->next);
911 nfs_list_move_request(req, &hdr->pages);
913 if (!last_page || last_page != req->wb_page) {
915 if (pageused > pagecount)
917 *pages++ = last_page = req->wb_page;
920 if (WARN_ON_ONCE(pageused != pagecount)) {
922 desc->pg_error = -EINVAL;
923 return desc->pg_error;
926 if ((desc->pg_ioflags & FLUSH_COND_STABLE) &&
927 (desc->pg_moreio || nfs_reqs_to_commit(&cinfo)))
928 desc->pg_ioflags &= ~FLUSH_COND_STABLE;
930 /* Set up the argument struct */
931 nfs_pgio_rpcsetup(hdr, mirror->pg_count, desc->pg_ioflags, &cinfo);
932 desc->pg_rpc_callops = &nfs_pgio_common_ops;
935 EXPORT_SYMBOL_GPL(nfs_generic_pgio);
937 static int nfs_generic_pg_pgios(struct nfs_pageio_descriptor *desc)
939 struct nfs_pgio_header *hdr;
942 hdr = nfs_pgio_header_alloc(desc->pg_rw_ops);
944 desc->pg_error = -ENOMEM;
945 return desc->pg_error;
947 nfs_pgheader_init(desc, hdr, nfs_pgio_header_free);
948 ret = nfs_generic_pgio(desc, hdr);
950 ret = nfs_initiate_pgio(NFS_CLIENT(hdr->inode),
953 NFS_PROTO(hdr->inode),
954 desc->pg_rpc_callops,
956 RPC_TASK_CRED_NOREF);
960 static struct nfs_pgio_mirror *
961 nfs_pageio_alloc_mirrors(struct nfs_pageio_descriptor *desc,
962 unsigned int mirror_count)
964 struct nfs_pgio_mirror *ret;
967 kfree(desc->pg_mirrors_dynamic);
968 desc->pg_mirrors_dynamic = NULL;
969 if (mirror_count == 1)
970 return desc->pg_mirrors_static;
971 ret = kmalloc_array(mirror_count, sizeof(*ret), GFP_KERNEL);
973 for (i = 0; i < mirror_count; i++)
974 nfs_pageio_mirror_init(&ret[i], desc->pg_bsize);
975 desc->pg_mirrors_dynamic = ret;
981 * nfs_pageio_setup_mirroring - determine if mirroring is to be used
982 * by calling the pg_get_mirror_count op
984 static void nfs_pageio_setup_mirroring(struct nfs_pageio_descriptor *pgio,
985 struct nfs_page *req)
987 unsigned int mirror_count = 1;
989 if (pgio->pg_ops->pg_get_mirror_count)
990 mirror_count = pgio->pg_ops->pg_get_mirror_count(pgio, req);
991 if (mirror_count == pgio->pg_mirror_count || pgio->pg_error < 0)
994 if (!mirror_count || mirror_count > NFS_PAGEIO_DESCRIPTOR_MIRROR_MAX) {
995 pgio->pg_error = -EINVAL;
999 pgio->pg_mirrors = nfs_pageio_alloc_mirrors(pgio, mirror_count);
1000 if (pgio->pg_mirrors == NULL) {
1001 pgio->pg_error = -ENOMEM;
1002 pgio->pg_mirrors = pgio->pg_mirrors_static;
1005 pgio->pg_mirror_count = mirror_count;
1008 static void nfs_pageio_cleanup_mirroring(struct nfs_pageio_descriptor *pgio)
1010 pgio->pg_mirror_count = 1;
1011 pgio->pg_mirror_idx = 0;
1012 pgio->pg_mirrors = pgio->pg_mirrors_static;
1013 kfree(pgio->pg_mirrors_dynamic);
1014 pgio->pg_mirrors_dynamic = NULL;
1017 static bool nfs_match_lock_context(const struct nfs_lock_context *l1,
1018 const struct nfs_lock_context *l2)
1020 return l1->lockowner == l2->lockowner;
1024 * nfs_coalesce_size - test two requests for compatibility
1025 * @prev: pointer to nfs_page
1026 * @req: pointer to nfs_page
1027 * @pgio: pointer to nfs_pagio_descriptor
1029 * The nfs_page structures 'prev' and 'req' are compared to ensure that the
1030 * page data area they describe is contiguous, and that their RPC
1031 * credentials, NFSv4 open state, and lockowners are the same.
1033 * Returns size of the request that can be coalesced
1035 static unsigned int nfs_coalesce_size(struct nfs_page *prev,
1036 struct nfs_page *req,
1037 struct nfs_pageio_descriptor *pgio)
1039 struct file_lock_context *flctx;
1042 if (!nfs_match_open_context(nfs_req_openctx(req), nfs_req_openctx(prev)))
1044 flctx = d_inode(nfs_req_openctx(req)->dentry)->i_flctx;
1045 if (flctx != NULL &&
1046 !(list_empty_careful(&flctx->flc_posix) &&
1047 list_empty_careful(&flctx->flc_flock)) &&
1048 !nfs_match_lock_context(req->wb_lock_context,
1049 prev->wb_lock_context))
1051 if (req_offset(req) != req_offset(prev) + prev->wb_bytes)
1053 if (req->wb_page == prev->wb_page) {
1054 if (req->wb_pgbase != prev->wb_pgbase + prev->wb_bytes)
1057 if (req->wb_pgbase != 0 ||
1058 prev->wb_pgbase + prev->wb_bytes != PAGE_SIZE)
1062 return pgio->pg_ops->pg_test(pgio, prev, req);
1066 * nfs_pageio_do_add_request - Attempt to coalesce a request into a page list.
1067 * @desc: destination io descriptor
1070 * If the request 'req' was successfully coalesced into the existing list
1071 * of pages 'desc', it returns the size of req.
1074 nfs_pageio_do_add_request(struct nfs_pageio_descriptor *desc,
1075 struct nfs_page *req)
1077 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1078 struct nfs_page *prev = NULL;
1081 if (mirror->pg_count != 0) {
1082 prev = nfs_list_entry(mirror->pg_list.prev);
1084 if (desc->pg_ops->pg_init)
1085 desc->pg_ops->pg_init(desc, req);
1086 if (desc->pg_error < 0)
1088 mirror->pg_base = req->wb_pgbase;
1091 if (desc->pg_maxretrans && req->wb_nio > desc->pg_maxretrans) {
1092 if (NFS_SERVER(desc->pg_inode)->flags & NFS_MOUNT_SOFTERR)
1093 desc->pg_error = -ETIMEDOUT;
1095 desc->pg_error = -EIO;
1099 size = nfs_coalesce_size(prev, req, desc);
1100 if (size < req->wb_bytes)
1102 nfs_list_move_request(req, &mirror->pg_list);
1103 mirror->pg_count += req->wb_bytes;
1104 return req->wb_bytes;
1108 * Helper for nfs_pageio_add_request and nfs_pageio_complete
1110 static void nfs_pageio_doio(struct nfs_pageio_descriptor *desc)
1112 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1115 if (!list_empty(&mirror->pg_list)) {
1116 int error = desc->pg_ops->pg_doio(desc);
1118 desc->pg_error = error;
1120 mirror->pg_bytes_written += mirror->pg_count;
1122 if (list_empty(&mirror->pg_list)) {
1123 mirror->pg_count = 0;
1124 mirror->pg_base = 0;
1129 nfs_pageio_cleanup_request(struct nfs_pageio_descriptor *desc,
1130 struct nfs_page *req)
1134 nfs_list_move_request(req, &head);
1135 desc->pg_completion_ops->error_cleanup(&head, desc->pg_error);
1139 * nfs_pageio_add_request - Attempt to coalesce a request into a page list.
1140 * @desc: destination io descriptor
1143 * This may split a request into subrequests which are all part of the
1144 * same page group. If so, it will submit @req as the last one, to ensure
1145 * the pointer to @req is still valid in case of failure.
1147 * Returns true if the request 'req' was successfully coalesced into the
1148 * existing list of pages 'desc'.
1150 static int __nfs_pageio_add_request(struct nfs_pageio_descriptor *desc,
1151 struct nfs_page *req)
1153 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1154 struct nfs_page *subreq;
1155 unsigned int size, subreq_size;
1157 nfs_page_group_lock(req);
1160 subreq_size = subreq->wb_bytes;
1162 size = nfs_pageio_do_add_request(desc, subreq);
1163 if (size == subreq_size) {
1164 /* We successfully submitted a request */
1167 req->wb_pgbase += size;
1168 req->wb_bytes -= size;
1169 req->wb_offset += size;
1170 subreq_size = req->wb_bytes;
1174 if (WARN_ON_ONCE(subreq != req)) {
1175 nfs_page_group_unlock(req);
1176 nfs_pageio_cleanup_request(desc, subreq);
1178 subreq_size = req->wb_bytes;
1179 nfs_page_group_lock(req);
1182 /* Can't coalesce any more, so do I/O */
1183 nfs_page_group_unlock(req);
1184 desc->pg_moreio = 1;
1185 nfs_pageio_doio(desc);
1186 if (desc->pg_error < 0 || mirror->pg_recoalesce)
1188 /* retry add_request for this subreq */
1189 nfs_page_group_lock(req);
1192 subreq = nfs_create_subreq(req, req->wb_pgbase,
1193 req->wb_offset, size);
1199 nfs_page_group_unlock(req);
1202 desc->pg_error = PTR_ERR(subreq);
1203 nfs_page_group_unlock(req);
1207 static int nfs_do_recoalesce(struct nfs_pageio_descriptor *desc)
1209 struct nfs_pgio_mirror *mirror = nfs_pgio_current_mirror(desc);
1213 list_splice_init(&mirror->pg_list, &head);
1214 mirror->pg_bytes_written -= mirror->pg_count;
1215 mirror->pg_count = 0;
1216 mirror->pg_base = 0;
1217 mirror->pg_recoalesce = 0;
1219 while (!list_empty(&head)) {
1220 struct nfs_page *req;
1222 req = list_first_entry(&head, struct nfs_page, wb_list);
1223 if (__nfs_pageio_add_request(desc, req))
1225 if (desc->pg_error < 0) {
1226 list_splice_tail(&head, &mirror->pg_list);
1227 mirror->pg_recoalesce = 1;
1232 } while (mirror->pg_recoalesce);
1236 static int nfs_pageio_add_request_mirror(struct nfs_pageio_descriptor *desc,
1237 struct nfs_page *req)
1242 ret = __nfs_pageio_add_request(desc, req);
1245 if (desc->pg_error < 0)
1247 ret = nfs_do_recoalesce(desc);
1253 static void nfs_pageio_error_cleanup(struct nfs_pageio_descriptor *desc)
1256 struct nfs_pgio_mirror *mirror;
1258 if (!desc->pg_error)
1261 for (midx = 0; midx < desc->pg_mirror_count; midx++) {
1262 mirror = &desc->pg_mirrors[midx];
1263 desc->pg_completion_ops->error_cleanup(&mirror->pg_list,
1268 int nfs_pageio_add_request(struct nfs_pageio_descriptor *desc,
1269 struct nfs_page *req)
1272 unsigned int pgbase, offset, bytes;
1273 struct nfs_page *dupreq;
1275 pgbase = req->wb_pgbase;
1276 offset = req->wb_offset;
1277 bytes = req->wb_bytes;
1279 nfs_pageio_setup_mirroring(desc, req);
1280 if (desc->pg_error < 0)
1283 /* Create the mirror instances first, and fire them off */
1284 for (midx = 1; midx < desc->pg_mirror_count; midx++) {
1285 nfs_page_group_lock(req);
1287 dupreq = nfs_create_subreq(req,
1288 pgbase, offset, bytes);
1290 nfs_page_group_unlock(req);
1291 if (IS_ERR(dupreq)) {
1292 desc->pg_error = PTR_ERR(dupreq);
1296 desc->pg_mirror_idx = midx;
1297 if (!nfs_pageio_add_request_mirror(desc, dupreq))
1298 goto out_cleanup_subreq;
1301 desc->pg_mirror_idx = 0;
1302 if (!nfs_pageio_add_request_mirror(desc, req))
1308 nfs_pageio_cleanup_request(desc, dupreq);
1310 nfs_pageio_error_cleanup(desc);
1315 * nfs_pageio_complete_mirror - Complete I/O on the current mirror of an
1316 * nfs_pageio_descriptor
1317 * @desc: pointer to io descriptor
1318 * @mirror_idx: pointer to mirror index
1320 static void nfs_pageio_complete_mirror(struct nfs_pageio_descriptor *desc,
1323 struct nfs_pgio_mirror *mirror = &desc->pg_mirrors[mirror_idx];
1324 u32 restore_idx = desc->pg_mirror_idx;
1326 desc->pg_mirror_idx = mirror_idx;
1328 nfs_pageio_doio(desc);
1329 if (desc->pg_error < 0 || !mirror->pg_recoalesce)
1331 if (!nfs_do_recoalesce(desc))
1334 desc->pg_mirror_idx = restore_idx;
1338 * nfs_pageio_resend - Transfer requests to new descriptor and resend
1339 * @hdr - the pgio header to move request from
1340 * @desc - the pageio descriptor to add requests to
1342 * Try to move each request (nfs_page) from @hdr to @desc then attempt
1345 * Returns 0 on success and < 0 on error.
1347 int nfs_pageio_resend(struct nfs_pageio_descriptor *desc,
1348 struct nfs_pgio_header *hdr)
1352 desc->pg_io_completion = hdr->io_completion;
1353 desc->pg_dreq = hdr->dreq;
1354 list_splice_init(&hdr->pages, &pages);
1355 while (!list_empty(&pages)) {
1356 struct nfs_page *req = nfs_list_entry(pages.next);
1358 if (!nfs_pageio_add_request(desc, req))
1361 nfs_pageio_complete(desc);
1362 if (!list_empty(&pages)) {
1363 int err = desc->pg_error < 0 ? desc->pg_error : -EIO;
1364 hdr->completion_ops->error_cleanup(&pages, err);
1365 nfs_set_pgio_error(hdr, err, hdr->io_start);
1370 EXPORT_SYMBOL_GPL(nfs_pageio_resend);
1373 * nfs_pageio_complete - Complete I/O then cleanup an nfs_pageio_descriptor
1374 * @desc: pointer to io descriptor
1376 void nfs_pageio_complete(struct nfs_pageio_descriptor *desc)
1380 for (midx = 0; midx < desc->pg_mirror_count; midx++)
1381 nfs_pageio_complete_mirror(desc, midx);
1383 if (desc->pg_error < 0)
1384 nfs_pageio_error_cleanup(desc);
1385 if (desc->pg_ops->pg_cleanup)
1386 desc->pg_ops->pg_cleanup(desc);
1387 nfs_pageio_cleanup_mirroring(desc);
1391 * nfs_pageio_cond_complete - Conditional I/O completion
1392 * @desc: pointer to io descriptor
1393 * @index: page index
1395 * It is important to ensure that processes don't try to take locks
1396 * on non-contiguous ranges of pages as that might deadlock. This
1397 * function should be called before attempting to wait on a locked
1398 * nfs_page. It will complete the I/O if the page index 'index'
1399 * is not contiguous with the existing list of pages in 'desc'.
1401 void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *desc, pgoff_t index)
1403 struct nfs_pgio_mirror *mirror;
1404 struct nfs_page *prev;
1407 for (midx = 0; midx < desc->pg_mirror_count; midx++) {
1408 mirror = &desc->pg_mirrors[midx];
1409 if (!list_empty(&mirror->pg_list)) {
1410 prev = nfs_list_entry(mirror->pg_list.prev);
1411 if (index != prev->wb_index + 1) {
1412 nfs_pageio_complete(desc);
1420 * nfs_pageio_stop_mirroring - stop using mirroring (set mirror count to 1)
1422 void nfs_pageio_stop_mirroring(struct nfs_pageio_descriptor *pgio)
1424 nfs_pageio_complete(pgio);
1427 int __init nfs_init_nfspagecache(void)
1429 nfs_page_cachep = kmem_cache_create("nfs_page",
1430 sizeof(struct nfs_page),
1431 0, SLAB_HWCACHE_ALIGN,
1433 if (nfs_page_cachep == NULL)
1439 void nfs_destroy_nfspagecache(void)
1441 kmem_cache_destroy(nfs_page_cachep);
1444 static const struct rpc_call_ops nfs_pgio_common_ops = {
1445 .rpc_call_prepare = nfs_pgio_prepare,
1446 .rpc_call_done = nfs_pgio_result,
1447 .rpc_release = nfs_pgio_release,
1450 const struct nfs_pageio_ops nfs_pgio_rw_ops = {
1451 .pg_test = nfs_generic_pg_test,
1452 .pg_doio = nfs_generic_pg_pgios,