blob: 125b69f59caadaa21468ad81c0301ab8272358fa [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;
Waiman Long032f8e02021-02-04 18:32:45 -0800838 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700839
Sasha Levin309381fea2014-01-23 15:52:54 -0800840 VM_BUG_ON_PAGE(!PageLocked(page), page);
841 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500842 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700843
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300844 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700845 page->mapping = mapping;
846 page->index = offset;
847
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700848 if (!huge) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700849 error = mem_cgroup_charge(page, current->mm, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700850 if (error)
851 goto error;
Waiman Long032f8e02021-02-04 18:32:45 -0800852 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700853 }
854
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700855 gfp &= GFP_RECLAIM_MASK;
856
Matthew Wilcox74d60952017-11-17 10:01:45 -0500857 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700858 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
859 void *entry, *old = NULL;
860
861 if (order > thp_order(page))
862 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
863 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500864 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700865 xas_for_each_conflict(&xas, entry) {
866 old = entry;
867 if (!xa_is_value(entry)) {
868 xas_set_err(&xas, -EEXIST);
869 goto unlock;
870 }
871 }
872
873 if (old) {
874 if (shadowp)
875 *shadowp = old;
876 /* entry may have been split before we acquired lock */
877 order = xa_get_order(xas.xa, xas.xa_index);
878 if (order > thp_order(page)) {
879 xas_split(&xas, old, order);
880 xas_reset(&xas);
881 }
882 }
883
Matthew Wilcox74d60952017-11-17 10:01:45 -0500884 xas_store(&xas, page);
885 if (xas_error(&xas))
886 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700887
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700888 if (old)
Matthew Wilcox74d60952017-11-17 10:01:45 -0500889 mapping->nrexceptional--;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500890 mapping->nrpages++;
891
892 /* hugetlb pages do not participate in page cache accounting */
893 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700894 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500895unlock:
896 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700897 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500898
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700899 if (xas_error(&xas)) {
900 error = xas_error(&xas);
Waiman Long032f8e02021-02-04 18:32:45 -0800901 if (charged)
902 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500903 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700904 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500905
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700906 trace_mm_filemap_add_to_page_cache(page);
907 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500908error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700909 page->mapping = NULL;
910 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300911 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700912 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700914ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700915
916/**
917 * add_to_page_cache_locked - add a locked page to the pagecache
918 * @page: page to add
919 * @mapping: the page's address_space
920 * @offset: page index
921 * @gfp_mask: page allocation mode
922 *
923 * This function is used to add a page to the pagecache. It must be locked.
924 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800925 *
926 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700927 */
928int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
929 pgoff_t offset, gfp_t gfp_mask)
930{
931 return __add_to_page_cache_locked(page, mapping, offset,
932 gfp_mask, NULL);
933}
Nick Piggine2867812008-07-25 19:45:30 -0700934EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
936int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400937 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938{
Johannes Weinera5289102014-04-03 14:47:51 -0700939 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700940 int ret;
941
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800942 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700943 ret = __add_to_page_cache_locked(page, mapping, offset,
944 gfp_mask, &shadow);
945 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800946 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700947 else {
948 /*
949 * The page might have been evicted from cache only
950 * recently, in which case it should be activated like
951 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700952 * The exception is pages getting rewritten; evicting other
953 * data from the working set, only to cache data that will
954 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700955 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700956 WARN_ON_ONCE(PageActive(page));
957 if (!(gfp_mask & __GFP_WRITE) && shadow)
958 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700959 lru_cache_add(page);
960 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 return ret;
962}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300963EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Paul Jackson44110fe2006-03-24 03:16:04 -0800965#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700966struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800967{
Miao Xiec0ff7452010-05-24 14:32:08 -0700968 int n;
969 struct page *page;
970
Paul Jackson44110fe2006-03-24 03:16:04 -0800971 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700972 unsigned int cpuset_mems_cookie;
973 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700974 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700975 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700976 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700977 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700978
Miao Xiec0ff7452010-05-24 14:32:08 -0700979 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800980 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700981 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800982}
Nick Piggin2ae88142006-10-28 10:38:23 -0700983EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800984#endif
985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986/*
987 * In order to wait for pages to become available there must be
988 * waitqueues associated with pages. By using a hash table of
989 * waitqueues where the bucket discipline is to maintain all
990 * waiters on the same queue and wake all when any of the pages
991 * become available, and for the woken contexts to check to be
992 * sure the appropriate page became available, this saves space
993 * at a cost of "thundering herd" phenomena during rare hash
994 * collisions.
995 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000996#define PAGE_WAIT_TABLE_BITS 8
997#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
998static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
999
1000static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001{
Nicholas Piggin62906022016-12-25 13:00:30 +10001002 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003}
Nicholas Piggin62906022016-12-25 13:00:30 +10001004
1005void __init pagecache_init(void)
1006{
1007 int i;
1008
1009 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1010 init_waitqueue_head(&page_wait_table[i]);
1011
1012 page_writeback_init();
1013}
1014
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001015/*
1016 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001017 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001018 * one.
1019 *
1020 * We have:
1021 *
1022 * (a) no special bits set:
1023 *
1024 * We're just waiting for the bit to be released, and when a waker
1025 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1026 * and remove it from the wait queue.
1027 *
1028 * Simple and straightforward.
1029 *
1030 * (b) WQ_FLAG_EXCLUSIVE:
1031 *
1032 * The waiter is waiting to get the lock, and only one waiter should
1033 * be woken up to avoid any thundering herd behavior. We'll set the
1034 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1035 *
1036 * This is the traditional exclusive wait.
1037 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001038 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001039 *
1040 * The waiter is waiting to get the bit, and additionally wants the
1041 * lock to be transferred to it for fair lock behavior. If the lock
1042 * cannot be taken, we stop walking the wait queue without waking
1043 * the waiter.
1044 *
1045 * This is the "fair lock handoff" case, and in addition to setting
1046 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1047 * that it now has the lock.
1048 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001049static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001050{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001051 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001052 struct wait_page_key *key = arg;
1053 struct wait_page_queue *wait_page
1054 = container_of(wait, struct wait_page_queue, wait);
1055
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001056 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001057 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001058
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001059 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001060 * If it's a lock handoff wait, we get the bit for it, and
1061 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001062 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001063 flags = wait->flags;
1064 if (flags & WQ_FLAG_EXCLUSIVE) {
1065 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001066 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001067 if (flags & WQ_FLAG_CUSTOM) {
1068 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1069 return -1;
1070 flags |= WQ_FLAG_DONE;
1071 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001072 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001073
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001074 /*
1075 * We are holding the wait-queue lock, but the waiter that
1076 * is waiting for this will be checking the flags without
1077 * any locking.
1078 *
1079 * So update the flags atomically, and wake up the waiter
1080 * afterwards to avoid any races. This store-release pairs
1081 * with the load-acquire in wait_on_page_bit_common().
1082 */
1083 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001084 wake_up_state(wait->private, mode);
1085
1086 /*
1087 * Ok, we have successfully done what we're waiting for,
1088 * and we can unconditionally remove the wait entry.
1089 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001090 * Note that this pairs with the "finish_wait()" in the
1091 * waiter, and has to be the absolute last thing we do.
1092 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001093 * might be de-allocated and the process might even have
1094 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001095 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001096 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001097 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001098}
1099
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001100static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001101{
1102 wait_queue_head_t *q = page_waitqueue(page);
1103 struct wait_page_key key;
1104 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001105 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001106
1107 key.page = page;
1108 key.bit_nr = bit_nr;
1109 key.page_match = 0;
1110
Tim Chen11a19c72017-08-25 09:13:55 -07001111 bookmark.flags = 0;
1112 bookmark.private = NULL;
1113 bookmark.func = NULL;
1114 INIT_LIST_HEAD(&bookmark.entry);
1115
Nicholas Piggin62906022016-12-25 13:00:30 +10001116 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001117 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1118
1119 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1120 /*
1121 * Take a breather from holding the lock,
1122 * allow pages that finish wake up asynchronously
1123 * to acquire the lock and remove themselves
1124 * from wait queue
1125 */
1126 spin_unlock_irqrestore(&q->lock, flags);
1127 cpu_relax();
1128 spin_lock_irqsave(&q->lock, flags);
1129 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1130 }
1131
Nicholas Piggin62906022016-12-25 13:00:30 +10001132 /*
1133 * It is possible for other pages to have collided on the waitqueue
1134 * hash, so in that case check for a page match. That prevents a long-
1135 * term waiter
1136 *
1137 * It is still possible to miss a case here, when we woke page waiters
1138 * and removed them from the waitqueue, but there are still other
1139 * page waiters.
1140 */
1141 if (!waitqueue_active(q) || !key.page_match) {
1142 ClearPageWaiters(page);
1143 /*
1144 * It's possible to miss clearing Waiters here, when we woke
1145 * our page waiters, but the hashed waitqueue has waiters for
1146 * other pages on it.
1147 *
1148 * That's okay, it's a rare case. The next waker will clear it.
1149 */
1150 }
1151 spin_unlock_irqrestore(&q->lock, flags);
1152}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001153
1154static void wake_up_page(struct page *page, int bit)
1155{
1156 if (!PageWaiters(page))
1157 return;
1158 wake_up_page_bit(page, bit);
1159}
Nicholas Piggin62906022016-12-25 13:00:30 +10001160
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001161/*
1162 * A choice of three behaviors for wait_on_page_bit_common():
1163 */
1164enum behavior {
1165 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1166 * __lock_page() waiting on then setting PG_locked.
1167 */
1168 SHARED, /* Hold ref to page and check the bit when woken, like
1169 * wait_on_page_writeback() waiting on PG_writeback.
1170 */
1171 DROP, /* Drop ref to page before wait, no check when woken,
1172 * like put_and_wait_on_page_locked() on PG_locked.
1173 */
1174};
1175
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001176/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001177 * Attempt to check (or get) the page bit, and mark us done
1178 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001179 */
1180static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1181 struct wait_queue_entry *wait)
1182{
1183 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1184 if (test_and_set_bit(bit_nr, &page->flags))
1185 return false;
1186 } else if (test_bit(bit_nr, &page->flags))
1187 return false;
1188
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001189 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001190 return true;
1191}
1192
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001193/* How many times do we accept lock stealing from under a waiter? */
1194int sysctl_page_lock_unfairness = 5;
1195
Nicholas Piggin62906022016-12-25 13:00:30 +10001196static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001197 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001198{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001199 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001200 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001201 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001202 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001203 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001204 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001205
Johannes Weinereb414682018-10-26 15:06:27 -07001206 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001207 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001208 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001209 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001210 delayacct = true;
1211 }
Johannes Weinereb414682018-10-26 15:06:27 -07001212 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001213 thrashing = true;
1214 }
1215
Nicholas Piggin62906022016-12-25 13:00:30 +10001216 init_wait(wait);
1217 wait->func = wake_page_function;
1218 wait_page.page = page;
1219 wait_page.bit_nr = bit_nr;
1220
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001221repeat:
1222 wait->flags = 0;
1223 if (behavior == EXCLUSIVE) {
1224 wait->flags = WQ_FLAG_EXCLUSIVE;
1225 if (--unfairness < 0)
1226 wait->flags |= WQ_FLAG_CUSTOM;
1227 }
1228
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001229 /*
1230 * Do one last check whether we can get the
1231 * page bit synchronously.
1232 *
1233 * Do the SetPageWaiters() marking before that
1234 * to let any waker we _just_ missed know they
1235 * need to wake us up (otherwise they'll never
1236 * even go to the slow case that looks at the
1237 * page queue), and add ourselves to the wait
1238 * queue if we need to sleep.
1239 *
1240 * This part needs to be done under the queue
1241 * lock to avoid races.
1242 */
1243 spin_lock_irq(&q->lock);
1244 SetPageWaiters(page);
1245 if (!trylock_page_bit_common(page, bit_nr, wait))
1246 __add_wait_queue_entry_tail(q, wait);
1247 spin_unlock_irq(&q->lock);
1248
1249 /*
1250 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001251 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1252 * see whether the page bit testing has already
1253 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001254 *
1255 * We can drop our reference to the page.
1256 */
1257 if (behavior == DROP)
1258 put_page(page);
1259
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001260 /*
1261 * Note that until the "finish_wait()", or until
1262 * we see the WQ_FLAG_WOKEN flag, we need to
1263 * be very careful with the 'wait->flags', because
1264 * we may race with a waker that sets them.
1265 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001266 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001267 unsigned int flags;
1268
Nicholas Piggin62906022016-12-25 13:00:30 +10001269 set_current_state(state);
1270
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001271 /* Loop until we've been woken or interrupted */
1272 flags = smp_load_acquire(&wait->flags);
1273 if (!(flags & WQ_FLAG_WOKEN)) {
1274 if (signal_pending_state(state, current))
1275 break;
1276
1277 io_schedule();
1278 continue;
1279 }
1280
1281 /* If we were non-exclusive, we're done */
1282 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001283 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001284
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001285 /* If the waker got the lock for us, we're done */
1286 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001287 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001288
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001289 /*
1290 * Otherwise, if we're getting the lock, we need to
1291 * try to get it ourselves.
1292 *
1293 * And if that fails, we'll have to retry this all.
1294 */
1295 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1296 goto repeat;
1297
1298 wait->flags |= WQ_FLAG_DONE;
1299 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001300 }
1301
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001302 /*
1303 * If a signal happened, this 'finish_wait()' may remove the last
1304 * waiter from the wait-queues, but the PageWaiters bit will remain
1305 * set. That's ok. The next wakeup will take care of it, and trying
1306 * to do it here would be difficult and prone to races.
1307 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001308 finish_wait(q, wait);
1309
Johannes Weinereb414682018-10-26 15:06:27 -07001310 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001311 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001312 delayacct_thrashing_end();
1313 psi_memstall_leave(&pflags);
1314 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001315
Nicholas Piggin62906022016-12-25 13:00:30 +10001316 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001317 * NOTE! The wait->flags weren't stable until we've done the
1318 * 'finish_wait()', and we could have exited the loop above due
1319 * to a signal, and had a wakeup event happen after the signal
1320 * test but before the 'finish_wait()'.
1321 *
1322 * So only after the finish_wait() can we reliably determine
1323 * if we got woken up or not, so we can now figure out the final
1324 * return value based on that state without races.
1325 *
1326 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1327 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001328 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001329 if (behavior == EXCLUSIVE)
1330 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001331
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001332 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001333}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
Harvey Harrison920c7a52008-02-04 22:29:26 -08001335void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336{
Nicholas Piggin62906022016-12-25 13:00:30 +10001337 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001338 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339}
1340EXPORT_SYMBOL(wait_on_page_bit);
1341
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001342int wait_on_page_bit_killable(struct page *page, int bit_nr)
1343{
Nicholas Piggin62906022016-12-25 13:00:30 +10001344 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001345 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001346}
David Howells4343d002017-11-02 15:27:52 +00001347EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001348
Jens Axboedd3e6d52020-05-22 09:12:09 -06001349static int __wait_on_page_locked_async(struct page *page,
1350 struct wait_page_queue *wait, bool set)
1351{
1352 struct wait_queue_head *q = page_waitqueue(page);
1353 int ret = 0;
1354
1355 wait->page = page;
1356 wait->bit_nr = PG_locked;
1357
1358 spin_lock_irq(&q->lock);
1359 __add_wait_queue_entry_tail(q, &wait->wait);
1360 SetPageWaiters(page);
1361 if (set)
1362 ret = !trylock_page(page);
1363 else
1364 ret = PageLocked(page);
1365 /*
1366 * If we were succesful now, we know we're still on the
1367 * waitqueue as we're still under the lock. This means it's
1368 * safe to remove and return success, we know the callback
1369 * isn't going to trigger.
1370 */
1371 if (!ret)
1372 __remove_wait_queue(q, &wait->wait);
1373 else
1374 ret = -EIOCBQUEUED;
1375 spin_unlock_irq(&q->lock);
1376 return ret;
1377}
1378
Jens Axboe1a0a7852020-05-22 09:18:38 -06001379static int wait_on_page_locked_async(struct page *page,
1380 struct wait_page_queue *wait)
1381{
1382 if (!PageLocked(page))
1383 return 0;
1384 return __wait_on_page_locked_async(compound_head(page), wait, false);
1385}
1386
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001388 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1389 * @page: The page to wait for.
1390 *
1391 * The caller should hold a reference on @page. They expect the page to
1392 * become unlocked relatively soon, but do not wish to hold up migration
1393 * (for example) by holding the reference while waiting for the page to
1394 * come unlocked. After this function returns, the caller should not
1395 * dereference @page.
1396 */
1397void put_and_wait_on_page_locked(struct page *page)
1398{
1399 wait_queue_head_t *q;
1400
1401 page = compound_head(page);
1402 q = page_waitqueue(page);
1403 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1404}
1405
1406/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001407 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001408 * @page: Page defining the wait queue of interest
1409 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001410 *
1411 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1412 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001413void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001414{
1415 wait_queue_head_t *q = page_waitqueue(page);
1416 unsigned long flags;
1417
1418 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001419 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001420 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001421 spin_unlock_irqrestore(&q->lock, flags);
1422}
1423EXPORT_SYMBOL_GPL(add_page_wait_queue);
1424
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001425#ifndef clear_bit_unlock_is_negative_byte
1426
1427/*
1428 * PG_waiters is the high bit in the same byte as PG_lock.
1429 *
1430 * On x86 (and on many other architectures), we can clear PG_lock and
1431 * test the sign bit at the same time. But if the architecture does
1432 * not support that special operation, we just do this all by hand
1433 * instead.
1434 *
1435 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001436 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001437 * in the same byte as PG_locked.
1438 */
1439static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1440{
1441 clear_bit_unlock(nr, mem);
1442 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001443 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001444}
1445
1446#endif
1447
David Howells385e1ca5f2009-04-03 16:42:39 +01001448/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001449 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 * @page: the page
1451 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001452 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001454 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1456 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001457 * Note that this depends on PG_waiters being the sign bit in the byte
1458 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1459 * clear the PG_locked bit and test PG_waiters at the same time fairly
1460 * portably (architectures that do LL/SC can test any bit, while x86 can
1461 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001463void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001465 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001466 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001467 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001468 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1469 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470}
1471EXPORT_SYMBOL(unlock_page);
1472
Randy Dunlap485bb992006-06-23 02:03:49 -07001473/**
1474 * end_page_writeback - end writeback against a page
1475 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476 */
1477void end_page_writeback(struct page *page)
1478{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001479 /*
1480 * TestClearPageReclaim could be used here but it is an atomic
1481 * operation and overkill in this particular case. Failing to
1482 * shuffle a page marked for immediate reclaim is too mild to
1483 * justify taking an atomic operation penalty at the end of
1484 * ever page writeback.
1485 */
1486 if (PageReclaim(page)) {
1487 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001488 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001489 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001490
Hugh Dickins073861e2020-11-24 08:46:43 -08001491 /*
1492 * Writeback does not hold a page reference of its own, relying
1493 * on truncation to wait for the clearing of PG_writeback.
1494 * But here we must make sure that the page is not freed and
1495 * reused before the wake_up_page().
1496 */
1497 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001498 if (!test_clear_page_writeback(page))
1499 BUG();
1500
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001501 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001503 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504}
1505EXPORT_SYMBOL(end_page_writeback);
1506
Matthew Wilcox57d99842014-06-04 16:07:45 -07001507/*
1508 * After completing I/O on a page, call this routine to update the page
1509 * flags appropriately
1510 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001511void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001512{
Jens Axboec11f0c02016-08-05 08:11:04 -06001513 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001514 if (!err) {
1515 SetPageUptodate(page);
1516 } else {
1517 ClearPageUptodate(page);
1518 SetPageError(page);
1519 }
1520 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001521 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001522 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001523 struct address_space *mapping;
1524
Matthew Wilcox57d99842014-06-04 16:07:45 -07001525 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001526 mapping = page_mapping(page);
1527 if (mapping)
1528 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001529 }
1530 end_page_writeback(page);
1531 }
1532}
1533EXPORT_SYMBOL_GPL(page_endio);
1534
Randy Dunlap485bb992006-06-23 02:03:49 -07001535/**
1536 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001537 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001539void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540{
Nicholas Piggin62906022016-12-25 13:00:30 +10001541 struct page *page = compound_head(__page);
1542 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001543 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1544 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001545}
1546EXPORT_SYMBOL(__lock_page);
1547
Nicholas Piggin62906022016-12-25 13:00:30 +10001548int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001549{
Nicholas Piggin62906022016-12-25 13:00:30 +10001550 struct page *page = compound_head(__page);
1551 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001552 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1553 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001554}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001555EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001556
Jens Axboedd3e6d52020-05-22 09:12:09 -06001557int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1558{
1559 return __wait_on_page_locked_async(page, wait, true);
1560}
1561
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001562/*
1563 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001564 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001565 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001566 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001567 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001568 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001569 *
1570 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001571 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001572 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001573int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1574 unsigned int flags)
1575{
Peter Xu4064b982020-04-01 21:08:45 -07001576 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001577 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001578 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001579 * even though return 0.
1580 */
1581 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1582 return 0;
1583
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001584 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001585 if (flags & FAULT_FLAG_KILLABLE)
1586 wait_on_page_locked_killable(page);
1587 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001588 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001589 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001590 } else {
1591 if (flags & FAULT_FLAG_KILLABLE) {
1592 int ret;
1593
1594 ret = __lock_page_killable(page);
1595 if (ret) {
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001596 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001597 return 0;
1598 }
1599 } else
1600 __lock_page(page);
1601 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001602 }
1603}
1604
Randy Dunlap485bb992006-06-23 02:03:49 -07001605/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001606 * page_cache_next_miss() - Find the next gap in the page cache.
1607 * @mapping: Mapping.
1608 * @index: Index.
1609 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001610 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001611 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1612 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001613 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001614 * This function may be called under the rcu_read_lock. However, this will
1615 * not atomically search a snapshot of the cache at a single point in time.
1616 * For example, if a gap is created at index 5, then subsequently a gap is
1617 * created at index 10, page_cache_next_miss covering both indices may
1618 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001619 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001620 * Return: The index of the gap if found, otherwise an index outside the
1621 * range specified (in which case 'return - index >= max_scan' will be true).
1622 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001623 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001624pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001625 pgoff_t index, unsigned long max_scan)
1626{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001627 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001628
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001629 while (max_scan--) {
1630 void *entry = xas_next(&xas);
1631 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001632 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001633 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001634 break;
1635 }
1636
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001637 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001638}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001639EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001640
1641/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001642 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001643 * @mapping: Mapping.
1644 * @index: Index.
1645 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001646 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001647 * Search the range [max(index - max_scan + 1, 0), index] for the
1648 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001649 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001650 * This function may be called under the rcu_read_lock. However, this will
1651 * not atomically search a snapshot of the cache at a single point in time.
1652 * For example, if a gap is created at index 10, then subsequently a gap is
1653 * created at index 5, page_cache_prev_miss() covering both indices may
1654 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001655 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001656 * Return: The index of the gap if found, otherwise an index outside the
1657 * range specified (in which case 'index - return >= max_scan' will be true).
1658 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001659 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001660pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001661 pgoff_t index, unsigned long max_scan)
1662{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001663 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001664
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001665 while (max_scan--) {
1666 void *entry = xas_prev(&xas);
1667 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001668 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001669 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001670 break;
1671 }
1672
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001673 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001674}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001675EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001676
1677/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001678 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001679 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001680 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001681 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001682 * Looks up the page cache slot at @mapping & @offset. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001683 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001684 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001685 * If the slot holds a shadow entry of a previously evicted page, or a
1686 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001687 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001688 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689 */
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001690struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001692 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001693 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694
Nick Piggina60637c2008-07-25 19:45:31 -07001695 rcu_read_lock();
1696repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001697 xas_reset(&xas);
1698 page = xas_load(&xas);
1699 if (xas_retry(&xas, page))
1700 goto repeat;
1701 /*
1702 * A shadow entry of a recently evicted page, or a swap entry from
1703 * shmem/tmpfs. Return it without attempting to raise page count.
1704 */
1705 if (!page || xa_is_value(page))
1706 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001707
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001708 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001709 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001710
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001711 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001712 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001713 * This is part of the lockless pagecache protocol. See
1714 * include/linux/pagemap.h for details.
1715 */
1716 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001717 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001718 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001719 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001720out:
Nick Piggina60637c2008-07-25 19:45:31 -07001721 rcu_read_unlock();
1722
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 return page;
1724}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
Randy Dunlap485bb992006-06-23 02:03:49 -07001726/**
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001727 * find_lock_entry - Locate and lock a page cache entry.
1728 * @mapping: The address_space to search.
1729 * @index: The page cache index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001730 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001731 * Looks up the page at @mapping & @index. If there is a page in the
1732 * cache, the head page is returned locked and with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001733 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001734 * If the slot holds a shadow entry of a previously evicted page, or a
1735 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001736 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001737 * Context: May sleep.
1738 * Return: The head page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001739 */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001740struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001741{
1742 struct page *page;
1743
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744repeat:
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001745 page = find_get_entry(mapping, index);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001746 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001747 lock_page(page);
1748 /* Has the page been truncated? */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001749 if (unlikely(page->mapping != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001750 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001751 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001752 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 }
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001754 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 return page;
1757}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001758
1759/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001760 * pagecache_get_page - Find and get a reference to a page.
1761 * @mapping: The address_space to search.
1762 * @index: The page index.
1763 * @fgp_flags: %FGP flags modify how the page is returned.
1764 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001765 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001766 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001767 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001768 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001769 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001770 * * %FGP_ACCESSED - The page will be marked accessed.
1771 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001772 * * %FGP_HEAD - If the page is present and a THP, return the head page
1773 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001774 * * %FGP_CREAT - If no page is present then a new page is allocated using
1775 * @gfp_mask and added to the page cache and the VM's LRU list.
1776 * The page is returned locked and with an increased refcount.
1777 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1778 * page is already in cache. If the page was allocated, unlock it before
1779 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001780 * * %FGP_WRITE - The page will be written
1781 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1782 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001783 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001784 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1785 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001786 *
1787 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001788 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001789 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001790 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001791struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1792 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793{
Nick Piggineb2be182007-10-16 01:24:57 -07001794 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001795
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001797 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001798 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001799 page = NULL;
1800 if (!page)
1801 goto no_page;
1802
1803 if (fgp_flags & FGP_LOCK) {
1804 if (fgp_flags & FGP_NOWAIT) {
1805 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001806 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001807 return NULL;
1808 }
1809 } else {
1810 lock_page(page);
1811 }
1812
1813 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001814 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001815 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001816 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001817 goto repeat;
1818 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001819 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001820 }
1821
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001822 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001823 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001824 else if (fgp_flags & FGP_WRITE) {
1825 /* Clear idle flag for buffer write */
1826 if (page_is_idle(page))
1827 clear_page_idle(page);
1828 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001829 if (!(fgp_flags & FGP_HEAD))
1830 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001831
1832no_page:
1833 if (!page && (fgp_flags & FGP_CREAT)) {
1834 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001835 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001836 gfp_mask |= __GFP_WRITE;
1837 if (fgp_flags & FGP_NOFS)
1838 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001839
Michal Hocko45f87de2014-12-29 20:30:35 +01001840 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001841 if (!page)
1842 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001843
Josef Bacika75d4c32019-03-13 11:44:14 -07001844 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001845 fgp_flags |= FGP_LOCK;
1846
Hugh Dickinseb39d612014-08-06 16:06:43 -07001847 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001848 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001849 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001850
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001851 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001852 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001853 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001854 page = NULL;
1855 if (err == -EEXIST)
1856 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001858
1859 /*
1860 * add_to_page_cache_lru locks the page, and for mmap we expect
1861 * an unlocked page.
1862 */
1863 if (page && (fgp_flags & FGP_FOR_MMAP))
1864 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001866
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 return page;
1868}
Mel Gorman2457aec2014-06-04 16:10:31 -07001869EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870
1871/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001872 * find_get_entries - gang pagecache lookup
1873 * @mapping: The address_space to search
1874 * @start: The starting page cache index
1875 * @nr_entries: The maximum number of entries
1876 * @entries: Where the resulting entries are placed
1877 * @indices: The cache indices corresponding to the entries in @entries
1878 *
1879 * find_get_entries() will search for and return a group of up to
1880 * @nr_entries entries in the mapping. The entries are placed at
1881 * @entries. find_get_entries() takes a reference against any actual
1882 * pages it returns.
1883 *
1884 * The search returns a group of mapping-contiguous page cache entries
1885 * with ascending indexes. There may be holes in the indices due to
1886 * not-present pages.
1887 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001888 * Any shadow entries of evicted pages, or swap entries from
1889 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001890 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001891 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1892 * stops at that page: the caller is likely to have a better way to handle
1893 * the compound page as a whole, and then skip its extent, than repeatedly
1894 * calling find_get_entries() to return all its tails.
1895 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001896 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001897 */
1898unsigned find_get_entries(struct address_space *mapping,
1899 pgoff_t start, unsigned int nr_entries,
1900 struct page **entries, pgoff_t *indices)
1901{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001902 XA_STATE(xas, &mapping->i_pages, start);
1903 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001904 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001905
1906 if (!nr_entries)
1907 return 0;
1908
1909 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001910 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001911 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001912 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001913 /*
1914 * A shadow entry of a recently evicted page, a swap
1915 * entry from shmem/tmpfs or a DAX entry. Return it
1916 * without attempting to raise page count.
1917 */
1918 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001919 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001920
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001921 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001922 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001923
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001924 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001925 if (unlikely(page != xas_reload(&xas)))
1926 goto put_page;
1927
Hugh Dickins71725ed2020-04-06 20:07:57 -07001928 /*
1929 * Terminate early on finding a THP, to allow the caller to
1930 * handle it all at once; but continue if this is hugetlbfs.
1931 */
1932 if (PageTransHuge(page) && !PageHuge(page)) {
1933 page = find_subpage(page, xas.xa_index);
1934 nr_entries = ret + 1;
1935 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001936export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001937 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001938 entries[ret] = page;
1939 if (++ret == nr_entries)
1940 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001941 continue;
1942put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001943 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001944retry:
1945 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001946 }
1947 rcu_read_unlock();
1948 return ret;
1949}
1950
1951/**
Jan Karab947cee2017-09-06 16:21:21 -07001952 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 * @mapping: The address_space to search
1954 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001955 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 * @nr_pages: The maximum number of pages
1957 * @pages: Where the resulting pages are placed
1958 *
Jan Karab947cee2017-09-06 16:21:21 -07001959 * find_get_pages_range() will search for and return a group of up to @nr_pages
1960 * pages in the mapping starting at index @start and up to index @end
1961 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1962 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963 *
1964 * The search returns a group of mapping-contiguous pages with ascending
1965 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001966 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001968 * Return: the number of pages which were found. If this number is
1969 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001970 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 */
Jan Karab947cee2017-09-06 16:21:21 -07001972unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1973 pgoff_t end, unsigned int nr_pages,
1974 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001976 XA_STATE(xas, &mapping->i_pages, *start);
1977 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001978 unsigned ret = 0;
1979
1980 if (unlikely(!nr_pages))
1981 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982
Nick Piggina60637c2008-07-25 19:45:31 -07001983 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001984 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001985 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001986 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001987 /* Skip over shadow, swap and DAX entries */
1988 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001989 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001990
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001991 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001992 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001993
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001994 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001995 if (unlikely(page != xas_reload(&xas)))
1996 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001997
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001998 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001999 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002000 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002001 goto out;
2002 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002003 continue;
2004put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002005 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002006retry:
2007 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002008 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002009
Jan Karab947cee2017-09-06 16:21:21 -07002010 /*
2011 * We come here when there is no page beyond @end. We take care to not
2012 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002013 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002014 * already broken anyway.
2015 */
2016 if (end == (pgoff_t)-1)
2017 *start = (pgoff_t)-1;
2018 else
2019 *start = end + 1;
2020out:
Nick Piggina60637c2008-07-25 19:45:31 -07002021 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002022
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 return ret;
2024}
2025
Jens Axboeebf43502006-04-27 08:46:01 +02002026/**
2027 * find_get_pages_contig - gang contiguous pagecache lookup
2028 * @mapping: The address_space to search
2029 * @index: The starting page index
2030 * @nr_pages: The maximum number of pages
2031 * @pages: Where the resulting pages are placed
2032 *
2033 * find_get_pages_contig() works exactly like find_get_pages(), except
2034 * that the returned number of pages are guaranteed to be contiguous.
2035 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002036 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002037 */
2038unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2039 unsigned int nr_pages, struct page **pages)
2040{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002041 XA_STATE(xas, &mapping->i_pages, index);
2042 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002043 unsigned int ret = 0;
2044
2045 if (unlikely(!nr_pages))
2046 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002047
Nick Piggina60637c2008-07-25 19:45:31 -07002048 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002049 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002050 if (xas_retry(&xas, page))
2051 continue;
2052 /*
2053 * If the entry has been swapped out, we can stop looking.
2054 * No current caller is looking for DAX entries.
2055 */
2056 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002057 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002058
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002059 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002060 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002061
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002062 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002063 if (unlikely(page != xas_reload(&xas)))
2064 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002065
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002066 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002067 if (++ret == nr_pages)
2068 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002069 continue;
2070put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002071 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002072retry:
2073 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002074 }
Nick Piggina60637c2008-07-25 19:45:31 -07002075 rcu_read_unlock();
2076 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002077}
David Howellsef71c152007-05-09 02:33:44 -07002078EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002079
Randy Dunlap485bb992006-06-23 02:03:49 -07002080/**
Jan Kara72b045a2017-11-15 17:34:33 -08002081 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07002082 * @mapping: the address_space to search
2083 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002084 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002085 * @tag: the tag index
2086 * @nr_pages: the maximum number of pages
2087 * @pages: where the resulting pages are placed
2088 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07002090 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08002091 *
2092 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 */
Jan Kara72b045a2017-11-15 17:34:33 -08002094unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002095 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002096 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002098 XA_STATE(xas, &mapping->i_pages, *index);
2099 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002100 unsigned ret = 0;
2101
2102 if (unlikely(!nr_pages))
2103 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104
Nick Piggina60637c2008-07-25 19:45:31 -07002105 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002106 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002107 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07002108 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002109 /*
2110 * Shadow entries should never be tagged, but this iteration
2111 * is lockless so there is a window for page reclaim to evict
2112 * a page we saw tagged. Skip over it.
2113 */
2114 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002115 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002116
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002117 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002118 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002119
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002120 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002121 if (unlikely(page != xas_reload(&xas)))
2122 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002123
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002124 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08002125 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002126 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08002127 goto out;
2128 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002129 continue;
2130put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002131 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002132retry:
2133 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002134 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002135
Jan Kara72b045a2017-11-15 17:34:33 -08002136 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002137 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002138 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002139 * iteration when there is a page at index -1 but that is already
2140 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002141 */
2142 if (end == (pgoff_t)-1)
2143 *index = (pgoff_t)-1;
2144 else
2145 *index = end + 1;
2146out:
Nick Piggina60637c2008-07-25 19:45:31 -07002147 rcu_read_unlock();
2148
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 return ret;
2150}
Jan Kara72b045a2017-11-15 17:34:33 -08002151EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002153/*
2154 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2155 * a _large_ part of the i/o request. Imagine the worst scenario:
2156 *
2157 * ---R__________________________________________B__________
2158 * ^ reading here ^ bad block(assume 4k)
2159 *
2160 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2161 * => failing the whole request => read(R) => read(R+1) =>
2162 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2163 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2164 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2165 *
2166 * It is going insane. Fix it by quickly scaling down the readahead size.
2167 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002168static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002169{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002170 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002171}
2172
Randy Dunlap485bb992006-06-23 02:03:49 -07002173/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002174 * generic_file_buffered_read - generic file read routine
2175 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05002176 * @iter: data destination
2177 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07002178 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07002180 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 *
2182 * This is really ugly. But the goto's actually try to clarify some
2183 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002184 *
2185 * Return:
2186 * * total number of bytes copied, including those the were already @written
2187 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002189ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002190 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002192 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002193 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002195 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002196 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002197 pgoff_t index;
2198 pgoff_t last_index;
2199 pgoff_t prev_index;
2200 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002201 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002202 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203
Wei Fangc2a97372016-10-07 17:01:52 -07002204 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002205 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002206 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2207
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002208 index = *ppos >> PAGE_SHIFT;
2209 prev_index = ra->prev_pos >> PAGE_SHIFT;
2210 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2211 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2212 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002213
Jens Axboe13bd6912020-10-17 08:31:29 -06002214 /*
2215 * If we've already successfully copied some data, then we
2216 * can no longer safely return -EIOCBQUEUED. Hence mark
2217 * an async read NOWAIT at that point.
2218 */
2219 if (written && (iocb->ki_flags & IOCB_WAITQ))
2220 iocb->ki_flags |= IOCB_NOWAIT;
2221
Linus Torvalds1da177e2005-04-16 15:20:36 -07002222 for (;;) {
2223 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002224 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002225 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 unsigned long nr, ret;
2227
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002230 if (fatal_signal_pending(current)) {
2231 error = -EINTR;
2232 goto out;
2233 }
2234
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002236 if (!page) {
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002237 if (iocb->ki_flags & IOCB_NOIO)
Milosz Tanski3239d832017-08-29 16:13:19 +02002238 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002239 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002240 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002241 index, last_index - index);
2242 page = find_get_page(mapping, index);
2243 if (unlikely(page == NULL))
2244 goto no_cached_page;
2245 }
2246 if (PageReadahead(page)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002247 if (iocb->ki_flags & IOCB_NOIO) {
2248 put_page(page);
2249 goto out;
2250 }
Rusty Russellcf914a72007-07-19 01:48:08 -07002251 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002252 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002253 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002255 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07002256 /*
2257 * See comment in do_read_cache_page on why
2258 * wait_on_page_locked is used to avoid unnecessarily
2259 * serialisations and why it's safe.
2260 */
Jens Axboe1a0a7852020-05-22 09:18:38 -06002261 if (iocb->ki_flags & IOCB_WAITQ) {
2262 if (written) {
2263 put_page(page);
2264 goto out;
2265 }
2266 error = wait_on_page_locked_async(page,
2267 iocb->ki_waitq);
2268 } else {
2269 if (iocb->ki_flags & IOCB_NOWAIT) {
2270 put_page(page);
2271 goto would_block;
2272 }
2273 error = wait_on_page_locked_killable(page);
2274 }
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002275 if (unlikely(error))
2276 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002277 if (PageUptodate(page))
2278 goto page_ok;
2279
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002280 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002281 !mapping->a_ops->is_partially_uptodate)
2282 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002283 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002284 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002285 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002286 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002287 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002288 /* Did it get truncated before we got the lock? */
2289 if (!page->mapping)
2290 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002291 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002292 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002293 goto page_not_up_to_date_locked;
2294 unlock_page(page);
2295 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002297 /*
2298 * i_size must be checked after we know the page is Uptodate.
2299 *
2300 * Checking i_size after the check allows us to calculate
2301 * the correct value for "nr", which means the zero-filled
2302 * part of the page is not copied back to userspace (unless
2303 * another truncate extends the file - this is desired though).
2304 */
2305
2306 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002307 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002308 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002309 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002310 goto out;
2311 }
2312
2313 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002314 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002315 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002316 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002317 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002318 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002319 goto out;
2320 }
2321 }
2322 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323
2324 /* If users can be writing to this page using arbitrary
2325 * virtual addresses, take care about potential aliasing
2326 * before reading the page on the kernel side.
2327 */
2328 if (mapping_writably_mapped(mapping))
2329 flush_dcache_page(page);
2330
2331 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002332 * When a sequential read accesses a page several times,
2333 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002334 */
Jan Karaec0f1632007-05-06 14:49:25 -07002335 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 mark_page_accessed(page);
2337 prev_index = index;
2338
2339 /*
2340 * Ok, we have the page, and it's up-to-date, so
2341 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002342 */
Al Viro6e58e792014-02-03 17:07:03 -05002343
2344 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002345 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002346 index += offset >> PAGE_SHIFT;
2347 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002348 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002349
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002350 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002351 written += ret;
2352 if (!iov_iter_count(iter))
2353 goto out;
2354 if (ret < nr) {
2355 error = -EFAULT;
2356 goto out;
2357 }
2358 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359
2360page_not_up_to_date:
2361 /* Get exclusive access to the page ... */
Jens Axboe0abed7c2020-11-16 13:36:24 -07002362 if (iocb->ki_flags & IOCB_WAITQ) {
2363 if (written) {
2364 put_page(page);
2365 goto out;
2366 }
Jens Axboe1a0a7852020-05-22 09:18:38 -06002367 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002368 } else {
Jens Axboe1a0a7852020-05-22 09:18:38 -06002369 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002370 }
Oleg Nesterov85462322008-06-08 21:20:43 +04002371 if (unlikely(error))
2372 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002373
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002374page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002375 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002376 if (!page->mapping) {
2377 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002378 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002379 continue;
2380 }
2381
2382 /* Did somebody else fill it already? */
2383 if (PageUptodate(page)) {
2384 unlock_page(page);
2385 goto page_ok;
2386 }
2387
2388readpage:
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002389 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002390 unlock_page(page);
2391 put_page(page);
2392 goto would_block;
2393 }
Jeff Moyer91803b42010-05-26 11:49:40 -04002394 /*
2395 * A previous I/O error may have been due to temporary
2396 * failures, eg. multipath errors.
2397 * PG_error will be set again if readpage fails.
2398 */
2399 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 /* Start the actual read. The read will unlock the page. */
2401 error = mapping->a_ops->readpage(filp, page);
2402
Zach Brown994fc28c2005-12-15 14:28:17 -08002403 if (unlikely(error)) {
2404 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002405 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002406 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002407 goto find_page;
2408 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002410 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411
2412 if (!PageUptodate(page)) {
Jens Axboe0abed7c2020-11-16 13:36:24 -07002413 if (iocb->ki_flags & IOCB_WAITQ) {
2414 if (written) {
2415 put_page(page);
2416 goto out;
2417 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002418 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002419 } else {
Hao Xuc8d317a2020-09-29 20:00:45 +08002420 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002421 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002422
Oleg Nesterov85462322008-06-08 21:20:43 +04002423 if (unlikely(error))
2424 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002425 if (!PageUptodate(page)) {
2426 if (page->mapping == NULL) {
2427 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002428 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002429 */
2430 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002431 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432 goto find_page;
2433 }
2434 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002435 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002436 error = -EIO;
2437 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002438 }
2439 unlock_page(page);
2440 }
2441
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442 goto page_ok;
2443
2444readpage_error:
2445 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002446 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 goto out;
2448
2449no_cached_page:
2450 /*
2451 * Ok, it wasn't cached, so we need to create a new
2452 * page..
2453 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002454 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002455 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002456 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002457 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002458 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002459 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002460 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002462 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002463 if (error == -EEXIST) {
2464 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002465 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002466 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 goto out;
2468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 goto readpage;
2470 }
2471
Milosz Tanski3239d832017-08-29 16:13:19 +02002472would_block:
2473 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002475 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002476 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002477 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002479 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002480 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002481 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002483EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484
Randy Dunlap485bb992006-06-23 02:03:49 -07002485/**
Al Viro6abd2322014-04-04 14:20:57 -04002486 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002487 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002488 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002489 *
Al Viro6abd2322014-04-04 14:20:57 -04002490 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002492 *
2493 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2494 * be returned when no data can be read without waiting for I/O requests
2495 * to complete; it doesn't prevent readahead.
2496 *
2497 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2498 * requests shall be made for the read or for readahead. When no data
2499 * can be read, -EAGAIN shall be returned. When readahead would be
2500 * triggered, a partial, possibly empty read shall be returned.
2501 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002502 * Return:
2503 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002504 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 */
2506ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002507generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002509 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002510 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002511
2512 if (!count)
2513 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514
Al Viro2ba48ce2015-04-09 13:52:01 -04002515 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002516 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002517 struct address_space *mapping = file->f_mapping;
2518 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002519 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002522 if (iocb->ki_flags & IOCB_NOWAIT) {
2523 if (filemap_range_has_page(mapping, iocb->ki_pos,
2524 iocb->ki_pos + count - 1))
2525 return -EAGAIN;
2526 } else {
2527 retval = filemap_write_and_wait_range(mapping,
2528 iocb->ki_pos,
2529 iocb->ki_pos + count - 1);
2530 if (retval < 0)
2531 goto out;
2532 }
Al Viroed978a82014-03-05 22:53:04 -05002533
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002534 file_accessed(file);
2535
Al Viro5ecda132017-04-13 14:13:36 -04002536 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002537 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002538 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002539 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002540 }
Al Viro5b47d592017-05-08 13:54:47 -04002541 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002542
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002543 /*
2544 * Btrfs can have a short DIO read if we encounter
2545 * compressed extents, so if there was an error, or if
2546 * we've already read everything we wanted to, or if
2547 * there was a short read because we hit EOF, go ahead
2548 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002549 * the rest of the read. Buffered reads will not work for
2550 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002551 */
Al Viro5ecda132017-04-13 14:13:36 -04002552 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002553 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002554 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 }
2556
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002557 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558out:
2559 return retval;
2560}
Al Viroed978a82014-03-05 22:53:04 -05002561EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002565/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002566 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002567 * @vmf - the vm_fault for this fault.
2568 * @page - the page to lock.
2569 * @fpin - the pointer to the file we may pin (or is already pinned).
2570 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002571 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002572 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002573 * 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 -07002574 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002575 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002576static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2577 struct file **fpin)
2578{
2579 if (trylock_page(page))
2580 return 1;
2581
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002582 /*
2583 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002584 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002585 * is supposed to work. We have way too many special cases..
2586 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002587 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2588 return 0;
2589
2590 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2591 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2592 if (__lock_page_killable(page)) {
2593 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002594 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002595 * but all fault_handlers only check for fatal signals
2596 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002597 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002598 */
2599 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002600 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002601 return 0;
2602 }
2603 } else
2604 __lock_page(page);
2605 return 1;
2606}
2607
2608
2609/*
2610 * Synchronous readahead happens when we don't even find a page in the page
2611 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2612 * to drop the mmap sem we return the file that was pinned in order for us to do
2613 * that. If we didn't pin a file then we return NULL. The file that is
2614 * returned needs to be fput()'ed when we're done with it.
2615 */
2616static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002617{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002618 struct file *file = vmf->vma->vm_file;
2619 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002620 struct address_space *mapping = file->f_mapping;
David Howellsdb660d42020-10-15 20:06:31 -07002621 DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002622 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002623 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002624
2625 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002626 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002627 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002628 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002629 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002630
Josef Bacik2a1180f2019-03-13 11:44:18 -07002631 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002632 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002633 page_cache_sync_ra(&ractl, ra, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002634 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002635 }
2636
Andi Kleen207d04b2011-05-24 17:12:29 -07002637 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002638 mmap_miss = READ_ONCE(ra->mmap_miss);
2639 if (mmap_miss < MMAP_LOTSAMISS * 10)
2640 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002641
2642 /*
2643 * Do we miss much more than hit in this file? If so,
2644 * stop bothering with read-ahead. It will only hurt.
2645 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002646 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002647 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002648
Wu Fengguangd30a1102009-06-16 15:31:30 -07002649 /*
2650 * mmap read-around
2651 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002652 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002653 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002654 ra->size = ra->ra_pages;
2655 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002656 ractl._index = ra->start;
2657 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002658 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002659}
2660
2661/*
2662 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002663 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002664 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002665 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002666static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2667 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002668{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002669 struct file *file = vmf->vma->vm_file;
2670 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002671 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002672 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002673 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002674 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002675
2676 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002677 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002678 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002679 mmap_miss = READ_ONCE(ra->mmap_miss);
2680 if (mmap_miss)
2681 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002682 if (PageReadahead(page)) {
2683 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002684 page_cache_async_readahead(mapping, ra, file,
2685 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002686 }
2687 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002688}
2689
Randy Dunlap485bb992006-06-23 02:03:49 -07002690/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002691 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002692 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002693 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002694 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002695 * mapped memory region to read in file data during a page fault.
2696 *
2697 * The goto's are kind of ugly, but this streamlines the normal case of having
2698 * it in the page cache, and handles the special cases reasonably without
2699 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002700 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002701 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002702 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002703 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002704 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002705 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002706 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002707 * has not been released.
2708 *
2709 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002710 *
2711 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002712 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002713vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714{
2715 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002716 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002717 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002718 struct address_space *mapping = file->f_mapping;
2719 struct file_ra_state *ra = &file->f_ra;
2720 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002721 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002722 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002724 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002726 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2727 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002728 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729
Linus Torvalds1da177e2005-04-16 15:20:36 -07002730 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002731 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002733 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002734 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002736 * We found the page, so try async readahead before
2737 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002739 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002740 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002741 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002742 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002743 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002744 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002745 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002746retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002747 page = pagecache_get_page(mapping, offset,
2748 FGP_CREAT|FGP_FOR_MMAP,
2749 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002750 if (!page) {
2751 if (fpin)
2752 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002753 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002754 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002755 }
2756
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002757 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2758 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002759
2760 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002761 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002762 unlock_page(page);
2763 put_page(page);
2764 goto retry_find;
2765 }
Song Liu520e5ba2019-09-23 15:37:50 -07002766 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002767
Linus Torvalds1da177e2005-04-16 15:20:36 -07002768 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002769 * We have a locked page in the page cache, now we need to check
2770 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 */
Nick Piggind00806b2007-07-19 01:46:57 -07002772 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 goto page_not_uptodate;
2774
Linus Torvaldsef00e082009-06-16 15:31:25 -07002775 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002776 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002777 * time to return to the upper layer and have it re-find the vma and
2778 * redo the fault.
2779 */
2780 if (fpin) {
2781 unlock_page(page);
2782 goto out_retry;
2783 }
2784
2785 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002786 * Found the page and have a reference on it.
2787 * We must recheck i_size under page lock.
2788 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002789 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2790 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002791 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002792 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002793 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002794 }
2795
Nick Piggind0217ac2007-07-19 01:47:03 -07002796 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002797 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798
Linus Torvalds1da177e2005-04-16 15:20:36 -07002799page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 /*
2801 * Umm, take care of errors if the page isn't up-to-date.
2802 * Try to re-read it _once_. We do this synchronously,
2803 * because there really aren't any performance issues here
2804 * and we need to check for errors.
2805 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002807 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002808 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002809 if (!error) {
2810 wait_on_page_locked(page);
2811 if (!PageUptodate(page))
2812 error = -EIO;
2813 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002814 if (fpin)
2815 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002816 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002817
2818 if (!error || error == AOP_TRUNCATED_PAGE)
2819 goto retry_find;
2820
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002821 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002822 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002823
2824out_retry:
2825 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002826 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002827 * re-find the vma and come back and find our hopefully still populated
2828 * page.
2829 */
2830 if (page)
2831 put_page(page);
2832 if (fpin)
2833 fput(fpin);
2834 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002835}
2836EXPORT_SYMBOL(filemap_fault);
2837
Jan Kara82b0f8c2016-12-14 15:06:58 -08002838void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002839 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002840{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002841 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002842 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002843 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002844 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002845 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002846 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002847 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002848
2849 rcu_read_lock();
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002850 xas_for_each(&xas, head, end_pgoff) {
2851 if (xas_retry(&xas, head))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002852 continue;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002853 if (xa_is_value(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002854 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002855
Michal Hockoe0975b22018-12-28 00:38:36 -08002856 /*
2857 * Check for a locked page first, as a speculative
2858 * reference may adversely influence page migration.
2859 */
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002860 if (PageLocked(head))
Michal Hockoe0975b22018-12-28 00:38:36 -08002861 goto next;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002862 if (!page_cache_get_speculative(head))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002863 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002864
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002865 /* Has the page moved or been split? */
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002866 if (unlikely(head != xas_reload(&xas)))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002867 goto skip;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002868 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002869
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002870 if (!PageUptodate(head) ||
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002871 PageReadahead(page) ||
2872 PageHWPoison(page))
2873 goto skip;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002874 if (!trylock_page(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002875 goto skip;
2876
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002877 if (head->mapping != mapping || !PageUptodate(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002878 goto unlock;
2879
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002880 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002881 if (xas.xa_index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002882 goto unlock;
2883
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002884 if (mmap_miss > 0)
2885 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002886
Matthew Wilcox070e8072018-05-17 00:08:30 -04002887 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002888 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002889 vmf->pte += xas.xa_index - last_pgoff;
2890 last_pgoff = xas.xa_index;
Johannes Weiner9d82c692020-06-03 16:02:04 -07002891 if (alloc_set_pte(vmf, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002892 goto unlock;
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002893 unlock_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002894 goto next;
2895unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002896 unlock_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002897skip:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002898 put_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002899next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002900 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002901 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002902 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002903 }
2904 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002905 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002906}
2907EXPORT_SYMBOL(filemap_map_pages);
2908
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002909vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002910{
2911 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002912 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002913 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002914
Jan Kara14da9202012-06-12 16:20:37 +02002915 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002916 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002917 lock_page(page);
2918 if (page->mapping != inode->i_mapping) {
2919 unlock_page(page);
2920 ret = VM_FAULT_NOPAGE;
2921 goto out;
2922 }
Jan Kara14da9202012-06-12 16:20:37 +02002923 /*
2924 * We mark the page dirty already here so that when freeze is in
2925 * progress, we are guaranteed that writeback during freezing will
2926 * see the dirty page and writeprotect it again.
2927 */
2928 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002929 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002930out:
Jan Kara14da9202012-06-12 16:20:37 +02002931 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002932 return ret;
2933}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002934
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002935const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002936 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002937 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002938 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939};
2940
2941/* This is used for a general mmap of a disk file */
2942
2943int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2944{
2945 struct address_space *mapping = file->f_mapping;
2946
2947 if (!mapping->a_ops->readpage)
2948 return -ENOEXEC;
2949 file_accessed(file);
2950 vma->vm_ops = &generic_file_vm_ops;
2951 return 0;
2952}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953
2954/*
2955 * This is for filesystems which do not implement ->writepage.
2956 */
2957int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2958{
2959 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2960 return -EINVAL;
2961 return generic_file_mmap(file, vma);
2962}
2963#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002964vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07002965{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002966 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07002967}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2969{
2970 return -ENOSYS;
2971}
2972int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2973{
2974 return -ENOSYS;
2975}
2976#endif /* CONFIG_MMU */
2977
Arnd Bergmann453972282018-04-13 15:35:27 -07002978EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979EXPORT_SYMBOL(generic_file_mmap);
2980EXPORT_SYMBOL(generic_file_readonly_mmap);
2981
Sasha Levin67f9fd92014-04-03 14:48:18 -07002982static struct page *wait_on_page_read(struct page *page)
2983{
2984 if (!IS_ERR(page)) {
2985 wait_on_page_locked(page);
2986 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002987 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002988 page = ERR_PTR(-EIO);
2989 }
2990 }
2991 return page;
2992}
2993
Mel Gorman32b63522016-03-15 14:55:36 -07002994static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002995 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002996 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002997 void *data,
2998 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002999{
Nick Piggineb2be182007-10-16 01:24:57 -07003000 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001 int err;
3002repeat:
3003 page = find_get_page(mapping, index);
3004 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003005 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003006 if (!page)
3007 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003008 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003009 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003010 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003011 if (err == -EEXIST)
3012 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003013 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014 return ERR_PTR(err);
3015 }
Mel Gorman32b63522016-03-15 14:55:36 -07003016
3017filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003018 if (filler)
3019 err = filler(data, page);
3020 else
3021 err = mapping->a_ops->readpage(data, page);
3022
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003024 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003025 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026 }
Mel Gorman32b63522016-03-15 14:55:36 -07003027
3028 page = wait_on_page_read(page);
3029 if (IS_ERR(page))
3030 return page;
3031 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003032 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003033 if (PageUptodate(page))
3034 goto out;
3035
Mel Gormanebded022016-03-15 14:55:39 -07003036 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003037 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003038 * case a: Page is being filled and the page lock is held
3039 * case b: Read/write error clearing the page uptodate status
3040 * case c: Truncation in progress (page locked)
3041 * case d: Reclaim in progress
3042 *
3043 * Case a, the page will be up to date when the page is unlocked.
3044 * There is no need to serialise on the page lock here as the page
3045 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003046 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003047 * it's a race vs truncate race.
3048 * Case b, the page will not be up to date
3049 * Case c, the page may be truncated but in itself, the data may still
3050 * be valid after IO completes as it's a read vs truncate race. The
3051 * operation must restart if the page is not uptodate on unlock but
3052 * otherwise serialising on page lock to stabilise the mapping gives
3053 * no additional guarantees to the caller as the page lock is
3054 * released before return.
3055 * Case d, similar to truncation. If reclaim holds the page lock, it
3056 * will be a race with remove_mapping that determines if the mapping
3057 * is valid on unlock but otherwise the data is valid and there is
3058 * no need to serialise with page lock.
3059 *
3060 * As the page lock gives no additional guarantee, we optimistically
3061 * wait on the page to be unlocked and check if it's up to date and
3062 * use the page if it is. Otherwise, the page lock is required to
3063 * distinguish between the different cases. The motivation is that we
3064 * avoid spurious serialisations and wakeups when multiple processes
3065 * wait on the same page for IO to complete.
3066 */
3067 wait_on_page_locked(page);
3068 if (PageUptodate(page))
3069 goto out;
3070
3071 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003072 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003073
3074 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003075 if (!page->mapping) {
3076 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003077 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003078 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003079 }
Mel Gormanebded022016-03-15 14:55:39 -07003080
3081 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082 if (PageUptodate(page)) {
3083 unlock_page(page);
3084 goto out;
3085 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003086
3087 /*
3088 * A previous I/O error may have been due to temporary
3089 * failures.
3090 * Clear page error before actual read, PG_error will be
3091 * set again if read page fails.
3092 */
3093 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003094 goto filler;
3095
David Howellsc855ff32007-05-09 13:42:20 +01003096out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003097 mark_page_accessed(page);
3098 return page;
3099}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003100
3101/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003102 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003103 * @mapping: the page's address_space
3104 * @index: the page index
3105 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003106 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003107 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003108 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003109 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003110 *
3111 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003112 *
3113 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003114 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003115struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003116 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003117 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003118 void *data)
3119{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003120 return do_read_cache_page(mapping, index, filler, data,
3121 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003122}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003123EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003124
3125/**
3126 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3127 * @mapping: the page's address_space
3128 * @index: the page index
3129 * @gfp: the page allocator flags to use if allocating
3130 *
3131 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003132 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003133 *
3134 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003135 *
3136 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003137 */
3138struct page *read_cache_page_gfp(struct address_space *mapping,
3139 pgoff_t index,
3140 gfp_t gfp)
3141{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003142 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003143}
3144EXPORT_SYMBOL(read_cache_page_gfp);
3145
Nick Pigginafddba42007-10-16 01:25:01 -07003146int pagecache_write_begin(struct file *file, struct address_space *mapping,
3147 loff_t pos, unsigned len, unsigned flags,
3148 struct page **pagep, void **fsdata)
3149{
3150 const struct address_space_operations *aops = mapping->a_ops;
3151
Nick Piggin4e02ed42008-10-29 14:00:55 -07003152 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003153 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003154}
3155EXPORT_SYMBOL(pagecache_write_begin);
3156
3157int pagecache_write_end(struct file *file, struct address_space *mapping,
3158 loff_t pos, unsigned len, unsigned copied,
3159 struct page *page, void *fsdata)
3160{
3161 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003162
Nick Piggin4e02ed42008-10-29 14:00:55 -07003163 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003164}
3165EXPORT_SYMBOL(pagecache_write_end);
3166
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003167/*
3168 * Warn about a page cache invalidation failure during a direct I/O write.
3169 */
3170void dio_warn_stale_pagecache(struct file *filp)
3171{
3172 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3173 char pathname[128];
3174 struct inode *inode = file_inode(filp);
3175 char *path;
3176
3177 errseq_set(&inode->i_mapping->wb_err, -EIO);
3178 if (__ratelimit(&_rs)) {
3179 path = file_path(filp, pathname, sizeof(pathname));
3180 if (IS_ERR(path))
3181 path = "(unknown)";
3182 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3183 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3184 current->comm);
3185 }
3186}
3187
Linus Torvalds1da177e2005-04-16 15:20:36 -07003188ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003189generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003190{
3191 struct file *file = iocb->ki_filp;
3192 struct address_space *mapping = file->f_mapping;
3193 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003194 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003196 size_t write_len;
3197 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198
Al Viro0c949332014-03-22 06:51:37 -04003199 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003200 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003201
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003202 if (iocb->ki_flags & IOCB_NOWAIT) {
3203 /* If there are pages to writeback, return */
3204 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003205 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003206 return -EAGAIN;
3207 } else {
3208 written = filemap_write_and_wait_range(mapping, pos,
3209 pos + write_len - 1);
3210 if (written)
3211 goto out;
3212 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003213
3214 /*
3215 * After a write we want buffered reads to be sure to go to disk to get
3216 * the new data. We invalidate clean cached page from the region we're
3217 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003218 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003219 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003220 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003221 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003222 /*
3223 * If a page can not be invalidated, return 0 to fall back
3224 * to buffered write.
3225 */
3226 if (written) {
3227 if (written == -EBUSY)
3228 return 0;
3229 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003230 }
3231
Al Viro639a93a52017-04-13 14:10:15 -04003232 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003233
3234 /*
3235 * Finally, try again to invalidate clean pages which might have been
3236 * cached by non-direct readahead, or faulted in by get_user_pages()
3237 * if the source of the write was an mmap'ed region of the file
3238 * we're writing. Either one is a pretty crazy thing to do,
3239 * so we don't support it 100%. If this invalidation
3240 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003241 *
3242 * Most of the time we do not need this since dio_complete() will do
3243 * the invalidation for us. However there are some file systems that
3244 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003245 * them by removing it completely.
3246 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003247 * Noticeable example is a blkdev_direct_IO().
3248 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003249 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003250 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003251 if (written > 0 && mapping->nrpages &&
3252 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3253 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003254
Linus Torvalds1da177e2005-04-16 15:20:36 -07003255 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003256 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003257 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003258 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3259 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003260 mark_inode_dirty(inode);
3261 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003262 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003263 }
Al Viro639a93a52017-04-13 14:10:15 -04003264 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003265out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266 return written;
3267}
3268EXPORT_SYMBOL(generic_file_direct_write);
3269
Nick Piggineb2be182007-10-16 01:24:57 -07003270/*
3271 * Find or create a page at the given pagecache position. Return the locked
3272 * page. This function is specifically for buffered writes.
3273 */
Nick Piggin54566b22009-01-04 12:00:53 -08003274struct page *grab_cache_page_write_begin(struct address_space *mapping,
3275 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003276{
Nick Piggineb2be182007-10-16 01:24:57 -07003277 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003278 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003279
Nick Piggin54566b22009-01-04 12:00:53 -08003280 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003281 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003282
Mel Gorman2457aec2014-06-04 16:10:31 -07003283 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003284 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003285 if (page)
3286 wait_for_stable_page(page);
3287
Nick Piggineb2be182007-10-16 01:24:57 -07003288 return page;
3289}
Nick Piggin54566b22009-01-04 12:00:53 -08003290EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003291
Al Viro3b93f912014-02-11 21:34:08 -05003292ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003293 struct iov_iter *i, loff_t pos)
3294{
3295 struct address_space *mapping = file->f_mapping;
3296 const struct address_space_operations *a_ops = mapping->a_ops;
3297 long status = 0;
3298 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003299 unsigned int flags = 0;
3300
Nick Pigginafddba42007-10-16 01:25:01 -07003301 do {
3302 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003303 unsigned long offset; /* Offset into pagecache page */
3304 unsigned long bytes; /* Bytes to write to page */
3305 size_t copied; /* Bytes copied from user */
3306 void *fsdata;
3307
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003308 offset = (pos & (PAGE_SIZE - 1));
3309 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003310 iov_iter_count(i));
3311
3312again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003313 /*
3314 * Bring in the user page that we will copy from _first_.
3315 * Otherwise there's a nasty deadlock on copying from the
3316 * same page as we're writing to, without it being marked
3317 * up-to-date.
3318 *
3319 * Not only is this an optimisation, but it is also required
3320 * to check that the address is actually valid, when atomic
3321 * usercopies are used, below.
3322 */
3323 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3324 status = -EFAULT;
3325 break;
3326 }
3327
Jan Kara296291c2015-10-22 13:32:21 -07003328 if (fatal_signal_pending(current)) {
3329 status = -EINTR;
3330 break;
3331 }
3332
Nick Piggin674b8922007-10-16 01:25:03 -07003333 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003334 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003335 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003336 break;
3337
anfei zhou931e80e2010-02-02 13:44:02 -08003338 if (mapping_writably_mapped(mapping))
3339 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003340
Nick Pigginafddba42007-10-16 01:25:01 -07003341 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003342 flush_dcache_page(page);
3343
3344 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3345 page, fsdata);
3346 if (unlikely(status < 0))
3347 break;
3348 copied = status;
3349
3350 cond_resched();
3351
Nick Piggin124d3b72008-02-02 15:01:17 +01003352 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003353 if (unlikely(copied == 0)) {
3354 /*
3355 * If we were unable to copy any data at all, we must
3356 * fall back to a single segment length write.
3357 *
3358 * If we didn't fallback here, we could livelock
3359 * because not all segments in the iov can be copied at
3360 * once without a pagefault.
3361 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003362 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003363 iov_iter_single_seg_count(i));
3364 goto again;
3365 }
Nick Pigginafddba42007-10-16 01:25:01 -07003366 pos += copied;
3367 written += copied;
3368
3369 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003370 } while (iov_iter_count(i));
3371
3372 return written ? written : status;
3373}
Al Viro3b93f912014-02-11 21:34:08 -05003374EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003375
Jan Karae4dd9de2009-08-17 18:10:06 +02003376/**
Al Viro81742022014-04-03 03:17:43 -04003377 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003378 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003379 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003380 *
3381 * This function does all the work needed for actually writing data to a
3382 * file. It does all basic checks, removes SUID from the file, updates
3383 * modification times and calls proper subroutines depending on whether we
3384 * do direct IO or a standard buffered write.
3385 *
3386 * It expects i_mutex to be grabbed unless we work on a block device or similar
3387 * object which does not need locking at all.
3388 *
3389 * This function does *not* take care of syncing data in case of O_SYNC write.
3390 * A caller has to handle it. This is mainly due to the fact that we want to
3391 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003392 *
3393 * Return:
3394 * * number of bytes written, even for truncated writes
3395 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003396 */
Al Viro81742022014-04-03 03:17:43 -04003397ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398{
3399 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003400 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003401 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003402 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003403 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003404 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003405
Linus Torvalds1da177e2005-04-16 15:20:36 -07003406 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003407 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003408 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003409 if (err)
3410 goto out;
3411
Josef Bacikc3b2da32012-03-26 09:59:21 -04003412 err = file_update_time(file);
3413 if (err)
3414 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003415
Al Viro2ba48ce2015-04-09 13:52:01 -04003416 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003417 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003418
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003419 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003420 /*
3421 * If the write stopped short of completing, fall back to
3422 * buffered writes. Some filesystems do this for writes to
3423 * holes, for example. For DAX files, a buffered write will
3424 * not succeed (even if it did, DAX does not handle dirty
3425 * page-cache pages correctly).
3426 */
Al Viro0b8def92015-04-07 10:22:53 -04003427 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003429
Al Viro0b8def92015-04-07 10:22:53 -04003430 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003431 /*
Al Viro3b93f912014-02-11 21:34:08 -05003432 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003433 * then we want to return the number of bytes which were
3434 * direct-written, or the error code if that was zero. Note
3435 * that this differs from normal direct-io semantics, which
3436 * will return -EFOO even if some bytes were written.
3437 */
Al Viro60bb4522014-08-08 12:39:16 -04003438 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003439 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003440 goto out;
3441 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003442 /*
3443 * We need to ensure that the page cache pages are written to
3444 * disk and invalidated to preserve the expected O_DIRECT
3445 * semantics.
3446 */
Al Viro3b93f912014-02-11 21:34:08 -05003447 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003448 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003449 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003450 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003451 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003452 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003453 pos >> PAGE_SHIFT,
3454 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003455 } else {
3456 /*
3457 * We don't know how much we wrote, so just return
3458 * the number of bytes which were direct-written
3459 */
3460 }
3461 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003462 written = generic_perform_write(file, from, iocb->ki_pos);
3463 if (likely(written > 0))
3464 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003465 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466out:
3467 current->backing_dev_info = NULL;
3468 return written ? written : err;
3469}
Al Viro81742022014-04-03 03:17:43 -04003470EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003471
Jan Karae4dd9de2009-08-17 18:10:06 +02003472/**
Al Viro81742022014-04-03 03:17:43 -04003473 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003474 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003475 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003476 *
Al Viro81742022014-04-03 03:17:43 -04003477 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003478 * filesystems. It takes care of syncing the file in case of O_SYNC file
3479 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003480 * Return:
3481 * * negative error code if no data has been written at all of
3482 * vfs_fsync_range() failed for a synchronous write
3483 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003484 */
Al Viro81742022014-04-03 03:17:43 -04003485ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003486{
3487 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003488 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003490
Al Viro59551022016-01-22 15:40:57 -05003491 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003492 ret = generic_write_checks(iocb, from);
3493 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003494 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003495 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496
Christoph Hellwige2592212016-04-07 08:52:01 -07003497 if (ret > 0)
3498 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003499 return ret;
3500}
Al Viro81742022014-04-03 03:17:43 -04003501EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003502
David Howellscf9a2ae2006-08-29 19:05:54 +01003503/**
3504 * try_to_release_page() - release old fs-specific metadata on a page
3505 *
3506 * @page: the page which the kernel is trying to free
3507 * @gfp_mask: memory allocation flags (and I/O mode)
3508 *
3509 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003510 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003511 *
David Howells266cf652009-04-03 16:42:36 +01003512 * This may also be called if PG_fscache is set on a page, indicating that the
3513 * page is known to the local caching routines.
3514 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003515 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003516 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003517 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003518 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003519 */
3520int try_to_release_page(struct page *page, gfp_t gfp_mask)
3521{
3522 struct address_space * const mapping = page->mapping;
3523
3524 BUG_ON(!PageLocked(page));
3525 if (PageWriteback(page))
3526 return 0;
3527
3528 if (mapping && mapping->a_ops->releasepage)
3529 return mapping->a_ops->releasepage(page, gfp_mask);
3530 return try_to_free_buffers(page);
3531}
3532
3533EXPORT_SYMBOL(try_to_release_page);