readahead.c 16.4 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5
/*
 * mm/readahead.c - address_space-level file readahead.
 *
 * Copyright (C) 2002, Linus Torvalds
 *
6
 * 09Apr2002	Andrew Morton
Linus Torvalds's avatar
Linus Torvalds committed
7 8 9 10
 *		Initial version.
 */

#include <linux/kernel.h>
11
#include <linux/dax.h>
12
#include <linux/gfp.h>
13
#include <linux/export.h>
Linus Torvalds's avatar
Linus Torvalds committed
14 15
#include <linux/blkdev.h>
#include <linux/backing-dev.h>
16
#include <linux/task_io_accounting_ops.h>
Linus Torvalds's avatar
Linus Torvalds committed
17
#include <linux/pagevec.h>
18
#include <linux/pagemap.h>
19 20
#include <linux/syscalls.h>
#include <linux/file.h>
21
#include <linux/mm_inline.h>
22
#include <linux/blk-cgroup.h>
23
#include <linux/fadvise.h>
Linus Torvalds's avatar
Linus Torvalds committed
24

25 26
#include "internal.h"

Linus Torvalds's avatar
Linus Torvalds committed
27 28 29 30 31 32 33
/*
 * Initialise a struct file's readahead state.  Assumes that the caller has
 * memset *ra to zero.
 */
void
file_ra_state_init(struct file_ra_state *ra, struct address_space *mapping)
{
34
	ra->ra_pages = inode_to_bdi(mapping->host)->ra_pages;
35
	ra->prev_pos = -1;
Linus Torvalds's avatar
Linus Torvalds committed
36
}
37
EXPORT_SYMBOL_GPL(file_ra_state_init);
Linus Torvalds's avatar
Linus Torvalds committed
38

39 40
/*
 * see if a page needs releasing upon read_cache_pages() failure
41 42 43 44
 * - the caller of read_cache_pages() may have set PG_private or PG_fscache
 *   before calling, such as the NFS fs marking pages that are cached locally
 *   on disk, thus we need to give the fs a chance to clean up in the event of
 *   an error
45 46 47 48
 */
static void read_cache_pages_invalidate_page(struct address_space *mapping,
					     struct page *page)
{
49
	if (page_has_private(page)) {
50 51 52
		if (!trylock_page(page))
			BUG();
		page->mapping = mapping;
53
		do_invalidatepage(page, 0, PAGE_SIZE);
54 55 56
		page->mapping = NULL;
		unlock_page(page);
	}
57
	put_page(page);
58 59 60 61 62 63 64 65 66 67 68
}

/*
 * release a list of pages, invalidating them first if need be
 */
static void read_cache_pages_invalidate_pages(struct address_space *mapping,
					      struct list_head *pages)
{
	struct page *victim;

	while (!list_empty(pages)) {
69
		victim = lru_to_page(pages);
70 71 72 73 74
		list_del(&victim->lru);
		read_cache_pages_invalidate_page(mapping, victim);
	}
}

Linus Torvalds's avatar
Linus Torvalds committed
75
/**
76
 * read_cache_pages - populate an address space with some pages & start reads against them
Linus Torvalds's avatar
Linus Torvalds committed
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
 * @mapping: the address_space
 * @pages: The address of a list_head which contains the target pages.  These
 *   pages have their ->index populated and are otherwise uninitialised.
 * @filler: callback routine for filling a single page.
 * @data: private data for the callback routine.
 *
 * Hides the details of the LRU cache etc from the filesystems.
 */
