Branch data Line data Source code
1 : : /*
2 : : * mm/readahead.c - address_space-level file readahead.
3 : : *
4 : : * Copyright (C) 2002, Linus Torvalds
5 : : *
6 : : * 09Apr2002 Andrew Morton
7 : : * Initial version.
8 : : */
9 : :
10 : : #include <linux/kernel.h>
11 : : #include <linux/fs.h>
12 : : #include <linux/gfp.h>
13 : : #include <linux/mm.h>
14 : : #include <linux/export.h>
15 : : #include <linux/blkdev.h>
16 : : #include <linux/backing-dev.h>
17 : : #include <linux/task_io_accounting_ops.h>
18 : : #include <linux/pagevec.h>
19 : : #include <linux/pagemap.h>
20 : : #include <linux/syscalls.h>
21 : : #include <linux/file.h>
22 : :
23 : : /*
24 : : * Initialise a struct file's readahead state. Assumes that the caller has
25 : : * memset *ra to zero.
26 : : */
27 : : void
28 : 0 : file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
29 : : {
30 : 2463338 : ra->ra_pages = mapping->backing_dev_info->ra_pages;
31 : 2463338 : ra->prev_pos = -1;
32 : 2463338 : }
33 : : EXPORT_SYMBOL_GPL(file_ra_state_init);
34 : :
35 : : #define list_to_page(head) (list_entry((head)->prev, struct page, lru))
36 : :
37 : : /*
38 : : * see if a page needs releasing upon read_cache_pages() failure
39 : : * - 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
43 : : */
44 : 0 : static void read_cache_pages_invalidate_page(struct address_space *mapping,
45 : 0 : struct page *page)
46 : : {
47 [ # # ]: 0 : if (page_has_private(page)) {
48 [ # # ]: 0 : if (!trylock_page(page))
49 : 0 : BUG();
50 : 0 : page->mapping = mapping;
51 : 0 : do_invalidatepage(page, 0, PAGE_CACHE_SIZE);
52 : 0 : page->mapping = NULL;
53 : 0 : unlock_page(page);
54 : : }
55 : 0 : page_cache_release(page);
56 : 0 : }
57 : :
58 : : /*
59 : : * release a list of pages, invalidating them first if need be
60 : : */
61 : 0 : static void read_cache_pages_invalidate_pages(struct address_space *mapping,
62 : : struct list_head *pages)
63 : : {
64 : : struct page *victim;
65 : :
66 [ # # ]: 0 : while (!list_empty(pages)) {
67 : 0 : victim = list_to_page(pages);
68 : : list_del(&victim->lru);
69 : 0 : read_cache_pages_invalidate_page(mapping, victim);
70 : : }
71 : 0 : }
72 : :
73 : : /**
74 : : * read_cache_pages - populate an address space with some pages & start reads against them
75 : : * @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 : : */
83 : 0 : int read_cache_pages(struct address_space *mapping, struct list_head *pages,
84 : : int (*filler)(void *, struct page *), void *data)
85 : : {
86 : : struct page *page;
87 : : int ret = 0;
88 : :
89 [ # # ]: 0 : while (!list_empty(pages)) {
90 : 0 : page = list_to_page(pages);
91 : : list_del(&page->lru);
92 [ # # ]: 0 : if (add_to_page_cache_lru(page, mapping,
93 : : page->index, GFP_KERNEL)) {
94 : 0 : read_cache_pages_invalidate_page(mapping, page);
95 : 0 : continue;
96 : : }
97 : 0 : page_cache_release(page);
98 : :
99 : 0 : ret = filler(data, page);
100 [ # # ]: 0 : if (unlikely(ret)) {
101 : 0 : read_cache_pages_invalidate_pages(mapping, pages);
102 : 0 : break;
103 : : }
104 : : task_io_account_read(PAGE_CACHE_SIZE);
105 : : }
106 : 0 : return ret;
107 : : }
108 : :
109 : : EXPORT_SYMBOL(read_cache_pages);
110 : :
111 : 0 : static int read_pages(struct address_space *mapping, struct file *filp,
112 : : struct list_head *pages, unsigned nr_pages)
113 : : {
114 : : struct blk_plug plug;
115 : : unsigned page_idx;
116 : : int ret;
117 : :
118 : 119298 : blk_start_plug(&plug);
119 : :
120 [ + + ]: 119257 : if (mapping->a_ops->readpages) {
121 : 118661 : ret = mapping->a_ops->readpages(filp, mapping, pages, nr_pages);
122 : : /* Clean up the remaining pages */
123 : 118727 : put_pages_list(pages);
124 : 118743 : goto out;
125 : : }
126 : :
127 [ + + ]: 1859 : for (page_idx = 0; page_idx < nr_pages; page_idx++) {
128 : 1263 : struct page *page = list_to_page(pages);
129 : : list_del(&page->lru);
130 [ + - ]: 1263 : if (!add_to_page_cache_lru(page, mapping,
131 : : page->index, GFP_KERNEL)) {
132 : 1263 : mapping->a_ops->readpage(filp, page);
133 : : }
134 : 1263 : page_cache_release(page);
135 : : }
136 : : ret = 0;
137 : :
138 : : out:
139 : 119339 : blk_finish_plug(&plug);
140 : :
141 : 119336 : return ret;
142 : : }
143 : :
144 : : /*
145 : : * __do_page_cache_readahead() actually reads a chunk of disk. It allocates all
146 : : * 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.
151 : : */
152 : : static int
153 : 0 : __do_page_cache_readahead(struct address_space *mapping, struct file *filp,
154 : : pgoff_t offset, unsigned long nr_to_read,
155 : : unsigned long lookahead_size)
156 : : {
157 : 138833 : struct inode *inode = mapping->host;
158 : : struct page *page;
159 : : unsigned long end_index; /* The last page we want to read */
160 : 138833 : LIST_HEAD(page_pool);
161 : : int page_idx;
162 : : int ret = 0;
163 : : loff_t isize = i_size_read(inode);
164 : :
165 [ + + ]: 138761 : if (isize == 0)
166 : : goto out;
167 : :
168 : 138223 : end_index = ((isize - 1) >> PAGE_CACHE_SHIFT);
169 : :
170 : : /*
171 : : * Preallocate as many pages as we will need.
172 : : */
173 [ + + ]: 595060 : for (page_idx = 0; page_idx < nr_to_read; page_idx++) {
174 : 501524 : pgoff_t page_offset = offset + page_idx;
175 : :
176 [ + + ]: 501524 : if (page_offset > end_index)
177 : : break;
178 : :
179 : : rcu_read_lock();
180 : 456949 : page = radix_tree_lookup(&mapping->page_tree, page_offset);
181 : : rcu_read_unlock();
182 [ + + ]: 595677 : if (page)
183 : 46084 : continue;
184 : :
185 : : page = page_cache_alloc_readahead(mapping);
186 [ + + ]: 410754 : if (!page)
187 : : break;
188 : 410705 : page->index = page_offset;
189 : 410705 : list_add(&page->lru, &page_pool);
190 [ + + ]: 410705 : if (page_idx == nr_to_read - lookahead_size)
191 : : SetPageReadahead(page);
192 : 410753 : ret++;
193 : : }
194 : :
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 [ + + ]: 138192 : if (ret)
201 : 119226 : read_pages(mapping, filp, &page_pool, ret);
202 [ - + ]: 138285 : BUG_ON(!list_empty(&page_pool));
203 : : out:
204 : 138823 : 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 : : */
211 : 0 : int force_page_cache_readahead(struct address_space *mapping, struct file *filp,
212 : : pgoff_t offset, unsigned long nr_to_read)
213 : : {
214 [ + + ][ - + ]: 578 : if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages))
215 : : return -EINVAL;
216 : :
217 : : nr_to_read = max_sane_readahead(nr_to_read);
218 [ + + ]: 2118 : while (nr_to_read) {
219 : : int err;
220 : :
221 : : unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_CACHE_SIZE;
222 : :
223 [ + + ]: 1544 : if (this_chunk > nr_to_read)
224 : : this_chunk = nr_to_read;
225 : 1544 : err = __do_page_cache_readahead(mapping, filp,
226 : : offset, this_chunk, 0);
227 [ + - ]: 1544 : if (err < 0)
228 : : return err;
229 : :
230 : 1544 : offset += this_chunk;
231 : 1544 : nr_to_read -= this_chunk;
232 : : }
233 : : return 0;
234 : : }
235 : :
236 : : /*
237 : : * Given a desired number of PAGE_CACHE_SIZE readahead pages, return a
238 : : * sensible upper limit.
239 : : */
240 : 0 : unsigned long max_sane_readahead(unsigned long nr)
241 : : {
242 : 134948 : return min(nr, (node_page_state(numa_node_id(), NR_INACTIVE_FILE)
243 : : + node_page_state(numa_node_id(), NR_FREE_PAGES)) / 2);
244 : : }
245 : :
246 : : /*
247 : : * Submit IO for the read-ahead request in file_ra_state.
248 : : */
249 : 0 : unsigned long ra_submit(struct file_ra_state *ra,
250 : : struct address_space *mapping, struct file *filp)
251 : : {
252 : : int actual;
253 : :
254 : 52460 : actual = __do_page_cache_readahead(mapping, filp,
255 : 52460 : ra->start, ra->size, ra->async_size);
256 : :
257 : 52472 : return actual;
258 : : }
259 : :
260 : : /*
261 : : * Set the initial window size, round to next power of 2 and square
262 : : * for small size, x 4 for medium, and x 2 for large
263 : : * for 128k (32 page) max ra
264 : : * 1-8 page = 32k initial, > 8 page = 128k initial
265 : : */
266 : 0 : static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
267 : : {
268 [ - + ][ # # ]: 20761 : unsigned long newsize = roundup_pow_of_two(size);
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
269 : :
270 [ + + ]: 20761 : if (newsize <= max / 32)
271 : 18965 : newsize = newsize * 4;
272 [ + + ]: 1796 : else if (newsize <= max / 4)
273 : 1566 : newsize = newsize * 2;
274 : : else
275 : : newsize = max;
276 : :
277 : 0 : return newsize;
278 : : }
279 : :
280 : : /*
281 : : * Get the previous window size, ramp it up, and
282 : : * return it as the new window size.
283 : : */
284 : : static unsigned long get_next_ra_size(struct file_ra_state *ra,
285 : : unsigned long max)
286 : : {
287 : : unsigned long cur = ra->size;
288 : : unsigned long newsize;
289 : :
290 [ - + ][ - + ]: 20797 : if (cur < max / 16)
[ - + ]
291 : 0 : newsize = 4 * cur;
292 : : else
293 : 20797 : newsize = 2 * cur;
294 : :
295 : 20797 : return min(newsize, max);
296 : : }
297 : :
298 : : /*
299 : : * On-demand readahead design.
300 : : *
301 : : * The fields in struct file_ra_state represent the most-recently-executed
302 : : * readahead attempt:
303 : : *
304 : : * |<----- async_size ---------|
305 : : * |------------------- size -------------------->|
306 : : * |==================#===========================|
307 : : * ^start ^page marked with PG_readahead
308 : : *
309 : : * To overlap application thinking time and disk I/O time, we do
310 : : * `readahead pipelining': Do not wait until the application consumed all
311 : : * readahead pages and stalled on the missing page at readahead_index;
312 : : * Instead, submit an asynchronous readahead I/O as soon as there are
313 : : * only async_size pages left in the readahead window. Normally async_size
314 : : * will be equal to size, for maximum pipelining.
315 : : *
316 : : * In interleaved sequential reads, concurrent streams on the same fd can
317 : : * be invalidating each other's readahead state. So we flag the new readahead
318 : : * page at (start+size-async_size) with PG_readahead, and use it as readahead
319 : : * indicator. The flag won't be set on already cached pages, to avoid the
320 : : * readahead-for-nothing fuss, saving pointless page cache lookups.
321 : : *
322 : : * prev_pos tracks the last visited byte in the _previous_ read request.
323 : : * It should be maintained by the caller, and will be used for detecting
324 : : * small random reads. Note that the readahead algorithm checks loosely
325 : : * for sequential patterns. Hence interleaved reads might be served as
326 : : * sequential ones.
327 : : *
328 : : * There is a special-case: if the first page which the application tries to
329 : : * read happens to be the first page of the file, it is assumed that a linear
330 : : * read is about to happen and the window is immediately set to the initial size
331 : : * based on I/O request size and the max_readahead.
332 : : *
333 : : * The code ramps up the readahead size aggressively at first, but slow down as
334 : : * it approaches max_readhead.
335 : : */
336 : :
337 : : /*
338 : : * Count contiguously cached pages from @offset-1 to @offset-@max,
339 : : * this count is a conservative estimation of
340 : : * - length of the sequential read sequence, or
341 : : * - thrashing threshold in memory tight systems
342 : : */
343 : : static pgoff_t count_history_pages(struct address_space *mapping,
344 : : struct file_ra_state *ra,
345 : : pgoff_t offset, unsigned long max)
346 : : {
347 : : pgoff_t head;
348 : :
349 : : rcu_read_lock();
350 : 92976 : head = radix_tree_prev_hole(&mapping->page_tree, offset - 1, max);
351 : : rcu_read_unlock();
352 : :
353 : 92983 : return offset - 1 - head;
354 : : }
355 : :
356 : : /*
357 : : * page cache context based read-ahead
358 : : */
359 : 0 : static int try_context_readahead(struct address_space *mapping,
360 : : struct file_ra_state *ra,
361 : : pgoff_t offset,
362 : : unsigned long req_size,
363 : : unsigned long max)
364 : : {
365 : : pgoff_t size;
366 : :
367 : : size = count_history_pages(mapping, ra, offset, max);
368 : :
369 : : /*
370 : : * not enough history pages:
371 : : * it could be a random read
372 : : */
373 [ + ]: 92983 : if (size <= req_size)
374 : : return 0;
375 : :
376 : : /*
377 : : * starts from beginning of file:
378 : : * it is a strong indication of long-run stream (or whole-file-read)
379 : : */
380 [ + + ]: 101029 : if (size >= offset)
381 : 243 : size *= 2;
382 : :
383 : 8116 : ra->start = offset;
384 : 8116 : ra->size = min(size + req_size, max);
385 : 8116 : ra->async_size = 1;
386 : :
387 : 8116 : return 1;
388 : : }
389 : :
390 : : /*
391 : : * A minimal readahead algorithm for trivial sequential/random reads.
392 : : */
393 : : static unsigned long
394 : 0 : ondemand_readahead(struct address_space *mapping,
395 : : struct file_ra_state *ra, struct file *filp,
396 : : bool hit_readahead_marker, pgoff_t offset,
397 : : unsigned long req_size)
398 : : {
399 : 134374 : unsigned long max = max_sane_readahead(ra->ra_pages);
400 : : pgoff_t prev_offset;
401 : :
402 : : /*
403 : : * start of file
404 : : */
405 [ + + ]: 134374 : if (!offset)
406 : : goto initial_readahead;
407 : :
408 : : /*
409 : : * It's the expected callback offset, assume sequential access.
410 : : * Ramp up sizes, and push forward the readahead window.
411 : : */
412 [ + + ][ + + ]: 125248 : if ((offset == (ra->start + ra->size - ra->async_size) ||
413 : : offset == (ra->start + ra->size))) {
414 : 18449 : ra->start += ra->size;
415 : 18449 : ra->size = get_next_ra_size(ra, max);
416 : 18449 : ra->async_size = ra->size;
417 : 18449 : goto readit;
418 : : }
419 : :
420 : : /*
421 : : * Hit a marked page without valid readahead state.
422 : : * E.g. interleaved reads.
423 : : * Query the pagecache for async_size, which normally equals to
424 : : * readahead size. Ramp it up and use it as the new readahead size.
425 : : */
426 [ + + ]: 106799 : if (hit_readahead_marker) {
427 : : pgoff_t start;
428 : :
429 : : rcu_read_lock();
430 : 2294 : start = radix_tree_next_hole(&mapping->page_tree, offset+1,max);
431 : : rcu_read_unlock();
432 : :
433 [ + - ][ + + ]: 2294 : if (!start || start - offset > max)
434 : : return 0;
435 : :
436 : 1984 : ra->start = start;
437 : 1984 : ra->size = start - offset; /* old async_size */
438 : 1984 : ra->size += req_size;
439 : 1984 : ra->size = get_next_ra_size(ra, max);
440 : 1984 : ra->async_size = ra->size;
441 : 1984 : goto readit;
442 : : }
443 : :
444 : : /*
445 : : * oversize read
446 : : */
447 [ + + ]: 104505 : if (req_size > max)
448 : : goto initial_readahead;
449 : :
450 : : /*
451 : : * sequential cache miss
452 : : * trivial case: (offset - prev_offset) == 1
453 : : * unaligned reads: (offset - prev_offset) == 0
454 : : */
455 : 104502 : prev_offset = (unsigned long long)ra->prev_pos >> PAGE_CACHE_SHIFT;
456 [ + + ]: 104502 : if (offset - prev_offset <= 1UL)
457 : : goto initial_readahead;
458 : :
459 : : /*
460 : : * Query the page cache and look for the traces(cached history pages)
461 : : * that a sequential stream would leave behind.
462 : : */
463 [ + + ]: 92909 : if (try_context_readahead(mapping, ra, offset, req_size, max))
464 : : goto readit;
465 : :
466 : : /*
467 : : * standalone, small random read
468 : : * Read as is, and do not pollute the readahead state.
469 : : */
470 : 84684 : return __do_page_cache_readahead(mapping, filp, offset, req_size, 0);
471 : :
472 : : initial_readahead:
473 : 0 : ra->start = offset;
474 : 20722 : ra->size = get_init_ra_size(req_size, max);
475 [ + + ]: 20761 : ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
476 : :
477 : : readit:
478 : : /*
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 [ + + ][ + + ]: 49299 : if (offset == ra->start && ra->size == ra->async_size) {
484 : 364 : ra->async_size = get_next_ra_size(ra, max);
485 : 364 : ra->size += ra->async_size;
486 : : }
487 : :
488 : 49311 : return ra_submit(ra, mapping, filp);
489 : : }
490 : :
491 : : /**
492 : : * page_cache_sync_readahead - generic file readahead
493 : : * @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()
496 : : * @offset: start offset into @mapping, in pagecache page-sized units
497 : : * @req_size: hint: total size of the read which the caller is performing in
498 : : * pagecache pages
499 : : *
500 : : * 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.
504 : : */
505 : 0 : void 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)
508 : : {
509 : : /* no read-ahead */
510 [ + ]: 114683 : if (!ra->ra_pages)
511 : : return;
512 : :
513 : : /* be dumb */
514 [ + ][ + + ]: 114728 : if (filp && (filp->f_mode & FMODE_RANDOM)) {
515 : 570 : force_page_cache_readahead(mapping, filp, offset, req_size);
516 : 570 : return;
517 : : }
518 : :
519 : : /* do read-ahead */
520 : 114158 : ondemand_readahead(mapping, ra, filp, false, offset, req_size);
521 : : }
522 : : EXPORT_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 : : *
534 : : * page_cache_async_readahead() should be called when a page is used which
535 : : * has the PG_readahead flag; this is a marker to suggest that the application
536 : : * has used up enough of the readahead window that we should start pulling in
537 : : * more pages.
538 : : */
539 : : void
540 : 0 : page_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 [ + - ]: 20242 : if (!ra->ra_pages)
547 : : return;
548 : :
549 : : /*
550 : : * Same bit is used for PG_readahead and PG_reclaim.
551 : : */
552 [ + - ]: 20242 : if (PageWriteback(page))
553 : : return;
554 : :
555 : : ClearPageReadahead(page);
556 : :
557 : : /*
558 : : * Defer asynchronous read-ahead on IO congestion.
559 : : */
560 [ + - ]: 20242 : if (bdi_read_congested(mapping->backing_dev_info))
561 : : return;
562 : :
563 : : /* do read-ahead */
564 : 20242 : ondemand_readahead(mapping, ra, filp, true, offset, req_size);
565 : : }
566 : : EXPORT_SYMBOL_GPL(page_cache_async_readahead);
567 : :
568 : : static ssize_t
569 : 0 : do_readahead(struct address_space *mapping, struct file *filp,
570 : : pgoff_t index, unsigned long nr)
571 : : {
572 [ + - ][ + - ]: 5 : if (!mapping || !mapping->a_ops)
573 : : return -EINVAL;
574 : :
575 : 5 : return force_page_cache_readahead(mapping, filp, index, nr);
576 : : }
577 : :
578 : 0 : SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
579 : : {
580 : : ssize_t ret;
581 : : struct fd f;
582 : :
583 : : ret = -EBADF;
584 : 7 : f = fdget(fd);
585 [ + + ]: 7 : if (f.file) {
586 [ + + ]: 6 : if (f.file->f_mode & FMODE_READ) {
587 : 5 : struct address_space *mapping = f.file->f_mapping;
588 : 5 : pgoff_t start = offset >> PAGE_CACHE_SHIFT;
589 : 5 : pgoff_t end = (offset + count - 1) >> PAGE_CACHE_SHIFT;
590 : 5 : unsigned long len = end - start + 1;
591 : 5 : ret = do_readahead(mapping, f.file, start, len);
592 : : }
593 : : fdput(f);
594 : : }
595 : : return ret;
596 : : }
|
