2 * mm/readahead.c - address_space-level file readahead.
4 * Copyright (C) 2002, Linus Torvalds
6 * 09Apr2002 akpm@zip.com.au
10 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/blkdev.h>
15 #include <linux/backing-dev.h>
16 #include <linux/task_io_accounting_ops.h>
17 #include <linux/pagevec.h>
18 #include <linux/pagemap.h>
20 void default_unplug_io_fn(struct backing_dev_info *bdi, struct page *page)
23 EXPORT_SYMBOL(default_unplug_io_fn);
25 struct backing_dev_info default_backing_dev_info = {
26 .ra_pages = VM_MAX_READAHEAD * 1024 / PAGE_CACHE_SIZE,
28 .capabilities = BDI_CAP_MAP_COPY,
29 .unplug_io_fn = default_unplug_io_fn,
31 EXPORT_SYMBOL_GPL(default_backing_dev_info);
34 * Initialise a struct file's readahead state. Assumes that the caller has
38 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
40 ra->ra_pages = mapping->backing_dev_info->ra_pages;
43 EXPORT_SYMBOL_GPL(file_ra_state_init);
45 #define list_to_page(head) (list_entry((head)->prev, struct page, lru))
48 * read_cache_pages - populate an address space with some pages & start reads against them
49 * @mapping: the address_space
50 * @pages: The address of a list_head which contains the target pages. These
51 * pages have their ->index populated and are otherwise uninitialised.
52 * @filler: callback routine for filling a single page.
53 * @data: private data for the callback routine.
55 * Hides the details of the LRU cache etc from the filesystems.
57 int read_cache_pages(struct address_space *mapping, struct list_head *pages,
58 int (*filler)(void *, struct page *), void *data)
63 while (!list_empty(pages)) {
64 page = list_to_page(pages);
66 if (add_to_page_cache_lru(page, mapping,
67 page->index, GFP_KERNEL)) {
68 page_cache_release(page);
71 page_cache_release(page);
73 ret = filler(data, page);
75 put_pages_list(pages);
78 task_io_account_read(PAGE_CACHE_SIZE);
83 EXPORT_SYMBOL(read_cache_pages);
85 static int read_pages(struct address_space *mapping, struct file *filp,
86 struct list_head *pages, unsigned nr_pages)
91 if (mapping->a_ops->readpages) {
92 ret = mapping->a_ops->readpages(filp, mapping, pages, nr_pages);
93 /* Clean up the remaining pages */
94 put_pages_list(pages);
98 for (page_idx = 0; page_idx < nr_pages; page_idx++) {
99 struct page *page = list_to_page(pages);
100 list_del(&page->lru);
101 if (!add_to_page_cache_lru(page, mapping,
102 page->index, GFP_KERNEL)) {
103 mapping->a_ops->readpage(filp, page);
105 page_cache_release(page);
113 * do_page_cache_readahead actually reads a chunk of disk. It allocates all
114 * the pages first, then submits them all for I/O. This avoids the very bad
115 * behaviour which would occur if page allocations are causing VM writeback.
116 * We really don't want to intermingle reads and writes like that.
118 * Returns the number of pages requested, or the maximum amount of I/O allowed.
120 * do_page_cache_readahead() returns -1 if it encountered request queue
124 __do_page_cache_readahead(struct address_space *mapping, struct file *filp,
125 pgoff_t offset, unsigned long nr_to_read,
126 unsigned long lookahead_size)
128 struct inode *inode = mapping->host;
130 unsigned long end_index; /* The last page we want to read */
131 LIST_HEAD(page_pool);
134 loff_t isize = i_size_read(inode);
139 end_index = ((isize - 1) >> PAGE_CACHE_SHIFT);
142 * Preallocate as many pages as we will need.
144 for (page_idx = 0; page_idx < nr_to_read; page_idx++) {
145 pgoff_t page_offset = offset + page_idx;
147 if (page_offset > end_index)
151 page = radix_tree_lookup(&mapping->page_tree, page_offset);
156 page = page_cache_alloc_cold(mapping);
159 page->index = page_offset;
160 list_add(&page->lru, &page_pool);
161 if (page_idx == nr_to_read - lookahead_size)
162 SetPageReadahead(page);
167 * Now start the IO. We ignore I/O errors - if the page is not
168 * uptodate then the caller will launch readpage again, and
169 * will then handle the error.
172 read_pages(mapping, filp, &page_pool, ret);
173 BUG_ON(!list_empty(&page_pool));
179 * Chunk the readahead into 2 megabyte units, so that we don't pin too much
182 int force_page_cache_readahead(struct address_space *mapping, struct file *filp,
183 pgoff_t offset, unsigned long nr_to_read)
187 if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages))
193 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_CACHE_SIZE;
195 if (this_chunk > nr_to_read)
196 this_chunk = nr_to_read;
197 err = __do_page_cache_readahead(mapping, filp,
198 offset, this_chunk, 0);
204 offset += this_chunk;
205 nr_to_read -= this_chunk;
211 * This version skips the IO if the queue is read-congested, and will tell the
212 * block layer to abandon the readahead if request allocation would block.
214 * force_page_cache_readahead() will ignore queue congestion and will block on
217 int do_page_cache_readahead(struct address_space *mapping, struct file *filp,
218 pgoff_t offset, unsigned long nr_to_read)
220 if (bdi_read_congested(mapping->backing_dev_info))
223 return __do_page_cache_readahead(mapping, filp, offset, nr_to_read, 0);
227 * Given a desired number of PAGE_CACHE_SIZE readahead pages, return a
228 * sensible upper limit.
230 unsigned long max_sane_readahead(unsigned long nr)
232 return min(nr, (node_page_state(numa_node_id(), NR_INACTIVE)
233 + node_page_state(numa_node_id(), NR_FREE_PAGES)) / 2);
236 static int __init readahead_init(void)
238 return bdi_init(&default_backing_dev_info);
240 subsys_initcall(readahead_init);
243 * Submit IO for the read-ahead request in file_ra_state.
245 static unsigned long ra_submit(struct file_ra_state *ra,
246 struct address_space *mapping, struct file *filp)
250 actual = __do_page_cache_readahead(mapping, filp,
251 ra->start, ra->size, ra->async_size);
257 * Set the initial window size, round to next power of 2 and square
258 * for small size, x 4 for medium, and x 2 for large
259 * for 128k (32 page) max ra
260 * 1-8 page = 32k initial, > 8 page = 128k initial
262 static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
264 unsigned long newsize = roundup_pow_of_two(size);
266 if (newsize <= max / 32)
267 newsize = newsize * 4;
268 else if (newsize <= max / 4)
269 newsize = newsize * 2;
277 * Get the previous window size, ramp it up, and
278 * return it as the new window size.
280 static unsigned long get_next_ra_size(struct file_ra_state *ra,
283 unsigned long cur = ra->size;
284 unsigned long newsize;
291 return min(newsize, max);
295 * On-demand readahead design.
297 * The fields in struct file_ra_state represent the most-recently-executed
300 * |<----- async_size ---------|
301 * |------------------- size -------------------->|
302 * |==================#===========================|
303 * ^start ^page marked with PG_readahead
305 * To overlap application thinking time and disk I/O time, we do
306 * `readahead pipelining': Do not wait until the application consumed all
307 * readahead pages and stalled on the missing page at readahead_index;
308 * Instead, submit an asynchronous readahead I/O as soon as there are
309 * only async_size pages left in the readahead window. Normally async_size
310 * will be equal to size, for maximum pipelining.
312 * In interleaved sequential reads, concurrent streams on the same fd can
313 * be invalidating each other's readahead state. So we flag the new readahead
314 * page at (start+size-async_size) with PG_readahead, and use it as readahead
315 * indicator. The flag won't be set on already cached pages, to avoid the
316 * readahead-for-nothing fuss, saving pointless page cache lookups.
318 * prev_pos tracks the last visited byte in the _previous_ read request.
319 * It should be maintained by the caller, and will be used for detecting
320 * small random reads. Note that the readahead algorithm checks loosely
321 * for sequential patterns. Hence interleaved reads might be served as
324 * There is a special-case: if the first page which the application tries to
325 * read happens to be the first page of the file, it is assumed that a linear
326 * read is about to happen and the window is immediately set to the initial size
327 * based on I/O request size and the max_readahead.
329 * The code ramps up the readahead size aggressively at first, but slow down as
330 * it approaches max_readhead.
334 * A minimal readahead algorithm for trivial sequential/random reads.
337 ondemand_readahead(struct address_space *mapping,
338 struct file_ra_state *ra, struct file *filp,
339 bool hit_readahead_marker, pgoff_t offset,
340 unsigned long req_size)
342 int max = ra->ra_pages; /* max readahead pages */
347 * It's the expected callback offset, assume sequential access.
348 * Ramp up sizes, and push forward the readahead window.
350 if (offset && (offset == (ra->start + ra->size - ra->async_size) ||
351 offset == (ra->start + ra->size))) {
352 ra->start += ra->size;
353 ra->size = get_next_ra_size(ra, max);
354 ra->async_size = ra->size;
358 prev_offset = ra->prev_pos >> PAGE_CACHE_SHIFT;
359 sequential = offset - prev_offset <= 1UL || req_size > max;
362 * Standalone, small read.
363 * Read as is, and do not pollute the readahead state.
365 if (!hit_readahead_marker && !sequential) {
366 return __do_page_cache_readahead(mapping, filp,
367 offset, req_size, 0);
371 * Hit a marked page without valid readahead state.
372 * E.g. interleaved reads.
373 * Query the pagecache for async_size, which normally equals to
374 * readahead size. Ramp it up and use it as the new readahead size.
376 if (hit_readahead_marker) {
379 read_lock_irq(&mapping->tree_lock);
380 start = radix_tree_next_hole(&mapping->page_tree, offset, max+1);
381 read_unlock_irq(&mapping->tree_lock);
383 if (!start || start - offset > max)
387 ra->size = start - offset; /* old async_size */
388 ra->size = get_next_ra_size(ra, max);
389 ra->async_size = ra->size;
395 * - first read on start of file
396 * - sequential cache miss
397 * - oversize random read
398 * Start readahead for it.
401 ra->size = get_init_ra_size(req_size, max);
402 ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
405 return ra_submit(ra, mapping, filp);
409 * page_cache_sync_readahead - generic file readahead
410 * @mapping: address_space which holds the pagecache and I/O vectors
411 * @ra: file_ra_state which holds the readahead state
412 * @filp: passed on to ->readpage() and ->readpages()
413 * @offset: start offset into @mapping, in pagecache page-sized units
414 * @req_size: hint: total size of the read which the caller is performing in
417 * page_cache_sync_readahead() should be called when a cache miss happened:
418 * it will submit the read. The readahead logic may decide to piggyback more
419 * pages onto the read request if access patterns suggest it will improve
422 void page_cache_sync_readahead(struct address_space *mapping,
423 struct file_ra_state *ra, struct file *filp,
424 pgoff_t offset, unsigned long req_size)
431 ondemand_readahead(mapping, ra, filp, false, offset, req_size);
433 EXPORT_SYMBOL_GPL(page_cache_sync_readahead);
436 * page_cache_async_readahead - file readahead for marked pages
437 * @mapping: address_space which holds the pagecache and I/O vectors
438 * @ra: file_ra_state which holds the readahead state
439 * @filp: passed on to ->readpage() and ->readpages()
440 * @page: the page at @offset which has the PG_readahead flag set
441 * @offset: start offset into @mapping, in pagecache page-sized units
442 * @req_size: hint: total size of the read which the caller is performing in
445 * page_cache_async_ondemand() should be called when a page is used which
446 * has the PG_readahead flag; this is a marker to suggest that the application
447 * has used up enough of the readahead window that we should start pulling in
451 page_cache_async_readahead(struct address_space *mapping,
452 struct file_ra_state *ra, struct file *filp,
453 struct page *page, pgoff_t offset,
454 unsigned long req_size)
461 * Same bit is used for PG_readahead and PG_reclaim.
463 if (PageWriteback(page))
466 ClearPageReadahead(page);
469 * Defer asynchronous read-ahead on IO congestion.
471 if (bdi_read_congested(mapping->backing_dev_info))
475 ondemand_readahead(mapping, ra, filp, true, offset, req_size);
477 EXPORT_SYMBOL_GPL(page_cache_async_readahead);