int read_cache_pages(struct address_space *mapping, struct list_head *pages,
			int (*filler)(void *, struct page *), void *data)
{
	struct page *page;
	int ret = 0;

	while (!list_empty(pages)) {
92
		page = lru_to_page(pages);
Linus Torvalds's avatar
Linus Torvalds committed
93
		list_del(&page->lru);
94
		if (add_to_page_cache_lru(page, mapping, page->index,
95
				readahead_gfp_mask(mapping))) {
96
			read_cache_pages_invalidate_page(mapping, page);
Linus Torvalds's avatar
Linus Torvalds committed
97 98
			continue;
		}
99
		put_page(page);
Nick Piggin's avatar
Nick Piggin committed
100

Linus Torvalds's avatar
Linus Torvalds committed
101
		ret = filler(data, page);
Nick Piggin's avatar
Nick Piggin committed
102
		if (unlikely(ret)) {
103
			read_cache_pages_invalidate_pages(mapping, pages);
Linus Torvalds's avatar
Linus Torvalds committed
104 105
			break;
		}
106
		task_io_account_read(PAGE_SIZE);
Linus Torvalds's avatar
Linus Torvalds committed
107 108 109 110 111 112 113
	}
	return ret;
}

EXPORT_SYMBOL(read_cache_pages);

static int read_pages(struct address_space *mapping, struct file *filp,
114
		struct list_head *pages, unsigned int nr_pages, gfp_t gfp)
Linus Torvalds's avatar
Linus Torvalds committed
115
{
Jens Axboe's avatar
Jens Axboe committed
116
	struct blk_plug plug;
Linus Torvalds's avatar
Linus Torvalds committed
117
	unsigned page_idx;
118
	int ret;
Linus Torvalds's avatar
Linus Torvalds committed
119

Jens Axboe's avatar
Jens Axboe committed
120 121
	blk_start_plug(&plug);

Linus Torvalds's avatar
Linus Torvalds committed
122 123
	if (mapping->a_ops->readpages) {
		ret = mapping->a_ops->readpages(filp, mapping, pages, nr_pages);
124 125
		/* Clean up the remaining pages */
		put_pages_list(pages);
Linus Torvalds's avatar
Linus Torvalds committed
126 127 128 129
		goto out;
	}

	for (page_idx = 0; page_idx < nr_pages; page_idx++) {
130
		struct page *page = lru_to_page(pages);
Linus Torvalds's avatar
Linus Torvalds committed
131
		list_del(&page->lru);
132
		if (!add_to_page_cache_lru(page, mapping, page->index, gfp))
133
			mapping->a_ops->readpage(filp, page);
134
		put_page(page);
Linus Torvalds's avatar
Linus Torvalds committed
135
	}
136
	ret = 0;
Jens Axboe's avatar
Jens Axboe committed
137

Linus Torvalds's avatar
Linus Torvalds committed
138
out:
Jens Axboe's avatar
Jens Axboe committed
139 140
	blk_finish_plug(&plug);

Linus Torvalds's avatar
Linus Torvalds committed
141 142 143 144
	return ret;
}

/*
145 146
 * __do_page_cache_readahead() actually reads a chunk of disk.  It allocates
 * the pages first, then submits them for I/O. This avoids the very bad
Linus Torvalds's avatar
Linus Torvalds committed
147 148 149 150 151
 * behaviour which would occur if page allocations are causing VM writeback.
 * We really don't want to intermingle reads and writes like that.
 *
 * Returns the number of pages requested, or the maximum amount of I/O allowed.
 */
152 153 154
unsigned int __do_page_cache_readahead(struct address_space *mapping,
		struct file *filp, pgoff_t offset, unsigned long nr_to_read,
		unsigned long lookahead_size)
