SUNRPC: Cleanup of rpc_task initialisation
[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         nfs_readdata_free(data);
77 }
78
79 static
80 int nfs_return_empty_page(struct page *page)
81 {
82         zero_user_page(page, 0, PAGE_CACHE_SIZE, KM_USER0);
83         SetPageUptodate(page);
84         unlock_page(page);
85         return 0;
86 }
87
88 static void nfs_readpage_truncate_uninitialised_page(struct nfs_read_data *data)
89 {
90         unsigned int remainder = data->args.count - data->res.count;
91         unsigned int base = data->args.pgbase + data->res.count;
92         unsigned int pglen;
93         struct page **pages;
94
95         if (data->res.eof == 0 || remainder == 0)
96                 return;
97         /*
98          * Note: "remainder" can never be negative, since we check for
99          *      this in the XDR code.
100          */
101         pages = &data->args.pages[base >> PAGE_CACHE_SHIFT];
102         base &= ~PAGE_CACHE_MASK;
103         pglen = PAGE_CACHE_SIZE - base;
104         for (;;) {
105                 if (remainder <= pglen) {
106                         zero_user_page(*pages, base, remainder, KM_USER0);
107                         break;
108                 }
109                 zero_user_page(*pages, base, pglen, KM_USER0);
110                 pages++;
111                 remainder -= pglen;
112                 pglen = PAGE_CACHE_SIZE;
113                 base = 0;
114         }
115 }
116
117 static int nfs_readpage_async(struct nfs_open_context *ctx, struct inode *inode,
118                 struct page *page)
119 {
120         LIST_HEAD(one_request);
121         struct nfs_page *new;
122         unsigned int len;
123
124         len = nfs_page_length(page);
125         if (len == 0)
126                 return nfs_return_empty_page(page);
127         new = nfs_create_request(ctx, inode, page, 0, len);
128         if (IS_ERR(new)) {
129                 unlock_page(page);
130                 return PTR_ERR(new);
131         }
132         if (len < PAGE_CACHE_SIZE)
133                 zero_user_page(page, len, PAGE_CACHE_SIZE - len, KM_USER0);
134
135         nfs_list_add_request(new, &one_request);
136         if (NFS_SERVER(inode)->rsize < PAGE_CACHE_SIZE)
137                 nfs_pagein_multi(inode, &one_request, 1, len, 0);
138         else
139                 nfs_pagein_one(inode, &one_request, 1, len, 0);
140         return 0;
141 }
142
143 static void nfs_readpage_release(struct nfs_page *req)
144 {
145         unlock_page(req->wb_page);
146
147         dprintk("NFS: read done (%s/%Ld %d@%Ld)\n",
148                         req->wb_context->path.dentry->d_inode->i_sb->s_id,
149                         (long long)NFS_FILEID(req->wb_context->path.dentry->d_inode),
150                         req->wb_bytes,
151                         (long long)req_offset(req));
152         nfs_clear_request(req);
153         nfs_release_request(req);
154 }
155
156 /*
157  * Set up the NFS read request struct
158  */
159 static void nfs_read_rpcsetup(struct nfs_page *req, struct nfs_read_data *data,
160                 const struct rpc_call_ops *call_ops,
161                 unsigned int count, unsigned int offset)
162 {
163         struct inode *inode = req->wb_context->path.dentry->d_inode;
164         int swap_flags = IS_SWAPFILE(inode) ? NFS_RPC_SWAPFLAGS : 0;
165         struct rpc_task_setup task_setup_data = {
166                 .rpc_client = NFS_CLIENT(inode),
167                 .callback_ops = call_ops,
168                 .callback_data = data,
169                 .flags = RPC_TASK_ASYNC | swap_flags,
170         };
171
172         data->req         = req;
173         data->inode       = inode;
174         data->cred        = req->wb_context->cred;
175
176         data->args.fh     = NFS_FH(inode);
177         data->args.offset = req_offset(req) + offset;
178         data->args.pgbase = req->wb_pgbase + offset;
179         data->args.pages  = data->pagevec;
180         data->args.count  = count;
181         data->args.context = req->wb_context;
182
183         data->res.fattr   = &data->fattr;
184         data->res.count   = count;
185         data->res.eof     = 0;
186         nfs_fattr_init(&data->fattr);
187
188         /* Set up the initial task struct. */
189         rpc_init_task(&data->task, &task_setup_data);
190         NFS_PROTO(inode)->read_setup(data);
191
192         data->task.tk_cookie = (unsigned long)inode;
193
194         dprintk("NFS: %5u initiated read call (req %s/%Ld, %u bytes @ offset %Lu)\n",
195                         data->task.tk_pid,
196                         inode->i_sb->s_id,
197                         (long long)NFS_FILEID(inode),
198                         count,
199                         (unsigned long long)data->args.offset);
200 }
201
202 static void
203 nfs_async_read_error(struct list_head *head)
204 {
205         struct nfs_page *req;
206
207         while (!list_empty(head)) {
208                 req = nfs_list_entry(head->next);
209                 nfs_list_remove_request(req);
210                 SetPageError(req->wb_page);
211                 nfs_readpage_release(req);
212         }
213 }
214
215 /*
216  * Start an async read operation
217  */
218 static void nfs_execute_read(struct nfs_read_data *data)
219 {
220         struct rpc_clnt *clnt = NFS_CLIENT(data->inode);
221         sigset_t oldset;
222
223         rpc_clnt_sigmask(clnt, &oldset);
224         rpc_execute(&data->task);
225         rpc_clnt_sigunmask(clnt, &oldset);
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                 nfs_execute_read(data);
283         } while (nbytes != 0);
284
285         return 0;
286
287 out_bad:
288         while (!list_empty(&list)) {
289                 data = list_entry(list.next, struct nfs_read_data, pages);
290                 list_del(&data->pages);
291                 nfs_readdata_free(data);
292         }
293         SetPageError(page);
294         nfs_readpage_release(req);
295         return -ENOMEM;
296 }
297
298 static int nfs_pagein_one(struct inode *inode, struct list_head *head, unsigned int npages, size_t count, int flags)
299 {
300         struct nfs_page         *req;
301         struct page             **pages;
302         struct nfs_read_data    *data;
303
304         data = nfs_readdata_alloc(npages);
305         if (!data)
306                 goto out_bad;
307
308         INIT_LIST_HEAD(&data->pages);
309         pages = data->pagevec;
310         while (!list_empty(head)) {
311                 req = nfs_list_entry(head->next);
312                 nfs_list_remove_request(req);
313                 nfs_list_add_request(req, &data->pages);
314                 ClearPageError(req->wb_page);
315                 *pages++ = req->wb_page;
316         }
317         req = nfs_list_entry(data->pages.next);
318
319         nfs_read_rpcsetup(req, data, &nfs_read_full_ops, count, 0);
320
321         nfs_execute_read(data);
322         return 0;
323 out_bad:
324         nfs_async_read_error(head);
325         return -ENOMEM;
326 }
327
328 /*
329  * This is the callback from RPC telling us whether a reply was
330  * received or some error occurred (timeout or socket shutdown).
331  */
332 int nfs_readpage_result(struct rpc_task *task, struct nfs_read_data *data)
333 {
334         int status;
335
336         dprintk("NFS: %s: %5u, (status %d)\n", __FUNCTION__, task->tk_pid,
337                         task->tk_status);
338
339         status = NFS_PROTO(data->inode)->read_done(task, data);
340         if (status != 0)
341                 return status;
342
343         nfs_add_stats(data->inode, NFSIOS_SERVERREADBYTES, data->res.count);
344
345         if (task->tk_status == -ESTALE) {
346                 set_bit(NFS_INO_STALE, &NFS_FLAGS(data->inode));
347                 nfs_mark_for_revalidate(data->inode);
348         }
349         return 0;
350 }
351
352 static int nfs_readpage_retry(struct rpc_task *task, struct nfs_read_data *data)
353 {
354         struct nfs_readargs *argp = &data->args;
355         struct nfs_readres *resp = &data->res;
356
357         if (resp->eof || resp->count == argp->count)
358                 return 0;
359
360         /* This is a short read! */
361         nfs_inc_stats(data->inode, NFSIOS_SHORTREAD);
362         /* Has the server at least made some progress? */
363         if (resp->count == 0)
364                 return 0;
365
366         /* Yes, so retry the read at the end of the data */
367         argp->offset += resp->count;
368         argp->pgbase += resp->count;
369         argp->count -= resp->count;
370         rpc_restart_call(task);
371         return -EAGAIN;
372 }
373
374 /*
375  * Handle a read reply that fills part of a page.
376  */
377 static void nfs_readpage_result_partial(struct rpc_task *task, void *calldata)
378 {
379         struct nfs_read_data *data = calldata;
380         struct nfs_page *req = data->req;
381         struct page *page = req->wb_page;
382  
383         if (nfs_readpage_result(task, data) != 0)
384                 return;
385
386         if (likely(task->tk_status >= 0)) {
387                 nfs_readpage_truncate_uninitialised_page(data);
388                 if (nfs_readpage_retry(task, data) != 0)
389                         return;
390         }
391         if (unlikely(task->tk_status < 0))
392                 SetPageError(page);
393         if (atomic_dec_and_test(&req->wb_complete)) {
394                 if (!PageError(page))
395                         SetPageUptodate(page);
396                 nfs_readpage_release(req);
397         }
398 }
399
400 static const struct rpc_call_ops nfs_read_partial_ops = {
401         .rpc_call_done = nfs_readpage_result_partial,
402         .rpc_release = nfs_readdata_release,
403 };
404
405 static void nfs_readpage_set_pages_uptodate(struct nfs_read_data *data)
406 {
407         unsigned int count = data->res.count;
408         unsigned int base = data->args.pgbase;
409         struct page **pages;
410
411         if (data->res.eof)
412                 count = data->args.count;
413         if (unlikely(count == 0))
414                 return;
415         pages = &data->args.pages[base >> PAGE_CACHE_SHIFT];
416         base &= ~PAGE_CACHE_MASK;
417         count += base;
418         for (;count >= PAGE_CACHE_SIZE; count -= PAGE_CACHE_SIZE, pages++)
419                 SetPageUptodate(*pages);
420         if (count == 0)
421                 return;
422         /* Was this a short read? */
423         if (data->res.eof || data->res.count == data->args.count)
424                 SetPageUptodate(*pages);
425 }
426
427 /*
428  * This is the callback from RPC telling us whether a reply was
429  * received or some error occurred (timeout or socket shutdown).
430  */
431 static void nfs_readpage_result_full(struct rpc_task *task, void *calldata)
432 {
433         struct nfs_read_data *data = calldata;
434
435         if (nfs_readpage_result(task, data) != 0)
436                 return;
437         /*
438          * Note: nfs_readpage_retry may change the values of
439          * data->args. In the multi-page case, we therefore need
440          * to ensure that we call nfs_readpage_set_pages_uptodate()
441          * first.
442          */
443         if (likely(task->tk_status >= 0)) {
444                 nfs_readpage_truncate_uninitialised_page(data);
445                 nfs_readpage_set_pages_uptodate(data);
446                 if (nfs_readpage_retry(task, data) != 0)
447                         return;
448         }
449         while (!list_empty(&data->pages)) {
450                 struct nfs_page *req = nfs_list_entry(data->pages.next);
451
452                 nfs_list_remove_request(req);
453                 nfs_readpage_release(req);
454         }
455 }
456
457 static const struct rpc_call_ops nfs_read_full_ops = {
458         .rpc_call_done = nfs_readpage_result_full,
459         .rpc_release = nfs_readdata_release,
460 };
461
462 /*
463  * Read a page over NFS.
464  * We read the page synchronously in the following case:
465  *  -   The error flag is set for this page. This happens only when a
466  *      previous async read operation failed.
467  */
468 int nfs_readpage(struct file *file, struct page *page)
469 {
470         struct nfs_open_context *ctx;
471         struct inode *inode = page->mapping->host;
472         int             error;
473
474         dprintk("NFS: nfs_readpage (%p %ld@%lu)\n",
475                 page, PAGE_CACHE_SIZE, page->index);
476         nfs_inc_stats(inode, NFSIOS_VFSREADPAGE);
477         nfs_add_stats(inode, NFSIOS_READPAGES, 1);
478
479         /*
480          * Try to flush any pending writes to the file..
481          *
482          * NOTE! Because we own the page lock, there cannot
483          * be any new pending writes generated at this point
484          * for this page (other pages can be written to).
485          */
486         error = nfs_wb_page(inode, page);
487         if (error)
488                 goto out_unlock;
489         if (PageUptodate(page))
490                 goto out_unlock;
491
492         error = -ESTALE;
493         if (NFS_STALE(inode))
494                 goto out_unlock;
495
496         if (file == NULL) {
497                 error = -EBADF;
498                 ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
499                 if (ctx == NULL)
500                         goto out_unlock;
501         } else
502                 ctx = get_nfs_open_context(nfs_file_open_context(file));
503
504         error = nfs_readpage_async(ctx, inode, page);
505
506         put_nfs_open_context(ctx);
507         return error;
508 out_unlock:
509         unlock_page(page);
510         return error;
511 }
512
513 struct nfs_readdesc {
514         struct nfs_pageio_descriptor *pgio;
515         struct nfs_open_context *ctx;
516 };
517
518 static int
519 readpage_async_filler(void *data, struct page *page)
520 {
521         struct nfs_readdesc *desc = (struct nfs_readdesc *)data;
522         struct inode *inode = page->mapping->host;
523         struct nfs_page *new;
524         unsigned int len;
525         int error;
526
527         error = nfs_wb_page(inode, page);
528         if (error)
529                 goto out_unlock;
530         if (PageUptodate(page))
531                 goto out_unlock;
532
533         len = nfs_page_length(page);
534         if (len == 0)
535                 return nfs_return_empty_page(page);
536
537         new = nfs_create_request(desc->ctx, inode, page, 0, len);
538         if (IS_ERR(new))
539                 goto out_error;
540
541         if (len < PAGE_CACHE_SIZE)
542                 zero_user_page(page, len, PAGE_CACHE_SIZE - len, KM_USER0);
543         nfs_pageio_add_request(desc->pgio, new);
544         return 0;
545 out_error:
546         error = PTR_ERR(new);
547         SetPageError(page);
548 out_unlock:
549         unlock_page(page);
550         return error;
551 }
552
553 int nfs_readpages(struct file *filp, struct address_space *mapping,
554                 struct list_head *pages, unsigned nr_pages)
555 {
556         struct nfs_pageio_descriptor pgio;
557         struct nfs_readdesc desc = {
558                 .pgio = &pgio,
559         };
560         struct inode *inode = mapping->host;
561         struct nfs_server *server = NFS_SERVER(inode);
562         size_t rsize = server->rsize;
563         unsigned long npages;
564         int ret = -ESTALE;
565
566         dprintk("NFS: nfs_readpages (%s/%Ld %d)\n",
567                         inode->i_sb->s_id,
568                         (long long)NFS_FILEID(inode),
569                         nr_pages);
570         nfs_inc_stats(inode, NFSIOS_VFSREADPAGES);
571
572         if (NFS_STALE(inode))
573                 goto out;
574
575         if (filp == NULL) {
576                 desc.ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
577                 if (desc.ctx == NULL)
578                         return -EBADF;
579         } else
580                 desc.ctx = get_nfs_open_context(nfs_file_open_context(filp));
581         if (rsize < PAGE_CACHE_SIZE)
582                 nfs_pageio_init(&pgio, inode, nfs_pagein_multi, rsize, 0);
583         else
584                 nfs_pageio_init(&pgio, inode, nfs_pagein_one, rsize, 0);
585
586         ret = read_cache_pages(mapping, pages, readpage_async_filler, &desc);
587
588         nfs_pageio_complete(&pgio);
589         npages = (pgio.pg_bytes_written + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
590         nfs_add_stats(inode, NFSIOS_READPAGES, npages);
591         put_nfs_open_context(desc.ctx);
592 out:
593         return ret;
594 }
595
596 int __init nfs_init_readpagecache(void)
597 {
598         nfs_rdata_cachep = kmem_cache_create("nfs_read_data",
599                                              sizeof(struct nfs_read_data),
600                                              0, SLAB_HWCACHE_ALIGN,
601                                              NULL);
602         if (nfs_rdata_cachep == NULL)
603                 return -ENOMEM;
604
605         nfs_rdata_mempool = mempool_create_slab_pool(MIN_POOL_READ,
606                                                      nfs_rdata_cachep);
607         if (nfs_rdata_mempool == NULL)
608                 return -ENOMEM;
609
610         return 0;
611 }
612
613 void nfs_destroy_readpagecache(void)
614 {
615         mempool_destroy(nfs_rdata_mempool);
616         kmem_cache_destroy(nfs_rdata_cachep);
617 }