NFS: Ensure that the asynchronous RPC calls complete on nfsiod.
[linux-2.6.git] / fs / nfs / read.c
1 /*
2  * linux/fs/nfs/read.c
3  *
4  * Block I/O for NFS
5  *
6  * Partial copy of Linus' read cache modifications to fs/nfs/file.c
7  * modified for async RPC by okir@monad.swb.de
8  */
9
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>
15 #include <linux/mm.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/smp_lock.h>
22
23 #include <asm/system.h>
24
25 #include "internal.h"
26 #include "iostat.h"
27
28 #define NFSDBG_FACILITY         NFSDBG_PAGECACHE
29
30 static int nfs_pagein_multi(struct inode *, struct list_head *, unsigned int, size_t, int);
31 static int nfs_pagein_one(struct inode *, struct list_head *, unsigned int, size_t, int);
32 static const struct rpc_call_ops nfs_read_partial_ops;
33 static const struct rpc_call_ops nfs_read_full_ops;
34
35 static struct kmem_cache *nfs_rdata_cachep;
36 static mempool_t *nfs_rdata_mempool;
37
38 #define MIN_POOL_READ   (32)
39
40 struct nfs_read_data *nfs_readdata_alloc(unsigned int pagecount)
41 {
42         struct nfs_read_data *p = mempool_alloc(nfs_rdata_mempool, GFP_NOFS);
43
44         if (p) {
45                 memset(p, 0, sizeof(*p));
46                 INIT_LIST_HEAD(&p->pages);
47                 p->npages = pagecount;
48                 if (pagecount <= ARRAY_SIZE(p->page_array))
49                         p->pagevec = p->page_array;
50                 else {
51                         p->pagevec = kcalloc(pagecount, sizeof(struct page *), GFP_NOFS);
52                         if (!p->pagevec) {
53                                 mempool_free(p, nfs_rdata_mempool);
54                                 p = NULL;
55                         }
56                 }
57         }
58         return p;
59 }
60
61 static void nfs_readdata_rcu_free(struct rcu_head *head)
62 {
63         struct nfs_read_data *p = container_of(head, struct nfs_read_data, task.u.tk_rcu);
64         if (p && (p->pagevec != &p->page_array[0]))
65                 kfree(p->pagevec);
66         mempool_free(p, nfs_rdata_mempool);
67 }
68
69 static void nfs_readdata_free(struct nfs_read_data *rdata)
70 {
71         call_rcu_bh(&rdata->task.u.tk_rcu, nfs_readdata_rcu_free);
72 }
73
74 void nfs_readdata_release(void *data)
75 {
76         struct nfs_read_data *rdata = data;
77
78         put_nfs_open_context(rdata->args.context);
79         nfs_readdata_free(rdata);
80 }
81
82 static
83 int nfs_return_empty_page(struct page *page)
84 {
85         zero_user(page, 0, PAGE_CACHE_SIZE);
86         SetPageUptodate(page);
87         unlock_page(page);
88         return 0;
89 }
90
91 static void nfs_readpage_truncate_uninitialised_page(struct nfs_read_data *data)
92 {
93         unsigned int remainder = data->args.count - data->res.count;
94         unsigned int base = data->args.pgbase + data->res.count;
95         unsigned int pglen;
96         struct page **pages;
97
98         if (data->res.eof == 0 || remainder == 0)
99                 return;
100         /*
101          * Note: "remainder" can never be negative, since we check for
102          *      this in the XDR code.
103          */
104         pages = &data->args.pages[base >> PAGE_CACHE_SHIFT];
105         base &= ~PAGE_CACHE_MASK;
106         pglen = PAGE_CACHE_SIZE - base;
107         for (;;) {
108                 if (remainder <= pglen) {
109                         zero_user(*pages, base, remainder);
110                         break;
111                 }
112                 zero_user(*pages, base, pglen);
113                 pages++;
114                 remainder -= pglen;
115                 pglen = PAGE_CACHE_SIZE;
116                 base = 0;
117         }
118 }
119
120 static int nfs_readpage_async(struct nfs_open_context *ctx, struct inode *inode,
121                 struct page *page)
122 {
123         LIST_HEAD(one_request);
124         struct nfs_page *new;
125         unsigned int len;
126
127         len = nfs_page_length(page);
128         if (len == 0)
129                 return nfs_return_empty_page(page);
130         new = nfs_create_request(ctx, inode, page, 0, len);
131         if (IS_ERR(new)) {
132                 unlock_page(page);
133                 return PTR_ERR(new);
134         }
135         if (len < PAGE_CACHE_SIZE)
136                 zero_user_segment(page, len, PAGE_CACHE_SIZE);
137
138         nfs_list_add_request(new, &one_request);
139         if (NFS_SERVER(inode)->rsize < PAGE_CACHE_SIZE)
140                 nfs_pagein_multi(inode, &one_request, 1, len, 0);
141         else
142                 nfs_pagein_one(inode, &one_request, 1, len, 0);
143         return 0;
144 }
145
146 static void nfs_readpage_release(struct nfs_page *req)
147 {
148         unlock_page(req->wb_page);
149
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),
153                         req->wb_bytes,
154                         (long long)req_offset(req));
155         nfs_clear_request(req);
156         nfs_release_request(req);
157 }
158
159 /*
160  * Set up the NFS read request struct
161  */
162 static void nfs_read_rpcsetup(struct nfs_page *req, struct nfs_read_data *data,
163                 const struct rpc_call_ops *call_ops,
164                 unsigned int count, unsigned int offset)
165 {
166         struct inode *inode = req->wb_context->path.dentry->d_inode;
167         int swap_flags = IS_SWAPFILE(inode) ? NFS_RPC_SWAPFLAGS : 0;
168         struct rpc_task *task;
169         struct rpc_message msg = {
170                 .rpc_argp = &data->args,
171                 .rpc_resp = &data->res,
172                 .rpc_cred = req->wb_context->cred,
173         };
174         struct rpc_task_setup task_setup_data = {
175                 .task = &data->task,
176                 .rpc_client = NFS_CLIENT(inode),
177                 .rpc_message = &msg,
178                 .callback_ops = call_ops,
179                 .callback_data = data,
180                 .workqueue = nfsiod_workqueue,
181                 .flags = RPC_TASK_ASYNC | swap_flags,
182         };
183
184         data->req         = req;
185         data->inode       = inode;
186         data->cred        = msg.rpc_cred;
187
188         data->args.fh     = NFS_FH(inode);
189         data->args.offset = req_offset(req) + offset;
190         data->args.pgbase = req->wb_pgbase + offset;
191         data->args.pages  = data->pagevec;
192         data->args.count  = count;
193         data->args.context = get_nfs_open_context(req->wb_context);
194
195         data->res.fattr   = &data->fattr;
196         data->res.count   = count;
197         data->res.eof     = 0;
198         nfs_fattr_init(&data->fattr);
199
200         /* Set up the initial task struct. */
201         NFS_PROTO(inode)->read_setup(data, &msg);
202
203         dprintk("NFS: %5u initiated read call (req %s/%Ld, %u bytes @ offset %Lu)\n",
204                         data->task.tk_pid,
205                         inode->i_sb->s_id,
206                         (long long)NFS_FILEID(inode),
207                         count,
208                         (unsigned long long)data->args.offset);
209
210         task = rpc_run_task(&task_setup_data);
211         if (!IS_ERR(task))
212                 rpc_put_task(task);
213 }
214
215 static void
216 nfs_async_read_error(struct list_head *head)
217 {
218         struct nfs_page *req;
219
220         while (!list_empty(head)) {
221                 req = nfs_list_entry(head->next);
222                 nfs_list_remove_request(req);
223                 SetPageError(req->wb_page);
224                 nfs_readpage_release(req);
225         }
226 }
227
228 /*
229  * Generate multiple requests to fill a single page.
230  *
231  * We optimize to reduce the number of read operations on the wire.  If we
232  * detect that we're reading a page, or an area of a page, that is past the
233  * end of file, we do not generate NFS read operations but just clear the
234  * parts of the page that would have come back zero from the server anyway.
235  *
236  * We rely on the cached value of i_size to make this determination; another
237  * client can fill pages on the server past our cached end-of-file, but we
238  * won't see the new data until our attribute cache is updated.  This is more
239  * or less conventional NFS client behavior.
240  */
241 static int nfs_pagein_multi(struct inode *inode, struct list_head *head, unsigned int npages, size_t count, int flags)
242 {
243         struct nfs_page *req = nfs_list_entry(head->next);
244         struct page *page = req->wb_page;
245         struct nfs_read_data *data;
246         size_t rsize = NFS_SERVER(inode)->rsize, nbytes;
247         unsigned int offset;
248         int requests = 0;
249         LIST_HEAD(list);
250
251         nfs_list_remove_request(req);
252
253         nbytes = count;
254         do {
255                 size_t len = min(nbytes,rsize);
256
257                 data = nfs_readdata_alloc(1);
258                 if (!data)
259                         goto out_bad;
260                 INIT_LIST_HEAD(&data->pages);
261                 list_add(&data->pages, &list);
262                 requests++;
263                 nbytes -= len;
264         } while(nbytes != 0);
265         atomic_set(&req->wb_complete, requests);
266
267         ClearPageError(page);
268         offset = 0;
269         nbytes = count;
270         do {
271                 data = list_entry(list.next, struct nfs_read_data, pages);
272                 list_del_init(&data->pages);
273
274                 data->pagevec[0] = page;
275
276                 if (nbytes < rsize)
277                         rsize = nbytes;
278                 nfs_read_rpcsetup(req, data, &nfs_read_partial_ops,
279                                   rsize, offset);
280                 offset += rsize;
281                 nbytes -= rsize;
282         } while (nbytes != 0);
283
284         return 0;
285
286 out_bad:
287         while (!list_empty(&list)) {
288                 data = list_entry(list.next, struct nfs_read_data, pages);
289                 list_del(&data->pages);
290                 nfs_readdata_free(data);
291         }
292         SetPageError(page);
293         nfs_readpage_release(req);
294         return -ENOMEM;
295 }
296
297 static int nfs_pagein_one(struct inode *inode, struct list_head *head, unsigned int npages, size_t count, int flags)
298 {
299         struct nfs_page         *req;
300         struct page             **pages;
301         struct nfs_read_data    *data;
302
303         data = nfs_readdata_alloc(npages);
304         if (!data)
305                 goto out_bad;
306
307         INIT_LIST_HEAD(&data->pages);
308         pages = data->pagevec;
309         while (!list_empty(head)) {
310                 req = nfs_list_entry(head->next);
311                 nfs_list_remove_request(req);
312                 nfs_list_add_request(req, &data->pages);
313                 ClearPageError(req->wb_page);
314                 *pages++ = req->wb_page;
315         }
316         req = nfs_list_entry(data->pages.next);
317
318         nfs_read_rpcsetup(req, data, &nfs_read_full_ops, count, 0);
319         return 0;
320 out_bad:
321         nfs_async_read_error(head);
322         return -ENOMEM;
323 }
324
325 /*
326  * This is the callback from RPC telling us whether a reply was
327  * received or some error occurred (timeout or socket shutdown).
328  */
329 int nfs_readpage_result(struct rpc_task *task, struct nfs_read_data *data)
330 {
331         int status;
332
333         dprintk("NFS: %s: %5u, (status %d)\n", __FUNCTION__, task->tk_pid,
334                         task->tk_status);
335
336         status = NFS_PROTO(data->inode)->read_done(task, data);
337         if (status != 0)
338                 return status;
339
340         nfs_add_stats(data->inode, NFSIOS_SERVERREADBYTES, data->res.count);
341
342         if (task->tk_status == -ESTALE) {
343                 set_bit(NFS_INO_STALE, &NFS_I(data->inode)->flags);
344                 nfs_mark_for_revalidate(data->inode);
345         }
346         return 0;
347 }
348
349 static int nfs_readpage_retry(struct rpc_task *task, struct nfs_read_data *data)
350 {
351         struct nfs_readargs *argp = &data->args;
352         struct nfs_readres *resp = &data->res;
353
354         if (resp->eof || resp->count == argp->count)
355                 return 0;
356
357         /* This is a short read! */
358         nfs_inc_stats(data->inode, NFSIOS_SHORTREAD);
359         /* Has the server at least made some progress? */
360         if (resp->count == 0)
361                 return 0;
362
363         /* Yes, so retry the read at the end of the data */
364         argp->offset += resp->count;
365         argp->pgbase += resp->count;
366         argp->count -= resp->count;
367         rpc_restart_call(task);
368         return -EAGAIN;
369 }
370
371 /*
372  * Handle a read reply that fills part of a page.
373  */
374 static void nfs_readpage_result_partial(struct rpc_task *task, void *calldata)
375 {
376         struct nfs_read_data *data = calldata;
377         struct nfs_page *req = data->req;
378         struct page *page = req->wb_page;
379  
380         if (nfs_readpage_result(task, data) != 0)
381                 return;
382
383         if (likely(task->tk_status >= 0)) {
384                 nfs_readpage_truncate_uninitialised_page(data);
385                 if (nfs_readpage_retry(task, data) != 0)
386                         return;
387         }
388         if (unlikely(task->tk_status < 0))
389                 SetPageError(page);
390         if (atomic_dec_and_test(&req->wb_complete)) {
391                 if (!PageError(page))
392                         SetPageUptodate(page);
393                 nfs_readpage_release(req);
394         }
395 }
396
397 static const struct rpc_call_ops nfs_read_partial_ops = {
398         .rpc_call_done = nfs_readpage_result_partial,
399         .rpc_release = nfs_readdata_release,
400 };
401
402 static void nfs_readpage_set_pages_uptodate(struct nfs_read_data *data)
403 {
404         unsigned int count = data->res.count;
405         unsigned int base = data->args.pgbase;
406         struct page **pages;
407
408         if (data->res.eof)
409                 count = data->args.count;
410         if (unlikely(count == 0))
411                 return;
412         pages = &data->args.pages[base >> PAGE_CACHE_SHIFT];
413         base &= ~PAGE_CACHE_MASK;
414         count += base;
415         for (;count >= PAGE_CACHE_SIZE; count -= PAGE_CACHE_SIZE, pages++)
416                 SetPageUptodate(*pages);
417         if (count == 0)
418                 return;
419         /* Was this a short read? */
420         if (data->res.eof || data->res.count == data->args.count)
421                 SetPageUptodate(*pages);
422 }
423
424 /*
425  * This is the callback from RPC telling us whether a reply was
426  * received or some error occurred (timeout or socket shutdown).
427  */
428 static void nfs_readpage_result_full(struct rpc_task *task, void *calldata)
429 {
430         struct nfs_read_data *data = calldata;
431
432         if (nfs_readpage_result(task, data) != 0)
433                 return;
434         /*
435          * Note: nfs_readpage_retry may change the values of
436          * data->args. In the multi-page case, we therefore need
437          * to ensure that we call nfs_readpage_set_pages_uptodate()
438          * first.
439          */
440         if (likely(task->tk_status >= 0)) {
441                 nfs_readpage_truncate_uninitialised_page(data);
442                 nfs_readpage_set_pages_uptodate(data);
443                 if (nfs_readpage_retry(task, data) != 0)
444                         return;
445         }
446         while (!list_empty(&data->pages)) {
447                 struct nfs_page *req = nfs_list_entry(data->pages.next);
448
449                 nfs_list_remove_request(req);
450                 nfs_readpage_release(req);
451         }
452 }
453
454 static const struct rpc_call_ops nfs_read_full_ops = {
455         .rpc_call_done = nfs_readpage_result_full,
456         .rpc_release = nfs_readdata_release,
457 };
458
459 /*
460  * Read a page over NFS.
461  * We read the page synchronously in the following case:
462  *  -   The error flag is set for this page. This happens only when a
463  *      previous async read operation failed.
464  */
465 int nfs_readpage(struct file *file, struct page *page)
466 {
467         struct nfs_open_context *ctx;
468         struct inode *inode = page->mapping->host;
469         int             error;
470
471         dprintk("NFS: nfs_readpage (%p %ld@%lu)\n",
472                 page, PAGE_CACHE_SIZE, page->index);
473         nfs_inc_stats(inode, NFSIOS_VFSREADPAGE);
474         nfs_add_stats(inode, NFSIOS_READPAGES, 1);
475
476         /*
477          * Try to flush any pending writes to the file..
478          *
479          * NOTE! Because we own the page lock, there cannot
480          * be any new pending writes generated at this point
481          * for this page (other pages can be written to).
482          */
483         error = nfs_wb_page(inode, page);
484         if (error)
485                 goto out_unlock;
486         if (PageUptodate(page))
487                 goto out_unlock;
488
489         error = -ESTALE;
490         if (NFS_STALE(inode))
491                 goto out_unlock;
492
493         if (file == NULL) {
494                 error = -EBADF;
495                 ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
496                 if (ctx == NULL)
497                         goto out_unlock;
498         } else
499                 ctx = get_nfs_open_context(nfs_file_open_context(file));
500
501         error = nfs_readpage_async(ctx, inode, page);
502
503         put_nfs_open_context(ctx);
504         return error;
505 out_unlock:
506         unlock_page(page);
507         return error;
508 }
509
510 struct nfs_readdesc {
511         struct nfs_pageio_descriptor *pgio;
512         struct nfs_open_context *ctx;
513 };
514
515 static int
516 readpage_async_filler(void *data, struct page *page)
517 {
518         struct nfs_readdesc *desc = (struct nfs_readdesc *)data;
519         struct inode *inode = page->mapping->host;
520         struct nfs_page *new;
521         unsigned int len;
522         int error;
523
524         error = nfs_wb_page(inode, page);
525         if (error)
526                 goto out_unlock;
527         if (PageUptodate(page))
528                 goto out_unlock;
529
530         len = nfs_page_length(page);
531         if (len == 0)
532                 return nfs_return_empty_page(page);
533
534         new = nfs_create_request(desc->ctx, inode, page, 0, len);
535         if (IS_ERR(new))
536                 goto out_error;
537
538         if (len < PAGE_CACHE_SIZE)
539                 zero_user_segment(page, len, PAGE_CACHE_SIZE);
540         nfs_pageio_add_request(desc->pgio, new);
541         return 0;
542 out_error:
543         error = PTR_ERR(new);
544         SetPageError(page);
545 out_unlock:
546         unlock_page(page);
547         return error;
548 }
549
550 int nfs_readpages(struct file *filp, struct address_space *mapping,
551                 struct list_head *pages, unsigned nr_pages)
552 {
553         struct nfs_pageio_descriptor pgio;
554         struct nfs_readdesc desc = {
555                 .pgio = &pgio,
556         };
557         struct inode *inode = mapping->host;
558         struct nfs_server *server = NFS_SERVER(inode);
559         size_t rsize = server->rsize;
560         unsigned long npages;
561         int ret = -ESTALE;
562
563         dprintk("NFS: nfs_readpages (%s/%Ld %d)\n",
564                         inode->i_sb->s_id,
565                         (long long)NFS_FILEID(inode),
566                         nr_pages);
567         nfs_inc_stats(inode, NFSIOS_VFSREADPAGES);
568
569         if (NFS_STALE(inode))
570                 goto out;
571
572         if (filp == NULL) {
573                 desc.ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
574                 if (desc.ctx == NULL)
575                         return -EBADF;
576         } else
577                 desc.ctx = get_nfs_open_context(nfs_file_open_context(filp));
578         if (rsize < PAGE_CACHE_SIZE)
579                 nfs_pageio_init(&pgio, inode, nfs_pagein_multi, rsize, 0);
580         else
581                 nfs_pageio_init(&pgio, inode, nfs_pagein_one, rsize, 0);
582
583         ret = read_cache_pages(mapping, pages, readpage_async_filler, &desc);
584
585         nfs_pageio_complete(&pgio);
586         npages = (pgio.pg_bytes_written + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
587         nfs_add_stats(inode, NFSIOS_READPAGES, npages);
588         put_nfs_open_context(desc.ctx);
589 out:
590         return ret;
591 }
592
593 int __init nfs_init_readpagecache(void)
594 {
595         nfs_rdata_cachep = kmem_cache_create("nfs_read_data",
596                                              sizeof(struct nfs_read_data),
597                                              0, SLAB_HWCACHE_ALIGN,
598                                              NULL);
599         if (nfs_rdata_cachep == NULL)
600                 return -ENOMEM;
601
602         nfs_rdata_mempool = mempool_create_slab_pool(MIN_POOL_READ,
603                                                      nfs_rdata_cachep);
604         if (nfs_rdata_mempool == NULL)
605                 return -ENOMEM;
606
607         return 0;
608 }
609
610 void nfs_destroy_readpagecache(void)
611 {
612         mempool_destroy(nfs_rdata_mempool);
613         kmem_cache_destroy(nfs_rdata_cachep);
614 }