Linus Torvalds's avatar
Linus Torvalds committed
155 156 157 158 159 160
{
	struct inode *inode = mapping->host;
	struct page *page;
	unsigned long end_index;	/* The last page we want to read */
	LIST_HEAD(page_pool);
	int page_idx;
161
	unsigned int nr_pages = 0;
Linus Torvalds's avatar
Linus Torvalds committed
162
	loff_t isize = i_size_read(inode);
163
	gfp_t gfp_mask = readahead_gfp_mask(mapping);
Linus Torvalds's avatar
Linus Torvalds committed
164 165 166 167

	if (isize == 0)
		goto out;

168
	end_index = ((isize - 1) >> PAGE_SHIFT);
Linus Torvalds's avatar
Linus Torvalds committed
169 170 171 172 173

	/*
	 * Preallocate as many pages as we will need.
	 */
	for (page_idx = 0; page_idx < nr_to_read; page_idx++) {
174
		pgoff_t page_offset = offset + page_idx;
175

Linus Torvalds's avatar
Linus Torvalds committed
176 177 178
		if (page_offset > end_index)
			break;

179
		page = xa_load(&mapping->i_pages, page_offset);
180
		if (page && !xa_is_value(page)) {
181 182 183 184 185 186 187 188 189
			/*
			 * Page already present?  Kick off the current batch of
			 * contiguous pages before continuing with the next
			 * batch.
			 */
			if (nr_pages)
				read_pages(mapping, filp, &page_pool, nr_pages,
						gfp_mask);
			nr_pages = 0;
Linus Torvalds's avatar
Linus Torvalds committed
190
			continue;
191
		}
Linus Torvalds's avatar
Linus Torvalds committed
192

193
		page = __page_cache_alloc(gfp_mask);
Linus Torvalds's avatar
Linus Torvalds committed
194 195 196 197
		if (!page)
			break;
		page->index = page_offset;
		list_add(&page->lru, &page_pool);
198 199
		if (page_idx == nr_to_read - lookahead_size)
			SetPageReadahead(page);
200
		nr_pages++;
Linus Torvalds's avatar
Linus Torvalds committed
201 202 203 204 205 206 207
	}

	/*
	 * Now start the IO.  We ignore I/O errors - if the page is not
	 * uptodate then the caller will launch readpage again, and
	 * will then handle the error.
	 */
208 209
	if (nr_pages)
		read_pages(mapping, filp, &page_pool, nr_pages, gfp_mask);
Linus Torvalds's avatar
Linus Torvalds committed
210 211
	BUG_ON(!list_empty(&page_pool));
out:
212
	return nr_pages;
Linus Torvalds's avatar
Linus Torvalds committed
213 214 215 216 217 218 219
}

/*
 * Chunk the readahead into 2 megabyte units, so that we don't pin too much
 * memory at once.
 */
int force_page_cache_readahead(struct address_space *mapping, struct file *filp,
220
			       pgoff_t offset, unsigned long nr_to_read)
Linus Torvalds's avatar
Linus Torvalds committed
221
{
222 223 224 225
	struct backing_dev_info *bdi = inode_to_bdi(mapping->host);
	struct file_ra_state *ra = &filp->f_ra;
	unsigned long max_pages;

Linus Torvalds's avatar
Linus Torvalds committed
226 227 228
	if (unlikely(!mapping->a_ops->readpage && !mapping->a_ops->readpages))
		return -EINVAL;

229 230 231 232 233 234
	/*
	 * If the request exceeds the readahead window, allow the read to
	 * be up to the optimal hardware IO size
	 */
	max_pages = max_t(unsigned long, bdi->io_pages, ra->ra_pages);
	nr_to_read = min(nr_to_read, max_pages);
Linus Torvalds's avatar
Linus Torvalds committed
235
	while (nr_to_read) {
236
		unsigned long this_chunk = (2 * 1024 * 1024) / PAGE_SIZE;
Linus Torvalds's avatar
Linus Torvalds committed
237 238 239

		if (this_chunk > nr_to_read)
			this_chunk = nr_to_read;
240
		__do_page_cache_readahead(mapping, filp, offset, this_chunk, 0);
241

Linus Torvalds's avatar
Linus Torvalds committed
242 243 244
		offset += this_chunk;
		nr_to_read -= this_chunk;
	}
245
	return 0;
Linus Torvalds's avatar
Linus Torvalds committed
246 247
}

248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
/*
 * Set the initial window size, round to next power of 2 and square
 * for small size, x 4 for medium, and x 2 for large
 * for 128k (32 page) max ra
 * 1-8 page = 32k initial, > 8 page = 128k initial
 */
static unsigned long get_init_ra_size(unsigned long size, unsigned long max)
{
	unsigned long newsize = roundup_pow_of_two(size);

	if (newsize <= max / 32)
		newsize = newsize * 4;
	else if (newsize <= max / 4)
		newsize = newsize * 2;
	else
		newsize = max;

	return newsize;
}

