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>
22 #include <asm/system.h>
30 #define NFSDBG_FACILITY NFSDBG_PAGECACHE
32 static int nfs_pagein_multi(struct inode
*, struct list_head
*, unsigned int, size_t, int);
33 static int nfs_pagein_one(struct inode
*, struct list_head
*, unsigned int, size_t, int);
34 static const struct rpc_call_ops nfs_read_partial_ops
;
35 static const struct rpc_call_ops nfs_read_full_ops
;
37 static struct kmem_cache
*nfs_rdata_cachep
;
38 static mempool_t
*nfs_rdata_mempool
;
40 #define MIN_POOL_READ (32)
42 struct nfs_read_data
*nfs_readdata_alloc(unsigned int pagecount
)
44 struct nfs_read_data
*p
= mempool_alloc(nfs_rdata_mempool
, GFP_KERNEL
);
47 memset(p
, 0, sizeof(*p
));
48 INIT_LIST_HEAD(&p
->pages
);
49 p
->npages
= pagecount
;
50 if (pagecount
<= ARRAY_SIZE(p
->page_array
))
51 p
->pagevec
= p
->page_array
;
53 p
->pagevec
= kcalloc(pagecount
, sizeof(struct page
*), GFP_KERNEL
);
55 mempool_free(p
, nfs_rdata_mempool
);
63 void nfs_readdata_free(struct nfs_read_data
*p
)
65 if (p
&& (p
->pagevec
!= &p
->page_array
[0]))
67 mempool_free(p
, nfs_rdata_mempool
);
70 static void nfs_readdata_release(struct nfs_read_data
*rdata
)
72 put_nfs_open_context(rdata
->args
.context
);
73 nfs_readdata_free(rdata
);
77 int nfs_return_empty_page(struct page
*page
)
79 zero_user(page
, 0, PAGE_CACHE_SIZE
);
80 SetPageUptodate(page
);
85 static void nfs_readpage_truncate_uninitialised_page(struct nfs_read_data
*data
)
87 unsigned int remainder
= data
->args
.count
- data
->res
.count
;
88 unsigned int base
= data
->args
.pgbase
+ data
->res
.count
;
92 if (data
->res
.eof
== 0 || remainder
== 0)
95 * Note: "remainder" can never be negative, since we check for
96 * this in the XDR code.
98 pages
= &data
->args
.pages
[base
>> PAGE_CACHE_SHIFT
];
99 base
&= ~PAGE_CACHE_MASK
;
100 pglen
= PAGE_CACHE_SIZE
- base
;
102 if (remainder
<= pglen
) {
103 zero_user(*pages
, base
, remainder
);
106 zero_user(*pages
, base
, pglen
);
109 pglen
= PAGE_CACHE_SIZE
;
114 int nfs_readpage_async(struct nfs_open_context
*ctx
, struct inode
*inode
,
117 LIST_HEAD(one_request
);
118 struct nfs_page
*new;
121 len
= nfs_page_length(page
);
123 return nfs_return_empty_page(page
);
124 pnfs_update_layout(inode
, ctx
, IOMODE_READ
);
125 new = nfs_create_request(ctx
, inode
, page
, 0, len
);
130 if (len
< PAGE_CACHE_SIZE
)
131 zero_user_segment(page
, len
, PAGE_CACHE_SIZE
);
133 nfs_list_add_request(new, &one_request
);
134 if (NFS_SERVER(inode
)->rsize
< PAGE_CACHE_SIZE
)
135 nfs_pagein_multi(inode
, &one_request
, 1, len
, 0);
137 nfs_pagein_one(inode
, &one_request
, 1, len
, 0);
141 static void nfs_readpage_release(struct nfs_page
*req
)
143 struct inode
*d_inode
= req
->wb_context
->path
.dentry
->d_inode
;
145 if (PageUptodate(req
->wb_page
))
146 nfs_readpage_to_fscache(d_inode
, req
->wb_page
, 0);
148 unlock_page(req
->wb_page
);
150 dprintk("NFS: read done (%s/%Ld %d@%Ld)\n",
151 req
->wb_context
->path
.dentry
->d_inode
->i_sb
->s_id
,
152 (long long)NFS_FILEID(req
->wb_context
->path
.dentry
->d_inode
),
154 (long long)req_offset(req
));
155 nfs_release_request(req
);
159 * Set up the NFS read request struct
161 static int nfs_read_rpcsetup(struct nfs_page
*req
, struct nfs_read_data
*data
,
162 const struct rpc_call_ops
*call_ops
,
163 unsigned int count
, unsigned int offset
)
165 struct inode
*inode
= req
->wb_context
->path
.dentry
->d_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
= req
->wb_context
->cred
,
173 struct rpc_task_setup task_setup_data
= {
175 .rpc_client
= NFS_CLIENT(inode
),
177 .callback_ops
= call_ops
,
178 .callback_data
= data
,
179 .workqueue
= nfsiod_workqueue
,
180 .flags
= RPC_TASK_ASYNC
| swap_flags
,
185 data
->cred
= msg
.rpc_cred
;
187 data
->args
.fh
= NFS_FH(inode
);
188 data
->args
.offset
= req_offset(req
) + offset
;
189 data
->args
.pgbase
= req
->wb_pgbase
+ offset
;
190 data
->args
.pages
= data
->pagevec
;
191 data
->args
.count
= count
;
192 data
->args
.context
= get_nfs_open_context(req
->wb_context
);
193 data
->args
.lock_context
= req
->wb_lock_context
;
195 data
->res
.fattr
= &data
->fattr
;
196 data
->res
.count
= count
;
198 nfs_fattr_init(&data
->fattr
);
200 /* Set up the initial task struct. */
201 NFS_PROTO(inode
)->read_setup(data
, &msg
);
203 dprintk("NFS: %5u initiated read call (req %s/%Ld, %u bytes @ offset %Lu)\n",
206 (long long)NFS_FILEID(inode
),
208 (unsigned long long)data
->args
.offset
);
210 task
= rpc_run_task(&task_setup_data
);
212 return PTR_ERR(task
);
218 nfs_async_read_error(struct list_head
*head
)
220 struct nfs_page
*req
;
222 while (!list_empty(head
)) {
223 req
= nfs_list_entry(head
->next
);
224 nfs_list_remove_request(req
);
225 SetPageError(req
->wb_page
);
226 nfs_readpage_release(req
);
231 * Generate multiple requests to fill a single page.
233 * We optimize to reduce the number of read operations on the wire. If we
234 * detect that we're reading a page, or an area of a page, that is past the
235 * end of file, we do not generate NFS read operations but just clear the
236 * parts of the page that would have come back zero from the server anyway.
238 * We rely on the cached value of i_size to make this determination; another
239 * client can fill pages on the server past our cached end-of-file, but we
240 * won't see the new data until our attribute cache is updated. This is more
241 * or less conventional NFS client behavior.
243 static int nfs_pagein_multi(struct inode
*inode
, struct list_head
*head
, unsigned int npages
, size_t count
, int flags
)
245 struct nfs_page
*req
= nfs_list_entry(head
->next
);
246 struct page
*page
= req
->wb_page
;
247 struct nfs_read_data
*data
;
248 size_t rsize
= NFS_SERVER(inode
)->rsize
, nbytes
;
254 nfs_list_remove_request(req
);
258 size_t len
= min(nbytes
,rsize
);
260 data
= nfs_readdata_alloc(1);
263 list_add(&data
->pages
, &list
);
266 } while(nbytes
!= 0);
267 atomic_set(&req
->wb_complete
, requests
);
269 ClearPageError(page
);
275 data
= list_entry(list
.next
, struct nfs_read_data
, pages
);
276 list_del_init(&data
->pages
);
278 data
->pagevec
[0] = page
;
282 ret2
= nfs_read_rpcsetup(req
, data
, &nfs_read_partial_ops
,
288 } while (nbytes
!= 0);
293 while (!list_empty(&list
)) {
294 data
= list_entry(list
.next
, struct nfs_read_data
, pages
);
295 list_del(&data
->pages
);
296 nfs_readdata_free(data
);
299 nfs_readpage_release(req
);
303 static int nfs_pagein_one(struct inode
*inode
, struct list_head
*head
, unsigned int npages
, size_t count
, int flags
)
305 struct nfs_page
*req
;
307 struct nfs_read_data
*data
;
310 data
= nfs_readdata_alloc(npages
);
314 pages
= data
->pagevec
;
315 while (!list_empty(head
)) {
316 req
= nfs_list_entry(head
->next
);
317 nfs_list_remove_request(req
);
318 nfs_list_add_request(req
, &data
->pages
);
319 ClearPageError(req
->wb_page
);
320 *pages
++ = req
->wb_page
;
322 req
= nfs_list_entry(data
->pages
.next
);
324 return nfs_read_rpcsetup(req
, data
, &nfs_read_full_ops
, count
, 0);
326 nfs_async_read_error(head
);
331 * This is the callback from RPC telling us whether a reply was
332 * received or some error occurred (timeout or socket shutdown).
334 int nfs_readpage_result(struct rpc_task
*task
, struct nfs_read_data
*data
)
338 dprintk("NFS: %s: %5u, (status %d)\n", __func__
, task
->tk_pid
,
341 status
= NFS_PROTO(data
->inode
)->read_done(task
, data
);
345 nfs_add_stats(data
->inode
, NFSIOS_SERVERREADBYTES
, data
->res
.count
);
347 if (task
->tk_status
== -ESTALE
) {
348 set_bit(NFS_INO_STALE
, &NFS_I(data
->inode
)->flags
);
349 nfs_mark_for_revalidate(data
->inode
);
354 static void nfs_readpage_retry(struct rpc_task
*task
, struct nfs_read_data
*data
)
356 struct nfs_readargs
*argp
= &data
->args
;
357 struct nfs_readres
*resp
= &data
->res
;
359 if (resp
->eof
|| resp
->count
== argp
->count
)
362 /* This is a short read! */
363 nfs_inc_stats(data
->inode
, NFSIOS_SHORTREAD
);
364 /* Has the server at least made some progress? */
365 if (resp
->count
== 0)
368 /* Yes, so retry the read at the end of the data */
369 argp
->offset
+= resp
->count
;
370 argp
->pgbase
+= resp
->count
;
371 argp
->count
-= resp
->count
;
372 nfs_restart_rpc(task
, NFS_SERVER(data
->inode
)->nfs_client
);
376 * Handle a read reply that fills part of a page.
378 static void nfs_readpage_result_partial(struct rpc_task
*task
, void *calldata
)
380 struct nfs_read_data
*data
= calldata
;
382 if (nfs_readpage_result(task
, data
) != 0)
384 if (task
->tk_status
< 0)
387 nfs_readpage_truncate_uninitialised_page(data
);
388 nfs_readpage_retry(task
, data
);
391 static void nfs_readpage_release_partial(void *calldata
)
393 struct nfs_read_data
*data
= calldata
;
394 struct nfs_page
*req
= data
->req
;
395 struct page
*page
= req
->wb_page
;
396 int status
= data
->task
.tk_status
;
401 if (atomic_dec_and_test(&req
->wb_complete
)) {
402 if (!PageError(page
))
403 SetPageUptodate(page
);
404 nfs_readpage_release(req
);
406 nfs_readdata_release(calldata
);
409 #if defined(CONFIG_NFS_V4_1)
410 void nfs_read_prepare(struct rpc_task
*task
, void *calldata
)
412 struct nfs_read_data
*data
= calldata
;
414 if (nfs4_setup_sequence(NFS_SERVER(data
->inode
),
415 &data
->args
.seq_args
, &data
->res
.seq_res
,
418 rpc_call_start(task
);
420 #endif /* CONFIG_NFS_V4_1 */
422 static const struct rpc_call_ops nfs_read_partial_ops
= {
423 #if defined(CONFIG_NFS_V4_1)
424 .rpc_call_prepare
= nfs_read_prepare
,
425 #endif /* CONFIG_NFS_V4_1 */
426 .rpc_call_done
= nfs_readpage_result_partial
,
427 .rpc_release
= nfs_readpage_release_partial
,
430 static void nfs_readpage_set_pages_uptodate(struct nfs_read_data
*data
)
432 unsigned int count
= data
->res
.count
;
433 unsigned int base
= data
->args
.pgbase
;
437 count
= data
->args
.count
;
438 if (unlikely(count
== 0))
440 pages
= &data
->args
.pages
[base
>> PAGE_CACHE_SHIFT
];
441 base
&= ~PAGE_CACHE_MASK
;
443 for (;count
>= PAGE_CACHE_SIZE
; count
-= PAGE_CACHE_SIZE
, pages
++)
444 SetPageUptodate(*pages
);
447 /* Was this a short read? */
448 if (data
->res
.eof
|| data
->res
.count
== data
->args
.count
)
449 SetPageUptodate(*pages
);
453 * This is the callback from RPC telling us whether a reply was
454 * received or some error occurred (timeout or socket shutdown).
456 static void nfs_readpage_result_full(struct rpc_task
*task
, void *calldata
)
458 struct nfs_read_data
*data
= calldata
;
460 if (nfs_readpage_result(task
, data
) != 0)
462 if (task
->tk_status
< 0)
465 * Note: nfs_readpage_retry may change the values of
466 * data->args. In the multi-page case, we therefore need
467 * to ensure that we call nfs_readpage_set_pages_uptodate()
470 nfs_readpage_truncate_uninitialised_page(data
);
471 nfs_readpage_set_pages_uptodate(data
);
472 nfs_readpage_retry(task
, data
);
475 static void nfs_readpage_release_full(void *calldata
)
477 struct nfs_read_data
*data
= calldata
;
479 while (!list_empty(&data
->pages
)) {
480 struct nfs_page
*req
= nfs_list_entry(data
->pages
.next
);
482 nfs_list_remove_request(req
);
483 nfs_readpage_release(req
);
485 nfs_readdata_release(calldata
);
488 static const struct rpc_call_ops nfs_read_full_ops
= {
489 #if defined(CONFIG_NFS_V4_1)
490 .rpc_call_prepare
= nfs_read_prepare
,
491 #endif /* CONFIG_NFS_V4_1 */
492 .rpc_call_done
= nfs_readpage_result_full
,
493 .rpc_release
= nfs_readpage_release_full
,
497 * Read a page over NFS.
498 * We read the page synchronously in the following case:
499 * - The error flag is set for this page. This happens only when a
500 * previous async read operation failed.
502 int nfs_readpage(struct file
*file
, struct page
*page
)
504 struct nfs_open_context
*ctx
;
505 struct inode
*inode
= page
->mapping
->host
;
508 dprintk("NFS: nfs_readpage (%p %ld@%lu)\n",
509 page
, PAGE_CACHE_SIZE
, page
->index
);
510 nfs_inc_stats(inode
, NFSIOS_VFSREADPAGE
);
511 nfs_add_stats(inode
, NFSIOS_READPAGES
, 1);
514 * Try to flush any pending writes to the file..
516 * NOTE! Because we own the page lock, there cannot
517 * be any new pending writes generated at this point
518 * for this page (other pages can be written to).
520 error
= nfs_wb_page(inode
, page
);
523 if (PageUptodate(page
))
527 if (NFS_STALE(inode
))
532 ctx
= nfs_find_open_context(inode
, NULL
, FMODE_READ
);
536 ctx
= get_nfs_open_context(nfs_file_open_context(file
));
538 if (!IS_SYNC(inode
)) {
539 error
= nfs_readpage_from_fscache(ctx
, inode
, page
);
544 error
= nfs_readpage_async(ctx
, inode
, page
);
547 put_nfs_open_context(ctx
);
554 struct nfs_readdesc
{
555 struct nfs_pageio_descriptor
*pgio
;
556 struct nfs_open_context
*ctx
;
560 readpage_async_filler(void *data
, struct page
*page
)
562 struct nfs_readdesc
*desc
= (struct nfs_readdesc
*)data
;
563 struct inode
*inode
= page
->mapping
->host
;
564 struct nfs_page
*new;
568 len
= nfs_page_length(page
);
570 return nfs_return_empty_page(page
);
572 new = nfs_create_request(desc
->ctx
, inode
, page
, 0, len
);
576 if (len
< PAGE_CACHE_SIZE
)
577 zero_user_segment(page
, len
, PAGE_CACHE_SIZE
);
578 if (!nfs_pageio_add_request(desc
->pgio
, new)) {
579 error
= desc
->pgio
->pg_error
;
584 error
= PTR_ERR(new);
591 int nfs_readpages(struct file
*filp
, struct address_space
*mapping
,
592 struct list_head
*pages
, unsigned nr_pages
)
594 struct nfs_pageio_descriptor pgio
;
595 struct nfs_readdesc desc
= {
598 struct inode
*inode
= mapping
->host
;
599 struct nfs_server
*server
= NFS_SERVER(inode
);
600 size_t rsize
= server
->rsize
;
601 unsigned long npages
;
604 dprintk("NFS: nfs_readpages (%s/%Ld %d)\n",
606 (long long)NFS_FILEID(inode
),
608 nfs_inc_stats(inode
, NFSIOS_VFSREADPAGES
);
610 if (NFS_STALE(inode
))
614 desc
.ctx
= nfs_find_open_context(inode
, NULL
, FMODE_READ
);
615 if (desc
.ctx
== NULL
)
618 desc
.ctx
= get_nfs_open_context(nfs_file_open_context(filp
));
620 /* attempt to read as many of the pages as possible from the cache
621 * - this returns -ENOBUFS immediately if the cookie is negative
623 ret
= nfs_readpages_from_fscache(desc
.ctx
, inode
, mapping
,
626 goto read_complete
; /* all pages were read */
628 pnfs_update_layout(inode
, desc
.ctx
, IOMODE_READ
);
629 if (rsize
< PAGE_CACHE_SIZE
)
630 nfs_pageio_init(&pgio
, inode
, nfs_pagein_multi
, rsize
, 0);
632 nfs_pageio_init(&pgio
, inode
, nfs_pagein_one
, rsize
, 0);
634 ret
= read_cache_pages(mapping
, pages
, readpage_async_filler
, &desc
);
636 nfs_pageio_complete(&pgio
);
637 npages
= (pgio
.pg_bytes_written
+ PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
638 nfs_add_stats(inode
, NFSIOS_READPAGES
, npages
);
640 put_nfs_open_context(desc
.ctx
);
645 int __init
nfs_init_readpagecache(void)
647 nfs_rdata_cachep
= kmem_cache_create("nfs_read_data",
648 sizeof(struct nfs_read_data
),
649 0, SLAB_HWCACHE_ALIGN
,
651 if (nfs_rdata_cachep
== NULL
)
654 nfs_rdata_mempool
= mempool_create_slab_pool(MIN_POOL_READ
,
656 if (nfs_rdata_mempool
== NULL
)
662 void nfs_destroy_readpagecache(void)
664 mempool_destroy(nfs_rdata_mempool
);
665 kmem_cache_destroy(nfs_rdata_cachep
);