mm/readahead.c

   1 /*
   2  * mm/readahead.c - address_space-level file readahead.
   3  *
   4  * Copyright (C) 2002, Linus Torvalds
   5  *
   6  * 09Apr2002    Andrew Morton
   7  *              Initial version.
   8  */
   9
  10 #include <linux/kernel.h>
  11 #include <linux/fs.h>
  12 #include <linux/gfp.h>
  13 #include <linux/mm.h>
  14 #include <linux/module.h>
  15 #include <linux/blkdev.h>
  16 #include <linux/backing-dev.h>
  17 #include <linux/task_io_accounting_ops.h>
  18 #include <linux/pagevec.h>
  19 #include <linux/pagemap.h>
  20
  21 /*
  22  * Initialise a struct file's readahead state.  Assumes that the caller has
  23  * memset *ra to zero.
  24  */
  25 void
  26 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
  27 {
  28         ra->ra_pages = mapping->backing_dev_info->ra_pages;
  29         ra->prev_pos = -1;
  30 }
  31 EXPORT_SYMBOL_GPL(file_ra_state_init);
  32
  33 #define list_to_page(head) (list_entry((head)->prev, struct page, lru))
  34
  35 /*
  36  * see if a page needs releasing upon read_cache_pages() failure
  37  * - the caller of read_cache_pages() may have set PG_private or PG_fscache
  38  *   before calling, such as the NFS fs marking pages that are cached locally
  39  *   on disk, thus we need to give the fs a chance to clean up in the event of
  40  *   an error
  41  */
  42 static void read_cache_pages_invalidate_page(struct address_space *mapping,
  43                                              struct page *page)
  44 {
  45         if (page_has_private(page)) {
  46                 if (!trylock_page(page))
  47                         BUG();
  48                 page->mapping = mapping;
  49                 do_invalidatepage(page, 0);
  50                 page->mapping = NULL;
  51                 unlock_page(page);
  52         }
  53         page_cache_release(page);
  54 }
  55
  56 /*
  57  * release a list of pages, invalidating them first if need be
  58  */
  59 static void read_cache_pages_invalidate_pages(struct address_space *mapping,
  60                                               struct list_head *pages)
  61 {
  62         struct page *victim;
  63
  64         while (!list_empty(pages)) {
  65                 victim = list_to_page(pages);
  66                 list_del(&victim->lru);
  67                 read_cache_pages_invalidate_page(mapping, victim);
  68         }
  69 }
  70
  71 /**
  72  * read_cache_pages - populate an address space with some pages & start reads against them
  73  * @mapping: the address_space
  74  * @pages: The address of a list_head which contains the target pages.  These
  75  *   pages have their ->index populated and are otherwise uninitialised.
  76  * @filler: callback routine for filling a single page.
  77  * @data: private data for the callback routine.
  78  *
  79  * Hides the details of the LRU cache etc from the filesystems.
  80  */
  81 int read_cache_pages(struct address_space *mapping, struct list_head *pages,
  82                         int (*filler)(void *, struct page *), void *data)
  83 {
  84         struct page *page;
  85         int ret = 0;
  86
  87         while (!list_empty(pages)) {
  88                 page = list_to_page(pages);
  89                 list_del(&page->lru);
  90                 if (add_to_page_cache_lru(page, mapping,
  91                                         page->index, GFP_KERNEL)) {
  92                         read_cache_pages_invalidate_page(mapping, page);
  93                         continue;
  94                 }
  95                 page_cache_release(page);
  96
  97                 ret = filler(data, page);
  98                 if (unlikely(ret)) {
  99                         read_cache_pages_invalidate_pages(mapping, pages);
 100                         break;
 101                 }
 102                 task_io_account_read(PAGE_CACHE_SIZE);
 103         }
 104         return ret;
 105 }
 106
 107 EXPORT_SYMBOL(read_cache_pages);
 108
 109 static int read_pages(struct address_space *mapping, struct file *filp,
 110                 struct list_head *pages, unsigned nr_pages)
 111 {
 112         unsigned page_idx;
 113         int ret;
 114
 115         if (mapping->a_ops->readpages) {
 116                 ret = mapping->a_ops->readpages(filp, mapping, pages, nr_pages);
 117                 /* Clean up the remaining pages */
 118                 put_pages_list(pages);
 119                 goto out;
 120         }
 121
 122         for (page_idx = 0; page_idx < nr_pages; page_idx++) {
 123                 struct page *page = list_to_page(pages);
 124                 list_del(&page->lru);
 125                 if (!add_to_page_cache_lru(page, mapping,
 126                                         page->index, GFP_KERNEL)) {
 127                         mapping->a_ops->readpage(filp, page);
 128                 }
 129                 page_cache_release(page);
 130         }
 131         ret = 0;
 132 out:
 133         return ret;
 134 }
 135
 136 /*
 137  * __do_page_cache_readahead() actually reads a chunk of disk.  It allocates all
 138  * the pages first, then submits them all for I/O. This avoids the very bad
 139  * behaviour which would occur if page allocations are causing VM writeback.
 140  * We really don't want to intermingle reads and writes like that.
 141  *
 142  * Returns the number of pages requested, or the maximum amount of I/O allowed.
 143  */
 144 static int
 145 __do_page_cache_readahead(struct address_space *mapping, struct file *filp,
 146                         pgoff_t offset, unsigned long nr_to_read,
 147                         unsigned long lookahead_size)
 148 {
 149         struct inode *inode = mapping->host;
 150         struct page *page;
 151         unsigned long end_index;        /* The last page we want to read */
 152         LIST_HEAD(page_pool);
 153         int page_idx;
 154         int ret = 0;
 155         loff_t isize = i_size_read(inode);
 156
 157         if (isize == 0)
 158                 goto out;
 159
 160         end_index = ((isize - 1) >> PAGE_CACHE_SHIFT);
 161
 162         /*
 163          * Preallocate as many pages as we will need.
 164          */
 165         for (page_idx = 0; page_idx < nr_to_read; page_idx++) {
 166                 pgoff_t page_offset = offset + page_idx;
 167
 168                 if (page_offset > end_index)
 169                         break;
 170
 171                 rcu_read_lock();
 172                 page = radix_tree_lookup(&mapping->page_tree, page_offset);
 173                 rcu_read_unlock();
 174                 if (page)
 175                         continue;
 176
 177                 page = page_cache_alloc_cold(mapping);
 178                 if (!page)
 179                         break;
 180                 page->index = page_offset;
 181                 list_add(&page->lru, &page_pool);
 182                 if (page_idx == nr_to_read - lookahead_size)
 183                         SetPageReadahead(page);
 184                 SetPageReadaheadUnused(page);
 185                 ret++;
 186         }
 187
 188         /*
 189          * Now start the IO.  We ignore I/O errors - if the page is not
 190          * uptodate then the caller will launch readpage again, and
 191          * will then handle the error.
 192          */
 193         if (ret)
 194                 read_pages(mapping, filp, &page_pool, ret);
 195         BUG_ON(!list_empty(&page_pool));
 196 out:
 197         return ret;
 198 }
 199
 200 /*
 201  * Chunk the readahead into 2 megabyte units, so that we don't pin too much
 202  * memory at once.
 203  */
 204 int force_page_cache_readahead(struct address_space *mapping, struct file *filp,
 205                 pgoff_t offset, unsigned long nr_to_read)
 206 {
 207         int ret = 0;
 208
 209         if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages))
 210                 return -EINVAL;
 211
 212         nr_to_read = max_sane_readahead(nr_to_read);
 213         while (nr_to_read) {
 214                 int err;
 215
 216                 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_CACHE_SIZE;
 217
 218                 if (this_chunk > nr_to_read)
 219                         this_chunk = nr_to_read;
 220                 err = __do_page_cache_readahead(mapping, filp,
 221                                                 offset, this_chunk, 0);
 222                 if (err < 0) {
 223                         ret = err;
 224                         break;
 225                 }
 226                 ret += err;
 227                 offset += this_chunk;
 228                 nr_to_read -= this_chunk;
 229         }
 230         return ret;
 231 }
 232
 233 /*
 234  * Given a desired number of PAGE_CACHE_SIZE readahead pages, return a
 235  * sensible upper limit.
 236  */
 237 unsigned long max_sane_readahead(unsigned long nr)
 238 {
 239         return min(nr, (node_page_state(numa_node_id(), NR_INACTIVE_FILE)
 240                 + node_page_state(numa_node_id(), NR_FREE_PAGES)) / 2);
 241 }
 242
 243 /*
 244  * Submit IO for the read-ahead request in file_ra_state.
 245  */
 246 unsigned long ra_submit(struct file_ra_state *ra,
 247                        struct address_space *mapping, struct file *filp)
 248 {
 249         int actual;
 250
 251         actual = __do_page_cache_readahead(mapping, filp,
 252                                         ra->start, ra->size, ra->async_size);
 253
 254         return actual;
 255 }
 256
 257 /*
 258  * Set the initial window size, round to next power of 2 and square
 259  * for small size, x 4 for medium, and x 2 for large
 260  * for 128k (32 page) max ra
 261  * 1-8 page = 32k initial, > 8 page = 128k initial
 262  */
 263 static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
 264 {
 265         unsigned long newsize = roundup_pow_of_two(size);
 266
 267         if (newsize <= max / 32)
 268                 newsize = newsize * 4;
 269         else if (newsize <= max / 4)
 270                 newsize = newsize * 2;
 271         else
 272                 newsize = max;
 273
 274         return newsize;
 275 }
 276
 277 /*
 278  *  Get the previous window size, ramp it up, and
 279  *  return it as the new window size.
 280  */
 281 static unsigned long get_next_ra_size(struct file_ra_state *ra,
 282                                                 unsigned long max)
 283 {
 284         unsigned long cur = ra->size;
 285         unsigned long newsize;
 286
 287         if (cur < max / 16)
 288                 newsize = 4 * cur;
 289         else
 290                 newsize = 2 * cur;
 291
 292         return min(newsize, max);
 293 }
 294
 295 /*
 296  * On-demand readahead design.
 297  *
 298  * The fields in struct file_ra_state represent the most-recently-executed
 299  * readahead attempt:
 300  *
 301  *                        |<----- async_size ---------|
 302  *     |------------------- size -------------------->|
 303  *     |==================#===========================|
 304  *     ^start             ^page marked with PG_readahead
 305  *
 306  * To overlap application thinking time and disk I/O time, we do
 307  * `readahead pipelining': Do not wait until the application consumed all
 308  * readahead pages and stalled on the missing page at readahead_index;
 309  * Instead, submit an asynchronous readahead I/O as soon as there are
 310  * only async_size pages left in the readahead window. Normally async_size
 311  * will be equal to size, for maximum pipelining.
 312  *
 313  * In interleaved sequential reads, concurrent streams on the same fd can
 314  * be invalidating each other's readahead state. So we flag the new readahead
 315  * page at (start+size-async_size) with PG_readahead, and use it as readahead
 316  * indicator. The flag won't be set on already cached pages, to avoid the
 317  * readahead-for-nothing fuss, saving pointless page cache lookups.
 318  *
 319  * prev_pos tracks the last visited byte in the _previous_ read request.
 320  * It should be maintained by the caller, and will be used for detecting
 321  * small random reads. Note that the readahead algorithm checks loosely
 322  * for sequential patterns. Hence interleaved reads might be served as
 323  * sequential ones.
 324  *
 325  * There is a special-case: if the first page which the application tries to
 326  * read happens to be the first page of the file, it is assumed that a linear
 327  * read is about to happen and the window is immediately set to the initial size
 328  * based on I/O request size and the max_readahead.
 329  *
 330  * The code ramps up the readahead size aggressively at first, but slow down as
 331  * it approaches max_readhead.
 332  */
 333
 334 /*
 335  * Count contiguously cached pages from @offset-1 to @offset-@max,
 336  * this count is a conservative estimation of
 337  *      - length of the sequential read sequence, or
 338  *      - thrashing threshold in memory tight systems
 339  */
 340 static pgoff_t count_history_pages(struct address_space *mapping,
 341                                    struct file_ra_state *ra,
 342                                    pgoff_t offset, unsigned long max)
 343 {
 344         pgoff_t head;
 345
 346         rcu_read_lock();
 347         head = radix_tree_prev_hole(&mapping->page_tree, offset - 1, max);
 348         rcu_read_unlock();
 349
 350         return offset - 1 - head;
 351 }
 352
 353 /*
 354  * page cache context based read-ahead
 355  */
 356 static int try_context_readahead(struct address_space *mapping,
 357                                  struct file_ra_state *ra,
 358                                  pgoff_t offset,
 359                                  unsigned long req_size,
 360                                  unsigned long max)
 361 {
 362         pgoff_t size;
 363
 364         size = count_history_pages(mapping, ra, offset, max);
 365
 366         /*
 367          * no history pages:
 368          * it could be a random read
 369          */
 370         if (!size)
 371                 return 0;
 372
 373         /*
 374          * starts from beginning of file:
 375          * it is a strong indication of long-run stream (or whole-file-read)
 376          */
 377         if (size >= offset)
 378                 size *= 2;
 379
 380         ra->start = offset;
 381         ra->size = get_init_ra_size(size + req_size, max);
 382         ra->async_size = ra->size;
 383
 384         return 1;
 385 }
 386
 387 /*
 388  * A minimal readahead algorithm for trivial sequential/random reads.
 389  */
 390 static unsigned long
 391 ondemand_readahead(struct address_space *mapping,
 392                    struct file_ra_state *ra, struct file *filp,
 393                    bool hit_readahead_marker, pgoff_t offset,
 394                    unsigned long req_size)
 395 {
 396         unsigned long max = max_sane_readahead(ra->ra_pages);
 397
 398         /*
 399          * start of file
 400          */
 401         if (!offset)
 402                 goto initial_readahead;
 403
 404         /*
 405          * It's the expected callback offset, assume sequential access.
 406          * Ramp up sizes, and push forward the readahead window.
 407          */
 408         if ((offset == (ra->start + ra->size - ra->async_size) ||
 409              offset == (ra->start + ra->size))) {
 410                 ra->start += ra->size;
 411                 ra->size = get_next_ra_size(ra, max);
 412                 ra->async_size = ra->size;
 413                 goto readit;
 414         }
 415
 416         /*
 417          * Hit a marked page without valid readahead state.
 418          * E.g. interleaved reads.
 419          * Query the pagecache for async_size, which normally equals to
 420          * readahead size. Ramp it up and use it as the new readahead size.
 421          */
 422         if (hit_readahead_marker) {
 423                 pgoff_t start;
 424
 425                 rcu_read_lock();
 426                 start = radix_tree_next_hole(&mapping->page_tree, offset+1,max);
 427                 rcu_read_unlock();
 428
 429                 if (!start || start - offset > max)
 430                         return 0;
 431
 432                 ra->start = start;
 433                 ra->size = start - offset;      /* old async_size */
 434                 ra->size += req_size;
 435                 ra->size = get_next_ra_size(ra, max);
 436                 ra->async_size = ra->size;
 437                 goto readit;
 438         }
 439
 440         /*
 441          * oversize read
 442          */
 443         if (req_size > max)
 444                 goto initial_readahead;
 445
 446         /*
 447          * sequential cache miss
 448          */
 449         if (offset - (ra->prev_pos >> PAGE_CACHE_SHIFT) <= 1UL)
 450                 goto initial_readahead;
 451
 452         /*
 453          * Query the page cache and look for the traces(cached history pages)
 454          * that a sequential stream would leave behind.
 455          */
 456         if (try_context_readahead(mapping, ra, offset, req_size, max))
 457                 goto readit;
 458
 459         /*
 460          * standalone, small random read
 461          * Read as is, and do not pollute the readahead state.
 462          */
 463         return __do_page_cache_readahead(mapping, filp, offset, req_size, 0);
 464
 465 initial_readahead:
 466         ra->start = offset;
 467         ra->size = get_init_ra_size(req_size, max);
 468         ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
 469
 470 readit:
 471         /*
 472          * Will this read hit the readahead marker made by itself?
 473          * If so, trigger the readahead marker hit now, and merge
 474          * the resulted next readahead window into the current one.
 475          */
 476         if (offset == ra->start && ra->size == ra->async_size) {
 477                 ra->async_size = get_next_ra_size(ra, max);
 478                 ra->size += ra->async_size;
 479         }
 480
 481         return ra_submit(ra, mapping, filp);
 482 }
 483
 484 /**
 485  * page_cache_sync_readahead - generic file readahead
 486  * @mapping: address_space which holds the pagecache and I/O vectors
 487  * @ra: file_ra_state which holds the readahead state
 488  * @filp: passed on to ->readpage() and ->readpages()
 489  * @offset: start offset into @mapping, in pagecache page-sized units
 490  * @req_size: hint: total size of the read which the caller is performing in
 491  *            pagecache pages
 492  *
 493  * page_cache_sync_readahead() should be called when a cache miss happened:
 494  * it will submit the read.  The readahead logic may decide to piggyback more
 495  * pages onto the read request if access patterns suggest it will improve
 496  * performance.
 497  */
 498 void page_cache_sync_readahead(struct address_space *mapping,
 499                                struct file_ra_state *ra, struct file *filp,
 500                                pgoff_t offset, unsigned long req_size)
 501 {
 502         /* no read-ahead */
 503         if (!ra->ra_pages)
 504                 return;
 505
 506         /* be dumb */
 507         if (filp && (filp->f_mode & FMODE_RANDOM)) {
 508                 force_page_cache_readahead(mapping, filp, offset, req_size);
 509                 return;
 510         }
 511
 512         /* do read-ahead */
 513         ondemand_readahead(mapping, ra, filp, false, offset, req_size);
 514 }
 515 EXPORT_SYMBOL_GPL(page_cache_sync_readahead);
 516
 517 /**
 518  * page_cache_async_readahead - file readahead for marked pages
 519  * @mapping: address_space which holds the pagecache and I/O vectors
 520  * @ra: file_ra_state which holds the readahead state
 521  * @filp: passed on to ->readpage() and ->readpages()
 522  * @page: the page at @offset which has the PG_readahead flag set
 523  * @offset: start offset into @mapping, in pagecache page-sized units
 524  * @req_size: hint: total size of the read which the caller is performing in
 525  *            pagecache pages
 526  *
 527  * page_cache_async_readahead() should be called when a page is used which
 528  * has the PG_readahead flag; this is a marker to suggest that the application
 529  * has used up enough of the readahead window that we should start pulling in
 530  * more pages.
 531  */
 532 void
 533 page_cache_async_readahead(struct address_space *mapping,
 534                            struct file_ra_state *ra, struct file *filp,
 535                            struct page *page, pgoff_t offset,
 536                            unsigned long req_size)
 537 {
 538         /* no read-ahead */
 539         if (!ra->ra_pages)
 540                 return;
 541
 542         /*
 543          * Same bit is used for PG_readahead and PG_reclaim.
 544          */
 545         if (PageWriteback(page))
 546                 return;
 547
 548         ClearPageReadahead(page);
 549
 550         /*
 551          * Defer asynchronous read-ahead on IO congestion.
 552          */
 553         if (bdi_read_congested(mapping->backing_dev_info))
 554                 return;
 555
 556         /* do read-ahead */
 557         ondemand_readahead(mapping, ra, filp, true, offset, req_size);
 558
 559 #ifdef CONFIG_BLOCK
 560         /*
 561          * Normally the current page is !uptodate and lock_page() will be
 562          * immediately called to implicitly unplug the device. However this
 563          * is not always true for RAID conifgurations, where data arrives
 564          * not strictly in their submission order. In this case we need to
 565          * explicitly kick off the IO.
 566          */
 567         if (PageUptodate(page))
 568                 blk_run_backing_dev(mapping->backing_dev_info, NULL);
 569 #endif
 570 }
 571 EXPORT_SYMBOL_GPL(page_cache_async_readahead);