268 269 270 271
/*
 *  Get the previous window size, ramp it up, and
 *  return it as the new window size.
 */
272
static unsigned long get_next_ra_size(struct file_ra_state *ra,
273 274
						unsigned long max)
{
275
	unsigned long cur = ra->size;
276 277 278
	unsigned long newsize;

	if (cur < max / 16)
279
		newsize = 4 * cur;
280
	else
281
		newsize = 2 * cur;
282 283 284 285 286 287 288 289 290 291

	return min(newsize, max);
}

/*
 * On-demand readahead design.
 *
 * The fields in struct file_ra_state represent the most-recently-executed
 * readahead attempt:
 *
292 293 294 295
 *                        |<----- async_size ---------|
 *     |------------------- size -------------------->|
 *     |==================#===========================|
 *     ^start             ^page marked with PG_readahead
296 297 298 299
 *
 * To overlap application thinking time and disk I/O time, we do
 * `readahead pipelining': Do not wait until the application consumed all
 * readahead pages and stalled on the missing page at readahead_index;
300 301 302
 * Instead, submit an asynchronous readahead I/O as soon as there are
 * only async_size pages left in the readahead window. Normally async_size
 * will be equal to size, for maximum pipelining.
303 304 305
 *
 * In interleaved sequential reads, concurrent streams on the same fd can
 * be invalidating each other's readahead state. So we flag the new readahead
306
 * page at (start+size-async_size) with PG_readahead, and use it as readahead
307 308 309
 * indicator. The flag won't be set on already cached pages, to avoid the
 * readahead-for-nothing fuss, saving pointless page cache lookups.
 *
310
 * prev_pos tracks the last visited byte in the _previous_ read request.
311 312 313 314 315 316 317 318 319 320 321 322 323 324
 * It should be maintained by the caller, and will be used for detecting
 * small random reads. Note that the readahead algorithm checks loosely
 * for sequential patterns. Hence interleaved reads might be served as
 * sequential ones.
 *
 * There is a special-case: if the first page which the application tries to
 * read happens to be the first page of the file, it is assumed that a linear
 * read is about to happen and the window is immediately set to the initial size
 * based on I/O request size and the max_readahead.
 *
 * The code ramps up the readahead size aggressively at first, but slow down as
 * it approaches max_readhead.
 */

325 326 327 328 329 330 331 332 333 334 335 336
/*
 * Count contiguously cached pages from @offset-1 to @offset-@max,
 * this count is a conservative estimation of
 * 	- length of the sequential read sequence, or
 * 	- thrashing threshold in memory tight systems
 */
static pgoff_t count_history_pages(struct address_space *mapping,
				   pgoff_t offset, unsigned long max)
{
	pgoff_t head;

	rcu_read_lock();
337
	head = page_cache_prev_miss(mapping, offset - 1, max);
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
	rcu_read_unlock();

	return offset - 1 - head;
}

/*
 * page cache context based read-ahead
 */
static int try_context_readahead(struct address_space *mapping,
				 struct file_ra_state *ra,
				 pgoff_t offset,
				 unsigned long req_size,
				 unsigned long max)
{
	pgoff_t size;

354
	size = count_history_pages(mapping, offset, max);
355 356

	/*
357
	 * not enough history pages:
358 359
	 * it could be a random read
	 */
360
	if (size <= req_size)
361 362 363 364 365 366 367 368 369 370
		return 0;

	/*
	 * starts from beginning of file:
	 * it is a strong indication of long-run stream (or whole-file-read)
	 */
	if (size >= offset)
		size *= 2;

	ra->start = offset;
371 372
	ra->size = min(size + req_size, max);
	ra->async_size = 1;
373 374 375 376

	return 1;
}

377 378 379 380 381 382
/*
 * A minimal readahead algorithm for trivial sequential/random reads.
 */
