1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  *	linux/mm/filemap.c
4  *
5  * Copyright (C) 1994-1999  Linus Torvalds
6  */
7 
8 /*
9  * This file handles the generic file mmap semantics used by
10  * most "normal" filesystems (but you don't /have/ to use this:
11  * the NFS filesystem used to do this differently, for example)
12  */
13 #include <linux/export.h>
14 #include <linux/compiler.h>
15 #include <linux/dax.h>
16 #include <linux/fs.h>
17 #include <linux/sched/signal.h>
18 #include <linux/uaccess.h>
19 #include <linux/capability.h>
20 #include <linux/kernel_stat.h>
21 #include <linux/gfp.h>
22 #include <linux/mm.h>
23 #include <linux/swap.h>
24 #include <linux/mman.h>
25 #include <linux/pagemap.h>
26 #include <linux/file.h>
27 #include <linux/uio.h>
28 #include <linux/error-injection.h>
29 #include <linux/hash.h>
30 #include <linux/writeback.h>
31 #include <linux/backing-dev.h>
32 #include <linux/pagevec.h>
33 #include <linux/blkdev.h>
34 #include <linux/security.h>
35 #include <linux/cpuset.h>
36 #include <linux/hugetlb.h>
37 #include <linux/memcontrol.h>
38 #include <linux/cleancache.h>
39 #include <linux/shmem_fs.h>
40 #include <linux/rmap.h>
41 #include <linux/delayacct.h>
42 #include <linux/psi.h>
43 #include <linux/ramfs.h>
44 #include <linux/page_idle.h>
45 #include "internal.h"
46 
47 #define CREATE_TRACE_POINTS
48 #include <trace/events/filemap.h>
49 
50 /*
51  * FIXME: remove all knowledge of the buffer layer from the core VM
52  */
53 #include <linux/buffer_head.h> /* for try_to_free_buffers */
54 
55 #include <asm/mman.h>
56 
57 /*
58  * Shared mappings implemented 30.11.1994. It's not fully working yet,
59  * though.
60  *
61  * Shared mappings now work. 15.8.1995  Bruno.
62  *
63  * finished 'unifying' the page and buffer cache and SMP-threaded the
64  * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
65  *
66  * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
67  */
68 
69 /*
70  * Lock ordering:
71  *
72  *  ->i_mmap_rwsem		(truncate_pagecache)
73  *    ->private_lock		(__free_pte->__set_page_dirty_buffers)
74  *      ->swap_lock		(exclusive_swap_page, others)
75  *        ->i_pages lock
76  *
77  *  ->i_mutex
78  *    ->i_mmap_rwsem		(truncate->unmap_mapping_range)
79  *
80  *  ->mmap_lock
81  *    ->i_mmap_rwsem
82  *      ->page_table_lock or pte_lock	(various, mainly in memory.c)
83  *        ->i_pages lock	(arch-dependent flush_dcache_mmap_lock)
84  *
85  *  ->mmap_lock
86  *    ->lock_page		(access_process_vm)
87  *
88  *  ->i_mutex			(generic_perform_write)
89  *    ->mmap_lock		(fault_in_pages_readable->do_page_fault)
90  *
91  *  bdi->wb.list_lock
92  *    sb_lock			(fs/fs-writeback.c)
93  *    ->i_pages lock		(__sync_single_inode)
94  *
95  *  ->i_mmap_rwsem
96  *    ->anon_vma.lock		(vma_adjust)
97  *
98  *  ->anon_vma.lock
99  *    ->page_table_lock or pte_lock	(anon_vma_prepare and various)
100  *
101  *  ->page_table_lock or pte_lock
102  *    ->swap_lock		(try_to_unmap_one)
103  *    ->private_lock		(try_to_unmap_one)
104  *    ->i_pages lock		(try_to_unmap_one)
105  *    ->pgdat->lru_lock		(follow_page->mark_page_accessed)
106  *    ->pgdat->lru_lock		(check_pte_range->isolate_lru_page)
107  *    ->private_lock		(page_remove_rmap->set_page_dirty)
108  *    ->i_pages lock		(page_remove_rmap->set_page_dirty)
109  *    bdi.wb->list_lock		(page_remove_rmap->set_page_dirty)
110  *    ->inode->i_lock		(page_remove_rmap->set_page_dirty)
111  *    ->memcg->move_lock	(page_remove_rmap->lock_page_memcg)
112  *    bdi.wb->list_lock		(zap_pte_range->set_page_dirty)
113  *    ->inode->i_lock		(zap_pte_range->set_page_dirty)
114  *    ->private_lock		(zap_pte_range->__set_page_dirty_buffers)
115  *
116  * ->i_mmap_rwsem
117  *   ->tasklist_lock            (memory_failure, collect_procs_ao)
118  */
119 
page_cache_delete(struct address_space *mapping, struct page *page, void *shadow)120 static void page_cache_delete(struct address_space *mapping,
121 				   struct page *page, void *shadow)
122 {
123 	XA_STATE(xas, &mapping->i_pages, page->index);
124 	unsigned int nr = 1;
125 
126 	mapping_set_update(&xas, mapping);
127 
128 	/* hugetlb pages are represented by a single entry in the xarray */
129 	if (!PageHuge(page)) {
130 		xas_set_order(&xas, page->index, compound_order(page));
131 		nr = compound_nr(page);
132 	}
133 
134 	VM_BUG_ON_PAGE(!PageLocked(page), page);
135 	VM_BUG_ON_PAGE(PageTail(page), page);
136 	VM_BUG_ON_PAGE(nr != 1 && shadow, page);
137 
138 	xas_store(&xas, shadow);
139 	xas_init_marks(&xas);
140 
141 	page->mapping = NULL;
142 	/* Leave page->index set: truncation lookup relies upon it */
143 
144 	if (shadow) {
145 		mapping->nrexceptional += nr;
146 		/*
147 		 * Make sure the nrexceptional update is committed before
148 		 * the nrpages update so that final truncate racing
149 		 * with reclaim does not see both counters 0 at the
150 		 * same time and miss a shadow entry.
151 		 */
152 		smp_wmb();
153 	}
154 	mapping->nrpages -= nr;
155 }
156 
unaccount_page_cache_page(struct address_space *mapping, struct page *page)157 static void unaccount_page_cache_page(struct address_space *mapping,
158 				      struct page *page)
159 {
160 	int nr;
161 
162 	/*
163 	 * if we're uptodate, flush out into the cleancache, otherwise
164 	 * invalidate any existing cleancache entries.  We can't leave
165 	 * stale data around in the cleancache once our page is gone
166 	 */
167 	if (PageUptodate(page) && PageMappedToDisk(page))
168 		cleancache_put_page(page);
169 	else
170 		cleancache_invalidate_page(mapping, page);
171 
172 	VM_BUG_ON_PAGE(PageTail(page), page);
173 	VM_BUG_ON_PAGE(page_mapped(page), page);
174 	if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
175 		int mapcount;
176 
177 		pr_alert("BUG: Bad page cache in process %s  pfn:%05lx\n",
178 			 current->comm, page_to_pfn(page));
179 		dump_page(page, "still mapped when deleted");
180 		dump_stack();
181 		add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
182 
183 		mapcount = page_mapcount(page);
184 		if (mapping_exiting(mapping) &&
185 		    page_count(page) >= mapcount + 2) {
186 			/*
187 			 * All vmas have already been torn down, so it's
188 			 * a good bet that actually the page is unmapped,
189 			 * and we'd prefer not to leak it: if we're wrong,
190 			 * some other bad page check should catch it later.
191 			 */
192 			page_mapcount_reset(page);
193 			page_ref_sub(page, mapcount);
194 		}
195 	}
196 
197 	/* hugetlb pages do not participate in page cache accounting. */
198 	if (PageHuge(page))
199 		return;
200 
201 	nr = thp_nr_pages(page);
202 
203 	__mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
204 	if (PageSwapBacked(page)) {
205 		__mod_lruvec_page_state(page, NR_SHMEM, -nr);
206 		if (PageTransHuge(page))
207 			__dec_node_page_state(page, NR_SHMEM_THPS);
208 	} else if (PageTransHuge(page)) {
209 		__dec_node_page_state(page, NR_FILE_THPS);
210 		filemap_nr_thps_dec(mapping);
211 	}
212 
213 	/*
214 	 * At this point page must be either written or cleaned by
215 	 * truncate.  Dirty page here signals a bug and loss of
216 	 * unwritten data.
217 	 *
218 	 * This fixes dirty accounting after removing the page entirely
219 	 * but leaves PageDirty set: it has no effect for truncated
220 	 * page and anyway will be cleared before returning page into
221 	 * buddy allocator.
222 	 */
223 	if (WARN_ON_ONCE(PageDirty(page)))
224 		account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
225 }
226 
227 /*
228  * Delete a page from the page cache and free it. Caller has to make
229  * sure the page is locked and that nobody else uses it - or that usage
230  * is safe.  The caller must hold the i_pages lock.
231  */
__delete_from_page_cache(struct page *page, void *shadow)232 void __delete_from_page_cache(struct page *page, void *shadow)
233 {
234 	struct address_space *mapping = page->mapping;
235 
236 	trace_mm_filemap_delete_from_page_cache(page);
237 
238 	unaccount_page_cache_page(mapping, page);
239 	page_cache_delete(mapping, page, shadow);
240 }
241 
page_cache_free_page(struct address_space *mapping, struct page *page)242 static void page_cache_free_page(struct address_space *mapping,
243 				struct page *page)
244 {
245 	void (*freepage)(struct page *);
246 
247 	freepage = mapping->a_ops->freepage;
248 	if (freepage)
249 		freepage(page);
250 
251 	if (PageTransHuge(page) && !PageHuge(page)) {
252 		page_ref_sub(page, thp_nr_pages(page));
253 		VM_BUG_ON_PAGE(page_count(page) <= 0, page);
254 	} else {
255 		put_page(page);
256 	}
257 }
258 
259 /**
260  * delete_from_page_cache - delete page from page cache
261  * @page: the page which the kernel is trying to remove from page cache
262  *
263  * This must be called only on pages that have been verified to be in the page
264  * cache and locked.  It will never put the page into the free list, the caller
265  * has a reference on the page.
266  */
delete_from_page_cache(struct page *page)267 void delete_from_page_cache(struct page *page)
268 {
269 	struct address_space *mapping = page_mapping(page);
270 	unsigned long flags;
271 
272 	BUG_ON(!PageLocked(page));
273 	xa_lock_irqsave(&mapping->i_pages, flags);
274 	__delete_from_page_cache(page, NULL);
275 	xa_unlock_irqrestore(&mapping->i_pages, flags);
276 
277 	page_cache_free_page(mapping, page);
278 }
279 EXPORT_SYMBOL(delete_from_page_cache);
280 
281 /*
282  * page_cache_delete_batch - delete several pages from page cache
283  * @mapping: the mapping to which pages belong
284  * @pvec: pagevec with pages to delete
285  *
286  * The function walks over mapping->i_pages and removes pages passed in @pvec
287  * from the mapping. The function expects @pvec to be sorted by page index
288  * and is optimised for it to be dense.
289  * It tolerates holes in @pvec (mapping entries at those indices are not
290  * modified). The function expects only THP head pages to be present in the
291  * @pvec.
292  *
293  * The function expects the i_pages lock to be held.
294  */
page_cache_delete_batch(struct address_space *mapping, struct pagevec *pvec)295 static void page_cache_delete_batch(struct address_space *mapping,
296 			     struct pagevec *pvec)
297 {
298 	XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
299 	int total_pages = 0;
300 	int i = 0;
301 	struct page *page;
302 
303 	mapping_set_update(&xas, mapping);
304 	xas_for_each(&xas, page, ULONG_MAX) {
305 		if (i >= pagevec_count(pvec))
306 			break;
307 
308 		/* A swap/dax/shadow entry got inserted? Skip it. */
309 		if (xa_is_value(page))
310 			continue;
311 		/*
312 		 * A page got inserted in our range? Skip it. We have our
313 		 * pages locked so they are protected from being removed.
314 		 * If we see a page whose index is higher than ours, it
315 		 * means our page has been removed, which shouldn't be
316 		 * possible because we're holding the PageLock.
317 		 */
318 		if (page != pvec->pages[i]) {
319 			VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
320 					page);
321 			continue;
322 		}
323 
324 		WARN_ON_ONCE(!PageLocked(page));
325 
326 		if (page->index == xas.xa_index)
327 			page->mapping = NULL;
328 		/* Leave page->index set: truncation lookup relies on it */
329 
330 		/*
331 		 * Move to the next page in the vector if this is a regular
332 		 * page or the index is of the last sub-page of this compound
333 		 * page.
334 		 */
335 		if (page->index + compound_nr(page) - 1 == xas.xa_index)
336 			i++;
337 		xas_store(&xas, NULL);
338 		total_pages++;
339 	}
340 	mapping->nrpages -= total_pages;
341 }
342 
delete_from_page_cache_batch(struct address_space *mapping, struct pagevec *pvec)343 void delete_from_page_cache_batch(struct address_space *mapping,
344 				  struct pagevec *pvec)
345 {
346 	int i;
347 	unsigned long flags;
348 
349 	if (!pagevec_count(pvec))
350 		return;
351 
352 	xa_lock_irqsave(&mapping->i_pages, flags);
353 	for (i = 0; i < pagevec_count(pvec); i++) {
354 		trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
355 
356 		unaccount_page_cache_page(mapping, pvec->pages[i]);
357 	}
358 	page_cache_delete_batch(mapping, pvec);
359 	xa_unlock_irqrestore(&mapping->i_pages, flags);
360 
361 	for (i = 0; i < pagevec_count(pvec); i++)
362 		page_cache_free_page(mapping, pvec->pages[i]);
363 }
364 
filemap_check_errors(struct address_space *mapping)365 int filemap_check_errors(struct address_space *mapping)
366 {
367 	int ret = 0;
368 	/* Check for outstanding write errors */
369 	if (test_bit(AS_ENOSPC, &mapping->flags) &&
370 	    test_and_clear_bit(AS_ENOSPC, &mapping->flags))
371 		ret = -ENOSPC;
372 	if (test_bit(AS_EIO, &mapping->flags) &&
373 	    test_and_clear_bit(AS_EIO, &mapping->flags))
374 		ret = -EIO;
375 	return ret;
376 }
377 EXPORT_SYMBOL(filemap_check_errors);
378 
filemap_check_and_keep_errors(struct address_space *mapping)379 static int filemap_check_and_keep_errors(struct address_space *mapping)
380 {
381 	/* Check for outstanding write errors */
382 	if (test_bit(AS_EIO, &mapping->flags))
383 		return -EIO;
384 	if (test_bit(AS_ENOSPC, &mapping->flags))
385 		return -ENOSPC;
386 	return 0;
387 }
388 
389 /**
390  * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
391  * @mapping:	address space structure to write
392  * @start:	offset in bytes where the range starts
393  * @end:	offset in bytes where the range ends (inclusive)
394  * @sync_mode:	enable synchronous operation
395  *
396  * Start writeback against all of a mapping's dirty pages that lie
397  * within the byte offsets <start, end> inclusive.
398  *
399  * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
400  * opposed to a regular memory cleansing writeback.  The difference between
401  * these two operations is that if a dirty page/buffer is encountered, it must
402  * be waited upon, and not just skipped over.
403  *
404  * Return: %0 on success, negative error code otherwise.
405  */
__filemap_fdatawrite_range(struct address_space *mapping, loff_t start, loff_t end, int sync_mode)406 int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
407 				loff_t end, int sync_mode)
408 {
409 	int ret;
410 	struct writeback_control wbc = {
411 		.sync_mode = sync_mode,
412 		.nr_to_write = LONG_MAX,
413 		.range_start = start,
414 		.range_end = end,
415 	};
416 
417 	if (!mapping_can_writeback(mapping) ||
418 	    !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
419 		return 0;
420 
421 	wbc_attach_fdatawrite_inode(&wbc, mapping->host);
422 	ret = do_writepages(mapping, &wbc);
423 	wbc_detach_inode(&wbc);
424 	return ret;
425 }
426 
__filemap_fdatawrite(struct address_space *mapping, int sync_mode)427 static inline int __filemap_fdatawrite(struct address_space *mapping,
428 	int sync_mode)
429 {
430 	return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
431 }
432 
filemap_fdatawrite(struct address_space *mapping)433 int filemap_fdatawrite(struct address_space *mapping)
434 {
435 	return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
436 }
437 EXPORT_SYMBOL(filemap_fdatawrite);
438 
filemap_fdatawrite_range(struct address_space *mapping, loff_t start, loff_t end)439 int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
440 				loff_t end)
441 {
442 	return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
443 }
444 EXPORT_SYMBOL(filemap_fdatawrite_range);
445 
446 /**
447  * filemap_flush - mostly a non-blocking flush
448  * @mapping:	target address_space
449  *
450  * This is a mostly non-blocking flush.  Not suitable for data-integrity
451  * purposes - I/O may not be started against all dirty pages.
452  *
453  * Return: %0 on success, negative error code otherwise.
454  */
filemap_flush(struct address_space *mapping)455 int filemap_flush(struct address_space *mapping)
456 {
457 	return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
458 }
459 EXPORT_SYMBOL(filemap_flush);
460 
461 /**
462  * filemap_range_has_page - check if a page exists in range.
463  * @mapping:           address space within which to check
464  * @start_byte:        offset in bytes where the range starts
465  * @end_byte:          offset in bytes where the range ends (inclusive)
466  *
467  * Find at least one page in the range supplied, usually used to check if
468  * direct writing in this range will trigger a writeback.
469  *
470  * Return: %true if at least one page exists in the specified range,
471  * %false otherwise.
472  */
filemap_range_has_page(struct address_space *mapping, loff_t start_byte, loff_t end_byte)473 bool filemap_range_has_page(struct address_space *mapping,
474 			   loff_t start_byte, loff_t end_byte)
475 {
476 	struct page *page;
477 	XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
478 	pgoff_t max = end_byte >> PAGE_SHIFT;
479 
480 	if (end_byte < start_byte)
481 		return false;
482 
483 	rcu_read_lock();
484 	for (;;) {
485 		page = xas_find(&xas, max);
486 		if (xas_retry(&xas, page))
487 			continue;
488 		/* Shadow entries don't count */
489 		if (xa_is_value(page))
490 			continue;
491 		/*
492 		 * We don't need to try to pin this page; we're about to
493 		 * release the RCU lock anyway.  It is enough to know that
494 		 * there was a page here recently.
495 		 */
496 		break;
497 	}
498 	rcu_read_unlock();
499 
500 	return page != NULL;
501 }
502 EXPORT_SYMBOL(filemap_range_has_page);
503 
__filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte, loff_t end_byte)504 static void __filemap_fdatawait_range(struct address_space *mapping,
505 				     loff_t start_byte, loff_t end_byte)
506 {
507 	pgoff_t index = start_byte >> PAGE_SHIFT;
508 	pgoff_t end = end_byte >> PAGE_SHIFT;
509 	struct pagevec pvec;
510 	int nr_pages;
511 
512 	if (end_byte < start_byte)
513 		return;
514 
515 	pagevec_init(&pvec);
516 	while (index <= end) {
517 		unsigned i;
518 
519 		nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
520 				end, PAGECACHE_TAG_WRITEBACK);
521 		if (!nr_pages)
522 			break;
523 
524 		for (i = 0; i < nr_pages; i++) {
525 			struct page *page = pvec.pages[i];
526 
527 			wait_on_page_writeback(page);
528 			ClearPageError(page);
529 		}
530 		pagevec_release(&pvec);
531 		cond_resched();
532 	}
533 }
534 
535 /**
536  * filemap_fdatawait_range - wait for writeback to complete
537  * @mapping:		address space structure to wait for
538  * @start_byte:		offset in bytes where the range starts
539  * @end_byte:		offset in bytes where the range ends (inclusive)
540  *
541  * Walk the list of under-writeback pages of the given address space
542  * in the given range and wait for all of them.  Check error status of
543  * the address space and return it.
544  *
545  * Since the error status of the address space is cleared by this function,
546  * callers are responsible for checking the return value and handling and/or
547  * reporting the error.
548  *
549  * Return: error status of the address space.
550  */
filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte, loff_t end_byte)551 int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
552 			    loff_t end_byte)
553 {
554 	__filemap_fdatawait_range(mapping, start_byte, end_byte);
555 	return filemap_check_errors(mapping);
556 }
557 EXPORT_SYMBOL(filemap_fdatawait_range);
558 
559 /**
560  * filemap_fdatawait_range_keep_errors - wait for writeback to complete
561  * @mapping:		address space structure to wait for
562  * @start_byte:		offset in bytes where the range starts
563  * @end_byte:		offset in bytes where the range ends (inclusive)
564  *
565  * Walk the list of under-writeback pages of the given address space in the
566  * given range and wait for all of them.  Unlike filemap_fdatawait_range(),
567  * this function does not clear error status of the address space.
568  *
569  * Use this function if callers don't handle errors themselves.  Expected
570  * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
571  * fsfreeze(8)
572  */
filemap_fdatawait_range_keep_errors(struct address_space *mapping, loff_t start_byte, loff_t end_byte)573 int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
574 		loff_t start_byte, loff_t end_byte)
575 {
576 	__filemap_fdatawait_range(mapping, start_byte, end_byte);
577 	return filemap_check_and_keep_errors(mapping);
578 }
579 EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
580 
581 /**
582  * file_fdatawait_range - wait for writeback to complete
583  * @file:		file pointing to address space structure to wait for
584  * @start_byte:		offset in bytes where the range starts
585  * @end_byte:		offset in bytes where the range ends (inclusive)
586  *
587  * Walk the list of under-writeback pages of the address space that file
588  * refers to, in the given range and wait for all of them.  Check error
589  * status of the address space vs. the file->f_wb_err cursor and return it.
590  *
591  * Since the error status of the file is advanced by this function,
592  * callers are responsible for checking the return value and handling and/or
593  * reporting the error.
594  *
595  * Return: error status of the address space vs. the file->f_wb_err cursor.
596  */
file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)597 int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
598 {
599 	struct address_space *mapping = file->f_mapping;
600 
601 	__filemap_fdatawait_range(mapping, start_byte, end_byte);
602 	return file_check_and_advance_wb_err(file);
603 }
604 EXPORT_SYMBOL(file_fdatawait_range);
605 
606 /**
607  * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
608  * @mapping: address space structure to wait for
609  *
610  * Walk the list of under-writeback pages of the given address space
611  * and wait for all of them.  Unlike filemap_fdatawait(), this function
612  * does not clear error status of the address space.
613  *
614  * Use this function if callers don't handle errors themselves.  Expected
615  * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
616  * fsfreeze(8)
617  *
618  * Return: error status of the address space.
619  */
filemap_fdatawait_keep_errors(struct address_space *mapping)620 int filemap_fdatawait_keep_errors(struct address_space *mapping)
621 {
622 	__filemap_fdatawait_range(mapping, 0, LLONG_MAX);
623 	return filemap_check_and_keep_errors(mapping);
624 }
625 EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
626 
627 /* Returns true if writeback might be needed or already in progress. */
mapping_needs_writeback(struct address_space *mapping)628 static bool mapping_needs_writeback(struct address_space *mapping)
629 {
630 	if (dax_mapping(mapping))
631 		return mapping->nrexceptional;
632 
633 	return mapping->nrpages;
634 }
635 
636 /**
637  * filemap_write_and_wait_range - write out & wait on a file range
638  * @mapping:	the address_space for the pages
639  * @lstart:	offset in bytes where the range starts
640  * @lend:	offset in bytes where the range ends (inclusive)
641  *
642  * Write out and wait upon file offsets lstart->lend, inclusive.
643  *
644  * Note that @lend is inclusive (describes the last byte to be written) so
645  * that this function can be used to write to the very end-of-file (end = -1).
646  *
647  * Return: error status of the address space.
648  */
filemap_write_and_wait_range(struct address_space *mapping, loff_t lstart, loff_t lend)649 int filemap_write_and_wait_range(struct address_space *mapping,
650 				 loff_t lstart, loff_t lend)
651 {
652 	int err = 0;
653 
654 	if (mapping_needs_writeback(mapping)) {
655 		err = __filemap_fdatawrite_range(mapping, lstart, lend,
656 						 WB_SYNC_ALL);
657 		/*
658 		 * Even if the above returned error, the pages may be
659 		 * written partially (e.g. -ENOSPC), so we wait for it.
660 		 * But the -EIO is special case, it may indicate the worst
661 		 * thing (e.g. bug) happened, so we avoid waiting for it.
662 		 */
663 		if (err != -EIO) {
664 			int err2 = filemap_fdatawait_range(mapping,
665 						lstart, lend);
666 			if (!err)
667 				err = err2;
668 		} else {
669 			/* Clear any previously stored errors */
670 			filemap_check_errors(mapping);
671 		}
672 	} else {
673 		err = filemap_check_errors(mapping);
674 	}
675 	return err;
676 }
677 EXPORT_SYMBOL(filemap_write_and_wait_range);
678 
__filemap_set_wb_err(struct address_space *mapping, int err)679 void __filemap_set_wb_err(struct address_space *mapping, int err)
680 {
681 	errseq_t eseq = errseq_set(&mapping->wb_err, err);
682 
683 	trace_filemap_set_wb_err(mapping, eseq);
684 }
685 EXPORT_SYMBOL(__filemap_set_wb_err);
686 
687 /**
688  * file_check_and_advance_wb_err - report wb error (if any) that was previously
689  * 				   and advance wb_err to current one
690  * @file: struct file on which the error is being reported
691  *
692  * When userland calls fsync (or something like nfsd does the equivalent), we
693  * want to report any writeback errors that occurred since the last fsync (or
694  * since the file was opened if there haven't been any).
695  *
696  * Grab the wb_err from the mapping. If it matches what we have in the file,
697  * then just quickly return 0. The file is all caught up.
698  *
699  * If it doesn't match, then take the mapping value, set the "seen" flag in
700  * it and try to swap it into place. If it works, or another task beat us
701  * to it with the new value, then update the f_wb_err and return the error
702  * portion. The error at this point must be reported via proper channels
703  * (a'la fsync, or NFS COMMIT operation, etc.).
704  *
705  * While we handle mapping->wb_err with atomic operations, the f_wb_err
706  * value is protected by the f_lock since we must ensure that it reflects
707  * the latest value swapped in for this file descriptor.
708  *
709  * Return: %0 on success, negative error code otherwise.
710  */
file_check_and_advance_wb_err(struct file *file)711 int file_check_and_advance_wb_err(struct file *file)
712 {
713 	int err = 0;
714 	errseq_t old = READ_ONCE(file->f_wb_err);
715 	struct address_space *mapping = file->f_mapping;
716 
717 	/* Locklessly handle the common case where nothing has changed */
718 	if (errseq_check(&mapping->wb_err, old)) {
719 		/* Something changed, must use slow path */
720 		spin_lock(&file->f_lock);
721 		old = file->f_wb_err;
722 		err = errseq_check_and_advance(&mapping->wb_err,
723 						&file->f_wb_err);
724 		trace_file_check_and_advance_wb_err(file, old);
725 		spin_unlock(&file->f_lock);
726 	}
727 
728 	/*
729 	 * We're mostly using this function as a drop in replacement for
730 	 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
731 	 * that the legacy code would have had on these flags.
732 	 */
733 	clear_bit(AS_EIO, &mapping->flags);
734 	clear_bit(AS_ENOSPC, &mapping->flags);
735 	return err;
736 }
737 EXPORT_SYMBOL(file_check_and_advance_wb_err);
738 
739 /**
740  * file_write_and_wait_range - write out & wait on a file range
741  * @file:	file pointing to address_space with pages
742  * @lstart:	offset in bytes where the range starts
743  * @lend:	offset in bytes where the range ends (inclusive)
744  *
745  * Write out and wait upon file offsets lstart->lend, inclusive.
746  *
747  * Note that @lend is inclusive (describes the last byte to be written) so
748  * that this function can be used to write to the very end-of-file (end = -1).
749  *
750  * After writing out and waiting on the data, we check and advance the
751  * f_wb_err cursor to the latest value, and return any errors detected there.
752  *
753  * Return: %0 on success, negative error code otherwise.
754  */
file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)755 int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
756 {
757 	int err = 0, err2;
758 	struct address_space *mapping = file->f_mapping;
759 
760 	if (mapping_needs_writeback(mapping)) {
761 		err = __filemap_fdatawrite_range(mapping, lstart, lend,
762 						 WB_SYNC_ALL);
763 		/* See comment of filemap_write_and_wait() */
764 		if (err != -EIO)
765 			__filemap_fdatawait_range(mapping, lstart, lend);
766 	}
767 	err2 = file_check_and_advance_wb_err(file);
768 	if (!err)
769 		err = err2;
770 	return err;
771 }
772 EXPORT_SYMBOL(file_write_and_wait_range);
773 
774 /**
775  * replace_page_cache_page - replace a pagecache page with a new one
776  * @old:	page to be replaced
777  * @new:	page to replace with
778  * @gfp_mask:	allocation mode
779  *
780  * This function replaces a page in the pagecache with a new one.  On
781  * success it acquires the pagecache reference for the new page and
782  * drops it for the old page.  Both the old and new pages must be
783  * locked.  This function does not add the new page to the LRU, the
784  * caller must do that.
785  *
786  * The remove + add is atomic.  This function cannot fail.
787  *
788  * Return: %0
789  */
replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)790 int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
791 {
792 	struct address_space *mapping = old->mapping;
793 	void (*freepage)(struct page *) = mapping->a_ops->freepage;
794 	pgoff_t offset = old->index;
795 	XA_STATE(xas, &mapping->i_pages, offset);
796 	unsigned long flags;
797 
798 	VM_BUG_ON_PAGE(!PageLocked(old), old);
799 	VM_BUG_ON_PAGE(!PageLocked(new), new);
800 	VM_BUG_ON_PAGE(new->mapping, new);
801 
802 	get_page(new);
803 	new->mapping = mapping;
804 	new->index = offset;
805 
806 	mem_cgroup_migrate(old, new);
807 
808 	xas_lock_irqsave(&xas, flags);
809 	xas_store(&xas, new);
810 
811 	old->mapping = NULL;
812 	/* hugetlb pages do not participate in page cache accounting. */
813 	if (!PageHuge(old))
814 		__dec_lruvec_page_state(old, NR_FILE_PAGES);
815 	if (!PageHuge(new))
816 		__inc_lruvec_page_state(new, NR_FILE_PAGES);
817 	if (PageSwapBacked(old))
818 		__dec_lruvec_page_state(old, NR_SHMEM);
819 	if (PageSwapBacked(new))
820 		__inc_lruvec_page_state(new, NR_SHMEM);
821 	xas_unlock_irqrestore(&xas, flags);
822 	if (freepage)
823 		freepage(old);
824 	put_page(old);
825 
826 	return 0;
827 }
828 EXPORT_SYMBOL_GPL(replace_page_cache_page);
829 
__add_to_page_cache_locked(struct page *page, struct address_space *mapping, pgoff_t offset, gfp_t gfp, void **shadowp)830 noinline int __add_to_page_cache_locked(struct page *page,
831 					struct address_space *mapping,
832 					pgoff_t offset, gfp_t gfp,
833 					void **shadowp)
834 {
835 	XA_STATE(xas, &mapping->i_pages, offset);
836 	int huge = PageHuge(page);
837 	int error;
838 	bool charged = false;
839 
840 	VM_BUG_ON_PAGE(!PageLocked(page), page);
841 	VM_BUG_ON_PAGE(PageSwapBacked(page), page);
842 	mapping_set_update(&xas, mapping);
843 
844 	get_page(page);
845 	page->mapping = mapping;
846 	page->index = offset;
847 
848 	if (!huge) {
849 		error = mem_cgroup_charge(page, current->mm, gfp);
850 		if (error)
851 			goto error;
852 		charged = true;
853 	}
854 
855 	gfp &= GFP_RECLAIM_MASK;
856 
857 	do {
858 		unsigned int order = xa_get_order(xas.xa, xas.xa_index);
859 		void *entry, *old = NULL;
860 
861 		if (order > thp_order(page))
862 			xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
863 					order, gfp);
864 		xas_lock_irq(&xas);
865 		xas_for_each_conflict(&xas, entry) {
866 			old = entry;
867 			if (!xa_is_value(entry)) {
868 				xas_set_err(&xas, -EEXIST);
869 				goto unlock;
870 			}
871 		}
872 
873 		if (old) {
874 			if (shadowp)
875 				*shadowp = old;
876 			/* entry may have been split before we acquired lock */
877 			order = xa_get_order(xas.xa, xas.xa_index);
878 			if (order > thp_order(page)) {
879 				xas_split(&xas, old, order);
880 				xas_reset(&xas);
881 			}
882 		}
883 
884 		xas_store(&xas, page);
885 		if (xas_error(&xas))
886 			goto unlock;
887 
888 		if (old)
889 			mapping->nrexceptional--;
890 		mapping->nrpages++;
891 
892 		/* hugetlb pages do not participate in page cache accounting */
893 		if (!huge)
894 			__inc_lruvec_page_state(page, NR_FILE_PAGES);
895 unlock:
896 		xas_unlock_irq(&xas);
897 	} while (xas_nomem(&xas, gfp));
898 
899 	if (xas_error(&xas)) {
900 		error = xas_error(&xas);
901 		if (charged)
902 			mem_cgroup_uncharge(page);
903 		goto error;
904 	}
905 
906 	trace_mm_filemap_add_to_page_cache(page);
907 	return 0;
908 error:
909 	page->mapping = NULL;
910 	/* Leave page->index set: truncation relies upon it */
911 	put_page(page);
912 	return error;
913 }
914 ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
915 
916 /**
917  * add_to_page_cache_locked - add a locked page to the pagecache
918  * @page:	page to add
919  * @mapping:	the page's address_space
920  * @offset:	page index
921  * @gfp_mask:	page allocation mode
922  *
923  * This function is used to add a page to the pagecache. It must be locked.
924  * This function does not add the page to the LRU.  The caller must do that.
925  *
926  * Return: %0 on success, negative error code otherwise.
927  */
add_to_page_cache_locked(struct page *page, struct address_space *mapping, pgoff_t offset, gfp_t gfp_mask)928 int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
929 		pgoff_t offset, gfp_t gfp_mask)
930 {
931 	return __add_to_page_cache_locked(page, mapping, offset,
932 					  gfp_mask, NULL);
933 }
934 EXPORT_SYMBOL(add_to_page_cache_locked);
935 
add_to_page_cache_lru(struct page *page, struct address_space *mapping, pgoff_t offset, gfp_t gfp_mask)936 int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
937 				pgoff_t offset, gfp_t gfp_mask)
938 {
939 	void *shadow = NULL;
940 	int ret;
941 
942 	__SetPageLocked(page);
943 	ret = __add_to_page_cache_locked(page, mapping, offset,
944 					 gfp_mask, &shadow);
945 	if (unlikely(ret))
946 		__ClearPageLocked(page);
947 	else {
948 		/*
949 		 * The page might have been evicted from cache only
950 		 * recently, in which case it should be activated like
951 		 * any other repeatedly accessed page.
952 		 * The exception is pages getting rewritten; evicting other
953 		 * data from the working set, only to cache data that will
954 		 * get overwritten with something else, is a waste of memory.
955 		 */
956 		WARN_ON_ONCE(PageActive(page));
957 		if (!(gfp_mask & __GFP_WRITE) && shadow)
958 			workingset_refault(page, shadow);
959 		lru_cache_add(page);
960 	}
961 	return ret;
962 }
963 EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
964 
965 #ifdef CONFIG_NUMA
__page_cache_alloc(gfp_t gfp)966 struct page *__page_cache_alloc(gfp_t gfp)
967 {
968 	int n;
969 	struct page *page;
970 
971 	if (cpuset_do_page_mem_spread()) {
972 		unsigned int cpuset_mems_cookie;
973 		do {
974 			cpuset_mems_cookie = read_mems_allowed_begin();
975 			n = cpuset_mem_spread_node();
976 			page = __alloc_pages_node(n, gfp, 0);
977 		} while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
978 
979 		return page;
980 	}
981 	return alloc_pages(gfp, 0);
982 }
983 EXPORT_SYMBOL(__page_cache_alloc);
984 #endif
985 
986 /*
987  * In order to wait for pages to become available there must be
988  * waitqueues associated with pages. By using a hash table of
989  * waitqueues where the bucket discipline is to maintain all
990  * waiters on the same queue and wake all when any of the pages
991  * become available, and for the woken contexts to check to be
992  * sure the appropriate page became available, this saves space
993  * at a cost of "thundering herd" phenomena during rare hash
994  * collisions.
995  */
996 #define PAGE_WAIT_TABLE_BITS 8
997 #define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
998 static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
999 
page_waitqueue(struct page *page)1000 static wait_queue_head_t *page_waitqueue(struct page *page)
1001 {
1002 	return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
1003 }
1004 
pagecache_init(void)1005 void __init pagecache_init(void)
1006 {
1007 	int i;
1008 
1009 	for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1010 		init_waitqueue_head(&page_wait_table[i]);
1011 
1012 	page_writeback_init();
1013 }
1014 
1015 /*
1016  * The page wait code treats the "wait->flags" somewhat unusually, because
1017  * we have multiple different kinds of waits, not just the usual "exclusive"
1018  * one.
1019  *
1020  * We have:
1021  *
1022  *  (a) no special bits set:
1023  *
1024  *	We're just waiting for the bit to be released, and when a waker
1025  *	calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1026  *	and remove it from the wait queue.
1027  *
1028  *	Simple and straightforward.
1029  *
1030  *  (b) WQ_FLAG_EXCLUSIVE:
1031  *
1032  *	The waiter is waiting to get the lock, and only one waiter should
1033  *	be woken up to avoid any thundering herd behavior. We'll set the
1034  *	WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1035  *
1036  *	This is the traditional exclusive wait.
1037  *
1038  *  (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
1039  *
1040  *	The waiter is waiting to get the bit, and additionally wants the
1041  *	lock to be transferred to it for fair lock behavior. If the lock
1042  *	cannot be taken, we stop walking the wait queue without waking
1043  *	the waiter.
1044  *
1045  *	This is the "fair lock handoff" case, and in addition to setting
1046  *	WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1047  *	that it now has the lock.
1048  */
wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)1049 static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
1050 {
1051 	unsigned int flags;
1052 	struct wait_page_key *key = arg;
1053 	struct wait_page_queue *wait_page
1054 		= container_of(wait, struct wait_page_queue, wait);
1055 
1056 	if (!wake_page_match(wait_page, key))
1057 		return 0;
1058 
1059 	/*
1060 	 * If it's a lock handoff wait, we get the bit for it, and
1061 	 * stop walking (and do not wake it up) if we can't.
1062 	 */
1063 	flags = wait->flags;
1064 	if (flags & WQ_FLAG_EXCLUSIVE) {
1065 		if (test_bit(key->bit_nr, &key->page->flags))
1066 			return -1;
1067 		if (flags & WQ_FLAG_CUSTOM) {
1068 			if (test_and_set_bit(key->bit_nr, &key->page->flags))
1069 				return -1;
1070 			flags |= WQ_FLAG_DONE;
1071 		}
1072 	}
1073 
1074 	/*
1075 	 * We are holding the wait-queue lock, but the waiter that
1076 	 * is waiting for this will be checking the flags without
1077 	 * any locking.
1078 	 *
1079 	 * So update the flags atomically, and wake up the waiter
1080 	 * afterwards to avoid any races. This store-release pairs
1081 	 * with the load-acquire in wait_on_page_bit_common().
1082 	 */
1083 	smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
1084 	wake_up_state(wait->private, mode);
1085 
1086 	/*
1087 	 * Ok, we have successfully done what we're waiting for,
1088 	 * and we can unconditionally remove the wait entry.
1089 	 *
1090 	 * Note that this pairs with the "finish_wait()" in the
1091 	 * waiter, and has to be the absolute last thing we do.
1092 	 * After this list_del_init(&wait->entry) the wait entry
1093 	 * might be de-allocated and the process might even have
1094 	 * exited.
1095 	 */
1096 	list_del_init_careful(&wait->entry);
1097 	return (flags & WQ_FLAG_EXCLUSIVE) != 0;
1098 }
1099 
wake_up_page_bit(struct page *page, int bit_nr)1100 static void wake_up_page_bit(struct page *page, int bit_nr)
1101 {
1102 	wait_queue_head_t *q = page_waitqueue(page);
1103 	struct wait_page_key key;
1104 	unsigned long flags;
1105 	wait_queue_entry_t bookmark;
1106 
1107 	key.page = page;
1108 	key.bit_nr = bit_nr;
1109 	key.page_match = 0;
1110 
1111 	bookmark.flags = 0;
1112 	bookmark.private = NULL;
1113 	bookmark.func = NULL;
1114 	INIT_LIST_HEAD(&bookmark.entry);
1115 
1116 	spin_lock_irqsave(&q->lock, flags);
1117 	__wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1118 
1119 	while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1120 		/*
1121 		 * Take a breather from holding the lock,
1122 		 * allow pages that finish wake up asynchronously
1123 		 * to acquire the lock and remove themselves
1124 		 * from wait queue
1125 		 */
1126 		spin_unlock_irqrestore(&q->lock, flags);
1127 		cpu_relax();
1128 		spin_lock_irqsave(&q->lock, flags);
1129 		__wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1130 	}
1131 
1132 	/*
1133 	 * It is possible for other pages to have collided on the waitqueue
1134 	 * hash, so in that case check for a page match. That prevents a long-
1135 	 * term waiter
1136 	 *
1137 	 * It is still possible to miss a case here, when we woke page waiters
1138 	 * and removed them from the waitqueue, but there are still other
1139 	 * page waiters.
1140 	 */
1141 	if (!waitqueue_active(q) || !key.page_match) {
1142 		ClearPageWaiters(page);
1143 		/*
1144 		 * It's possible to miss clearing Waiters here, when we woke
1145 		 * our page waiters, but the hashed waitqueue has waiters for
1146 		 * other pages on it.
1147 		 *
1148 		 * That's okay, it's a rare case. The next waker will clear it.
1149 		 */
1150 	}
1151 	spin_unlock_irqrestore(&q->lock, flags);
1152 }
1153 
wake_up_page(struct page *page, int bit)1154 static void wake_up_page(struct page *page, int bit)
1155 {
1156 	if (!PageWaiters(page))
1157 		return;
1158 	wake_up_page_bit(page, bit);
1159 }
1160 
1161 /*
1162  * A choice of three behaviors for wait_on_page_bit_common():
1163  */
1164 enum behavior {
1165 	EXCLUSIVE,	/* Hold ref to page and take the bit when woken, like
1166 			 * __lock_page() waiting on then setting PG_locked.
1167 			 */
1168 	SHARED,		/* Hold ref to page and check the bit when woken, like
1169 			 * wait_on_page_writeback() waiting on PG_writeback.
1170 			 */
1171 	DROP,		/* Drop ref to page before wait, no check when woken,
1172 			 * like put_and_wait_on_page_locked() on PG_locked.
1173 			 */
1174 };
1175 
1176 /*
1177  * Attempt to check (or get) the page bit, and mark us done
1178  * if successful.
1179  */
trylock_page_bit_common(struct page *page, int bit_nr, struct wait_queue_entry *wait)1180 static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1181 					struct wait_queue_entry *wait)
1182 {
1183 	if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1184 		if (test_and_set_bit(bit_nr, &page->flags))
1185 			return false;
1186 	} else if (test_bit(bit_nr, &page->flags))
1187 		return false;
1188 
1189 	wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
1190 	return true;
1191 }
1192 
1193 /* How many times do we accept lock stealing from under a waiter? */
1194 int sysctl_page_lock_unfairness = 5;
1195 
wait_on_page_bit_common(wait_queue_head_t *q, struct page *page, int bit_nr, int state, enum behavior behavior)1196 static inline int wait_on_page_bit_common(wait_queue_head_t *q,
1197 	struct page *page, int bit_nr, int state, enum behavior behavior)
1198 {
1199 	int unfairness = sysctl_page_lock_unfairness;
1200 	struct wait_page_queue wait_page;
1201 	wait_queue_entry_t *wait = &wait_page.wait;
1202 	bool thrashing = false;
1203 	bool delayacct = false;
1204 	unsigned long pflags;
1205 
1206 	if (bit_nr == PG_locked &&
1207 	    !PageUptodate(page) && PageWorkingset(page)) {
1208 		if (!PageSwapBacked(page)) {
1209 			delayacct_thrashing_start();
1210 			delayacct = true;
1211 		}
1212 		psi_memstall_enter(&pflags);
1213 		thrashing = true;
1214 	}
1215 
1216 	init_wait(wait);
1217 	wait->func = wake_page_function;
1218 	wait_page.page = page;
1219 	wait_page.bit_nr = bit_nr;
1220 
1221 repeat:
1222 	wait->flags = 0;
1223 	if (behavior == EXCLUSIVE) {
1224 		wait->flags = WQ_FLAG_EXCLUSIVE;
1225 		if (--unfairness < 0)
1226 			wait->flags |= WQ_FLAG_CUSTOM;
1227 	}
1228 
1229 	/*
1230 	 * Do one last check whether we can get the
1231 	 * page bit synchronously.
1232 	 *
1233 	 * Do the SetPageWaiters() marking before that
1234 	 * to let any waker we _just_ missed know they
1235 	 * need to wake us up (otherwise they'll never
1236 	 * even go to the slow case that looks at the
1237 	 * page queue), and add ourselves to the wait
1238 	 * queue if we need to sleep.
1239 	 *
1240 	 * This part needs to be done under the queue
1241 	 * lock to avoid races.
1242 	 */
1243 	spin_lock_irq(&q->lock);
1244 	SetPageWaiters(page);
1245 	if (!trylock_page_bit_common(page, bit_nr, wait))
1246 		__add_wait_queue_entry_tail(q, wait);
1247 	spin_unlock_irq(&q->lock);
1248 
1249 	/*
1250 	 * From now on, all the logic will be based on
1251 	 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1252 	 * see whether the page bit testing has already
1253 	 * been done by the wake function.
1254 	 *
1255 	 * We can drop our reference to the page.
1256 	 */
1257 	if (behavior == DROP)
1258 		put_page(page);
1259 
1260 	/*
1261 	 * Note that until the "finish_wait()", or until
1262 	 * we see the WQ_FLAG_WOKEN flag, we need to
1263 	 * be very careful with the 'wait->flags', because
1264 	 * we may race with a waker that sets them.
1265 	 */
1266 	for (;;) {
1267 		unsigned int flags;
1268 
1269 		set_current_state(state);
1270 
1271 		/* Loop until we've been woken or interrupted */
1272 		flags = smp_load_acquire(&wait->flags);
1273 		if (!(flags & WQ_FLAG_WOKEN)) {
1274 			if (signal_pending_state(state, current))
1275 				break;
1276 
1277 			io_schedule();
1278 			continue;
1279 		}
1280 
1281 		/* If we were non-exclusive, we're done */
1282 		if (behavior != EXCLUSIVE)
1283 			break;
1284 
1285 		/* If the waker got the lock for us, we're done */
1286 		if (flags & WQ_FLAG_DONE)
1287 			break;
1288 
1289 		/*
1290 		 * Otherwise, if we're getting the lock, we need to
1291 		 * try to get it ourselves.
1292 		 *
1293 		 * And if that fails, we'll have to retry this all.
1294 		 */
1295 		if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1296 			goto repeat;
1297 
1298 		wait->flags |= WQ_FLAG_DONE;
1299 		break;
1300 	}
1301 
1302 	/*
1303 	 * If a signal happened, this 'finish_wait()' may remove the last
1304 	 * waiter from the wait-queues, but the PageWaiters bit will remain
1305 	 * set. That's ok. The next wakeup will take care of it, and trying
1306 	 * to do it here would be difficult and prone to races.
1307 	 */
1308 	finish_wait(q, wait);
1309 
1310 	if (thrashing) {
1311 		if (delayacct)
1312 			delayacct_thrashing_end();
1313 		psi_memstall_leave(&pflags);
1314 	}
1315 
1316 	/*
1317 	 * NOTE! The wait->flags weren't stable until we've done the
1318 	 * 'finish_wait()', and we could have exited the loop above due
1319 	 * to a signal, and had a wakeup event happen after the signal
1320 	 * test but before the 'finish_wait()'.
1321 	 *
1322 	 * So only after the finish_wait() can we reliably determine
1323 	 * if we got woken up or not, so we can now figure out the final
1324 	 * return value based on that state without races.
1325 	 *
1326 	 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1327 	 * waiter, but an exclusive one requires WQ_FLAG_DONE.
1328 	 */
1329 	if (behavior == EXCLUSIVE)
1330 		return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
1331 
1332 	return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
1333 }
1334 
wait_on_page_bit(struct page *page, int bit_nr)1335 void wait_on_page_bit(struct page *page, int bit_nr)
1336 {
1337 	wait_queue_head_t *q = page_waitqueue(page);
1338 	wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
1339 }
1340 EXPORT_SYMBOL(wait_on_page_bit);
1341 
wait_on_page_bit_killable(struct page *page, int bit_nr)1342 int wait_on_page_bit_killable(struct page *page, int bit_nr)
1343 {
1344 	wait_queue_head_t *q = page_waitqueue(page);
1345 	return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
1346 }
1347 EXPORT_SYMBOL(wait_on_page_bit_killable);
1348 
__wait_on_page_locked_async(struct page *page, struct wait_page_queue *wait, bool set)1349 static int __wait_on_page_locked_async(struct page *page,
1350 				       struct wait_page_queue *wait, bool set)
1351 {
1352 	struct wait_queue_head *q = page_waitqueue(page);
1353 	int ret = 0;
1354 
1355 	wait->page = page;
1356 	wait->bit_nr = PG_locked;
1357 
1358 	spin_lock_irq(&q->lock);
1359 	__add_wait_queue_entry_tail(q, &wait->wait);
1360 	SetPageWaiters(page);
1361 	if (set)
1362 		ret = !trylock_page(page);
1363 	else
1364 		ret = PageLocked(page);
1365 	/*
1366 	 * If we were succesful now, we know we're still on the
1367 	 * waitqueue as we're still under the lock. This means it's
1368 	 * safe to remove and return success, we know the callback
1369 	 * isn't going to trigger.
1370 	 */
1371 	if (!ret)
1372 		__remove_wait_queue(q, &wait->wait);
1373 	else
1374 		ret = -EIOCBQUEUED;
1375 	spin_unlock_irq(&q->lock);
1376 	return ret;
1377 }
1378 
wait_on_page_locked_async(struct page *page, struct wait_page_queue *wait)1379 static int wait_on_page_locked_async(struct page *page,
1380 				     struct wait_page_queue *wait)
1381 {
1382 	if (!PageLocked(page))
1383 		return 0;
1384 	return __wait_on_page_locked_async(compound_head(page), wait, false);
1385 }
1386 
1387 /**
1388  * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1389  * @page: The page to wait for.
1390  *
1391  * The caller should hold a reference on @page.  They expect the page to
1392  * become unlocked relatively soon, but do not wish to hold up migration
1393  * (for example) by holding the reference while waiting for the page to
1394  * come unlocked.  After this function returns, the caller should not
1395  * dereference @page.
1396  */
put_and_wait_on_page_locked(struct page *page)1397 void put_and_wait_on_page_locked(struct page *page)
1398 {
1399 	wait_queue_head_t *q;
1400 
1401 	page = compound_head(page);
1402 	q = page_waitqueue(page);
1403 	wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1404 }
1405 
1406 /**
1407  * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
1408  * @page: Page defining the wait queue of interest
1409  * @waiter: Waiter to add to the queue
1410  *
1411  * Add an arbitrary @waiter to the wait queue for the nominated @page.
1412  */
add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)1413 void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
1414 {
1415 	wait_queue_head_t *q = page_waitqueue(page);
1416 	unsigned long flags;
1417 
1418 	spin_lock_irqsave(&q->lock, flags);
1419 	__add_wait_queue_entry_tail(q, waiter);
1420 	SetPageWaiters(page);
1421 	spin_unlock_irqrestore(&q->lock, flags);
1422 }
1423 EXPORT_SYMBOL_GPL(add_page_wait_queue);
1424 
1425 #ifndef clear_bit_unlock_is_negative_byte
1426 
1427 /*
1428  * PG_waiters is the high bit in the same byte as PG_lock.
1429  *
1430  * On x86 (and on many other architectures), we can clear PG_lock and
1431  * test the sign bit at the same time. But if the architecture does
1432  * not support that special operation, we just do this all by hand
1433  * instead.
1434  *
1435  * The read of PG_waiters has to be after (or concurrently with) PG_locked
1436  * being cleared, but a memory barrier should be unnecessary since it is
1437  * in the same byte as PG_locked.
1438  */
clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)1439 static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1440 {
1441 	clear_bit_unlock(nr, mem);
1442 	/* smp_mb__after_atomic(); */
1443 	return test_bit(PG_waiters, mem);
1444 }
1445 
1446 #endif
1447 
1448 /**
1449  * unlock_page - unlock a locked page
1450  * @page: the page
1451  *
1452  * Unlocks the page and wakes up sleepers in wait_on_page_locked().
1453  * Also wakes sleepers in wait_on_page_writeback() because the wakeup
1454  * mechanism between PageLocked pages and PageWriteback pages is shared.
1455  * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1456  *
1457  * Note that this depends on PG_waiters being the sign bit in the byte
1458  * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1459  * clear the PG_locked bit and test PG_waiters at the same time fairly
1460  * portably (architectures that do LL/SC can test any bit, while x86 can
1461  * test the sign bit).
1462  */
unlock_page(struct page *page)1463 void unlock_page(struct page *page)
1464 {
1465 	BUILD_BUG_ON(PG_waiters != 7);
1466 	page = compound_head(page);
1467 	VM_BUG_ON_PAGE(!PageLocked(page), page);
1468 	if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1469 		wake_up_page_bit(page, PG_locked);
1470 }
1471 EXPORT_SYMBOL(unlock_page);
1472 
1473 /**
1474  * end_page_writeback - end writeback against a page
1475  * @page: the page
1476  */
end_page_writeback(struct page *page)1477 void end_page_writeback(struct page *page)
1478 {
1479 	/*
1480 	 * TestClearPageReclaim could be used here but it is an atomic
1481 	 * operation and overkill in this particular case. Failing to
1482 	 * shuffle a page marked for immediate reclaim is too mild to
1483 	 * justify taking an atomic operation penalty at the end of
1484 	 * ever page writeback.
1485 	 */
1486 	if (PageReclaim(page)) {
1487 		ClearPageReclaim(page);
1488 		rotate_reclaimable_page(page);
1489 	}
1490 
1491 	/*
1492 	 * Writeback does not hold a page reference of its own, relying
1493 	 * on truncation to wait for the clearing of PG_writeback.
1494 	 * But here we must make sure that the page is not freed and
1495 	 * reused before the wake_up_page().
1496 	 */
1497 	get_page(page);
1498 	if (!test_clear_page_writeback(page))
1499 		BUG();
1500 
1501 	smp_mb__after_atomic();
1502 	wake_up_page(page, PG_writeback);
1503 	put_page(page);
1504 }
1505 EXPORT_SYMBOL(end_page_writeback);
1506 
1507 /*
1508  * After completing I/O on a page, call this routine to update the page
1509  * flags appropriately
1510  */
page_endio(struct page *page, bool is_write, int err)1511 void page_endio(struct page *page, bool is_write, int err)
1512 {
1513 	if (!is_write) {
1514 		if (!err) {
1515 			SetPageUptodate(page);
1516 		} else {
1517 			ClearPageUptodate(page);
1518 			SetPageError(page);
1519 		}
1520 		unlock_page(page);
1521 	} else {
1522 		if (err) {
1523 			struct address_space *mapping;
1524 
1525 			SetPageError(page);
1526 			mapping = page_mapping(page);
1527 			if (mapping)
1528 				mapping_set_error(mapping, err);
1529 		}
1530 		end_page_writeback(page);
1531 	}
1532 }
1533 EXPORT_SYMBOL_GPL(page_endio);
1534 
1535 /**
1536  * __lock_page - get a lock on the page, assuming we need to sleep to get it
1537  * @__page: the page to lock
1538  */
__lock_page(struct page *__page)1539 void __lock_page(struct page *__page)
1540 {
1541 	struct page *page = compound_head(__page);
1542 	wait_queue_head_t *q = page_waitqueue(page);
1543 	wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1544 				EXCLUSIVE);
1545 }
1546 EXPORT_SYMBOL(__lock_page);
1547 
__lock_page_killable(struct page *__page)1548 int __lock_page_killable(struct page *__page)
1549 {
1550 	struct page *page = compound_head(__page);
1551 	wait_queue_head_t *q = page_waitqueue(page);
1552 	return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1553 					EXCLUSIVE);
1554 }
1555 EXPORT_SYMBOL_GPL(__lock_page_killable);
1556 
__lock_page_async(struct page *page, struct wait_page_queue *wait)1557 int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1558 {
1559 	return __wait_on_page_locked_async(page, wait, true);
1560 }
1561 
1562 /*
1563  * Return values:
1564  * 1 - page is locked; mmap_lock is still held.
1565  * 0 - page is not locked.
1566  *     mmap_lock has been released (mmap_read_unlock(), unless flags had both
1567  *     FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1568  *     which case mmap_lock is still held.
1569  *
1570  * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1571  * with the page locked and the mmap_lock unperturbed.
1572  */
__lock_page_or_retry(struct page *page, struct mm_struct *mm, unsigned int flags)1573 int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1574 			 unsigned int flags)
1575 {
1576 	if (fault_flag_allow_retry_first(flags)) {
1577 		/*
1578 		 * CAUTION! In this case, mmap_lock is not released
1579 		 * even though return 0.
1580 		 */
1581 		if (flags & FAULT_FLAG_RETRY_NOWAIT)
1582 			return 0;
1583 
1584 		mmap_read_unlock(mm);
1585 		if (flags & FAULT_FLAG_KILLABLE)
1586 			wait_on_page_locked_killable(page);
1587 		else
1588 			wait_on_page_locked(page);
1589 		return 0;
1590 	} else {
1591 		if (flags & FAULT_FLAG_KILLABLE) {
1592 			int ret;
1593 
1594 			ret = __lock_page_killable(page);
1595 			if (ret) {
1596 				mmap_read_unlock(mm);
1597 				return 0;
1598 			}
1599 		} else
1600 			__lock_page(page);
1601 		return 1;
1602 	}
1603 }
1604 
1605 /**
1606  * page_cache_next_miss() - Find the next gap in the page cache.
1607  * @mapping: Mapping.
1608  * @index: Index.
1609  * @max_scan: Maximum range to search.
1610  *
1611  * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1612  * gap with the lowest index.
1613  *
1614  * This function may be called under the rcu_read_lock.  However, this will
1615  * not atomically search a snapshot of the cache at a single point in time.
1616  * For example, if a gap is created at index 5, then subsequently a gap is
1617  * created at index 10, page_cache_next_miss covering both indices may
1618  * return 10 if called under the rcu_read_lock.
1619  *
1620  * Return: The index of the gap if found, otherwise an index outside the
1621  * range specified (in which case 'return - index >= max_scan' will be true).
1622  * In the rare case of index wrap-around, 0 will be returned.
1623  */
page_cache_next_miss(struct address_space *mapping, pgoff_t index, unsigned long max_scan)1624 pgoff_t page_cache_next_miss(struct address_space *mapping,
1625 			     pgoff_t index, unsigned long max_scan)
1626 {
1627 	XA_STATE(xas, &mapping->i_pages, index);
1628 
1629 	while (max_scan--) {
1630 		void *entry = xas_next(&xas);
1631 		if (!entry || xa_is_value(entry))
1632 			break;
1633 		if (xas.xa_index == 0)
1634 			break;
1635 	}
1636 
1637 	return xas.xa_index;
1638 }
1639 EXPORT_SYMBOL(page_cache_next_miss);
1640 
1641 /**
1642  * page_cache_prev_miss() - Find the previous gap in the page cache.
1643  * @mapping: Mapping.
1644  * @index: Index.
1645  * @max_scan: Maximum range to search.
1646  *
1647  * Search the range [max(index - max_scan + 1, 0), index] for the
1648  * gap with the highest index.
1649  *
1650  * This function may be called under the rcu_read_lock.  However, this will
1651  * not atomically search a snapshot of the cache at a single point in time.
1652  * For example, if a gap is created at index 10, then subsequently a gap is
1653  * created at index 5, page_cache_prev_miss() covering both indices may
1654  * return 5 if called under the rcu_read_lock.
1655  *
1656  * Return: The index of the gap if found, otherwise an index outside the
1657  * range specified (in which case 'index - return >= max_scan' will be true).
1658  * In the rare case of wrap-around, ULONG_MAX will be returned.
1659  */
page_cache_prev_miss(struct address_space *mapping, pgoff_t index, unsigned long max_scan)1660 pgoff_t page_cache_prev_miss(struct address_space *mapping,
1661 			     pgoff_t index, unsigned long max_scan)
1662 {
1663 	XA_STATE(xas, &mapping->i_pages, index);
1664 
1665 	while (max_scan--) {
1666 		void *entry = xas_prev(&xas);
1667 		if (!entry || xa_is_value(entry))
1668 			break;
1669 		if (xas.xa_index == ULONG_MAX)
1670 			break;
1671 	}
1672 
1673 	return xas.xa_index;
1674 }
1675 EXPORT_SYMBOL(page_cache_prev_miss);
1676 
1677 /**
1678  * find_get_entry - find and get a page cache entry
1679  * @mapping: the address_space to search
1680  * @index: The page cache index.
1681  *
1682  * Looks up the page cache slot at @mapping & @offset.  If there is a
1683  * page cache page, the head page is returned with an increased refcount.
1684  *
1685  * If the slot holds a shadow entry of a previously evicted page, or a
1686  * swap entry from shmem/tmpfs, it is returned.
1687  *
1688  * Return: The head page or shadow entry, %NULL if nothing is found.
1689  */
find_get_entry(struct address_space *mapping, pgoff_t index)1690 struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
1691 {
1692 	XA_STATE(xas, &mapping->i_pages, index);
1693 	struct page *page;
1694 
1695 	rcu_read_lock();
1696 repeat:
1697 	xas_reset(&xas);
1698 	page = xas_load(&xas);
1699 	if (xas_retry(&xas, page))
1700 		goto repeat;
1701 	/*
1702 	 * A shadow entry of a recently evicted page, or a swap entry from
1703 	 * shmem/tmpfs.  Return it without attempting to raise page count.
1704 	 */
1705 	if (!page || xa_is_value(page))
1706 		goto out;
1707 
1708 	if (!page_cache_get_speculative(page))
1709 		goto repeat;
1710 
1711 	/*
1712 	 * Has the page moved or been split?
1713 	 * This is part of the lockless pagecache protocol. See
1714 	 * include/linux/pagemap.h for details.
1715 	 */
1716 	if (unlikely(page != xas_reload(&xas))) {
1717 		put_page(page);
1718 		goto repeat;
1719 	}
1720 out:
1721 	rcu_read_unlock();
1722 
1723 	return page;
1724 }
1725 
1726 /**
1727  * find_lock_entry - Locate and lock a page cache entry.
1728  * @mapping: The address_space to search.
1729  * @index: The page cache index.
1730  *
1731  * Looks up the page at @mapping & @index.  If there is a page in the
1732  * cache, the head page is returned locked and with an increased refcount.
1733  *
1734  * If the slot holds a shadow entry of a previously evicted page, or a
1735  * swap entry from shmem/tmpfs, it is returned.
1736  *
1737  * Context: May sleep.
1738  * Return: The head page or shadow entry, %NULL if nothing is found.
1739  */
find_lock_entry(struct address_space *mapping, pgoff_t index)1740 struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
1741 {
1742 	struct page *page;
1743 
1744 repeat:
1745 	page = find_get_entry(mapping, index);
1746 	if (page && !xa_is_value(page)) {
1747 		lock_page(page);
1748 		/* Has the page been truncated? */
1749 		if (unlikely(page->mapping != mapping)) {
1750 			unlock_page(page);
1751 			put_page(page);
1752 			goto repeat;
1753 		}
1754 		VM_BUG_ON_PAGE(!thp_contains(page, index), page);
1755 	}
1756 	return page;
1757 }
1758 
1759 /**
1760  * pagecache_get_page - Find and get a reference to a page.
1761  * @mapping: The address_space to search.
1762  * @index: The page index.
1763  * @fgp_flags: %FGP flags modify how the page is returned.
1764  * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
1765  *
1766  * Looks up the page cache entry at @mapping & @index.
1767  *
1768  * @fgp_flags can be zero or more of these flags:
1769  *
1770  * * %FGP_ACCESSED - The page will be marked accessed.
1771  * * %FGP_LOCK - The page is returned locked.
1772  * * %FGP_HEAD - If the page is present and a THP, return the head page
1773  *   rather than the exact page specified by the index.
1774  * * %FGP_CREAT - If no page is present then a new page is allocated using
1775  *   @gfp_mask and added to the page cache and the VM's LRU list.
1776  *   The page is returned locked and with an increased refcount.
1777  * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1778  *   page is already in cache.  If the page was allocated, unlock it before
1779  *   returning so the caller can do the same dance.
1780  * * %FGP_WRITE - The page will be written
1781  * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1782  * * %FGP_NOWAIT - Don't get blocked by page lock
1783  *
1784  * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1785  * if the %GFP flags specified for %FGP_CREAT are atomic.
1786  *
1787  * If there is a page cache page, it is returned with an increased refcount.
1788  *
1789  * Return: The found page or %NULL otherwise.
1790  */
pagecache_get_page(struct address_space *mapping, pgoff_t index, int fgp_flags, gfp_t gfp_mask)1791 struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1792 		int fgp_flags, gfp_t gfp_mask)
1793 {
1794 	struct page *page;
1795 
1796 repeat:
1797 	page = find_get_entry(mapping, index);
1798 	if (xa_is_value(page))
1799 		page = NULL;
1800 	if (!page)
1801 		goto no_page;
1802 
1803 	if (fgp_flags & FGP_LOCK) {
1804 		if (fgp_flags & FGP_NOWAIT) {
1805 			if (!trylock_page(page)) {
1806 				put_page(page);
1807 				return NULL;
1808 			}
1809 		} else {
1810 			lock_page(page);
1811 		}
1812 
1813 		/* Has the page been truncated? */
1814 		if (unlikely(page->mapping != mapping)) {
1815 			unlock_page(page);
1816 			put_page(page);
1817 			goto repeat;
1818 		}
1819 		VM_BUG_ON_PAGE(!thp_contains(page, index), page);
1820 	}
1821 
1822 	if (fgp_flags & FGP_ACCESSED)
1823 		mark_page_accessed(page);
1824 	else if (fgp_flags & FGP_WRITE) {
1825 		/* Clear idle flag for buffer write */
1826 		if (page_is_idle(page))
1827 			clear_page_idle(page);
1828 	}
1829 	if (!(fgp_flags & FGP_HEAD))
1830 		page = find_subpage(page, index);
1831 
1832 no_page:
1833 	if (!page && (fgp_flags & FGP_CREAT)) {
1834 		int err;
1835 		if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
1836 			gfp_mask |= __GFP_WRITE;
1837 		if (fgp_flags & FGP_NOFS)
1838 			gfp_mask &= ~__GFP_FS;
1839 
1840 		page = __page_cache_alloc(gfp_mask);
1841 		if (!page)
1842 			return NULL;
1843 
1844 		if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
1845 			fgp_flags |= FGP_LOCK;
1846 
1847 		/* Init accessed so avoid atomic mark_page_accessed later */
1848 		if (fgp_flags & FGP_ACCESSED)
1849 			__SetPageReferenced(page);
1850 
1851 		err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
1852 		if (unlikely(err)) {
1853 			put_page(page);
1854 			page = NULL;
1855 			if (err == -EEXIST)
1856 				goto repeat;
1857 		}
1858 
1859 		/*
1860 		 * add_to_page_cache_lru locks the page, and for mmap we expect
1861 		 * an unlocked page.
1862 		 */
1863 		if (page && (fgp_flags & FGP_FOR_MMAP))
1864 			unlock_page(page);
1865 	}
1866 
1867 	return page;
1868 }
1869 EXPORT_SYMBOL(pagecache_get_page);
1870 
1871 /**
1872  * find_get_entries - gang pagecache lookup
1873  * @mapping:	The address_space to search
1874  * @start:	The starting page cache index
1875  * @nr_entries:	The maximum number of entries
1876  * @entries:	Where the resulting entries are placed
1877  * @indices:	The cache indices corresponding to the entries in @entries
1878  *
1879  * find_get_entries() will search for and return a group of up to
1880  * @nr_entries entries in the mapping.  The entries are placed at
1881  * @entries.  find_get_entries() takes a reference against any actual
1882  * pages it returns.
1883  *
1884  * The search returns a group of mapping-contiguous page cache entries
1885  * with ascending indexes.  There may be holes in the indices due to
1886  * not-present pages.
1887  *
1888  * Any shadow entries of evicted pages, or swap entries from
1889  * shmem/tmpfs, are included in the returned array.
1890  *
1891  * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1892  * stops at that page: the caller is likely to have a better way to handle
1893  * the compound page as a whole, and then skip its extent, than repeatedly
1894  * calling find_get_entries() to return all its tails.
1895  *
1896  * Return: the number of pages and shadow entries which were found.
1897  */
find_get_entries(struct address_space *mapping, pgoff_t start, unsigned int nr_entries, struct page **entries, pgoff_t *indices)1898 unsigned find_get_entries(struct address_space *mapping,
1899 			  pgoff_t start, unsigned int nr_entries,
1900 			  struct page **entries, pgoff_t *indices)
1901 {
1902 	XA_STATE(xas, &mapping->i_pages, start);
1903 	struct page *page;
1904 	unsigned int ret = 0;
1905 
1906 	if (!nr_entries)
1907 		return 0;
1908 
1909 	rcu_read_lock();
1910 	xas_for_each(&xas, page, ULONG_MAX) {
1911 		if (xas_retry(&xas, page))
1912 			continue;
1913 		/*
1914 		 * A shadow entry of a recently evicted page, a swap
1915 		 * entry from shmem/tmpfs or a DAX entry.  Return it
1916 		 * without attempting to raise page count.
1917 		 */
1918 		if (xa_is_value(page))
1919 			goto export;
1920 
1921 		if (!page_cache_get_speculative(page))
1922 			goto retry;
1923 
1924 		/* Has the page moved or been split? */
1925 		if (unlikely(page != xas_reload(&xas)))
1926 			goto put_page;
1927 
1928 		/*
1929 		 * Terminate early on finding a THP, to allow the caller to
1930 		 * handle it all at once; but continue if this is hugetlbfs.
1931 		 */
1932 		if (PageTransHuge(page) && !PageHuge(page)) {
1933 			page = find_subpage(page, xas.xa_index);
1934 			nr_entries = ret + 1;
1935 		}
1936 export:
1937 		indices[ret] = xas.xa_index;
1938 		entries[ret] = page;
1939 		if (++ret == nr_entries)
1940 			break;
1941 		continue;
1942 put_page:
1943 		put_page(page);
1944 retry:
1945 		xas_reset(&xas);
1946 	}
1947 	rcu_read_unlock();
1948 	return ret;
1949 }
1950 
1951 /**
1952  * find_get_pages_range - gang pagecache lookup
1953  * @mapping:	The address_space to search
1954  * @start:	The starting page index
1955  * @end:	The final page index (inclusive)
1956  * @nr_pages:	The maximum number of pages
1957  * @pages:	Where the resulting pages are placed
1958  *
1959  * find_get_pages_range() will search for and return a group of up to @nr_pages
1960  * pages in the mapping starting at index @start and up to index @end
1961  * (inclusive).  The pages are placed at @pages.  find_get_pages_range() takes
1962  * a reference against the returned pages.
1963  *
1964  * The search returns a group of mapping-contiguous pages with ascending
1965  * indexes.  There may be holes in the indices due to not-present pages.
1966  * We also update @start to index the next page for the traversal.
1967  *
1968  * Return: the number of pages which were found. If this number is
1969  * smaller than @nr_pages, the end of specified range has been
1970  * reached.
1971  */
find_get_pages_range(struct address_space *mapping, pgoff_t *start, pgoff_t end, unsigned int nr_pages, struct page **pages)1972 unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1973 			      pgoff_t end, unsigned int nr_pages,
1974 			      struct page **pages)
1975 {
1976 	XA_STATE(xas, &mapping->i_pages, *start);
1977 	struct page *page;
1978 	unsigned ret = 0;
1979 
1980 	if (unlikely(!nr_pages))
1981 		return 0;
1982 
1983 	rcu_read_lock();
1984 	xas_for_each(&xas, page, end) {
1985 		if (xas_retry(&xas, page))
1986 			continue;
1987 		/* Skip over shadow, swap and DAX entries */
1988 		if (xa_is_value(page))
1989 			continue;
1990 
1991 		if (!page_cache_get_speculative(page))
1992 			goto retry;
1993 
1994 		/* Has the page moved or been split? */
1995 		if (unlikely(page != xas_reload(&xas)))
1996 			goto put_page;
1997 
1998 		pages[ret] = find_subpage(page, xas.xa_index);
1999 		if (++ret == nr_pages) {
2000 			*start = xas.xa_index + 1;
2001 			goto out;
2002 		}
2003 		continue;
2004 put_page:
2005 		put_page(page);
2006 retry:
2007 		xas_reset(&xas);
2008 	}
2009 
2010 	/*
2011 	 * We come here when there is no page beyond @end. We take care to not
2012 	 * overflow the index @start as it confuses some of the callers. This
2013 	 * breaks the iteration when there is a page at index -1 but that is
2014 	 * already broken anyway.
2015 	 */
2016 	if (end == (pgoff_t)-1)
2017 		*start = (pgoff_t)-1;
2018 	else
2019 		*start = end + 1;
2020 out:
2021 	rcu_read_unlock();
2022 
2023 	return ret;
2024 }
2025 
2026 /**
2027  * find_get_pages_contig - gang contiguous pagecache lookup
2028  * @mapping:	The address_space to search
2029  * @index:	The starting page index
2030  * @nr_pages:	The maximum number of pages
2031  * @pages:	Where the resulting pages are placed
2032  *
2033  * find_get_pages_contig() works exactly like find_get_pages(), except
2034  * that the returned number of pages are guaranteed to be contiguous.
2035  *
2036  * Return: the number of pages which were found.
2037  */
find_get_pages_contig(struct address_space *mapping, pgoff_t index, unsigned int nr_pages, struct page **pages)2038 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2039 			       unsigned int nr_pages, struct page **pages)
2040 {
2041 	XA_STATE(xas, &mapping->i_pages, index);
2042 	struct page *page;
2043 	unsigned int ret = 0;
2044 
2045 	if (unlikely(!nr_pages))
2046 		return 0;
2047 
2048 	rcu_read_lock();
2049 	for (page = xas_load(&xas); page; page = xas_next(&xas)) {
2050 		if (xas_retry(&xas, page))
2051 			continue;
2052 		/*
2053 		 * If the entry has been swapped out, we can stop looking.
2054 		 * No current caller is looking for DAX entries.
2055 		 */
2056 		if (xa_is_value(page))
2057 			break;
2058 
2059 		if (!page_cache_get_speculative(page))
2060 			goto retry;
2061 
2062 		/* Has the page moved or been split? */
2063 		if (unlikely(page != xas_reload(&xas)))
2064 			goto put_page;
2065 
2066 		pages[ret] = find_subpage(page, xas.xa_index);
2067 		if (++ret == nr_pages)
2068 			break;
2069 		continue;
2070 put_page:
2071 		put_page(page);
2072 retry:
2073 		xas_reset(&xas);
2074 	}
2075 	rcu_read_unlock();
2076 	return ret;
2077 }
2078 EXPORT_SYMBOL(find_get_pages_contig);
2079 
2080 /**
2081  * find_get_pages_range_tag - find and return pages in given range matching @tag
2082  * @mapping:	the address_space to search
2083  * @index:	the starting page index
2084  * @end:	The final page index (inclusive)
2085  * @tag:	the tag index
2086  * @nr_pages:	the maximum number of pages
2087  * @pages:	where the resulting pages are placed
2088  *
2089  * Like find_get_pages, except we only return pages which are tagged with
2090  * @tag.   We update @index to index the next page for the traversal.
2091  *
2092  * Return: the number of pages which were found.
2093  */
find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index, pgoff_t end, xa_mark_t tag, unsigned int nr_pages, struct page **pages)2094 unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
2095 			pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
2096 			struct page **pages)
2097 {
2098 	XA_STATE(xas, &mapping->i_pages, *index);
2099 	struct page *page;
2100 	unsigned ret = 0;
2101 
2102 	if (unlikely(!nr_pages))
2103 		return 0;
2104 
2105 	rcu_read_lock();
2106 	xas_for_each_marked(&xas, page, end, tag) {
2107 		if (xas_retry(&xas, page))
2108 			continue;
2109 		/*
2110 		 * Shadow entries should never be tagged, but this iteration
2111 		 * is lockless so there is a window for page reclaim to evict
2112 		 * a page we saw tagged.  Skip over it.
2113 		 */
2114 		if (xa_is_value(page))
2115 			continue;
2116 
2117 		if (!page_cache_get_speculative(page))
2118 			goto retry;
2119 
2120 		/* Has the page moved or been split? */
2121 		if (unlikely(page != xas_reload(&xas)))
2122 			goto put_page;
2123 
2124 		pages[ret] = find_subpage(page, xas.xa_index);
2125 		if (++ret == nr_pages) {
2126 			*index = xas.xa_index + 1;
2127 			goto out;
2128 		}
2129 		continue;
2130 put_page:
2131 		put_page(page);
2132 retry:
2133 		xas_reset(&xas);
2134 	}
2135 
2136 	/*
2137 	 * We come here when we got to @end. We take care to not overflow the
2138 	 * index @index as it confuses some of the callers. This breaks the
2139 	 * iteration when there is a page at index -1 but that is already
2140 	 * broken anyway.
2141 	 */
2142 	if (end == (pgoff_t)-1)
2143 		*index = (pgoff_t)-1;
2144 	else
2145 		*index = end + 1;
2146 out:
2147 	rcu_read_unlock();
2148 
2149 	return ret;
2150 }
2151 EXPORT_SYMBOL(find_get_pages_range_tag);
2152 
2153 /*
2154  * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2155  * a _large_ part of the i/o request. Imagine the worst scenario:
2156  *
2157  *      ---R__________________________________________B__________
2158  *         ^ reading here                             ^ bad block(assume 4k)
2159  *
2160  * read(R) => miss => readahead(R...B) => media error => frustrating retries
2161  * => failing the whole request => read(R) => read(R+1) =>
2162  * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2163  * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2164  * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2165  *
2166  * It is going insane. Fix it by quickly scaling down the readahead size.
2167  */
shrink_readahead_size_eio(struct file_ra_state *ra)2168 static void shrink_readahead_size_eio(struct file_ra_state *ra)
2169 {
2170 	ra->ra_pages /= 4;
2171 }
2172 
2173 /**
2174  * generic_file_buffered_read - generic file read routine
2175  * @iocb:	the iocb to read
2176  * @iter:	data destination
2177  * @written:	already copied
2178  *
2179  * This is a generic file read routine, and uses the
2180  * mapping->a_ops->readpage() function for the actual low-level stuff.
2181  *
2182  * This is really ugly. But the goto's actually try to clarify some
2183  * of the logic when it comes to error handling etc.
2184  *
2185  * Return:
2186  * * total number of bytes copied, including those the were already @written
2187  * * negative error code if nothing was copied
2188  */
generic_file_buffered_read(struct kiocb *iocb, struct iov_iter *iter, ssize_t written)2189 ssize_t generic_file_buffered_read(struct kiocb *iocb,
2190 		struct iov_iter *iter, ssize_t written)
2191 {
2192 	struct file *filp = iocb->ki_filp;
2193 	struct address_space *mapping = filp->f_mapping;
2194 	struct inode *inode = mapping->host;
2195 	struct file_ra_state *ra = &filp->f_ra;
2196 	loff_t *ppos = &iocb->ki_pos;
2197 	pgoff_t index;
2198 	pgoff_t last_index;
2199 	pgoff_t prev_index;
2200 	unsigned long offset;      /* offset into pagecache page */
2201 	unsigned int prev_offset;
2202 	int error = 0;
2203 
2204 	if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
2205 		return 0;
2206 	if (unlikely(!iov_iter_count(iter)))
2207 		return 0;
2208 
2209 	iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2210 
2211 	index = *ppos >> PAGE_SHIFT;
2212 	prev_index = ra->prev_pos >> PAGE_SHIFT;
2213 	prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2214 	last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2215 	offset = *ppos & ~PAGE_MASK;
2216 
2217 	/*
2218 	 * If we've already successfully copied some data, then we
2219 	 * can no longer safely return -EIOCBQUEUED. Hence mark
2220 	 * an async read NOWAIT at that point.
2221 	 */
2222 	if (written && (iocb->ki_flags & IOCB_WAITQ))
2223 		iocb->ki_flags |= IOCB_NOWAIT;
2224 
2225 	for (;;) {
2226 		struct page *page;
2227 		pgoff_t end_index;
2228 		loff_t isize;
2229 		unsigned long nr, ret;
2230 
2231 		cond_resched();
2232 find_page:
2233 		if (fatal_signal_pending(current)) {
2234 			error = -EINTR;
2235 			goto out;
2236 		}
2237 
2238 		page = find_get_page(mapping, index);
2239 		if (!page) {
2240 			if (iocb->ki_flags & IOCB_NOIO)
2241 				goto would_block;
2242 			page_cache_sync_readahead(mapping,
2243 					ra, filp,
2244 					index, last_index - index);
2245 			page = find_get_page(mapping, index);
2246 			if (unlikely(page == NULL))
2247 				goto no_cached_page;
2248 		}
2249 		if (PageReadahead(page)) {
2250 			if (iocb->ki_flags & IOCB_NOIO) {
2251 				put_page(page);
2252 				goto out;
2253 			}
2254 			page_cache_async_readahead(mapping,
2255 					ra, filp, page,
2256 					index, last_index - index);
2257 		}
2258 		if (!PageUptodate(page)) {
2259 			/*
2260 			 * See comment in do_read_cache_page on why
2261 			 * wait_on_page_locked is used to avoid unnecessarily
2262 			 * serialisations and why it's safe.
2263 			 */
2264 			if (iocb->ki_flags & IOCB_WAITQ) {
2265 				if (written) {
2266 					put_page(page);
2267 					goto out;
2268 				}
2269 				error = wait_on_page_locked_async(page,
2270 								iocb->ki_waitq);
2271 			} else {
2272 				if (iocb->ki_flags & IOCB_NOWAIT) {
2273 					put_page(page);
2274 					goto would_block;
2275 				}
2276 				error = wait_on_page_locked_killable(page);
2277 			}
2278 			if (unlikely(error))
2279 				goto readpage_error;
2280 			if (PageUptodate(page))
2281 				goto page_ok;
2282 
2283 			if (inode->i_blkbits == PAGE_SHIFT ||
2284 					!mapping->a_ops->is_partially_uptodate)
2285 				goto page_not_up_to_date;
2286 			/* pipes can't handle partially uptodate pages */
2287 			if (unlikely(iov_iter_is_pipe(iter)))
2288 				goto page_not_up_to_date;
2289 			if (!trylock_page(page))
2290 				goto page_not_up_to_date;
2291 			/* Did it get truncated before we got the lock? */
2292 			if (!page->mapping)
2293 				goto page_not_up_to_date_locked;
2294 			if (!mapping->a_ops->is_partially_uptodate(page,
2295 							offset, iter->count))
2296 				goto page_not_up_to_date_locked;
2297 			unlock_page(page);
2298 		}
2299 page_ok:
2300 		/*
2301 		 * i_size must be checked after we know the page is Uptodate.
2302 		 *
2303 		 * Checking i_size after the check allows us to calculate
2304 		 * the correct value for "nr", which means the zero-filled
2305 		 * part of the page is not copied back to userspace (unless
2306 		 * another truncate extends the file - this is desired though).
2307 		 */
2308 
2309 		isize = i_size_read(inode);
2310 		end_index = (isize - 1) >> PAGE_SHIFT;
2311 		if (unlikely(!isize || index > end_index)) {
2312 			put_page(page);
2313 			goto out;
2314 		}
2315 
2316 		/* nr is the maximum number of bytes to copy from this page */
2317 		nr = PAGE_SIZE;
2318 		if (index == end_index) {
2319 			nr = ((isize - 1) & ~PAGE_MASK) + 1;
2320 			if (nr <= offset) {
2321 				put_page(page);
2322 				goto out;
2323 			}
2324 		}
2325 		nr = nr - offset;
2326 
2327 		/* If users can be writing to this page using arbitrary
2328 		 * virtual addresses, take care about potential aliasing
2329 		 * before reading the page on the kernel side.
2330 		 */
2331 		if (mapping_writably_mapped(mapping))
2332 			flush_dcache_page(page);
2333 
2334 		/*
2335 		 * When a sequential read accesses a page several times,
2336 		 * only mark it as accessed the first time.
2337 		 */
2338 		if (prev_index != index || offset != prev_offset)
2339 			mark_page_accessed(page);
2340 		prev_index = index;
2341 
2342 		/*
2343 		 * Ok, we have the page, and it's up-to-date, so
2344 		 * now we can copy it to user space...
2345 		 */
2346 
2347 		ret = copy_page_to_iter(page, offset, nr, iter);
2348 		offset += ret;
2349 		index += offset >> PAGE_SHIFT;
2350 		offset &= ~PAGE_MASK;
2351 		prev_offset = offset;
2352 
2353 		put_page(page);
2354 		written += ret;
2355 		if (!iov_iter_count(iter))
2356 			goto out;
2357 		if (ret < nr) {
2358 			error = -EFAULT;
2359 			goto out;
2360 		}
2361 		continue;
2362 
2363 page_not_up_to_date:
2364 		/* Get exclusive access to the page ... */
2365 		if (iocb->ki_flags & IOCB_WAITQ) {
2366 			if (written) {
2367 				put_page(page);
2368 				goto out;
2369 			}
2370 			error = lock_page_async(page, iocb->ki_waitq);
2371 		} else {
2372 			error = lock_page_killable(page);
2373 		}
2374 		if (unlikely(error))
2375 			goto readpage_error;
2376 
2377 page_not_up_to_date_locked:
2378 		/* Did it get truncated before we got the lock? */
2379 		if (!page->mapping) {
2380 			unlock_page(page);
2381 			put_page(page);
2382 			continue;
2383 		}
2384 
2385 		/* Did somebody else fill it already? */
2386 		if (PageUptodate(page)) {
2387 			unlock_page(page);
2388 			goto page_ok;
2389 		}
2390 
2391 readpage:
2392 		if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
2393 			unlock_page(page);
2394 			put_page(page);
2395 			goto would_block;
2396 		}
2397 		/*
2398 		 * A previous I/O error may have been due to temporary
2399 		 * failures, eg. multipath errors.
2400 		 * PG_error will be set again if readpage fails.
2401 		 */
2402 		ClearPageError(page);
2403 		/* Start the actual read. The read will unlock the page. */
2404 		error = mapping->a_ops->readpage(filp, page);
2405 
2406 		if (unlikely(error)) {
2407 			if (error == AOP_TRUNCATED_PAGE) {
2408 				put_page(page);
2409 				error = 0;
2410 				goto find_page;
2411 			}
2412 			goto readpage_error;
2413 		}
2414 
2415 		if (!PageUptodate(page)) {
2416 			if (iocb->ki_flags & IOCB_WAITQ) {
2417 				if (written) {
2418 					put_page(page);
2419 					goto out;
2420 				}
2421 				error = lock_page_async(page, iocb->ki_waitq);
2422 			} else {
2423 				error = lock_page_killable(page);
2424 			}
2425 
2426 			if (unlikely(error))
2427 				goto readpage_error;
2428 			if (!PageUptodate(page)) {
2429 				if (page->mapping == NULL) {
2430 					/*
2431 					 * invalidate_mapping_pages got it
2432 					 */
2433 					unlock_page(page);
2434 					put_page(page);
2435 					goto find_page;
2436 				}
2437 				unlock_page(page);
2438 				shrink_readahead_size_eio(ra);
2439 				error = -EIO;
2440 				goto readpage_error;
2441 			}
2442 			unlock_page(page);
2443 		}
2444 
2445 		goto page_ok;
2446 
2447 readpage_error:
2448 		/* UHHUH! A synchronous read error occurred. Report it */
2449 		put_page(page);
2450 		goto out;
2451 
2452 no_cached_page:
2453 		/*
2454 		 * Ok, it wasn't cached, so we need to create a new
2455 		 * page..
2456 		 */
2457 		page = page_cache_alloc(mapping);
2458 		if (!page) {
2459 			error = -ENOMEM;
2460 			goto out;
2461 		}
2462 		error = add_to_page_cache_lru(page, mapping, index,
2463 				mapping_gfp_constraint(mapping, GFP_KERNEL));
2464 		if (error) {
2465 			put_page(page);
2466 			if (error == -EEXIST) {
2467 				error = 0;
2468 				goto find_page;
2469 			}
2470 			goto out;
2471 		}
2472 		goto readpage;
2473 	}
2474 
2475 would_block:
2476 	error = -EAGAIN;
2477 out:
2478 	ra->prev_pos = prev_index;
2479 	ra->prev_pos <<= PAGE_SHIFT;
2480 	ra->prev_pos |= prev_offset;
2481 
2482 	*ppos = ((loff_t)index << PAGE_SHIFT) + offset;
2483 	file_accessed(filp);
2484 	return written ? written : error;
2485 }
2486 EXPORT_SYMBOL_GPL(generic_file_buffered_read);
2487 
2488 /**
2489  * generic_file_read_iter - generic filesystem read routine
2490  * @iocb:	kernel I/O control block
2491  * @iter:	destination for the data read
2492  *
2493  * This is the "read_iter()" routine for all filesystems
2494  * that can use the page cache directly.
2495  *
2496  * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2497  * be returned when no data can be read without waiting for I/O requests
2498  * to complete; it doesn't prevent readahead.
2499  *
2500  * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2501  * requests shall be made for the read or for readahead.  When no data
2502  * can be read, -EAGAIN shall be returned.  When readahead would be
2503  * triggered, a partial, possibly empty read shall be returned.
2504  *
2505  * Return:
2506  * * number of bytes copied, even for partial reads
2507  * * negative error code (or 0 if IOCB_NOIO) if nothing was read
2508  */
2509 ssize_t
generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)2510 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
2511 {
2512 	size_t count = iov_iter_count(iter);
2513 	ssize_t retval = 0;
2514 
2515 	if (!count)
2516 		goto out; /* skip atime */
2517 
2518 	if (iocb->ki_flags & IOCB_DIRECT) {
2519 		struct file *file = iocb->ki_filp;
2520 		struct address_space *mapping = file->f_mapping;
2521 		struct inode *inode = mapping->host;
2522 		loff_t size;
2523 
2524 		size = i_size_read(inode);
2525 		if (iocb->ki_flags & IOCB_NOWAIT) {
2526 			if (filemap_range_has_page(mapping, iocb->ki_pos,
2527 						   iocb->ki_pos + count - 1))
2528 				return -EAGAIN;
2529 		} else {
2530 			retval = filemap_write_and_wait_range(mapping,
2531 						iocb->ki_pos,
2532 					        iocb->ki_pos + count - 1);
2533 			if (retval < 0)
2534 				goto out;
2535 		}
2536 
2537 		file_accessed(file);
2538 
2539 		retval = mapping->a_ops->direct_IO(iocb, iter);
2540 		if (retval >= 0) {
2541 			iocb->ki_pos += retval;
2542 			count -= retval;
2543 		}
2544 		iov_iter_revert(iter, count - iov_iter_count(iter));
2545 
2546 		/*
2547 		 * Btrfs can have a short DIO read if we encounter
2548 		 * compressed extents, so if there was an error, or if
2549 		 * we've already read everything we wanted to, or if
2550 		 * there was a short read because we hit EOF, go ahead
2551 		 * and return.  Otherwise fallthrough to buffered io for
2552 		 * the rest of the read.  Buffered reads will not work for
2553 		 * DAX files, so don't bother trying.
2554 		 */
2555 		if (retval < 0 || !count || iocb->ki_pos >= size ||
2556 		    IS_DAX(inode))
2557 			goto out;
2558 	}
2559 
2560 	retval = generic_file_buffered_read(iocb, iter, retval);
2561 out:
2562 	return retval;
2563 }
2564 EXPORT_SYMBOL(generic_file_read_iter);
2565 
2566 #ifdef CONFIG_MMU
2567 #define MMAP_LOTSAMISS  (100)
2568 /*
2569  * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
2570  * @vmf - the vm_fault for this fault.
2571  * @page - the page to lock.
2572  * @fpin - the pointer to the file we may pin (or is already pinned).
2573  *
2574  * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
2575  * It differs in that it actually returns the page locked if it returns 1 and 0
2576  * if it couldn't lock the page.  If we did have to drop the mmap_lock then fpin
2577  * will point to the pinned file and needs to be fput()'ed at a later point.
2578  */
lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page, struct file **fpin)2579 static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2580 				     struct file **fpin)
2581 {
2582 	if (trylock_page(page))
2583 		return 1;
2584 
2585 	/*
2586 	 * NOTE! This will make us return with VM_FAULT_RETRY, but with
2587 	 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
2588 	 * is supposed to work. We have way too many special cases..
2589 	 */
2590 	if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2591 		return 0;
2592 
2593 	*fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2594 	if (vmf->flags & FAULT_FLAG_KILLABLE) {
2595 		if (__lock_page_killable(page)) {
2596 			/*
2597 			 * We didn't have the right flags to drop the mmap_lock,
2598 			 * but all fault_handlers only check for fatal signals
2599 			 * if we return VM_FAULT_RETRY, so we need to drop the
2600 			 * mmap_lock here and return 0 if we don't have a fpin.
2601 			 */
2602 			if (*fpin == NULL)
2603 				mmap_read_unlock(vmf->vma->vm_mm);
2604 			return 0;
2605 		}
2606 	} else
2607 		__lock_page(page);
2608 	return 1;
2609 }
2610 
2611 
2612 /*
2613  * Synchronous readahead happens when we don't even find a page in the page
2614  * cache at all.  We don't want to perform IO under the mmap sem, so if we have
2615  * to drop the mmap sem we return the file that was pinned in order for us to do
2616  * that.  If we didn't pin a file then we return NULL.  The file that is
2617  * returned needs to be fput()'ed when we're done with it.
2618  */
do_sync_mmap_readahead(struct vm_fault *vmf)2619 static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
2620 {
2621 	struct file *file = vmf->vma->vm_file;
2622 	struct file_ra_state *ra = &file->f_ra;
2623 	struct address_space *mapping = file->f_mapping;
2624 	DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
2625 	struct file *fpin = NULL;
2626 	unsigned int mmap_miss;
2627 
2628 	/* If we don't want any read-ahead, don't bother */
2629 	if (vmf->vma->vm_flags & VM_RAND_READ)
2630 		return fpin;
2631 	if (!ra->ra_pages)
2632 		return fpin;
2633 
2634 	if (vmf->vma->vm_flags & VM_SEQ_READ) {
2635 		fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2636 		page_cache_sync_ra(&ractl, ra, ra->ra_pages);
2637 		return fpin;
2638 	}
2639 
2640 	/* Avoid banging the cache line if not needed */
2641 	mmap_miss = READ_ONCE(ra->mmap_miss);
2642 	if (mmap_miss < MMAP_LOTSAMISS * 10)
2643 		WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
2644 
2645 	/*
2646 	 * Do we miss much more than hit in this file? If so,
2647 	 * stop bothering with read-ahead. It will only hurt.
2648 	 */
2649 	if (mmap_miss > MMAP_LOTSAMISS)
2650 		return fpin;
2651 
2652 	/*
2653 	 * mmap read-around
2654 	 */
2655 	fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2656 	ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
2657 	ra->size = ra->ra_pages;
2658 	ra->async_size = ra->ra_pages / 4;
2659 	ractl._index = ra->start;
2660 	do_page_cache_ra(&ractl, ra->size, ra->async_size);
2661 	return fpin;
2662 }
2663 
2664 /*
2665  * Asynchronous readahead happens when we find the page and PG_readahead,
2666  * so we want to possibly extend the readahead further.  We return the file that
2667  * was pinned if we have to drop the mmap_lock in order to do IO.
2668  */
do_async_mmap_readahead(struct vm_fault *vmf, struct page *page)2669 static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2670 					    struct page *page)
2671 {
2672 	struct file *file = vmf->vma->vm_file;
2673 	struct file_ra_state *ra = &file->f_ra;
2674 	struct address_space *mapping = file->f_mapping;
2675 	struct file *fpin = NULL;
2676 	unsigned int mmap_miss;
2677 	pgoff_t offset = vmf->pgoff;
2678 
2679 	/* If we don't want any read-ahead, don't bother */
2680 	if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
2681 		return fpin;
2682 	mmap_miss = READ_ONCE(ra->mmap_miss);
2683 	if (mmap_miss)
2684 		WRITE_ONCE(ra->mmap_miss, --mmap_miss);
2685 	if (PageReadahead(page)) {
2686 		fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2687 		page_cache_async_readahead(mapping, ra, file,
2688 					   page, offset, ra->ra_pages);
2689 	}
2690 	return fpin;
2691 }
2692 
2693 /**
2694  * filemap_fault - read in file data for page fault handling
2695  * @vmf:	struct vm_fault containing details of the fault
2696  *
2697  * filemap_fault() is invoked via the vma operations vector for a
2698  * mapped memory region to read in file data during a page fault.
2699  *
2700  * The goto's are kind of ugly, but this streamlines the normal case of having
2701  * it in the page cache, and handles the special cases reasonably without
2702  * having a lot of duplicated code.
2703  *
2704  * vma->vm_mm->mmap_lock must be held on entry.
2705  *
2706  * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
2707  * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
2708  *
2709  * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
2710  * has not been released.
2711  *
2712  * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
2713  *
2714  * Return: bitwise-OR of %VM_FAULT_ codes.
2715  */
filemap_fault(struct vm_fault *vmf)2716 vm_fault_t filemap_fault(struct vm_fault *vmf)
2717 {
2718 	int error;
2719 	struct file *file = vmf->vma->vm_file;
2720 	struct file *fpin = NULL;
2721 	struct address_space *mapping = file->f_mapping;
2722 	struct file_ra_state *ra = &file->f_ra;
2723 	struct inode *inode = mapping->host;
2724 	pgoff_t offset = vmf->pgoff;
2725 	pgoff_t max_off;
2726 	struct page *page;
2727 	vm_fault_t ret = 0;
2728 
2729 	max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2730 	if (unlikely(offset >= max_off))
2731 		return VM_FAULT_SIGBUS;
2732 
2733 	/*
2734 	 * Do we have something in the page cache already?
2735 	 */
2736 	page = find_get_page(mapping, offset);
2737 	if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
2738 		/*
2739 		 * We found the page, so try async readahead before
2740 		 * waiting for the lock.
2741 		 */
2742 		fpin = do_async_mmap_readahead(vmf, page);
2743 	} else if (!page) {
2744 		/* No page in the page cache at all */
2745 		count_vm_event(PGMAJFAULT);
2746 		count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
2747 		ret = VM_FAULT_MAJOR;
2748 		fpin = do_sync_mmap_readahead(vmf);
2749 retry_find:
2750 		page = pagecache_get_page(mapping, offset,
2751 					  FGP_CREAT|FGP_FOR_MMAP,
2752 					  vmf->gfp_mask);
2753 		if (!page) {
2754 			if (fpin)
2755 				goto out_retry;
2756 			return VM_FAULT_OOM;
2757 		}
2758 	}
2759 
2760 	if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2761 		goto out_retry;
2762 
2763 	/* Did it get truncated? */
2764 	if (unlikely(compound_head(page)->mapping != mapping)) {
2765 		unlock_page(page);
2766 		put_page(page);
2767 		goto retry_find;
2768 	}
2769 	VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
2770 
2771 	/*
2772 	 * We have a locked page in the page cache, now we need to check
2773 	 * that it's up-to-date. If not, it is going to be due to an error.
2774 	 */
2775 	if (unlikely(!PageUptodate(page)))
2776 		goto page_not_uptodate;
2777 
2778 	/*
2779 	 * We've made it this far and we had to drop our mmap_lock, now is the
2780 	 * time to return to the upper layer and have it re-find the vma and
2781 	 * redo the fault.
2782 	 */
2783 	if (fpin) {
2784 		unlock_page(page);
2785 		goto out_retry;
2786 	}
2787 
2788 	/*
2789 	 * Found the page and have a reference on it.
2790 	 * We must recheck i_size under page lock.
2791 	 */
2792 	max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2793 	if (unlikely(offset >= max_off)) {
2794 		unlock_page(page);
2795 		put_page(page);
2796 		return VM_FAULT_SIGBUS;
2797 	}
2798 
2799 	vmf->page = page;
2800 	return ret | VM_FAULT_LOCKED;
2801 
2802 page_not_uptodate:
2803 	/*
2804 	 * Umm, take care of errors if the page isn't up-to-date.
2805 	 * Try to re-read it _once_. We do this synchronously,
2806 	 * because there really aren't any performance issues here
2807 	 * and we need to check for errors.
2808 	 */
2809 	ClearPageError(page);
2810 	fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2811 	error = mapping->a_ops->readpage(file, page);
2812 	if (!error) {
2813 		wait_on_page_locked(page);
2814 		if (!PageUptodate(page))
2815 			error = -EIO;
2816 	}
2817 	if (fpin)
2818 		goto out_retry;
2819 	put_page(page);
2820 
2821 	if (!error || error == AOP_TRUNCATED_PAGE)
2822 		goto retry_find;
2823 
2824 	shrink_readahead_size_eio(ra);
2825 	return VM_FAULT_SIGBUS;
2826 
2827 out_retry:
2828 	/*
2829 	 * We dropped the mmap_lock, we need to return to the fault handler to
2830 	 * re-find the vma and come back and find our hopefully still populated
2831 	 * page.
2832 	 */
2833 	if (page)
2834 		put_page(page);
2835 	if (fpin)
2836 		fput(fpin);
2837 	return ret | VM_FAULT_RETRY;
2838 }
2839 EXPORT_SYMBOL(filemap_fault);
2840 
filemap_map_pages(struct vm_fault *vmf, pgoff_t start_pgoff, pgoff_t end_pgoff)2841 void filemap_map_pages(struct vm_fault *vmf,
2842 		pgoff_t start_pgoff, pgoff_t end_pgoff)
2843 {
2844 	struct file *file = vmf->vma->vm_file;
2845 	struct address_space *mapping = file->f_mapping;
2846 	pgoff_t last_pgoff = start_pgoff;
2847 	unsigned long max_idx;
2848 	XA_STATE(xas, &mapping->i_pages, start_pgoff);
2849 	struct page *head, *page;
2850 	unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
2851 
2852 	rcu_read_lock();
2853 	xas_for_each(&xas, head, end_pgoff) {
2854 		if (xas_retry(&xas, head))
2855 			continue;
2856 		if (xa_is_value(head))
2857 			goto next;
2858 
2859 		/*
2860 		 * Check for a locked page first, as a speculative
2861 		 * reference may adversely influence page migration.
2862 		 */
2863 		if (PageLocked(head))
2864 			goto next;
2865 		if (!page_cache_get_speculative(head))
2866 			goto next;
2867 
2868 		/* Has the page moved or been split? */
2869 		if (unlikely(head != xas_reload(&xas)))
2870 			goto skip;
2871 		page = find_subpage(head, xas.xa_index);
2872 
2873 		if (!PageUptodate(head) ||
2874 				PageReadahead(page) ||
2875 				PageHWPoison(page))
2876 			goto skip;
2877 		if (!trylock_page(head))
2878 			goto skip;
2879 
2880 		if (head->mapping != mapping || !PageUptodate(head))
2881 			goto unlock;
2882 
2883 		max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2884 		if (xas.xa_index >= max_idx)
2885 			goto unlock;
2886 
2887 		if (mmap_miss > 0)
2888 			mmap_miss--;
2889 
2890 		vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
2891 		if (vmf->pte)
2892 			vmf->pte += xas.xa_index - last_pgoff;
2893 		last_pgoff = xas.xa_index;
2894 		if (alloc_set_pte(vmf, page))
2895 			goto unlock;
2896 		unlock_page(head);
2897 		goto next;
2898 unlock:
2899 		unlock_page(head);
2900 skip:
2901 		put_page(head);
2902 next:
2903 		/* Huge page is mapped? No need to proceed. */
2904 		if (pmd_trans_huge(*vmf->pmd))
2905 			break;
2906 	}
2907 	rcu_read_unlock();
2908 	WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
2909 }
2910 EXPORT_SYMBOL(filemap_map_pages);
2911 
filemap_page_mkwrite(struct vm_fault *vmf)2912 vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
2913 {
2914 	struct page *page = vmf->page;
2915 	struct inode *inode = file_inode(vmf->vma->vm_file);
2916 	vm_fault_t ret = VM_FAULT_LOCKED;
2917 
2918 	sb_start_pagefault(inode->i_sb);
2919 	file_update_time(vmf->vma->vm_file);
2920 	lock_page(page);
2921 	if (page->mapping != inode->i_mapping) {
2922 		unlock_page(page);
2923 		ret = VM_FAULT_NOPAGE;
2924 		goto out;
2925 	}
2926 	/*
2927 	 * We mark the page dirty already here so that when freeze is in
2928 	 * progress, we are guaranteed that writeback during freezing will
2929 	 * see the dirty page and writeprotect it again.
2930 	 */
2931 	set_page_dirty(page);
2932 	wait_for_stable_page(page);
2933 out:
2934 	sb_end_pagefault(inode->i_sb);
2935 	return ret;
2936 }
2937 
2938 const struct vm_operations_struct generic_file_vm_ops = {
2939 	.fault		= filemap_fault,
2940 	.map_pages	= filemap_map_pages,
2941 	.page_mkwrite	= filemap_page_mkwrite,
2942 };
2943 
2944 /* This is used for a general mmap of a disk file */
2945 
generic_file_mmap(struct file * file, struct vm_area_struct * vma)2946 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2947 {
2948 	struct address_space *mapping = file->f_mapping;
2949 
2950 	if (!mapping->a_ops->readpage)
2951 		return -ENOEXEC;
2952 	file_accessed(file);
2953 	vma->vm_ops = &generic_file_vm_ops;
2954 	return 0;
2955 }
2956 
2957 /*
2958  * This is for filesystems which do not implement ->writepage.
2959  */
generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)2960 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2961 {
2962 	if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2963 		return -EINVAL;
2964 	return generic_file_mmap(file, vma);
2965 }
2966 #else
filemap_page_mkwrite(struct vm_fault *vmf)2967 vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
2968 {
2969 	return VM_FAULT_SIGBUS;
2970 }
generic_file_mmap(struct file * file, struct vm_area_struct * vma)2971 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2972 {
2973 	return -ENOSYS;
2974 }
generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)2975 int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2976 {
2977 	return -ENOSYS;
2978 }
2979 #endif /* CONFIG_MMU */
2980 
2981 EXPORT_SYMBOL(filemap_page_mkwrite);
2982 EXPORT_SYMBOL(generic_file_mmap);
2983 EXPORT_SYMBOL(generic_file_readonly_mmap);
2984 
wait_on_page_read(struct page *page)2985 static struct page *wait_on_page_read(struct page *page)
2986 {
2987 	if (!IS_ERR(page)) {
2988 		wait_on_page_locked(page);
2989 		if (!PageUptodate(page)) {
2990 			put_page(page);
2991 			page = ERR_PTR(-EIO);
2992 		}
2993 	}
2994 	return page;
2995 }
2996 
do_read_cache_page(struct address_space *mapping, pgoff_t index, int (*filler)(void *, struct page *), void *data, gfp_t gfp)2997 static struct page *do_read_cache_page(struct address_space *mapping,
2998 				pgoff_t index,
2999 				int (*filler)(void *, struct page *),
3000 				void *data,
3001 				gfp_t gfp)
3002 {
3003 	struct page *page;
3004 	int err;
3005 repeat:
3006 	page = find_get_page(mapping, index);
3007 	if (!page) {
3008 		page = __page_cache_alloc(gfp);
3009 		if (!page)
3010 			return ERR_PTR(-ENOMEM);
3011 		err = add_to_page_cache_lru(page, mapping, index, gfp);
3012 		if (unlikely(err)) {
3013 			put_page(page);
3014 			if (err == -EEXIST)
3015 				goto repeat;
3016 			/* Presumably ENOMEM for xarray node */
3017 			return ERR_PTR(err);
3018 		}
3019 
3020 filler:
3021 		if (filler)
3022 			err = filler(data, page);
3023 		else
3024 			err = mapping->a_ops->readpage(data, page);
3025 
3026 		if (err < 0) {
3027 			put_page(page);
3028 			return ERR_PTR(err);
3029 		}
3030 
3031 		page = wait_on_page_read(page);
3032 		if (IS_ERR(page))
3033 			return page;
3034 		goto out;
3035 	}
3036 	if (PageUptodate(page))
3037 		goto out;
3038 
3039 	/*
3040 	 * Page is not up to date and may be locked due to one of the following
3041 	 * case a: Page is being filled and the page lock is held
3042 	 * case b: Read/write error clearing the page uptodate status
3043 	 * case c: Truncation in progress (page locked)
3044 	 * case d: Reclaim in progress
3045 	 *
3046 	 * Case a, the page will be up to date when the page is unlocked.
3047 	 *    There is no need to serialise on the page lock here as the page
3048 	 *    is pinned so the lock gives no additional protection. Even if the
3049 	 *    page is truncated, the data is still valid if PageUptodate as
3050 	 *    it's a race vs truncate race.
3051 	 * Case b, the page will not be up to date
3052 	 * Case c, the page may be truncated but in itself, the data may still
3053 	 *    be valid after IO completes as it's a read vs truncate race. The
3054 	 *    operation must restart if the page is not uptodate on unlock but
3055 	 *    otherwise serialising on page lock to stabilise the mapping gives
3056 	 *    no additional guarantees to the caller as the page lock is
3057 	 *    released before return.
3058 	 * Case d, similar to truncation. If reclaim holds the page lock, it
3059 	 *    will be a race with remove_mapping that determines if the mapping
3060 	 *    is valid on unlock but otherwise the data is valid and there is
3061 	 *    no need to serialise with page lock.
3062 	 *
3063 	 * As the page lock gives no additional guarantee, we optimistically
3064 	 * wait on the page to be unlocked and check if it's up to date and
3065 	 * use the page if it is. Otherwise, the page lock is required to
3066 	 * distinguish between the different cases. The motivation is that we
3067 	 * avoid spurious serialisations and wakeups when multiple processes
3068 	 * wait on the same page for IO to complete.
3069 	 */
3070 	wait_on_page_locked(page);
3071 	if (PageUptodate(page))
3072 		goto out;
3073 
3074 	/* Distinguish between all the cases under the safety of the lock */
3075 	lock_page(page);
3076 
3077 	/* Case c or d, restart the operation */
3078 	if (!page->mapping) {
3079 		unlock_page(page);
3080 		put_page(page);
3081 		goto repeat;
3082 	}
3083 
3084 	/* Someone else locked and filled the page in a very small window */
3085 	if (PageUptodate(page)) {
3086 		unlock_page(page);
3087 		goto out;
3088 	}
3089 
3090 	/*
3091 	 * A previous I/O error may have been due to temporary
3092 	 * failures.
3093 	 * Clear page error before actual read, PG_error will be
3094 	 * set again if read page fails.
3095 	 */
3096 	ClearPageError(page);
3097 	goto filler;
3098 
3099 out:
3100 	mark_page_accessed(page);
3101 	return page;
3102 }
3103 
3104 /**
3105  * read_cache_page - read into page cache, fill it if needed
3106  * @mapping:	the page's address_space
3107  * @index:	the page index
3108  * @filler:	function to perform the read
3109  * @data:	first arg to filler(data, page) function, often left as NULL
3110  *
3111  * Read into the page cache. If a page already exists, and PageUptodate() is
3112  * not set, try to fill the page and wait for it to become unlocked.
3113  *
3114  * If the page does not get brought uptodate, return -EIO.
3115  *
3116  * Return: up to date page on success, ERR_PTR() on failure.
3117  */
read_cache_page(struct address_space *mapping, pgoff_t index, int (*filler)(void *, struct page *), void *data)3118 struct page *read_cache_page(struct address_space *mapping,
3119 				pgoff_t index,
3120 				int (*filler)(void *, struct page *),
3121 				void *data)
3122 {
3123 	return do_read_cache_page(mapping, index, filler, data,
3124 			mapping_gfp_mask(mapping));
3125 }
3126 EXPORT_SYMBOL(read_cache_page);
3127 
3128 /**
3129  * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3130  * @mapping:	the page's address_space
3131  * @index:	the page index
3132  * @gfp:	the page allocator flags to use if allocating
3133  *
3134  * This is the same as "read_mapping_page(mapping, index, NULL)", but with
3135  * any new page allocations done using the specified allocation flags.
3136  *
3137  * If the page does not get brought uptodate, return -EIO.
3138  *
3139  * Return: up to date page on success, ERR_PTR() on failure.
3140  */
read_cache_page_gfp(struct address_space *mapping, pgoff_t index, gfp_t gfp)3141 struct page *read_cache_page_gfp(struct address_space *mapping,
3142 				pgoff_t index,
3143 				gfp_t gfp)
3144 {
3145 	return do_read_cache_page(mapping, index, NULL, NULL, gfp);
3146 }
3147 EXPORT_SYMBOL(read_cache_page_gfp);
3148 
pagecache_write_begin(struct file *file, struct address_space *mapping, loff_t pos, unsigned len, unsigned flags, struct page **pagep, void **fsdata)3149 int pagecache_write_begin(struct file *file, struct address_space *mapping,
3150 				loff_t pos, unsigned len, unsigned flags,
3151 				struct page **pagep, void **fsdata)
3152 {
3153 	const struct address_space_operations *aops = mapping->a_ops;
3154 
3155 	return aops->write_begin(file, mapping, pos, len, flags,
3156 							pagep, fsdata);
3157 }
3158 EXPORT_SYMBOL(pagecache_write_begin);
3159 
pagecache_write_end(struct file *file, struct address_space *mapping, loff_t pos, unsigned len, unsigned copied, struct page *page, void *fsdata)3160 int pagecache_write_end(struct file *file, struct address_space *mapping,
3161 				loff_t pos, unsigned len, unsigned copied,
3162 				struct page *page, void *fsdata)
3163 {
3164 	const struct address_space_operations *aops = mapping->a_ops;
3165 
3166 	return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
3167 }
3168 EXPORT_SYMBOL(pagecache_write_end);
3169 
3170 /*
3171  * Warn about a page cache invalidation failure during a direct I/O write.
3172  */
dio_warn_stale_pagecache(struct file *filp)3173 void dio_warn_stale_pagecache(struct file *filp)
3174 {
3175 	static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3176 	char pathname[128];
3177 	struct inode *inode = file_inode(filp);
3178 	char *path;
3179 
3180 	errseq_set(&inode->i_mapping->wb_err, -EIO);
3181 	if (__ratelimit(&_rs)) {
3182 		path = file_path(filp, pathname, sizeof(pathname));
3183 		if (IS_ERR(path))
3184 			path = "(unknown)";
3185 		pr_crit("Page cache invalidation failure on direct I/O.  Possible data corruption due to collision with buffered I/O!\n");
3186 		pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3187 			current->comm);
3188 	}
3189 }
3190 
3191 ssize_t
generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)3192 generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
3193 {
3194 	struct file	*file = iocb->ki_filp;
3195 	struct address_space *mapping = file->f_mapping;
3196 	struct inode	*inode = mapping->host;
3197 	loff_t		pos = iocb->ki_pos;
3198 	ssize_t		written;
3199 	size_t		write_len;
3200 	pgoff_t		end;
3201 
3202 	write_len = iov_iter_count(from);
3203 	end = (pos + write_len - 1) >> PAGE_SHIFT;
3204 
3205 	if (iocb->ki_flags & IOCB_NOWAIT) {
3206 		/* If there are pages to writeback, return */
3207 		if (filemap_range_has_page(inode->i_mapping, pos,
3208 					   pos + write_len - 1))
3209 			return -EAGAIN;
3210 	} else {
3211 		written = filemap_write_and_wait_range(mapping, pos,
3212 							pos + write_len - 1);
3213 		if (written)
3214 			goto out;
3215 	}
3216 
3217 	/*
3218 	 * After a write we want buffered reads to be sure to go to disk to get
3219 	 * the new data.  We invalidate clean cached page from the region we're
3220 	 * about to write.  We do this *before* the write so that we can return
3221 	 * without clobbering -EIOCBQUEUED from ->direct_IO().
3222 	 */
3223 	written = invalidate_inode_pages2_range(mapping,
3224 					pos >> PAGE_SHIFT, end);
3225 	/*
3226 	 * If a page can not be invalidated, return 0 to fall back
3227 	 * to buffered write.
3228 	 */
3229 	if (written) {
3230 		if (written == -EBUSY)
3231 			return 0;
3232 		goto out;
3233 	}
3234 
3235 	written = mapping->a_ops->direct_IO(iocb, from);
3236 
3237 	/*
3238 	 * Finally, try again to invalidate clean pages which might have been
3239 	 * cached by non-direct readahead, or faulted in by get_user_pages()
3240 	 * if the source of the write was an mmap'ed region of the file
3241 	 * we're writing.  Either one is a pretty crazy thing to do,
3242 	 * so we don't support it 100%.  If this invalidation
3243 	 * fails, tough, the write still worked...
3244 	 *
3245 	 * Most of the time we do not need this since dio_complete() will do
3246 	 * the invalidation for us. However there are some file systems that
3247 	 * do not end up with dio_complete() being called, so let's not break
3248 	 * them by removing it completely.
3249 	 *
3250 	 * Noticeable example is a blkdev_direct_IO().
3251 	 *
3252 	 * Skip invalidation for async writes or if mapping has no pages.
3253 	 */
3254 	if (written > 0 && mapping->nrpages &&
3255 	    invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3256 		dio_warn_stale_pagecache(file);
3257 
3258 	if (written > 0) {
3259 		pos += written;
3260 		write_len -= written;
3261 		if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3262 			i_size_write(inode, pos);
3263 			mark_inode_dirty(inode);
3264 		}
3265 		iocb->ki_pos = pos;
3266 	}
3267 	iov_iter_revert(from, write_len - iov_iter_count(from));
3268 out:
3269 	return written;
3270 }
3271 EXPORT_SYMBOL(generic_file_direct_write);
3272 
3273 /*
3274  * Find or create a page at the given pagecache position. Return the locked
3275  * page. This function is specifically for buffered writes.
3276  */
grab_cache_page_write_begin(struct address_space *mapping, pgoff_t index, unsigned flags)3277 struct page *grab_cache_page_write_begin(struct address_space *mapping,
3278 					pgoff_t index, unsigned flags)
3279 {
3280 	struct page *page;
3281 	int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
3282 
3283 	if (flags & AOP_FLAG_NOFS)
3284 		fgp_flags |= FGP_NOFS;
3285 
3286 	page = pagecache_get_page(mapping, index, fgp_flags,
3287 			mapping_gfp_mask(mapping));
3288 	if (page)
3289 		wait_for_stable_page(page);
3290 
3291 	return page;
3292 }
3293 EXPORT_SYMBOL(grab_cache_page_write_begin);
3294 
generic_perform_write(struct file *file, struct iov_iter *i, loff_t pos)3295 ssize_t generic_perform_write(struct file *file,
3296 				struct iov_iter *i, loff_t pos)
3297 {
3298 	struct address_space *mapping = file->f_mapping;
3299 	const struct address_space_operations *a_ops = mapping->a_ops;
3300 	long status = 0;
3301 	ssize_t written = 0;
3302 	unsigned int flags = 0;
3303 
3304 	do {
3305 		struct page *page;
3306 		unsigned long offset;	/* Offset into pagecache page */
3307 		unsigned long bytes;	/* Bytes to write to page */
3308 		size_t copied;		/* Bytes copied from user */
3309 		void *fsdata = NULL;
3310 
3311 		offset = (pos & (PAGE_SIZE - 1));
3312 		bytes = min_t(unsigned long, PAGE_SIZE - offset,
3313 						iov_iter_count(i));
3314 
3315 again:
3316 		/*
3317 		 * Bring in the user page that we will copy from _first_.
3318 		 * Otherwise there's a nasty deadlock on copying from the
3319 		 * same page as we're writing to, without it being marked
3320 		 * up-to-date.
3321 		 *
3322 		 * Not only is this an optimisation, but it is also required
3323 		 * to check that the address is actually valid, when atomic
3324 		 * usercopies are used, below.
3325 		 */
3326 		if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3327 			status = -EFAULT;
3328 			break;
3329 		}
3330 
3331 		if (fatal_signal_pending(current)) {
3332 			status = -EINTR;
3333 			break;
3334 		}
3335 
3336 		status = a_ops->write_begin(file, mapping, pos, bytes, flags,
3337 						&page, &fsdata);
3338 		if (unlikely(status < 0))
3339 			break;
3340 
3341 		if (mapping_writably_mapped(mapping))
3342 			flush_dcache_page(page);
3343 
3344 		copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
3345 		flush_dcache_page(page);
3346 
3347 		status = a_ops->write_end(file, mapping, pos, bytes, copied,
3348 						page, fsdata);
3349 		if (unlikely(status < 0))
3350 			break;
3351 		copied = status;
3352 
3353 		cond_resched();
3354 
3355 		iov_iter_advance(i, copied);
3356 		if (unlikely(copied == 0)) {
3357 			/*
3358 			 * If we were unable to copy any data at all, we must
3359 			 * fall back to a single segment length write.
3360 			 *
3361 			 * If we didn't fallback here, we could livelock
3362 			 * because not all segments in the iov can be copied at
3363 			 * once without a pagefault.
3364 			 */
3365 			bytes = min_t(unsigned long, PAGE_SIZE - offset,
3366 						iov_iter_single_seg_count(i));
3367 			goto again;
3368 		}
3369 		pos += copied;
3370 		written += copied;
3371 
3372 		balance_dirty_pages_ratelimited(mapping);
3373 	} while (iov_iter_count(i));
3374 
3375 	return written ? written : status;
3376 }
3377 EXPORT_SYMBOL(generic_perform_write);
3378 
3379 /**
3380  * __generic_file_write_iter - write data to a file
3381  * @iocb:	IO state structure (file, offset, etc.)
3382  * @from:	iov_iter with data to write
3383  *
3384  * This function does all the work needed for actually writing data to a
3385  * file. It does all basic checks, removes SUID from the file, updates
3386  * modification times and calls proper subroutines depending on whether we
3387  * do direct IO or a standard buffered write.
3388  *
3389  * It expects i_mutex to be grabbed unless we work on a block device or similar
3390  * object which does not need locking at all.
3391  *
3392  * This function does *not* take care of syncing data in case of O_SYNC write.
3393  * A caller has to handle it. This is mainly due to the fact that we want to
3394  * avoid syncing under i_mutex.
3395  *
3396  * Return:
3397  * * number of bytes written, even for truncated writes
3398  * * negative error code if no data has been written at all
3399  */
__generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)3400 ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3401 {
3402 	struct file *file = iocb->ki_filp;
3403 	struct address_space * mapping = file->f_mapping;
3404 	struct inode 	*inode = mapping->host;
3405 	ssize_t		written = 0;
3406 	ssize_t		err;
3407 	ssize_t		status;
3408 
3409 	/* We can write back this queue in page reclaim */
3410 	current->backing_dev_info = inode_to_bdi(inode);
3411 	err = file_remove_privs(file);
3412 	if (err)
3413 		goto out;
3414 
3415 	err = file_update_time(file);
3416 	if (err)
3417 		goto out;
3418 
3419 	if (iocb->ki_flags & IOCB_DIRECT) {
3420 		loff_t pos, endbyte;
3421 
3422 		written = generic_file_direct_write(iocb, from);
3423 		/*
3424 		 * If the write stopped short of completing, fall back to
3425 		 * buffered writes.  Some filesystems do this for writes to
3426 		 * holes, for example.  For DAX files, a buffered write will
3427 		 * not succeed (even if it did, DAX does not handle dirty
3428 		 * page-cache pages correctly).
3429 		 */
3430 		if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
3431 			goto out;
3432 
3433 		status = generic_perform_write(file, from, pos = iocb->ki_pos);
3434 		/*
3435 		 * If generic_perform_write() returned a synchronous error
3436 		 * then we want to return the number of bytes which were
3437 		 * direct-written, or the error code if that was zero.  Note
3438 		 * that this differs from normal direct-io semantics, which
3439 		 * will return -EFOO even if some bytes were written.
3440 		 */
3441 		if (unlikely(status < 0)) {
3442 			err = status;
3443 			goto out;
3444 		}
3445 		/*
3446 		 * We need to ensure that the page cache pages are written to
3447 		 * disk and invalidated to preserve the expected O_DIRECT
3448 		 * semantics.
3449 		 */
3450 		endbyte = pos + status - 1;
3451 		err = filemap_write_and_wait_range(mapping, pos, endbyte);
3452 		if (err == 0) {
3453 			iocb->ki_pos = endbyte + 1;
3454 			written += status;
3455 			invalidate_mapping_pages(mapping,
3456 						 pos >> PAGE_SHIFT,
3457 						 endbyte >> PAGE_SHIFT);
3458 		} else {
3459 			/*
3460 			 * We don't know how much we wrote, so just return
3461 			 * the number of bytes which were direct-written
3462 			 */
3463 		}
3464 	} else {
3465 		written = generic_perform_write(file, from, iocb->ki_pos);
3466 		if (likely(written > 0))
3467 			iocb->ki_pos += written;
3468 	}
3469 out:
3470 	current->backing_dev_info = NULL;
3471 	return written ? written : err;
3472 }
3473 EXPORT_SYMBOL(__generic_file_write_iter);
3474 
3475 /**
3476  * generic_file_write_iter - write data to a file
3477  * @iocb:	IO state structure
3478  * @from:	iov_iter with data to write
3479  *
3480  * This is a wrapper around __generic_file_write_iter() to be used by most
3481  * filesystems. It takes care of syncing the file in case of O_SYNC file
3482  * and acquires i_mutex as needed.
3483  * Return:
3484  * * negative error code if no data has been written at all of
3485  *   vfs_fsync_range() failed for a synchronous write
3486  * * number of bytes written, even for truncated writes
3487  */
generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)3488 ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3489 {
3490 	struct file *file = iocb->ki_filp;
3491 	struct inode *inode = file->f_mapping->host;
3492 	ssize_t ret;
3493 
3494 	inode_lock(inode);
3495 	ret = generic_write_checks(iocb, from);
3496 	if (ret > 0)
3497 		ret = __generic_file_write_iter(iocb, from);
3498 	inode_unlock(inode);
3499 
3500 	if (ret > 0)
3501 		ret = generic_write_sync(iocb, ret);
3502 	return ret;
3503 }
3504 EXPORT_SYMBOL(generic_file_write_iter);
3505 
3506 /**
3507  * try_to_release_page() - release old fs-specific metadata on a page
3508  *
3509  * @page: the page which the kernel is trying to free
3510  * @gfp_mask: memory allocation flags (and I/O mode)
3511  *
3512  * The address_space is to try to release any data against the page
3513  * (presumably at page->private).
3514  *
3515  * This may also be called if PG_fscache is set on a page, indicating that the
3516  * page is known to the local caching routines.
3517  *
3518  * The @gfp_mask argument specifies whether I/O may be performed to release
3519  * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
3520  *
3521  * Return: %1 if the release was successful, otherwise return zero.
3522  */
try_to_release_page(struct page *page, gfp_t gfp_mask)3523 int try_to_release_page(struct page *page, gfp_t gfp_mask)
3524 {
3525 	struct address_space * const mapping = page->mapping;
3526 
3527 	BUG_ON(!PageLocked(page));
3528 	if (PageWriteback(page))
3529 		return 0;
3530 
3531 	if (mapping && mapping->a_ops->releasepage)
3532 		return mapping->a_ops->releasepage(page, gfp_mask);
3533 	return try_to_free_buffers(page);
3534 }
3535 
3536 EXPORT_SYMBOL(try_to_release_page);
3537