xref: /linux/mm/readahead.c (revision 60bee40e30d047356a118bd637ba4960baadcd46)
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 ->read_folio() 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 ->read_folio() 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  * ->read_folio() which may be less efficient.
114  */
115 
116 #include <linux/blkdev.h>
117 #include <linux/kernel.h>
118 #include <linux/dax.h>
119 #include <linux/gfp.h>
120 #include <linux/export.h>
121 #include <linux/backing-dev.h>
122 #include <linux/task_io_accounting_ops.h>
123 #include <linux/pagemap.h>
124 #include <linux/psi.h>
125 #include <linux/syscalls.h>
126 #include <linux/file.h>
127 #include <linux/mm_inline.h>
128 #include <linux/blk-cgroup.h>
129 #include <linux/fadvise.h>
130 #include <linux/sched/mm.h>
131 
132 #define CREATE_TRACE_POINTS
133 #include <trace/events/readahead.h>
134 
135 #include "internal.h"
136 
137 /*
138  * Initialise a struct file's readahead state.  Assumes that the caller has
139  * memset *ra to zero.
140  */
141 void
142 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
143 {
144 	ra->ra_pages = inode_to_bdi(mapping->host)->ra_pages;
145 	ra->prev_pos = -1;
146 }
147 EXPORT_SYMBOL_GPL(file_ra_state_init);
148 
149 static void read_pages(struct readahead_control *rac)
150 {
151 	const struct address_space_operations *aops = rac->mapping->a_ops;
152 	struct folio *folio;
153 	struct blk_plug plug;
154 
155 	if (!readahead_count(rac))
156 		return;
157 
158 	if (unlikely(rac->_workingset))
159 		psi_memstall_enter(&rac->_pflags);
160 	blk_start_plug(&plug);
161 
162 	if (aops->readahead) {
163 		aops->readahead(rac);
164 		/* Clean up the remaining folios. */
165 		while ((folio = readahead_folio(rac)) != NULL) {
166 			folio_get(folio);
167 			filemap_remove_folio(folio);
168 			folio_unlock(folio);
169 			folio_put(folio);
170 		}
171 	} else {
172 		while ((folio = readahead_folio(rac)) != NULL)
173 			aops->read_folio(rac->file, folio);
174 	}
175 
176 	blk_finish_plug(&plug);
177 	if (unlikely(rac->_workingset))
178 		psi_memstall_leave(&rac->_pflags);
179 	rac->_workingset = false;
180 
181 	BUG_ON(readahead_count(rac));
182 }
183 
184 static struct folio *ractl_alloc_folio(struct readahead_control *ractl,
185 				       gfp_t gfp_mask, unsigned int order)
186 {
187 	struct folio *folio;
188 
189 	folio = filemap_alloc_folio(gfp_mask, order, NULL);
190 	if (folio && ractl->dropbehind)
191 		__folio_set_dropbehind(folio);
192 
193 	return folio;
194 }
195 
196 /**
197  * page_cache_ra_unbounded - Start unchecked readahead.
198  * @ractl: Readahead control.
199  * @nr_to_read: The number of pages to read.
200  * @lookahead_size: Where to start the next readahead.
201  *
202  * This function is for filesystems to call when they want to start
203  * readahead beyond a file's stated i_size.  This is almost certainly
204  * not the function you want to call.  Use page_cache_async_readahead()
205  * or page_cache_sync_readahead() instead.
206  *
207  * Context: File is referenced by caller, and ractl->mapping->invalidate_lock
208  * must be held by the caller at least in shared mode.  Mutexes may be held by
209  * caller.  May sleep, but will not reenter filesystem to reclaim memory.
210  */
211 void page_cache_ra_unbounded(struct readahead_control *ractl,
212 		unsigned long nr_to_read, unsigned long lookahead_size)
213 {
214 	struct address_space *mapping = ractl->mapping;
215 	unsigned long index = readahead_index(ractl);
216 	gfp_t gfp_mask = readahead_gfp_mask(mapping);
217 	unsigned long mark = ULONG_MAX, i = 0;
218 	unsigned int min_nrpages = mapping_min_folio_nrpages(mapping);
219 
220 	/*
221 	 * Partway through the readahead operation, we will have added
222 	 * locked pages to the page cache, but will not yet have submitted
223 	 * them for I/O.  Adding another page may need to allocate memory,
224 	 * which can trigger memory reclaim.  Telling the VM we're in
225 	 * the middle of a filesystem operation will cause it to not
226 	 * touch file-backed pages, preventing a deadlock.  Most (all?)
227 	 * filesystems already specify __GFP_NOFS in their mapping's
228 	 * gfp_mask, but let's be explicit here.
229 	 */
230 	unsigned int nofs = memalloc_nofs_save();
231 
232 	lockdep_assert_held(&mapping->invalidate_lock);
233 
234 	trace_page_cache_ra_unbounded(mapping->host, index, nr_to_read,
235 				      lookahead_size);
236 	index = mapping_align_index(mapping, index);
237 
238 	/*
239 	 * As iterator `i` is aligned to min_nrpages, round_up the
240 	 * difference between nr_to_read and lookahead_size to mark the
241 	 * index that only has lookahead or "async_region" to set the
242 	 * readahead flag.
243 	 */
244 	if (lookahead_size <= nr_to_read) {
245 		unsigned long ra_folio_index;
246 
247 		ra_folio_index = round_up(readahead_index(ractl) +
248 					  nr_to_read - lookahead_size,
249 					  min_nrpages);
250 		mark = ra_folio_index - index;
251 	}
252 	nr_to_read += readahead_index(ractl) - index;
253 	ractl->_index = index;
254 
255 	/*
256 	 * Preallocate as many pages as we will need.
257 	 */
258 	while (i < nr_to_read) {
259 		struct folio *folio = xa_load(&mapping->i_pages, index + i);
260 		int ret;
261 
262 		if (folio && !xa_is_value(folio)) {
263 			/*
264 			 * Page already present?  Kick off the current batch
265 			 * of contiguous pages before continuing with the
266 			 * next batch.  This page may be the one we would
267 			 * have intended to mark as Readahead, but we don't
268 			 * have a stable reference to this page, and it's
269 			 * not worth getting one just for that.
270 			 */
271 			read_pages(ractl);
272 			ractl->_index += min_nrpages;
273 			i = ractl->_index + ractl->_nr_pages - index;
274 			continue;
275 		}
276 
277 		folio = ractl_alloc_folio(ractl, gfp_mask,
278 					mapping_min_folio_order(mapping));
279 		if (!folio)
280 			break;
281 
282 		ret = filemap_add_folio(mapping, folio, index + i, gfp_mask);
283 		if (ret < 0) {
284 			folio_put(folio);
285 			if (ret == -ENOMEM)
286 				break;
287 			read_pages(ractl);
288 			ractl->_index += min_nrpages;
289 			i = ractl->_index + ractl->_nr_pages - index;
290 			continue;
291 		}
292 		if (i == mark)
293 			folio_set_readahead(folio);
294 		ractl->_workingset |= folio_test_workingset(folio);
295 		ractl->_nr_pages += min_nrpages;
296 		i += min_nrpages;
297 	}
298 
299 	/*
300 	 * Now start the IO.  We ignore I/O errors - if the folio is not
301 	 * uptodate then the caller will launch read_folio again, and
302 	 * will then handle the error.
303 	 */
304 	read_pages(ractl);
305 	memalloc_nofs_restore(nofs);
306 }
307 EXPORT_SYMBOL_GPL(page_cache_ra_unbounded);
308 
309 /*
310  * do_page_cache_ra() actually reads a chunk of disk.  It allocates
311  * the pages first, then submits them for I/O. This avoids the very bad
312  * behaviour which would occur if page allocations are causing VM writeback.
313  * We really don't want to intermingle reads and writes like that.
314  */
315 static void do_page_cache_ra(struct readahead_control *ractl,
316 		unsigned long nr_to_read, unsigned long lookahead_size)
317 {
318 	struct address_space *mapping = ractl->mapping;
319 	unsigned long index = readahead_index(ractl);
320 	loff_t isize = i_size_read(mapping->host);
321 	pgoff_t end_index;	/* The last page we want to read */
322 
323 	if (isize == 0)
324 		return;
325 
326 	end_index = (isize - 1) >> PAGE_SHIFT;
327 	if (end_index > ractl->_max_index)
328 		end_index = ractl->_max_index;
329 	if (index > end_index)
330 		return;
331 	/* Don't read past the page containing the last byte of the file */
332 	if (nr_to_read > end_index - index)
333 		nr_to_read = end_index - index + 1;
334 
335 	filemap_invalidate_lock_shared(mapping);
336 	page_cache_ra_unbounded(ractl, nr_to_read, lookahead_size);
337 	filemap_invalidate_unlock_shared(mapping);
338 }
339 
340 /*
341  * Chunk the readahead into 2 megabyte units, so that we don't pin too much
342  * memory at once.
343  */
344 void force_page_cache_ra(struct readahead_control *ractl,
345 		unsigned long nr_to_read)
346 {
347 	struct address_space *mapping = ractl->mapping;
348 	struct file_ra_state *ra = ractl->ra;
349 	struct backing_dev_info *bdi = inode_to_bdi(mapping->host);
350 	unsigned long max_pages;
351 
352 	if (unlikely(!mapping->a_ops->read_folio && !mapping->a_ops->readahead))
353 		return;
354 
355 	/*
356 	 * If the request exceeds the readahead window, allow the read to
357 	 * be up to the optimal hardware IO size
358 	 */
359 	max_pages = max_t(unsigned long, bdi->io_pages, ra->ra_pages);
360 	nr_to_read = min_t(unsigned long, nr_to_read, max_pages);
361 	while (nr_to_read) {
362 		unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_SIZE;
363 
364 		if (this_chunk > nr_to_read)
365 			this_chunk = nr_to_read;
366 		do_page_cache_ra(ractl, this_chunk, 0);
367 
368 		nr_to_read -= this_chunk;
369 	}
370 }
371 
372 /*
373  * Set the initial window size, round to next power of 2 and square
374  * for small size, x 4 for medium, and x 2 for large
375  * for 128k (32 page) max ra
376  * 1-2 page = 16k, 3-4 page 32k, 5-8 page = 64k, > 8 page = 128k initial
377  */
378 static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
379 {
380 	unsigned long newsize = roundup_pow_of_two(size);
381 
382 	if (newsize <= max / 32)
383 		newsize = newsize * 4;
384 	else if (newsize <= max / 4)
385 		newsize = newsize * 2;
386 	else
387 		newsize = max;
388 
389 	return newsize;
390 }
391 
392 /*
393  *  Get the previous window size, ramp it up, and
394  *  return it as the new window size.
395  */
396 static unsigned long get_next_ra_size(struct file_ra_state *ra,
397 				      unsigned long max)
398 {
399 	unsigned long cur = ra->size;
400 
401 	if (cur < max / 16)
402 		return 4 * cur;
403 	if (cur <= max / 2)
404 		return 2 * cur;
405 	return max;
406 }
407 
408 /*
409  * On-demand readahead design.
410  *
411  * The fields in struct file_ra_state represent the most-recently-executed
412  * readahead attempt:
413  *
414  *                        |<----- async_size ---------|
415  *     |------------------- size -------------------->|
416  *     |==================#===========================|
417  *     ^start             ^page marked with PG_readahead
418  *
419  * To overlap application thinking time and disk I/O time, we do
420  * `readahead pipelining': Do not wait until the application consumed all
421  * readahead pages and stalled on the missing page at readahead_index;
422  * Instead, submit an asynchronous readahead I/O as soon as there are
423  * only async_size pages left in the readahead window. Normally async_size
424  * will be equal to size, for maximum pipelining.
425  *
426  * In interleaved sequential reads, concurrent streams on the same fd can
427  * be invalidating each other's readahead state. So we flag the new readahead
428  * page at (start+size-async_size) with PG_readahead, and use it as readahead
429  * indicator. The flag won't be set on already cached pages, to avoid the
430  * readahead-for-nothing fuss, saving pointless page cache lookups.
431  *
432  * prev_pos tracks the last visited byte in the _previous_ read request.
433  * It should be maintained by the caller, and will be used for detecting
434  * small random reads. Note that the readahead algorithm checks loosely
435  * for sequential patterns. Hence interleaved reads might be served as
436  * sequential ones.
437  *
438  * There is a special-case: if the first page which the application tries to
439  * read happens to be the first page of the file, it is assumed that a linear
440  * read is about to happen and the window is immediately set to the initial size
441  * based on I/O request size and the max_readahead.
442  *
443  * The code ramps up the readahead size aggressively at first, but slow down as
444  * it approaches max_readahead.
445  */
446 
447 static inline int ra_alloc_folio(struct readahead_control *ractl, pgoff_t index,
448 		pgoff_t mark, unsigned int order, gfp_t gfp)
449 {
450 	int err;
451 	struct folio *folio = ractl_alloc_folio(ractl, gfp, order);
452 
453 	if (!folio)
454 		return -ENOMEM;
455 	mark = round_down(mark, 1UL << order);
456 	if (index == mark)
457 		folio_set_readahead(folio);
458 	err = filemap_add_folio(ractl->mapping, folio, index, gfp);
459 	if (err) {
460 		folio_put(folio);
461 		return err;
462 	}
463 
464 	ractl->_nr_pages += 1UL << order;
465 	ractl->_workingset |= folio_test_workingset(folio);
466 	return 0;
467 }
468 
469 void page_cache_ra_order(struct readahead_control *ractl,
470 		struct file_ra_state *ra)
471 {
472 	struct address_space *mapping = ractl->mapping;
473 	pgoff_t start = readahead_index(ractl);
474 	pgoff_t index = start;
475 	unsigned int min_order = mapping_min_folio_order(mapping);
476 	pgoff_t limit;
477 	pgoff_t mark = index + ra->size - ra->async_size;
478 	unsigned int nofs;
479 	int err = 0;
480 	gfp_t gfp = readahead_gfp_mask(mapping);
481 	unsigned int new_order = ra->order;
482 
483 	trace_page_cache_ra_order(mapping->host, start, ra);
484 	if (!mapping_large_folio_support(mapping)) {
485 		ra->order = 0;
486 		goto fallback;
487 	}
488 
489 	limit = (i_size_read(mapping->host) - 1) >> PAGE_SHIFT;
490 	limit = min(limit, ractl->_max_index);
491 	limit = min(limit, index + ra->size - 1);
492 
493 	new_order = min(mapping_max_folio_order(mapping), new_order);
494 	new_order = min_t(unsigned int, new_order, ilog2(ra->size));
495 	new_order = max(new_order, min_order);
496 
497 	ra->order = new_order;
498 
499 	/* See comment in page_cache_ra_unbounded() */
500 	nofs = memalloc_nofs_save();
501 	filemap_invalidate_lock_shared(mapping);
502 	/*
503 	 * If the new_order is greater than min_order and index is
504 	 * already aligned to new_order, then this will be noop as index
505 	 * aligned to new_order should also be aligned to min_order.
506 	 */
507 	ractl->_index = mapping_align_index(mapping, index);
508 	index = readahead_index(ractl);
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 		/* Don't allocate pages past EOF */
517 		while (order > min_order && index + (1UL << order) - 1 > limit)
518 			order--;
519 		err = ra_alloc_folio(ractl, index, mark, order, gfp);
520 		if (err)
521 			break;
522 		index += 1UL << order;
523 	}
524 
525 	read_pages(ractl);
526 	filemap_invalidate_unlock_shared(mapping);
527 	memalloc_nofs_restore(nofs);
528 
529 	/*
530 	 * If there were already pages in the page cache, then we may have
531 	 * left some gaps.  Let the regular readahead code take care of this
532 	 * situation below.
533 	 */
534 	if (!err)
535 		return;
536 fallback:
537 	/*
538 	 * ->readahead() may have updated readahead window size so we have to
539 	 * check there's still something to read.
540 	 */
541 	if (ra->size > index - start)
542 		do_page_cache_ra(ractl, ra->size - (index - start),
543 				 ra->async_size);
544 }
545 
546 static unsigned long ractl_max_pages(struct readahead_control *ractl,
547 		unsigned long req_size)
548 {
549 	struct backing_dev_info *bdi = inode_to_bdi(ractl->mapping->host);
550 	unsigned long max_pages = ractl->ra->ra_pages;
551 
552 	/*
553 	 * If the request exceeds the readahead window, allow the read to
554 	 * be up to the optimal hardware IO size
555 	 */
556 	if (req_size > max_pages && bdi->io_pages > max_pages)
557 		max_pages = min(req_size, bdi->io_pages);
558 	return max_pages;
559 }
560 
561 void page_cache_sync_ra(struct readahead_control *ractl,
562 		unsigned long req_count)
563 {
564 	pgoff_t index = readahead_index(ractl);
565 	bool do_forced_ra = ractl->file && (ractl->file->f_mode & FMODE_RANDOM);
566 	struct file_ra_state *ra = ractl->ra;
567 	unsigned long max_pages, contig_count;
568 	pgoff_t prev_index, miss;
569 
570 	trace_page_cache_sync_ra(ractl->mapping->host, index, ra, req_count);
571 	/*
572 	 * Even if readahead is disabled, issue this request as readahead
573 	 * as we'll need it to satisfy the requested range. The forced
574 	 * readahead will do the right thing and limit the read to just the
575 	 * requested range, which we'll set to 1 page for this case.
576 	 */
577 	if (!ra->ra_pages || blk_cgroup_congested()) {
578 		if (!ractl->file)
579 			return;
580 		req_count = 1;
581 		do_forced_ra = true;
582 	}
583 
584 	/* be dumb */
585 	if (do_forced_ra) {
586 		force_page_cache_ra(ractl, req_count);
587 		return;
588 	}
589 
590 	max_pages = ractl_max_pages(ractl, req_count);
591 	prev_index = (unsigned long long)ra->prev_pos >> PAGE_SHIFT;
592 	/*
593 	 * A start of file, oversized read, or sequential cache miss:
594 	 * trivial case: (index - prev_index) == 1
595 	 * unaligned reads: (index - prev_index) == 0
596 	 */
597 	if (!index || req_count > max_pages || index - prev_index <= 1UL) {
598 		ra->start = index;
599 		ra->size = get_init_ra_size(req_count, max_pages);
600 		ra->async_size = ra->size > req_count ? ra->size - req_count :
601 							ra->size >> 1;
602 		goto readit;
603 	}
604 
605 	/*
606 	 * Query the page cache and look for the traces(cached history pages)
607 	 * that a sequential stream would leave behind.
608 	 */
609 	rcu_read_lock();
610 	miss = page_cache_prev_miss(ractl->mapping, index - 1, max_pages);
611 	rcu_read_unlock();
612 	contig_count = index - miss - 1;
613 	/*
614 	 * Standalone, small random read. Read as is, and do not pollute the
615 	 * readahead state.
616 	 */
617 	if (contig_count <= req_count) {
618 		do_page_cache_ra(ractl, req_count, 0);
619 		return;
620 	}
621 	/*
622 	 * File cached from the beginning:
623 	 * it is a strong indication of long-run stream (or whole-file-read)
624 	 */
625 	if (miss == ULONG_MAX)
626 		contig_count *= 2;
627 	ra->start = index;
628 	ra->size = min(contig_count + req_count, max_pages);
629 	ra->async_size = 1;
630 readit:
631 	ra->order = 0;
632 	ractl->_index = ra->start;
633 	page_cache_ra_order(ractl, ra);
634 }
635 EXPORT_SYMBOL_GPL(page_cache_sync_ra);
636 
637 void page_cache_async_ra(struct readahead_control *ractl,
638 		struct folio *folio, unsigned long req_count)
639 {
640 	unsigned long max_pages;
641 	struct file_ra_state *ra = ractl->ra;
642 	pgoff_t index = readahead_index(ractl);
643 	pgoff_t expected, start, end, aligned_end, align;
644 
645 	/* no readahead */
646 	if (!ra->ra_pages)
647 		return;
648 
649 	/*
650 	 * Same bit is used for PG_readahead and PG_reclaim.
651 	 */
652 	if (folio_test_writeback(folio))
653 		return;
654 
655 	trace_page_cache_async_ra(ractl->mapping->host, index, ra, req_count);
656 	folio_clear_readahead(folio);
657 
658 	if (blk_cgroup_congested())
659 		return;
660 
661 	max_pages = ractl_max_pages(ractl, req_count);
662 	/*
663 	 * It's the expected callback index, assume sequential access.
664 	 * Ramp up sizes, and push forward the readahead window.
665 	 */
666 	expected = round_down(ra->start + ra->size - ra->async_size,
667 			folio_nr_pages(folio));
668 	if (index == expected) {
669 		ra->start += ra->size;
670 		/*
671 		 * In the case of MADV_HUGEPAGE, the actual size might exceed
672 		 * the readahead window.
673 		 */
674 		ra->size = max(ra->size, get_next_ra_size(ra, max_pages));
675 		goto readit;
676 	}
677 
678 	/*
679 	 * Hit a marked folio without valid readahead state.
680 	 * E.g. interleaved reads.
681 	 * Query the pagecache for async_size, which normally equals to
682 	 * readahead size. Ramp it up and use it as the new readahead size.
683 	 */
684 	rcu_read_lock();
685 	start = page_cache_next_miss(ractl->mapping, index + 1, max_pages);
686 	rcu_read_unlock();
687 
688 	if (!start || start - index > max_pages)
689 		return;
690 
691 	ra->start = start;
692 	ra->size = start - index;	/* old async_size */
693 	ra->size += req_count;
694 	ra->size = get_next_ra_size(ra, max_pages);
695 readit:
696 	ra->order += 2;
697 	align = 1UL << min(ra->order, ffs(max_pages) - 1);
698 	end = ra->start + ra->size;
699 	aligned_end = round_down(end, align);
700 	if (aligned_end > ra->start)
701 		ra->size -= end - aligned_end;
702 	ra->async_size = ra->size;
703 	ractl->_index = ra->start;
704 	page_cache_ra_order(ractl, ra);
705 }
706 EXPORT_SYMBOL_GPL(page_cache_async_ra);
707 
708 ssize_t ksys_readahead(int fd, loff_t offset, size_t count)
709 {
710 	struct file *file;
711 	const struct inode *inode;
712 
713 	CLASS(fd, f)(fd);
714 	if (fd_empty(f))
715 		return -EBADF;
716 
717 	file = fd_file(f);
718 	if (!(file->f_mode & FMODE_READ))
719 		return -EBADF;
720 
721 	/*
722 	 * The readahead() syscall is intended to run only on files
723 	 * that can execute readahead. If readahead is not possible
724 	 * on this file, then we must return -EINVAL.
725 	 */
726 	if (!file->f_mapping)
727 		return -EINVAL;
728 	if (!file->f_mapping->a_ops)
729 		return -EINVAL;
730 
731 	inode = file_inode(file);
732 	if (!S_ISREG(inode->i_mode) && !S_ISBLK(inode->i_mode))
733 		return -EINVAL;
734 	if (IS_ANON_FILE(inode))
735 		return -EINVAL;
736 
737 	return vfs_fadvise(fd_file(f), offset, count, POSIX_FADV_WILLNEED);
738 }
739 
740 SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
741 {
742 	return ksys_readahead(fd, offset, count);
743 }
744 
745 #if defined(CONFIG_COMPAT) && defined(__ARCH_WANT_COMPAT_READAHEAD)
746 COMPAT_SYSCALL_DEFINE4(readahead, int, fd, compat_arg_u64_dual(offset), size_t, count)
747 {
748 	return ksys_readahead(fd, compat_arg_u64_glue(offset), count);
749 }
750 #endif
751 
752 /**
753  * readahead_expand - Expand a readahead request
754  * @ractl: The request to be expanded
755  * @new_start: The revised start
756  * @new_len: The revised size of the request
757  *
758  * Attempt to expand a readahead request outwards from the current size to the
759  * specified size by inserting locked pages before and after the current window
760  * to increase the size to the new window.  This may involve the insertion of
761  * THPs, in which case the window may get expanded even beyond what was
762  * requested.
763  *
764  * The algorithm will stop if it encounters a conflicting page already in the
765  * pagecache and leave a smaller expansion than requested.
766  *
767  * The caller must check for this by examining the revised @ractl object for a
768  * different expansion than was requested.
769  */
770 void readahead_expand(struct readahead_control *ractl,
771 		      loff_t new_start, size_t new_len)
772 {
773 	struct address_space *mapping = ractl->mapping;
774 	struct file_ra_state *ra = ractl->ra;
775 	pgoff_t new_index, new_nr_pages;
776 	gfp_t gfp_mask = readahead_gfp_mask(mapping);
777 	unsigned long min_nrpages = mapping_min_folio_nrpages(mapping);
778 	unsigned int min_order = mapping_min_folio_order(mapping);
779 
780 	new_index = new_start / PAGE_SIZE;
781 	/*
782 	 * Readahead code should have aligned the ractl->_index to
783 	 * min_nrpages before calling readahead aops.
784 	 */
785 	VM_BUG_ON(!IS_ALIGNED(ractl->_index, min_nrpages));
786 
787 	/* Expand the leading edge downwards */
788 	while (ractl->_index > new_index) {
789 		unsigned long index = ractl->_index - 1;
790 		struct folio *folio = xa_load(&mapping->i_pages, index);
791 
792 		if (folio && !xa_is_value(folio))
793 			return; /* Folio apparently present */
794 
795 		folio = ractl_alloc_folio(ractl, gfp_mask, min_order);
796 		if (!folio)
797 			return;
798 
799 		index = mapping_align_index(mapping, index);
800 		if (filemap_add_folio(mapping, folio, index, gfp_mask) < 0) {
801 			folio_put(folio);
802 			return;
803 		}
804 		if (unlikely(folio_test_workingset(folio)) &&
805 				!ractl->_workingset) {
806 			ractl->_workingset = true;
807 			psi_memstall_enter(&ractl->_pflags);
808 		}
809 		ractl->_nr_pages += min_nrpages;
810 		ractl->_index = folio->index;
811 	}
812 
813 	new_len += new_start - readahead_pos(ractl);
814 	new_nr_pages = DIV_ROUND_UP(new_len, PAGE_SIZE);
815 
816 	/* Expand the trailing edge upwards */
817 	while (ractl->_nr_pages < new_nr_pages) {
818 		unsigned long index = ractl->_index + ractl->_nr_pages;
819 		struct folio *folio = xa_load(&mapping->i_pages, index);
820 
821 		if (folio && !xa_is_value(folio))
822 			return; /* Folio apparently present */
823 
824 		folio = ractl_alloc_folio(ractl, gfp_mask, min_order);
825 		if (!folio)
826 			return;
827 
828 		index = mapping_align_index(mapping, index);
829 		if (filemap_add_folio(mapping, folio, index, gfp_mask) < 0) {
830 			folio_put(folio);
831 			return;
832 		}
833 		if (unlikely(folio_test_workingset(folio)) &&
834 				!ractl->_workingset) {
835 			ractl->_workingset = true;
836 			psi_memstall_enter(&ractl->_pflags);
837 		}
838 		ractl->_nr_pages += min_nrpages;
839 		if (ra) {
840 			ra->size += min_nrpages;
841 			ra->async_size += min_nrpages;
842 		}
843 	}
844 }
845 EXPORT_SYMBOL(readahead_expand);
846