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