buffer: Rewrite nobh_truncate_page() to use folios
[linux-2.6-block.git] / mm / readahead.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * mm/readahead.c - address_space-level file readahead.
4 *
5 * Copyright (C) 2002, Linus Torvalds
6 *
e1f8e874 7 * 09Apr2002 Andrew Morton
1da177e4
LT
8 * Initial version.
9 */
10
84dacdbd
N
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
1e470280
MWO
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
84dacdbd
N
18 * it. In that case a simple ->readpage() will be requested.
19 *
20 * Readahead is triggered when an application read request (whether a
1e470280 21 * system call or a page fault) finds that the requested folio is not in
84dacdbd 22 * the page cache, or that it is in the page cache and has the
1e470280
MWO
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.
84dacdbd
N
26 *
27 * Each readahead request is partly synchronous read, and partly async
1e470280
MWO
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
84dacdbd 33 * established, there should be no need for a synchronous component and
1e470280 34 * all readahead request will be fully asynchronous.
84dacdbd 35 *
1e470280
MWO
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.
84dacdbd
N
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
1e470280 48 * PAGE. ALSO THIS CALCULATION IS NOT USED CONSISTENTLY.
84dacdbd
N
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
1e470280 55 * was triggered by the readahead flag, the size of the previous
84dacdbd
N
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 *
1e470280 68 * In general readahead is accelerated at the start of the file, as
84dacdbd 69 * reads from there are often sequential. There are other minor
1e470280 70 * adjustments to the readahead size in various special cases and these
84dacdbd
N
71 * are best discovered by reading the code.
72 *
1e470280
MWO
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.
84dacdbd
N
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
1e470280 80 * folios, but may fail to read any or all folios without causing an I/O
84dacdbd 81 * error. The page cache reading code will issue a ->readpage() request
1e470280 82 * for any folio which ->readahead() did not read, and only an error
84dacdbd
N
83 * from this will be final.
84 *
1e470280
MWO
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:
84dacdbd 88 *
1e470280
MWO
89 * * not calling readahead_folio() sufficiently many times, effectively
90 * ignoring some folios, as might be appropriate if the path to
84dacdbd
N
91 * storage is congested.
92 *
1e470280 93 * * failing to actually submit a read request for a given folio,
84dacdbd
N
94 * possibly due to insufficient resources, or
95 *
96 * * getting an error during subsequent processing of a request.
97 *
1e470280
MWO
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.
84dacdbd 101 *
1e470280 102 * Those folios not in the final ``async_size`` of the request should be
84dacdbd
N
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
1e470280 106 * become available. Folios in the final ``async_size`` may be
84dacdbd 107 * considered less urgent and failure to read them is more acceptable.
1e470280
MWO
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
9fd472af 112 * are left in the page cache, then they will be read individually using
1e470280 113 * ->readpage() which may be less efficient.
84dacdbd
N
114 */
115
1da177e4 116#include <linux/kernel.h>
11bd969f 117#include <linux/dax.h>
5a0e3ad6 118#include <linux/gfp.h>
b95f1b31 119#include <linux/export.h>
1da177e4 120#include <linux/backing-dev.h>
8bde37f0 121#include <linux/task_io_accounting_ops.h>
1da177e4 122#include <linux/pagevec.h>
f5ff8422 123#include <linux/pagemap.h>
782182e5
CW
124#include <linux/syscalls.h>
125#include <linux/file.h>
d72ee911 126#include <linux/mm_inline.h>
ca47e8c7 127#include <linux/blk-cgroup.h>
3d8f7615 128#include <linux/fadvise.h>
f2c817be 129#include <linux/sched/mm.h>
1da177e4 130
29f175d1
FF
131#include "internal.h"
132
1da177e4
LT
133/*
134 * Initialise a struct file's readahead state. Assumes that the caller has
135 * memset *ra to zero.
136 */
137void
138file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
139{
de1414a6 140 ra->ra_pages = inode_to_bdi(mapping->host)->ra_pages;
f4e6b498 141 ra->prev_pos = -1;
1da177e4 142}
d41cc702 143EXPORT_SYMBOL_GPL(file_ra_state_init);
1da177e4 144
b4e089d7 145static void read_pages(struct readahead_control *rac)
1da177e4 146{
a4d96536 147 const struct address_space_operations *aops = rac->mapping->a_ops;
a42634a6 148 struct folio *folio;
5b417b18 149 struct blk_plug plug;
1da177e4 150
a4d96536 151 if (!readahead_count(rac))
b4e089d7 152 return;
ad4ae1c7 153
5b417b18
JA
154 blk_start_plug(&plug);
155
8151b4c8
MWO
156 if (aops->readahead) {
157 aops->readahead(rac);
9fd472af 158 /*
a42634a6 159 * Clean up the remaining folios. The sizes in ->ra
1e470280 160 * may be used to size the next readahead, so make sure
9fd472af
N
161 * they accurately reflect what happened.
162 */
a42634a6
MWO
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);
9fd472af 170 }
a42634a6 171 folio_unlock(folio);
8151b4c8 172 }
c1f6925e 173 } else {
a42634a6
MWO
174 while ((folio = readahead_folio(rac)))
175 aops->readpage(rac->file, &folio->page);
1da177e4 176 }
5b417b18 177
5b417b18 178 blk_finish_plug(&plug);
ad4ae1c7 179
c1f6925e 180 BUG_ON(readahead_count(rac));
1da177e4
LT
181}
182
2c684234 183/**
73bb49da
MWO
184 * page_cache_ra_unbounded - Start unchecked readahead.
185 * @ractl: Readahead control.
2c684234
MWO
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.
1da177e4 196 */
73bb49da
MWO
197void page_cache_ra_unbounded(struct readahead_control *ractl,
198 unsigned long nr_to_read, unsigned long lookahead_size)
1da177e4 199{
73bb49da
MWO
200 struct address_space *mapping = ractl->mapping;
201 unsigned long index = readahead_index(ractl);
8a5c743e 202 gfp_t gfp_mask = readahead_gfp_mask(mapping);
c2c7ad74 203 unsigned long i;
1da177e4 204
f2c817be
MWO
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
730633f0 217 filemap_invalidate_lock_shared(mapping);
1da177e4
LT
218 /*
219 * Preallocate as many pages as we will need.
220 */
c2c7ad74 221 for (i = 0; i < nr_to_read; i++) {
0387df1d 222 struct folio *folio = xa_load(&mapping->i_pages, index + i);
1da177e4 223
0387df1d 224 if (folio && !xa_is_value(folio)) {
b3751e6a 225 /*
2d8163e4
MWO
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.
b3751e6a 232 */
b4e089d7
CH
233 read_pages(ractl);
234 ractl->_index++;
f615bd5c 235 i = ractl->_index + ractl->_nr_pages - index - 1;
1da177e4 236 continue;
b3751e6a 237 }
1da177e4 238
0387df1d
MWO
239 folio = filemap_alloc_folio(gfp_mask, 0);
240 if (!folio)
1da177e4 241 break;
704528d8 242 if (filemap_add_folio(mapping, folio, index + i,
c1f6925e 243 gfp_mask) < 0) {
0387df1d 244 folio_put(folio);
b4e089d7
CH
245 read_pages(ractl);
246 ractl->_index++;
f615bd5c 247 i = ractl->_index + ractl->_nr_pages - index - 1;
c1f6925e
MWO
248 continue;
249 }
c2c7ad74 250 if (i == nr_to_read - lookahead_size)
0387df1d 251 folio_set_readahead(folio);
73bb49da 252 ractl->_nr_pages++;
1da177e4 253 }
1da177e4
LT
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 */
b4e089d7 260 read_pages(ractl);
730633f0 261 filemap_invalidate_unlock_shared(mapping);
f2c817be 262 memalloc_nofs_restore(nofs);
1da177e4 263}
73bb49da 264EXPORT_SYMBOL_GPL(page_cache_ra_unbounded);
2c684234
MWO
265
266/*
8238287e 267 * do_page_cache_ra() actually reads a chunk of disk. It allocates
2c684234
MWO
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 */
56a4d67c 272static void do_page_cache_ra(struct readahead_control *ractl,
8238287e 273 unsigned long nr_to_read, unsigned long lookahead_size)
2c684234 274{
8238287e
MWO
275 struct inode *inode = ractl->mapping->host;
276 unsigned long index = readahead_index(ractl);
2c684234
MWO
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
8238287e 290 page_cache_ra_unbounded(ractl, nr_to_read, lookahead_size);
2c684234 291}
1da177e4
LT
292
293/*
294 * Chunk the readahead into 2 megabyte units, so that we don't pin too much
295 * memory at once.
296 */
7b3df3b9 297void force_page_cache_ra(struct readahead_control *ractl,
fcd9ae4f 298 unsigned long nr_to_read)
1da177e4 299{
7b3df3b9 300 struct address_space *mapping = ractl->mapping;
fcd9ae4f 301 struct file_ra_state *ra = ractl->ra;
9491ae4a 302 struct backing_dev_info *bdi = inode_to_bdi(mapping->host);
7b3df3b9 303 unsigned long max_pages, index;
9491ae4a 304
704528d8 305 if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readahead))
9a42823a 306 return;
1da177e4 307
9491ae4a
JA
308 /*
309 * If the request exceeds the readahead window, allow the read to
310 * be up to the optimal hardware IO size
311 */
7b3df3b9 312 index = readahead_index(ractl);
9491ae4a 313 max_pages = max_t(unsigned long, bdi->io_pages, ra->ra_pages);
7b3df3b9 314 nr_to_read = min_t(unsigned long, nr_to_read, max_pages);
1da177e4 315 while (nr_to_read) {
09cbfeaf 316 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_SIZE;
1da177e4
LT
317
318 if (this_chunk > nr_to_read)
319 this_chunk = nr_to_read;
7b3df3b9
DH
320 ractl->_index = index;
321 do_page_cache_ra(ractl, this_chunk, 0);
58d5640e 322
08eb9658 323 index += this_chunk;
1da177e4
LT
324 nr_to_read -= this_chunk;
325 }
1da177e4
LT
326}
327
c743d96b
FW
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
fb25a77d 332 * 1-2 page = 16k, 3-4 page 32k, 5-8 page = 64k, > 8 page = 128k initial
c743d96b
FW
333 */
334static 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
122a21d1
FW
348/*
349 * Get the previous window size, ramp it up, and
350 * return it as the new window size.
351 */
c743d96b 352static unsigned long get_next_ra_size(struct file_ra_state *ra,
20ff1c95 353 unsigned long max)
122a21d1 354{
f9acc8c7 355 unsigned long cur = ra->size;
122a21d1
FW
356
357 if (cur < max / 16)
20ff1c95
GX
358 return 4 * cur;
359 if (cur <= max / 2)
360 return 2 * cur;
361 return max;
122a21d1
FW
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 *
f9acc8c7
FW
370 * |<----- async_size ---------|
371 * |------------------- size -------------------->|
372 * |==================#===========================|
373 * ^start ^page marked with PG_readahead
122a21d1
FW
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;
f9acc8c7
FW
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.
122a21d1
FW
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
f9acc8c7 384 * page at (start+size-async_size) with PG_readahead, and use it as readahead
122a21d1
FW
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 *
f4e6b498 388 * prev_pos tracks the last visited byte in the _previous_ read request.
122a21d1
FW
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
10be0b37 403/*
08eb9658 404 * Count contiguously cached pages from @index-1 to @index-@max,
10be0b37
WF
405 * this count is a conservative estimation of
406 * - length of the sequential read sequence, or
407 * - thrashing threshold in memory tight systems
408 */
409static pgoff_t count_history_pages(struct address_space *mapping,
08eb9658 410 pgoff_t index, unsigned long max)
10be0b37
WF
411{
412 pgoff_t head;
413
414 rcu_read_lock();
08eb9658 415 head = page_cache_prev_miss(mapping, index - 1, max);
10be0b37
WF
416 rcu_read_unlock();
417
08eb9658 418 return index - 1 - head;
10be0b37
WF
419}
420
421/*
1e470280 422 * page cache context based readahead
10be0b37
WF
423 */
424static int try_context_readahead(struct address_space *mapping,
425 struct file_ra_state *ra,
08eb9658 426 pgoff_t index,
10be0b37
WF
427 unsigned long req_size,
428 unsigned long max)
429{
430 pgoff_t size;
431
08eb9658 432 size = count_history_pages(mapping, index, max);
10be0b37
WF
433
434 /*
2cad4018 435 * not enough history pages:
10be0b37
WF
436 * it could be a random read
437 */
2cad4018 438 if (size <= req_size)
10be0b37
WF
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 */
08eb9658 445 if (size >= index)
10be0b37
WF
446 size *= 2;
447
08eb9658 448 ra->start = index;
2cad4018
FW
449 ra->size = min(size + req_size, max);
450 ra->async_size = 1;
10be0b37
WF
451
452 return 1;
453}
454
793917d9
MWO
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
468static 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;
b9ff43dd
MWO
476 mark = round_up(mark, 1UL << order);
477 if (index == mark)
793917d9
MWO
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
56a4d67c 487void page_cache_ra_order(struct readahead_control *ractl,
793917d9
MWO
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
b4e089d7 535 read_pages(ractl);
793917d9
MWO
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;
544fallback:
545 do_page_cache_ra(ractl, ra->size, ra->async_size);
546}
547
122a21d1
FW
548/*
549 * A minimal readahead algorithm for trivial sequential/random reads.
550 */
6e4af69a 551static void ondemand_readahead(struct readahead_control *ractl,
793917d9 552 struct folio *folio, unsigned long req_size)
122a21d1 553{
6e4af69a 554 struct backing_dev_info *bdi = inode_to_bdi(ractl->mapping->host);
fcd9ae4f 555 struct file_ra_state *ra = ractl->ra;
9491ae4a 556 unsigned long max_pages = ra->ra_pages;
dc30b96a 557 unsigned long add_pages;
b9ff43dd
MWO
558 pgoff_t index = readahead_index(ractl);
559 pgoff_t expected, prev_index;
560 unsigned int order = folio ? folio_order(folio) : 0;
045a2529 561
9491ae4a
JA
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
045a2529
WF
569 /*
570 * start of file
571 */
08eb9658 572 if (!index)
045a2529 573 goto initial_readahead;
122a21d1
FW
574
575 /*
08eb9658 576 * It's the expected callback index, assume sequential access.
122a21d1
FW
577 * Ramp up sizes, and push forward the readahead window.
578 */
b9ff43dd
MWO
579 expected = round_up(ra->start + ra->size - ra->async_size,
580 1UL << order);
581 if (index == expected || index == (ra->start + ra->size)) {
f9acc8c7 582 ra->start += ra->size;
9491ae4a 583 ra->size = get_next_ra_size(ra, max_pages);
f9acc8c7
FW
584 ra->async_size = ra->size;
585 goto readit;
122a21d1
FW
586 }
587
6b10c6c9 588 /*
793917d9 589 * Hit a marked folio without valid readahead state.
6b10c6c9
FW
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 */
793917d9 594 if (folio) {
6b10c6c9
FW
595 pgoff_t start;
596
30002ed2 597 rcu_read_lock();
6e4af69a
DH
598 start = page_cache_next_miss(ractl->mapping, index + 1,
599 max_pages);
30002ed2 600 rcu_read_unlock();
6b10c6c9 601
08eb9658 602 if (!start || start - index > max_pages)
9a42823a 603 return;
6b10c6c9
FW
604
605 ra->start = start;
08eb9658 606 ra->size = start - index; /* old async_size */
160334a0 607 ra->size += req_size;
9491ae4a 608 ra->size = get_next_ra_size(ra, max_pages);
6b10c6c9
FW
609 ra->async_size = ra->size;
610 goto readit;
611 }
612
122a21d1 613 /*
045a2529 614 * oversize read
122a21d1 615 */
9491ae4a 616 if (req_size > max_pages)
045a2529
WF
617 goto initial_readahead;
618
619 /*
620 * sequential cache miss
08eb9658
MWO
621 * trivial case: (index - prev_index) == 1
622 * unaligned reads: (index - prev_index) == 0
045a2529 623 */
08eb9658
MWO
624 prev_index = (unsigned long long)ra->prev_pos >> PAGE_SHIFT;
625 if (index - prev_index <= 1UL)
045a2529
WF
626 goto initial_readahead;
627
10be0b37
WF
628 /*
629 * Query the page cache and look for the traces(cached history pages)
630 * that a sequential stream would leave behind.
631 */
6e4af69a
DH
632 if (try_context_readahead(ractl->mapping, ra, index, req_size,
633 max_pages))
10be0b37
WF
634 goto readit;
635
045a2529
WF
636 /*
637 * standalone, small random read
638 * Read as is, and do not pollute the readahead state.
639 */
6e4af69a 640 do_page_cache_ra(ractl, req_size, 0);
9a42823a 641 return;
045a2529
WF
642
643initial_readahead:
08eb9658 644 ra->start = index;
9491ae4a 645 ra->size = get_init_ra_size(req_size, max_pages);
f9acc8c7 646 ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
122a21d1 647
f9acc8c7 648readit:
51daa88e
WF
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.
dc30b96a 653 * Take care of maximum IO pages as above.
51daa88e 654 */
08eb9658 655 if (index == ra->start && ra->size == ra->async_size) {
dc30b96a
MS
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 }
51daa88e
WF
664 }
665
6e4af69a 666 ractl->_index = ra->start;
b9ff43dd 667 page_cache_ra_order(ractl, ra, order);
122a21d1
FW
668}
669
fefa7c47 670void page_cache_sync_ra(struct readahead_control *ractl,
fcd9ae4f 671 unsigned long req_count)
122a21d1 672{
324bcf54 673 bool do_forced_ra = ractl->file && (ractl->file->f_mode & FMODE_RANDOM);
cf914a7d 674
324bcf54 675 /*
1e470280 676 * Even if readahead is disabled, issue this request as readahead
324bcf54 677 * as we'll need it to satisfy the requested range. The forced
1e470280 678 * readahead will do the right thing and limit the read to just the
324bcf54
JA
679 * requested range, which we'll set to 1 page for this case.
680 */
fcd9ae4f 681 if (!ractl->ra->ra_pages || blk_cgroup_congested()) {
324bcf54
JA
682 if (!ractl->file)
683 return;
684 req_count = 1;
685 do_forced_ra = true;
686 }
ca47e8c7 687
0141450f 688 /* be dumb */
324bcf54 689 if (do_forced_ra) {
fcd9ae4f 690 force_page_cache_ra(ractl, req_count);
0141450f
WF
691 return;
692 }
693
793917d9 694 ondemand_readahead(ractl, NULL, req_count);
cf914a7d 695}
fefa7c47 696EXPORT_SYMBOL_GPL(page_cache_sync_ra);
cf914a7d 697
fefa7c47 698void page_cache_async_ra(struct readahead_control *ractl,
7836d999 699 struct folio *folio, unsigned long req_count)
cf914a7d 700{
1e470280 701 /* no readahead */
fcd9ae4f 702 if (!ractl->ra->ra_pages)
cf914a7d
RR
703 return;
704
705 /*
706 * Same bit is used for PG_readahead and PG_reclaim.
707 */
7836d999 708 if (folio_test_writeback(folio))
cf914a7d
RR
709 return;
710
7836d999 711 folio_clear_readahead(folio);
cf914a7d 712
ca47e8c7
JB
713 if (blk_cgroup_congested())
714 return;
715
793917d9 716 ondemand_readahead(ractl, folio, req_count);
122a21d1 717}
fefa7c47 718EXPORT_SYMBOL_GPL(page_cache_async_ra);
782182e5 719
c7b95d51 720ssize_t ksys_readahead(int fd, loff_t offset, size_t count)
782182e5
CW
721{
722 ssize_t ret;
2903ff01 723 struct fd f;
782182e5
CW
724
725 ret = -EBADF;
2903ff01 726 f = fdget(fd);
3d8f7615
AG
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);
741out:
742 fdput(f);
782182e5
CW
743 return ret;
744}
c7b95d51
DB
745
746SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
747{
748 return ksys_readahead(fd, offset, count);
749}
3ca23644
DH
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 */
769void 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}
824EXPORT_SYMBOL(readahead_expand);