fs/afs/file.c

   1 /* AFS filesystem file handling
   2  *
   3  * Copyright (C) 2002, 2007 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells ([email protected])
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11
  12 #include <linux/kernel.h>
  13 #include <linux/module.h>
  14 #include <linux/init.h>
  15 #include <linux/fs.h>
  16 #include <linux/pagemap.h>
  17 #include <linux/writeback.h>
  18 #include <linux/gfp.h>
  19 #include <linux/task_io_accounting_ops.h>
  20 #include "internal.h"
  21
  22 static int afs_readpage(struct file *file, struct page *page);
  23 static void afs_invalidatepage(struct page *page, unsigned int offset,
  24                                unsigned int length);
  25 static int afs_releasepage(struct page *page, gfp_t gfp_flags);
  26 static int afs_launder_page(struct page *page);
  27
  28 static int afs_readpages(struct file *filp, struct address_space *mapping,
  29                          struct list_head *pages, unsigned nr_pages);
  30
  31 const struct file_operations afs_file_operations = {
  32         .open           = afs_open,
  33         .release        = afs_release,
  34         .llseek         = generic_file_llseek,
  35         .read_iter      = generic_file_read_iter,
  36         .write_iter     = afs_file_write,
  37         .mmap           = generic_file_readonly_mmap,
  38         .splice_read    = generic_file_splice_read,
  39         .fsync          = afs_fsync,
  40         .lock           = afs_lock,
  41         .flock          = afs_flock,
  42 };
  43
  44 const struct inode_operations afs_file_inode_operations = {
  45         .getattr        = afs_getattr,
  46         .setattr        = afs_setattr,
  47         .permission     = afs_permission,
  48 };
  49
  50 const struct address_space_operations afs_fs_aops = {
  51         .readpage       = afs_readpage,
  52         .readpages      = afs_readpages,
  53         .set_page_dirty = afs_set_page_dirty,
  54         .launder_page   = afs_launder_page,
  55         .releasepage    = afs_releasepage,
  56         .invalidatepage = afs_invalidatepage,
  57         .write_begin    = afs_write_begin,
  58         .write_end      = afs_write_end,
  59         .writepage      = afs_writepage,
  60         .writepages     = afs_writepages,
  61 };
  62
  63 /*
  64  * open an AFS file or directory and attach a key to it
  65  */
  66 int afs_open(struct inode *inode, struct file *file)
  67 {
  68         struct afs_vnode *vnode = AFS_FS_I(inode);
  69         struct key *key;
  70         int ret;
  71
  72         _enter("{%x:%u},", vnode->fid.vid, vnode->fid.vnode);
  73
  74         key = afs_request_key(vnode->volume->cell);
  75         if (IS_ERR(key)) {
  76                 _leave(" = %ld [key]", PTR_ERR(key));
  77                 return PTR_ERR(key);
  78         }
  79
  80         ret = afs_validate(vnode, key);
  81         if (ret < 0) {
  82                 _leave(" = %d [val]", ret);
  83                 return ret;
  84         }
  85
  86         file->private_data = key;
  87         _leave(" = 0");
  88         return 0;
  89 }
  90
  91 /*
  92  * release an AFS file or directory and discard its key
  93  */
  94 int afs_release(struct inode *inode, struct file *file)
  95 {
  96         struct afs_vnode *vnode = AFS_FS_I(inode);
  97
  98         _enter("{%x:%u},", vnode->fid.vid, vnode->fid.vnode);
  99
 100         key_put(file->private_data);
 101         _leave(" = 0");
 102         return 0;
 103 }
 104
 105 /*
 106  * Dispose of a ref to a read record.
 107  */
 108 void afs_put_read(struct afs_read *req)
 109 {
 110         int i;
 111
 112         if (atomic_dec_and_test(&req->usage)) {
 113                 for (i = 0; i < req->nr_pages; i++)
 114                         if (req->pages[i])
 115                                 put_page(req->pages[i]);
 116                 kfree(req);
 117         }
 118 }
 119
 120 #ifdef CONFIG_AFS_FSCACHE
 121 /*
 122  * deal with notification that a page was read from the cache
 123  */
 124 static void afs_file_readpage_read_complete(struct page *page,
 125                                             void *data,
 126                                             int error)
 127 {
 128         _enter("%p,%p,%d", page, data, error);
 129
 130         /* if the read completes with an error, we just unlock the page and let
 131          * the VM reissue the readpage */
 132         if (!error)
 133                 SetPageUptodate(page);
 134         unlock_page(page);
 135 }
 136 #endif
 137
 138 /*
 139  * read page from file, directory or symlink, given a key to use
 140  */
 141 int afs_page_filler(void *data, struct page *page)
 142 {
 143         struct inode *inode = page->mapping->host;
 144         struct afs_vnode *vnode = AFS_FS_I(inode);
 145         struct afs_read *req;
 146         struct key *key = data;
 147         int ret;
 148
 149         _enter("{%x},{%lu},{%lu}", key_serial(key), inode->i_ino, page->index);
 150
 151         BUG_ON(!PageLocked(page));
 152
 153         ret = -ESTALE;
 154         if (test_bit(AFS_VNODE_DELETED, &vnode->flags))
 155                 goto error;
 156
 157         /* is it cached? */
 158 #ifdef CONFIG_AFS_FSCACHE
 159         ret = fscache_read_or_alloc_page(vnode->cache,
 160                                          page,
 161                                          afs_file_readpage_read_complete,
 162                                          NULL,
 163                                          GFP_KERNEL);
 164 #else
 165         ret = -ENOBUFS;
 166 #endif
 167         switch (ret) {
 168                 /* read BIO submitted (page in cache) */
 169         case 0:
 170                 break;
 171
 172                 /* page not yet cached */
 173         case -ENODATA:
 174                 _debug("cache said ENODATA");
 175                 goto go_on;
 176
 177                 /* page will not be cached */
 178         case -ENOBUFS:
 179                 _debug("cache said ENOBUFS");
 180         default:
 181         go_on:
 182                 req = kzalloc(sizeof(struct afs_read) + sizeof(struct page *),
 183                               GFP_KERNEL);
 184                 if (!req)
 185                         goto enomem;
 186
 187                 atomic_set(&req->usage, 1);
 188                 req->pos = (loff_t)page->index << PAGE_SHIFT;
 189                 req->len = min_t(size_t, i_size_read(inode) - req->pos,
 190                                  PAGE_SIZE);
 191                 req->nr_pages = 1;
 192                 req->pages[0] = page;
 193                 get_page(page);
 194
 195                 /* read the contents of the file from the server into the
 196                  * page */
 197                 ret = afs_vnode_fetch_data(vnode, key, req);
 198                 afs_put_read(req);
 199                 if (ret < 0) {
 200                         if (ret == -ENOENT) {
 201                                 _debug("got NOENT from server"
 202                                        " - marking file deleted and stale");
 203                                 set_bit(AFS_VNODE_DELETED, &vnode->flags);
 204                                 ret = -ESTALE;
 205                         }
 206
 207 #ifdef CONFIG_AFS_FSCACHE
 208                         fscache_uncache_page(vnode->cache, page);
 209 #endif
 210                         BUG_ON(PageFsCache(page));
 211                         goto error;
 212                 }
 213
 214                 SetPageUptodate(page);
 215
 216                 /* send the page to the cache */
 217 #ifdef CONFIG_AFS_FSCACHE
 218                 if (PageFsCache(page) &&
 219                     fscache_write_page(vnode->cache, page, GFP_KERNEL) != 0) {
 220                         fscache_uncache_page(vnode->cache, page);
 221                         BUG_ON(PageFsCache(page));
 222                 }
 223 #endif
 224                 unlock_page(page);
 225         }
 226
 227         _leave(" = 0");
 228         return 0;
 229
 230 enomem:
 231         ret = -ENOMEM;
 232 error:
 233         SetPageError(page);
 234         unlock_page(page);
 235         _leave(" = %d", ret);
 236         return ret;
 237 }
 238
 239 /*
 240  * read page from file, directory or symlink, given a file to nominate the key
 241  * to be used
 242  */
 243 static int afs_readpage(struct file *file, struct page *page)
 244 {
 245         struct key *key;
 246         int ret;
 247
 248         if (file) {
 249                 key = file->private_data;
 250                 ASSERT(key != NULL);
 251                 ret = afs_page_filler(key, page);
 252         } else {
 253                 struct inode *inode = page->mapping->host;
 254                 key = afs_request_key(AFS_FS_S(inode->i_sb)->volume->cell);
 255                 if (IS_ERR(key)) {
 256                         ret = PTR_ERR(key);
 257                 } else {
 258                         ret = afs_page_filler(key, page);
 259                         key_put(key);
 260                 }
 261         }
 262         return ret;
 263 }
 264
 265 /*
 266  * Make pages available as they're filled.
 267  */
 268 static void afs_readpages_page_done(struct afs_call *call, struct afs_read *req)
 269 {
 270         struct afs_vnode *vnode = call->reply;
 271         struct page *page = req->pages[req->index];
 272
 273         req->pages[req->index] = NULL;
 274         SetPageUptodate(page);
 275
 276         /* send the page to the cache */
 277 #ifdef CONFIG_AFS_FSCACHE
 278         if (PageFsCache(page) &&
 279             fscache_write_page(vnode->cache, page, GFP_KERNEL) != 0) {
 280                 fscache_uncache_page(vnode->cache, page);
 281                 BUG_ON(PageFsCache(page));
 282         }
 283 #endif
 284         unlock_page(page);
 285         put_page(page);
 286 }
 287
 288 /*
 289  * Read a contiguous set of pages.
 290  */
 291 static int afs_readpages_one(struct file *file, struct address_space *mapping,
 292                              struct list_head *pages)
 293 {
 294         struct afs_vnode *vnode = AFS_FS_I(mapping->host);
 295         struct afs_read *req;
 296         struct list_head *p;
 297         struct page *first, *page;
 298         struct key *key = file->private_data;
 299         pgoff_t index;
 300         int ret, n, i;
 301
 302         /* Count the number of contiguous pages at the front of the list.  Note
 303          * that the list goes prev-wards rather than next-wards.
 304          */
 305         first = list_entry(pages->prev, struct page, lru);
 306         index = first->index + 1;
 307         n = 1;
 308         for (p = first->lru.prev; p != pages; p = p->prev) {
 309                 page = list_entry(p, struct page, lru);
 310                 if (page->index != index)
 311                         break;
 312                 index++;
 313                 n++;
 314         }
 315
 316         req = kzalloc(sizeof(struct afs_read) + sizeof(struct page *) * n,
 317                       GFP_NOFS);
 318         if (!req)
 319                 return -ENOMEM;
 320
 321         atomic_set(&req->usage, 1);
 322         req->page_done = afs_readpages_page_done;
 323         req->pos = first->index;
 324         req->pos <<= PAGE_SHIFT;
 325
 326         /* Transfer the pages to the request.  We add them in until one fails
 327          * to add to the LRU and then we stop (as that'll make a hole in the
 328          * contiguous run.
 329          *
 330          * Note that it's possible for the file size to change whilst we're
 331          * doing this, but we rely on the server returning less than we asked
 332          * for if the file shrank.  We also rely on this to deal with a partial
 333          * page at the end of the file.
 334          */
 335         do {
 336                 page = list_entry(pages->prev, struct page, lru);
 337                 list_del(&page->lru);
 338                 index = page->index;
 339                 if (add_to_page_cache_lru(page, mapping, index,
 340                                           readahead_gfp_mask(mapping))) {
 341 #ifdef CONFIG_AFS_FSCACHE
 342                         fscache_uncache_page(vnode->cache, page);
 343 #endif
 344                         put_page(page);
 345                         break;
 346                 }
 347
 348                 req->pages[req->nr_pages++] = page;
 349                 req->len += PAGE_SIZE;
 350         } while (req->nr_pages < n);
 351
 352         if (req->nr_pages == 0) {
 353                 kfree(req);
 354                 return 0;
 355         }
 356
 357         ret = afs_vnode_fetch_data(vnode, key, req);
 358         if (ret < 0)
 359                 goto error;
 360
 361         task_io_account_read(PAGE_SIZE * req->nr_pages);
 362         afs_put_read(req);
 363         return 0;
 364
 365 error:
 366         if (ret == -ENOENT) {
 367                 _debug("got NOENT from server"
 368                        " - marking file deleted and stale");
 369                 set_bit(AFS_VNODE_DELETED, &vnode->flags);
 370                 ret = -ESTALE;
 371         }
 372
 373         for (i = 0; i < req->nr_pages; i++) {
 374                 page = req->pages[i];
 375                 if (page) {
 376 #ifdef CONFIG_AFS_FSCACHE
 377                         fscache_uncache_page(vnode->cache, page);
 378 #endif
 379                         SetPageError(page);
 380                         unlock_page(page);
 381                 }
 382         }
 383
 384         afs_put_read(req);
 385         return ret;
 386 }
 387
 388 /*
 389  * read a set of pages
 390  */
 391 static int afs_readpages(struct file *file, struct address_space *mapping,
 392                          struct list_head *pages, unsigned nr_pages)
 393 {
 394         struct key *key = file->private_data;
 395         struct afs_vnode *vnode;
 396         int ret = 0;
 397
 398         _enter("{%d},{%lu},,%d",
 399                key_serial(key), mapping->host->i_ino, nr_pages);
 400
 401         ASSERT(key != NULL);
 402
 403         vnode = AFS_FS_I(mapping->host);
 404         if (test_bit(AFS_VNODE_DELETED, &vnode->flags)) {
 405                 _leave(" = -ESTALE");
 406                 return -ESTALE;
 407         }
 408
 409         /* attempt to read as many of the pages as possible */
 410 #ifdef CONFIG_AFS_FSCACHE
 411         ret = fscache_read_or_alloc_pages(vnode->cache,
 412                                           mapping,
 413                                           pages,
 414                                           &nr_pages,
 415                                           afs_file_readpage_read_complete,
 416                                           NULL,
 417                                           mapping_gfp_mask(mapping));
 418 #else
 419         ret = -ENOBUFS;
 420 #endif
 421
 422         switch (ret) {
 423                 /* all pages are being read from the cache */
 424         case 0:
 425                 BUG_ON(!list_empty(pages));
 426                 BUG_ON(nr_pages != 0);
 427                 _leave(" = 0 [reading all]");
 428                 return 0;
 429
 430                 /* there were pages that couldn't be read from the cache */
 431         case -ENODATA:
 432         case -ENOBUFS:
 433                 break;
 434
 435                 /* other error */
 436         default:
 437                 _leave(" = %d", ret);
 438                 return ret;
 439         }
 440
 441         while (!list_empty(pages)) {
 442                 ret = afs_readpages_one(file, mapping, pages);
 443                 if (ret < 0)
 444                         break;
 445         }
 446
 447         _leave(" = %d [netting]", ret);
 448         return ret;
 449 }
 450
 451 /*
 452  * write back a dirty page
 453  */
 454 static int afs_launder_page(struct page *page)
 455 {
 456         _enter("{%lu}", page->index);
 457
 458         return 0;
 459 }
 460
 461 /*
 462  * invalidate part or all of a page
 463  * - release a page and clean up its private data if offset is 0 (indicating
 464  *   the entire page)
 465  */
 466 static void afs_invalidatepage(struct page *page, unsigned int offset,
 467                                unsigned int length)
 468 {
 469         struct afs_writeback *wb = (struct afs_writeback *) page_private(page);
 470
 471         _enter("{%lu},%u,%u", page->index, offset, length);
 472
 473         BUG_ON(!PageLocked(page));
 474
 475         /* we clean up only if the entire page is being invalidated */
 476         if (offset == 0 && length == PAGE_SIZE) {
 477 #ifdef CONFIG_AFS_FSCACHE
 478                 if (PageFsCache(page)) {
 479                         struct afs_vnode *vnode = AFS_FS_I(page->mapping->host);
 480                         fscache_wait_on_page_write(vnode->cache, page);
 481                         fscache_uncache_page(vnode->cache, page);
 482                 }
 483 #endif
 484
 485                 if (PagePrivate(page)) {
 486                         if (wb && !PageWriteback(page)) {
 487                                 set_page_private(page, 0);
 488                                 afs_put_writeback(wb);
 489                         }
 490
 491                         if (!page_private(page))
 492                                 ClearPagePrivate(page);
 493                 }
 494         }
 495
 496         _leave("");
 497 }
 498
 499 /*
 500  * release a page and clean up its private state if it's not busy
 501  * - return true if the page can now be released, false if not
 502  */
 503 static int afs_releasepage(struct page *page, gfp_t gfp_flags)
 504 {
 505         struct afs_writeback *wb = (struct afs_writeback *) page_private(page);
 506         struct afs_vnode *vnode = AFS_FS_I(page->mapping->host);
 507
 508         _enter("{{%x:%u}[%lu],%lx},%x",
 509                vnode->fid.vid, vnode->fid.vnode, page->index, page->flags,
 510                gfp_flags);
 511
 512         /* deny if page is being written to the cache and the caller hasn't
 513          * elected to wait */
 514 #ifdef CONFIG_AFS_FSCACHE
 515         if (!fscache_maybe_release_page(vnode->cache, page, gfp_flags)) {
 516                 _leave(" = F [cache busy]");
 517                 return 0;
 518         }
 519 #endif
 520
 521         if (PagePrivate(page)) {
 522                 if (wb) {
 523                         set_page_private(page, 0);
 524                         afs_put_writeback(wb);
 525                 }
 526                 ClearPagePrivate(page);
 527         }
 528
 529         /* indicate that the page can be released */
 530         _leave(" = T");
 531         return 1;
 532 }