mdio-sun4i: oops in error handling in probe
[linux/fpc-iii.git] / fs / nfs / pagelist.c
bloba60f64d88df3f7cc62482e57700350a70e160a23
1 /*
2 * linux/fs/nfs/pagelist.c
4 * A set of helper functions for managing NFS read and write requests.
5 * The main purpose of these routines is to provide support for the
6 * coalescing of several requests into a single RPC call.
8 * Copyright 2000, 2001 (c) Trond Myklebust <trond.myklebust@fys.uio.no>
12 #include <linux/slab.h>
13 #include <linux/file.h>
14 #include <linux/sched.h>
15 #include <linux/sunrpc/clnt.h>
16 #include <linux/nfs.h>
17 #include <linux/nfs3.h>
18 #include <linux/nfs4.h>
19 #include <linux/nfs_page.h>
20 #include <linux/nfs_fs.h>
21 #include <linux/nfs_mount.h>
22 #include <linux/export.h>
24 #include "internal.h"
25 #include "pnfs.h"
27 #define NFSDBG_FACILITY NFSDBG_PAGECACHE
29 static struct kmem_cache *nfs_page_cachep;
30 static const struct rpc_call_ops nfs_pgio_common_ops;
32 static bool nfs_pgarray_set(struct nfs_page_array *p, unsigned int pagecount)
34 p->npages = pagecount;
35 if (pagecount <= ARRAY_SIZE(p->page_array))
36 p->pagevec = p->page_array;
37 else {
38 p->pagevec = kcalloc(pagecount, sizeof(struct page *), GFP_KERNEL);
39 if (!p->pagevec)
40 p->npages = 0;
42 return p->pagevec != NULL;
45 void nfs_pgheader_init(struct nfs_pageio_descriptor *desc,
46 struct nfs_pgio_header *hdr,
47 void (*release)(struct nfs_pgio_header *hdr))
49 hdr->req = nfs_list_entry(desc->pg_list.next);
50 hdr->inode = desc->pg_inode;
51 hdr->cred = hdr->req->wb_context->cred;
52 hdr->io_start = req_offset(hdr->req);
53 hdr->good_bytes = desc->pg_count;
54 hdr->dreq = desc->pg_dreq;
55 hdr->layout_private = desc->pg_layout_private;
56 hdr->release = release;
57 hdr->completion_ops = desc->pg_completion_ops;
58 if (hdr->completion_ops->init_hdr)
59 hdr->completion_ops->init_hdr(hdr);
61 EXPORT_SYMBOL_GPL(nfs_pgheader_init);
63 void nfs_set_pgio_error(struct nfs_pgio_header *hdr, int error, loff_t pos)
65 spin_lock(&hdr->lock);
66 if (!test_and_set_bit(NFS_IOHDR_ERROR, &hdr->flags)
67 || pos < hdr->io_start + hdr->good_bytes) {
68 clear_bit(NFS_IOHDR_EOF, &hdr->flags);
69 hdr->good_bytes = pos - hdr->io_start;
70 hdr->error = error;
72 spin_unlock(&hdr->lock);
75 static inline struct nfs_page *
76 nfs_page_alloc(void)
78 struct nfs_page *p = kmem_cache_zalloc(nfs_page_cachep, GFP_NOIO);
79 if (p)
80 INIT_LIST_HEAD(&p->wb_list);
81 return p;
84 static inline void
85 nfs_page_free(struct nfs_page *p)
87 kmem_cache_free(nfs_page_cachep, p);
90 static void
91 nfs_iocounter_inc(struct nfs_io_counter *c)
93 atomic_inc(&c->io_count);
96 static void
97 nfs_iocounter_dec(struct nfs_io_counter *c)
99 if (atomic_dec_and_test(&c->io_count)) {
100 clear_bit(NFS_IO_INPROGRESS, &c->flags);
101 smp_mb__after_atomic();
102 wake_up_bit(&c->flags, NFS_IO_INPROGRESS);
106 static int
107 __nfs_iocounter_wait(struct nfs_io_counter *c)
109 wait_queue_head_t *wq = bit_waitqueue(&c->flags, NFS_IO_INPROGRESS);
110 DEFINE_WAIT_BIT(q, &c->flags, NFS_IO_INPROGRESS);
111 int ret = 0;
113 do {
114 prepare_to_wait(wq, &q.wait, TASK_KILLABLE);
115 set_bit(NFS_IO_INPROGRESS, &c->flags);
116 if (atomic_read(&c->io_count) == 0)
117 break;
118 ret = nfs_wait_bit_killable(&c->flags);
119 } while (atomic_read(&c->io_count) != 0 && !ret);
120 finish_wait(wq, &q.wait);
121 return ret;
125 * nfs_iocounter_wait - wait for i/o to complete
126 * @c: nfs_io_counter to use
128 * returns -ERESTARTSYS if interrupted by a fatal signal.
129 * Otherwise returns 0 once the io_count hits 0.
132 nfs_iocounter_wait(struct nfs_io_counter *c)
134 if (atomic_read(&c->io_count) == 0)
135 return 0;
136 return __nfs_iocounter_wait(c);
139 static int nfs_wait_bit_uninterruptible(void *word)
141 io_schedule();
142 return 0;
146 * nfs_page_group_lock - lock the head of the page group
147 * @req - request in group that is to be locked
148 * @nonblock - if true don't block waiting for lock
150 * this lock must be held if modifying the page group list
152 * return 0 on success, < 0 on error: -EDELAY if nonblocking or the
153 * result from wait_on_bit_lock
155 * NOTE: calling with nonblock=false should always have set the
156 * lock bit (see fs/buffer.c and other uses of wait_on_bit_lock
157 * with TASK_UNINTERRUPTIBLE), so there is no need to check the result.
160 nfs_page_group_lock(struct nfs_page *req, bool nonblock)
162 struct nfs_page *head = req->wb_head;
164 WARN_ON_ONCE(head != head->wb_head);
166 if (!test_and_set_bit(PG_HEADLOCK, &head->wb_flags))
167 return 0;
169 if (!nonblock)
170 return wait_on_bit_lock(&head->wb_flags, PG_HEADLOCK,
171 nfs_wait_bit_uninterruptible,
172 TASK_UNINTERRUPTIBLE);
174 return -EAGAIN;
178 * nfs_page_group_lock_wait - wait for the lock to clear, but don't grab it
179 * @req - a request in the group
181 * This is a blocking call to wait for the group lock to be cleared.
183 void
184 nfs_page_group_lock_wait(struct nfs_page *req)
186 struct nfs_page *head = req->wb_head;
188 WARN_ON_ONCE(head != head->wb_head);
190 wait_on_bit(&head->wb_flags, PG_HEADLOCK,
191 nfs_wait_bit_uninterruptible,
192 TASK_UNINTERRUPTIBLE);
196 * nfs_page_group_unlock - unlock the head of the page group
197 * @req - request in group that is to be unlocked
199 void
200 nfs_page_group_unlock(struct nfs_page *req)
202 struct nfs_page *head = req->wb_head;
204 WARN_ON_ONCE(head != head->wb_head);
206 smp_mb__before_atomic();
207 clear_bit(PG_HEADLOCK, &head->wb_flags);
208 smp_mb__after_atomic();
209 wake_up_bit(&head->wb_flags, PG_HEADLOCK);
213 * nfs_page_group_sync_on_bit_locked
215 * must be called with page group lock held
217 static bool
218 nfs_page_group_sync_on_bit_locked(struct nfs_page *req, unsigned int bit)
220 struct nfs_page *head = req->wb_head;
221 struct nfs_page *tmp;
223 WARN_ON_ONCE(!test_bit(PG_HEADLOCK, &head->wb_flags));
224 WARN_ON_ONCE(test_and_set_bit(bit, &req->wb_flags));
226 tmp = req->wb_this_page;
227 while (tmp != req) {
228 if (!test_bit(bit, &tmp->wb_flags))
229 return false;
230 tmp = tmp->wb_this_page;
233 /* true! reset all bits */
234 tmp = req;
235 do {
236 clear_bit(bit, &tmp->wb_flags);
237 tmp = tmp->wb_this_page;
238 } while (tmp != req);
240 return true;
244 * nfs_page_group_sync_on_bit - set bit on current request, but only
245 * return true if the bit is set for all requests in page group
246 * @req - request in page group
247 * @bit - PG_* bit that is used to sync page group
249 bool nfs_page_group_sync_on_bit(struct nfs_page *req, unsigned int bit)
251 bool ret;
253 nfs_page_group_lock(req, false);
254 ret = nfs_page_group_sync_on_bit_locked(req, bit);
255 nfs_page_group_unlock(req);
257 return ret;
261 * nfs_page_group_init - Initialize the page group linkage for @req
262 * @req - a new nfs request
263 * @prev - the previous request in page group, or NULL if @req is the first
264 * or only request in the group (the head).
266 static inline void
267 nfs_page_group_init(struct nfs_page *req, struct nfs_page *prev)
269 WARN_ON_ONCE(prev == req);
271 if (!prev) {
272 /* a head request */
273 req->wb_head = req;
274 req->wb_this_page = req;
275 } else {
276 /* a subrequest */
277 WARN_ON_ONCE(prev->wb_this_page != prev->wb_head);
278 WARN_ON_ONCE(!test_bit(PG_HEADLOCK, &prev->wb_head->wb_flags));
279 req->wb_head = prev->wb_head;
280 req->wb_this_page = prev->wb_this_page;
281 prev->wb_this_page = req;
283 /* All subrequests take a ref on the head request until
284 * nfs_page_group_destroy is called */
285 kref_get(&req->wb_head->wb_kref);
287 /* grab extra ref if head request has extra ref from
288 * the write/commit path to handle handoff between write
289 * and commit lists */
290 if (test_bit(PG_INODE_REF, &prev->wb_head->wb_flags)) {
291 set_bit(PG_INODE_REF, &req->wb_flags);
292 kref_get(&req->wb_kref);
298 * nfs_page_group_destroy - sync the destruction of page groups
299 * @req - request that no longer needs the page group
301 * releases the page group reference from each member once all
302 * members have called this function.
304 static void
305 nfs_page_group_destroy(struct kref *kref)
307 struct nfs_page *req = container_of(kref, struct nfs_page, wb_kref);
308 struct nfs_page *tmp, *next;
310 /* subrequests must release the ref on the head request */
311 if (req->wb_head != req)
312 nfs_release_request(req->wb_head);
314 if (!nfs_page_group_sync_on_bit(req, PG_TEARDOWN))
315 return;
317 tmp = req;
318 do {
319 next = tmp->wb_this_page;
320 /* unlink and free */
321 tmp->wb_this_page = tmp;
322 tmp->wb_head = tmp;
323 nfs_free_request(tmp);
324 tmp = next;
325 } while (tmp != req);
329 * nfs_create_request - Create an NFS read/write request.
330 * @ctx: open context to use
331 * @page: page to write
332 * @last: last nfs request created for this page group or NULL if head
333 * @offset: starting offset within the page for the write
334 * @count: number of bytes to read/write
336 * The page must be locked by the caller. This makes sure we never
337 * create two different requests for the same page.
338 * User should ensure it is safe to sleep in this function.
340 struct nfs_page *
341 nfs_create_request(struct nfs_open_context *ctx, struct page *page,
342 struct nfs_page *last, unsigned int offset,
343 unsigned int count)
345 struct nfs_page *req;
346 struct nfs_lock_context *l_ctx;
348 if (test_bit(NFS_CONTEXT_BAD, &ctx->flags))
349 return ERR_PTR(-EBADF);
350 /* try to allocate the request struct */
351 req = nfs_page_alloc();
352 if (req == NULL)
353 return ERR_PTR(-ENOMEM);
355 /* get lock context early so we can deal with alloc failures */
356 l_ctx = nfs_get_lock_context(ctx);
357 if (IS_ERR(l_ctx)) {
358 nfs_page_free(req);
359 return ERR_CAST(l_ctx);
361 req->wb_lock_context = l_ctx;
362 nfs_iocounter_inc(&l_ctx->io_count);
364 /* Initialize the request struct. Initially, we assume a
365 * long write-back delay. This will be adjusted in
366 * update_nfs_request below if the region is not locked. */
367 req->wb_page = page;
368 req->wb_index = page_file_index(page);
369 page_cache_get(page);
370 req->wb_offset = offset;
371 req->wb_pgbase = offset;
372 req->wb_bytes = count;
373 req->wb_context = get_nfs_open_context(ctx);
374 kref_init(&req->wb_kref);
375 nfs_page_group_init(req, last);
376 return req;
380 * nfs_unlock_request - Unlock request and wake up sleepers.
381 * @req:
383 void nfs_unlock_request(struct nfs_page *req)
385 if (!NFS_WBACK_BUSY(req)) {
386 printk(KERN_ERR "NFS: Invalid unlock attempted\n");
387 BUG();
389 smp_mb__before_atomic();
390 clear_bit(PG_BUSY, &req->wb_flags);
391 smp_mb__after_atomic();
392 wake_up_bit(&req->wb_flags, PG_BUSY);
396 * nfs_unlock_and_release_request - Unlock request and release the nfs_page
397 * @req:
399 void nfs_unlock_and_release_request(struct nfs_page *req)
401 nfs_unlock_request(req);
402 nfs_release_request(req);
406 * nfs_clear_request - Free up all resources allocated to the request
407 * @req:
409 * Release page and open context resources associated with a read/write
410 * request after it has completed.
412 static void nfs_clear_request(struct nfs_page *req)
414 struct page *page = req->wb_page;
415 struct nfs_open_context *ctx = req->wb_context;
416 struct nfs_lock_context *l_ctx = req->wb_lock_context;
418 if (page != NULL) {
419 page_cache_release(page);
420 req->wb_page = NULL;
422 if (l_ctx != NULL) {
423 nfs_iocounter_dec(&l_ctx->io_count);
424 nfs_put_lock_context(l_ctx);
425 req->wb_lock_context = NULL;
427 if (ctx != NULL) {
428 put_nfs_open_context(ctx);
429 req->wb_context = NULL;
434 * nfs_release_request - Release the count on an NFS read/write request
435 * @req: request to release
437 * Note: Should never be called with the spinlock held!
439 void nfs_free_request(struct nfs_page *req)
441 WARN_ON_ONCE(req->wb_this_page != req);
443 /* extra debug: make sure no sync bits are still set */
444 WARN_ON_ONCE(test_bit(PG_TEARDOWN, &req->wb_flags));
445 WARN_ON_ONCE(test_bit(PG_UNLOCKPAGE, &req->wb_flags));
446 WARN_ON_ONCE(test_bit(PG_UPTODATE, &req->wb_flags));
447 WARN_ON_ONCE(test_bit(PG_WB_END, &req->wb_flags));
448 WARN_ON_ONCE(test_bit(PG_REMOVE, &req->wb_flags));
450 /* Release struct file and open context */
451 nfs_clear_request(req);
452 nfs_page_free(req);
455 void nfs_release_request(struct nfs_page *req)
457 kref_put(&req->wb_kref, nfs_page_group_destroy);
461 * nfs_wait_on_request - Wait for a request to complete.
462 * @req: request to wait upon.
464 * Interruptible by fatal signals only.
465 * The user is responsible for holding a count on the request.
468 nfs_wait_on_request(struct nfs_page *req)
470 return wait_on_bit(&req->wb_flags, PG_BUSY,
471 nfs_wait_bit_uninterruptible,
472 TASK_UNINTERRUPTIBLE);
476 * nfs_generic_pg_test - determine if requests can be coalesced
477 * @desc: pointer to descriptor
478 * @prev: previous request in desc, or NULL
479 * @req: this request
481 * Returns zero if @req can be coalesced into @desc, otherwise it returns
482 * the size of the request.
484 size_t nfs_generic_pg_test(struct nfs_pageio_descriptor *desc,
485 struct nfs_page *prev, struct nfs_page *req)
487 if (desc->pg_count > desc->pg_bsize) {
488 /* should never happen */
489 WARN_ON_ONCE(1);
490 return 0;
493 return min(desc->pg_bsize - desc->pg_count, (size_t)req->wb_bytes);
495 EXPORT_SYMBOL_GPL(nfs_generic_pg_test);
497 struct nfs_pgio_header *nfs_pgio_header_alloc(const struct nfs_rw_ops *ops)
499 struct nfs_pgio_header *hdr = ops->rw_alloc_header();
501 if (hdr) {
502 INIT_LIST_HEAD(&hdr->pages);
503 spin_lock_init(&hdr->lock);
504 hdr->rw_ops = ops;
506 return hdr;
508 EXPORT_SYMBOL_GPL(nfs_pgio_header_alloc);
511 * nfs_pgio_header_free - Free a read or write header
512 * @hdr: The header to free
514 void nfs_pgio_header_free(struct nfs_pgio_header *hdr)
516 hdr->rw_ops->rw_free_header(hdr);
518 EXPORT_SYMBOL_GPL(nfs_pgio_header_free);
521 * nfs_pgio_data_destroy - make @hdr suitable for reuse
523 * Frees memory and releases refs from nfs_generic_pgio, so that it may
524 * be called again.
526 * @hdr: A header that has had nfs_generic_pgio called
528 void nfs_pgio_data_destroy(struct nfs_pgio_header *hdr)
530 if (hdr->args.context)
531 put_nfs_open_context(hdr->args.context);
532 if (hdr->page_array.pagevec != hdr->page_array.page_array)
533 kfree(hdr->page_array.pagevec);
535 EXPORT_SYMBOL_GPL(nfs_pgio_data_destroy);
538 * nfs_pgio_rpcsetup - Set up arguments for a pageio call
539 * @hdr: The pageio hdr
540 * @count: Number of bytes to read
541 * @offset: Initial offset
542 * @how: How to commit data (writes only)
543 * @cinfo: Commit information for the call (writes only)
545 static void nfs_pgio_rpcsetup(struct nfs_pgio_header *hdr,
546 unsigned int count, unsigned int offset,
547 int how, struct nfs_commit_info *cinfo)
549 struct nfs_page *req = hdr->req;
551 /* Set up the RPC argument and reply structs
552 * NB: take care not to mess about with hdr->commit et al. */
554 hdr->args.fh = NFS_FH(hdr->inode);
555 hdr->args.offset = req_offset(req) + offset;
556 /* pnfs_set_layoutcommit needs this */
557 hdr->mds_offset = hdr->args.offset;
558 hdr->args.pgbase = req->wb_pgbase + offset;
559 hdr->args.pages = hdr->page_array.pagevec;
560 hdr->args.count = count;
561 hdr->args.context = get_nfs_open_context(req->wb_context);
562 hdr->args.lock_context = req->wb_lock_context;
563 hdr->args.stable = NFS_UNSTABLE;
564 switch (how & (FLUSH_STABLE | FLUSH_COND_STABLE)) {
565 case 0:
566 break;
567 case FLUSH_COND_STABLE:
568 if (nfs_reqs_to_commit(cinfo))
569 break;
570 default:
571 hdr->args.stable = NFS_FILE_SYNC;
574 hdr->res.fattr = &hdr->fattr;
575 hdr->res.count = count;
576 hdr->res.eof = 0;
577 hdr->res.verf = &hdr->writeverf;
578 nfs_fattr_init(&hdr->fattr);
582 * nfs_pgio_prepare - Prepare pageio hdr to go over the wire
583 * @task: The current task
584 * @calldata: pageio header to prepare
586 static void nfs_pgio_prepare(struct rpc_task *task, void *calldata)
588 struct nfs_pgio_header *hdr = calldata;
589 int err;
590 err = NFS_PROTO(hdr->inode)->pgio_rpc_prepare(task, hdr);
591 if (err)
592 rpc_exit(task, err);
595 int nfs_initiate_pgio(struct rpc_clnt *clnt, struct nfs_pgio_header *hdr,
596 const struct rpc_call_ops *call_ops, int how, int flags)
598 struct rpc_task *task;
599 struct rpc_message msg = {
600 .rpc_argp = &hdr->args,
601 .rpc_resp = &hdr->res,
602 .rpc_cred = hdr->cred,
604 struct rpc_task_setup task_setup_data = {
605 .rpc_client = clnt,
606 .task = &hdr->task,
607 .rpc_message = &msg,
608 .callback_ops = call_ops,
609 .callback_data = hdr,
610 .workqueue = nfsiod_workqueue,
611 .flags = RPC_TASK_ASYNC | flags,
613 int ret = 0;
615 hdr->rw_ops->rw_initiate(hdr, &msg, &task_setup_data, how);
617 dprintk("NFS: %5u initiated pgio call "
618 "(req %s/%llu, %u bytes @ offset %llu)\n",
619 hdr->task.tk_pid,
620 hdr->inode->i_sb->s_id,
621 (unsigned long long)NFS_FILEID(hdr->inode),
622 hdr->args.count,
623 (unsigned long long)hdr->args.offset);
625 task = rpc_run_task(&task_setup_data);
626 if (IS_ERR(task)) {
627 ret = PTR_ERR(task);
628 goto out;
630 if (how & FLUSH_SYNC) {
631 ret = rpc_wait_for_completion_task(task);
632 if (ret == 0)
633 ret = task->tk_status;
635 rpc_put_task(task);
636 out:
637 return ret;
639 EXPORT_SYMBOL_GPL(nfs_initiate_pgio);
642 * nfs_pgio_error - Clean up from a pageio error
643 * @desc: IO descriptor
644 * @hdr: pageio header
646 static int nfs_pgio_error(struct nfs_pageio_descriptor *desc,
647 struct nfs_pgio_header *hdr)
649 set_bit(NFS_IOHDR_REDO, &hdr->flags);
650 nfs_pgio_data_destroy(hdr);
651 hdr->completion_ops->completion(hdr);
652 desc->pg_completion_ops->error_cleanup(&desc->pg_list);
653 return -ENOMEM;
657 * nfs_pgio_release - Release pageio data
658 * @calldata: The pageio header to release
660 static void nfs_pgio_release(void *calldata)
662 struct nfs_pgio_header *hdr = calldata;
663 if (hdr->rw_ops->rw_release)
664 hdr->rw_ops->rw_release(hdr);
665 nfs_pgio_data_destroy(hdr);
666 hdr->completion_ops->completion(hdr);
670 * nfs_pageio_init - initialise a page io descriptor
671 * @desc: pointer to descriptor
672 * @inode: pointer to inode
673 * @doio: pointer to io function
674 * @bsize: io block size
675 * @io_flags: extra parameters for the io function
677 void nfs_pageio_init(struct nfs_pageio_descriptor *desc,
678 struct inode *inode,
679 const struct nfs_pageio_ops *pg_ops,
680 const struct nfs_pgio_completion_ops *compl_ops,
681 const struct nfs_rw_ops *rw_ops,
682 size_t bsize,
683 int io_flags)
685 INIT_LIST_HEAD(&desc->pg_list);
686 desc->pg_bytes_written = 0;
687 desc->pg_count = 0;
688 desc->pg_bsize = bsize;
689 desc->pg_base = 0;
690 desc->pg_moreio = 0;
691 desc->pg_recoalesce = 0;
692 desc->pg_inode = inode;
693 desc->pg_ops = pg_ops;
694 desc->pg_completion_ops = compl_ops;
695 desc->pg_rw_ops = rw_ops;
696 desc->pg_ioflags = io_flags;
697 desc->pg_error = 0;
698 desc->pg_lseg = NULL;
699 desc->pg_dreq = NULL;
700 desc->pg_layout_private = NULL;
702 EXPORT_SYMBOL_GPL(nfs_pageio_init);
705 * nfs_pgio_result - Basic pageio error handling
706 * @task: The task that ran
707 * @calldata: Pageio header to check
709 static void nfs_pgio_result(struct rpc_task *task, void *calldata)
711 struct nfs_pgio_header *hdr = calldata;
712 struct inode *inode = hdr->inode;
714 dprintk("NFS: %s: %5u, (status %d)\n", __func__,
715 task->tk_pid, task->tk_status);
717 if (hdr->rw_ops->rw_done(task, hdr, inode) != 0)
718 return;
719 if (task->tk_status < 0)
720 nfs_set_pgio_error(hdr, task->tk_status, hdr->args.offset);
721 else
722 hdr->rw_ops->rw_result(task, hdr);
726 * Create an RPC task for the given read or write request and kick it.
727 * The page must have been locked by the caller.
729 * It may happen that the page we're passed is not marked dirty.
730 * This is the case if nfs_updatepage detects a conflicting request
731 * that has been written but not committed.
733 int nfs_generic_pgio(struct nfs_pageio_descriptor *desc,
734 struct nfs_pgio_header *hdr)
736 struct nfs_page *req;
737 struct page **pages,
738 *last_page;
739 struct list_head *head = &desc->pg_list;
740 struct nfs_commit_info cinfo;
741 unsigned int pagecount, pageused;
743 pagecount = nfs_page_array_len(desc->pg_base, desc->pg_count);
744 if (!nfs_pgarray_set(&hdr->page_array, pagecount))
745 return nfs_pgio_error(desc, hdr);
747 nfs_init_cinfo(&cinfo, desc->pg_inode, desc->pg_dreq);
748 pages = hdr->page_array.pagevec;
749 last_page = NULL;
750 pageused = 0;
751 while (!list_empty(head)) {
752 req = nfs_list_entry(head->next);
753 nfs_list_remove_request(req);
754 nfs_list_add_request(req, &hdr->pages);
756 if (!last_page || last_page != req->wb_page) {
757 pageused++;
758 if (pageused > pagecount)
759 break;
760 *pages++ = last_page = req->wb_page;
763 if (WARN_ON_ONCE(pageused != pagecount))
764 return nfs_pgio_error(desc, hdr);
766 if ((desc->pg_ioflags & FLUSH_COND_STABLE) &&
767 (desc->pg_moreio || nfs_reqs_to_commit(&cinfo)))
768 desc->pg_ioflags &= ~FLUSH_COND_STABLE;
770 /* Set up the argument struct */
771 nfs_pgio_rpcsetup(hdr, desc->pg_count, 0, desc->pg_ioflags, &cinfo);
772 desc->pg_rpc_callops = &nfs_pgio_common_ops;
773 return 0;
775 EXPORT_SYMBOL_GPL(nfs_generic_pgio);
777 static int nfs_generic_pg_pgios(struct nfs_pageio_descriptor *desc)
779 struct nfs_pgio_header *hdr;
780 int ret;
782 hdr = nfs_pgio_header_alloc(desc->pg_rw_ops);
783 if (!hdr) {
784 desc->pg_completion_ops->error_cleanup(&desc->pg_list);
785 return -ENOMEM;
787 nfs_pgheader_init(desc, hdr, nfs_pgio_header_free);
788 ret = nfs_generic_pgio(desc, hdr);
789 if (ret == 0)
790 ret = nfs_initiate_pgio(NFS_CLIENT(hdr->inode),
791 hdr, desc->pg_rpc_callops,
792 desc->pg_ioflags, 0);
793 return ret;
796 static bool nfs_match_open_context(const struct nfs_open_context *ctx1,
797 const struct nfs_open_context *ctx2)
799 return ctx1->cred == ctx2->cred && ctx1->state == ctx2->state;
802 static bool nfs_match_lock_context(const struct nfs_lock_context *l1,
803 const struct nfs_lock_context *l2)
805 return l1->lockowner.l_owner == l2->lockowner.l_owner
806 && l1->lockowner.l_pid == l2->lockowner.l_pid;
810 * nfs_can_coalesce_requests - test two requests for compatibility
811 * @prev: pointer to nfs_page
812 * @req: pointer to nfs_page
814 * The nfs_page structures 'prev' and 'req' are compared to ensure that the
815 * page data area they describe is contiguous, and that their RPC
816 * credentials, NFSv4 open state, and lockowners are the same.
818 * Return 'true' if this is the case, else return 'false'.
820 static bool nfs_can_coalesce_requests(struct nfs_page *prev,
821 struct nfs_page *req,
822 struct nfs_pageio_descriptor *pgio)
824 size_t size;
826 if (prev) {
827 if (!nfs_match_open_context(req->wb_context, prev->wb_context))
828 return false;
829 if (req->wb_context->dentry->d_inode->i_flock != NULL &&
830 !nfs_match_lock_context(req->wb_lock_context,
831 prev->wb_lock_context))
832 return false;
833 if (req_offset(req) != req_offset(prev) + prev->wb_bytes)
834 return false;
835 if (req->wb_page == prev->wb_page) {
836 if (req->wb_pgbase != prev->wb_pgbase + prev->wb_bytes)
837 return false;
838 } else {
839 if (req->wb_pgbase != 0 ||
840 prev->wb_pgbase + prev->wb_bytes != PAGE_CACHE_SIZE)
841 return false;
844 size = pgio->pg_ops->pg_test(pgio, prev, req);
845 WARN_ON_ONCE(size > req->wb_bytes);
846 if (size && size < req->wb_bytes)
847 req->wb_bytes = size;
848 return size > 0;
852 * nfs_pageio_do_add_request - Attempt to coalesce a request into a page list.
853 * @desc: destination io descriptor
854 * @req: request
856 * Returns true if the request 'req' was successfully coalesced into the
857 * existing list of pages 'desc'.
859 static int nfs_pageio_do_add_request(struct nfs_pageio_descriptor *desc,
860 struct nfs_page *req)
862 struct nfs_page *prev = NULL;
863 if (desc->pg_count != 0) {
864 prev = nfs_list_entry(desc->pg_list.prev);
865 } else {
866 if (desc->pg_ops->pg_init)
867 desc->pg_ops->pg_init(desc, req);
868 desc->pg_base = req->wb_pgbase;
870 if (!nfs_can_coalesce_requests(prev, req, desc))
871 return 0;
872 nfs_list_remove_request(req);
873 nfs_list_add_request(req, &desc->pg_list);
874 desc->pg_count += req->wb_bytes;
875 return 1;
879 * Helper for nfs_pageio_add_request and nfs_pageio_complete
881 static void nfs_pageio_doio(struct nfs_pageio_descriptor *desc)
883 if (!list_empty(&desc->pg_list)) {
884 int error = desc->pg_ops->pg_doio(desc);
885 if (error < 0)
886 desc->pg_error = error;
887 else
888 desc->pg_bytes_written += desc->pg_count;
890 if (list_empty(&desc->pg_list)) {
891 desc->pg_count = 0;
892 desc->pg_base = 0;
897 * nfs_pageio_add_request - Attempt to coalesce a request into a page list.
898 * @desc: destination io descriptor
899 * @req: request
901 * This may split a request into subrequests which are all part of the
902 * same page group.
904 * Returns true if the request 'req' was successfully coalesced into the
905 * existing list of pages 'desc'.
907 static int __nfs_pageio_add_request(struct nfs_pageio_descriptor *desc,
908 struct nfs_page *req)
910 struct nfs_page *subreq;
911 unsigned int bytes_left = 0;
912 unsigned int offset, pgbase;
914 nfs_page_group_lock(req, false);
916 subreq = req;
917 bytes_left = subreq->wb_bytes;
918 offset = subreq->wb_offset;
919 pgbase = subreq->wb_pgbase;
921 do {
922 if (!nfs_pageio_do_add_request(desc, subreq)) {
923 /* make sure pg_test call(s) did nothing */
924 WARN_ON_ONCE(subreq->wb_bytes != bytes_left);
925 WARN_ON_ONCE(subreq->wb_offset != offset);
926 WARN_ON_ONCE(subreq->wb_pgbase != pgbase);
928 nfs_page_group_unlock(req);
929 desc->pg_moreio = 1;
930 nfs_pageio_doio(desc);
931 if (desc->pg_error < 0)
932 return 0;
933 if (desc->pg_recoalesce)
934 return 0;
935 /* retry add_request for this subreq */
936 nfs_page_group_lock(req, false);
937 continue;
940 /* check for buggy pg_test call(s) */
941 WARN_ON_ONCE(subreq->wb_bytes + subreq->wb_pgbase > PAGE_SIZE);
942 WARN_ON_ONCE(subreq->wb_bytes > bytes_left);
943 WARN_ON_ONCE(subreq->wb_bytes == 0);
945 bytes_left -= subreq->wb_bytes;
946 offset += subreq->wb_bytes;
947 pgbase += subreq->wb_bytes;
949 if (bytes_left) {
950 subreq = nfs_create_request(req->wb_context,
951 req->wb_page,
952 subreq, pgbase, bytes_left);
953 if (IS_ERR(subreq))
954 goto err_ptr;
955 nfs_lock_request(subreq);
956 subreq->wb_offset = offset;
957 subreq->wb_index = req->wb_index;
959 } while (bytes_left > 0);
961 nfs_page_group_unlock(req);
962 return 1;
963 err_ptr:
964 desc->pg_error = PTR_ERR(subreq);
965 nfs_page_group_unlock(req);
966 return 0;
969 static int nfs_do_recoalesce(struct nfs_pageio_descriptor *desc)
971 LIST_HEAD(head);
973 do {
974 list_splice_init(&desc->pg_list, &head);
975 desc->pg_bytes_written -= desc->pg_count;
976 desc->pg_count = 0;
977 desc->pg_base = 0;
978 desc->pg_recoalesce = 0;
979 desc->pg_moreio = 0;
981 while (!list_empty(&head)) {
982 struct nfs_page *req;
984 req = list_first_entry(&head, struct nfs_page, wb_list);
985 nfs_list_remove_request(req);
986 if (__nfs_pageio_add_request(desc, req))
987 continue;
988 if (desc->pg_error < 0)
989 return 0;
990 break;
992 } while (desc->pg_recoalesce);
993 return 1;
996 int nfs_pageio_add_request(struct nfs_pageio_descriptor *desc,
997 struct nfs_page *req)
999 int ret;
1001 do {
1002 ret = __nfs_pageio_add_request(desc, req);
1003 if (ret)
1004 break;
1005 if (desc->pg_error < 0)
1006 break;
1007 ret = nfs_do_recoalesce(desc);
1008 } while (ret);
1009 return ret;
1011 EXPORT_SYMBOL_GPL(nfs_pageio_add_request);
1014 * nfs_pageio_complete - Complete I/O on an nfs_pageio_descriptor
1015 * @desc: pointer to io descriptor
1017 void nfs_pageio_complete(struct nfs_pageio_descriptor *desc)
1019 for (;;) {
1020 nfs_pageio_doio(desc);
1021 if (!desc->pg_recoalesce)
1022 break;
1023 if (!nfs_do_recoalesce(desc))
1024 break;
1027 EXPORT_SYMBOL_GPL(nfs_pageio_complete);
1030 * nfs_pageio_cond_complete - Conditional I/O completion
1031 * @desc: pointer to io descriptor
1032 * @index: page index
1034 * It is important to ensure that processes don't try to take locks
1035 * on non-contiguous ranges of pages as that might deadlock. This
1036 * function should be called before attempting to wait on a locked
1037 * nfs_page. It will complete the I/O if the page index 'index'
1038 * is not contiguous with the existing list of pages in 'desc'.
1040 void nfs_pageio_cond_complete(struct nfs_pageio_descriptor *desc, pgoff_t index)
1042 if (!list_empty(&desc->pg_list)) {
1043 struct nfs_page *prev = nfs_list_entry(desc->pg_list.prev);
1044 if (index != prev->wb_index + 1)
1045 nfs_pageio_complete(desc);
1049 int __init nfs_init_nfspagecache(void)
1051 nfs_page_cachep = kmem_cache_create("nfs_page",
1052 sizeof(struct nfs_page),
1053 0, SLAB_HWCACHE_ALIGN,
1054 NULL);
1055 if (nfs_page_cachep == NULL)
1056 return -ENOMEM;
1058 return 0;
1061 void nfs_destroy_nfspagecache(void)
1063 kmem_cache_destroy(nfs_page_cachep);
1066 static const struct rpc_call_ops nfs_pgio_common_ops = {
1067 .rpc_call_prepare = nfs_pgio_prepare,
1068 .rpc_call_done = nfs_pgio_result,
1069 .rpc_release = nfs_pgio_release,
1072 const struct nfs_pageio_ops nfs_pgio_rw_ops = {
1073 .pg_test = nfs_generic_pg_test,
1074 .pg_doio = nfs_generic_pg_pgios,