blob: 034d370d4ebb5bc72c92aac1fdd2de0b55553403 [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/**
Josef Bacik5a798492021-07-14 14:47:22 -0400381 * filemap_fdatawrite_wbc - start writeback on mapping dirty pages in range
382 * @mapping: address space structure to write
383 * @wbc: the writeback_control controlling the writeout
384 *
385 * Call writepages on the mapping using the provided wbc to control the
386 * writeout.
387 *
388 * Return: %0 on success, negative error code otherwise.
389 */
390int filemap_fdatawrite_wbc(struct address_space *mapping,
391 struct writeback_control *wbc)
392{
393 int ret;
394
395 if (!mapping_can_writeback(mapping) ||
396 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
397 return 0;
398
399 wbc_attach_fdatawrite_inode(wbc, mapping->host);
400 ret = do_writepages(mapping, wbc);
401 wbc_detach_inode(wbc);
402 return ret;
403}
404EXPORT_SYMBOL(filemap_fdatawrite_wbc);
405
406/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700407 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700408 * @mapping: address space structure to write
409 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800410 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700411 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700413 * Start writeback against all of a mapping's dirty pages that lie
414 * within the byte offsets <start, end> inclusive.
415 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700417 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 * these two operations is that if a dirty page/buffer is encountered, it must
419 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800420 *
421 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800423int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
424 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 struct writeback_control wbc = {
427 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800428 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700429 .range_start = start,
430 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 };
432
Josef Bacik5a798492021-07-14 14:47:22 -0400433 return filemap_fdatawrite_wbc(mapping, &wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434}
435
436static inline int __filemap_fdatawrite(struct address_space *mapping,
437 int sync_mode)
438{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700439 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440}
441
442int filemap_fdatawrite(struct address_space *mapping)
443{
444 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
445}
446EXPORT_SYMBOL(filemap_fdatawrite);
447
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400448int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800449 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
451 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
452}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400453EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Randy Dunlap485bb992006-06-23 02:03:49 -0700455/**
456 * filemap_flush - mostly a non-blocking flush
457 * @mapping: target address_space
458 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 * This is a mostly non-blocking flush. Not suitable for data-integrity
460 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800461 *
462 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 */
464int filemap_flush(struct address_space *mapping)
465{
466 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
467}
468EXPORT_SYMBOL(filemap_flush);
469
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500470/**
471 * filemap_range_has_page - check if a page exists in range.
472 * @mapping: address space within which to check
473 * @start_byte: offset in bytes where the range starts
474 * @end_byte: offset in bytes where the range ends (inclusive)
475 *
476 * Find at least one page in the range supplied, usually used to check if
477 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800478 *
479 * Return: %true if at least one page exists in the specified range,
480 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500481 */
482bool filemap_range_has_page(struct address_space *mapping,
483 loff_t start_byte, loff_t end_byte)
484{
Jan Karaf7b68042017-09-06 16:21:40 -0700485 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500486 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
487 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500488
489 if (end_byte < start_byte)
490 return false;
491
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500492 rcu_read_lock();
493 for (;;) {
494 page = xas_find(&xas, max);
495 if (xas_retry(&xas, page))
496 continue;
497 /* Shadow entries don't count */
498 if (xa_is_value(page))
499 continue;
500 /*
501 * We don't need to try to pin this page; we're about to
502 * release the RCU lock anyway. It is enough to know that
503 * there was a page here recently.
504 */
505 break;
506 }
507 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500508
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500509 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500510}
511EXPORT_SYMBOL(filemap_range_has_page);
512
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400513static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800514 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300516 pgoff_t index = start_byte >> PAGE_SHIFT;
517 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 struct pagevec pvec;
519 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200521 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400522 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Mel Gorman86679822017-11-15 17:37:52 -0800524 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800525 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 unsigned i;
527
Jan Kara312e9d22017-11-15 17:35:05 -0800528 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800529 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800530 if (!nr_pages)
531 break;
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 for (i = 0; i < nr_pages; i++) {
534 struct page *page = pvec.pages[i];
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400537 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 }
539 pagevec_release(&pvec);
540 cond_resched();
541 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800542}
543
544/**
545 * filemap_fdatawait_range - wait for writeback to complete
546 * @mapping: address space structure to wait for
547 * @start_byte: offset in bytes where the range starts
548 * @end_byte: offset in bytes where the range ends (inclusive)
549 *
550 * Walk the list of under-writeback pages of the given address space
551 * in the given range and wait for all of them. Check error status of
552 * the address space and return it.
553 *
554 * Since the error status of the address space is cleared by this function,
555 * callers are responsible for checking the return value and handling and/or
556 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800557 *
558 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800559 */
560int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
561 loff_t end_byte)
562{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400563 __filemap_fdatawait_range(mapping, start_byte, end_byte);
564 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200566EXPORT_SYMBOL(filemap_fdatawait_range);
567
568/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400569 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
570 * @mapping: address space structure to wait for
571 * @start_byte: offset in bytes where the range starts
572 * @end_byte: offset in bytes where the range ends (inclusive)
573 *
574 * Walk the list of under-writeback pages of the given address space in the
575 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
576 * this function does not clear error status of the address space.
577 *
578 * Use this function if callers don't handle errors themselves. Expected
579 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
580 * fsfreeze(8)
581 */
582int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
583 loff_t start_byte, loff_t end_byte)
584{
585 __filemap_fdatawait_range(mapping, start_byte, end_byte);
586 return filemap_check_and_keep_errors(mapping);
587}
588EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
589
590/**
Jeff Laytona823e452017-07-28 07:24:43 -0400591 * file_fdatawait_range - wait for writeback to complete
592 * @file: file pointing to address space structure to wait for
593 * @start_byte: offset in bytes where the range starts
594 * @end_byte: offset in bytes where the range ends (inclusive)
595 *
596 * Walk the list of under-writeback pages of the address space that file
597 * refers to, in the given range and wait for all of them. Check error
598 * status of the address space vs. the file->f_wb_err cursor and return it.
599 *
600 * Since the error status of the file is advanced by this function,
601 * callers are responsible for checking the return value and handling and/or
602 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800603 *
604 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400605 */
606int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
607{
608 struct address_space *mapping = file->f_mapping;
609
610 __filemap_fdatawait_range(mapping, start_byte, end_byte);
611 return file_check_and_advance_wb_err(file);
612}
613EXPORT_SYMBOL(file_fdatawait_range);
614
615/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800616 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
617 * @mapping: address space structure to wait for
618 *
619 * Walk the list of under-writeback pages of the given address space
620 * and wait for all of them. Unlike filemap_fdatawait(), this function
621 * does not clear error status of the address space.
622 *
623 * Use this function if callers don't handle errors themselves. Expected
624 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
625 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800626 *
627 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800628 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400629int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800630{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400631 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400632 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800633}
Jeff Layton76341ca2017-07-06 07:02:22 -0400634EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800635
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700636/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400637static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700639 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Randy Dunlap485bb992006-06-23 02:03:49 -0700642/**
Jens Axboe63135aa2021-04-29 22:55:18 -0700643 * filemap_range_needs_writeback - check if range potentially needs writeback
644 * @mapping: address space within which to check
645 * @start_byte: offset in bytes where the range starts
646 * @end_byte: offset in bytes where the range ends (inclusive)
647 *
648 * Find at least one page in the range supplied, usually used to check if
649 * direct writing in this range will trigger a writeback. Used by O_DIRECT
650 * read/write with IOCB_NOWAIT, to see if the caller needs to do
651 * filemap_write_and_wait_range() before proceeding.
652 *
653 * Return: %true if the caller should do filemap_write_and_wait_range() before
654 * doing O_DIRECT to a page in this range, %false otherwise.
655 */
656bool filemap_range_needs_writeback(struct address_space *mapping,
657 loff_t start_byte, loff_t end_byte)
658{
659 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
660 pgoff_t max = end_byte >> PAGE_SHIFT;
661 struct page *page;
662
663 if (!mapping_needs_writeback(mapping))
664 return false;
665 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
666 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
667 return false;
668 if (end_byte < start_byte)
669 return false;
670
671 rcu_read_lock();
672 xas_for_each(&xas, page, max) {
673 if (xas_retry(&xas, page))
674 continue;
675 if (xa_is_value(page))
676 continue;
677 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
678 break;
679 }
680 rcu_read_unlock();
681 return page != NULL;
682}
683EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
684
685/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700686 * filemap_write_and_wait_range - write out & wait on a file range
687 * @mapping: the address_space for the pages
688 * @lstart: offset in bytes where the range starts
689 * @lend: offset in bytes where the range ends (inclusive)
690 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800691 * Write out and wait upon file offsets lstart->lend, inclusive.
692 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300693 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800694 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800695 *
696 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800697 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698int filemap_write_and_wait_range(struct address_space *mapping,
699 loff_t lstart, loff_t lend)
700{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800701 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Jeff Layton9326c9b2017-07-26 10:21:11 -0400703 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800704 err = __filemap_fdatawrite_range(mapping, lstart, lend,
705 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800706 /*
707 * Even if the above returned error, the pages may be
708 * written partially (e.g. -ENOSPC), so we wait for it.
709 * But the -EIO is special case, it may indicate the worst
710 * thing (e.g. bug) happened, so we avoid waiting for it.
711 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800712 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200713 int err2 = filemap_fdatawait_range(mapping,
714 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800715 if (!err)
716 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400717 } else {
718 /* Clear any previously stored errors */
719 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800720 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700721 } else {
722 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800724 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725}
Chris Masonf6995582009-04-15 13:22:37 -0400726EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
Jeff Layton5660e132017-07-06 07:02:25 -0400728void __filemap_set_wb_err(struct address_space *mapping, int err)
729{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400730 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400731
732 trace_filemap_set_wb_err(mapping, eseq);
733}
734EXPORT_SYMBOL(__filemap_set_wb_err);
735
736/**
737 * file_check_and_advance_wb_err - report wb error (if any) that was previously
738 * and advance wb_err to current one
739 * @file: struct file on which the error is being reported
740 *
741 * When userland calls fsync (or something like nfsd does the equivalent), we
742 * want to report any writeback errors that occurred since the last fsync (or
743 * since the file was opened if there haven't been any).
744 *
745 * Grab the wb_err from the mapping. If it matches what we have in the file,
746 * then just quickly return 0. The file is all caught up.
747 *
748 * If it doesn't match, then take the mapping value, set the "seen" flag in
749 * it and try to swap it into place. If it works, or another task beat us
750 * to it with the new value, then update the f_wb_err and return the error
751 * portion. The error at this point must be reported via proper channels
752 * (a'la fsync, or NFS COMMIT operation, etc.).
753 *
754 * While we handle mapping->wb_err with atomic operations, the f_wb_err
755 * value is protected by the f_lock since we must ensure that it reflects
756 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800757 *
758 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400759 */
760int file_check_and_advance_wb_err(struct file *file)
761{
762 int err = 0;
763 errseq_t old = READ_ONCE(file->f_wb_err);
764 struct address_space *mapping = file->f_mapping;
765
766 /* Locklessly handle the common case where nothing has changed */
767 if (errseq_check(&mapping->wb_err, old)) {
768 /* Something changed, must use slow path */
769 spin_lock(&file->f_lock);
770 old = file->f_wb_err;
771 err = errseq_check_and_advance(&mapping->wb_err,
772 &file->f_wb_err);
773 trace_file_check_and_advance_wb_err(file, old);
774 spin_unlock(&file->f_lock);
775 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700776
777 /*
778 * We're mostly using this function as a drop in replacement for
779 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
780 * that the legacy code would have had on these flags.
781 */
782 clear_bit(AS_EIO, &mapping->flags);
783 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400784 return err;
785}
786EXPORT_SYMBOL(file_check_and_advance_wb_err);
787
788/**
789 * file_write_and_wait_range - write out & wait on a file range
790 * @file: file pointing to address_space with pages
791 * @lstart: offset in bytes where the range starts
792 * @lend: offset in bytes where the range ends (inclusive)
793 *
794 * Write out and wait upon file offsets lstart->lend, inclusive.
795 *
796 * Note that @lend is inclusive (describes the last byte to be written) so
797 * that this function can be used to write to the very end-of-file (end = -1).
798 *
799 * After writing out and waiting on the data, we check and advance the
800 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800801 *
802 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400803 */
804int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
805{
806 int err = 0, err2;
807 struct address_space *mapping = file->f_mapping;
808
Jeff Layton9326c9b2017-07-26 10:21:11 -0400809 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400810 err = __filemap_fdatawrite_range(mapping, lstart, lend,
811 WB_SYNC_ALL);
812 /* See comment of filemap_write_and_wait() */
813 if (err != -EIO)
814 __filemap_fdatawait_range(mapping, lstart, lend);
815 }
816 err2 = file_check_and_advance_wb_err(file);
817 if (!err)
818 err = err2;
819 return err;
820}
821EXPORT_SYMBOL(file_write_and_wait_range);
822
Randy Dunlap485bb992006-06-23 02:03:49 -0700823/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700824 * replace_page_cache_page - replace a pagecache page with a new one
825 * @old: page to be replaced
826 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700827 *
828 * This function replaces a page in the pagecache with a new one. On
829 * success it acquires the pagecache reference for the new page and
830 * drops it for the old page. Both the old and new pages must be
831 * locked. This function does not add the new page to the LRU, the
832 * caller must do that.
833 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500834 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700835 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800836void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700837{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500838 struct address_space *mapping = old->mapping;
839 void (*freepage)(struct page *) = mapping->a_ops->freepage;
840 pgoff_t offset = old->index;
841 XA_STATE(xas, &mapping->i_pages, offset);
842 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700843
Sasha Levin309381fea2014-01-23 15:52:54 -0800844 VM_BUG_ON_PAGE(!PageLocked(old), old);
845 VM_BUG_ON_PAGE(!PageLocked(new), new);
846 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700847
Matthew Wilcox74d60952017-11-17 10:01:45 -0500848 get_page(new);
849 new->mapping = mapping;
850 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700851
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700852 mem_cgroup_migrate(old, new);
853
Matthew Wilcox74d60952017-11-17 10:01:45 -0500854 xas_lock_irqsave(&xas, flags);
855 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700856
Matthew Wilcox74d60952017-11-17 10:01:45 -0500857 old->mapping = NULL;
858 /* hugetlb pages do not participate in page cache accounting. */
859 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700860 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500861 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700862 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500863 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700864 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500865 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700866 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500867 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500868 if (freepage)
869 freepage(old);
870 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700871}
872EXPORT_SYMBOL_GPL(replace_page_cache_page);
873
Andrew Morton16c0cc02020-12-11 13:36:27 -0800874noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700875 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700876 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700877 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500879 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700880 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700881 int error;
Waiman Longda742402021-02-04 18:32:45 -0800882 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700883
Sasha Levin309381fea2014-01-23 15:52:54 -0800884 VM_BUG_ON_PAGE(!PageLocked(page), page);
885 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500886 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700887
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300888 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700889 page->mapping = mapping;
890 page->index = offset;
891
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700892 if (!huge) {
Dan Schatzberg04f94e32021-06-28 19:38:18 -0700893 error = mem_cgroup_charge(page, NULL, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700894 if (error)
895 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800896 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700897 }
898
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700899 gfp &= GFP_RECLAIM_MASK;
900
Matthew Wilcox74d60952017-11-17 10:01:45 -0500901 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700902 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
903 void *entry, *old = NULL;
904
905 if (order > thp_order(page))
906 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
907 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500908 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700909 xas_for_each_conflict(&xas, entry) {
910 old = entry;
911 if (!xa_is_value(entry)) {
912 xas_set_err(&xas, -EEXIST);
913 goto unlock;
914 }
915 }
916
917 if (old) {
918 if (shadowp)
919 *shadowp = old;
920 /* entry may have been split before we acquired lock */
921 order = xa_get_order(xas.xa, xas.xa_index);
922 if (order > thp_order(page)) {
923 xas_split(&xas, old, order);
924 xas_reset(&xas);
925 }
926 }
927
Matthew Wilcox74d60952017-11-17 10:01:45 -0500928 xas_store(&xas, page);
929 if (xas_error(&xas))
930 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700931
Matthew Wilcox74d60952017-11-17 10:01:45 -0500932 mapping->nrpages++;
933
934 /* hugetlb pages do not participate in page cache accounting */
935 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700936 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500937unlock:
938 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700939 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500940
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700941 if (xas_error(&xas)) {
942 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800943 if (charged)
944 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500945 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700946 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500947
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700948 trace_mm_filemap_add_to_page_cache(page);
949 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500950error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700951 page->mapping = NULL;
952 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300953 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700954 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700956ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700957
958/**
959 * add_to_page_cache_locked - add a locked page to the pagecache
960 * @page: page to add
961 * @mapping: the page's address_space
962 * @offset: page index
963 * @gfp_mask: page allocation mode
964 *
965 * This function is used to add a page to the pagecache. It must be locked.
966 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800967 *
968 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700969 */
970int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
971 pgoff_t offset, gfp_t gfp_mask)
972{
973 return __add_to_page_cache_locked(page, mapping, offset,
974 gfp_mask, NULL);
975}
Nick Piggine2867812008-07-25 19:45:30 -0700976EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
978int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400979 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980{
Johannes Weinera5289102014-04-03 14:47:51 -0700981 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700982 int ret;
983
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800984 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700985 ret = __add_to_page_cache_locked(page, mapping, offset,
986 gfp_mask, &shadow);
987 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800988 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700989 else {
990 /*
991 * The page might have been evicted from cache only
992 * recently, in which case it should be activated like
993 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700994 * The exception is pages getting rewritten; evicting other
995 * data from the working set, only to cache data that will
996 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700997 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700998 WARN_ON_ONCE(PageActive(page));
999 if (!(gfp_mask & __GFP_WRITE) && shadow)
1000 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -07001001 lru_cache_add(page);
1002 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 return ret;
1004}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001005EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Paul Jackson44110fe2006-03-24 03:16:04 -08001007#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -07001008struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -08001009{
Miao Xiec0ff7452010-05-24 14:32:08 -07001010 int n;
1011 struct page *page;
1012
Paul Jackson44110fe2006-03-24 03:16:04 -08001013 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -07001014 unsigned int cpuset_mems_cookie;
1015 do {
Mel Gormand26914d2014-04-03 14:47:24 -07001016 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -07001017 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -07001018 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -07001019 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -07001020
Miao Xiec0ff7452010-05-24 14:32:08 -07001021 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -08001022 }
Nick Piggin2ae88142006-10-28 10:38:23 -07001023 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -08001024}
Nick Piggin2ae88142006-10-28 10:38:23 -07001025EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -08001026#endif
1027
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028/*
1029 * In order to wait for pages to become available there must be
1030 * waitqueues associated with pages. By using a hash table of
1031 * waitqueues where the bucket discipline is to maintain all
1032 * waiters on the same queue and wake all when any of the pages
1033 * become available, and for the woken contexts to check to be
1034 * sure the appropriate page became available, this saves space
1035 * at a cost of "thundering herd" phenomena during rare hash
1036 * collisions.
1037 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001038#define PAGE_WAIT_TABLE_BITS 8
1039#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1040static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1041
1042static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001043{
Nicholas Piggin62906022016-12-25 13:00:30 +10001044 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045}
Nicholas Piggin62906022016-12-25 13:00:30 +10001046
1047void __init pagecache_init(void)
1048{
1049 int i;
1050
1051 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1052 init_waitqueue_head(&page_wait_table[i]);
1053
1054 page_writeback_init();
1055}
1056
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001057/*
1058 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001059 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001060 * one.
1061 *
1062 * We have:
1063 *
1064 * (a) no special bits set:
1065 *
1066 * We're just waiting for the bit to be released, and when a waker
1067 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1068 * and remove it from the wait queue.
1069 *
1070 * Simple and straightforward.
1071 *
1072 * (b) WQ_FLAG_EXCLUSIVE:
1073 *
1074 * The waiter is waiting to get the lock, and only one waiter should
1075 * be woken up to avoid any thundering herd behavior. We'll set the
1076 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1077 *
1078 * This is the traditional exclusive wait.
1079 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001080 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001081 *
1082 * The waiter is waiting to get the bit, and additionally wants the
1083 * lock to be transferred to it for fair lock behavior. If the lock
1084 * cannot be taken, we stop walking the wait queue without waking
1085 * the waiter.
1086 *
1087 * This is the "fair lock handoff" case, and in addition to setting
1088 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1089 * that it now has the lock.
1090 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001091static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001092{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001093 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001094 struct wait_page_key *key = arg;
1095 struct wait_page_queue *wait_page
1096 = container_of(wait, struct wait_page_queue, wait);
1097
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001098 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001099 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001100
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001101 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001102 * If it's a lock handoff wait, we get the bit for it, and
1103 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001104 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001105 flags = wait->flags;
1106 if (flags & WQ_FLAG_EXCLUSIVE) {
1107 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001108 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001109 if (flags & WQ_FLAG_CUSTOM) {
1110 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1111 return -1;
1112 flags |= WQ_FLAG_DONE;
1113 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001114 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001115
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001116 /*
1117 * We are holding the wait-queue lock, but the waiter that
1118 * is waiting for this will be checking the flags without
1119 * any locking.
1120 *
1121 * So update the flags atomically, and wake up the waiter
1122 * afterwards to avoid any races. This store-release pairs
1123 * with the load-acquire in wait_on_page_bit_common().
1124 */
1125 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001126 wake_up_state(wait->private, mode);
1127
1128 /*
1129 * Ok, we have successfully done what we're waiting for,
1130 * and we can unconditionally remove the wait entry.
1131 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001132 * Note that this pairs with the "finish_wait()" in the
1133 * waiter, and has to be the absolute last thing we do.
1134 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001135 * might be de-allocated and the process might even have
1136 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001137 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001138 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001139 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001140}
1141
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001142static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001143{
1144 wait_queue_head_t *q = page_waitqueue(page);
1145 struct wait_page_key key;
1146 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001147 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001148
1149 key.page = page;
1150 key.bit_nr = bit_nr;
1151 key.page_match = 0;
1152
Tim Chen11a19c72017-08-25 09:13:55 -07001153 bookmark.flags = 0;
1154 bookmark.private = NULL;
1155 bookmark.func = NULL;
1156 INIT_LIST_HEAD(&bookmark.entry);
1157
Nicholas Piggin62906022016-12-25 13:00:30 +10001158 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001159 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1160
1161 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1162 /*
1163 * Take a breather from holding the lock,
1164 * allow pages that finish wake up asynchronously
1165 * to acquire the lock and remove themselves
1166 * from wait queue
1167 */
1168 spin_unlock_irqrestore(&q->lock, flags);
1169 cpu_relax();
1170 spin_lock_irqsave(&q->lock, flags);
1171 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1172 }
1173
Nicholas Piggin62906022016-12-25 13:00:30 +10001174 /*
1175 * It is possible for other pages to have collided on the waitqueue
1176 * hash, so in that case check for a page match. That prevents a long-
1177 * term waiter
1178 *
1179 * It is still possible to miss a case here, when we woke page waiters
1180 * and removed them from the waitqueue, but there are still other
1181 * page waiters.
1182 */
1183 if (!waitqueue_active(q) || !key.page_match) {
1184 ClearPageWaiters(page);
1185 /*
1186 * It's possible to miss clearing Waiters here, when we woke
1187 * our page waiters, but the hashed waitqueue has waiters for
1188 * other pages on it.
1189 *
1190 * That's okay, it's a rare case. The next waker will clear it.
1191 */
1192 }
1193 spin_unlock_irqrestore(&q->lock, flags);
1194}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001195
1196static void wake_up_page(struct page *page, int bit)
1197{
1198 if (!PageWaiters(page))
1199 return;
1200 wake_up_page_bit(page, bit);
1201}
Nicholas Piggin62906022016-12-25 13:00:30 +10001202
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001203/*
1204 * A choice of three behaviors for wait_on_page_bit_common():
1205 */
1206enum behavior {
1207 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1208 * __lock_page() waiting on then setting PG_locked.
1209 */
1210 SHARED, /* Hold ref to page and check the bit when woken, like
1211 * wait_on_page_writeback() waiting on PG_writeback.
1212 */
1213 DROP, /* Drop ref to page before wait, no check when woken,
1214 * like put_and_wait_on_page_locked() on PG_locked.
1215 */
1216};
1217
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001218/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001219 * Attempt to check (or get) the page bit, and mark us done
1220 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001221 */
1222static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1223 struct wait_queue_entry *wait)
1224{
1225 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1226 if (test_and_set_bit(bit_nr, &page->flags))
1227 return false;
1228 } else if (test_bit(bit_nr, &page->flags))
1229 return false;
1230
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001231 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001232 return true;
1233}
1234
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001235/* How many times do we accept lock stealing from under a waiter? */
1236int sysctl_page_lock_unfairness = 5;
1237
Nicholas Piggin62906022016-12-25 13:00:30 +10001238static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001239 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001240{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001241 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001242 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001243 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001244 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001245 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001246 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001247
Johannes Weinereb414682018-10-26 15:06:27 -07001248 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001249 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001250 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001251 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001252 delayacct = true;
1253 }
Johannes Weinereb414682018-10-26 15:06:27 -07001254 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001255 thrashing = true;
1256 }
1257
Nicholas Piggin62906022016-12-25 13:00:30 +10001258 init_wait(wait);
1259 wait->func = wake_page_function;
1260 wait_page.page = page;
1261 wait_page.bit_nr = bit_nr;
1262
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001263repeat:
1264 wait->flags = 0;
1265 if (behavior == EXCLUSIVE) {
1266 wait->flags = WQ_FLAG_EXCLUSIVE;
1267 if (--unfairness < 0)
1268 wait->flags |= WQ_FLAG_CUSTOM;
1269 }
1270
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001271 /*
1272 * Do one last check whether we can get the
1273 * page bit synchronously.
1274 *
1275 * Do the SetPageWaiters() marking before that
1276 * to let any waker we _just_ missed know they
1277 * need to wake us up (otherwise they'll never
1278 * even go to the slow case that looks at the
1279 * page queue), and add ourselves to the wait
1280 * queue if we need to sleep.
1281 *
1282 * This part needs to be done under the queue
1283 * lock to avoid races.
1284 */
1285 spin_lock_irq(&q->lock);
1286 SetPageWaiters(page);
1287 if (!trylock_page_bit_common(page, bit_nr, wait))
1288 __add_wait_queue_entry_tail(q, wait);
1289 spin_unlock_irq(&q->lock);
1290
1291 /*
1292 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001293 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1294 * see whether the page bit testing has already
1295 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001296 *
1297 * We can drop our reference to the page.
1298 */
1299 if (behavior == DROP)
1300 put_page(page);
1301
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001302 /*
1303 * Note that until the "finish_wait()", or until
1304 * we see the WQ_FLAG_WOKEN flag, we need to
1305 * be very careful with the 'wait->flags', because
1306 * we may race with a waker that sets them.
1307 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001308 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001309 unsigned int flags;
1310
Nicholas Piggin62906022016-12-25 13:00:30 +10001311 set_current_state(state);
1312
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001313 /* Loop until we've been woken or interrupted */
1314 flags = smp_load_acquire(&wait->flags);
1315 if (!(flags & WQ_FLAG_WOKEN)) {
1316 if (signal_pending_state(state, current))
1317 break;
1318
1319 io_schedule();
1320 continue;
1321 }
1322
1323 /* If we were non-exclusive, we're done */
1324 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001325 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001326
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001327 /* If the waker got the lock for us, we're done */
1328 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001329 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001330
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001331 /*
1332 * Otherwise, if we're getting the lock, we need to
1333 * try to get it ourselves.
1334 *
1335 * And if that fails, we'll have to retry this all.
1336 */
1337 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1338 goto repeat;
1339
1340 wait->flags |= WQ_FLAG_DONE;
1341 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001342 }
1343
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001344 /*
1345 * If a signal happened, this 'finish_wait()' may remove the last
1346 * waiter from the wait-queues, but the PageWaiters bit will remain
1347 * set. That's ok. The next wakeup will take care of it, and trying
1348 * to do it here would be difficult and prone to races.
1349 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001350 finish_wait(q, wait);
1351
Johannes Weinereb414682018-10-26 15:06:27 -07001352 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001353 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001354 delayacct_thrashing_end();
1355 psi_memstall_leave(&pflags);
1356 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001357
Nicholas Piggin62906022016-12-25 13:00:30 +10001358 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001359 * NOTE! The wait->flags weren't stable until we've done the
1360 * 'finish_wait()', and we could have exited the loop above due
1361 * to a signal, and had a wakeup event happen after the signal
1362 * test but before the 'finish_wait()'.
1363 *
1364 * So only after the finish_wait() can we reliably determine
1365 * if we got woken up or not, so we can now figure out the final
1366 * return value based on that state without races.
1367 *
1368 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1369 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001370 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001371 if (behavior == EXCLUSIVE)
1372 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001373
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001374 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001375}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
Harvey Harrison920c7a52008-02-04 22:29:26 -08001377void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378{
Nicholas Piggin62906022016-12-25 13:00:30 +10001379 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001380 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381}
1382EXPORT_SYMBOL(wait_on_page_bit);
1383
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001384int wait_on_page_bit_killable(struct page *page, int bit_nr)
1385{
Nicholas Piggin62906022016-12-25 13:00:30 +10001386 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001387 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001388}
David Howells4343d002017-11-02 15:27:52 +00001389EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001390
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001392 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1393 * @page: The page to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001394 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001395 *
1396 * The caller should hold a reference on @page. They expect the page to
1397 * become unlocked relatively soon, but do not wish to hold up migration
1398 * (for example) by holding the reference while waiting for the page to
1399 * come unlocked. After this function returns, the caller should not
1400 * dereference @page.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001401 *
1402 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001403 */
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001404int put_and_wait_on_page_locked(struct page *page, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001405{
1406 wait_queue_head_t *q;
1407
1408 page = compound_head(page);
1409 q = page_waitqueue(page);
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001410 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001411}
1412
1413/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001414 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001415 * @page: Page defining the wait queue of interest
1416 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001417 *
1418 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1419 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001420void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001421{
1422 wait_queue_head_t *q = page_waitqueue(page);
1423 unsigned long flags;
1424
1425 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001426 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001427 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001428 spin_unlock_irqrestore(&q->lock, flags);
1429}
1430EXPORT_SYMBOL_GPL(add_page_wait_queue);
1431
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001432#ifndef clear_bit_unlock_is_negative_byte
1433
1434/*
1435 * PG_waiters is the high bit in the same byte as PG_lock.
1436 *
1437 * On x86 (and on many other architectures), we can clear PG_lock and
1438 * test the sign bit at the same time. But if the architecture does
1439 * not support that special operation, we just do this all by hand
1440 * instead.
1441 *
1442 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001443 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001444 * in the same byte as PG_locked.
1445 */
1446static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1447{
1448 clear_bit_unlock(nr, mem);
1449 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001450 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001451}
1452
1453#endif
1454
David Howells385e1ca5f2009-04-03 16:42:39 +01001455/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001456 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 * @page: the page
1458 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001459 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001460 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001461 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1463 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001464 * Note that this depends on PG_waiters being the sign bit in the byte
1465 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1466 * clear the PG_locked bit and test PG_waiters at the same time fairly
1467 * portably (architectures that do LL/SC can test any bit, while x86 can
1468 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001470void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001472 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001473 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001474 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001475 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1476 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477}
1478EXPORT_SYMBOL(unlock_page);
1479
Randy Dunlap485bb992006-06-23 02:03:49 -07001480/**
David Howells73e10de2020-02-10 10:00:21 +00001481 * end_page_private_2 - Clear PG_private_2 and release any waiters
1482 * @page: The page
1483 *
1484 * Clear the PG_private_2 bit on a page and wake up any sleepers waiting for
1485 * this. The page ref held for PG_private_2 being set is released.
1486 *
1487 * This is, for example, used when a netfs page is being written to a local
1488 * disk cache, thereby allowing writes to the cache for the same page to be
1489 * serialised.
1490 */
1491void end_page_private_2(struct page *page)
1492{
1493 page = compound_head(page);
1494 VM_BUG_ON_PAGE(!PagePrivate2(page), page);
1495 clear_bit_unlock(PG_private_2, &page->flags);
1496 wake_up_page_bit(page, PG_private_2);
1497 put_page(page);
1498}
1499EXPORT_SYMBOL(end_page_private_2);
1500
1501/**
1502 * wait_on_page_private_2 - Wait for PG_private_2 to be cleared on a page
1503 * @page: The page to wait on
1504 *
1505 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page.
1506 */
1507void wait_on_page_private_2(struct page *page)
1508{
1509 page = compound_head(page);
1510 while (PagePrivate2(page))
1511 wait_on_page_bit(page, PG_private_2);
1512}
1513EXPORT_SYMBOL(wait_on_page_private_2);
1514
1515/**
1516 * wait_on_page_private_2_killable - Wait for PG_private_2 to be cleared on a page
1517 * @page: The page to wait on
1518 *
1519 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page or until a
1520 * fatal signal is received by the calling task.
1521 *
1522 * Return:
1523 * - 0 if successful.
1524 * - -EINTR if a fatal signal was encountered.
1525 */
1526int wait_on_page_private_2_killable(struct page *page)
1527{
1528 int ret = 0;
1529
1530 page = compound_head(page);
1531 while (PagePrivate2(page)) {
1532 ret = wait_on_page_bit_killable(page, PG_private_2);
1533 if (ret < 0)
1534 break;
1535 }
1536
1537 return ret;
1538}
1539EXPORT_SYMBOL(wait_on_page_private_2_killable);
1540
1541/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001542 * end_page_writeback - end writeback against a page
1543 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 */
1545void end_page_writeback(struct page *page)
1546{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001547 /*
1548 * TestClearPageReclaim could be used here but it is an atomic
1549 * operation and overkill in this particular case. Failing to
1550 * shuffle a page marked for immediate reclaim is too mild to
1551 * justify taking an atomic operation penalty at the end of
1552 * ever page writeback.
1553 */
1554 if (PageReclaim(page)) {
1555 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001556 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001557 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001558
Hugh Dickins073861e2020-11-24 08:46:43 -08001559 /*
1560 * Writeback does not hold a page reference of its own, relying
1561 * on truncation to wait for the clearing of PG_writeback.
1562 * But here we must make sure that the page is not freed and
1563 * reused before the wake_up_page().
1564 */
1565 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001566 if (!test_clear_page_writeback(page))
1567 BUG();
1568
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001569 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001571 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572}
1573EXPORT_SYMBOL(end_page_writeback);
1574
Matthew Wilcox57d99842014-06-04 16:07:45 -07001575/*
1576 * After completing I/O on a page, call this routine to update the page
1577 * flags appropriately
1578 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001579void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001580{
Jens Axboec11f0c02016-08-05 08:11:04 -06001581 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001582 if (!err) {
1583 SetPageUptodate(page);
1584 } else {
1585 ClearPageUptodate(page);
1586 SetPageError(page);
1587 }
1588 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001589 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001590 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001591 struct address_space *mapping;
1592
Matthew Wilcox57d99842014-06-04 16:07:45 -07001593 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001594 mapping = page_mapping(page);
1595 if (mapping)
1596 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001597 }
1598 end_page_writeback(page);
1599 }
1600}
1601EXPORT_SYMBOL_GPL(page_endio);
1602
Randy Dunlap485bb992006-06-23 02:03:49 -07001603/**
1604 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001605 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001607void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608{
Nicholas Piggin62906022016-12-25 13:00:30 +10001609 struct page *page = compound_head(__page);
1610 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001611 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1612 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613}
1614EXPORT_SYMBOL(__lock_page);
1615
Nicholas Piggin62906022016-12-25 13:00:30 +10001616int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001617{
Nicholas Piggin62906022016-12-25 13:00:30 +10001618 struct page *page = compound_head(__page);
1619 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001620 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1621 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001622}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001623EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001624
Jens Axboedd3e6d52020-05-22 09:12:09 -06001625int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1626{
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001627 struct wait_queue_head *q = page_waitqueue(page);
1628 int ret = 0;
1629
1630 wait->page = page;
1631 wait->bit_nr = PG_locked;
1632
1633 spin_lock_irq(&q->lock);
1634 __add_wait_queue_entry_tail(q, &wait->wait);
1635 SetPageWaiters(page);
1636 ret = !trylock_page(page);
1637 /*
1638 * If we were successful now, we know we're still on the
1639 * waitqueue as we're still under the lock. This means it's
1640 * safe to remove and return success, we know the callback
1641 * isn't going to trigger.
1642 */
1643 if (!ret)
1644 __remove_wait_queue(q, &wait->wait);
1645 else
1646 ret = -EIOCBQUEUED;
1647 spin_unlock_irq(&q->lock);
1648 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001649}
1650
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001651/*
1652 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001653 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001654 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001655 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001656 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001657 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001658 *
1659 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001660 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001661 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001662int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1663 unsigned int flags)
1664{
Peter Xu4064b982020-04-01 21:08:45 -07001665 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001666 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001667 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001668 * even though return 0.
1669 */
1670 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1671 return 0;
1672
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001673 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001674 if (flags & FAULT_FLAG_KILLABLE)
1675 wait_on_page_locked_killable(page);
1676 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001677 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001678 return 0;
1679 }
Hailong Liu800bca72020-12-14 19:05:02 -08001680 if (flags & FAULT_FLAG_KILLABLE) {
1681 int ret;
1682
1683 ret = __lock_page_killable(page);
1684 if (ret) {
1685 mmap_read_unlock(mm);
1686 return 0;
1687 }
1688 } else {
1689 __lock_page(page);
1690 }
1691 return 1;
1692
Michel Lespinassed065bd82010-10-26 14:21:57 -07001693}
1694
Randy Dunlap485bb992006-06-23 02:03:49 -07001695/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001696 * page_cache_next_miss() - Find the next gap in the page cache.
1697 * @mapping: Mapping.
1698 * @index: Index.
1699 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001700 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001701 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1702 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001703 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001704 * This function may be called under the rcu_read_lock. However, this will
1705 * not atomically search a snapshot of the cache at a single point in time.
1706 * For example, if a gap is created at index 5, then subsequently a gap is
1707 * created at index 10, page_cache_next_miss covering both indices may
1708 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001709 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001710 * Return: The index of the gap if found, otherwise an index outside the
1711 * range specified (in which case 'return - index >= max_scan' will be true).
1712 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001713 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001714pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001715 pgoff_t index, unsigned long max_scan)
1716{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001717 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001718
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001719 while (max_scan--) {
1720 void *entry = xas_next(&xas);
1721 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001722 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001723 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001724 break;
1725 }
1726
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001727 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001728}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001729EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001730
1731/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001732 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001733 * @mapping: Mapping.
1734 * @index: Index.
1735 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001736 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001737 * Search the range [max(index - max_scan + 1, 0), index] for the
1738 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001739 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001740 * This function may be called under the rcu_read_lock. However, this will
1741 * not atomically search a snapshot of the cache at a single point in time.
1742 * For example, if a gap is created at index 10, then subsequently a gap is
1743 * created at index 5, page_cache_prev_miss() covering both indices may
1744 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001745 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001746 * Return: The index of the gap if found, otherwise an index outside the
1747 * range specified (in which case 'index - return >= max_scan' will be true).
1748 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001749 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001750pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001751 pgoff_t index, unsigned long max_scan)
1752{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001753 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001754
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001755 while (max_scan--) {
1756 void *entry = xas_prev(&xas);
1757 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001758 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001759 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001760 break;
1761 }
1762
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001763 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001764}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001765EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001766
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001767/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001768 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001769 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001770 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001771 *
Rui Sun4b17f032021-04-29 22:55:38 -07001772 * Looks up the page cache slot at @mapping & @index. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001773 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001774 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001775 * If the slot holds a shadow entry of a previously evicted page, or a
1776 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001777 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001778 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 */
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001780static struct page *mapping_get_entry(struct address_space *mapping,
1781 pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001783 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001784 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785
Nick Piggina60637c2008-07-25 19:45:31 -07001786 rcu_read_lock();
1787repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001788 xas_reset(&xas);
1789 page = xas_load(&xas);
1790 if (xas_retry(&xas, page))
1791 goto repeat;
1792 /*
1793 * A shadow entry of a recently evicted page, or a swap entry from
1794 * shmem/tmpfs. Return it without attempting to raise page count.
1795 */
1796 if (!page || xa_is_value(page))
1797 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001798
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001799 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001800 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001801
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001802 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001803 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001804 * This is part of the lockless pagecache protocol. See
1805 * include/linux/pagemap.h for details.
1806 */
1807 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001808 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001809 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001810 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001811out:
Nick Piggina60637c2008-07-25 19:45:31 -07001812 rcu_read_unlock();
1813
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 return page;
1815}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
Randy Dunlap485bb992006-06-23 02:03:49 -07001817/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001818 * pagecache_get_page - Find and get a reference to a page.
1819 * @mapping: The address_space to search.
1820 * @index: The page index.
1821 * @fgp_flags: %FGP flags modify how the page is returned.
1822 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001823 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001824 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001825 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001826 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001827 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001828 * * %FGP_ACCESSED - The page will be marked accessed.
1829 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001830 * * %FGP_HEAD - If the page is present and a THP, return the head page
1831 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001832 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
1833 * instead of allocating a new page to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001834 * * %FGP_CREAT - If no page is present then a new page is allocated using
1835 * @gfp_mask and added to the page cache and the VM's LRU list.
1836 * The page is returned locked and with an increased refcount.
1837 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1838 * page is already in cache. If the page was allocated, unlock it before
1839 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001840 * * %FGP_WRITE - The page will be written
1841 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1842 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001843 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001844 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1845 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001846 *
1847 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001848 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001849 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001850 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001851struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1852 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853{
Nick Piggineb2be182007-10-16 01:24:57 -07001854 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001855
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856repeat:
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001857 page = mapping_get_entry(mapping, index);
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001858 if (xa_is_value(page)) {
1859 if (fgp_flags & FGP_ENTRY)
1860 return page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001861 page = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001862 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001863 if (!page)
1864 goto no_page;
1865
1866 if (fgp_flags & FGP_LOCK) {
1867 if (fgp_flags & FGP_NOWAIT) {
1868 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001869 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001870 return NULL;
1871 }
1872 } else {
1873 lock_page(page);
1874 }
1875
1876 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001877 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001878 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001879 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001880 goto repeat;
1881 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001882 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001883 }
1884
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001885 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001886 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001887 else if (fgp_flags & FGP_WRITE) {
1888 /* Clear idle flag for buffer write */
1889 if (page_is_idle(page))
1890 clear_page_idle(page);
1891 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001892 if (!(fgp_flags & FGP_HEAD))
1893 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001894
1895no_page:
1896 if (!page && (fgp_flags & FGP_CREAT)) {
1897 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001898 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001899 gfp_mask |= __GFP_WRITE;
1900 if (fgp_flags & FGP_NOFS)
1901 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001902
Michal Hocko45f87de2014-12-29 20:30:35 +01001903 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001904 if (!page)
1905 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001906
Josef Bacika75d4c32019-03-13 11:44:14 -07001907 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001908 fgp_flags |= FGP_LOCK;
1909
Hugh Dickinseb39d612014-08-06 16:06:43 -07001910 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001911 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001912 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001913
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001914 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001915 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001916 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001917 page = NULL;
1918 if (err == -EEXIST)
1919 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001921
1922 /*
1923 * add_to_page_cache_lru locks the page, and for mmap we expect
1924 * an unlocked page.
1925 */
1926 if (page && (fgp_flags & FGP_FOR_MMAP))
1927 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001929
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 return page;
1931}
Mel Gorman2457aec2014-06-04 16:10:31 -07001932EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001934static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1935 xa_mark_t mark)
1936{
1937 struct page *page;
1938
1939retry:
1940 if (mark == XA_PRESENT)
1941 page = xas_find(xas, max);
1942 else
1943 page = xas_find_marked(xas, max, mark);
1944
1945 if (xas_retry(xas, page))
1946 goto retry;
1947 /*
1948 * A shadow entry of a recently evicted page, a swap
1949 * entry from shmem/tmpfs or a DAX entry. Return it
1950 * without attempting to raise page count.
1951 */
1952 if (!page || xa_is_value(page))
1953 return page;
1954
1955 if (!page_cache_get_speculative(page))
1956 goto reset;
1957
1958 /* Has the page moved or been split? */
1959 if (unlikely(page != xas_reload(xas))) {
1960 put_page(page);
1961 goto reset;
1962 }
1963
1964 return page;
1965reset:
1966 xas_reset(xas);
1967 goto retry;
1968}
1969
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001971 * find_get_entries - gang pagecache lookup
1972 * @mapping: The address_space to search
1973 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001974 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001975 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001976 * @indices: The cache indices corresponding to the entries in @entries
1977 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001978 * find_get_entries() will search for and return a batch of entries in
1979 * the mapping. The entries are placed in @pvec. find_get_entries()
1980 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001981 *
1982 * The search returns a group of mapping-contiguous page cache entries
1983 * with ascending indexes. There may be holes in the indices due to
1984 * not-present pages.
1985 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001986 * Any shadow entries of evicted pages, or swap entries from
1987 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001988 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001989 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1990 * stops at that page: the caller is likely to have a better way to handle
1991 * the compound page as a whole, and then skip its extent, than repeatedly
1992 * calling find_get_entries() to return all its tails.
1993 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001994 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001995 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001996unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001997 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07001998{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001999 XA_STATE(xas, &mapping->i_pages, start);
2000 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002001 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002002 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002003
2004 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002005 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002006 /*
2007 * Terminate early on finding a THP, to allow the caller to
2008 * handle it all at once; but continue if this is hugetlbfs.
2009 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002010 if (!xa_is_value(page) && PageTransHuge(page) &&
2011 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002012 page = find_subpage(page, xas.xa_index);
2013 nr_entries = ret + 1;
2014 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002015
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002016 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002017 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002018 if (++ret == nr_entries)
2019 break;
2020 }
2021 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002022
2023 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002024 return ret;
2025}
2026
2027/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002028 * find_lock_entries - Find a batch of pagecache entries.
2029 * @mapping: The address_space to search.
2030 * @start: The starting page cache index.
2031 * @end: The final page index (inclusive).
2032 * @pvec: Where the resulting entries are placed.
2033 * @indices: The cache indices of the entries in @pvec.
2034 *
2035 * find_lock_entries() will return a batch of entries from @mapping.
2036 * Swap, shadow and DAX entries are included. Pages are returned
2037 * locked and with an incremented refcount. Pages which are locked by
2038 * somebody else or under writeback are skipped. Only the head page of
2039 * a THP is returned. Pages which are partially outside the range are
2040 * not returned.
2041 *
2042 * The entries have ascending indexes. The indices may not be consecutive
2043 * due to not-present entries, THP pages, pages which could not be locked
2044 * or pages under writeback.
2045 *
2046 * Return: The number of entries which were found.
2047 */
2048unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2049 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2050{
2051 XA_STATE(xas, &mapping->i_pages, start);
2052 struct page *page;
2053
2054 rcu_read_lock();
2055 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2056 if (!xa_is_value(page)) {
2057 if (page->index < start)
2058 goto put;
2059 VM_BUG_ON_PAGE(page->index != xas.xa_index, page);
2060 if (page->index + thp_nr_pages(page) - 1 > end)
2061 goto put;
2062 if (!trylock_page(page))
2063 goto put;
2064 if (page->mapping != mapping || PageWriteback(page))
2065 goto unlock;
2066 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2067 page);
2068 }
2069 indices[pvec->nr] = xas.xa_index;
2070 if (!pagevec_add(pvec, page))
2071 break;
2072 goto next;
2073unlock:
2074 unlock_page(page);
2075put:
2076 put_page(page);
2077next:
Hugh Dickins2d11e732021-04-23 14:28:57 -07002078 if (!xa_is_value(page) && PageTransHuge(page)) {
2079 unsigned int nr_pages = thp_nr_pages(page);
2080
2081 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
2082 xas_set(&xas, page->index + nr_pages);
2083 if (xas.xa_index < nr_pages)
2084 break;
2085 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002086 }
2087 rcu_read_unlock();
2088
2089 return pagevec_count(pvec);
2090}
2091
2092/**
Jan Karab947cee2017-09-06 16:21:21 -07002093 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 * @mapping: The address_space to search
2095 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002096 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 * @nr_pages: The maximum number of pages
2098 * @pages: Where the resulting pages are placed
2099 *
Jan Karab947cee2017-09-06 16:21:21 -07002100 * find_get_pages_range() will search for and return a group of up to @nr_pages
2101 * pages in the mapping starting at index @start and up to index @end
2102 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2103 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104 *
2105 * The search returns a group of mapping-contiguous pages with ascending
2106 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002107 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002109 * Return: the number of pages which were found. If this number is
2110 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002111 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 */
Jan Karab947cee2017-09-06 16:21:21 -07002113unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2114 pgoff_t end, unsigned int nr_pages,
2115 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002116{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002117 XA_STATE(xas, &mapping->i_pages, *start);
2118 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002119 unsigned ret = 0;
2120
2121 if (unlikely(!nr_pages))
2122 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123
Nick Piggina60637c2008-07-25 19:45:31 -07002124 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002125 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002126 /* Skip over shadow, swap and DAX entries */
2127 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002128 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002129
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002130 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002131 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002132 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002133 goto out;
2134 }
Nick Piggina60637c2008-07-25 19:45:31 -07002135 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002136
Jan Karab947cee2017-09-06 16:21:21 -07002137 /*
2138 * We come here when there is no page beyond @end. We take care to not
2139 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002140 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002141 * already broken anyway.
2142 */
2143 if (end == (pgoff_t)-1)
2144 *start = (pgoff_t)-1;
2145 else
2146 *start = end + 1;
2147out:
Nick Piggina60637c2008-07-25 19:45:31 -07002148 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002149
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 return ret;
2151}
2152
Jens Axboeebf43502006-04-27 08:46:01 +02002153/**
2154 * find_get_pages_contig - gang contiguous pagecache lookup
2155 * @mapping: The address_space to search
2156 * @index: The starting page index
2157 * @nr_pages: The maximum number of pages
2158 * @pages: Where the resulting pages are placed
2159 *
2160 * find_get_pages_contig() works exactly like find_get_pages(), except
2161 * that the returned number of pages are guaranteed to be contiguous.
2162 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002163 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002164 */
2165unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2166 unsigned int nr_pages, struct page **pages)
2167{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002168 XA_STATE(xas, &mapping->i_pages, index);
2169 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002170 unsigned int ret = 0;
2171
2172 if (unlikely(!nr_pages))
2173 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002174
Nick Piggina60637c2008-07-25 19:45:31 -07002175 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002176 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002177 if (xas_retry(&xas, page))
2178 continue;
2179 /*
2180 * If the entry has been swapped out, we can stop looking.
2181 * No current caller is looking for DAX entries.
2182 */
2183 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002184 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002185
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002186 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002187 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002188
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002189 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002190 if (unlikely(page != xas_reload(&xas)))
2191 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002192
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002193 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002194 if (++ret == nr_pages)
2195 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002196 continue;
2197put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002198 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002199retry:
2200 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002201 }
Nick Piggina60637c2008-07-25 19:45:31 -07002202 rcu_read_unlock();
2203 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002204}
David Howellsef71c152007-05-09 02:33:44 -07002205EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002206
Randy Dunlap485bb992006-06-23 02:03:49 -07002207/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002208 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002209 * @mapping: the address_space to search
2210 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002211 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002212 * @tag: the tag index
2213 * @nr_pages: the maximum number of pages
2214 * @pages: where the resulting pages are placed
2215 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002216 * Like find_get_pages(), except we only return head pages which are tagged
2217 * with @tag. @index is updated to the index immediately after the last
2218 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002219 *
2220 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 */
Jan Kara72b045a2017-11-15 17:34:33 -08002222unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002223 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002224 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002226 XA_STATE(xas, &mapping->i_pages, *index);
2227 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002228 unsigned ret = 0;
2229
2230 if (unlikely(!nr_pages))
2231 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232
Nick Piggina60637c2008-07-25 19:45:31 -07002233 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002234 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002235 /*
2236 * Shadow entries should never be tagged, but this iteration
2237 * is lockless so there is a window for page reclaim to evict
2238 * a page we saw tagged. Skip over it.
2239 */
2240 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002241 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002242
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002243 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002244 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002245 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002246 goto out;
2247 }
Nick Piggina60637c2008-07-25 19:45:31 -07002248 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002249
Jan Kara72b045a2017-11-15 17:34:33 -08002250 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002251 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002252 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002253 * iteration when there is a page at index -1 but that is already
2254 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002255 */
2256 if (end == (pgoff_t)-1)
2257 *index = (pgoff_t)-1;
2258 else
2259 *index = end + 1;
2260out:
Nick Piggina60637c2008-07-25 19:45:31 -07002261 rcu_read_unlock();
2262
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 return ret;
2264}
Jan Kara72b045a2017-11-15 17:34:33 -08002265EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002267/*
2268 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2269 * a _large_ part of the i/o request. Imagine the worst scenario:
2270 *
2271 * ---R__________________________________________B__________
2272 * ^ reading here ^ bad block(assume 4k)
2273 *
2274 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2275 * => failing the whole request => read(R) => read(R+1) =>
2276 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2277 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2278 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2279 *
2280 * It is going insane. Fix it by quickly scaling down the readahead size.
2281 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002282static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002283{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002284 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002285}
2286
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002287/*
2288 * filemap_get_read_batch - Get a batch of pages for read
2289 *
2290 * Get a batch of pages which represent a contiguous range of bytes
2291 * in the file. No tail pages will be returned. If @index is in the
2292 * middle of a THP, the entire THP will be returned. The last page in
2293 * the batch may have Readahead set or be not Uptodate so that the
2294 * caller can take the appropriate action.
2295 */
2296static void filemap_get_read_batch(struct address_space *mapping,
2297 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2298{
2299 XA_STATE(xas, &mapping->i_pages, index);
2300 struct page *head;
2301
2302 rcu_read_lock();
2303 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2304 if (xas_retry(&xas, head))
2305 continue;
2306 if (xas.xa_index > max || xa_is_value(head))
2307 break;
2308 if (!page_cache_get_speculative(head))
2309 goto retry;
2310
2311 /* Has the page moved or been split? */
2312 if (unlikely(head != xas_reload(&xas)))
2313 goto put_page;
2314
2315 if (!pagevec_add(pvec, head))
2316 break;
2317 if (!PageUptodate(head))
2318 break;
2319 if (PageReadahead(head))
2320 break;
2321 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2322 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2323 continue;
2324put_page:
2325 put_page(head);
2326retry:
2327 xas_reset(&xas);
2328 }
2329 rcu_read_unlock();
2330}
2331
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002332static int filemap_read_page(struct file *file, struct address_space *mapping,
2333 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002334{
Kent Overstreet723ef242020-12-14 19:04:52 -08002335 int error;
2336
Kent Overstreet723ef242020-12-14 19:04:52 -08002337 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002338 * A previous I/O error may have been due to temporary failures,
2339 * eg. multipath errors. PG_error will be set again if readpage
2340 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002341 */
2342 ClearPageError(page);
2343 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002344 error = mapping->a_ops->readpage(file, page);
2345 if (error)
2346 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002347
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002348 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002349 if (error)
2350 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002351 if (PageUptodate(page))
2352 return 0;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002353 shrink_readahead_size_eio(&file->f_ra);
2354 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002355}
2356
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002357static bool filemap_range_uptodate(struct address_space *mapping,
2358 loff_t pos, struct iov_iter *iter, struct page *page)
2359{
2360 int count;
2361
2362 if (PageUptodate(page))
2363 return true;
2364 /* pipes can't handle partially uptodate pages */
2365 if (iov_iter_is_pipe(iter))
2366 return false;
2367 if (!mapping->a_ops->is_partially_uptodate)
2368 return false;
2369 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2370 return false;
2371
2372 count = iter->count;
2373 if (page_offset(page) > pos) {
2374 count -= page_offset(page) - pos;
2375 pos = 0;
2376 } else {
2377 pos -= page_offset(page);
2378 }
2379
2380 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2381}
2382
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002383static int filemap_update_page(struct kiocb *iocb,
2384 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002385 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002386{
Kent Overstreet723ef242020-12-14 19:04:52 -08002387 int error;
2388
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002389 if (!trylock_page(page)) {
2390 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2391 return -EAGAIN;
2392 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002393 put_and_wait_on_page_locked(page, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002394 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002395 }
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002396 error = __lock_page_async(page, iocb->ki_waitq);
2397 if (error)
2398 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002399 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002400
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002401 if (!page->mapping)
2402 goto truncated;
Kent Overstreet723ef242020-12-14 19:04:52 -08002403
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002404 error = 0;
2405 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, page))
2406 goto unlock;
2407
2408 error = -EAGAIN;
2409 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2410 goto unlock;
2411
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002412 error = filemap_read_page(iocb->ki_filp, mapping, page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002413 if (error == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002414 put_page(page);
2415 return error;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002416truncated:
2417 unlock_page(page);
2418 put_page(page);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002419 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002420unlock:
2421 unlock_page(page);
2422 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002423}
2424
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002425static int filemap_create_page(struct file *file,
2426 struct address_space *mapping, pgoff_t index,
2427 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002428{
Kent Overstreet723ef242020-12-14 19:04:52 -08002429 struct page *page;
2430 int error;
2431
Kent Overstreet723ef242020-12-14 19:04:52 -08002432 page = page_cache_alloc(mapping);
2433 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002434 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002435
2436 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002437 mapping_gfp_constraint(mapping, GFP_KERNEL));
2438 if (error == -EEXIST)
2439 error = AOP_TRUNCATED_PAGE;
2440 if (error)
2441 goto error;
2442
2443 error = filemap_read_page(file, mapping, page);
2444 if (error)
2445 goto error;
2446
2447 pagevec_add(pvec, page);
2448 return 0;
2449error:
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002450 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002451 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002452}
2453
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002454static int filemap_readahead(struct kiocb *iocb, struct file *file,
2455 struct address_space *mapping, struct page *page,
2456 pgoff_t last_index)
2457{
2458 if (iocb->ki_flags & IOCB_NOIO)
2459 return -EAGAIN;
2460 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2461 page->index, last_index - page->index);
2462 return 0;
2463}
2464
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002465static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002466 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002467{
2468 struct file *filp = iocb->ki_filp;
2469 struct address_space *mapping = filp->f_mapping;
2470 struct file_ra_state *ra = &filp->f_ra;
2471 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002472 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002473 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002474 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002475
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002476 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002477retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002478 if (fatal_signal_pending(current))
2479 return -EINTR;
2480
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002481 filemap_get_read_batch(mapping, index, last_index, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002482 if (!pagevec_count(pvec)) {
2483 if (iocb->ki_flags & IOCB_NOIO)
2484 return -EAGAIN;
2485 page_cache_sync_readahead(mapping, ra, filp, index,
2486 last_index - index);
2487 filemap_get_read_batch(mapping, index, last_index, pvec);
2488 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002489 if (!pagevec_count(pvec)) {
2490 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2491 return -EAGAIN;
2492 err = filemap_create_page(filp, mapping,
2493 iocb->ki_pos >> PAGE_SHIFT, pvec);
2494 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002495 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002496 return err;
2497 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002498
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002499 page = pvec->pages[pagevec_count(pvec) - 1];
2500 if (PageReadahead(page)) {
2501 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2502 if (err)
2503 goto err;
2504 }
2505 if (!PageUptodate(page)) {
2506 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2507 iocb->ki_flags |= IOCB_NOWAIT;
2508 err = filemap_update_page(iocb, mapping, iter, page);
2509 if (err)
2510 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002511 }
2512
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002513 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002514err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002515 if (err < 0)
2516 put_page(page);
2517 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002518 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002519 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002520 goto retry;
2521 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002522}
2523
Randy Dunlap485bb992006-06-23 02:03:49 -07002524/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002525 * filemap_read - Read data from the page cache.
2526 * @iocb: The iocb to read.
2527 * @iter: Destination for the data.
2528 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002529 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002530 * Copies data from the page cache. If the data is not currently present,
2531 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002533 * Return: Total number of bytes copied, including those already read by
2534 * the caller. If an error happens before any bytes are copied, returns
2535 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002537ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2538 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002539{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002540 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002541 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002542 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002544 struct pagevec pvec;
2545 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002546 bool writably_mapped;
2547 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548
Kent Overstreet723ef242020-12-14 19:04:52 -08002549 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002550 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002551 if (unlikely(!iov_iter_count(iter)))
2552 return 0;
2553
Wei Fangc2a97372016-10-07 17:01:52 -07002554 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002555 pagevec_init(&pvec);
Wei Fangc2a97372016-10-07 17:01:52 -07002556
Kent Overstreet06c04442020-12-14 19:04:56 -08002557 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 cond_resched();
Kent Overstreet06c04442020-12-14 19:04:56 -08002559
2560 /*
2561 * If we've already successfully copied some data, then we
2562 * can no longer safely return -EIOCBQUEUED. Hence mark
2563 * an async read NOWAIT at that point.
2564 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002565 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002566 iocb->ki_flags |= IOCB_NOWAIT;
2567
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002568 error = filemap_get_pages(iocb, iter, &pvec);
2569 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002570 break;
Michal Hocko5abf1862017-02-03 13:13:29 -08002571
Kent Overstreet723ef242020-12-14 19:04:52 -08002572 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002573 * i_size must be checked after we know the pages are Uptodate.
2574 *
2575 * Checking i_size after the check allows us to calculate
2576 * the correct value for "nr", which means the zero-filled
2577 * part of the page is not copied back to userspace (unless
2578 * another truncate extends the file - this is desired though).
Kent Overstreet723ef242020-12-14 19:04:52 -08002579 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002580 isize = i_size_read(inode);
2581 if (unlikely(iocb->ki_pos >= isize))
2582 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002583 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2584
Kent Overstreet06c04442020-12-14 19:04:56 -08002585 /*
2586 * Once we start copying data, we don't want to be touching any
2587 * cachelines that might be contended:
2588 */
2589 writably_mapped = mapping_writably_mapped(mapping);
2590
2591 /*
2592 * When a sequential read accesses a page several times, only
2593 * mark it as accessed the first time.
2594 */
2595 if (iocb->ki_pos >> PAGE_SHIFT !=
2596 ra->prev_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002597 mark_page_accessed(pvec.pages[0]);
Kent Overstreet06c04442020-12-14 19:04:56 -08002598
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002599 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002600 struct page *page = pvec.pages[i];
2601 size_t page_size = thp_size(page);
2602 size_t offset = iocb->ki_pos & (page_size - 1);
2603 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2604 page_size - offset);
2605 size_t copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002606
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002607 if (end_offset < page_offset(page))
2608 break;
2609 if (i > 0)
2610 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002611 /*
2612 * If users can be writing to this page using arbitrary
2613 * virtual addresses, take care about potential aliasing
2614 * before reading the page on the kernel side.
2615 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002616 if (writably_mapped) {
2617 int j;
Kent Overstreet06c04442020-12-14 19:04:56 -08002618
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002619 for (j = 0; j < thp_nr_pages(page); j++)
2620 flush_dcache_page(page + j);
2621 }
2622
2623 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002624
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002625 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002626 iocb->ki_pos += copied;
2627 ra->prev_pos = iocb->ki_pos;
2628
2629 if (copied < bytes) {
2630 error = -EFAULT;
2631 break;
Kent Overstreet723ef242020-12-14 19:04:52 -08002632 }
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002633 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002634put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002635 for (i = 0; i < pagevec_count(&pvec); i++)
2636 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002637 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002638 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002640 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002641
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002642 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002643}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002644EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645
Randy Dunlap485bb992006-06-23 02:03:49 -07002646/**
Al Viro6abd2322014-04-04 14:20:57 -04002647 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002648 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002649 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002650 *
Al Viro6abd2322014-04-04 14:20:57 -04002651 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002652 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002653 *
2654 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2655 * be returned when no data can be read without waiting for I/O requests
2656 * to complete; it doesn't prevent readahead.
2657 *
2658 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2659 * requests shall be made for the read or for readahead. When no data
2660 * can be read, -EAGAIN shall be returned. When readahead would be
2661 * triggered, a partial, possibly empty read shall be returned.
2662 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002663 * Return:
2664 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002665 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666 */
2667ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002668generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002670 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002671 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002672
2673 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002674 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675
Al Viro2ba48ce2015-04-09 13:52:01 -04002676 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002677 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002678 struct address_space *mapping = file->f_mapping;
2679 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002680 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002681
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002683 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002684 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2685 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002686 return -EAGAIN;
2687 } else {
2688 retval = filemap_write_and_wait_range(mapping,
2689 iocb->ki_pos,
2690 iocb->ki_pos + count - 1);
2691 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002692 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002693 }
Al Viroed978a82014-03-05 22:53:04 -05002694
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002695 file_accessed(file);
2696
Al Viro5ecda132017-04-13 14:13:36 -04002697 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002698 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002699 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002700 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002701 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002702 if (retval != -EIOCBQUEUED)
2703 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002704
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002705 /*
2706 * Btrfs can have a short DIO read if we encounter
2707 * compressed extents, so if there was an error, or if
2708 * we've already read everything we wanted to, or if
2709 * there was a short read because we hit EOF, go ahead
2710 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002711 * the rest of the read. Buffered reads will not work for
2712 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002713 */
Al Viro5ecda132017-04-13 14:13:36 -04002714 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002715 IS_DAX(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002716 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 }
2718
Christoph Hellwig826ea862021-02-24 12:02:45 -08002719 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720}
Al Viroed978a82014-03-05 22:53:04 -05002721EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002723static inline loff_t page_seek_hole_data(struct xa_state *xas,
2724 struct address_space *mapping, struct page *page,
2725 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002726{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002727 const struct address_space_operations *ops = mapping->a_ops;
2728 size_t offset, bsz = i_blocksize(mapping->host);
2729
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002730 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002731 return seek_data ? start : end;
2732 if (!ops->is_partially_uptodate)
2733 return seek_data ? end : start;
2734
2735 xas_pause(xas);
2736 rcu_read_unlock();
2737 lock_page(page);
2738 if (unlikely(page->mapping != mapping))
2739 goto unlock;
2740
2741 offset = offset_in_thp(page, start) & ~(bsz - 1);
2742
2743 do {
2744 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2745 break;
2746 start = (start + bsz) & ~(bsz - 1);
2747 offset += bsz;
2748 } while (offset < thp_size(page));
2749unlock:
2750 unlock_page(page);
2751 rcu_read_lock();
2752 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002753}
2754
2755static inline
2756unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2757{
2758 if (xa_is_value(page))
2759 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2760 return thp_size(page);
2761}
2762
2763/**
2764 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2765 * @mapping: Address space to search.
2766 * @start: First byte to consider.
2767 * @end: Limit of search (exclusive).
2768 * @whence: Either SEEK_HOLE or SEEK_DATA.
2769 *
2770 * If the page cache knows which blocks contain holes and which blocks
2771 * contain data, your filesystem can use this function to implement
2772 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2773 * entirely memory-based such as tmpfs, and filesystems which support
2774 * unwritten extents.
2775 *
Ingo Molnarf0953a12021-05-06 18:06:47 -07002776 * Return: The requested offset on success, or -ENXIO if @whence specifies
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002777 * SEEK_DATA and there is no data after @start. There is an implicit hole
2778 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2779 * and @end contain data.
2780 */
2781loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2782 loff_t end, int whence)
2783{
2784 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002785 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002786 bool seek_data = (whence == SEEK_DATA);
2787 struct page *page;
2788
2789 if (end <= start)
2790 return -ENXIO;
2791
2792 rcu_read_lock();
2793 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002794 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2795 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002796
2797 if (start < pos) {
2798 if (!seek_data)
2799 goto unlock;
2800 start = pos;
2801 }
2802
Hugh Dickinsed98b012021-04-23 14:29:00 -07002803 seek_size = seek_page_size(&xas, page);
2804 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002805 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2806 seek_data);
2807 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002808 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002809 if (start >= end)
2810 break;
2811 if (seek_size > PAGE_SIZE)
2812 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002813 if (!xa_is_value(page))
2814 put_page(page);
2815 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002816 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002817 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002818unlock:
2819 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002820 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002821 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002822 if (start > end)
2823 return end;
2824 return start;
2825}
2826
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002828#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002829/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002830 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002831 * @vmf - the vm_fault for this fault.
2832 * @page - the page to lock.
2833 * @fpin - the pointer to the file we may pin (or is already pinned).
2834 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002835 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002836 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002837 * if it couldn't lock the page. If we did have to drop the mmap_lock then fpin
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002838 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002839 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002840static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2841 struct file **fpin)
2842{
2843 if (trylock_page(page))
2844 return 1;
2845
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002846 /*
2847 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002848 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002849 * is supposed to work. We have way too many special cases..
2850 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002851 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2852 return 0;
2853
2854 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2855 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2856 if (__lock_page_killable(page)) {
2857 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002858 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002859 * but all fault_handlers only check for fatal signals
2860 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002861 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002862 */
2863 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002864 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002865 return 0;
2866 }
2867 } else
2868 __lock_page(page);
2869 return 1;
2870}
2871
2872
2873/*
2874 * Synchronous readahead happens when we don't even find a page in the page
2875 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2876 * to drop the mmap sem we return the file that was pinned in order for us to do
2877 * that. If we didn't pin a file then we return NULL. The file that is
2878 * returned needs to be fput()'ed when we're done with it.
2879 */
2880static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002881{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002882 struct file *file = vmf->vma->vm_file;
2883 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002884 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002885 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002886 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002887 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002888
2889 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002890 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002891 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002892 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002893 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002894
Josef Bacik2a1180f2019-03-13 11:44:18 -07002895 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002896 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002897 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002898 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002899 }
2900
Andi Kleen207d04b2011-05-24 17:12:29 -07002901 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002902 mmap_miss = READ_ONCE(ra->mmap_miss);
2903 if (mmap_miss < MMAP_LOTSAMISS * 10)
2904 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002905
2906 /*
2907 * Do we miss much more than hit in this file? If so,
2908 * stop bothering with read-ahead. It will only hurt.
2909 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002910 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002911 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002912
Wu Fengguangd30a1102009-06-16 15:31:30 -07002913 /*
2914 * mmap read-around
2915 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002916 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002917 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002918 ra->size = ra->ra_pages;
2919 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002920 ractl._index = ra->start;
2921 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002922 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002923}
2924
2925/*
2926 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002927 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002928 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002929 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002930static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2931 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002932{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002933 struct file *file = vmf->vma->vm_file;
2934 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002935 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002936 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002937 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002938 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002939
2940 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002941 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002942 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002943 mmap_miss = READ_ONCE(ra->mmap_miss);
2944 if (mmap_miss)
2945 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002946 if (PageReadahead(page)) {
2947 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002948 page_cache_async_readahead(mapping, ra, file,
2949 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002950 }
2951 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002952}
2953
Randy Dunlap485bb992006-06-23 02:03:49 -07002954/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002955 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002956 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002957 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002958 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959 * mapped memory region to read in file data during a page fault.
2960 *
2961 * The goto's are kind of ugly, but this streamlines the normal case of having
2962 * it in the page cache, and handles the special cases reasonably without
2963 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002964 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002965 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002966 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002967 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002968 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002969 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002970 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002971 * has not been released.
2972 *
2973 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002974 *
2975 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002976 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002977vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002978{
2979 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002980 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002981 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002984 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002985 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002987 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002989 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2990 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002991 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002992
Linus Torvalds1da177e2005-04-16 15:20:36 -07002993 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002994 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002996 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002997 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002998 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002999 * We found the page, so try async readahead before
3000 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003002 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07003003 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07003004 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003005 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07003006 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003007 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003008 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003009retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07003010 page = pagecache_get_page(mapping, offset,
3011 FGP_CREAT|FGP_FOR_MMAP,
3012 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003013 if (!page) {
3014 if (fpin)
3015 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07003016 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003017 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003018 }
3019
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003020 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3021 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003022
3023 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003024 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003025 unlock_page(page);
3026 put_page(page);
3027 goto retry_find;
3028 }
Song Liu520e5ba2019-09-23 15:37:50 -07003029 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003030
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003032 * We have a locked page in the page cache, now we need to check
3033 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003034 */
Nick Piggind00806b2007-07-19 01:46:57 -07003035 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003036 goto page_not_uptodate;
3037
Linus Torvaldsef00e082009-06-16 15:31:25 -07003038 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003039 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003040 * time to return to the upper layer and have it re-find the vma and
3041 * redo the fault.
3042 */
3043 if (fpin) {
3044 unlock_page(page);
3045 goto out_retry;
3046 }
3047
3048 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003049 * Found the page and have a reference on it.
3050 * We must recheck i_size under page lock.
3051 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003052 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3053 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003054 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003055 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003056 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003057 }
3058
Nick Piggind0217ac2007-07-19 01:47:03 -07003059 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003060 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003063 /*
3064 * Umm, take care of errors if the page isn't up-to-date.
3065 * Try to re-read it _once_. We do this synchronously,
3066 * because there really aren't any performance issues here
3067 * and we need to check for errors.
3068 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003069 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)d31fa862021-04-29 22:55:26 -07003070 error = filemap_read_page(file, mapping, page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003071 if (fpin)
3072 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003073 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003074
3075 if (!error || error == AOP_TRUNCATED_PAGE)
3076 goto retry_find;
3077
Nick Piggind0217ac2007-07-19 01:47:03 -07003078 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003079
3080out_retry:
3081 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003082 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003083 * re-find the vma and come back and find our hopefully still populated
3084 * page.
3085 */
3086 if (page)
3087 put_page(page);
3088 if (fpin)
3089 fput(fpin);
3090 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003091}
3092EXPORT_SYMBOL(filemap_fault);
3093
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003094static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003095{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003096 struct mm_struct *mm = vmf->vma->vm_mm;
3097
3098 /* Huge page is mapped? No need to proceed. */
3099 if (pmd_trans_huge(*vmf->pmd)) {
3100 unlock_page(page);
3101 put_page(page);
3102 return true;
3103 }
3104
3105 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
3106 vm_fault_t ret = do_set_pmd(vmf, page);
3107 if (!ret) {
3108 /* The page is mapped successfully, reference consumed. */
3109 unlock_page(page);
3110 return true;
3111 }
3112 }
3113
3114 if (pmd_none(*vmf->pmd)) {
3115 vmf->ptl = pmd_lock(mm, vmf->pmd);
3116 if (likely(pmd_none(*vmf->pmd))) {
3117 mm_inc_nr_ptes(mm);
3118 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
3119 vmf->prealloc_pte = NULL;
3120 }
3121 spin_unlock(vmf->ptl);
3122 }
3123
3124 /* See comment in handle_pte_fault() */
3125 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3126 unlock_page(page);
3127 put_page(page);
3128 return true;
3129 }
3130
3131 return false;
3132}
3133
3134static struct page *next_uptodate_page(struct page *page,
3135 struct address_space *mapping,
3136 struct xa_state *xas, pgoff_t end_pgoff)
3137{
3138 unsigned long max_idx;
3139
3140 do {
3141 if (!page)
3142 return NULL;
3143 if (xas_retry(xas, page))
3144 continue;
3145 if (xa_is_value(page))
3146 continue;
3147 if (PageLocked(page))
3148 continue;
3149 if (!page_cache_get_speculative(page))
3150 continue;
3151 /* Has the page moved or been split? */
3152 if (unlikely(page != xas_reload(xas)))
3153 goto skip;
3154 if (!PageUptodate(page) || PageReadahead(page))
3155 goto skip;
3156 if (PageHWPoison(page))
3157 goto skip;
3158 if (!trylock_page(page))
3159 goto skip;
3160 if (page->mapping != mapping)
3161 goto unlock;
3162 if (!PageUptodate(page))
3163 goto unlock;
3164 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3165 if (xas->xa_index >= max_idx)
3166 goto unlock;
3167 return page;
3168unlock:
3169 unlock_page(page);
3170skip:
3171 put_page(page);
3172 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3173
3174 return NULL;
3175}
3176
3177static inline struct page *first_map_page(struct address_space *mapping,
3178 struct xa_state *xas,
3179 pgoff_t end_pgoff)
3180{
3181 return next_uptodate_page(xas_find(xas, end_pgoff),
3182 mapping, xas, end_pgoff);
3183}
3184
3185static inline struct page *next_map_page(struct address_space *mapping,
3186 struct xa_state *xas,
3187 pgoff_t end_pgoff)
3188{
3189 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3190 mapping, xas, end_pgoff);
3191}
3192
3193vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3194 pgoff_t start_pgoff, pgoff_t end_pgoff)
3195{
3196 struct vm_area_struct *vma = vmf->vma;
3197 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003198 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07003199 pgoff_t last_pgoff = start_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003200 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003201 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003202 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003203 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003204 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003205
3206 rcu_read_lock();
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003207 head = first_map_page(mapping, &xas, end_pgoff);
3208 if (!head)
3209 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003210
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003211 if (filemap_map_pmd(vmf, head)) {
3212 ret = VM_FAULT_NOPAGE;
3213 goto out;
3214 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003215
Will Deacon9d3af4b2021-01-14 15:24:19 +00003216 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3217 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003218 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003219 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003220 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003221 goto unlock;
3222
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003223 if (mmap_miss > 0)
3224 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003225
Will Deacon9d3af4b2021-01-14 15:24:19 +00003226 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003227 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003228 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003229
3230 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003231 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003232
Will Deacon46bdb422020-11-24 18:48:26 +00003233 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003234 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003235 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003236
Will Deacon9d3af4b2021-01-14 15:24:19 +00003237 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003238 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003239 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003240 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003241 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003242unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003243 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003244 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003245 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3246 pte_unmap_unlock(vmf->pte, vmf->ptl);
3247out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003248 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003249 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003250 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003251}
3252EXPORT_SYMBOL(filemap_map_pages);
3253
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003254vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003255{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003256 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003257 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003258 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003259
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003260 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003261 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003262 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003263 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003264 unlock_page(page);
3265 ret = VM_FAULT_NOPAGE;
3266 goto out;
3267 }
Jan Kara14da9202012-06-12 16:20:37 +02003268 /*
3269 * We mark the page dirty already here so that when freeze is in
3270 * progress, we are guaranteed that writeback during freezing will
3271 * see the dirty page and writeprotect it again.
3272 */
3273 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003274 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003275out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003276 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003277 return ret;
3278}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003279
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003280const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003281 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003282 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003283 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003284};
3285
3286/* This is used for a general mmap of a disk file */
3287
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003288int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289{
3290 struct address_space *mapping = file->f_mapping;
3291
3292 if (!mapping->a_ops->readpage)
3293 return -ENOEXEC;
3294 file_accessed(file);
3295 vma->vm_ops = &generic_file_vm_ops;
3296 return 0;
3297}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003298
3299/*
3300 * This is for filesystems which do not implement ->writepage.
3301 */
3302int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3303{
3304 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3305 return -EINVAL;
3306 return generic_file_mmap(file, vma);
3307}
3308#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003309vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003310{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003311 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003312}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003313int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003314{
3315 return -ENOSYS;
3316}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003317int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003318{
3319 return -ENOSYS;
3320}
3321#endif /* CONFIG_MMU */
3322
Arnd Bergmann453972282018-04-13 15:35:27 -07003323EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003324EXPORT_SYMBOL(generic_file_mmap);
3325EXPORT_SYMBOL(generic_file_readonly_mmap);
3326
Sasha Levin67f9fd92014-04-03 14:48:18 -07003327static struct page *wait_on_page_read(struct page *page)
3328{
3329 if (!IS_ERR(page)) {
3330 wait_on_page_locked(page);
3331 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003332 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003333 page = ERR_PTR(-EIO);
3334 }
3335 }
3336 return page;
3337}
3338
Mel Gorman32b63522016-03-15 14:55:36 -07003339static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003340 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003341 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003342 void *data,
3343 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003344{
Nick Piggineb2be182007-10-16 01:24:57 -07003345 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003346 int err;
3347repeat:
3348 page = find_get_page(mapping, index);
3349 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003350 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003351 if (!page)
3352 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003353 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003354 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003355 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003356 if (err == -EEXIST)
3357 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003358 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003359 return ERR_PTR(err);
3360 }
Mel Gorman32b63522016-03-15 14:55:36 -07003361
3362filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003363 if (filler)
3364 err = filler(data, page);
3365 else
3366 err = mapping->a_ops->readpage(data, page);
3367
Linus Torvalds1da177e2005-04-16 15:20:36 -07003368 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003369 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003370 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371 }
Mel Gorman32b63522016-03-15 14:55:36 -07003372
3373 page = wait_on_page_read(page);
3374 if (IS_ERR(page))
3375 return page;
3376 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003377 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003378 if (PageUptodate(page))
3379 goto out;
3380
Mel Gormanebded022016-03-15 14:55:39 -07003381 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003382 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003383 * case a: Page is being filled and the page lock is held
3384 * case b: Read/write error clearing the page uptodate status
3385 * case c: Truncation in progress (page locked)
3386 * case d: Reclaim in progress
3387 *
3388 * Case a, the page will be up to date when the page is unlocked.
3389 * There is no need to serialise on the page lock here as the page
3390 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003391 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003392 * it's a race vs truncate race.
3393 * Case b, the page will not be up to date
3394 * Case c, the page may be truncated but in itself, the data may still
3395 * be valid after IO completes as it's a read vs truncate race. The
3396 * operation must restart if the page is not uptodate on unlock but
3397 * otherwise serialising on page lock to stabilise the mapping gives
3398 * no additional guarantees to the caller as the page lock is
3399 * released before return.
3400 * Case d, similar to truncation. If reclaim holds the page lock, it
3401 * will be a race with remove_mapping that determines if the mapping
3402 * is valid on unlock but otherwise the data is valid and there is
3403 * no need to serialise with page lock.
3404 *
3405 * As the page lock gives no additional guarantee, we optimistically
3406 * wait on the page to be unlocked and check if it's up to date and
3407 * use the page if it is. Otherwise, the page lock is required to
3408 * distinguish between the different cases. The motivation is that we
3409 * avoid spurious serialisations and wakeups when multiple processes
3410 * wait on the same page for IO to complete.
3411 */
3412 wait_on_page_locked(page);
3413 if (PageUptodate(page))
3414 goto out;
3415
3416 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003417 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003418
3419 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003420 if (!page->mapping) {
3421 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003422 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003423 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003424 }
Mel Gormanebded022016-03-15 14:55:39 -07003425
3426 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003427 if (PageUptodate(page)) {
3428 unlock_page(page);
3429 goto out;
3430 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003431
3432 /*
3433 * A previous I/O error may have been due to temporary
3434 * failures.
3435 * Clear page error before actual read, PG_error will be
3436 * set again if read page fails.
3437 */
3438 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003439 goto filler;
3440
David Howellsc855ff32007-05-09 13:42:20 +01003441out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003442 mark_page_accessed(page);
3443 return page;
3444}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003445
3446/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003447 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003448 * @mapping: the page's address_space
3449 * @index: the page index
3450 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003451 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003452 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003453 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003454 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003455 *
3456 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003457 *
3458 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003459 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003460struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003461 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003462 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003463 void *data)
3464{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003465 return do_read_cache_page(mapping, index, filler, data,
3466 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003467}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003468EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003469
3470/**
3471 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3472 * @mapping: the page's address_space
3473 * @index: the page index
3474 * @gfp: the page allocator flags to use if allocating
3475 *
3476 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003477 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003478 *
3479 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003480 *
3481 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003482 */
3483struct page *read_cache_page_gfp(struct address_space *mapping,
3484 pgoff_t index,
3485 gfp_t gfp)
3486{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003487 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003488}
3489EXPORT_SYMBOL(read_cache_page_gfp);
3490
Nick Pigginafddba42007-10-16 01:25:01 -07003491int pagecache_write_begin(struct file *file, struct address_space *mapping,
3492 loff_t pos, unsigned len, unsigned flags,
3493 struct page **pagep, void **fsdata)
3494{
3495 const struct address_space_operations *aops = mapping->a_ops;
3496
Nick Piggin4e02ed42008-10-29 14:00:55 -07003497 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003498 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003499}
3500EXPORT_SYMBOL(pagecache_write_begin);
3501
3502int pagecache_write_end(struct file *file, struct address_space *mapping,
3503 loff_t pos, unsigned len, unsigned copied,
3504 struct page *page, void *fsdata)
3505{
3506 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003507
Nick Piggin4e02ed42008-10-29 14:00:55 -07003508 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003509}
3510EXPORT_SYMBOL(pagecache_write_end);
3511
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003512/*
3513 * Warn about a page cache invalidation failure during a direct I/O write.
3514 */
3515void dio_warn_stale_pagecache(struct file *filp)
3516{
3517 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3518 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003519 char *path;
3520
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003521 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003522 if (__ratelimit(&_rs)) {
3523 path = file_path(filp, pathname, sizeof(pathname));
3524 if (IS_ERR(path))
3525 path = "(unknown)";
3526 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3527 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3528 current->comm);
3529 }
3530}
3531
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003533generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003534{
3535 struct file *file = iocb->ki_filp;
3536 struct address_space *mapping = file->f_mapping;
3537 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003538 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003539 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003540 size_t write_len;
3541 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542
Al Viro0c949332014-03-22 06:51:37 -04003543 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003544 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003545
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003546 if (iocb->ki_flags & IOCB_NOWAIT) {
3547 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003548 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003549 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003550 return -EAGAIN;
3551 } else {
3552 written = filemap_write_and_wait_range(mapping, pos,
3553 pos + write_len - 1);
3554 if (written)
3555 goto out;
3556 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003557
3558 /*
3559 * After a write we want buffered reads to be sure to go to disk to get
3560 * the new data. We invalidate clean cached page from the region we're
3561 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003562 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003563 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003564 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003565 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003566 /*
3567 * If a page can not be invalidated, return 0 to fall back
3568 * to buffered write.
3569 */
3570 if (written) {
3571 if (written == -EBUSY)
3572 return 0;
3573 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003574 }
3575
Al Viro639a93a52017-04-13 14:10:15 -04003576 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003577
3578 /*
3579 * Finally, try again to invalidate clean pages which might have been
3580 * cached by non-direct readahead, or faulted in by get_user_pages()
3581 * if the source of the write was an mmap'ed region of the file
3582 * we're writing. Either one is a pretty crazy thing to do,
3583 * so we don't support it 100%. If this invalidation
3584 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003585 *
3586 * Most of the time we do not need this since dio_complete() will do
3587 * the invalidation for us. However there are some file systems that
3588 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003589 * them by removing it completely.
3590 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003591 * Noticeable example is a blkdev_direct_IO().
3592 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003593 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003594 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003595 if (written > 0 && mapping->nrpages &&
3596 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3597 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003598
Linus Torvalds1da177e2005-04-16 15:20:36 -07003599 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003600 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003601 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003602 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3603 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003604 mark_inode_dirty(inode);
3605 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003606 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003607 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003608 if (written != -EIOCBQUEUED)
3609 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003610out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003611 return written;
3612}
3613EXPORT_SYMBOL(generic_file_direct_write);
3614
Nick Piggineb2be182007-10-16 01:24:57 -07003615/*
3616 * Find or create a page at the given pagecache position. Return the locked
3617 * page. This function is specifically for buffered writes.
3618 */
Nick Piggin54566b22009-01-04 12:00:53 -08003619struct page *grab_cache_page_write_begin(struct address_space *mapping,
3620 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003621{
Nick Piggineb2be182007-10-16 01:24:57 -07003622 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003623 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003624
Nick Piggin54566b22009-01-04 12:00:53 -08003625 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003626 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003627
Mel Gorman2457aec2014-06-04 16:10:31 -07003628 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003629 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003630 if (page)
3631 wait_for_stable_page(page);
3632
Nick Piggineb2be182007-10-16 01:24:57 -07003633 return page;
3634}
Nick Piggin54566b22009-01-04 12:00:53 -08003635EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003636
Al Viro3b93f912014-02-11 21:34:08 -05003637ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003638 struct iov_iter *i, loff_t pos)
3639{
3640 struct address_space *mapping = file->f_mapping;
3641 const struct address_space_operations *a_ops = mapping->a_ops;
3642 long status = 0;
3643 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003644 unsigned int flags = 0;
3645
Nick Pigginafddba42007-10-16 01:25:01 -07003646 do {
3647 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003648 unsigned long offset; /* Offset into pagecache page */
3649 unsigned long bytes; /* Bytes to write to page */
3650 size_t copied; /* Bytes copied from user */
3651 void *fsdata;
3652
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003653 offset = (pos & (PAGE_SIZE - 1));
3654 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003655 iov_iter_count(i));
3656
3657again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003658 /*
3659 * Bring in the user page that we will copy from _first_.
3660 * Otherwise there's a nasty deadlock on copying from the
3661 * same page as we're writing to, without it being marked
3662 * up-to-date.
Linus Torvalds00a3d662015-10-07 08:32:38 +01003663 */
3664 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3665 status = -EFAULT;
3666 break;
3667 }
3668
Jan Kara296291c2015-10-22 13:32:21 -07003669 if (fatal_signal_pending(current)) {
3670 status = -EINTR;
3671 break;
3672 }
3673
Nick Piggin674b8922007-10-16 01:25:03 -07003674 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003675 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003676 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003677 break;
3678
anfei zhou931e80e2010-02-02 13:44:02 -08003679 if (mapping_writably_mapped(mapping))
3680 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003681
Al Virof0b65f32021-04-30 10:26:41 -04003682 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
Nick Pigginafddba42007-10-16 01:25:01 -07003683 flush_dcache_page(page);
3684
3685 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3686 page, fsdata);
Al Virof0b65f32021-04-30 10:26:41 -04003687 if (unlikely(status != copied)) {
3688 iov_iter_revert(i, copied - max(status, 0L));
3689 if (unlikely(status < 0))
3690 break;
3691 }
Nick Pigginafddba42007-10-16 01:25:01 -07003692 cond_resched();
3693
Al Virobc1bb412021-05-31 00:32:44 -04003694 if (unlikely(status == 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07003695 /*
Al Virobc1bb412021-05-31 00:32:44 -04003696 * A short copy made ->write_end() reject the
3697 * thing entirely. Might be memory poisoning
3698 * halfway through, might be a race with munmap,
3699 * might be severe memory pressure.
Nick Pigginafddba42007-10-16 01:25:01 -07003700 */
Al Virobc1bb412021-05-31 00:32:44 -04003701 if (copied)
3702 bytes = copied;
Nick Pigginafddba42007-10-16 01:25:01 -07003703 goto again;
3704 }
Al Virof0b65f32021-04-30 10:26:41 -04003705 pos += status;
3706 written += status;
Nick Pigginafddba42007-10-16 01:25:01 -07003707
3708 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003709 } while (iov_iter_count(i));
3710
3711 return written ? written : status;
3712}
Al Viro3b93f912014-02-11 21:34:08 -05003713EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003714
Jan Karae4dd9de2009-08-17 18:10:06 +02003715/**
Al Viro81742022014-04-03 03:17:43 -04003716 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003717 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003718 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003719 *
3720 * This function does all the work needed for actually writing data to a
3721 * file. It does all basic checks, removes SUID from the file, updates
3722 * modification times and calls proper subroutines depending on whether we
3723 * do direct IO or a standard buffered write.
3724 *
3725 * It expects i_mutex to be grabbed unless we work on a block device or similar
3726 * object which does not need locking at all.
3727 *
3728 * This function does *not* take care of syncing data in case of O_SYNC write.
3729 * A caller has to handle it. This is mainly due to the fact that we want to
3730 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003731 *
3732 * Return:
3733 * * number of bytes written, even for truncated writes
3734 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003735 */
Al Viro81742022014-04-03 03:17:43 -04003736ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003737{
3738 struct file *file = iocb->ki_filp;
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003739 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003740 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003741 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003742 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003743 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003744
Linus Torvalds1da177e2005-04-16 15:20:36 -07003745 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003746 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003747 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003748 if (err)
3749 goto out;
3750
Josef Bacikc3b2da32012-03-26 09:59:21 -04003751 err = file_update_time(file);
3752 if (err)
3753 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003754
Al Viro2ba48ce2015-04-09 13:52:01 -04003755 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003756 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003757
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003758 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003759 /*
3760 * If the write stopped short of completing, fall back to
3761 * buffered writes. Some filesystems do this for writes to
3762 * holes, for example. For DAX files, a buffered write will
3763 * not succeed (even if it did, DAX does not handle dirty
3764 * page-cache pages correctly).
3765 */
Al Viro0b8def92015-04-07 10:22:53 -04003766 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003767 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003768
Al Viro0b8def92015-04-07 10:22:53 -04003769 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003770 /*
Al Viro3b93f912014-02-11 21:34:08 -05003771 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003772 * then we want to return the number of bytes which were
3773 * direct-written, or the error code if that was zero. Note
3774 * that this differs from normal direct-io semantics, which
3775 * will return -EFOO even if some bytes were written.
3776 */
Al Viro60bb4522014-08-08 12:39:16 -04003777 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003778 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003779 goto out;
3780 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003781 /*
3782 * We need to ensure that the page cache pages are written to
3783 * disk and invalidated to preserve the expected O_DIRECT
3784 * semantics.
3785 */
Al Viro3b93f912014-02-11 21:34:08 -05003786 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003787 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003788 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003789 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003790 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003791 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003792 pos >> PAGE_SHIFT,
3793 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003794 } else {
3795 /*
3796 * We don't know how much we wrote, so just return
3797 * the number of bytes which were direct-written
3798 */
3799 }
3800 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003801 written = generic_perform_write(file, from, iocb->ki_pos);
3802 if (likely(written > 0))
3803 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003804 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003805out:
3806 current->backing_dev_info = NULL;
3807 return written ? written : err;
3808}
Al Viro81742022014-04-03 03:17:43 -04003809EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003810
Jan Karae4dd9de2009-08-17 18:10:06 +02003811/**
Al Viro81742022014-04-03 03:17:43 -04003812 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003813 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003814 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003815 *
Al Viro81742022014-04-03 03:17:43 -04003816 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003817 * filesystems. It takes care of syncing the file in case of O_SYNC file
3818 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003819 * Return:
3820 * * negative error code if no data has been written at all of
3821 * vfs_fsync_range() failed for a synchronous write
3822 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003823 */
Al Viro81742022014-04-03 03:17:43 -04003824ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003825{
3826 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003827 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003828 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003829
Al Viro59551022016-01-22 15:40:57 -05003830 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003831 ret = generic_write_checks(iocb, from);
3832 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003833 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003834 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003835
Christoph Hellwige2592212016-04-07 08:52:01 -07003836 if (ret > 0)
3837 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003838 return ret;
3839}
Al Viro81742022014-04-03 03:17:43 -04003840EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003841
David Howellscf9a2ae2006-08-29 19:05:54 +01003842/**
3843 * try_to_release_page() - release old fs-specific metadata on a page
3844 *
3845 * @page: the page which the kernel is trying to free
3846 * @gfp_mask: memory allocation flags (and I/O mode)
3847 *
3848 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003849 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003850 *
David Howells266cf652009-04-03 16:42:36 +01003851 * This may also be called if PG_fscache is set on a page, indicating that the
3852 * page is known to the local caching routines.
3853 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003854 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003855 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003856 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003857 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003858 */
3859int try_to_release_page(struct page *page, gfp_t gfp_mask)
3860{
3861 struct address_space * const mapping = page->mapping;
3862
3863 BUG_ON(!PageLocked(page));
3864 if (PageWriteback(page))
3865 return 0;
3866
3867 if (mapping && mapping->a_ops->releasepage)
3868 return mapping->a_ops->releasepage(page, gfp_mask);
3869 return try_to_free_buffers(page);
3870}
3871
3872EXPORT_SYMBOL(try_to_release_page);