blob: 7b17a22943aa28921a80310959d698ff828d177d [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
Chiawei Wang6ef0f852021-02-18 10:47:37 +080052#undef CREATE_TRACE_POINTS
53#include <trace/hooks/mm.h>
54
Linus Torvalds1da177e2005-04-16 15:20:36 -070055/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 * FIXME: remove all knowledge of the buffer layer from the core VM
57 */
Jan Kara148f9482009-08-17 19:52:36 +020058#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060#include <asm/mman.h>
61
62/*
63 * Shared mappings implemented 30.11.1994. It's not fully working yet,
64 * though.
65 *
66 * Shared mappings now work. 15.8.1995 Bruno.
67 *
68 * finished 'unifying' the page and buffer cache and SMP-threaded the
69 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
70 *
71 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
72 */
73
74/*
75 * Lock ordering:
76 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080077 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070079 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070080 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 *
Jan Kara96087032021-04-12 15:50:21 +020082 * ->i_rwsem
Jan Kara730633f2021-01-28 19:19:45 +010083 * ->invalidate_lock (acquired by fs in truncate path)
84 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070086 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080087 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070088 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070089 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070091 * ->mmap_lock
Jan Kara730633f2021-01-28 19:19:45 +010092 * ->invalidate_lock (filemap_fault)
93 * ->lock_page (filemap_fault, access_process_vm)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
Jan Kara96087032021-04-12 15:50:21 +020095 * ->i_rwsem (generic_perform_write)
Andreas Gruenbacher923f05a2022-04-15 06:28:39 +080096 * ->mmap_lock (fault_in_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060098 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110099 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700100 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800102 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 * ->anon_vma.lock (vma_adjust)
104 *
105 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700106 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700108 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700109 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700111 * ->i_pages lock (try_to_unmap_one)
Hugh Dickins15b44732020-12-15 14:21:31 -0800112 * ->lruvec->lru_lock (follow_page->mark_page_accessed)
113 * ->lruvec->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700115 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600116 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100117 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700118 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600119 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100120 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
122 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800123 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700124 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 */
126
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500127static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700128 struct page *page, void *shadow)
129{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500130 XA_STATE(xas, &mapping->i_pages, page->index);
131 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800132
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500133 mapping_set_update(&xas, mapping);
134
135 /* hugetlb pages are represented by a single entry in the xarray */
136 if (!PageHuge(page)) {
137 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700138 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500139 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700140
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700141 VM_BUG_ON_PAGE(!PageLocked(page), page);
142 VM_BUG_ON_PAGE(PageTail(page), page);
143 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700144
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500145 xas_store(&xas, shadow);
146 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200147
Jan Kara23006382017-11-15 17:37:26 -0800148 page->mapping = NULL;
149 /* Leave page->index set: truncation lookup relies upon it */
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200150 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700151}
152
Jan Kara5ecc4d82017-11-15 17:37:29 -0800153static void unaccount_page_cache_page(struct address_space *mapping,
154 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800156 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600158 /*
159 * if we're uptodate, flush out into the cleancache, otherwise
160 * invalidate any existing cleancache entries. We can't leave
161 * stale data around in the cleancache once our page is gone
162 */
163 if (PageUptodate(page) && PageMappedToDisk(page))
164 cleancache_put_page(page);
165 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400166 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600167
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700168 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800169 VM_BUG_ON_PAGE(page_mapped(page), page);
170 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
171 int mapcount;
172
173 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
174 current->comm, page_to_pfn(page));
175 dump_page(page, "still mapped when deleted");
176 dump_stack();
177 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
178
179 mapcount = page_mapcount(page);
180 if (mapping_exiting(mapping) &&
181 page_count(page) >= mapcount + 2) {
182 /*
183 * All vmas have already been torn down, so it's
184 * a good bet that actually the page is unmapped,
185 * and we'd prefer not to leak it: if we're wrong,
186 * some other bad page check should catch it later.
187 */
188 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700189 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800190 }
191 }
192
Jan Kara76253fb2017-11-15 17:37:22 -0800193 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800194 if (PageHuge(page))
195 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800196
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700197 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800198
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700199 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800200 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700201 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800202 if (PageTransHuge(page))
Muchun Song57b28472021-02-24 12:03:31 -0800203 __mod_lruvec_page_state(page, NR_SHMEM_THPS, -nr);
Song Liu99cb0db2019-09-23 15:38:00 -0700204 } else if (PageTransHuge(page)) {
Muchun Songbf9ecea2021-02-24 12:03:27 -0800205 __mod_lruvec_page_state(page, NR_FILE_THPS, -nr);
Song Liu09d91cd2019-09-23 15:38:03 -0700206 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800207 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800208
209 /*
210 * At this point page must be either written or cleaned by
211 * truncate. Dirty page here signals a bug and loss of
212 * unwritten data.
213 *
214 * This fixes dirty accounting after removing the page entirely
215 * but leaves PageDirty set: it has no effect for truncated
216 * page and anyway will be cleared before returning page into
217 * buddy allocator.
218 */
219 if (WARN_ON_ONCE(PageDirty(page)))
220 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
221}
222
223/*
224 * Delete a page from the page cache and free it. Caller has to make
225 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700226 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800227 */
228void __delete_from_page_cache(struct page *page, void *shadow)
229{
230 struct address_space *mapping = page->mapping;
231
232 trace_mm_filemap_delete_from_page_cache(page);
233
234 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500235 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236}
237
Jan Kara59c66c52017-11-15 17:37:18 -0800238static void page_cache_free_page(struct address_space *mapping,
239 struct page *page)
240{
241 void (*freepage)(struct page *);
242
243 freepage = mapping->a_ops->freepage;
244 if (freepage)
245 freepage(page);
246
247 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700248 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800249 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
250 } else {
251 put_page(page);
252 }
253}
254
Minchan Kim702cfbf2011-03-22 16:32:43 -0700255/**
256 * delete_from_page_cache - delete page from page cache
257 * @page: the page which the kernel is trying to remove from page cache
258 *
259 * This must be called only on pages that have been verified to be in the page
260 * cache and locked. It will never put the page into the free list, the caller
261 * has a reference on the page.
262 */
263void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700265 struct address_space *mapping = page_mapping(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266
Matt Mackallcd7619d2005-05-01 08:59:01 -0700267 BUG_ON(!PageLocked(page));
Johannes Weiner30472502021-09-02 14:53:18 -0700268 xa_lock_irq(&mapping->i_pages);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700269 __delete_from_page_cache(page, NULL);
Johannes Weiner30472502021-09-02 14:53:18 -0700270 xa_unlock_irq(&mapping->i_pages);
Linus Torvalds6072d132010-12-01 13:35:19 -0500271
Jan Kara59c66c52017-11-15 17:37:18 -0800272 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700273}
274EXPORT_SYMBOL(delete_from_page_cache);
275
Jan Karaaa65c292017-11-15 17:37:33 -0800276/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500277 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800278 * @mapping: the mapping to which pages belong
279 * @pvec: pagevec with pages to delete
280 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700281 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700282 * from the mapping. The function expects @pvec to be sorted by page index
283 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700284 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800285 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700286 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800287 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700288 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800289 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500290static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800291 struct pagevec *pvec)
292{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500293 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800294 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700295 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800296 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800297
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500298 mapping_set_update(&xas, mapping);
299 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700300 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800301 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700302
303 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400304 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800305 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700306 /*
307 * A page got inserted in our range? Skip it. We have our
308 * pages locked so they are protected from being removed.
309 * If we see a page whose index is higher than ours, it
310 * means our page has been removed, which shouldn't be
311 * possible because we're holding the PageLock.
312 */
313 if (page != pvec->pages[i]) {
314 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
315 page);
316 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700317 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700318
319 WARN_ON_ONCE(!PageLocked(page));
320
321 if (page->index == xas.xa_index)
322 page->mapping = NULL;
323 /* Leave page->index set: truncation lookup relies on it */
324
325 /*
326 * Move to the next page in the vector if this is a regular
327 * page or the index is of the last sub-page of this compound
328 * page.
329 */
330 if (page->index + compound_nr(page) - 1 == xas.xa_index)
331 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500332 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800333 total_pages++;
334 }
335 mapping->nrpages -= total_pages;
336}
337
338void delete_from_page_cache_batch(struct address_space *mapping,
339 struct pagevec *pvec)
340{
341 int i;
Jan Karaaa65c292017-11-15 17:37:33 -0800342
343 if (!pagevec_count(pvec))
344 return;
345
Johannes Weiner30472502021-09-02 14:53:18 -0700346 xa_lock_irq(&mapping->i_pages);
Jan Karaaa65c292017-11-15 17:37:33 -0800347 for (i = 0; i < pagevec_count(pvec); i++) {
348 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
349
350 unaccount_page_cache_page(mapping, pvec->pages[i]);
351 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500352 page_cache_delete_batch(mapping, pvec);
Johannes Weiner30472502021-09-02 14:53:18 -0700353 xa_unlock_irq(&mapping->i_pages);
Jan Karaaa65c292017-11-15 17:37:33 -0800354
355 for (i = 0; i < pagevec_count(pvec); i++)
356 page_cache_free_page(mapping, pvec->pages[i]);
357}
358
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200359int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700360{
361 int ret = 0;
362 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700363 if (test_bit(AS_ENOSPC, &mapping->flags) &&
364 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700365 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700366 if (test_bit(AS_EIO, &mapping->flags) &&
367 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700368 ret = -EIO;
369 return ret;
370}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200371EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700372
Jeff Layton76341ca2017-07-06 07:02:22 -0400373static int filemap_check_and_keep_errors(struct address_space *mapping)
374{
375 /* Check for outstanding write errors */
376 if (test_bit(AS_EIO, &mapping->flags))
377 return -EIO;
378 if (test_bit(AS_ENOSPC, &mapping->flags))
379 return -ENOSPC;
380 return 0;
381}
382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383/**
Josef Bacik5a798492021-07-14 14:47:22 -0400384 * filemap_fdatawrite_wbc - start writeback on mapping dirty pages in range
385 * @mapping: address space structure to write
386 * @wbc: the writeback_control controlling the writeout
387 *
388 * Call writepages on the mapping using the provided wbc to control the
389 * writeout.
390 *
391 * Return: %0 on success, negative error code otherwise.
392 */
393int filemap_fdatawrite_wbc(struct address_space *mapping,
394 struct writeback_control *wbc)
395{
396 int ret;
397
398 if (!mapping_can_writeback(mapping) ||
399 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
400 return 0;
401
402 wbc_attach_fdatawrite_inode(wbc, mapping->host);
403 ret = do_writepages(mapping, wbc);
404 wbc_detach_inode(wbc);
405 return ret;
406}
407EXPORT_SYMBOL(filemap_fdatawrite_wbc);
408
409/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700410 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700411 * @mapping: address space structure to write
412 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800413 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700414 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700416 * Start writeback against all of a mapping's dirty pages that lie
417 * within the byte offsets <start, end> inclusive.
418 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700420 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 * these two operations is that if a dirty page/buffer is encountered, it must
422 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800423 *
424 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800426int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
427 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 struct writeback_control wbc = {
430 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800431 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700432 .range_start = start,
433 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 };
435
Josef Bacik5a798492021-07-14 14:47:22 -0400436 return filemap_fdatawrite_wbc(mapping, &wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437}
438
439static inline int __filemap_fdatawrite(struct address_space *mapping,
440 int sync_mode)
441{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700442 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443}
444
445int filemap_fdatawrite(struct address_space *mapping)
446{
447 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
448}
449EXPORT_SYMBOL(filemap_fdatawrite);
450
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400451int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800452 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{
454 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
455}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400456EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Randy Dunlap485bb992006-06-23 02:03:49 -0700458/**
459 * filemap_flush - mostly a non-blocking flush
460 * @mapping: target address_space
461 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 * This is a mostly non-blocking flush. Not suitable for data-integrity
463 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800464 *
465 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 */
467int filemap_flush(struct address_space *mapping)
468{
469 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
470}
471EXPORT_SYMBOL(filemap_flush);
472
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500473/**
474 * filemap_range_has_page - check if a page exists in range.
475 * @mapping: address space within which to check
476 * @start_byte: offset in bytes where the range starts
477 * @end_byte: offset in bytes where the range ends (inclusive)
478 *
479 * Find at least one page in the range supplied, usually used to check if
480 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800481 *
482 * Return: %true if at least one page exists in the specified range,
483 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500484 */
485bool filemap_range_has_page(struct address_space *mapping,
486 loff_t start_byte, loff_t end_byte)
487{
Jan Karaf7b68042017-09-06 16:21:40 -0700488 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500489 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
490 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500491
492 if (end_byte < start_byte)
493 return false;
494
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500495 rcu_read_lock();
496 for (;;) {
497 page = xas_find(&xas, max);
498 if (xas_retry(&xas, page))
499 continue;
500 /* Shadow entries don't count */
501 if (xa_is_value(page))
502 continue;
503 /*
504 * We don't need to try to pin this page; we're about to
505 * release the RCU lock anyway. It is enough to know that
506 * there was a page here recently.
507 */
508 break;
509 }
510 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500511
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500512 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500513}
514EXPORT_SYMBOL(filemap_range_has_page);
515
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400516static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800517 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300519 pgoff_t index = start_byte >> PAGE_SHIFT;
520 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 struct pagevec pvec;
522 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200524 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400525 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Mel Gorman86679822017-11-15 17:37:52 -0800527 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800528 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 unsigned i;
530
Jan Kara312e9d22017-11-15 17:35:05 -0800531 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800532 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800533 if (!nr_pages)
534 break;
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 for (i = 0; i < nr_pages; i++) {
537 struct page *page = pvec.pages[i];
538
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400540 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 }
542 pagevec_release(&pvec);
543 cond_resched();
544 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800545}
546
547/**
548 * filemap_fdatawait_range - wait for writeback to complete
549 * @mapping: address space structure to wait for
550 * @start_byte: offset in bytes where the range starts
551 * @end_byte: offset in bytes where the range ends (inclusive)
552 *
553 * Walk the list of under-writeback pages of the given address space
554 * in the given range and wait for all of them. Check error status of
555 * the address space and return it.
556 *
557 * Since the error status of the address space is cleared by this function,
558 * callers are responsible for checking the return value and handling and/or
559 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800560 *
561 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800562 */
563int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
564 loff_t end_byte)
565{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400566 __filemap_fdatawait_range(mapping, start_byte, end_byte);
567 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200569EXPORT_SYMBOL(filemap_fdatawait_range);
570
571/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400572 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
573 * @mapping: address space structure to wait for
574 * @start_byte: offset in bytes where the range starts
575 * @end_byte: offset in bytes where the range ends (inclusive)
576 *
577 * Walk the list of under-writeback pages of the given address space in the
578 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
579 * this function does not clear error status of the address space.
580 *
581 * Use this function if callers don't handle errors themselves. Expected
582 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
583 * fsfreeze(8)
584 */
585int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
586 loff_t start_byte, loff_t end_byte)
587{
588 __filemap_fdatawait_range(mapping, start_byte, end_byte);
589 return filemap_check_and_keep_errors(mapping);
590}
591EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
592
593/**
Jeff Laytona823e452017-07-28 07:24:43 -0400594 * file_fdatawait_range - wait for writeback to complete
595 * @file: file pointing to address space structure to wait for
596 * @start_byte: offset in bytes where the range starts
597 * @end_byte: offset in bytes where the range ends (inclusive)
598 *
599 * Walk the list of under-writeback pages of the address space that file
600 * refers to, in the given range and wait for all of them. Check error
601 * status of the address space vs. the file->f_wb_err cursor and return it.
602 *
603 * Since the error status of the file is advanced by this function,
604 * callers are responsible for checking the return value and handling and/or
605 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800606 *
607 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400608 */
609int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
610{
611 struct address_space *mapping = file->f_mapping;
612
613 __filemap_fdatawait_range(mapping, start_byte, end_byte);
614 return file_check_and_advance_wb_err(file);
615}
616EXPORT_SYMBOL(file_fdatawait_range);
617
618/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800619 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
620 * @mapping: address space structure to wait for
621 *
622 * Walk the list of under-writeback pages of the given address space
623 * and wait for all of them. Unlike filemap_fdatawait(), this function
624 * does not clear error status of the address space.
625 *
626 * Use this function if callers don't handle errors themselves. Expected
627 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
628 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800629 *
630 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800631 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400632int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800633{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400634 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400635 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800636}
Jeff Layton76341ca2017-07-06 07:02:22 -0400637EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800638
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700639/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400640static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700642 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644
Randy Dunlap485bb992006-06-23 02:03:49 -0700645/**
Jens Axboe63135aa2021-04-29 22:55:18 -0700646 * filemap_range_needs_writeback - check if range potentially needs writeback
647 * @mapping: address space within which to check
648 * @start_byte: offset in bytes where the range starts
649 * @end_byte: offset in bytes where the range ends (inclusive)
650 *
651 * Find at least one page in the range supplied, usually used to check if
652 * direct writing in this range will trigger a writeback. Used by O_DIRECT
653 * read/write with IOCB_NOWAIT, to see if the caller needs to do
654 * filemap_write_and_wait_range() before proceeding.
655 *
656 * Return: %true if the caller should do filemap_write_and_wait_range() before
657 * doing O_DIRECT to a page in this range, %false otherwise.
658 */
659bool filemap_range_needs_writeback(struct address_space *mapping,
660 loff_t start_byte, loff_t end_byte)
661{
662 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
663 pgoff_t max = end_byte >> PAGE_SHIFT;
664 struct page *page;
665
666 if (!mapping_needs_writeback(mapping))
667 return false;
668 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
669 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
670 return false;
671 if (end_byte < start_byte)
672 return false;
673
674 rcu_read_lock();
675 xas_for_each(&xas, page, max) {
676 if (xas_retry(&xas, page))
677 continue;
678 if (xa_is_value(page))
679 continue;
680 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
681 break;
682 }
683 rcu_read_unlock();
684 return page != NULL;
685}
686EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
687
688/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700689 * filemap_write_and_wait_range - write out & wait on a file range
690 * @mapping: the address_space for the pages
691 * @lstart: offset in bytes where the range starts
692 * @lend: offset in bytes where the range ends (inclusive)
693 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800694 * Write out and wait upon file offsets lstart->lend, inclusive.
695 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300696 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800697 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800698 *
699 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800700 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701int filemap_write_and_wait_range(struct address_space *mapping,
702 loff_t lstart, loff_t lend)
703{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800704 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
Jeff Layton9326c9b2017-07-26 10:21:11 -0400706 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800707 err = __filemap_fdatawrite_range(mapping, lstart, lend,
708 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800709 /*
710 * Even if the above returned error, the pages may be
711 * written partially (e.g. -ENOSPC), so we wait for it.
712 * But the -EIO is special case, it may indicate the worst
713 * thing (e.g. bug) happened, so we avoid waiting for it.
714 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800715 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200716 int err2 = filemap_fdatawait_range(mapping,
717 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800718 if (!err)
719 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400720 } else {
721 /* Clear any previously stored errors */
722 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800723 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700724 } else {
725 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800727 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728}
Chris Masonf6995582009-04-15 13:22:37 -0400729EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Jeff Layton5660e132017-07-06 07:02:25 -0400731void __filemap_set_wb_err(struct address_space *mapping, int err)
732{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400733 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400734
735 trace_filemap_set_wb_err(mapping, eseq);
736}
737EXPORT_SYMBOL(__filemap_set_wb_err);
738
739/**
740 * file_check_and_advance_wb_err - report wb error (if any) that was previously
741 * and advance wb_err to current one
742 * @file: struct file on which the error is being reported
743 *
744 * When userland calls fsync (or something like nfsd does the equivalent), we
745 * want to report any writeback errors that occurred since the last fsync (or
746 * since the file was opened if there haven't been any).
747 *
748 * Grab the wb_err from the mapping. If it matches what we have in the file,
749 * then just quickly return 0. The file is all caught up.
750 *
751 * If it doesn't match, then take the mapping value, set the "seen" flag in
752 * it and try to swap it into place. If it works, or another task beat us
753 * to it with the new value, then update the f_wb_err and return the error
754 * portion. The error at this point must be reported via proper channels
755 * (a'la fsync, or NFS COMMIT operation, etc.).
756 *
757 * While we handle mapping->wb_err with atomic operations, the f_wb_err
758 * value is protected by the f_lock since we must ensure that it reflects
759 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800760 *
761 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400762 */
763int file_check_and_advance_wb_err(struct file *file)
764{
765 int err = 0;
766 errseq_t old = READ_ONCE(file->f_wb_err);
767 struct address_space *mapping = file->f_mapping;
768
769 /* Locklessly handle the common case where nothing has changed */
770 if (errseq_check(&mapping->wb_err, old)) {
771 /* Something changed, must use slow path */
772 spin_lock(&file->f_lock);
773 old = file->f_wb_err;
774 err = errseq_check_and_advance(&mapping->wb_err,
775 &file->f_wb_err);
776 trace_file_check_and_advance_wb_err(file, old);
777 spin_unlock(&file->f_lock);
778 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700779
780 /*
781 * We're mostly using this function as a drop in replacement for
782 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
783 * that the legacy code would have had on these flags.
784 */
785 clear_bit(AS_EIO, &mapping->flags);
786 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400787 return err;
788}
789EXPORT_SYMBOL(file_check_and_advance_wb_err);
790
791/**
792 * file_write_and_wait_range - write out & wait on a file range
793 * @file: file pointing to address_space with pages
794 * @lstart: offset in bytes where the range starts
795 * @lend: offset in bytes where the range ends (inclusive)
796 *
797 * Write out and wait upon file offsets lstart->lend, inclusive.
798 *
799 * Note that @lend is inclusive (describes the last byte to be written) so
800 * that this function can be used to write to the very end-of-file (end = -1).
801 *
802 * After writing out and waiting on the data, we check and advance the
803 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800804 *
805 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400806 */
807int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
808{
809 int err = 0, err2;
810 struct address_space *mapping = file->f_mapping;
811
Jeff Layton9326c9b2017-07-26 10:21:11 -0400812 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400813 err = __filemap_fdatawrite_range(mapping, lstart, lend,
814 WB_SYNC_ALL);
815 /* See comment of filemap_write_and_wait() */
816 if (err != -EIO)
817 __filemap_fdatawait_range(mapping, lstart, lend);
818 }
819 err2 = file_check_and_advance_wb_err(file);
820 if (!err)
821 err = err2;
822 return err;
823}
824EXPORT_SYMBOL(file_write_and_wait_range);
825
Randy Dunlap485bb992006-06-23 02:03:49 -0700826/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700827 * replace_page_cache_page - replace a pagecache page with a new one
828 * @old: page to be replaced
829 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700830 *
831 * This function replaces a page in the pagecache with a new one. On
832 * success it acquires the pagecache reference for the new page and
833 * drops it for the old page. Both the old and new pages must be
834 * locked. This function does not add the new page to the LRU, the
835 * caller must do that.
836 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500837 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700838 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800839void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700840{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500841 struct address_space *mapping = old->mapping;
842 void (*freepage)(struct page *) = mapping->a_ops->freepage;
843 pgoff_t offset = old->index;
844 XA_STATE(xas, &mapping->i_pages, offset);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700845
Sasha Levin309381fea2014-01-23 15:52:54 -0800846 VM_BUG_ON_PAGE(!PageLocked(old), old);
847 VM_BUG_ON_PAGE(!PageLocked(new), new);
848 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700849
Matthew Wilcox74d60952017-11-17 10:01:45 -0500850 get_page(new);
851 new->mapping = mapping;
852 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700853
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700854 mem_cgroup_migrate(old, new);
855
Johannes Weiner30472502021-09-02 14:53:18 -0700856 xas_lock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500857 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700858
Matthew Wilcox74d60952017-11-17 10:01:45 -0500859 old->mapping = NULL;
860 /* hugetlb pages do not participate in page cache accounting. */
861 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700862 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500863 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700864 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500865 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700866 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500867 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700868 __inc_lruvec_page_state(new, NR_SHMEM);
Johannes Weiner30472502021-09-02 14:53:18 -0700869 xas_unlock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500870 if (freepage)
871 freepage(old);
872 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700873}
874EXPORT_SYMBOL_GPL(replace_page_cache_page);
875
Andrew Morton16c0cc02020-12-11 13:36:27 -0800876noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700877 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700878 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700879 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500881 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700882 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700883 int error;
Waiman Longda742402021-02-04 18:32:45 -0800884 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700885
Sasha Levin309381fea2014-01-23 15:52:54 -0800886 VM_BUG_ON_PAGE(!PageLocked(page), page);
887 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500888 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700889
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300890 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700891 page->mapping = mapping;
892 page->index = offset;
893
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700894 if (!huge) {
Dan Schatzberg04f94e32021-06-28 19:38:18 -0700895 error = mem_cgroup_charge(page, NULL, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700896 if (error)
897 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800898 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700899 }
900
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700901 gfp &= GFP_RECLAIM_MASK;
902
Matthew Wilcox74d60952017-11-17 10:01:45 -0500903 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700904 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
905 void *entry, *old = NULL;
906
907 if (order > thp_order(page))
908 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
909 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500910 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700911 xas_for_each_conflict(&xas, entry) {
912 old = entry;
913 if (!xa_is_value(entry)) {
914 xas_set_err(&xas, -EEXIST);
915 goto unlock;
916 }
917 }
918
919 if (old) {
920 if (shadowp)
921 *shadowp = old;
922 /* entry may have been split before we acquired lock */
923 order = xa_get_order(xas.xa, xas.xa_index);
924 if (order > thp_order(page)) {
925 xas_split(&xas, old, order);
926 xas_reset(&xas);
927 }
928 }
929
Matthew Wilcox74d60952017-11-17 10:01:45 -0500930 xas_store(&xas, page);
931 if (xas_error(&xas))
932 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700933
Matthew Wilcox74d60952017-11-17 10:01:45 -0500934 mapping->nrpages++;
935
936 /* hugetlb pages do not participate in page cache accounting */
937 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700938 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500939unlock:
940 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700941 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500942
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700943 if (xas_error(&xas)) {
944 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800945 if (charged)
946 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500947 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700948 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500949
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700950 trace_mm_filemap_add_to_page_cache(page);
951 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500952error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700953 page->mapping = NULL;
954 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300955 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700956 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700958ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700959
960/**
961 * add_to_page_cache_locked - add a locked page to the pagecache
962 * @page: page to add
963 * @mapping: the page's address_space
964 * @offset: page index
965 * @gfp_mask: page allocation mode
966 *
967 * This function is used to add a page to the pagecache. It must be locked.
968 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800969 *
970 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700971 */
972int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
973 pgoff_t offset, gfp_t gfp_mask)
974{
975 return __add_to_page_cache_locked(page, mapping, offset,
976 gfp_mask, NULL);
977}
Nick Piggine2867812008-07-25 19:45:30 -0700978EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979
980int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400981 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982{
Johannes Weinera5289102014-04-03 14:47:51 -0700983 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700984 int ret;
985
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800986 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700987 ret = __add_to_page_cache_locked(page, mapping, offset,
988 gfp_mask, &shadow);
989 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800990 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700991 else {
992 /*
993 * The page might have been evicted from cache only
994 * recently, in which case it should be activated like
995 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700996 * The exception is pages getting rewritten; evicting other
997 * data from the working set, only to cache data that will
998 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700999 */
Johannes Weiner1899ad12018-10-26 15:06:04 -07001000 WARN_ON_ONCE(PageActive(page));
1001 if (!(gfp_mask & __GFP_WRITE) && shadow)
1002 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -07001003 lru_cache_add(page);
1004 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 return ret;
1006}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001007EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008
Paul Jackson44110fe2006-03-24 03:16:04 -08001009#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -07001010struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -08001011{
Miao Xiec0ff7452010-05-24 14:32:08 -07001012 int n;
1013 struct page *page;
1014
Paul Jackson44110fe2006-03-24 03:16:04 -08001015 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -07001016 unsigned int cpuset_mems_cookie;
1017 do {
Mel Gormand26914d2014-04-03 14:47:24 -07001018 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -07001019 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -07001020 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -07001021 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -07001022
Miao Xiec0ff7452010-05-24 14:32:08 -07001023 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -08001024 }
Nick Piggin2ae88142006-10-28 10:38:23 -07001025 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -08001026}
Nick Piggin2ae88142006-10-28 10:38:23 -07001027EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -08001028#endif
1029
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030/*
Jan Kara7506ae62021-05-24 13:02:30 +02001031 * filemap_invalidate_lock_two - lock invalidate_lock for two mappings
1032 *
1033 * Lock exclusively invalidate_lock of any passed mapping that is not NULL.
1034 *
1035 * @mapping1: the first mapping to lock
1036 * @mapping2: the second mapping to lock
1037 */
1038void filemap_invalidate_lock_two(struct address_space *mapping1,
1039 struct address_space *mapping2)
1040{
1041 if (mapping1 > mapping2)
1042 swap(mapping1, mapping2);
1043 if (mapping1)
1044 down_write(&mapping1->invalidate_lock);
1045 if (mapping2 && mapping1 != mapping2)
1046 down_write_nested(&mapping2->invalidate_lock, 1);
1047}
1048EXPORT_SYMBOL(filemap_invalidate_lock_two);
1049
1050/*
1051 * filemap_invalidate_unlock_two - unlock invalidate_lock for two mappings
1052 *
1053 * Unlock exclusive invalidate_lock of any passed mapping that is not NULL.
1054 *
1055 * @mapping1: the first mapping to unlock
1056 * @mapping2: the second mapping to unlock
1057 */
1058void filemap_invalidate_unlock_two(struct address_space *mapping1,
1059 struct address_space *mapping2)
1060{
1061 if (mapping1)
1062 up_write(&mapping1->invalidate_lock);
1063 if (mapping2 && mapping1 != mapping2)
1064 up_write(&mapping2->invalidate_lock);
1065}
1066EXPORT_SYMBOL(filemap_invalidate_unlock_two);
1067
1068/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 * In order to wait for pages to become available there must be
1070 * waitqueues associated with pages. By using a hash table of
1071 * waitqueues where the bucket discipline is to maintain all
1072 * waiters on the same queue and wake all when any of the pages
1073 * become available, and for the woken contexts to check to be
1074 * sure the appropriate page became available, this saves space
1075 * at a cost of "thundering herd" phenomena during rare hash
1076 * collisions.
1077 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001078#define PAGE_WAIT_TABLE_BITS 8
1079#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1080static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1081
1082static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001083{
Nicholas Piggin62906022016-12-25 13:00:30 +10001084 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085}
Nicholas Piggin62906022016-12-25 13:00:30 +10001086
1087void __init pagecache_init(void)
1088{
1089 int i;
1090
1091 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1092 init_waitqueue_head(&page_wait_table[i]);
1093
1094 page_writeback_init();
1095}
1096
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001097/*
1098 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001099 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001100 * one.
1101 *
1102 * We have:
1103 *
1104 * (a) no special bits set:
1105 *
1106 * We're just waiting for the bit to be released, and when a waker
1107 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1108 * and remove it from the wait queue.
1109 *
1110 * Simple and straightforward.
1111 *
1112 * (b) WQ_FLAG_EXCLUSIVE:
1113 *
1114 * The waiter is waiting to get the lock, and only one waiter should
1115 * be woken up to avoid any thundering herd behavior. We'll set the
1116 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1117 *
1118 * This is the traditional exclusive wait.
1119 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001120 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001121 *
1122 * The waiter is waiting to get the bit, and additionally wants the
1123 * lock to be transferred to it for fair lock behavior. If the lock
1124 * cannot be taken, we stop walking the wait queue without waking
1125 * the waiter.
1126 *
1127 * This is the "fair lock handoff" case, and in addition to setting
1128 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1129 * that it now has the lock.
1130 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001131static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001132{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001133 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001134 struct wait_page_key *key = arg;
1135 struct wait_page_queue *wait_page
1136 = container_of(wait, struct wait_page_queue, wait);
1137
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001138 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001139 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001140
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001141 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001142 * If it's a lock handoff wait, we get the bit for it, and
1143 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001144 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001145 flags = wait->flags;
1146 if (flags & WQ_FLAG_EXCLUSIVE) {
1147 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001148 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001149 if (flags & WQ_FLAG_CUSTOM) {
1150 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1151 return -1;
1152 flags |= WQ_FLAG_DONE;
1153 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001154 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001155
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001156 /*
1157 * We are holding the wait-queue lock, but the waiter that
1158 * is waiting for this will be checking the flags without
1159 * any locking.
1160 *
1161 * So update the flags atomically, and wake up the waiter
1162 * afterwards to avoid any races. This store-release pairs
1163 * with the load-acquire in wait_on_page_bit_common().
1164 */
1165 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001166 wake_up_state(wait->private, mode);
1167
1168 /*
1169 * Ok, we have successfully done what we're waiting for,
1170 * and we can unconditionally remove the wait entry.
1171 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001172 * Note that this pairs with the "finish_wait()" in the
1173 * waiter, and has to be the absolute last thing we do.
1174 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001175 * might be de-allocated and the process might even have
1176 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001177 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001178 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001179 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001180}
1181
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001182static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001183{
1184 wait_queue_head_t *q = page_waitqueue(page);
1185 struct wait_page_key key;
1186 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001187 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001188
1189 key.page = page;
1190 key.bit_nr = bit_nr;
1191 key.page_match = 0;
1192
Tim Chen11a19c72017-08-25 09:13:55 -07001193 bookmark.flags = 0;
1194 bookmark.private = NULL;
1195 bookmark.func = NULL;
1196 INIT_LIST_HEAD(&bookmark.entry);
1197
Nicholas Piggin62906022016-12-25 13:00:30 +10001198 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001199 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1200
1201 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1202 /*
1203 * Take a breather from holding the lock,
1204 * allow pages that finish wake up asynchronously
1205 * to acquire the lock and remove themselves
1206 * from wait queue
1207 */
1208 spin_unlock_irqrestore(&q->lock, flags);
1209 cpu_relax();
1210 spin_lock_irqsave(&q->lock, flags);
1211 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1212 }
1213
Nicholas Piggin62906022016-12-25 13:00:30 +10001214 /*
1215 * It is possible for other pages to have collided on the waitqueue
1216 * hash, so in that case check for a page match. That prevents a long-
1217 * term waiter
1218 *
1219 * It is still possible to miss a case here, when we woke page waiters
1220 * and removed them from the waitqueue, but there are still other
1221 * page waiters.
1222 */
1223 if (!waitqueue_active(q) || !key.page_match) {
1224 ClearPageWaiters(page);
1225 /*
1226 * It's possible to miss clearing Waiters here, when we woke
1227 * our page waiters, but the hashed waitqueue has waiters for
1228 * other pages on it.
1229 *
1230 * That's okay, it's a rare case. The next waker will clear it.
1231 */
1232 }
1233 spin_unlock_irqrestore(&q->lock, flags);
1234}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001235
1236static void wake_up_page(struct page *page, int bit)
1237{
1238 if (!PageWaiters(page))
1239 return;
1240 wake_up_page_bit(page, bit);
1241}
Nicholas Piggin62906022016-12-25 13:00:30 +10001242
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001243/*
1244 * A choice of three behaviors for wait_on_page_bit_common():
1245 */
1246enum behavior {
1247 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1248 * __lock_page() waiting on then setting PG_locked.
1249 */
1250 SHARED, /* Hold ref to page and check the bit when woken, like
1251 * wait_on_page_writeback() waiting on PG_writeback.
1252 */
1253 DROP, /* Drop ref to page before wait, no check when woken,
1254 * like put_and_wait_on_page_locked() on PG_locked.
1255 */
1256};
1257
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001258/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001259 * Attempt to check (or get) the page bit, and mark us done
1260 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001261 */
1262static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1263 struct wait_queue_entry *wait)
1264{
1265 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1266 if (test_and_set_bit(bit_nr, &page->flags))
1267 return false;
1268 } else if (test_bit(bit_nr, &page->flags))
1269 return false;
1270
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001271 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001272 return true;
1273}
1274
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001275/* How many times do we accept lock stealing from under a waiter? */
1276int sysctl_page_lock_unfairness = 5;
1277
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001278static inline __sched int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001279 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001280{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001281 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001282 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001283 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001284 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001285 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001286 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001287
Johannes Weinereb414682018-10-26 15:06:27 -07001288 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001289 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001290 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001291 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001292 delayacct = true;
1293 }
Johannes Weinereb414682018-10-26 15:06:27 -07001294 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001295 thrashing = true;
1296 }
1297
Nicholas Piggin62906022016-12-25 13:00:30 +10001298 init_wait(wait);
1299 wait->func = wake_page_function;
1300 wait_page.page = page;
1301 wait_page.bit_nr = bit_nr;
1302
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001303repeat:
1304 wait->flags = 0;
1305 if (behavior == EXCLUSIVE) {
1306 wait->flags = WQ_FLAG_EXCLUSIVE;
1307 if (--unfairness < 0)
1308 wait->flags |= WQ_FLAG_CUSTOM;
1309 }
1310
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001311 /*
1312 * Do one last check whether we can get the
1313 * page bit synchronously.
1314 *
1315 * Do the SetPageWaiters() marking before that
1316 * to let any waker we _just_ missed know they
1317 * need to wake us up (otherwise they'll never
1318 * even go to the slow case that looks at the
1319 * page queue), and add ourselves to the wait
1320 * queue if we need to sleep.
1321 *
1322 * This part needs to be done under the queue
1323 * lock to avoid races.
1324 */
1325 spin_lock_irq(&q->lock);
1326 SetPageWaiters(page);
1327 if (!trylock_page_bit_common(page, bit_nr, wait))
1328 __add_wait_queue_entry_tail(q, wait);
1329 spin_unlock_irq(&q->lock);
1330
1331 /*
1332 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001333 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1334 * see whether the page bit testing has already
1335 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001336 *
1337 * We can drop our reference to the page.
1338 */
1339 if (behavior == DROP)
1340 put_page(page);
1341
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001342 /*
1343 * Note that until the "finish_wait()", or until
1344 * we see the WQ_FLAG_WOKEN flag, we need to
1345 * be very careful with the 'wait->flags', because
1346 * we may race with a waker that sets them.
1347 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001348 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001349 unsigned int flags;
1350
Nicholas Piggin62906022016-12-25 13:00:30 +10001351 set_current_state(state);
1352
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001353 /* Loop until we've been woken or interrupted */
1354 flags = smp_load_acquire(&wait->flags);
1355 if (!(flags & WQ_FLAG_WOKEN)) {
1356 if (signal_pending_state(state, current))
1357 break;
1358
1359 io_schedule();
1360 continue;
1361 }
1362
1363 /* If we were non-exclusive, we're done */
1364 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001365 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001366
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001367 /* If the waker got the lock for us, we're done */
1368 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001369 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001370
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001371 /*
1372 * Otherwise, if we're getting the lock, we need to
1373 * try to get it ourselves.
1374 *
1375 * And if that fails, we'll have to retry this all.
1376 */
1377 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1378 goto repeat;
1379
1380 wait->flags |= WQ_FLAG_DONE;
1381 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001382 }
1383
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001384 /*
1385 * If a signal happened, this 'finish_wait()' may remove the last
1386 * waiter from the wait-queues, but the PageWaiters bit will remain
1387 * set. That's ok. The next wakeup will take care of it, and trying
1388 * to do it here would be difficult and prone to races.
1389 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001390 finish_wait(q, wait);
1391
Johannes Weinereb414682018-10-26 15:06:27 -07001392 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001393 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001394 delayacct_thrashing_end();
1395 psi_memstall_leave(&pflags);
1396 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001397
Nicholas Piggin62906022016-12-25 13:00:30 +10001398 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001399 * NOTE! The wait->flags weren't stable until we've done the
1400 * 'finish_wait()', and we could have exited the loop above due
1401 * to a signal, and had a wakeup event happen after the signal
1402 * test but before the 'finish_wait()'.
1403 *
1404 * So only after the finish_wait() can we reliably determine
1405 * if we got woken up or not, so we can now figure out the final
1406 * return value based on that state without races.
1407 *
1408 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1409 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001410 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001411 if (behavior == EXCLUSIVE)
1412 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001413
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001414 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001415}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001417__sched void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418{
Nicholas Piggin62906022016-12-25 13:00:30 +10001419 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001420 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421}
1422EXPORT_SYMBOL(wait_on_page_bit);
1423
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001424__sched int wait_on_page_bit_killable(struct page *page, int bit_nr)
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001425{
Nicholas Piggin62906022016-12-25 13:00:30 +10001426 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001427 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001428}
David Howells4343d002017-11-02 15:27:52 +00001429EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001430
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001432 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1433 * @page: The page to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001434 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001435 *
1436 * The caller should hold a reference on @page. They expect the page to
1437 * become unlocked relatively soon, but do not wish to hold up migration
1438 * (for example) by holding the reference while waiting for the page to
1439 * come unlocked. After this function returns, the caller should not
1440 * dereference @page.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001441 *
1442 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001443 */
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001444int put_and_wait_on_page_locked(struct page *page, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001445{
1446 wait_queue_head_t *q;
1447
1448 page = compound_head(page);
1449 q = page_waitqueue(page);
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001450 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001451}
1452
1453/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001454 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001455 * @page: Page defining the wait queue of interest
1456 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001457 *
1458 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1459 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001460void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001461{
1462 wait_queue_head_t *q = page_waitqueue(page);
1463 unsigned long flags;
1464
1465 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001466 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001467 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001468 spin_unlock_irqrestore(&q->lock, flags);
1469}
1470EXPORT_SYMBOL_GPL(add_page_wait_queue);
1471
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001472#ifndef clear_bit_unlock_is_negative_byte
1473
1474/*
1475 * PG_waiters is the high bit in the same byte as PG_lock.
1476 *
1477 * On x86 (and on many other architectures), we can clear PG_lock and
1478 * test the sign bit at the same time. But if the architecture does
1479 * not support that special operation, we just do this all by hand
1480 * instead.
1481 *
1482 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001483 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001484 * in the same byte as PG_locked.
1485 */
1486static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1487{
1488 clear_bit_unlock(nr, mem);
1489 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001490 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001491}
1492
1493#endif
1494
David Howells385e1ca5f2009-04-03 16:42:39 +01001495/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001496 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 * @page: the page
1498 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001499 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001501 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1503 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001504 * Note that this depends on PG_waiters being the sign bit in the byte
1505 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1506 * clear the PG_locked bit and test PG_waiters at the same time fairly
1507 * portably (architectures that do LL/SC can test any bit, while x86 can
1508 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001510void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001512 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001513 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001514 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001515 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1516 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001517}
1518EXPORT_SYMBOL(unlock_page);
1519
Randy Dunlap485bb992006-06-23 02:03:49 -07001520/**
David Howells73e10de2020-02-10 10:00:21 +00001521 * end_page_private_2 - Clear PG_private_2 and release any waiters
1522 * @page: The page
1523 *
1524 * Clear the PG_private_2 bit on a page and wake up any sleepers waiting for
1525 * this. The page ref held for PG_private_2 being set is released.
1526 *
1527 * This is, for example, used when a netfs page is being written to a local
1528 * disk cache, thereby allowing writes to the cache for the same page to be
1529 * serialised.
1530 */
1531void end_page_private_2(struct page *page)
1532{
1533 page = compound_head(page);
1534 VM_BUG_ON_PAGE(!PagePrivate2(page), page);
1535 clear_bit_unlock(PG_private_2, &page->flags);
1536 wake_up_page_bit(page, PG_private_2);
1537 put_page(page);
1538}
1539EXPORT_SYMBOL(end_page_private_2);
1540
1541/**
1542 * wait_on_page_private_2 - Wait for PG_private_2 to be cleared on a page
1543 * @page: The page to wait on
1544 *
1545 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page.
1546 */
1547void wait_on_page_private_2(struct page *page)
1548{
1549 page = compound_head(page);
1550 while (PagePrivate2(page))
1551 wait_on_page_bit(page, PG_private_2);
1552}
1553EXPORT_SYMBOL(wait_on_page_private_2);
1554
1555/**
1556 * wait_on_page_private_2_killable - Wait for PG_private_2 to be cleared on a page
1557 * @page: The page to wait on
1558 *
1559 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page or until a
1560 * fatal signal is received by the calling task.
1561 *
1562 * Return:
1563 * - 0 if successful.
1564 * - -EINTR if a fatal signal was encountered.
1565 */
1566int wait_on_page_private_2_killable(struct page *page)
1567{
1568 int ret = 0;
1569
1570 page = compound_head(page);
1571 while (PagePrivate2(page)) {
1572 ret = wait_on_page_bit_killable(page, PG_private_2);
1573 if (ret < 0)
1574 break;
1575 }
1576
1577 return ret;
1578}
1579EXPORT_SYMBOL(wait_on_page_private_2_killable);
1580
1581/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001582 * end_page_writeback - end writeback against a page
1583 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584 */
1585void end_page_writeback(struct page *page)
1586{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001587 /*
1588 * TestClearPageReclaim could be used here but it is an atomic
1589 * operation and overkill in this particular case. Failing to
1590 * shuffle a page marked for immediate reclaim is too mild to
1591 * justify taking an atomic operation penalty at the end of
1592 * ever page writeback.
1593 */
1594 if (PageReclaim(page)) {
1595 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001596 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001597 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001598
Hugh Dickins073861e2020-11-24 08:46:43 -08001599 /*
1600 * Writeback does not hold a page reference of its own, relying
1601 * on truncation to wait for the clearing of PG_writeback.
1602 * But here we must make sure that the page is not freed and
1603 * reused before the wake_up_page().
1604 */
1605 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001606 if (!test_clear_page_writeback(page))
1607 BUG();
1608
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001609 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001611 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612}
1613EXPORT_SYMBOL(end_page_writeback);
1614
Matthew Wilcox57d99842014-06-04 16:07:45 -07001615/*
1616 * After completing I/O on a page, call this routine to update the page
1617 * flags appropriately
1618 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001619void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001620{
Jens Axboec11f0c02016-08-05 08:11:04 -06001621 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001622 if (!err) {
1623 SetPageUptodate(page);
1624 } else {
1625 ClearPageUptodate(page);
1626 SetPageError(page);
1627 }
1628 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001629 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001630 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001631 struct address_space *mapping;
1632
Matthew Wilcox57d99842014-06-04 16:07:45 -07001633 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001634 mapping = page_mapping(page);
1635 if (mapping)
1636 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001637 }
1638 end_page_writeback(page);
1639 }
1640}
1641EXPORT_SYMBOL_GPL(page_endio);
1642
Randy Dunlap485bb992006-06-23 02:03:49 -07001643/**
1644 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001645 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001647__sched void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648{
Nicholas Piggin62906022016-12-25 13:00:30 +10001649 struct page *page = compound_head(__page);
1650 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001651 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1652 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653}
1654EXPORT_SYMBOL(__lock_page);
1655
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001656__sched int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001657{
Nicholas Piggin62906022016-12-25 13:00:30 +10001658 struct page *page = compound_head(__page);
1659 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001660 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1661 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001662}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001663EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001664
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001665__sched int __lock_page_async(struct page *page, struct wait_page_queue *wait)
Jens Axboedd3e6d52020-05-22 09:12:09 -06001666{
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001667 struct wait_queue_head *q = page_waitqueue(page);
1668 int ret = 0;
1669
1670 wait->page = page;
1671 wait->bit_nr = PG_locked;
1672
1673 spin_lock_irq(&q->lock);
1674 __add_wait_queue_entry_tail(q, &wait->wait);
1675 SetPageWaiters(page);
1676 ret = !trylock_page(page);
1677 /*
1678 * If we were successful now, we know we're still on the
1679 * waitqueue as we're still under the lock. This means it's
1680 * safe to remove and return success, we know the callback
1681 * isn't going to trigger.
1682 */
1683 if (!ret)
1684 __remove_wait_queue(q, &wait->wait);
1685 else
1686 ret = -EIOCBQUEUED;
1687 spin_unlock_irq(&q->lock);
1688 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001689}
1690
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001691/*
1692 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001693 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001694 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001695 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001696 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001697 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001698 *
1699 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001700 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001701 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001702__sched int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
Michel Lespinassed065bd82010-10-26 14:21:57 -07001703 unsigned int flags)
1704{
Peter Xu4064b982020-04-01 21:08:45 -07001705 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001706 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001707 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001708 * even though return 0.
1709 */
1710 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1711 return 0;
1712
Oven25ebc092024-04-10 19:23:08 +08001713 if (!(flags & FAULT_FLAG_SPECULATIVE))
1714 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001715 if (flags & FAULT_FLAG_KILLABLE)
1716 wait_on_page_locked_killable(page);
1717 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001718 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001719 return 0;
1720 }
Hailong Liu800bca72020-12-14 19:05:02 -08001721 if (flags & FAULT_FLAG_KILLABLE) {
1722 int ret;
1723
1724 ret = __lock_page_killable(page);
1725 if (ret) {
Oven25ebc092024-04-10 19:23:08 +08001726 if (!(flags & FAULT_FLAG_SPECULATIVE))
1727 mmap_read_unlock(mm);
Hailong Liu800bca72020-12-14 19:05:02 -08001728 return 0;
1729 }
1730 } else {
1731 __lock_page(page);
1732 }
1733 return 1;
1734
Michel Lespinassed065bd82010-10-26 14:21:57 -07001735}
1736
Randy Dunlap485bb992006-06-23 02:03:49 -07001737/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001738 * page_cache_next_miss() - Find the next gap in the page cache.
1739 * @mapping: Mapping.
1740 * @index: Index.
1741 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001742 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001743 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1744 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001745 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001746 * This function may be called under the rcu_read_lock. However, this will
1747 * not atomically search a snapshot of the cache at a single point in time.
1748 * For example, if a gap is created at index 5, then subsequently a gap is
1749 * created at index 10, page_cache_next_miss covering both indices may
1750 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001751 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001752 * Return: The index of the gap if found, otherwise an index outside the
1753 * range specified (in which case 'return - index >= max_scan' will be true).
1754 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001755 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001756pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001757 pgoff_t index, unsigned long max_scan)
1758{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001759 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001760
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001761 while (max_scan--) {
1762 void *entry = xas_next(&xas);
1763 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001764 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001765 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001766 break;
1767 }
1768
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001769 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001770}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001771EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001772
1773/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001774 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001775 * @mapping: Mapping.
1776 * @index: Index.
1777 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001778 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001779 * Search the range [max(index - max_scan + 1, 0), index] for the
1780 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001781 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001782 * This function may be called under the rcu_read_lock. However, this will
1783 * not atomically search a snapshot of the cache at a single point in time.
1784 * For example, if a gap is created at index 10, then subsequently a gap is
1785 * created at index 5, page_cache_prev_miss() covering both indices may
1786 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001787 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001788 * Return: The index of the gap if found, otherwise an index outside the
1789 * range specified (in which case 'index - return >= max_scan' will be true).
1790 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001791 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001792pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001793 pgoff_t index, unsigned long max_scan)
1794{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001795 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001796
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001797 while (max_scan--) {
1798 void *entry = xas_prev(&xas);
1799 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001800 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001801 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001802 break;
1803 }
1804
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001805 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001806}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001807EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001808
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001809/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001810 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001811 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001812 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001813 *
Rui Sun4b17f032021-04-29 22:55:38 -07001814 * Looks up the page cache slot at @mapping & @index. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001815 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001816 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001817 * If the slot holds a shadow entry of a previously evicted page, or a
1818 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001819 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001820 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 */
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001822static struct page *mapping_get_entry(struct address_space *mapping,
1823 pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001825 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001826 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001827
Nick Piggina60637c2008-07-25 19:45:31 -07001828 rcu_read_lock();
1829repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001830 xas_reset(&xas);
1831 page = xas_load(&xas);
1832 if (xas_retry(&xas, page))
1833 goto repeat;
1834 /*
1835 * A shadow entry of a recently evicted page, or a swap entry from
1836 * shmem/tmpfs. Return it without attempting to raise page count.
1837 */
1838 if (!page || xa_is_value(page))
1839 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001840
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001841 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001842 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001843
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001844 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001845 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001846 * This is part of the lockless pagecache protocol. See
1847 * include/linux/pagemap.h for details.
1848 */
1849 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001850 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001851 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001852 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001853out:
Nick Piggina60637c2008-07-25 19:45:31 -07001854 rcu_read_unlock();
1855
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856 return page;
1857}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858
Randy Dunlap485bb992006-06-23 02:03:49 -07001859/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001860 * pagecache_get_page - Find and get a reference to a page.
1861 * @mapping: The address_space to search.
1862 * @index: The page index.
1863 * @fgp_flags: %FGP flags modify how the page is returned.
1864 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001865 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001866 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001867 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001868 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001869 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001870 * * %FGP_ACCESSED - The page will be marked accessed.
1871 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001872 * * %FGP_HEAD - If the page is present and a THP, return the head page
1873 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001874 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
1875 * instead of allocating a new page to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001876 * * %FGP_CREAT - If no page is present then a new page is allocated using
1877 * @gfp_mask and added to the page cache and the VM's LRU list.
1878 * The page is returned locked and with an increased refcount.
1879 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1880 * page is already in cache. If the page was allocated, unlock it before
1881 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001882 * * %FGP_WRITE - The page will be written
1883 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1884 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001885 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001886 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1887 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001888 *
1889 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001890 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001891 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001892 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001893struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1894 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895{
Nick Piggineb2be182007-10-16 01:24:57 -07001896 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001897
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898repeat:
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001899 page = mapping_get_entry(mapping, index);
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001900 if (xa_is_value(page)) {
1901 if (fgp_flags & FGP_ENTRY)
1902 return page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001903 page = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001904 }
Chiawei Wang6ef0f852021-02-18 10:47:37 +08001905
1906 trace_android_vh_pagecache_get_page(mapping, index, fgp_flags,
1907 gfp_mask, page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001908 if (!page)
1909 goto no_page;
1910
1911 if (fgp_flags & FGP_LOCK) {
1912 if (fgp_flags & FGP_NOWAIT) {
1913 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001914 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001915 return NULL;
1916 }
1917 } else {
1918 lock_page(page);
1919 }
1920
1921 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001922 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001923 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001924 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001925 goto repeat;
1926 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001927 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001928 }
1929
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001930 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001931 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001932 else if (fgp_flags & FGP_WRITE) {
1933 /* Clear idle flag for buffer write */
1934 if (page_is_idle(page))
1935 clear_page_idle(page);
1936 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001937 if (!(fgp_flags & FGP_HEAD))
1938 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001939
1940no_page:
1941 if (!page && (fgp_flags & FGP_CREAT)) {
1942 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001943 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001944 gfp_mask |= __GFP_WRITE;
1945 if (fgp_flags & FGP_NOFS)
1946 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001947
Michal Hocko45f87de2014-12-29 20:30:35 +01001948 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001949 if (!page)
1950 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001951
Josef Bacika75d4c32019-03-13 11:44:14 -07001952 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001953 fgp_flags |= FGP_LOCK;
1954
Hugh Dickinseb39d612014-08-06 16:06:43 -07001955 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001956 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001957 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001958
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001959 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001960 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001961 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001962 page = NULL;
1963 if (err == -EEXIST)
1964 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001966
1967 /*
1968 * add_to_page_cache_lru locks the page, and for mmap we expect
1969 * an unlocked page.
1970 */
1971 if (page && (fgp_flags & FGP_FOR_MMAP))
1972 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001974
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 return page;
1976}
Mel Gorman2457aec2014-06-04 16:10:31 -07001977EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001979static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1980 xa_mark_t mark)
1981{
1982 struct page *page;
1983
1984retry:
1985 if (mark == XA_PRESENT)
1986 page = xas_find(xas, max);
1987 else
1988 page = xas_find_marked(xas, max, mark);
1989
1990 if (xas_retry(xas, page))
1991 goto retry;
1992 /*
1993 * A shadow entry of a recently evicted page, a swap
1994 * entry from shmem/tmpfs or a DAX entry. Return it
1995 * without attempting to raise page count.
1996 */
1997 if (!page || xa_is_value(page))
1998 return page;
1999
2000 if (!page_cache_get_speculative(page))
2001 goto reset;
2002
2003 /* Has the page moved or been split? */
2004 if (unlikely(page != xas_reload(xas))) {
2005 put_page(page);
2006 goto reset;
2007 }
2008
2009 return page;
2010reset:
2011 xas_reset(xas);
2012 goto retry;
2013}
2014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07002016 * find_get_entries - gang pagecache lookup
2017 * @mapping: The address_space to search
2018 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002019 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002020 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002021 * @indices: The cache indices corresponding to the entries in @entries
2022 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002023 * find_get_entries() will search for and return a batch of entries in
2024 * the mapping. The entries are placed in @pvec. find_get_entries()
2025 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002026 *
2027 * The search returns a group of mapping-contiguous page cache entries
2028 * with ascending indexes. There may be holes in the indices due to
2029 * not-present pages.
2030 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07002031 * Any shadow entries of evicted pages, or swap entries from
2032 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002033 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07002034 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
2035 * stops at that page: the caller is likely to have a better way to handle
2036 * the compound page as a whole, and then skip its extent, than repeatedly
2037 * calling find_get_entries() to return all its tails.
2038 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002039 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002040 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002041unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002042 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07002043{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002044 XA_STATE(xas, &mapping->i_pages, start);
2045 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002046 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002047 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002048
2049 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002050 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002051 /*
2052 * Terminate early on finding a THP, to allow the caller to
2053 * handle it all at once; but continue if this is hugetlbfs.
2054 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002055 if (!xa_is_value(page) && PageTransHuge(page) &&
2056 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002057 page = find_subpage(page, xas.xa_index);
2058 nr_entries = ret + 1;
2059 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002060
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002061 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002062 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002063 if (++ret == nr_entries)
2064 break;
2065 }
2066 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002067
2068 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002069 return ret;
2070}
2071
2072/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002073 * find_lock_entries - Find a batch of pagecache entries.
2074 * @mapping: The address_space to search.
2075 * @start: The starting page cache index.
2076 * @end: The final page index (inclusive).
2077 * @pvec: Where the resulting entries are placed.
2078 * @indices: The cache indices of the entries in @pvec.
2079 *
2080 * find_lock_entries() will return a batch of entries from @mapping.
2081 * Swap, shadow and DAX entries are included. Pages are returned
2082 * locked and with an incremented refcount. Pages which are locked by
2083 * somebody else or under writeback are skipped. Only the head page of
2084 * a THP is returned. Pages which are partially outside the range are
2085 * not returned.
2086 *
2087 * The entries have ascending indexes. The indices may not be consecutive
2088 * due to not-present entries, THP pages, pages which could not be locked
2089 * or pages under writeback.
2090 *
2091 * Return: The number of entries which were found.
2092 */
2093unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2094 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2095{
2096 XA_STATE(xas, &mapping->i_pages, start);
2097 struct page *page;
2098
2099 rcu_read_lock();
2100 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Liu Shixin066a5b62022-07-07 10:09:38 +08002101 unsigned long next_idx = xas.xa_index + 1;
2102
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002103 if (!xa_is_value(page)) {
Liu Shixin066a5b62022-07-07 10:09:38 +08002104 if (PageTransHuge(page))
2105 next_idx = page->index + thp_nr_pages(page);
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002106 if (page->index < start)
2107 goto put;
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002108 if (page->index + thp_nr_pages(page) - 1 > end)
2109 goto put;
2110 if (!trylock_page(page))
2111 goto put;
2112 if (page->mapping != mapping || PageWriteback(page))
2113 goto unlock;
2114 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2115 page);
2116 }
2117 indices[pvec->nr] = xas.xa_index;
2118 if (!pagevec_add(pvec, page))
2119 break;
2120 goto next;
2121unlock:
2122 unlock_page(page);
2123put:
2124 put_page(page);
2125next:
Liu Shixin066a5b62022-07-07 10:09:38 +08002126 if (next_idx != xas.xa_index + 1) {
Hugh Dickins2d11e732021-04-23 14:28:57 -07002127 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
Liu Shixin066a5b62022-07-07 10:09:38 +08002128 if (next_idx < xas.xa_index)
Hugh Dickins2d11e732021-04-23 14:28:57 -07002129 break;
Liu Shixin066a5b62022-07-07 10:09:38 +08002130 xas_set(&xas, next_idx);
Hugh Dickins2d11e732021-04-23 14:28:57 -07002131 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002132 }
2133 rcu_read_unlock();
2134
2135 return pagevec_count(pvec);
2136}
2137
2138/**
Jan Karab947cee2017-09-06 16:21:21 -07002139 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 * @mapping: The address_space to search
2141 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002142 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 * @nr_pages: The maximum number of pages
2144 * @pages: Where the resulting pages are placed
2145 *
Jan Karab947cee2017-09-06 16:21:21 -07002146 * find_get_pages_range() will search for and return a group of up to @nr_pages
2147 * pages in the mapping starting at index @start and up to index @end
2148 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2149 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 *
2151 * The search returns a group of mapping-contiguous pages with ascending
2152 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002153 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002155 * Return: the number of pages which were found. If this number is
2156 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002157 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 */
Jan Karab947cee2017-09-06 16:21:21 -07002159unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2160 pgoff_t end, unsigned int nr_pages,
2161 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002163 XA_STATE(xas, &mapping->i_pages, *start);
2164 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002165 unsigned ret = 0;
2166
2167 if (unlikely(!nr_pages))
2168 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
Nick Piggina60637c2008-07-25 19:45:31 -07002170 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002171 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002172 /* Skip over shadow, swap and DAX entries */
2173 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002174 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002175
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002176 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002177 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002178 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002179 goto out;
2180 }
Nick Piggina60637c2008-07-25 19:45:31 -07002181 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002182
Jan Karab947cee2017-09-06 16:21:21 -07002183 /*
2184 * We come here when there is no page beyond @end. We take care to not
2185 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002186 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002187 * already broken anyway.
2188 */
2189 if (end == (pgoff_t)-1)
2190 *start = (pgoff_t)-1;
2191 else
2192 *start = end + 1;
2193out:
Nick Piggina60637c2008-07-25 19:45:31 -07002194 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002195
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 return ret;
2197}
2198
Jens Axboeebf43502006-04-27 08:46:01 +02002199/**
2200 * find_get_pages_contig - gang contiguous pagecache lookup
2201 * @mapping: The address_space to search
2202 * @index: The starting page index
2203 * @nr_pages: The maximum number of pages
2204 * @pages: Where the resulting pages are placed
2205 *
2206 * find_get_pages_contig() works exactly like find_get_pages(), except
2207 * that the returned number of pages are guaranteed to be contiguous.
2208 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002209 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002210 */
2211unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2212 unsigned int nr_pages, struct page **pages)
2213{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002214 XA_STATE(xas, &mapping->i_pages, index);
2215 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002216 unsigned int ret = 0;
2217
2218 if (unlikely(!nr_pages))
2219 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002220
Nick Piggina60637c2008-07-25 19:45:31 -07002221 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002222 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002223 if (xas_retry(&xas, page))
2224 continue;
2225 /*
2226 * If the entry has been swapped out, we can stop looking.
2227 * No current caller is looking for DAX entries.
2228 */
2229 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002230 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002231
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002232 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002233 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002234
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002235 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002236 if (unlikely(page != xas_reload(&xas)))
2237 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002238
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002239 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002240 if (++ret == nr_pages)
2241 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002242 continue;
2243put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002244 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002245retry:
2246 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002247 }
Nick Piggina60637c2008-07-25 19:45:31 -07002248 rcu_read_unlock();
2249 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002250}
David Howellsef71c152007-05-09 02:33:44 -07002251EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002252
Randy Dunlap485bb992006-06-23 02:03:49 -07002253/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002254 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002255 * @mapping: the address_space to search
2256 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002257 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002258 * @tag: the tag index
2259 * @nr_pages: the maximum number of pages
2260 * @pages: where the resulting pages are placed
2261 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002262 * Like find_get_pages(), except we only return head pages which are tagged
2263 * with @tag. @index is updated to the index immediately after the last
2264 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002265 *
2266 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 */
Jan Kara72b045a2017-11-15 17:34:33 -08002268unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002269 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002270 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002272 XA_STATE(xas, &mapping->i_pages, *index);
2273 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002274 unsigned ret = 0;
2275
2276 if (unlikely(!nr_pages))
2277 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278
Nick Piggina60637c2008-07-25 19:45:31 -07002279 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002280 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002281 /*
2282 * Shadow entries should never be tagged, but this iteration
2283 * is lockless so there is a window for page reclaim to evict
2284 * a page we saw tagged. Skip over it.
2285 */
2286 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002287 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002288
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002289 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002290 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002291 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002292 goto out;
2293 }
Nick Piggina60637c2008-07-25 19:45:31 -07002294 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002295
Jan Kara72b045a2017-11-15 17:34:33 -08002296 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002297 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002298 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002299 * iteration when there is a page at index -1 but that is already
2300 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002301 */
2302 if (end == (pgoff_t)-1)
2303 *index = (pgoff_t)-1;
2304 else
2305 *index = end + 1;
2306out:
Nick Piggina60637c2008-07-25 19:45:31 -07002307 rcu_read_unlock();
2308
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 return ret;
2310}
Jan Kara72b045a2017-11-15 17:34:33 -08002311EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002313/*
2314 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2315 * a _large_ part of the i/o request. Imagine the worst scenario:
2316 *
2317 * ---R__________________________________________B__________
2318 * ^ reading here ^ bad block(assume 4k)
2319 *
2320 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2321 * => failing the whole request => read(R) => read(R+1) =>
2322 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2323 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2324 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2325 *
2326 * It is going insane. Fix it by quickly scaling down the readahead size.
2327 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002328static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002329{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002330 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002331}
2332
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002333/*
2334 * filemap_get_read_batch - Get a batch of pages for read
2335 *
2336 * Get a batch of pages which represent a contiguous range of bytes
2337 * in the file. No tail pages will be returned. If @index is in the
2338 * middle of a THP, the entire THP will be returned. The last page in
2339 * the batch may have Readahead set or be not Uptodate so that the
2340 * caller can take the appropriate action.
2341 */
2342static void filemap_get_read_batch(struct address_space *mapping,
2343 pgoff_t index, pgoff_t max, struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002344{
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002345 XA_STATE(xas, &mapping->i_pages, index);
2346 struct page *head;
2347
2348 rcu_read_lock();
2349 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2350 if (xas_retry(&xas, head))
2351 continue;
2352 if (xas.xa_index > max || xa_is_value(head))
2353 break;
2354 if (!page_cache_get_speculative(head))
2355 goto retry;
2356
2357 /* Has the page moved or been split? */
2358 if (unlikely(head != xas_reload(&xas)))
2359 goto put_page;
2360
2361 if (!pagevec_add(pvec, head))
2362 break;
2363 if (!PageUptodate(head))
2364 break;
2365 if (PageReadahead(head))
2366 break;
Matthew Wilcox (Oracle)f89903a2022-02-23 15:59:18 +00002367 if (PageHead(head)) {
2368 xas_set(&xas, head->index + thp_nr_pages(head));
2369 /* Handle wrap correctly */
2370 if (xas.xa_index - 1 >= max)
2371 break;
2372 }
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002373 continue;
2374put_page:
2375 put_page(head);
2376retry:
2377 xas_reset(&xas);
2378 }
2379 rcu_read_unlock();
Kent Overstreet723ef242020-12-14 19:04:52 -08002380}
2381
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002382static int filemap_read_page(struct file *file, struct address_space *mapping,
2383 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002384{
Kent Overstreet723ef242020-12-14 19:04:52 -08002385 int error;
2386
Kent Overstreet723ef242020-12-14 19:04:52 -08002387 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002388 * A previous I/O error may have been due to temporary failures,
2389 * eg. multipath errors. PG_error will be set again if readpage
2390 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002391 */
2392 ClearPageError(page);
2393 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002394 error = mapping->a_ops->readpage(file, page);
2395 if (error)
2396 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002397
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002398 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002399 if (error)
2400 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002401 if (PageUptodate(page))
2402 return 0;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002403 shrink_readahead_size_eio(&file->f_ra);
2404 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002405}
2406
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002407static bool filemap_range_uptodate(struct address_space *mapping,
2408 loff_t pos, struct iov_iter *iter, struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002409{
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002410 int count;
2411
2412 if (PageUptodate(page))
2413 return true;
2414 /* pipes can't handle partially uptodate pages */
2415 if (iov_iter_is_pipe(iter))
2416 return false;
2417 if (!mapping->a_ops->is_partially_uptodate)
2418 return false;
2419 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2420 return false;
2421
2422 count = iter->count;
2423 if (page_offset(page) > pos) {
2424 count -= page_offset(page) - pos;
2425 pos = 0;
2426 } else {
2427 pos -= page_offset(page);
2428 }
2429
2430 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2431}
2432
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002433static int filemap_update_page(struct kiocb *iocb,
2434 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002435 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002436{
Kent Overstreet723ef242020-12-14 19:04:52 -08002437 int error;
2438
Jan Kara730633f2021-01-28 19:19:45 +01002439 if (iocb->ki_flags & IOCB_NOWAIT) {
2440 if (!filemap_invalidate_trylock_shared(mapping))
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002441 return -EAGAIN;
Jan Kara730633f2021-01-28 19:19:45 +01002442 } else {
2443 filemap_invalidate_lock_shared(mapping);
2444 }
2445
2446 if (!trylock_page(page)) {
2447 error = -EAGAIN;
2448 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2449 goto unlock_mapping;
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002450 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Jan Kara730633f2021-01-28 19:19:45 +01002451 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002452 put_and_wait_on_page_locked(page, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002453 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002454 }
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002455 error = __lock_page_async(page, iocb->ki_waitq);
2456 if (error)
Jan Kara730633f2021-01-28 19:19:45 +01002457 goto unlock_mapping;
Kent Overstreet723ef242020-12-14 19:04:52 -08002458 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002459
Jan Kara730633f2021-01-28 19:19:45 +01002460 error = AOP_TRUNCATED_PAGE;
Kent Overstreet723ef242020-12-14 19:04:52 -08002461 if (!page->mapping)
Jan Kara730633f2021-01-28 19:19:45 +01002462 goto unlock;
Kent Overstreet723ef242020-12-14 19:04:52 -08002463
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002464 error = 0;
2465 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, page))
2466 goto unlock;
2467
2468 error = -EAGAIN;
2469 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2470 goto unlock;
2471
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002472 error = filemap_read_page(iocb->ki_filp, mapping, page);
Jan Kara730633f2021-01-28 19:19:45 +01002473 goto unlock_mapping;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002474unlock:
2475 unlock_page(page);
Jan Kara730633f2021-01-28 19:19:45 +01002476unlock_mapping:
2477 filemap_invalidate_unlock_shared(mapping);
2478 if (error == AOP_TRUNCATED_PAGE)
2479 put_page(page);
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002480 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002481}
2482
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002483static int filemap_create_page(struct file *file,
2484 struct address_space *mapping, pgoff_t index,
2485 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002486{
Kent Overstreet723ef242020-12-14 19:04:52 -08002487 struct page *page;
2488 int error;
2489
Kent Overstreet723ef242020-12-14 19:04:52 -08002490 page = page_cache_alloc(mapping);
2491 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002492 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002493
Jan Kara730633f2021-01-28 19:19:45 +01002494 /*
2495 * Protect against truncate / hole punch. Grabbing invalidate_lock here
2496 * assures we cannot instantiate and bring uptodate new pagecache pages
2497 * after evicting page cache during truncate and before actually
2498 * freeing blocks. Note that we could release invalidate_lock after
2499 * inserting the page into page cache as the locked page would then be
2500 * enough to synchronize with hole punching. But there are code paths
2501 * such as filemap_update_page() filling in partially uptodate pages or
2502 * ->readpages() that need to hold invalidate_lock while mapping blocks
2503 * for IO so let's hold the lock here as well to keep locking rules
2504 * simple.
2505 */
2506 filemap_invalidate_lock_shared(mapping);
Kent Overstreet723ef242020-12-14 19:04:52 -08002507 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002508 mapping_gfp_constraint(mapping, GFP_KERNEL));
2509 if (error == -EEXIST)
2510 error = AOP_TRUNCATED_PAGE;
2511 if (error)
2512 goto error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002513
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002514 error = filemap_read_page(file, mapping, page);
2515 if (error)
2516 goto error;
2517
Jan Kara730633f2021-01-28 19:19:45 +01002518 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002519 pagevec_add(pvec, page);
2520 return 0;
2521error:
Jan Kara730633f2021-01-28 19:19:45 +01002522 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002523 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002524 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002525}
2526
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002527static int filemap_readahead(struct kiocb *iocb, struct file *file,
2528 struct address_space *mapping, struct page *page,
2529 pgoff_t last_index)
2530{
2531 if (iocb->ki_flags & IOCB_NOIO)
2532 return -EAGAIN;
2533 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2534 page->index, last_index - page->index);
2535 return 0;
2536}
2537
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002538static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002539 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002540{
2541 struct file *filp = iocb->ki_filp;
2542 struct address_space *mapping = filp->f_mapping;
2543 struct file_ra_state *ra = &filp->f_ra;
2544 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002545 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002546 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002547 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002548
Qian Yingjin43dd56f2023-02-08 10:24:00 +08002549 /* "last_index" is the index of the page beyond the end of the read */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002550 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002551retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002552 if (fatal_signal_pending(current))
2553 return -EINTR;
2554
Qian Yingjin43dd56f2023-02-08 10:24:00 +08002555 filemap_get_read_batch(mapping, index, last_index - 1, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002556 if (!pagevec_count(pvec)) {
2557 if (iocb->ki_flags & IOCB_NOIO)
2558 return -EAGAIN;
2559 page_cache_sync_readahead(mapping, ra, filp, index,
2560 last_index - index);
Qian Yingjin43dd56f2023-02-08 10:24:00 +08002561 filemap_get_read_batch(mapping, index, last_index - 1, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002562 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002563 if (!pagevec_count(pvec)) {
2564 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2565 return -EAGAIN;
2566 err = filemap_create_page(filp, mapping,
2567 iocb->ki_pos >> PAGE_SHIFT, pvec);
2568 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002569 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002570 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002571 }
2572
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002573 page = pvec->pages[pagevec_count(pvec) - 1];
2574 if (PageReadahead(page)) {
2575 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2576 if (err)
2577 goto err;
2578 }
2579 if (!PageUptodate(page)) {
2580 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2581 iocb->ki_flags |= IOCB_NOWAIT;
2582 err = filemap_update_page(iocb, mapping, iter, page);
2583 if (err)
2584 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002585 }
2586
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002587 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002588err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002589 if (err < 0)
2590 put_page(page);
2591 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002592 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002593 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002594 goto retry;
2595 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002596}
2597
Randy Dunlap485bb992006-06-23 02:03:49 -07002598/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002599 * filemap_read - Read data from the page cache.
2600 * @iocb: The iocb to read.
2601 * @iter: Destination for the data.
2602 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002603 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002604 * Copies data from the page cache. If the data is not currently present,
2605 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002607 * Return: Total number of bytes copied, including those already read by
2608 * the caller. If an error happens before any bytes are copied, returns
2609 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002611ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2612 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002614 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002615 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002616 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002618 struct pagevec pvec;
2619 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002620 bool writably_mapped;
2621 loff_t isize, end_offset;
Haibo Li5fae5402023-06-28 19:02:20 +08002622 loff_t last_pos = ra->prev_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623
Kent Overstreet723ef242020-12-14 19:04:52 -08002624 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002625 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002626 if (unlikely(!iov_iter_count(iter)))
2627 return 0;
2628
Wei Fangc2a97372016-10-07 17:01:52 -07002629 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002630 pagevec_init(&pvec);
Jens Axboe13bd6912020-10-17 08:31:29 -06002631
Kent Overstreet06c04442020-12-14 19:04:56 -08002632 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633 cond_resched();
Michal Hocko5abf1862017-02-03 13:13:29 -08002634
NeilBrowna32ea1e2007-07-17 04:03:04 -07002635 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002636 * If we've already successfully copied some data, then we
2637 * can no longer safely return -EIOCBQUEUED. Hence mark
2638 * an async read NOWAIT at that point.
2639 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002640 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002641 iocb->ki_flags |= IOCB_NOWAIT;
2642
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002643 error = filemap_get_pages(iocb, iter, &pvec);
2644 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002645 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646
Kent Overstreet723ef242020-12-14 19:04:52 -08002647 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002648 * i_size must be checked after we know the pages are Uptodate.
NeilBrowna32ea1e2007-07-17 04:03:04 -07002649 *
2650 * Checking i_size after the check allows us to calculate
2651 * the correct value for "nr", which means the zero-filled
2652 * part of the page is not copied back to userspace (unless
2653 * another truncate extends the file - this is desired though).
2654 */
NeilBrowna32ea1e2007-07-17 04:03:04 -07002655 isize = i_size_read(inode);
Kent Overstreet06c04442020-12-14 19:04:56 -08002656 if (unlikely(iocb->ki_pos >= isize))
2657 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002658 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 /*
Baokun Lic0be5212023-12-13 14:23:24 +08002661 * Pairs with a barrier in
2662 * block_write_end()->mark_buffer_dirty() or other page
2663 * dirtying routines like iomap_write_end() to ensure
2664 * changes to page contents are visible before we see
2665 * increased inode size.
2666 */
2667 smp_rmb();
2668
2669 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002670 * Once we start copying data, we don't want to be touching any
2671 * cachelines that might be contended:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002673 writably_mapped = mapping_writably_mapped(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674
2675 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002676 * When a sequential read accesses a page several times, only
2677 * mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002678 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002679 if (iocb->ki_pos >> PAGE_SHIFT !=
Haibo Li5fae5402023-06-28 19:02:20 +08002680 last_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002681 mark_page_accessed(pvec.pages[0]);
Al Viro6e58e792014-02-03 17:07:03 -05002682
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002683 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002684 struct page *page = pvec.pages[i];
2685 size_t page_size = thp_size(page);
2686 size_t offset = iocb->ki_pos & (page_size - 1);
2687 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2688 page_size - offset);
2689 size_t copied;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002690
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002691 if (end_offset < page_offset(page))
2692 break;
2693 if (i > 0)
2694 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002695 /*
2696 * If users can be writing to this page using arbitrary
2697 * virtual addresses, take care about potential aliasing
2698 * before reading the page on the kernel side.
2699 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002700 if (writably_mapped) {
2701 int j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002702
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002703 for (j = 0; j < thp_nr_pages(page); j++)
2704 flush_dcache_page(page + j);
2705 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002706
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002707 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002708
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002709 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002710 iocb->ki_pos += copied;
Haibo Li5fae5402023-06-28 19:02:20 +08002711 last_pos = iocb->ki_pos;
Kent Overstreet06c04442020-12-14 19:04:56 -08002712
2713 if (copied < bytes) {
2714 error = -EFAULT;
2715 break;
Jens Axboe0abed7c2020-11-16 13:36:24 -07002716 }
Jens Axboe0abed7c2020-11-16 13:36:24 -07002717 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002718put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002719 for (i = 0; i < pagevec_count(&pvec); i++)
2720 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002721 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002722 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002724 file_accessed(filp);
Haibo Li5fae5402023-06-28 19:02:20 +08002725 ra->prev_pos = last_pos;
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002726 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002728EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729
Randy Dunlap485bb992006-06-23 02:03:49 -07002730/**
Al Viro6abd2322014-04-04 14:20:57 -04002731 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002732 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002733 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002734 *
Al Viro6abd2322014-04-04 14:20:57 -04002735 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002736 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002737 *
2738 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2739 * be returned when no data can be read without waiting for I/O requests
2740 * to complete; it doesn't prevent readahead.
2741 *
2742 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2743 * requests shall be made for the read or for readahead. When no data
2744 * can be read, -EAGAIN shall be returned. When readahead would be
2745 * triggered, a partial, possibly empty read shall be returned.
2746 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002747 * Return:
2748 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002749 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002750 */
2751ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002752generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002754 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002755 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002756
2757 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002758 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759
Al Viro2ba48ce2015-04-09 13:52:01 -04002760 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002761 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002762 struct address_space *mapping = file->f_mapping;
2763 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002764 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002765
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002767 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002768 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2769 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002770 return -EAGAIN;
2771 } else {
2772 retval = filemap_write_and_wait_range(mapping,
2773 iocb->ki_pos,
2774 iocb->ki_pos + count - 1);
2775 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002776 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002777 }
Al Viroed978a82014-03-05 22:53:04 -05002778
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002779 file_accessed(file);
2780
Al Viro5ecda132017-04-13 14:13:36 -04002781 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002782 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002783 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002784 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002785 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002786 if (retval != -EIOCBQUEUED)
2787 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002788
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002789 /*
2790 * Btrfs can have a short DIO read if we encounter
2791 * compressed extents, so if there was an error, or if
2792 * we've already read everything we wanted to, or if
2793 * there was a short read because we hit EOF, go ahead
2794 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002795 * the rest of the read. Buffered reads will not work for
2796 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002797 */
Al Viro5ecda132017-04-13 14:13:36 -04002798 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002799 IS_DAX(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002800 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801 }
2802
Christoph Hellwig826ea862021-02-24 12:02:45 -08002803 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804}
Al Viroed978a82014-03-05 22:53:04 -05002805EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002807static inline loff_t page_seek_hole_data(struct xa_state *xas,
2808 struct address_space *mapping, struct page *page,
2809 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002810{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002811 const struct address_space_operations *ops = mapping->a_ops;
2812 size_t offset, bsz = i_blocksize(mapping->host);
2813
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002814 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002815 return seek_data ? start : end;
2816 if (!ops->is_partially_uptodate)
2817 return seek_data ? end : start;
2818
2819 xas_pause(xas);
2820 rcu_read_unlock();
2821 lock_page(page);
2822 if (unlikely(page->mapping != mapping))
2823 goto unlock;
2824
2825 offset = offset_in_thp(page, start) & ~(bsz - 1);
2826
2827 do {
2828 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2829 break;
2830 start = (start + bsz) & ~(bsz - 1);
2831 offset += bsz;
2832 } while (offset < thp_size(page));
2833unlock:
2834 unlock_page(page);
2835 rcu_read_lock();
2836 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002837}
2838
2839static inline
2840unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2841{
2842 if (xa_is_value(page))
2843 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2844 return thp_size(page);
2845}
2846
2847/**
2848 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2849 * @mapping: Address space to search.
2850 * @start: First byte to consider.
2851 * @end: Limit of search (exclusive).
2852 * @whence: Either SEEK_HOLE or SEEK_DATA.
2853 *
2854 * If the page cache knows which blocks contain holes and which blocks
2855 * contain data, your filesystem can use this function to implement
2856 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2857 * entirely memory-based such as tmpfs, and filesystems which support
2858 * unwritten extents.
2859 *
Ingo Molnarf0953a12021-05-06 18:06:47 -07002860 * Return: The requested offset on success, or -ENXIO if @whence specifies
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002861 * SEEK_DATA and there is no data after @start. There is an implicit hole
2862 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2863 * and @end contain data.
2864 */
2865loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2866 loff_t end, int whence)
2867{
2868 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002869 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002870 bool seek_data = (whence == SEEK_DATA);
2871 struct page *page;
2872
2873 if (end <= start)
2874 return -ENXIO;
2875
2876 rcu_read_lock();
2877 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002878 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2879 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002880
2881 if (start < pos) {
2882 if (!seek_data)
2883 goto unlock;
2884 start = pos;
2885 }
2886
Hugh Dickinsed98b012021-04-23 14:29:00 -07002887 seek_size = seek_page_size(&xas, page);
2888 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002889 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2890 seek_data);
2891 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002892 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002893 if (start >= end)
2894 break;
2895 if (seek_size > PAGE_SIZE)
2896 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002897 if (!xa_is_value(page))
2898 put_page(page);
2899 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002900 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002901 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002902unlock:
2903 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002904 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002905 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002906 if (start > end)
2907 return end;
2908 return start;
2909}
2910
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002913/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002914 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002915 * @vmf - the vm_fault for this fault.
2916 * @page - the page to lock.
2917 * @fpin - the pointer to the file we may pin (or is already pinned).
2918 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002919 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002920 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002921 * 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 -07002922 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002923 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002924static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2925 struct file **fpin)
2926{
2927 if (trylock_page(page))
2928 return 1;
2929
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002930 /*
2931 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002932 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002933 * is supposed to work. We have way too many special cases..
2934 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002935 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2936 return 0;
2937
2938 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2939 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2940 if (__lock_page_killable(page)) {
2941 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002942 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002943 * but all fault_handlers only check for fatal signals
2944 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002945 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002946 */
2947 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002948 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002949 return 0;
2950 }
2951 } else
2952 __lock_page(page);
2953 return 1;
2954}
2955
2956
2957/*
2958 * Synchronous readahead happens when we don't even find a page in the page
2959 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2960 * to drop the mmap sem we return the file that was pinned in order for us to do
2961 * that. If we didn't pin a file then we return NULL. The file that is
2962 * returned needs to be fput()'ed when we're done with it.
2963 */
2964static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002965{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002966 struct file *file = vmf->vma->vm_file;
2967 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002968 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002969 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002970 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002971 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002972
2973 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002974 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002975 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002976 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002977 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002978
Josef Bacik2a1180f2019-03-13 11:44:18 -07002979 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002980 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002981 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002982 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002983 }
2984
Andi Kleen207d04b2011-05-24 17:12:29 -07002985 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002986 mmap_miss = READ_ONCE(ra->mmap_miss);
2987 if (mmap_miss < MMAP_LOTSAMISS * 10)
2988 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002989
2990 /*
2991 * Do we miss much more than hit in this file? If so,
2992 * stop bothering with read-ahead. It will only hurt.
2993 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002994 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002995 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002996
Wu Fengguangd30a1102009-06-16 15:31:30 -07002997 /*
2998 * mmap read-around
2999 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003000 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07003001 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08003002 ra->size = ra->ra_pages;
3003 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07003004 ractl._index = ra->start;
3005 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003006 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003007}
3008
3009/*
3010 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003011 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003012 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07003013 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003014static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
3015 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07003016{
Josef Bacik2a1180f2019-03-13 11:44:18 -07003017 struct file *file = vmf->vma->vm_file;
3018 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003019 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003020 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003021 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07003022 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003023
3024 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07003025 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003026 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003027 mmap_miss = READ_ONCE(ra->mmap_miss);
3028 if (mmap_miss)
3029 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003030 if (PageReadahead(page)) {
3031 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07003032 page_cache_async_readahead(mapping, ra, file,
3033 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003034 }
3035 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003036}
3037
Randy Dunlap485bb992006-06-23 02:03:49 -07003038/**
Nick Piggin54cb8822007-07-19 01:46:59 -07003039 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07003040 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07003041 *
Nick Piggin54cb8822007-07-19 01:46:59 -07003042 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043 * mapped memory region to read in file data during a page fault.
3044 *
3045 * The goto's are kind of ugly, but this streamlines the normal case of having
3046 * it in the page cache, and handles the special cases reasonably without
3047 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003048 *
Michel Lespinassecd333a02021-04-29 10:28:25 -07003049 * If FAULT_FLAG_SPECULATIVE is set, this function runs within an rcu
3050 * read locked section and with mmap lock not held.
3051 * Otherwise, vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003052 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003053 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07003054 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003055 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003056 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003057 * has not been released.
3058 *
3059 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08003060 *
3061 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003062 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003063vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064{
3065 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08003066 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003067 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003068 struct address_space *mapping = file->f_mapping;
Michel Lespinassecd333a02021-04-29 10:28:25 -07003069 struct file_ra_state *ra = &file->f_ra;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003071 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003072 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003073 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003074 vm_fault_t ret = 0;
Jan Kara730633f2021-01-28 19:19:45 +01003075 bool mapping_locked = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003076
Michel Lespinassecd333a02021-04-29 10:28:25 -07003077 if (vmf->flags & FAULT_FLAG_SPECULATIVE) {
3078 page = find_get_page(mapping, offset);
Patrick Dalya467d8a2022-10-10 19:25:27 -07003079 if (unlikely(!page))
Michel Lespinassecd333a02021-04-29 10:28:25 -07003080 return VM_FAULT_RETRY;
3081
Patrick Dalya467d8a2022-10-10 19:25:27 -07003082 if (unlikely(PageReadahead(page)))
3083 goto page_put;
3084
Michel Lespinassecd333a02021-04-29 10:28:25 -07003085 if (!trylock_page(page))
Patrick Dalya467d8a2022-10-10 19:25:27 -07003086 goto page_put;
Michel Lespinassecd333a02021-04-29 10:28:25 -07003087
3088 if (unlikely(compound_head(page)->mapping != mapping))
3089 goto page_unlock;
3090 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
3091 if (unlikely(!PageUptodate(page)))
3092 goto page_unlock;
3093
3094 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3095 if (unlikely(offset >= max_off))
3096 goto page_unlock;
3097
3098 /*
3099 * Update readahead mmap_miss statistic.
3100 *
3101 * Note that we are not sure if finish_fault() will
3102 * manage to complete the transaction. If it fails,
3103 * we'll come back to filemap_fault() non-speculative
3104 * case which will update mmap_miss a second time.
3105 * This is not ideal, we would prefer to guarantee the
3106 * update will happen exactly once.
3107 */
3108 if (!(vmf->vma->vm_flags & VM_RAND_READ) && ra->ra_pages) {
3109 unsigned int mmap_miss = READ_ONCE(ra->mmap_miss);
3110 if (mmap_miss)
3111 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
3112 }
3113
3114 vmf->page = page;
3115 return VM_FAULT_LOCKED;
3116page_unlock:
3117 unlock_page(page);
Patrick Dalya467d8a2022-10-10 19:25:27 -07003118page_put:
3119 put_page(page);
Michel Lespinassecd333a02021-04-29 10:28:25 -07003120 return VM_FAULT_RETRY;
3121 }
3122
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003123 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3124 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07003125 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003126
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127 /*
Johannes Weiner49426422013-10-16 13:46:59 -07003128 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07003129 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003130 page = find_get_page(mapping, offset);
Jan Kara730633f2021-01-28 19:19:45 +01003131 if (likely(page)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003132 /*
Jan Kara730633f2021-01-28 19:19:45 +01003133 * We found the page, so try async readahead before waiting for
3134 * the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003135 */
Jan Kara730633f2021-01-28 19:19:45 +01003136 if (!(vmf->flags & FAULT_FLAG_TRIED))
3137 fpin = do_async_mmap_readahead(vmf, page);
3138 if (unlikely(!PageUptodate(page))) {
3139 filemap_invalidate_lock_shared(mapping);
3140 mapping_locked = true;
3141 }
3142 } else {
Linus Torvaldsef00e082009-06-16 15:31:25 -07003143 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003144 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07003145 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003146 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003147 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003148retry_find:
Jan Kara730633f2021-01-28 19:19:45 +01003149 /*
3150 * See comment in filemap_create_page() why we need
3151 * invalidate_lock
3152 */
3153 if (!mapping_locked) {
3154 filemap_invalidate_lock_shared(mapping);
3155 mapping_locked = true;
3156 }
Josef Bacika75d4c32019-03-13 11:44:14 -07003157 page = pagecache_get_page(mapping, offset,
3158 FGP_CREAT|FGP_FOR_MMAP,
3159 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003160 if (!page) {
3161 if (fpin)
3162 goto out_retry;
Jan Kara730633f2021-01-28 19:19:45 +01003163 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07003164 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003165 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166 }
3167
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003168 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3169 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003170
3171 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003172 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003173 unlock_page(page);
3174 put_page(page);
3175 goto retry_find;
3176 }
Song Liu520e5ba2019-09-23 15:37:50 -07003177 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003178
Linus Torvalds1da177e2005-04-16 15:20:36 -07003179 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003180 * We have a locked page in the page cache, now we need to check
3181 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003182 */
Jan Kara730633f2021-01-28 19:19:45 +01003183 if (unlikely(!PageUptodate(page))) {
3184 /*
3185 * The page was in cache and uptodate and now it is not.
3186 * Strange but possible since we didn't hold the page lock all
3187 * the time. Let's drop everything get the invalidate lock and
3188 * try again.
3189 */
3190 if (!mapping_locked) {
3191 unlock_page(page);
3192 put_page(page);
3193 goto retry_find;
3194 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003195 goto page_not_uptodate;
Jan Kara730633f2021-01-28 19:19:45 +01003196 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003197
Linus Torvaldsef00e082009-06-16 15:31:25 -07003198 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003199 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003200 * time to return to the upper layer and have it re-find the vma and
3201 * redo the fault.
3202 */
3203 if (fpin) {
3204 unlock_page(page);
3205 goto out_retry;
3206 }
Jan Kara730633f2021-01-28 19:19:45 +01003207 if (mapping_locked)
3208 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003209
3210 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003211 * Found the page and have a reference on it.
3212 * We must recheck i_size under page lock.
3213 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003214 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3215 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003216 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003217 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003218 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003219 }
3220
Nick Piggind0217ac2007-07-19 01:47:03 -07003221 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003222 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003223
Linus Torvalds1da177e2005-04-16 15:20:36 -07003224page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225 /*
3226 * Umm, take care of errors if the page isn't up-to-date.
3227 * Try to re-read it _once_. We do this synchronously,
3228 * because there really aren't any performance issues here
3229 * and we need to check for errors.
3230 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003231 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)d31fa862021-04-29 22:55:26 -07003232 error = filemap_read_page(file, mapping, page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003233 if (fpin)
3234 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003235 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003236
3237 if (!error || error == AOP_TRUNCATED_PAGE)
3238 goto retry_find;
Jan Kara730633f2021-01-28 19:19:45 +01003239 filemap_invalidate_unlock_shared(mapping);
Nick Piggind00806b2007-07-19 01:46:57 -07003240
Nick Piggind0217ac2007-07-19 01:47:03 -07003241 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003242
3243out_retry:
3244 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003245 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003246 * re-find the vma and come back and find our hopefully still populated
3247 * page.
3248 */
3249 if (page)
3250 put_page(page);
Jan Kara730633f2021-01-28 19:19:45 +01003251 if (mapping_locked)
3252 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003253 if (fpin)
3254 fput(fpin);
3255 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003256}
3257EXPORT_SYMBOL(filemap_fault);
3258
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003259static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003260{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003261 struct mm_struct *mm = vmf->vma->vm_mm;
3262
3263 /* Huge page is mapped? No need to proceed. */
3264 if (pmd_trans_huge(*vmf->pmd)) {
3265 unlock_page(page);
3266 put_page(page);
3267 return true;
3268 }
3269
3270 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
3271 vm_fault_t ret = do_set_pmd(vmf, page);
3272 if (!ret) {
3273 /* The page is mapped successfully, reference consumed. */
3274 unlock_page(page);
3275 return true;
3276 }
3277 }
3278
Hugh Dickinsc5a09d12023-11-17 00:49:18 -08003279 if (pmd_none(*vmf->pmd) && vmf->prealloc_pte) {
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003280 vmf->ptl = pmd_lock(mm, vmf->pmd);
3281 if (likely(pmd_none(*vmf->pmd))) {
3282 mm_inc_nr_ptes(mm);
3283 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
3284 vmf->prealloc_pte = NULL;
3285 }
3286 spin_unlock(vmf->ptl);
3287 }
3288
3289 /* See comment in handle_pte_fault() */
3290 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3291 unlock_page(page);
3292 put_page(page);
3293 return true;
3294 }
3295
3296 return false;
3297}
3298
3299static struct page *next_uptodate_page(struct page *page,
3300 struct address_space *mapping,
3301 struct xa_state *xas, pgoff_t end_pgoff)
3302{
3303 unsigned long max_idx;
3304
3305 do {
3306 if (!page)
3307 return NULL;
3308 if (xas_retry(xas, page))
3309 continue;
3310 if (xa_is_value(page))
3311 continue;
3312 if (PageLocked(page))
3313 continue;
3314 if (!page_cache_get_speculative(page))
3315 continue;
3316 /* Has the page moved or been split? */
3317 if (unlikely(page != xas_reload(xas)))
3318 goto skip;
3319 if (!PageUptodate(page) || PageReadahead(page))
3320 goto skip;
3321 if (PageHWPoison(page))
3322 goto skip;
3323 if (!trylock_page(page))
3324 goto skip;
3325 if (page->mapping != mapping)
3326 goto unlock;
3327 if (!PageUptodate(page))
3328 goto unlock;
3329 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3330 if (xas->xa_index >= max_idx)
3331 goto unlock;
3332 return page;
3333unlock:
3334 unlock_page(page);
3335skip:
3336 put_page(page);
3337 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3338
3339 return NULL;
3340}
3341
3342static inline struct page *first_map_page(struct address_space *mapping,
3343 struct xa_state *xas,
3344 pgoff_t end_pgoff)
3345{
3346 return next_uptodate_page(xas_find(xas, end_pgoff),
3347 mapping, xas, end_pgoff);
3348}
3349
3350static inline struct page *next_map_page(struct address_space *mapping,
3351 struct xa_state *xas,
3352 pgoff_t end_pgoff)
3353{
3354 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3355 mapping, xas, end_pgoff);
3356}
3357
3358vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3359 pgoff_t start_pgoff, pgoff_t end_pgoff)
3360{
3361 struct vm_area_struct *vma = vmf->vma;
3362 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003363 struct address_space *mapping = file->f_mapping;
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003364 pgoff_t last_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003365 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003366 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003367 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003368 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003369 vm_fault_t ret = (vmf->flags & FAULT_FLAG_SPECULATIVE) ?
3370 VM_FAULT_RETRY : 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003371
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003372 /* filemap_map_pages() is called within an rcu read lock already. */
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003373 head = first_map_page(mapping, &xas, end_pgoff);
3374 if (!head)
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003375 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003376
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003377 if (!(vmf->flags & FAULT_FLAG_SPECULATIVE) &&
3378 filemap_map_pmd(vmf, head))
3379 return VM_FAULT_NOPAGE;
3380
3381 if (!pte_map_lock(vmf)) {
3382 unlock_page(head);
3383 put_page(head);
3384 return VM_FAULT_RETRY;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003385 }
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003386 addr = vmf->address;
3387 last_pgoff = vmf->pgoff;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003388
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003389 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003390 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003391 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003392 goto unlock;
3393
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003394 if (mmap_miss > 0)
3395 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003396
Will Deacon9d3af4b2021-01-14 15:24:19 +00003397 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003398 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003399 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003400
3401 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003402 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003403
Will Deacon46bdb422020-11-24 18:48:26 +00003404 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003405 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003406 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003407
Will Deacon9d3af4b2021-01-14 15:24:19 +00003408 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003409 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003410 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003411 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003412 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003413unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003414 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003415 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003416 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3417 pte_unmap_unlock(vmf->pte, vmf->ptl);
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003418 vmf->pte = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003419 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003420 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003421}
3422EXPORT_SYMBOL(filemap_map_pages);
3423
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003424vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003425{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003426 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003427 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003428 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003429
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003430 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003431 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003432 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003433 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003434 unlock_page(page);
3435 ret = VM_FAULT_NOPAGE;
3436 goto out;
3437 }
Jan Kara14da9202012-06-12 16:20:37 +02003438 /*
3439 * We mark the page dirty already here so that when freeze is in
3440 * progress, we are guaranteed that writeback during freezing will
3441 * see the dirty page and writeprotect it again.
3442 */
3443 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003444 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003445out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003446 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003447 return ret;
3448}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003449
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003450const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003451 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003452 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003453 .page_mkwrite = filemap_page_mkwrite,
Michel Lespinassea2138fe2021-04-29 10:28:25 -07003454 .speculative = true,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003455};
3456
3457/* This is used for a general mmap of a disk file */
3458
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003459int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460{
3461 struct address_space *mapping = file->f_mapping;
3462
3463 if (!mapping->a_ops->readpage)
3464 return -ENOEXEC;
3465 file_accessed(file);
3466 vma->vm_ops = &generic_file_vm_ops;
3467 return 0;
3468}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003469
3470/*
3471 * This is for filesystems which do not implement ->writepage.
3472 */
3473int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3474{
3475 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3476 return -EINVAL;
3477 return generic_file_mmap(file, vma);
3478}
3479#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003480vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003481{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003482 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003483}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003484int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485{
3486 return -ENOSYS;
3487}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003488int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489{
3490 return -ENOSYS;
3491}
3492#endif /* CONFIG_MMU */
3493
Arnd Bergmann453972282018-04-13 15:35:27 -07003494EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003495EXPORT_SYMBOL(generic_file_mmap);
3496EXPORT_SYMBOL(generic_file_readonly_mmap);
3497
Sasha Levin67f9fd92014-04-03 14:48:18 -07003498static struct page *wait_on_page_read(struct page *page)
3499{
3500 if (!IS_ERR(page)) {
3501 wait_on_page_locked(page);
3502 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003503 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003504 page = ERR_PTR(-EIO);
3505 }
3506 }
3507 return page;
3508}
3509
Mel Gorman32b63522016-03-15 14:55:36 -07003510static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003511 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003512 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003513 void *data,
3514 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003515{
Nick Piggineb2be182007-10-16 01:24:57 -07003516 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003517 int err;
3518repeat:
3519 page = find_get_page(mapping, index);
3520 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003521 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003522 if (!page)
3523 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003524 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003525 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003526 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003527 if (err == -EEXIST)
3528 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003529 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530 return ERR_PTR(err);
3531 }
Mel Gorman32b63522016-03-15 14:55:36 -07003532
3533filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003534 if (filler)
3535 err = filler(data, page);
3536 else
3537 err = mapping->a_ops->readpage(data, page);
3538
Linus Torvalds1da177e2005-04-16 15:20:36 -07003539 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003540 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003541 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003542 }
Mel Gorman32b63522016-03-15 14:55:36 -07003543
3544 page = wait_on_page_read(page);
3545 if (IS_ERR(page))
3546 return page;
3547 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003548 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003549 if (PageUptodate(page))
3550 goto out;
3551
Mel Gormanebded022016-03-15 14:55:39 -07003552 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003553 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003554 * case a: Page is being filled and the page lock is held
3555 * case b: Read/write error clearing the page uptodate status
3556 * case c: Truncation in progress (page locked)
3557 * case d: Reclaim in progress
3558 *
3559 * Case a, the page will be up to date when the page is unlocked.
3560 * There is no need to serialise on the page lock here as the page
3561 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003562 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003563 * it's a race vs truncate race.
3564 * Case b, the page will not be up to date
3565 * Case c, the page may be truncated but in itself, the data may still
3566 * be valid after IO completes as it's a read vs truncate race. The
3567 * operation must restart if the page is not uptodate on unlock but
3568 * otherwise serialising on page lock to stabilise the mapping gives
3569 * no additional guarantees to the caller as the page lock is
3570 * released before return.
3571 * Case d, similar to truncation. If reclaim holds the page lock, it
3572 * will be a race with remove_mapping that determines if the mapping
3573 * is valid on unlock but otherwise the data is valid and there is
3574 * no need to serialise with page lock.
3575 *
3576 * As the page lock gives no additional guarantee, we optimistically
3577 * wait on the page to be unlocked and check if it's up to date and
3578 * use the page if it is. Otherwise, the page lock is required to
3579 * distinguish between the different cases. The motivation is that we
3580 * avoid spurious serialisations and wakeups when multiple processes
3581 * wait on the same page for IO to complete.
3582 */
3583 wait_on_page_locked(page);
3584 if (PageUptodate(page))
3585 goto out;
3586
3587 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003588 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003589
3590 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003591 if (!page->mapping) {
3592 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003593 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003594 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003595 }
Mel Gormanebded022016-03-15 14:55:39 -07003596
3597 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003598 if (PageUptodate(page)) {
3599 unlock_page(page);
3600 goto out;
3601 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003602
3603 /*
3604 * A previous I/O error may have been due to temporary
3605 * failures.
3606 * Clear page error before actual read, PG_error will be
3607 * set again if read page fails.
3608 */
3609 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003610 goto filler;
3611
David Howellsc855ff32007-05-09 13:42:20 +01003612out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003613 mark_page_accessed(page);
3614 return page;
3615}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003616
3617/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003618 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003619 * @mapping: the page's address_space
3620 * @index: the page index
3621 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003622 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003623 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003624 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003625 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003626 *
3627 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003628 *
Jan Kara730633f2021-01-28 19:19:45 +01003629 * The function expects mapping->invalidate_lock to be already held.
3630 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003631 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003632 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003633struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003634 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003635 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003636 void *data)
3637{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003638 return do_read_cache_page(mapping, index, filler, data,
3639 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003640}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003641EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003642
3643/**
3644 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3645 * @mapping: the page's address_space
3646 * @index: the page index
3647 * @gfp: the page allocator flags to use if allocating
3648 *
3649 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003650 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003651 *
3652 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003653 *
Jan Kara730633f2021-01-28 19:19:45 +01003654 * The function expects mapping->invalidate_lock to be already held.
3655 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003656 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003657 */
3658struct page *read_cache_page_gfp(struct address_space *mapping,
3659 pgoff_t index,
3660 gfp_t gfp)
3661{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003662 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003663}
3664EXPORT_SYMBOL(read_cache_page_gfp);
3665
Nick Pigginafddba42007-10-16 01:25:01 -07003666int pagecache_write_begin(struct file *file, struct address_space *mapping,
3667 loff_t pos, unsigned len, unsigned flags,
3668 struct page **pagep, void **fsdata)
3669{
3670 const struct address_space_operations *aops = mapping->a_ops;
3671
Nick Piggin4e02ed42008-10-29 14:00:55 -07003672 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003673 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003674}
3675EXPORT_SYMBOL(pagecache_write_begin);
3676
3677int pagecache_write_end(struct file *file, struct address_space *mapping,
3678 loff_t pos, unsigned len, unsigned copied,
3679 struct page *page, void *fsdata)
3680{
3681 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003682
Nick Piggin4e02ed42008-10-29 14:00:55 -07003683 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003684}
3685EXPORT_SYMBOL(pagecache_write_end);
3686
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003687/*
3688 * Warn about a page cache invalidation failure during a direct I/O write.
3689 */
3690void dio_warn_stale_pagecache(struct file *filp)
3691{
3692 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3693 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003694 char *path;
3695
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003696 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003697 if (__ratelimit(&_rs)) {
3698 path = file_path(filp, pathname, sizeof(pathname));
3699 if (IS_ERR(path))
3700 path = "(unknown)";
3701 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3702 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3703 current->comm);
3704 }
3705}
3706
Linus Torvalds1da177e2005-04-16 15:20:36 -07003707ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003708generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003709{
3710 struct file *file = iocb->ki_filp;
3711 struct address_space *mapping = file->f_mapping;
3712 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003713 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003714 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003715 size_t write_len;
3716 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003717
Al Viro0c949332014-03-22 06:51:37 -04003718 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003719 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003720
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003721 if (iocb->ki_flags & IOCB_NOWAIT) {
3722 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003723 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003724 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003725 return -EAGAIN;
3726 } else {
3727 written = filemap_write_and_wait_range(mapping, pos,
3728 pos + write_len - 1);
3729 if (written)
3730 goto out;
3731 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003732
3733 /*
3734 * After a write we want buffered reads to be sure to go to disk to get
3735 * the new data. We invalidate clean cached page from the region we're
3736 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003737 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003738 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003739 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003740 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003741 /*
3742 * If a page can not be invalidated, return 0 to fall back
3743 * to buffered write.
3744 */
3745 if (written) {
3746 if (written == -EBUSY)
3747 return 0;
3748 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003749 }
3750
Al Viro639a93a52017-04-13 14:10:15 -04003751 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003752
3753 /*
3754 * Finally, try again to invalidate clean pages which might have been
3755 * cached by non-direct readahead, or faulted in by get_user_pages()
3756 * if the source of the write was an mmap'ed region of the file
3757 * we're writing. Either one is a pretty crazy thing to do,
3758 * so we don't support it 100%. If this invalidation
3759 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003760 *
3761 * Most of the time we do not need this since dio_complete() will do
3762 * the invalidation for us. However there are some file systems that
3763 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003764 * them by removing it completely.
3765 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003766 * Noticeable example is a blkdev_direct_IO().
3767 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003768 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003769 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003770 if (written > 0 && mapping->nrpages &&
3771 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3772 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003773
Linus Torvalds1da177e2005-04-16 15:20:36 -07003774 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003775 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003776 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003777 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3778 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003779 mark_inode_dirty(inode);
3780 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003781 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003782 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003783 if (written != -EIOCBQUEUED)
3784 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003785out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003786 return written;
3787}
3788EXPORT_SYMBOL(generic_file_direct_write);
3789
Nick Piggineb2be182007-10-16 01:24:57 -07003790/*
3791 * Find or create a page at the given pagecache position. Return the locked
3792 * page. This function is specifically for buffered writes.
3793 */
Nick Piggin54566b22009-01-04 12:00:53 -08003794struct page *grab_cache_page_write_begin(struct address_space *mapping,
3795 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003796{
Nick Piggineb2be182007-10-16 01:24:57 -07003797 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003798 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003799
Nick Piggin54566b22009-01-04 12:00:53 -08003800 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003801 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003802
Mel Gorman2457aec2014-06-04 16:10:31 -07003803 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003804 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003805 if (page)
3806 wait_for_stable_page(page);
3807
Nick Piggineb2be182007-10-16 01:24:57 -07003808 return page;
3809}
Nick Piggin54566b22009-01-04 12:00:53 -08003810EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003811
Al Viro3b93f912014-02-11 21:34:08 -05003812ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003813 struct iov_iter *i, loff_t pos)
3814{
3815 struct address_space *mapping = file->f_mapping;
3816 const struct address_space_operations *a_ops = mapping->a_ops;
3817 long status = 0;
3818 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003819 unsigned int flags = 0;
3820
Nick Pigginafddba42007-10-16 01:25:01 -07003821 do {
3822 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003823 unsigned long offset; /* Offset into pagecache page */
3824 unsigned long bytes; /* Bytes to write to page */
3825 size_t copied; /* Bytes copied from user */
Alexander Potapenko9357fca2022-09-15 17:04:16 +02003826 void *fsdata = NULL;
Nick Pigginafddba42007-10-16 01:25:01 -07003827
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003828 offset = (pos & (PAGE_SIZE - 1));
3829 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003830 iov_iter_count(i));
3831
3832again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003833 /*
3834 * Bring in the user page that we will copy from _first_.
3835 * Otherwise there's a nasty deadlock on copying from the
3836 * same page as we're writing to, without it being marked
3837 * up-to-date.
Linus Torvalds00a3d662015-10-07 08:32:38 +01003838 */
Andreas Gruenbacher30e66b12022-04-15 06:28:40 +08003839 if (unlikely(fault_in_iov_iter_readable(i, bytes))) {
Linus Torvalds00a3d662015-10-07 08:32:38 +01003840 status = -EFAULT;
3841 break;
3842 }
3843
Jan Kara296291c2015-10-22 13:32:21 -07003844 if (fatal_signal_pending(current)) {
3845 status = -EINTR;
3846 break;
3847 }
3848
Nick Piggin674b8922007-10-16 01:25:03 -07003849 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003850 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003851 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003852 break;
3853
anfei zhou931e80e2010-02-02 13:44:02 -08003854 if (mapping_writably_mapped(mapping))
3855 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003856
Al Virof0b65f32021-04-30 10:26:41 -04003857 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
Nick Pigginafddba42007-10-16 01:25:01 -07003858 flush_dcache_page(page);
3859
3860 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3861 page, fsdata);
Al Virof0b65f32021-04-30 10:26:41 -04003862 if (unlikely(status != copied)) {
3863 iov_iter_revert(i, copied - max(status, 0L));
3864 if (unlikely(status < 0))
3865 break;
3866 }
Nick Pigginafddba42007-10-16 01:25:01 -07003867 cond_resched();
3868
Al Virobc1bb412021-05-31 00:32:44 -04003869 if (unlikely(status == 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07003870 /*
Al Virobc1bb412021-05-31 00:32:44 -04003871 * A short copy made ->write_end() reject the
3872 * thing entirely. Might be memory poisoning
3873 * halfway through, might be a race with munmap,
3874 * might be severe memory pressure.
Nick Pigginafddba42007-10-16 01:25:01 -07003875 */
Al Virobc1bb412021-05-31 00:32:44 -04003876 if (copied)
3877 bytes = copied;
Nick Pigginafddba42007-10-16 01:25:01 -07003878 goto again;
3879 }
Al Virof0b65f32021-04-30 10:26:41 -04003880 pos += status;
3881 written += status;
Nick Pigginafddba42007-10-16 01:25:01 -07003882
3883 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003884 } while (iov_iter_count(i));
3885
3886 return written ? written : status;
3887}
Al Viro3b93f912014-02-11 21:34:08 -05003888EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003889
Jan Karae4dd9de2009-08-17 18:10:06 +02003890/**
Al Viro81742022014-04-03 03:17:43 -04003891 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003892 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003893 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003894 *
3895 * This function does all the work needed for actually writing data to a
3896 * file. It does all basic checks, removes SUID from the file, updates
3897 * modification times and calls proper subroutines depending on whether we
3898 * do direct IO or a standard buffered write.
3899 *
Jan Kara96087032021-04-12 15:50:21 +02003900 * It expects i_rwsem to be grabbed unless we work on a block device or similar
Jan Karae4dd9de2009-08-17 18:10:06 +02003901 * object which does not need locking at all.
3902 *
3903 * This function does *not* take care of syncing data in case of O_SYNC write.
3904 * A caller has to handle it. This is mainly due to the fact that we want to
Jan Kara96087032021-04-12 15:50:21 +02003905 * avoid syncing under i_rwsem.
Mike Rapoporta862f682019-03-05 15:48:42 -08003906 *
3907 * Return:
3908 * * number of bytes written, even for truncated writes
3909 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003910 */
Al Viro81742022014-04-03 03:17:43 -04003911ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003912{
3913 struct file *file = iocb->ki_filp;
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003914 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003915 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003916 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003917 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003918 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003919
Linus Torvalds1da177e2005-04-16 15:20:36 -07003920 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003921 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003922 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003923 if (err)
3924 goto out;
3925
Josef Bacikc3b2da32012-03-26 09:59:21 -04003926 err = file_update_time(file);
3927 if (err)
3928 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003929
Al Viro2ba48ce2015-04-09 13:52:01 -04003930 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003931 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003932
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003933 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003934 /*
3935 * If the write stopped short of completing, fall back to
3936 * buffered writes. Some filesystems do this for writes to
3937 * holes, for example. For DAX files, a buffered write will
3938 * not succeed (even if it did, DAX does not handle dirty
3939 * page-cache pages correctly).
3940 */
Al Viro0b8def92015-04-07 10:22:53 -04003941 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003942 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003943
Al Viro0b8def92015-04-07 10:22:53 -04003944 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003945 /*
Al Viro3b93f912014-02-11 21:34:08 -05003946 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003947 * then we want to return the number of bytes which were
3948 * direct-written, or the error code if that was zero. Note
3949 * that this differs from normal direct-io semantics, which
3950 * will return -EFOO even if some bytes were written.
3951 */
Al Viro60bb4522014-08-08 12:39:16 -04003952 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003953 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003954 goto out;
3955 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003956 /*
3957 * We need to ensure that the page cache pages are written to
3958 * disk and invalidated to preserve the expected O_DIRECT
3959 * semantics.
3960 */
Al Viro3b93f912014-02-11 21:34:08 -05003961 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003962 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003963 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003964 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003965 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003966 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003967 pos >> PAGE_SHIFT,
3968 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003969 } else {
3970 /*
3971 * We don't know how much we wrote, so just return
3972 * the number of bytes which were direct-written
3973 */
3974 }
3975 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003976 written = generic_perform_write(file, from, iocb->ki_pos);
3977 if (likely(written > 0))
3978 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003979 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003980out:
3981 current->backing_dev_info = NULL;
3982 return written ? written : err;
3983}
Al Viro81742022014-04-03 03:17:43 -04003984EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003985
Jan Karae4dd9de2009-08-17 18:10:06 +02003986/**
Al Viro81742022014-04-03 03:17:43 -04003987 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003988 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003989 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003990 *
Al Viro81742022014-04-03 03:17:43 -04003991 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003992 * filesystems. It takes care of syncing the file in case of O_SYNC file
Jan Kara96087032021-04-12 15:50:21 +02003993 * and acquires i_rwsem as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003994 * Return:
3995 * * negative error code if no data has been written at all of
3996 * vfs_fsync_range() failed for a synchronous write
3997 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003998 */
Al Viro81742022014-04-03 03:17:43 -04003999ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004000{
4001 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02004002 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004003 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004004
Al Viro59551022016-01-22 15:40:57 -05004005 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04004006 ret = generic_write_checks(iocb, from);
4007 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04004008 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05004009 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004010
Christoph Hellwige2592212016-04-07 08:52:01 -07004011 if (ret > 0)
4012 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004013 return ret;
4014}
Al Viro81742022014-04-03 03:17:43 -04004015EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004016
David Howellscf9a2ae2006-08-29 19:05:54 +01004017/**
4018 * try_to_release_page() - release old fs-specific metadata on a page
4019 *
4020 * @page: the page which the kernel is trying to free
4021 * @gfp_mask: memory allocation flags (and I/O mode)
4022 *
4023 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08004024 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01004025 *
David Howells266cf652009-04-03 16:42:36 +01004026 * This may also be called if PG_fscache is set on a page, indicating that the
4027 * page is known to the local caching routines.
4028 *
David Howellscf9a2ae2006-08-29 19:05:54 +01004029 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08004030 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01004031 *
Mike Rapoporta862f682019-03-05 15:48:42 -08004032 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01004033 */
4034int try_to_release_page(struct page *page, gfp_t gfp_mask)
4035{
4036 struct address_space * const mapping = page->mapping;
4037
4038 BUG_ON(!PageLocked(page));
4039 if (PageWriteback(page))
4040 return 0;
4041
4042 if (mapping && mapping->a_ops->releasepage)
4043 return mapping->a_ops->releasepage(page, gfp_mask);
4044 return try_to_free_buffers(page);
4045}
4046
4047EXPORT_SYMBOL(try_to_release_page);