blob: 19fbb69b43fb25324ea01fa6565efd2b09f1822c [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
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 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080015#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/fs.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010017#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070018#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080019#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#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>
Josef Bacikcfcbfb12019-05-13 17:21:04 -070028#include <linux/error-injection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/hash.h>
30#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070031#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080035#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070036#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080037#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060038#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080039#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070040#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070041#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070042#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070043#include <linux/ramfs.h>
Yang Shib9306a72020-08-06 23:19:55 -070044#include <linux/page_idle.h>
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +030045#include <asm/pgalloc.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080046#include "internal.h"
47
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070048#define CREATE_TRACE_POINTS
49#include <trace/events/filemap.h>
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * FIXME: remove all knowledge of the buffer layer from the core VM
53 */
Jan Kara148f9482009-08-17 19:52:36 +020054#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#include <asm/mman.h>
57
58/*
59 * Shared mappings implemented 30.11.1994. It's not fully working yet,
60 * though.
61 *
62 * Shared mappings now work. 15.8.1995 Bruno.
63 *
64 * finished 'unifying' the page and buffer cache and SMP-threaded the
65 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
66 *
67 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
68 */
69
70/*
71 * Lock ordering:
72 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080073 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070075 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070076 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080078 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080079 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070081 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080082 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070083 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070084 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070086 * ->mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 * ->lock_page (access_process_vm)
88 *
Al Viroccad2362014-02-11 22:36:48 -050089 * ->i_mutex (generic_perform_write)
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070090 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060092 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110093 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070094 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080096 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 * ->anon_vma.lock (vma_adjust)
98 *
99 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700100 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700102 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700103 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700105 * ->i_pages lock (try_to_unmap_one)
Andrey Ryabininf4b7e272019-03-05 15:49:39 -0800106 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
107 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700109 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600110 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100111 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700112 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600113 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100114 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
116 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800117 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700118 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
120
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500121static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700122 struct page *page, void *shadow)
123{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500124 XA_STATE(xas, &mapping->i_pages, page->index);
125 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800126
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500127 mapping_set_update(&xas, mapping);
128
129 /* hugetlb pages are represented by a single entry in the xarray */
130 if (!PageHuge(page)) {
131 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700132 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500133 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700134
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700135 VM_BUG_ON_PAGE(!PageLocked(page), page);
136 VM_BUG_ON_PAGE(PageTail(page), page);
137 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700138
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500139 xas_store(&xas, shadow);
140 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200141
Jan Kara23006382017-11-15 17:37:26 -0800142 page->mapping = NULL;
143 /* Leave page->index set: truncation lookup relies upon it */
144
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200145 if (shadow) {
146 mapping->nrexceptional += nr;
147 /*
148 * Make sure the nrexceptional update is committed before
149 * the nrpages update so that final truncate racing
150 * with reclaim does not see both counters 0 at the
151 * same time and miss a shadow entry.
152 */
153 smp_wmb();
154 }
155 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700156}
157
Jan Kara5ecc4d82017-11-15 17:37:29 -0800158static void unaccount_page_cache_page(struct address_space *mapping,
159 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800161 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600163 /*
164 * if we're uptodate, flush out into the cleancache, otherwise
165 * invalidate any existing cleancache entries. We can't leave
166 * stale data around in the cleancache once our page is gone
167 */
168 if (PageUptodate(page) && PageMappedToDisk(page))
169 cleancache_put_page(page);
170 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400171 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600172
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700173 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800174 VM_BUG_ON_PAGE(page_mapped(page), page);
175 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
176 int mapcount;
177
178 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
179 current->comm, page_to_pfn(page));
180 dump_page(page, "still mapped when deleted");
181 dump_stack();
182 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
183
184 mapcount = page_mapcount(page);
185 if (mapping_exiting(mapping) &&
186 page_count(page) >= mapcount + 2) {
187 /*
188 * All vmas have already been torn down, so it's
189 * a good bet that actually the page is unmapped,
190 * and we'd prefer not to leak it: if we're wrong,
191 * some other bad page check should catch it later.
192 */
193 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700194 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800195 }
196 }
197
Jan Kara76253fb2017-11-15 17:37:22 -0800198 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800199 if (PageHuge(page))
200 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800201
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700202 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800203
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700204 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800205 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700206 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800207 if (PageTransHuge(page))
208 __dec_node_page_state(page, NR_SHMEM_THPS);
Song Liu99cb0db2019-09-23 15:38:00 -0700209 } else if (PageTransHuge(page)) {
210 __dec_node_page_state(page, NR_FILE_THPS);
Song Liu09d91cd2019-09-23 15:38:03 -0700211 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800212 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800213
214 /*
215 * At this point page must be either written or cleaned by
216 * truncate. Dirty page here signals a bug and loss of
217 * unwritten data.
218 *
219 * This fixes dirty accounting after removing the page entirely
220 * but leaves PageDirty set: it has no effect for truncated
221 * page and anyway will be cleared before returning page into
222 * buddy allocator.
223 */
224 if (WARN_ON_ONCE(PageDirty(page)))
225 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
226}
227
228/*
229 * Delete a page from the page cache and free it. Caller has to make
230 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700231 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800232 */
233void __delete_from_page_cache(struct page *page, void *shadow)
234{
235 struct address_space *mapping = page->mapping;
236
237 trace_mm_filemap_delete_from_page_cache(page);
238
239 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500240 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241}
242
Jan Kara59c66c52017-11-15 17:37:18 -0800243static void page_cache_free_page(struct address_space *mapping,
244 struct page *page)
245{
246 void (*freepage)(struct page *);
247
248 freepage = mapping->a_ops->freepage;
249 if (freepage)
250 freepage(page);
251
252 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700253 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800254 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
255 } else {
256 put_page(page);
257 }
258}
259
Minchan Kim702cfbf2011-03-22 16:32:43 -0700260/**
261 * delete_from_page_cache - delete page from page cache
262 * @page: the page which the kernel is trying to remove from page cache
263 *
264 * This must be called only on pages that have been verified to be in the page
265 * cache and locked. It will never put the page into the free list, the caller
266 * has a reference on the page.
267 */
268void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700270 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400271 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Matt Mackallcd7619d2005-05-01 08:59:01 -0700273 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700274 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700275 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700276 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500277
Jan Kara59c66c52017-11-15 17:37:18 -0800278 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700279}
280EXPORT_SYMBOL(delete_from_page_cache);
281
Jan Karaaa65c292017-11-15 17:37:33 -0800282/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500283 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800284 * @mapping: the mapping to which pages belong
285 * @pvec: pagevec with pages to delete
286 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700287 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700288 * from the mapping. The function expects @pvec to be sorted by page index
289 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700290 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800291 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700292 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800293 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700294 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800295 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500296static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800297 struct pagevec *pvec)
298{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500299 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800300 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700301 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800302 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800303
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500304 mapping_set_update(&xas, mapping);
305 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700306 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800307 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700308
309 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400310 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800311 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700312 /*
313 * A page got inserted in our range? Skip it. We have our
314 * pages locked so they are protected from being removed.
315 * If we see a page whose index is higher than ours, it
316 * means our page has been removed, which shouldn't be
317 * possible because we're holding the PageLock.
318 */
319 if (page != pvec->pages[i]) {
320 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
321 page);
322 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700323 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700324
325 WARN_ON_ONCE(!PageLocked(page));
326
327 if (page->index == xas.xa_index)
328 page->mapping = NULL;
329 /* Leave page->index set: truncation lookup relies on it */
330
331 /*
332 * Move to the next page in the vector if this is a regular
333 * page or the index is of the last sub-page of this compound
334 * page.
335 */
336 if (page->index + compound_nr(page) - 1 == xas.xa_index)
337 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500338 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800339 total_pages++;
340 }
341 mapping->nrpages -= total_pages;
342}
343
344void delete_from_page_cache_batch(struct address_space *mapping,
345 struct pagevec *pvec)
346{
347 int i;
348 unsigned long flags;
349
350 if (!pagevec_count(pvec))
351 return;
352
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700353 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800354 for (i = 0; i < pagevec_count(pvec); i++) {
355 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
356
357 unaccount_page_cache_page(mapping, pvec->pages[i]);
358 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500359 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700360 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800361
362 for (i = 0; i < pagevec_count(pvec); i++)
363 page_cache_free_page(mapping, pvec->pages[i]);
364}
365
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200366int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700367{
368 int ret = 0;
369 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700370 if (test_bit(AS_ENOSPC, &mapping->flags) &&
371 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700372 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700373 if (test_bit(AS_EIO, &mapping->flags) &&
374 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700375 ret = -EIO;
376 return ret;
377}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200378EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700379
Jeff Layton76341ca2017-07-06 07:02:22 -0400380static int filemap_check_and_keep_errors(struct address_space *mapping)
381{
382 /* Check for outstanding write errors */
383 if (test_bit(AS_EIO, &mapping->flags))
384 return -EIO;
385 if (test_bit(AS_ENOSPC, &mapping->flags))
386 return -ENOSPC;
387 return 0;
388}
389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700391 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700392 * @mapping: address space structure to write
393 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800394 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700395 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700397 * Start writeback against all of a mapping's dirty pages that lie
398 * within the byte offsets <start, end> inclusive.
399 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700401 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 * these two operations is that if a dirty page/buffer is encountered, it must
403 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800404 *
405 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800407int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
408 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
410 int ret;
411 struct writeback_control wbc = {
412 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800413 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700414 .range_start = start,
415 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 };
417
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200418 if (!mapping_can_writeback(mapping) ||
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700419 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 return 0;
421
Tejun Heob16b1de2015-06-02 08:39:48 -0600422 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600424 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 return ret;
426}
427
428static inline int __filemap_fdatawrite(struct address_space *mapping,
429 int sync_mode)
430{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700431 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432}
433
434int filemap_fdatawrite(struct address_space *mapping)
435{
436 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
437}
438EXPORT_SYMBOL(filemap_fdatawrite);
439
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400440int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800441 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
443 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
444}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400445EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Randy Dunlap485bb992006-06-23 02:03:49 -0700447/**
448 * filemap_flush - mostly a non-blocking flush
449 * @mapping: target address_space
450 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 * This is a mostly non-blocking flush. Not suitable for data-integrity
452 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800453 *
454 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 */
456int filemap_flush(struct address_space *mapping)
457{
458 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
459}
460EXPORT_SYMBOL(filemap_flush);
461
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500462/**
463 * filemap_range_has_page - check if a page exists in range.
464 * @mapping: address space within which to check
465 * @start_byte: offset in bytes where the range starts
466 * @end_byte: offset in bytes where the range ends (inclusive)
467 *
468 * Find at least one page in the range supplied, usually used to check if
469 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800470 *
471 * Return: %true if at least one page exists in the specified range,
472 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500473 */
474bool filemap_range_has_page(struct address_space *mapping,
475 loff_t start_byte, loff_t end_byte)
476{
Jan Karaf7b68042017-09-06 16:21:40 -0700477 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500478 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
479 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500480
481 if (end_byte < start_byte)
482 return false;
483
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500484 rcu_read_lock();
485 for (;;) {
486 page = xas_find(&xas, max);
487 if (xas_retry(&xas, page))
488 continue;
489 /* Shadow entries don't count */
490 if (xa_is_value(page))
491 continue;
492 /*
493 * We don't need to try to pin this page; we're about to
494 * release the RCU lock anyway. It is enough to know that
495 * there was a page here recently.
496 */
497 break;
498 }
499 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500500
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500501 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500502}
503EXPORT_SYMBOL(filemap_range_has_page);
504
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400505static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800506 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300508 pgoff_t index = start_byte >> PAGE_SHIFT;
509 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 struct pagevec pvec;
511 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200513 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400514 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Mel Gorman86679822017-11-15 17:37:52 -0800516 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800517 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 unsigned i;
519
Jan Kara312e9d22017-11-15 17:35:05 -0800520 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800521 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800522 if (!nr_pages)
523 break;
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 for (i = 0; i < nr_pages; i++) {
526 struct page *page = pvec.pages[i];
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400529 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 }
531 pagevec_release(&pvec);
532 cond_resched();
533 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800534}
535
536/**
537 * filemap_fdatawait_range - wait for writeback to complete
538 * @mapping: address space structure to wait for
539 * @start_byte: offset in bytes where the range starts
540 * @end_byte: offset in bytes where the range ends (inclusive)
541 *
542 * Walk the list of under-writeback pages of the given address space
543 * in the given range and wait for all of them. Check error status of
544 * the address space and return it.
545 *
546 * Since the error status of the address space is cleared by this function,
547 * callers are responsible for checking the return value and handling and/or
548 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800549 *
550 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800551 */
552int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
553 loff_t end_byte)
554{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400555 __filemap_fdatawait_range(mapping, start_byte, end_byte);
556 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200558EXPORT_SYMBOL(filemap_fdatawait_range);
559
560/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400561 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
562 * @mapping: address space structure to wait for
563 * @start_byte: offset in bytes where the range starts
564 * @end_byte: offset in bytes where the range ends (inclusive)
565 *
566 * Walk the list of under-writeback pages of the given address space in the
567 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
568 * this function does not clear error status of the address space.
569 *
570 * Use this function if callers don't handle errors themselves. Expected
571 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
572 * fsfreeze(8)
573 */
574int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
575 loff_t start_byte, loff_t end_byte)
576{
577 __filemap_fdatawait_range(mapping, start_byte, end_byte);
578 return filemap_check_and_keep_errors(mapping);
579}
580EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
581
582/**
Jeff Laytona823e452017-07-28 07:24:43 -0400583 * file_fdatawait_range - wait for writeback to complete
584 * @file: file pointing to address space structure to wait for
585 * @start_byte: offset in bytes where the range starts
586 * @end_byte: offset in bytes where the range ends (inclusive)
587 *
588 * Walk the list of under-writeback pages of the address space that file
589 * refers to, in the given range and wait for all of them. Check error
590 * status of the address space vs. the file->f_wb_err cursor and return it.
591 *
592 * Since the error status of the file is advanced by this function,
593 * callers are responsible for checking the return value and handling and/or
594 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800595 *
596 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400597 */
598int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
599{
600 struct address_space *mapping = file->f_mapping;
601
602 __filemap_fdatawait_range(mapping, start_byte, end_byte);
603 return file_check_and_advance_wb_err(file);
604}
605EXPORT_SYMBOL(file_fdatawait_range);
606
607/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800608 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
609 * @mapping: address space structure to wait for
610 *
611 * Walk the list of under-writeback pages of the given address space
612 * and wait for all of them. Unlike filemap_fdatawait(), this function
613 * does not clear error status of the address space.
614 *
615 * Use this function if callers don't handle errors themselves. Expected
616 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
617 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800618 *
619 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800620 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400621int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800622{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400623 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400624 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800625}
Jeff Layton76341ca2017-07-06 07:02:22 -0400626EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800627
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700628/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400629static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700631 if (dax_mapping(mapping))
632 return mapping->nrexceptional;
633
634 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Randy Dunlap485bb992006-06-23 02:03:49 -0700637/**
638 * filemap_write_and_wait_range - write out & wait on a file range
639 * @mapping: the address_space for the pages
640 * @lstart: offset in bytes where the range starts
641 * @lend: offset in bytes where the range ends (inclusive)
642 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800643 * Write out and wait upon file offsets lstart->lend, inclusive.
644 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300645 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800646 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800647 *
648 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800649 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650int filemap_write_and_wait_range(struct address_space *mapping,
651 loff_t lstart, loff_t lend)
652{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800653 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Jeff Layton9326c9b2017-07-26 10:21:11 -0400655 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800656 err = __filemap_fdatawrite_range(mapping, lstart, lend,
657 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800658 /*
659 * Even if the above returned error, the pages may be
660 * written partially (e.g. -ENOSPC), so we wait for it.
661 * But the -EIO is special case, it may indicate the worst
662 * thing (e.g. bug) happened, so we avoid waiting for it.
663 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800664 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200665 int err2 = filemap_fdatawait_range(mapping,
666 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800667 if (!err)
668 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400669 } else {
670 /* Clear any previously stored errors */
671 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800672 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700673 } else {
674 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800676 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
Chris Masonf6995582009-04-15 13:22:37 -0400678EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Jeff Layton5660e132017-07-06 07:02:25 -0400680void __filemap_set_wb_err(struct address_space *mapping, int err)
681{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400682 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400683
684 trace_filemap_set_wb_err(mapping, eseq);
685}
686EXPORT_SYMBOL(__filemap_set_wb_err);
687
688/**
689 * file_check_and_advance_wb_err - report wb error (if any) that was previously
690 * and advance wb_err to current one
691 * @file: struct file on which the error is being reported
692 *
693 * When userland calls fsync (or something like nfsd does the equivalent), we
694 * want to report any writeback errors that occurred since the last fsync (or
695 * since the file was opened if there haven't been any).
696 *
697 * Grab the wb_err from the mapping. If it matches what we have in the file,
698 * then just quickly return 0. The file is all caught up.
699 *
700 * If it doesn't match, then take the mapping value, set the "seen" flag in
701 * it and try to swap it into place. If it works, or another task beat us
702 * to it with the new value, then update the f_wb_err and return the error
703 * portion. The error at this point must be reported via proper channels
704 * (a'la fsync, or NFS COMMIT operation, etc.).
705 *
706 * While we handle mapping->wb_err with atomic operations, the f_wb_err
707 * value is protected by the f_lock since we must ensure that it reflects
708 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800709 *
710 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400711 */
712int file_check_and_advance_wb_err(struct file *file)
713{
714 int err = 0;
715 errseq_t old = READ_ONCE(file->f_wb_err);
716 struct address_space *mapping = file->f_mapping;
717
718 /* Locklessly handle the common case where nothing has changed */
719 if (errseq_check(&mapping->wb_err, old)) {
720 /* Something changed, must use slow path */
721 spin_lock(&file->f_lock);
722 old = file->f_wb_err;
723 err = errseq_check_and_advance(&mapping->wb_err,
724 &file->f_wb_err);
725 trace_file_check_and_advance_wb_err(file, old);
726 spin_unlock(&file->f_lock);
727 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700728
729 /*
730 * We're mostly using this function as a drop in replacement for
731 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
732 * that the legacy code would have had on these flags.
733 */
734 clear_bit(AS_EIO, &mapping->flags);
735 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400736 return err;
737}
738EXPORT_SYMBOL(file_check_and_advance_wb_err);
739
740/**
741 * file_write_and_wait_range - write out & wait on a file range
742 * @file: file pointing to address_space with pages
743 * @lstart: offset in bytes where the range starts
744 * @lend: offset in bytes where the range ends (inclusive)
745 *
746 * Write out and wait upon file offsets lstart->lend, inclusive.
747 *
748 * Note that @lend is inclusive (describes the last byte to be written) so
749 * that this function can be used to write to the very end-of-file (end = -1).
750 *
751 * After writing out and waiting on the data, we check and advance the
752 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800753 *
754 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400755 */
756int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
757{
758 int err = 0, err2;
759 struct address_space *mapping = file->f_mapping;
760
Jeff Layton9326c9b2017-07-26 10:21:11 -0400761 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400762 err = __filemap_fdatawrite_range(mapping, lstart, lend,
763 WB_SYNC_ALL);
764 /* See comment of filemap_write_and_wait() */
765 if (err != -EIO)
766 __filemap_fdatawait_range(mapping, lstart, lend);
767 }
768 err2 = file_check_and_advance_wb_err(file);
769 if (!err)
770 err = err2;
771 return err;
772}
773EXPORT_SYMBOL(file_write_and_wait_range);
774
Randy Dunlap485bb992006-06-23 02:03:49 -0700775/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700776 * replace_page_cache_page - replace a pagecache page with a new one
777 * @old: page to be replaced
778 * @new: page to replace with
779 * @gfp_mask: allocation mode
780 *
781 * This function replaces a page in the pagecache with a new one. On
782 * success it acquires the pagecache reference for the new page and
783 * drops it for the old page. Both the old and new pages must be
784 * locked. This function does not add the new page to the LRU, the
785 * caller must do that.
786 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500787 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800788 *
789 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700790 */
791int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
792{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500793 struct address_space *mapping = old->mapping;
794 void (*freepage)(struct page *) = mapping->a_ops->freepage;
795 pgoff_t offset = old->index;
796 XA_STATE(xas, &mapping->i_pages, offset);
797 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700798
Sasha Levin309381fea2014-01-23 15:52:54 -0800799 VM_BUG_ON_PAGE(!PageLocked(old), old);
800 VM_BUG_ON_PAGE(!PageLocked(new), new);
801 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700802
Matthew Wilcox74d60952017-11-17 10:01:45 -0500803 get_page(new);
804 new->mapping = mapping;
805 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700806
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700807 mem_cgroup_migrate(old, new);
808
Matthew Wilcox74d60952017-11-17 10:01:45 -0500809 xas_lock_irqsave(&xas, flags);
810 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700811
Matthew Wilcox74d60952017-11-17 10:01:45 -0500812 old->mapping = NULL;
813 /* hugetlb pages do not participate in page cache accounting. */
814 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700815 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500816 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700817 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500818 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700819 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500820 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700821 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500822 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500823 if (freepage)
824 freepage(old);
825 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700826
Matthew Wilcox74d60952017-11-17 10:01:45 -0500827 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700828}
829EXPORT_SYMBOL_GPL(replace_page_cache_page);
830
Andrew Morton16c0cc02020-12-11 13:36:27 -0800831noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700832 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700833 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700834 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500836 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700837 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700838 int error;
Waiman Long032f8e02021-02-04 18:32:45 -0800839 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700840
Sasha Levin309381fea2014-01-23 15:52:54 -0800841 VM_BUG_ON_PAGE(!PageLocked(page), page);
842 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500843 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700844
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300845 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700846 page->mapping = mapping;
847 page->index = offset;
848
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700849 if (!huge) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700850 error = mem_cgroup_charge(page, current->mm, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700851 if (error)
852 goto error;
Waiman Long032f8e02021-02-04 18:32:45 -0800853 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700854 }
855
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700856 gfp &= GFP_RECLAIM_MASK;
857
Matthew Wilcox74d60952017-11-17 10:01:45 -0500858 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700859 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
860 void *entry, *old = NULL;
861
862 if (order > thp_order(page))
863 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
864 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500865 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700866 xas_for_each_conflict(&xas, entry) {
867 old = entry;
868 if (!xa_is_value(entry)) {
869 xas_set_err(&xas, -EEXIST);
870 goto unlock;
871 }
872 }
873
874 if (old) {
875 if (shadowp)
876 *shadowp = old;
877 /* entry may have been split before we acquired lock */
878 order = xa_get_order(xas.xa, xas.xa_index);
879 if (order > thp_order(page)) {
880 xas_split(&xas, old, order);
881 xas_reset(&xas);
882 }
883 }
884
Matthew Wilcox74d60952017-11-17 10:01:45 -0500885 xas_store(&xas, page);
886 if (xas_error(&xas))
887 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700888
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700889 if (old)
Matthew Wilcox74d60952017-11-17 10:01:45 -0500890 mapping->nrexceptional--;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500891 mapping->nrpages++;
892
893 /* hugetlb pages do not participate in page cache accounting */
894 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700895 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500896unlock:
897 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700898 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500899
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700900 if (xas_error(&xas)) {
901 error = xas_error(&xas);
Waiman Long032f8e02021-02-04 18:32:45 -0800902 if (charged)
903 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500904 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700905 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500906
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700907 trace_mm_filemap_add_to_page_cache(page);
908 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500909error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700910 page->mapping = NULL;
911 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300912 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700913 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700915ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700916
917/**
918 * add_to_page_cache_locked - add a locked page to the pagecache
919 * @page: page to add
920 * @mapping: the page's address_space
921 * @offset: page index
922 * @gfp_mask: page allocation mode
923 *
924 * This function is used to add a page to the pagecache. It must be locked.
925 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800926 *
927 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700928 */
929int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
930 pgoff_t offset, gfp_t gfp_mask)
931{
932 return __add_to_page_cache_locked(page, mapping, offset,
933 gfp_mask, NULL);
934}
Nick Piggine2867812008-07-25 19:45:30 -0700935EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
937int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400938 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939{
Johannes Weinera5289102014-04-03 14:47:51 -0700940 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700941 int ret;
942
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800943 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700944 ret = __add_to_page_cache_locked(page, mapping, offset,
945 gfp_mask, &shadow);
946 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800947 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700948 else {
949 /*
950 * The page might have been evicted from cache only
951 * recently, in which case it should be activated like
952 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700953 * The exception is pages getting rewritten; evicting other
954 * data from the working set, only to cache data that will
955 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700956 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700957 WARN_ON_ONCE(PageActive(page));
958 if (!(gfp_mask & __GFP_WRITE) && shadow)
959 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700960 lru_cache_add(page);
961 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 return ret;
963}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300964EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Paul Jackson44110fe2006-03-24 03:16:04 -0800966#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700967struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800968{
Miao Xiec0ff7452010-05-24 14:32:08 -0700969 int n;
970 struct page *page;
971
Paul Jackson44110fe2006-03-24 03:16:04 -0800972 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700973 unsigned int cpuset_mems_cookie;
974 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700975 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700976 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700977 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700978 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700979
Miao Xiec0ff7452010-05-24 14:32:08 -0700980 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800981 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700982 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800983}
Nick Piggin2ae88142006-10-28 10:38:23 -0700984EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800985#endif
986
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987/*
988 * In order to wait for pages to become available there must be
989 * waitqueues associated with pages. By using a hash table of
990 * waitqueues where the bucket discipline is to maintain all
991 * waiters on the same queue and wake all when any of the pages
992 * become available, and for the woken contexts to check to be
993 * sure the appropriate page became available, this saves space
994 * at a cost of "thundering herd" phenomena during rare hash
995 * collisions.
996 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000997#define PAGE_WAIT_TABLE_BITS 8
998#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
999static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1000
1001static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002{
Nicholas Piggin62906022016-12-25 13:00:30 +10001003 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004}
Nicholas Piggin62906022016-12-25 13:00:30 +10001005
1006void __init pagecache_init(void)
1007{
1008 int i;
1009
1010 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1011 init_waitqueue_head(&page_wait_table[i]);
1012
1013 page_writeback_init();
1014}
1015
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001016/*
1017 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001018 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001019 * one.
1020 *
1021 * We have:
1022 *
1023 * (a) no special bits set:
1024 *
1025 * We're just waiting for the bit to be released, and when a waker
1026 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1027 * and remove it from the wait queue.
1028 *
1029 * Simple and straightforward.
1030 *
1031 * (b) WQ_FLAG_EXCLUSIVE:
1032 *
1033 * The waiter is waiting to get the lock, and only one waiter should
1034 * be woken up to avoid any thundering herd behavior. We'll set the
1035 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1036 *
1037 * This is the traditional exclusive wait.
1038 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001039 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001040 *
1041 * The waiter is waiting to get the bit, and additionally wants the
1042 * lock to be transferred to it for fair lock behavior. If the lock
1043 * cannot be taken, we stop walking the wait queue without waking
1044 * the waiter.
1045 *
1046 * This is the "fair lock handoff" case, and in addition to setting
1047 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1048 * that it now has the lock.
1049 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001050static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001051{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001052 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001053 struct wait_page_key *key = arg;
1054 struct wait_page_queue *wait_page
1055 = container_of(wait, struct wait_page_queue, wait);
1056
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001057 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001058 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001059
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001060 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001061 * If it's a lock handoff wait, we get the bit for it, and
1062 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001063 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001064 flags = wait->flags;
1065 if (flags & WQ_FLAG_EXCLUSIVE) {
1066 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001067 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001068 if (flags & WQ_FLAG_CUSTOM) {
1069 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1070 return -1;
1071 flags |= WQ_FLAG_DONE;
1072 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001073 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001074
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001075 /*
1076 * We are holding the wait-queue lock, but the waiter that
1077 * is waiting for this will be checking the flags without
1078 * any locking.
1079 *
1080 * So update the flags atomically, and wake up the waiter
1081 * afterwards to avoid any races. This store-release pairs
1082 * with the load-acquire in wait_on_page_bit_common().
1083 */
1084 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001085 wake_up_state(wait->private, mode);
1086
1087 /*
1088 * Ok, we have successfully done what we're waiting for,
1089 * and we can unconditionally remove the wait entry.
1090 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001091 * Note that this pairs with the "finish_wait()" in the
1092 * waiter, and has to be the absolute last thing we do.
1093 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001094 * might be de-allocated and the process might even have
1095 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001096 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001097 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001098 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001099}
1100
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001101static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001102{
1103 wait_queue_head_t *q = page_waitqueue(page);
1104 struct wait_page_key key;
1105 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001106 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001107
1108 key.page = page;
1109 key.bit_nr = bit_nr;
1110 key.page_match = 0;
1111
Tim Chen11a19c72017-08-25 09:13:55 -07001112 bookmark.flags = 0;
1113 bookmark.private = NULL;
1114 bookmark.func = NULL;
1115 INIT_LIST_HEAD(&bookmark.entry);
1116
Nicholas Piggin62906022016-12-25 13:00:30 +10001117 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001118 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1119
1120 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1121 /*
1122 * Take a breather from holding the lock,
1123 * allow pages that finish wake up asynchronously
1124 * to acquire the lock and remove themselves
1125 * from wait queue
1126 */
1127 spin_unlock_irqrestore(&q->lock, flags);
1128 cpu_relax();
1129 spin_lock_irqsave(&q->lock, flags);
1130 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1131 }
1132
Nicholas Piggin62906022016-12-25 13:00:30 +10001133 /*
1134 * It is possible for other pages to have collided on the waitqueue
1135 * hash, so in that case check for a page match. That prevents a long-
1136 * term waiter
1137 *
1138 * It is still possible to miss a case here, when we woke page waiters
1139 * and removed them from the waitqueue, but there are still other
1140 * page waiters.
1141 */
1142 if (!waitqueue_active(q) || !key.page_match) {
1143 ClearPageWaiters(page);
1144 /*
1145 * It's possible to miss clearing Waiters here, when we woke
1146 * our page waiters, but the hashed waitqueue has waiters for
1147 * other pages on it.
1148 *
1149 * That's okay, it's a rare case. The next waker will clear it.
1150 */
1151 }
1152 spin_unlock_irqrestore(&q->lock, flags);
1153}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001154
1155static void wake_up_page(struct page *page, int bit)
1156{
1157 if (!PageWaiters(page))
1158 return;
1159 wake_up_page_bit(page, bit);
1160}
Nicholas Piggin62906022016-12-25 13:00:30 +10001161
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001162/*
1163 * A choice of three behaviors for wait_on_page_bit_common():
1164 */
1165enum behavior {
1166 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1167 * __lock_page() waiting on then setting PG_locked.
1168 */
1169 SHARED, /* Hold ref to page and check the bit when woken, like
1170 * wait_on_page_writeback() waiting on PG_writeback.
1171 */
1172 DROP, /* Drop ref to page before wait, no check when woken,
1173 * like put_and_wait_on_page_locked() on PG_locked.
1174 */
1175};
1176
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001177/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001178 * Attempt to check (or get) the page bit, and mark us done
1179 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001180 */
1181static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1182 struct wait_queue_entry *wait)
1183{
1184 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1185 if (test_and_set_bit(bit_nr, &page->flags))
1186 return false;
1187 } else if (test_bit(bit_nr, &page->flags))
1188 return false;
1189
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001190 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001191 return true;
1192}
1193
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001194/* How many times do we accept lock stealing from under a waiter? */
1195int sysctl_page_lock_unfairness = 5;
1196
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001197static inline __sched int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001198 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001199{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001200 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001201 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001202 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001203 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001204 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001205 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001206
Johannes Weinereb414682018-10-26 15:06:27 -07001207 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001208 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001209 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001210 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001211 delayacct = true;
1212 }
Johannes Weinereb414682018-10-26 15:06:27 -07001213 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001214 thrashing = true;
1215 }
1216
Nicholas Piggin62906022016-12-25 13:00:30 +10001217 init_wait(wait);
1218 wait->func = wake_page_function;
1219 wait_page.page = page;
1220 wait_page.bit_nr = bit_nr;
1221
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001222repeat:
1223 wait->flags = 0;
1224 if (behavior == EXCLUSIVE) {
1225 wait->flags = WQ_FLAG_EXCLUSIVE;
1226 if (--unfairness < 0)
1227 wait->flags |= WQ_FLAG_CUSTOM;
1228 }
1229
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001230 /*
1231 * Do one last check whether we can get the
1232 * page bit synchronously.
1233 *
1234 * Do the SetPageWaiters() marking before that
1235 * to let any waker we _just_ missed know they
1236 * need to wake us up (otherwise they'll never
1237 * even go to the slow case that looks at the
1238 * page queue), and add ourselves to the wait
1239 * queue if we need to sleep.
1240 *
1241 * This part needs to be done under the queue
1242 * lock to avoid races.
1243 */
1244 spin_lock_irq(&q->lock);
1245 SetPageWaiters(page);
1246 if (!trylock_page_bit_common(page, bit_nr, wait))
1247 __add_wait_queue_entry_tail(q, wait);
1248 spin_unlock_irq(&q->lock);
1249
1250 /*
1251 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001252 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1253 * see whether the page bit testing has already
1254 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001255 *
1256 * We can drop our reference to the page.
1257 */
1258 if (behavior == DROP)
1259 put_page(page);
1260
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001261 /*
1262 * Note that until the "finish_wait()", or until
1263 * we see the WQ_FLAG_WOKEN flag, we need to
1264 * be very careful with the 'wait->flags', because
1265 * we may race with a waker that sets them.
1266 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001267 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001268 unsigned int flags;
1269
Nicholas Piggin62906022016-12-25 13:00:30 +10001270 set_current_state(state);
1271
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001272 /* Loop until we've been woken or interrupted */
1273 flags = smp_load_acquire(&wait->flags);
1274 if (!(flags & WQ_FLAG_WOKEN)) {
1275 if (signal_pending_state(state, current))
1276 break;
1277
1278 io_schedule();
1279 continue;
1280 }
1281
1282 /* If we were non-exclusive, we're done */
1283 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001284 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001285
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001286 /* If the waker got the lock for us, we're done */
1287 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001288 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001289
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001290 /*
1291 * Otherwise, if we're getting the lock, we need to
1292 * try to get it ourselves.
1293 *
1294 * And if that fails, we'll have to retry this all.
1295 */
1296 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1297 goto repeat;
1298
1299 wait->flags |= WQ_FLAG_DONE;
1300 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001301 }
1302
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001303 /*
1304 * If a signal happened, this 'finish_wait()' may remove the last
1305 * waiter from the wait-queues, but the PageWaiters bit will remain
1306 * set. That's ok. The next wakeup will take care of it, and trying
1307 * to do it here would be difficult and prone to races.
1308 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001309 finish_wait(q, wait);
1310
Johannes Weinereb414682018-10-26 15:06:27 -07001311 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001312 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001313 delayacct_thrashing_end();
1314 psi_memstall_leave(&pflags);
1315 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001316
Nicholas Piggin62906022016-12-25 13:00:30 +10001317 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001318 * NOTE! The wait->flags weren't stable until we've done the
1319 * 'finish_wait()', and we could have exited the loop above due
1320 * to a signal, and had a wakeup event happen after the signal
1321 * test but before the 'finish_wait()'.
1322 *
1323 * So only after the finish_wait() can we reliably determine
1324 * if we got woken up or not, so we can now figure out the final
1325 * return value based on that state without races.
1326 *
1327 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1328 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001329 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001330 if (behavior == EXCLUSIVE)
1331 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001332
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001333 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001334}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001336__sched void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337{
Nicholas Piggin62906022016-12-25 13:00:30 +10001338 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001339 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340}
1341EXPORT_SYMBOL(wait_on_page_bit);
1342
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001343__sched int wait_on_page_bit_killable(struct page *page, int bit_nr)
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001344{
Nicholas Piggin62906022016-12-25 13:00:30 +10001345 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001346 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001347}
David Howells4343d002017-11-02 15:27:52 +00001348EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001349
Jens Axboedd3e6d52020-05-22 09:12:09 -06001350static int __wait_on_page_locked_async(struct page *page,
1351 struct wait_page_queue *wait, bool set)
1352{
1353 struct wait_queue_head *q = page_waitqueue(page);
1354 int ret = 0;
1355
1356 wait->page = page;
1357 wait->bit_nr = PG_locked;
1358
1359 spin_lock_irq(&q->lock);
1360 __add_wait_queue_entry_tail(q, &wait->wait);
1361 SetPageWaiters(page);
1362 if (set)
1363 ret = !trylock_page(page);
1364 else
1365 ret = PageLocked(page);
1366 /*
1367 * If we were succesful now, we know we're still on the
1368 * waitqueue as we're still under the lock. This means it's
1369 * safe to remove and return success, we know the callback
1370 * isn't going to trigger.
1371 */
1372 if (!ret)
1373 __remove_wait_queue(q, &wait->wait);
1374 else
1375 ret = -EIOCBQUEUED;
1376 spin_unlock_irq(&q->lock);
1377 return ret;
1378}
1379
Jens Axboe1a0a7852020-05-22 09:18:38 -06001380static int wait_on_page_locked_async(struct page *page,
1381 struct wait_page_queue *wait)
1382{
1383 if (!PageLocked(page))
1384 return 0;
1385 return __wait_on_page_locked_async(compound_head(page), wait, false);
1386}
1387
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001389 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1390 * @page: The page to wait for.
1391 *
1392 * The caller should hold a reference on @page. They expect the page to
1393 * become unlocked relatively soon, but do not wish to hold up migration
1394 * (for example) by holding the reference while waiting for the page to
1395 * come unlocked. After this function returns, the caller should not
1396 * dereference @page.
1397 */
1398void put_and_wait_on_page_locked(struct page *page)
1399{
1400 wait_queue_head_t *q;
1401
1402 page = compound_head(page);
1403 q = page_waitqueue(page);
1404 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1405}
1406
1407/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001408 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001409 * @page: Page defining the wait queue of interest
1410 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001411 *
1412 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1413 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001414void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001415{
1416 wait_queue_head_t *q = page_waitqueue(page);
1417 unsigned long flags;
1418
1419 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001420 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001421 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001422 spin_unlock_irqrestore(&q->lock, flags);
1423}
1424EXPORT_SYMBOL_GPL(add_page_wait_queue);
1425
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001426#ifndef clear_bit_unlock_is_negative_byte
1427
1428/*
1429 * PG_waiters is the high bit in the same byte as PG_lock.
1430 *
1431 * On x86 (and on many other architectures), we can clear PG_lock and
1432 * test the sign bit at the same time. But if the architecture does
1433 * not support that special operation, we just do this all by hand
1434 * instead.
1435 *
1436 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001437 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001438 * in the same byte as PG_locked.
1439 */
1440static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1441{
1442 clear_bit_unlock(nr, mem);
1443 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001444 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001445}
1446
1447#endif
1448
David Howells385e1ca5f2009-04-03 16:42:39 +01001449/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001450 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 * @page: the page
1452 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001453 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001455 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1457 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001458 * Note that this depends on PG_waiters being the sign bit in the byte
1459 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1460 * clear the PG_locked bit and test PG_waiters at the same time fairly
1461 * portably (architectures that do LL/SC can test any bit, while x86 can
1462 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001463 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001464void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001466 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001467 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001468 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001469 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1470 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471}
1472EXPORT_SYMBOL(unlock_page);
1473
Randy Dunlap485bb992006-06-23 02:03:49 -07001474/**
1475 * end_page_writeback - end writeback against a page
1476 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477 */
1478void end_page_writeback(struct page *page)
1479{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001480 /*
1481 * TestClearPageReclaim could be used here but it is an atomic
1482 * operation and overkill in this particular case. Failing to
1483 * shuffle a page marked for immediate reclaim is too mild to
1484 * justify taking an atomic operation penalty at the end of
1485 * ever page writeback.
1486 */
1487 if (PageReclaim(page)) {
1488 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001489 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001490 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001491
Hugh Dickins073861e2020-11-24 08:46:43 -08001492 /*
1493 * Writeback does not hold a page reference of its own, relying
1494 * on truncation to wait for the clearing of PG_writeback.
1495 * But here we must make sure that the page is not freed and
1496 * reused before the wake_up_page().
1497 */
1498 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001499 if (!test_clear_page_writeback(page))
1500 BUG();
1501
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001502 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001504 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505}
1506EXPORT_SYMBOL(end_page_writeback);
1507
Matthew Wilcox57d99842014-06-04 16:07:45 -07001508/*
1509 * After completing I/O on a page, call this routine to update the page
1510 * flags appropriately
1511 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001512void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001513{
Jens Axboec11f0c02016-08-05 08:11:04 -06001514 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001515 if (!err) {
1516 SetPageUptodate(page);
1517 } else {
1518 ClearPageUptodate(page);
1519 SetPageError(page);
1520 }
1521 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001522 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001523 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001524 struct address_space *mapping;
1525
Matthew Wilcox57d99842014-06-04 16:07:45 -07001526 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001527 mapping = page_mapping(page);
1528 if (mapping)
1529 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001530 }
1531 end_page_writeback(page);
1532 }
1533}
1534EXPORT_SYMBOL_GPL(page_endio);
1535
Randy Dunlap485bb992006-06-23 02:03:49 -07001536/**
1537 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001538 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001540__sched void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541{
Nicholas Piggin62906022016-12-25 13:00:30 +10001542 struct page *page = compound_head(__page);
1543 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001544 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1545 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001546}
1547EXPORT_SYMBOL(__lock_page);
1548
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001549__sched int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001550{
Nicholas Piggin62906022016-12-25 13:00:30 +10001551 struct page *page = compound_head(__page);
1552 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001553 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1554 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001555}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001556EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001557
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001558__sched int __lock_page_async(struct page *page, struct wait_page_queue *wait)
Jens Axboedd3e6d52020-05-22 09:12:09 -06001559{
1560 return __wait_on_page_locked_async(page, wait, true);
1561}
1562
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001563/*
1564 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001565 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001566 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001567 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001568 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001569 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001570 *
1571 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001572 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001573 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001574__sched int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
Michel Lespinassed065bd82010-10-26 14:21:57 -07001575 unsigned int flags)
1576{
Peter Xu4064b982020-04-01 21:08:45 -07001577 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001578 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001579 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001580 * even though return 0.
1581 */
1582 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1583 return 0;
1584
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001585 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001586 if (flags & FAULT_FLAG_KILLABLE)
1587 wait_on_page_locked_killable(page);
1588 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001589 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001590 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001591 } else {
1592 if (flags & FAULT_FLAG_KILLABLE) {
1593 int ret;
1594
1595 ret = __lock_page_killable(page);
1596 if (ret) {
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001597 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001598 return 0;
1599 }
1600 } else
1601 __lock_page(page);
1602 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001603 }
1604}
1605
Randy Dunlap485bb992006-06-23 02:03:49 -07001606/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001607 * page_cache_next_miss() - Find the next gap in the page cache.
1608 * @mapping: Mapping.
1609 * @index: Index.
1610 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001611 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001612 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1613 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001614 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001615 * This function may be called under the rcu_read_lock. However, this will
1616 * not atomically search a snapshot of the cache at a single point in time.
1617 * For example, if a gap is created at index 5, then subsequently a gap is
1618 * created at index 10, page_cache_next_miss covering both indices may
1619 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001620 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001621 * Return: The index of the gap if found, otherwise an index outside the
1622 * range specified (in which case 'return - index >= max_scan' will be true).
1623 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001624 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001625pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001626 pgoff_t index, unsigned long max_scan)
1627{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001628 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001629
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001630 while (max_scan--) {
1631 void *entry = xas_next(&xas);
1632 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001633 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001634 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001635 break;
1636 }
1637
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001638 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001639}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001640EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001641
1642/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001643 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001644 * @mapping: Mapping.
1645 * @index: Index.
1646 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001647 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001648 * Search the range [max(index - max_scan + 1, 0), index] for the
1649 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001650 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001651 * This function may be called under the rcu_read_lock. However, this will
1652 * not atomically search a snapshot of the cache at a single point in time.
1653 * For example, if a gap is created at index 10, then subsequently a gap is
1654 * created at index 5, page_cache_prev_miss() covering both indices may
1655 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001656 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001657 * Return: The index of the gap if found, otherwise an index outside the
1658 * range specified (in which case 'index - return >= max_scan' will be true).
1659 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001660 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001661pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001662 pgoff_t index, unsigned long max_scan)
1663{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001664 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001665
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001666 while (max_scan--) {
1667 void *entry = xas_prev(&xas);
1668 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001669 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001670 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001671 break;
1672 }
1673
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001674 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001675}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001676EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001677
1678/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001679 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001680 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001681 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001682 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001683 * Looks up the page cache slot at @mapping & @offset. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001684 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001685 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001686 * If the slot holds a shadow entry of a previously evicted page, or a
1687 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001688 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001689 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 */
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001691struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001693 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001694 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695
Nick Piggina60637c2008-07-25 19:45:31 -07001696 rcu_read_lock();
1697repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001698 xas_reset(&xas);
1699 page = xas_load(&xas);
1700 if (xas_retry(&xas, page))
1701 goto repeat;
1702 /*
1703 * A shadow entry of a recently evicted page, or a swap entry from
1704 * shmem/tmpfs. Return it without attempting to raise page count.
1705 */
1706 if (!page || xa_is_value(page))
1707 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001708
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001709 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001710 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001711
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001712 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001713 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001714 * This is part of the lockless pagecache protocol. See
1715 * include/linux/pagemap.h for details.
1716 */
1717 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001718 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001719 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001720 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001721out:
Nick Piggina60637c2008-07-25 19:45:31 -07001722 rcu_read_unlock();
1723
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 return page;
1725}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001726
Randy Dunlap485bb992006-06-23 02:03:49 -07001727/**
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001728 * find_lock_entry - Locate and lock a page cache entry.
1729 * @mapping: The address_space to search.
1730 * @index: The page cache index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001731 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001732 * Looks up the page at @mapping & @index. If there is a page in the
1733 * cache, the head page is returned locked and with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001734 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001735 * If the slot holds a shadow entry of a previously evicted page, or a
1736 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001737 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001738 * Context: May sleep.
1739 * Return: The head page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001740 */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001741struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742{
1743 struct page *page;
1744
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745repeat:
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001746 page = find_get_entry(mapping, index);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001747 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001748 lock_page(page);
1749 /* Has the page been truncated? */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001750 if (unlikely(page->mapping != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001751 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001752 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001753 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 }
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001755 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 return page;
1758}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001759
1760/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001761 * pagecache_get_page - Find and get a reference to a page.
1762 * @mapping: The address_space to search.
1763 * @index: The page index.
1764 * @fgp_flags: %FGP flags modify how the page is returned.
1765 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001766 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001767 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001768 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001769 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001770 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001771 * * %FGP_ACCESSED - The page will be marked accessed.
1772 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001773 * * %FGP_HEAD - If the page is present and a THP, return the head page
1774 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001775 * * %FGP_CREAT - If no page is present then a new page is allocated using
1776 * @gfp_mask and added to the page cache and the VM's LRU list.
1777 * The page is returned locked and with an increased refcount.
1778 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1779 * page is already in cache. If the page was allocated, unlock it before
1780 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001781 * * %FGP_WRITE - The page will be written
1782 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1783 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001784 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001785 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1786 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001787 *
1788 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001789 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001790 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001791 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001792struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1793 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794{
Nick Piggineb2be182007-10-16 01:24:57 -07001795 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001796
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001798 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001799 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001800 page = NULL;
1801 if (!page)
1802 goto no_page;
1803
1804 if (fgp_flags & FGP_LOCK) {
1805 if (fgp_flags & FGP_NOWAIT) {
1806 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001807 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001808 return NULL;
1809 }
1810 } else {
1811 lock_page(page);
1812 }
1813
1814 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001815 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001816 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001817 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001818 goto repeat;
1819 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001820 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001821 }
1822
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001823 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001824 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001825 else if (fgp_flags & FGP_WRITE) {
1826 /* Clear idle flag for buffer write */
1827 if (page_is_idle(page))
1828 clear_page_idle(page);
1829 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001830 if (!(fgp_flags & FGP_HEAD))
1831 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001832
1833no_page:
1834 if (!page && (fgp_flags & FGP_CREAT)) {
1835 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001836 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001837 gfp_mask |= __GFP_WRITE;
1838 if (fgp_flags & FGP_NOFS)
1839 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001840
Michal Hocko45f87de2014-12-29 20:30:35 +01001841 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001842 if (!page)
1843 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001844
Josef Bacika75d4c32019-03-13 11:44:14 -07001845 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001846 fgp_flags |= FGP_LOCK;
1847
Hugh Dickinseb39d612014-08-06 16:06:43 -07001848 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001849 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001850 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001851
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001852 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001853 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001854 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001855 page = NULL;
1856 if (err == -EEXIST)
1857 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001859
1860 /*
1861 * add_to_page_cache_lru locks the page, and for mmap we expect
1862 * an unlocked page.
1863 */
1864 if (page && (fgp_flags & FGP_FOR_MMAP))
1865 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001867
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868 return page;
1869}
Mel Gorman2457aec2014-06-04 16:10:31 -07001870EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001871
1872/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001873 * find_get_entries - gang pagecache lookup
1874 * @mapping: The address_space to search
1875 * @start: The starting page cache index
1876 * @nr_entries: The maximum number of entries
1877 * @entries: Where the resulting entries are placed
1878 * @indices: The cache indices corresponding to the entries in @entries
1879 *
1880 * find_get_entries() will search for and return a group of up to
1881 * @nr_entries entries in the mapping. The entries are placed at
1882 * @entries. find_get_entries() takes a reference against any actual
1883 * pages it returns.
1884 *
1885 * The search returns a group of mapping-contiguous page cache entries
1886 * with ascending indexes. There may be holes in the indices due to
1887 * not-present pages.
1888 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001889 * Any shadow entries of evicted pages, or swap entries from
1890 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001891 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001892 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1893 * stops at that page: the caller is likely to have a better way to handle
1894 * the compound page as a whole, and then skip its extent, than repeatedly
1895 * calling find_get_entries() to return all its tails.
1896 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001897 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001898 */
1899unsigned find_get_entries(struct address_space *mapping,
1900 pgoff_t start, unsigned int nr_entries,
1901 struct page **entries, pgoff_t *indices)
1902{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001903 XA_STATE(xas, &mapping->i_pages, start);
1904 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001905 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001906
1907 if (!nr_entries)
1908 return 0;
1909
1910 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001911 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001912 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001913 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001914 /*
1915 * A shadow entry of a recently evicted page, a swap
1916 * entry from shmem/tmpfs or a DAX entry. Return it
1917 * without attempting to raise page count.
1918 */
1919 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001920 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001921
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001922 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001923 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001924
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001925 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001926 if (unlikely(page != xas_reload(&xas)))
1927 goto put_page;
1928
Hugh Dickins71725ed2020-04-06 20:07:57 -07001929 /*
1930 * Terminate early on finding a THP, to allow the caller to
1931 * handle it all at once; but continue if this is hugetlbfs.
1932 */
1933 if (PageTransHuge(page) && !PageHuge(page)) {
1934 page = find_subpage(page, xas.xa_index);
1935 nr_entries = ret + 1;
1936 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001937export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001938 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001939 entries[ret] = page;
1940 if (++ret == nr_entries)
1941 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001942 continue;
1943put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001944 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001945retry:
1946 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001947 }
1948 rcu_read_unlock();
1949 return ret;
1950}
1951
1952/**
Jan Karab947cee2017-09-06 16:21:21 -07001953 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 * @mapping: The address_space to search
1955 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001956 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 * @nr_pages: The maximum number of pages
1958 * @pages: Where the resulting pages are placed
1959 *
Jan Karab947cee2017-09-06 16:21:21 -07001960 * find_get_pages_range() will search for and return a group of up to @nr_pages
1961 * pages in the mapping starting at index @start and up to index @end
1962 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1963 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 *
1965 * The search returns a group of mapping-contiguous pages with ascending
1966 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001967 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001969 * Return: the number of pages which were found. If this number is
1970 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001971 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 */
Jan Karab947cee2017-09-06 16:21:21 -07001973unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1974 pgoff_t end, unsigned int nr_pages,
1975 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001977 XA_STATE(xas, &mapping->i_pages, *start);
1978 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001979 unsigned ret = 0;
1980
1981 if (unlikely(!nr_pages))
1982 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001983
Nick Piggina60637c2008-07-25 19:45:31 -07001984 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001985 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001986 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001987 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001988 /* Skip over shadow, swap and DAX entries */
1989 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001990 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001991
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001992 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001993 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001994
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001995 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001996 if (unlikely(page != xas_reload(&xas)))
1997 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001998
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001999 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002000 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002001 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002002 goto out;
2003 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002004 continue;
2005put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002006 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002007retry:
2008 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002009 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002010
Jan Karab947cee2017-09-06 16:21:21 -07002011 /*
2012 * We come here when there is no page beyond @end. We take care to not
2013 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002014 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002015 * already broken anyway.
2016 */
2017 if (end == (pgoff_t)-1)
2018 *start = (pgoff_t)-1;
2019 else
2020 *start = end + 1;
2021out:
Nick Piggina60637c2008-07-25 19:45:31 -07002022 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002023
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 return ret;
2025}
2026
Jens Axboeebf43502006-04-27 08:46:01 +02002027/**
2028 * find_get_pages_contig - gang contiguous pagecache lookup
2029 * @mapping: The address_space to search
2030 * @index: The starting page index
2031 * @nr_pages: The maximum number of pages
2032 * @pages: Where the resulting pages are placed
2033 *
2034 * find_get_pages_contig() works exactly like find_get_pages(), except
2035 * that the returned number of pages are guaranteed to be contiguous.
2036 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002037 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002038 */
2039unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2040 unsigned int nr_pages, struct page **pages)
2041{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002042 XA_STATE(xas, &mapping->i_pages, index);
2043 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002044 unsigned int ret = 0;
2045
2046 if (unlikely(!nr_pages))
2047 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002048
Nick Piggina60637c2008-07-25 19:45:31 -07002049 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002050 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002051 if (xas_retry(&xas, page))
2052 continue;
2053 /*
2054 * If the entry has been swapped out, we can stop looking.
2055 * No current caller is looking for DAX entries.
2056 */
2057 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002058 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002059
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002060 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002061 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002062
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002063 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002064 if (unlikely(page != xas_reload(&xas)))
2065 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002066
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002067 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002068 if (++ret == nr_pages)
2069 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002070 continue;
2071put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002072 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002073retry:
2074 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002075 }
Nick Piggina60637c2008-07-25 19:45:31 -07002076 rcu_read_unlock();
2077 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002078}
David Howellsef71c152007-05-09 02:33:44 -07002079EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002080
Randy Dunlap485bb992006-06-23 02:03:49 -07002081/**
Jan Kara72b045a2017-11-15 17:34:33 -08002082 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07002083 * @mapping: the address_space to search
2084 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002085 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002086 * @tag: the tag index
2087 * @nr_pages: the maximum number of pages
2088 * @pages: where the resulting pages are placed
2089 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07002091 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08002092 *
2093 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 */
Jan Kara72b045a2017-11-15 17:34:33 -08002095unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002096 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002097 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002099 XA_STATE(xas, &mapping->i_pages, *index);
2100 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002101 unsigned ret = 0;
2102
2103 if (unlikely(!nr_pages))
2104 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
Nick Piggina60637c2008-07-25 19:45:31 -07002106 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002107 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002108 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07002109 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002110 /*
2111 * Shadow entries should never be tagged, but this iteration
2112 * is lockless so there is a window for page reclaim to evict
2113 * a page we saw tagged. Skip over it.
2114 */
2115 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002116 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002117
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002118 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002119 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002120
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002121 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002122 if (unlikely(page != xas_reload(&xas)))
2123 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002124
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002125 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08002126 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002127 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08002128 goto out;
2129 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002130 continue;
2131put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002132 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002133retry:
2134 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002135 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002136
Jan Kara72b045a2017-11-15 17:34:33 -08002137 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002138 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002139 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002140 * iteration when there is a page at index -1 but that is already
2141 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002142 */
2143 if (end == (pgoff_t)-1)
2144 *index = (pgoff_t)-1;
2145 else
2146 *index = end + 1;
2147out:
Nick Piggina60637c2008-07-25 19:45:31 -07002148 rcu_read_unlock();
2149
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 return ret;
2151}
Jan Kara72b045a2017-11-15 17:34:33 -08002152EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002154/*
2155 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2156 * a _large_ part of the i/o request. Imagine the worst scenario:
2157 *
2158 * ---R__________________________________________B__________
2159 * ^ reading here ^ bad block(assume 4k)
2160 *
2161 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2162 * => failing the whole request => read(R) => read(R+1) =>
2163 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2164 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2165 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2166 *
2167 * It is going insane. Fix it by quickly scaling down the readahead size.
2168 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002169static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002170{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002171 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002172}
2173
Randy Dunlap485bb992006-06-23 02:03:49 -07002174/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002175 * generic_file_buffered_read - generic file read routine
2176 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05002177 * @iter: data destination
2178 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07002179 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07002181 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182 *
2183 * This is really ugly. But the goto's actually try to clarify some
2184 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002185 *
2186 * Return:
2187 * * total number of bytes copied, including those the were already @written
2188 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002190ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002191 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002193 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002194 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002196 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002197 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002198 pgoff_t index;
2199 pgoff_t last_index;
2200 pgoff_t prev_index;
2201 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002202 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002203 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204
Wei Fangc2a97372016-10-07 17:01:52 -07002205 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002206 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002207 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2208
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002209 index = *ppos >> PAGE_SHIFT;
2210 prev_index = ra->prev_pos >> PAGE_SHIFT;
2211 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2212 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2213 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214
Jens Axboe13bd6912020-10-17 08:31:29 -06002215 /*
2216 * If we've already successfully copied some data, then we
2217 * can no longer safely return -EIOCBQUEUED. Hence mark
2218 * an async read NOWAIT at that point.
2219 */
2220 if (written && (iocb->ki_flags & IOCB_WAITQ))
2221 iocb->ki_flags |= IOCB_NOWAIT;
2222
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 for (;;) {
2224 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002225 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002226 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227 unsigned long nr, ret;
2228
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002231 if (fatal_signal_pending(current)) {
2232 error = -EINTR;
2233 goto out;
2234 }
2235
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002237 if (!page) {
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002238 if (iocb->ki_flags & IOCB_NOIO)
Milosz Tanski3239d832017-08-29 16:13:19 +02002239 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002240 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002241 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002242 index, last_index - index);
2243 page = find_get_page(mapping, index);
2244 if (unlikely(page == NULL))
2245 goto no_cached_page;
2246 }
2247 if (PageReadahead(page)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002248 if (iocb->ki_flags & IOCB_NOIO) {
2249 put_page(page);
2250 goto out;
2251 }
Rusty Russellcf914a72007-07-19 01:48:08 -07002252 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002253 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002254 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002256 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07002257 /*
2258 * See comment in do_read_cache_page on why
2259 * wait_on_page_locked is used to avoid unnecessarily
2260 * serialisations and why it's safe.
2261 */
Jens Axboe1a0a7852020-05-22 09:18:38 -06002262 if (iocb->ki_flags & IOCB_WAITQ) {
2263 if (written) {
2264 put_page(page);
2265 goto out;
2266 }
2267 error = wait_on_page_locked_async(page,
2268 iocb->ki_waitq);
2269 } else {
2270 if (iocb->ki_flags & IOCB_NOWAIT) {
2271 put_page(page);
2272 goto would_block;
2273 }
2274 error = wait_on_page_locked_killable(page);
2275 }
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002276 if (unlikely(error))
2277 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002278 if (PageUptodate(page))
2279 goto page_ok;
2280
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002281 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002282 !mapping->a_ops->is_partially_uptodate)
2283 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002284 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002285 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002286 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002287 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002288 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002289 /* Did it get truncated before we got the lock? */
2290 if (!page->mapping)
2291 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002292 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002293 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002294 goto page_not_up_to_date_locked;
2295 unlock_page(page);
2296 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002297page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002298 /*
2299 * i_size must be checked after we know the page is Uptodate.
2300 *
2301 * Checking i_size after the check allows us to calculate
2302 * the correct value for "nr", which means the zero-filled
2303 * part of the page is not copied back to userspace (unless
2304 * another truncate extends the file - this is desired though).
2305 */
2306
2307 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002308 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002309 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002310 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002311 goto out;
2312 }
2313
2314 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002315 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002316 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002317 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002318 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002319 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002320 goto out;
2321 }
2322 }
2323 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324
2325 /* If users can be writing to this page using arbitrary
2326 * virtual addresses, take care about potential aliasing
2327 * before reading the page on the kernel side.
2328 */
2329 if (mapping_writably_mapped(mapping))
2330 flush_dcache_page(page);
2331
2332 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002333 * When a sequential read accesses a page several times,
2334 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002335 */
Jan Karaec0f1632007-05-06 14:49:25 -07002336 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002337 mark_page_accessed(page);
2338 prev_index = index;
2339
2340 /*
2341 * Ok, we have the page, and it's up-to-date, so
2342 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002343 */
Al Viro6e58e792014-02-03 17:07:03 -05002344
2345 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002346 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002347 index += offset >> PAGE_SHIFT;
2348 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002349 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002351 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002352 written += ret;
2353 if (!iov_iter_count(iter))
2354 goto out;
2355 if (ret < nr) {
2356 error = -EFAULT;
2357 goto out;
2358 }
2359 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002360
2361page_not_up_to_date:
2362 /* Get exclusive access to the page ... */
Jens Axboe0abed7c2020-11-16 13:36:24 -07002363 if (iocb->ki_flags & IOCB_WAITQ) {
2364 if (written) {
2365 put_page(page);
2366 goto out;
2367 }
Jens Axboe1a0a7852020-05-22 09:18:38 -06002368 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002369 } else {
Jens Axboe1a0a7852020-05-22 09:18:38 -06002370 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002371 }
Oleg Nesterov85462322008-06-08 21:20:43 +04002372 if (unlikely(error))
2373 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002374
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002375page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002376 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002377 if (!page->mapping) {
2378 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002379 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002380 continue;
2381 }
2382
2383 /* Did somebody else fill it already? */
2384 if (PageUptodate(page)) {
2385 unlock_page(page);
2386 goto page_ok;
2387 }
2388
2389readpage:
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002390 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002391 unlock_page(page);
2392 put_page(page);
2393 goto would_block;
2394 }
Jeff Moyer91803b42010-05-26 11:49:40 -04002395 /*
2396 * A previous I/O error may have been due to temporary
2397 * failures, eg. multipath errors.
2398 * PG_error will be set again if readpage fails.
2399 */
2400 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002401 /* Start the actual read. The read will unlock the page. */
2402 error = mapping->a_ops->readpage(filp, page);
2403
Zach Brown994fc28c2005-12-15 14:28:17 -08002404 if (unlikely(error)) {
2405 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002406 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002407 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002408 goto find_page;
2409 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002410 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002411 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002412
2413 if (!PageUptodate(page)) {
Jens Axboe0abed7c2020-11-16 13:36:24 -07002414 if (iocb->ki_flags & IOCB_WAITQ) {
2415 if (written) {
2416 put_page(page);
2417 goto out;
2418 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002419 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002420 } else {
Hao Xuc8d317a2020-09-29 20:00:45 +08002421 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002422 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002423
Oleg Nesterov85462322008-06-08 21:20:43 +04002424 if (unlikely(error))
2425 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002426 if (!PageUptodate(page)) {
2427 if (page->mapping == NULL) {
2428 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002429 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 */
2431 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002432 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002433 goto find_page;
2434 }
2435 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002436 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002437 error = -EIO;
2438 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 }
2440 unlock_page(page);
2441 }
2442
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 goto page_ok;
2444
2445readpage_error:
2446 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002447 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002448 goto out;
2449
2450no_cached_page:
2451 /*
2452 * Ok, it wasn't cached, so we need to create a new
2453 * page..
2454 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002455 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002456 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002457 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002458 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002460 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002461 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002462 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002463 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002464 if (error == -EEXIST) {
2465 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002466 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002467 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 goto out;
2469 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470 goto readpage;
2471 }
2472
Milosz Tanski3239d832017-08-29 16:13:19 +02002473would_block:
2474 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002476 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002477 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002478 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002480 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002481 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002482 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002484EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002485
Randy Dunlap485bb992006-06-23 02:03:49 -07002486/**
Al Viro6abd2322014-04-04 14:20:57 -04002487 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002488 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002489 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002490 *
Al Viro6abd2322014-04-04 14:20:57 -04002491 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002493 *
2494 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2495 * be returned when no data can be read without waiting for I/O requests
2496 * to complete; it doesn't prevent readahead.
2497 *
2498 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2499 * requests shall be made for the read or for readahead. When no data
2500 * can be read, -EAGAIN shall be returned. When readahead would be
2501 * triggered, a partial, possibly empty read shall be returned.
2502 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002503 * Return:
2504 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002505 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 */
2507ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002508generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002510 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002511 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002512
2513 if (!count)
2514 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515
Al Viro2ba48ce2015-04-09 13:52:01 -04002516 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002517 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002518 struct address_space *mapping = file->f_mapping;
2519 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002520 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002523 if (iocb->ki_flags & IOCB_NOWAIT) {
2524 if (filemap_range_has_page(mapping, iocb->ki_pos,
2525 iocb->ki_pos + count - 1))
2526 return -EAGAIN;
2527 } else {
2528 retval = filemap_write_and_wait_range(mapping,
2529 iocb->ki_pos,
2530 iocb->ki_pos + count - 1);
2531 if (retval < 0)
2532 goto out;
2533 }
Al Viroed978a82014-03-05 22:53:04 -05002534
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002535 file_accessed(file);
2536
Al Viro5ecda132017-04-13 14:13:36 -04002537 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002538 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002539 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002540 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002541 }
Al Viro5b47d592017-05-08 13:54:47 -04002542 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002543
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002544 /*
2545 * Btrfs can have a short DIO read if we encounter
2546 * compressed extents, so if there was an error, or if
2547 * we've already read everything we wanted to, or if
2548 * there was a short read because we hit EOF, go ahead
2549 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002550 * the rest of the read. Buffered reads will not work for
2551 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002552 */
Al Viro5ecda132017-04-13 14:13:36 -04002553 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002554 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002555 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 }
2557
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002558 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559out:
2560 return retval;
2561}
Al Viroed978a82014-03-05 22:53:04 -05002562EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002566/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002567 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002568 * @vmf - the vm_fault for this fault.
2569 * @page - the page to lock.
2570 * @fpin - the pointer to the file we may pin (or is already pinned).
2571 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002572 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002573 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002574 * if it couldn't lock the page. If we did have to drop the mmap_lock then fpin
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002575 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002576 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002577static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2578 struct file **fpin)
2579{
2580 if (trylock_page(page))
2581 return 1;
2582
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002583 /*
2584 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002585 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002586 * is supposed to work. We have way too many special cases..
2587 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002588 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2589 return 0;
2590
2591 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2592 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2593 if (__lock_page_killable(page)) {
2594 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002595 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002596 * but all fault_handlers only check for fatal signals
2597 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002598 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002599 */
2600 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002601 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002602 return 0;
2603 }
2604 } else
2605 __lock_page(page);
2606 return 1;
2607}
2608
2609
2610/*
2611 * Synchronous readahead happens when we don't even find a page in the page
2612 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2613 * to drop the mmap sem we return the file that was pinned in order for us to do
2614 * that. If we didn't pin a file then we return NULL. The file that is
2615 * returned needs to be fput()'ed when we're done with it.
2616 */
2617static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002618{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002619 struct file *file = vmf->vma->vm_file;
2620 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002621 struct address_space *mapping = file->f_mapping;
David Howellsdb660d42020-10-15 20:06:31 -07002622 DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002623 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002624 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002625
2626 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002627 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002628 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002629 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002630 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002631
Josef Bacik2a1180f2019-03-13 11:44:18 -07002632 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002633 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002634 page_cache_sync_ra(&ractl, ra, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002635 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002636 }
2637
Andi Kleen207d04b2011-05-24 17:12:29 -07002638 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002639 mmap_miss = READ_ONCE(ra->mmap_miss);
2640 if (mmap_miss < MMAP_LOTSAMISS * 10)
2641 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002642
2643 /*
2644 * Do we miss much more than hit in this file? If so,
2645 * stop bothering with read-ahead. It will only hurt.
2646 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002647 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002648 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002649
Wu Fengguangd30a1102009-06-16 15:31:30 -07002650 /*
2651 * mmap read-around
2652 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002653 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002654 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002655 ra->size = ra->ra_pages;
2656 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002657 ractl._index = ra->start;
2658 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002659 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002660}
2661
2662/*
2663 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002664 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002665 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002666 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002667static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2668 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002669{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002670 struct file *file = vmf->vma->vm_file;
2671 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002672 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002673 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002674 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002675 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002676
2677 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002678 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002679 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002680 mmap_miss = READ_ONCE(ra->mmap_miss);
2681 if (mmap_miss)
2682 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002683 if (PageReadahead(page)) {
2684 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002685 page_cache_async_readahead(mapping, ra, file,
2686 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002687 }
2688 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002689}
2690
Randy Dunlap485bb992006-06-23 02:03:49 -07002691/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002692 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002693 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002694 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002695 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696 * mapped memory region to read in file data during a page fault.
2697 *
2698 * The goto's are kind of ugly, but this streamlines the normal case of having
2699 * it in the page cache, and handles the special cases reasonably without
2700 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002701 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002702 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002703 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002704 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002705 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002706 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002707 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002708 * has not been released.
2709 *
2710 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002711 *
2712 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002713 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002714vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002715{
2716 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002717 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002718 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002719 struct address_space *mapping = file->f_mapping;
2720 struct file_ra_state *ra = &file->f_ra;
2721 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002722 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002723 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002725 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002727 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2728 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002729 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002732 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002733 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002734 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002735 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002737 * We found the page, so try async readahead before
2738 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002739 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002740 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002741 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002742 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002743 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002744 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002745 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002746 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002747retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002748 page = pagecache_get_page(mapping, offset,
2749 FGP_CREAT|FGP_FOR_MMAP,
2750 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002751 if (!page) {
2752 if (fpin)
2753 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002754 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002755 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 }
2757
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002758 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2759 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002760
2761 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002762 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002763 unlock_page(page);
2764 put_page(page);
2765 goto retry_find;
2766 }
Song Liu520e5ba2019-09-23 15:37:50 -07002767 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002768
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002770 * We have a locked page in the page cache, now we need to check
2771 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 */
Nick Piggind00806b2007-07-19 01:46:57 -07002773 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774 goto page_not_uptodate;
2775
Linus Torvaldsef00e082009-06-16 15:31:25 -07002776 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002777 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002778 * time to return to the upper layer and have it re-find the vma and
2779 * redo the fault.
2780 */
2781 if (fpin) {
2782 unlock_page(page);
2783 goto out_retry;
2784 }
2785
2786 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002787 * Found the page and have a reference on it.
2788 * We must recheck i_size under page lock.
2789 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002790 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2791 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002792 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002793 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002794 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002795 }
2796
Nick Piggind0217ac2007-07-19 01:47:03 -07002797 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002798 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 /*
2802 * Umm, take care of errors if the page isn't up-to-date.
2803 * Try to re-read it _once_. We do this synchronously,
2804 * because there really aren't any performance issues here
2805 * and we need to check for errors.
2806 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002808 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002809 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002810 if (!error) {
2811 wait_on_page_locked(page);
2812 if (!PageUptodate(page))
2813 error = -EIO;
2814 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002815 if (fpin)
2816 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002817 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002818
2819 if (!error || error == AOP_TRUNCATED_PAGE)
2820 goto retry_find;
2821
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002822 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002823 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002824
2825out_retry:
2826 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002827 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002828 * re-find the vma and come back and find our hopefully still populated
2829 * page.
2830 */
2831 if (page)
2832 put_page(page);
2833 if (fpin)
2834 fput(fpin);
2835 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002836}
2837EXPORT_SYMBOL(filemap_fault);
2838
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002839static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002840{
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002841 struct mm_struct *mm = vmf->vma->vm_mm;
2842
2843 /* Huge page is mapped? No need to proceed. */
2844 if (pmd_trans_huge(*vmf->pmd)) {
2845 unlock_page(page);
2846 put_page(page);
2847 return true;
2848 }
2849
2850 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
2851 vm_fault_t ret = do_set_pmd(vmf, page);
2852 if (!ret) {
2853 /* The page is mapped successfully, reference consumed. */
2854 unlock_page(page);
2855 return true;
2856 }
2857 }
2858
2859 if (pmd_none(*vmf->pmd)) {
2860 vmf->ptl = pmd_lock(mm, vmf->pmd);
2861 if (likely(pmd_none(*vmf->pmd))) {
2862 mm_inc_nr_ptes(mm);
2863 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
2864 vmf->prealloc_pte = NULL;
2865 }
2866 spin_unlock(vmf->ptl);
2867 }
2868
2869 /* See comment in handle_pte_fault() */
2870 if (pmd_devmap_trans_unstable(vmf->pmd)) {
2871 unlock_page(page);
2872 put_page(page);
2873 return true;
2874 }
2875
2876 return false;
2877}
2878
2879static struct page *next_uptodate_page(struct page *page,
2880 struct address_space *mapping,
2881 struct xa_state *xas, pgoff_t end_pgoff)
2882{
2883 unsigned long max_idx;
2884
2885 do {
2886 if (!page)
2887 return NULL;
2888 if (xas_retry(xas, page))
2889 continue;
2890 if (xa_is_value(page))
2891 continue;
2892 if (PageLocked(page))
2893 continue;
2894 if (!page_cache_get_speculative(page))
2895 continue;
2896 /* Has the page moved or been split? */
2897 if (unlikely(page != xas_reload(xas)))
2898 goto skip;
2899 if (!PageUptodate(page) || PageReadahead(page))
2900 goto skip;
2901 if (PageHWPoison(page))
2902 goto skip;
2903 if (!trylock_page(page))
2904 goto skip;
2905 if (page->mapping != mapping)
2906 goto unlock;
2907 if (!PageUptodate(page))
2908 goto unlock;
2909 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2910 if (xas->xa_index >= max_idx)
2911 goto unlock;
2912 return page;
2913unlock:
2914 unlock_page(page);
2915skip:
2916 put_page(page);
2917 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
2918
2919 return NULL;
2920}
2921
2922static inline struct page *first_map_page(struct address_space *mapping,
2923 struct xa_state *xas,
2924 pgoff_t end_pgoff)
2925{
2926 return next_uptodate_page(xas_find(xas, end_pgoff),
2927 mapping, xas, end_pgoff);
2928}
2929
2930static inline struct page *next_map_page(struct address_space *mapping,
2931 struct xa_state *xas,
2932 pgoff_t end_pgoff)
2933{
2934 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
2935 mapping, xas, end_pgoff);
2936}
2937
2938vm_fault_t filemap_map_pages(struct vm_fault *vmf,
2939 pgoff_t start_pgoff, pgoff_t end_pgoff)
2940{
2941 struct vm_area_struct *vma = vmf->vma;
2942 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002943 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002944 pgoff_t last_pgoff = start_pgoff;
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002945 unsigned long address = vmf->address;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002946 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002947 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002948 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002949 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002950
2951 rcu_read_lock();
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002952 head = first_map_page(mapping, &xas, end_pgoff);
2953 if (!head)
2954 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002955
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002956 if (filemap_map_pmd(vmf, head)) {
2957 ret = VM_FAULT_NOPAGE;
2958 goto out;
2959 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002960
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002961 vmf->address = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
2962 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, vmf->address, &vmf->ptl);
2963 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002964 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002965 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002966 goto unlock;
2967
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002968 if (mmap_miss > 0)
2969 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002970
Matthew Wilcox070e8072018-05-17 00:08:30 -04002971 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002972 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002973 last_pgoff = xas.xa_index;
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002974
2975 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002976 goto unlock;
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002977
2978 do_set_pte(vmf, page);
2979 /* no need to invalidate: a not-present page won't be cached */
2980 update_mmu_cache(vma, vmf->address, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002981 unlock_page(head);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002982
2983 /* The fault is handled */
2984 if (vmf->address == address)
2985 ret = VM_FAULT_NOPAGE;
2986 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002987unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002988 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002989 put_page(head);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002990 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
2991 pte_unmap_unlock(vmf->pte, vmf->ptl);
2992out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002993 rcu_read_unlock();
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002994 vmf->address = address;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002995 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002996 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002997}
2998EXPORT_SYMBOL(filemap_map_pages);
2999
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003000vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003001{
3002 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08003003 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003004 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003005
Jan Kara14da9202012-06-12 16:20:37 +02003006 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003007 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003008 lock_page(page);
3009 if (page->mapping != inode->i_mapping) {
3010 unlock_page(page);
3011 ret = VM_FAULT_NOPAGE;
3012 goto out;
3013 }
Jan Kara14da9202012-06-12 16:20:37 +02003014 /*
3015 * We mark the page dirty already here so that when freeze is in
3016 * progress, we are guaranteed that writeback during freezing will
3017 * see the dirty page and writeprotect it again.
3018 */
3019 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003020 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003021out:
Jan Kara14da9202012-06-12 16:20:37 +02003022 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003023 return ret;
3024}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003025
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003026const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003027 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003028 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003029 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030};
3031
3032/* This is used for a general mmap of a disk file */
3033
3034int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3035{
3036 struct address_space *mapping = file->f_mapping;
3037
3038 if (!mapping->a_ops->readpage)
3039 return -ENOEXEC;
3040 file_accessed(file);
3041 vma->vm_ops = &generic_file_vm_ops;
3042 return 0;
3043}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044
3045/*
3046 * This is for filesystems which do not implement ->writepage.
3047 */
3048int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3049{
3050 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3051 return -EINVAL;
3052 return generic_file_mmap(file, vma);
3053}
3054#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003055vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann45397222018-04-13 15:35:27 -07003056{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003057 return VM_FAULT_SIGBUS;
Arnd Bergmann45397222018-04-13 15:35:27 -07003058}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3060{
3061 return -ENOSYS;
3062}
3063int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
3064{
3065 return -ENOSYS;
3066}
3067#endif /* CONFIG_MMU */
3068
Arnd Bergmann45397222018-04-13 15:35:27 -07003069EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070EXPORT_SYMBOL(generic_file_mmap);
3071EXPORT_SYMBOL(generic_file_readonly_mmap);
3072
Sasha Levin67f9fd92014-04-03 14:48:18 -07003073static struct page *wait_on_page_read(struct page *page)
3074{
3075 if (!IS_ERR(page)) {
3076 wait_on_page_locked(page);
3077 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003078 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003079 page = ERR_PTR(-EIO);
3080 }
3081 }
3082 return page;
3083}
3084
Mel Gorman32b63522016-03-15 14:55:36 -07003085static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003086 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003087 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003088 void *data,
3089 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090{
Nick Piggineb2be182007-10-16 01:24:57 -07003091 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092 int err;
3093repeat:
3094 page = find_get_page(mapping, index);
3095 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003096 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003097 if (!page)
3098 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003099 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003100 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003101 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003102 if (err == -EEXIST)
3103 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003104 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105 return ERR_PTR(err);
3106 }
Mel Gorman32b63522016-03-15 14:55:36 -07003107
3108filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003109 if (filler)
3110 err = filler(data, page);
3111 else
3112 err = mapping->a_ops->readpage(data, page);
3113
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003115 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003116 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117 }
Mel Gorman32b63522016-03-15 14:55:36 -07003118
3119 page = wait_on_page_read(page);
3120 if (IS_ERR(page))
3121 return page;
3122 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003123 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124 if (PageUptodate(page))
3125 goto out;
3126
Mel Gormanebded022016-03-15 14:55:39 -07003127 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003128 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003129 * case a: Page is being filled and the page lock is held
3130 * case b: Read/write error clearing the page uptodate status
3131 * case c: Truncation in progress (page locked)
3132 * case d: Reclaim in progress
3133 *
3134 * Case a, the page will be up to date when the page is unlocked.
3135 * There is no need to serialise on the page lock here as the page
3136 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003137 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003138 * it's a race vs truncate race.
3139 * Case b, the page will not be up to date
3140 * Case c, the page may be truncated but in itself, the data may still
3141 * be valid after IO completes as it's a read vs truncate race. The
3142 * operation must restart if the page is not uptodate on unlock but
3143 * otherwise serialising on page lock to stabilise the mapping gives
3144 * no additional guarantees to the caller as the page lock is
3145 * released before return.
3146 * Case d, similar to truncation. If reclaim holds the page lock, it
3147 * will be a race with remove_mapping that determines if the mapping
3148 * is valid on unlock but otherwise the data is valid and there is
3149 * no need to serialise with page lock.
3150 *
3151 * As the page lock gives no additional guarantee, we optimistically
3152 * wait on the page to be unlocked and check if it's up to date and
3153 * use the page if it is. Otherwise, the page lock is required to
3154 * distinguish between the different cases. The motivation is that we
3155 * avoid spurious serialisations and wakeups when multiple processes
3156 * wait on the same page for IO to complete.
3157 */
3158 wait_on_page_locked(page);
3159 if (PageUptodate(page))
3160 goto out;
3161
3162 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003164
3165 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166 if (!page->mapping) {
3167 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003168 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003169 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170 }
Mel Gormanebded022016-03-15 14:55:39 -07003171
3172 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173 if (PageUptodate(page)) {
3174 unlock_page(page);
3175 goto out;
3176 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003177
3178 /*
3179 * A previous I/O error may have been due to temporary
3180 * failures.
3181 * Clear page error before actual read, PG_error will be
3182 * set again if read page fails.
3183 */
3184 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003185 goto filler;
3186
David Howellsc855ff32007-05-09 13:42:20 +01003187out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003188 mark_page_accessed(page);
3189 return page;
3190}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003191
3192/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003193 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003194 * @mapping: the page's address_space
3195 * @index: the page index
3196 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003197 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003198 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003199 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003200 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003201 *
3202 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003203 *
3204 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003205 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003206struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003207 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003208 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003209 void *data)
3210{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003211 return do_read_cache_page(mapping, index, filler, data,
3212 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003213}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003214EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003215
3216/**
3217 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3218 * @mapping: the page's address_space
3219 * @index: the page index
3220 * @gfp: the page allocator flags to use if allocating
3221 *
3222 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003223 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003224 *
3225 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003226 *
3227 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003228 */
3229struct page *read_cache_page_gfp(struct address_space *mapping,
3230 pgoff_t index,
3231 gfp_t gfp)
3232{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003233 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003234}
3235EXPORT_SYMBOL(read_cache_page_gfp);
3236
Nick Pigginafddba42007-10-16 01:25:01 -07003237int pagecache_write_begin(struct file *file, struct address_space *mapping,
3238 loff_t pos, unsigned len, unsigned flags,
3239 struct page **pagep, void **fsdata)
3240{
3241 const struct address_space_operations *aops = mapping->a_ops;
3242
Nick Piggin4e02ed42008-10-29 14:00:55 -07003243 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003244 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003245}
3246EXPORT_SYMBOL(pagecache_write_begin);
3247
3248int pagecache_write_end(struct file *file, struct address_space *mapping,
3249 loff_t pos, unsigned len, unsigned copied,
3250 struct page *page, void *fsdata)
3251{
3252 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003253
Nick Piggin4e02ed42008-10-29 14:00:55 -07003254 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003255}
3256EXPORT_SYMBOL(pagecache_write_end);
3257
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003258/*
3259 * Warn about a page cache invalidation failure during a direct I/O write.
3260 */
3261void dio_warn_stale_pagecache(struct file *filp)
3262{
3263 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3264 char pathname[128];
3265 struct inode *inode = file_inode(filp);
3266 char *path;
3267
3268 errseq_set(&inode->i_mapping->wb_err, -EIO);
3269 if (__ratelimit(&_rs)) {
3270 path = file_path(filp, pathname, sizeof(pathname));
3271 if (IS_ERR(path))
3272 path = "(unknown)";
3273 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3274 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3275 current->comm);
3276 }
3277}
3278
Linus Torvalds1da177e2005-04-16 15:20:36 -07003279ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003280generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281{
3282 struct file *file = iocb->ki_filp;
3283 struct address_space *mapping = file->f_mapping;
3284 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003285 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003286 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003287 size_t write_len;
3288 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289
Al Viro0c949332014-03-22 06:51:37 -04003290 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003291 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003292
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003293 if (iocb->ki_flags & IOCB_NOWAIT) {
3294 /* If there are pages to writeback, return */
3295 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003296 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003297 return -EAGAIN;
3298 } else {
3299 written = filemap_write_and_wait_range(mapping, pos,
3300 pos + write_len - 1);
3301 if (written)
3302 goto out;
3303 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003304
3305 /*
3306 * After a write we want buffered reads to be sure to go to disk to get
3307 * the new data. We invalidate clean cached page from the region we're
3308 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003309 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003310 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003311 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003312 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003313 /*
3314 * If a page can not be invalidated, return 0 to fall back
3315 * to buffered write.
3316 */
3317 if (written) {
3318 if (written == -EBUSY)
3319 return 0;
3320 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003321 }
3322
Al Viro639a93a52017-04-13 14:10:15 -04003323 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003324
3325 /*
3326 * Finally, try again to invalidate clean pages which might have been
3327 * cached by non-direct readahead, or faulted in by get_user_pages()
3328 * if the source of the write was an mmap'ed region of the file
3329 * we're writing. Either one is a pretty crazy thing to do,
3330 * so we don't support it 100%. If this invalidation
3331 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003332 *
3333 * Most of the time we do not need this since dio_complete() will do
3334 * the invalidation for us. However there are some file systems that
3335 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003336 * them by removing it completely.
3337 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003338 * Noticeable example is a blkdev_direct_IO().
3339 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003340 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003341 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003342 if (written > 0 && mapping->nrpages &&
3343 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3344 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003345
Linus Torvalds1da177e2005-04-16 15:20:36 -07003346 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003347 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003348 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003349 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3350 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003351 mark_inode_dirty(inode);
3352 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003353 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003354 }
Al Viro639a93a52017-04-13 14:10:15 -04003355 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003356out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003357 return written;
3358}
3359EXPORT_SYMBOL(generic_file_direct_write);
3360
Nick Piggineb2be182007-10-16 01:24:57 -07003361/*
3362 * Find or create a page at the given pagecache position. Return the locked
3363 * page. This function is specifically for buffered writes.
3364 */
Nick Piggin54566b22009-01-04 12:00:53 -08003365struct page *grab_cache_page_write_begin(struct address_space *mapping,
3366 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003367{
Nick Piggineb2be182007-10-16 01:24:57 -07003368 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003369 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003370
Nick Piggin54566b22009-01-04 12:00:53 -08003371 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003372 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003373
Mel Gorman2457aec2014-06-04 16:10:31 -07003374 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003375 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003376 if (page)
3377 wait_for_stable_page(page);
3378
Nick Piggineb2be182007-10-16 01:24:57 -07003379 return page;
3380}
Nick Piggin54566b22009-01-04 12:00:53 -08003381EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003382
Al Viro3b93f912014-02-11 21:34:08 -05003383ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003384 struct iov_iter *i, loff_t pos)
3385{
3386 struct address_space *mapping = file->f_mapping;
3387 const struct address_space_operations *a_ops = mapping->a_ops;
3388 long status = 0;
3389 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003390 unsigned int flags = 0;
3391
Nick Pigginafddba42007-10-16 01:25:01 -07003392 do {
3393 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003394 unsigned long offset; /* Offset into pagecache page */
3395 unsigned long bytes; /* Bytes to write to page */
3396 size_t copied; /* Bytes copied from user */
3397 void *fsdata;
3398
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003399 offset = (pos & (PAGE_SIZE - 1));
3400 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003401 iov_iter_count(i));
3402
3403again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003404 /*
3405 * Bring in the user page that we will copy from _first_.
3406 * Otherwise there's a nasty deadlock on copying from the
3407 * same page as we're writing to, without it being marked
3408 * up-to-date.
3409 *
3410 * Not only is this an optimisation, but it is also required
3411 * to check that the address is actually valid, when atomic
3412 * usercopies are used, below.
3413 */
3414 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3415 status = -EFAULT;
3416 break;
3417 }
3418
Jan Kara296291c2015-10-22 13:32:21 -07003419 if (fatal_signal_pending(current)) {
3420 status = -EINTR;
3421 break;
3422 }
3423
Nick Piggin674b8922007-10-16 01:25:03 -07003424 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003425 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003426 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003427 break;
3428
anfei zhou931e80e2010-02-02 13:44:02 -08003429 if (mapping_writably_mapped(mapping))
3430 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003431
Nick Pigginafddba42007-10-16 01:25:01 -07003432 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003433 flush_dcache_page(page);
3434
3435 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3436 page, fsdata);
3437 if (unlikely(status < 0))
3438 break;
3439 copied = status;
3440
3441 cond_resched();
3442
Nick Piggin124d3b72008-02-02 15:01:17 +01003443 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003444 if (unlikely(copied == 0)) {
3445 /*
3446 * If we were unable to copy any data at all, we must
3447 * fall back to a single segment length write.
3448 *
3449 * If we didn't fallback here, we could livelock
3450 * because not all segments in the iov can be copied at
3451 * once without a pagefault.
3452 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003453 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003454 iov_iter_single_seg_count(i));
3455 goto again;
3456 }
Nick Pigginafddba42007-10-16 01:25:01 -07003457 pos += copied;
3458 written += copied;
3459
3460 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003461 } while (iov_iter_count(i));
3462
3463 return written ? written : status;
3464}
Al Viro3b93f912014-02-11 21:34:08 -05003465EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
Jan Karae4dd9de2009-08-17 18:10:06 +02003467/**
Al Viro81742022014-04-03 03:17:43 -04003468 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003469 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003470 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003471 *
3472 * This function does all the work needed for actually writing data to a
3473 * file. It does all basic checks, removes SUID from the file, updates
3474 * modification times and calls proper subroutines depending on whether we
3475 * do direct IO or a standard buffered write.
3476 *
3477 * It expects i_mutex to be grabbed unless we work on a block device or similar
3478 * object which does not need locking at all.
3479 *
3480 * This function does *not* take care of syncing data in case of O_SYNC write.
3481 * A caller has to handle it. This is mainly due to the fact that we want to
3482 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003483 *
3484 * Return:
3485 * * number of bytes written, even for truncated writes
3486 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003487 */
Al Viro81742022014-04-03 03:17:43 -04003488ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489{
3490 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003491 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003493 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003495 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003498 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003499 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500 if (err)
3501 goto out;
3502
Josef Bacikc3b2da32012-03-26 09:59:21 -04003503 err = file_update_time(file);
3504 if (err)
3505 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003506
Al Viro2ba48ce2015-04-09 13:52:01 -04003507 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003508 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003509
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003510 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003511 /*
3512 * If the write stopped short of completing, fall back to
3513 * buffered writes. Some filesystems do this for writes to
3514 * holes, for example. For DAX files, a buffered write will
3515 * not succeed (even if it did, DAX does not handle dirty
3516 * page-cache pages correctly).
3517 */
Al Viro0b8def92015-04-07 10:22:53 -04003518 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003520
Al Viro0b8def92015-04-07 10:22:53 -04003521 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003522 /*
Al Viro3b93f912014-02-11 21:34:08 -05003523 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003524 * then we want to return the number of bytes which were
3525 * direct-written, or the error code if that was zero. Note
3526 * that this differs from normal direct-io semantics, which
3527 * will return -EFOO even if some bytes were written.
3528 */
Al Viro60bb4522014-08-08 12:39:16 -04003529 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003530 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003531 goto out;
3532 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003533 /*
3534 * We need to ensure that the page cache pages are written to
3535 * disk and invalidated to preserve the expected O_DIRECT
3536 * semantics.
3537 */
Al Viro3b93f912014-02-11 21:34:08 -05003538 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003539 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003540 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003541 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003542 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003543 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003544 pos >> PAGE_SHIFT,
3545 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003546 } else {
3547 /*
3548 * We don't know how much we wrote, so just return
3549 * the number of bytes which were direct-written
3550 */
3551 }
3552 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003553 written = generic_perform_write(file, from, iocb->ki_pos);
3554 if (likely(written > 0))
3555 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003556 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003557out:
3558 current->backing_dev_info = NULL;
3559 return written ? written : err;
3560}
Al Viro81742022014-04-03 03:17:43 -04003561EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562
Jan Karae4dd9de2009-08-17 18:10:06 +02003563/**
Al Viro81742022014-04-03 03:17:43 -04003564 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003565 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003566 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003567 *
Al Viro81742022014-04-03 03:17:43 -04003568 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003569 * filesystems. It takes care of syncing the file in case of O_SYNC file
3570 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003571 * Return:
3572 * * negative error code if no data has been written at all of
3573 * vfs_fsync_range() failed for a synchronous write
3574 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003575 */
Al Viro81742022014-04-03 03:17:43 -04003576ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577{
3578 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003579 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003581
Al Viro59551022016-01-22 15:40:57 -05003582 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003583 ret = generic_write_checks(iocb, from);
3584 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003585 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003586 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587
Christoph Hellwige2592212016-04-07 08:52:01 -07003588 if (ret > 0)
3589 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 return ret;
3591}
Al Viro81742022014-04-03 03:17:43 -04003592EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593
David Howellscf9a2ae2006-08-29 19:05:54 +01003594/**
3595 * try_to_release_page() - release old fs-specific metadata on a page
3596 *
3597 * @page: the page which the kernel is trying to free
3598 * @gfp_mask: memory allocation flags (and I/O mode)
3599 *
3600 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003601 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003602 *
David Howells266cf652009-04-03 16:42:36 +01003603 * This may also be called if PG_fscache is set on a page, indicating that the
3604 * page is known to the local caching routines.
3605 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003606 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003607 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003608 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003609 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003610 */
3611int try_to_release_page(struct page *page, gfp_t gfp_mask)
3612{
3613 struct address_space * const mapping = page->mapping;
3614
3615 BUG_ON(!PageLocked(page));
3616 if (PageWriteback(page))
3617 return 0;
3618
3619 if (mapping && mapping->a_ops->releasepage)
3620 return mapping->a_ops->releasepage(page, gfp_mask);
3621 return try_to_free_buffers(page);
3622}
3623
3624EXPORT_SYMBOL(try_to_release_page);