static unsigned long
ondemand_readahead(struct address_space *mapping,
		   struct file_ra_state *ra, struct file *filp,
383
		   bool hit_readahead_marker, pgoff_t offset,
384 385
		   unsigned long req_size)
{
386 387
	struct backing_dev_info *bdi = inode_to_bdi(mapping->host);
	unsigned long max_pages = ra->ra_pages;
388
	unsigned long add_pages;
389
	pgoff_t prev_offset;
390

391 392 393 394 395 396 397
	/*
	 * If the request exceeds the readahead window, allow the read to
	 * be up to the optimal hardware IO size
	 */
	if (req_size > max_pages && bdi->io_pages > max_pages)
		max_pages = min(req_size, bdi->io_pages);

398 399 400 401 402
	/*
	 * start of file
	 */
	if (!offset)
		goto initial_readahead;
403 404

	/*
405
	 * It's the expected callback offset, assume sequential access.
406 407
	 * Ramp up sizes, and push forward the readahead window.
	 */
408 409
	if ((offset == (ra->start + ra->size - ra->async_size) ||
	     offset == (ra->start + ra->size))) {
410
		ra->start += ra->size;
411
		ra->size = get_next_ra_size(ra, max_pages);
412 413
		ra->async_size = ra->size;
		goto readit;
414 415
	}

416 417 418 419 420 421 422 423 424
	/*
	 * Hit a marked page without valid readahead state.
	 * E.g. interleaved reads.
	 * Query the pagecache for async_size, which normally equals to
	 * readahead size. Ramp it up and use it as the new readahead size.
	 */
	if (hit_readahead_marker) {
		pgoff_t start;

425
		rcu_read_lock();
426
		start = page_cache_next_miss(mapping, offset + 1, max_pages);
427
		rcu_read_unlock();
428

429
		if (!start || start - offset > max_pages)
430 431 432 433
			return 0;

		ra->start = start;
		ra->size = start - offset;	/* old async_size */
434
		ra->size += req_size;
435
		ra->size = get_next_ra_size(ra, max_pages);
436 437 438 439
		ra->async_size = ra->size;
		goto readit;
	}

440
	/*
441
	 * oversize read
442
	 */
443
	if (req_size > max_pages)
444 445 446 447
		goto initial_readahead;

	/*
	 * sequential cache miss
448 449
	 * trivial case: (offset - prev_offset) == 1
	 * unaligned reads: (offset - prev_offset) == 0
450
	 */
451
	prev_offset = (unsigned long long)ra->prev_pos >> PAGE_SHIFT;
452
	if (offset - prev_offset <= 1UL)
453 454
		goto initial_readahead;

455 456 457 458
	/*
	 * Query the page cache and look for the traces(cached history pages)
	 * that a sequential stream would leave behind.
	 */
459
	if (try_context_readahead(mapping, ra, offset, req_size, max_pages))
460 461
		goto readit;

462 463 464 465 466 467 468
	/*
	 * standalone, small random read
	 * Read as is, and do not pollute the readahead state.
	 */
	return __do_page_cache_readahead(mapping, filp, offset, req_size, 0);

initial_readahead:
469
	ra->start = offset;
470
	ra->size = get_init_ra_size(req_size, max_pages);
471
	ra->async_size = ra->size > req_size ? ra->size - req_size : ra->size;
472

473
readit:
474 475 476 477
	/*
	 * Will this read hit the readahead marker made by itself?
	 * If so, trigger the readahead marker hit now, and merge
	 * the resulted next readahead window into the current one.
478
	 * Take care of maximum IO pages as above.
479 480
	 */
	if (offset == ra->start && ra->size == ra->async_size) {
481 482 483 484 485 486 487 488
		add_pages = get_next_ra_size(ra, max_pages);
		if (ra->size + add_pages <= max_pages) {
			ra->async_size = add_pages;
			ra->size += add_pages;
		} else {
			ra->size = max_pages;
			ra->async_size = max_pages >> 1;
		}
489 490
	}

491 492 493 494
	return ra_submit(ra, mapping, filp);
}

