blob: 4926f16ec52db3931cb4abdaef945b05da7b24c9 [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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261
Matt Mackallcd7619d2005-05-01 08:59:01 -0700262 BUG_ON(!PageLocked(page));
Johannes Weiner30472502021-09-02 14:53:18 -0700263 xa_lock_irq(&mapping->i_pages);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700264 __delete_from_page_cache(page, NULL);
Johannes Weiner30472502021-09-02 14:53:18 -0700265 xa_unlock_irq(&mapping->i_pages);
Linus Torvalds6072d132010-12-01 13:35:19 -0500266
Jan Kara59c66c52017-11-15 17:37:18 -0800267 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700268}
269EXPORT_SYMBOL(delete_from_page_cache);
270
Jan Karaaa65c292017-11-15 17:37:33 -0800271/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500272 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800273 * @mapping: the mapping to which pages belong
274 * @pvec: pagevec with pages to delete
275 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700276 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700277 * from the mapping. The function expects @pvec to be sorted by page index
278 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700279 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800280 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700281 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800282 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700283 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800284 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500285static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800286 struct pagevec *pvec)
287{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500288 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800289 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700290 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800291 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800292
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500293 mapping_set_update(&xas, mapping);
294 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700295 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800296 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700297
298 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400299 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800300 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700301 /*
302 * A page got inserted in our range? Skip it. We have our
303 * pages locked so they are protected from being removed.
304 * If we see a page whose index is higher than ours, it
305 * means our page has been removed, which shouldn't be
306 * possible because we're holding the PageLock.
307 */
308 if (page != pvec->pages[i]) {
309 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
310 page);
311 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700312 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700313
314 WARN_ON_ONCE(!PageLocked(page));
315
316 if (page->index == xas.xa_index)
317 page->mapping = NULL;
318 /* Leave page->index set: truncation lookup relies on it */
319
320 /*
321 * Move to the next page in the vector if this is a regular
322 * page or the index is of the last sub-page of this compound
323 * page.
324 */
325 if (page->index + compound_nr(page) - 1 == xas.xa_index)
326 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500327 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800328 total_pages++;
329 }
330 mapping->nrpages -= total_pages;
331}
332
333void delete_from_page_cache_batch(struct address_space *mapping,
334 struct pagevec *pvec)
335{
336 int i;
Jan Karaaa65c292017-11-15 17:37:33 -0800337
338 if (!pagevec_count(pvec))
339 return;
340
Johannes Weiner30472502021-09-02 14:53:18 -0700341 xa_lock_irq(&mapping->i_pages);
Jan Karaaa65c292017-11-15 17:37:33 -0800342 for (i = 0; i < pagevec_count(pvec); i++) {
343 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
344
345 unaccount_page_cache_page(mapping, pvec->pages[i]);
346 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500347 page_cache_delete_batch(mapping, pvec);
Johannes Weiner30472502021-09-02 14:53:18 -0700348 xa_unlock_irq(&mapping->i_pages);
Jan Karaaa65c292017-11-15 17:37:33 -0800349
350 for (i = 0; i < pagevec_count(pvec); i++)
351 page_cache_free_page(mapping, pvec->pages[i]);
352}
353
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200354int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700355{
356 int ret = 0;
357 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700358 if (test_bit(AS_ENOSPC, &mapping->flags) &&
359 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700360 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700361 if (test_bit(AS_EIO, &mapping->flags) &&
362 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700363 ret = -EIO;
364 return ret;
365}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200366EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700367
Jeff Layton76341ca2017-07-06 07:02:22 -0400368static int filemap_check_and_keep_errors(struct address_space *mapping)
369{
370 /* Check for outstanding write errors */
371 if (test_bit(AS_EIO, &mapping->flags))
372 return -EIO;
373 if (test_bit(AS_ENOSPC, &mapping->flags))
374 return -ENOSPC;
375 return 0;
376}
377
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700379 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700380 * @mapping: address space structure to write
381 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800382 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700383 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700385 * Start writeback against all of a mapping's dirty pages that lie
386 * within the byte offsets <start, end> inclusive.
387 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700389 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 * these two operations is that if a dirty page/buffer is encountered, it must
391 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800392 *
393 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800395int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
396 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397{
398 int ret;
399 struct writeback_control wbc = {
400 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800401 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700402 .range_start = start,
403 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 };
405
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200406 if (!mapping_can_writeback(mapping) ||
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700407 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 return 0;
409
Tejun Heob16b1de2015-06-02 08:39:48 -0600410 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600412 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 return ret;
414}
415
416static inline int __filemap_fdatawrite(struct address_space *mapping,
417 int sync_mode)
418{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700419 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420}
421
422int filemap_fdatawrite(struct address_space *mapping)
423{
424 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
425}
426EXPORT_SYMBOL(filemap_fdatawrite);
427
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400428int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800429 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430{
431 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
432}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400433EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Randy Dunlap485bb992006-06-23 02:03:49 -0700435/**
436 * filemap_flush - mostly a non-blocking flush
437 * @mapping: target address_space
438 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 * This is a mostly non-blocking flush. Not suitable for data-integrity
440 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800441 *
442 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 */
444int filemap_flush(struct address_space *mapping)
445{
446 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
447}
448EXPORT_SYMBOL(filemap_flush);
449
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500450/**
451 * filemap_range_has_page - check if a page exists in range.
452 * @mapping: address space within which to check
453 * @start_byte: offset in bytes where the range starts
454 * @end_byte: offset in bytes where the range ends (inclusive)
455 *
456 * Find at least one page in the range supplied, usually used to check if
457 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800458 *
459 * Return: %true if at least one page exists in the specified range,
460 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500461 */
462bool filemap_range_has_page(struct address_space *mapping,
463 loff_t start_byte, loff_t end_byte)
464{
Jan Karaf7b68042017-09-06 16:21:40 -0700465 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500466 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
467 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500468
469 if (end_byte < start_byte)
470 return false;
471
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500472 rcu_read_lock();
473 for (;;) {
474 page = xas_find(&xas, max);
475 if (xas_retry(&xas, page))
476 continue;
477 /* Shadow entries don't count */
478 if (xa_is_value(page))
479 continue;
480 /*
481 * We don't need to try to pin this page; we're about to
482 * release the RCU lock anyway. It is enough to know that
483 * there was a page here recently.
484 */
485 break;
486 }
487 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500488
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500489 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500490}
491EXPORT_SYMBOL(filemap_range_has_page);
492
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400493static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800494 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300496 pgoff_t index = start_byte >> PAGE_SHIFT;
497 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 struct pagevec pvec;
499 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200501 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400502 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Mel Gorman86679822017-11-15 17:37:52 -0800504 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800505 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 unsigned i;
507
Jan Kara312e9d22017-11-15 17:35:05 -0800508 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800509 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800510 if (!nr_pages)
511 break;
512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 for (i = 0; i < nr_pages; i++) {
514 struct page *page = pvec.pages[i];
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400517 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 }
519 pagevec_release(&pvec);
520 cond_resched();
521 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800522}
523
524/**
525 * filemap_fdatawait_range - wait for writeback to complete
526 * @mapping: address space structure to wait for
527 * @start_byte: offset in bytes where the range starts
528 * @end_byte: offset in bytes where the range ends (inclusive)
529 *
530 * Walk the list of under-writeback pages of the given address space
531 * in the given range and wait for all of them. Check error status of
532 * the address space and return it.
533 *
534 * Since the error status of the address space is cleared by this function,
535 * callers are responsible for checking the return value and handling and/or
536 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800537 *
538 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800539 */
540int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
541 loff_t end_byte)
542{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400543 __filemap_fdatawait_range(mapping, start_byte, end_byte);
544 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200546EXPORT_SYMBOL(filemap_fdatawait_range);
547
548/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400549 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
550 * @mapping: address space structure to wait for
551 * @start_byte: offset in bytes where the range starts
552 * @end_byte: offset in bytes where the range ends (inclusive)
553 *
554 * Walk the list of under-writeback pages of the given address space in the
555 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
556 * this function does not clear error status of the address space.
557 *
558 * Use this function if callers don't handle errors themselves. Expected
559 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
560 * fsfreeze(8)
561 */
562int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
563 loff_t start_byte, loff_t end_byte)
564{
565 __filemap_fdatawait_range(mapping, start_byte, end_byte);
566 return filemap_check_and_keep_errors(mapping);
567}
568EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
569
570/**
Jeff Laytona823e452017-07-28 07:24:43 -0400571 * file_fdatawait_range - wait for writeback to complete
572 * @file: file pointing to address space structure to wait for
573 * @start_byte: offset in bytes where the range starts
574 * @end_byte: offset in bytes where the range ends (inclusive)
575 *
576 * Walk the list of under-writeback pages of the address space that file
577 * refers to, in the given range and wait for all of them. Check error
578 * status of the address space vs. the file->f_wb_err cursor and return it.
579 *
580 * Since the error status of the file is advanced by this function,
581 * callers are responsible for checking the return value and handling and/or
582 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800583 *
584 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400585 */
586int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
587{
588 struct address_space *mapping = file->f_mapping;
589
590 __filemap_fdatawait_range(mapping, start_byte, end_byte);
591 return file_check_and_advance_wb_err(file);
592}
593EXPORT_SYMBOL(file_fdatawait_range);
594
595/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800596 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
597 * @mapping: address space structure to wait for
598 *
599 * Walk the list of under-writeback pages of the given address space
600 * and wait for all of them. Unlike filemap_fdatawait(), this function
601 * does not clear error status of the address space.
602 *
603 * Use this function if callers don't handle errors themselves. Expected
604 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
605 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800606 *
607 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800608 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400609int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800610{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400611 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400612 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800613}
Jeff Layton76341ca2017-07-06 07:02:22 -0400614EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800615
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700616/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400617static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700619 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Randy Dunlap485bb992006-06-23 02:03:49 -0700622/**
Jens Axboe63135aa2021-04-29 22:55:18 -0700623 * filemap_range_needs_writeback - check if range potentially needs writeback
624 * @mapping: address space within which to check
625 * @start_byte: offset in bytes where the range starts
626 * @end_byte: offset in bytes where the range ends (inclusive)
627 *
628 * Find at least one page in the range supplied, usually used to check if
629 * direct writing in this range will trigger a writeback. Used by O_DIRECT
630 * read/write with IOCB_NOWAIT, to see if the caller needs to do
631 * filemap_write_and_wait_range() before proceeding.
632 *
633 * Return: %true if the caller should do filemap_write_and_wait_range() before
634 * doing O_DIRECT to a page in this range, %false otherwise.
635 */
636bool filemap_range_needs_writeback(struct address_space *mapping,
637 loff_t start_byte, loff_t end_byte)
638{
639 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
640 pgoff_t max = end_byte >> PAGE_SHIFT;
641 struct page *page;
642
643 if (!mapping_needs_writeback(mapping))
644 return false;
645 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
646 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
647 return false;
648 if (end_byte < start_byte)
649 return false;
650
651 rcu_read_lock();
652 xas_for_each(&xas, page, max) {
653 if (xas_retry(&xas, page))
654 continue;
655 if (xa_is_value(page))
656 continue;
657 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
658 break;
659 }
660 rcu_read_unlock();
661 return page != NULL;
662}
663EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
664
665/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700666 * filemap_write_and_wait_range - write out & wait on a file range
667 * @mapping: the address_space for the pages
668 * @lstart: offset in bytes where the range starts
669 * @lend: offset in bytes where the range ends (inclusive)
670 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800671 * Write out and wait upon file offsets lstart->lend, inclusive.
672 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300673 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800674 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800675 *
676 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800677 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678int filemap_write_and_wait_range(struct address_space *mapping,
679 loff_t lstart, loff_t lend)
680{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800681 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Jeff Layton9326c9b2017-07-26 10:21:11 -0400683 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800684 err = __filemap_fdatawrite_range(mapping, lstart, lend,
685 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800686 /*
687 * Even if the above returned error, the pages may be
688 * written partially (e.g. -ENOSPC), so we wait for it.
689 * But the -EIO is special case, it may indicate the worst
690 * thing (e.g. bug) happened, so we avoid waiting for it.
691 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800692 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200693 int err2 = filemap_fdatawait_range(mapping,
694 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800695 if (!err)
696 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400697 } else {
698 /* Clear any previously stored errors */
699 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800700 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700701 } else {
702 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800704 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705}
Chris Masonf6995582009-04-15 13:22:37 -0400706EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Jeff Layton5660e132017-07-06 07:02:25 -0400708void __filemap_set_wb_err(struct address_space *mapping, int err)
709{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400710 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400711
712 trace_filemap_set_wb_err(mapping, eseq);
713}
714EXPORT_SYMBOL(__filemap_set_wb_err);
715
716/**
717 * file_check_and_advance_wb_err - report wb error (if any) that was previously
718 * and advance wb_err to current one
719 * @file: struct file on which the error is being reported
720 *
721 * When userland calls fsync (or something like nfsd does the equivalent), we
722 * want to report any writeback errors that occurred since the last fsync (or
723 * since the file was opened if there haven't been any).
724 *
725 * Grab the wb_err from the mapping. If it matches what we have in the file,
726 * then just quickly return 0. The file is all caught up.
727 *
728 * If it doesn't match, then take the mapping value, set the "seen" flag in
729 * it and try to swap it into place. If it works, or another task beat us
730 * to it with the new value, then update the f_wb_err and return the error
731 * portion. The error at this point must be reported via proper channels
732 * (a'la fsync, or NFS COMMIT operation, etc.).
733 *
734 * While we handle mapping->wb_err with atomic operations, the f_wb_err
735 * value is protected by the f_lock since we must ensure that it reflects
736 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800737 *
738 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400739 */
740int file_check_and_advance_wb_err(struct file *file)
741{
742 int err = 0;
743 errseq_t old = READ_ONCE(file->f_wb_err);
744 struct address_space *mapping = file->f_mapping;
745
746 /* Locklessly handle the common case where nothing has changed */
747 if (errseq_check(&mapping->wb_err, old)) {
748 /* Something changed, must use slow path */
749 spin_lock(&file->f_lock);
750 old = file->f_wb_err;
751 err = errseq_check_and_advance(&mapping->wb_err,
752 &file->f_wb_err);
753 trace_file_check_and_advance_wb_err(file, old);
754 spin_unlock(&file->f_lock);
755 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700756
757 /*
758 * We're mostly using this function as a drop in replacement for
759 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
760 * that the legacy code would have had on these flags.
761 */
762 clear_bit(AS_EIO, &mapping->flags);
763 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400764 return err;
765}
766EXPORT_SYMBOL(file_check_and_advance_wb_err);
767
768/**
769 * file_write_and_wait_range - write out & wait on a file range
770 * @file: file pointing to address_space with pages
771 * @lstart: offset in bytes where the range starts
772 * @lend: offset in bytes where the range ends (inclusive)
773 *
774 * Write out and wait upon file offsets lstart->lend, inclusive.
775 *
776 * Note that @lend is inclusive (describes the last byte to be written) so
777 * that this function can be used to write to the very end-of-file (end = -1).
778 *
779 * After writing out and waiting on the data, we check and advance the
780 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800781 *
782 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400783 */
784int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
785{
786 int err = 0, err2;
787 struct address_space *mapping = file->f_mapping;
788
Jeff Layton9326c9b2017-07-26 10:21:11 -0400789 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400790 err = __filemap_fdatawrite_range(mapping, lstart, lend,
791 WB_SYNC_ALL);
792 /* See comment of filemap_write_and_wait() */
793 if (err != -EIO)
794 __filemap_fdatawait_range(mapping, lstart, lend);
795 }
796 err2 = file_check_and_advance_wb_err(file);
797 if (!err)
798 err = err2;
799 return err;
800}
801EXPORT_SYMBOL(file_write_and_wait_range);
802
Randy Dunlap485bb992006-06-23 02:03:49 -0700803/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700804 * replace_page_cache_page - replace a pagecache page with a new one
805 * @old: page to be replaced
806 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700807 *
808 * This function replaces a page in the pagecache with a new one. On
809 * success it acquires the pagecache reference for the new page and
810 * drops it for the old page. Both the old and new pages must be
811 * locked. This function does not add the new page to the LRU, the
812 * caller must do that.
813 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500814 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700815 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800816void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700817{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500818 struct address_space *mapping = old->mapping;
819 void (*freepage)(struct page *) = mapping->a_ops->freepage;
820 pgoff_t offset = old->index;
821 XA_STATE(xas, &mapping->i_pages, offset);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700822
Sasha Levin309381fea2014-01-23 15:52:54 -0800823 VM_BUG_ON_PAGE(!PageLocked(old), old);
824 VM_BUG_ON_PAGE(!PageLocked(new), new);
825 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700826
Matthew Wilcox74d60952017-11-17 10:01:45 -0500827 get_page(new);
828 new->mapping = mapping;
829 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700830
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700831 mem_cgroup_migrate(old, new);
832
Johannes Weiner30472502021-09-02 14:53:18 -0700833 xas_lock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500834 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700835
Matthew Wilcox74d60952017-11-17 10:01:45 -0500836 old->mapping = NULL;
837 /* hugetlb pages do not participate in page cache accounting. */
838 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700839 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500840 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700841 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500842 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700843 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500844 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700845 __inc_lruvec_page_state(new, NR_SHMEM);
Johannes Weiner30472502021-09-02 14:53:18 -0700846 xas_unlock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500847 if (freepage)
848 freepage(old);
849 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700850}
851EXPORT_SYMBOL_GPL(replace_page_cache_page);
852
Andrew Morton16c0cc02020-12-11 13:36:27 -0800853noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700854 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700855 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700856 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500858 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700859 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700860 int error;
Waiman Longda742402021-02-04 18:32:45 -0800861 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700862
Sasha Levin309381fea2014-01-23 15:52:54 -0800863 VM_BUG_ON_PAGE(!PageLocked(page), page);
864 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500865 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700866
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300867 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700868 page->mapping = mapping;
869 page->index = offset;
870
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700871 if (!huge) {
Dan Schatzberg04f94e32021-06-28 19:38:18 -0700872 error = mem_cgroup_charge(page, NULL, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700873 if (error)
874 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800875 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700876 }
877
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700878 gfp &= GFP_RECLAIM_MASK;
879
Matthew Wilcox74d60952017-11-17 10:01:45 -0500880 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700881 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
882 void *entry, *old = NULL;
883
884 if (order > thp_order(page))
885 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
886 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500887 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700888 xas_for_each_conflict(&xas, entry) {
889 old = entry;
890 if (!xa_is_value(entry)) {
891 xas_set_err(&xas, -EEXIST);
892 goto unlock;
893 }
894 }
895
896 if (old) {
897 if (shadowp)
898 *shadowp = old;
899 /* entry may have been split before we acquired lock */
900 order = xa_get_order(xas.xa, xas.xa_index);
901 if (order > thp_order(page)) {
902 xas_split(&xas, old, order);
903 xas_reset(&xas);
904 }
905 }
906
Matthew Wilcox74d60952017-11-17 10:01:45 -0500907 xas_store(&xas, page);
908 if (xas_error(&xas))
909 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700910
Matthew Wilcox74d60952017-11-17 10:01:45 -0500911 mapping->nrpages++;
912
913 /* hugetlb pages do not participate in page cache accounting */
914 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700915 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500916unlock:
917 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700918 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500919
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700920 if (xas_error(&xas)) {
921 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800922 if (charged)
923 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500924 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700925 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500926
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700927 trace_mm_filemap_add_to_page_cache(page);
928 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500929error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700930 page->mapping = NULL;
931 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300932 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700933 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700935ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700936
937/**
938 * add_to_page_cache_locked - add a locked page to the pagecache
939 * @page: page to add
940 * @mapping: the page's address_space
941 * @offset: page index
942 * @gfp_mask: page allocation mode
943 *
944 * This function is used to add a page to the pagecache. It must be locked.
945 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800946 *
947 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700948 */
949int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
950 pgoff_t offset, gfp_t gfp_mask)
951{
952 return __add_to_page_cache_locked(page, mapping, offset,
953 gfp_mask, NULL);
954}
Nick Piggine2867812008-07-25 19:45:30 -0700955EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
957int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400958 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959{
Johannes Weinera5289102014-04-03 14:47:51 -0700960 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700961 int ret;
962
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800963 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700964 ret = __add_to_page_cache_locked(page, mapping, offset,
965 gfp_mask, &shadow);
966 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800967 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700968 else {
969 /*
970 * The page might have been evicted from cache only
971 * recently, in which case it should be activated like
972 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700973 * The exception is pages getting rewritten; evicting other
974 * data from the working set, only to cache data that will
975 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700976 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700977 WARN_ON_ONCE(PageActive(page));
978 if (!(gfp_mask & __GFP_WRITE) && shadow)
979 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700980 lru_cache_add(page);
981 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982 return ret;
983}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300984EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985
Paul Jackson44110fe2006-03-24 03:16:04 -0800986#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700987struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800988{
Miao Xiec0ff7452010-05-24 14:32:08 -0700989 int n;
990 struct page *page;
991
Paul Jackson44110fe2006-03-24 03:16:04 -0800992 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700993 unsigned int cpuset_mems_cookie;
994 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700995 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700996 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700997 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700998 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700999
Miao Xiec0ff7452010-05-24 14:32:08 -07001000 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -08001001 }
Nick Piggin2ae88142006-10-28 10:38:23 -07001002 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -08001003}
Nick Piggin2ae88142006-10-28 10:38:23 -07001004EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -08001005#endif
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007/*
1008 * In order to wait for pages to become available there must be
1009 * waitqueues associated with pages. By using a hash table of
1010 * waitqueues where the bucket discipline is to maintain all
1011 * waiters on the same queue and wake all when any of the pages
1012 * become available, and for the woken contexts to check to be
1013 * sure the appropriate page became available, this saves space
1014 * at a cost of "thundering herd" phenomena during rare hash
1015 * collisions.
1016 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001017#define PAGE_WAIT_TABLE_BITS 8
1018#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1019static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1020
1021static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022{
Nicholas Piggin62906022016-12-25 13:00:30 +10001023 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024}
Nicholas Piggin62906022016-12-25 13:00:30 +10001025
1026void __init pagecache_init(void)
1027{
1028 int i;
1029
1030 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1031 init_waitqueue_head(&page_wait_table[i]);
1032
1033 page_writeback_init();
1034}
1035
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001036/*
1037 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001038 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001039 * one.
1040 *
1041 * We have:
1042 *
1043 * (a) no special bits set:
1044 *
1045 * We're just waiting for the bit to be released, and when a waker
1046 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1047 * and remove it from the wait queue.
1048 *
1049 * Simple and straightforward.
1050 *
1051 * (b) WQ_FLAG_EXCLUSIVE:
1052 *
1053 * The waiter is waiting to get the lock, and only one waiter should
1054 * be woken up to avoid any thundering herd behavior. We'll set the
1055 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1056 *
1057 * This is the traditional exclusive wait.
1058 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001059 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001060 *
1061 * The waiter is waiting to get the bit, and additionally wants the
1062 * lock to be transferred to it for fair lock behavior. If the lock
1063 * cannot be taken, we stop walking the wait queue without waking
1064 * the waiter.
1065 *
1066 * This is the "fair lock handoff" case, and in addition to setting
1067 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1068 * that it now has the lock.
1069 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001070static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001071{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001072 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001073 struct wait_page_key *key = arg;
1074 struct wait_page_queue *wait_page
1075 = container_of(wait, struct wait_page_queue, wait);
1076
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001077 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001078 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001079
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001080 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001081 * If it's a lock handoff wait, we get the bit for it, and
1082 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001083 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001084 flags = wait->flags;
1085 if (flags & WQ_FLAG_EXCLUSIVE) {
1086 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001087 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001088 if (flags & WQ_FLAG_CUSTOM) {
1089 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1090 return -1;
1091 flags |= WQ_FLAG_DONE;
1092 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001093 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001094
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001095 /*
1096 * We are holding the wait-queue lock, but the waiter that
1097 * is waiting for this will be checking the flags without
1098 * any locking.
1099 *
1100 * So update the flags atomically, and wake up the waiter
1101 * afterwards to avoid any races. This store-release pairs
1102 * with the load-acquire in wait_on_page_bit_common().
1103 */
1104 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001105 wake_up_state(wait->private, mode);
1106
1107 /*
1108 * Ok, we have successfully done what we're waiting for,
1109 * and we can unconditionally remove the wait entry.
1110 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001111 * Note that this pairs with the "finish_wait()" in the
1112 * waiter, and has to be the absolute last thing we do.
1113 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001114 * might be de-allocated and the process might even have
1115 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001116 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001117 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001118 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001119}
1120
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001121static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001122{
1123 wait_queue_head_t *q = page_waitqueue(page);
1124 struct wait_page_key key;
1125 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001126 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001127
1128 key.page = page;
1129 key.bit_nr = bit_nr;
1130 key.page_match = 0;
1131
Tim Chen11a19c72017-08-25 09:13:55 -07001132 bookmark.flags = 0;
1133 bookmark.private = NULL;
1134 bookmark.func = NULL;
1135 INIT_LIST_HEAD(&bookmark.entry);
1136
Nicholas Piggin62906022016-12-25 13:00:30 +10001137 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001138 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1139
1140 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1141 /*
1142 * Take a breather from holding the lock,
1143 * allow pages that finish wake up asynchronously
1144 * to acquire the lock and remove themselves
1145 * from wait queue
1146 */
1147 spin_unlock_irqrestore(&q->lock, flags);
1148 cpu_relax();
1149 spin_lock_irqsave(&q->lock, flags);
1150 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1151 }
1152
Nicholas Piggin62906022016-12-25 13:00:30 +10001153 /*
1154 * It is possible for other pages to have collided on the waitqueue
1155 * hash, so in that case check for a page match. That prevents a long-
1156 * term waiter
1157 *
1158 * It is still possible to miss a case here, when we woke page waiters
1159 * and removed them from the waitqueue, but there are still other
1160 * page waiters.
1161 */
1162 if (!waitqueue_active(q) || !key.page_match) {
1163 ClearPageWaiters(page);
1164 /*
1165 * It's possible to miss clearing Waiters here, when we woke
1166 * our page waiters, but the hashed waitqueue has waiters for
1167 * other pages on it.
1168 *
1169 * That's okay, it's a rare case. The next waker will clear it.
1170 */
1171 }
1172 spin_unlock_irqrestore(&q->lock, flags);
1173}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001174
1175static void wake_up_page(struct page *page, int bit)
1176{
1177 if (!PageWaiters(page))
1178 return;
1179 wake_up_page_bit(page, bit);
1180}
Nicholas Piggin62906022016-12-25 13:00:30 +10001181
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001182/*
1183 * A choice of three behaviors for wait_on_page_bit_common():
1184 */
1185enum behavior {
1186 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1187 * __lock_page() waiting on then setting PG_locked.
1188 */
1189 SHARED, /* Hold ref to page and check the bit when woken, like
1190 * wait_on_page_writeback() waiting on PG_writeback.
1191 */
1192 DROP, /* Drop ref to page before wait, no check when woken,
1193 * like put_and_wait_on_page_locked() on PG_locked.
1194 */
1195};
1196
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001197/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001198 * Attempt to check (or get) the page bit, and mark us done
1199 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001200 */
1201static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1202 struct wait_queue_entry *wait)
1203{
1204 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1205 if (test_and_set_bit(bit_nr, &page->flags))
1206 return false;
1207 } else if (test_bit(bit_nr, &page->flags))
1208 return false;
1209
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001210 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001211 return true;
1212}
1213
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001214/* How many times do we accept lock stealing from under a waiter? */
1215int sysctl_page_lock_unfairness = 5;
1216
Nicholas Piggin62906022016-12-25 13:00:30 +10001217static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001218 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001219{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001220 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001221 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001222 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001223 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001224 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001225 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001226
Johannes Weinereb414682018-10-26 15:06:27 -07001227 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001228 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001229 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001230 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001231 delayacct = true;
1232 }
Johannes Weinereb414682018-10-26 15:06:27 -07001233 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001234 thrashing = true;
1235 }
1236
Nicholas Piggin62906022016-12-25 13:00:30 +10001237 init_wait(wait);
1238 wait->func = wake_page_function;
1239 wait_page.page = page;
1240 wait_page.bit_nr = bit_nr;
1241
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001242repeat:
1243 wait->flags = 0;
1244 if (behavior == EXCLUSIVE) {
1245 wait->flags = WQ_FLAG_EXCLUSIVE;
1246 if (--unfairness < 0)
1247 wait->flags |= WQ_FLAG_CUSTOM;
1248 }
1249
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001250 /*
1251 * Do one last check whether we can get the
1252 * page bit synchronously.
1253 *
1254 * Do the SetPageWaiters() marking before that
1255 * to let any waker we _just_ missed know they
1256 * need to wake us up (otherwise they'll never
1257 * even go to the slow case that looks at the
1258 * page queue), and add ourselves to the wait
1259 * queue if we need to sleep.
1260 *
1261 * This part needs to be done under the queue
1262 * lock to avoid races.
1263 */
1264 spin_lock_irq(&q->lock);
1265 SetPageWaiters(page);
1266 if (!trylock_page_bit_common(page, bit_nr, wait))
1267 __add_wait_queue_entry_tail(q, wait);
1268 spin_unlock_irq(&q->lock);
1269
1270 /*
1271 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001272 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1273 * see whether the page bit testing has already
1274 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001275 *
1276 * We can drop our reference to the page.
1277 */
1278 if (behavior == DROP)
1279 put_page(page);
1280
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001281 /*
1282 * Note that until the "finish_wait()", or until
1283 * we see the WQ_FLAG_WOKEN flag, we need to
1284 * be very careful with the 'wait->flags', because
1285 * we may race with a waker that sets them.
1286 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001287 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001288 unsigned int flags;
1289
Nicholas Piggin62906022016-12-25 13:00:30 +10001290 set_current_state(state);
1291
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001292 /* Loop until we've been woken or interrupted */
1293 flags = smp_load_acquire(&wait->flags);
1294 if (!(flags & WQ_FLAG_WOKEN)) {
1295 if (signal_pending_state(state, current))
1296 break;
1297
1298 io_schedule();
1299 continue;
1300 }
1301
1302 /* If we were non-exclusive, we're done */
1303 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001304 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001305
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001306 /* If the waker got the lock for us, we're done */
1307 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001308 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001309
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001310 /*
1311 * Otherwise, if we're getting the lock, we need to
1312 * try to get it ourselves.
1313 *
1314 * And if that fails, we'll have to retry this all.
1315 */
1316 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1317 goto repeat;
1318
1319 wait->flags |= WQ_FLAG_DONE;
1320 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001321 }
1322
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001323 /*
1324 * If a signal happened, this 'finish_wait()' may remove the last
1325 * waiter from the wait-queues, but the PageWaiters bit will remain
1326 * set. That's ok. The next wakeup will take care of it, and trying
1327 * to do it here would be difficult and prone to races.
1328 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001329 finish_wait(q, wait);
1330
Johannes Weinereb414682018-10-26 15:06:27 -07001331 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001332 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001333 delayacct_thrashing_end();
1334 psi_memstall_leave(&pflags);
1335 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001336
Nicholas Piggin62906022016-12-25 13:00:30 +10001337 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001338 * NOTE! The wait->flags weren't stable until we've done the
1339 * 'finish_wait()', and we could have exited the loop above due
1340 * to a signal, and had a wakeup event happen after the signal
1341 * test but before the 'finish_wait()'.
1342 *
1343 * So only after the finish_wait() can we reliably determine
1344 * if we got woken up or not, so we can now figure out the final
1345 * return value based on that state without races.
1346 *
1347 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1348 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001349 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001350 if (behavior == EXCLUSIVE)
1351 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001352
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001353 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001354}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355
Harvey Harrison920c7a52008-02-04 22:29:26 -08001356void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357{
Nicholas Piggin62906022016-12-25 13:00:30 +10001358 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001359 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360}
1361EXPORT_SYMBOL(wait_on_page_bit);
1362
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001363int wait_on_page_bit_killable(struct page *page, int bit_nr)
1364{
Nicholas Piggin62906022016-12-25 13:00:30 +10001365 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001366 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001367}
David Howells4343d002017-11-02 15:27:52 +00001368EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001369
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001371 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1372 * @page: The page to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001373 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001374 *
1375 * The caller should hold a reference on @page. They expect the page to
1376 * become unlocked relatively soon, but do not wish to hold up migration
1377 * (for example) by holding the reference while waiting for the page to
1378 * come unlocked. After this function returns, the caller should not
1379 * dereference @page.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001380 *
1381 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001382 */
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001383int put_and_wait_on_page_locked(struct page *page, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001384{
1385 wait_queue_head_t *q;
1386
1387 page = compound_head(page);
1388 q = page_waitqueue(page);
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001389 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001390}
1391
1392/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001393 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001394 * @page: Page defining the wait queue of interest
1395 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001396 *
1397 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1398 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001399void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001400{
1401 wait_queue_head_t *q = page_waitqueue(page);
1402 unsigned long flags;
1403
1404 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001405 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001406 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001407 spin_unlock_irqrestore(&q->lock, flags);
1408}
1409EXPORT_SYMBOL_GPL(add_page_wait_queue);
1410
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001411#ifndef clear_bit_unlock_is_negative_byte
1412
1413/*
1414 * PG_waiters is the high bit in the same byte as PG_lock.
1415 *
1416 * On x86 (and on many other architectures), we can clear PG_lock and
1417 * test the sign bit at the same time. But if the architecture does
1418 * not support that special operation, we just do this all by hand
1419 * instead.
1420 *
1421 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001422 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001423 * in the same byte as PG_locked.
1424 */
1425static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1426{
1427 clear_bit_unlock(nr, mem);
1428 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001429 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001430}
1431
1432#endif
1433
David Howells385e1ca5f2009-04-03 16:42:39 +01001434/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001435 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 * @page: the page
1437 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001438 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001440 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1442 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001443 * Note that this depends on PG_waiters being the sign bit in the byte
1444 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1445 * clear the PG_locked bit and test PG_waiters at the same time fairly
1446 * portably (architectures that do LL/SC can test any bit, while x86 can
1447 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001449void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001451 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001452 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001453 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001454 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1455 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456}
1457EXPORT_SYMBOL(unlock_page);
1458
Randy Dunlap485bb992006-06-23 02:03:49 -07001459/**
David Howells73e10de2020-02-10 10:00:21 +00001460 * end_page_private_2 - Clear PG_private_2 and release any waiters
1461 * @page: The page
1462 *
1463 * Clear the PG_private_2 bit on a page and wake up any sleepers waiting for
1464 * this. The page ref held for PG_private_2 being set is released.
1465 *
1466 * This is, for example, used when a netfs page is being written to a local
1467 * disk cache, thereby allowing writes to the cache for the same page to be
1468 * serialised.
1469 */
1470void end_page_private_2(struct page *page)
1471{
1472 page = compound_head(page);
1473 VM_BUG_ON_PAGE(!PagePrivate2(page), page);
1474 clear_bit_unlock(PG_private_2, &page->flags);
1475 wake_up_page_bit(page, PG_private_2);
1476 put_page(page);
1477}
1478EXPORT_SYMBOL(end_page_private_2);
1479
1480/**
1481 * wait_on_page_private_2 - Wait for PG_private_2 to be cleared on a page
1482 * @page: The page to wait on
1483 *
1484 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page.
1485 */
1486void wait_on_page_private_2(struct page *page)
1487{
1488 page = compound_head(page);
1489 while (PagePrivate2(page))
1490 wait_on_page_bit(page, PG_private_2);
1491}
1492EXPORT_SYMBOL(wait_on_page_private_2);
1493
1494/**
1495 * wait_on_page_private_2_killable - Wait for PG_private_2 to be cleared on a page
1496 * @page: The page to wait on
1497 *
1498 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page or until a
1499 * fatal signal is received by the calling task.
1500 *
1501 * Return:
1502 * - 0 if successful.
1503 * - -EINTR if a fatal signal was encountered.
1504 */
1505int wait_on_page_private_2_killable(struct page *page)
1506{
1507 int ret = 0;
1508
1509 page = compound_head(page);
1510 while (PagePrivate2(page)) {
1511 ret = wait_on_page_bit_killable(page, PG_private_2);
1512 if (ret < 0)
1513 break;
1514 }
1515
1516 return ret;
1517}
1518EXPORT_SYMBOL(wait_on_page_private_2_killable);
1519
1520/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001521 * end_page_writeback - end writeback against a page
1522 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 */
1524void end_page_writeback(struct page *page)
1525{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001526 /*
1527 * TestClearPageReclaim could be used here but it is an atomic
1528 * operation and overkill in this particular case. Failing to
1529 * shuffle a page marked for immediate reclaim is too mild to
1530 * justify taking an atomic operation penalty at the end of
1531 * ever page writeback.
1532 */
1533 if (PageReclaim(page)) {
1534 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001535 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001536 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001537
Hugh Dickins073861e2020-11-24 08:46:43 -08001538 /*
1539 * Writeback does not hold a page reference of its own, relying
1540 * on truncation to wait for the clearing of PG_writeback.
1541 * But here we must make sure that the page is not freed and
1542 * reused before the wake_up_page().
1543 */
1544 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001545 if (!test_clear_page_writeback(page))
1546 BUG();
1547
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001548 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001549 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001550 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551}
1552EXPORT_SYMBOL(end_page_writeback);
1553
Matthew Wilcox57d99842014-06-04 16:07:45 -07001554/*
1555 * After completing I/O on a page, call this routine to update the page
1556 * flags appropriately
1557 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001558void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001559{
Jens Axboec11f0c02016-08-05 08:11:04 -06001560 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001561 if (!err) {
1562 SetPageUptodate(page);
1563 } else {
1564 ClearPageUptodate(page);
1565 SetPageError(page);
1566 }
1567 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001568 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001569 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001570 struct address_space *mapping;
1571
Matthew Wilcox57d99842014-06-04 16:07:45 -07001572 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001573 mapping = page_mapping(page);
1574 if (mapping)
1575 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001576 }
1577 end_page_writeback(page);
1578 }
1579}
1580EXPORT_SYMBOL_GPL(page_endio);
1581
Randy Dunlap485bb992006-06-23 02:03:49 -07001582/**
1583 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001584 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001586void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587{
Nicholas Piggin62906022016-12-25 13:00:30 +10001588 struct page *page = compound_head(__page);
1589 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001590 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1591 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592}
1593EXPORT_SYMBOL(__lock_page);
1594
Nicholas Piggin62906022016-12-25 13:00:30 +10001595int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001596{
Nicholas Piggin62906022016-12-25 13:00:30 +10001597 struct page *page = compound_head(__page);
1598 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001599 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1600 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001601}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001602EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001603
Jens Axboedd3e6d52020-05-22 09:12:09 -06001604int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1605{
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001606 struct wait_queue_head *q = page_waitqueue(page);
1607 int ret = 0;
1608
1609 wait->page = page;
1610 wait->bit_nr = PG_locked;
1611
1612 spin_lock_irq(&q->lock);
1613 __add_wait_queue_entry_tail(q, &wait->wait);
1614 SetPageWaiters(page);
1615 ret = !trylock_page(page);
1616 /*
1617 * If we were successful now, we know we're still on the
1618 * waitqueue as we're still under the lock. This means it's
1619 * safe to remove and return success, we know the callback
1620 * isn't going to trigger.
1621 */
1622 if (!ret)
1623 __remove_wait_queue(q, &wait->wait);
1624 else
1625 ret = -EIOCBQUEUED;
1626 spin_unlock_irq(&q->lock);
1627 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001628}
1629
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001630/*
1631 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001632 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001633 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001634 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001635 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001636 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001637 *
1638 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001639 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001640 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001641int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1642 unsigned int flags)
1643{
Peter Xu4064b982020-04-01 21:08:45 -07001644 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001645 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001646 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001647 * even though return 0.
1648 */
1649 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1650 return 0;
1651
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001652 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001653 if (flags & FAULT_FLAG_KILLABLE)
1654 wait_on_page_locked_killable(page);
1655 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001656 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001657 return 0;
1658 }
Hailong Liu800bca72020-12-14 19:05:02 -08001659 if (flags & FAULT_FLAG_KILLABLE) {
1660 int ret;
1661
1662 ret = __lock_page_killable(page);
1663 if (ret) {
1664 mmap_read_unlock(mm);
1665 return 0;
1666 }
1667 } else {
1668 __lock_page(page);
1669 }
1670 return 1;
1671
Michel Lespinassed065bd82010-10-26 14:21:57 -07001672}
1673
Randy Dunlap485bb992006-06-23 02:03:49 -07001674/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001675 * page_cache_next_miss() - Find the next gap in the page cache.
1676 * @mapping: Mapping.
1677 * @index: Index.
1678 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001679 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001680 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1681 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001682 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001683 * This function may be called under the rcu_read_lock. However, this will
1684 * not atomically search a snapshot of the cache at a single point in time.
1685 * For example, if a gap is created at index 5, then subsequently a gap is
1686 * created at index 10, page_cache_next_miss covering both indices may
1687 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001688 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001689 * Return: The index of the gap if found, otherwise an index outside the
1690 * range specified (in which case 'return - index >= max_scan' will be true).
1691 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001692 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001693pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001694 pgoff_t index, unsigned long max_scan)
1695{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001696 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001697
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001698 while (max_scan--) {
1699 void *entry = xas_next(&xas);
1700 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001701 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001702 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001703 break;
1704 }
1705
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001706 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001707}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001708EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001709
1710/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001711 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001712 * @mapping: Mapping.
1713 * @index: Index.
1714 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001715 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001716 * Search the range [max(index - max_scan + 1, 0), index] for the
1717 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001718 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001719 * This function may be called under the rcu_read_lock. However, this will
1720 * not atomically search a snapshot of the cache at a single point in time.
1721 * For example, if a gap is created at index 10, then subsequently a gap is
1722 * created at index 5, page_cache_prev_miss() covering both indices may
1723 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001724 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001725 * Return: The index of the gap if found, otherwise an index outside the
1726 * range specified (in which case 'index - return >= max_scan' will be true).
1727 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001728 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001729pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001730 pgoff_t index, unsigned long max_scan)
1731{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001732 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001733
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001734 while (max_scan--) {
1735 void *entry = xas_prev(&xas);
1736 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001737 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001738 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001739 break;
1740 }
1741
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001742 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001743}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001744EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001745
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001746/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001747 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001748 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001749 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001750 *
Rui Sun4b17f032021-04-29 22:55:38 -07001751 * Looks up the page cache slot at @mapping & @index. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001752 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001753 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001754 * If the slot holds a shadow entry of a previously evicted page, or a
1755 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001756 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001757 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 */
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001759static struct page *mapping_get_entry(struct address_space *mapping,
1760 pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001762 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001763 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764
Nick Piggina60637c2008-07-25 19:45:31 -07001765 rcu_read_lock();
1766repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001767 xas_reset(&xas);
1768 page = xas_load(&xas);
1769 if (xas_retry(&xas, page))
1770 goto repeat;
1771 /*
1772 * A shadow entry of a recently evicted page, or a swap entry from
1773 * shmem/tmpfs. Return it without attempting to raise page count.
1774 */
1775 if (!page || xa_is_value(page))
1776 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001777
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001778 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001779 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001780
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001781 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001782 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001783 * This is part of the lockless pagecache protocol. See
1784 * include/linux/pagemap.h for details.
1785 */
1786 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001787 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001788 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001789 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001790out:
Nick Piggina60637c2008-07-25 19:45:31 -07001791 rcu_read_unlock();
1792
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 return page;
1794}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795
Randy Dunlap485bb992006-06-23 02:03:49 -07001796/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001797 * pagecache_get_page - Find and get a reference to a page.
1798 * @mapping: The address_space to search.
1799 * @index: The page index.
1800 * @fgp_flags: %FGP flags modify how the page is returned.
1801 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001802 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001803 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001804 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001805 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001806 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001807 * * %FGP_ACCESSED - The page will be marked accessed.
1808 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001809 * * %FGP_HEAD - If the page is present and a THP, return the head page
1810 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001811 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
1812 * instead of allocating a new page to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001813 * * %FGP_CREAT - If no page is present then a new page is allocated using
1814 * @gfp_mask and added to the page cache and the VM's LRU list.
1815 * The page is returned locked and with an increased refcount.
1816 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1817 * page is already in cache. If the page was allocated, unlock it before
1818 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001819 * * %FGP_WRITE - The page will be written
1820 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1821 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001822 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001823 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1824 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001825 *
1826 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001827 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001828 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001829 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001830struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1831 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832{
Nick Piggineb2be182007-10-16 01:24:57 -07001833 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835repeat:
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001836 page = mapping_get_entry(mapping, index);
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001837 if (xa_is_value(page)) {
1838 if (fgp_flags & FGP_ENTRY)
1839 return page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001840 page = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001841 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001842 if (!page)
1843 goto no_page;
1844
1845 if (fgp_flags & FGP_LOCK) {
1846 if (fgp_flags & FGP_NOWAIT) {
1847 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001848 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001849 return NULL;
1850 }
1851 } else {
1852 lock_page(page);
1853 }
1854
1855 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001856 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001857 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001858 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001859 goto repeat;
1860 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001861 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001862 }
1863
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001864 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001865 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001866 else if (fgp_flags & FGP_WRITE) {
1867 /* Clear idle flag for buffer write */
1868 if (page_is_idle(page))
1869 clear_page_idle(page);
1870 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001871 if (!(fgp_flags & FGP_HEAD))
1872 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001873
1874no_page:
1875 if (!page && (fgp_flags & FGP_CREAT)) {
1876 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001877 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001878 gfp_mask |= __GFP_WRITE;
1879 if (fgp_flags & FGP_NOFS)
1880 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001881
Michal Hocko45f87de2014-12-29 20:30:35 +01001882 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001883 if (!page)
1884 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001885
Josef Bacika75d4c32019-03-13 11:44:14 -07001886 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001887 fgp_flags |= FGP_LOCK;
1888
Hugh Dickinseb39d612014-08-06 16:06:43 -07001889 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001890 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001891 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001892
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001893 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001894 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001895 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001896 page = NULL;
1897 if (err == -EEXIST)
1898 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001900
1901 /*
1902 * add_to_page_cache_lru locks the page, and for mmap we expect
1903 * an unlocked page.
1904 */
1905 if (page && (fgp_flags & FGP_FOR_MMAP))
1906 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001908
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909 return page;
1910}
Mel Gorman2457aec2014-06-04 16:10:31 -07001911EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001913static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1914 xa_mark_t mark)
1915{
1916 struct page *page;
1917
1918retry:
1919 if (mark == XA_PRESENT)
1920 page = xas_find(xas, max);
1921 else
1922 page = xas_find_marked(xas, max, mark);
1923
1924 if (xas_retry(xas, page))
1925 goto retry;
1926 /*
1927 * A shadow entry of a recently evicted page, a swap
1928 * entry from shmem/tmpfs or a DAX entry. Return it
1929 * without attempting to raise page count.
1930 */
1931 if (!page || xa_is_value(page))
1932 return page;
1933
1934 if (!page_cache_get_speculative(page))
1935 goto reset;
1936
1937 /* Has the page moved or been split? */
1938 if (unlikely(page != xas_reload(xas))) {
1939 put_page(page);
1940 goto reset;
1941 }
1942
1943 return page;
1944reset:
1945 xas_reset(xas);
1946 goto retry;
1947}
1948
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001950 * find_get_entries - gang pagecache lookup
1951 * @mapping: The address_space to search
1952 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001953 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001954 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001955 * @indices: The cache indices corresponding to the entries in @entries
1956 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001957 * find_get_entries() will search for and return a batch of entries in
1958 * the mapping. The entries are placed in @pvec. find_get_entries()
1959 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001960 *
1961 * The search returns a group of mapping-contiguous page cache entries
1962 * with ascending indexes. There may be holes in the indices due to
1963 * not-present pages.
1964 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001965 * Any shadow entries of evicted pages, or swap entries from
1966 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001967 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001968 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1969 * stops at that page: the caller is likely to have a better way to handle
1970 * the compound page as a whole, and then skip its extent, than repeatedly
1971 * calling find_get_entries() to return all its tails.
1972 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001973 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001974 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001975unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001976 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07001977{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001978 XA_STATE(xas, &mapping->i_pages, start);
1979 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001980 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001981 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001982
1983 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001984 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07001985 /*
1986 * Terminate early on finding a THP, to allow the caller to
1987 * handle it all at once; but continue if this is hugetlbfs.
1988 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001989 if (!xa_is_value(page) && PageTransHuge(page) &&
1990 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07001991 page = find_subpage(page, xas.xa_index);
1992 nr_entries = ret + 1;
1993 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001994
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001995 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001996 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001997 if (++ret == nr_entries)
1998 break;
1999 }
2000 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002001
2002 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002003 return ret;
2004}
2005
2006/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002007 * find_lock_entries - Find a batch of pagecache entries.
2008 * @mapping: The address_space to search.
2009 * @start: The starting page cache index.
2010 * @end: The final page index (inclusive).
2011 * @pvec: Where the resulting entries are placed.
2012 * @indices: The cache indices of the entries in @pvec.
2013 *
2014 * find_lock_entries() will return a batch of entries from @mapping.
2015 * Swap, shadow and DAX entries are included. Pages are returned
2016 * locked and with an incremented refcount. Pages which are locked by
2017 * somebody else or under writeback are skipped. Only the head page of
2018 * a THP is returned. Pages which are partially outside the range are
2019 * not returned.
2020 *
2021 * The entries have ascending indexes. The indices may not be consecutive
2022 * due to not-present entries, THP pages, pages which could not be locked
2023 * or pages under writeback.
2024 *
2025 * Return: The number of entries which were found.
2026 */
2027unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2028 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2029{
2030 XA_STATE(xas, &mapping->i_pages, start);
2031 struct page *page;
2032
2033 rcu_read_lock();
2034 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2035 if (!xa_is_value(page)) {
2036 if (page->index < start)
2037 goto put;
2038 VM_BUG_ON_PAGE(page->index != xas.xa_index, page);
2039 if (page->index + thp_nr_pages(page) - 1 > end)
2040 goto put;
2041 if (!trylock_page(page))
2042 goto put;
2043 if (page->mapping != mapping || PageWriteback(page))
2044 goto unlock;
2045 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2046 page);
2047 }
2048 indices[pvec->nr] = xas.xa_index;
2049 if (!pagevec_add(pvec, page))
2050 break;
2051 goto next;
2052unlock:
2053 unlock_page(page);
2054put:
2055 put_page(page);
2056next:
Hugh Dickins2d11e732021-04-23 14:28:57 -07002057 if (!xa_is_value(page) && PageTransHuge(page)) {
2058 unsigned int nr_pages = thp_nr_pages(page);
2059
2060 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
2061 xas_set(&xas, page->index + nr_pages);
2062 if (xas.xa_index < nr_pages)
2063 break;
2064 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002065 }
2066 rcu_read_unlock();
2067
2068 return pagevec_count(pvec);
2069}
2070
2071/**
Jan Karab947cee2017-09-06 16:21:21 -07002072 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 * @mapping: The address_space to search
2074 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002075 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 * @nr_pages: The maximum number of pages
2077 * @pages: Where the resulting pages are placed
2078 *
Jan Karab947cee2017-09-06 16:21:21 -07002079 * find_get_pages_range() will search for and return a group of up to @nr_pages
2080 * pages in the mapping starting at index @start and up to index @end
2081 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2082 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 *
2084 * The search returns a group of mapping-contiguous pages with ascending
2085 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002086 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002088 * Return: the number of pages which were found. If this number is
2089 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002090 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 */
Jan Karab947cee2017-09-06 16:21:21 -07002092unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2093 pgoff_t end, unsigned int nr_pages,
2094 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002096 XA_STATE(xas, &mapping->i_pages, *start);
2097 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002098 unsigned ret = 0;
2099
2100 if (unlikely(!nr_pages))
2101 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
Nick Piggina60637c2008-07-25 19:45:31 -07002103 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002104 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002105 /* Skip over shadow, swap and DAX entries */
2106 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002107 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002108
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002109 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002110 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002111 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002112 goto out;
2113 }
Nick Piggina60637c2008-07-25 19:45:31 -07002114 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002115
Jan Karab947cee2017-09-06 16:21:21 -07002116 /*
2117 * We come here when there is no page beyond @end. We take care to not
2118 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002119 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002120 * already broken anyway.
2121 */
2122 if (end == (pgoff_t)-1)
2123 *start = (pgoff_t)-1;
2124 else
2125 *start = end + 1;
2126out:
Nick Piggina60637c2008-07-25 19:45:31 -07002127 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002128
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 return ret;
2130}
2131
Jens Axboeebf43502006-04-27 08:46:01 +02002132/**
2133 * find_get_pages_contig - gang contiguous pagecache lookup
2134 * @mapping: The address_space to search
2135 * @index: The starting page index
2136 * @nr_pages: The maximum number of pages
2137 * @pages: Where the resulting pages are placed
2138 *
2139 * find_get_pages_contig() works exactly like find_get_pages(), except
2140 * that the returned number of pages are guaranteed to be contiguous.
2141 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002142 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002143 */
2144unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2145 unsigned int nr_pages, struct page **pages)
2146{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002147 XA_STATE(xas, &mapping->i_pages, index);
2148 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002149 unsigned int ret = 0;
2150
2151 if (unlikely(!nr_pages))
2152 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002153
Nick Piggina60637c2008-07-25 19:45:31 -07002154 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002155 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002156 if (xas_retry(&xas, page))
2157 continue;
2158 /*
2159 * If the entry has been swapped out, we can stop looking.
2160 * No current caller is looking for DAX entries.
2161 */
2162 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002163 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002164
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002165 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002166 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002167
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002168 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002169 if (unlikely(page != xas_reload(&xas)))
2170 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002171
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002172 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002173 if (++ret == nr_pages)
2174 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002175 continue;
2176put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002177 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002178retry:
2179 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002180 }
Nick Piggina60637c2008-07-25 19:45:31 -07002181 rcu_read_unlock();
2182 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002183}
David Howellsef71c152007-05-09 02:33:44 -07002184EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002185
Randy Dunlap485bb992006-06-23 02:03:49 -07002186/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002187 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002188 * @mapping: the address_space to search
2189 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002190 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002191 * @tag: the tag index
2192 * @nr_pages: the maximum number of pages
2193 * @pages: where the resulting pages are placed
2194 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002195 * Like find_get_pages(), except we only return head pages which are tagged
2196 * with @tag. @index is updated to the index immediately after the last
2197 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002198 *
2199 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 */
Jan Kara72b045a2017-11-15 17:34:33 -08002201unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002202 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002203 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002205 XA_STATE(xas, &mapping->i_pages, *index);
2206 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002207 unsigned ret = 0;
2208
2209 if (unlikely(!nr_pages))
2210 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211
Nick Piggina60637c2008-07-25 19:45:31 -07002212 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002213 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002214 /*
2215 * Shadow entries should never be tagged, but this iteration
2216 * is lockless so there is a window for page reclaim to evict
2217 * a page we saw tagged. Skip over it.
2218 */
2219 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002220 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002221
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002222 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002223 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002224 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002225 goto out;
2226 }
Nick Piggina60637c2008-07-25 19:45:31 -07002227 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002228
Jan Kara72b045a2017-11-15 17:34:33 -08002229 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002230 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002231 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002232 * iteration when there is a page at index -1 but that is already
2233 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002234 */
2235 if (end == (pgoff_t)-1)
2236 *index = (pgoff_t)-1;
2237 else
2238 *index = end + 1;
2239out:
Nick Piggina60637c2008-07-25 19:45:31 -07002240 rcu_read_unlock();
2241
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 return ret;
2243}
Jan Kara72b045a2017-11-15 17:34:33 -08002244EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002246/*
2247 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2248 * a _large_ part of the i/o request. Imagine the worst scenario:
2249 *
2250 * ---R__________________________________________B__________
2251 * ^ reading here ^ bad block(assume 4k)
2252 *
2253 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2254 * => failing the whole request => read(R) => read(R+1) =>
2255 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2256 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2257 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2258 *
2259 * It is going insane. Fix it by quickly scaling down the readahead size.
2260 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002261static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002262{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002263 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002264}
2265
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002266/*
2267 * filemap_get_read_batch - Get a batch of pages for read
2268 *
2269 * Get a batch of pages which represent a contiguous range of bytes
2270 * in the file. No tail pages will be returned. If @index is in the
2271 * middle of a THP, the entire THP will be returned. The last page in
2272 * the batch may have Readahead set or be not Uptodate so that the
2273 * caller can take the appropriate action.
2274 */
2275static void filemap_get_read_batch(struct address_space *mapping,
2276 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2277{
2278 XA_STATE(xas, &mapping->i_pages, index);
2279 struct page *head;
2280
2281 rcu_read_lock();
2282 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2283 if (xas_retry(&xas, head))
2284 continue;
2285 if (xas.xa_index > max || xa_is_value(head))
2286 break;
2287 if (!page_cache_get_speculative(head))
2288 goto retry;
2289
2290 /* Has the page moved or been split? */
2291 if (unlikely(head != xas_reload(&xas)))
2292 goto put_page;
2293
2294 if (!pagevec_add(pvec, head))
2295 break;
2296 if (!PageUptodate(head))
2297 break;
2298 if (PageReadahead(head))
2299 break;
2300 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2301 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2302 continue;
2303put_page:
2304 put_page(head);
2305retry:
2306 xas_reset(&xas);
2307 }
2308 rcu_read_unlock();
2309}
2310
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002311static int filemap_read_page(struct file *file, struct address_space *mapping,
2312 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002313{
Kent Overstreet723ef242020-12-14 19:04:52 -08002314 int error;
2315
Kent Overstreet723ef242020-12-14 19:04:52 -08002316 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002317 * A previous I/O error may have been due to temporary failures,
2318 * eg. multipath errors. PG_error will be set again if readpage
2319 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002320 */
2321 ClearPageError(page);
2322 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002323 error = mapping->a_ops->readpage(file, page);
2324 if (error)
2325 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002326
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002327 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002328 if (error)
2329 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002330 if (PageUptodate(page))
2331 return 0;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002332 shrink_readahead_size_eio(&file->f_ra);
2333 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002334}
2335
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002336static bool filemap_range_uptodate(struct address_space *mapping,
2337 loff_t pos, struct iov_iter *iter, struct page *page)
2338{
2339 int count;
2340
2341 if (PageUptodate(page))
2342 return true;
2343 /* pipes can't handle partially uptodate pages */
2344 if (iov_iter_is_pipe(iter))
2345 return false;
2346 if (!mapping->a_ops->is_partially_uptodate)
2347 return false;
2348 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2349 return false;
2350
2351 count = iter->count;
2352 if (page_offset(page) > pos) {
2353 count -= page_offset(page) - pos;
2354 pos = 0;
2355 } else {
2356 pos -= page_offset(page);
2357 }
2358
2359 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2360}
2361
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002362static int filemap_update_page(struct kiocb *iocb,
2363 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002364 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002365{
Kent Overstreet723ef242020-12-14 19:04:52 -08002366 int error;
2367
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002368 if (!trylock_page(page)) {
2369 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2370 return -EAGAIN;
2371 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002372 put_and_wait_on_page_locked(page, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002373 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002374 }
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002375 error = __lock_page_async(page, iocb->ki_waitq);
2376 if (error)
2377 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002378 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002379
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002380 if (!page->mapping)
2381 goto truncated;
Kent Overstreet723ef242020-12-14 19:04:52 -08002382
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002383 error = 0;
2384 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, page))
2385 goto unlock;
2386
2387 error = -EAGAIN;
2388 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2389 goto unlock;
2390
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002391 error = filemap_read_page(iocb->ki_filp, mapping, page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002392 if (error == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002393 put_page(page);
2394 return error;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002395truncated:
2396 unlock_page(page);
2397 put_page(page);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002398 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002399unlock:
2400 unlock_page(page);
2401 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002402}
2403
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002404static int filemap_create_page(struct file *file,
2405 struct address_space *mapping, pgoff_t index,
2406 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002407{
Kent Overstreet723ef242020-12-14 19:04:52 -08002408 struct page *page;
2409 int error;
2410
Kent Overstreet723ef242020-12-14 19:04:52 -08002411 page = page_cache_alloc(mapping);
2412 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002413 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002414
2415 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002416 mapping_gfp_constraint(mapping, GFP_KERNEL));
2417 if (error == -EEXIST)
2418 error = AOP_TRUNCATED_PAGE;
2419 if (error)
2420 goto error;
2421
2422 error = filemap_read_page(file, mapping, page);
2423 if (error)
2424 goto error;
2425
2426 pagevec_add(pvec, page);
2427 return 0;
2428error:
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002429 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002430 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002431}
2432
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002433static int filemap_readahead(struct kiocb *iocb, struct file *file,
2434 struct address_space *mapping, struct page *page,
2435 pgoff_t last_index)
2436{
2437 if (iocb->ki_flags & IOCB_NOIO)
2438 return -EAGAIN;
2439 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2440 page->index, last_index - page->index);
2441 return 0;
2442}
2443
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002444static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002445 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002446{
2447 struct file *filp = iocb->ki_filp;
2448 struct address_space *mapping = filp->f_mapping;
2449 struct file_ra_state *ra = &filp->f_ra;
2450 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002451 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002452 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002453 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002454
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002455 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002456retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002457 if (fatal_signal_pending(current))
2458 return -EINTR;
2459
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002460 filemap_get_read_batch(mapping, index, last_index, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002461 if (!pagevec_count(pvec)) {
2462 if (iocb->ki_flags & IOCB_NOIO)
2463 return -EAGAIN;
2464 page_cache_sync_readahead(mapping, ra, filp, index,
2465 last_index - index);
2466 filemap_get_read_batch(mapping, index, last_index, pvec);
2467 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002468 if (!pagevec_count(pvec)) {
2469 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2470 return -EAGAIN;
2471 err = filemap_create_page(filp, mapping,
2472 iocb->ki_pos >> PAGE_SHIFT, pvec);
2473 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002474 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002475 return err;
2476 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002477
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002478 page = pvec->pages[pagevec_count(pvec) - 1];
2479 if (PageReadahead(page)) {
2480 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2481 if (err)
2482 goto err;
2483 }
2484 if (!PageUptodate(page)) {
2485 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2486 iocb->ki_flags |= IOCB_NOWAIT;
2487 err = filemap_update_page(iocb, mapping, iter, page);
2488 if (err)
2489 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002490 }
2491
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002492 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002493err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002494 if (err < 0)
2495 put_page(page);
2496 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002497 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002498 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002499 goto retry;
2500 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002501}
2502
Randy Dunlap485bb992006-06-23 02:03:49 -07002503/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002504 * filemap_read - Read data from the page cache.
2505 * @iocb: The iocb to read.
2506 * @iter: Destination for the data.
2507 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002508 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002509 * Copies data from the page cache. If the data is not currently present,
2510 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002512 * Return: Total number of bytes copied, including those already read by
2513 * the caller. If an error happens before any bytes are copied, returns
2514 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002516ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2517 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002519 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002520 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002521 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002523 struct pagevec pvec;
2524 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002525 bool writably_mapped;
2526 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527
Kent Overstreet723ef242020-12-14 19:04:52 -08002528 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002529 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002530 if (unlikely(!iov_iter_count(iter)))
2531 return 0;
2532
Wei Fangc2a97372016-10-07 17:01:52 -07002533 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002534 pagevec_init(&pvec);
Wei Fangc2a97372016-10-07 17:01:52 -07002535
Kent Overstreet06c04442020-12-14 19:04:56 -08002536 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 cond_resched();
Kent Overstreet06c04442020-12-14 19:04:56 -08002538
2539 /*
2540 * If we've already successfully copied some data, then we
2541 * can no longer safely return -EIOCBQUEUED. Hence mark
2542 * an async read NOWAIT at that point.
2543 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002544 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002545 iocb->ki_flags |= IOCB_NOWAIT;
2546
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002547 error = filemap_get_pages(iocb, iter, &pvec);
2548 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002549 break;
Michal Hocko5abf1862017-02-03 13:13:29 -08002550
Kent Overstreet723ef242020-12-14 19:04:52 -08002551 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002552 * i_size must be checked after we know the pages are Uptodate.
2553 *
2554 * Checking i_size after the check allows us to calculate
2555 * the correct value for "nr", which means the zero-filled
2556 * part of the page is not copied back to userspace (unless
2557 * another truncate extends the file - this is desired though).
Kent Overstreet723ef242020-12-14 19:04:52 -08002558 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002559 isize = i_size_read(inode);
2560 if (unlikely(iocb->ki_pos >= isize))
2561 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002562 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2563
Kent Overstreet06c04442020-12-14 19:04:56 -08002564 /*
2565 * Once we start copying data, we don't want to be touching any
2566 * cachelines that might be contended:
2567 */
2568 writably_mapped = mapping_writably_mapped(mapping);
2569
2570 /*
2571 * When a sequential read accesses a page several times, only
2572 * mark it as accessed the first time.
2573 */
2574 if (iocb->ki_pos >> PAGE_SHIFT !=
2575 ra->prev_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002576 mark_page_accessed(pvec.pages[0]);
Kent Overstreet06c04442020-12-14 19:04:56 -08002577
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002578 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002579 struct page *page = pvec.pages[i];
2580 size_t page_size = thp_size(page);
2581 size_t offset = iocb->ki_pos & (page_size - 1);
2582 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2583 page_size - offset);
2584 size_t copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002585
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002586 if (end_offset < page_offset(page))
2587 break;
2588 if (i > 0)
2589 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002590 /*
2591 * If users can be writing to this page using arbitrary
2592 * virtual addresses, take care about potential aliasing
2593 * before reading the page on the kernel side.
2594 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002595 if (writably_mapped) {
2596 int j;
Kent Overstreet06c04442020-12-14 19:04:56 -08002597
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002598 for (j = 0; j < thp_nr_pages(page); j++)
2599 flush_dcache_page(page + j);
2600 }
2601
2602 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002603
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002604 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002605 iocb->ki_pos += copied;
2606 ra->prev_pos = iocb->ki_pos;
2607
2608 if (copied < bytes) {
2609 error = -EFAULT;
2610 break;
Kent Overstreet723ef242020-12-14 19:04:52 -08002611 }
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002612 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002613put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002614 for (i = 0; i < pagevec_count(&pvec); i++)
2615 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002616 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002617 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002618
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002619 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002620
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002621 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002623EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624
Randy Dunlap485bb992006-06-23 02:03:49 -07002625/**
Al Viro6abd2322014-04-04 14:20:57 -04002626 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002627 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002628 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002629 *
Al Viro6abd2322014-04-04 14:20:57 -04002630 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002631 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002632 *
2633 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2634 * be returned when no data can be read without waiting for I/O requests
2635 * to complete; it doesn't prevent readahead.
2636 *
2637 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2638 * requests shall be made for the read or for readahead. When no data
2639 * can be read, -EAGAIN shall be returned. When readahead would be
2640 * triggered, a partial, possibly empty read shall be returned.
2641 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002642 * Return:
2643 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002644 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002645 */
2646ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002647generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002649 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002650 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002651
2652 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002653 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654
Al Viro2ba48ce2015-04-09 13:52:01 -04002655 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002656 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002657 struct address_space *mapping = file->f_mapping;
2658 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002659 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002662 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002663 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2664 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002665 return -EAGAIN;
2666 } else {
2667 retval = filemap_write_and_wait_range(mapping,
2668 iocb->ki_pos,
2669 iocb->ki_pos + count - 1);
2670 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002671 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002672 }
Al Viroed978a82014-03-05 22:53:04 -05002673
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002674 file_accessed(file);
2675
Al Viro5ecda132017-04-13 14:13:36 -04002676 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002677 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002678 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002679 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002680 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002681 if (retval != -EIOCBQUEUED)
2682 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002683
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002684 /*
2685 * Btrfs can have a short DIO read if we encounter
2686 * compressed extents, so if there was an error, or if
2687 * we've already read everything we wanted to, or if
2688 * there was a short read because we hit EOF, go ahead
2689 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002690 * the rest of the read. Buffered reads will not work for
2691 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002692 */
Al Viro5ecda132017-04-13 14:13:36 -04002693 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002694 IS_DAX(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002695 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696 }
2697
Christoph Hellwig826ea862021-02-24 12:02:45 -08002698 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699}
Al Viroed978a82014-03-05 22:53:04 -05002700EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002702static inline loff_t page_seek_hole_data(struct xa_state *xas,
2703 struct address_space *mapping, struct page *page,
2704 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002705{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002706 const struct address_space_operations *ops = mapping->a_ops;
2707 size_t offset, bsz = i_blocksize(mapping->host);
2708
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002709 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002710 return seek_data ? start : end;
2711 if (!ops->is_partially_uptodate)
2712 return seek_data ? end : start;
2713
2714 xas_pause(xas);
2715 rcu_read_unlock();
2716 lock_page(page);
2717 if (unlikely(page->mapping != mapping))
2718 goto unlock;
2719
2720 offset = offset_in_thp(page, start) & ~(bsz - 1);
2721
2722 do {
2723 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2724 break;
2725 start = (start + bsz) & ~(bsz - 1);
2726 offset += bsz;
2727 } while (offset < thp_size(page));
2728unlock:
2729 unlock_page(page);
2730 rcu_read_lock();
2731 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002732}
2733
2734static inline
2735unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2736{
2737 if (xa_is_value(page))
2738 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2739 return thp_size(page);
2740}
2741
2742/**
2743 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2744 * @mapping: Address space to search.
2745 * @start: First byte to consider.
2746 * @end: Limit of search (exclusive).
2747 * @whence: Either SEEK_HOLE or SEEK_DATA.
2748 *
2749 * If the page cache knows which blocks contain holes and which blocks
2750 * contain data, your filesystem can use this function to implement
2751 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2752 * entirely memory-based such as tmpfs, and filesystems which support
2753 * unwritten extents.
2754 *
Ingo Molnarf0953a12021-05-06 18:06:47 -07002755 * Return: The requested offset on success, or -ENXIO if @whence specifies
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002756 * SEEK_DATA and there is no data after @start. There is an implicit hole
2757 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2758 * and @end contain data.
2759 */
2760loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2761 loff_t end, int whence)
2762{
2763 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002764 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002765 bool seek_data = (whence == SEEK_DATA);
2766 struct page *page;
2767
2768 if (end <= start)
2769 return -ENXIO;
2770
2771 rcu_read_lock();
2772 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002773 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2774 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002775
2776 if (start < pos) {
2777 if (!seek_data)
2778 goto unlock;
2779 start = pos;
2780 }
2781
Hugh Dickinsed98b012021-04-23 14:29:00 -07002782 seek_size = seek_page_size(&xas, page);
2783 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002784 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2785 seek_data);
2786 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002787 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002788 if (start >= end)
2789 break;
2790 if (seek_size > PAGE_SIZE)
2791 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002792 if (!xa_is_value(page))
2793 put_page(page);
2794 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002795 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002796 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002797unlock:
2798 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002799 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002800 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002801 if (start > end)
2802 return end;
2803 return start;
2804}
2805
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002808/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002809 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002810 * @vmf - the vm_fault for this fault.
2811 * @page - the page to lock.
2812 * @fpin - the pointer to the file we may pin (or is already pinned).
2813 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002814 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002815 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002816 * 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 -07002817 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002818 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002819static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2820 struct file **fpin)
2821{
2822 if (trylock_page(page))
2823 return 1;
2824
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002825 /*
2826 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002827 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002828 * is supposed to work. We have way too many special cases..
2829 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002830 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2831 return 0;
2832
2833 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2834 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2835 if (__lock_page_killable(page)) {
2836 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002837 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002838 * but all fault_handlers only check for fatal signals
2839 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002840 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002841 */
2842 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002843 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002844 return 0;
2845 }
2846 } else
2847 __lock_page(page);
2848 return 1;
2849}
2850
2851
2852/*
2853 * Synchronous readahead happens when we don't even find a page in the page
2854 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2855 * to drop the mmap sem we return the file that was pinned in order for us to do
2856 * that. If we didn't pin a file then we return NULL. The file that is
2857 * returned needs to be fput()'ed when we're done with it.
2858 */
2859static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002860{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002861 struct file *file = vmf->vma->vm_file;
2862 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002863 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002864 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002865 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002866 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002867
2868 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002869 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002870 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002871 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002872 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002873
Josef Bacik2a1180f2019-03-13 11:44:18 -07002874 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002875 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002876 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002877 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002878 }
2879
Andi Kleen207d04b2011-05-24 17:12:29 -07002880 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002881 mmap_miss = READ_ONCE(ra->mmap_miss);
2882 if (mmap_miss < MMAP_LOTSAMISS * 10)
2883 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002884
2885 /*
2886 * Do we miss much more than hit in this file? If so,
2887 * stop bothering with read-ahead. It will only hurt.
2888 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002889 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002890 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002891
Wu Fengguangd30a1102009-06-16 15:31:30 -07002892 /*
2893 * mmap read-around
2894 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002895 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002896 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002897 ra->size = ra->ra_pages;
2898 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002899 ractl._index = ra->start;
2900 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002901 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002902}
2903
2904/*
2905 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002906 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002907 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002908 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002909static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2910 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002911{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002912 struct file *file = vmf->vma->vm_file;
2913 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002914 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002915 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002916 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002917 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002918
2919 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002920 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002921 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002922 mmap_miss = READ_ONCE(ra->mmap_miss);
2923 if (mmap_miss)
2924 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002925 if (PageReadahead(page)) {
2926 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002927 page_cache_async_readahead(mapping, ra, file,
2928 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002929 }
2930 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002931}
2932
Randy Dunlap485bb992006-06-23 02:03:49 -07002933/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002934 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002935 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002936 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002937 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938 * mapped memory region to read in file data during a page fault.
2939 *
2940 * The goto's are kind of ugly, but this streamlines the normal case of having
2941 * it in the page cache, and handles the special cases reasonably without
2942 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002943 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002944 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002945 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002946 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002947 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002948 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002949 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002950 * has not been released.
2951 *
2952 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002953 *
2954 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002956vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002957{
2958 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002959 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002960 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002961 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002962 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002963 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002964 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002965 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002966 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002967
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002968 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2969 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002970 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971
Linus Torvalds1da177e2005-04-16 15:20:36 -07002972 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002973 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002975 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002976 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002977 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002978 * We found the page, so try async readahead before
2979 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002980 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002981 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002982 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002983 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002984 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002985 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002986 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002987 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002988retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002989 page = pagecache_get_page(mapping, offset,
2990 FGP_CREAT|FGP_FOR_MMAP,
2991 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002992 if (!page) {
2993 if (fpin)
2994 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002995 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002996 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997 }
2998
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002999 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3000 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003001
3002 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003003 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003004 unlock_page(page);
3005 put_page(page);
3006 goto retry_find;
3007 }
Song Liu520e5ba2019-09-23 15:37:50 -07003008 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003009
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003011 * We have a locked page in the page cache, now we need to check
3012 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 */
Nick Piggind00806b2007-07-19 01:46:57 -07003014 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003015 goto page_not_uptodate;
3016
Linus Torvaldsef00e082009-06-16 15:31:25 -07003017 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003018 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003019 * time to return to the upper layer and have it re-find the vma and
3020 * redo the fault.
3021 */
3022 if (fpin) {
3023 unlock_page(page);
3024 goto out_retry;
3025 }
3026
3027 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003028 * Found the page and have a reference on it.
3029 * We must recheck i_size under page lock.
3030 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003031 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3032 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003033 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003034 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003035 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003036 }
3037
Nick Piggind0217ac2007-07-19 01:47:03 -07003038 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003039 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003040
Linus Torvalds1da177e2005-04-16 15:20:36 -07003041page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042 /*
3043 * Umm, take care of errors if the page isn't up-to-date.
3044 * Try to re-read it _once_. We do this synchronously,
3045 * because there really aren't any performance issues here
3046 * and we need to check for errors.
3047 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003048 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)d31fa862021-04-29 22:55:26 -07003049 error = filemap_read_page(file, mapping, page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003050 if (fpin)
3051 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003052 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003053
3054 if (!error || error == AOP_TRUNCATED_PAGE)
3055 goto retry_find;
3056
Nick Piggind0217ac2007-07-19 01:47:03 -07003057 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003058
3059out_retry:
3060 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003061 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003062 * re-find the vma and come back and find our hopefully still populated
3063 * page.
3064 */
3065 if (page)
3066 put_page(page);
3067 if (fpin)
3068 fput(fpin);
3069 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003070}
3071EXPORT_SYMBOL(filemap_fault);
3072
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003073static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003074{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003075 struct mm_struct *mm = vmf->vma->vm_mm;
3076
3077 /* Huge page is mapped? No need to proceed. */
3078 if (pmd_trans_huge(*vmf->pmd)) {
3079 unlock_page(page);
3080 put_page(page);
3081 return true;
3082 }
3083
3084 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
3085 vm_fault_t ret = do_set_pmd(vmf, page);
3086 if (!ret) {
3087 /* The page is mapped successfully, reference consumed. */
3088 unlock_page(page);
3089 return true;
3090 }
3091 }
3092
3093 if (pmd_none(*vmf->pmd)) {
3094 vmf->ptl = pmd_lock(mm, vmf->pmd);
3095 if (likely(pmd_none(*vmf->pmd))) {
3096 mm_inc_nr_ptes(mm);
3097 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
3098 vmf->prealloc_pte = NULL;
3099 }
3100 spin_unlock(vmf->ptl);
3101 }
3102
3103 /* See comment in handle_pte_fault() */
3104 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3105 unlock_page(page);
3106 put_page(page);
3107 return true;
3108 }
3109
3110 return false;
3111}
3112
3113static struct page *next_uptodate_page(struct page *page,
3114 struct address_space *mapping,
3115 struct xa_state *xas, pgoff_t end_pgoff)
3116{
3117 unsigned long max_idx;
3118
3119 do {
3120 if (!page)
3121 return NULL;
3122 if (xas_retry(xas, page))
3123 continue;
3124 if (xa_is_value(page))
3125 continue;
3126 if (PageLocked(page))
3127 continue;
3128 if (!page_cache_get_speculative(page))
3129 continue;
3130 /* Has the page moved or been split? */
3131 if (unlikely(page != xas_reload(xas)))
3132 goto skip;
3133 if (!PageUptodate(page) || PageReadahead(page))
3134 goto skip;
3135 if (PageHWPoison(page))
3136 goto skip;
3137 if (!trylock_page(page))
3138 goto skip;
3139 if (page->mapping != mapping)
3140 goto unlock;
3141 if (!PageUptodate(page))
3142 goto unlock;
3143 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3144 if (xas->xa_index >= max_idx)
3145 goto unlock;
3146 return page;
3147unlock:
3148 unlock_page(page);
3149skip:
3150 put_page(page);
3151 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3152
3153 return NULL;
3154}
3155
3156static inline struct page *first_map_page(struct address_space *mapping,
3157 struct xa_state *xas,
3158 pgoff_t end_pgoff)
3159{
3160 return next_uptodate_page(xas_find(xas, end_pgoff),
3161 mapping, xas, end_pgoff);
3162}
3163
3164static inline struct page *next_map_page(struct address_space *mapping,
3165 struct xa_state *xas,
3166 pgoff_t end_pgoff)
3167{
3168 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3169 mapping, xas, end_pgoff);
3170}
3171
3172vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3173 pgoff_t start_pgoff, pgoff_t end_pgoff)
3174{
3175 struct vm_area_struct *vma = vmf->vma;
3176 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003177 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07003178 pgoff_t last_pgoff = start_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003179 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003180 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003181 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003182 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003183 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003184
3185 rcu_read_lock();
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003186 head = first_map_page(mapping, &xas, end_pgoff);
3187 if (!head)
3188 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003189
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003190 if (filemap_map_pmd(vmf, head)) {
3191 ret = VM_FAULT_NOPAGE;
3192 goto out;
3193 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003194
Will Deacon9d3af4b2021-01-14 15:24:19 +00003195 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3196 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003197 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003198 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003199 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003200 goto unlock;
3201
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003202 if (mmap_miss > 0)
3203 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003204
Will Deacon9d3af4b2021-01-14 15:24:19 +00003205 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003206 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003207 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003208
3209 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003210 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003211
Will Deacon46bdb422020-11-24 18:48:26 +00003212 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003213 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003214 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003215
Will Deacon9d3af4b2021-01-14 15:24:19 +00003216 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003217 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003218 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003219 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003220 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003221unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003222 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003223 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003224 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3225 pte_unmap_unlock(vmf->pte, vmf->ptl);
3226out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003227 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003228 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003229 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003230}
3231EXPORT_SYMBOL(filemap_map_pages);
3232
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003233vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003234{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003235 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003236 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003237 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003238
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003239 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003240 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003241 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003242 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003243 unlock_page(page);
3244 ret = VM_FAULT_NOPAGE;
3245 goto out;
3246 }
Jan Kara14da9202012-06-12 16:20:37 +02003247 /*
3248 * We mark the page dirty already here so that when freeze is in
3249 * progress, we are guaranteed that writeback during freezing will
3250 * see the dirty page and writeprotect it again.
3251 */
3252 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003253 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003254out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003255 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003256 return ret;
3257}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003258
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003259const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003260 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003261 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003262 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003263};
3264
3265/* This is used for a general mmap of a disk file */
3266
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003267int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268{
3269 struct address_space *mapping = file->f_mapping;
3270
3271 if (!mapping->a_ops->readpage)
3272 return -ENOEXEC;
3273 file_accessed(file);
3274 vma->vm_ops = &generic_file_vm_ops;
3275 return 0;
3276}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277
3278/*
3279 * This is for filesystems which do not implement ->writepage.
3280 */
3281int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3282{
3283 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3284 return -EINVAL;
3285 return generic_file_mmap(file, vma);
3286}
3287#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003288vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003289{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003290 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003291}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003292int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003293{
3294 return -ENOSYS;
3295}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003296int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297{
3298 return -ENOSYS;
3299}
3300#endif /* CONFIG_MMU */
3301
Arnd Bergmann453972282018-04-13 15:35:27 -07003302EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303EXPORT_SYMBOL(generic_file_mmap);
3304EXPORT_SYMBOL(generic_file_readonly_mmap);
3305
Sasha Levin67f9fd92014-04-03 14:48:18 -07003306static struct page *wait_on_page_read(struct page *page)
3307{
3308 if (!IS_ERR(page)) {
3309 wait_on_page_locked(page);
3310 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003311 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003312 page = ERR_PTR(-EIO);
3313 }
3314 }
3315 return page;
3316}
3317
Mel Gorman32b63522016-03-15 14:55:36 -07003318static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003319 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003320 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003321 void *data,
3322 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003323{
Nick Piggineb2be182007-10-16 01:24:57 -07003324 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003325 int err;
3326repeat:
3327 page = find_get_page(mapping, index);
3328 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003329 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003330 if (!page)
3331 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003332 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003333 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003334 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003335 if (err == -EEXIST)
3336 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003337 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003338 return ERR_PTR(err);
3339 }
Mel Gorman32b63522016-03-15 14:55:36 -07003340
3341filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003342 if (filler)
3343 err = filler(data, page);
3344 else
3345 err = mapping->a_ops->readpage(data, page);
3346
Linus Torvalds1da177e2005-04-16 15:20:36 -07003347 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003348 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003349 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003350 }
Mel Gorman32b63522016-03-15 14:55:36 -07003351
3352 page = wait_on_page_read(page);
3353 if (IS_ERR(page))
3354 return page;
3355 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003356 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003357 if (PageUptodate(page))
3358 goto out;
3359
Mel Gormanebded022016-03-15 14:55:39 -07003360 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003361 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003362 * case a: Page is being filled and the page lock is held
3363 * case b: Read/write error clearing the page uptodate status
3364 * case c: Truncation in progress (page locked)
3365 * case d: Reclaim in progress
3366 *
3367 * Case a, the page will be up to date when the page is unlocked.
3368 * There is no need to serialise on the page lock here as the page
3369 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003370 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003371 * it's a race vs truncate race.
3372 * Case b, the page will not be up to date
3373 * Case c, the page may be truncated but in itself, the data may still
3374 * be valid after IO completes as it's a read vs truncate race. The
3375 * operation must restart if the page is not uptodate on unlock but
3376 * otherwise serialising on page lock to stabilise the mapping gives
3377 * no additional guarantees to the caller as the page lock is
3378 * released before return.
3379 * Case d, similar to truncation. If reclaim holds the page lock, it
3380 * will be a race with remove_mapping that determines if the mapping
3381 * is valid on unlock but otherwise the data is valid and there is
3382 * no need to serialise with page lock.
3383 *
3384 * As the page lock gives no additional guarantee, we optimistically
3385 * wait on the page to be unlocked and check if it's up to date and
3386 * use the page if it is. Otherwise, the page lock is required to
3387 * distinguish between the different cases. The motivation is that we
3388 * avoid spurious serialisations and wakeups when multiple processes
3389 * wait on the same page for IO to complete.
3390 */
3391 wait_on_page_locked(page);
3392 if (PageUptodate(page))
3393 goto out;
3394
3395 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003396 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003397
3398 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003399 if (!page->mapping) {
3400 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003401 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003402 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003403 }
Mel Gormanebded022016-03-15 14:55:39 -07003404
3405 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003406 if (PageUptodate(page)) {
3407 unlock_page(page);
3408 goto out;
3409 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003410
3411 /*
3412 * A previous I/O error may have been due to temporary
3413 * failures.
3414 * Clear page error before actual read, PG_error will be
3415 * set again if read page fails.
3416 */
3417 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003418 goto filler;
3419
David Howellsc855ff32007-05-09 13:42:20 +01003420out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003421 mark_page_accessed(page);
3422 return page;
3423}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003424
3425/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003426 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003427 * @mapping: the page's address_space
3428 * @index: the page index
3429 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003430 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003431 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003432 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003433 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003434 *
3435 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003436 *
3437 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003438 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003439struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003440 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003441 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003442 void *data)
3443{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003444 return do_read_cache_page(mapping, index, filler, data,
3445 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003446}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003447EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003448
3449/**
3450 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3451 * @mapping: the page's address_space
3452 * @index: the page index
3453 * @gfp: the page allocator flags to use if allocating
3454 *
3455 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003456 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003457 *
3458 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003459 *
3460 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003461 */
3462struct page *read_cache_page_gfp(struct address_space *mapping,
3463 pgoff_t index,
3464 gfp_t gfp)
3465{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003466 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003467}
3468EXPORT_SYMBOL(read_cache_page_gfp);
3469
Nick Pigginafddba42007-10-16 01:25:01 -07003470int pagecache_write_begin(struct file *file, struct address_space *mapping,
3471 loff_t pos, unsigned len, unsigned flags,
3472 struct page **pagep, void **fsdata)
3473{
3474 const struct address_space_operations *aops = mapping->a_ops;
3475
Nick Piggin4e02ed42008-10-29 14:00:55 -07003476 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003477 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003478}
3479EXPORT_SYMBOL(pagecache_write_begin);
3480
3481int pagecache_write_end(struct file *file, struct address_space *mapping,
3482 loff_t pos, unsigned len, unsigned copied,
3483 struct page *page, void *fsdata)
3484{
3485 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003486
Nick Piggin4e02ed42008-10-29 14:00:55 -07003487 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003488}
3489EXPORT_SYMBOL(pagecache_write_end);
3490
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003491/*
3492 * Warn about a page cache invalidation failure during a direct I/O write.
3493 */
3494void dio_warn_stale_pagecache(struct file *filp)
3495{
3496 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3497 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003498 char *path;
3499
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003500 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003501 if (__ratelimit(&_rs)) {
3502 path = file_path(filp, pathname, sizeof(pathname));
3503 if (IS_ERR(path))
3504 path = "(unknown)";
3505 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3506 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3507 current->comm);
3508 }
3509}
3510
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003512generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513{
3514 struct file *file = iocb->ki_filp;
3515 struct address_space *mapping = file->f_mapping;
3516 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003517 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003519 size_t write_len;
3520 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003521
Al Viro0c949332014-03-22 06:51:37 -04003522 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003523 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003524
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003525 if (iocb->ki_flags & IOCB_NOWAIT) {
3526 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003527 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003528 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003529 return -EAGAIN;
3530 } else {
3531 written = filemap_write_and_wait_range(mapping, pos,
3532 pos + write_len - 1);
3533 if (written)
3534 goto out;
3535 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003536
3537 /*
3538 * After a write we want buffered reads to be sure to go to disk to get
3539 * the new data. We invalidate clean cached page from the region we're
3540 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003541 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003542 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003543 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003544 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003545 /*
3546 * If a page can not be invalidated, return 0 to fall back
3547 * to buffered write.
3548 */
3549 if (written) {
3550 if (written == -EBUSY)
3551 return 0;
3552 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003553 }
3554
Al Viro639a93a52017-04-13 14:10:15 -04003555 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003556
3557 /*
3558 * Finally, try again to invalidate clean pages which might have been
3559 * cached by non-direct readahead, or faulted in by get_user_pages()
3560 * if the source of the write was an mmap'ed region of the file
3561 * we're writing. Either one is a pretty crazy thing to do,
3562 * so we don't support it 100%. If this invalidation
3563 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003564 *
3565 * Most of the time we do not need this since dio_complete() will do
3566 * the invalidation for us. However there are some file systems that
3567 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003568 * them by removing it completely.
3569 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003570 * Noticeable example is a blkdev_direct_IO().
3571 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003572 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003573 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003574 if (written > 0 && mapping->nrpages &&
3575 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3576 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003577
Linus Torvalds1da177e2005-04-16 15:20:36 -07003578 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003579 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003580 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003581 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3582 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003583 mark_inode_dirty(inode);
3584 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003585 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003586 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003587 if (written != -EIOCBQUEUED)
3588 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003589out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 return written;
3591}
3592EXPORT_SYMBOL(generic_file_direct_write);
3593
Nick Piggineb2be182007-10-16 01:24:57 -07003594/*
3595 * Find or create a page at the given pagecache position. Return the locked
3596 * page. This function is specifically for buffered writes.
3597 */
Nick Piggin54566b22009-01-04 12:00:53 -08003598struct page *grab_cache_page_write_begin(struct address_space *mapping,
3599 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003600{
Nick Piggineb2be182007-10-16 01:24:57 -07003601 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003602 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003603
Nick Piggin54566b22009-01-04 12:00:53 -08003604 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003605 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003606
Mel Gorman2457aec2014-06-04 16:10:31 -07003607 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003608 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003609 if (page)
3610 wait_for_stable_page(page);
3611
Nick Piggineb2be182007-10-16 01:24:57 -07003612 return page;
3613}
Nick Piggin54566b22009-01-04 12:00:53 -08003614EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003615
Al Viro3b93f912014-02-11 21:34:08 -05003616ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003617 struct iov_iter *i, loff_t pos)
3618{
3619 struct address_space *mapping = file->f_mapping;
3620 const struct address_space_operations *a_ops = mapping->a_ops;
3621 long status = 0;
3622 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003623 unsigned int flags = 0;
3624
Nick Pigginafddba42007-10-16 01:25:01 -07003625 do {
3626 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003627 unsigned long offset; /* Offset into pagecache page */
3628 unsigned long bytes; /* Bytes to write to page */
3629 size_t copied; /* Bytes copied from user */
3630 void *fsdata;
3631
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003632 offset = (pos & (PAGE_SIZE - 1));
3633 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003634 iov_iter_count(i));
3635
3636again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003637 /*
3638 * Bring in the user page that we will copy from _first_.
3639 * Otherwise there's a nasty deadlock on copying from the
3640 * same page as we're writing to, without it being marked
3641 * up-to-date.
Linus Torvalds00a3d662015-10-07 08:32:38 +01003642 */
3643 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3644 status = -EFAULT;
3645 break;
3646 }
3647
Jan Kara296291c2015-10-22 13:32:21 -07003648 if (fatal_signal_pending(current)) {
3649 status = -EINTR;
3650 break;
3651 }
3652
Nick Piggin674b8922007-10-16 01:25:03 -07003653 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003654 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003655 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003656 break;
3657
anfei zhou931e80e2010-02-02 13:44:02 -08003658 if (mapping_writably_mapped(mapping))
3659 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003660
Al Virof0b65f32021-04-30 10:26:41 -04003661 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
Nick Pigginafddba42007-10-16 01:25:01 -07003662 flush_dcache_page(page);
3663
3664 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3665 page, fsdata);
Al Virof0b65f32021-04-30 10:26:41 -04003666 if (unlikely(status != copied)) {
3667 iov_iter_revert(i, copied - max(status, 0L));
3668 if (unlikely(status < 0))
3669 break;
3670 }
Nick Pigginafddba42007-10-16 01:25:01 -07003671 cond_resched();
3672
Al Virobc1bb412021-05-31 00:32:44 -04003673 if (unlikely(status == 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07003674 /*
Al Virobc1bb412021-05-31 00:32:44 -04003675 * A short copy made ->write_end() reject the
3676 * thing entirely. Might be memory poisoning
3677 * halfway through, might be a race with munmap,
3678 * might be severe memory pressure.
Nick Pigginafddba42007-10-16 01:25:01 -07003679 */
Al Virobc1bb412021-05-31 00:32:44 -04003680 if (copied)
3681 bytes = copied;
Nick Pigginafddba42007-10-16 01:25:01 -07003682 goto again;
3683 }
Al Virof0b65f32021-04-30 10:26:41 -04003684 pos += status;
3685 written += status;
Nick Pigginafddba42007-10-16 01:25:01 -07003686
3687 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003688 } while (iov_iter_count(i));
3689
3690 return written ? written : status;
3691}
Al Viro3b93f912014-02-11 21:34:08 -05003692EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003693
Jan Karae4dd9de2009-08-17 18:10:06 +02003694/**
Al Viro81742022014-04-03 03:17:43 -04003695 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003696 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003697 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003698 *
3699 * This function does all the work needed for actually writing data to a
3700 * file. It does all basic checks, removes SUID from the file, updates
3701 * modification times and calls proper subroutines depending on whether we
3702 * do direct IO or a standard buffered write.
3703 *
3704 * It expects i_mutex to be grabbed unless we work on a block device or similar
3705 * object which does not need locking at all.
3706 *
3707 * This function does *not* take care of syncing data in case of O_SYNC write.
3708 * A caller has to handle it. This is mainly due to the fact that we want to
3709 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003710 *
3711 * Return:
3712 * * number of bytes written, even for truncated writes
3713 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003714 */
Al Viro81742022014-04-03 03:17:43 -04003715ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003716{
3717 struct file *file = iocb->ki_filp;
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003718 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003719 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003720 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003721 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003722 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003723
Linus Torvalds1da177e2005-04-16 15:20:36 -07003724 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003725 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003726 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003727 if (err)
3728 goto out;
3729
Josef Bacikc3b2da32012-03-26 09:59:21 -04003730 err = file_update_time(file);
3731 if (err)
3732 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003733
Al Viro2ba48ce2015-04-09 13:52:01 -04003734 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003735 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003736
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003737 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003738 /*
3739 * If the write stopped short of completing, fall back to
3740 * buffered writes. Some filesystems do this for writes to
3741 * holes, for example. For DAX files, a buffered write will
3742 * not succeed (even if it did, DAX does not handle dirty
3743 * page-cache pages correctly).
3744 */
Al Viro0b8def92015-04-07 10:22:53 -04003745 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003746 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003747
Al Viro0b8def92015-04-07 10:22:53 -04003748 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003749 /*
Al Viro3b93f912014-02-11 21:34:08 -05003750 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003751 * then we want to return the number of bytes which were
3752 * direct-written, or the error code if that was zero. Note
3753 * that this differs from normal direct-io semantics, which
3754 * will return -EFOO even if some bytes were written.
3755 */
Al Viro60bb4522014-08-08 12:39:16 -04003756 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003757 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003758 goto out;
3759 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003760 /*
3761 * We need to ensure that the page cache pages are written to
3762 * disk and invalidated to preserve the expected O_DIRECT
3763 * semantics.
3764 */
Al Viro3b93f912014-02-11 21:34:08 -05003765 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003766 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003767 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003768 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003769 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003770 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003771 pos >> PAGE_SHIFT,
3772 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003773 } else {
3774 /*
3775 * We don't know how much we wrote, so just return
3776 * the number of bytes which were direct-written
3777 */
3778 }
3779 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003780 written = generic_perform_write(file, from, iocb->ki_pos);
3781 if (likely(written > 0))
3782 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003783 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003784out:
3785 current->backing_dev_info = NULL;
3786 return written ? written : err;
3787}
Al Viro81742022014-04-03 03:17:43 -04003788EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003789
Jan Karae4dd9de2009-08-17 18:10:06 +02003790/**
Al Viro81742022014-04-03 03:17:43 -04003791 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003792 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003793 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003794 *
Al Viro81742022014-04-03 03:17:43 -04003795 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003796 * filesystems. It takes care of syncing the file in case of O_SYNC file
3797 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003798 * Return:
3799 * * negative error code if no data has been written at all of
3800 * vfs_fsync_range() failed for a synchronous write
3801 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003802 */
Al Viro81742022014-04-03 03:17:43 -04003803ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003804{
3805 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003806 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003807 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003808
Al Viro59551022016-01-22 15:40:57 -05003809 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003810 ret = generic_write_checks(iocb, from);
3811 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003812 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003813 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003814
Christoph Hellwige2592212016-04-07 08:52:01 -07003815 if (ret > 0)
3816 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003817 return ret;
3818}
Al Viro81742022014-04-03 03:17:43 -04003819EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003820
David Howellscf9a2ae2006-08-29 19:05:54 +01003821/**
3822 * try_to_release_page() - release old fs-specific metadata on a page
3823 *
3824 * @page: the page which the kernel is trying to free
3825 * @gfp_mask: memory allocation flags (and I/O mode)
3826 *
3827 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003828 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003829 *
David Howells266cf652009-04-03 16:42:36 +01003830 * This may also be called if PG_fscache is set on a page, indicating that the
3831 * page is known to the local caching routines.
3832 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003833 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003834 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003835 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003836 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003837 */
3838int try_to_release_page(struct page *page, gfp_t gfp_mask)
3839{
3840 struct address_space * const mapping = page->mapping;
3841
3842 BUG_ON(!PageLocked(page));
3843 if (PageWriteback(page))
3844 return 0;
3845
3846 if (mapping && mapping->a_ops->releasepage)
3847 return mapping->a_ops->releasepage(page, gfp_mask);
3848 return try_to_free_buffers(page);
3849}
3850
3851EXPORT_SYMBOL(try_to_release_page);