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  * We do an ugly hack here in order to return proper error codes to the
  10  * user program when a read request failed: since generic_file_read
  11  * only checks the return value of inode->i_op->readpage() which is always 0
  12  * for async RPC, we set the error bit of the page to 1 when an error occurs,
  13  * and make nfs_readpage transmit requests synchronously when encountering this.
  14  * This is only a small problem, though, since we now retry all operations
  15  * within the RPC code when root squashing is suspected.
  16  */
  17
  18 #include <linux/config.h>
  19 #include <linux/time.h>
  20 #include <linux/kernel.h>
  21 #include <linux/errno.h>
  22 #include <linux/fcntl.h>
  23 #include <linux/stat.h>
  24 #include <linux/mm.h>
  25 #include <linux/slab.h>
  26 #include <linux/pagemap.h>
  27 #include <linux/sunrpc/clnt.h>
  28 #include <linux/nfs_fs.h>
  29 #include <linux/nfs_page.h>
  30 #include <linux/smp_lock.h>
  31
  32 #include <asm/system.h>
  33
  34 #include "iostat.h"
  35
  36 #define NFSDBG_FACILITY         NFSDBG_PAGECACHE
  37
  38 static int nfs_pagein_one(struct list_head *, struct inode *);
  39 static void nfs_readpage_result_partial(struct nfs_read_data *, int);
  40 static void nfs_readpage_result_full(struct nfs_read_data *, int);
  41
  42 static kmem_cache_t *nfs_rdata_cachep;
  43 mempool_t *nfs_rdata_mempool;
  44
  45 #define MIN_POOL_READ   (32)
  46
  47 void nfs_readdata_release(void *data)
  48 {
  49         nfs_readdata_free(data);
  50 }
  51
  52 static
  53 unsigned int nfs_page_length(struct inode *inode, struct page *page)
  54 {
  55         loff_t i_size = i_size_read(inode);
  56         unsigned long idx;
  57
  58         if (i_size <= 0)
  59                 return 0;
  60         idx = (i_size - 1) >> PAGE_CACHE_SHIFT;
  61         if (page->index > idx)
  62                 return 0;
  63         if (page->index != idx)
  64                 return PAGE_CACHE_SIZE;
  65         return 1 + ((i_size - 1) & (PAGE_CACHE_SIZE - 1));
  66 }
  67
  68 static
  69 int nfs_return_empty_page(struct page *page)
  70 {
  71         memclear_highpage_flush(page, 0, PAGE_CACHE_SIZE);
  72         SetPageUptodate(page);
  73         unlock_page(page);
  74         return 0;
  75 }
  76
  77 /*
  78  * Read a page synchronously.
  79  */
  80 static int nfs_readpage_sync(struct nfs_open_context *ctx, struct inode *inode,
  81                 struct page *page)
  82 {
  83         unsigned int    rsize = NFS_SERVER(inode)->rsize;
  84         unsigned int    count = PAGE_CACHE_SIZE;
  85         int             result;
  86         struct nfs_read_data *rdata;
  87
  88         rdata = nfs_readdata_alloc(1);
  89         if (!rdata)
  90                 return -ENOMEM;
  91
  92         memset(rdata, 0, sizeof(*rdata));
  93         rdata->flags = (IS_SWAPFILE(inode)? NFS_RPC_SWAPFLAGS : 0);
  94         rdata->cred = ctx->cred;
  95         rdata->inode = inode;
  96         INIT_LIST_HEAD(&rdata->pages);
  97         rdata->args.fh = NFS_FH(inode);
  98         rdata->args.context = ctx;
  99         rdata->args.pages = &page;
 100         rdata->args.pgbase = 0UL;
 101         rdata->args.count = rsize;
 102         rdata->res.fattr = &rdata->fattr;
 103
 104         dprintk("NFS: nfs_readpage_sync(%p)\n", page);
 105
 106         /*
 107          * This works now because the socket layer never tries to DMA
 108          * into this buffer directly.
 109          */
 110         do {
 111                 if (count < rsize)
 112                         rdata->args.count = count;
 113                 rdata->res.count = rdata->args.count;
 114                 rdata->args.offset = page_offset(page) + rdata->args.pgbase;
 115
 116                 dprintk("NFS: nfs_proc_read(%s, (%s/%Ld), %Lu, %u)\n",
 117                         NFS_SERVER(inode)->hostname,
 118                         inode->i_sb->s_id,
 119                         (long long)NFS_FILEID(inode),
 120                         (unsigned long long)rdata->args.pgbase,
 121                         rdata->args.count);
 122
 123                 lock_kernel();
 124                 result = NFS_PROTO(inode)->read(rdata);
 125                 unlock_kernel();
 126
 127                 /*
 128                  * Even if we had a partial success we can't mark the page
 129                  * cache valid.
 130                  */
 131                 if (result < 0) {
 132                         if (result == -EISDIR)
 133                                 result = -EINVAL;
 134                         goto io_error;
 135                 }
 136                 count -= result;
 137                 rdata->args.pgbase += result;
 138                 nfs_add_stats(inode, NFSIOS_SERVERREADBYTES, result);
 139
 140                 /* Note: result == 0 should only happen if we're caching
 141                  * a write that extends the file and punches a hole.
 142                  */
 143                 if (rdata->res.eof != 0 || result == 0)
 144                         break;
 145         } while (count);
 146         spin_lock(&inode->i_lock);
 147         NFS_I(inode)->cache_validity |= NFS_INO_INVALID_ATIME;
 148         spin_unlock(&inode->i_lock);
 149
 150         if (count)
 151                 memclear_highpage_flush(page, rdata->args.pgbase, count);
 152         SetPageUptodate(page);
 153         if (PageError(page))
 154                 ClearPageError(page);
 155         result = 0;
 156
 157 io_error:
 158         unlock_page(page);
 159         nfs_readdata_free(rdata);
 160         return result;
 161 }
 162
 163 static int nfs_readpage_async(struct nfs_open_context *ctx, struct inode *inode,
 164                 struct page *page)
 165 {
 166         LIST_HEAD(one_request);
 167         struct nfs_page *new;
 168         unsigned int len;
 169
 170         len = nfs_page_length(inode, page);
 171         if (len == 0)
 172                 return nfs_return_empty_page(page);
 173         new = nfs_create_request(ctx, inode, page, 0, len);
 174         if (IS_ERR(new)) {
 175                 unlock_page(page);
 176                 return PTR_ERR(new);
 177         }
 178         if (len < PAGE_CACHE_SIZE)
 179                 memclear_highpage_flush(page, len, PAGE_CACHE_SIZE - len);
 180
 181         nfs_list_add_request(new, &one_request);
 182         nfs_pagein_one(&one_request, inode);
 183         return 0;
 184 }
 185
 186 static void nfs_readpage_release(struct nfs_page *req)
 187 {
 188         unlock_page(req->wb_page);
 189
 190         dprintk("NFS: read done (%s/%Ld %d@%Ld)\n",
 191                         req->wb_context->dentry->d_inode->i_sb->s_id,
 192                         (long long)NFS_FILEID(req->wb_context->dentry->d_inode),
 193                         req->wb_bytes,
 194                         (long long)req_offset(req));
 195         nfs_clear_request(req);
 196         nfs_release_request(req);
 197 }
 198
 199 /*
 200  * Set up the NFS read request struct
 201  */
 202 static void nfs_read_rpcsetup(struct nfs_page *req, struct nfs_read_data *data,
 203                 unsigned int count, unsigned int offset)
 204 {
 205         struct inode            *inode;
 206
 207         data->req         = req;
 208         data->inode       = inode = req->wb_context->dentry->d_inode;
 209         data->cred        = req->wb_context->cred;
 210
 211         data->args.fh     = NFS_FH(inode);
 212         data->args.offset = req_offset(req) + offset;
 213         data->args.pgbase = req->wb_pgbase + offset;
 214         data->args.pages  = data->pagevec;
 215         data->args.count  = count;
 216         data->args.context = req->wb_context;
 217
 218         data->res.fattr   = &data->fattr;
 219         data->res.count   = count;
 220         data->res.eof     = 0;
 221         nfs_fattr_init(&data->fattr);
 222
 223         NFS_PROTO(inode)->read_setup(data);
 224
 225         data->task.tk_cookie = (unsigned long)inode;
 226
 227         dprintk("NFS: %4d initiated read call (req %s/%Ld, %u bytes @ offset %Lu)\n",
 228                         data->task.tk_pid,
 229                         inode->i_sb->s_id,
 230                         (long long)NFS_FILEID(inode),
 231                         count,
 232                         (unsigned long long)data->args.offset);
 233 }
 234
 235 static void
 236 nfs_async_read_error(struct list_head *head)
 237 {
 238         struct nfs_page *req;
 239
 240         while (!list_empty(head)) {
 241                 req = nfs_list_entry(head->next);
 242                 nfs_list_remove_request(req);
 243                 SetPageError(req->wb_page);
 244                 nfs_readpage_release(req);
 245         }
 246 }
 247
 248 /*
 249  * Start an async read operation
 250  */
 251 static void nfs_execute_read(struct nfs_read_data *data)
 252 {
 253         struct rpc_clnt *clnt = NFS_CLIENT(data->inode);
 254         sigset_t oldset;
 255
 256         rpc_clnt_sigmask(clnt, &oldset);
 257         lock_kernel();
 258         rpc_execute(&data->task);
 259         unlock_kernel();
 260         rpc_clnt_sigunmask(clnt, &oldset);
 261 }
 262
 263 /*
 264  * Generate multiple requests to fill a single page.
 265  *
 266  * We optimize to reduce the number of read operations on the wire.  If we
 267  * detect that we're reading a page, or an area of a page, that is past the
 268  * end of file, we do not generate NFS read operations but just clear the
 269  * parts of the page that would have come back zero from the server anyway.
 270  *
 271  * We rely on the cached value of i_size to make this determination; another
 272  * client can fill pages on the server past our cached end-of-file, but we
 273  * won't see the new data until our attribute cache is updated.  This is more
 274  * or less conventional NFS client behavior.
 275  */
 276 static int nfs_pagein_multi(struct list_head *head, struct inode *inode)
 277 {
 278         struct nfs_page *req = nfs_list_entry(head->next);
 279         struct page *page = req->wb_page;
 280         struct nfs_read_data *data;
 281         unsigned int rsize = NFS_SERVER(inode)->rsize;
 282         unsigned int nbytes, offset;
 283         int requests = 0;
 284         LIST_HEAD(list);
 285
 286         nfs_list_remove_request(req);
 287
 288         nbytes = req->wb_bytes;
 289         for(;;) {
 290                 data = nfs_readdata_alloc(1);
 291                 if (!data)
 292                         goto out_bad;
 293                 INIT_LIST_HEAD(&data->pages);
 294                 list_add(&data->pages, &list);
 295                 requests++;
 296                 if (nbytes <= rsize)
 297                         break;
 298                 nbytes -= rsize;
 299         }
 300         atomic_set(&req->wb_complete, requests);
 301
 302         ClearPageError(page);
 303         offset = 0;
 304         nbytes = req->wb_bytes;
 305         do {
 306                 data = list_entry(list.next, struct nfs_read_data, pages);
 307                 list_del_init(&data->pages);
 308
 309                 data->pagevec[0] = page;
 310                 data->complete = nfs_readpage_result_partial;
 311
 312                 if (nbytes > rsize) {
 313                         nfs_read_rpcsetup(req, data, rsize, offset);
 314                         offset += rsize;
 315                         nbytes -= rsize;
 316                 } else {
 317                         nfs_read_rpcsetup(req, data, nbytes, offset);
 318                         nbytes = 0;
 319                 }
 320                 nfs_execute_read(data);
 321         } while (nbytes != 0);
 322
 323         return 0;
 324
 325 out_bad:
 326         while (!list_empty(&list)) {
 327                 data = list_entry(list.next, struct nfs_read_data, pages);
 328                 list_del(&data->pages);
 329                 nfs_readdata_free(data);
 330         }
 331         SetPageError(page);
 332         nfs_readpage_release(req);
 333         return -ENOMEM;
 334 }
 335
 336 static int nfs_pagein_one(struct list_head *head, struct inode *inode)
 337 {
 338         struct nfs_page         *req;
 339         struct page             **pages;
 340         struct nfs_read_data    *data;
 341         unsigned int            count;
 342
 343         if (NFS_SERVER(inode)->rsize < PAGE_CACHE_SIZE)
 344                 return nfs_pagein_multi(head, inode);
 345
 346         data = nfs_readdata_alloc(NFS_SERVER(inode)->rpages);
 347         if (!data)
 348                 goto out_bad;
 349
 350         INIT_LIST_HEAD(&data->pages);
 351         pages = data->pagevec;
 352         count = 0;
 353         while (!list_empty(head)) {
 354                 req = nfs_list_entry(head->next);
 355                 nfs_list_remove_request(req);
 356                 nfs_list_add_request(req, &data->pages);
 357                 ClearPageError(req->wb_page);
 358                 *pages++ = req->wb_page;
 359                 count += req->wb_bytes;
 360         }
 361         req = nfs_list_entry(data->pages.next);
 362
 363         data->complete = nfs_readpage_result_full;
 364         nfs_read_rpcsetup(req, data, count, 0);
 365
 366         nfs_execute_read(data);
 367         return 0;
 368 out_bad:
 369         nfs_async_read_error(head);
 370         return -ENOMEM;
 371 }
 372
 373 static int
 374 nfs_pagein_list(struct list_head *head, int rpages)
 375 {
 376         LIST_HEAD(one_request);
 377         struct nfs_page         *req;
 378         int                     error = 0;
 379         unsigned int            pages = 0;
 380
 381         while (!list_empty(head)) {
 382                 pages += nfs_coalesce_requests(head, &one_request, rpages);
 383                 req = nfs_list_entry(one_request.next);
 384                 error = nfs_pagein_one(&one_request, req->wb_context->dentry->d_inode);
 385                 if (error < 0)
 386                         break;
 387         }
 388         if (error >= 0)
 389                 return pages;
 390
 391         nfs_async_read_error(head);
 392         return error;
 393 }
 394
 395 /*
 396  * Handle a read reply that fills part of a page.
 397  */
 398 static void nfs_readpage_result_partial(struct nfs_read_data *data, int status)
 399 {
 400         struct nfs_page *req = data->req;
 401         struct page *page = req->wb_page;
 402
 403         if (status >= 0) {
 404                 unsigned int request = data->args.count;
 405                 unsigned int result = data->res.count;
 406
 407                 if (result < request) {
 408                         memclear_highpage_flush(page,
 409                                                 data->args.pgbase + result,
 410                                                 request - result);
 411                 }
 412         } else
 413                 SetPageError(page);
 414
 415         if (atomic_dec_and_test(&req->wb_complete)) {
 416                 if (!PageError(page))
 417                         SetPageUptodate(page);
 418                 nfs_readpage_release(req);
 419         }
 420 }
 421
 422 /*
 423  * This is the callback from RPC telling us whether a reply was
 424  * received or some error occurred (timeout or socket shutdown).
 425  */
 426 static void nfs_readpage_result_full(struct nfs_read_data *data, int status)
 427 {
 428         unsigned int count = data->res.count;
 429
 430         while (!list_empty(&data->pages)) {
 431                 struct nfs_page *req = nfs_list_entry(data->pages.next);
 432                 struct page *page = req->wb_page;
 433                 nfs_list_remove_request(req);
 434
 435                 if (status >= 0) {
 436                         if (count < PAGE_CACHE_SIZE) {
 437                                 if (count < req->wb_bytes)
 438                                         memclear_highpage_flush(page,
 439                                                         req->wb_pgbase + count,
 440                                                         req->wb_bytes - count);
 441                                 count = 0;
 442                         } else
 443                                 count -= PAGE_CACHE_SIZE;
 444                         SetPageUptodate(page);
 445                 } else
 446                         SetPageError(page);
 447                 nfs_readpage_release(req);
 448         }
 449 }
 450
 451 /*
 452  * This is the callback from RPC telling us whether a reply was
 453  * received or some error occurred (timeout or socket shutdown).
 454  */
 455 void nfs_readpage_result(struct rpc_task *task, void *calldata)
 456 {
 457         struct nfs_read_data *data = calldata;
 458         struct nfs_readargs *argp = &data->args;
 459         struct nfs_readres *resp = &data->res;
 460         int status = task->tk_status;
 461
 462         dprintk("NFS: %4d nfs_readpage_result, (status %d)\n",
 463                 task->tk_pid, status);
 464
 465         nfs_add_stats(data->inode, NFSIOS_SERVERREADBYTES, resp->count);
 466
 467         /* Is this a short read? */
 468         if (task->tk_status >= 0 && resp->count < argp->count && !resp->eof) {
 469                 nfs_inc_stats(data->inode, NFSIOS_SHORTREAD);
 470                 /* Has the server at least made some progress? */
 471                 if (resp->count != 0) {
 472                         /* Yes, so retry the read at the end of the data */
 473                         argp->offset += resp->count;
 474                         argp->pgbase += resp->count;
 475                         argp->count -= resp->count;
 476                         rpc_restart_call(task);
 477                         return;
 478                 }
 479                 task->tk_status = -EIO;
 480         }
 481         spin_lock(&data->inode->i_lock);
 482         NFS_I(data->inode)->cache_validity |= NFS_INO_INVALID_ATIME;
 483         spin_unlock(&data->inode->i_lock);
 484         data->complete(data, status);
 485 }
 486
 487 /*
 488  * Read a page over NFS.
 489  * We read the page synchronously in the following case:
 490  *  -   The error flag is set for this page. This happens only when a
 491  *      previous async read operation failed.
 492  */
 493 int nfs_readpage(struct file *file, struct page *page)
 494 {
 495         struct nfs_open_context *ctx;
 496         struct inode *inode = page->mapping->host;
 497         int             error;
 498
 499         dprintk("NFS: nfs_readpage (%p %ld@%lu)\n",
 500                 page, PAGE_CACHE_SIZE, page->index);
 501         nfs_inc_stats(inode, NFSIOS_VFSREADPAGE);
 502         nfs_add_stats(inode, NFSIOS_READPAGES, 1);
 503
 504         /*
 505          * Try to flush any pending writes to the file..
 506          *
 507          * NOTE! Because we own the page lock, there cannot
 508          * be any new pending writes generated at this point
 509          * for this page (other pages can be written to).
 510          */
 511         error = nfs_wb_page(inode, page);
 512         if (error)
 513                 goto out_error;
 514
 515         if (file == NULL) {
 516                 ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
 517                 if (ctx == NULL)
 518                         return -EBADF;
 519         } else
 520                 ctx = get_nfs_open_context((struct nfs_open_context *)
 521                                 file->private_data);
 522         if (!IS_SYNC(inode)) {
 523                 error = nfs_readpage_async(ctx, inode, page);
 524                 goto out;
 525         }
 526
 527         error = nfs_readpage_sync(ctx, inode, page);
 528         if (error < 0 && IS_SWAPFILE(inode))
 529                 printk("Aiee.. nfs swap-in of page failed!\n");
 530 out:
 531         put_nfs_open_context(ctx);
 532         return error;
 533
 534 out_error:
 535         unlock_page(page);
 536         return error;
 537 }
 538
 539 struct nfs_readdesc {
 540         struct list_head *head;
 541         struct nfs_open_context *ctx;
 542 };
 543
 544 static int
 545 readpage_async_filler(void *data, struct page *page)
 546 {
 547         struct nfs_readdesc *desc = (struct nfs_readdesc *)data;
 548         struct inode *inode = page->mapping->host;
 549         struct nfs_page *new;
 550         unsigned int len;
 551
 552         nfs_wb_page(inode, page);
 553         len = nfs_page_length(inode, page);
 554         if (len == 0)
 555                 return nfs_return_empty_page(page);
 556         new = nfs_create_request(desc->ctx, inode, page, 0, len);
 557         if (IS_ERR(new)) {
 558                         SetPageError(page);
 559                         unlock_page(page);
 560                         return PTR_ERR(new);
 561         }
 562         if (len < PAGE_CACHE_SIZE)
 563                 memclear_highpage_flush(page, len, PAGE_CACHE_SIZE - len);
 564         nfs_list_add_request(new, desc->head);
 565         return 0;
 566 }
 567
 568 int nfs_readpages(struct file *filp, struct address_space *mapping,
 569                 struct list_head *pages, unsigned nr_pages)
 570 {
 571         LIST_HEAD(head);
 572         struct nfs_readdesc desc = {
 573                 .head           = &head,
 574         };
 575         struct inode *inode = mapping->host;
 576         struct nfs_server *server = NFS_SERVER(inode);
 577         int ret;
 578
 579         dprintk("NFS: nfs_readpages (%s/%Ld %d)\n",
 580                         inode->i_sb->s_id,
 581                         (long long)NFS_FILEID(inode),
 582                         nr_pages);
 583         nfs_inc_stats(inode, NFSIOS_VFSREADPAGES);
 584
 585         if (filp == NULL) {
 586                 desc.ctx = nfs_find_open_context(inode, NULL, FMODE_READ);
 587                 if (desc.ctx == NULL)
 588                         return -EBADF;
 589         } else
 590                 desc.ctx = get_nfs_open_context((struct nfs_open_context *)
 591                                 filp->private_data);
 592         ret = read_cache_pages(mapping, pages, readpage_async_filler, &desc);
 593         if (!list_empty(&head)) {
 594                 int err = nfs_pagein_list(&head, server->rpages);
 595                 if (!ret)
 596                         nfs_add_stats(inode, NFSIOS_READPAGES, err);
 597                         ret = err;
 598         }
 599         put_nfs_open_context(desc.ctx);
 600         return ret;
 601 }
 602
 603 int nfs_init_readpagecache(void)
 604 {
 605         nfs_rdata_cachep = kmem_cache_create("nfs_read_data",
 606                                              sizeof(struct nfs_read_data),
 607                                              0, SLAB_HWCACHE_ALIGN,
 608                                              NULL, NULL);
 609         if (nfs_rdata_cachep == NULL)
 610                 return -ENOMEM;
 611
 612         nfs_rdata_mempool = mempool_create(MIN_POOL_READ,
 613                                            mempool_alloc_slab,
 614                                            mempool_free_slab,
 615                                            nfs_rdata_cachep);
 616         if (nfs_rdata_mempool == NULL)
 617                 return -ENOMEM;
 618
 619         return 0;
 620 }
 621
 622 void nfs_destroy_readpagecache(void)
 623 {
 624         mempool_destroy(nfs_rdata_mempool);
 625         if (kmem_cache_destroy(nfs_rdata_cachep))
 626                 printk(KERN_INFO "nfs_read_data: not all structures were freed\n");
 627 }