6 * Partial copy of Linus' read cache modifications to fs/nfs/file.c
10 #include <linux/time.h>
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/fcntl.h>
14 #include <linux/stat.h>
16 #include <linux/slab.h>
17 #include <linux/pagemap.h>
18 #include <linux/sunrpc/clnt.h>
19 #include <linux/nfs_fs.h>
20 #include <linux/nfs_page.h>
21 #include <linux/module.h>
23 #include <asm/system.h>
31 #define NFSDBG_FACILITY NFSDBG_PAGECACHE
33 static int nfs_pagein_multi(struct nfs_pageio_descriptor *desc);
34 static int nfs_pagein_one(struct nfs_pageio_descriptor *desc);
35 static const struct rpc_call_ops nfs_read_partial_ops;
36 static const struct rpc_call_ops nfs_read_full_ops;
38 static struct kmem_cache *nfs_rdata_cachep;
39 static mempool_t *nfs_rdata_mempool;
41 #define MIN_POOL_READ (32)
43 struct nfs_read_data *nfs_readdata_alloc(unsigned int pagecount)
45 struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, GFP_KERNEL);
48 memset(p, 0, sizeof(*p));
49 INIT_LIST_HEAD(&p->pages);
50 p->npages = pagecount;
51 if (pagecount <= ARRAY_SIZE(p->page_array))
52 p->pagevec = p->page_array;
54 p->pagevec = kcalloc(pagecount, sizeof(struct page *), GFP_KERNEL);
56 mempool_free(p, nfs_rdata_mempool);
64 void nfs_readdata_free(struct nfs_read_data *p)
66 if (p && (p->pagevec != &p->page_array[0]))
68 mempool_free(p, nfs_rdata_mempool);
71 static void nfs_readdata_release(struct nfs_read_data *rdata)
73 put_lseg(rdata->lseg);
74 put_nfs_open_context(rdata->args.context);
75 nfs_readdata_free(rdata);
79 int nfs_return_empty_page(struct page *page)
81 zero_user(page, 0, PAGE_CACHE_SIZE);
82 SetPageUptodate(page);
87 static void nfs_readpage_truncate_uninitialised_page(struct nfs_read_data *data)
89 unsigned int remainder = data->args.count - data->res.count;
90 unsigned int base = data->args.pgbase + data->res.count;
94 if (data->res.eof == 0 || remainder == 0)
97 * Note: "remainder" can never be negative, since we check for
98 * this in the XDR code.
100 pages = &data->args.pages[base >> PAGE_CACHE_SHIFT];
101 base &= ~PAGE_CACHE_MASK;
102 pglen = PAGE_CACHE_SIZE - base;
104 if (remainder <= pglen) {
105 zero_user(*pages, base, remainder);
108 zero_user(*pages, base, pglen);
111 pglen = PAGE_CACHE_SIZE;
116 int nfs_readpage_async(struct nfs_open_context *ctx, struct inode *inode,
119 struct nfs_page *new;
121 struct nfs_pageio_descriptor pgio;
123 len = nfs_page_length(page);
125 return nfs_return_empty_page(page);
126 new = nfs_create_request(ctx, inode, page, 0, len);
131 if (len < PAGE_CACHE_SIZE)
132 zero_user_segment(page, len, PAGE_CACHE_SIZE);
134 nfs_pageio_init(&pgio, inode, NULL, 0, 0);
135 nfs_list_add_request(new, &pgio.pg_list);
138 if (NFS_SERVER(inode)->rsize < PAGE_CACHE_SIZE)
139 nfs_pagein_multi(&pgio);
141 nfs_pagein_one(&pgio);
145 static void nfs_readpage_release(struct nfs_page *req)
147 struct inode *d_inode = req->wb_context->path.dentry->d_inode;
149 if (PageUptodate(req->wb_page))
150 nfs_readpage_to_fscache(d_inode, req->wb_page, 0);
152 unlock_page(req->wb_page);
154 dprintk("NFS: read done (%s/%Ld %d@%Ld)\n",
155 req->wb_context->path.dentry->d_inode->i_sb->s_id,
156 (long long)NFS_FILEID(req->wb_context->path.dentry->d_inode),
158 (long long)req_offset(req));
159 nfs_release_request(req);
162 int nfs_initiate_read(struct nfs_read_data *data, struct rpc_clnt *clnt,
163 const struct rpc_call_ops *call_ops)
165 struct inode *inode = data->inode;
166 int swap_flags = IS_SWAPFILE(inode) ? NFS_RPC_SWAPFLAGS : 0;
167 struct rpc_task *task;
168 struct rpc_message msg = {
169 .rpc_argp = &data->args,
170 .rpc_resp = &data->res,
171 .rpc_cred = data->cred,
173 struct rpc_task_setup task_setup_data = {
177 .callback_ops = call_ops,
178 .callback_data = data,
179 .workqueue = nfsiod_workqueue,
180 .flags = RPC_TASK_ASYNC | swap_flags,
183 /* Set up the initial task struct. */
184 NFS_PROTO(inode)->read_setup(data, &msg);
186 dprintk("NFS: %5u initiated read call (req %s/%lld, %u bytes @ "
190 (long long)NFS_FILEID(inode),
192 (unsigned long long)data->args.offset);
194 task = rpc_run_task(&task_setup_data);
196 return PTR_ERR(task);
200 EXPORT_SYMBOL_GPL(nfs_initiate_read);
203 * Set up the NFS read request struct
205 static int nfs_read_rpcsetup(struct nfs_page *req, struct nfs_read_data *data,
206 const struct rpc_call_ops *call_ops,
207 unsigned int count, unsigned int offset,
208 struct pnfs_layout_segment *lseg)
210 struct inode *inode = req->wb_context->path.dentry->d_inode;
214 data->cred = req->wb_context->cred;
215 data->lseg = get_lseg(lseg);
217 data->args.fh = NFS_FH(inode);
218 data->args.offset = req_offset(req) + offset;
219 data->args.pgbase = req->wb_pgbase + offset;
220 data->args.pages = data->pagevec;
221 data->args.count = count;
222 data->args.context = get_nfs_open_context(req->wb_context);
223 data->args.lock_context = req->wb_lock_context;
225 data->res.fattr = &data->fattr;
226 data->res.count = count;
228 nfs_fattr_init(&data->fattr);
231 (pnfs_try_to_read_data(data, call_ops) == PNFS_ATTEMPTED))
234 return nfs_initiate_read(data, NFS_CLIENT(inode), call_ops);
238 nfs_async_read_error(struct list_head *head)
240 struct nfs_page *req;
242 while (!list_empty(head)) {
243 req = nfs_list_entry(head->next);
244 nfs_list_remove_request(req);
245 SetPageError(req->wb_page);
246 nfs_readpage_release(req);
251 * Generate multiple requests to fill a single page.
253 * We optimize to reduce the number of read operations on the wire. If we
254 * detect that we're reading a page, or an area of a page, that is past the
255 * end of file, we do not generate NFS read operations but just clear the
256 * parts of the page that would have come back zero from the server anyway.
258 * We rely on the cached value of i_size to make this determination; another
259 * client can fill pages on the server past our cached end-of-file, but we
260 * won't see the new data until our attribute cache is updated. This is more
261 * or less conventional NFS client behavior.
263 static int nfs_pagein_multi(struct nfs_pageio_descriptor *desc)
265 struct nfs_page *req = nfs_list_entry(desc->pg_list.next);
266 struct page *page = req->wb_page;
267 struct nfs_read_data *data;
268 size_t rsize = NFS_SERVER(desc->pg_inode)->rsize, nbytes;
272 struct pnfs_layout_segment *lseg;
275 nfs_list_remove_request(req);
277 nbytes = desc->pg_count;
279 size_t len = min(nbytes,rsize);
281 data = nfs_readdata_alloc(1);
284 list_add(&data->pages, &list);
287 } while(nbytes != 0);
288 atomic_set(&req->wb_complete, requests);
290 BUG_ON(desc->pg_lseg != NULL);
291 lseg = pnfs_update_layout(desc->pg_inode, req->wb_context, IOMODE_READ, GFP_KERNEL);
292 ClearPageError(page);
294 nbytes = desc->pg_count;
298 data = list_entry(list.next, struct nfs_read_data, pages);
299 list_del_init(&data->pages);
301 data->pagevec[0] = page;
305 ret2 = nfs_read_rpcsetup(req, data, &nfs_read_partial_ops,
306 rsize, offset, lseg);
311 } while (nbytes != 0);
313 desc->pg_lseg = NULL;
318 while (!list_empty(&list)) {
319 data = list_entry(list.next, struct nfs_read_data, pages);
320 list_del(&data->pages);
321 nfs_readdata_free(data);
324 nfs_readpage_release(req);
328 static int nfs_pagein_one(struct nfs_pageio_descriptor *desc)
330 struct nfs_page *req;
332 struct nfs_read_data *data;
333 struct list_head *head = &desc->pg_list;
334 struct pnfs_layout_segment *lseg = desc->pg_lseg;
337 data = nfs_readdata_alloc(nfs_page_array_len(desc->pg_base,
340 nfs_async_read_error(head);
344 pages = data->pagevec;
345 while (!list_empty(head)) {
346 req = nfs_list_entry(head->next);
347 nfs_list_remove_request(req);
348 nfs_list_add_request(req, &data->pages);
349 ClearPageError(req->wb_page);
350 *pages++ = req->wb_page;
352 req = nfs_list_entry(data->pages.next);
353 if ((!lseg) && list_is_singular(&data->pages))
354 lseg = pnfs_update_layout(desc->pg_inode, req->wb_context, IOMODE_READ, GFP_KERNEL);
356 ret = nfs_read_rpcsetup(req, data, &nfs_read_full_ops, desc->pg_count,
360 desc->pg_lseg = NULL;
365 * This is the callback from RPC telling us whether a reply was
366 * received or some error occurred (timeout or socket shutdown).
368 int nfs_readpage_result(struct rpc_task *task, struct nfs_read_data *data)
372 dprintk("NFS: %s: %5u, (status %d)\n", __func__, task->tk_pid,
375 status = NFS_PROTO(data->inode)->read_done(task, data);
379 nfs_add_stats(data->inode, NFSIOS_SERVERREADBYTES, data->res.count);
381 if (task->tk_status == -ESTALE) {
382 set_bit(NFS_INO_STALE, &NFS_I(data->inode)->flags);
383 nfs_mark_for_revalidate(data->inode);
388 static void nfs_readpage_retry(struct rpc_task *task, struct nfs_read_data *data)
390 struct nfs_readargs *argp = &data->args;
391 struct nfs_readres *resp = &data->res;
393 if (resp->eof || resp->count == argp->count)
396 /* This is a short read! */
397 nfs_inc_stats(data->inode, NFSIOS_SHORTREAD);
398 /* Has the server at least made some progress? */
399 if (resp->count == 0)
402 /* Yes, so retry the read at the end of the data */
403 data->mds_offset += resp->count;
404 argp->offset += resp->count;
405 argp->pgbase += resp->count;
406 argp->count -= resp->count;
407 nfs_restart_rpc(task, NFS_SERVER(data->inode)->nfs_client);
411 * Handle a read reply that fills part of a page.
413 static void nfs_readpage_result_partial(struct rpc_task *task, void *calldata)
415 struct nfs_read_data *data = calldata;
417 if (nfs_readpage_result(task, data) != 0)
419 if (task->tk_status < 0)
422 nfs_readpage_truncate_uninitialised_page(data);
423 nfs_readpage_retry(task, data);
426 static void nfs_readpage_release_partial(void *calldata)
428 struct nfs_read_data *data = calldata;
429 struct nfs_page *req = data->req;
430 struct page *page = req->wb_page;
431 int status = data->task.tk_status;
436 if (atomic_dec_and_test(&req->wb_complete)) {
437 if (!PageError(page))
438 SetPageUptodate(page);
439 nfs_readpage_release(req);
441 nfs_readdata_release(calldata);
444 #if defined(CONFIG_NFS_V4_1)
445 void nfs_read_prepare(struct rpc_task *task, void *calldata)
447 struct nfs_read_data *data = calldata;
449 if (nfs4_setup_sequence(NFS_SERVER(data->inode),
450 &data->args.seq_args, &data->res.seq_res,
453 rpc_call_start(task);
455 #endif /* CONFIG_NFS_V4_1 */
457 static const struct rpc_call_ops nfs_read_partial_ops = {
458 #if defined(CONFIG_NFS_V4_1)
459 .rpc_call_prepare = nfs_read_prepare,
460 #endif /* CONFIG_NFS_V4_1 */
461 .rpc_call_done = nfs_readpage_result_partial,
462 .rpc_release = nfs_readpage_release_partial,
465 static void nfs_readpage_set_pages_uptodate(struct nfs_read_data *data)
467 unsigned int count = data->res.count;
468 unsigned int base = data->args.pgbase;
472 count = data->args.count;
473 if (unlikely(count == 0))
475 pages = &data->args.pages[base >> PAGE_CACHE_SHIFT];
476 base &= ~PAGE_CACHE_MASK;
478 for (;count >= PAGE_CACHE_SIZE; count -= PAGE_CACHE_SIZE, pages++)
479 SetPageUptodate(*pages);
482 /* Was this a short read? */
483 if (data->res.eof || data->res.count == data->args.count)
484 SetPageUptodate(*pages);
488 * This is the callback from RPC telling us whether a reply was
489 * received or some error occurred (timeout or socket shutdown).
491 static void nfs_readpage_result_full(struct rpc_task *task, void *calldata)
493 struct nfs_read_data *data = calldata;
495 if (nfs_readpage_result(task, data) != 0)
497 if (task->tk_status < 0)
500 * Note: nfs_readpage_retry may change the values of
501 * data->args. In the multi-page case, we therefore need
502 * to ensure that we call nfs_readpage_set_pages_uptodate()
505 nfs_readpage_truncate_uninitialised_page(data);
506 nfs_readpage_set_pages_uptodate(data);
507 nfs_readpage_retry(task, data);
510 static void nfs_readpage_release_full(void *calldata)
512 struct nfs_read_data *data = calldata;
514 while (!list_empty(&data->pages)) {
515 struct nfs_page *req = nfs_list_entry(data->pages.next);
517 nfs_list_remove_request(req);
518 nfs_readpage_release(req);
520 nfs_readdata_release(calldata);
523 static const struct rpc_call_ops nfs_read_full_ops = {
524 #if defined(CONFIG_NFS_V4_1)
525 .rpc_call_prepare = nfs_read_prepare,
526 #endif /* CONFIG_NFS_V4_1 */
527 .rpc_call_done = nfs_readpage_result_full,
528 .rpc_release = nfs_readpage_release_full,
532 * Read a page over NFS.
533 * We read the page synchronously in the following case:
534 * - The error flag is set for this page. This happens only when a
535 * previous async read operation failed.
537 int nfs_readpage(struct file *file, struct page *page)
539 struct nfs_open_context *ctx;
540 struct inode *inode = page->mapping->host;
543 dprintk("NFS: nfs_readpage (%p %ld@%lu)\n",
544 page, PAGE_CACHE_SIZE, page->index);
545 nfs_inc_stats(inode, NFSIOS_VFSREADPAGE);
546 nfs_add_stats(inode, NFSIOS_READPAGES, 1);
549 * Try to flush any pending writes to the file..
551 * NOTE! Because we own the page lock, there cannot
552 * be any new pending writes generated at this point
553 * for this page (other pages can be written to).
555 error = nfs_wb_page(inode, page);
558 if (PageUptodate(page))
562 if (NFS_STALE(inode))
567 ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
571 ctx = get_nfs_open_context(nfs_file_open_context(file));
573 if (!IS_SYNC(inode)) {
574 error = nfs_readpage_from_fscache(ctx, inode, page);
579 error = nfs_readpage_async(ctx, inode, page);
582 put_nfs_open_context(ctx);
589 struct nfs_readdesc {
590 struct nfs_pageio_descriptor *pgio;
591 struct nfs_open_context *ctx;
595 readpage_async_filler(void *data, struct page *page)
597 struct nfs_readdesc *desc = (struct nfs_readdesc *)data;
598 struct inode *inode = page->mapping->host;
599 struct nfs_page *new;
603 len = nfs_page_length(page);
605 return nfs_return_empty_page(page);
607 new = nfs_create_request(desc->ctx, inode, page, 0, len);
611 if (len < PAGE_CACHE_SIZE)
612 zero_user_segment(page, len, PAGE_CACHE_SIZE);
613 if (!nfs_pageio_add_request(desc->pgio, new)) {
614 error = desc->pgio->pg_error;
619 error = PTR_ERR(new);
626 int nfs_readpages(struct file *filp, struct address_space *mapping,
627 struct list_head *pages, unsigned nr_pages)
629 struct nfs_pageio_descriptor pgio;
630 struct nfs_readdesc desc = {
633 struct inode *inode = mapping->host;
634 struct nfs_server *server = NFS_SERVER(inode);
635 size_t rsize = server->rsize;
636 unsigned long npages;
639 dprintk("NFS: nfs_readpages (%s/%Ld %d)\n",
641 (long long)NFS_FILEID(inode),
643 nfs_inc_stats(inode, NFSIOS_VFSREADPAGES);
645 if (NFS_STALE(inode))
649 desc.ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
650 if (desc.ctx == NULL)
653 desc.ctx = get_nfs_open_context(nfs_file_open_context(filp));
655 /* attempt to read as many of the pages as possible from the cache
656 * - this returns -ENOBUFS immediately if the cookie is negative
658 ret = nfs_readpages_from_fscache(desc.ctx, inode, mapping,
661 goto read_complete; /* all pages were read */
663 pnfs_pageio_init_read(&pgio, inode);
664 if (rsize < PAGE_CACHE_SIZE)
665 nfs_pageio_init(&pgio, inode, nfs_pagein_multi, rsize, 0);
667 nfs_pageio_init(&pgio, inode, nfs_pagein_one, rsize, 0);
669 ret = read_cache_pages(mapping, pages, readpage_async_filler, &desc);
671 nfs_pageio_complete(&pgio);
672 npages = (pgio.pg_bytes_written + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
673 nfs_add_stats(inode, NFSIOS_READPAGES, npages);
675 put_nfs_open_context(desc.ctx);
680 int __init nfs_init_readpagecache(void)
682 nfs_rdata_cachep = kmem_cache_create("nfs_read_data",
683 sizeof(struct nfs_read_data),
684 0, SLAB_HWCACHE_ALIGN,
686 if (nfs_rdata_cachep == NULL)
689 nfs_rdata_mempool = mempool_create_slab_pool(MIN_POOL_READ,
691 if (nfs_rdata_mempool == NULL)
697 void nfs_destroy_readpagecache(void)
699 mempool_destroy(nfs_rdata_mempool);
700 kmem_cache_destroy(nfs_rdata_cachep);