blob: daed28dd583031b4759f68b04cfb7e99c0f60d48 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * mm/readahead.c - address_space-level file readahead.
3 *
4 * Copyright (C) 2002, Linus Torvalds
5 *
Francois Camie1f8e872008-10-15 22:01:59 -07006 * 09Apr2002 Andrew Morton
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * Initial version.
8 */
9
10#include <linux/kernel.h>
11#include <linux/fs.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090012#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/mm.h>
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040014#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/blkdev.h>
16#include <linux/backing-dev.h>
Andrew Morton8bde37f2006-12-10 02:19:40 -080017#include <linux/task_io_accounting_ops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/pagevec.h>
Jens Axboef5ff8422007-09-21 09:19:54 +020019#include <linux/pagemap.h>
Cong Wang782182e2012-05-29 15:06:43 -070020#include <linux/syscalls.h>
21#include <linux/file.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023/*
24 * Initialise a struct file's readahead state. Assumes that the caller has
25 * memset *ra to zero.
26 */
27void
28file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
29{
30 ra->ra_pages = mapping->backing_dev_info->ra_pages;
Fengguang Wuf4e6b492007-10-16 01:24:33 -070031 ra->prev_pos = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070032}
Steven Whitehoused41cc702006-01-30 08:53:33 +000033EXPORT_SYMBOL_GPL(file_ra_state_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#define list_to_page(head) (list_entry((head)->prev, struct page, lru))
36
David Howells03fb3d22009-04-03 16:42:35 +010037/*
38 * see if a page needs releasing upon read_cache_pages() failure
David Howells266cf652009-04-03 16:42:36 +010039 * - the caller of read_cache_pages() may have set PG_private or PG_fscache
40 * before calling, such as the NFS fs marking pages that are cached locally
41 * on disk, thus we need to give the fs a chance to clean up in the event of
42 * an error
David Howells03fb3d22009-04-03 16:42:35 +010043 */
44static void read_cache_pages_invalidate_page(struct address_space *mapping,
45 struct page *page)
46{
David Howells266cf652009-04-03 16:42:36 +010047 if (page_has_private(page)) {
David Howells03fb3d22009-04-03 16:42:35 +010048 if (!trylock_page(page))
49 BUG();
50 page->mapping = mapping;
51 do_invalidatepage(page, 0);
52 page->mapping = NULL;
53 unlock_page(page);
54 }
55 page_cache_release(page);
56}
57
58/*
59 * release a list of pages, invalidating them first if need be
60 */
61static void read_cache_pages_invalidate_pages(struct address_space *mapping,
62 struct list_head *pages)
63{
64 struct page *victim;
65
66 while (!list_empty(pages)) {
67 victim = list_to_page(pages);
68 list_del(&victim->lru);
69 read_cache_pages_invalidate_page(mapping, victim);
70 }
71}
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073/**
Randy Dunlapbd40cdd2006-06-25 05:48:08 -070074 * read_cache_pages - populate an address space with some pages & start reads against them
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * @mapping: the address_space
76 * @pages: The address of a list_head which contains the target pages. These
77 * pages have their ->index populated and are otherwise uninitialised.
78 * @filler: callback routine for filling a single page.
79 * @data: private data for the callback routine.
80 *
81 * Hides the details of the LRU cache etc from the filesystems.
82 */
83int read_cache_pages(struct address_space *mapping, struct list_head *pages,
84 int (*filler)(void *, struct page *), void *data)
85{
86 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 int ret = 0;
88
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 while (!list_empty(pages)) {
90 page = list_to_page(pages);
91 list_del(&page->lru);
Nick Piggineb2be182007-10-16 01:24:57 -070092 if (add_to_page_cache_lru(page, mapping,
93 page->index, GFP_KERNEL)) {
David Howells03fb3d22009-04-03 16:42:35 +010094 read_cache_pages_invalidate_page(mapping, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 continue;
96 }
Nick Piggineb2be182007-10-16 01:24:57 -070097 page_cache_release(page);
98
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 ret = filler(data, page);
Nick Piggineb2be182007-10-16 01:24:57 -0700100 if (unlikely(ret)) {
David Howells03fb3d22009-04-03 16:42:35 +0100101 read_cache_pages_invalidate_pages(mapping, pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 break;
103 }
Andrew Morton8bde37f2006-12-10 02:19:40 -0800104 task_io_account_read(PAGE_CACHE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 return ret;
107}
108
109EXPORT_SYMBOL(read_cache_pages);
110
111static int read_pages(struct address_space *mapping, struct file *filp,
112 struct list_head *pages, unsigned nr_pages)
113{
Jens Axboe5b417b12010-04-19 10:04:38 +0200114 struct blk_plug plug;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 unsigned page_idx;
Zach Brown994fc28c2005-12-15 14:28:17 -0800116 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Jens Axboe5b417b12010-04-19 10:04:38 +0200118 blk_start_plug(&plug);
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 if (mapping->a_ops->readpages) {
121 ret = mapping->a_ops->readpages(filp, mapping, pages, nr_pages);
OGAWA Hirofumi029e3322006-11-02 22:07:06 -0800122 /* Clean up the remaining pages */
123 put_pages_list(pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 goto out;
125 }
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 for (page_idx = 0; page_idx < nr_pages; page_idx++) {
128 struct page *page = list_to_page(pages);
129 list_del(&page->lru);
Nick Piggineb2be182007-10-16 01:24:57 -0700130 if (!add_to_page_cache_lru(page, mapping,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 page->index, GFP_KERNEL)) {
Zach Brown9f1a3cf2006-06-25 05:46:46 -0700132 mapping->a_ops->readpage(filp, page);
Nick Piggineb2be182007-10-16 01:24:57 -0700133 }
134 page_cache_release(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 }
Zach Brown994fc28c2005-12-15 14:28:17 -0800136 ret = 0;
Jens Axboe5b417b12010-04-19 10:04:38 +0200137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138out:
Jens Axboe5b417b12010-04-19 10:04:38 +0200139 blk_finish_plug(&plug);
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 return ret;
142}
143
144/*
Wu Fengguangd30a1102009-06-16 15:31:30 -0700145 * __do_page_cache_readahead() actually reads a chunk of disk. It allocates all
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 * the pages first, then submits them all for I/O. This avoids the very bad
147 * behaviour which would occur if page allocations are causing VM writeback.
148 * We really don't want to intermingle reads and writes like that.
149 *
150 * Returns the number of pages requested, or the maximum amount of I/O allowed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 */
152static int
153__do_page_cache_readahead(struct address_space *mapping, struct file *filp,
Fengguang Wu46fc3e72007-07-19 01:47:57 -0700154 pgoff_t offset, unsigned long nr_to_read,
155 unsigned long lookahead_size)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156{
157 struct inode *inode = mapping->host;
158 struct page *page;
159 unsigned long end_index; /* The last page we want to read */
160 LIST_HEAD(page_pool);
161 int page_idx;
162 int ret = 0;
163 loff_t isize = i_size_read(inode);
164
165 if (isize == 0)
166 goto out;
167
Fengguang Wu46fc3e72007-07-19 01:47:57 -0700168 end_index = ((isize - 1) >> PAGE_CACHE_SHIFT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170 /*
171 * Preallocate as many pages as we will need.
172 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 for (page_idx = 0; page_idx < nr_to_read; page_idx++) {
Andrew Morton7361f4d2005-11-07 00:59:28 -0800174 pgoff_t page_offset = offset + page_idx;
Fengguang Wuc743d962007-07-19 01:48:04 -0700175
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 if (page_offset > end_index)
177 break;
178
Nick Piggin00128182007-10-16 01:24:40 -0700179 rcu_read_lock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180 page = radix_tree_lookup(&mapping->page_tree, page_offset);
Nick Piggin00128182007-10-16 01:24:40 -0700181 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 if (page)
183 continue;
184
Wu Fengguang7b1de582011-05-24 17:12:25 -0700185 page = page_cache_alloc_readahead(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 if (!page)
187 break;
188 page->index = page_offset;
189 list_add(&page->lru, &page_pool);
Fengguang Wu46fc3e72007-07-19 01:47:57 -0700190 if (page_idx == nr_to_read - lookahead_size)
191 SetPageReadahead(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 ret++;
193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
195 /*
196 * Now start the IO. We ignore I/O errors - if the page is not
197 * uptodate then the caller will launch readpage again, and
198 * will then handle the error.
199 */
200 if (ret)
201 read_pages(mapping, filp, &page_pool, ret);
202 BUG_ON(!list_empty(&page_pool));
203out:
204 return ret;
205}
206
207/*
208 * Chunk the readahead into 2 megabyte units, so that we don't pin too much
209 * memory at once.
210 */
211int force_page_cache_readahead(struct address_space *mapping, struct file *filp,
Andrew Morton7361f4d2005-11-07 00:59:28 -0800212 pgoff_t offset, unsigned long nr_to_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213{
214 int ret = 0;
215
216 if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages))
217 return -EINVAL;
218
Wu Fengguangf7e839d2009-06-16 15:31:20 -0700219 nr_to_read = max_sane_readahead(nr_to_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 while (nr_to_read) {
221 int err;
222
223 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_CACHE_SIZE;
224
225 if (this_chunk > nr_to_read)
226 this_chunk = nr_to_read;
227 err = __do_page_cache_readahead(mapping, filp,
Fengguang Wu46fc3e72007-07-19 01:47:57 -0700228 offset, this_chunk, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 if (err < 0) {
230 ret = err;
231 break;
232 }
233 ret += err;
234 offset += this_chunk;
235 nr_to_read -= this_chunk;
236 }
237 return ret;
238}
239
240/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241 * Given a desired number of PAGE_CACHE_SIZE readahead pages, return a
242 * sensible upper limit.
243 */
244unsigned long max_sane_readahead(unsigned long nr)
245{
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700246 return min(nr, (node_page_state(numa_node_id(), NR_INACTIVE_FILE)
Christoph Lameter05a04162007-02-10 01:43:05 -0800247 + node_page_state(numa_node_id(), NR_FREE_PAGES)) / 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248}
Fengguang Wu5ce11102007-07-19 01:47:59 -0700249
250/*
251 * Submit IO for the read-ahead request in file_ra_state.
252 */
Wu Fengguangd30a1102009-06-16 15:31:30 -0700253unsigned long ra_submit(struct file_ra_state *ra,
Fengguang Wu5ce11102007-07-19 01:47:59 -0700254 struct address_space *mapping, struct file *filp)
255{
Fengguang Wu5ce11102007-07-19 01:47:59 -0700256 int actual;
257
Fengguang Wu5ce11102007-07-19 01:47:59 -0700258 actual = __do_page_cache_readahead(mapping, filp,
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700259 ra->start, ra->size, ra->async_size);
Fengguang Wu5ce11102007-07-19 01:47:59 -0700260
261 return actual;
262}
Fengguang Wu122a21d2007-07-19 01:48:01 -0700263
264/*
Fengguang Wuc743d962007-07-19 01:48:04 -0700265 * Set the initial window size, round to next power of 2 and square
266 * for small size, x 4 for medium, and x 2 for large
267 * for 128k (32 page) max ra
268 * 1-8 page = 32k initial, > 8 page = 128k initial
269 */
270static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
271{
272 unsigned long newsize = roundup_pow_of_two(size);
273
274 if (newsize <= max / 32)
275 newsize = newsize * 4;
276 else if (newsize <= max / 4)
277 newsize = newsize * 2;
278 else
279 newsize = max;
280
281 return newsize;
282}
283
284/*
Fengguang Wu122a21d2007-07-19 01:48:01 -0700285 * Get the previous window size, ramp it up, and
286 * return it as the new window size.
287 */
Fengguang Wuc743d962007-07-19 01:48:04 -0700288static unsigned long get_next_ra_size(struct file_ra_state *ra,
Fengguang Wu122a21d2007-07-19 01:48:01 -0700289 unsigned long max)
290{
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700291 unsigned long cur = ra->size;
Fengguang Wu122a21d2007-07-19 01:48:01 -0700292 unsigned long newsize;
293
294 if (cur < max / 16)
Fengguang Wuc743d962007-07-19 01:48:04 -0700295 newsize = 4 * cur;
Fengguang Wu122a21d2007-07-19 01:48:01 -0700296 else
Fengguang Wuc743d962007-07-19 01:48:04 -0700297 newsize = 2 * cur;
Fengguang Wu122a21d2007-07-19 01:48:01 -0700298
299 return min(newsize, max);
300}
301
302/*
303 * On-demand readahead design.
304 *
305 * The fields in struct file_ra_state represent the most-recently-executed
306 * readahead attempt:
307 *
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700308 * |<----- async_size ---------|
309 * |------------------- size -------------------->|
310 * |==================#===========================|
311 * ^start ^page marked with PG_readahead
Fengguang Wu122a21d2007-07-19 01:48:01 -0700312 *
313 * To overlap application thinking time and disk I/O time, we do
314 * `readahead pipelining': Do not wait until the application consumed all
315 * readahead pages and stalled on the missing page at readahead_index;
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700316 * Instead, submit an asynchronous readahead I/O as soon as there are
317 * only async_size pages left in the readahead window. Normally async_size
318 * will be equal to size, for maximum pipelining.
Fengguang Wu122a21d2007-07-19 01:48:01 -0700319 *
320 * In interleaved sequential reads, concurrent streams on the same fd can
321 * be invalidating each other's readahead state. So we flag the new readahead
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700322 * page at (start+size-async_size) with PG_readahead, and use it as readahead
Fengguang Wu122a21d2007-07-19 01:48:01 -0700323 * indicator. The flag won't be set on already cached pages, to avoid the
324 * readahead-for-nothing fuss, saving pointless page cache lookups.
325 *
Fengguang Wuf4e6b492007-10-16 01:24:33 -0700326 * prev_pos tracks the last visited byte in the _previous_ read request.
Fengguang Wu122a21d2007-07-19 01:48:01 -0700327 * It should be maintained by the caller, and will be used for detecting
328 * small random reads. Note that the readahead algorithm checks loosely
329 * for sequential patterns. Hence interleaved reads might be served as
330 * sequential ones.
331 *
332 * There is a special-case: if the first page which the application tries to
333 * read happens to be the first page of the file, it is assumed that a linear
334 * read is about to happen and the window is immediately set to the initial size
335 * based on I/O request size and the max_readahead.
336 *
337 * The code ramps up the readahead size aggressively at first, but slow down as
338 * it approaches max_readhead.
339 */
340
341/*
Wu Fengguang10be0b32009-06-16 15:31:36 -0700342 * Count contiguously cached pages from @offset-1 to @offset-@max,
343 * this count is a conservative estimation of
344 * - length of the sequential read sequence, or
345 * - thrashing threshold in memory tight systems
346 */
347static pgoff_t count_history_pages(struct address_space *mapping,
348 struct file_ra_state *ra,
349 pgoff_t offset, unsigned long max)
350{
351 pgoff_t head;
352
353 rcu_read_lock();
354 head = radix_tree_prev_hole(&mapping->page_tree, offset - 1, max);
355 rcu_read_unlock();
356
357 return offset - 1 - head;
358}
359
360/*
361 * page cache context based read-ahead
362 */
363static int try_context_readahead(struct address_space *mapping,
364 struct file_ra_state *ra,
365 pgoff_t offset,
366 unsigned long req_size,
367 unsigned long max)
368{
369 pgoff_t size;
370
371 size = count_history_pages(mapping, ra, offset, max);
372
373 /*
374 * no history pages:
375 * it could be a random read
376 */
377 if (!size)
378 return 0;
379
380 /*
381 * starts from beginning of file:
382 * it is a strong indication of long-run stream (or whole-file-read)
383 */
384 if (size >= offset)
385 size *= 2;
386
387 ra->start = offset;
388 ra->size = get_init_ra_size(size + req_size, max);
389 ra->async_size = ra->size;
390
391 return 1;
392}
393
394/*
Fengguang Wu122a21d2007-07-19 01:48:01 -0700395 * A minimal readahead algorithm for trivial sequential/random reads.
396 */
397static unsigned long
398ondemand_readahead(struct address_space *mapping,
399 struct file_ra_state *ra, struct file *filp,
Rusty Russellcf914a72007-07-19 01:48:08 -0700400 bool hit_readahead_marker, pgoff_t offset,
Fengguang Wu122a21d2007-07-19 01:48:01 -0700401 unsigned long req_size)
402{
Wu Fengguangfc31d162009-06-16 15:31:21 -0700403 unsigned long max = max_sane_readahead(ra->ra_pages);
Wu Fengguang045a2522009-06-16 15:31:33 -0700404
405 /*
406 * start of file
407 */
408 if (!offset)
409 goto initial_readahead;
Fengguang Wu122a21d2007-07-19 01:48:01 -0700410
411 /*
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700412 * It's the expected callback offset, assume sequential access.
Fengguang Wu122a21d2007-07-19 01:48:01 -0700413 * Ramp up sizes, and push forward the readahead window.
414 */
Wu Fengguang045a2522009-06-16 15:31:33 -0700415 if ((offset == (ra->start + ra->size - ra->async_size) ||
416 offset == (ra->start + ra->size))) {
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700417 ra->start += ra->size;
418 ra->size = get_next_ra_size(ra, max);
419 ra->async_size = ra->size;
420 goto readit;
Fengguang Wu122a21d2007-07-19 01:48:01 -0700421 }
422
Fengguang Wu122a21d2007-07-19 01:48:01 -0700423 /*
Fengguang Wu6b10c6c2007-10-16 01:24:34 -0700424 * Hit a marked page without valid readahead state.
425 * E.g. interleaved reads.
426 * Query the pagecache for async_size, which normally equals to
427 * readahead size. Ramp it up and use it as the new readahead size.
428 */
429 if (hit_readahead_marker) {
430 pgoff_t start;
431
Nick Piggin30002ed2008-07-25 19:45:28 -0700432 rcu_read_lock();
Wu Fengguangcaca7cb2009-06-16 15:31:21 -0700433 start = radix_tree_next_hole(&mapping->page_tree, offset+1,max);
Nick Piggin30002ed2008-07-25 19:45:28 -0700434 rcu_read_unlock();
Fengguang Wu6b10c6c2007-10-16 01:24:34 -0700435
436 if (!start || start - offset > max)
437 return 0;
438
439 ra->start = start;
440 ra->size = start - offset; /* old async_size */
Wu Fengguang160334a2009-06-16 15:31:23 -0700441 ra->size += req_size;
Fengguang Wu6b10c6c2007-10-16 01:24:34 -0700442 ra->size = get_next_ra_size(ra, max);
443 ra->async_size = ra->size;
444 goto readit;
445 }
446
447 /*
Wu Fengguang045a2522009-06-16 15:31:33 -0700448 * oversize read
Fengguang Wu122a21d2007-07-19 01:48:01 -0700449 */
Wu Fengguang045a2522009-06-16 15:31:33 -0700450 if (req_size > max)
451 goto initial_readahead;
452
453 /*
454 * sequential cache miss
455 */
456 if (offset - (ra->prev_pos >> PAGE_CACHE_SHIFT) <= 1UL)
457 goto initial_readahead;
458
459 /*
Wu Fengguang10be0b32009-06-16 15:31:36 -0700460 * Query the page cache and look for the traces(cached history pages)
461 * that a sequential stream would leave behind.
462 */
463 if (try_context_readahead(mapping, ra, offset, req_size, max))
464 goto readit;
465
466 /*
Wu Fengguang045a2522009-06-16 15:31:33 -0700467 * standalone, small random read
468 * Read as is, and do not pollute the readahead state.
469 */
470 return __do_page_cache_readahead(mapping, filp, offset, req_size, 0);
471
472initial_readahead:
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700473 ra->start = offset;
474 ra->size = get_init_ra_size(req_size, max);
475 ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
Fengguang Wu122a21d2007-07-19 01:48:01 -0700476
Fengguang Wuf9acc8c2007-07-19 01:48:08 -0700477readit:
Wu Fengguang51daa882009-06-16 15:31:24 -0700478 /*
479 * Will this read hit the readahead marker made by itself?
480 * If so, trigger the readahead marker hit now, and merge
481 * the resulted next readahead window into the current one.
482 */
483 if (offset == ra->start && ra->size == ra->async_size) {
484 ra->async_size = get_next_ra_size(ra, max);
485 ra->size += ra->async_size;
486 }
487
Fengguang Wu122a21d2007-07-19 01:48:01 -0700488 return ra_submit(ra, mapping, filp);
489}
490
491/**
Rusty Russellcf914a72007-07-19 01:48:08 -0700492 * page_cache_sync_readahead - generic file readahead
Fengguang Wu122a21d2007-07-19 01:48:01 -0700493 * @mapping: address_space which holds the pagecache and I/O vectors
494 * @ra: file_ra_state which holds the readahead state
495 * @filp: passed on to ->readpage() and ->readpages()
Rusty Russellcf914a72007-07-19 01:48:08 -0700496 * @offset: start offset into @mapping, in pagecache page-sized units
Fengguang Wu122a21d2007-07-19 01:48:01 -0700497 * @req_size: hint: total size of the read which the caller is performing in
Rusty Russellcf914a72007-07-19 01:48:08 -0700498 * pagecache pages
Fengguang Wu122a21d2007-07-19 01:48:01 -0700499 *
Rusty Russellcf914a72007-07-19 01:48:08 -0700500 * page_cache_sync_readahead() should be called when a cache miss happened:
501 * it will submit the read. The readahead logic may decide to piggyback more
502 * pages onto the read request if access patterns suggest it will improve
503 * performance.
Fengguang Wu122a21d2007-07-19 01:48:01 -0700504 */
Rusty Russellcf914a72007-07-19 01:48:08 -0700505void page_cache_sync_readahead(struct address_space *mapping,
506 struct file_ra_state *ra, struct file *filp,
507 pgoff_t offset, unsigned long req_size)
Fengguang Wu122a21d2007-07-19 01:48:01 -0700508{
509 /* no read-ahead */
510 if (!ra->ra_pages)
Rusty Russellcf914a72007-07-19 01:48:08 -0700511 return;
Fengguang Wu122a21d2007-07-19 01:48:01 -0700512
Wu Fengguang01414502010-03-05 13:42:03 -0800513 /* be dumb */
Wu Fengguang70655c02010-04-06 14:34:53 -0700514 if (filp && (filp->f_mode & FMODE_RANDOM)) {
Wu Fengguang01414502010-03-05 13:42:03 -0800515 force_page_cache_readahead(mapping, filp, offset, req_size);
516 return;
517 }
518
Fengguang Wu122a21d2007-07-19 01:48:01 -0700519 /* do read-ahead */
Rusty Russellcf914a72007-07-19 01:48:08 -0700520 ondemand_readahead(mapping, ra, filp, false, offset, req_size);
Fengguang Wu122a21d2007-07-19 01:48:01 -0700521}
Rusty Russellcf914a72007-07-19 01:48:08 -0700522EXPORT_SYMBOL_GPL(page_cache_sync_readahead);
523
524/**
525 * page_cache_async_readahead - file readahead for marked pages
526 * @mapping: address_space which holds the pagecache and I/O vectors
527 * @ra: file_ra_state which holds the readahead state
528 * @filp: passed on to ->readpage() and ->readpages()
529 * @page: the page at @offset which has the PG_readahead flag set
530 * @offset: start offset into @mapping, in pagecache page-sized units
531 * @req_size: hint: total size of the read which the caller is performing in
532 * pagecache pages
533 *
Huang Shijiebf8abe82010-05-24 14:32:36 -0700534 * page_cache_async_readahead() should be called when a page is used which
Randy Dunlapf7850d92008-03-19 17:01:02 -0700535 * has the PG_readahead flag; this is a marker to suggest that the application
Rusty Russellcf914a72007-07-19 01:48:08 -0700536 * has used up enough of the readahead window that we should start pulling in
Randy Dunlapf7850d92008-03-19 17:01:02 -0700537 * more pages.
538 */
Rusty Russellcf914a72007-07-19 01:48:08 -0700539void
540page_cache_async_readahead(struct address_space *mapping,
541 struct file_ra_state *ra, struct file *filp,
542 struct page *page, pgoff_t offset,
543 unsigned long req_size)
544{
545 /* no read-ahead */
546 if (!ra->ra_pages)
547 return;
548
549 /*
550 * Same bit is used for PG_readahead and PG_reclaim.
551 */
552 if (PageWriteback(page))
553 return;
554
555 ClearPageReadahead(page);
556
557 /*
558 * Defer asynchronous read-ahead on IO congestion.
559 */
560 if (bdi_read_congested(mapping->backing_dev_info))
561 return;
562
563 /* do read-ahead */
564 ondemand_readahead(mapping, ra, filp, true, offset, req_size);
565}
566EXPORT_SYMBOL_GPL(page_cache_async_readahead);
Cong Wang782182e2012-05-29 15:06:43 -0700567
568static ssize_t
569do_readahead(struct address_space *mapping, struct file *filp,
570 pgoff_t index, unsigned long nr)
571{
572 if (!mapping || !mapping->a_ops || !mapping->a_ops->readpage)
573 return -EINVAL;
574
575 force_page_cache_readahead(mapping, filp, index, nr);
576 return 0;
577}
578
Al Viro4a0fd5b2013-01-21 15:16:58 -0500579SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
Cong Wang782182e2012-05-29 15:06:43 -0700580{
581 ssize_t ret;
Al Viro2903ff02012-08-28 12:52:22 -0400582 struct fd f;
Cong Wang782182e2012-05-29 15:06:43 -0700583
584 ret = -EBADF;
Al Viro2903ff02012-08-28 12:52:22 -0400585 f = fdget(fd);
586 if (f.file) {
587 if (f.file->f_mode & FMODE_READ) {
588 struct address_space *mapping = f.file->f_mapping;
Cong Wang782182e2012-05-29 15:06:43 -0700589 pgoff_t start = offset >> PAGE_CACHE_SHIFT;
590 pgoff_t end = (offset + count - 1) >> PAGE_CACHE_SHIFT;
591 unsigned long len = end - start + 1;
Al Viro2903ff02012-08-28 12:52:22 -0400592 ret = do_readahead(mapping, f.file, start, len);
Cong Wang782182e2012-05-29 15:06:43 -0700593 }
Al Viro2903ff02012-08-28 12:52:22 -0400594 fdput(f);
Cong Wang782182e2012-05-29 15:06:43 -0700595 }
596 return ret;
597}