/**
495
 * page_cache_sync_readahead - generic file readahead
496 497 498
 * @mapping: address_space which holds the pagecache and I/O vectors
 * @ra: file_ra_state which holds the readahead state
 * @filp: passed on to ->readpage() and ->readpages()
499
 * @offset: start offset into @mapping, in pagecache page-sized units
500
 * @req_size: hint: total size of the read which the caller is performing in
501
 *            pagecache pages
502
 *
503 504 505 506
 * page_cache_sync_readahead() should be called when a cache miss happened:
 * it will submit the read.  The readahead logic may decide to piggyback more
 * pages onto the read request if access patterns suggest it will improve
 * performance.
507
 */
508 509 510
void page_cache_sync_readahead(struct address_space *mapping,
			       struct file_ra_state *ra, struct file *filp,
			       pgoff_t offset, unsigned long req_size)
511 512 513
{
	/* no read-ahead */
	if (!ra->ra_pages)
514 515
		return;

516 517 518
	if (blk_cgroup_congested())
		return;

519
	/* be dumb */
520
	if (filp && (filp->f_mode & FMODE_RANDOM)) {
521 522 523 524
		force_page_cache_readahead(mapping, filp, offset, req_size);
		return;
	}

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
	/* do read-ahead */
	ondemand_readahead(mapping, ra, filp, false, offset, req_size);
}
EXPORT_SYMBOL_GPL(page_cache_sync_readahead);

/**
 * page_cache_async_readahead - file readahead for marked pages
 * @mapping: address_space which holds the pagecache and I/O vectors
 * @ra: file_ra_state which holds the readahead state
 * @filp: passed on to ->readpage() and ->readpages()
 * @page: the page at @offset which has the PG_readahead flag set
 * @offset: start offset into @mapping, in pagecache page-sized units
 * @req_size: hint: total size of the read which the caller is performing in
 *            pagecache pages
 *
Huang Shijie's avatar
Huang Shijie committed
540
 * page_cache_async_readahead() should be called when a page is used which
541
 * has the PG_readahead flag; this is a marker to suggest that the application
542
 * has used up enough of the readahead window that we should start pulling in
543 544
 * more pages.
 */
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
void
page_cache_async_readahead(struct address_space *mapping,
			   struct file_ra_state *ra, struct file *filp,
			   struct page *page, pgoff_t offset,
			   unsigned long req_size)
{
	/* no read-ahead */
	if (!ra->ra_pages)
		return;

	/*
	 * Same bit is used for PG_readahead and PG_reclaim.
	 */
	if (PageWriteback(page))
		return;

	ClearPageReadahead(page);

	/*
	 * Defer asynchronous read-ahead on IO congestion.
	 */
566
	if (inode_read_congested(mapping->host))
567
		return;
568

569 570 571
	if (blk_cgroup_congested())
		return;

572
	/* do read-ahead */
573
	ondemand_readahead(mapping, ra, filp, true, offset, req_size);
574
}
575
EXPORT_SYMBOL_GPL(page_cache_async_readahead);
576

577
ssize_t ksys_readahead(int fd, loff_t offset, size_t count)
578 579
{
	ssize_t ret;
580
	struct fd f;
581 582

	ret = -EBADF;
583
	f = fdget(fd);
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
	if (!f.file || !(f.file->f_mode & FMODE_READ))
		goto out;

	/*
	 * The readahead() syscall is intended to run only on files
	 * that can execute readahead. If readahead is not possible
	 * on this file, then we must return -EINVAL.
	 */
	ret = -EINVAL;
	if (!f.file->f_mapping || !f.file->f_mapping->a_ops ||
	    !S_ISREG(file_inode(f.file)->i_mode))
		goto out;

	ret = vfs_fadvise(f.file, offset, count, POSIX_FADV_WILLNEED);
out:
	fdput(f);
600 601
	return ret;
}
602 603 604 605 606

SYSCALL_DEFINE3(readahead, int, fd, loff_t, offset, size_t, count)
{
	return ksys_readahead(fd, offset, count);
}