blob: 0b2067b3c32831aa1617123b3dc964d479cbd9d1 [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>
Nick Piggin0f8053a2006-03-22 00:08:33 -080045#include "internal.h"
46
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070047#define CREATE_TRACE_POINTS
48#include <trace/events/filemap.h>
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * FIXME: remove all knowledge of the buffer layer from the core VM
52 */
Jan Kara148f9482009-08-17 19:52:36 +020053#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <asm/mman.h>
56
57/*
58 * Shared mappings implemented 30.11.1994. It's not fully working yet,
59 * though.
60 *
61 * Shared mappings now work. 15.8.1995 Bruno.
62 *
63 * finished 'unifying' the page and buffer cache and SMP-threaded the
64 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
65 *
66 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
67 */
68
69/*
70 * Lock ordering:
71 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080072 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070074 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070075 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080077 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080078 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070080 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080081 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070082 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070083 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070085 * ->mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 * ->lock_page (access_process_vm)
87 *
Al Viroccad2362014-02-11 22:36:48 -050088 * ->i_mutex (generic_perform_write)
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070089 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060091 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110092 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070093 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080095 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * ->anon_vma.lock (vma_adjust)
97 *
98 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070099 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700101 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700102 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700104 * ->i_pages lock (try_to_unmap_one)
Andrey Ryabininf4b7e272019-03-05 15:49:39 -0800105 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
106 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700108 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600109 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100110 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700111 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600112 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100113 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
115 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800116 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700117 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 */
119
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500120static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700121 struct page *page, void *shadow)
122{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500123 XA_STATE(xas, &mapping->i_pages, page->index);
124 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800125
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500126 mapping_set_update(&xas, mapping);
127
128 /* hugetlb pages are represented by a single entry in the xarray */
129 if (!PageHuge(page)) {
130 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700131 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500132 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700133
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700134 VM_BUG_ON_PAGE(!PageLocked(page), page);
135 VM_BUG_ON_PAGE(PageTail(page), page);
136 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700137
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500138 xas_store(&xas, shadow);
139 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200140
Jan Kara23006382017-11-15 17:37:26 -0800141 page->mapping = NULL;
142 /* Leave page->index set: truncation lookup relies upon it */
143
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200144 if (shadow) {
145 mapping->nrexceptional += nr;
146 /*
147 * Make sure the nrexceptional update is committed before
148 * the nrpages update so that final truncate racing
149 * with reclaim does not see both counters 0 at the
150 * same time and miss a shadow entry.
151 */
152 smp_wmb();
153 }
154 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700155}
156
Jan Kara5ecc4d82017-11-15 17:37:29 -0800157static void unaccount_page_cache_page(struct address_space *mapping,
158 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800160 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600162 /*
163 * if we're uptodate, flush out into the cleancache, otherwise
164 * invalidate any existing cleancache entries. We can't leave
165 * stale data around in the cleancache once our page is gone
166 */
167 if (PageUptodate(page) && PageMappedToDisk(page))
168 cleancache_put_page(page);
169 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400170 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600171
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700172 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800173 VM_BUG_ON_PAGE(page_mapped(page), page);
174 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
175 int mapcount;
176
177 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
178 current->comm, page_to_pfn(page));
179 dump_page(page, "still mapped when deleted");
180 dump_stack();
181 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
182
183 mapcount = page_mapcount(page);
184 if (mapping_exiting(mapping) &&
185 page_count(page) >= mapcount + 2) {
186 /*
187 * All vmas have already been torn down, so it's
188 * a good bet that actually the page is unmapped,
189 * and we'd prefer not to leak it: if we're wrong,
190 * some other bad page check should catch it later.
191 */
192 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700193 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800194 }
195 }
196
Jan Kara76253fb2017-11-15 17:37:22 -0800197 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800198 if (PageHuge(page))
199 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800200
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700201 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800202
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700203 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800204 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700205 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800206 if (PageTransHuge(page))
207 __dec_node_page_state(page, NR_SHMEM_THPS);
Song Liu99cb0db2019-09-23 15:38:00 -0700208 } else if (PageTransHuge(page)) {
209 __dec_node_page_state(page, NR_FILE_THPS);
Song Liu09d91cd2019-09-23 15:38:03 -0700210 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800211 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800212
213 /*
214 * At this point page must be either written or cleaned by
215 * truncate. Dirty page here signals a bug and loss of
216 * unwritten data.
217 *
218 * This fixes dirty accounting after removing the page entirely
219 * but leaves PageDirty set: it has no effect for truncated
220 * page and anyway will be cleared before returning page into
221 * buddy allocator.
222 */
223 if (WARN_ON_ONCE(PageDirty(page)))
224 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
225}
226
227/*
228 * Delete a page from the page cache and free it. Caller has to make
229 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700230 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800231 */
232void __delete_from_page_cache(struct page *page, void *shadow)
233{
234 struct address_space *mapping = page->mapping;
235
236 trace_mm_filemap_delete_from_page_cache(page);
237
238 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500239 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240}
241
Jan Kara59c66c52017-11-15 17:37:18 -0800242static void page_cache_free_page(struct address_space *mapping,
243 struct page *page)
244{
245 void (*freepage)(struct page *);
246
247 freepage = mapping->a_ops->freepage;
248 if (freepage)
249 freepage(page);
250
251 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700252 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800253 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
254 } else {
255 put_page(page);
256 }
257}
258
Minchan Kim702cfbf2011-03-22 16:32:43 -0700259/**
260 * delete_from_page_cache - delete page from page cache
261 * @page: the page which the kernel is trying to remove from page cache
262 *
263 * This must be called only on pages that have been verified to be in the page
264 * cache and locked. It will never put the page into the free list, the caller
265 * has a reference on the page.
266 */
267void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700269 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400270 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Matt Mackallcd7619d2005-05-01 08:59:01 -0700272 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700273 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700274 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700275 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500276
Jan Kara59c66c52017-11-15 17:37:18 -0800277 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700278}
279EXPORT_SYMBOL(delete_from_page_cache);
280
Jan Karaaa65c292017-11-15 17:37:33 -0800281/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500282 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800283 * @mapping: the mapping to which pages belong
284 * @pvec: pagevec with pages to delete
285 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700286 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700287 * from the mapping. The function expects @pvec to be sorted by page index
288 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700289 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800290 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700291 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800292 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700293 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800294 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500295static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800296 struct pagevec *pvec)
297{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500298 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800299 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700300 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800301 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800302
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500303 mapping_set_update(&xas, mapping);
304 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700305 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800306 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700307
308 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400309 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800310 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700311 /*
312 * A page got inserted in our range? Skip it. We have our
313 * pages locked so they are protected from being removed.
314 * If we see a page whose index is higher than ours, it
315 * means our page has been removed, which shouldn't be
316 * possible because we're holding the PageLock.
317 */
318 if (page != pvec->pages[i]) {
319 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
320 page);
321 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700322 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700323
324 WARN_ON_ONCE(!PageLocked(page));
325
326 if (page->index == xas.xa_index)
327 page->mapping = NULL;
328 /* Leave page->index set: truncation lookup relies on it */
329
330 /*
331 * Move to the next page in the vector if this is a regular
332 * page or the index is of the last sub-page of this compound
333 * page.
334 */
335 if (page->index + compound_nr(page) - 1 == xas.xa_index)
336 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500337 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800338 total_pages++;
339 }
340 mapping->nrpages -= total_pages;
341}
342
343void delete_from_page_cache_batch(struct address_space *mapping,
344 struct pagevec *pvec)
345{
346 int i;
347 unsigned long flags;
348
349 if (!pagevec_count(pvec))
350 return;
351
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700352 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800353 for (i = 0; i < pagevec_count(pvec); i++) {
354 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
355
356 unaccount_page_cache_page(mapping, pvec->pages[i]);
357 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500358 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700359 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800360
361 for (i = 0; i < pagevec_count(pvec); i++)
362 page_cache_free_page(mapping, pvec->pages[i]);
363}
364
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200365int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700366{
367 int ret = 0;
368 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700369 if (test_bit(AS_ENOSPC, &mapping->flags) &&
370 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700371 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700372 if (test_bit(AS_EIO, &mapping->flags) &&
373 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700374 ret = -EIO;
375 return ret;
376}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200377EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700378
Jeff Layton76341ca2017-07-06 07:02:22 -0400379static int filemap_check_and_keep_errors(struct address_space *mapping)
380{
381 /* Check for outstanding write errors */
382 if (test_bit(AS_EIO, &mapping->flags))
383 return -EIO;
384 if (test_bit(AS_ENOSPC, &mapping->flags))
385 return -ENOSPC;
386 return 0;
387}
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700390 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700391 * @mapping: address space structure to write
392 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800393 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700394 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700396 * Start writeback against all of a mapping's dirty pages that lie
397 * within the byte offsets <start, end> inclusive.
398 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700400 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * these two operations is that if a dirty page/buffer is encountered, it must
402 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800403 *
404 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800406int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
407 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
409 int ret;
410 struct writeback_control wbc = {
411 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800412 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700413 .range_start = start,
414 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 };
416
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200417 if (!mapping_can_writeback(mapping) ||
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700418 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 return 0;
420
Tejun Heob16b1de2015-06-02 08:39:48 -0600421 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600423 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 return ret;
425}
426
427static inline int __filemap_fdatawrite(struct address_space *mapping,
428 int sync_mode)
429{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700430 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
432
433int filemap_fdatawrite(struct address_space *mapping)
434{
435 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
436}
437EXPORT_SYMBOL(filemap_fdatawrite);
438
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400439int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800440 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
443}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400444EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Randy Dunlap485bb992006-06-23 02:03:49 -0700446/**
447 * filemap_flush - mostly a non-blocking flush
448 * @mapping: target address_space
449 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 * This is a mostly non-blocking flush. Not suitable for data-integrity
451 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800452 *
453 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 */
455int filemap_flush(struct address_space *mapping)
456{
457 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
458}
459EXPORT_SYMBOL(filemap_flush);
460
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500461/**
462 * filemap_range_has_page - check if a page exists in range.
463 * @mapping: address space within which to check
464 * @start_byte: offset in bytes where the range starts
465 * @end_byte: offset in bytes where the range ends (inclusive)
466 *
467 * Find at least one page in the range supplied, usually used to check if
468 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800469 *
470 * Return: %true if at least one page exists in the specified range,
471 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500472 */
473bool filemap_range_has_page(struct address_space *mapping,
474 loff_t start_byte, loff_t end_byte)
475{
Jan Karaf7b68042017-09-06 16:21:40 -0700476 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500477 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
478 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500479
480 if (end_byte < start_byte)
481 return false;
482
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500483 rcu_read_lock();
484 for (;;) {
485 page = xas_find(&xas, max);
486 if (xas_retry(&xas, page))
487 continue;
488 /* Shadow entries don't count */
489 if (xa_is_value(page))
490 continue;
491 /*
492 * We don't need to try to pin this page; we're about to
493 * release the RCU lock anyway. It is enough to know that
494 * there was a page here recently.
495 */
496 break;
497 }
498 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500499
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500500 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500501}
502EXPORT_SYMBOL(filemap_range_has_page);
503
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400504static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800505 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300507 pgoff_t index = start_byte >> PAGE_SHIFT;
508 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 struct pagevec pvec;
510 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200512 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400513 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Mel Gorman86679822017-11-15 17:37:52 -0800515 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800516 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 unsigned i;
518
Jan Kara312e9d22017-11-15 17:35:05 -0800519 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800520 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800521 if (!nr_pages)
522 break;
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 for (i = 0; i < nr_pages; i++) {
525 struct page *page = pvec.pages[i];
526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400528 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 }
530 pagevec_release(&pvec);
531 cond_resched();
532 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800533}
534
535/**
536 * filemap_fdatawait_range - wait for writeback to complete
537 * @mapping: address space structure to wait for
538 * @start_byte: offset in bytes where the range starts
539 * @end_byte: offset in bytes where the range ends (inclusive)
540 *
541 * Walk the list of under-writeback pages of the given address space
542 * in the given range and wait for all of them. Check error status of
543 * the address space and return it.
544 *
545 * Since the error status of the address space is cleared by this function,
546 * callers are responsible for checking the return value and handling and/or
547 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800548 *
549 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800550 */
551int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
552 loff_t end_byte)
553{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400554 __filemap_fdatawait_range(mapping, start_byte, end_byte);
555 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200557EXPORT_SYMBOL(filemap_fdatawait_range);
558
559/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400560 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
561 * @mapping: address space structure to wait for
562 * @start_byte: offset in bytes where the range starts
563 * @end_byte: offset in bytes where the range ends (inclusive)
564 *
565 * Walk the list of under-writeback pages of the given address space in the
566 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
567 * this function does not clear error status of the address space.
568 *
569 * Use this function if callers don't handle errors themselves. Expected
570 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
571 * fsfreeze(8)
572 */
573int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
574 loff_t start_byte, loff_t end_byte)
575{
576 __filemap_fdatawait_range(mapping, start_byte, end_byte);
577 return filemap_check_and_keep_errors(mapping);
578}
579EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
580
581/**
Jeff Laytona823e452017-07-28 07:24:43 -0400582 * file_fdatawait_range - wait for writeback to complete
583 * @file: file pointing to address space structure to wait for
584 * @start_byte: offset in bytes where the range starts
585 * @end_byte: offset in bytes where the range ends (inclusive)
586 *
587 * Walk the list of under-writeback pages of the address space that file
588 * refers to, in the given range and wait for all of them. Check error
589 * status of the address space vs. the file->f_wb_err cursor and return it.
590 *
591 * Since the error status of the file is advanced by this function,
592 * callers are responsible for checking the return value and handling and/or
593 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800594 *
595 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400596 */
597int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
598{
599 struct address_space *mapping = file->f_mapping;
600
601 __filemap_fdatawait_range(mapping, start_byte, end_byte);
602 return file_check_and_advance_wb_err(file);
603}
604EXPORT_SYMBOL(file_fdatawait_range);
605
606/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800607 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
608 * @mapping: address space structure to wait for
609 *
610 * Walk the list of under-writeback pages of the given address space
611 * and wait for all of them. Unlike filemap_fdatawait(), this function
612 * does not clear error status of the address space.
613 *
614 * Use this function if callers don't handle errors themselves. Expected
615 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
616 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800617 *
618 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800619 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400620int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800621{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400622 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400623 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800624}
Jeff Layton76341ca2017-07-06 07:02:22 -0400625EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800626
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700627/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400628static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700630 if (dax_mapping(mapping))
631 return mapping->nrexceptional;
632
633 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Randy Dunlap485bb992006-06-23 02:03:49 -0700636/**
637 * filemap_write_and_wait_range - write out & wait on a file range
638 * @mapping: the address_space for the pages
639 * @lstart: offset in bytes where the range starts
640 * @lend: offset in bytes where the range ends (inclusive)
641 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800642 * Write out and wait upon file offsets lstart->lend, inclusive.
643 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300644 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800645 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800646 *
647 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800648 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649int filemap_write_and_wait_range(struct address_space *mapping,
650 loff_t lstart, loff_t lend)
651{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800652 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Jeff Layton9326c9b2017-07-26 10:21:11 -0400654 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800655 err = __filemap_fdatawrite_range(mapping, lstart, lend,
656 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800657 /*
658 * Even if the above returned error, the pages may be
659 * written partially (e.g. -ENOSPC), so we wait for it.
660 * But the -EIO is special case, it may indicate the worst
661 * thing (e.g. bug) happened, so we avoid waiting for it.
662 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800663 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200664 int err2 = filemap_fdatawait_range(mapping,
665 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800666 if (!err)
667 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400668 } else {
669 /* Clear any previously stored errors */
670 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800671 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700672 } else {
673 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800675 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
Chris Masonf6995582009-04-15 13:22:37 -0400677EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Jeff Layton5660e132017-07-06 07:02:25 -0400679void __filemap_set_wb_err(struct address_space *mapping, int err)
680{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400681 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400682
683 trace_filemap_set_wb_err(mapping, eseq);
684}
685EXPORT_SYMBOL(__filemap_set_wb_err);
686
687/**
688 * file_check_and_advance_wb_err - report wb error (if any) that was previously
689 * and advance wb_err to current one
690 * @file: struct file on which the error is being reported
691 *
692 * When userland calls fsync (or something like nfsd does the equivalent), we
693 * want to report any writeback errors that occurred since the last fsync (or
694 * since the file was opened if there haven't been any).
695 *
696 * Grab the wb_err from the mapping. If it matches what we have in the file,
697 * then just quickly return 0. The file is all caught up.
698 *
699 * If it doesn't match, then take the mapping value, set the "seen" flag in
700 * it and try to swap it into place. If it works, or another task beat us
701 * to it with the new value, then update the f_wb_err and return the error
702 * portion. The error at this point must be reported via proper channels
703 * (a'la fsync, or NFS COMMIT operation, etc.).
704 *
705 * While we handle mapping->wb_err with atomic operations, the f_wb_err
706 * value is protected by the f_lock since we must ensure that it reflects
707 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800708 *
709 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400710 */
711int file_check_and_advance_wb_err(struct file *file)
712{
713 int err = 0;
714 errseq_t old = READ_ONCE(file->f_wb_err);
715 struct address_space *mapping = file->f_mapping;
716
717 /* Locklessly handle the common case where nothing has changed */
718 if (errseq_check(&mapping->wb_err, old)) {
719 /* Something changed, must use slow path */
720 spin_lock(&file->f_lock);
721 old = file->f_wb_err;
722 err = errseq_check_and_advance(&mapping->wb_err,
723 &file->f_wb_err);
724 trace_file_check_and_advance_wb_err(file, old);
725 spin_unlock(&file->f_lock);
726 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700727
728 /*
729 * We're mostly using this function as a drop in replacement for
730 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
731 * that the legacy code would have had on these flags.
732 */
733 clear_bit(AS_EIO, &mapping->flags);
734 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400735 return err;
736}
737EXPORT_SYMBOL(file_check_and_advance_wb_err);
738
739/**
740 * file_write_and_wait_range - write out & wait on a file range
741 * @file: file pointing to address_space with pages
742 * @lstart: offset in bytes where the range starts
743 * @lend: offset in bytes where the range ends (inclusive)
744 *
745 * Write out and wait upon file offsets lstart->lend, inclusive.
746 *
747 * Note that @lend is inclusive (describes the last byte to be written) so
748 * that this function can be used to write to the very end-of-file (end = -1).
749 *
750 * After writing out and waiting on the data, we check and advance the
751 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800752 *
753 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400754 */
755int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
756{
757 int err = 0, err2;
758 struct address_space *mapping = file->f_mapping;
759
Jeff Layton9326c9b2017-07-26 10:21:11 -0400760 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400761 err = __filemap_fdatawrite_range(mapping, lstart, lend,
762 WB_SYNC_ALL);
763 /* See comment of filemap_write_and_wait() */
764 if (err != -EIO)
765 __filemap_fdatawait_range(mapping, lstart, lend);
766 }
767 err2 = file_check_and_advance_wb_err(file);
768 if (!err)
769 err = err2;
770 return err;
771}
772EXPORT_SYMBOL(file_write_and_wait_range);
773
Randy Dunlap485bb992006-06-23 02:03:49 -0700774/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700775 * replace_page_cache_page - replace a pagecache page with a new one
776 * @old: page to be replaced
777 * @new: page to replace with
778 * @gfp_mask: allocation mode
779 *
780 * This function replaces a page in the pagecache with a new one. On
781 * success it acquires the pagecache reference for the new page and
782 * drops it for the old page. Both the old and new pages must be
783 * locked. This function does not add the new page to the LRU, the
784 * caller must do that.
785 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500786 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800787 *
788 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700789 */
790int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
791{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500792 struct address_space *mapping = old->mapping;
793 void (*freepage)(struct page *) = mapping->a_ops->freepage;
794 pgoff_t offset = old->index;
795 XA_STATE(xas, &mapping->i_pages, offset);
796 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700797
Sasha Levin309381fea2014-01-23 15:52:54 -0800798 VM_BUG_ON_PAGE(!PageLocked(old), old);
799 VM_BUG_ON_PAGE(!PageLocked(new), new);
800 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700801
Matthew Wilcox74d60952017-11-17 10:01:45 -0500802 get_page(new);
803 new->mapping = mapping;
804 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700805
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700806 mem_cgroup_migrate(old, new);
807
Matthew Wilcox74d60952017-11-17 10:01:45 -0500808 xas_lock_irqsave(&xas, flags);
809 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700810
Matthew Wilcox74d60952017-11-17 10:01:45 -0500811 old->mapping = NULL;
812 /* hugetlb pages do not participate in page cache accounting. */
813 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700814 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500815 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700816 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500817 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700818 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500819 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700820 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500821 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500822 if (freepage)
823 freepage(old);
824 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700825
Matthew Wilcox74d60952017-11-17 10:01:45 -0500826 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700827}
828EXPORT_SYMBOL_GPL(replace_page_cache_page);
829
Andrew Morton16c0cc02020-12-11 13:36:27 -0800830noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700831 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700832 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700833 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500835 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700836 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700837 int error;
838
Sasha Levin309381fea2014-01-23 15:52:54 -0800839 VM_BUG_ON_PAGE(!PageLocked(page), page);
840 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500841 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700842
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300843 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700844 page->mapping = mapping;
845 page->index = offset;
846
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700847 if (!huge) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700848 error = mem_cgroup_charge(page, current->mm, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700849 if (error)
850 goto error;
851 }
852
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700853 gfp &= GFP_RECLAIM_MASK;
854
Matthew Wilcox74d60952017-11-17 10:01:45 -0500855 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700856 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
857 void *entry, *old = NULL;
858
859 if (order > thp_order(page))
860 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
861 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500862 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700863 xas_for_each_conflict(&xas, entry) {
864 old = entry;
865 if (!xa_is_value(entry)) {
866 xas_set_err(&xas, -EEXIST);
867 goto unlock;
868 }
869 }
870
871 if (old) {
872 if (shadowp)
873 *shadowp = old;
874 /* entry may have been split before we acquired lock */
875 order = xa_get_order(xas.xa, xas.xa_index);
876 if (order > thp_order(page)) {
877 xas_split(&xas, old, order);
878 xas_reset(&xas);
879 }
880 }
881
Matthew Wilcox74d60952017-11-17 10:01:45 -0500882 xas_store(&xas, page);
883 if (xas_error(&xas))
884 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700885
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700886 if (old)
Matthew Wilcox74d60952017-11-17 10:01:45 -0500887 mapping->nrexceptional--;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500888 mapping->nrpages++;
889
890 /* hugetlb pages do not participate in page cache accounting */
891 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700892 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500893unlock:
894 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700895 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500896
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700897 if (xas_error(&xas)) {
898 error = xas_error(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500899 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700900 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500901
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700902 trace_mm_filemap_add_to_page_cache(page);
903 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500904error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700905 page->mapping = NULL;
906 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300907 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700908 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700910ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700911
912/**
913 * add_to_page_cache_locked - add a locked page to the pagecache
914 * @page: page to add
915 * @mapping: the page's address_space
916 * @offset: page index
917 * @gfp_mask: page allocation mode
918 *
919 * This function is used to add a page to the pagecache. It must be locked.
920 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800921 *
922 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700923 */
924int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
925 pgoff_t offset, gfp_t gfp_mask)
926{
927 return __add_to_page_cache_locked(page, mapping, offset,
928 gfp_mask, NULL);
929}
Nick Piggine2867812008-07-25 19:45:30 -0700930EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
932int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400933 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934{
Johannes Weinera5289102014-04-03 14:47:51 -0700935 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700936 int ret;
937
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800938 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700939 ret = __add_to_page_cache_locked(page, mapping, offset,
940 gfp_mask, &shadow);
941 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800942 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700943 else {
944 /*
945 * The page might have been evicted from cache only
946 * recently, in which case it should be activated like
947 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700948 * The exception is pages getting rewritten; evicting other
949 * data from the working set, only to cache data that will
950 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700951 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700952 WARN_ON_ONCE(PageActive(page));
953 if (!(gfp_mask & __GFP_WRITE) && shadow)
954 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700955 lru_cache_add(page);
956 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 return ret;
958}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300959EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
Paul Jackson44110fe2006-03-24 03:16:04 -0800961#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700962struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800963{
Miao Xiec0ff7452010-05-24 14:32:08 -0700964 int n;
965 struct page *page;
966
Paul Jackson44110fe2006-03-24 03:16:04 -0800967 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700968 unsigned int cpuset_mems_cookie;
969 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700970 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700971 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700972 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700973 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700974
Miao Xiec0ff7452010-05-24 14:32:08 -0700975 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800976 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700977 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800978}
Nick Piggin2ae88142006-10-28 10:38:23 -0700979EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800980#endif
981
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982/*
983 * In order to wait for pages to become available there must be
984 * waitqueues associated with pages. By using a hash table of
985 * waitqueues where the bucket discipline is to maintain all
986 * waiters on the same queue and wake all when any of the pages
987 * become available, and for the woken contexts to check to be
988 * sure the appropriate page became available, this saves space
989 * at a cost of "thundering herd" phenomena during rare hash
990 * collisions.
991 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000992#define PAGE_WAIT_TABLE_BITS 8
993#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
994static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
995
996static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700997{
Nicholas Piggin62906022016-12-25 13:00:30 +1000998 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999}
Nicholas Piggin62906022016-12-25 13:00:30 +10001000
1001void __init pagecache_init(void)
1002{
1003 int i;
1004
1005 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1006 init_waitqueue_head(&page_wait_table[i]);
1007
1008 page_writeback_init();
1009}
1010
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001011/*
1012 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001013 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001014 * one.
1015 *
1016 * We have:
1017 *
1018 * (a) no special bits set:
1019 *
1020 * We're just waiting for the bit to be released, and when a waker
1021 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1022 * and remove it from the wait queue.
1023 *
1024 * Simple and straightforward.
1025 *
1026 * (b) WQ_FLAG_EXCLUSIVE:
1027 *
1028 * The waiter is waiting to get the lock, and only one waiter should
1029 * be woken up to avoid any thundering herd behavior. We'll set the
1030 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1031 *
1032 * This is the traditional exclusive wait.
1033 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001034 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001035 *
1036 * The waiter is waiting to get the bit, and additionally wants the
1037 * lock to be transferred to it for fair lock behavior. If the lock
1038 * cannot be taken, we stop walking the wait queue without waking
1039 * the waiter.
1040 *
1041 * This is the "fair lock handoff" case, and in addition to setting
1042 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1043 * that it now has the lock.
1044 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001045static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001046{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001047 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001048 struct wait_page_key *key = arg;
1049 struct wait_page_queue *wait_page
1050 = container_of(wait, struct wait_page_queue, wait);
1051
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001052 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001053 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001054
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001055 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001056 * If it's a lock handoff wait, we get the bit for it, and
1057 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001058 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001059 flags = wait->flags;
1060 if (flags & WQ_FLAG_EXCLUSIVE) {
1061 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001062 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001063 if (flags & WQ_FLAG_CUSTOM) {
1064 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1065 return -1;
1066 flags |= WQ_FLAG_DONE;
1067 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001068 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001069
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001070 /*
1071 * We are holding the wait-queue lock, but the waiter that
1072 * is waiting for this will be checking the flags without
1073 * any locking.
1074 *
1075 * So update the flags atomically, and wake up the waiter
1076 * afterwards to avoid any races. This store-release pairs
1077 * with the load-acquire in wait_on_page_bit_common().
1078 */
1079 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001080 wake_up_state(wait->private, mode);
1081
1082 /*
1083 * Ok, we have successfully done what we're waiting for,
1084 * and we can unconditionally remove the wait entry.
1085 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001086 * Note that this pairs with the "finish_wait()" in the
1087 * waiter, and has to be the absolute last thing we do.
1088 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001089 * might be de-allocated and the process might even have
1090 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001091 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001092 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001093 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001094}
1095
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001096static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001097{
1098 wait_queue_head_t *q = page_waitqueue(page);
1099 struct wait_page_key key;
1100 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001101 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001102
1103 key.page = page;
1104 key.bit_nr = bit_nr;
1105 key.page_match = 0;
1106
Tim Chen11a19c72017-08-25 09:13:55 -07001107 bookmark.flags = 0;
1108 bookmark.private = NULL;
1109 bookmark.func = NULL;
1110 INIT_LIST_HEAD(&bookmark.entry);
1111
Nicholas Piggin62906022016-12-25 13:00:30 +10001112 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001113 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1114
1115 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1116 /*
1117 * Take a breather from holding the lock,
1118 * allow pages that finish wake up asynchronously
1119 * to acquire the lock and remove themselves
1120 * from wait queue
1121 */
1122 spin_unlock_irqrestore(&q->lock, flags);
1123 cpu_relax();
1124 spin_lock_irqsave(&q->lock, flags);
1125 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1126 }
1127
Nicholas Piggin62906022016-12-25 13:00:30 +10001128 /*
1129 * It is possible for other pages to have collided on the waitqueue
1130 * hash, so in that case check for a page match. That prevents a long-
1131 * term waiter
1132 *
1133 * It is still possible to miss a case here, when we woke page waiters
1134 * and removed them from the waitqueue, but there are still other
1135 * page waiters.
1136 */
1137 if (!waitqueue_active(q) || !key.page_match) {
1138 ClearPageWaiters(page);
1139 /*
1140 * It's possible to miss clearing Waiters here, when we woke
1141 * our page waiters, but the hashed waitqueue has waiters for
1142 * other pages on it.
1143 *
1144 * That's okay, it's a rare case. The next waker will clear it.
1145 */
1146 }
1147 spin_unlock_irqrestore(&q->lock, flags);
1148}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001149
1150static void wake_up_page(struct page *page, int bit)
1151{
1152 if (!PageWaiters(page))
1153 return;
1154 wake_up_page_bit(page, bit);
1155}
Nicholas Piggin62906022016-12-25 13:00:30 +10001156
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001157/*
1158 * A choice of three behaviors for wait_on_page_bit_common():
1159 */
1160enum behavior {
1161 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1162 * __lock_page() waiting on then setting PG_locked.
1163 */
1164 SHARED, /* Hold ref to page and check the bit when woken, like
1165 * wait_on_page_writeback() waiting on PG_writeback.
1166 */
1167 DROP, /* Drop ref to page before wait, no check when woken,
1168 * like put_and_wait_on_page_locked() on PG_locked.
1169 */
1170};
1171
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001172/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001173 * Attempt to check (or get) the page bit, and mark us done
1174 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001175 */
1176static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1177 struct wait_queue_entry *wait)
1178{
1179 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1180 if (test_and_set_bit(bit_nr, &page->flags))
1181 return false;
1182 } else if (test_bit(bit_nr, &page->flags))
1183 return false;
1184
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001185 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001186 return true;
1187}
1188
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001189/* How many times do we accept lock stealing from under a waiter? */
1190int sysctl_page_lock_unfairness = 5;
1191
Nicholas Piggin62906022016-12-25 13:00:30 +10001192static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001193 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001194{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001195 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001196 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001197 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001198 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001199 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001200 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001201
Johannes Weinereb414682018-10-26 15:06:27 -07001202 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001203 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001204 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001205 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001206 delayacct = true;
1207 }
Johannes Weinereb414682018-10-26 15:06:27 -07001208 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001209 thrashing = true;
1210 }
1211
Nicholas Piggin62906022016-12-25 13:00:30 +10001212 init_wait(wait);
1213 wait->func = wake_page_function;
1214 wait_page.page = page;
1215 wait_page.bit_nr = bit_nr;
1216
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001217repeat:
1218 wait->flags = 0;
1219 if (behavior == EXCLUSIVE) {
1220 wait->flags = WQ_FLAG_EXCLUSIVE;
1221 if (--unfairness < 0)
1222 wait->flags |= WQ_FLAG_CUSTOM;
1223 }
1224
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001225 /*
1226 * Do one last check whether we can get the
1227 * page bit synchronously.
1228 *
1229 * Do the SetPageWaiters() marking before that
1230 * to let any waker we _just_ missed know they
1231 * need to wake us up (otherwise they'll never
1232 * even go to the slow case that looks at the
1233 * page queue), and add ourselves to the wait
1234 * queue if we need to sleep.
1235 *
1236 * This part needs to be done under the queue
1237 * lock to avoid races.
1238 */
1239 spin_lock_irq(&q->lock);
1240 SetPageWaiters(page);
1241 if (!trylock_page_bit_common(page, bit_nr, wait))
1242 __add_wait_queue_entry_tail(q, wait);
1243 spin_unlock_irq(&q->lock);
1244
1245 /*
1246 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001247 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1248 * see whether the page bit testing has already
1249 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001250 *
1251 * We can drop our reference to the page.
1252 */
1253 if (behavior == DROP)
1254 put_page(page);
1255
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001256 /*
1257 * Note that until the "finish_wait()", or until
1258 * we see the WQ_FLAG_WOKEN flag, we need to
1259 * be very careful with the 'wait->flags', because
1260 * we may race with a waker that sets them.
1261 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001262 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001263 unsigned int flags;
1264
Nicholas Piggin62906022016-12-25 13:00:30 +10001265 set_current_state(state);
1266
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001267 /* Loop until we've been woken or interrupted */
1268 flags = smp_load_acquire(&wait->flags);
1269 if (!(flags & WQ_FLAG_WOKEN)) {
1270 if (signal_pending_state(state, current))
1271 break;
1272
1273 io_schedule();
1274 continue;
1275 }
1276
1277 /* If we were non-exclusive, we're done */
1278 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001279 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001280
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001281 /* If the waker got the lock for us, we're done */
1282 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001283 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001284
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001285 /*
1286 * Otherwise, if we're getting the lock, we need to
1287 * try to get it ourselves.
1288 *
1289 * And if that fails, we'll have to retry this all.
1290 */
1291 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1292 goto repeat;
1293
1294 wait->flags |= WQ_FLAG_DONE;
1295 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001296 }
1297
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001298 /*
1299 * If a signal happened, this 'finish_wait()' may remove the last
1300 * waiter from the wait-queues, but the PageWaiters bit will remain
1301 * set. That's ok. The next wakeup will take care of it, and trying
1302 * to do it here would be difficult and prone to races.
1303 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001304 finish_wait(q, wait);
1305
Johannes Weinereb414682018-10-26 15:06:27 -07001306 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001307 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001308 delayacct_thrashing_end();
1309 psi_memstall_leave(&pflags);
1310 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001311
Nicholas Piggin62906022016-12-25 13:00:30 +10001312 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001313 * NOTE! The wait->flags weren't stable until we've done the
1314 * 'finish_wait()', and we could have exited the loop above due
1315 * to a signal, and had a wakeup event happen after the signal
1316 * test but before the 'finish_wait()'.
1317 *
1318 * So only after the finish_wait() can we reliably determine
1319 * if we got woken up or not, so we can now figure out the final
1320 * return value based on that state without races.
1321 *
1322 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1323 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001324 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001325 if (behavior == EXCLUSIVE)
1326 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001327
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001328 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001329}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Harvey Harrison920c7a52008-02-04 22:29:26 -08001331void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332{
Nicholas Piggin62906022016-12-25 13:00:30 +10001333 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001334 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335}
1336EXPORT_SYMBOL(wait_on_page_bit);
1337
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001338int wait_on_page_bit_killable(struct page *page, int bit_nr)
1339{
Nicholas Piggin62906022016-12-25 13:00:30 +10001340 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001341 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001342}
David Howells4343d002017-11-02 15:27:52 +00001343EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001344
Jens Axboedd3e6d52020-05-22 09:12:09 -06001345static int __wait_on_page_locked_async(struct page *page,
1346 struct wait_page_queue *wait, bool set)
1347{
1348 struct wait_queue_head *q = page_waitqueue(page);
1349 int ret = 0;
1350
1351 wait->page = page;
1352 wait->bit_nr = PG_locked;
1353
1354 spin_lock_irq(&q->lock);
1355 __add_wait_queue_entry_tail(q, &wait->wait);
1356 SetPageWaiters(page);
1357 if (set)
1358 ret = !trylock_page(page);
1359 else
1360 ret = PageLocked(page);
1361 /*
1362 * If we were succesful now, we know we're still on the
1363 * waitqueue as we're still under the lock. This means it's
1364 * safe to remove and return success, we know the callback
1365 * isn't going to trigger.
1366 */
1367 if (!ret)
1368 __remove_wait_queue(q, &wait->wait);
1369 else
1370 ret = -EIOCBQUEUED;
1371 spin_unlock_irq(&q->lock);
1372 return ret;
1373}
1374
Jens Axboe1a0a7852020-05-22 09:18:38 -06001375static int wait_on_page_locked_async(struct page *page,
1376 struct wait_page_queue *wait)
1377{
1378 if (!PageLocked(page))
1379 return 0;
1380 return __wait_on_page_locked_async(compound_head(page), wait, false);
1381}
1382
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001384 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1385 * @page: The page to wait for.
1386 *
1387 * The caller should hold a reference on @page. They expect the page to
1388 * become unlocked relatively soon, but do not wish to hold up migration
1389 * (for example) by holding the reference while waiting for the page to
1390 * come unlocked. After this function returns, the caller should not
1391 * dereference @page.
1392 */
1393void put_and_wait_on_page_locked(struct page *page)
1394{
1395 wait_queue_head_t *q;
1396
1397 page = compound_head(page);
1398 q = page_waitqueue(page);
1399 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1400}
1401
1402/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001403 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001404 * @page: Page defining the wait queue of interest
1405 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001406 *
1407 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1408 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001409void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001410{
1411 wait_queue_head_t *q = page_waitqueue(page);
1412 unsigned long flags;
1413
1414 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001415 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001416 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001417 spin_unlock_irqrestore(&q->lock, flags);
1418}
1419EXPORT_SYMBOL_GPL(add_page_wait_queue);
1420
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001421#ifndef clear_bit_unlock_is_negative_byte
1422
1423/*
1424 * PG_waiters is the high bit in the same byte as PG_lock.
1425 *
1426 * On x86 (and on many other architectures), we can clear PG_lock and
1427 * test the sign bit at the same time. But if the architecture does
1428 * not support that special operation, we just do this all by hand
1429 * instead.
1430 *
1431 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001432 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001433 * in the same byte as PG_locked.
1434 */
1435static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1436{
1437 clear_bit_unlock(nr, mem);
1438 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001439 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001440}
1441
1442#endif
1443
David Howells385e1ca5f2009-04-03 16:42:39 +01001444/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001445 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 * @page: the page
1447 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001448 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001450 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1452 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001453 * Note that this depends on PG_waiters being the sign bit in the byte
1454 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1455 * clear the PG_locked bit and test PG_waiters at the same time fairly
1456 * portably (architectures that do LL/SC can test any bit, while x86 can
1457 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001459void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001461 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001462 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001463 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001464 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1465 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466}
1467EXPORT_SYMBOL(unlock_page);
1468
Randy Dunlap485bb992006-06-23 02:03:49 -07001469/**
1470 * end_page_writeback - end writeback against a page
1471 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 */
1473void end_page_writeback(struct page *page)
1474{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001475 /*
1476 * TestClearPageReclaim could be used here but it is an atomic
1477 * operation and overkill in this particular case. Failing to
1478 * shuffle a page marked for immediate reclaim is too mild to
1479 * justify taking an atomic operation penalty at the end of
1480 * ever page writeback.
1481 */
1482 if (PageReclaim(page)) {
1483 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001484 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001485 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001486
Hugh Dickins073861e2020-11-24 08:46:43 -08001487 /*
1488 * Writeback does not hold a page reference of its own, relying
1489 * on truncation to wait for the clearing of PG_writeback.
1490 * But here we must make sure that the page is not freed and
1491 * reused before the wake_up_page().
1492 */
1493 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001494 if (!test_clear_page_writeback(page))
1495 BUG();
1496
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001497 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001499 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500}
1501EXPORT_SYMBOL(end_page_writeback);
1502
Matthew Wilcox57d99842014-06-04 16:07:45 -07001503/*
1504 * After completing I/O on a page, call this routine to update the page
1505 * flags appropriately
1506 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001507void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001508{
Jens Axboec11f0c02016-08-05 08:11:04 -06001509 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001510 if (!err) {
1511 SetPageUptodate(page);
1512 } else {
1513 ClearPageUptodate(page);
1514 SetPageError(page);
1515 }
1516 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001517 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001518 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001519 struct address_space *mapping;
1520
Matthew Wilcox57d99842014-06-04 16:07:45 -07001521 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001522 mapping = page_mapping(page);
1523 if (mapping)
1524 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001525 }
1526 end_page_writeback(page);
1527 }
1528}
1529EXPORT_SYMBOL_GPL(page_endio);
1530
Randy Dunlap485bb992006-06-23 02:03:49 -07001531/**
1532 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001533 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001534 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001535void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001536{
Nicholas Piggin62906022016-12-25 13:00:30 +10001537 struct page *page = compound_head(__page);
1538 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001539 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1540 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541}
1542EXPORT_SYMBOL(__lock_page);
1543
Nicholas Piggin62906022016-12-25 13:00:30 +10001544int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001545{
Nicholas Piggin62906022016-12-25 13:00:30 +10001546 struct page *page = compound_head(__page);
1547 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001548 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1549 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001550}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001551EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001552
Jens Axboedd3e6d52020-05-22 09:12:09 -06001553int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1554{
1555 return __wait_on_page_locked_async(page, wait, true);
1556}
1557
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001558/*
1559 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001560 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001561 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001562 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001563 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001564 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001565 *
1566 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001567 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001568 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001569int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1570 unsigned int flags)
1571{
Peter Xu4064b982020-04-01 21:08:45 -07001572 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001573 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001574 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001575 * even though return 0.
1576 */
1577 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1578 return 0;
1579
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001580 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001581 if (flags & FAULT_FLAG_KILLABLE)
1582 wait_on_page_locked_killable(page);
1583 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001584 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001585 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001586 } else {
1587 if (flags & FAULT_FLAG_KILLABLE) {
1588 int ret;
1589
1590 ret = __lock_page_killable(page);
1591 if (ret) {
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001592 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001593 return 0;
1594 }
1595 } else
1596 __lock_page(page);
1597 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001598 }
1599}
1600
Randy Dunlap485bb992006-06-23 02:03:49 -07001601/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001602 * page_cache_next_miss() - Find the next gap in the page cache.
1603 * @mapping: Mapping.
1604 * @index: Index.
1605 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001606 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001607 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1608 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001609 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001610 * This function may be called under the rcu_read_lock. However, this will
1611 * not atomically search a snapshot of the cache at a single point in time.
1612 * For example, if a gap is created at index 5, then subsequently a gap is
1613 * created at index 10, page_cache_next_miss covering both indices may
1614 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001615 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001616 * Return: The index of the gap if found, otherwise an index outside the
1617 * range specified (in which case 'return - index >= max_scan' will be true).
1618 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001619 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001620pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001621 pgoff_t index, unsigned long max_scan)
1622{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001623 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001624
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001625 while (max_scan--) {
1626 void *entry = xas_next(&xas);
1627 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001628 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001629 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001630 break;
1631 }
1632
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001633 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001634}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001635EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001636
1637/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001638 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001639 * @mapping: Mapping.
1640 * @index: Index.
1641 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001642 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001643 * Search the range [max(index - max_scan + 1, 0), index] for the
1644 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001645 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001646 * This function may be called under the rcu_read_lock. However, this will
1647 * not atomically search a snapshot of the cache at a single point in time.
1648 * For example, if a gap is created at index 10, then subsequently a gap is
1649 * created at index 5, page_cache_prev_miss() covering both indices may
1650 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001651 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001652 * Return: The index of the gap if found, otherwise an index outside the
1653 * range specified (in which case 'index - return >= max_scan' will be true).
1654 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001655 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001656pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001657 pgoff_t index, unsigned long max_scan)
1658{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001659 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001660
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001661 while (max_scan--) {
1662 void *entry = xas_prev(&xas);
1663 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001664 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001665 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001666 break;
1667 }
1668
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001669 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001670}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001671EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001672
1673/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001674 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001675 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001676 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001677 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001678 * Looks up the page cache slot at @mapping & @offset. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001679 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001680 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001681 * If the slot holds a shadow entry of a previously evicted page, or a
1682 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001683 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001684 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 */
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001686struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001688 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001689 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690
Nick Piggina60637c2008-07-25 19:45:31 -07001691 rcu_read_lock();
1692repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001693 xas_reset(&xas);
1694 page = xas_load(&xas);
1695 if (xas_retry(&xas, page))
1696 goto repeat;
1697 /*
1698 * A shadow entry of a recently evicted page, or a swap entry from
1699 * shmem/tmpfs. Return it without attempting to raise page count.
1700 */
1701 if (!page || xa_is_value(page))
1702 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001703
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001704 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001705 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001706
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001707 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001708 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001709 * This is part of the lockless pagecache protocol. See
1710 * include/linux/pagemap.h for details.
1711 */
1712 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001713 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001714 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001715 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001716out:
Nick Piggina60637c2008-07-25 19:45:31 -07001717 rcu_read_unlock();
1718
Linus Torvalds1da177e2005-04-16 15:20:36 -07001719 return page;
1720}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721
Randy Dunlap485bb992006-06-23 02:03:49 -07001722/**
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001723 * find_lock_entry - Locate and lock a page cache entry.
1724 * @mapping: The address_space to search.
1725 * @index: The page cache index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001726 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001727 * Looks up the page at @mapping & @index. If there is a page in the
1728 * cache, the head page is returned locked and with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001729 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001730 * If the slot holds a shadow entry of a previously evicted page, or a
1731 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001732 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001733 * Context: May sleep.
1734 * Return: The head page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001735 */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001736struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737{
1738 struct page *page;
1739
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740repeat:
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001741 page = find_get_entry(mapping, index);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001742 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001743 lock_page(page);
1744 /* Has the page been truncated? */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001745 if (unlikely(page->mapping != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001746 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001747 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001748 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 }
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001750 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 return page;
1753}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001754
1755/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001756 * pagecache_get_page - Find and get a reference to a page.
1757 * @mapping: The address_space to search.
1758 * @index: The page index.
1759 * @fgp_flags: %FGP flags modify how the page is returned.
1760 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001761 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001762 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001763 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001764 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001765 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001766 * * %FGP_ACCESSED - The page will be marked accessed.
1767 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001768 * * %FGP_HEAD - If the page is present and a THP, return the head page
1769 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001770 * * %FGP_CREAT - If no page is present then a new page is allocated using
1771 * @gfp_mask and added to the page cache and the VM's LRU list.
1772 * The page is returned locked and with an increased refcount.
1773 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1774 * page is already in cache. If the page was allocated, unlock it before
1775 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001776 * * %FGP_WRITE - The page will be written
1777 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1778 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001779 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001780 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1781 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001782 *
1783 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001784 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001785 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001786 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001787struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1788 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789{
Nick Piggineb2be182007-10-16 01:24:57 -07001790 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001791
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001793 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001794 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001795 page = NULL;
1796 if (!page)
1797 goto no_page;
1798
1799 if (fgp_flags & FGP_LOCK) {
1800 if (fgp_flags & FGP_NOWAIT) {
1801 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001802 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001803 return NULL;
1804 }
1805 } else {
1806 lock_page(page);
1807 }
1808
1809 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001810 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001811 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001812 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001813 goto repeat;
1814 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001815 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001816 }
1817
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001818 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001819 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001820 else if (fgp_flags & FGP_WRITE) {
1821 /* Clear idle flag for buffer write */
1822 if (page_is_idle(page))
1823 clear_page_idle(page);
1824 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001825 if (!(fgp_flags & FGP_HEAD))
1826 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001827
1828no_page:
1829 if (!page && (fgp_flags & FGP_CREAT)) {
1830 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001831 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001832 gfp_mask |= __GFP_WRITE;
1833 if (fgp_flags & FGP_NOFS)
1834 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001835
Michal Hocko45f87de2014-12-29 20:30:35 +01001836 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001837 if (!page)
1838 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001839
Josef Bacika75d4c32019-03-13 11:44:14 -07001840 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001841 fgp_flags |= FGP_LOCK;
1842
Hugh Dickinseb39d612014-08-06 16:06:43 -07001843 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001844 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001845 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001846
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001847 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001848 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001849 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001850 page = NULL;
1851 if (err == -EEXIST)
1852 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001854
1855 /*
1856 * add_to_page_cache_lru locks the page, and for mmap we expect
1857 * an unlocked page.
1858 */
1859 if (page && (fgp_flags & FGP_FOR_MMAP))
1860 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001862
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 return page;
1864}
Mel Gorman2457aec2014-06-04 16:10:31 -07001865EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001866
1867/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001868 * find_get_entries - gang pagecache lookup
1869 * @mapping: The address_space to search
1870 * @start: The starting page cache index
1871 * @nr_entries: The maximum number of entries
1872 * @entries: Where the resulting entries are placed
1873 * @indices: The cache indices corresponding to the entries in @entries
1874 *
1875 * find_get_entries() will search for and return a group of up to
1876 * @nr_entries entries in the mapping. The entries are placed at
1877 * @entries. find_get_entries() takes a reference against any actual
1878 * pages it returns.
1879 *
1880 * The search returns a group of mapping-contiguous page cache entries
1881 * with ascending indexes. There may be holes in the indices due to
1882 * not-present pages.
1883 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001884 * Any shadow entries of evicted pages, or swap entries from
1885 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001886 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001887 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1888 * stops at that page: the caller is likely to have a better way to handle
1889 * the compound page as a whole, and then skip its extent, than repeatedly
1890 * calling find_get_entries() to return all its tails.
1891 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001892 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001893 */
1894unsigned find_get_entries(struct address_space *mapping,
1895 pgoff_t start, unsigned int nr_entries,
1896 struct page **entries, pgoff_t *indices)
1897{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001898 XA_STATE(xas, &mapping->i_pages, start);
1899 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001900 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001901
1902 if (!nr_entries)
1903 return 0;
1904
1905 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001906 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001907 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001908 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001909 /*
1910 * A shadow entry of a recently evicted page, a swap
1911 * entry from shmem/tmpfs or a DAX entry. Return it
1912 * without attempting to raise page count.
1913 */
1914 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001915 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001916
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001917 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001918 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001919
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001920 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001921 if (unlikely(page != xas_reload(&xas)))
1922 goto put_page;
1923
Hugh Dickins71725ed2020-04-06 20:07:57 -07001924 /*
1925 * Terminate early on finding a THP, to allow the caller to
1926 * handle it all at once; but continue if this is hugetlbfs.
1927 */
1928 if (PageTransHuge(page) && !PageHuge(page)) {
1929 page = find_subpage(page, xas.xa_index);
1930 nr_entries = ret + 1;
1931 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001932export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001933 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001934 entries[ret] = page;
1935 if (++ret == nr_entries)
1936 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001937 continue;
1938put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001939 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001940retry:
1941 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001942 }
1943 rcu_read_unlock();
1944 return ret;
1945}
1946
1947/**
Jan Karab947cee2017-09-06 16:21:21 -07001948 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 * @mapping: The address_space to search
1950 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001951 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 * @nr_pages: The maximum number of pages
1953 * @pages: Where the resulting pages are placed
1954 *
Jan Karab947cee2017-09-06 16:21:21 -07001955 * find_get_pages_range() will search for and return a group of up to @nr_pages
1956 * pages in the mapping starting at index @start and up to index @end
1957 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1958 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001959 *
1960 * The search returns a group of mapping-contiguous pages with ascending
1961 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001962 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001964 * Return: the number of pages which were found. If this number is
1965 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001966 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 */
Jan Karab947cee2017-09-06 16:21:21 -07001968unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1969 pgoff_t end, unsigned int nr_pages,
1970 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001972 XA_STATE(xas, &mapping->i_pages, *start);
1973 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001974 unsigned ret = 0;
1975
1976 if (unlikely(!nr_pages))
1977 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
Nick Piggina60637c2008-07-25 19:45:31 -07001979 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001980 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001981 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001982 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001983 /* Skip over shadow, swap and DAX entries */
1984 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001985 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001986
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001987 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001988 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001989
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001990 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001991 if (unlikely(page != xas_reload(&xas)))
1992 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001993
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001994 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001995 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001996 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001997 goto out;
1998 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001999 continue;
2000put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002001 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002002retry:
2003 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002004 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002005
Jan Karab947cee2017-09-06 16:21:21 -07002006 /*
2007 * We come here when there is no page beyond @end. We take care to not
2008 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002009 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002010 * already broken anyway.
2011 */
2012 if (end == (pgoff_t)-1)
2013 *start = (pgoff_t)-1;
2014 else
2015 *start = end + 1;
2016out:
Nick Piggina60637c2008-07-25 19:45:31 -07002017 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002018
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 return ret;
2020}
2021
Jens Axboeebf43502006-04-27 08:46:01 +02002022/**
2023 * find_get_pages_contig - gang contiguous pagecache lookup
2024 * @mapping: The address_space to search
2025 * @index: The starting page index
2026 * @nr_pages: The maximum number of pages
2027 * @pages: Where the resulting pages are placed
2028 *
2029 * find_get_pages_contig() works exactly like find_get_pages(), except
2030 * that the returned number of pages are guaranteed to be contiguous.
2031 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002032 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002033 */
2034unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2035 unsigned int nr_pages, struct page **pages)
2036{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002037 XA_STATE(xas, &mapping->i_pages, index);
2038 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002039 unsigned int ret = 0;
2040
2041 if (unlikely(!nr_pages))
2042 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002043
Nick Piggina60637c2008-07-25 19:45:31 -07002044 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002045 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002046 if (xas_retry(&xas, page))
2047 continue;
2048 /*
2049 * If the entry has been swapped out, we can stop looking.
2050 * No current caller is looking for DAX entries.
2051 */
2052 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002053 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002054
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002055 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002056 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002057
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002058 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002059 if (unlikely(page != xas_reload(&xas)))
2060 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002061
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002062 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002063 if (++ret == nr_pages)
2064 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002065 continue;
2066put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002067 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002068retry:
2069 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002070 }
Nick Piggina60637c2008-07-25 19:45:31 -07002071 rcu_read_unlock();
2072 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002073}
David Howellsef71c152007-05-09 02:33:44 -07002074EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002075
Randy Dunlap485bb992006-06-23 02:03:49 -07002076/**
Jan Kara72b045a2017-11-15 17:34:33 -08002077 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07002078 * @mapping: the address_space to search
2079 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002080 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002081 * @tag: the tag index
2082 * @nr_pages: the maximum number of pages
2083 * @pages: where the resulting pages are placed
2084 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07002086 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08002087 *
2088 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 */
Jan Kara72b045a2017-11-15 17:34:33 -08002090unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002091 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002092 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002094 XA_STATE(xas, &mapping->i_pages, *index);
2095 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002096 unsigned ret = 0;
2097
2098 if (unlikely(!nr_pages))
2099 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100
Nick Piggina60637c2008-07-25 19:45:31 -07002101 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002102 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002103 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07002104 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002105 /*
2106 * Shadow entries should never be tagged, but this iteration
2107 * is lockless so there is a window for page reclaim to evict
2108 * a page we saw tagged. Skip over it.
2109 */
2110 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002111 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002112
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002113 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002114 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002115
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002116 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002117 if (unlikely(page != xas_reload(&xas)))
2118 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002119
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002120 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08002121 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002122 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08002123 goto out;
2124 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002125 continue;
2126put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002127 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002128retry:
2129 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002130 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002131
Jan Kara72b045a2017-11-15 17:34:33 -08002132 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002133 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002134 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002135 * iteration when there is a page at index -1 but that is already
2136 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002137 */
2138 if (end == (pgoff_t)-1)
2139 *index = (pgoff_t)-1;
2140 else
2141 *index = end + 1;
2142out:
Nick Piggina60637c2008-07-25 19:45:31 -07002143 rcu_read_unlock();
2144
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 return ret;
2146}
Jan Kara72b045a2017-11-15 17:34:33 -08002147EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002149/*
2150 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2151 * a _large_ part of the i/o request. Imagine the worst scenario:
2152 *
2153 * ---R__________________________________________B__________
2154 * ^ reading here ^ bad block(assume 4k)
2155 *
2156 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2157 * => failing the whole request => read(R) => read(R+1) =>
2158 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2159 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2160 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2161 *
2162 * It is going insane. Fix it by quickly scaling down the readahead size.
2163 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002164static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002165{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002166 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002167}
2168
Randy Dunlap485bb992006-06-23 02:03:49 -07002169/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002170 * generic_file_buffered_read - generic file read routine
2171 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05002172 * @iter: data destination
2173 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07002174 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07002176 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 *
2178 * This is really ugly. But the goto's actually try to clarify some
2179 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002180 *
2181 * Return:
2182 * * total number of bytes copied, including those the were already @written
2183 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002185ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002186 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002188 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002189 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002191 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002192 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002193 pgoff_t index;
2194 pgoff_t last_index;
2195 pgoff_t prev_index;
2196 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002197 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002198 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002199
Wei Fangc2a97372016-10-07 17:01:52 -07002200 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002201 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002202 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2203
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002204 index = *ppos >> PAGE_SHIFT;
2205 prev_index = ra->prev_pos >> PAGE_SHIFT;
2206 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2207 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2208 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209
Jens Axboe13bd6912020-10-17 08:31:29 -06002210 /*
2211 * If we've already successfully copied some data, then we
2212 * can no longer safely return -EIOCBQUEUED. Hence mark
2213 * an async read NOWAIT at that point.
2214 */
2215 if (written && (iocb->ki_flags & IOCB_WAITQ))
2216 iocb->ki_flags |= IOCB_NOWAIT;
2217
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 for (;;) {
2219 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002220 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002221 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 unsigned long nr, ret;
2223
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002226 if (fatal_signal_pending(current)) {
2227 error = -EINTR;
2228 goto out;
2229 }
2230
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002232 if (!page) {
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002233 if (iocb->ki_flags & IOCB_NOIO)
Milosz Tanski3239d832017-08-29 16:13:19 +02002234 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002235 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002236 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002237 index, last_index - index);
2238 page = find_get_page(mapping, index);
2239 if (unlikely(page == NULL))
2240 goto no_cached_page;
2241 }
2242 if (PageReadahead(page)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002243 if (iocb->ki_flags & IOCB_NOIO) {
2244 put_page(page);
2245 goto out;
2246 }
Rusty Russellcf914a72007-07-19 01:48:08 -07002247 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002248 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002249 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002251 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07002252 /*
2253 * See comment in do_read_cache_page on why
2254 * wait_on_page_locked is used to avoid unnecessarily
2255 * serialisations and why it's safe.
2256 */
Jens Axboe1a0a7852020-05-22 09:18:38 -06002257 if (iocb->ki_flags & IOCB_WAITQ) {
2258 if (written) {
2259 put_page(page);
2260 goto out;
2261 }
2262 error = wait_on_page_locked_async(page,
2263 iocb->ki_waitq);
2264 } else {
2265 if (iocb->ki_flags & IOCB_NOWAIT) {
2266 put_page(page);
2267 goto would_block;
2268 }
2269 error = wait_on_page_locked_killable(page);
2270 }
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002271 if (unlikely(error))
2272 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002273 if (PageUptodate(page))
2274 goto page_ok;
2275
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002276 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002277 !mapping->a_ops->is_partially_uptodate)
2278 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002279 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002280 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002281 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002282 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002283 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002284 /* Did it get truncated before we got the lock? */
2285 if (!page->mapping)
2286 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002287 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002288 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002289 goto page_not_up_to_date_locked;
2290 unlock_page(page);
2291 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002293 /*
2294 * i_size must be checked after we know the page is Uptodate.
2295 *
2296 * Checking i_size after the check allows us to calculate
2297 * the correct value for "nr", which means the zero-filled
2298 * part of the page is not copied back to userspace (unless
2299 * another truncate extends the file - this is desired though).
2300 */
2301
2302 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002303 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002304 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002305 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002306 goto out;
2307 }
2308
2309 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002310 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002311 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002312 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002313 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002314 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002315 goto out;
2316 }
2317 }
2318 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
2320 /* If users can be writing to this page using arbitrary
2321 * virtual addresses, take care about potential aliasing
2322 * before reading the page on the kernel side.
2323 */
2324 if (mapping_writably_mapped(mapping))
2325 flush_dcache_page(page);
2326
2327 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002328 * When a sequential read accesses a page several times,
2329 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 */
Jan Karaec0f1632007-05-06 14:49:25 -07002331 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002332 mark_page_accessed(page);
2333 prev_index = index;
2334
2335 /*
2336 * Ok, we have the page, and it's up-to-date, so
2337 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 */
Al Viro6e58e792014-02-03 17:07:03 -05002339
2340 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002341 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002342 index += offset >> PAGE_SHIFT;
2343 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002344 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002346 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002347 written += ret;
2348 if (!iov_iter_count(iter))
2349 goto out;
2350 if (ret < nr) {
2351 error = -EFAULT;
2352 goto out;
2353 }
2354 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002355
2356page_not_up_to_date:
2357 /* Get exclusive access to the page ... */
Jens Axboe0abed7c2020-11-16 13:36:24 -07002358 if (iocb->ki_flags & IOCB_WAITQ) {
2359 if (written) {
2360 put_page(page);
2361 goto out;
2362 }
Jens Axboe1a0a7852020-05-22 09:18:38 -06002363 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002364 } else {
Jens Axboe1a0a7852020-05-22 09:18:38 -06002365 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002366 }
Oleg Nesterov85462322008-06-08 21:20:43 +04002367 if (unlikely(error))
2368 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002370page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002371 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002372 if (!page->mapping) {
2373 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002374 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375 continue;
2376 }
2377
2378 /* Did somebody else fill it already? */
2379 if (PageUptodate(page)) {
2380 unlock_page(page);
2381 goto page_ok;
2382 }
2383
2384readpage:
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002385 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002386 unlock_page(page);
2387 put_page(page);
2388 goto would_block;
2389 }
Jeff Moyer91803b42010-05-26 11:49:40 -04002390 /*
2391 * A previous I/O error may have been due to temporary
2392 * failures, eg. multipath errors.
2393 * PG_error will be set again if readpage fails.
2394 */
2395 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002396 /* Start the actual read. The read will unlock the page. */
2397 error = mapping->a_ops->readpage(filp, page);
2398
Zach Brown994fc28c2005-12-15 14:28:17 -08002399 if (unlikely(error)) {
2400 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002401 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002402 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002403 goto find_page;
2404 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002405 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002406 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407
2408 if (!PageUptodate(page)) {
Jens Axboe0abed7c2020-11-16 13:36:24 -07002409 if (iocb->ki_flags & IOCB_WAITQ) {
2410 if (written) {
2411 put_page(page);
2412 goto out;
2413 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002414 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002415 } else {
Hao Xuc8d317a2020-09-29 20:00:45 +08002416 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002417 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002418
Oleg Nesterov85462322008-06-08 21:20:43 +04002419 if (unlikely(error))
2420 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002421 if (!PageUptodate(page)) {
2422 if (page->mapping == NULL) {
2423 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002424 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 */
2426 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002427 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002428 goto find_page;
2429 }
2430 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002431 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002432 error = -EIO;
2433 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 }
2435 unlock_page(page);
2436 }
2437
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 goto page_ok;
2439
2440readpage_error:
2441 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002442 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002443 goto out;
2444
2445no_cached_page:
2446 /*
2447 * Ok, it wasn't cached, so we need to create a new
2448 * page..
2449 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002450 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002451 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002452 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002453 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002455 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002456 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002458 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002459 if (error == -EEXIST) {
2460 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002462 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 goto out;
2464 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 goto readpage;
2466 }
2467
Milosz Tanski3239d832017-08-29 16:13:19 +02002468would_block:
2469 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002471 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002472 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002473 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002475 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002476 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002477 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002479EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480
Randy Dunlap485bb992006-06-23 02:03:49 -07002481/**
Al Viro6abd2322014-04-04 14:20:57 -04002482 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002483 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002484 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002485 *
Al Viro6abd2322014-04-04 14:20:57 -04002486 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002488 *
2489 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2490 * be returned when no data can be read without waiting for I/O requests
2491 * to complete; it doesn't prevent readahead.
2492 *
2493 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2494 * requests shall be made for the read or for readahead. When no data
2495 * can be read, -EAGAIN shall be returned. When readahead would be
2496 * triggered, a partial, possibly empty read shall be returned.
2497 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002498 * Return:
2499 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002500 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 */
2502ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002503generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002505 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002506 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002507
2508 if (!count)
2509 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510
Al Viro2ba48ce2015-04-09 13:52:01 -04002511 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002512 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002513 struct address_space *mapping = file->f_mapping;
2514 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002515 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002518 if (iocb->ki_flags & IOCB_NOWAIT) {
2519 if (filemap_range_has_page(mapping, iocb->ki_pos,
2520 iocb->ki_pos + count - 1))
2521 return -EAGAIN;
2522 } else {
2523 retval = filemap_write_and_wait_range(mapping,
2524 iocb->ki_pos,
2525 iocb->ki_pos + count - 1);
2526 if (retval < 0)
2527 goto out;
2528 }
Al Viroed978a82014-03-05 22:53:04 -05002529
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002530 file_accessed(file);
2531
Al Viro5ecda132017-04-13 14:13:36 -04002532 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002533 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002534 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002535 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002536 }
Al Viro5b47d592017-05-08 13:54:47 -04002537 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002538
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002539 /*
2540 * Btrfs can have a short DIO read if we encounter
2541 * compressed extents, so if there was an error, or if
2542 * we've already read everything we wanted to, or if
2543 * there was a short read because we hit EOF, go ahead
2544 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002545 * the rest of the read. Buffered reads will not work for
2546 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002547 */
Al Viro5ecda132017-04-13 14:13:36 -04002548 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002549 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002550 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 }
2552
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002553 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002554out:
2555 return retval;
2556}
Al Viroed978a82014-03-05 22:53:04 -05002557EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002561/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002562 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002563 * @vmf - the vm_fault for this fault.
2564 * @page - the page to lock.
2565 * @fpin - the pointer to the file we may pin (or is already pinned).
2566 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002567 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002568 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002569 * 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 -07002570 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002571 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002572static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2573 struct file **fpin)
2574{
2575 if (trylock_page(page))
2576 return 1;
2577
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002578 /*
2579 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002580 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002581 * is supposed to work. We have way too many special cases..
2582 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002583 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2584 return 0;
2585
2586 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2587 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2588 if (__lock_page_killable(page)) {
2589 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002590 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002591 * but all fault_handlers only check for fatal signals
2592 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002593 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002594 */
2595 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002596 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002597 return 0;
2598 }
2599 } else
2600 __lock_page(page);
2601 return 1;
2602}
2603
2604
2605/*
2606 * Synchronous readahead happens when we don't even find a page in the page
2607 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2608 * to drop the mmap sem we return the file that was pinned in order for us to do
2609 * that. If we didn't pin a file then we return NULL. The file that is
2610 * returned needs to be fput()'ed when we're done with it.
2611 */
2612static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002613{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002614 struct file *file = vmf->vma->vm_file;
2615 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002616 struct address_space *mapping = file->f_mapping;
David Howellsdb660d42020-10-15 20:06:31 -07002617 DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002618 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002619 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002620
2621 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002622 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002623 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002624 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002625 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002626
Josef Bacik2a1180f2019-03-13 11:44:18 -07002627 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002628 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002629 page_cache_sync_ra(&ractl, ra, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002630 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002631 }
2632
Andi Kleen207d04b2011-05-24 17:12:29 -07002633 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002634 mmap_miss = READ_ONCE(ra->mmap_miss);
2635 if (mmap_miss < MMAP_LOTSAMISS * 10)
2636 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002637
2638 /*
2639 * Do we miss much more than hit in this file? If so,
2640 * stop bothering with read-ahead. It will only hurt.
2641 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002642 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002643 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002644
Wu Fengguangd30a1102009-06-16 15:31:30 -07002645 /*
2646 * mmap read-around
2647 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002648 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002649 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002650 ra->size = ra->ra_pages;
2651 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002652 ractl._index = ra->start;
2653 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002654 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002655}
2656
2657/*
2658 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002659 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002660 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002661 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002662static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2663 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002664{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002665 struct file *file = vmf->vma->vm_file;
2666 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002667 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002668 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002669 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002670 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002671
2672 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002673 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002674 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002675 mmap_miss = READ_ONCE(ra->mmap_miss);
2676 if (mmap_miss)
2677 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002678 if (PageReadahead(page)) {
2679 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002680 page_cache_async_readahead(mapping, ra, file,
2681 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002682 }
2683 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002684}
2685
Randy Dunlap485bb992006-06-23 02:03:49 -07002686/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002687 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002688 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002689 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002690 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691 * mapped memory region to read in file data during a page fault.
2692 *
2693 * The goto's are kind of ugly, but this streamlines the normal case of having
2694 * it in the page cache, and handles the special cases reasonably without
2695 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002696 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002697 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002698 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002699 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002700 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002701 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002702 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002703 * has not been released.
2704 *
2705 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002706 *
2707 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002708 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002709vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710{
2711 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002712 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002713 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714 struct address_space *mapping = file->f_mapping;
2715 struct file_ra_state *ra = &file->f_ra;
2716 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002717 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002718 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002719 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002720 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002721
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002722 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2723 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002724 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002727 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002729 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002730 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002732 * We found the page, so try async readahead before
2733 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002735 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002736 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002737 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002738 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002739 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002740 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002741 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002742retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002743 page = pagecache_get_page(mapping, offset,
2744 FGP_CREAT|FGP_FOR_MMAP,
2745 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002746 if (!page) {
2747 if (fpin)
2748 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002749 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751 }
2752
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002753 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2754 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002755
2756 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002757 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002758 unlock_page(page);
2759 put_page(page);
2760 goto retry_find;
2761 }
Song Liu520e5ba2019-09-23 15:37:50 -07002762 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002763
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002765 * We have a locked page in the page cache, now we need to check
2766 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767 */
Nick Piggind00806b2007-07-19 01:46:57 -07002768 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 goto page_not_uptodate;
2770
Linus Torvaldsef00e082009-06-16 15:31:25 -07002771 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002772 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002773 * time to return to the upper layer and have it re-find the vma and
2774 * redo the fault.
2775 */
2776 if (fpin) {
2777 unlock_page(page);
2778 goto out_retry;
2779 }
2780
2781 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002782 * Found the page and have a reference on it.
2783 * We must recheck i_size under page lock.
2784 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002785 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2786 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002787 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002788 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002789 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002790 }
2791
Nick Piggind0217ac2007-07-19 01:47:03 -07002792 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002793 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002794
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796 /*
2797 * Umm, take care of errors if the page isn't up-to-date.
2798 * Try to re-read it _once_. We do this synchronously,
2799 * because there really aren't any performance issues here
2800 * and we need to check for errors.
2801 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002803 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002804 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002805 if (!error) {
2806 wait_on_page_locked(page);
2807 if (!PageUptodate(page))
2808 error = -EIO;
2809 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002810 if (fpin)
2811 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002812 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002813
2814 if (!error || error == AOP_TRUNCATED_PAGE)
2815 goto retry_find;
2816
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002817 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002818 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002819
2820out_retry:
2821 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002822 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002823 * re-find the vma and come back and find our hopefully still populated
2824 * page.
2825 */
2826 if (page)
2827 put_page(page);
2828 if (fpin)
2829 fput(fpin);
2830 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002831}
2832EXPORT_SYMBOL(filemap_fault);
2833
Jan Kara82b0f8c2016-12-14 15:06:58 -08002834void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002835 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002836{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002837 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002838 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002839 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002840 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002841 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002842 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002843 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002844
2845 rcu_read_lock();
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002846 xas_for_each(&xas, head, end_pgoff) {
2847 if (xas_retry(&xas, head))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002848 continue;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002849 if (xa_is_value(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002850 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002851
Michal Hockoe0975b22018-12-28 00:38:36 -08002852 /*
2853 * Check for a locked page first, as a speculative
2854 * reference may adversely influence page migration.
2855 */
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002856 if (PageLocked(head))
Michal Hockoe0975b22018-12-28 00:38:36 -08002857 goto next;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002858 if (!page_cache_get_speculative(head))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002859 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002860
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002861 /* Has the page moved or been split? */
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002862 if (unlikely(head != xas_reload(&xas)))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002863 goto skip;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002864 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002865
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002866 if (!PageUptodate(head) ||
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002867 PageReadahead(page) ||
2868 PageHWPoison(page))
2869 goto skip;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002870 if (!trylock_page(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002871 goto skip;
2872
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002873 if (head->mapping != mapping || !PageUptodate(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002874 goto unlock;
2875
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002876 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002877 if (xas.xa_index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002878 goto unlock;
2879
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002880 if (mmap_miss > 0)
2881 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002882
Matthew Wilcox070e8072018-05-17 00:08:30 -04002883 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002884 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002885 vmf->pte += xas.xa_index - last_pgoff;
2886 last_pgoff = xas.xa_index;
Johannes Weiner9d82c692020-06-03 16:02:04 -07002887 if (alloc_set_pte(vmf, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002888 goto unlock;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002889 unlock_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002890 goto next;
2891unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002892 unlock_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002893skip:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002894 put_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002895next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002896 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002897 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002898 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002899 }
2900 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002901 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002902}
2903EXPORT_SYMBOL(filemap_map_pages);
2904
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002905vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002906{
2907 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002908 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002909 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002910
Jan Kara14da9202012-06-12 16:20:37 +02002911 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002912 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002913 lock_page(page);
2914 if (page->mapping != inode->i_mapping) {
2915 unlock_page(page);
2916 ret = VM_FAULT_NOPAGE;
2917 goto out;
2918 }
Jan Kara14da9202012-06-12 16:20:37 +02002919 /*
2920 * We mark the page dirty already here so that when freeze is in
2921 * progress, we are guaranteed that writeback during freezing will
2922 * see the dirty page and writeprotect it again.
2923 */
2924 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002925 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002926out:
Jan Kara14da9202012-06-12 16:20:37 +02002927 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002928 return ret;
2929}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002930
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002931const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002932 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002933 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002934 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935};
2936
2937/* This is used for a general mmap of a disk file */
2938
2939int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2940{
2941 struct address_space *mapping = file->f_mapping;
2942
2943 if (!mapping->a_ops->readpage)
2944 return -ENOEXEC;
2945 file_accessed(file);
2946 vma->vm_ops = &generic_file_vm_ops;
2947 return 0;
2948}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002949
2950/*
2951 * This is for filesystems which do not implement ->writepage.
2952 */
2953int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2954{
2955 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2956 return -EINVAL;
2957 return generic_file_mmap(file, vma);
2958}
2959#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002960vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07002961{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002962 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07002963}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2965{
2966 return -ENOSYS;
2967}
2968int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2969{
2970 return -ENOSYS;
2971}
2972#endif /* CONFIG_MMU */
2973
Arnd Bergmann453972282018-04-13 15:35:27 -07002974EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975EXPORT_SYMBOL(generic_file_mmap);
2976EXPORT_SYMBOL(generic_file_readonly_mmap);
2977
Sasha Levin67f9fd92014-04-03 14:48:18 -07002978static struct page *wait_on_page_read(struct page *page)
2979{
2980 if (!IS_ERR(page)) {
2981 wait_on_page_locked(page);
2982 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002983 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002984 page = ERR_PTR(-EIO);
2985 }
2986 }
2987 return page;
2988}
2989
Mel Gorman32b63522016-03-15 14:55:36 -07002990static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002991 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002992 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002993 void *data,
2994 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995{
Nick Piggineb2be182007-10-16 01:24:57 -07002996 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997 int err;
2998repeat:
2999 page = find_get_page(mapping, index);
3000 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003001 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003002 if (!page)
3003 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003004 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003005 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003006 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003007 if (err == -EEXIST)
3008 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003009 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010 return ERR_PTR(err);
3011 }
Mel Gorman32b63522016-03-15 14:55:36 -07003012
3013filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003014 if (filler)
3015 err = filler(data, page);
3016 else
3017 err = mapping->a_ops->readpage(data, page);
3018
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003020 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003021 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003022 }
Mel Gorman32b63522016-03-15 14:55:36 -07003023
3024 page = wait_on_page_read(page);
3025 if (IS_ERR(page))
3026 return page;
3027 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003029 if (PageUptodate(page))
3030 goto out;
3031
Mel Gormanebded022016-03-15 14:55:39 -07003032 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003033 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003034 * case a: Page is being filled and the page lock is held
3035 * case b: Read/write error clearing the page uptodate status
3036 * case c: Truncation in progress (page locked)
3037 * case d: Reclaim in progress
3038 *
3039 * Case a, the page will be up to date when the page is unlocked.
3040 * There is no need to serialise on the page lock here as the page
3041 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003042 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003043 * it's a race vs truncate race.
3044 * Case b, the page will not be up to date
3045 * Case c, the page may be truncated but in itself, the data may still
3046 * be valid after IO completes as it's a read vs truncate race. The
3047 * operation must restart if the page is not uptodate on unlock but
3048 * otherwise serialising on page lock to stabilise the mapping gives
3049 * no additional guarantees to the caller as the page lock is
3050 * released before return.
3051 * Case d, similar to truncation. If reclaim holds the page lock, it
3052 * will be a race with remove_mapping that determines if the mapping
3053 * is valid on unlock but otherwise the data is valid and there is
3054 * no need to serialise with page lock.
3055 *
3056 * As the page lock gives no additional guarantee, we optimistically
3057 * wait on the page to be unlocked and check if it's up to date and
3058 * use the page if it is. Otherwise, the page lock is required to
3059 * distinguish between the different cases. The motivation is that we
3060 * avoid spurious serialisations and wakeups when multiple processes
3061 * wait on the same page for IO to complete.
3062 */
3063 wait_on_page_locked(page);
3064 if (PageUptodate(page))
3065 goto out;
3066
3067 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003069
3070 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071 if (!page->mapping) {
3072 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003073 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003074 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075 }
Mel Gormanebded022016-03-15 14:55:39 -07003076
3077 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003078 if (PageUptodate(page)) {
3079 unlock_page(page);
3080 goto out;
3081 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003082
3083 /*
3084 * A previous I/O error may have been due to temporary
3085 * failures.
3086 * Clear page error before actual read, PG_error will be
3087 * set again if read page fails.
3088 */
3089 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003090 goto filler;
3091
David Howellsc855ff32007-05-09 13:42:20 +01003092out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003093 mark_page_accessed(page);
3094 return page;
3095}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003096
3097/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003098 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003099 * @mapping: the page's address_space
3100 * @index: the page index
3101 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003102 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003103 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003104 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003105 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003106 *
3107 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003108 *
3109 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003110 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003111struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003112 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003113 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003114 void *data)
3115{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003116 return do_read_cache_page(mapping, index, filler, data,
3117 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003118}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003119EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003120
3121/**
3122 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3123 * @mapping: the page's address_space
3124 * @index: the page index
3125 * @gfp: the page allocator flags to use if allocating
3126 *
3127 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003128 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003129 *
3130 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003131 *
3132 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003133 */
3134struct page *read_cache_page_gfp(struct address_space *mapping,
3135 pgoff_t index,
3136 gfp_t gfp)
3137{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003138 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003139}
3140EXPORT_SYMBOL(read_cache_page_gfp);
3141
Nick Pigginafddba42007-10-16 01:25:01 -07003142int pagecache_write_begin(struct file *file, struct address_space *mapping,
3143 loff_t pos, unsigned len, unsigned flags,
3144 struct page **pagep, void **fsdata)
3145{
3146 const struct address_space_operations *aops = mapping->a_ops;
3147
Nick Piggin4e02ed42008-10-29 14:00:55 -07003148 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003149 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003150}
3151EXPORT_SYMBOL(pagecache_write_begin);
3152
3153int pagecache_write_end(struct file *file, struct address_space *mapping,
3154 loff_t pos, unsigned len, unsigned copied,
3155 struct page *page, void *fsdata)
3156{
3157 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003158
Nick Piggin4e02ed42008-10-29 14:00:55 -07003159 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003160}
3161EXPORT_SYMBOL(pagecache_write_end);
3162
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003163/*
3164 * Warn about a page cache invalidation failure during a direct I/O write.
3165 */
3166void dio_warn_stale_pagecache(struct file *filp)
3167{
3168 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3169 char pathname[128];
3170 struct inode *inode = file_inode(filp);
3171 char *path;
3172
3173 errseq_set(&inode->i_mapping->wb_err, -EIO);
3174 if (__ratelimit(&_rs)) {
3175 path = file_path(filp, pathname, sizeof(pathname));
3176 if (IS_ERR(path))
3177 path = "(unknown)";
3178 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3179 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3180 current->comm);
3181 }
3182}
3183
Linus Torvalds1da177e2005-04-16 15:20:36 -07003184ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003185generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003186{
3187 struct file *file = iocb->ki_filp;
3188 struct address_space *mapping = file->f_mapping;
3189 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003190 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003191 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003192 size_t write_len;
3193 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003194
Al Viro0c949332014-03-22 06:51:37 -04003195 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003196 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003197
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003198 if (iocb->ki_flags & IOCB_NOWAIT) {
3199 /* If there are pages to writeback, return */
3200 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003201 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003202 return -EAGAIN;
3203 } else {
3204 written = filemap_write_and_wait_range(mapping, pos,
3205 pos + write_len - 1);
3206 if (written)
3207 goto out;
3208 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003209
3210 /*
3211 * After a write we want buffered reads to be sure to go to disk to get
3212 * the new data. We invalidate clean cached page from the region we're
3213 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003214 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003215 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003216 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003217 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003218 /*
3219 * If a page can not be invalidated, return 0 to fall back
3220 * to buffered write.
3221 */
3222 if (written) {
3223 if (written == -EBUSY)
3224 return 0;
3225 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003226 }
3227
Al Viro639a93a52017-04-13 14:10:15 -04003228 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003229
3230 /*
3231 * Finally, try again to invalidate clean pages which might have been
3232 * cached by non-direct readahead, or faulted in by get_user_pages()
3233 * if the source of the write was an mmap'ed region of the file
3234 * we're writing. Either one is a pretty crazy thing to do,
3235 * so we don't support it 100%. If this invalidation
3236 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003237 *
3238 * Most of the time we do not need this since dio_complete() will do
3239 * the invalidation for us. However there are some file systems that
3240 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003241 * them by removing it completely.
3242 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003243 * Noticeable example is a blkdev_direct_IO().
3244 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003245 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003246 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003247 if (written > 0 && mapping->nrpages &&
3248 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3249 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003250
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003252 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003253 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003254 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3255 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256 mark_inode_dirty(inode);
3257 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003258 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259 }
Al Viro639a93a52017-04-13 14:10:15 -04003260 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003261out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003262 return written;
3263}
3264EXPORT_SYMBOL(generic_file_direct_write);
3265
Nick Piggineb2be182007-10-16 01:24:57 -07003266/*
3267 * Find or create a page at the given pagecache position. Return the locked
3268 * page. This function is specifically for buffered writes.
3269 */
Nick Piggin54566b22009-01-04 12:00:53 -08003270struct page *grab_cache_page_write_begin(struct address_space *mapping,
3271 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003272{
Nick Piggineb2be182007-10-16 01:24:57 -07003273 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003274 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003275
Nick Piggin54566b22009-01-04 12:00:53 -08003276 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003277 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003278
Mel Gorman2457aec2014-06-04 16:10:31 -07003279 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003280 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003281 if (page)
3282 wait_for_stable_page(page);
3283
Nick Piggineb2be182007-10-16 01:24:57 -07003284 return page;
3285}
Nick Piggin54566b22009-01-04 12:00:53 -08003286EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003287
Al Viro3b93f912014-02-11 21:34:08 -05003288ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003289 struct iov_iter *i, loff_t pos)
3290{
3291 struct address_space *mapping = file->f_mapping;
3292 const struct address_space_operations *a_ops = mapping->a_ops;
3293 long status = 0;
3294 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003295 unsigned int flags = 0;
3296
Nick Pigginafddba42007-10-16 01:25:01 -07003297 do {
3298 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003299 unsigned long offset; /* Offset into pagecache page */
3300 unsigned long bytes; /* Bytes to write to page */
3301 size_t copied; /* Bytes copied from user */
3302 void *fsdata;
3303
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003304 offset = (pos & (PAGE_SIZE - 1));
3305 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003306 iov_iter_count(i));
3307
3308again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003309 /*
3310 * Bring in the user page that we will copy from _first_.
3311 * Otherwise there's a nasty deadlock on copying from the
3312 * same page as we're writing to, without it being marked
3313 * up-to-date.
3314 *
3315 * Not only is this an optimisation, but it is also required
3316 * to check that the address is actually valid, when atomic
3317 * usercopies are used, below.
3318 */
3319 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3320 status = -EFAULT;
3321 break;
3322 }
3323
Jan Kara296291c2015-10-22 13:32:21 -07003324 if (fatal_signal_pending(current)) {
3325 status = -EINTR;
3326 break;
3327 }
3328
Nick Piggin674b8922007-10-16 01:25:03 -07003329 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003330 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003331 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003332 break;
3333
anfei zhou931e80e2010-02-02 13:44:02 -08003334 if (mapping_writably_mapped(mapping))
3335 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003336
Nick Pigginafddba42007-10-16 01:25:01 -07003337 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003338 flush_dcache_page(page);
3339
3340 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3341 page, fsdata);
3342 if (unlikely(status < 0))
3343 break;
3344 copied = status;
3345
3346 cond_resched();
3347
Nick Piggin124d3b72008-02-02 15:01:17 +01003348 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003349 if (unlikely(copied == 0)) {
3350 /*
3351 * If we were unable to copy any data at all, we must
3352 * fall back to a single segment length write.
3353 *
3354 * If we didn't fallback here, we could livelock
3355 * because not all segments in the iov can be copied at
3356 * once without a pagefault.
3357 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003358 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003359 iov_iter_single_seg_count(i));
3360 goto again;
3361 }
Nick Pigginafddba42007-10-16 01:25:01 -07003362 pos += copied;
3363 written += copied;
3364
3365 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003366 } while (iov_iter_count(i));
3367
3368 return written ? written : status;
3369}
Al Viro3b93f912014-02-11 21:34:08 -05003370EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371
Jan Karae4dd9de2009-08-17 18:10:06 +02003372/**
Al Viro81742022014-04-03 03:17:43 -04003373 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003374 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003375 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003376 *
3377 * This function does all the work needed for actually writing data to a
3378 * file. It does all basic checks, removes SUID from the file, updates
3379 * modification times and calls proper subroutines depending on whether we
3380 * do direct IO or a standard buffered write.
3381 *
3382 * It expects i_mutex to be grabbed unless we work on a block device or similar
3383 * object which does not need locking at all.
3384 *
3385 * This function does *not* take care of syncing data in case of O_SYNC write.
3386 * A caller has to handle it. This is mainly due to the fact that we want to
3387 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003388 *
3389 * Return:
3390 * * number of bytes written, even for truncated writes
3391 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003392 */
Al Viro81742022014-04-03 03:17:43 -04003393ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003394{
3395 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003396 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003397 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003398 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003399 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003400 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003401
Linus Torvalds1da177e2005-04-16 15:20:36 -07003402 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003403 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003404 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003405 if (err)
3406 goto out;
3407
Josef Bacikc3b2da32012-03-26 09:59:21 -04003408 err = file_update_time(file);
3409 if (err)
3410 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003411
Al Viro2ba48ce2015-04-09 13:52:01 -04003412 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003413 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003414
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003415 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003416 /*
3417 * If the write stopped short of completing, fall back to
3418 * buffered writes. Some filesystems do this for writes to
3419 * holes, for example. For DAX files, a buffered write will
3420 * not succeed (even if it did, DAX does not handle dirty
3421 * page-cache pages correctly).
3422 */
Al Viro0b8def92015-04-07 10:22:53 -04003423 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003424 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003425
Al Viro0b8def92015-04-07 10:22:53 -04003426 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003427 /*
Al Viro3b93f912014-02-11 21:34:08 -05003428 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003429 * then we want to return the number of bytes which were
3430 * direct-written, or the error code if that was zero. Note
3431 * that this differs from normal direct-io semantics, which
3432 * will return -EFOO even if some bytes were written.
3433 */
Al Viro60bb4522014-08-08 12:39:16 -04003434 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003435 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003436 goto out;
3437 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003438 /*
3439 * We need to ensure that the page cache pages are written to
3440 * disk and invalidated to preserve the expected O_DIRECT
3441 * semantics.
3442 */
Al Viro3b93f912014-02-11 21:34:08 -05003443 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003444 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003445 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003446 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003447 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003448 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003449 pos >> PAGE_SHIFT,
3450 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003451 } else {
3452 /*
3453 * We don't know how much we wrote, so just return
3454 * the number of bytes which were direct-written
3455 */
3456 }
3457 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003458 written = generic_perform_write(file, from, iocb->ki_pos);
3459 if (likely(written > 0))
3460 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003461 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003462out:
3463 current->backing_dev_info = NULL;
3464 return written ? written : err;
3465}
Al Viro81742022014-04-03 03:17:43 -04003466EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467
Jan Karae4dd9de2009-08-17 18:10:06 +02003468/**
Al Viro81742022014-04-03 03:17:43 -04003469 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003470 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003471 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003472 *
Al Viro81742022014-04-03 03:17:43 -04003473 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003474 * filesystems. It takes care of syncing the file in case of O_SYNC file
3475 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003476 * Return:
3477 * * negative error code if no data has been written at all of
3478 * vfs_fsync_range() failed for a synchronous write
3479 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003480 */
Al Viro81742022014-04-03 03:17:43 -04003481ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003482{
3483 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003484 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003486
Al Viro59551022016-01-22 15:40:57 -05003487 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003488 ret = generic_write_checks(iocb, from);
3489 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003490 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003491 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492
Christoph Hellwige2592212016-04-07 08:52:01 -07003493 if (ret > 0)
3494 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003495 return ret;
3496}
Al Viro81742022014-04-03 03:17:43 -04003497EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498
David Howellscf9a2ae2006-08-29 19:05:54 +01003499/**
3500 * try_to_release_page() - release old fs-specific metadata on a page
3501 *
3502 * @page: the page which the kernel is trying to free
3503 * @gfp_mask: memory allocation flags (and I/O mode)
3504 *
3505 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003506 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003507 *
David Howells266cf652009-04-03 16:42:36 +01003508 * This may also be called if PG_fscache is set on a page, indicating that the
3509 * page is known to the local caching routines.
3510 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003511 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003512 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003513 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003514 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003515 */
3516int try_to_release_page(struct page *page, gfp_t gfp_mask)
3517{
3518 struct address_space * const mapping = page->mapping;
3519
3520 BUG_ON(!PageLocked(page));
3521 if (PageWriteback(page))
3522 return 0;
3523
3524 if (mapping && mapping->a_ops->releasepage)
3525 return mapping->a_ops->releasepage(page, gfp_mask);
3526 return try_to_free_buffers(page);
3527}
3528
3529EXPORT_SYMBOL(try_to_release_page);