mm/readahead.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * mm/readahead.c - address_space-level file readahead.
   4  *
   5  * Copyright (C) 2002, Linus Torvalds
   6  *
   7  * 09Apr2002    Andrew Morton
   8  *              Initial version.
   9  */
  10
  11 #include <linux/kernel.h>
  12 #include <linux/dax.h>
  13 #include <linux/gfp.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 #include <linux/syscalls.h>
  21 #include <linux/file.h>
  22 #include <linux/mm_inline.h>
  23 #include <linux/blk-cgroup.h>
  24 #include <linux/fadvise.h>
  25
  26 #include "internal.h"
  27
  28 /*
  29  * Initialise a struct file's readahead state.  Assumes that the caller has
  30  * memset *ra to zero.
  31  */
  32 void
  33 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
  34 {
  35         ra->ra_pages = inode_to_bdi(mapping->host)->ra_pages;
  36         ra->prev_pos = -1;
  37 }
  38 EXPORT_SYMBOL_GPL(file_ra_state_init);
  39
  40 /*
  41  * see if a page needs releasing upon read_cache_pages() failure
  42  * - the caller of read_cache_pages() may have set PG_private or PG_fscache
  43  *   before calling, such as the NFS fs marking pages that are cached locally
  44  *   on disk, thus we need to give the fs a chance to clean up in the event of
  45  *   an error
  46  */
  47 static void read_cache_pages_invalidate_page(struct address_space *mapping,
  48                                              struct page *page)
  49 {
  50         if (page_has_private(page)) {
  51                 if (!trylock_page(page))
  52                         BUG();
  53                 page->mapping = mapping;
  54                 do_invalidatepage(page, 0, PAGE_SIZE);
  55                 page->mapping = NULL;
  56                 unlock_page(page);
  57         }
  58         put_page(page);
  59 }
  60
  61 /*
  62  * release a list of pages, invalidating them first if need be
  63  */
  64 static void read_cache_pages_invalidate_pages(struct address_space *mapping,
  65                                               struct list_head *pages)
  66 {
  67         struct page *victim;
  68
  69         while (!list_empty(pages)) {
  70                 victim = lru_to_page(pages);
  71                 list_del(&victim->lru);
  72                 read_cache_pages_invalidate_page(mapping, victim);
  73         }
  74 }
  75
  76 /**
  77  * read_cache_pages - populate an address space with some pages & start reads against them
  78  * @mapping: the address_space
  79  * @pages: The address of a list_head which contains the target pages.  These
  80  *   pages have their ->index populated and are otherwise uninitialised.
  81  * @filler: callback routine for filling a single page.
  82  * @data: private data for the callback routine.
  83  *
  84  * Hides the details of the LRU cache etc from the filesystems.
  85  *
  86  * Returns: %0 on success, error return by @filler otherwise
  87  */
  88 int read_cache_pages(struct address_space *mapping, struct list_head *pages,
  89                         int (*filler)(void *, struct page *), void *data)
  90 {
  91         struct page *page;
  92         int ret = 0;
  93
  94         while (!list_empty(pages)) {
  95                 page = lru_to_page(pages);
  96                 list_del(&page->lru);
  97                 if (add_to_page_cache_lru(page, mapping, page->index,
  98                                 readahead_gfp_mask(mapping))) {
  99                         read_cache_pages_invalidate_page(mapping, page);
 100                         continue;
 101                 }
 102                 put_page(page);
 103
 104                 ret = filler(data, page);
 105                 if (unlikely(ret)) {
 106                         read_cache_pages_invalidate_pages(mapping, pages);
 107                         break;
 108                 }
 109                 task_io_account_read(PAGE_SIZE);
 110         }
 111         return ret;
 112 }
 113
 114 EXPORT_SYMBOL(read_cache_pages);
 115
 116 static void read_pages(struct readahead_control *rac, struct list_head *pages,
 117                 bool skip_page)
 118 {
 119         const struct address_space_operations *aops = rac->mapping->a_ops;
 120         struct page *page;
 121         struct blk_plug plug;
 122
 123         if (!readahead_count(rac))
 124                 goto out;
 125
 126         blk_start_plug(&plug);
 127
 128         if (aops->readahead) {
 129                 aops->readahead(rac);
 130                 /* Clean up the remaining pages */
 131                 while ((page = readahead_page(rac))) {
 132                         unlock_page(page);
 133                         put_page(page);
 134                 }
 135         } else if (aops->readpages) {
 136                 aops->readpages(rac->file, rac->mapping, pages,
 137                                 readahead_count(rac));
 138                 /* Clean up the remaining pages */
 139                 put_pages_list(pages);
 140                 rac->_index += rac->_nr_pages;
 141                 rac->_nr_pages = 0;
 142         } else {
 143                 while ((page = readahead_page(rac))) {
 144                         aops->readpage(rac->file, page);
 145                         put_page(page);
 146                 }
 147         }
 148
 149         blk_finish_plug(&plug);
 150
 151         BUG_ON(!list_empty(pages));
 152         BUG_ON(readahead_count(rac));
 153
 154 out:
 155         if (skip_page)
 156                 rac->_index++;
 157 }
 158
 159 /*
 160  * __do_page_cache_readahead() actually reads a chunk of disk.  It allocates
 161  * the pages first, then submits them for I/O. This avoids the very bad
 162  * behaviour which would occur if page allocations are causing VM writeback.
 163  * We really don't want to intermingle reads and writes like that.
 164  */
 165 void __do_page_cache_readahead(struct address_space *mapping,
 166                 struct file *filp, pgoff_t index, unsigned long nr_to_read,
 167                 unsigned long lookahead_size)
 168 {
 169         struct inode *inode = mapping->host;
 170         struct page *page;
 171         unsigned long end_index;        /* The last page we want to read */
 172         LIST_HEAD(page_pool);
 173         loff_t isize = i_size_read(inode);
 174         gfp_t gfp_mask = readahead_gfp_mask(mapping);
 175         struct readahead_control rac = {
 176                 .mapping = mapping,
 177                 .file = filp,
 178                 ._index = index,
 179         };
 180         unsigned long i;
 181
 182         if (isize == 0)
 183                 return;
 184
 185         end_index = ((isize - 1) >> PAGE_SHIFT);
 186
 187         /*
 188          * Preallocate as many pages as we will need.
 189          */
 190         for (i = 0; i < nr_to_read; i++) {
 191                 if (index + i > end_index)
 192                         break;
 193
 194                 BUG_ON(index + i != rac._index + rac._nr_pages);
 195
 196                 page = xa_load(&mapping->i_pages, index + i);
 197                 if (page && !xa_is_value(page)) {
 198                         /*
 199                          * Page already present?  Kick off the current batch of
 200                          * contiguous pages before continuing with the next
 201                          * batch.
 202                          */
 203                         read_pages(&rac, &page_pool, true);
 204                         continue;
 205                 }
 206
 207                 page = __page_cache_alloc(gfp_mask);
 208                 if (!page)
 209                         break;
 210                 if (mapping->a_ops->readpages) {
 211                         page->index = index + i;
 212                         list_add(&page->lru, &page_pool);
 213                 } else if (add_to_page_cache_lru(page, mapping, index + i,
 214                                         gfp_mask) < 0) {
 215                         put_page(page);
 216                         read_pages(&rac, &page_pool, true);
 217                         continue;
 218                 }
 219                 if (i == nr_to_read - lookahead_size)
 220                         SetPageReadahead(page);
 221                 rac._nr_pages++;
 222         }
 223
 224         /*
 225          * Now start the IO.  We ignore I/O errors - if the page is not
 226          * uptodate then the caller will launch readpage again, and
 227          * will then handle the error.
 228          */
 229         read_pages(&rac, &page_pool, false);
 230 }
 231
 232 /*
 233  * Chunk the readahead into 2 megabyte units, so that we don't pin too much
 234  * memory at once.
 235  */
 236 void force_page_cache_readahead(struct address_space *mapping,
 237                 struct file *filp, pgoff_t index, unsigned long nr_to_read)
 238 {
 239         struct backing_dev_info *bdi = inode_to_bdi(mapping->host);
 240         struct file_ra_state *ra = &filp->f_ra;
 241         unsigned long max_pages;
 242
 243         if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages &&
 244                         !mapping->a_ops->readahead))
 245                 return;
 246
 247         /*
 248          * If the request exceeds the readahead window, allow the read to
 249          * be up to the optimal hardware IO size
 250          */
 251         max_pages = max_t(unsigned long, bdi->io_pages, ra->ra_pages);
 252         nr_to_read = min(nr_to_read, max_pages);
 253         while (nr_to_read) {
 254                 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_SIZE;
 255
 256                 if (this_chunk > nr_to_read)
 257                         this_chunk = nr_to_read;
 258                 __do_page_cache_readahead(mapping, filp, index, this_chunk, 0);
 259
 260                 index += this_chunk;
 261                 nr_to_read -= this_chunk;
 262         }
 263 }
 264
 265 /*
 266  * Set the initial window size, round to next power of 2 and square
 267  * for small size, x 4 for medium, and x 2 for large
 268  * for 128k (32 page) max ra
 269  * 1-8 page = 32k initial, > 8 page = 128k initial
 270  */
 271 static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
 272 {
 273         unsigned long newsize = roundup_pow_of_two(size);
 274
 275         if (newsize <= max / 32)
 276                 newsize = newsize * 4;
 277         else if (newsize <= max / 4)
 278                 newsize = newsize * 2;
 279         else
 280                 newsize = max;
 281
 282         return newsize;
 283 }
 284
 285 /*
 286  *  Get the previous window size, ramp it up, and
 287  *  return it as the new window size.
 288  */
 289 static unsigned long get_next_ra_size(struct file_ra_state *ra,
 290                                       unsigned long max)
 291 {
 292         unsigned long cur = ra->size;
 293
 294         if (cur < max / 16)
 295                 return 4 * cur;
 296         if (cur <= max / 2)
 297                 return 2 * cur;
 298         return 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 @index-1 to @index-@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                                    pgoff_t index, unsigned long max)
 348 {
 349         pgoff_t head;
 350
 351         rcu_read_lock();
 352         head = page_cache_prev_miss(mapping, index - 1, max);
 353         rcu_read_unlock();
 354
 355         return index - 1 - head;
 356 }
 357
 358 /*
 359  * page cache context based read-ahead
 360  */
 361 static int try_context_readahead(struct address_space *mapping,
 362                                  struct file_ra_state *ra,
 363                                  pgoff_t index,
 364                                  unsigned long req_size,
 365                                  unsigned long max)
 366 {
 367         pgoff_t size;
 368
 369         size = count_history_pages(mapping, index, max);
 370
 371         /*
 372          * not enough history pages:
 373          * it could be a random read
 374          */
 375         if (size <= req_size)
 376                 return 0;
 377
 378         /*
 379          * starts from beginning of file:
 380          * it is a strong indication of long-run stream (or whole-file-read)
 381          */
 382         if (size >= index)
 383                 size *= 2;
 384
 385         ra->start = index;
 386         ra->size = min(size + req_size, max);
 387         ra->async_size = 1;
 388
 389         return 1;
 390 }
 391
 392 /*
 393  * A minimal readahead algorithm for trivial sequential/random reads.
 394  */
 395 static void ondemand_readahead(struct address_space *mapping,
 396                 struct file_ra_state *ra, struct file *filp,
 397                 bool hit_readahead_marker, pgoff_t index,
 398                 unsigned long req_size)
 399 {
 400         struct backing_dev_info *bdi = inode_to_bdi(mapping->host);
 401         unsigned long max_pages = ra->ra_pages;
 402         unsigned long add_pages;
 403         pgoff_t prev_index;
 404
 405         /*
 406          * If the request exceeds the readahead window, allow the read to
 407          * be up to the optimal hardware IO size
 408          */
 409         if (req_size > max_pages && bdi->io_pages > max_pages)
 410                 max_pages = min(req_size, bdi->io_pages);
 411
 412         /*
 413          * start of file
 414          */
 415         if (!index)
 416                 goto initial_readahead;
 417
 418         /*
 419          * It's the expected callback index, assume sequential access.
 420          * Ramp up sizes, and push forward the readahead window.
 421          */
 422         if ((index == (ra->start + ra->size - ra->async_size) ||
 423              index == (ra->start + ra->size))) {
 424                 ra->start += ra->size;
 425                 ra->size = get_next_ra_size(ra, max_pages);
 426                 ra->async_size = ra->size;
 427                 goto readit;
 428         }
 429
 430         /*
 431          * Hit a marked page without valid readahead state.
 432          * E.g. interleaved reads.
 433          * Query the pagecache for async_size, which normally equals to
 434          * readahead size. Ramp it up and use it as the new readahead size.
 435          */
 436         if (hit_readahead_marker) {
 437                 pgoff_t start;
 438
 439                 rcu_read_lock();
 440                 start = page_cache_next_miss(mapping, index + 1, max_pages);
 441                 rcu_read_unlock();
 442
 443                 if (!start || start - index > max_pages)
 444                         return;
 445
 446                 ra->start = start;
 447                 ra->size = start - index;       /* old async_size */
 448                 ra->size += req_size;
 449                 ra->size = get_next_ra_size(ra, max_pages);
 450                 ra->async_size = ra->size;
 451                 goto readit;
 452         }
 453
 454         /*
 455          * oversize read
 456          */
 457         if (req_size > max_pages)
 458                 goto initial_readahead;
 459
 460         /*
 461          * sequential cache miss
 462          * trivial case: (index - prev_index) == 1
 463          * unaligned reads: (index - prev_index) == 0
 464          */
 465         prev_index = (unsigned long long)ra->prev_pos >> PAGE_SHIFT;
 466         if (index - prev_index <= 1UL)
 467                 goto initial_readahead;
 468
 469         /*
 470          * Query the page cache and look for the traces(cached history pages)
 471          * that a sequential stream would leave behind.
 472          */
 473         if (try_context_readahead(mapping, ra, index, req_size, max_pages))
 474                 goto readit;
 475
 476         /*
 477          * standalone, small random read
 478          * Read as is, and do not pollute the readahead state.
 479          */
 480         __do_page_cache_readahead(mapping, filp, index, req_size, 0);
 481         return;
 482
 483 initial_readahead:
 484         ra->start = index;
 485         ra->size = get_init_ra_size(req_size, max_pages);
 486         ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
 487
 488 readit:
 489         /*
 490          * Will this read hit the readahead marker made by itself?
 491          * If so, trigger the readahead marker hit now, and merge
 492          * the resulted next readahead window into the current one.
 493          * Take care of maximum IO pages as above.
 494          */
 495         if (index == ra->start && ra->size == ra->async_size) {
 496                 add_pages = get_next_ra_size(ra, max_pages);
 497                 if (ra->size + add_pages <= max_pages) {
 498                         ra->async_size = add_pages;
 499                         ra->size += add_pages;
 500                 } else {
 501                         ra->size = max_pages;
 502                         ra->async_size = max_pages >> 1;
 503                 }
 504         }
 505
 506         ra_submit(ra, mapping, filp);
 507 }
 508
 509 /**
 510  * page_cache_sync_readahead - generic file readahead
 511  * @mapping: address_space which holds the pagecache and I/O vectors
 512  * @ra: file_ra_state which holds the readahead state
 513  * @filp: passed on to ->readpage() and ->readpages()
 514  * @index: Index of first page to be read.
 515  * @req_count: Total number of pages being read by the caller.
 516  *
 517  * page_cache_sync_readahead() should be called when a cache miss happened:
 518  * it will submit the read.  The readahead logic may decide to piggyback more
 519  * pages onto the read request if access patterns suggest it will improve
 520  * performance.
 521  */
 522 void page_cache_sync_readahead(struct address_space *mapping,
 523                                struct file_ra_state *ra, struct file *filp,
 524                                pgoff_t index, unsigned long req_count)
 525 {
 526         /* no read-ahead */
 527         if (!ra->ra_pages)
 528                 return;
 529
 530         if (blk_cgroup_congested())
 531                 return;
 532
 533         /* be dumb */
 534         if (filp && (filp->f_mode & FMODE_RANDOM)) {
 535                 force_page_cache_readahead(mapping, filp, index, req_count);
 536                 return;
 537         }
 538
 539         /* do read-ahead */
 540         ondemand_readahead(mapping, ra, filp, false, index, req_count);
 541 }
 542 EXPORT_SYMBOL_GPL(page_cache_sync_readahead);
 543
 544 /**
 545  * page_cache_async_readahead - file readahead for marked pages
 546  * @mapping: address_space which holds the pagecache and I/O vectors
 547  * @ra: file_ra_state which holds the readahead state
 548  * @filp: passed on to ->readpage() and ->readpages()
 549  * @page: The page at @index which triggered the readahead call.
 550  * @index: Index of first page to be read.
 551  * @req_count: Total number of pages being read by the caller.
 552  *
 553  * page_cache_async_readahead() should be called when a page is used which
 554  * is marked as PageReadahead; this is a marker to suggest that the application
 555  * has used up enough of the readahead window that we should start pulling in
 556  * more pages.
 557  */
 558 void
 559 page_cache_async_readahead(struct address_space *mapping,
 560                            struct file_ra_state *ra, struct file *filp,
 561                            struct page *page, pgoff_t index,
 562                            unsigned long req_count)
 563 {
 564         /* no read-ahead */
 565         if (!ra->ra_pages)
 566                 return;
 567
 568         /*
 569          * Same bit is used for PG_readahead and PG_reclaim.
 570          */
 571         if (PageWriteback(page))
 572                 return;
 573
 574         ClearPageReadahead(page);
 575
 576         /*
 577          * Defer asynchronous read-ahead on IO congestion.
 578          */
 579         if (inode_read_congested(mapping->host))
 580                 return;
 581
 582         if (blk_cgroup_congested())
 583                 return;
 584
 585         /* do read-ahead */
 586         ondemand_readahead(mapping, ra, filp, true, index, req_count);
 587 }
 588 EXPORT_SYMBOL_GPL(page_cache_async_readahead);
 589
 590 ssize_t ksys_readahead(int fd, loff_t offset, size_t count)
 591 {
 592         ssize_t ret;
 593         struct fd f;
 594
 595         ret = -EBADF;
 596         f = fdget(fd);
 597         if (!f.file || !(f.file->f_mode & FMODE_READ))
 598                 goto out;
 599
 600         /*
 601          * The readahead() syscall is intended to run only on files
 602          * that can execute readahead. If readahead is not possible
 603          * on this file, then we must return -EINVAL.
 604          */
 605         ret = -EINVAL;
 606         if (!f.file->f_mapping || !f.file->f_mapping->a_ops ||
 607             !S_ISREG(file_inode(f.file)->i_mode))
 608                 goto out;
 609
 610         ret = vfs_fadvise(f.file, offset, count, POSIX_FADV_WILLNEED);
 611 out:
 612         fdput(f);
 613         return ret;
 614 }
 615
 616 SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
 617 {
 618         return ksys_readahead(fd, offset, count);
 619 }