blob: 16aea94b7e671c9fcd059d9c894d09727b466b31 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8/*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080015#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/fs.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010017#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070018#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080019#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mm.h>
23#include <linux/swap.h>
24#include <linux/mman.h>
25#include <linux/pagemap.h>
26#include <linux/file.h>
27#include <linux/uio.h>
Josef Bacikcfcbfb12019-05-13 17:21:04 -070028#include <linux/error-injection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/hash.h>
30#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070031#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080035#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070036#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080037#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060038#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080039#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070040#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070041#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070042#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070043#include <linux/ramfs.h>
Yang Shib9306a72020-08-06 23:19:55 -070044#include <linux/page_idle.h>
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +030045#include <asm/pgalloc.h>
Will Deaconde591a82021-02-10 11:15:11 +000046#include <asm/tlbflush.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080047#include "internal.h"
48
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070049#define CREATE_TRACE_POINTS
50#include <trace/events/filemap.h>
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * FIXME: remove all knowledge of the buffer layer from the core VM
54 */
Jan Kara148f9482009-08-17 19:52:36 +020055#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#include <asm/mman.h>
58
59/*
60 * Shared mappings implemented 30.11.1994. It's not fully working yet,
61 * though.
62 *
63 * Shared mappings now work. 15.8.1995 Bruno.
64 *
65 * finished 'unifying' the page and buffer cache and SMP-threaded the
66 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
67 *
68 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
69 */
70
71/*
72 * Lock ordering:
73 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080074 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070076 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070077 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080079 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080080 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070082 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080083 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070084 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070085 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070087 * ->mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 * ->lock_page (access_process_vm)
89 *
Al Viroccad2362014-02-11 22:36:48 -050090 * ->i_mutex (generic_perform_write)
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070091 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060093 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110094 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070095 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080097 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 * ->anon_vma.lock (vma_adjust)
99 *
100 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700101 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700103 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700104 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700106 * ->i_pages lock (try_to_unmap_one)
Hugh Dickins15b44732020-12-15 14:21:31 -0800107 * ->lruvec->lru_lock (follow_page->mark_page_accessed)
108 * ->lruvec->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700110 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600111 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100112 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700113 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600114 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100115 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
117 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800118 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700119 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 */
121
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500122static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700123 struct page *page, void *shadow)
124{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500125 XA_STATE(xas, &mapping->i_pages, page->index);
126 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800127
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500128 mapping_set_update(&xas, mapping);
129
130 /* hugetlb pages are represented by a single entry in the xarray */
131 if (!PageHuge(page)) {
132 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700133 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500134 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700135
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700136 VM_BUG_ON_PAGE(!PageLocked(page), page);
137 VM_BUG_ON_PAGE(PageTail(page), page);
138 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700139
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500140 xas_store(&xas, shadow);
141 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200142
Jan Kara23006382017-11-15 17:37:26 -0800143 page->mapping = NULL;
144 /* Leave page->index set: truncation lookup relies upon it */
145
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200146 if (shadow) {
147 mapping->nrexceptional += nr;
148 /*
149 * Make sure the nrexceptional update is committed before
150 * the nrpages update so that final truncate racing
151 * with reclaim does not see both counters 0 at the
152 * same time and miss a shadow entry.
153 */
154 smp_wmb();
155 }
156 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700157}
158
Jan Kara5ecc4d82017-11-15 17:37:29 -0800159static void unaccount_page_cache_page(struct address_space *mapping,
160 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800162 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600164 /*
165 * if we're uptodate, flush out into the cleancache, otherwise
166 * invalidate any existing cleancache entries. We can't leave
167 * stale data around in the cleancache once our page is gone
168 */
169 if (PageUptodate(page) && PageMappedToDisk(page))
170 cleancache_put_page(page);
171 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400172 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600173
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700174 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800175 VM_BUG_ON_PAGE(page_mapped(page), page);
176 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
177 int mapcount;
178
179 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
180 current->comm, page_to_pfn(page));
181 dump_page(page, "still mapped when deleted");
182 dump_stack();
183 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
184
185 mapcount = page_mapcount(page);
186 if (mapping_exiting(mapping) &&
187 page_count(page) >= mapcount + 2) {
188 /*
189 * All vmas have already been torn down, so it's
190 * a good bet that actually the page is unmapped,
191 * and we'd prefer not to leak it: if we're wrong,
192 * some other bad page check should catch it later.
193 */
194 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700195 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800196 }
197 }
198
Jan Kara76253fb2017-11-15 17:37:22 -0800199 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800200 if (PageHuge(page))
201 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800202
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700203 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800204
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700205 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800206 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700207 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800208 if (PageTransHuge(page))
Muchun Song57b28472021-02-24 12:03:31 -0800209 __mod_lruvec_page_state(page, NR_SHMEM_THPS, -nr);
Song Liu99cb0db2019-09-23 15:38:00 -0700210 } else if (PageTransHuge(page)) {
Muchun Songbf9ecea2021-02-24 12:03:27 -0800211 __mod_lruvec_page_state(page, NR_FILE_THPS, -nr);
Song Liu09d91cd2019-09-23 15:38:03 -0700212 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800213 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800214
215 /*
216 * At this point page must be either written or cleaned by
217 * truncate. Dirty page here signals a bug and loss of
218 * unwritten data.
219 *
220 * This fixes dirty accounting after removing the page entirely
221 * but leaves PageDirty set: it has no effect for truncated
222 * page and anyway will be cleared before returning page into
223 * buddy allocator.
224 */
225 if (WARN_ON_ONCE(PageDirty(page)))
226 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
227}
228
229/*
230 * Delete a page from the page cache and free it. Caller has to make
231 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700232 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800233 */
234void __delete_from_page_cache(struct page *page, void *shadow)
235{
236 struct address_space *mapping = page->mapping;
237
238 trace_mm_filemap_delete_from_page_cache(page);
239
240 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500241 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242}
243
Jan Kara59c66c52017-11-15 17:37:18 -0800244static void page_cache_free_page(struct address_space *mapping,
245 struct page *page)
246{
247 void (*freepage)(struct page *);
248
249 freepage = mapping->a_ops->freepage;
250 if (freepage)
251 freepage(page);
252
253 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700254 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800255 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
256 } else {
257 put_page(page);
258 }
259}
260
Minchan Kim702cfbf2011-03-22 16:32:43 -0700261/**
262 * delete_from_page_cache - delete page from page cache
263 * @page: the page which the kernel is trying to remove from page cache
264 *
265 * This must be called only on pages that have been verified to be in the page
266 * cache and locked. It will never put the page into the free list, the caller
267 * has a reference on the page.
268 */
269void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700271 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400272 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Matt Mackallcd7619d2005-05-01 08:59:01 -0700274 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700275 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700276 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700277 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500278
Jan Kara59c66c52017-11-15 17:37:18 -0800279 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700280}
281EXPORT_SYMBOL(delete_from_page_cache);
282
Jan Karaaa65c292017-11-15 17:37:33 -0800283/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500284 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800285 * @mapping: the mapping to which pages belong
286 * @pvec: pagevec with pages to delete
287 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700288 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700289 * from the mapping. The function expects @pvec to be sorted by page index
290 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700291 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800292 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700293 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800294 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700295 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800296 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500297static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800298 struct pagevec *pvec)
299{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500300 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800301 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700302 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800303 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800304
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500305 mapping_set_update(&xas, mapping);
306 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700307 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800308 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700309
310 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400311 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800312 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700313 /*
314 * A page got inserted in our range? Skip it. We have our
315 * pages locked so they are protected from being removed.
316 * If we see a page whose index is higher than ours, it
317 * means our page has been removed, which shouldn't be
318 * possible because we're holding the PageLock.
319 */
320 if (page != pvec->pages[i]) {
321 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
322 page);
323 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700324 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700325
326 WARN_ON_ONCE(!PageLocked(page));
327
328 if (page->index == xas.xa_index)
329 page->mapping = NULL;
330 /* Leave page->index set: truncation lookup relies on it */
331
332 /*
333 * Move to the next page in the vector if this is a regular
334 * page or the index is of the last sub-page of this compound
335 * page.
336 */
337 if (page->index + compound_nr(page) - 1 == xas.xa_index)
338 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500339 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800340 total_pages++;
341 }
342 mapping->nrpages -= total_pages;
343}
344
345void delete_from_page_cache_batch(struct address_space *mapping,
346 struct pagevec *pvec)
347{
348 int i;
349 unsigned long flags;
350
351 if (!pagevec_count(pvec))
352 return;
353
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700354 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800355 for (i = 0; i < pagevec_count(pvec); i++) {
356 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
357
358 unaccount_page_cache_page(mapping, pvec->pages[i]);
359 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500360 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700361 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800362
363 for (i = 0; i < pagevec_count(pvec); i++)
364 page_cache_free_page(mapping, pvec->pages[i]);
365}
366
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200367int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700368{
369 int ret = 0;
370 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700371 if (test_bit(AS_ENOSPC, &mapping->flags) &&
372 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700373 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700374 if (test_bit(AS_EIO, &mapping->flags) &&
375 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700376 ret = -EIO;
377 return ret;
378}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200379EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700380
Jeff Layton76341ca2017-07-06 07:02:22 -0400381static int filemap_check_and_keep_errors(struct address_space *mapping)
382{
383 /* Check for outstanding write errors */
384 if (test_bit(AS_EIO, &mapping->flags))
385 return -EIO;
386 if (test_bit(AS_ENOSPC, &mapping->flags))
387 return -ENOSPC;
388 return 0;
389}
390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700392 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700393 * @mapping: address space structure to write
394 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800395 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700396 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700398 * Start writeback against all of a mapping's dirty pages that lie
399 * within the byte offsets <start, end> inclusive.
400 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700402 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 * these two operations is that if a dirty page/buffer is encountered, it must
404 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800405 *
406 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800408int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
409 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
411 int ret;
412 struct writeback_control wbc = {
413 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800414 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700415 .range_start = start,
416 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 };
418
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200419 if (!mapping_can_writeback(mapping) ||
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700420 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 return 0;
422
Tejun Heob16b1de2015-06-02 08:39:48 -0600423 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600425 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 return ret;
427}
428
429static inline int __filemap_fdatawrite(struct address_space *mapping,
430 int sync_mode)
431{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700432 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433}
434
435int filemap_fdatawrite(struct address_space *mapping)
436{
437 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
438}
439EXPORT_SYMBOL(filemap_fdatawrite);
440
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400441int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800442 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
444 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
445}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400446EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Randy Dunlap485bb992006-06-23 02:03:49 -0700448/**
449 * filemap_flush - mostly a non-blocking flush
450 * @mapping: target address_space
451 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 * This is a mostly non-blocking flush. Not suitable for data-integrity
453 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800454 *
455 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 */
457int filemap_flush(struct address_space *mapping)
458{
459 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
460}
461EXPORT_SYMBOL(filemap_flush);
462
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500463/**
464 * filemap_range_has_page - check if a page exists in range.
465 * @mapping: address space within which to check
466 * @start_byte: offset in bytes where the range starts
467 * @end_byte: offset in bytes where the range ends (inclusive)
468 *
469 * Find at least one page in the range supplied, usually used to check if
470 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800471 *
472 * Return: %true if at least one page exists in the specified range,
473 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500474 */
475bool filemap_range_has_page(struct address_space *mapping,
476 loff_t start_byte, loff_t end_byte)
477{
Jan Karaf7b68042017-09-06 16:21:40 -0700478 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500479 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
480 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500481
482 if (end_byte < start_byte)
483 return false;
484
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500485 rcu_read_lock();
486 for (;;) {
487 page = xas_find(&xas, max);
488 if (xas_retry(&xas, page))
489 continue;
490 /* Shadow entries don't count */
491 if (xa_is_value(page))
492 continue;
493 /*
494 * We don't need to try to pin this page; we're about to
495 * release the RCU lock anyway. It is enough to know that
496 * there was a page here recently.
497 */
498 break;
499 }
500 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500501
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500502 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500503}
504EXPORT_SYMBOL(filemap_range_has_page);
505
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400506static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800507 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300509 pgoff_t index = start_byte >> PAGE_SHIFT;
510 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 struct pagevec pvec;
512 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200514 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400515 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Mel Gorman86679822017-11-15 17:37:52 -0800517 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800518 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 unsigned i;
520
Jan Kara312e9d22017-11-15 17:35:05 -0800521 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800522 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800523 if (!nr_pages)
524 break;
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 for (i = 0; i < nr_pages; i++) {
527 struct page *page = pvec.pages[i];
528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400530 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 }
532 pagevec_release(&pvec);
533 cond_resched();
534 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800535}
536
537/**
538 * filemap_fdatawait_range - wait for writeback to complete
539 * @mapping: address space structure to wait for
540 * @start_byte: offset in bytes where the range starts
541 * @end_byte: offset in bytes where the range ends (inclusive)
542 *
543 * Walk the list of under-writeback pages of the given address space
544 * in the given range and wait for all of them. Check error status of
545 * the address space and return it.
546 *
547 * Since the error status of the address space is cleared by this function,
548 * callers are responsible for checking the return value and handling and/or
549 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800550 *
551 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800552 */
553int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
554 loff_t end_byte)
555{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400556 __filemap_fdatawait_range(mapping, start_byte, end_byte);
557 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200559EXPORT_SYMBOL(filemap_fdatawait_range);
560
561/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400562 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
563 * @mapping: address space structure to wait for
564 * @start_byte: offset in bytes where the range starts
565 * @end_byte: offset in bytes where the range ends (inclusive)
566 *
567 * Walk the list of under-writeback pages of the given address space in the
568 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
569 * this function does not clear error status of the address space.
570 *
571 * Use this function if callers don't handle errors themselves. Expected
572 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
573 * fsfreeze(8)
574 */
575int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
576 loff_t start_byte, loff_t end_byte)
577{
578 __filemap_fdatawait_range(mapping, start_byte, end_byte);
579 return filemap_check_and_keep_errors(mapping);
580}
581EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
582
583/**
Jeff Laytona823e452017-07-28 07:24:43 -0400584 * file_fdatawait_range - wait for writeback to complete
585 * @file: file pointing to address space structure to wait for
586 * @start_byte: offset in bytes where the range starts
587 * @end_byte: offset in bytes where the range ends (inclusive)
588 *
589 * Walk the list of under-writeback pages of the address space that file
590 * refers to, in the given range and wait for all of them. Check error
591 * status of the address space vs. the file->f_wb_err cursor and return it.
592 *
593 * Since the error status of the file is advanced by this function,
594 * callers are responsible for checking the return value and handling and/or
595 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800596 *
597 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400598 */
599int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
600{
601 struct address_space *mapping = file->f_mapping;
602
603 __filemap_fdatawait_range(mapping, start_byte, end_byte);
604 return file_check_and_advance_wb_err(file);
605}
606EXPORT_SYMBOL(file_fdatawait_range);
607
608/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800609 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
610 * @mapping: address space structure to wait for
611 *
612 * Walk the list of under-writeback pages of the given address space
613 * and wait for all of them. Unlike filemap_fdatawait(), this function
614 * does not clear error status of the address space.
615 *
616 * Use this function if callers don't handle errors themselves. Expected
617 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
618 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800619 *
620 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800621 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400622int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800623{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400624 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400625 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800626}
Jeff Layton76341ca2017-07-06 07:02:22 -0400627EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800628
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700629/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400630static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700632 if (dax_mapping(mapping))
633 return mapping->nrexceptional;
634
635 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Randy Dunlap485bb992006-06-23 02:03:49 -0700638/**
Jens Axboe63135aa2021-04-29 22:55:18 -0700639 * filemap_range_needs_writeback - check if range potentially needs writeback
640 * @mapping: address space within which to check
641 * @start_byte: offset in bytes where the range starts
642 * @end_byte: offset in bytes where the range ends (inclusive)
643 *
644 * Find at least one page in the range supplied, usually used to check if
645 * direct writing in this range will trigger a writeback. Used by O_DIRECT
646 * read/write with IOCB_NOWAIT, to see if the caller needs to do
647 * filemap_write_and_wait_range() before proceeding.
648 *
649 * Return: %true if the caller should do filemap_write_and_wait_range() before
650 * doing O_DIRECT to a page in this range, %false otherwise.
651 */
652bool filemap_range_needs_writeback(struct address_space *mapping,
653 loff_t start_byte, loff_t end_byte)
654{
655 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
656 pgoff_t max = end_byte >> PAGE_SHIFT;
657 struct page *page;
658
659 if (!mapping_needs_writeback(mapping))
660 return false;
661 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
662 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
663 return false;
664 if (end_byte < start_byte)
665 return false;
666
667 rcu_read_lock();
668 xas_for_each(&xas, page, max) {
669 if (xas_retry(&xas, page))
670 continue;
671 if (xa_is_value(page))
672 continue;
673 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
674 break;
675 }
676 rcu_read_unlock();
677 return page != NULL;
678}
679EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
680
681/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700682 * filemap_write_and_wait_range - write out & wait on a file range
683 * @mapping: the address_space for the pages
684 * @lstart: offset in bytes where the range starts
685 * @lend: offset in bytes where the range ends (inclusive)
686 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800687 * Write out and wait upon file offsets lstart->lend, inclusive.
688 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300689 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800690 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800691 *
692 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800693 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694int filemap_write_and_wait_range(struct address_space *mapping,
695 loff_t lstart, loff_t lend)
696{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800697 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698
Jeff Layton9326c9b2017-07-26 10:21:11 -0400699 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800700 err = __filemap_fdatawrite_range(mapping, lstart, lend,
701 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800702 /*
703 * Even if the above returned error, the pages may be
704 * written partially (e.g. -ENOSPC), so we wait for it.
705 * But the -EIO is special case, it may indicate the worst
706 * thing (e.g. bug) happened, so we avoid waiting for it.
707 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800708 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200709 int err2 = filemap_fdatawait_range(mapping,
710 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800711 if (!err)
712 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400713 } else {
714 /* Clear any previously stored errors */
715 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800716 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700717 } else {
718 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800720 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721}
Chris Masonf6995582009-04-15 13:22:37 -0400722EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
Jeff Layton5660e132017-07-06 07:02:25 -0400724void __filemap_set_wb_err(struct address_space *mapping, int err)
725{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400726 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400727
728 trace_filemap_set_wb_err(mapping, eseq);
729}
730EXPORT_SYMBOL(__filemap_set_wb_err);
731
732/**
733 * file_check_and_advance_wb_err - report wb error (if any) that was previously
734 * and advance wb_err to current one
735 * @file: struct file on which the error is being reported
736 *
737 * When userland calls fsync (or something like nfsd does the equivalent), we
738 * want to report any writeback errors that occurred since the last fsync (or
739 * since the file was opened if there haven't been any).
740 *
741 * Grab the wb_err from the mapping. If it matches what we have in the file,
742 * then just quickly return 0. The file is all caught up.
743 *
744 * If it doesn't match, then take the mapping value, set the "seen" flag in
745 * it and try to swap it into place. If it works, or another task beat us
746 * to it with the new value, then update the f_wb_err and return the error
747 * portion. The error at this point must be reported via proper channels
748 * (a'la fsync, or NFS COMMIT operation, etc.).
749 *
750 * While we handle mapping->wb_err with atomic operations, the f_wb_err
751 * value is protected by the f_lock since we must ensure that it reflects
752 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800753 *
754 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400755 */
756int file_check_and_advance_wb_err(struct file *file)
757{
758 int err = 0;
759 errseq_t old = READ_ONCE(file->f_wb_err);
760 struct address_space *mapping = file->f_mapping;
761
762 /* Locklessly handle the common case where nothing has changed */
763 if (errseq_check(&mapping->wb_err, old)) {
764 /* Something changed, must use slow path */
765 spin_lock(&file->f_lock);
766 old = file->f_wb_err;
767 err = errseq_check_and_advance(&mapping->wb_err,
768 &file->f_wb_err);
769 trace_file_check_and_advance_wb_err(file, old);
770 spin_unlock(&file->f_lock);
771 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700772
773 /*
774 * We're mostly using this function as a drop in replacement for
775 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
776 * that the legacy code would have had on these flags.
777 */
778 clear_bit(AS_EIO, &mapping->flags);
779 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400780 return err;
781}
782EXPORT_SYMBOL(file_check_and_advance_wb_err);
783
784/**
785 * file_write_and_wait_range - write out & wait on a file range
786 * @file: file pointing to address_space with pages
787 * @lstart: offset in bytes where the range starts
788 * @lend: offset in bytes where the range ends (inclusive)
789 *
790 * Write out and wait upon file offsets lstart->lend, inclusive.
791 *
792 * Note that @lend is inclusive (describes the last byte to be written) so
793 * that this function can be used to write to the very end-of-file (end = -1).
794 *
795 * After writing out and waiting on the data, we check and advance the
796 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800797 *
798 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400799 */
800int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
801{
802 int err = 0, err2;
803 struct address_space *mapping = file->f_mapping;
804
Jeff Layton9326c9b2017-07-26 10:21:11 -0400805 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400806 err = __filemap_fdatawrite_range(mapping, lstart, lend,
807 WB_SYNC_ALL);
808 /* See comment of filemap_write_and_wait() */
809 if (err != -EIO)
810 __filemap_fdatawait_range(mapping, lstart, lend);
811 }
812 err2 = file_check_and_advance_wb_err(file);
813 if (!err)
814 err = err2;
815 return err;
816}
817EXPORT_SYMBOL(file_write_and_wait_range);
818
Randy Dunlap485bb992006-06-23 02:03:49 -0700819/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700820 * replace_page_cache_page - replace a pagecache page with a new one
821 * @old: page to be replaced
822 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700823 *
824 * This function replaces a page in the pagecache with a new one. On
825 * success it acquires the pagecache reference for the new page and
826 * drops it for the old page. Both the old and new pages must be
827 * locked. This function does not add the new page to the LRU, the
828 * caller must do that.
829 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500830 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700831 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800832void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700833{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500834 struct address_space *mapping = old->mapping;
835 void (*freepage)(struct page *) = mapping->a_ops->freepage;
836 pgoff_t offset = old->index;
837 XA_STATE(xas, &mapping->i_pages, offset);
838 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700839
Sasha Levin309381fea2014-01-23 15:52:54 -0800840 VM_BUG_ON_PAGE(!PageLocked(old), old);
841 VM_BUG_ON_PAGE(!PageLocked(new), new);
842 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700843
Matthew Wilcox74d60952017-11-17 10:01:45 -0500844 get_page(new);
845 new->mapping = mapping;
846 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700847
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700848 mem_cgroup_migrate(old, new);
849
Matthew Wilcox74d60952017-11-17 10:01:45 -0500850 xas_lock_irqsave(&xas, flags);
851 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700852
Matthew Wilcox74d60952017-11-17 10:01:45 -0500853 old->mapping = NULL;
854 /* hugetlb pages do not participate in page cache accounting. */
855 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700856 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500857 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700858 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500859 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700860 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500861 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700862 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500863 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500864 if (freepage)
865 freepage(old);
866 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700867}
868EXPORT_SYMBOL_GPL(replace_page_cache_page);
869
Andrew Morton16c0cc02020-12-11 13:36:27 -0800870noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700871 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700872 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700873 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500875 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700876 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700877 int error;
Waiman Longda742402021-02-04 18:32:45 -0800878 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700879
Sasha Levin309381fea2014-01-23 15:52:54 -0800880 VM_BUG_ON_PAGE(!PageLocked(page), page);
881 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500882 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700883
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300884 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700885 page->mapping = mapping;
886 page->index = offset;
887
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700888 if (!huge) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700889 error = mem_cgroup_charge(page, current->mm, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700890 if (error)
891 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800892 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700893 }
894
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700895 gfp &= GFP_RECLAIM_MASK;
896
Matthew Wilcox74d60952017-11-17 10:01:45 -0500897 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700898 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
899 void *entry, *old = NULL;
900
901 if (order > thp_order(page))
902 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
903 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500904 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700905 xas_for_each_conflict(&xas, entry) {
906 old = entry;
907 if (!xa_is_value(entry)) {
908 xas_set_err(&xas, -EEXIST);
909 goto unlock;
910 }
911 }
912
913 if (old) {
914 if (shadowp)
915 *shadowp = old;
916 /* entry may have been split before we acquired lock */
917 order = xa_get_order(xas.xa, xas.xa_index);
918 if (order > thp_order(page)) {
919 xas_split(&xas, old, order);
920 xas_reset(&xas);
921 }
922 }
923
Matthew Wilcox74d60952017-11-17 10:01:45 -0500924 xas_store(&xas, page);
925 if (xas_error(&xas))
926 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700927
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700928 if (old)
Matthew Wilcox74d60952017-11-17 10:01:45 -0500929 mapping->nrexceptional--;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500930 mapping->nrpages++;
931
932 /* hugetlb pages do not participate in page cache accounting */
933 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700934 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500935unlock:
936 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700937 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500938
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700939 if (xas_error(&xas)) {
940 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800941 if (charged)
942 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500943 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700944 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500945
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700946 trace_mm_filemap_add_to_page_cache(page);
947 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500948error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700949 page->mapping = NULL;
950 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300951 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700952 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700954ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700955
956/**
957 * add_to_page_cache_locked - add a locked page to the pagecache
958 * @page: page to add
959 * @mapping: the page's address_space
960 * @offset: page index
961 * @gfp_mask: page allocation mode
962 *
963 * This function is used to add a page to the pagecache. It must be locked.
964 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800965 *
966 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700967 */
968int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
969 pgoff_t offset, gfp_t gfp_mask)
970{
971 return __add_to_page_cache_locked(page, mapping, offset,
972 gfp_mask, NULL);
973}
Nick Piggine2867812008-07-25 19:45:30 -0700974EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
976int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400977 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978{
Johannes Weinera5289102014-04-03 14:47:51 -0700979 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700980 int ret;
981
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800982 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700983 ret = __add_to_page_cache_locked(page, mapping, offset,
984 gfp_mask, &shadow);
985 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800986 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700987 else {
988 /*
989 * The page might have been evicted from cache only
990 * recently, in which case it should be activated like
991 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700992 * The exception is pages getting rewritten; evicting other
993 * data from the working set, only to cache data that will
994 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700995 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700996 WARN_ON_ONCE(PageActive(page));
997 if (!(gfp_mask & __GFP_WRITE) && shadow)
998 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700999 lru_cache_add(page);
1000 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 return ret;
1002}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001003EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004
Paul Jackson44110fe2006-03-24 03:16:04 -08001005#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -07001006struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -08001007{
Miao Xiec0ff7452010-05-24 14:32:08 -07001008 int n;
1009 struct page *page;
1010
Paul Jackson44110fe2006-03-24 03:16:04 -08001011 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -07001012 unsigned int cpuset_mems_cookie;
1013 do {
Mel Gormand26914d2014-04-03 14:47:24 -07001014 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -07001015 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -07001016 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -07001017 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -07001018
Miao Xiec0ff7452010-05-24 14:32:08 -07001019 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -08001020 }
Nick Piggin2ae88142006-10-28 10:38:23 -07001021 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -08001022}
Nick Piggin2ae88142006-10-28 10:38:23 -07001023EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -08001024#endif
1025
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026/*
1027 * In order to wait for pages to become available there must be
1028 * waitqueues associated with pages. By using a hash table of
1029 * waitqueues where the bucket discipline is to maintain all
1030 * waiters on the same queue and wake all when any of the pages
1031 * become available, and for the woken contexts to check to be
1032 * sure the appropriate page became available, this saves space
1033 * at a cost of "thundering herd" phenomena during rare hash
1034 * collisions.
1035 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001036#define PAGE_WAIT_TABLE_BITS 8
1037#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1038static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1039
1040static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041{
Nicholas Piggin62906022016-12-25 13:00:30 +10001042 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043}
Nicholas Piggin62906022016-12-25 13:00:30 +10001044
1045void __init pagecache_init(void)
1046{
1047 int i;
1048
1049 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1050 init_waitqueue_head(&page_wait_table[i]);
1051
1052 page_writeback_init();
1053}
1054
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001055/*
1056 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001057 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001058 * one.
1059 *
1060 * We have:
1061 *
1062 * (a) no special bits set:
1063 *
1064 * We're just waiting for the bit to be released, and when a waker
1065 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1066 * and remove it from the wait queue.
1067 *
1068 * Simple and straightforward.
1069 *
1070 * (b) WQ_FLAG_EXCLUSIVE:
1071 *
1072 * The waiter is waiting to get the lock, and only one waiter should
1073 * be woken up to avoid any thundering herd behavior. We'll set the
1074 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1075 *
1076 * This is the traditional exclusive wait.
1077 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001078 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001079 *
1080 * The waiter is waiting to get the bit, and additionally wants the
1081 * lock to be transferred to it for fair lock behavior. If the lock
1082 * cannot be taken, we stop walking the wait queue without waking
1083 * the waiter.
1084 *
1085 * This is the "fair lock handoff" case, and in addition to setting
1086 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1087 * that it now has the lock.
1088 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001089static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001090{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001091 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001092 struct wait_page_key *key = arg;
1093 struct wait_page_queue *wait_page
1094 = container_of(wait, struct wait_page_queue, wait);
1095
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001096 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001097 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001098
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001099 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001100 * If it's a lock handoff wait, we get the bit for it, and
1101 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001102 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001103 flags = wait->flags;
1104 if (flags & WQ_FLAG_EXCLUSIVE) {
1105 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001106 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001107 if (flags & WQ_FLAG_CUSTOM) {
1108 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1109 return -1;
1110 flags |= WQ_FLAG_DONE;
1111 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001112 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001113
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001114 /*
1115 * We are holding the wait-queue lock, but the waiter that
1116 * is waiting for this will be checking the flags without
1117 * any locking.
1118 *
1119 * So update the flags atomically, and wake up the waiter
1120 * afterwards to avoid any races. This store-release pairs
1121 * with the load-acquire in wait_on_page_bit_common().
1122 */
1123 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001124 wake_up_state(wait->private, mode);
1125
1126 /*
1127 * Ok, we have successfully done what we're waiting for,
1128 * and we can unconditionally remove the wait entry.
1129 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001130 * Note that this pairs with the "finish_wait()" in the
1131 * waiter, and has to be the absolute last thing we do.
1132 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001133 * might be de-allocated and the process might even have
1134 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001135 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001136 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001137 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001138}
1139
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001140static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001141{
1142 wait_queue_head_t *q = page_waitqueue(page);
1143 struct wait_page_key key;
1144 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001145 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001146
1147 key.page = page;
1148 key.bit_nr = bit_nr;
1149 key.page_match = 0;
1150
Tim Chen11a19c72017-08-25 09:13:55 -07001151 bookmark.flags = 0;
1152 bookmark.private = NULL;
1153 bookmark.func = NULL;
1154 INIT_LIST_HEAD(&bookmark.entry);
1155
Nicholas Piggin62906022016-12-25 13:00:30 +10001156 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001157 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1158
1159 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1160 /*
1161 * Take a breather from holding the lock,
1162 * allow pages that finish wake up asynchronously
1163 * to acquire the lock and remove themselves
1164 * from wait queue
1165 */
1166 spin_unlock_irqrestore(&q->lock, flags);
1167 cpu_relax();
1168 spin_lock_irqsave(&q->lock, flags);
1169 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1170 }
1171
Nicholas Piggin62906022016-12-25 13:00:30 +10001172 /*
1173 * It is possible for other pages to have collided on the waitqueue
1174 * hash, so in that case check for a page match. That prevents a long-
1175 * term waiter
1176 *
1177 * It is still possible to miss a case here, when we woke page waiters
1178 * and removed them from the waitqueue, but there are still other
1179 * page waiters.
1180 */
1181 if (!waitqueue_active(q) || !key.page_match) {
1182 ClearPageWaiters(page);
1183 /*
1184 * It's possible to miss clearing Waiters here, when we woke
1185 * our page waiters, but the hashed waitqueue has waiters for
1186 * other pages on it.
1187 *
1188 * That's okay, it's a rare case. The next waker will clear it.
1189 */
1190 }
1191 spin_unlock_irqrestore(&q->lock, flags);
1192}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001193
1194static void wake_up_page(struct page *page, int bit)
1195{
1196 if (!PageWaiters(page))
1197 return;
1198 wake_up_page_bit(page, bit);
1199}
Nicholas Piggin62906022016-12-25 13:00:30 +10001200
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001201/*
1202 * A choice of three behaviors for wait_on_page_bit_common():
1203 */
1204enum behavior {
1205 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1206 * __lock_page() waiting on then setting PG_locked.
1207 */
1208 SHARED, /* Hold ref to page and check the bit when woken, like
1209 * wait_on_page_writeback() waiting on PG_writeback.
1210 */
1211 DROP, /* Drop ref to page before wait, no check when woken,
1212 * like put_and_wait_on_page_locked() on PG_locked.
1213 */
1214};
1215
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001216/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001217 * Attempt to check (or get) the page bit, and mark us done
1218 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001219 */
1220static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1221 struct wait_queue_entry *wait)
1222{
1223 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1224 if (test_and_set_bit(bit_nr, &page->flags))
1225 return false;
1226 } else if (test_bit(bit_nr, &page->flags))
1227 return false;
1228
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001229 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001230 return true;
1231}
1232
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001233/* How many times do we accept lock stealing from under a waiter? */
1234int sysctl_page_lock_unfairness = 5;
1235
Nicholas Piggin62906022016-12-25 13:00:30 +10001236static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001237 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001238{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001239 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001240 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001241 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001242 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001243 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001244 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001245
Johannes Weinereb414682018-10-26 15:06:27 -07001246 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001247 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001248 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001249 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001250 delayacct = true;
1251 }
Johannes Weinereb414682018-10-26 15:06:27 -07001252 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001253 thrashing = true;
1254 }
1255
Nicholas Piggin62906022016-12-25 13:00:30 +10001256 init_wait(wait);
1257 wait->func = wake_page_function;
1258 wait_page.page = page;
1259 wait_page.bit_nr = bit_nr;
1260
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001261repeat:
1262 wait->flags = 0;
1263 if (behavior == EXCLUSIVE) {
1264 wait->flags = WQ_FLAG_EXCLUSIVE;
1265 if (--unfairness < 0)
1266 wait->flags |= WQ_FLAG_CUSTOM;
1267 }
1268
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001269 /*
1270 * Do one last check whether we can get the
1271 * page bit synchronously.
1272 *
1273 * Do the SetPageWaiters() marking before that
1274 * to let any waker we _just_ missed know they
1275 * need to wake us up (otherwise they'll never
1276 * even go to the slow case that looks at the
1277 * page queue), and add ourselves to the wait
1278 * queue if we need to sleep.
1279 *
1280 * This part needs to be done under the queue
1281 * lock to avoid races.
1282 */
1283 spin_lock_irq(&q->lock);
1284 SetPageWaiters(page);
1285 if (!trylock_page_bit_common(page, bit_nr, wait))
1286 __add_wait_queue_entry_tail(q, wait);
1287 spin_unlock_irq(&q->lock);
1288
1289 /*
1290 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001291 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1292 * see whether the page bit testing has already
1293 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001294 *
1295 * We can drop our reference to the page.
1296 */
1297 if (behavior == DROP)
1298 put_page(page);
1299
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001300 /*
1301 * Note that until the "finish_wait()", or until
1302 * we see the WQ_FLAG_WOKEN flag, we need to
1303 * be very careful with the 'wait->flags', because
1304 * we may race with a waker that sets them.
1305 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001306 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001307 unsigned int flags;
1308
Nicholas Piggin62906022016-12-25 13:00:30 +10001309 set_current_state(state);
1310
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001311 /* Loop until we've been woken or interrupted */
1312 flags = smp_load_acquire(&wait->flags);
1313 if (!(flags & WQ_FLAG_WOKEN)) {
1314 if (signal_pending_state(state, current))
1315 break;
1316
1317 io_schedule();
1318 continue;
1319 }
1320
1321 /* If we were non-exclusive, we're done */
1322 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001323 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001324
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001325 /* If the waker got the lock for us, we're done */
1326 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001327 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001328
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001329 /*
1330 * Otherwise, if we're getting the lock, we need to
1331 * try to get it ourselves.
1332 *
1333 * And if that fails, we'll have to retry this all.
1334 */
1335 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1336 goto repeat;
1337
1338 wait->flags |= WQ_FLAG_DONE;
1339 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001340 }
1341
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001342 /*
1343 * If a signal happened, this 'finish_wait()' may remove the last
1344 * waiter from the wait-queues, but the PageWaiters bit will remain
1345 * set. That's ok. The next wakeup will take care of it, and trying
1346 * to do it here would be difficult and prone to races.
1347 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001348 finish_wait(q, wait);
1349
Johannes Weinereb414682018-10-26 15:06:27 -07001350 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001351 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001352 delayacct_thrashing_end();
1353 psi_memstall_leave(&pflags);
1354 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001355
Nicholas Piggin62906022016-12-25 13:00:30 +10001356 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001357 * NOTE! The wait->flags weren't stable until we've done the
1358 * 'finish_wait()', and we could have exited the loop above due
1359 * to a signal, and had a wakeup event happen after the signal
1360 * test but before the 'finish_wait()'.
1361 *
1362 * So only after the finish_wait() can we reliably determine
1363 * if we got woken up or not, so we can now figure out the final
1364 * return value based on that state without races.
1365 *
1366 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1367 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001368 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001369 if (behavior == EXCLUSIVE)
1370 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001371
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001372 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001373}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374
Harvey Harrison920c7a52008-02-04 22:29:26 -08001375void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376{
Nicholas Piggin62906022016-12-25 13:00:30 +10001377 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001378 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379}
1380EXPORT_SYMBOL(wait_on_page_bit);
1381
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001382int wait_on_page_bit_killable(struct page *page, int bit_nr)
1383{
Nicholas Piggin62906022016-12-25 13:00:30 +10001384 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001385 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001386}
David Howells4343d002017-11-02 15:27:52 +00001387EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001388
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001390 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1391 * @page: The page to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001392 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001393 *
1394 * The caller should hold a reference on @page. They expect the page to
1395 * become unlocked relatively soon, but do not wish to hold up migration
1396 * (for example) by holding the reference while waiting for the page to
1397 * come unlocked. After this function returns, the caller should not
1398 * dereference @page.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001399 *
1400 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001401 */
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001402int put_and_wait_on_page_locked(struct page *page, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001403{
1404 wait_queue_head_t *q;
1405
1406 page = compound_head(page);
1407 q = page_waitqueue(page);
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001408 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001409}
1410
1411/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001412 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001413 * @page: Page defining the wait queue of interest
1414 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001415 *
1416 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1417 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001418void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001419{
1420 wait_queue_head_t *q = page_waitqueue(page);
1421 unsigned long flags;
1422
1423 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001424 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001425 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001426 spin_unlock_irqrestore(&q->lock, flags);
1427}
1428EXPORT_SYMBOL_GPL(add_page_wait_queue);
1429
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001430#ifndef clear_bit_unlock_is_negative_byte
1431
1432/*
1433 * PG_waiters is the high bit in the same byte as PG_lock.
1434 *
1435 * On x86 (and on many other architectures), we can clear PG_lock and
1436 * test the sign bit at the same time. But if the architecture does
1437 * not support that special operation, we just do this all by hand
1438 * instead.
1439 *
1440 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001441 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001442 * in the same byte as PG_locked.
1443 */
1444static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1445{
1446 clear_bit_unlock(nr, mem);
1447 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001448 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001449}
1450
1451#endif
1452
David Howells385e1ca5f2009-04-03 16:42:39 +01001453/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001454 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 * @page: the page
1456 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001457 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001459 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1461 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001462 * Note that this depends on PG_waiters being the sign bit in the byte
1463 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1464 * clear the PG_locked bit and test PG_waiters at the same time fairly
1465 * portably (architectures that do LL/SC can test any bit, while x86 can
1466 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001468void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001470 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001471 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001472 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001473 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1474 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475}
1476EXPORT_SYMBOL(unlock_page);
1477
Randy Dunlap485bb992006-06-23 02:03:49 -07001478/**
David Howells73e10de2020-02-10 10:00:21 +00001479 * end_page_private_2 - Clear PG_private_2 and release any waiters
1480 * @page: The page
1481 *
1482 * Clear the PG_private_2 bit on a page and wake up any sleepers waiting for
1483 * this. The page ref held for PG_private_2 being set is released.
1484 *
1485 * This is, for example, used when a netfs page is being written to a local
1486 * disk cache, thereby allowing writes to the cache for the same page to be
1487 * serialised.
1488 */
1489void end_page_private_2(struct page *page)
1490{
1491 page = compound_head(page);
1492 VM_BUG_ON_PAGE(!PagePrivate2(page), page);
1493 clear_bit_unlock(PG_private_2, &page->flags);
1494 wake_up_page_bit(page, PG_private_2);
1495 put_page(page);
1496}
1497EXPORT_SYMBOL(end_page_private_2);
1498
1499/**
1500 * wait_on_page_private_2 - Wait for PG_private_2 to be cleared on a page
1501 * @page: The page to wait on
1502 *
1503 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page.
1504 */
1505void wait_on_page_private_2(struct page *page)
1506{
1507 page = compound_head(page);
1508 while (PagePrivate2(page))
1509 wait_on_page_bit(page, PG_private_2);
1510}
1511EXPORT_SYMBOL(wait_on_page_private_2);
1512
1513/**
1514 * wait_on_page_private_2_killable - Wait for PG_private_2 to be cleared on a page
1515 * @page: The page to wait on
1516 *
1517 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page or until a
1518 * fatal signal is received by the calling task.
1519 *
1520 * Return:
1521 * - 0 if successful.
1522 * - -EINTR if a fatal signal was encountered.
1523 */
1524int wait_on_page_private_2_killable(struct page *page)
1525{
1526 int ret = 0;
1527
1528 page = compound_head(page);
1529 while (PagePrivate2(page)) {
1530 ret = wait_on_page_bit_killable(page, PG_private_2);
1531 if (ret < 0)
1532 break;
1533 }
1534
1535 return ret;
1536}
1537EXPORT_SYMBOL(wait_on_page_private_2_killable);
1538
1539/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001540 * end_page_writeback - end writeback against a page
1541 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 */
1543void end_page_writeback(struct page *page)
1544{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001545 /*
1546 * TestClearPageReclaim could be used here but it is an atomic
1547 * operation and overkill in this particular case. Failing to
1548 * shuffle a page marked for immediate reclaim is too mild to
1549 * justify taking an atomic operation penalty at the end of
1550 * ever page writeback.
1551 */
1552 if (PageReclaim(page)) {
1553 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001554 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001555 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001556
Hugh Dickins073861e2020-11-24 08:46:43 -08001557 /*
1558 * Writeback does not hold a page reference of its own, relying
1559 * on truncation to wait for the clearing of PG_writeback.
1560 * But here we must make sure that the page is not freed and
1561 * reused before the wake_up_page().
1562 */
1563 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001564 if (!test_clear_page_writeback(page))
1565 BUG();
1566
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001567 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001569 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570}
1571EXPORT_SYMBOL(end_page_writeback);
1572
Matthew Wilcox57d99842014-06-04 16:07:45 -07001573/*
1574 * After completing I/O on a page, call this routine to update the page
1575 * flags appropriately
1576 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001577void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001578{
Jens Axboec11f0c02016-08-05 08:11:04 -06001579 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001580 if (!err) {
1581 SetPageUptodate(page);
1582 } else {
1583 ClearPageUptodate(page);
1584 SetPageError(page);
1585 }
1586 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001587 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001588 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001589 struct address_space *mapping;
1590
Matthew Wilcox57d99842014-06-04 16:07:45 -07001591 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001592 mapping = page_mapping(page);
1593 if (mapping)
1594 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001595 }
1596 end_page_writeback(page);
1597 }
1598}
1599EXPORT_SYMBOL_GPL(page_endio);
1600
Randy Dunlap485bb992006-06-23 02:03:49 -07001601/**
1602 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001603 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001605void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606{
Nicholas Piggin62906022016-12-25 13:00:30 +10001607 struct page *page = compound_head(__page);
1608 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001609 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1610 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611}
1612EXPORT_SYMBOL(__lock_page);
1613
Nicholas Piggin62906022016-12-25 13:00:30 +10001614int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001615{
Nicholas Piggin62906022016-12-25 13:00:30 +10001616 struct page *page = compound_head(__page);
1617 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001618 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1619 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001620}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001621EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001622
Jens Axboedd3e6d52020-05-22 09:12:09 -06001623int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1624{
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001625 struct wait_queue_head *q = page_waitqueue(page);
1626 int ret = 0;
1627
1628 wait->page = page;
1629 wait->bit_nr = PG_locked;
1630
1631 spin_lock_irq(&q->lock);
1632 __add_wait_queue_entry_tail(q, &wait->wait);
1633 SetPageWaiters(page);
1634 ret = !trylock_page(page);
1635 /*
1636 * If we were successful now, we know we're still on the
1637 * waitqueue as we're still under the lock. This means it's
1638 * safe to remove and return success, we know the callback
1639 * isn't going to trigger.
1640 */
1641 if (!ret)
1642 __remove_wait_queue(q, &wait->wait);
1643 else
1644 ret = -EIOCBQUEUED;
1645 spin_unlock_irq(&q->lock);
1646 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001647}
1648
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001649/*
1650 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001651 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001652 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001653 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001654 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001655 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001656 *
1657 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001658 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001659 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001660int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1661 unsigned int flags)
1662{
Peter Xu4064b982020-04-01 21:08:45 -07001663 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001664 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001665 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001666 * even though return 0.
1667 */
1668 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1669 return 0;
1670
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001671 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001672 if (flags & FAULT_FLAG_KILLABLE)
1673 wait_on_page_locked_killable(page);
1674 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001675 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001676 return 0;
1677 }
Hailong Liu800bca72020-12-14 19:05:02 -08001678 if (flags & FAULT_FLAG_KILLABLE) {
1679 int ret;
1680
1681 ret = __lock_page_killable(page);
1682 if (ret) {
1683 mmap_read_unlock(mm);
1684 return 0;
1685 }
1686 } else {
1687 __lock_page(page);
1688 }
1689 return 1;
1690
Michel Lespinassed065bd82010-10-26 14:21:57 -07001691}
1692
Randy Dunlap485bb992006-06-23 02:03:49 -07001693/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001694 * page_cache_next_miss() - Find the next gap in the page cache.
1695 * @mapping: Mapping.
1696 * @index: Index.
1697 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001698 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001699 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1700 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001701 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001702 * This function may be called under the rcu_read_lock. However, this will
1703 * not atomically search a snapshot of the cache at a single point in time.
1704 * For example, if a gap is created at index 5, then subsequently a gap is
1705 * created at index 10, page_cache_next_miss covering both indices may
1706 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001707 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001708 * Return: The index of the gap if found, otherwise an index outside the
1709 * range specified (in which case 'return - index >= max_scan' will be true).
1710 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001711 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001712pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001713 pgoff_t index, unsigned long max_scan)
1714{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001715 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001716
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001717 while (max_scan--) {
1718 void *entry = xas_next(&xas);
1719 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001720 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001721 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001722 break;
1723 }
1724
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001725 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001726}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001727EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001728
1729/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001730 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001731 * @mapping: Mapping.
1732 * @index: Index.
1733 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001734 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001735 * Search the range [max(index - max_scan + 1, 0), index] for the
1736 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001737 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001738 * This function may be called under the rcu_read_lock. However, this will
1739 * not atomically search a snapshot of the cache at a single point in time.
1740 * For example, if a gap is created at index 10, then subsequently a gap is
1741 * created at index 5, page_cache_prev_miss() covering both indices may
1742 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001743 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001744 * Return: The index of the gap if found, otherwise an index outside the
1745 * range specified (in which case 'index - return >= max_scan' will be true).
1746 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001747 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001748pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001749 pgoff_t index, unsigned long max_scan)
1750{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001751 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001752
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001753 while (max_scan--) {
1754 void *entry = xas_prev(&xas);
1755 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001756 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001757 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001758 break;
1759 }
1760
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001761 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001762}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001763EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001764
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001765/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001766 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001767 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001768 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001769 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001770 * Looks up the page cache slot at @mapping & @offset. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001771 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001772 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001773 * If the slot holds a shadow entry of a previously evicted page, or a
1774 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001775 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001776 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777 */
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001778static struct page *mapping_get_entry(struct address_space *mapping,
1779 pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001781 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001782 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Nick Piggina60637c2008-07-25 19:45:31 -07001784 rcu_read_lock();
1785repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001786 xas_reset(&xas);
1787 page = xas_load(&xas);
1788 if (xas_retry(&xas, page))
1789 goto repeat;
1790 /*
1791 * A shadow entry of a recently evicted page, or a swap entry from
1792 * shmem/tmpfs. Return it without attempting to raise page count.
1793 */
1794 if (!page || xa_is_value(page))
1795 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001796
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001797 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001798 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001799
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001800 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001801 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001802 * This is part of the lockless pagecache protocol. See
1803 * include/linux/pagemap.h for details.
1804 */
1805 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001806 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001807 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001808 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001809out:
Nick Piggina60637c2008-07-25 19:45:31 -07001810 rcu_read_unlock();
1811
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 return page;
1813}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
Randy Dunlap485bb992006-06-23 02:03:49 -07001815/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001816 * pagecache_get_page - Find and get a reference to a page.
1817 * @mapping: The address_space to search.
1818 * @index: The page index.
1819 * @fgp_flags: %FGP flags modify how the page is returned.
1820 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001821 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001822 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001823 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001824 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001825 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001826 * * %FGP_ACCESSED - The page will be marked accessed.
1827 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001828 * * %FGP_HEAD - If the page is present and a THP, return the head page
1829 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001830 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
1831 * instead of allocating a new page to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001832 * * %FGP_CREAT - If no page is present then a new page is allocated using
1833 * @gfp_mask and added to the page cache and the VM's LRU list.
1834 * The page is returned locked and with an increased refcount.
1835 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1836 * page is already in cache. If the page was allocated, unlock it before
1837 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001838 * * %FGP_WRITE - The page will be written
1839 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1840 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001841 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001842 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1843 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001844 *
1845 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001846 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001847 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001848 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001849struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1850 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851{
Nick Piggineb2be182007-10-16 01:24:57 -07001852 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001853
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854repeat:
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001855 page = mapping_get_entry(mapping, index);
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001856 if (xa_is_value(page)) {
1857 if (fgp_flags & FGP_ENTRY)
1858 return page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001859 page = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001860 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001861 if (!page)
1862 goto no_page;
1863
1864 if (fgp_flags & FGP_LOCK) {
1865 if (fgp_flags & FGP_NOWAIT) {
1866 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001867 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001868 return NULL;
1869 }
1870 } else {
1871 lock_page(page);
1872 }
1873
1874 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001875 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001876 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001877 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001878 goto repeat;
1879 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001880 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001881 }
1882
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001883 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001884 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001885 else if (fgp_flags & FGP_WRITE) {
1886 /* Clear idle flag for buffer write */
1887 if (page_is_idle(page))
1888 clear_page_idle(page);
1889 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001890 if (!(fgp_flags & FGP_HEAD))
1891 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001892
1893no_page:
1894 if (!page && (fgp_flags & FGP_CREAT)) {
1895 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001896 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001897 gfp_mask |= __GFP_WRITE;
1898 if (fgp_flags & FGP_NOFS)
1899 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001900
Michal Hocko45f87de2014-12-29 20:30:35 +01001901 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001902 if (!page)
1903 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001904
Josef Bacika75d4c32019-03-13 11:44:14 -07001905 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001906 fgp_flags |= FGP_LOCK;
1907
Hugh Dickinseb39d612014-08-06 16:06:43 -07001908 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001909 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001910 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001911
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001912 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001913 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001914 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001915 page = NULL;
1916 if (err == -EEXIST)
1917 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001919
1920 /*
1921 * add_to_page_cache_lru locks the page, and for mmap we expect
1922 * an unlocked page.
1923 */
1924 if (page && (fgp_flags & FGP_FOR_MMAP))
1925 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001927
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 return page;
1929}
Mel Gorman2457aec2014-06-04 16:10:31 -07001930EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001932static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1933 xa_mark_t mark)
1934{
1935 struct page *page;
1936
1937retry:
1938 if (mark == XA_PRESENT)
1939 page = xas_find(xas, max);
1940 else
1941 page = xas_find_marked(xas, max, mark);
1942
1943 if (xas_retry(xas, page))
1944 goto retry;
1945 /*
1946 * A shadow entry of a recently evicted page, a swap
1947 * entry from shmem/tmpfs or a DAX entry. Return it
1948 * without attempting to raise page count.
1949 */
1950 if (!page || xa_is_value(page))
1951 return page;
1952
1953 if (!page_cache_get_speculative(page))
1954 goto reset;
1955
1956 /* Has the page moved or been split? */
1957 if (unlikely(page != xas_reload(xas))) {
1958 put_page(page);
1959 goto reset;
1960 }
1961
1962 return page;
1963reset:
1964 xas_reset(xas);
1965 goto retry;
1966}
1967
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001969 * find_get_entries - gang pagecache lookup
1970 * @mapping: The address_space to search
1971 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001972 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001973 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001974 * @indices: The cache indices corresponding to the entries in @entries
1975 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001976 * find_get_entries() will search for and return a batch of entries in
1977 * the mapping. The entries are placed in @pvec. find_get_entries()
1978 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001979 *
1980 * The search returns a group of mapping-contiguous page cache entries
1981 * with ascending indexes. There may be holes in the indices due to
1982 * not-present pages.
1983 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001984 * Any shadow entries of evicted pages, or swap entries from
1985 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001986 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001987 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1988 * stops at that page: the caller is likely to have a better way to handle
1989 * the compound page as a whole, and then skip its extent, than repeatedly
1990 * calling find_get_entries() to return all its tails.
1991 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001992 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001993 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001994unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001995 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07001996{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001997 XA_STATE(xas, &mapping->i_pages, start);
1998 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001999 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002000 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002001
2002 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002003 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002004 /*
2005 * Terminate early on finding a THP, to allow the caller to
2006 * handle it all at once; but continue if this is hugetlbfs.
2007 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002008 if (!xa_is_value(page) && PageTransHuge(page) &&
2009 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002010 page = find_subpage(page, xas.xa_index);
2011 nr_entries = ret + 1;
2012 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002013
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002014 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002015 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002016 if (++ret == nr_entries)
2017 break;
2018 }
2019 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002020
2021 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002022 return ret;
2023}
2024
2025/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002026 * find_lock_entries - Find a batch of pagecache entries.
2027 * @mapping: The address_space to search.
2028 * @start: The starting page cache index.
2029 * @end: The final page index (inclusive).
2030 * @pvec: Where the resulting entries are placed.
2031 * @indices: The cache indices of the entries in @pvec.
2032 *
2033 * find_lock_entries() will return a batch of entries from @mapping.
2034 * Swap, shadow and DAX entries are included. Pages are returned
2035 * locked and with an incremented refcount. Pages which are locked by
2036 * somebody else or under writeback are skipped. Only the head page of
2037 * a THP is returned. Pages which are partially outside the range are
2038 * not returned.
2039 *
2040 * The entries have ascending indexes. The indices may not be consecutive
2041 * due to not-present entries, THP pages, pages which could not be locked
2042 * or pages under writeback.
2043 *
2044 * Return: The number of entries which were found.
2045 */
2046unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2047 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2048{
2049 XA_STATE(xas, &mapping->i_pages, start);
2050 struct page *page;
2051
2052 rcu_read_lock();
2053 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2054 if (!xa_is_value(page)) {
2055 if (page->index < start)
2056 goto put;
2057 VM_BUG_ON_PAGE(page->index != xas.xa_index, page);
2058 if (page->index + thp_nr_pages(page) - 1 > end)
2059 goto put;
2060 if (!trylock_page(page))
2061 goto put;
2062 if (page->mapping != mapping || PageWriteback(page))
2063 goto unlock;
2064 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2065 page);
2066 }
2067 indices[pvec->nr] = xas.xa_index;
2068 if (!pagevec_add(pvec, page))
2069 break;
2070 goto next;
2071unlock:
2072 unlock_page(page);
2073put:
2074 put_page(page);
2075next:
Hugh Dickins2d11e732021-04-23 14:28:57 -07002076 if (!xa_is_value(page) && PageTransHuge(page)) {
2077 unsigned int nr_pages = thp_nr_pages(page);
2078
2079 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
2080 xas_set(&xas, page->index + nr_pages);
2081 if (xas.xa_index < nr_pages)
2082 break;
2083 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002084 }
2085 rcu_read_unlock();
2086
2087 return pagevec_count(pvec);
2088}
2089
2090/**
Jan Karab947cee2017-09-06 16:21:21 -07002091 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 * @mapping: The address_space to search
2093 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002094 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 * @nr_pages: The maximum number of pages
2096 * @pages: Where the resulting pages are placed
2097 *
Jan Karab947cee2017-09-06 16:21:21 -07002098 * find_get_pages_range() will search for and return a group of up to @nr_pages
2099 * pages in the mapping starting at index @start and up to index @end
2100 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2101 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102 *
2103 * The search returns a group of mapping-contiguous pages with ascending
2104 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002105 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002107 * Return: the number of pages which were found. If this number is
2108 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002109 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110 */
Jan Karab947cee2017-09-06 16:21:21 -07002111unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2112 pgoff_t end, unsigned int nr_pages,
2113 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002115 XA_STATE(xas, &mapping->i_pages, *start);
2116 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002117 unsigned ret = 0;
2118
2119 if (unlikely(!nr_pages))
2120 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
Nick Piggina60637c2008-07-25 19:45:31 -07002122 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002123 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002124 /* Skip over shadow, swap and DAX entries */
2125 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002126 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002127
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002128 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002129 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002130 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002131 goto out;
2132 }
Nick Piggina60637c2008-07-25 19:45:31 -07002133 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002134
Jan Karab947cee2017-09-06 16:21:21 -07002135 /*
2136 * We come here when there is no page beyond @end. We take care to not
2137 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002138 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002139 * already broken anyway.
2140 */
2141 if (end == (pgoff_t)-1)
2142 *start = (pgoff_t)-1;
2143 else
2144 *start = end + 1;
2145out:
Nick Piggina60637c2008-07-25 19:45:31 -07002146 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002147
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148 return ret;
2149}
2150
Jens Axboeebf43502006-04-27 08:46:01 +02002151/**
2152 * find_get_pages_contig - gang contiguous pagecache lookup
2153 * @mapping: The address_space to search
2154 * @index: The starting page index
2155 * @nr_pages: The maximum number of pages
2156 * @pages: Where the resulting pages are placed
2157 *
2158 * find_get_pages_contig() works exactly like find_get_pages(), except
2159 * that the returned number of pages are guaranteed to be contiguous.
2160 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002161 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002162 */
2163unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2164 unsigned int nr_pages, struct page **pages)
2165{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002166 XA_STATE(xas, &mapping->i_pages, index);
2167 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002168 unsigned int ret = 0;
2169
2170 if (unlikely(!nr_pages))
2171 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002172
Nick Piggina60637c2008-07-25 19:45:31 -07002173 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002174 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002175 if (xas_retry(&xas, page))
2176 continue;
2177 /*
2178 * If the entry has been swapped out, we can stop looking.
2179 * No current caller is looking for DAX entries.
2180 */
2181 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002182 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002183
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002184 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002185 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002186
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002187 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002188 if (unlikely(page != xas_reload(&xas)))
2189 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002190
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002191 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002192 if (++ret == nr_pages)
2193 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002194 continue;
2195put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002196 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002197retry:
2198 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002199 }
Nick Piggina60637c2008-07-25 19:45:31 -07002200 rcu_read_unlock();
2201 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002202}
David Howellsef71c152007-05-09 02:33:44 -07002203EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002204
Randy Dunlap485bb992006-06-23 02:03:49 -07002205/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002206 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002207 * @mapping: the address_space to search
2208 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002209 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002210 * @tag: the tag index
2211 * @nr_pages: the maximum number of pages
2212 * @pages: where the resulting pages are placed
2213 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002214 * Like find_get_pages(), except we only return head pages which are tagged
2215 * with @tag. @index is updated to the index immediately after the last
2216 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002217 *
2218 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 */
Jan Kara72b045a2017-11-15 17:34:33 -08002220unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002221 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002222 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002224 XA_STATE(xas, &mapping->i_pages, *index);
2225 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002226 unsigned ret = 0;
2227
2228 if (unlikely(!nr_pages))
2229 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230
Nick Piggina60637c2008-07-25 19:45:31 -07002231 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002232 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002233 /*
2234 * Shadow entries should never be tagged, but this iteration
2235 * is lockless so there is a window for page reclaim to evict
2236 * a page we saw tagged. Skip over it.
2237 */
2238 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002239 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002240
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002241 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002242 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002243 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002244 goto out;
2245 }
Nick Piggina60637c2008-07-25 19:45:31 -07002246 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002247
Jan Kara72b045a2017-11-15 17:34:33 -08002248 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002249 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002250 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002251 * iteration when there is a page at index -1 but that is already
2252 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002253 */
2254 if (end == (pgoff_t)-1)
2255 *index = (pgoff_t)-1;
2256 else
2257 *index = end + 1;
2258out:
Nick Piggina60637c2008-07-25 19:45:31 -07002259 rcu_read_unlock();
2260
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 return ret;
2262}
Jan Kara72b045a2017-11-15 17:34:33 -08002263EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002264
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002265/*
2266 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2267 * a _large_ part of the i/o request. Imagine the worst scenario:
2268 *
2269 * ---R__________________________________________B__________
2270 * ^ reading here ^ bad block(assume 4k)
2271 *
2272 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2273 * => failing the whole request => read(R) => read(R+1) =>
2274 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2275 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2276 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2277 *
2278 * It is going insane. Fix it by quickly scaling down the readahead size.
2279 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002280static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002281{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002282 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002283}
2284
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002285/*
2286 * filemap_get_read_batch - Get a batch of pages for read
2287 *
2288 * Get a batch of pages which represent a contiguous range of bytes
2289 * in the file. No tail pages will be returned. If @index is in the
2290 * middle of a THP, the entire THP will be returned. The last page in
2291 * the batch may have Readahead set or be not Uptodate so that the
2292 * caller can take the appropriate action.
2293 */
2294static void filemap_get_read_batch(struct address_space *mapping,
2295 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2296{
2297 XA_STATE(xas, &mapping->i_pages, index);
2298 struct page *head;
2299
2300 rcu_read_lock();
2301 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2302 if (xas_retry(&xas, head))
2303 continue;
2304 if (xas.xa_index > max || xa_is_value(head))
2305 break;
2306 if (!page_cache_get_speculative(head))
2307 goto retry;
2308
2309 /* Has the page moved or been split? */
2310 if (unlikely(head != xas_reload(&xas)))
2311 goto put_page;
2312
2313 if (!pagevec_add(pvec, head))
2314 break;
2315 if (!PageUptodate(head))
2316 break;
2317 if (PageReadahead(head))
2318 break;
2319 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2320 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2321 continue;
2322put_page:
2323 put_page(head);
2324retry:
2325 xas_reset(&xas);
2326 }
2327 rcu_read_unlock();
2328}
2329
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002330static int filemap_read_page(struct file *file, struct address_space *mapping,
2331 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002332{
Kent Overstreet723ef242020-12-14 19:04:52 -08002333 int error;
2334
Kent Overstreet723ef242020-12-14 19:04:52 -08002335 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002336 * A previous I/O error may have been due to temporary failures,
2337 * eg. multipath errors. PG_error will be set again if readpage
2338 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002339 */
2340 ClearPageError(page);
2341 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002342 error = mapping->a_ops->readpage(file, page);
2343 if (error)
2344 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002345
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002346 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002347 if (error)
2348 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002349 if (PageUptodate(page))
2350 return 0;
2351 if (!page->mapping) /* page truncated */
2352 return AOP_TRUNCATED_PAGE;
2353 shrink_readahead_size_eio(&file->f_ra);
2354 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002355}
2356
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002357static bool filemap_range_uptodate(struct address_space *mapping,
2358 loff_t pos, struct iov_iter *iter, struct page *page)
2359{
2360 int count;
2361
2362 if (PageUptodate(page))
2363 return true;
2364 /* pipes can't handle partially uptodate pages */
2365 if (iov_iter_is_pipe(iter))
2366 return false;
2367 if (!mapping->a_ops->is_partially_uptodate)
2368 return false;
2369 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2370 return false;
2371
2372 count = iter->count;
2373 if (page_offset(page) > pos) {
2374 count -= page_offset(page) - pos;
2375 pos = 0;
2376 } else {
2377 pos -= page_offset(page);
2378 }
2379
2380 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2381}
2382
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002383static int filemap_update_page(struct kiocb *iocb,
2384 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002385 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002386{
Kent Overstreet723ef242020-12-14 19:04:52 -08002387 int error;
2388
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002389 if (!trylock_page(page)) {
2390 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2391 return -EAGAIN;
2392 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002393 put_and_wait_on_page_locked(page, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002394 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002395 }
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002396 error = __lock_page_async(page, iocb->ki_waitq);
2397 if (error)
2398 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002399 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002400
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002401 if (!page->mapping)
2402 goto truncated;
Kent Overstreet723ef242020-12-14 19:04:52 -08002403
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002404 error = 0;
2405 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, page))
2406 goto unlock;
2407
2408 error = -EAGAIN;
2409 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2410 goto unlock;
2411
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002412 error = filemap_read_page(iocb->ki_filp, mapping, page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002413 if (error == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002414 put_page(page);
2415 return error;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002416truncated:
2417 unlock_page(page);
2418 put_page(page);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002419 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002420unlock:
2421 unlock_page(page);
2422 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002423}
2424
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002425static int filemap_create_page(struct file *file,
2426 struct address_space *mapping, pgoff_t index,
2427 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002428{
Kent Overstreet723ef242020-12-14 19:04:52 -08002429 struct page *page;
2430 int error;
2431
Kent Overstreet723ef242020-12-14 19:04:52 -08002432 page = page_cache_alloc(mapping);
2433 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002434 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002435
2436 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002437 mapping_gfp_constraint(mapping, GFP_KERNEL));
2438 if (error == -EEXIST)
2439 error = AOP_TRUNCATED_PAGE;
2440 if (error)
2441 goto error;
2442
2443 error = filemap_read_page(file, mapping, page);
2444 if (error)
2445 goto error;
2446
2447 pagevec_add(pvec, page);
2448 return 0;
2449error:
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002450 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002451 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002452}
2453
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002454static int filemap_readahead(struct kiocb *iocb, struct file *file,
2455 struct address_space *mapping, struct page *page,
2456 pgoff_t last_index)
2457{
2458 if (iocb->ki_flags & IOCB_NOIO)
2459 return -EAGAIN;
2460 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2461 page->index, last_index - page->index);
2462 return 0;
2463}
2464
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002465static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002466 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002467{
2468 struct file *filp = iocb->ki_filp;
2469 struct address_space *mapping = filp->f_mapping;
2470 struct file_ra_state *ra = &filp->f_ra;
2471 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002472 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002473 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002474 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002475
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002476 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002477retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002478 if (fatal_signal_pending(current))
2479 return -EINTR;
2480
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002481 filemap_get_read_batch(mapping, index, last_index, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002482 if (!pagevec_count(pvec)) {
2483 if (iocb->ki_flags & IOCB_NOIO)
2484 return -EAGAIN;
2485 page_cache_sync_readahead(mapping, ra, filp, index,
2486 last_index - index);
2487 filemap_get_read_batch(mapping, index, last_index, pvec);
2488 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002489 if (!pagevec_count(pvec)) {
2490 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2491 return -EAGAIN;
2492 err = filemap_create_page(filp, mapping,
2493 iocb->ki_pos >> PAGE_SHIFT, pvec);
2494 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002495 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002496 return err;
2497 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002498
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002499 page = pvec->pages[pagevec_count(pvec) - 1];
2500 if (PageReadahead(page)) {
2501 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2502 if (err)
2503 goto err;
2504 }
2505 if (!PageUptodate(page)) {
2506 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2507 iocb->ki_flags |= IOCB_NOWAIT;
2508 err = filemap_update_page(iocb, mapping, iter, page);
2509 if (err)
2510 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002511 }
2512
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002513 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002514err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002515 if (err < 0)
2516 put_page(page);
2517 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002518 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002519 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002520 goto retry;
2521 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002522}
2523
Randy Dunlap485bb992006-06-23 02:03:49 -07002524/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002525 * filemap_read - Read data from the page cache.
2526 * @iocb: The iocb to read.
2527 * @iter: Destination for the data.
2528 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002529 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002530 * Copies data from the page cache. If the data is not currently present,
2531 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002533 * Return: Total number of bytes copied, including those already read by
2534 * the caller. If an error happens before any bytes are copied, returns
2535 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002537ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2538 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002540 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002541 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002542 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002544 struct pagevec pvec;
2545 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002546 bool writably_mapped;
2547 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548
Kent Overstreet723ef242020-12-14 19:04:52 -08002549 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002550 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002551 if (unlikely(!iov_iter_count(iter)))
2552 return 0;
2553
Wei Fangc2a97372016-10-07 17:01:52 -07002554 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002555 pagevec_init(&pvec);
Wei Fangc2a97372016-10-07 17:01:52 -07002556
Kent Overstreet06c04442020-12-14 19:04:56 -08002557 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 cond_resched();
Kent Overstreet06c04442020-12-14 19:04:56 -08002559
2560 /*
2561 * If we've already successfully copied some data, then we
2562 * can no longer safely return -EIOCBQUEUED. Hence mark
2563 * an async read NOWAIT at that point.
2564 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002565 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002566 iocb->ki_flags |= IOCB_NOWAIT;
2567
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002568 error = filemap_get_pages(iocb, iter, &pvec);
2569 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002570 break;
Michal Hocko5abf1862017-02-03 13:13:29 -08002571
Kent Overstreet723ef242020-12-14 19:04:52 -08002572 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002573 * i_size must be checked after we know the pages are Uptodate.
2574 *
2575 * Checking i_size after the check allows us to calculate
2576 * the correct value for "nr", which means the zero-filled
2577 * part of the page is not copied back to userspace (unless
2578 * another truncate extends the file - this is desired though).
Kent Overstreet723ef242020-12-14 19:04:52 -08002579 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002580 isize = i_size_read(inode);
2581 if (unlikely(iocb->ki_pos >= isize))
2582 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002583 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2584
Kent Overstreet06c04442020-12-14 19:04:56 -08002585 /*
2586 * Once we start copying data, we don't want to be touching any
2587 * cachelines that might be contended:
2588 */
2589 writably_mapped = mapping_writably_mapped(mapping);
2590
2591 /*
2592 * When a sequential read accesses a page several times, only
2593 * mark it as accessed the first time.
2594 */
2595 if (iocb->ki_pos >> PAGE_SHIFT !=
2596 ra->prev_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002597 mark_page_accessed(pvec.pages[0]);
Kent Overstreet06c04442020-12-14 19:04:56 -08002598
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002599 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002600 struct page *page = pvec.pages[i];
2601 size_t page_size = thp_size(page);
2602 size_t offset = iocb->ki_pos & (page_size - 1);
2603 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2604 page_size - offset);
2605 size_t copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002606
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002607 if (end_offset < page_offset(page))
2608 break;
2609 if (i > 0)
2610 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002611 /*
2612 * If users can be writing to this page using arbitrary
2613 * virtual addresses, take care about potential aliasing
2614 * before reading the page on the kernel side.
2615 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002616 if (writably_mapped) {
2617 int j;
Kent Overstreet06c04442020-12-14 19:04:56 -08002618
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002619 for (j = 0; j < thp_nr_pages(page); j++)
2620 flush_dcache_page(page + j);
2621 }
2622
2623 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002624
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002625 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002626 iocb->ki_pos += copied;
2627 ra->prev_pos = iocb->ki_pos;
2628
2629 if (copied < bytes) {
2630 error = -EFAULT;
2631 break;
Kent Overstreet723ef242020-12-14 19:04:52 -08002632 }
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002633 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002634put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002635 for (i = 0; i < pagevec_count(&pvec); i++)
2636 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002637 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002638 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002640 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002641
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002642 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002644EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645
Randy Dunlap485bb992006-06-23 02:03:49 -07002646/**
Al Viro6abd2322014-04-04 14:20:57 -04002647 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002648 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002649 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002650 *
Al Viro6abd2322014-04-04 14:20:57 -04002651 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002653 *
2654 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2655 * be returned when no data can be read without waiting for I/O requests
2656 * to complete; it doesn't prevent readahead.
2657 *
2658 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2659 * requests shall be made for the read or for readahead. When no data
2660 * can be read, -EAGAIN shall be returned. When readahead would be
2661 * triggered, a partial, possibly empty read shall be returned.
2662 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002663 * Return:
2664 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002665 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 */
2667ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002668generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002670 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002671 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002672
2673 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002674 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675
Al Viro2ba48ce2015-04-09 13:52:01 -04002676 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002677 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002678 struct address_space *mapping = file->f_mapping;
2679 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002680 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002683 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002684 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2685 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002686 return -EAGAIN;
2687 } else {
2688 retval = filemap_write_and_wait_range(mapping,
2689 iocb->ki_pos,
2690 iocb->ki_pos + count - 1);
2691 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002692 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002693 }
Al Viroed978a82014-03-05 22:53:04 -05002694
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002695 file_accessed(file);
2696
Al Viro5ecda132017-04-13 14:13:36 -04002697 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002698 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002699 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002700 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002701 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002702 if (retval != -EIOCBQUEUED)
2703 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002704
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002705 /*
2706 * Btrfs can have a short DIO read if we encounter
2707 * compressed extents, so if there was an error, or if
2708 * we've already read everything we wanted to, or if
2709 * there was a short read because we hit EOF, go ahead
2710 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002711 * the rest of the read. Buffered reads will not work for
2712 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002713 */
Al Viro5ecda132017-04-13 14:13:36 -04002714 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002715 IS_DAX(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002716 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 }
2718
Christoph Hellwig826ea862021-02-24 12:02:45 -08002719 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720}
Al Viroed978a82014-03-05 22:53:04 -05002721EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002723static inline loff_t page_seek_hole_data(struct xa_state *xas,
2724 struct address_space *mapping, struct page *page,
2725 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002726{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002727 const struct address_space_operations *ops = mapping->a_ops;
2728 size_t offset, bsz = i_blocksize(mapping->host);
2729
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002730 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002731 return seek_data ? start : end;
2732 if (!ops->is_partially_uptodate)
2733 return seek_data ? end : start;
2734
2735 xas_pause(xas);
2736 rcu_read_unlock();
2737 lock_page(page);
2738 if (unlikely(page->mapping != mapping))
2739 goto unlock;
2740
2741 offset = offset_in_thp(page, start) & ~(bsz - 1);
2742
2743 do {
2744 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2745 break;
2746 start = (start + bsz) & ~(bsz - 1);
2747 offset += bsz;
2748 } while (offset < thp_size(page));
2749unlock:
2750 unlock_page(page);
2751 rcu_read_lock();
2752 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002753}
2754
2755static inline
2756unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2757{
2758 if (xa_is_value(page))
2759 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2760 return thp_size(page);
2761}
2762
2763/**
2764 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2765 * @mapping: Address space to search.
2766 * @start: First byte to consider.
2767 * @end: Limit of search (exclusive).
2768 * @whence: Either SEEK_HOLE or SEEK_DATA.
2769 *
2770 * If the page cache knows which blocks contain holes and which blocks
2771 * contain data, your filesystem can use this function to implement
2772 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2773 * entirely memory-based such as tmpfs, and filesystems which support
2774 * unwritten extents.
2775 *
2776 * Return: The requested offset on successs, or -ENXIO if @whence specifies
2777 * SEEK_DATA and there is no data after @start. There is an implicit hole
2778 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2779 * and @end contain data.
2780 */
2781loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2782 loff_t end, int whence)
2783{
2784 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002785 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002786 bool seek_data = (whence == SEEK_DATA);
2787 struct page *page;
2788
2789 if (end <= start)
2790 return -ENXIO;
2791
2792 rcu_read_lock();
2793 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002794 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2795 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002796
2797 if (start < pos) {
2798 if (!seek_data)
2799 goto unlock;
2800 start = pos;
2801 }
2802
Hugh Dickinsed98b012021-04-23 14:29:00 -07002803 seek_size = seek_page_size(&xas, page);
2804 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002805 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2806 seek_data);
2807 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002808 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002809 if (start >= end)
2810 break;
2811 if (seek_size > PAGE_SIZE)
2812 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002813 if (!xa_is_value(page))
2814 put_page(page);
2815 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002816 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002817 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002818unlock:
2819 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002820 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002821 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002822 if (start > end)
2823 return end;
2824 return start;
2825}
2826
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002829/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002830 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002831 * @vmf - the vm_fault for this fault.
2832 * @page - the page to lock.
2833 * @fpin - the pointer to the file we may pin (or is already pinned).
2834 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002835 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002836 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002837 * 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 -07002838 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002839 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002840static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2841 struct file **fpin)
2842{
2843 if (trylock_page(page))
2844 return 1;
2845
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002846 /*
2847 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002848 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002849 * is supposed to work. We have way too many special cases..
2850 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002851 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2852 return 0;
2853
2854 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2855 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2856 if (__lock_page_killable(page)) {
2857 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002858 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002859 * but all fault_handlers only check for fatal signals
2860 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002861 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002862 */
2863 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002864 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002865 return 0;
2866 }
2867 } else
2868 __lock_page(page);
2869 return 1;
2870}
2871
2872
2873/*
2874 * Synchronous readahead happens when we don't even find a page in the page
2875 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2876 * to drop the mmap sem we return the file that was pinned in order for us to do
2877 * that. If we didn't pin a file then we return NULL. The file that is
2878 * returned needs to be fput()'ed when we're done with it.
2879 */
2880static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002881{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002882 struct file *file = vmf->vma->vm_file;
2883 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002884 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002885 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002886 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002887 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002888
2889 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002890 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002891 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002892 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002893 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002894
Josef Bacik2a1180f2019-03-13 11:44:18 -07002895 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002896 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002897 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002898 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002899 }
2900
Andi Kleen207d04b2011-05-24 17:12:29 -07002901 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002902 mmap_miss = READ_ONCE(ra->mmap_miss);
2903 if (mmap_miss < MMAP_LOTSAMISS * 10)
2904 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002905
2906 /*
2907 * Do we miss much more than hit in this file? If so,
2908 * stop bothering with read-ahead. It will only hurt.
2909 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002910 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002911 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002912
Wu Fengguangd30a1102009-06-16 15:31:30 -07002913 /*
2914 * mmap read-around
2915 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002916 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002917 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002918 ra->size = ra->ra_pages;
2919 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002920 ractl._index = ra->start;
2921 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002922 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002923}
2924
2925/*
2926 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002927 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002928 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002929 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002930static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2931 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002932{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002933 struct file *file = vmf->vma->vm_file;
2934 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002935 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002936 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002937 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002938 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002939
2940 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002941 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002942 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002943 mmap_miss = READ_ONCE(ra->mmap_miss);
2944 if (mmap_miss)
2945 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002946 if (PageReadahead(page)) {
2947 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002948 page_cache_async_readahead(mapping, ra, file,
2949 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002950 }
2951 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002952}
2953
Randy Dunlap485bb992006-06-23 02:03:49 -07002954/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002955 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002956 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002957 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002958 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959 * mapped memory region to read in file data during a page fault.
2960 *
2961 * The goto's are kind of ugly, but this streamlines the normal case of having
2962 * it in the page cache, and handles the special cases reasonably without
2963 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002964 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002965 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002966 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002967 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002968 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002969 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002970 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002971 * has not been released.
2972 *
2973 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002974 *
2975 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002977vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978{
2979 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002980 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002981 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 struct address_space *mapping = file->f_mapping;
2983 struct file_ra_state *ra = &file->f_ra;
2984 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002985 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002986 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002988 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002990 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2991 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002992 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002995 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002997 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002998 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002999 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003000 * We found the page, so try async readahead before
3001 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003002 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003003 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07003004 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07003005 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003006 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07003007 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003008 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003009 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003010retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07003011 page = pagecache_get_page(mapping, offset,
3012 FGP_CREAT|FGP_FOR_MMAP,
3013 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003014 if (!page) {
3015 if (fpin)
3016 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07003017 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003018 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003019 }
3020
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003021 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3022 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003023
3024 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003025 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003026 unlock_page(page);
3027 put_page(page);
3028 goto retry_find;
3029 }
Song Liu520e5ba2019-09-23 15:37:50 -07003030 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003031
Linus Torvalds1da177e2005-04-16 15:20:36 -07003032 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003033 * We have a locked page in the page cache, now we need to check
3034 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035 */
Nick Piggind00806b2007-07-19 01:46:57 -07003036 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003037 goto page_not_uptodate;
3038
Linus Torvaldsef00e082009-06-16 15:31:25 -07003039 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003040 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003041 * time to return to the upper layer and have it re-find the vma and
3042 * redo the fault.
3043 */
3044 if (fpin) {
3045 unlock_page(page);
3046 goto out_retry;
3047 }
3048
3049 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003050 * Found the page and have a reference on it.
3051 * We must recheck i_size under page lock.
3052 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003053 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3054 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003055 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003056 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003057 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003058 }
3059
Nick Piggind0217ac2007-07-19 01:47:03 -07003060 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003061 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 /*
3065 * Umm, take care of errors if the page isn't up-to-date.
3066 * Try to re-read it _once_. We do this synchronously,
3067 * because there really aren't any performance issues here
3068 * and we need to check for errors.
3069 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003071 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08003072 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07003073 if (!error) {
3074 wait_on_page_locked(page);
3075 if (!PageUptodate(page))
3076 error = -EIO;
3077 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003078 if (fpin)
3079 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003080 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003081
3082 if (!error || error == AOP_TRUNCATED_PAGE)
3083 goto retry_find;
3084
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07003085 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07003086 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003087
3088out_retry:
3089 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003090 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003091 * re-find the vma and come back and find our hopefully still populated
3092 * page.
3093 */
3094 if (page)
3095 put_page(page);
3096 if (fpin)
3097 fput(fpin);
3098 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003099}
3100EXPORT_SYMBOL(filemap_fault);
3101
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003102static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003103{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003104 struct mm_struct *mm = vmf->vma->vm_mm;
3105
3106 /* Huge page is mapped? No need to proceed. */
3107 if (pmd_trans_huge(*vmf->pmd)) {
3108 unlock_page(page);
3109 put_page(page);
3110 return true;
3111 }
3112
3113 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
3114 vm_fault_t ret = do_set_pmd(vmf, page);
3115 if (!ret) {
3116 /* The page is mapped successfully, reference consumed. */
3117 unlock_page(page);
3118 return true;
3119 }
3120 }
3121
3122 if (pmd_none(*vmf->pmd)) {
3123 vmf->ptl = pmd_lock(mm, vmf->pmd);
3124 if (likely(pmd_none(*vmf->pmd))) {
3125 mm_inc_nr_ptes(mm);
3126 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
3127 vmf->prealloc_pte = NULL;
3128 }
3129 spin_unlock(vmf->ptl);
3130 }
3131
3132 /* See comment in handle_pte_fault() */
3133 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3134 unlock_page(page);
3135 put_page(page);
3136 return true;
3137 }
3138
3139 return false;
3140}
3141
3142static struct page *next_uptodate_page(struct page *page,
3143 struct address_space *mapping,
3144 struct xa_state *xas, pgoff_t end_pgoff)
3145{
3146 unsigned long max_idx;
3147
3148 do {
3149 if (!page)
3150 return NULL;
3151 if (xas_retry(xas, page))
3152 continue;
3153 if (xa_is_value(page))
3154 continue;
3155 if (PageLocked(page))
3156 continue;
3157 if (!page_cache_get_speculative(page))
3158 continue;
3159 /* Has the page moved or been split? */
3160 if (unlikely(page != xas_reload(xas)))
3161 goto skip;
3162 if (!PageUptodate(page) || PageReadahead(page))
3163 goto skip;
3164 if (PageHWPoison(page))
3165 goto skip;
3166 if (!trylock_page(page))
3167 goto skip;
3168 if (page->mapping != mapping)
3169 goto unlock;
3170 if (!PageUptodate(page))
3171 goto unlock;
3172 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3173 if (xas->xa_index >= max_idx)
3174 goto unlock;
3175 return page;
3176unlock:
3177 unlock_page(page);
3178skip:
3179 put_page(page);
3180 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3181
3182 return NULL;
3183}
3184
3185static inline struct page *first_map_page(struct address_space *mapping,
3186 struct xa_state *xas,
3187 pgoff_t end_pgoff)
3188{
3189 return next_uptodate_page(xas_find(xas, end_pgoff),
3190 mapping, xas, end_pgoff);
3191}
3192
3193static inline struct page *next_map_page(struct address_space *mapping,
3194 struct xa_state *xas,
3195 pgoff_t end_pgoff)
3196{
3197 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3198 mapping, xas, end_pgoff);
3199}
3200
3201vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3202 pgoff_t start_pgoff, pgoff_t end_pgoff)
3203{
3204 struct vm_area_struct *vma = vmf->vma;
3205 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003206 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07003207 pgoff_t last_pgoff = start_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003208 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003209 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003210 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003211 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003212 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003213
3214 rcu_read_lock();
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003215 head = first_map_page(mapping, &xas, end_pgoff);
3216 if (!head)
3217 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003218
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003219 if (filemap_map_pmd(vmf, head)) {
3220 ret = VM_FAULT_NOPAGE;
3221 goto out;
3222 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003223
Will Deacon9d3af4b2021-01-14 15:24:19 +00003224 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3225 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003226 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003227 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003228 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003229 goto unlock;
3230
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003231 if (mmap_miss > 0)
3232 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003233
Will Deacon9d3af4b2021-01-14 15:24:19 +00003234 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003235 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003236 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003237
3238 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003239 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003240
Will Deacon46bdb422020-11-24 18:48:26 +00003241 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003242 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003243 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003244
Will Deacon9d3af4b2021-01-14 15:24:19 +00003245 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003246 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003247 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003248 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003249 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003250unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003251 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003252 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003253 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3254 pte_unmap_unlock(vmf->pte, vmf->ptl);
3255out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003256 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003257 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003258 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003259}
3260EXPORT_SYMBOL(filemap_map_pages);
3261
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003262vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003263{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003264 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003265 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003266 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003267
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003268 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003269 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003270 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003271 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003272 unlock_page(page);
3273 ret = VM_FAULT_NOPAGE;
3274 goto out;
3275 }
Jan Kara14da9202012-06-12 16:20:37 +02003276 /*
3277 * We mark the page dirty already here so that when freeze is in
3278 * progress, we are guaranteed that writeback during freezing will
3279 * see the dirty page and writeprotect it again.
3280 */
3281 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003282 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003283out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003284 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003285 return ret;
3286}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003287
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003288const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003289 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003290 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003291 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003292};
3293
3294/* This is used for a general mmap of a disk file */
3295
3296int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3297{
3298 struct address_space *mapping = file->f_mapping;
3299
3300 if (!mapping->a_ops->readpage)
3301 return -ENOEXEC;
3302 file_accessed(file);
3303 vma->vm_ops = &generic_file_vm_ops;
3304 return 0;
3305}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306
3307/*
3308 * This is for filesystems which do not implement ->writepage.
3309 */
3310int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3311{
3312 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3313 return -EINVAL;
3314 return generic_file_mmap(file, vma);
3315}
3316#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003317vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003318{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003319 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003320}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003321int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3322{
3323 return -ENOSYS;
3324}
3325int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
3326{
3327 return -ENOSYS;
3328}
3329#endif /* CONFIG_MMU */
3330
Arnd Bergmann453972282018-04-13 15:35:27 -07003331EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003332EXPORT_SYMBOL(generic_file_mmap);
3333EXPORT_SYMBOL(generic_file_readonly_mmap);
3334
Sasha Levin67f9fd92014-04-03 14:48:18 -07003335static struct page *wait_on_page_read(struct page *page)
3336{
3337 if (!IS_ERR(page)) {
3338 wait_on_page_locked(page);
3339 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003340 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003341 page = ERR_PTR(-EIO);
3342 }
3343 }
3344 return page;
3345}
3346
Mel Gorman32b63522016-03-15 14:55:36 -07003347static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003348 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003349 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003350 void *data,
3351 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003352{
Nick Piggineb2be182007-10-16 01:24:57 -07003353 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003354 int err;
3355repeat:
3356 page = find_get_page(mapping, index);
3357 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003358 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003359 if (!page)
3360 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003361 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003362 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003363 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003364 if (err == -EEXIST)
3365 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003366 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003367 return ERR_PTR(err);
3368 }
Mel Gorman32b63522016-03-15 14:55:36 -07003369
3370filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003371 if (filler)
3372 err = filler(data, page);
3373 else
3374 err = mapping->a_ops->readpage(data, page);
3375
Linus Torvalds1da177e2005-04-16 15:20:36 -07003376 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003377 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003378 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003379 }
Mel Gorman32b63522016-03-15 14:55:36 -07003380
3381 page = wait_on_page_read(page);
3382 if (IS_ERR(page))
3383 return page;
3384 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003385 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003386 if (PageUptodate(page))
3387 goto out;
3388
Mel Gormanebded022016-03-15 14:55:39 -07003389 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003390 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003391 * case a: Page is being filled and the page lock is held
3392 * case b: Read/write error clearing the page uptodate status
3393 * case c: Truncation in progress (page locked)
3394 * case d: Reclaim in progress
3395 *
3396 * Case a, the page will be up to date when the page is unlocked.
3397 * There is no need to serialise on the page lock here as the page
3398 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003399 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003400 * it's a race vs truncate race.
3401 * Case b, the page will not be up to date
3402 * Case c, the page may be truncated but in itself, the data may still
3403 * be valid after IO completes as it's a read vs truncate race. The
3404 * operation must restart if the page is not uptodate on unlock but
3405 * otherwise serialising on page lock to stabilise the mapping gives
3406 * no additional guarantees to the caller as the page lock is
3407 * released before return.
3408 * Case d, similar to truncation. If reclaim holds the page lock, it
3409 * will be a race with remove_mapping that determines if the mapping
3410 * is valid on unlock but otherwise the data is valid and there is
3411 * no need to serialise with page lock.
3412 *
3413 * As the page lock gives no additional guarantee, we optimistically
3414 * wait on the page to be unlocked and check if it's up to date and
3415 * use the page if it is. Otherwise, the page lock is required to
3416 * distinguish between the different cases. The motivation is that we
3417 * avoid spurious serialisations and wakeups when multiple processes
3418 * wait on the same page for IO to complete.
3419 */
3420 wait_on_page_locked(page);
3421 if (PageUptodate(page))
3422 goto out;
3423
3424 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003426
3427 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428 if (!page->mapping) {
3429 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003430 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003431 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003432 }
Mel Gormanebded022016-03-15 14:55:39 -07003433
3434 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003435 if (PageUptodate(page)) {
3436 unlock_page(page);
3437 goto out;
3438 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003439
3440 /*
3441 * A previous I/O error may have been due to temporary
3442 * failures.
3443 * Clear page error before actual read, PG_error will be
3444 * set again if read page fails.
3445 */
3446 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003447 goto filler;
3448
David Howellsc855ff32007-05-09 13:42:20 +01003449out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003450 mark_page_accessed(page);
3451 return page;
3452}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003453
3454/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003455 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003456 * @mapping: the page's address_space
3457 * @index: the page index
3458 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003459 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003460 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003461 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003462 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003463 *
3464 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003465 *
3466 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003467 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003468struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003469 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003470 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003471 void *data)
3472{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003473 return do_read_cache_page(mapping, index, filler, data,
3474 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003475}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003476EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003477
3478/**
3479 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3480 * @mapping: the page's address_space
3481 * @index: the page index
3482 * @gfp: the page allocator flags to use if allocating
3483 *
3484 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003485 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003486 *
3487 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003488 *
3489 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003490 */
3491struct page *read_cache_page_gfp(struct address_space *mapping,
3492 pgoff_t index,
3493 gfp_t gfp)
3494{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003495 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003496}
3497EXPORT_SYMBOL(read_cache_page_gfp);
3498
Nick Pigginafddba42007-10-16 01:25:01 -07003499int pagecache_write_begin(struct file *file, struct address_space *mapping,
3500 loff_t pos, unsigned len, unsigned flags,
3501 struct page **pagep, void **fsdata)
3502{
3503 const struct address_space_operations *aops = mapping->a_ops;
3504
Nick Piggin4e02ed42008-10-29 14:00:55 -07003505 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003506 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003507}
3508EXPORT_SYMBOL(pagecache_write_begin);
3509
3510int pagecache_write_end(struct file *file, struct address_space *mapping,
3511 loff_t pos, unsigned len, unsigned copied,
3512 struct page *page, void *fsdata)
3513{
3514 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003515
Nick Piggin4e02ed42008-10-29 14:00:55 -07003516 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003517}
3518EXPORT_SYMBOL(pagecache_write_end);
3519
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003520/*
3521 * Warn about a page cache invalidation failure during a direct I/O write.
3522 */
3523void dio_warn_stale_pagecache(struct file *filp)
3524{
3525 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3526 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003527 char *path;
3528
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003529 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003530 if (__ratelimit(&_rs)) {
3531 path = file_path(filp, pathname, sizeof(pathname));
3532 if (IS_ERR(path))
3533 path = "(unknown)";
3534 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3535 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3536 current->comm);
3537 }
3538}
3539
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003541generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542{
3543 struct file *file = iocb->ki_filp;
3544 struct address_space *mapping = file->f_mapping;
3545 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003546 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003548 size_t write_len;
3549 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550
Al Viro0c949332014-03-22 06:51:37 -04003551 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003552 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003553
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003554 if (iocb->ki_flags & IOCB_NOWAIT) {
3555 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003556 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003557 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003558 return -EAGAIN;
3559 } else {
3560 written = filemap_write_and_wait_range(mapping, pos,
3561 pos + write_len - 1);
3562 if (written)
3563 goto out;
3564 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003565
3566 /*
3567 * After a write we want buffered reads to be sure to go to disk to get
3568 * the new data. We invalidate clean cached page from the region we're
3569 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003570 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003571 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003572 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003573 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003574 /*
3575 * If a page can not be invalidated, return 0 to fall back
3576 * to buffered write.
3577 */
3578 if (written) {
3579 if (written == -EBUSY)
3580 return 0;
3581 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003582 }
3583
Al Viro639a93a52017-04-13 14:10:15 -04003584 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003585
3586 /*
3587 * Finally, try again to invalidate clean pages which might have been
3588 * cached by non-direct readahead, or faulted in by get_user_pages()
3589 * if the source of the write was an mmap'ed region of the file
3590 * we're writing. Either one is a pretty crazy thing to do,
3591 * so we don't support it 100%. If this invalidation
3592 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003593 *
3594 * Most of the time we do not need this since dio_complete() will do
3595 * the invalidation for us. However there are some file systems that
3596 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003597 * them by removing it completely.
3598 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003599 * Noticeable example is a blkdev_direct_IO().
3600 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003601 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003602 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003603 if (written > 0 && mapping->nrpages &&
3604 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3605 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003606
Linus Torvalds1da177e2005-04-16 15:20:36 -07003607 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003608 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003609 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003610 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3611 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612 mark_inode_dirty(inode);
3613 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003614 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003615 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003616 if (written != -EIOCBQUEUED)
3617 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003618out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003619 return written;
3620}
3621EXPORT_SYMBOL(generic_file_direct_write);
3622
Nick Piggineb2be182007-10-16 01:24:57 -07003623/*
3624 * Find or create a page at the given pagecache position. Return the locked
3625 * page. This function is specifically for buffered writes.
3626 */
Nick Piggin54566b22009-01-04 12:00:53 -08003627struct page *grab_cache_page_write_begin(struct address_space *mapping,
3628 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003629{
Nick Piggineb2be182007-10-16 01:24:57 -07003630 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003631 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003632
Nick Piggin54566b22009-01-04 12:00:53 -08003633 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003634 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003635
Mel Gorman2457aec2014-06-04 16:10:31 -07003636 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003637 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003638 if (page)
3639 wait_for_stable_page(page);
3640
Nick Piggineb2be182007-10-16 01:24:57 -07003641 return page;
3642}
Nick Piggin54566b22009-01-04 12:00:53 -08003643EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003644
Al Viro3b93f912014-02-11 21:34:08 -05003645ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003646 struct iov_iter *i, loff_t pos)
3647{
3648 struct address_space *mapping = file->f_mapping;
3649 const struct address_space_operations *a_ops = mapping->a_ops;
3650 long status = 0;
3651 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003652 unsigned int flags = 0;
3653
Nick Pigginafddba42007-10-16 01:25:01 -07003654 do {
3655 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003656 unsigned long offset; /* Offset into pagecache page */
3657 unsigned long bytes; /* Bytes to write to page */
3658 size_t copied; /* Bytes copied from user */
3659 void *fsdata;
3660
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003661 offset = (pos & (PAGE_SIZE - 1));
3662 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003663 iov_iter_count(i));
3664
3665again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003666 /*
3667 * Bring in the user page that we will copy from _first_.
3668 * Otherwise there's a nasty deadlock on copying from the
3669 * same page as we're writing to, without it being marked
3670 * up-to-date.
3671 *
3672 * Not only is this an optimisation, but it is also required
3673 * to check that the address is actually valid, when atomic
3674 * usercopies are used, below.
3675 */
3676 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3677 status = -EFAULT;
3678 break;
3679 }
3680
Jan Kara296291c2015-10-22 13:32:21 -07003681 if (fatal_signal_pending(current)) {
3682 status = -EINTR;
3683 break;
3684 }
3685
Nick Piggin674b8922007-10-16 01:25:03 -07003686 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003687 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003688 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003689 break;
3690
anfei zhou931e80e2010-02-02 13:44:02 -08003691 if (mapping_writably_mapped(mapping))
3692 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003693
Nick Pigginafddba42007-10-16 01:25:01 -07003694 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003695 flush_dcache_page(page);
3696
3697 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3698 page, fsdata);
3699 if (unlikely(status < 0))
3700 break;
3701 copied = status;
3702
3703 cond_resched();
3704
Nick Piggin124d3b72008-02-02 15:01:17 +01003705 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003706 if (unlikely(copied == 0)) {
3707 /*
3708 * If we were unable to copy any data at all, we must
3709 * fall back to a single segment length write.
3710 *
3711 * If we didn't fallback here, we could livelock
3712 * because not all segments in the iov can be copied at
3713 * once without a pagefault.
3714 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003715 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003716 iov_iter_single_seg_count(i));
3717 goto again;
3718 }
Nick Pigginafddba42007-10-16 01:25:01 -07003719 pos += copied;
3720 written += copied;
3721
3722 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003723 } while (iov_iter_count(i));
3724
3725 return written ? written : status;
3726}
Al Viro3b93f912014-02-11 21:34:08 -05003727EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003728
Jan Karae4dd9de2009-08-17 18:10:06 +02003729/**
Al Viro81742022014-04-03 03:17:43 -04003730 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003731 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003732 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003733 *
3734 * This function does all the work needed for actually writing data to a
3735 * file. It does all basic checks, removes SUID from the file, updates
3736 * modification times and calls proper subroutines depending on whether we
3737 * do direct IO or a standard buffered write.
3738 *
3739 * It expects i_mutex to be grabbed unless we work on a block device or similar
3740 * object which does not need locking at all.
3741 *
3742 * This function does *not* take care of syncing data in case of O_SYNC write.
3743 * A caller has to handle it. This is mainly due to the fact that we want to
3744 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003745 *
3746 * Return:
3747 * * number of bytes written, even for truncated writes
3748 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003749 */
Al Viro81742022014-04-03 03:17:43 -04003750ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003751{
3752 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003753 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003754 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003755 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003756 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003757 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003758
Linus Torvalds1da177e2005-04-16 15:20:36 -07003759 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003760 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003761 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003762 if (err)
3763 goto out;
3764
Josef Bacikc3b2da32012-03-26 09:59:21 -04003765 err = file_update_time(file);
3766 if (err)
3767 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003768
Al Viro2ba48ce2015-04-09 13:52:01 -04003769 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003770 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003771
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003772 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003773 /*
3774 * If the write stopped short of completing, fall back to
3775 * buffered writes. Some filesystems do this for writes to
3776 * holes, for example. For DAX files, a buffered write will
3777 * not succeed (even if it did, DAX does not handle dirty
3778 * page-cache pages correctly).
3779 */
Al Viro0b8def92015-04-07 10:22:53 -04003780 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003781 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003782
Al Viro0b8def92015-04-07 10:22:53 -04003783 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003784 /*
Al Viro3b93f912014-02-11 21:34:08 -05003785 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003786 * then we want to return the number of bytes which were
3787 * direct-written, or the error code if that was zero. Note
3788 * that this differs from normal direct-io semantics, which
3789 * will return -EFOO even if some bytes were written.
3790 */
Al Viro60bb4522014-08-08 12:39:16 -04003791 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003792 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003793 goto out;
3794 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003795 /*
3796 * We need to ensure that the page cache pages are written to
3797 * disk and invalidated to preserve the expected O_DIRECT
3798 * semantics.
3799 */
Al Viro3b93f912014-02-11 21:34:08 -05003800 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003801 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003802 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003803 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003804 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003805 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003806 pos >> PAGE_SHIFT,
3807 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003808 } else {
3809 /*
3810 * We don't know how much we wrote, so just return
3811 * the number of bytes which were direct-written
3812 */
3813 }
3814 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003815 written = generic_perform_write(file, from, iocb->ki_pos);
3816 if (likely(written > 0))
3817 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003818 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003819out:
3820 current->backing_dev_info = NULL;
3821 return written ? written : err;
3822}
Al Viro81742022014-04-03 03:17:43 -04003823EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003824
Jan Karae4dd9de2009-08-17 18:10:06 +02003825/**
Al Viro81742022014-04-03 03:17:43 -04003826 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003827 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003828 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003829 *
Al Viro81742022014-04-03 03:17:43 -04003830 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003831 * filesystems. It takes care of syncing the file in case of O_SYNC file
3832 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003833 * Return:
3834 * * negative error code if no data has been written at all of
3835 * vfs_fsync_range() failed for a synchronous write
3836 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003837 */
Al Viro81742022014-04-03 03:17:43 -04003838ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003839{
3840 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003841 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003842 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003843
Al Viro59551022016-01-22 15:40:57 -05003844 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003845 ret = generic_write_checks(iocb, from);
3846 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003847 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003848 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003849
Christoph Hellwige2592212016-04-07 08:52:01 -07003850 if (ret > 0)
3851 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003852 return ret;
3853}
Al Viro81742022014-04-03 03:17:43 -04003854EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003855
David Howellscf9a2ae2006-08-29 19:05:54 +01003856/**
3857 * try_to_release_page() - release old fs-specific metadata on a page
3858 *
3859 * @page: the page which the kernel is trying to free
3860 * @gfp_mask: memory allocation flags (and I/O mode)
3861 *
3862 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003863 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003864 *
David Howells266cf652009-04-03 16:42:36 +01003865 * This may also be called if PG_fscache is set on a page, indicating that the
3866 * page is known to the local caching routines.
3867 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003868 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003869 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003870 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003871 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003872 */
3873int try_to_release_page(struct page *page, gfp_t gfp_mask)
3874{
3875 struct address_space * const mapping = page->mapping;
3876
3877 BUG_ON(!PageLocked(page));
3878 if (PageWriteback(page))
3879 return 0;
3880
3881 if (mapping && mapping->a_ops->releasepage)
3882 return mapping->a_ops->releasepage(page, gfp_mask);
3883 return try_to_free_buffers(page);
3884}
3885
3886EXPORT_SYMBOL(try_to_release_page);