blob: cf9de790f49391264d35aa90a1db9e67f885bddc [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 */
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200145 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700146}
147
Jan Kara5ecc4d82017-11-15 17:37:29 -0800148static void unaccount_page_cache_page(struct address_space *mapping,
149 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800151 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600153 /*
154 * if we're uptodate, flush out into the cleancache, otherwise
155 * invalidate any existing cleancache entries. We can't leave
156 * stale data around in the cleancache once our page is gone
157 */
158 if (PageUptodate(page) && PageMappedToDisk(page))
159 cleancache_put_page(page);
160 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400161 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600162
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700163 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800164 VM_BUG_ON_PAGE(page_mapped(page), page);
165 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
166 int mapcount;
167
168 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
169 current->comm, page_to_pfn(page));
170 dump_page(page, "still mapped when deleted");
171 dump_stack();
172 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
173
174 mapcount = page_mapcount(page);
175 if (mapping_exiting(mapping) &&
176 page_count(page) >= mapcount + 2) {
177 /*
178 * All vmas have already been torn down, so it's
179 * a good bet that actually the page is unmapped,
180 * and we'd prefer not to leak it: if we're wrong,
181 * some other bad page check should catch it later.
182 */
183 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700184 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800185 }
186 }
187
Jan Kara76253fb2017-11-15 17:37:22 -0800188 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800189 if (PageHuge(page))
190 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800191
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700192 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800193
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700194 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800195 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700196 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800197 if (PageTransHuge(page))
Muchun Song57b28472021-02-24 12:03:31 -0800198 __mod_lruvec_page_state(page, NR_SHMEM_THPS, -nr);
Song Liu99cb0db2019-09-23 15:38:00 -0700199 } else if (PageTransHuge(page)) {
Muchun Songbf9ecea2021-02-24 12:03:27 -0800200 __mod_lruvec_page_state(page, NR_FILE_THPS, -nr);
Song Liu09d91cd2019-09-23 15:38:03 -0700201 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800202 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800203
204 /*
205 * At this point page must be either written or cleaned by
206 * truncate. Dirty page here signals a bug and loss of
207 * unwritten data.
208 *
209 * This fixes dirty accounting after removing the page entirely
210 * but leaves PageDirty set: it has no effect for truncated
211 * page and anyway will be cleared before returning page into
212 * buddy allocator.
213 */
214 if (WARN_ON_ONCE(PageDirty(page)))
215 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
216}
217
218/*
219 * Delete a page from the page cache and free it. Caller has to make
220 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700221 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800222 */
223void __delete_from_page_cache(struct page *page, void *shadow)
224{
225 struct address_space *mapping = page->mapping;
226
227 trace_mm_filemap_delete_from_page_cache(page);
228
229 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500230 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231}
232
Jan Kara59c66c52017-11-15 17:37:18 -0800233static void page_cache_free_page(struct address_space *mapping,
234 struct page *page)
235{
236 void (*freepage)(struct page *);
237
238 freepage = mapping->a_ops->freepage;
239 if (freepage)
240 freepage(page);
241
242 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700243 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800244 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
245 } else {
246 put_page(page);
247 }
248}
249
Minchan Kim702cfbf2011-03-22 16:32:43 -0700250/**
251 * delete_from_page_cache - delete page from page cache
252 * @page: the page which the kernel is trying to remove from page cache
253 *
254 * This must be called only on pages that have been verified to be in the page
255 * cache and locked. It will never put the page into the free list, the caller
256 * has a reference on the page.
257 */
258void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700260 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400261 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Matt Mackallcd7619d2005-05-01 08:59:01 -0700263 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700264 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700265 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700266 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500267
Jan Kara59c66c52017-11-15 17:37:18 -0800268 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700269}
270EXPORT_SYMBOL(delete_from_page_cache);
271
Jan Karaaa65c292017-11-15 17:37:33 -0800272/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500273 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800274 * @mapping: the mapping to which pages belong
275 * @pvec: pagevec with pages to delete
276 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700277 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700278 * from the mapping. The function expects @pvec to be sorted by page index
279 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700280 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800281 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700282 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800283 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700284 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800285 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500286static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800287 struct pagevec *pvec)
288{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500289 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800290 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700291 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800292 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800293
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500294 mapping_set_update(&xas, mapping);
295 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700296 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800297 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700298
299 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400300 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800301 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700302 /*
303 * A page got inserted in our range? Skip it. We have our
304 * pages locked so they are protected from being removed.
305 * If we see a page whose index is higher than ours, it
306 * means our page has been removed, which shouldn't be
307 * possible because we're holding the PageLock.
308 */
309 if (page != pvec->pages[i]) {
310 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
311 page);
312 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700313 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700314
315 WARN_ON_ONCE(!PageLocked(page));
316
317 if (page->index == xas.xa_index)
318 page->mapping = NULL;
319 /* Leave page->index set: truncation lookup relies on it */
320
321 /*
322 * Move to the next page in the vector if this is a regular
323 * page or the index is of the last sub-page of this compound
324 * page.
325 */
326 if (page->index + compound_nr(page) - 1 == xas.xa_index)
327 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500328 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800329 total_pages++;
330 }
331 mapping->nrpages -= total_pages;
332}
333
334void delete_from_page_cache_batch(struct address_space *mapping,
335 struct pagevec *pvec)
336{
337 int i;
338 unsigned long flags;
339
340 if (!pagevec_count(pvec))
341 return;
342
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700343 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800344 for (i = 0; i < pagevec_count(pvec); i++) {
345 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
346
347 unaccount_page_cache_page(mapping, pvec->pages[i]);
348 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500349 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700350 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800351
352 for (i = 0; i < pagevec_count(pvec); i++)
353 page_cache_free_page(mapping, pvec->pages[i]);
354}
355
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200356int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700357{
358 int ret = 0;
359 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700360 if (test_bit(AS_ENOSPC, &mapping->flags) &&
361 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700362 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700363 if (test_bit(AS_EIO, &mapping->flags) &&
364 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700365 ret = -EIO;
366 return ret;
367}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200368EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700369
Jeff Layton76341ca2017-07-06 07:02:22 -0400370static int filemap_check_and_keep_errors(struct address_space *mapping)
371{
372 /* Check for outstanding write errors */
373 if (test_bit(AS_EIO, &mapping->flags))
374 return -EIO;
375 if (test_bit(AS_ENOSPC, &mapping->flags))
376 return -ENOSPC;
377 return 0;
378}
379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700381 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700382 * @mapping: address space structure to write
383 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800384 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700385 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700387 * Start writeback against all of a mapping's dirty pages that lie
388 * within the byte offsets <start, end> inclusive.
389 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700391 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 * these two operations is that if a dirty page/buffer is encountered, it must
393 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800394 *
395 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800397int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
398 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
400 int ret;
401 struct writeback_control wbc = {
402 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800403 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700404 .range_start = start,
405 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 };
407
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200408 if (!mapping_can_writeback(mapping) ||
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700409 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 return 0;
411
Tejun Heob16b1de2015-06-02 08:39:48 -0600412 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600414 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 return ret;
416}
417
418static inline int __filemap_fdatawrite(struct address_space *mapping,
419 int sync_mode)
420{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700421 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422}
423
424int filemap_fdatawrite(struct address_space *mapping)
425{
426 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
427}
428EXPORT_SYMBOL(filemap_fdatawrite);
429
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400430int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800431 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
433 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
434}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400435EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Randy Dunlap485bb992006-06-23 02:03:49 -0700437/**
438 * filemap_flush - mostly a non-blocking flush
439 * @mapping: target address_space
440 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 * This is a mostly non-blocking flush. Not suitable for data-integrity
442 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800443 *
444 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 */
446int filemap_flush(struct address_space *mapping)
447{
448 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
449}
450EXPORT_SYMBOL(filemap_flush);
451
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500452/**
453 * filemap_range_has_page - check if a page exists in range.
454 * @mapping: address space within which to check
455 * @start_byte: offset in bytes where the range starts
456 * @end_byte: offset in bytes where the range ends (inclusive)
457 *
458 * Find at least one page in the range supplied, usually used to check if
459 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800460 *
461 * Return: %true if at least one page exists in the specified range,
462 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500463 */
464bool filemap_range_has_page(struct address_space *mapping,
465 loff_t start_byte, loff_t end_byte)
466{
Jan Karaf7b68042017-09-06 16:21:40 -0700467 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500468 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
469 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500470
471 if (end_byte < start_byte)
472 return false;
473
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500474 rcu_read_lock();
475 for (;;) {
476 page = xas_find(&xas, max);
477 if (xas_retry(&xas, page))
478 continue;
479 /* Shadow entries don't count */
480 if (xa_is_value(page))
481 continue;
482 /*
483 * We don't need to try to pin this page; we're about to
484 * release the RCU lock anyway. It is enough to know that
485 * there was a page here recently.
486 */
487 break;
488 }
489 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500490
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500491 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500492}
493EXPORT_SYMBOL(filemap_range_has_page);
494
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400495static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800496 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300498 pgoff_t index = start_byte >> PAGE_SHIFT;
499 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 struct pagevec pvec;
501 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200503 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400504 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
Mel Gorman86679822017-11-15 17:37:52 -0800506 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800507 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 unsigned i;
509
Jan Kara312e9d22017-11-15 17:35:05 -0800510 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800511 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800512 if (!nr_pages)
513 break;
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 for (i = 0; i < nr_pages; i++) {
516 struct page *page = pvec.pages[i];
517
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400519 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 }
521 pagevec_release(&pvec);
522 cond_resched();
523 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800524}
525
526/**
527 * filemap_fdatawait_range - wait for writeback to complete
528 * @mapping: address space structure to wait for
529 * @start_byte: offset in bytes where the range starts
530 * @end_byte: offset in bytes where the range ends (inclusive)
531 *
532 * Walk the list of under-writeback pages of the given address space
533 * in the given range and wait for all of them. Check error status of
534 * the address space and return it.
535 *
536 * Since the error status of the address space is cleared by this function,
537 * callers are responsible for checking the return value and handling and/or
538 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800539 *
540 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800541 */
542int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
543 loff_t end_byte)
544{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400545 __filemap_fdatawait_range(mapping, start_byte, end_byte);
546 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200548EXPORT_SYMBOL(filemap_fdatawait_range);
549
550/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400551 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
552 * @mapping: address space structure to wait for
553 * @start_byte: offset in bytes where the range starts
554 * @end_byte: offset in bytes where the range ends (inclusive)
555 *
556 * Walk the list of under-writeback pages of the given address space in the
557 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
558 * this function does not clear error status of the address space.
559 *
560 * Use this function if callers don't handle errors themselves. Expected
561 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
562 * fsfreeze(8)
563 */
564int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
565 loff_t start_byte, loff_t end_byte)
566{
567 __filemap_fdatawait_range(mapping, start_byte, end_byte);
568 return filemap_check_and_keep_errors(mapping);
569}
570EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
571
572/**
Jeff Laytona823e452017-07-28 07:24:43 -0400573 * file_fdatawait_range - wait for writeback to complete
574 * @file: file pointing to address space structure to wait for
575 * @start_byte: offset in bytes where the range starts
576 * @end_byte: offset in bytes where the range ends (inclusive)
577 *
578 * Walk the list of under-writeback pages of the address space that file
579 * refers to, in the given range and wait for all of them. Check error
580 * status of the address space vs. the file->f_wb_err cursor and return it.
581 *
582 * Since the error status of the file is advanced by this function,
583 * callers are responsible for checking the return value and handling and/or
584 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800585 *
586 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400587 */
588int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
589{
590 struct address_space *mapping = file->f_mapping;
591
592 __filemap_fdatawait_range(mapping, start_byte, end_byte);
593 return file_check_and_advance_wb_err(file);
594}
595EXPORT_SYMBOL(file_fdatawait_range);
596
597/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800598 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
599 * @mapping: address space structure to wait for
600 *
601 * Walk the list of under-writeback pages of the given address space
602 * and wait for all of them. Unlike filemap_fdatawait(), this function
603 * does not clear error status of the address space.
604 *
605 * Use this function if callers don't handle errors themselves. Expected
606 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
607 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800608 *
609 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800610 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400611int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800612{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400613 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400614 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800615}
Jeff Layton76341ca2017-07-06 07:02:22 -0400616EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800617
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700618/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400619static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700621 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623
Randy Dunlap485bb992006-06-23 02:03:49 -0700624/**
Jens Axboe63135aa2021-04-29 22:55:18 -0700625 * filemap_range_needs_writeback - check if range potentially needs writeback
626 * @mapping: address space within which to check
627 * @start_byte: offset in bytes where the range starts
628 * @end_byte: offset in bytes where the range ends (inclusive)
629 *
630 * Find at least one page in the range supplied, usually used to check if
631 * direct writing in this range will trigger a writeback. Used by O_DIRECT
632 * read/write with IOCB_NOWAIT, to see if the caller needs to do
633 * filemap_write_and_wait_range() before proceeding.
634 *
635 * Return: %true if the caller should do filemap_write_and_wait_range() before
636 * doing O_DIRECT to a page in this range, %false otherwise.
637 */
638bool filemap_range_needs_writeback(struct address_space *mapping,
639 loff_t start_byte, loff_t end_byte)
640{
641 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
642 pgoff_t max = end_byte >> PAGE_SHIFT;
643 struct page *page;
644
645 if (!mapping_needs_writeback(mapping))
646 return false;
647 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
648 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
649 return false;
650 if (end_byte < start_byte)
651 return false;
652
653 rcu_read_lock();
654 xas_for_each(&xas, page, max) {
655 if (xas_retry(&xas, page))
656 continue;
657 if (xa_is_value(page))
658 continue;
659 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
660 break;
661 }
662 rcu_read_unlock();
663 return page != NULL;
664}
665EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
666
667/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700668 * filemap_write_and_wait_range - write out & wait on a file range
669 * @mapping: the address_space for the pages
670 * @lstart: offset in bytes where the range starts
671 * @lend: offset in bytes where the range ends (inclusive)
672 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800673 * Write out and wait upon file offsets lstart->lend, inclusive.
674 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300675 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800676 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800677 *
678 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800679 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680int filemap_write_and_wait_range(struct address_space *mapping,
681 loff_t lstart, loff_t lend)
682{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800683 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684
Jeff Layton9326c9b2017-07-26 10:21:11 -0400685 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800686 err = __filemap_fdatawrite_range(mapping, lstart, lend,
687 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800688 /*
689 * Even if the above returned error, the pages may be
690 * written partially (e.g. -ENOSPC), so we wait for it.
691 * But the -EIO is special case, it may indicate the worst
692 * thing (e.g. bug) happened, so we avoid waiting for it.
693 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800694 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200695 int err2 = filemap_fdatawait_range(mapping,
696 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800697 if (!err)
698 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400699 } else {
700 /* Clear any previously stored errors */
701 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800702 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700703 } else {
704 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800706 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707}
Chris Masonf6995582009-04-15 13:22:37 -0400708EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Jeff Layton5660e132017-07-06 07:02:25 -0400710void __filemap_set_wb_err(struct address_space *mapping, int err)
711{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400712 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400713
714 trace_filemap_set_wb_err(mapping, eseq);
715}
716EXPORT_SYMBOL(__filemap_set_wb_err);
717
718/**
719 * file_check_and_advance_wb_err - report wb error (if any) that was previously
720 * and advance wb_err to current one
721 * @file: struct file on which the error is being reported
722 *
723 * When userland calls fsync (or something like nfsd does the equivalent), we
724 * want to report any writeback errors that occurred since the last fsync (or
725 * since the file was opened if there haven't been any).
726 *
727 * Grab the wb_err from the mapping. If it matches what we have in the file,
728 * then just quickly return 0. The file is all caught up.
729 *
730 * If it doesn't match, then take the mapping value, set the "seen" flag in
731 * it and try to swap it into place. If it works, or another task beat us
732 * to it with the new value, then update the f_wb_err and return the error
733 * portion. The error at this point must be reported via proper channels
734 * (a'la fsync, or NFS COMMIT operation, etc.).
735 *
736 * While we handle mapping->wb_err with atomic operations, the f_wb_err
737 * value is protected by the f_lock since we must ensure that it reflects
738 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800739 *
740 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400741 */
742int file_check_and_advance_wb_err(struct file *file)
743{
744 int err = 0;
745 errseq_t old = READ_ONCE(file->f_wb_err);
746 struct address_space *mapping = file->f_mapping;
747
748 /* Locklessly handle the common case where nothing has changed */
749 if (errseq_check(&mapping->wb_err, old)) {
750 /* Something changed, must use slow path */
751 spin_lock(&file->f_lock);
752 old = file->f_wb_err;
753 err = errseq_check_and_advance(&mapping->wb_err,
754 &file->f_wb_err);
755 trace_file_check_and_advance_wb_err(file, old);
756 spin_unlock(&file->f_lock);
757 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700758
759 /*
760 * We're mostly using this function as a drop in replacement for
761 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
762 * that the legacy code would have had on these flags.
763 */
764 clear_bit(AS_EIO, &mapping->flags);
765 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400766 return err;
767}
768EXPORT_SYMBOL(file_check_and_advance_wb_err);
769
770/**
771 * file_write_and_wait_range - write out & wait on a file range
772 * @file: file pointing to address_space with pages
773 * @lstart: offset in bytes where the range starts
774 * @lend: offset in bytes where the range ends (inclusive)
775 *
776 * Write out and wait upon file offsets lstart->lend, inclusive.
777 *
778 * Note that @lend is inclusive (describes the last byte to be written) so
779 * that this function can be used to write to the very end-of-file (end = -1).
780 *
781 * After writing out and waiting on the data, we check and advance the
782 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800783 *
784 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400785 */
786int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
787{
788 int err = 0, err2;
789 struct address_space *mapping = file->f_mapping;
790
Jeff Layton9326c9b2017-07-26 10:21:11 -0400791 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400792 err = __filemap_fdatawrite_range(mapping, lstart, lend,
793 WB_SYNC_ALL);
794 /* See comment of filemap_write_and_wait() */
795 if (err != -EIO)
796 __filemap_fdatawait_range(mapping, lstart, lend);
797 }
798 err2 = file_check_and_advance_wb_err(file);
799 if (!err)
800 err = err2;
801 return err;
802}
803EXPORT_SYMBOL(file_write_and_wait_range);
804
Randy Dunlap485bb992006-06-23 02:03:49 -0700805/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700806 * replace_page_cache_page - replace a pagecache page with a new one
807 * @old: page to be replaced
808 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700809 *
810 * This function replaces a page in the pagecache with a new one. On
811 * success it acquires the pagecache reference for the new page and
812 * drops it for the old page. Both the old and new pages must be
813 * locked. This function does not add the new page to the LRU, the
814 * caller must do that.
815 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500816 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700817 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800818void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700819{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500820 struct address_space *mapping = old->mapping;
821 void (*freepage)(struct page *) = mapping->a_ops->freepage;
822 pgoff_t offset = old->index;
823 XA_STATE(xas, &mapping->i_pages, offset);
824 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700825
Sasha Levin309381fea2014-01-23 15:52:54 -0800826 VM_BUG_ON_PAGE(!PageLocked(old), old);
827 VM_BUG_ON_PAGE(!PageLocked(new), new);
828 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700829
Matthew Wilcox74d60952017-11-17 10:01:45 -0500830 get_page(new);
831 new->mapping = mapping;
832 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700833
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700834 mem_cgroup_migrate(old, new);
835
Matthew Wilcox74d60952017-11-17 10:01:45 -0500836 xas_lock_irqsave(&xas, flags);
837 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700838
Matthew Wilcox74d60952017-11-17 10:01:45 -0500839 old->mapping = NULL;
840 /* hugetlb pages do not participate in page cache accounting. */
841 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700842 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500843 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700844 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500845 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700846 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500847 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700848 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500849 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500850 if (freepage)
851 freepage(old);
852 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700853}
854EXPORT_SYMBOL_GPL(replace_page_cache_page);
855
Andrew Morton16c0cc02020-12-11 13:36:27 -0800856noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700857 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700858 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700859 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500861 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700862 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700863 int error;
Waiman Longda742402021-02-04 18:32:45 -0800864 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700865
Sasha Levin309381fea2014-01-23 15:52:54 -0800866 VM_BUG_ON_PAGE(!PageLocked(page), page);
867 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500868 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700869
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300870 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700871 page->mapping = mapping;
872 page->index = offset;
873
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700874 if (!huge) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700875 error = mem_cgroup_charge(page, current->mm, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700876 if (error)
877 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800878 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700879 }
880
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700881 gfp &= GFP_RECLAIM_MASK;
882
Matthew Wilcox74d60952017-11-17 10:01:45 -0500883 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700884 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
885 void *entry, *old = NULL;
886
887 if (order > thp_order(page))
888 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
889 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500890 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700891 xas_for_each_conflict(&xas, entry) {
892 old = entry;
893 if (!xa_is_value(entry)) {
894 xas_set_err(&xas, -EEXIST);
895 goto unlock;
896 }
897 }
898
899 if (old) {
900 if (shadowp)
901 *shadowp = old;
902 /* entry may have been split before we acquired lock */
903 order = xa_get_order(xas.xa, xas.xa_index);
904 if (order > thp_order(page)) {
905 xas_split(&xas, old, order);
906 xas_reset(&xas);
907 }
908 }
909
Matthew Wilcox74d60952017-11-17 10:01:45 -0500910 xas_store(&xas, page);
911 if (xas_error(&xas))
912 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700913
Matthew Wilcox74d60952017-11-17 10:01:45 -0500914 mapping->nrpages++;
915
916 /* hugetlb pages do not participate in page cache accounting */
917 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700918 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500919unlock:
920 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700921 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500922
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700923 if (xas_error(&xas)) {
924 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800925 if (charged)
926 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500927 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700928 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500929
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700930 trace_mm_filemap_add_to_page_cache(page);
931 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500932error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700933 page->mapping = NULL;
934 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300935 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700936 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700938ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700939
940/**
941 * add_to_page_cache_locked - add a locked page to the pagecache
942 * @page: page to add
943 * @mapping: the page's address_space
944 * @offset: page index
945 * @gfp_mask: page allocation mode
946 *
947 * This function is used to add a page to the pagecache. It must be locked.
948 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800949 *
950 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700951 */
952int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
953 pgoff_t offset, gfp_t gfp_mask)
954{
955 return __add_to_page_cache_locked(page, mapping, offset,
956 gfp_mask, NULL);
957}
Nick Piggine2867812008-07-25 19:45:30 -0700958EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
960int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400961 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962{
Johannes Weinera5289102014-04-03 14:47:51 -0700963 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700964 int ret;
965
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800966 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700967 ret = __add_to_page_cache_locked(page, mapping, offset,
968 gfp_mask, &shadow);
969 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800970 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700971 else {
972 /*
973 * The page might have been evicted from cache only
974 * recently, in which case it should be activated like
975 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700976 * The exception is pages getting rewritten; evicting other
977 * data from the working set, only to cache data that will
978 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700979 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700980 WARN_ON_ONCE(PageActive(page));
981 if (!(gfp_mask & __GFP_WRITE) && shadow)
982 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700983 lru_cache_add(page);
984 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 return ret;
986}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300987EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
Paul Jackson44110fe2006-03-24 03:16:04 -0800989#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700990struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800991{
Miao Xiec0ff7452010-05-24 14:32:08 -0700992 int n;
993 struct page *page;
994
Paul Jackson44110fe2006-03-24 03:16:04 -0800995 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700996 unsigned int cpuset_mems_cookie;
997 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700998 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700999 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -07001000 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -07001001 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -07001002
Miao Xiec0ff7452010-05-24 14:32:08 -07001003 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -08001004 }
Nick Piggin2ae88142006-10-28 10:38:23 -07001005 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -08001006}
Nick Piggin2ae88142006-10-28 10:38:23 -07001007EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -08001008#endif
1009
Linus Torvalds1da177e2005-04-16 15:20:36 -07001010/*
1011 * In order to wait for pages to become available there must be
1012 * waitqueues associated with pages. By using a hash table of
1013 * waitqueues where the bucket discipline is to maintain all
1014 * waiters on the same queue and wake all when any of the pages
1015 * become available, and for the woken contexts to check to be
1016 * sure the appropriate page became available, this saves space
1017 * at a cost of "thundering herd" phenomena during rare hash
1018 * collisions.
1019 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001020#define PAGE_WAIT_TABLE_BITS 8
1021#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1022static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1023
1024static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025{
Nicholas Piggin62906022016-12-25 13:00:30 +10001026 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027}
Nicholas Piggin62906022016-12-25 13:00:30 +10001028
1029void __init pagecache_init(void)
1030{
1031 int i;
1032
1033 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1034 init_waitqueue_head(&page_wait_table[i]);
1035
1036 page_writeback_init();
1037}
1038
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001039/*
1040 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001041 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001042 * one.
1043 *
1044 * We have:
1045 *
1046 * (a) no special bits set:
1047 *
1048 * We're just waiting for the bit to be released, and when a waker
1049 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1050 * and remove it from the wait queue.
1051 *
1052 * Simple and straightforward.
1053 *
1054 * (b) WQ_FLAG_EXCLUSIVE:
1055 *
1056 * The waiter is waiting to get the lock, and only one waiter should
1057 * be woken up to avoid any thundering herd behavior. We'll set the
1058 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1059 *
1060 * This is the traditional exclusive wait.
1061 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001062 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001063 *
1064 * The waiter is waiting to get the bit, and additionally wants the
1065 * lock to be transferred to it for fair lock behavior. If the lock
1066 * cannot be taken, we stop walking the wait queue without waking
1067 * the waiter.
1068 *
1069 * This is the "fair lock handoff" case, and in addition to setting
1070 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1071 * that it now has the lock.
1072 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001073static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001074{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001075 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001076 struct wait_page_key *key = arg;
1077 struct wait_page_queue *wait_page
1078 = container_of(wait, struct wait_page_queue, wait);
1079
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001080 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001081 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001082
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001083 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001084 * If it's a lock handoff wait, we get the bit for it, and
1085 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001086 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001087 flags = wait->flags;
1088 if (flags & WQ_FLAG_EXCLUSIVE) {
1089 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001090 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001091 if (flags & WQ_FLAG_CUSTOM) {
1092 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1093 return -1;
1094 flags |= WQ_FLAG_DONE;
1095 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001096 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001097
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001098 /*
1099 * We are holding the wait-queue lock, but the waiter that
1100 * is waiting for this will be checking the flags without
1101 * any locking.
1102 *
1103 * So update the flags atomically, and wake up the waiter
1104 * afterwards to avoid any races. This store-release pairs
1105 * with the load-acquire in wait_on_page_bit_common().
1106 */
1107 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001108 wake_up_state(wait->private, mode);
1109
1110 /*
1111 * Ok, we have successfully done what we're waiting for,
1112 * and we can unconditionally remove the wait entry.
1113 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001114 * Note that this pairs with the "finish_wait()" in the
1115 * waiter, and has to be the absolute last thing we do.
1116 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001117 * might be de-allocated and the process might even have
1118 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001119 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001120 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001121 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001122}
1123
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001124static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001125{
1126 wait_queue_head_t *q = page_waitqueue(page);
1127 struct wait_page_key key;
1128 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001129 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001130
1131 key.page = page;
1132 key.bit_nr = bit_nr;
1133 key.page_match = 0;
1134
Tim Chen11a19c72017-08-25 09:13:55 -07001135 bookmark.flags = 0;
1136 bookmark.private = NULL;
1137 bookmark.func = NULL;
1138 INIT_LIST_HEAD(&bookmark.entry);
1139
Nicholas Piggin62906022016-12-25 13:00:30 +10001140 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001141 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1142
1143 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1144 /*
1145 * Take a breather from holding the lock,
1146 * allow pages that finish wake up asynchronously
1147 * to acquire the lock and remove themselves
1148 * from wait queue
1149 */
1150 spin_unlock_irqrestore(&q->lock, flags);
1151 cpu_relax();
1152 spin_lock_irqsave(&q->lock, flags);
1153 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1154 }
1155
Nicholas Piggin62906022016-12-25 13:00:30 +10001156 /*
1157 * It is possible for other pages to have collided on the waitqueue
1158 * hash, so in that case check for a page match. That prevents a long-
1159 * term waiter
1160 *
1161 * It is still possible to miss a case here, when we woke page waiters
1162 * and removed them from the waitqueue, but there are still other
1163 * page waiters.
1164 */
1165 if (!waitqueue_active(q) || !key.page_match) {
1166 ClearPageWaiters(page);
1167 /*
1168 * It's possible to miss clearing Waiters here, when we woke
1169 * our page waiters, but the hashed waitqueue has waiters for
1170 * other pages on it.
1171 *
1172 * That's okay, it's a rare case. The next waker will clear it.
1173 */
1174 }
1175 spin_unlock_irqrestore(&q->lock, flags);
1176}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001177
1178static void wake_up_page(struct page *page, int bit)
1179{
1180 if (!PageWaiters(page))
1181 return;
1182 wake_up_page_bit(page, bit);
1183}
Nicholas Piggin62906022016-12-25 13:00:30 +10001184
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001185/*
1186 * A choice of three behaviors for wait_on_page_bit_common():
1187 */
1188enum behavior {
1189 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1190 * __lock_page() waiting on then setting PG_locked.
1191 */
1192 SHARED, /* Hold ref to page and check the bit when woken, like
1193 * wait_on_page_writeback() waiting on PG_writeback.
1194 */
1195 DROP, /* Drop ref to page before wait, no check when woken,
1196 * like put_and_wait_on_page_locked() on PG_locked.
1197 */
1198};
1199
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001200/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001201 * Attempt to check (or get) the page bit, and mark us done
1202 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001203 */
1204static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1205 struct wait_queue_entry *wait)
1206{
1207 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1208 if (test_and_set_bit(bit_nr, &page->flags))
1209 return false;
1210 } else if (test_bit(bit_nr, &page->flags))
1211 return false;
1212
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001213 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001214 return true;
1215}
1216
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001217/* How many times do we accept lock stealing from under a waiter? */
1218int sysctl_page_lock_unfairness = 5;
1219
Nicholas Piggin62906022016-12-25 13:00:30 +10001220static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001221 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001222{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001223 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001224 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001225 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001226 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001227 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001228 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001229
Johannes Weinereb414682018-10-26 15:06:27 -07001230 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001231 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001232 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001233 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001234 delayacct = true;
1235 }
Johannes Weinereb414682018-10-26 15:06:27 -07001236 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001237 thrashing = true;
1238 }
1239
Nicholas Piggin62906022016-12-25 13:00:30 +10001240 init_wait(wait);
1241 wait->func = wake_page_function;
1242 wait_page.page = page;
1243 wait_page.bit_nr = bit_nr;
1244
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001245repeat:
1246 wait->flags = 0;
1247 if (behavior == EXCLUSIVE) {
1248 wait->flags = WQ_FLAG_EXCLUSIVE;
1249 if (--unfairness < 0)
1250 wait->flags |= WQ_FLAG_CUSTOM;
1251 }
1252
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001253 /*
1254 * Do one last check whether we can get the
1255 * page bit synchronously.
1256 *
1257 * Do the SetPageWaiters() marking before that
1258 * to let any waker we _just_ missed know they
1259 * need to wake us up (otherwise they'll never
1260 * even go to the slow case that looks at the
1261 * page queue), and add ourselves to the wait
1262 * queue if we need to sleep.
1263 *
1264 * This part needs to be done under the queue
1265 * lock to avoid races.
1266 */
1267 spin_lock_irq(&q->lock);
1268 SetPageWaiters(page);
1269 if (!trylock_page_bit_common(page, bit_nr, wait))
1270 __add_wait_queue_entry_tail(q, wait);
1271 spin_unlock_irq(&q->lock);
1272
1273 /*
1274 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001275 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1276 * see whether the page bit testing has already
1277 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001278 *
1279 * We can drop our reference to the page.
1280 */
1281 if (behavior == DROP)
1282 put_page(page);
1283
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001284 /*
1285 * Note that until the "finish_wait()", or until
1286 * we see the WQ_FLAG_WOKEN flag, we need to
1287 * be very careful with the 'wait->flags', because
1288 * we may race with a waker that sets them.
1289 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001290 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001291 unsigned int flags;
1292
Nicholas Piggin62906022016-12-25 13:00:30 +10001293 set_current_state(state);
1294
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001295 /* Loop until we've been woken or interrupted */
1296 flags = smp_load_acquire(&wait->flags);
1297 if (!(flags & WQ_FLAG_WOKEN)) {
1298 if (signal_pending_state(state, current))
1299 break;
1300
1301 io_schedule();
1302 continue;
1303 }
1304
1305 /* If we were non-exclusive, we're done */
1306 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001307 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001308
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001309 /* If the waker got the lock for us, we're done */
1310 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001311 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001312
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001313 /*
1314 * Otherwise, if we're getting the lock, we need to
1315 * try to get it ourselves.
1316 *
1317 * And if that fails, we'll have to retry this all.
1318 */
1319 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1320 goto repeat;
1321
1322 wait->flags |= WQ_FLAG_DONE;
1323 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001324 }
1325
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001326 /*
1327 * If a signal happened, this 'finish_wait()' may remove the last
1328 * waiter from the wait-queues, but the PageWaiters bit will remain
1329 * set. That's ok. The next wakeup will take care of it, and trying
1330 * to do it here would be difficult and prone to races.
1331 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001332 finish_wait(q, wait);
1333
Johannes Weinereb414682018-10-26 15:06:27 -07001334 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001335 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001336 delayacct_thrashing_end();
1337 psi_memstall_leave(&pflags);
1338 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001339
Nicholas Piggin62906022016-12-25 13:00:30 +10001340 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001341 * NOTE! The wait->flags weren't stable until we've done the
1342 * 'finish_wait()', and we could have exited the loop above due
1343 * to a signal, and had a wakeup event happen after the signal
1344 * test but before the 'finish_wait()'.
1345 *
1346 * So only after the finish_wait() can we reliably determine
1347 * if we got woken up or not, so we can now figure out the final
1348 * return value based on that state without races.
1349 *
1350 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1351 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001352 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001353 if (behavior == EXCLUSIVE)
1354 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001355
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001356 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001357}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358
Harvey Harrison920c7a52008-02-04 22:29:26 -08001359void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360{
Nicholas Piggin62906022016-12-25 13:00:30 +10001361 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001362 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363}
1364EXPORT_SYMBOL(wait_on_page_bit);
1365
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001366int wait_on_page_bit_killable(struct page *page, int bit_nr)
1367{
Nicholas Piggin62906022016-12-25 13:00:30 +10001368 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001369 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001370}
David Howells4343d002017-11-02 15:27:52 +00001371EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001372
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001374 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1375 * @page: The page to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001376 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001377 *
1378 * The caller should hold a reference on @page. They expect the page to
1379 * become unlocked relatively soon, but do not wish to hold up migration
1380 * (for example) by holding the reference while waiting for the page to
1381 * come unlocked. After this function returns, the caller should not
1382 * dereference @page.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001383 *
1384 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001385 */
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001386int put_and_wait_on_page_locked(struct page *page, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001387{
1388 wait_queue_head_t *q;
1389
1390 page = compound_head(page);
1391 q = page_waitqueue(page);
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001392 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001393}
1394
1395/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001396 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001397 * @page: Page defining the wait queue of interest
1398 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001399 *
1400 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1401 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001402void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001403{
1404 wait_queue_head_t *q = page_waitqueue(page);
1405 unsigned long flags;
1406
1407 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001408 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001409 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001410 spin_unlock_irqrestore(&q->lock, flags);
1411}
1412EXPORT_SYMBOL_GPL(add_page_wait_queue);
1413
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001414#ifndef clear_bit_unlock_is_negative_byte
1415
1416/*
1417 * PG_waiters is the high bit in the same byte as PG_lock.
1418 *
1419 * On x86 (and on many other architectures), we can clear PG_lock and
1420 * test the sign bit at the same time. But if the architecture does
1421 * not support that special operation, we just do this all by hand
1422 * instead.
1423 *
1424 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001425 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001426 * in the same byte as PG_locked.
1427 */
1428static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1429{
1430 clear_bit_unlock(nr, mem);
1431 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001432 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001433}
1434
1435#endif
1436
David Howells385e1ca5f2009-04-03 16:42:39 +01001437/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001438 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 * @page: the page
1440 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001441 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001442 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001443 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1445 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001446 * Note that this depends on PG_waiters being the sign bit in the byte
1447 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1448 * clear the PG_locked bit and test PG_waiters at the same time fairly
1449 * portably (architectures that do LL/SC can test any bit, while x86 can
1450 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001452void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001454 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001455 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001456 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001457 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1458 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459}
1460EXPORT_SYMBOL(unlock_page);
1461
Randy Dunlap485bb992006-06-23 02:03:49 -07001462/**
David Howells73e10de2020-02-10 10:00:21 +00001463 * end_page_private_2 - Clear PG_private_2 and release any waiters
1464 * @page: The page
1465 *
1466 * Clear the PG_private_2 bit on a page and wake up any sleepers waiting for
1467 * this. The page ref held for PG_private_2 being set is released.
1468 *
1469 * This is, for example, used when a netfs page is being written to a local
1470 * disk cache, thereby allowing writes to the cache for the same page to be
1471 * serialised.
1472 */
1473void end_page_private_2(struct page *page)
1474{
1475 page = compound_head(page);
1476 VM_BUG_ON_PAGE(!PagePrivate2(page), page);
1477 clear_bit_unlock(PG_private_2, &page->flags);
1478 wake_up_page_bit(page, PG_private_2);
1479 put_page(page);
1480}
1481EXPORT_SYMBOL(end_page_private_2);
1482
1483/**
1484 * wait_on_page_private_2 - Wait for PG_private_2 to be cleared on a page
1485 * @page: The page to wait on
1486 *
1487 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page.
1488 */
1489void wait_on_page_private_2(struct page *page)
1490{
1491 page = compound_head(page);
1492 while (PagePrivate2(page))
1493 wait_on_page_bit(page, PG_private_2);
1494}
1495EXPORT_SYMBOL(wait_on_page_private_2);
1496
1497/**
1498 * wait_on_page_private_2_killable - Wait for PG_private_2 to be cleared on a page
1499 * @page: The page to wait on
1500 *
1501 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page or until a
1502 * fatal signal is received by the calling task.
1503 *
1504 * Return:
1505 * - 0 if successful.
1506 * - -EINTR if a fatal signal was encountered.
1507 */
1508int wait_on_page_private_2_killable(struct page *page)
1509{
1510 int ret = 0;
1511
1512 page = compound_head(page);
1513 while (PagePrivate2(page)) {
1514 ret = wait_on_page_bit_killable(page, PG_private_2);
1515 if (ret < 0)
1516 break;
1517 }
1518
1519 return ret;
1520}
1521EXPORT_SYMBOL(wait_on_page_private_2_killable);
1522
1523/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001524 * end_page_writeback - end writeback against a page
1525 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526 */
1527void end_page_writeback(struct page *page)
1528{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001529 /*
1530 * TestClearPageReclaim could be used here but it is an atomic
1531 * operation and overkill in this particular case. Failing to
1532 * shuffle a page marked for immediate reclaim is too mild to
1533 * justify taking an atomic operation penalty at the end of
1534 * ever page writeback.
1535 */
1536 if (PageReclaim(page)) {
1537 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001538 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001539 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001540
Hugh Dickins073861e2020-11-24 08:46:43 -08001541 /*
1542 * Writeback does not hold a page reference of its own, relying
1543 * on truncation to wait for the clearing of PG_writeback.
1544 * But here we must make sure that the page is not freed and
1545 * reused before the wake_up_page().
1546 */
1547 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001548 if (!test_clear_page_writeback(page))
1549 BUG();
1550
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001551 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001552 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001553 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001554}
1555EXPORT_SYMBOL(end_page_writeback);
1556
Matthew Wilcox57d99842014-06-04 16:07:45 -07001557/*
1558 * After completing I/O on a page, call this routine to update the page
1559 * flags appropriately
1560 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001561void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001562{
Jens Axboec11f0c02016-08-05 08:11:04 -06001563 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001564 if (!err) {
1565 SetPageUptodate(page);
1566 } else {
1567 ClearPageUptodate(page);
1568 SetPageError(page);
1569 }
1570 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001571 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001572 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001573 struct address_space *mapping;
1574
Matthew Wilcox57d99842014-06-04 16:07:45 -07001575 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001576 mapping = page_mapping(page);
1577 if (mapping)
1578 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001579 }
1580 end_page_writeback(page);
1581 }
1582}
1583EXPORT_SYMBOL_GPL(page_endio);
1584
Randy Dunlap485bb992006-06-23 02:03:49 -07001585/**
1586 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001587 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001589void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590{
Nicholas Piggin62906022016-12-25 13:00:30 +10001591 struct page *page = compound_head(__page);
1592 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001593 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1594 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595}
1596EXPORT_SYMBOL(__lock_page);
1597
Nicholas Piggin62906022016-12-25 13:00:30 +10001598int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001599{
Nicholas Piggin62906022016-12-25 13:00:30 +10001600 struct page *page = compound_head(__page);
1601 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001602 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1603 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001604}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001605EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001606
Jens Axboedd3e6d52020-05-22 09:12:09 -06001607int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1608{
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001609 struct wait_queue_head *q = page_waitqueue(page);
1610 int ret = 0;
1611
1612 wait->page = page;
1613 wait->bit_nr = PG_locked;
1614
1615 spin_lock_irq(&q->lock);
1616 __add_wait_queue_entry_tail(q, &wait->wait);
1617 SetPageWaiters(page);
1618 ret = !trylock_page(page);
1619 /*
1620 * If we were successful now, we know we're still on the
1621 * waitqueue as we're still under the lock. This means it's
1622 * safe to remove and return success, we know the callback
1623 * isn't going to trigger.
1624 */
1625 if (!ret)
1626 __remove_wait_queue(q, &wait->wait);
1627 else
1628 ret = -EIOCBQUEUED;
1629 spin_unlock_irq(&q->lock);
1630 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001631}
1632
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001633/*
1634 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001635 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001636 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001637 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001638 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001639 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001640 *
1641 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001642 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001643 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001644int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1645 unsigned int flags)
1646{
Peter Xu4064b982020-04-01 21:08:45 -07001647 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001648 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001649 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001650 * even though return 0.
1651 */
1652 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1653 return 0;
1654
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001655 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001656 if (flags & FAULT_FLAG_KILLABLE)
1657 wait_on_page_locked_killable(page);
1658 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001659 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001660 return 0;
1661 }
Hailong Liu800bca72020-12-14 19:05:02 -08001662 if (flags & FAULT_FLAG_KILLABLE) {
1663 int ret;
1664
1665 ret = __lock_page_killable(page);
1666 if (ret) {
1667 mmap_read_unlock(mm);
1668 return 0;
1669 }
1670 } else {
1671 __lock_page(page);
1672 }
1673 return 1;
1674
Michel Lespinassed065bd82010-10-26 14:21:57 -07001675}
1676
Randy Dunlap485bb992006-06-23 02:03:49 -07001677/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001678 * page_cache_next_miss() - Find the next gap in the page cache.
1679 * @mapping: Mapping.
1680 * @index: Index.
1681 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001682 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001683 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1684 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001685 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001686 * This function may be called under the rcu_read_lock. However, this will
1687 * not atomically search a snapshot of the cache at a single point in time.
1688 * For example, if a gap is created at index 5, then subsequently a gap is
1689 * created at index 10, page_cache_next_miss covering both indices may
1690 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001691 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001692 * Return: The index of the gap if found, otherwise an index outside the
1693 * range specified (in which case 'return - index >= max_scan' will be true).
1694 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001695 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001696pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001697 pgoff_t index, unsigned long max_scan)
1698{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001699 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001700
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001701 while (max_scan--) {
1702 void *entry = xas_next(&xas);
1703 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001704 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001705 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001706 break;
1707 }
1708
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001709 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001710}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001711EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001712
1713/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001714 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001715 * @mapping: Mapping.
1716 * @index: Index.
1717 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001718 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001719 * Search the range [max(index - max_scan + 1, 0), index] for the
1720 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001721 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001722 * This function may be called under the rcu_read_lock. However, this will
1723 * not atomically search a snapshot of the cache at a single point in time.
1724 * For example, if a gap is created at index 10, then subsequently a gap is
1725 * created at index 5, page_cache_prev_miss() covering both indices may
1726 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001727 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001728 * Return: The index of the gap if found, otherwise an index outside the
1729 * range specified (in which case 'index - return >= max_scan' will be true).
1730 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001731 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001732pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001733 pgoff_t index, unsigned long max_scan)
1734{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001735 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001736
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001737 while (max_scan--) {
1738 void *entry = xas_prev(&xas);
1739 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001740 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001741 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001742 break;
1743 }
1744
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001745 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001746}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001747EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001748
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001749/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001750 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001751 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001752 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001753 *
Rui Sun4b17f032021-04-29 22:55:38 -07001754 * Looks up the page cache slot at @mapping & @index. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001755 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001756 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001757 * If the slot holds a shadow entry of a previously evicted page, or a
1758 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001759 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001760 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 */
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001762static struct page *mapping_get_entry(struct address_space *mapping,
1763 pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001765 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001766 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
Nick Piggina60637c2008-07-25 19:45:31 -07001768 rcu_read_lock();
1769repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001770 xas_reset(&xas);
1771 page = xas_load(&xas);
1772 if (xas_retry(&xas, page))
1773 goto repeat;
1774 /*
1775 * A shadow entry of a recently evicted page, or a swap entry from
1776 * shmem/tmpfs. Return it without attempting to raise page count.
1777 */
1778 if (!page || xa_is_value(page))
1779 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001780
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001781 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001782 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001783
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001784 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001785 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001786 * This is part of the lockless pagecache protocol. See
1787 * include/linux/pagemap.h for details.
1788 */
1789 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001790 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001791 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001792 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001793out:
Nick Piggina60637c2008-07-25 19:45:31 -07001794 rcu_read_unlock();
1795
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 return page;
1797}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798
Randy Dunlap485bb992006-06-23 02:03:49 -07001799/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001800 * pagecache_get_page - Find and get a reference to a page.
1801 * @mapping: The address_space to search.
1802 * @index: The page index.
1803 * @fgp_flags: %FGP flags modify how the page is returned.
1804 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001805 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001806 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001807 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001808 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001809 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001810 * * %FGP_ACCESSED - The page will be marked accessed.
1811 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001812 * * %FGP_HEAD - If the page is present and a THP, return the head page
1813 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001814 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
1815 * instead of allocating a new page to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001816 * * %FGP_CREAT - If no page is present then a new page is allocated using
1817 * @gfp_mask and added to the page cache and the VM's LRU list.
1818 * The page is returned locked and with an increased refcount.
1819 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1820 * page is already in cache. If the page was allocated, unlock it before
1821 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001822 * * %FGP_WRITE - The page will be written
1823 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1824 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001825 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001826 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1827 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001828 *
1829 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001830 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001831 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001832 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001833struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1834 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835{
Nick Piggineb2be182007-10-16 01:24:57 -07001836 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838repeat:
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001839 page = mapping_get_entry(mapping, index);
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001840 if (xa_is_value(page)) {
1841 if (fgp_flags & FGP_ENTRY)
1842 return page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001843 page = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001844 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001845 if (!page)
1846 goto no_page;
1847
1848 if (fgp_flags & FGP_LOCK) {
1849 if (fgp_flags & FGP_NOWAIT) {
1850 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001851 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001852 return NULL;
1853 }
1854 } else {
1855 lock_page(page);
1856 }
1857
1858 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001859 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001860 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001861 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001862 goto repeat;
1863 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001864 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001865 }
1866
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001867 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001868 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001869 else if (fgp_flags & FGP_WRITE) {
1870 /* Clear idle flag for buffer write */
1871 if (page_is_idle(page))
1872 clear_page_idle(page);
1873 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001874 if (!(fgp_flags & FGP_HEAD))
1875 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001876
1877no_page:
1878 if (!page && (fgp_flags & FGP_CREAT)) {
1879 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001880 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001881 gfp_mask |= __GFP_WRITE;
1882 if (fgp_flags & FGP_NOFS)
1883 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001884
Michal Hocko45f87de2014-12-29 20:30:35 +01001885 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001886 if (!page)
1887 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001888
Josef Bacika75d4c32019-03-13 11:44:14 -07001889 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001890 fgp_flags |= FGP_LOCK;
1891
Hugh Dickinseb39d612014-08-06 16:06:43 -07001892 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001893 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001894 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001895
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001896 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001897 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001898 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001899 page = NULL;
1900 if (err == -EEXIST)
1901 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001903
1904 /*
1905 * add_to_page_cache_lru locks the page, and for mmap we expect
1906 * an unlocked page.
1907 */
1908 if (page && (fgp_flags & FGP_FOR_MMAP))
1909 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001911
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 return page;
1913}
Mel Gorman2457aec2014-06-04 16:10:31 -07001914EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001916static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1917 xa_mark_t mark)
1918{
1919 struct page *page;
1920
1921retry:
1922 if (mark == XA_PRESENT)
1923 page = xas_find(xas, max);
1924 else
1925 page = xas_find_marked(xas, max, mark);
1926
1927 if (xas_retry(xas, page))
1928 goto retry;
1929 /*
1930 * A shadow entry of a recently evicted page, a swap
1931 * entry from shmem/tmpfs or a DAX entry. Return it
1932 * without attempting to raise page count.
1933 */
1934 if (!page || xa_is_value(page))
1935 return page;
1936
1937 if (!page_cache_get_speculative(page))
1938 goto reset;
1939
1940 /* Has the page moved or been split? */
1941 if (unlikely(page != xas_reload(xas))) {
1942 put_page(page);
1943 goto reset;
1944 }
1945
1946 return page;
1947reset:
1948 xas_reset(xas);
1949 goto retry;
1950}
1951
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001953 * find_get_entries - gang pagecache lookup
1954 * @mapping: The address_space to search
1955 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001956 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001957 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001958 * @indices: The cache indices corresponding to the entries in @entries
1959 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001960 * find_get_entries() will search for and return a batch of entries in
1961 * the mapping. The entries are placed in @pvec. find_get_entries()
1962 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001963 *
1964 * The search returns a group of mapping-contiguous page cache entries
1965 * with ascending indexes. There may be holes in the indices due to
1966 * not-present pages.
1967 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001968 * Any shadow entries of evicted pages, or swap entries from
1969 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001970 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001971 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1972 * stops at that page: the caller is likely to have a better way to handle
1973 * the compound page as a whole, and then skip its extent, than repeatedly
1974 * calling find_get_entries() to return all its tails.
1975 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001976 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001977 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001978unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001979 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07001980{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001981 XA_STATE(xas, &mapping->i_pages, start);
1982 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001983 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001984 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001985
1986 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001987 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07001988 /*
1989 * Terminate early on finding a THP, to allow the caller to
1990 * handle it all at once; but continue if this is hugetlbfs.
1991 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001992 if (!xa_is_value(page) && PageTransHuge(page) &&
1993 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07001994 page = find_subpage(page, xas.xa_index);
1995 nr_entries = ret + 1;
1996 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001997
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001998 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001999 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002000 if (++ret == nr_entries)
2001 break;
2002 }
2003 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002004
2005 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002006 return ret;
2007}
2008
2009/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002010 * find_lock_entries - Find a batch of pagecache entries.
2011 * @mapping: The address_space to search.
2012 * @start: The starting page cache index.
2013 * @end: The final page index (inclusive).
2014 * @pvec: Where the resulting entries are placed.
2015 * @indices: The cache indices of the entries in @pvec.
2016 *
2017 * find_lock_entries() will return a batch of entries from @mapping.
2018 * Swap, shadow and DAX entries are included. Pages are returned
2019 * locked and with an incremented refcount. Pages which are locked by
2020 * somebody else or under writeback are skipped. Only the head page of
2021 * a THP is returned. Pages which are partially outside the range are
2022 * not returned.
2023 *
2024 * The entries have ascending indexes. The indices may not be consecutive
2025 * due to not-present entries, THP pages, pages which could not be locked
2026 * or pages under writeback.
2027 *
2028 * Return: The number of entries which were found.
2029 */
2030unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2031 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2032{
2033 XA_STATE(xas, &mapping->i_pages, start);
2034 struct page *page;
2035
2036 rcu_read_lock();
2037 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2038 if (!xa_is_value(page)) {
2039 if (page->index < start)
2040 goto put;
2041 VM_BUG_ON_PAGE(page->index != xas.xa_index, page);
2042 if (page->index + thp_nr_pages(page) - 1 > end)
2043 goto put;
2044 if (!trylock_page(page))
2045 goto put;
2046 if (page->mapping != mapping || PageWriteback(page))
2047 goto unlock;
2048 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2049 page);
2050 }
2051 indices[pvec->nr] = xas.xa_index;
2052 if (!pagevec_add(pvec, page))
2053 break;
2054 goto next;
2055unlock:
2056 unlock_page(page);
2057put:
2058 put_page(page);
2059next:
Hugh Dickins2d11e732021-04-23 14:28:57 -07002060 if (!xa_is_value(page) && PageTransHuge(page)) {
2061 unsigned int nr_pages = thp_nr_pages(page);
2062
2063 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
2064 xas_set(&xas, page->index + nr_pages);
2065 if (xas.xa_index < nr_pages)
2066 break;
2067 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002068 }
2069 rcu_read_unlock();
2070
2071 return pagevec_count(pvec);
2072}
2073
2074/**
Jan Karab947cee2017-09-06 16:21:21 -07002075 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 * @mapping: The address_space to search
2077 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002078 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 * @nr_pages: The maximum number of pages
2080 * @pages: Where the resulting pages are placed
2081 *
Jan Karab947cee2017-09-06 16:21:21 -07002082 * find_get_pages_range() will search for and return a group of up to @nr_pages
2083 * pages in the mapping starting at index @start and up to index @end
2084 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2085 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 *
2087 * The search returns a group of mapping-contiguous pages with ascending
2088 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002089 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002091 * Return: the number of pages which were found. If this number is
2092 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002093 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 */
Jan Karab947cee2017-09-06 16:21:21 -07002095unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2096 pgoff_t end, unsigned int nr_pages,
2097 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002099 XA_STATE(xas, &mapping->i_pages, *start);
2100 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002101 unsigned ret = 0;
2102
2103 if (unlikely(!nr_pages))
2104 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
Nick Piggina60637c2008-07-25 19:45:31 -07002106 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002107 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002108 /* Skip over shadow, swap and DAX entries */
2109 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002110 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002111
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002112 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002113 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002114 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002115 goto out;
2116 }
Nick Piggina60637c2008-07-25 19:45:31 -07002117 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002118
Jan Karab947cee2017-09-06 16:21:21 -07002119 /*
2120 * We come here when there is no page beyond @end. We take care to not
2121 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002122 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002123 * already broken anyway.
2124 */
2125 if (end == (pgoff_t)-1)
2126 *start = (pgoff_t)-1;
2127 else
2128 *start = end + 1;
2129out:
Nick Piggina60637c2008-07-25 19:45:31 -07002130 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002131
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 return ret;
2133}
2134
Jens Axboeebf43502006-04-27 08:46:01 +02002135/**
2136 * find_get_pages_contig - gang contiguous pagecache lookup
2137 * @mapping: The address_space to search
2138 * @index: The starting page index
2139 * @nr_pages: The maximum number of pages
2140 * @pages: Where the resulting pages are placed
2141 *
2142 * find_get_pages_contig() works exactly like find_get_pages(), except
2143 * that the returned number of pages are guaranteed to be contiguous.
2144 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002145 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002146 */
2147unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2148 unsigned int nr_pages, struct page **pages)
2149{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002150 XA_STATE(xas, &mapping->i_pages, index);
2151 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002152 unsigned int ret = 0;
2153
2154 if (unlikely(!nr_pages))
2155 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002156
Nick Piggina60637c2008-07-25 19:45:31 -07002157 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002158 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002159 if (xas_retry(&xas, page))
2160 continue;
2161 /*
2162 * If the entry has been swapped out, we can stop looking.
2163 * No current caller is looking for DAX entries.
2164 */
2165 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002166 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002167
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002168 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002169 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002170
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002171 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002172 if (unlikely(page != xas_reload(&xas)))
2173 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002174
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002175 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002176 if (++ret == nr_pages)
2177 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002178 continue;
2179put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002180 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002181retry:
2182 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002183 }
Nick Piggina60637c2008-07-25 19:45:31 -07002184 rcu_read_unlock();
2185 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002186}
David Howellsef71c152007-05-09 02:33:44 -07002187EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002188
Randy Dunlap485bb992006-06-23 02:03:49 -07002189/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002190 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002191 * @mapping: the address_space to search
2192 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002193 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002194 * @tag: the tag index
2195 * @nr_pages: the maximum number of pages
2196 * @pages: where the resulting pages are placed
2197 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002198 * Like find_get_pages(), except we only return head pages which are tagged
2199 * with @tag. @index is updated to the index immediately after the last
2200 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002201 *
2202 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 */
Jan Kara72b045a2017-11-15 17:34:33 -08002204unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002205 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002206 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002208 XA_STATE(xas, &mapping->i_pages, *index);
2209 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002210 unsigned ret = 0;
2211
2212 if (unlikely(!nr_pages))
2213 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214
Nick Piggina60637c2008-07-25 19:45:31 -07002215 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002216 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002217 /*
2218 * Shadow entries should never be tagged, but this iteration
2219 * is lockless so there is a window for page reclaim to evict
2220 * a page we saw tagged. Skip over it.
2221 */
2222 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002223 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002224
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002225 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002226 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002227 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002228 goto out;
2229 }
Nick Piggina60637c2008-07-25 19:45:31 -07002230 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002231
Jan Kara72b045a2017-11-15 17:34:33 -08002232 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002233 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002234 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002235 * iteration when there is a page at index -1 but that is already
2236 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002237 */
2238 if (end == (pgoff_t)-1)
2239 *index = (pgoff_t)-1;
2240 else
2241 *index = end + 1;
2242out:
Nick Piggina60637c2008-07-25 19:45:31 -07002243 rcu_read_unlock();
2244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 return ret;
2246}
Jan Kara72b045a2017-11-15 17:34:33 -08002247EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002249/*
2250 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2251 * a _large_ part of the i/o request. Imagine the worst scenario:
2252 *
2253 * ---R__________________________________________B__________
2254 * ^ reading here ^ bad block(assume 4k)
2255 *
2256 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2257 * => failing the whole request => read(R) => read(R+1) =>
2258 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2259 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2260 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2261 *
2262 * It is going insane. Fix it by quickly scaling down the readahead size.
2263 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002264static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002265{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002266 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002267}
2268
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002269/*
2270 * filemap_get_read_batch - Get a batch of pages for read
2271 *
2272 * Get a batch of pages which represent a contiguous range of bytes
2273 * in the file. No tail pages will be returned. If @index is in the
2274 * middle of a THP, the entire THP will be returned. The last page in
2275 * the batch may have Readahead set or be not Uptodate so that the
2276 * caller can take the appropriate action.
2277 */
2278static void filemap_get_read_batch(struct address_space *mapping,
2279 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2280{
2281 XA_STATE(xas, &mapping->i_pages, index);
2282 struct page *head;
2283
2284 rcu_read_lock();
2285 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2286 if (xas_retry(&xas, head))
2287 continue;
2288 if (xas.xa_index > max || xa_is_value(head))
2289 break;
2290 if (!page_cache_get_speculative(head))
2291 goto retry;
2292
2293 /* Has the page moved or been split? */
2294 if (unlikely(head != xas_reload(&xas)))
2295 goto put_page;
2296
2297 if (!pagevec_add(pvec, head))
2298 break;
2299 if (!PageUptodate(head))
2300 break;
2301 if (PageReadahead(head))
2302 break;
2303 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2304 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2305 continue;
2306put_page:
2307 put_page(head);
2308retry:
2309 xas_reset(&xas);
2310 }
2311 rcu_read_unlock();
2312}
2313
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002314static int filemap_read_page(struct file *file, struct address_space *mapping,
2315 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002316{
Kent Overstreet723ef242020-12-14 19:04:52 -08002317 int error;
2318
Kent Overstreet723ef242020-12-14 19:04:52 -08002319 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002320 * A previous I/O error may have been due to temporary failures,
2321 * eg. multipath errors. PG_error will be set again if readpage
2322 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002323 */
2324 ClearPageError(page);
2325 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002326 error = mapping->a_ops->readpage(file, page);
2327 if (error)
2328 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002329
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002330 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002331 if (error)
2332 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002333 if (PageUptodate(page))
2334 return 0;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002335 shrink_readahead_size_eio(&file->f_ra);
2336 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002337}
2338
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002339static bool filemap_range_uptodate(struct address_space *mapping,
2340 loff_t pos, struct iov_iter *iter, struct page *page)
2341{
2342 int count;
2343
2344 if (PageUptodate(page))
2345 return true;
2346 /* pipes can't handle partially uptodate pages */
2347 if (iov_iter_is_pipe(iter))
2348 return false;
2349 if (!mapping->a_ops->is_partially_uptodate)
2350 return false;
2351 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2352 return false;
2353
2354 count = iter->count;
2355 if (page_offset(page) > pos) {
2356 count -= page_offset(page) - pos;
2357 pos = 0;
2358 } else {
2359 pos -= page_offset(page);
2360 }
2361
2362 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2363}
2364
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002365static int filemap_update_page(struct kiocb *iocb,
2366 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002367 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002368{
Kent Overstreet723ef242020-12-14 19:04:52 -08002369 int error;
2370
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002371 if (!trylock_page(page)) {
2372 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2373 return -EAGAIN;
2374 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002375 put_and_wait_on_page_locked(page, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002376 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002377 }
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002378 error = __lock_page_async(page, iocb->ki_waitq);
2379 if (error)
2380 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002381 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002382
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002383 if (!page->mapping)
2384 goto truncated;
Kent Overstreet723ef242020-12-14 19:04:52 -08002385
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002386 error = 0;
2387 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, page))
2388 goto unlock;
2389
2390 error = -EAGAIN;
2391 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2392 goto unlock;
2393
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002394 error = filemap_read_page(iocb->ki_filp, mapping, page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002395 if (error == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002396 put_page(page);
2397 return error;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002398truncated:
2399 unlock_page(page);
2400 put_page(page);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002401 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002402unlock:
2403 unlock_page(page);
2404 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002405}
2406
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002407static int filemap_create_page(struct file *file,
2408 struct address_space *mapping, pgoff_t index,
2409 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002410{
Kent Overstreet723ef242020-12-14 19:04:52 -08002411 struct page *page;
2412 int error;
2413
Kent Overstreet723ef242020-12-14 19:04:52 -08002414 page = page_cache_alloc(mapping);
2415 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002416 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002417
2418 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002419 mapping_gfp_constraint(mapping, GFP_KERNEL));
2420 if (error == -EEXIST)
2421 error = AOP_TRUNCATED_PAGE;
2422 if (error)
2423 goto error;
2424
2425 error = filemap_read_page(file, mapping, page);
2426 if (error)
2427 goto error;
2428
2429 pagevec_add(pvec, page);
2430 return 0;
2431error:
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002432 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002433 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002434}
2435
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002436static int filemap_readahead(struct kiocb *iocb, struct file *file,
2437 struct address_space *mapping, struct page *page,
2438 pgoff_t last_index)
2439{
2440 if (iocb->ki_flags & IOCB_NOIO)
2441 return -EAGAIN;
2442 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2443 page->index, last_index - page->index);
2444 return 0;
2445}
2446
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002447static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002448 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002449{
2450 struct file *filp = iocb->ki_filp;
2451 struct address_space *mapping = filp->f_mapping;
2452 struct file_ra_state *ra = &filp->f_ra;
2453 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002454 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002455 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002456 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002457
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002458 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002459retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002460 if (fatal_signal_pending(current))
2461 return -EINTR;
2462
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002463 filemap_get_read_batch(mapping, index, last_index, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002464 if (!pagevec_count(pvec)) {
2465 if (iocb->ki_flags & IOCB_NOIO)
2466 return -EAGAIN;
2467 page_cache_sync_readahead(mapping, ra, filp, index,
2468 last_index - index);
2469 filemap_get_read_batch(mapping, index, last_index, pvec);
2470 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002471 if (!pagevec_count(pvec)) {
2472 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2473 return -EAGAIN;
2474 err = filemap_create_page(filp, mapping,
2475 iocb->ki_pos >> PAGE_SHIFT, pvec);
2476 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002477 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002478 return err;
2479 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002480
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002481 page = pvec->pages[pagevec_count(pvec) - 1];
2482 if (PageReadahead(page)) {
2483 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2484 if (err)
2485 goto err;
2486 }
2487 if (!PageUptodate(page)) {
2488 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2489 iocb->ki_flags |= IOCB_NOWAIT;
2490 err = filemap_update_page(iocb, mapping, iter, page);
2491 if (err)
2492 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002493 }
2494
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002495 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002496err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002497 if (err < 0)
2498 put_page(page);
2499 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002500 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002501 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002502 goto retry;
2503 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002504}
2505
Randy Dunlap485bb992006-06-23 02:03:49 -07002506/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002507 * filemap_read - Read data from the page cache.
2508 * @iocb: The iocb to read.
2509 * @iter: Destination for the data.
2510 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002511 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002512 * Copies data from the page cache. If the data is not currently present,
2513 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002515 * Return: Total number of bytes copied, including those already read by
2516 * the caller. If an error happens before any bytes are copied, returns
2517 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002519ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2520 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002522 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002523 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002524 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002525 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002526 struct pagevec pvec;
2527 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002528 bool writably_mapped;
2529 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530
Kent Overstreet723ef242020-12-14 19:04:52 -08002531 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002532 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002533 if (unlikely(!iov_iter_count(iter)))
2534 return 0;
2535
Wei Fangc2a97372016-10-07 17:01:52 -07002536 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002537 pagevec_init(&pvec);
Wei Fangc2a97372016-10-07 17:01:52 -07002538
Kent Overstreet06c04442020-12-14 19:04:56 -08002539 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540 cond_resched();
Kent Overstreet06c04442020-12-14 19:04:56 -08002541
2542 /*
2543 * If we've already successfully copied some data, then we
2544 * can no longer safely return -EIOCBQUEUED. Hence mark
2545 * an async read NOWAIT at that point.
2546 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002547 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002548 iocb->ki_flags |= IOCB_NOWAIT;
2549
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002550 error = filemap_get_pages(iocb, iter, &pvec);
2551 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002552 break;
Michal Hocko5abf1862017-02-03 13:13:29 -08002553
Kent Overstreet723ef242020-12-14 19:04:52 -08002554 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002555 * i_size must be checked after we know the pages are Uptodate.
2556 *
2557 * Checking i_size after the check allows us to calculate
2558 * the correct value for "nr", which means the zero-filled
2559 * part of the page is not copied back to userspace (unless
2560 * another truncate extends the file - this is desired though).
Kent Overstreet723ef242020-12-14 19:04:52 -08002561 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002562 isize = i_size_read(inode);
2563 if (unlikely(iocb->ki_pos >= isize))
2564 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002565 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2566
Kent Overstreet06c04442020-12-14 19:04:56 -08002567 /*
2568 * Once we start copying data, we don't want to be touching any
2569 * cachelines that might be contended:
2570 */
2571 writably_mapped = mapping_writably_mapped(mapping);
2572
2573 /*
2574 * When a sequential read accesses a page several times, only
2575 * mark it as accessed the first time.
2576 */
2577 if (iocb->ki_pos >> PAGE_SHIFT !=
2578 ra->prev_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002579 mark_page_accessed(pvec.pages[0]);
Kent Overstreet06c04442020-12-14 19:04:56 -08002580
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002581 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002582 struct page *page = pvec.pages[i];
2583 size_t page_size = thp_size(page);
2584 size_t offset = iocb->ki_pos & (page_size - 1);
2585 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2586 page_size - offset);
2587 size_t copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002588
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002589 if (end_offset < page_offset(page))
2590 break;
2591 if (i > 0)
2592 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002593 /*
2594 * If users can be writing to this page using arbitrary
2595 * virtual addresses, take care about potential aliasing
2596 * before reading the page on the kernel side.
2597 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002598 if (writably_mapped) {
2599 int j;
Kent Overstreet06c04442020-12-14 19:04:56 -08002600
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002601 for (j = 0; j < thp_nr_pages(page); j++)
2602 flush_dcache_page(page + j);
2603 }
2604
2605 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002606
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002607 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002608 iocb->ki_pos += copied;
2609 ra->prev_pos = iocb->ki_pos;
2610
2611 if (copied < bytes) {
2612 error = -EFAULT;
2613 break;
Kent Overstreet723ef242020-12-14 19:04:52 -08002614 }
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002615 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002616put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002617 for (i = 0; i < pagevec_count(&pvec); i++)
2618 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002619 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002620 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002621
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002622 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002623
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002624 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002625}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002626EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627
Randy Dunlap485bb992006-06-23 02:03:49 -07002628/**
Al Viro6abd2322014-04-04 14:20:57 -04002629 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002630 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002631 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002632 *
Al Viro6abd2322014-04-04 14:20:57 -04002633 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002634 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002635 *
2636 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2637 * be returned when no data can be read without waiting for I/O requests
2638 * to complete; it doesn't prevent readahead.
2639 *
2640 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2641 * requests shall be made for the read or for readahead. When no data
2642 * can be read, -EAGAIN shall be returned. When readahead would be
2643 * triggered, a partial, possibly empty read shall be returned.
2644 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002645 * Return:
2646 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002647 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 */
2649ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002650generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002652 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002653 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002654
2655 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002656 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657
Al Viro2ba48ce2015-04-09 13:52:01 -04002658 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002659 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002660 struct address_space *mapping = file->f_mapping;
2661 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002662 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663
Linus Torvalds1da177e2005-04-16 15:20:36 -07002664 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002665 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002666 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2667 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002668 return -EAGAIN;
2669 } else {
2670 retval = filemap_write_and_wait_range(mapping,
2671 iocb->ki_pos,
2672 iocb->ki_pos + count - 1);
2673 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002674 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002675 }
Al Viroed978a82014-03-05 22:53:04 -05002676
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002677 file_accessed(file);
2678
Al Viro5ecda132017-04-13 14:13:36 -04002679 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002680 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002681 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002682 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002683 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002684 if (retval != -EIOCBQUEUED)
2685 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002686
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002687 /*
2688 * Btrfs can have a short DIO read if we encounter
2689 * compressed extents, so if there was an error, or if
2690 * we've already read everything we wanted to, or if
2691 * there was a short read because we hit EOF, go ahead
2692 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002693 * the rest of the read. Buffered reads will not work for
2694 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002695 */
Al Viro5ecda132017-04-13 14:13:36 -04002696 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002697 IS_DAX(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002698 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699 }
2700
Christoph Hellwig826ea862021-02-24 12:02:45 -08002701 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702}
Al Viroed978a82014-03-05 22:53:04 -05002703EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002704
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002705static inline loff_t page_seek_hole_data(struct xa_state *xas,
2706 struct address_space *mapping, struct page *page,
2707 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002708{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002709 const struct address_space_operations *ops = mapping->a_ops;
2710 size_t offset, bsz = i_blocksize(mapping->host);
2711
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002712 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002713 return seek_data ? start : end;
2714 if (!ops->is_partially_uptodate)
2715 return seek_data ? end : start;
2716
2717 xas_pause(xas);
2718 rcu_read_unlock();
2719 lock_page(page);
2720 if (unlikely(page->mapping != mapping))
2721 goto unlock;
2722
2723 offset = offset_in_thp(page, start) & ~(bsz - 1);
2724
2725 do {
2726 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2727 break;
2728 start = (start + bsz) & ~(bsz - 1);
2729 offset += bsz;
2730 } while (offset < thp_size(page));
2731unlock:
2732 unlock_page(page);
2733 rcu_read_lock();
2734 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002735}
2736
2737static inline
2738unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2739{
2740 if (xa_is_value(page))
2741 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2742 return thp_size(page);
2743}
2744
2745/**
2746 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2747 * @mapping: Address space to search.
2748 * @start: First byte to consider.
2749 * @end: Limit of search (exclusive).
2750 * @whence: Either SEEK_HOLE or SEEK_DATA.
2751 *
2752 * If the page cache knows which blocks contain holes and which blocks
2753 * contain data, your filesystem can use this function to implement
2754 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2755 * entirely memory-based such as tmpfs, and filesystems which support
2756 * unwritten extents.
2757 *
Ingo Molnarf0953a12021-05-06 18:06:47 -07002758 * Return: The requested offset on success, or -ENXIO if @whence specifies
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002759 * SEEK_DATA and there is no data after @start. There is an implicit hole
2760 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2761 * and @end contain data.
2762 */
2763loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2764 loff_t end, int whence)
2765{
2766 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002767 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002768 bool seek_data = (whence == SEEK_DATA);
2769 struct page *page;
2770
2771 if (end <= start)
2772 return -ENXIO;
2773
2774 rcu_read_lock();
2775 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002776 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2777 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002778
2779 if (start < pos) {
2780 if (!seek_data)
2781 goto unlock;
2782 start = pos;
2783 }
2784
Hugh Dickinsed98b012021-04-23 14:29:00 -07002785 seek_size = seek_page_size(&xas, page);
2786 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002787 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2788 seek_data);
2789 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002790 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002791 if (start >= end)
2792 break;
2793 if (seek_size > PAGE_SIZE)
2794 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002795 if (!xa_is_value(page))
2796 put_page(page);
2797 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002798 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002799 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002800unlock:
2801 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002802 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002803 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002804 if (start > end)
2805 return end;
2806 return start;
2807}
2808
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002810#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002811/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002812 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002813 * @vmf - the vm_fault for this fault.
2814 * @page - the page to lock.
2815 * @fpin - the pointer to the file we may pin (or is already pinned).
2816 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002817 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002818 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002819 * 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 -07002820 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002821 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002822static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2823 struct file **fpin)
2824{
2825 if (trylock_page(page))
2826 return 1;
2827
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002828 /*
2829 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002830 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002831 * is supposed to work. We have way too many special cases..
2832 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002833 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2834 return 0;
2835
2836 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2837 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2838 if (__lock_page_killable(page)) {
2839 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002840 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002841 * but all fault_handlers only check for fatal signals
2842 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002843 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002844 */
2845 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002846 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002847 return 0;
2848 }
2849 } else
2850 __lock_page(page);
2851 return 1;
2852}
2853
2854
2855/*
2856 * Synchronous readahead happens when we don't even find a page in the page
2857 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2858 * to drop the mmap sem we return the file that was pinned in order for us to do
2859 * that. If we didn't pin a file then we return NULL. The file that is
2860 * returned needs to be fput()'ed when we're done with it.
2861 */
2862static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002863{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002864 struct file *file = vmf->vma->vm_file;
2865 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002866 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002867 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002868 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002869 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002870
2871 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002872 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002873 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002874 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002875 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002876
Josef Bacik2a1180f2019-03-13 11:44:18 -07002877 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002878 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002879 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002880 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002881 }
2882
Andi Kleen207d04b2011-05-24 17:12:29 -07002883 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002884 mmap_miss = READ_ONCE(ra->mmap_miss);
2885 if (mmap_miss < MMAP_LOTSAMISS * 10)
2886 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002887
2888 /*
2889 * Do we miss much more than hit in this file? If so,
2890 * stop bothering with read-ahead. It will only hurt.
2891 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002892 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002893 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002894
Wu Fengguangd30a1102009-06-16 15:31:30 -07002895 /*
2896 * mmap read-around
2897 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002898 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002899 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002900 ra->size = ra->ra_pages;
2901 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002902 ractl._index = ra->start;
2903 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002904 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002905}
2906
2907/*
2908 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002909 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002910 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002911 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002912static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2913 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002914{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002915 struct file *file = vmf->vma->vm_file;
2916 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002917 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002918 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002919 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002920 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002921
2922 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002923 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002924 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002925 mmap_miss = READ_ONCE(ra->mmap_miss);
2926 if (mmap_miss)
2927 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002928 if (PageReadahead(page)) {
2929 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002930 page_cache_async_readahead(mapping, ra, file,
2931 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002932 }
2933 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002934}
2935
Randy Dunlap485bb992006-06-23 02:03:49 -07002936/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002937 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002938 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002939 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002940 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002941 * mapped memory region to read in file data during a page fault.
2942 *
2943 * The goto's are kind of ugly, but this streamlines the normal case of having
2944 * it in the page cache, and handles the special cases reasonably without
2945 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002946 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002947 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002948 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002949 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002950 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002951 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002952 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002953 * has not been released.
2954 *
2955 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002956 *
2957 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002958 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002959vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960{
2961 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002962 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002963 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002964 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002965 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002966 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002967 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002969 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002970
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002971 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2972 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002973 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002976 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002977 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002978 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002979 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002980 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002981 * We found the page, so try async readahead before
2982 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002984 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002985 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002986 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002987 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002988 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002989 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002990 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002991retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002992 page = pagecache_get_page(mapping, offset,
2993 FGP_CREAT|FGP_FOR_MMAP,
2994 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002995 if (!page) {
2996 if (fpin)
2997 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002998 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002999 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003000 }
3001
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003002 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3003 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003004
3005 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003006 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003007 unlock_page(page);
3008 put_page(page);
3009 goto retry_find;
3010 }
Song Liu520e5ba2019-09-23 15:37:50 -07003011 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003012
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003014 * We have a locked page in the page cache, now we need to check
3015 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003016 */
Nick Piggind00806b2007-07-19 01:46:57 -07003017 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 goto page_not_uptodate;
3019
Linus Torvaldsef00e082009-06-16 15:31:25 -07003020 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003021 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003022 * time to return to the upper layer and have it re-find the vma and
3023 * redo the fault.
3024 */
3025 if (fpin) {
3026 unlock_page(page);
3027 goto out_retry;
3028 }
3029
3030 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003031 * Found the page and have a reference on it.
3032 * We must recheck i_size under page lock.
3033 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003034 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3035 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003036 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003037 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003038 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003039 }
3040
Nick Piggind0217ac2007-07-19 01:47:03 -07003041 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003042 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045 /*
3046 * Umm, take care of errors if the page isn't up-to-date.
3047 * Try to re-read it _once_. We do this synchronously,
3048 * because there really aren't any performance issues here
3049 * and we need to check for errors.
3050 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003051 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)d31fa862021-04-29 22:55:26 -07003052 error = filemap_read_page(file, mapping, page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003053 if (fpin)
3054 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003055 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003056
3057 if (!error || error == AOP_TRUNCATED_PAGE)
3058 goto retry_find;
3059
Nick Piggind0217ac2007-07-19 01:47:03 -07003060 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003061
3062out_retry:
3063 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003064 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003065 * re-find the vma and come back and find our hopefully still populated
3066 * page.
3067 */
3068 if (page)
3069 put_page(page);
3070 if (fpin)
3071 fput(fpin);
3072 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003073}
3074EXPORT_SYMBOL(filemap_fault);
3075
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003076static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003077{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003078 struct mm_struct *mm = vmf->vma->vm_mm;
3079
3080 /* Huge page is mapped? No need to proceed. */
3081 if (pmd_trans_huge(*vmf->pmd)) {
3082 unlock_page(page);
3083 put_page(page);
3084 return true;
3085 }
3086
3087 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
3088 vm_fault_t ret = do_set_pmd(vmf, page);
3089 if (!ret) {
3090 /* The page is mapped successfully, reference consumed. */
3091 unlock_page(page);
3092 return true;
3093 }
3094 }
3095
3096 if (pmd_none(*vmf->pmd)) {
3097 vmf->ptl = pmd_lock(mm, vmf->pmd);
3098 if (likely(pmd_none(*vmf->pmd))) {
3099 mm_inc_nr_ptes(mm);
3100 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
3101 vmf->prealloc_pte = NULL;
3102 }
3103 spin_unlock(vmf->ptl);
3104 }
3105
3106 /* See comment in handle_pte_fault() */
3107 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3108 unlock_page(page);
3109 put_page(page);
3110 return true;
3111 }
3112
3113 return false;
3114}
3115
3116static struct page *next_uptodate_page(struct page *page,
3117 struct address_space *mapping,
3118 struct xa_state *xas, pgoff_t end_pgoff)
3119{
3120 unsigned long max_idx;
3121
3122 do {
3123 if (!page)
3124 return NULL;
3125 if (xas_retry(xas, page))
3126 continue;
3127 if (xa_is_value(page))
3128 continue;
3129 if (PageLocked(page))
3130 continue;
3131 if (!page_cache_get_speculative(page))
3132 continue;
3133 /* Has the page moved or been split? */
3134 if (unlikely(page != xas_reload(xas)))
3135 goto skip;
3136 if (!PageUptodate(page) || PageReadahead(page))
3137 goto skip;
3138 if (PageHWPoison(page))
3139 goto skip;
3140 if (!trylock_page(page))
3141 goto skip;
3142 if (page->mapping != mapping)
3143 goto unlock;
3144 if (!PageUptodate(page))
3145 goto unlock;
3146 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3147 if (xas->xa_index >= max_idx)
3148 goto unlock;
3149 return page;
3150unlock:
3151 unlock_page(page);
3152skip:
3153 put_page(page);
3154 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3155
3156 return NULL;
3157}
3158
3159static inline struct page *first_map_page(struct address_space *mapping,
3160 struct xa_state *xas,
3161 pgoff_t end_pgoff)
3162{
3163 return next_uptodate_page(xas_find(xas, end_pgoff),
3164 mapping, xas, end_pgoff);
3165}
3166
3167static inline struct page *next_map_page(struct address_space *mapping,
3168 struct xa_state *xas,
3169 pgoff_t end_pgoff)
3170{
3171 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3172 mapping, xas, end_pgoff);
3173}
3174
3175vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3176 pgoff_t start_pgoff, pgoff_t end_pgoff)
3177{
3178 struct vm_area_struct *vma = vmf->vma;
3179 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003180 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07003181 pgoff_t last_pgoff = start_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003182 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003183 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003184 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003185 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003186 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003187
3188 rcu_read_lock();
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003189 head = first_map_page(mapping, &xas, end_pgoff);
3190 if (!head)
3191 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003192
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003193 if (filemap_map_pmd(vmf, head)) {
3194 ret = VM_FAULT_NOPAGE;
3195 goto out;
3196 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003197
Will Deacon9d3af4b2021-01-14 15:24:19 +00003198 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3199 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003200 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003201 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003202 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003203 goto unlock;
3204
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003205 if (mmap_miss > 0)
3206 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003207
Will Deacon9d3af4b2021-01-14 15:24:19 +00003208 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003209 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003210 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003211
3212 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003213 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003214
Will Deacon46bdb422020-11-24 18:48:26 +00003215 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003216 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003217 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003218
Will Deacon9d3af4b2021-01-14 15:24:19 +00003219 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003220 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003221 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003222 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003223 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003224unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003225 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003226 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003227 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3228 pte_unmap_unlock(vmf->pte, vmf->ptl);
3229out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003230 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003231 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003232 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003233}
3234EXPORT_SYMBOL(filemap_map_pages);
3235
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003236vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003237{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003238 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003239 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003240 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003241
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003242 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003243 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003244 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003245 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003246 unlock_page(page);
3247 ret = VM_FAULT_NOPAGE;
3248 goto out;
3249 }
Jan Kara14da9202012-06-12 16:20:37 +02003250 /*
3251 * We mark the page dirty already here so that when freeze is in
3252 * progress, we are guaranteed that writeback during freezing will
3253 * see the dirty page and writeprotect it again.
3254 */
3255 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003256 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003257out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003258 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003259 return ret;
3260}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003261
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003262const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003263 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003264 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003265 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003266};
3267
3268/* This is used for a general mmap of a disk file */
3269
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003270int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003271{
3272 struct address_space *mapping = file->f_mapping;
3273
3274 if (!mapping->a_ops->readpage)
3275 return -ENOEXEC;
3276 file_accessed(file);
3277 vma->vm_ops = &generic_file_vm_ops;
3278 return 0;
3279}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003280
3281/*
3282 * This is for filesystems which do not implement ->writepage.
3283 */
3284int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3285{
3286 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3287 return -EINVAL;
3288 return generic_file_mmap(file, vma);
3289}
3290#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003291vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003292{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003293 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003294}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003295int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003296{
3297 return -ENOSYS;
3298}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003299int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003300{
3301 return -ENOSYS;
3302}
3303#endif /* CONFIG_MMU */
3304
Arnd Bergmann453972282018-04-13 15:35:27 -07003305EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003306EXPORT_SYMBOL(generic_file_mmap);
3307EXPORT_SYMBOL(generic_file_readonly_mmap);
3308
Sasha Levin67f9fd92014-04-03 14:48:18 -07003309static struct page *wait_on_page_read(struct page *page)
3310{
3311 if (!IS_ERR(page)) {
3312 wait_on_page_locked(page);
3313 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003314 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003315 page = ERR_PTR(-EIO);
3316 }
3317 }
3318 return page;
3319}
3320
Mel Gorman32b63522016-03-15 14:55:36 -07003321static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003322 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003323 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003324 void *data,
3325 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003326{
Nick Piggineb2be182007-10-16 01:24:57 -07003327 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003328 int err;
3329repeat:
3330 page = find_get_page(mapping, index);
3331 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003332 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003333 if (!page)
3334 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003335 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003336 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003337 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003338 if (err == -EEXIST)
3339 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003340 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003341 return ERR_PTR(err);
3342 }
Mel Gorman32b63522016-03-15 14:55:36 -07003343
3344filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003345 if (filler)
3346 err = filler(data, page);
3347 else
3348 err = mapping->a_ops->readpage(data, page);
3349
Linus Torvalds1da177e2005-04-16 15:20:36 -07003350 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003351 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003352 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003353 }
Mel Gorman32b63522016-03-15 14:55:36 -07003354
3355 page = wait_on_page_read(page);
3356 if (IS_ERR(page))
3357 return page;
3358 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003359 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003360 if (PageUptodate(page))
3361 goto out;
3362
Mel Gormanebded022016-03-15 14:55:39 -07003363 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003364 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003365 * case a: Page is being filled and the page lock is held
3366 * case b: Read/write error clearing the page uptodate status
3367 * case c: Truncation in progress (page locked)
3368 * case d: Reclaim in progress
3369 *
3370 * Case a, the page will be up to date when the page is unlocked.
3371 * There is no need to serialise on the page lock here as the page
3372 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003373 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003374 * it's a race vs truncate race.
3375 * Case b, the page will not be up to date
3376 * Case c, the page may be truncated but in itself, the data may still
3377 * be valid after IO completes as it's a read vs truncate race. The
3378 * operation must restart if the page is not uptodate on unlock but
3379 * otherwise serialising on page lock to stabilise the mapping gives
3380 * no additional guarantees to the caller as the page lock is
3381 * released before return.
3382 * Case d, similar to truncation. If reclaim holds the page lock, it
3383 * will be a race with remove_mapping that determines if the mapping
3384 * is valid on unlock but otherwise the data is valid and there is
3385 * no need to serialise with page lock.
3386 *
3387 * As the page lock gives no additional guarantee, we optimistically
3388 * wait on the page to be unlocked and check if it's up to date and
3389 * use the page if it is. Otherwise, the page lock is required to
3390 * distinguish between the different cases. The motivation is that we
3391 * avoid spurious serialisations and wakeups when multiple processes
3392 * wait on the same page for IO to complete.
3393 */
3394 wait_on_page_locked(page);
3395 if (PageUptodate(page))
3396 goto out;
3397
3398 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003399 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003400
3401 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003402 if (!page->mapping) {
3403 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003404 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003405 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003406 }
Mel Gormanebded022016-03-15 14:55:39 -07003407
3408 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003409 if (PageUptodate(page)) {
3410 unlock_page(page);
3411 goto out;
3412 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003413
3414 /*
3415 * A previous I/O error may have been due to temporary
3416 * failures.
3417 * Clear page error before actual read, PG_error will be
3418 * set again if read page fails.
3419 */
3420 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003421 goto filler;
3422
David Howellsc855ff32007-05-09 13:42:20 +01003423out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003424 mark_page_accessed(page);
3425 return page;
3426}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003427
3428/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003429 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003430 * @mapping: the page's address_space
3431 * @index: the page index
3432 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003433 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003434 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003435 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003436 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003437 *
3438 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003439 *
3440 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003441 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003442struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003443 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003444 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003445 void *data)
3446{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003447 return do_read_cache_page(mapping, index, filler, data,
3448 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003449}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003450EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003451
3452/**
3453 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3454 * @mapping: the page's address_space
3455 * @index: the page index
3456 * @gfp: the page allocator flags to use if allocating
3457 *
3458 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003459 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003460 *
3461 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003462 *
3463 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003464 */
3465struct page *read_cache_page_gfp(struct address_space *mapping,
3466 pgoff_t index,
3467 gfp_t gfp)
3468{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003469 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003470}
3471EXPORT_SYMBOL(read_cache_page_gfp);
3472
Nick Pigginafddba42007-10-16 01:25:01 -07003473int pagecache_write_begin(struct file *file, struct address_space *mapping,
3474 loff_t pos, unsigned len, unsigned flags,
3475 struct page **pagep, void **fsdata)
3476{
3477 const struct address_space_operations *aops = mapping->a_ops;
3478
Nick Piggin4e02ed42008-10-29 14:00:55 -07003479 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003480 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003481}
3482EXPORT_SYMBOL(pagecache_write_begin);
3483
3484int pagecache_write_end(struct file *file, struct address_space *mapping,
3485 loff_t pos, unsigned len, unsigned copied,
3486 struct page *page, void *fsdata)
3487{
3488 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003489
Nick Piggin4e02ed42008-10-29 14:00:55 -07003490 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003491}
3492EXPORT_SYMBOL(pagecache_write_end);
3493
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003494/*
3495 * Warn about a page cache invalidation failure during a direct I/O write.
3496 */
3497void dio_warn_stale_pagecache(struct file *filp)
3498{
3499 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3500 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003501 char *path;
3502
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003503 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003504 if (__ratelimit(&_rs)) {
3505 path = file_path(filp, pathname, sizeof(pathname));
3506 if (IS_ERR(path))
3507 path = "(unknown)";
3508 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3509 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3510 current->comm);
3511 }
3512}
3513
Linus Torvalds1da177e2005-04-16 15:20:36 -07003514ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003515generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003516{
3517 struct file *file = iocb->ki_filp;
3518 struct address_space *mapping = file->f_mapping;
3519 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003520 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003521 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003522 size_t write_len;
3523 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003524
Al Viro0c949332014-03-22 06:51:37 -04003525 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003526 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003527
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003528 if (iocb->ki_flags & IOCB_NOWAIT) {
3529 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003530 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003531 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003532 return -EAGAIN;
3533 } else {
3534 written = filemap_write_and_wait_range(mapping, pos,
3535 pos + write_len - 1);
3536 if (written)
3537 goto out;
3538 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003539
3540 /*
3541 * After a write we want buffered reads to be sure to go to disk to get
3542 * the new data. We invalidate clean cached page from the region we're
3543 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003544 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003545 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003546 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003547 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003548 /*
3549 * If a page can not be invalidated, return 0 to fall back
3550 * to buffered write.
3551 */
3552 if (written) {
3553 if (written == -EBUSY)
3554 return 0;
3555 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003556 }
3557
Al Viro639a93a52017-04-13 14:10:15 -04003558 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003559
3560 /*
3561 * Finally, try again to invalidate clean pages which might have been
3562 * cached by non-direct readahead, or faulted in by get_user_pages()
3563 * if the source of the write was an mmap'ed region of the file
3564 * we're writing. Either one is a pretty crazy thing to do,
3565 * so we don't support it 100%. If this invalidation
3566 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003567 *
3568 * Most of the time we do not need this since dio_complete() will do
3569 * the invalidation for us. However there are some file systems that
3570 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003571 * them by removing it completely.
3572 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003573 * Noticeable example is a blkdev_direct_IO().
3574 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003575 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003576 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003577 if (written > 0 && mapping->nrpages &&
3578 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3579 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003580
Linus Torvalds1da177e2005-04-16 15:20:36 -07003581 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003582 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003583 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003584 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3585 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003586 mark_inode_dirty(inode);
3587 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003588 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003589 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003590 if (written != -EIOCBQUEUED)
3591 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003592out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593 return written;
3594}
3595EXPORT_SYMBOL(generic_file_direct_write);
3596
Nick Piggineb2be182007-10-16 01:24:57 -07003597/*
3598 * Find or create a page at the given pagecache position. Return the locked
3599 * page. This function is specifically for buffered writes.
3600 */
Nick Piggin54566b22009-01-04 12:00:53 -08003601struct page *grab_cache_page_write_begin(struct address_space *mapping,
3602 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003603{
Nick Piggineb2be182007-10-16 01:24:57 -07003604 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003605 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003606
Nick Piggin54566b22009-01-04 12:00:53 -08003607 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003608 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003609
Mel Gorman2457aec2014-06-04 16:10:31 -07003610 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003611 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003612 if (page)
3613 wait_for_stable_page(page);
3614
Nick Piggineb2be182007-10-16 01:24:57 -07003615 return page;
3616}
Nick Piggin54566b22009-01-04 12:00:53 -08003617EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003618
Al Viro3b93f912014-02-11 21:34:08 -05003619ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003620 struct iov_iter *i, loff_t pos)
3621{
3622 struct address_space *mapping = file->f_mapping;
3623 const struct address_space_operations *a_ops = mapping->a_ops;
3624 long status = 0;
3625 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003626 unsigned int flags = 0;
3627
Nick Pigginafddba42007-10-16 01:25:01 -07003628 do {
3629 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003630 unsigned long offset; /* Offset into pagecache page */
3631 unsigned long bytes; /* Bytes to write to page */
3632 size_t copied; /* Bytes copied from user */
3633 void *fsdata;
3634
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003635 offset = (pos & (PAGE_SIZE - 1));
3636 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003637 iov_iter_count(i));
3638
3639again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003640 /*
3641 * Bring in the user page that we will copy from _first_.
3642 * Otherwise there's a nasty deadlock on copying from the
3643 * same page as we're writing to, without it being marked
3644 * up-to-date.
Linus Torvalds00a3d662015-10-07 08:32:38 +01003645 */
3646 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3647 status = -EFAULT;
3648 break;
3649 }
3650
Jan Kara296291c2015-10-22 13:32:21 -07003651 if (fatal_signal_pending(current)) {
3652 status = -EINTR;
3653 break;
3654 }
3655
Nick Piggin674b8922007-10-16 01:25:03 -07003656 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003657 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003658 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003659 break;
3660
anfei zhou931e80e2010-02-02 13:44:02 -08003661 if (mapping_writably_mapped(mapping))
3662 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003663
Al Virof0b65f32021-04-30 10:26:41 -04003664 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
Nick Pigginafddba42007-10-16 01:25:01 -07003665 flush_dcache_page(page);
3666
3667 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3668 page, fsdata);
Al Virof0b65f32021-04-30 10:26:41 -04003669 if (unlikely(status != copied)) {
3670 iov_iter_revert(i, copied - max(status, 0L));
3671 if (unlikely(status < 0))
3672 break;
3673 }
Nick Pigginafddba42007-10-16 01:25:01 -07003674 cond_resched();
3675
Al Virobc1bb412021-05-31 00:32:44 -04003676 if (unlikely(status == 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07003677 /*
Al Virobc1bb412021-05-31 00:32:44 -04003678 * A short copy made ->write_end() reject the
3679 * thing entirely. Might be memory poisoning
3680 * halfway through, might be a race with munmap,
3681 * might be severe memory pressure.
Nick Pigginafddba42007-10-16 01:25:01 -07003682 */
Al Virobc1bb412021-05-31 00:32:44 -04003683 if (copied)
3684 bytes = copied;
Nick Pigginafddba42007-10-16 01:25:01 -07003685 goto again;
3686 }
Al Virof0b65f32021-04-30 10:26:41 -04003687 pos += status;
3688 written += status;
Nick Pigginafddba42007-10-16 01:25:01 -07003689
3690 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003691 } while (iov_iter_count(i));
3692
3693 return written ? written : status;
3694}
Al Viro3b93f912014-02-11 21:34:08 -05003695EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003696
Jan Karae4dd9de2009-08-17 18:10:06 +02003697/**
Al Viro81742022014-04-03 03:17:43 -04003698 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003699 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003700 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003701 *
3702 * This function does all the work needed for actually writing data to a
3703 * file. It does all basic checks, removes SUID from the file, updates
3704 * modification times and calls proper subroutines depending on whether we
3705 * do direct IO or a standard buffered write.
3706 *
3707 * It expects i_mutex to be grabbed unless we work on a block device or similar
3708 * object which does not need locking at all.
3709 *
3710 * This function does *not* take care of syncing data in case of O_SYNC write.
3711 * A caller has to handle it. This is mainly due to the fact that we want to
3712 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003713 *
3714 * Return:
3715 * * number of bytes written, even for truncated writes
3716 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003717 */
Al Viro81742022014-04-03 03:17:43 -04003718ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003719{
3720 struct file *file = iocb->ki_filp;
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003721 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003722 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003723 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003724 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003725 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003726
Linus Torvalds1da177e2005-04-16 15:20:36 -07003727 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003728 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003729 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003730 if (err)
3731 goto out;
3732
Josef Bacikc3b2da32012-03-26 09:59:21 -04003733 err = file_update_time(file);
3734 if (err)
3735 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003736
Al Viro2ba48ce2015-04-09 13:52:01 -04003737 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003738 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003739
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003740 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003741 /*
3742 * If the write stopped short of completing, fall back to
3743 * buffered writes. Some filesystems do this for writes to
3744 * holes, for example. For DAX files, a buffered write will
3745 * not succeed (even if it did, DAX does not handle dirty
3746 * page-cache pages correctly).
3747 */
Al Viro0b8def92015-04-07 10:22:53 -04003748 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003749 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003750
Al Viro0b8def92015-04-07 10:22:53 -04003751 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003752 /*
Al Viro3b93f912014-02-11 21:34:08 -05003753 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003754 * then we want to return the number of bytes which were
3755 * direct-written, or the error code if that was zero. Note
3756 * that this differs from normal direct-io semantics, which
3757 * will return -EFOO even if some bytes were written.
3758 */
Al Viro60bb4522014-08-08 12:39:16 -04003759 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003760 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003761 goto out;
3762 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003763 /*
3764 * We need to ensure that the page cache pages are written to
3765 * disk and invalidated to preserve the expected O_DIRECT
3766 * semantics.
3767 */
Al Viro3b93f912014-02-11 21:34:08 -05003768 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003769 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003770 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003771 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003772 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003773 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003774 pos >> PAGE_SHIFT,
3775 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003776 } else {
3777 /*
3778 * We don't know how much we wrote, so just return
3779 * the number of bytes which were direct-written
3780 */
3781 }
3782 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003783 written = generic_perform_write(file, from, iocb->ki_pos);
3784 if (likely(written > 0))
3785 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003786 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003787out:
3788 current->backing_dev_info = NULL;
3789 return written ? written : err;
3790}
Al Viro81742022014-04-03 03:17:43 -04003791EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003792
Jan Karae4dd9de2009-08-17 18:10:06 +02003793/**
Al Viro81742022014-04-03 03:17:43 -04003794 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003795 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003796 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003797 *
Al Viro81742022014-04-03 03:17:43 -04003798 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003799 * filesystems. It takes care of syncing the file in case of O_SYNC file
3800 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003801 * Return:
3802 * * negative error code if no data has been written at all of
3803 * vfs_fsync_range() failed for a synchronous write
3804 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003805 */
Al Viro81742022014-04-03 03:17:43 -04003806ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003807{
3808 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003809 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003810 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003811
Al Viro59551022016-01-22 15:40:57 -05003812 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003813 ret = generic_write_checks(iocb, from);
3814 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003815 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003816 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003817
Christoph Hellwige2592212016-04-07 08:52:01 -07003818 if (ret > 0)
3819 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003820 return ret;
3821}
Al Viro81742022014-04-03 03:17:43 -04003822EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003823
David Howellscf9a2ae2006-08-29 19:05:54 +01003824/**
3825 * try_to_release_page() - release old fs-specific metadata on a page
3826 *
3827 * @page: the page which the kernel is trying to free
3828 * @gfp_mask: memory allocation flags (and I/O mode)
3829 *
3830 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003831 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003832 *
David Howells266cf652009-04-03 16:42:36 +01003833 * This may also be called if PG_fscache is set on a page, indicating that the
3834 * page is known to the local caching routines.
3835 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003836 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003837 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003838 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003839 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003840 */
3841int try_to_release_page(struct page *page, gfp_t gfp_mask)
3842{
3843 struct address_space * const mapping = page->mapping;
3844
3845 BUG_ON(!PageLocked(page));
3846 if (PageWriteback(page))
3847 return 0;
3848
3849 if (mapping && mapping->a_ops->releasepage)
3850 return mapping->a_ops->releasepage(page, gfp_mask);
3851 return try_to_free_buffers(page);
3852}
3853
3854EXPORT_SYMBOL(try_to_release_page);