readahead: Use a folio in read_pages()
[linux-2.6-microblaze.git] / 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 /**
12  * DOC: Readahead Overview
13  *
14  * Readahead is used to read content into the page cache before it is
15  * explicitly requested by the application.  Readahead only ever
16  * attempts to read folios that are not yet in the page cache.  If a
17  * folio is present but not up-to-date, readahead will not try to read
18  * it. In that case a simple ->readpage() will be requested.
19  *
20  * Readahead is triggered when an application read request (whether a
21  * system call or a page fault) finds that the requested folio is not in
22  * the page cache, or that it is in the page cache and has the
23  * readahead flag set.  This flag indicates that the folio was read
24  * as part of a previous readahead request and now that it has been
25  * accessed, it is time for the next readahead.
26  *
27  * Each readahead request is partly synchronous read, and partly async
28  * readahead.  This is reflected in the struct file_ra_state which
29  * contains ->size being the total number of pages, and ->async_size
30  * which is the number of pages in the async section.  The readahead
31  * flag will be set on the first folio in this async section to trigger
32  * a subsequent readahead.  Once a series of sequential reads has been
33  * established, there should be no need for a synchronous component and
34  * all readahead request will be fully asynchronous.
35  *
36  * When either of the triggers causes a readahead, three numbers need
37  * to be determined: the start of the region to read, the size of the
38  * region, and the size of the async tail.
39  *
40  * The start of the region is simply the first page address at or after
41  * the accessed address, which is not currently populated in the page
42  * cache.  This is found with a simple search in the page cache.
43  *
44  * The size of the async tail is determined by subtracting the size that
45  * was explicitly requested from the determined request size, unless
46  * this would be less than zero - then zero is used.  NOTE THIS
47  * CALCULATION IS WRONG WHEN THE START OF THE REGION IS NOT THE ACCESSED
48  * PAGE.  ALSO THIS CALCULATION IS NOT USED CONSISTENTLY.
49  *
50  * The size of the region is normally determined from the size of the
51  * previous readahead which loaded the preceding pages.  This may be
52  * discovered from the struct file_ra_state for simple sequential reads,
53  * or from examining the state of the page cache when multiple
54  * sequential reads are interleaved.  Specifically: where the readahead
55  * was triggered by the readahead flag, the size of the previous
56  * readahead is assumed to be the number of pages from the triggering
57  * page to the start of the new readahead.  In these cases, the size of
58  * the previous readahead is scaled, often doubled, for the new
59  * readahead, though see get_next_ra_size() for details.
60  *
61  * If the size of the previous read cannot be determined, the number of
62  * preceding pages in the page cache is used to estimate the size of
63  * a previous read.  This estimate could easily be misled by random
64  * reads being coincidentally adjacent, so it is ignored unless it is
65  * larger than the current request, and it is not scaled up, unless it
66  * is at the start of file.
67  *
68  * In general readahead is accelerated at the start of the file, as
69  * reads from there are often sequential.  There are other minor
70  * adjustments to the readahead size in various special cases and these
71  * are best discovered by reading the code.
72  *
73  * The above calculation, based on the previous readahead size,
74  * determines the size of the readahead, to which any requested read
75  * size may be added.
76  *
77  * Readahead requests are sent to the filesystem using the ->readahead()
78  * address space operation, for which mpage_readahead() is a canonical
79  * implementation.  ->readahead() should normally initiate reads on all
80  * folios, but may fail to read any or all folios without causing an I/O
81  * error.  The page cache reading code will issue a ->readpage() request
82  * for any folio which ->readahead() did not read, and only an error
83  * from this will be final.
84  *
85  * ->readahead() will generally call readahead_folio() repeatedly to get
86  * each folio from those prepared for readahead.  It may fail to read a
87  * folio by:
88  *
89  * * not calling readahead_folio() sufficiently many times, effectively
90  *   ignoring some folios, as might be appropriate if the path to
91  *   storage is congested.
92  *
93  * * failing to actually submit a read request for a given folio,
94  *   possibly due to insufficient resources, or
95  *
96  * * getting an error during subsequent processing of a request.
97  *
98  * In the last two cases, the folio should be unlocked by the filesystem
99  * to indicate that the read attempt has failed.  In the first case the
100  * folio will be unlocked by the VFS.
101  *
102  * Those folios not in the final ``async_size`` of the request should be
103  * considered to be important and ->readahead() should not fail them due
104  * to congestion or temporary resource unavailability, but should wait
105  * for necessary resources (e.g.  memory or indexing information) to
106  * become available.  Folios in the final ``async_size`` may be
107  * considered less urgent and failure to read them is more acceptable.
108  * In this case it is best to use filemap_remove_folio() to remove the
109  * folios from the page cache as is automatically done for folios that
110  * were not fetched with readahead_folio().  This will allow a
111  * subsequent synchronous readahead request to try them again.  If they
112  * are left in the page cache, then they will be read individually using
113  * ->readpage() which may be less efficient.
114  */
115
116 #include <linux/kernel.h>
117 #include <linux/dax.h>
118 #include <linux/gfp.h>
119 #include <linux/export.h>
120 #include <linux/backing-dev.h>
121 #include <linux/task_io_accounting_ops.h>
122 #include <linux/pagevec.h>
123 #include <linux/pagemap.h>
124 #include <linux/syscalls.h>
125 #include <linux/file.h>
126 #include <linux/mm_inline.h>
127 #include <linux/blk-cgroup.h>
128 #include <linux/fadvise.h>
129 #include <linux/sched/mm.h>
130
131 #include "internal.h"
132
133 /*
134  * Initialise a struct file's readahead state.  Assumes that the caller has
135  * memset *ra to zero.
136  */
137 void
138 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
139 {
140         ra->ra_pages = inode_to_bdi(mapping->host)->ra_pages;
141         ra->prev_pos = -1;
142 }
143 EXPORT_SYMBOL_GPL(file_ra_state_init);
144
145 static void read_pages(struct readahead_control *rac)
146 {
147         const struct address_space_operations *aops = rac->mapping->a_ops;
148         struct folio *folio;
149         struct blk_plug plug;
150
151         if (!readahead_count(rac))
152                 return;
153
154         blk_start_plug(&plug);
155
156         if (aops->readahead) {
157                 aops->readahead(rac);
158                 /*
159                  * Clean up the remaining folios.  The sizes in ->ra
160                  * may be used to size the next readahead, so make sure
161                  * they accurately reflect what happened.
162                  */
163                 while ((folio = readahead_folio(rac)) != NULL) {
164                         unsigned long nr = folio_nr_pages(folio);
165
166                         rac->ra->size -= nr;
167                         if (rac->ra->async_size >= nr) {
168                                 rac->ra->async_size -= nr;
169                                 filemap_remove_folio(folio);
170                         }
171                         folio_unlock(folio);
172                 }
173         } else {
174                 while ((folio = readahead_folio(rac)))
175                         aops->readpage(rac->file, &folio->page);
176         }
177
178         blk_finish_plug(&plug);
179
180         BUG_ON(readahead_count(rac));
181 }
182
183 /**
184  * page_cache_ra_unbounded - Start unchecked readahead.
185  * @ractl: Readahead control.
186  * @nr_to_read: The number of pages to read.
187  * @lookahead_size: Where to start the next readahead.
188  *
189  * This function is for filesystems to call when they want to start
190  * readahead beyond a file's stated i_size.  This is almost certainly
191  * not the function you want to call.  Use page_cache_async_readahead()
192  * or page_cache_sync_readahead() instead.
193  *
194  * Context: File is referenced by caller.  Mutexes may be held by caller.
195  * May sleep, but will not reenter filesystem to reclaim memory.
196  */
197 void page_cache_ra_unbounded(struct readahead_control *ractl,
198                 unsigned long nr_to_read, unsigned long lookahead_size)
199 {
200         struct address_space *mapping = ractl->mapping;
201         unsigned long index = readahead_index(ractl);
202         gfp_t gfp_mask = readahead_gfp_mask(mapping);
203         unsigned long i;
204
205         /*
206          * Partway through the readahead operation, we will have added
207          * locked pages to the page cache, but will not yet have submitted
208          * them for I/O.  Adding another page may need to allocate memory,
209          * which can trigger memory reclaim.  Telling the VM we're in
210          * the middle of a filesystem operation will cause it to not
211          * touch file-backed pages, preventing a deadlock.  Most (all?)
212          * filesystems already specify __GFP_NOFS in their mapping's
213          * gfp_mask, but let's be explicit here.
214          */
215         unsigned int nofs = memalloc_nofs_save();
216
217         filemap_invalidate_lock_shared(mapping);
218         /*
219          * Preallocate as many pages as we will need.
220          */
221         for (i = 0; i < nr_to_read; i++) {
222                 struct folio *folio = xa_load(&mapping->i_pages, index + i);
223
224                 if (folio && !xa_is_value(folio)) {
225                         /*
226                          * Page already present?  Kick off the current batch
227                          * of contiguous pages before continuing with the
228                          * next batch.  This page may be the one we would
229                          * have intended to mark as Readahead, but we don't
230                          * have a stable reference to this page, and it's
231                          * not worth getting one just for that.
232                          */
233                         read_pages(ractl);
234                         ractl->_index++;
235                         i = ractl->_index + ractl->_nr_pages - index - 1;
236                         continue;
237                 }
238
239                 folio = filemap_alloc_folio(gfp_mask, 0);
240                 if (!folio)
241                         break;
242                 if (filemap_add_folio(mapping, folio, index + i,
243                                         gfp_mask) < 0) {
244                         folio_put(folio);
245                         read_pages(ractl);
246                         ractl->_index++;
247                         i = ractl->_index + ractl->_nr_pages - index - 1;
248                         continue;
249                 }
250                 if (i == nr_to_read - lookahead_size)
251                         folio_set_readahead(folio);
252                 ractl->_nr_pages++;
253         }
254
255         /*
256          * Now start the IO.  We ignore I/O errors - if the page is not
257          * uptodate then the caller will launch readpage again, and
258          * will then handle the error.
259          */
260         read_pages(ractl);
261         filemap_invalidate_unlock_shared(mapping);
262         memalloc_nofs_restore(nofs);
263 }
264 EXPORT_SYMBOL_GPL(page_cache_ra_unbounded);
265
266 /*
267  * do_page_cache_ra() actually reads a chunk of disk.  It allocates
268  * the pages first, then submits them for I/O. This avoids the very bad
269  * behaviour which would occur if page allocations are causing VM writeback.
270  * We really don't want to intermingle reads and writes like that.
271  */
272 static void do_page_cache_ra(struct readahead_control *ractl,
273                 unsigned long nr_to_read, unsigned long lookahead_size)
274 {
275         struct inode *inode = ractl->mapping->host;
276         unsigned long index = readahead_index(ractl);
277         loff_t isize = i_size_read(inode);
278         pgoff_t end_index;      /* The last page we want to read */
279
280         if (isize == 0)
281                 return;
282
283         end_index = (isize - 1) >> PAGE_SHIFT;
284         if (index > end_index)
285                 return;
286         /* Don't read past the page containing the last byte of the file */
287         if (nr_to_read > end_index - index)
288                 nr_to_read = end_index - index + 1;
289
290         page_cache_ra_unbounded(ractl, nr_to_read, lookahead_size);
291 }
292
293 /*
294  * Chunk the readahead into 2 megabyte units, so that we don't pin too much
295  * memory at once.
296  */
297 void force_page_cache_ra(struct readahead_control *ractl,
298                 unsigned long nr_to_read)
299 {
300         struct address_space *mapping = ractl->mapping;
301         struct file_ra_state *ra = ractl->ra;
302         struct backing_dev_info *bdi = inode_to_bdi(mapping->host);
303         unsigned long max_pages, index;
304
305         if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readahead))
306                 return;
307
308         /*
309          * If the request exceeds the readahead window, allow the read to
310          * be up to the optimal hardware IO size
311          */
312         index = readahead_index(ractl);
313         max_pages = max_t(unsigned long, bdi->io_pages, ra->ra_pages);
314         nr_to_read = min_t(unsigned long, nr_to_read, max_pages);
315         while (nr_to_read) {
316                 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_SIZE;
317
318                 if (this_chunk > nr_to_read)
319                         this_chunk = nr_to_read;
320                 ractl->_index = index;
321                 do_page_cache_ra(ractl, this_chunk, 0);
322
323                 index += this_chunk;
324                 nr_to_read -= this_chunk;
325         }
326 }
327
328 /*
329  * Set the initial window size, round to next power of 2 and square
330  * for small size, x 4 for medium, and x 2 for large
331  * for 128k (32 page) max ra
332  * 1-2 page = 16k, 3-4 page 32k, 5-8 page = 64k, > 8 page = 128k initial
333  */
334 static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
335 {
336         unsigned long newsize = roundup_pow_of_two(size);
337
338         if (newsize <= max / 32)
339                 newsize = newsize * 4;
340         else if (newsize <= max / 4)
341                 newsize = newsize * 2;
342         else
343                 newsize = max;
344
345         return newsize;
346 }
347
348 /*
349  *  Get the previous window size, ramp it up, and
350  *  return it as the new window size.
351  */
352 static unsigned long get_next_ra_size(struct file_ra_state *ra,
353                                       unsigned long max)
354 {
355         unsigned long cur = ra->size;
356
357         if (cur < max / 16)
358                 return 4 * cur;
359         if (cur <= max / 2)
360                 return 2 * cur;
361         return max;
362 }
363
364 /*
365  * On-demand readahead design.
366  *
367  * The fields in struct file_ra_state represent the most-recently-executed
368  * readahead attempt:
369  *
370  *                        |<----- async_size ---------|
371  *     |------------------- size -------------------->|
372  *     |==================#===========================|
373  *     ^start             ^page marked with PG_readahead
374  *
375  * To overlap application thinking time and disk I/O time, we do
376  * `readahead pipelining': Do not wait until the application consumed all
377  * readahead pages and stalled on the missing page at readahead_index;
378  * Instead, submit an asynchronous readahead I/O as soon as there are
379  * only async_size pages left in the readahead window. Normally async_size
380  * will be equal to size, for maximum pipelining.
381  *
382  * In interleaved sequential reads, concurrent streams on the same fd can
383  * be invalidating each other's readahead state. So we flag the new readahead
384  * page at (start+size-async_size) with PG_readahead, and use it as readahead
385  * indicator. The flag won't be set on already cached pages, to avoid the
386  * readahead-for-nothing fuss, saving pointless page cache lookups.
387  *
388  * prev_pos tracks the last visited byte in the _previous_ read request.
389  * It should be maintained by the caller, and will be used for detecting
390  * small random reads. Note that the readahead algorithm checks loosely
391  * for sequential patterns. Hence interleaved reads might be served as
392  * sequential ones.
393  *
394  * There is a special-case: if the first page which the application tries to
395  * read happens to be the first page of the file, it is assumed that a linear
396  * read is about to happen and the window is immediately set to the initial size
397  * based on I/O request size and the max_readahead.
398  *
399  * The code ramps up the readahead size aggressively at first, but slow down as
400  * it approaches max_readhead.
401  */
402
403 /*
404  * Count contiguously cached pages from @index-1 to @index-@max,
405  * this count is a conservative estimation of
406  *      - length of the sequential read sequence, or
407  *      - thrashing threshold in memory tight systems
408  */
409 static pgoff_t count_history_pages(struct address_space *mapping,
410                                    pgoff_t index, unsigned long max)
411 {
412         pgoff_t head;
413
414         rcu_read_lock();
415         head = page_cache_prev_miss(mapping, index - 1, max);
416         rcu_read_unlock();
417
418         return index - 1 - head;
419 }
420
421 /*
422  * page cache context based readahead
423  */
424 static int try_context_readahead(struct address_space *mapping,
425                                  struct file_ra_state *ra,
426                                  pgoff_t index,
427                                  unsigned long req_size,
428                                  unsigned long max)
429 {
430         pgoff_t size;
431
432         size = count_history_pages(mapping, index, max);
433
434         /*
435          * not enough history pages:
436          * it could be a random read
437          */
438         if (size <= req_size)
439                 return 0;
440
441         /*
442          * starts from beginning of file:
443          * it is a strong indication of long-run stream (or whole-file-read)
444          */
445         if (size >= index)
446                 size *= 2;
447
448         ra->start = index;
449         ra->size = min(size + req_size, max);
450         ra->async_size = 1;
451
452         return 1;
453 }
454
455 /*
456  * There are some parts of the kernel which assume that PMD entries
457  * are exactly HPAGE_PMD_ORDER.  Those should be fixed, but until then,
458  * limit the maximum allocation order to PMD size.  I'm not aware of any
459  * assumptions about maximum order if THP are disabled, but 8 seems like
460  * a good order (that's 1MB if you're using 4kB pages)
461  */
462 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
463 #define MAX_PAGECACHE_ORDER     HPAGE_PMD_ORDER
464 #else
465 #define MAX_PAGECACHE_ORDER     8
466 #endif
467
468 static inline int ra_alloc_folio(struct readahead_control *ractl, pgoff_t index,
469                 pgoff_t mark, unsigned int order, gfp_t gfp)
470 {
471         int err;
472         struct folio *folio = filemap_alloc_folio(gfp, order);
473
474         if (!folio)
475                 return -ENOMEM;
476         mark = round_up(mark, 1UL << order);
477         if (index == mark)
478                 folio_set_readahead(folio);
479         err = filemap_add_folio(ractl->mapping, folio, index, gfp);
480         if (err)
481                 folio_put(folio);
482         else
483                 ractl->_nr_pages += 1UL << order;
484         return err;
485 }
486
487 void page_cache_ra_order(struct readahead_control *ractl,
488                 struct file_ra_state *ra, unsigned int new_order)
489 {
490         struct address_space *mapping = ractl->mapping;
491         pgoff_t index = readahead_index(ractl);
492         pgoff_t limit = (i_size_read(mapping->host) - 1) >> PAGE_SHIFT;
493         pgoff_t mark = index + ra->size - ra->async_size;
494         int err = 0;
495         gfp_t gfp = readahead_gfp_mask(mapping);
496
497         if (!mapping_large_folio_support(mapping) || ra->size < 4)
498                 goto fallback;
499
500         limit = min(limit, index + ra->size - 1);
501
502         if (new_order < MAX_PAGECACHE_ORDER) {
503                 new_order += 2;
504                 if (new_order > MAX_PAGECACHE_ORDER)
505                         new_order = MAX_PAGECACHE_ORDER;
506                 while ((1 << new_order) > ra->size)
507                         new_order--;
508         }
509
510         while (index <= limit) {
511                 unsigned int order = new_order;
512
513                 /* Align with smaller pages if needed */
514                 if (index & ((1UL << order) - 1)) {
515                         order = __ffs(index);
516                         if (order == 1)
517                                 order = 0;
518                 }
519                 /* Don't allocate pages past EOF */
520                 while (index + (1UL << order) - 1 > limit) {
521                         if (--order == 1)
522                                 order = 0;
523                 }
524                 err = ra_alloc_folio(ractl, index, mark, order, gfp);
525                 if (err)
526                         break;
527                 index += 1UL << order;
528         }
529
530         if (index > limit) {
531                 ra->size += index - limit - 1;
532                 ra->async_size += index - limit - 1;
533         }
534
535         read_pages(ractl);
536
537         /*
538          * If there were already pages in the page cache, then we may have
539          * left some gaps.  Let the regular readahead code take care of this
540          * situation.
541          */
542         if (!err)
543                 return;
544 fallback:
545         do_page_cache_ra(ractl, ra->size, ra->async_size);
546 }
547
548 /*
549  * A minimal readahead algorithm for trivial sequential/random reads.
550  */
551 static void ondemand_readahead(struct readahead_control *ractl,
552                 struct folio *folio, unsigned long req_size)
553 {
554         struct backing_dev_info *bdi = inode_to_bdi(ractl->mapping->host);
555         struct file_ra_state *ra = ractl->ra;
556         unsigned long max_pages = ra->ra_pages;
557         unsigned long add_pages;
558         pgoff_t index = readahead_index(ractl);
559         pgoff_t expected, prev_index;
560         unsigned int order = folio ? folio_order(folio) : 0;
561
562         /*
563          * If the request exceeds the readahead window, allow the read to
564          * be up to the optimal hardware IO size
565          */
566         if (req_size > max_pages && bdi->io_pages > max_pages)
567                 max_pages = min(req_size, bdi->io_pages);
568
569         /*
570          * start of file
571          */
572         if (!index)
573                 goto initial_readahead;
574
575         /*
576          * It's the expected callback index, assume sequential access.
577          * Ramp up sizes, and push forward the readahead window.
578          */
579         expected = round_up(ra->start + ra->size - ra->async_size,
580                         1UL << order);
581         if (index == expected || index == (ra->start + ra->size)) {
582                 ra->start += ra->size;
583                 ra->size = get_next_ra_size(ra, max_pages);
584                 ra->async_size = ra->size;
585                 goto readit;
586         }
587
588         /*
589          * Hit a marked folio without valid readahead state.
590          * E.g. interleaved reads.
591          * Query the pagecache for async_size, which normally equals to
592          * readahead size. Ramp it up and use it as the new readahead size.
593          */
594         if (folio) {
595                 pgoff_t start;
596
597                 rcu_read_lock();
598                 start = page_cache_next_miss(ractl->mapping, index + 1,
599                                 max_pages);
600                 rcu_read_unlock();
601
602                 if (!start || start - index > max_pages)
603                         return;
604
605                 ra->start = start;
606                 ra->size = start - index;       /* old async_size */
607                 ra->size += req_size;
608                 ra->size = get_next_ra_size(ra, max_pages);
609                 ra->async_size = ra->size;
610                 goto readit;
611         }
612
613         /*
614          * oversize read
615          */
616         if (req_size > max_pages)
617                 goto initial_readahead;
618
619         /*
620          * sequential cache miss
621          * trivial case: (index - prev_index) == 1
622          * unaligned reads: (index - prev_index) == 0
623          */
624         prev_index = (unsigned long long)ra->prev_pos >> PAGE_SHIFT;
625         if (index - prev_index <= 1UL)
626                 goto initial_readahead;
627
628         /*
629          * Query the page cache and look for the traces(cached history pages)
630          * that a sequential stream would leave behind.
631          */
632         if (try_context_readahead(ractl->mapping, ra, index, req_size,
633                         max_pages))
634                 goto readit;
635
636         /*
637          * standalone, small random read
638          * Read as is, and do not pollute the readahead state.
639          */
640         do_page_cache_ra(ractl, req_size, 0);
641         return;
642
643 initial_readahead:
644         ra->start = index;
645         ra->size = get_init_ra_size(req_size, max_pages);
646         ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
647
648 readit:
649         /*
650          * Will this read hit the readahead marker made by itself?
651          * If so, trigger the readahead marker hit now, and merge
652          * the resulted next readahead window into the current one.
653          * Take care of maximum IO pages as above.
654          */
655         if (index == ra->start && ra->size == ra->async_size) {
656                 add_pages = get_next_ra_size(ra, max_pages);
657                 if (ra->size + add_pages <= max_pages) {
658                         ra->async_size = add_pages;
659                         ra->size += add_pages;
660                 } else {
661                         ra->size = max_pages;
662                         ra->async_size = max_pages >> 1;
663                 }
664         }
665
666         ractl->_index = ra->start;
667         page_cache_ra_order(ractl, ra, order);
668 }
669
670 void page_cache_sync_ra(struct readahead_control *ractl,
671                 unsigned long req_count)
672 {
673         bool do_forced_ra = ractl->file && (ractl->file->f_mode & FMODE_RANDOM);
674
675         /*
676          * Even if readahead is disabled, issue this request as readahead
677          * as we'll need it to satisfy the requested range. The forced
678          * readahead will do the right thing and limit the read to just the
679          * requested range, which we'll set to 1 page for this case.
680          */
681         if (!ractl->ra->ra_pages || blk_cgroup_congested()) {
682                 if (!ractl->file)
683                         return;
684                 req_count = 1;
685                 do_forced_ra = true;
686         }
687
688         /* be dumb */
689         if (do_forced_ra) {
690                 force_page_cache_ra(ractl, req_count);
691                 return;
692         }
693
694         ondemand_readahead(ractl, NULL, req_count);
695 }
696 EXPORT_SYMBOL_GPL(page_cache_sync_ra);
697
698 void page_cache_async_ra(struct readahead_control *ractl,
699                 struct folio *folio, unsigned long req_count)
700 {
701         /* no readahead */
702         if (!ractl->ra->ra_pages)
703                 return;
704
705         /*
706          * Same bit is used for PG_readahead and PG_reclaim.
707          */
708         if (folio_test_writeback(folio))
709                 return;
710
711         folio_clear_readahead(folio);
712
713         if (blk_cgroup_congested())
714                 return;
715
716         ondemand_readahead(ractl, folio, req_count);
717 }
718 EXPORT_SYMBOL_GPL(page_cache_async_ra);
719
720 ssize_t ksys_readahead(int fd, loff_t offset, size_t count)
721 {
722         ssize_t ret;
723         struct fd f;
724
725         ret = -EBADF;
726         f = fdget(fd);
727         if (!f.file || !(f.file->f_mode & FMODE_READ))
728                 goto out;
729
730         /*
731          * The readahead() syscall is intended to run only on files
732          * that can execute readahead. If readahead is not possible
733          * on this file, then we must return -EINVAL.
734          */
735         ret = -EINVAL;
736         if (!f.file->f_mapping || !f.file->f_mapping->a_ops ||
737             !S_ISREG(file_inode(f.file)->i_mode))
738                 goto out;
739
740         ret = vfs_fadvise(f.file, offset, count, POSIX_FADV_WILLNEED);
741 out:
742         fdput(f);
743         return ret;
744 }
745
746 SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
747 {
748         return ksys_readahead(fd, offset, count);
749 }
750
751 /**
752  * readahead_expand - Expand a readahead request
753  * @ractl: The request to be expanded
754  * @new_start: The revised start
755  * @new_len: The revised size of the request
756  *
757  * Attempt to expand a readahead request outwards from the current size to the
758  * specified size by inserting locked pages before and after the current window
759  * to increase the size to the new window.  This may involve the insertion of
760  * THPs, in which case the window may get expanded even beyond what was
761  * requested.
762  *
763  * The algorithm will stop if it encounters a conflicting page already in the
764  * pagecache and leave a smaller expansion than requested.
765  *
766  * The caller must check for this by examining the revised @ractl object for a
767  * different expansion than was requested.
768  */
769 void readahead_expand(struct readahead_control *ractl,
770                       loff_t new_start, size_t new_len)
771 {
772         struct address_space *mapping = ractl->mapping;
773         struct file_ra_state *ra = ractl->ra;
774         pgoff_t new_index, new_nr_pages;
775         gfp_t gfp_mask = readahead_gfp_mask(mapping);
776
777         new_index = new_start / PAGE_SIZE;
778
779         /* Expand the leading edge downwards */
780         while (ractl->_index > new_index) {
781                 unsigned long index = ractl->_index - 1;
782                 struct page *page = xa_load(&mapping->i_pages, index);
783
784                 if (page && !xa_is_value(page))
785                         return; /* Page apparently present */
786
787                 page = __page_cache_alloc(gfp_mask);
788                 if (!page)
789                         return;
790                 if (add_to_page_cache_lru(page, mapping, index, gfp_mask) < 0) {
791                         put_page(page);
792                         return;
793                 }
794
795                 ractl->_nr_pages++;
796                 ractl->_index = page->index;
797         }
798
799         new_len += new_start - readahead_pos(ractl);
800         new_nr_pages = DIV_ROUND_UP(new_len, PAGE_SIZE);
801
802         /* Expand the trailing edge upwards */
803         while (ractl->_nr_pages < new_nr_pages) {
804                 unsigned long index = ractl->_index + ractl->_nr_pages;
805                 struct page *page = xa_load(&mapping->i_pages, index);
806
807                 if (page && !xa_is_value(page))
808                         return; /* Page apparently present */
809
810                 page = __page_cache_alloc(gfp_mask);
811                 if (!page)
812                         return;
813                 if (add_to_page_cache_lru(page, mapping, index, gfp_mask) < 0) {
814                         put_page(page);
815                         return;
816                 }
817                 ractl->_nr_pages++;
818                 if (ra) {
819                         ra->size++;
820                         ra->async_size++;
821                 }
822         }
823 }
824 EXPORT_SYMBOL(readahead_expand);