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