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/export.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         struct blk_plug plug;
 113         unsigned page_idx;
 114         int ret;
 115
 116         blk_start_plug(&plug);
 117
 118         if (mapping->a_ops->readpages) {
 119                 ret = mapping->a_ops->readpages(filp, mapping, pages, nr_pages);
 120                 /* Clean up the remaining pages */
 121                 put_pages_list(pages);
 122                 goto out;
 123         }
 124
 125         for (page_idx = 0; page_idx < nr_pages; page_idx++) {
 126                 struct page *page = list_to_page(pages);
 127                 list_del(&page->lru);
 128                 if (!add_to_page_cache_lru(page, mapping,
 129                                         page->index, GFP_KERNEL)) {
 130                         mapping->a_ops->readpage(filp, page);
 131                 }
 132                 page_cache_release(page);
 133         }
 134         ret = 0;
 135
 136 out:
 137         blk_finish_plug(&plug);
 138
 139         return ret;
 140 }
 141
 142 /*
 143  * __do_page_cache_readahead() actually reads a chunk of disk.  It allocates all
 144  * the pages first, then submits them all for I/O. This avoids the very bad
 145  * behaviour which would occur if page allocations are causing VM writeback.
 146  * We really don't want to intermingle reads and writes like that.
 147  *
 148  * Returns the number of pages requested, or the maximum amount of I/O allowed.
 149  */
 150 static int
 151 __do_page_cache_readahead(struct address_space *mapping, struct file *filp,
 152                         pgoff_t offset, unsigned long nr_to_read,
 153                         unsigned long lookahead_size)
 154 {
 155         struct inode *inode = mapping->host;
 156         struct page *page;
 157         unsigned long end_index;        /* The last page we want to read */
 158         LIST_HEAD(page_pool);
 159         int page_idx;
 160         int ret = 0;
 161         loff_t isize = i_size_read(inode);
 162
 163         if (isize == 0)
 164                 goto out;
 165
 166         end_index = ((isize - 1) >> PAGE_CACHE_SHIFT);
 167
 168         /*
 169          * Preallocate as many pages as we will need.
 170          */
 171         for (page_idx = 0; page_idx < nr_to_read; page_idx++) {
 172                 pgoff_t page_offset = offset + page_idx;
 173
 174                 if (page_offset > end_index)
 175                         break;
 176
 177                 rcu_read_lock();
 178                 page = radix_tree_lookup(&mapping->page_tree, page_offset);
 179                 rcu_read_unlock();
 180                 if (page)
 181                         continue;
 182
 183                 page = page_cache_alloc_readahead(mapping);
 184                 if (!page)
 185                         break;
 186                 page->index = page_offset;
 187                 list_add(&page->lru, &page_pool);
 188                 if (page_idx == nr_to_read - lookahead_size)
 189                         SetPageReadahead(page);
 190                 SetPageReadaheadUnused(page);
 191                 ret++;
 192         }
 193
 194         /*
 195          * Now start the IO.  We ignore I/O errors - if the page is not
 196          * uptodate then the caller will launch readpage again, and
 197          * will then handle the error.
 198          */
 199         if (ret)
 200                 read_pages(mapping, filp, &page_pool, ret);
 201         BUG_ON(!list_empty(&page_pool));
 202 out:
 203         return ret;
 204 }
 205
 206 /*
 207  * Chunk the readahead into 2 megabyte units, so that we don't pin too much
 208  * memory at once.
 209  */
 210 int force_page_cache_readahead(struct address_space *mapping, struct file *filp,
 211                 pgoff_t offset, unsigned long nr_to_read)
 212 {
 213         int ret = 0;
 214
 215         if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages))
 216                 return -EINVAL;
 217
 218         nr_to_read = max_sane_readahead(nr_to_read);
 219         while (nr_to_read) {
 220                 int err;
 221
 222                 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_CACHE_SIZE;
 223
 224                 if (this_chunk > nr_to_read)
 225                         this_chunk = nr_to_read;
 226                 err = __do_page_cache_readahead(mapping, filp,
 227                                                 offset, this_chunk, 0);
 228                 if (err < 0) {
 229                         ret = err;
 230                         break;
 231                 }
 232                 ret += err;
 233                 offset += this_chunk;
 234                 nr_to_read -= this_chunk;
 235         }
 236         return ret;
 237 }
 238
 239 /*
 240  * Given a desired number of PAGE_CACHE_SIZE readahead pages, return a
 241  * sensible upper limit.
 242  */
 243 unsigned long max_sane_readahead(unsigned long nr)
 244 {
 245         return min(nr, (node_page_state(numa_node_id(), NR_INACTIVE_FILE)
 246                 + node_page_state(numa_node_id(), NR_FREE_PAGES)) / 2);
 247 }
 248
 249 /*
 250  * Submit IO for the read-ahead request in file_ra_state.
 251  */
 252 unsigned long ra_submit(struct file_ra_state *ra,
 253                        struct address_space *mapping, struct file *filp)
 254 {
 255         int actual;
 256
 257         actual = __do_page_cache_readahead(mapping, filp,
 258                                         ra->start, ra->size, ra->async_size);
 259
 260         return actual;
 261 }
 262
 263 /*
 264  * Set the initial window size, round to next power of 2 and square
 265  * for small size, x 4 for medium, and x 2 for large
 266  * for 128k (32 page) max ra
 267  * 1-8 page = 32k initial, > 8 page = 128k initial
 268  */
 269 static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
 270 {
 271         unsigned long newsize = roundup_pow_of_two(size);
 272
 273         if (newsize <= max / 32)
 274                 newsize = newsize * 4;
 275         else if (newsize <= max / 4)
 276                 newsize = newsize * 2;
 277         else
 278                 newsize = max;
 279
 280         return newsize;
 281 }
 282
 283 /*
 284  *  Get the previous window size, ramp it up, and
 285  *  return it as the new window size.
 286  */
 287 static unsigned long get_next_ra_size(struct file_ra_state *ra,
 288                                                 unsigned long max)
 289 {
 290         unsigned long cur = ra->size;
 291         unsigned long newsize;
 292
 293         if (cur < max / 16)
 294                 newsize = 4 * cur;
 295         else
 296                 newsize = 2 * cur;
 297
 298         return min(newsize, max);
 299 }
 300
 301 /*
 302  * On-demand readahead design.
 303  *
 304  * The fields in struct file_ra_state represent the most-recently-executed
 305  * readahead attempt:
 306  *
 307  *                        |<----- async_size ---------|
 308  *     |------------------- size -------------------->|
 309  *     |==================#===========================|
 310  *     ^start             ^page marked with PG_readahead
 311  *
 312  * To overlap application thinking time and disk I/O time, we do
 313  * `readahead pipelining': Do not wait until the application consumed all
 314  * readahead pages and stalled on the missing page at readahead_index;
 315  * Instead, submit an asynchronous readahead I/O as soon as there are
 316  * only async_size pages left in the readahead window. Normally async_size
 317  * will be equal to size, for maximum pipelining.
 318  *
 319  * In interleaved sequential reads, concurrent streams on the same fd can
 320  * be invalidating each other's readahead state. So we flag the new readahead
 321  * page at (start+size-async_size) with PG_readahead, and use it as readahead
 322  * indicator. The flag won't be set on already cached pages, to avoid the
 323  * readahead-for-nothing fuss, saving pointless page cache lookups.
 324  *
 325  * prev_pos tracks the last visited byte in the _previous_ read request.
 326  * It should be maintained by the caller, and will be used for detecting
 327  * small random reads. Note that the readahead algorithm checks loosely
 328  * for sequential patterns. Hence interleaved reads might be served as
 329  * sequential ones.
 330  *
 331  * There is a special-case: if the first page which the application tries to
 332  * read happens to be the first page of the file, it is assumed that a linear
 333  * read is about to happen and the window is immediately set to the initial size
 334  * based on I/O request size and the max_readahead.
 335  *
 336  * The code ramps up the readahead size aggressively at first, but slow down as
 337  * it approaches max_readhead.
 338  */
 339
 340 /*
 341  * Count contiguously cached pages from @offset-1 to @offset-@max,
 342  * this count is a conservative estimation of
 343  *      - length of the sequential read sequence, or
 344  *      - thrashing threshold in memory tight systems
 345  */
 346 static pgoff_t count_history_pages(struct address_space *mapping,
 347                                    struct file_ra_state *ra,
 348                                    pgoff_t offset, unsigned long max)
 349 {
 350         pgoff_t head;
 351
 352         rcu_read_lock();
 353         head = radix_tree_prev_hole(&mapping->page_tree, offset - 1, max);
 354         rcu_read_unlock();
 355
 356         return offset - 1 - head;
 357 }
 358
 359 /*
 360  * page cache context based read-ahead
 361  */
 362 static int try_context_readahead(struct address_space *mapping,
 363                                  struct file_ra_state *ra,
 364                                  pgoff_t offset,
 365                                  unsigned long req_size,
 366                                  unsigned long max)
 367 {
 368         pgoff_t size;
 369
 370         size = count_history_pages(mapping, ra, offset, max);
 371
 372         /*
 373          * no history pages:
 374          * it could be a random read
 375          */
 376         if (!size)
 377                 return 0;
 378
 379         /*
 380          * starts from beginning of file:
 381          * it is a strong indication of long-run stream (or whole-file-read)
 382          */
 383         if (size >= offset)
 384                 size *= 2;
 385
 386         ra->start = offset;
 387         ra->size = get_init_ra_size(size + req_size, max);
 388         ra->async_size = ra->size;
 389
 390         return 1;
 391 }
 392
 393 /*
 394  * A minimal readahead algorithm for trivial sequential/random reads.
 395  */
 396 static unsigned long
 397 ondemand_readahead(struct address_space *mapping,
 398                    struct file_ra_state *ra, struct file *filp,
 399                    bool hit_readahead_marker, pgoff_t offset,
 400                    unsigned long req_size)
 401 {
 402         unsigned long max = max_sane_readahead(ra->ra_pages);
 403
 404         /*
 405          * start of file
 406          */
 407         if (!offset)
 408                 goto initial_readahead;
 409
 410         /*
 411          * It's the expected callback offset, assume sequential access.
 412          * Ramp up sizes, and push forward the readahead window.
 413          */
 414         if ((offset == (ra->start + ra->size - ra->async_size) ||
 415              offset == (ra->start + ra->size))) {
 416                 ra->start += ra->size;
 417                 ra->size = get_next_ra_size(ra, max);
 418                 ra->async_size = ra->size;
 419                 goto readit;
 420         }
 421
 422         /*
 423          * Hit a marked page without valid readahead state.
 424          * E.g. interleaved reads.
 425          * Query the pagecache for async_size, which normally equals to
 426          * readahead size. Ramp it up and use it as the new readahead size.
 427          */
 428         if (hit_readahead_marker) {
 429                 pgoff_t start;
 430
 431                 rcu_read_lock();
 432                 start = radix_tree_next_hole(&mapping->page_tree, offset+1,max);
 433                 rcu_read_unlock();
 434
 435                 if (!start || start - offset > max)
 436                         return 0;
 437
 438                 ra->start = start;
 439                 ra->size = start - offset;      /* old async_size */
 440                 ra->size += req_size;
 441                 ra->size = get_next_ra_size(ra, max);
 442                 ra->async_size = ra->size;
 443                 goto readit;
 444         }
 445
 446         /*
 447          * oversize read
 448          */
 449         if (req_size > max)
 450                 goto initial_readahead;
 451
 452         /*
 453          * sequential cache miss
 454          */
 455         if (offset - (ra->prev_pos >> PAGE_CACHE_SHIFT) <= 1UL)
 456                 goto initial_readahead;
 457
 458         /*
 459          * Query the page cache and look for the traces(cached history pages)
 460          * that a sequential stream would leave behind.
 461          */
 462         if (try_context_readahead(mapping, ra, offset, req_size, max))
 463                 goto readit;
 464
 465         /*
 466          * standalone, small random read
 467          * Read as is, and do not pollute the readahead state.
 468          */
 469         return __do_page_cache_readahead(mapping, filp, offset, req_size, 0);
 470
 471 initial_readahead:
 472         ra->start = offset;
 473         ra->size = get_init_ra_size(req_size, max);
 474         ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
 475
 476 readit:
 477         /*
 478          * Will this read hit the readahead marker made by itself?
 479          * If so, trigger the readahead marker hit now, and merge
 480          * the resulted next readahead window into the current one.
 481          */
 482         if (offset == ra->start && ra->size == ra->async_size) {
 483                 ra->async_size = get_next_ra_size(ra, max);
 484                 ra->size += ra->async_size;
 485         }
 486
 487         return ra_submit(ra, mapping, filp);
 488 }
 489
 490 /**
 491  * page_cache_sync_readahead - generic file readahead
 492  * @mapping: address_space which holds the pagecache and I/O vectors
 493  * @ra: file_ra_state which holds the readahead state
 494  * @filp: passed on to ->readpage() and ->readpages()
 495  * @offset: start offset into @mapping, in pagecache page-sized units
 496  * @req_size: hint: total size of the read which the caller is performing in
 497  *            pagecache pages
 498  *
 499  * page_cache_sync_readahead() should be called when a cache miss happened:
 500  * it will submit the read.  The readahead logic may decide to piggyback more
 501  * pages onto the read request if access patterns suggest it will improve
 502  * performance.
 503  */
 504 void page_cache_sync_readahead(struct address_space *mapping,
 505                                struct file_ra_state *ra, struct file *filp,
 506                                pgoff_t offset, unsigned long req_size)
 507 {
 508         /* no read-ahead */
 509         if (!ra->ra_pages)
 510                 return;
 511
 512         /* be dumb */
 513         if (filp && (filp->f_mode & FMODE_RANDOM)) {
 514                 force_page_cache_readahead(mapping, filp, offset, req_size);
 515                 return;
 516         }
 517
 518         /* do read-ahead */
 519         ondemand_readahead(mapping, ra, filp, false, offset, req_size);
 520 }
 521 EXPORT_SYMBOL_GPL(page_cache_sync_readahead);
 522
 523 /**
 524  * page_cache_async_readahead - file readahead for marked pages
 525  * @mapping: address_space which holds the pagecache and I/O vectors
 526  * @ra: file_ra_state which holds the readahead state
 527  * @filp: passed on to ->readpage() and ->readpages()
 528  * @page: the page at @offset which has the PG_readahead flag set
 529  * @offset: start offset into @mapping, in pagecache page-sized units
 530  * @req_size: hint: total size of the read which the caller is performing in
 531  *            pagecache pages
 532  *
 533  * page_cache_async_readahead() should be called when a page is used which
 534  * has the PG_readahead flag; this is a marker to suggest that the application
 535  * has used up enough of the readahead window that we should start pulling in
 536  * more pages.
 537  */
 538 void
 539 page_cache_async_readahead(struct address_space *mapping,
 540                            struct file_ra_state *ra, struct file *filp,
 541                            struct page *page, pgoff_t offset,
 542                            unsigned long req_size)
 543 {
 544         /* no read-ahead */
 545         if (!ra->ra_pages)
 546                 return;
 547
 548         /*
 549          * Same bit is used for PG_readahead and PG_reclaim.
 550          */
 551         if (PageWriteback(page))
 552                 return;
 553
 554         ClearPageReadahead(page);
 555
 556         /*
 557          * Defer asynchronous read-ahead on IO congestion.
 558          */
 559         if (bdi_read_congested(mapping->backing_dev_info))
 560                 return;
 561
 562         /* do read-ahead */
 563         ondemand_readahead(mapping, ra, filp, true, offset, req_size);
 564 }
 565 EXPORT_SYMBOL_GPL(page_cache_async_readahead);