OSDN Git Service

Merge "ASoC: msm: qdsp6v2: Add MM28 and MM29 for record usecase"
[sagit-ice-cold/kernel_xiaomi_msm8998.git] / mm / readahead.c
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/gfp.h>
12 #include <linux/export.h>
13 #include <linux/blkdev.h>
14 #include <linux/backing-dev.h>
15 #include <linux/task_io_accounting_ops.h>
16 #include <linux/pagevec.h>
17 #include <linux/pagemap.h>
18 #include <linux/syscalls.h>
19 #include <linux/file.h>
20
21 #include "internal.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 file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
29 {
30         ra->ra_pages = inode_to_bdi(mapping->host)->ra_pages;
31         ra->prev_pos = -1;
32 }
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 static void read_cache_pages_invalidate_page(struct address_space *mapping,
45                                              struct page *page)
46 {
47         if (page_has_private(page)) {
48                 if (!trylock_page(page))
49                         BUG();
50                 page->mapping = mapping;
51                 do_invalidatepage(page, 0, PAGE_CACHE_SIZE);
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  */
61 static 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
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 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         while (!list_empty(pages)) {
90                 page = list_to_page(pages);
91                 list_del(&page->lru);
92                 if (add_to_page_cache_lru(page, mapping, page->index,
93                                 mapping_gfp_constraint(mapping, GFP_KERNEL))) {
94                         read_cache_pages_invalidate_page(mapping, page);
95                         continue;
96                 }
97                 page_cache_release(page);
98
99                 ret = filler(data, page);
100                 if (unlikely(ret)) {
101                         read_cache_pages_invalidate_pages(mapping, pages);
102                         break;
103                 }
104                 task_io_account_read(PAGE_CACHE_SIZE);
105         }
106         return ret;
107 }
108
109 EXPORT_SYMBOL(read_cache_pages);
110
111 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         blk_start_plug(&plug);
119
120         if (mapping->a_ops->readpages) {
121                 ret = mapping->a_ops->readpages(filp, mapping, pages, nr_pages);
122                 /* Clean up the remaining pages */
123                 put_pages_list(pages);
124                 goto out;
125         }
126
127         for (page_idx = 0; page_idx < nr_pages; page_idx++) {
128                 struct page *page = list_to_page(pages);
129                 list_del(&page->lru);
130                 if (!add_to_page_cache_lru(page, mapping, page->index,
131                                 mapping_gfp_constraint(mapping, GFP_KERNEL))) {
132                         mapping->a_ops->readpage(filp, page);
133                 }
134                 page_cache_release(page);
135         }
136         ret = 0;
137
138 out:
139         blk_finish_plug(&plug);
140
141         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 int __do_page_cache_readahead(struct address_space *mapping, struct file *filp,
153                         pgoff_t offset, unsigned long nr_to_read,
154                         unsigned long lookahead_size)
155 {
156         struct inode *inode = mapping->host;
157         struct page *page;
158         unsigned long end_index;        /* The last page we want to read */
159         LIST_HEAD(page_pool);
160         int page_idx;
161         int ret = 0;
162         loff_t isize = i_size_read(inode);
163
164         if (isize == 0)
165                 goto out;
166
167         end_index = ((isize - 1) >> PAGE_CACHE_SHIFT);
168
169         /*
170          * Preallocate as many pages as we will need.
171          */
172         for (page_idx = 0; page_idx < nr_to_read; page_idx++) {
173                 pgoff_t page_offset = offset + page_idx;
174
175                 if (page_offset > end_index)
176                         break;
177
178                 rcu_read_lock();
179                 page = radix_tree_lookup(&mapping->page_tree, page_offset);
180                 rcu_read_unlock();
181                 if (page && !radix_tree_exceptional_entry(page))
182                         continue;
183
184                 page = page_cache_alloc_readahead(mapping);
185                 if (!page)
186                         break;
187                 page->index = page_offset;
188                 list_add(&page->lru, &page_pool);
189                 if (page_idx == nr_to_read - lookahead_size)
190                         SetPageReadahead(page);
191                 ret++;
192         }
193
194         /*
195          * Now start the IO.  We ignore I/O errors - if the page is not
196          * uptodate then the caller will launch readpage again, and
197          * will then handle the error.
198          */
199         if (ret)
200                 read_pages(mapping, filp, &page_pool, ret);
201         BUG_ON(!list_empty(&page_pool));
202 out:
203         return ret;
204 }
205
206 /*
207  * Chunk the readahead into 2 megabyte units, so that we don't pin too much
208  * memory at once.
209  */
210 int force_page_cache_readahead(struct address_space *mapping, struct file *filp,
211                 pgoff_t offset, unsigned long nr_to_read)
212 {
213         if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages))
214                 return -EINVAL;
215
216         nr_to_read = min(nr_to_read, inode_to_bdi(mapping->host)->ra_pages);
217         while (nr_to_read) {
218                 int err;
219
220                 unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_CACHE_SIZE;
221
222                 if (this_chunk > nr_to_read)
223                         this_chunk = nr_to_read;
224                 err = __do_page_cache_readahead(mapping, filp,
225                                                 offset, this_chunk, 0);
226                 if (err < 0)
227                         return err;
228
229                 offset += this_chunk;
230                 nr_to_read -= this_chunk;
231         }
232         return 0;
233 }
234
235 /*
236  * Set the initial window size, round to next power of 2 and square
237  * Small size is not dependant on max value - only a one-page read is regarded
238  * as small.
239  * for small size, x 4 for medium, and x 2 for large
240  * for 128k (32 page) max ra
241  * 1-8 page = 32k initial, > 8 page = 128k initial
242  */
243 static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
244 {
245         unsigned long newsize = roundup_pow_of_two(size);
246
247         if (newsize <= 1)
248                 newsize = newsize * 4;
249         else if (newsize <= max / 4)
250                 newsize = newsize * 2;
251         else
252                 newsize = max;
253
254         return newsize;
255 }
256
257 /*
258  *  Get the previous window size, ramp it up, and
259  *  return it as the new window size.
260  */
261 static unsigned long get_next_ra_size(struct file_ra_state *ra,
262                                                 unsigned long max)
263 {
264         unsigned long cur = ra->size;
265         unsigned long newsize;
266
267         if (cur < max / 16)
268                 newsize = 4 * cur;
269         else
270                 newsize = 2 * cur;
271
272         return min(newsize, max);
273 }
274
275 /*
276  * On-demand readahead design.
277  *
278  * The fields in struct file_ra_state represent the most-recently-executed
279  * readahead attempt:
280  *
281  *                        |<----- async_size ---------|
282  *     |------------------- size -------------------->|
283  *     |==================#===========================|
284  *     ^start             ^page marked with PG_readahead
285  *
286  * To overlap application thinking time and disk I/O time, we do
287  * `readahead pipelining': Do not wait until the application consumed all
288  * readahead pages and stalled on the missing page at readahead_index;
289  * Instead, submit an asynchronous readahead I/O as soon as there are
290  * only async_size pages left in the readahead window. Normally async_size
291  * will be equal to size, for maximum pipelining.
292  *
293  * In interleaved sequential reads, concurrent streams on the same fd can
294  * be invalidating each other's readahead state. So we flag the new readahead
295  * page at (start+size-async_size) with PG_readahead, and use it as readahead
296  * indicator. The flag won't be set on already cached pages, to avoid the
297  * readahead-for-nothing fuss, saving pointless page cache lookups.
298  *
299  * prev_pos tracks the last visited byte in the _previous_ read request.
300  * It should be maintained by the caller, and will be used for detecting
301  * small random reads. Note that the readahead algorithm checks loosely
302  * for sequential patterns. Hence interleaved reads might be served as
303  * sequential ones.
304  *
305  * There is a special-case: if the first page which the application tries to
306  * read happens to be the first page of the file, it is assumed that a linear
307  * read is about to happen and the window is immediately set to the initial size
308  * based on I/O request size and the max_readahead.
309  *
310  * The code ramps up the readahead size aggressively at first, but slow down as
311  * it approaches max_readhead.
312  */
313
314 /*
315  * Count contiguously cached pages from @offset-1 to @offset-@max,
316  * this count is a conservative estimation of
317  *      - length of the sequential read sequence, or
318  *      - thrashing threshold in memory tight systems
319  */
320 static pgoff_t count_history_pages(struct address_space *mapping,
321                                    pgoff_t offset, unsigned long max)
322 {
323         pgoff_t head;
324
325         rcu_read_lock();
326         head = page_cache_prev_hole(mapping, offset - 1, max);
327         rcu_read_unlock();
328
329         return offset - 1 - head;
330 }
331
332 /*
333  * page cache context based read-ahead
334  */
335 static int try_context_readahead(struct address_space *mapping,
336                                  struct file_ra_state *ra,
337                                  pgoff_t offset,
338                                  unsigned long req_size,
339                                  unsigned long max)
340 {
341         pgoff_t size;
342
343         size = count_history_pages(mapping, offset, max);
344
345         /*
346          * not enough history pages:
347          * it could be a random read
348          */
349         if (size <= req_size)
350                 return 0;
351
352         /*
353          * starts from beginning of file:
354          * it is a strong indication of long-run stream (or whole-file-read)
355          */
356         if (size >= offset)
357                 size *= 2;
358
359         ra->start = offset;
360         ra->size = min(size + req_size, max);
361         ra->async_size = 1;
362
363         return 1;
364 }
365
366 /*
367  * A minimal readahead algorithm for trivial sequential/random reads.
368  */
369 static unsigned long
370 ondemand_readahead(struct address_space *mapping,
371                    struct file_ra_state *ra, struct file *filp,
372                    bool hit_readahead_marker, pgoff_t offset,
373                    unsigned long req_size)
374 {
375         unsigned long max = ra->ra_pages;
376         pgoff_t prev_offset;
377
378         /*
379          * start of file
380          */
381         if (!offset)
382                 goto initial_readahead;
383
384         /*
385          * It's the expected callback offset, assume sequential access.
386          * Ramp up sizes, and push forward the readahead window.
387          */
388         if ((offset == (ra->start + ra->size - ra->async_size) ||
389              offset == (ra->start + ra->size))) {
390                 ra->start += ra->size;
391                 ra->size = get_next_ra_size(ra, max);
392                 ra->async_size = ra->size;
393                 goto readit;
394         }
395
396         /*
397          * Hit a marked page without valid readahead state.
398          * E.g. interleaved reads.
399          * Query the pagecache for async_size, which normally equals to
400          * readahead size. Ramp it up and use it as the new readahead size.
401          */
402         if (hit_readahead_marker) {
403                 pgoff_t start;
404
405                 rcu_read_lock();
406                 start = page_cache_next_hole(mapping, offset + 1, max);
407                 rcu_read_unlock();
408
409                 if (!start || start - offset > max)
410                         return 0;
411
412                 ra->start = start;
413                 ra->size = start - offset;      /* old async_size */
414                 ra->size += req_size;
415                 ra->size = get_next_ra_size(ra, max);
416                 ra->async_size = ra->size;
417                 goto readit;
418         }
419
420         /*
421          * oversize read
422          */
423         if (req_size > max)
424                 goto initial_readahead;
425
426         /*
427          * sequential cache miss
428          * trivial case: (offset - prev_offset) == 1
429          * unaligned reads: (offset - prev_offset) == 0
430          */
431         prev_offset = (unsigned long long)ra->prev_pos >> PAGE_CACHE_SHIFT;
432         if (offset - prev_offset <= 1UL)
433                 goto initial_readahead;
434
435         /*
436          * Query the page cache and look for the traces(cached history pages)
437          * that a sequential stream would leave behind.
438          */
439         if (try_context_readahead(mapping, ra, offset, req_size, max))
440                 goto readit;
441
442         /*
443          * standalone, small random read
444          * Read as is, and do not pollute the readahead state.
445          */
446         return __do_page_cache_readahead(mapping, filp, offset, req_size, 0);
447
448 initial_readahead:
449         ra->start = offset;
450         ra->size = get_init_ra_size(req_size, max);
451         ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
452
453 readit:
454         /*
455          * Will this read hit the readahead marker made by itself?
456          * If so, trigger the readahead marker hit now, and merge
457          * the resulted next readahead window into the current one.
458          */
459         if (offset == ra->start && ra->size == ra->async_size) {
460                 ra->async_size = get_next_ra_size(ra, max);
461                 ra->size += ra->async_size;
462         }
463
464         return ra_submit(ra, mapping, filp);
465 }
466
467 /**
468  * page_cache_sync_readahead - generic file readahead
469  * @mapping: address_space which holds the pagecache and I/O vectors
470  * @ra: file_ra_state which holds the readahead state
471  * @filp: passed on to ->readpage() and ->readpages()
472  * @offset: start offset into @mapping, in pagecache page-sized units
473  * @req_size: hint: total size of the read which the caller is performing in
474  *            pagecache pages
475  *
476  * page_cache_sync_readahead() should be called when a cache miss happened:
477  * it will submit the read.  The readahead logic may decide to piggyback more
478  * pages onto the read request if access patterns suggest it will improve
479  * performance.
480  */
481 void page_cache_sync_readahead(struct address_space *mapping,
482                                struct file_ra_state *ra, struct file *filp,
483                                pgoff_t offset, unsigned long req_size)
484 {
485         /* no read-ahead */
486         if (!ra->ra_pages)
487                 return;
488
489         /* be dumb */
490         if (filp && (filp->f_mode & FMODE_RANDOM)) {
491                 force_page_cache_readahead(mapping, filp, offset, req_size);
492                 return;
493         }
494
495         /* do read-ahead */
496         ondemand_readahead(mapping, ra, filp, false, offset, req_size);
497 }
498 EXPORT_SYMBOL_GPL(page_cache_sync_readahead);
499
500 /**
501  * page_cache_async_readahead - file readahead for marked pages
502  * @mapping: address_space which holds the pagecache and I/O vectors
503  * @ra: file_ra_state which holds the readahead state
504  * @filp: passed on to ->readpage() and ->readpages()
505  * @page: the page at @offset which has the PG_readahead flag set
506  * @offset: start offset into @mapping, in pagecache page-sized units
507  * @req_size: hint: total size of the read which the caller is performing in
508  *            pagecache pages
509  *
510  * page_cache_async_readahead() should be called when a page is used which
511  * has the PG_readahead flag; this is a marker to suggest that the application
512  * has used up enough of the readahead window that we should start pulling in
513  * more pages.
514  */
515 void
516 page_cache_async_readahead(struct address_space *mapping,
517                            struct file_ra_state *ra, struct file *filp,
518                            struct page *page, pgoff_t offset,
519                            unsigned long req_size)
520 {
521         /* no read-ahead */
522         if (!ra->ra_pages)
523                 return;
524
525         /*
526          * Same bit is used for PG_readahead and PG_reclaim.
527          */
528         if (PageWriteback(page))
529                 return;
530
531         ClearPageReadahead(page);
532
533         /*
534          * Defer asynchronous read-ahead on IO congestion.
535          */
536         if (inode_read_congested(mapping->host))
537                 return;
538
539         /* do read-ahead */
540         ondemand_readahead(mapping, ra, filp, true, offset, req_size);
541 }
542 EXPORT_SYMBOL_GPL(page_cache_async_readahead);
543
544 static ssize_t
545 do_readahead(struct address_space *mapping, struct file *filp,
546              pgoff_t index, unsigned long nr)
547 {
548         if (!mapping || !mapping->a_ops)
549                 return -EINVAL;
550
551         return force_page_cache_readahead(mapping, filp, index, nr);
552 }
553
554 SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
555 {
556         ssize_t ret;
557         struct fd f;
558
559         ret = -EBADF;
560         f = fdget(fd);
561         if (f.file) {
562                 if (f.file->f_mode & FMODE_READ) {
563                         struct address_space *mapping = f.file->f_mapping;
564                         pgoff_t start = offset >> PAGE_CACHE_SHIFT;
565                         pgoff_t end = (offset + count - 1) >> PAGE_CACHE_SHIFT;
566                         unsigned long len = end - start + 1;
567                         ret = do_readahead(mapping, f.file, start, len);
568                 }
569                 fdput(f);
570         }
571         return ret;
572 }