6 * Partial copy of Linus' read cache modifications to fs/nfs/file.c
7 * modified for async RPC by okir@monad.swb.de
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>
30 #define NFSDBG_FACILITY NFSDBG_PAGECACHE
32 static const struct nfs_pageio_ops nfs_pageio_read_ops;
33 static const struct rpc_call_ops nfs_read_common_ops;
34 static const struct nfs_pgio_completion_ops nfs_async_read_completion_ops;
36 static struct kmem_cache *nfs_rdata_cachep;
38 struct nfs_read_header *nfs_readhdr_alloc()
40 struct nfs_read_header *rhdr;
42 rhdr = kmem_cache_zalloc(nfs_rdata_cachep, GFP_KERNEL);
44 struct nfs_pgio_header *hdr = &rhdr->header;
46 INIT_LIST_HEAD(&hdr->pages);
47 INIT_LIST_HEAD(&hdr->rpc_list);
48 spin_lock_init(&hdr->lock);
49 atomic_set(&hdr->refcnt, 0);
54 struct nfs_read_data *nfs_readdata_alloc(struct nfs_pgio_header *hdr,
55 unsigned int pagecount)
57 struct nfs_read_data *data, *prealloc;
59 prealloc = &container_of(hdr, struct nfs_read_header, header)->rpc_data;
60 if (prealloc->header == NULL)
63 data = kzalloc(sizeof(*data), GFP_KERNEL);
67 if (nfs_pgarray_set(&data->pages, pagecount)) {
69 atomic_inc(&hdr->refcnt);
79 void nfs_readhdr_free(struct nfs_pgio_header *hdr)
81 struct nfs_read_header *rhdr = container_of(hdr, struct nfs_read_header, header);
83 kmem_cache_free(nfs_rdata_cachep, rhdr);
86 void nfs_readdata_release(struct nfs_read_data *rdata)
88 struct nfs_pgio_header *hdr = rdata->header;
89 struct nfs_read_header *read_header = container_of(hdr, struct nfs_read_header, header);
91 put_nfs_open_context(rdata->args.context);
92 if (rdata->pages.pagevec != rdata->pages.page_array)
93 kfree(rdata->pages.pagevec);
94 if (rdata != &read_header->rpc_data)
98 if (atomic_dec_and_test(&hdr->refcnt))
99 hdr->completion_ops->completion(hdr);
103 int nfs_return_empty_page(struct page *page)
105 zero_user(page, 0, PAGE_CACHE_SIZE);
106 SetPageUptodate(page);
111 void nfs_pageio_init_read_mds(struct nfs_pageio_descriptor *pgio,
113 const struct nfs_pgio_completion_ops *compl_ops)
115 nfs_pageio_init(pgio, inode, &nfs_pageio_read_ops, compl_ops,
116 NFS_SERVER(inode)->rsize, 0);
119 void nfs_pageio_reset_read_mds(struct nfs_pageio_descriptor *pgio)
121 pgio->pg_ops = &nfs_pageio_read_ops;
122 pgio->pg_bsize = NFS_SERVER(pgio->pg_inode)->rsize;
124 EXPORT_SYMBOL_GPL(nfs_pageio_reset_read_mds);
126 static void nfs_pageio_init_read(struct nfs_pageio_descriptor *pgio,
128 const struct nfs_pgio_completion_ops *compl_ops)
130 if (!pnfs_pageio_init_read(pgio, inode, compl_ops))
131 nfs_pageio_init_read_mds(pgio, inode, compl_ops);
134 int nfs_readpage_async(struct nfs_open_context *ctx, struct inode *inode,
137 struct nfs_page *new;
139 struct nfs_pageio_descriptor pgio;
141 len = nfs_page_length(page);
143 return nfs_return_empty_page(page);
144 new = nfs_create_request(ctx, inode, page, 0, len);
149 if (len < PAGE_CACHE_SIZE)
150 zero_user_segment(page, len, PAGE_CACHE_SIZE);
152 nfs_pageio_init_read(&pgio, inode, &nfs_async_read_completion_ops);
153 nfs_pageio_add_request(&pgio, new);
154 nfs_pageio_complete(&pgio);
158 static void nfs_readpage_release(struct nfs_page *req)
160 struct inode *d_inode = req->wb_context->dentry->d_inode;
162 if (PageUptodate(req->wb_page))
163 nfs_readpage_to_fscache(d_inode, req->wb_page, 0);
165 unlock_page(req->wb_page);
167 dprintk("NFS: read done (%s/%Ld %d@%Ld)\n",
168 req->wb_context->dentry->d_inode->i_sb->s_id,
169 (long long)NFS_FILEID(req->wb_context->dentry->d_inode),
171 (long long)req_offset(req));
172 nfs_release_request(req);
175 /* Note io was page aligned */
176 static void nfs_read_completion(struct nfs_pgio_header *hdr)
178 unsigned long bytes = 0;
180 if (test_bit(NFS_IOHDR_REDO, &hdr->flags))
182 if (!test_bit(NFS_IOHDR_ERROR, &hdr->flags)) {
183 while (!list_empty(&hdr->pages)) {
184 struct nfs_page *req = nfs_list_entry(hdr->pages.next);
185 struct page *page = req->wb_page;
187 if (test_bit(NFS_IOHDR_EOF, &hdr->flags)) {
188 if (bytes > hdr->good_bytes)
189 zero_user(page, 0, PAGE_SIZE);
190 else if (hdr->good_bytes - bytes < PAGE_SIZE)
191 zero_user_segment(page,
192 hdr->good_bytes & ~PAGE_MASK,
195 SetPageUptodate(page);
196 nfs_list_remove_request(req);
197 nfs_readpage_release(req);
201 while (!list_empty(&hdr->pages)) {
202 struct nfs_page *req = nfs_list_entry(hdr->pages.next);
204 bytes += req->wb_bytes;
205 if (bytes <= hdr->good_bytes)
206 SetPageUptodate(req->wb_page);
207 nfs_list_remove_request(req);
208 nfs_readpage_release(req);
215 int nfs_initiate_read(struct rpc_clnt *clnt,
216 struct nfs_read_data *data,
217 const struct rpc_call_ops *call_ops)
219 struct inode *inode = data->header->inode;
220 int swap_flags = IS_SWAPFILE(inode) ? NFS_RPC_SWAPFLAGS : 0;
221 struct rpc_task *task;
222 struct rpc_message msg = {
223 .rpc_argp = &data->args,
224 .rpc_resp = &data->res,
225 .rpc_cred = data->header->cred,
227 struct rpc_task_setup task_setup_data = {
231 .callback_ops = call_ops,
232 .callback_data = data,
233 .workqueue = nfsiod_workqueue,
234 .flags = RPC_TASK_ASYNC | swap_flags,
237 /* Set up the initial task struct. */
238 NFS_PROTO(inode)->read_setup(data, &msg);
240 dprintk("NFS: %5u initiated read call (req %s/%lld, %u bytes @ "
244 (long long)NFS_FILEID(inode),
246 (unsigned long long)data->args.offset);
248 task = rpc_run_task(&task_setup_data);
250 return PTR_ERR(task);
254 EXPORT_SYMBOL_GPL(nfs_initiate_read);
257 * Set up the NFS read request struct
259 static void nfs_read_rpcsetup(struct nfs_read_data *data,
260 unsigned int count, unsigned int offset)
262 struct nfs_page *req = data->header->req;
264 data->args.fh = NFS_FH(data->header->inode);
265 data->args.offset = req_offset(req) + offset;
266 data->args.pgbase = req->wb_pgbase + offset;
267 data->args.pages = data->pages.pagevec;
268 data->args.count = count;
269 data->args.context = get_nfs_open_context(req->wb_context);
270 data->args.lock_context = req->wb_lock_context;
272 data->res.fattr = &data->fattr;
273 data->res.count = count;
275 nfs_fattr_init(&data->fattr);
278 static int nfs_do_read(struct nfs_read_data *data,
279 const struct rpc_call_ops *call_ops)
281 struct inode *inode = data->header->inode;
283 return nfs_initiate_read(NFS_CLIENT(inode), data, call_ops);
287 nfs_do_multiple_reads(struct list_head *head,
288 const struct rpc_call_ops *call_ops)
290 struct nfs_read_data *data;
293 while (!list_empty(head)) {
296 data = list_first_entry(head, struct nfs_read_data, list);
297 list_del_init(&data->list);
299 ret2 = nfs_do_read(data, call_ops);
307 nfs_async_read_error(struct list_head *head)
309 struct nfs_page *req;
311 while (!list_empty(head)) {
312 req = nfs_list_entry(head->next);
313 nfs_list_remove_request(req);
314 nfs_readpage_release(req);
318 static const struct nfs_pgio_completion_ops nfs_async_read_completion_ops = {
319 .error_cleanup = nfs_async_read_error,
320 .completion = nfs_read_completion,
324 * Generate multiple requests to fill a single page.
326 * We optimize to reduce the number of read operations on the wire. If we
327 * detect that we're reading a page, or an area of a page, that is past the
328 * end of file, we do not generate NFS read operations but just clear the
329 * parts of the page that would have come back zero from the server anyway.
331 * We rely on the cached value of i_size to make this determination; another
332 * client can fill pages on the server past our cached end-of-file, but we
333 * won't see the new data until our attribute cache is updated. This is more
334 * or less conventional NFS client behavior.
336 static int nfs_pagein_multi(struct nfs_pageio_descriptor *desc,
337 struct nfs_pgio_header *hdr)
339 struct nfs_page *req = hdr->req;
340 struct page *page = req->wb_page;
341 struct nfs_read_data *data;
342 size_t rsize = desc->pg_bsize, nbytes;
347 nfs_list_remove_request(req);
348 nfs_list_add_request(req, &hdr->pages);
351 nbytes = desc->pg_count;
353 size_t len = min(nbytes,rsize);
355 data = nfs_readdata_alloc(hdr, 1);
358 data->pages.pagevec[0] = page;
359 nfs_read_rpcsetup(data, len, offset);
360 list_add(&data->list, &hdr->rpc_list);
364 } while(nbytes != 0);
365 desc->pg_rpc_callops = &nfs_read_common_ops;
368 while (!list_empty(&hdr->rpc_list)) {
369 data = list_first_entry(&hdr->rpc_list, struct nfs_read_data, list);
370 list_del(&data->list);
371 nfs_readdata_release(data);
373 desc->pg_completion_ops->error_cleanup(&hdr->pages);
377 static int nfs_pagein_one(struct nfs_pageio_descriptor *desc,
378 struct nfs_pgio_header *hdr)
380 struct nfs_page *req;
382 struct nfs_read_data *data;
383 struct list_head *head = &desc->pg_list;
386 data = nfs_readdata_alloc(hdr, nfs_page_array_len(desc->pg_base,
389 desc->pg_completion_ops->error_cleanup(head);
394 pages = data->pages.pagevec;
395 while (!list_empty(head)) {
396 req = nfs_list_entry(head->next);
397 nfs_list_remove_request(req);
398 nfs_list_add_request(req, &hdr->pages);
399 *pages++ = req->wb_page;
402 nfs_read_rpcsetup(data, desc->pg_count, 0);
403 list_add(&data->list, &hdr->rpc_list);
404 desc->pg_rpc_callops = &nfs_read_common_ops;
409 int nfs_generic_pagein(struct nfs_pageio_descriptor *desc,
410 struct nfs_pgio_header *hdr)
412 if (desc->pg_bsize < PAGE_CACHE_SIZE)
413 return nfs_pagein_multi(desc, hdr);
414 return nfs_pagein_one(desc, hdr);
417 static int nfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc)
419 struct nfs_read_header *rhdr;
420 struct nfs_pgio_header *hdr;
423 rhdr = nfs_readhdr_alloc();
425 desc->pg_completion_ops->error_cleanup(&desc->pg_list);
429 nfs_pgheader_init(desc, hdr, nfs_readhdr_free);
430 atomic_inc(&hdr->refcnt);
431 ret = nfs_generic_pagein(desc, hdr);
433 ret = nfs_do_multiple_reads(&hdr->rpc_list,
434 desc->pg_rpc_callops);
436 set_bit(NFS_IOHDR_REDO, &hdr->flags);
437 if (atomic_dec_and_test(&hdr->refcnt))
438 hdr->completion_ops->completion(hdr);
442 static const struct nfs_pageio_ops nfs_pageio_read_ops = {
443 .pg_test = nfs_generic_pg_test,
444 .pg_doio = nfs_generic_pg_readpages,
448 * This is the callback from RPC telling us whether a reply was
449 * received or some error occurred (timeout or socket shutdown).
451 int nfs_readpage_result(struct rpc_task *task, struct nfs_read_data *data)
453 struct inode *inode = data->header->inode;
456 dprintk("NFS: %s: %5u, (status %d)\n", __func__, task->tk_pid,
459 status = NFS_PROTO(inode)->read_done(task, data);
463 nfs_add_stats(inode, NFSIOS_SERVERREADBYTES, data->res.count);
465 if (task->tk_status == -ESTALE) {
466 set_bit(NFS_INO_STALE, &NFS_I(inode)->flags);
467 nfs_mark_for_revalidate(inode);
472 static void nfs_readpage_retry(struct rpc_task *task, struct nfs_read_data *data)
474 struct nfs_readargs *argp = &data->args;
475 struct nfs_readres *resp = &data->res;
477 /* This is a short read! */
478 nfs_inc_stats(data->header->inode, NFSIOS_SHORTREAD);
479 /* Has the server at least made some progress? */
480 if (resp->count == 0) {
481 nfs_set_pgio_error(data->header, -EIO, argp->offset);
484 /* Yes, so retry the read at the end of the data */
485 data->mds_offset += resp->count;
486 argp->offset += resp->count;
487 argp->pgbase += resp->count;
488 argp->count -= resp->count;
489 rpc_restart_call_prepare(task);
492 static void nfs_readpage_result_common(struct rpc_task *task, void *calldata)
494 struct nfs_read_data *data = calldata;
495 struct nfs_pgio_header *hdr = data->header;
497 /* Note the only returns of nfs_readpage_result are 0 and -EAGAIN */
498 if (nfs_readpage_result(task, data) != 0)
500 if (task->tk_status < 0)
501 nfs_set_pgio_error(hdr, task->tk_status, data->args.offset);
502 else if (data->res.eof) {
505 bound = data->args.offset + data->res.count;
506 spin_lock(&hdr->lock);
507 if (bound < hdr->io_start + hdr->good_bytes) {
508 set_bit(NFS_IOHDR_EOF, &hdr->flags);
509 clear_bit(NFS_IOHDR_ERROR, &hdr->flags);
510 hdr->good_bytes = bound - hdr->io_start;
512 spin_unlock(&hdr->lock);
513 } else if (data->res.count != data->args.count)
514 nfs_readpage_retry(task, data);
517 static void nfs_readpage_release_common(void *calldata)
519 nfs_readdata_release(calldata);
522 void nfs_read_prepare(struct rpc_task *task, void *calldata)
524 struct nfs_read_data *data = calldata;
525 NFS_PROTO(data->header->inode)->read_rpc_prepare(task, data);
528 static const struct rpc_call_ops nfs_read_common_ops = {
529 .rpc_call_prepare = nfs_read_prepare,
530 .rpc_call_done = nfs_readpage_result_common,
531 .rpc_release = nfs_readpage_release_common,
535 * Read a page over NFS.
536 * We read the page synchronously in the following case:
537 * - The error flag is set for this page. This happens only when a
538 * previous async read operation failed.
540 int nfs_readpage(struct file *file, struct page *page)
542 struct nfs_open_context *ctx;
543 struct inode *inode = page->mapping->host;
546 dprintk("NFS: nfs_readpage (%p %ld@%lu)\n",
547 page, PAGE_CACHE_SIZE, page->index);
548 nfs_inc_stats(inode, NFSIOS_VFSREADPAGE);
549 nfs_add_stats(inode, NFSIOS_READPAGES, 1);
552 * Try to flush any pending writes to the file..
554 * NOTE! Because we own the page lock, there cannot
555 * be any new pending writes generated at this point
556 * for this page (other pages can be written to).
558 error = nfs_wb_page(inode, page);
561 if (PageUptodate(page))
565 if (NFS_STALE(inode))
570 ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
574 ctx = get_nfs_open_context(nfs_file_open_context(file));
576 if (!IS_SYNC(inode)) {
577 error = nfs_readpage_from_fscache(ctx, inode, page);
582 error = nfs_readpage_async(ctx, inode, page);
585 put_nfs_open_context(ctx);
592 struct nfs_readdesc {
593 struct nfs_pageio_descriptor *pgio;
594 struct nfs_open_context *ctx;
598 readpage_async_filler(void *data, struct page *page)
600 struct nfs_readdesc *desc = (struct nfs_readdesc *)data;
601 struct inode *inode = page->mapping->host;
602 struct nfs_page *new;
606 len = nfs_page_length(page);
608 return nfs_return_empty_page(page);
610 new = nfs_create_request(desc->ctx, inode, page, 0, len);
614 if (len < PAGE_CACHE_SIZE)
615 zero_user_segment(page, len, PAGE_CACHE_SIZE);
616 if (!nfs_pageio_add_request(desc->pgio, new)) {
617 error = desc->pgio->pg_error;
622 error = PTR_ERR(new);
628 int nfs_readpages(struct file *filp, struct address_space *mapping,
629 struct list_head *pages, unsigned nr_pages)
631 struct nfs_pageio_descriptor pgio;
632 struct nfs_readdesc desc = {
635 struct inode *inode = mapping->host;
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 nfs_pageio_init_read(&pgio, inode, &nfs_async_read_completion_ops);
665 ret = read_cache_pages(mapping, pages, readpage_async_filler, &desc);
667 nfs_pageio_complete(&pgio);
668 npages = (pgio.pg_bytes_written + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
669 nfs_add_stats(inode, NFSIOS_READPAGES, npages);
671 put_nfs_open_context(desc.ctx);
676 int __init nfs_init_readpagecache(void)
678 nfs_rdata_cachep = kmem_cache_create("nfs_read_data",
679 sizeof(struct nfs_read_header),
680 0, SLAB_HWCACHE_ALIGN,
682 if (nfs_rdata_cachep == NULL)
688 void nfs_destroy_readpagecache(void)
690 kmem_cache_destroy(nfs_rdata_cachep);