blob: 528a21dcc116304ca7aab7c5284ca07998867022 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8/*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080015#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/fs.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010017#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070018#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080019#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mm.h>
23#include <linux/swap.h>
24#include <linux/mman.h>
25#include <linux/pagemap.h>
26#include <linux/file.h>
27#include <linux/uio.h>
Josef Bacikcfcbfb12019-05-13 17:21:04 -070028#include <linux/error-injection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/hash.h>
30#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070031#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080035#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070036#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080037#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060038#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080039#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070040#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070041#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070042#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070043#include <linux/ramfs.h>
Yang Shib9306a72020-08-06 23:19:55 -070044#include <linux/page_idle.h>
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +030045#include <asm/pgalloc.h>
Will Deaconde591a82021-02-10 11:15:11 +000046#include <asm/tlbflush.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080047#include "internal.h"
48
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070049#define CREATE_TRACE_POINTS
50#include <trace/events/filemap.h>
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * FIXME: remove all knowledge of the buffer layer from the core VM
54 */
Jan Kara148f9482009-08-17 19:52:36 +020055#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#include <asm/mman.h>
58
59/*
60 * Shared mappings implemented 30.11.1994. It's not fully working yet,
61 * though.
62 *
63 * Shared mappings now work. 15.8.1995 Bruno.
64 *
65 * finished 'unifying' the page and buffer cache and SMP-threaded the
66 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
67 *
68 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
69 */
70
71/*
72 * Lock ordering:
73 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080074 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070076 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070077 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 *
Jan Kara96087032021-04-12 15:50:21 +020079 * ->i_rwsem
Jan Kara730633f2021-01-28 19:19:45 +010080 * ->invalidate_lock (acquired by fs in truncate path)
81 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070083 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080084 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070085 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070086 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070088 * ->mmap_lock
Jan Kara730633f2021-01-28 19:19:45 +010089 * ->invalidate_lock (filemap_fault)
90 * ->lock_page (filemap_fault, access_process_vm)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 *
Jan Kara96087032021-04-12 15:50:21 +020092 * ->i_rwsem (generic_perform_write)
Andreas Gruenbacher923f05a2022-04-15 06:28:39 +080093 * ->mmap_lock (fault_in_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060095 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110096 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070097 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080099 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 * ->anon_vma.lock (vma_adjust)
101 *
102 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700103 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700105 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700106 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700108 * ->i_pages lock (try_to_unmap_one)
Hugh Dickins15b44732020-12-15 14:21:31 -0800109 * ->lruvec->lru_lock (follow_page->mark_page_accessed)
110 * ->lruvec->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700112 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600113 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100114 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700115 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600116 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100117 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
119 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800120 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700121 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 */
123
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500124static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700125 struct page *page, void *shadow)
126{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500127 XA_STATE(xas, &mapping->i_pages, page->index);
128 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800129
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500130 mapping_set_update(&xas, mapping);
131
132 /* hugetlb pages are represented by a single entry in the xarray */
133 if (!PageHuge(page)) {
134 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700135 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500136 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700137
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700138 VM_BUG_ON_PAGE(!PageLocked(page), page);
139 VM_BUG_ON_PAGE(PageTail(page), page);
140 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700141
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500142 xas_store(&xas, shadow);
143 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200144
Jan Kara23006382017-11-15 17:37:26 -0800145 page->mapping = NULL;
146 /* Leave page->index set: truncation lookup relies upon it */
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200147 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700148}
149
Jan Kara5ecc4d82017-11-15 17:37:29 -0800150static void unaccount_page_cache_page(struct address_space *mapping,
151 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800153 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600155 /*
156 * if we're uptodate, flush out into the cleancache, otherwise
157 * invalidate any existing cleancache entries. We can't leave
158 * stale data around in the cleancache once our page is gone
159 */
160 if (PageUptodate(page) && PageMappedToDisk(page))
161 cleancache_put_page(page);
162 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400163 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600164
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700165 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800166 VM_BUG_ON_PAGE(page_mapped(page), page);
167 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
168 int mapcount;
169
170 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
171 current->comm, page_to_pfn(page));
172 dump_page(page, "still mapped when deleted");
173 dump_stack();
174 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
175
176 mapcount = page_mapcount(page);
177 if (mapping_exiting(mapping) &&
178 page_count(page) >= mapcount + 2) {
179 /*
180 * All vmas have already been torn down, so it's
181 * a good bet that actually the page is unmapped,
182 * and we'd prefer not to leak it: if we're wrong,
183 * some other bad page check should catch it later.
184 */
185 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700186 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800187 }
188 }
189
Jan Kara76253fb2017-11-15 17:37:22 -0800190 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800191 if (PageHuge(page))
192 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800193
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700194 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800195
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700196 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800197 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700198 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800199 if (PageTransHuge(page))
Muchun Song57b28472021-02-24 12:03:31 -0800200 __mod_lruvec_page_state(page, NR_SHMEM_THPS, -nr);
Song Liu99cb0db2019-09-23 15:38:00 -0700201 } else if (PageTransHuge(page)) {
Muchun Songbf9ecea2021-02-24 12:03:27 -0800202 __mod_lruvec_page_state(page, NR_FILE_THPS, -nr);
Song Liu09d91cd2019-09-23 15:38:03 -0700203 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800204 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800205
206 /*
207 * At this point page must be either written or cleaned by
208 * truncate. Dirty page here signals a bug and loss of
209 * unwritten data.
210 *
211 * This fixes dirty accounting after removing the page entirely
212 * but leaves PageDirty set: it has no effect for truncated
213 * page and anyway will be cleared before returning page into
214 * buddy allocator.
215 */
216 if (WARN_ON_ONCE(PageDirty(page)))
217 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
218}
219
220/*
221 * Delete a page from the page cache and free it. Caller has to make
222 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700223 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800224 */
225void __delete_from_page_cache(struct page *page, void *shadow)
226{
227 struct address_space *mapping = page->mapping;
228
229 trace_mm_filemap_delete_from_page_cache(page);
230
231 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500232 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233}
234
Jan Kara59c66c52017-11-15 17:37:18 -0800235static void page_cache_free_page(struct address_space *mapping,
236 struct page *page)
237{
238 void (*freepage)(struct page *);
239
240 freepage = mapping->a_ops->freepage;
241 if (freepage)
242 freepage(page);
243
244 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700245 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800246 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
247 } else {
248 put_page(page);
249 }
250}
251
Minchan Kim702cfbf2011-03-22 16:32:43 -0700252/**
253 * delete_from_page_cache - delete page from page cache
254 * @page: the page which the kernel is trying to remove from page cache
255 *
256 * This must be called only on pages that have been verified to be in the page
257 * cache and locked. It will never put the page into the free list, the caller
258 * has a reference on the page.
259 */
260void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700262 struct address_space *mapping = page_mapping(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Matt Mackallcd7619d2005-05-01 08:59:01 -0700264 BUG_ON(!PageLocked(page));
Johannes Weiner30472502021-09-02 14:53:18 -0700265 xa_lock_irq(&mapping->i_pages);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700266 __delete_from_page_cache(page, NULL);
Johannes Weiner30472502021-09-02 14:53:18 -0700267 xa_unlock_irq(&mapping->i_pages);
Linus Torvalds6072d132010-12-01 13:35:19 -0500268
Jan Kara59c66c52017-11-15 17:37:18 -0800269 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700270}
271EXPORT_SYMBOL(delete_from_page_cache);
272
Jan Karaaa65c292017-11-15 17:37:33 -0800273/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500274 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800275 * @mapping: the mapping to which pages belong
276 * @pvec: pagevec with pages to delete
277 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700278 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700279 * from the mapping. The function expects @pvec to be sorted by page index
280 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700281 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800282 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700283 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800284 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700285 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800286 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500287static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800288 struct pagevec *pvec)
289{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500290 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800291 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700292 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800293 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800294
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500295 mapping_set_update(&xas, mapping);
296 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700297 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800298 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700299
300 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400301 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800302 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700303 /*
304 * A page got inserted in our range? Skip it. We have our
305 * pages locked so they are protected from being removed.
306 * If we see a page whose index is higher than ours, it
307 * means our page has been removed, which shouldn't be
308 * possible because we're holding the PageLock.
309 */
310 if (page != pvec->pages[i]) {
311 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
312 page);
313 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700314 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700315
316 WARN_ON_ONCE(!PageLocked(page));
317
318 if (page->index == xas.xa_index)
319 page->mapping = NULL;
320 /* Leave page->index set: truncation lookup relies on it */
321
322 /*
323 * Move to the next page in the vector if this is a regular
324 * page or the index is of the last sub-page of this compound
325 * page.
326 */
327 if (page->index + compound_nr(page) - 1 == xas.xa_index)
328 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500329 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800330 total_pages++;
331 }
332 mapping->nrpages -= total_pages;
333}
334
335void delete_from_page_cache_batch(struct address_space *mapping,
336 struct pagevec *pvec)
337{
338 int i;
Jan Karaaa65c292017-11-15 17:37:33 -0800339
340 if (!pagevec_count(pvec))
341 return;
342
Johannes Weiner30472502021-09-02 14:53:18 -0700343 xa_lock_irq(&mapping->i_pages);
Jan Karaaa65c292017-11-15 17:37:33 -0800344 for (i = 0; i < pagevec_count(pvec); i++) {
345 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
346
347 unaccount_page_cache_page(mapping, pvec->pages[i]);
348 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500349 page_cache_delete_batch(mapping, pvec);
Johannes Weiner30472502021-09-02 14:53:18 -0700350 xa_unlock_irq(&mapping->i_pages);
Jan Karaaa65c292017-11-15 17:37:33 -0800351
352 for (i = 0; i < pagevec_count(pvec); i++)
353 page_cache_free_page(mapping, pvec->pages[i]);
354}
355
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200356int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700357{
358 int ret = 0;
359 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700360 if (test_bit(AS_ENOSPC, &mapping->flags) &&
361 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700362 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700363 if (test_bit(AS_EIO, &mapping->flags) &&
364 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700365 ret = -EIO;
366 return ret;
367}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200368EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700369
Jeff Layton76341ca2017-07-06 07:02:22 -0400370static int filemap_check_and_keep_errors(struct address_space *mapping)
371{
372 /* Check for outstanding write errors */
373 if (test_bit(AS_EIO, &mapping->flags))
374 return -EIO;
375 if (test_bit(AS_ENOSPC, &mapping->flags))
376 return -ENOSPC;
377 return 0;
378}
379
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380/**
Josef Bacik5a798492021-07-14 14:47:22 -0400381 * filemap_fdatawrite_wbc - start writeback on mapping dirty pages in range
382 * @mapping: address space structure to write
383 * @wbc: the writeback_control controlling the writeout
384 *
385 * Call writepages on the mapping using the provided wbc to control the
386 * writeout.
387 *
388 * Return: %0 on success, negative error code otherwise.
389 */
390int filemap_fdatawrite_wbc(struct address_space *mapping,
391 struct writeback_control *wbc)
392{
393 int ret;
394
395 if (!mapping_can_writeback(mapping) ||
396 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
397 return 0;
398
399 wbc_attach_fdatawrite_inode(wbc, mapping->host);
400 ret = do_writepages(mapping, wbc);
401 wbc_detach_inode(wbc);
402 return ret;
403}
404EXPORT_SYMBOL(filemap_fdatawrite_wbc);
405
406/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700407 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700408 * @mapping: address space structure to write
409 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800410 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700411 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700413 * Start writeback against all of a mapping's dirty pages that lie
414 * within the byte offsets <start, end> inclusive.
415 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700417 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 * these two operations is that if a dirty page/buffer is encountered, it must
419 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800420 *
421 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800423int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
424 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 struct writeback_control wbc = {
427 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800428 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700429 .range_start = start,
430 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 };
432
Josef Bacik5a798492021-07-14 14:47:22 -0400433 return filemap_fdatawrite_wbc(mapping, &wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434}
435
436static inline int __filemap_fdatawrite(struct address_space *mapping,
437 int sync_mode)
438{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700439 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440}
441
442int filemap_fdatawrite(struct address_space *mapping)
443{
444 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
445}
446EXPORT_SYMBOL(filemap_fdatawrite);
447
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400448int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800449 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
451 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
452}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400453EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
Randy Dunlap485bb992006-06-23 02:03:49 -0700455/**
456 * filemap_flush - mostly a non-blocking flush
457 * @mapping: target address_space
458 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 * This is a mostly non-blocking flush. Not suitable for data-integrity
460 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800461 *
462 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 */
464int filemap_flush(struct address_space *mapping)
465{
466 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
467}
468EXPORT_SYMBOL(filemap_flush);
469
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500470/**
471 * filemap_range_has_page - check if a page exists in range.
472 * @mapping: address space within which to check
473 * @start_byte: offset in bytes where the range starts
474 * @end_byte: offset in bytes where the range ends (inclusive)
475 *
476 * Find at least one page in the range supplied, usually used to check if
477 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800478 *
479 * Return: %true if at least one page exists in the specified range,
480 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500481 */
482bool filemap_range_has_page(struct address_space *mapping,
483 loff_t start_byte, loff_t end_byte)
484{
Jan Karaf7b68042017-09-06 16:21:40 -0700485 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500486 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
487 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500488
489 if (end_byte < start_byte)
490 return false;
491
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500492 rcu_read_lock();
493 for (;;) {
494 page = xas_find(&xas, max);
495 if (xas_retry(&xas, page))
496 continue;
497 /* Shadow entries don't count */
498 if (xa_is_value(page))
499 continue;
500 /*
501 * We don't need to try to pin this page; we're about to
502 * release the RCU lock anyway. It is enough to know that
503 * there was a page here recently.
504 */
505 break;
506 }
507 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500508
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500509 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500510}
511EXPORT_SYMBOL(filemap_range_has_page);
512
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400513static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800514 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300516 pgoff_t index = start_byte >> PAGE_SHIFT;
517 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 struct pagevec pvec;
519 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200521 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400522 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Mel Gorman86679822017-11-15 17:37:52 -0800524 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800525 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 unsigned i;
527
Jan Kara312e9d22017-11-15 17:35:05 -0800528 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800529 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800530 if (!nr_pages)
531 break;
532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 for (i = 0; i < nr_pages; i++) {
534 struct page *page = pvec.pages[i];
535
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400537 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 }
539 pagevec_release(&pvec);
540 cond_resched();
541 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800542}
543
544/**
545 * filemap_fdatawait_range - wait for writeback to complete
546 * @mapping: address space structure to wait for
547 * @start_byte: offset in bytes where the range starts
548 * @end_byte: offset in bytes where the range ends (inclusive)
549 *
550 * Walk the list of under-writeback pages of the given address space
551 * in the given range and wait for all of them. Check error status of
552 * the address space and return it.
553 *
554 * Since the error status of the address space is cleared by this function,
555 * callers are responsible for checking the return value and handling and/or
556 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800557 *
558 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800559 */
560int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
561 loff_t end_byte)
562{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400563 __filemap_fdatawait_range(mapping, start_byte, end_byte);
564 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200566EXPORT_SYMBOL(filemap_fdatawait_range);
567
568/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400569 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
570 * @mapping: address space structure to wait for
571 * @start_byte: offset in bytes where the range starts
572 * @end_byte: offset in bytes where the range ends (inclusive)
573 *
574 * Walk the list of under-writeback pages of the given address space in the
575 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
576 * this function does not clear error status of the address space.
577 *
578 * Use this function if callers don't handle errors themselves. Expected
579 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
580 * fsfreeze(8)
581 */
582int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
583 loff_t start_byte, loff_t end_byte)
584{
585 __filemap_fdatawait_range(mapping, start_byte, end_byte);
586 return filemap_check_and_keep_errors(mapping);
587}
588EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
589
590/**
Jeff Laytona823e452017-07-28 07:24:43 -0400591 * file_fdatawait_range - wait for writeback to complete
592 * @file: file pointing to address space structure to wait for
593 * @start_byte: offset in bytes where the range starts
594 * @end_byte: offset in bytes where the range ends (inclusive)
595 *
596 * Walk the list of under-writeback pages of the address space that file
597 * refers to, in the given range and wait for all of them. Check error
598 * status of the address space vs. the file->f_wb_err cursor and return it.
599 *
600 * Since the error status of the file is advanced by this function,
601 * callers are responsible for checking the return value and handling and/or
602 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800603 *
604 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400605 */
606int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
607{
608 struct address_space *mapping = file->f_mapping;
609
610 __filemap_fdatawait_range(mapping, start_byte, end_byte);
611 return file_check_and_advance_wb_err(file);
612}
613EXPORT_SYMBOL(file_fdatawait_range);
614
615/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800616 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
617 * @mapping: address space structure to wait for
618 *
619 * Walk the list of under-writeback pages of the given address space
620 * and wait for all of them. Unlike filemap_fdatawait(), this function
621 * does not clear error status of the address space.
622 *
623 * Use this function if callers don't handle errors themselves. Expected
624 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
625 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800626 *
627 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800628 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400629int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800630{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400631 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400632 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800633}
Jeff Layton76341ca2017-07-06 07:02:22 -0400634EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800635
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700636/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400637static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700639 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641
Randy Dunlap485bb992006-06-23 02:03:49 -0700642/**
Jens Axboe63135aa2021-04-29 22:55:18 -0700643 * filemap_range_needs_writeback - check if range potentially needs writeback
644 * @mapping: address space within which to check
645 * @start_byte: offset in bytes where the range starts
646 * @end_byte: offset in bytes where the range ends (inclusive)
647 *
648 * Find at least one page in the range supplied, usually used to check if
649 * direct writing in this range will trigger a writeback. Used by O_DIRECT
650 * read/write with IOCB_NOWAIT, to see if the caller needs to do
651 * filemap_write_and_wait_range() before proceeding.
652 *
653 * Return: %true if the caller should do filemap_write_and_wait_range() before
654 * doing O_DIRECT to a page in this range, %false otherwise.
655 */
656bool filemap_range_needs_writeback(struct address_space *mapping,
657 loff_t start_byte, loff_t end_byte)
658{
659 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
660 pgoff_t max = end_byte >> PAGE_SHIFT;
661 struct page *page;
662
663 if (!mapping_needs_writeback(mapping))
664 return false;
665 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
666 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
667 return false;
668 if (end_byte < start_byte)
669 return false;
670
671 rcu_read_lock();
672 xas_for_each(&xas, page, max) {
673 if (xas_retry(&xas, page))
674 continue;
675 if (xa_is_value(page))
676 continue;
677 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
678 break;
679 }
680 rcu_read_unlock();
681 return page != NULL;
682}
683EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
684
685/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700686 * filemap_write_and_wait_range - write out & wait on a file range
687 * @mapping: the address_space for the pages
688 * @lstart: offset in bytes where the range starts
689 * @lend: offset in bytes where the range ends (inclusive)
690 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800691 * Write out and wait upon file offsets lstart->lend, inclusive.
692 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300693 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800694 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800695 *
696 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800697 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698int filemap_write_and_wait_range(struct address_space *mapping,
699 loff_t lstart, loff_t lend)
700{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800701 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702
Jeff Layton9326c9b2017-07-26 10:21:11 -0400703 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800704 err = __filemap_fdatawrite_range(mapping, lstart, lend,
705 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800706 /*
707 * Even if the above returned error, the pages may be
708 * written partially (e.g. -ENOSPC), so we wait for it.
709 * But the -EIO is special case, it may indicate the worst
710 * thing (e.g. bug) happened, so we avoid waiting for it.
711 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800712 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200713 int err2 = filemap_fdatawait_range(mapping,
714 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800715 if (!err)
716 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400717 } else {
718 /* Clear any previously stored errors */
719 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800720 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700721 } else {
722 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800724 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725}
Chris Masonf6995582009-04-15 13:22:37 -0400726EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
Jeff Layton5660e132017-07-06 07:02:25 -0400728void __filemap_set_wb_err(struct address_space *mapping, int err)
729{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400730 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400731
732 trace_filemap_set_wb_err(mapping, eseq);
733}
734EXPORT_SYMBOL(__filemap_set_wb_err);
735
736/**
737 * file_check_and_advance_wb_err - report wb error (if any) that was previously
738 * and advance wb_err to current one
739 * @file: struct file on which the error is being reported
740 *
741 * When userland calls fsync (or something like nfsd does the equivalent), we
742 * want to report any writeback errors that occurred since the last fsync (or
743 * since the file was opened if there haven't been any).
744 *
745 * Grab the wb_err from the mapping. If it matches what we have in the file,
746 * then just quickly return 0. The file is all caught up.
747 *
748 * If it doesn't match, then take the mapping value, set the "seen" flag in
749 * it and try to swap it into place. If it works, or another task beat us
750 * to it with the new value, then update the f_wb_err and return the error
751 * portion. The error at this point must be reported via proper channels
752 * (a'la fsync, or NFS COMMIT operation, etc.).
753 *
754 * While we handle mapping->wb_err with atomic operations, the f_wb_err
755 * value is protected by the f_lock since we must ensure that it reflects
756 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800757 *
758 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400759 */
760int file_check_and_advance_wb_err(struct file *file)
761{
762 int err = 0;
763 errseq_t old = READ_ONCE(file->f_wb_err);
764 struct address_space *mapping = file->f_mapping;
765
766 /* Locklessly handle the common case where nothing has changed */
767 if (errseq_check(&mapping->wb_err, old)) {
768 /* Something changed, must use slow path */
769 spin_lock(&file->f_lock);
770 old = file->f_wb_err;
771 err = errseq_check_and_advance(&mapping->wb_err,
772 &file->f_wb_err);
773 trace_file_check_and_advance_wb_err(file, old);
774 spin_unlock(&file->f_lock);
775 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700776
777 /*
778 * We're mostly using this function as a drop in replacement for
779 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
780 * that the legacy code would have had on these flags.
781 */
782 clear_bit(AS_EIO, &mapping->flags);
783 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400784 return err;
785}
786EXPORT_SYMBOL(file_check_and_advance_wb_err);
787
788/**
789 * file_write_and_wait_range - write out & wait on a file range
790 * @file: file pointing to address_space with pages
791 * @lstart: offset in bytes where the range starts
792 * @lend: offset in bytes where the range ends (inclusive)
793 *
794 * Write out and wait upon file offsets lstart->lend, inclusive.
795 *
796 * Note that @lend is inclusive (describes the last byte to be written) so
797 * that this function can be used to write to the very end-of-file (end = -1).
798 *
799 * After writing out and waiting on the data, we check and advance the
800 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800801 *
802 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400803 */
804int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
805{
806 int err = 0, err2;
807 struct address_space *mapping = file->f_mapping;
808
Jeff Layton9326c9b2017-07-26 10:21:11 -0400809 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400810 err = __filemap_fdatawrite_range(mapping, lstart, lend,
811 WB_SYNC_ALL);
812 /* See comment of filemap_write_and_wait() */
813 if (err != -EIO)
814 __filemap_fdatawait_range(mapping, lstart, lend);
815 }
816 err2 = file_check_and_advance_wb_err(file);
817 if (!err)
818 err = err2;
819 return err;
820}
821EXPORT_SYMBOL(file_write_and_wait_range);
822
Randy Dunlap485bb992006-06-23 02:03:49 -0700823/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700824 * replace_page_cache_page - replace a pagecache page with a new one
825 * @old: page to be replaced
826 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700827 *
828 * This function replaces a page in the pagecache with a new one. On
829 * success it acquires the pagecache reference for the new page and
830 * drops it for the old page. Both the old and new pages must be
831 * locked. This function does not add the new page to the LRU, the
832 * caller must do that.
833 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500834 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700835 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800836void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700837{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500838 struct address_space *mapping = old->mapping;
839 void (*freepage)(struct page *) = mapping->a_ops->freepage;
840 pgoff_t offset = old->index;
841 XA_STATE(xas, &mapping->i_pages, offset);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700842
Sasha Levin309381fea2014-01-23 15:52:54 -0800843 VM_BUG_ON_PAGE(!PageLocked(old), old);
844 VM_BUG_ON_PAGE(!PageLocked(new), new);
845 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700846
Matthew Wilcox74d60952017-11-17 10:01:45 -0500847 get_page(new);
848 new->mapping = mapping;
849 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700850
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700851 mem_cgroup_migrate(old, new);
852
Johannes Weiner30472502021-09-02 14:53:18 -0700853 xas_lock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500854 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700855
Matthew Wilcox74d60952017-11-17 10:01:45 -0500856 old->mapping = NULL;
857 /* hugetlb pages do not participate in page cache accounting. */
858 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700859 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500860 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700861 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500862 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700863 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500864 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700865 __inc_lruvec_page_state(new, NR_SHMEM);
Johannes Weiner30472502021-09-02 14:53:18 -0700866 xas_unlock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500867 if (freepage)
868 freepage(old);
869 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700870}
871EXPORT_SYMBOL_GPL(replace_page_cache_page);
872
Andrew Morton16c0cc02020-12-11 13:36:27 -0800873noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700874 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700875 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700876 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500878 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700879 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700880 int error;
Waiman Longda742402021-02-04 18:32:45 -0800881 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700882
Sasha Levin309381fea2014-01-23 15:52:54 -0800883 VM_BUG_ON_PAGE(!PageLocked(page), page);
884 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500885 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700886
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300887 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700888 page->mapping = mapping;
889 page->index = offset;
890
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700891 if (!huge) {
Dan Schatzberg04f94e32021-06-28 19:38:18 -0700892 error = mem_cgroup_charge(page, NULL, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700893 if (error)
894 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800895 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700896 }
897
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700898 gfp &= GFP_RECLAIM_MASK;
899
Matthew Wilcox74d60952017-11-17 10:01:45 -0500900 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700901 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
902 void *entry, *old = NULL;
903
904 if (order > thp_order(page))
905 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
906 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500907 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700908 xas_for_each_conflict(&xas, entry) {
909 old = entry;
910 if (!xa_is_value(entry)) {
911 xas_set_err(&xas, -EEXIST);
912 goto unlock;
913 }
914 }
915
916 if (old) {
917 if (shadowp)
918 *shadowp = old;
919 /* entry may have been split before we acquired lock */
920 order = xa_get_order(xas.xa, xas.xa_index);
921 if (order > thp_order(page)) {
922 xas_split(&xas, old, order);
923 xas_reset(&xas);
924 }
925 }
926
Matthew Wilcox74d60952017-11-17 10:01:45 -0500927 xas_store(&xas, page);
928 if (xas_error(&xas))
929 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700930
Matthew Wilcox74d60952017-11-17 10:01:45 -0500931 mapping->nrpages++;
932
933 /* hugetlb pages do not participate in page cache accounting */
934 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700935 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500936unlock:
937 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700938 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500939
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700940 if (xas_error(&xas)) {
941 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800942 if (charged)
943 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500944 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700945 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500946
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700947 trace_mm_filemap_add_to_page_cache(page);
948 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500949error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700950 page->mapping = NULL;
951 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300952 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700953 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700955ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700956
957/**
958 * add_to_page_cache_locked - add a locked page to the pagecache
959 * @page: page to add
960 * @mapping: the page's address_space
961 * @offset: page index
962 * @gfp_mask: page allocation mode
963 *
964 * This function is used to add a page to the pagecache. It must be locked.
965 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800966 *
967 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700968 */
969int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
970 pgoff_t offset, gfp_t gfp_mask)
971{
972 return __add_to_page_cache_locked(page, mapping, offset,
973 gfp_mask, NULL);
974}
Nick Piggine2867812008-07-25 19:45:30 -0700975EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
977int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400978 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
Johannes Weinera5289102014-04-03 14:47:51 -0700980 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700981 int ret;
982
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800983 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700984 ret = __add_to_page_cache_locked(page, mapping, offset,
985 gfp_mask, &shadow);
986 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800987 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700988 else {
989 /*
990 * The page might have been evicted from cache only
991 * recently, in which case it should be activated like
992 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700993 * The exception is pages getting rewritten; evicting other
994 * data from the working set, only to cache data that will
995 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700996 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700997 WARN_ON_ONCE(PageActive(page));
998 if (!(gfp_mask & __GFP_WRITE) && shadow)
999 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -07001000 lru_cache_add(page);
1001 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002 return ret;
1003}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001004EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Paul Jackson44110fe2006-03-24 03:16:04 -08001006#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -07001007struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -08001008{
Miao Xiec0ff7452010-05-24 14:32:08 -07001009 int n;
1010 struct page *page;
1011
Paul Jackson44110fe2006-03-24 03:16:04 -08001012 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -07001013 unsigned int cpuset_mems_cookie;
1014 do {
Mel Gormand26914d2014-04-03 14:47:24 -07001015 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -07001016 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -07001017 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -07001018 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -07001019
Miao Xiec0ff7452010-05-24 14:32:08 -07001020 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -08001021 }
Nick Piggin2ae88142006-10-28 10:38:23 -07001022 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -08001023}
Nick Piggin2ae88142006-10-28 10:38:23 -07001024EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -08001025#endif
1026
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027/*
Jan Kara7506ae62021-05-24 13:02:30 +02001028 * filemap_invalidate_lock_two - lock invalidate_lock for two mappings
1029 *
1030 * Lock exclusively invalidate_lock of any passed mapping that is not NULL.
1031 *
1032 * @mapping1: the first mapping to lock
1033 * @mapping2: the second mapping to lock
1034 */
1035void filemap_invalidate_lock_two(struct address_space *mapping1,
1036 struct address_space *mapping2)
1037{
1038 if (mapping1 > mapping2)
1039 swap(mapping1, mapping2);
1040 if (mapping1)
1041 down_write(&mapping1->invalidate_lock);
1042 if (mapping2 && mapping1 != mapping2)
1043 down_write_nested(&mapping2->invalidate_lock, 1);
1044}
1045EXPORT_SYMBOL(filemap_invalidate_lock_two);
1046
1047/*
1048 * filemap_invalidate_unlock_two - unlock invalidate_lock for two mappings
1049 *
1050 * Unlock exclusive invalidate_lock of any passed mapping that is not NULL.
1051 *
1052 * @mapping1: the first mapping to unlock
1053 * @mapping2: the second mapping to unlock
1054 */
1055void filemap_invalidate_unlock_two(struct address_space *mapping1,
1056 struct address_space *mapping2)
1057{
1058 if (mapping1)
1059 up_write(&mapping1->invalidate_lock);
1060 if (mapping2 && mapping1 != mapping2)
1061 up_write(&mapping2->invalidate_lock);
1062}
1063EXPORT_SYMBOL(filemap_invalidate_unlock_two);
1064
1065/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 * In order to wait for pages to become available there must be
1067 * waitqueues associated with pages. By using a hash table of
1068 * waitqueues where the bucket discipline is to maintain all
1069 * waiters on the same queue and wake all when any of the pages
1070 * become available, and for the woken contexts to check to be
1071 * sure the appropriate page became available, this saves space
1072 * at a cost of "thundering herd" phenomena during rare hash
1073 * collisions.
1074 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001075#define PAGE_WAIT_TABLE_BITS 8
1076#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1077static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1078
1079static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080{
Nicholas Piggin62906022016-12-25 13:00:30 +10001081 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082}
Nicholas Piggin62906022016-12-25 13:00:30 +10001083
1084void __init pagecache_init(void)
1085{
1086 int i;
1087
1088 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1089 init_waitqueue_head(&page_wait_table[i]);
1090
1091 page_writeback_init();
1092}
1093
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001094/*
1095 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001096 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001097 * one.
1098 *
1099 * We have:
1100 *
1101 * (a) no special bits set:
1102 *
1103 * We're just waiting for the bit to be released, and when a waker
1104 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1105 * and remove it from the wait queue.
1106 *
1107 * Simple and straightforward.
1108 *
1109 * (b) WQ_FLAG_EXCLUSIVE:
1110 *
1111 * The waiter is waiting to get the lock, and only one waiter should
1112 * be woken up to avoid any thundering herd behavior. We'll set the
1113 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1114 *
1115 * This is the traditional exclusive wait.
1116 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001117 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001118 *
1119 * The waiter is waiting to get the bit, and additionally wants the
1120 * lock to be transferred to it for fair lock behavior. If the lock
1121 * cannot be taken, we stop walking the wait queue without waking
1122 * the waiter.
1123 *
1124 * This is the "fair lock handoff" case, and in addition to setting
1125 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1126 * that it now has the lock.
1127 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001128static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001129{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001130 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001131 struct wait_page_key *key = arg;
1132 struct wait_page_queue *wait_page
1133 = container_of(wait, struct wait_page_queue, wait);
1134
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001135 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001136 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001137
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001138 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001139 * If it's a lock handoff wait, we get the bit for it, and
1140 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001141 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001142 flags = wait->flags;
1143 if (flags & WQ_FLAG_EXCLUSIVE) {
1144 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001145 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001146 if (flags & WQ_FLAG_CUSTOM) {
1147 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1148 return -1;
1149 flags |= WQ_FLAG_DONE;
1150 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001151 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001152
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001153 /*
1154 * We are holding the wait-queue lock, but the waiter that
1155 * is waiting for this will be checking the flags without
1156 * any locking.
1157 *
1158 * So update the flags atomically, and wake up the waiter
1159 * afterwards to avoid any races. This store-release pairs
1160 * with the load-acquire in wait_on_page_bit_common().
1161 */
1162 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001163 wake_up_state(wait->private, mode);
1164
1165 /*
1166 * Ok, we have successfully done what we're waiting for,
1167 * and we can unconditionally remove the wait entry.
1168 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001169 * Note that this pairs with the "finish_wait()" in the
1170 * waiter, and has to be the absolute last thing we do.
1171 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001172 * might be de-allocated and the process might even have
1173 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001174 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001175 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001176 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001177}
1178
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001179static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001180{
1181 wait_queue_head_t *q = page_waitqueue(page);
1182 struct wait_page_key key;
1183 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001184 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001185
1186 key.page = page;
1187 key.bit_nr = bit_nr;
1188 key.page_match = 0;
1189
Tim Chen11a19c72017-08-25 09:13:55 -07001190 bookmark.flags = 0;
1191 bookmark.private = NULL;
1192 bookmark.func = NULL;
1193 INIT_LIST_HEAD(&bookmark.entry);
1194
Nicholas Piggin62906022016-12-25 13:00:30 +10001195 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001196 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1197
1198 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1199 /*
1200 * Take a breather from holding the lock,
1201 * allow pages that finish wake up asynchronously
1202 * to acquire the lock and remove themselves
1203 * from wait queue
1204 */
1205 spin_unlock_irqrestore(&q->lock, flags);
1206 cpu_relax();
1207 spin_lock_irqsave(&q->lock, flags);
1208 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1209 }
1210
Nicholas Piggin62906022016-12-25 13:00:30 +10001211 /*
1212 * It is possible for other pages to have collided on the waitqueue
1213 * hash, so in that case check for a page match. That prevents a long-
1214 * term waiter
1215 *
1216 * It is still possible to miss a case here, when we woke page waiters
1217 * and removed them from the waitqueue, but there are still other
1218 * page waiters.
1219 */
1220 if (!waitqueue_active(q) || !key.page_match) {
1221 ClearPageWaiters(page);
1222 /*
1223 * It's possible to miss clearing Waiters here, when we woke
1224 * our page waiters, but the hashed waitqueue has waiters for
1225 * other pages on it.
1226 *
1227 * That's okay, it's a rare case. The next waker will clear it.
1228 */
1229 }
1230 spin_unlock_irqrestore(&q->lock, flags);
1231}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001232
1233static void wake_up_page(struct page *page, int bit)
1234{
1235 if (!PageWaiters(page))
1236 return;
1237 wake_up_page_bit(page, bit);
1238}
Nicholas Piggin62906022016-12-25 13:00:30 +10001239
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001240/*
1241 * A choice of three behaviors for wait_on_page_bit_common():
1242 */
1243enum behavior {
1244 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1245 * __lock_page() waiting on then setting PG_locked.
1246 */
1247 SHARED, /* Hold ref to page and check the bit when woken, like
1248 * wait_on_page_writeback() waiting on PG_writeback.
1249 */
1250 DROP, /* Drop ref to page before wait, no check when woken,
1251 * like put_and_wait_on_page_locked() on PG_locked.
1252 */
1253};
1254
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001255/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001256 * Attempt to check (or get) the page bit, and mark us done
1257 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001258 */
1259static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1260 struct wait_queue_entry *wait)
1261{
1262 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1263 if (test_and_set_bit(bit_nr, &page->flags))
1264 return false;
1265 } else if (test_bit(bit_nr, &page->flags))
1266 return false;
1267
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001268 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001269 return true;
1270}
1271
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001272/* How many times do we accept lock stealing from under a waiter? */
1273int sysctl_page_lock_unfairness = 5;
1274
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001275static inline __sched int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001276 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001277{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001278 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001279 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001280 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001281 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001282 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001283 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001284
Johannes Weinereb414682018-10-26 15:06:27 -07001285 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001286 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001287 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001288 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001289 delayacct = true;
1290 }
Johannes Weinereb414682018-10-26 15:06:27 -07001291 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001292 thrashing = true;
1293 }
1294
Nicholas Piggin62906022016-12-25 13:00:30 +10001295 init_wait(wait);
1296 wait->func = wake_page_function;
1297 wait_page.page = page;
1298 wait_page.bit_nr = bit_nr;
1299
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001300repeat:
1301 wait->flags = 0;
1302 if (behavior == EXCLUSIVE) {
1303 wait->flags = WQ_FLAG_EXCLUSIVE;
1304 if (--unfairness < 0)
1305 wait->flags |= WQ_FLAG_CUSTOM;
1306 }
1307
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001308 /*
1309 * Do one last check whether we can get the
1310 * page bit synchronously.
1311 *
1312 * Do the SetPageWaiters() marking before that
1313 * to let any waker we _just_ missed know they
1314 * need to wake us up (otherwise they'll never
1315 * even go to the slow case that looks at the
1316 * page queue), and add ourselves to the wait
1317 * queue if we need to sleep.
1318 *
1319 * This part needs to be done under the queue
1320 * lock to avoid races.
1321 */
1322 spin_lock_irq(&q->lock);
1323 SetPageWaiters(page);
1324 if (!trylock_page_bit_common(page, bit_nr, wait))
1325 __add_wait_queue_entry_tail(q, wait);
1326 spin_unlock_irq(&q->lock);
1327
1328 /*
1329 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001330 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1331 * see whether the page bit testing has already
1332 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001333 *
1334 * We can drop our reference to the page.
1335 */
1336 if (behavior == DROP)
1337 put_page(page);
1338
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001339 /*
1340 * Note that until the "finish_wait()", or until
1341 * we see the WQ_FLAG_WOKEN flag, we need to
1342 * be very careful with the 'wait->flags', because
1343 * we may race with a waker that sets them.
1344 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001345 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001346 unsigned int flags;
1347
Nicholas Piggin62906022016-12-25 13:00:30 +10001348 set_current_state(state);
1349
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001350 /* Loop until we've been woken or interrupted */
1351 flags = smp_load_acquire(&wait->flags);
1352 if (!(flags & WQ_FLAG_WOKEN)) {
1353 if (signal_pending_state(state, current))
1354 break;
1355
1356 io_schedule();
1357 continue;
1358 }
1359
1360 /* If we were non-exclusive, we're done */
1361 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001362 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001363
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001364 /* If the waker got the lock for us, we're done */
1365 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001366 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001367
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001368 /*
1369 * Otherwise, if we're getting the lock, we need to
1370 * try to get it ourselves.
1371 *
1372 * And if that fails, we'll have to retry this all.
1373 */
1374 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1375 goto repeat;
1376
1377 wait->flags |= WQ_FLAG_DONE;
1378 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001379 }
1380
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001381 /*
1382 * If a signal happened, this 'finish_wait()' may remove the last
1383 * waiter from the wait-queues, but the PageWaiters bit will remain
1384 * set. That's ok. The next wakeup will take care of it, and trying
1385 * to do it here would be difficult and prone to races.
1386 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001387 finish_wait(q, wait);
1388
Johannes Weinereb414682018-10-26 15:06:27 -07001389 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001390 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001391 delayacct_thrashing_end();
1392 psi_memstall_leave(&pflags);
1393 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001394
Nicholas Piggin62906022016-12-25 13:00:30 +10001395 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001396 * NOTE! The wait->flags weren't stable until we've done the
1397 * 'finish_wait()', and we could have exited the loop above due
1398 * to a signal, and had a wakeup event happen after the signal
1399 * test but before the 'finish_wait()'.
1400 *
1401 * So only after the finish_wait() can we reliably determine
1402 * if we got woken up or not, so we can now figure out the final
1403 * return value based on that state without races.
1404 *
1405 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1406 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001407 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001408 if (behavior == EXCLUSIVE)
1409 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001410
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001411 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001412}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001414__sched void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415{
Nicholas Piggin62906022016-12-25 13:00:30 +10001416 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001417 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418}
1419EXPORT_SYMBOL(wait_on_page_bit);
1420
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001421__sched int wait_on_page_bit_killable(struct page *page, int bit_nr)
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001422{
Nicholas Piggin62906022016-12-25 13:00:30 +10001423 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001424 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001425}
David Howells4343d002017-11-02 15:27:52 +00001426EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001427
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001429 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1430 * @page: The page to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001431 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001432 *
1433 * The caller should hold a reference on @page. They expect the page to
1434 * become unlocked relatively soon, but do not wish to hold up migration
1435 * (for example) by holding the reference while waiting for the page to
1436 * come unlocked. After this function returns, the caller should not
1437 * dereference @page.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001438 *
1439 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001440 */
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001441int put_and_wait_on_page_locked(struct page *page, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001442{
1443 wait_queue_head_t *q;
1444
1445 page = compound_head(page);
1446 q = page_waitqueue(page);
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001447 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001448}
1449
1450/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001451 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001452 * @page: Page defining the wait queue of interest
1453 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001454 *
1455 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1456 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001457void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001458{
1459 wait_queue_head_t *q = page_waitqueue(page);
1460 unsigned long flags;
1461
1462 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001463 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001464 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001465 spin_unlock_irqrestore(&q->lock, flags);
1466}
1467EXPORT_SYMBOL_GPL(add_page_wait_queue);
1468
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001469#ifndef clear_bit_unlock_is_negative_byte
1470
1471/*
1472 * PG_waiters is the high bit in the same byte as PG_lock.
1473 *
1474 * On x86 (and on many other architectures), we can clear PG_lock and
1475 * test the sign bit at the same time. But if the architecture does
1476 * not support that special operation, we just do this all by hand
1477 * instead.
1478 *
1479 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001480 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001481 * in the same byte as PG_locked.
1482 */
1483static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1484{
1485 clear_bit_unlock(nr, mem);
1486 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001487 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001488}
1489
1490#endif
1491
David Howells385e1ca5f2009-04-03 16:42:39 +01001492/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001493 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 * @page: the page
1495 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001496 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001498 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1500 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001501 * Note that this depends on PG_waiters being the sign bit in the byte
1502 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1503 * clear the PG_locked bit and test PG_waiters at the same time fairly
1504 * portably (architectures that do LL/SC can test any bit, while x86 can
1505 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001507void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001508{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001509 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001510 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001511 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001512 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1513 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514}
1515EXPORT_SYMBOL(unlock_page);
1516
Randy Dunlap485bb992006-06-23 02:03:49 -07001517/**
David Howells73e10de2020-02-10 10:00:21 +00001518 * end_page_private_2 - Clear PG_private_2 and release any waiters
1519 * @page: The page
1520 *
1521 * Clear the PG_private_2 bit on a page and wake up any sleepers waiting for
1522 * this. The page ref held for PG_private_2 being set is released.
1523 *
1524 * This is, for example, used when a netfs page is being written to a local
1525 * disk cache, thereby allowing writes to the cache for the same page to be
1526 * serialised.
1527 */
1528void end_page_private_2(struct page *page)
1529{
1530 page = compound_head(page);
1531 VM_BUG_ON_PAGE(!PagePrivate2(page), page);
1532 clear_bit_unlock(PG_private_2, &page->flags);
1533 wake_up_page_bit(page, PG_private_2);
1534 put_page(page);
1535}
1536EXPORT_SYMBOL(end_page_private_2);
1537
1538/**
1539 * wait_on_page_private_2 - Wait for PG_private_2 to be cleared on a page
1540 * @page: The page to wait on
1541 *
1542 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page.
1543 */
1544void wait_on_page_private_2(struct page *page)
1545{
1546 page = compound_head(page);
1547 while (PagePrivate2(page))
1548 wait_on_page_bit(page, PG_private_2);
1549}
1550EXPORT_SYMBOL(wait_on_page_private_2);
1551
1552/**
1553 * wait_on_page_private_2_killable - Wait for PG_private_2 to be cleared on a page
1554 * @page: The page to wait on
1555 *
1556 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page or until a
1557 * fatal signal is received by the calling task.
1558 *
1559 * Return:
1560 * - 0 if successful.
1561 * - -EINTR if a fatal signal was encountered.
1562 */
1563int wait_on_page_private_2_killable(struct page *page)
1564{
1565 int ret = 0;
1566
1567 page = compound_head(page);
1568 while (PagePrivate2(page)) {
1569 ret = wait_on_page_bit_killable(page, PG_private_2);
1570 if (ret < 0)
1571 break;
1572 }
1573
1574 return ret;
1575}
1576EXPORT_SYMBOL(wait_on_page_private_2_killable);
1577
1578/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001579 * end_page_writeback - end writeback against a page
1580 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581 */
1582void end_page_writeback(struct page *page)
1583{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001584 /*
1585 * TestClearPageReclaim could be used here but it is an atomic
1586 * operation and overkill in this particular case. Failing to
1587 * shuffle a page marked for immediate reclaim is too mild to
1588 * justify taking an atomic operation penalty at the end of
1589 * ever page writeback.
1590 */
1591 if (PageReclaim(page)) {
1592 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001593 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001594 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001595
Hugh Dickins073861e2020-11-24 08:46:43 -08001596 /*
1597 * Writeback does not hold a page reference of its own, relying
1598 * on truncation to wait for the clearing of PG_writeback.
1599 * But here we must make sure that the page is not freed and
1600 * reused before the wake_up_page().
1601 */
1602 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001603 if (!test_clear_page_writeback(page))
1604 BUG();
1605
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001606 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001608 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609}
1610EXPORT_SYMBOL(end_page_writeback);
1611
Matthew Wilcox57d99842014-06-04 16:07:45 -07001612/*
1613 * After completing I/O on a page, call this routine to update the page
1614 * flags appropriately
1615 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001616void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001617{
Jens Axboec11f0c02016-08-05 08:11:04 -06001618 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001619 if (!err) {
1620 SetPageUptodate(page);
1621 } else {
1622 ClearPageUptodate(page);
1623 SetPageError(page);
1624 }
1625 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001626 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001627 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001628 struct address_space *mapping;
1629
Matthew Wilcox57d99842014-06-04 16:07:45 -07001630 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001631 mapping = page_mapping(page);
1632 if (mapping)
1633 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001634 }
1635 end_page_writeback(page);
1636 }
1637}
1638EXPORT_SYMBOL_GPL(page_endio);
1639
Randy Dunlap485bb992006-06-23 02:03:49 -07001640/**
1641 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001642 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001644__sched void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645{
Nicholas Piggin62906022016-12-25 13:00:30 +10001646 struct page *page = compound_head(__page);
1647 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001648 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1649 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650}
1651EXPORT_SYMBOL(__lock_page);
1652
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001653__sched int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001654{
Nicholas Piggin62906022016-12-25 13:00:30 +10001655 struct page *page = compound_head(__page);
1656 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001657 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1658 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001659}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001660EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001661
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001662__sched int __lock_page_async(struct page *page, struct wait_page_queue *wait)
Jens Axboedd3e6d52020-05-22 09:12:09 -06001663{
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001664 struct wait_queue_head *q = page_waitqueue(page);
1665 int ret = 0;
1666
1667 wait->page = page;
1668 wait->bit_nr = PG_locked;
1669
1670 spin_lock_irq(&q->lock);
1671 __add_wait_queue_entry_tail(q, &wait->wait);
1672 SetPageWaiters(page);
1673 ret = !trylock_page(page);
1674 /*
1675 * If we were successful now, we know we're still on the
1676 * waitqueue as we're still under the lock. This means it's
1677 * safe to remove and return success, we know the callback
1678 * isn't going to trigger.
1679 */
1680 if (!ret)
1681 __remove_wait_queue(q, &wait->wait);
1682 else
1683 ret = -EIOCBQUEUED;
1684 spin_unlock_irq(&q->lock);
1685 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001686}
1687
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001688/*
1689 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001690 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001691 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001692 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001693 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001694 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001695 *
1696 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001697 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001698 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001699__sched int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
Michel Lespinassed065bd82010-10-26 14:21:57 -07001700 unsigned int flags)
1701{
Peter Xu4064b982020-04-01 21:08:45 -07001702 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001703 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001704 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001705 * even though return 0.
1706 */
1707 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1708 return 0;
1709
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001710 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001711 if (flags & FAULT_FLAG_KILLABLE)
1712 wait_on_page_locked_killable(page);
1713 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001714 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001715 return 0;
1716 }
Hailong Liu800bca72020-12-14 19:05:02 -08001717 if (flags & FAULT_FLAG_KILLABLE) {
1718 int ret;
1719
1720 ret = __lock_page_killable(page);
1721 if (ret) {
1722 mmap_read_unlock(mm);
1723 return 0;
1724 }
1725 } else {
1726 __lock_page(page);
1727 }
1728 return 1;
1729
Michel Lespinassed065bd82010-10-26 14:21:57 -07001730}
1731
Randy Dunlap485bb992006-06-23 02:03:49 -07001732/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001733 * page_cache_next_miss() - Find the next gap in the page cache.
1734 * @mapping: Mapping.
1735 * @index: Index.
1736 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001737 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001738 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1739 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001740 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001741 * This function may be called under the rcu_read_lock. However, this will
1742 * not atomically search a snapshot of the cache at a single point in time.
1743 * For example, if a gap is created at index 5, then subsequently a gap is
1744 * created at index 10, page_cache_next_miss covering both indices may
1745 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001746 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001747 * Return: The index of the gap if found, otherwise an index outside the
1748 * range specified (in which case 'return - index >= max_scan' will be true).
1749 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001750 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001751pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001752 pgoff_t index, unsigned long max_scan)
1753{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001754 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001755
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001756 while (max_scan--) {
1757 void *entry = xas_next(&xas);
1758 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001759 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001760 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001761 break;
1762 }
1763
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001764 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001765}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001766EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001767
1768/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001769 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001770 * @mapping: Mapping.
1771 * @index: Index.
1772 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001773 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001774 * Search the range [max(index - max_scan + 1, 0), index] for the
1775 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001776 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001777 * This function may be called under the rcu_read_lock. However, this will
1778 * not atomically search a snapshot of the cache at a single point in time.
1779 * For example, if a gap is created at index 10, then subsequently a gap is
1780 * created at index 5, page_cache_prev_miss() covering both indices may
1781 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001782 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001783 * Return: The index of the gap if found, otherwise an index outside the
1784 * range specified (in which case 'index - return >= max_scan' will be true).
1785 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001786 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001787pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001788 pgoff_t index, unsigned long max_scan)
1789{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001790 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001791
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001792 while (max_scan--) {
1793 void *entry = xas_prev(&xas);
1794 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001795 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001796 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001797 break;
1798 }
1799
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001800 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001801}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001802EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001803
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001804/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001805 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001806 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001807 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001808 *
Rui Sun4b17f032021-04-29 22:55:38 -07001809 * Looks up the page cache slot at @mapping & @index. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001810 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001811 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001812 * If the slot holds a shadow entry of a previously evicted page, or a
1813 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001814 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001815 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816 */
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001817static struct page *mapping_get_entry(struct address_space *mapping,
1818 pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001819{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001820 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001821 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Nick Piggina60637c2008-07-25 19:45:31 -07001823 rcu_read_lock();
1824repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001825 xas_reset(&xas);
1826 page = xas_load(&xas);
1827 if (xas_retry(&xas, page))
1828 goto repeat;
1829 /*
1830 * A shadow entry of a recently evicted page, or a swap entry from
1831 * shmem/tmpfs. Return it without attempting to raise page count.
1832 */
1833 if (!page || xa_is_value(page))
1834 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001835
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001836 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001837 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001838
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001839 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001840 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001841 * This is part of the lockless pagecache protocol. See
1842 * include/linux/pagemap.h for details.
1843 */
1844 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001845 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001846 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001847 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001848out:
Nick Piggina60637c2008-07-25 19:45:31 -07001849 rcu_read_unlock();
1850
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 return page;
1852}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853
Randy Dunlap485bb992006-06-23 02:03:49 -07001854/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001855 * pagecache_get_page - Find and get a reference to a page.
1856 * @mapping: The address_space to search.
1857 * @index: The page index.
1858 * @fgp_flags: %FGP flags modify how the page is returned.
1859 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001860 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001861 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001862 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001863 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001864 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001865 * * %FGP_ACCESSED - The page will be marked accessed.
1866 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001867 * * %FGP_HEAD - If the page is present and a THP, return the head page
1868 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001869 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
1870 * instead of allocating a new page to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001871 * * %FGP_CREAT - If no page is present then a new page is allocated using
1872 * @gfp_mask and added to the page cache and the VM's LRU list.
1873 * The page is returned locked and with an increased refcount.
1874 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1875 * page is already in cache. If the page was allocated, unlock it before
1876 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001877 * * %FGP_WRITE - The page will be written
1878 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1879 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001880 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001881 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1882 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001883 *
1884 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001885 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001886 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001887 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001888struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1889 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890{
Nick Piggineb2be182007-10-16 01:24:57 -07001891 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001892
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893repeat:
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001894 page = mapping_get_entry(mapping, index);
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001895 if (xa_is_value(page)) {
1896 if (fgp_flags & FGP_ENTRY)
1897 return page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001898 page = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001899 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001900 if (!page)
1901 goto no_page;
1902
1903 if (fgp_flags & FGP_LOCK) {
1904 if (fgp_flags & FGP_NOWAIT) {
1905 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001906 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001907 return NULL;
1908 }
1909 } else {
1910 lock_page(page);
1911 }
1912
1913 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001914 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001915 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001916 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001917 goto repeat;
1918 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001919 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001920 }
1921
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001922 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001923 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001924 else if (fgp_flags & FGP_WRITE) {
1925 /* Clear idle flag for buffer write */
1926 if (page_is_idle(page))
1927 clear_page_idle(page);
1928 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001929 if (!(fgp_flags & FGP_HEAD))
1930 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001931
1932no_page:
1933 if (!page && (fgp_flags & FGP_CREAT)) {
1934 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001935 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001936 gfp_mask |= __GFP_WRITE;
1937 if (fgp_flags & FGP_NOFS)
1938 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001939
Michal Hocko45f87de2014-12-29 20:30:35 +01001940 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001941 if (!page)
1942 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001943
Josef Bacika75d4c32019-03-13 11:44:14 -07001944 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001945 fgp_flags |= FGP_LOCK;
1946
Hugh Dickinseb39d612014-08-06 16:06:43 -07001947 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001948 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001949 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001950
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001951 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001952 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001953 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001954 page = NULL;
1955 if (err == -EEXIST)
1956 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001958
1959 /*
1960 * add_to_page_cache_lru locks the page, and for mmap we expect
1961 * an unlocked page.
1962 */
1963 if (page && (fgp_flags & FGP_FOR_MMAP))
1964 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001966
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 return page;
1968}
Mel Gorman2457aec2014-06-04 16:10:31 -07001969EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001971static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1972 xa_mark_t mark)
1973{
1974 struct page *page;
1975
1976retry:
1977 if (mark == XA_PRESENT)
1978 page = xas_find(xas, max);
1979 else
1980 page = xas_find_marked(xas, max, mark);
1981
1982 if (xas_retry(xas, page))
1983 goto retry;
1984 /*
1985 * A shadow entry of a recently evicted page, a swap
1986 * entry from shmem/tmpfs or a DAX entry. Return it
1987 * without attempting to raise page count.
1988 */
1989 if (!page || xa_is_value(page))
1990 return page;
1991
1992 if (!page_cache_get_speculative(page))
1993 goto reset;
1994
1995 /* Has the page moved or been split? */
1996 if (unlikely(page != xas_reload(xas))) {
1997 put_page(page);
1998 goto reset;
1999 }
2000
2001 return page;
2002reset:
2003 xas_reset(xas);
2004 goto retry;
2005}
2006
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07002008 * find_get_entries - gang pagecache lookup
2009 * @mapping: The address_space to search
2010 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002011 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002012 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002013 * @indices: The cache indices corresponding to the entries in @entries
2014 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002015 * find_get_entries() will search for and return a batch of entries in
2016 * the mapping. The entries are placed in @pvec. find_get_entries()
2017 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002018 *
2019 * The search returns a group of mapping-contiguous page cache entries
2020 * with ascending indexes. There may be holes in the indices due to
2021 * not-present pages.
2022 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07002023 * Any shadow entries of evicted pages, or swap entries from
2024 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002025 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07002026 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
2027 * stops at that page: the caller is likely to have a better way to handle
2028 * the compound page as a whole, and then skip its extent, than repeatedly
2029 * calling find_get_entries() to return all its tails.
2030 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002031 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002032 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002033unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002034 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07002035{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002036 XA_STATE(xas, &mapping->i_pages, start);
2037 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002038 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002039 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002040
2041 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002042 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002043 /*
2044 * Terminate early on finding a THP, to allow the caller to
2045 * handle it all at once; but continue if this is hugetlbfs.
2046 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002047 if (!xa_is_value(page) && PageTransHuge(page) &&
2048 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002049 page = find_subpage(page, xas.xa_index);
2050 nr_entries = ret + 1;
2051 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002052
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002053 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002054 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002055 if (++ret == nr_entries)
2056 break;
2057 }
2058 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002059
2060 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002061 return ret;
2062}
2063
2064/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002065 * find_lock_entries - Find a batch of pagecache entries.
2066 * @mapping: The address_space to search.
2067 * @start: The starting page cache index.
2068 * @end: The final page index (inclusive).
2069 * @pvec: Where the resulting entries are placed.
2070 * @indices: The cache indices of the entries in @pvec.
2071 *
2072 * find_lock_entries() will return a batch of entries from @mapping.
2073 * Swap, shadow and DAX entries are included. Pages are returned
2074 * locked and with an incremented refcount. Pages which are locked by
2075 * somebody else or under writeback are skipped. Only the head page of
2076 * a THP is returned. Pages which are partially outside the range are
2077 * not returned.
2078 *
2079 * The entries have ascending indexes. The indices may not be consecutive
2080 * due to not-present entries, THP pages, pages which could not be locked
2081 * or pages under writeback.
2082 *
2083 * Return: The number of entries which were found.
2084 */
2085unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2086 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2087{
2088 XA_STATE(xas, &mapping->i_pages, start);
2089 struct page *page;
2090
2091 rcu_read_lock();
2092 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Liu Shixin066a5b62022-07-07 10:09:38 +08002093 unsigned long next_idx = xas.xa_index + 1;
2094
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002095 if (!xa_is_value(page)) {
Liu Shixin066a5b62022-07-07 10:09:38 +08002096 if (PageTransHuge(page))
2097 next_idx = page->index + thp_nr_pages(page);
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002098 if (page->index < start)
2099 goto put;
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002100 if (page->index + thp_nr_pages(page) - 1 > end)
2101 goto put;
2102 if (!trylock_page(page))
2103 goto put;
2104 if (page->mapping != mapping || PageWriteback(page))
2105 goto unlock;
2106 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2107 page);
2108 }
2109 indices[pvec->nr] = xas.xa_index;
2110 if (!pagevec_add(pvec, page))
2111 break;
2112 goto next;
2113unlock:
2114 unlock_page(page);
2115put:
2116 put_page(page);
2117next:
Liu Shixin066a5b62022-07-07 10:09:38 +08002118 if (next_idx != xas.xa_index + 1) {
Hugh Dickins2d11e732021-04-23 14:28:57 -07002119 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
Liu Shixin066a5b62022-07-07 10:09:38 +08002120 if (next_idx < xas.xa_index)
Hugh Dickins2d11e732021-04-23 14:28:57 -07002121 break;
Liu Shixin066a5b62022-07-07 10:09:38 +08002122 xas_set(&xas, next_idx);
Hugh Dickins2d11e732021-04-23 14:28:57 -07002123 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002124 }
2125 rcu_read_unlock();
2126
2127 return pagevec_count(pvec);
2128}
2129
2130/**
Jan Karab947cee2017-09-06 16:21:21 -07002131 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 * @mapping: The address_space to search
2133 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002134 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 * @nr_pages: The maximum number of pages
2136 * @pages: Where the resulting pages are placed
2137 *
Jan Karab947cee2017-09-06 16:21:21 -07002138 * find_get_pages_range() will search for and return a group of up to @nr_pages
2139 * pages in the mapping starting at index @start and up to index @end
2140 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2141 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002142 *
2143 * The search returns a group of mapping-contiguous pages with ascending
2144 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002145 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002147 * Return: the number of pages which were found. If this number is
2148 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002149 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 */
Jan Karab947cee2017-09-06 16:21:21 -07002151unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2152 pgoff_t end, unsigned int nr_pages,
2153 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002155 XA_STATE(xas, &mapping->i_pages, *start);
2156 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002157 unsigned ret = 0;
2158
2159 if (unlikely(!nr_pages))
2160 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002161
Nick Piggina60637c2008-07-25 19:45:31 -07002162 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002163 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002164 /* Skip over shadow, swap and DAX entries */
2165 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002166 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002167
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002168 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002169 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002170 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002171 goto out;
2172 }
Nick Piggina60637c2008-07-25 19:45:31 -07002173 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002174
Jan Karab947cee2017-09-06 16:21:21 -07002175 /*
2176 * We come here when there is no page beyond @end. We take care to not
2177 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002178 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002179 * already broken anyway.
2180 */
2181 if (end == (pgoff_t)-1)
2182 *start = (pgoff_t)-1;
2183 else
2184 *start = end + 1;
2185out:
Nick Piggina60637c2008-07-25 19:45:31 -07002186 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002187
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 return ret;
2189}
2190
Jens Axboeebf43502006-04-27 08:46:01 +02002191/**
2192 * find_get_pages_contig - gang contiguous pagecache lookup
2193 * @mapping: The address_space to search
2194 * @index: The starting page index
2195 * @nr_pages: The maximum number of pages
2196 * @pages: Where the resulting pages are placed
2197 *
2198 * find_get_pages_contig() works exactly like find_get_pages(), except
2199 * that the returned number of pages are guaranteed to be contiguous.
2200 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002201 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002202 */
2203unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2204 unsigned int nr_pages, struct page **pages)
2205{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002206 XA_STATE(xas, &mapping->i_pages, index);
2207 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002208 unsigned int ret = 0;
2209
2210 if (unlikely(!nr_pages))
2211 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002212
Nick Piggina60637c2008-07-25 19:45:31 -07002213 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002214 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002215 if (xas_retry(&xas, page))
2216 continue;
2217 /*
2218 * If the entry has been swapped out, we can stop looking.
2219 * No current caller is looking for DAX entries.
2220 */
2221 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002222 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002223
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002224 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002225 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002226
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002227 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002228 if (unlikely(page != xas_reload(&xas)))
2229 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002230
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002231 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002232 if (++ret == nr_pages)
2233 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002234 continue;
2235put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002236 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002237retry:
2238 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002239 }
Nick Piggina60637c2008-07-25 19:45:31 -07002240 rcu_read_unlock();
2241 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002242}
David Howellsef71c152007-05-09 02:33:44 -07002243EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002244
Randy Dunlap485bb992006-06-23 02:03:49 -07002245/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002246 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002247 * @mapping: the address_space to search
2248 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002249 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002250 * @tag: the tag index
2251 * @nr_pages: the maximum number of pages
2252 * @pages: where the resulting pages are placed
2253 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002254 * Like find_get_pages(), except we only return head pages which are tagged
2255 * with @tag. @index is updated to the index immediately after the last
2256 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002257 *
2258 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002259 */
Jan Kara72b045a2017-11-15 17:34:33 -08002260unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002261 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002262 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002264 XA_STATE(xas, &mapping->i_pages, *index);
2265 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002266 unsigned ret = 0;
2267
2268 if (unlikely(!nr_pages))
2269 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270
Nick Piggina60637c2008-07-25 19:45:31 -07002271 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002272 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002273 /*
2274 * Shadow entries should never be tagged, but this iteration
2275 * is lockless so there is a window for page reclaim to evict
2276 * a page we saw tagged. Skip over it.
2277 */
2278 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002279 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002280
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002281 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002282 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002283 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002284 goto out;
2285 }
Nick Piggina60637c2008-07-25 19:45:31 -07002286 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002287
Jan Kara72b045a2017-11-15 17:34:33 -08002288 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002289 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002290 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002291 * iteration when there is a page at index -1 but that is already
2292 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002293 */
2294 if (end == (pgoff_t)-1)
2295 *index = (pgoff_t)-1;
2296 else
2297 *index = end + 1;
2298out:
Nick Piggina60637c2008-07-25 19:45:31 -07002299 rcu_read_unlock();
2300
Linus Torvalds1da177e2005-04-16 15:20:36 -07002301 return ret;
2302}
Jan Kara72b045a2017-11-15 17:34:33 -08002303EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002305/*
2306 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2307 * a _large_ part of the i/o request. Imagine the worst scenario:
2308 *
2309 * ---R__________________________________________B__________
2310 * ^ reading here ^ bad block(assume 4k)
2311 *
2312 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2313 * => failing the whole request => read(R) => read(R+1) =>
2314 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2315 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2316 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2317 *
2318 * It is going insane. Fix it by quickly scaling down the readahead size.
2319 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002320static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002321{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002322 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002323}
2324
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002325/*
2326 * filemap_get_read_batch - Get a batch of pages for read
2327 *
2328 * Get a batch of pages which represent a contiguous range of bytes
2329 * in the file. No tail pages will be returned. If @index is in the
2330 * middle of a THP, the entire THP will be returned. The last page in
2331 * the batch may have Readahead set or be not Uptodate so that the
2332 * caller can take the appropriate action.
2333 */
2334static void filemap_get_read_batch(struct address_space *mapping,
2335 pgoff_t index, pgoff_t max, struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002336{
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002337 XA_STATE(xas, &mapping->i_pages, index);
2338 struct page *head;
2339
2340 rcu_read_lock();
2341 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2342 if (xas_retry(&xas, head))
2343 continue;
2344 if (xas.xa_index > max || xa_is_value(head))
2345 break;
2346 if (!page_cache_get_speculative(head))
2347 goto retry;
2348
2349 /* Has the page moved or been split? */
2350 if (unlikely(head != xas_reload(&xas)))
2351 goto put_page;
2352
2353 if (!pagevec_add(pvec, head))
2354 break;
2355 if (!PageUptodate(head))
2356 break;
2357 if (PageReadahead(head))
2358 break;
Matthew Wilcox (Oracle)f89903a2022-02-23 15:59:18 +00002359 if (PageHead(head)) {
2360 xas_set(&xas, head->index + thp_nr_pages(head));
2361 /* Handle wrap correctly */
2362 if (xas.xa_index - 1 >= max)
2363 break;
2364 }
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002365 continue;
2366put_page:
2367 put_page(head);
2368retry:
2369 xas_reset(&xas);
2370 }
2371 rcu_read_unlock();
Kent Overstreet723ef242020-12-14 19:04:52 -08002372}
2373
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002374static int filemap_read_page(struct file *file, struct address_space *mapping,
2375 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002376{
Kent Overstreet723ef242020-12-14 19:04:52 -08002377 int error;
2378
Kent Overstreet723ef242020-12-14 19:04:52 -08002379 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002380 * A previous I/O error may have been due to temporary failures,
2381 * eg. multipath errors. PG_error will be set again if readpage
2382 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002383 */
2384 ClearPageError(page);
2385 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002386 error = mapping->a_ops->readpage(file, page);
2387 if (error)
2388 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002389
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002390 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002391 if (error)
2392 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002393 if (PageUptodate(page))
2394 return 0;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002395 shrink_readahead_size_eio(&file->f_ra);
2396 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002397}
2398
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002399static bool filemap_range_uptodate(struct address_space *mapping,
2400 loff_t pos, struct iov_iter *iter, struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002401{
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002402 int count;
2403
2404 if (PageUptodate(page))
2405 return true;
2406 /* pipes can't handle partially uptodate pages */
2407 if (iov_iter_is_pipe(iter))
2408 return false;
2409 if (!mapping->a_ops->is_partially_uptodate)
2410 return false;
2411 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2412 return false;
2413
2414 count = iter->count;
2415 if (page_offset(page) > pos) {
2416 count -= page_offset(page) - pos;
2417 pos = 0;
2418 } else {
2419 pos -= page_offset(page);
2420 }
2421
2422 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2423}
2424
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002425static int filemap_update_page(struct kiocb *iocb,
2426 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002427 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002428{
Kent Overstreet723ef242020-12-14 19:04:52 -08002429 int error;
2430
Jan Kara730633f2021-01-28 19:19:45 +01002431 if (iocb->ki_flags & IOCB_NOWAIT) {
2432 if (!filemap_invalidate_trylock_shared(mapping))
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002433 return -EAGAIN;
Jan Kara730633f2021-01-28 19:19:45 +01002434 } else {
2435 filemap_invalidate_lock_shared(mapping);
2436 }
2437
2438 if (!trylock_page(page)) {
2439 error = -EAGAIN;
2440 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2441 goto unlock_mapping;
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002442 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Jan Kara730633f2021-01-28 19:19:45 +01002443 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002444 put_and_wait_on_page_locked(page, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002445 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002446 }
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002447 error = __lock_page_async(page, iocb->ki_waitq);
2448 if (error)
Jan Kara730633f2021-01-28 19:19:45 +01002449 goto unlock_mapping;
Kent Overstreet723ef242020-12-14 19:04:52 -08002450 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002451
Jan Kara730633f2021-01-28 19:19:45 +01002452 error = AOP_TRUNCATED_PAGE;
Kent Overstreet723ef242020-12-14 19:04:52 -08002453 if (!page->mapping)
Jan Kara730633f2021-01-28 19:19:45 +01002454 goto unlock;
Kent Overstreet723ef242020-12-14 19:04:52 -08002455
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002456 error = 0;
2457 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, page))
2458 goto unlock;
2459
2460 error = -EAGAIN;
2461 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2462 goto unlock;
2463
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002464 error = filemap_read_page(iocb->ki_filp, mapping, page);
Jan Kara730633f2021-01-28 19:19:45 +01002465 goto unlock_mapping;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002466unlock:
2467 unlock_page(page);
Jan Kara730633f2021-01-28 19:19:45 +01002468unlock_mapping:
2469 filemap_invalidate_unlock_shared(mapping);
2470 if (error == AOP_TRUNCATED_PAGE)
2471 put_page(page);
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002472 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002473}
2474
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002475static int filemap_create_page(struct file *file,
2476 struct address_space *mapping, pgoff_t index,
2477 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002478{
Kent Overstreet723ef242020-12-14 19:04:52 -08002479 struct page *page;
2480 int error;
2481
Kent Overstreet723ef242020-12-14 19:04:52 -08002482 page = page_cache_alloc(mapping);
2483 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002484 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002485
Jan Kara730633f2021-01-28 19:19:45 +01002486 /*
2487 * Protect against truncate / hole punch. Grabbing invalidate_lock here
2488 * assures we cannot instantiate and bring uptodate new pagecache pages
2489 * after evicting page cache during truncate and before actually
2490 * freeing blocks. Note that we could release invalidate_lock after
2491 * inserting the page into page cache as the locked page would then be
2492 * enough to synchronize with hole punching. But there are code paths
2493 * such as filemap_update_page() filling in partially uptodate pages or
2494 * ->readpages() that need to hold invalidate_lock while mapping blocks
2495 * for IO so let's hold the lock here as well to keep locking rules
2496 * simple.
2497 */
2498 filemap_invalidate_lock_shared(mapping);
Kent Overstreet723ef242020-12-14 19:04:52 -08002499 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002500 mapping_gfp_constraint(mapping, GFP_KERNEL));
2501 if (error == -EEXIST)
2502 error = AOP_TRUNCATED_PAGE;
2503 if (error)
2504 goto error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002505
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002506 error = filemap_read_page(file, mapping, page);
2507 if (error)
2508 goto error;
2509
Jan Kara730633f2021-01-28 19:19:45 +01002510 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002511 pagevec_add(pvec, page);
2512 return 0;
2513error:
Jan Kara730633f2021-01-28 19:19:45 +01002514 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002515 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002516 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002517}
2518
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002519static int filemap_readahead(struct kiocb *iocb, struct file *file,
2520 struct address_space *mapping, struct page *page,
2521 pgoff_t last_index)
2522{
2523 if (iocb->ki_flags & IOCB_NOIO)
2524 return -EAGAIN;
2525 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2526 page->index, last_index - page->index);
2527 return 0;
2528}
2529
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002530static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002531 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002532{
2533 struct file *filp = iocb->ki_filp;
2534 struct address_space *mapping = filp->f_mapping;
2535 struct file_ra_state *ra = &filp->f_ra;
2536 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002537 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002538 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002539 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002540
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002541 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002542retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002543 if (fatal_signal_pending(current))
2544 return -EINTR;
2545
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002546 filemap_get_read_batch(mapping, index, last_index, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002547 if (!pagevec_count(pvec)) {
2548 if (iocb->ki_flags & IOCB_NOIO)
2549 return -EAGAIN;
2550 page_cache_sync_readahead(mapping, ra, filp, index,
2551 last_index - index);
2552 filemap_get_read_batch(mapping, index, last_index, pvec);
2553 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002554 if (!pagevec_count(pvec)) {
2555 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2556 return -EAGAIN;
2557 err = filemap_create_page(filp, mapping,
2558 iocb->ki_pos >> PAGE_SHIFT, pvec);
2559 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002560 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002561 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002562 }
2563
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002564 page = pvec->pages[pagevec_count(pvec) - 1];
2565 if (PageReadahead(page)) {
2566 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2567 if (err)
2568 goto err;
2569 }
2570 if (!PageUptodate(page)) {
2571 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2572 iocb->ki_flags |= IOCB_NOWAIT;
2573 err = filemap_update_page(iocb, mapping, iter, page);
2574 if (err)
2575 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002576 }
2577
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002578 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002579err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002580 if (err < 0)
2581 put_page(page);
2582 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002583 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002584 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002585 goto retry;
2586 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002587}
2588
Randy Dunlap485bb992006-06-23 02:03:49 -07002589/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002590 * filemap_read - Read data from the page cache.
2591 * @iocb: The iocb to read.
2592 * @iter: Destination for the data.
2593 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002594 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002595 * Copies data from the page cache. If the data is not currently present,
2596 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002598 * Return: Total number of bytes copied, including those already read by
2599 * the caller. If an error happens before any bytes are copied, returns
2600 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002602ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2603 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002604{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002605 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002606 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002607 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002608 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002609 struct pagevec pvec;
2610 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002611 bool writably_mapped;
2612 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613
Kent Overstreet723ef242020-12-14 19:04:52 -08002614 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002615 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002616 if (unlikely(!iov_iter_count(iter)))
2617 return 0;
2618
Wei Fangc2a97372016-10-07 17:01:52 -07002619 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002620 pagevec_init(&pvec);
Jens Axboe13bd6912020-10-17 08:31:29 -06002621
Kent Overstreet06c04442020-12-14 19:04:56 -08002622 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 cond_resched();
Michal Hocko5abf1862017-02-03 13:13:29 -08002624
NeilBrowna32ea1e2007-07-17 04:03:04 -07002625 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002626 * If we've already successfully copied some data, then we
2627 * can no longer safely return -EIOCBQUEUED. Hence mark
2628 * an async read NOWAIT at that point.
2629 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002630 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002631 iocb->ki_flags |= IOCB_NOWAIT;
2632
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002633 error = filemap_get_pages(iocb, iter, &pvec);
2634 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002635 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002636
Kent Overstreet723ef242020-12-14 19:04:52 -08002637 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002638 * i_size must be checked after we know the pages are Uptodate.
NeilBrowna32ea1e2007-07-17 04:03:04 -07002639 *
2640 * Checking i_size after the check allows us to calculate
2641 * the correct value for "nr", which means the zero-filled
2642 * part of the page is not copied back to userspace (unless
2643 * another truncate extends the file - this is desired though).
2644 */
NeilBrowna32ea1e2007-07-17 04:03:04 -07002645 isize = i_size_read(inode);
Kent Overstreet06c04442020-12-14 19:04:56 -08002646 if (unlikely(iocb->ki_pos >= isize))
2647 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002648 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649
Linus Torvalds1da177e2005-04-16 15:20:36 -07002650 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002651 * Once we start copying data, we don't want to be touching any
2652 * cachelines that might be contended:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002653 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002654 writably_mapped = mapping_writably_mapped(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655
2656 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002657 * When a sequential read accesses a page several times, only
2658 * mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002660 if (iocb->ki_pos >> PAGE_SHIFT !=
2661 ra->prev_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002662 mark_page_accessed(pvec.pages[0]);
Al Viro6e58e792014-02-03 17:07:03 -05002663
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002664 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002665 struct page *page = pvec.pages[i];
2666 size_t page_size = thp_size(page);
2667 size_t offset = iocb->ki_pos & (page_size - 1);
2668 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2669 page_size - offset);
2670 size_t copied;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002671
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002672 if (end_offset < page_offset(page))
2673 break;
2674 if (i > 0)
2675 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002676 /*
2677 * If users can be writing to this page using arbitrary
2678 * virtual addresses, take care about potential aliasing
2679 * before reading the page on the kernel side.
2680 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002681 if (writably_mapped) {
2682 int j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002683
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002684 for (j = 0; j < thp_nr_pages(page); j++)
2685 flush_dcache_page(page + j);
2686 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002687
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002688 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002689
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002690 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002691 iocb->ki_pos += copied;
2692 ra->prev_pos = iocb->ki_pos;
2693
2694 if (copied < bytes) {
2695 error = -EFAULT;
2696 break;
Jens Axboe0abed7c2020-11-16 13:36:24 -07002697 }
Jens Axboe0abed7c2020-11-16 13:36:24 -07002698 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002699put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002700 for (i = 0; i < pagevec_count(&pvec); i++)
2701 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002702 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002703 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002704
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002705 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002706
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002707 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002708}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002709EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002710
Randy Dunlap485bb992006-06-23 02:03:49 -07002711/**
Al Viro6abd2322014-04-04 14:20:57 -04002712 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002713 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002714 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002715 *
Al Viro6abd2322014-04-04 14:20:57 -04002716 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002718 *
2719 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2720 * be returned when no data can be read without waiting for I/O requests
2721 * to complete; it doesn't prevent readahead.
2722 *
2723 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2724 * requests shall be made for the read or for readahead. When no data
2725 * can be read, -EAGAIN shall be returned. When readahead would be
2726 * triggered, a partial, possibly empty read shall be returned.
2727 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002728 * Return:
2729 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002730 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 */
2732ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002733generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002735 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002736 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002737
2738 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002739 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740
Al Viro2ba48ce2015-04-09 13:52:01 -04002741 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002742 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002743 struct address_space *mapping = file->f_mapping;
2744 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002745 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002748 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002749 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2750 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002751 return -EAGAIN;
2752 } else {
2753 retval = filemap_write_and_wait_range(mapping,
2754 iocb->ki_pos,
2755 iocb->ki_pos + count - 1);
2756 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002757 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002758 }
Al Viroed978a82014-03-05 22:53:04 -05002759
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002760 file_accessed(file);
2761
Al Viro5ecda132017-04-13 14:13:36 -04002762 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002763 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002764 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002765 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002766 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002767 if (retval != -EIOCBQUEUED)
2768 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002769
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002770 /*
2771 * Btrfs can have a short DIO read if we encounter
2772 * compressed extents, so if there was an error, or if
2773 * we've already read everything we wanted to, or if
2774 * there was a short read because we hit EOF, go ahead
2775 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002776 * the rest of the read. Buffered reads will not work for
2777 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002778 */
Al Viro5ecda132017-04-13 14:13:36 -04002779 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002780 IS_DAX(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002781 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782 }
2783
Christoph Hellwig826ea862021-02-24 12:02:45 -08002784 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002785}
Al Viroed978a82014-03-05 22:53:04 -05002786EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002788static inline loff_t page_seek_hole_data(struct xa_state *xas,
2789 struct address_space *mapping, struct page *page,
2790 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002791{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002792 const struct address_space_operations *ops = mapping->a_ops;
2793 size_t offset, bsz = i_blocksize(mapping->host);
2794
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002795 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002796 return seek_data ? start : end;
2797 if (!ops->is_partially_uptodate)
2798 return seek_data ? end : start;
2799
2800 xas_pause(xas);
2801 rcu_read_unlock();
2802 lock_page(page);
2803 if (unlikely(page->mapping != mapping))
2804 goto unlock;
2805
2806 offset = offset_in_thp(page, start) & ~(bsz - 1);
2807
2808 do {
2809 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2810 break;
2811 start = (start + bsz) & ~(bsz - 1);
2812 offset += bsz;
2813 } while (offset < thp_size(page));
2814unlock:
2815 unlock_page(page);
2816 rcu_read_lock();
2817 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002818}
2819
2820static inline
2821unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2822{
2823 if (xa_is_value(page))
2824 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2825 return thp_size(page);
2826}
2827
2828/**
2829 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2830 * @mapping: Address space to search.
2831 * @start: First byte to consider.
2832 * @end: Limit of search (exclusive).
2833 * @whence: Either SEEK_HOLE or SEEK_DATA.
2834 *
2835 * If the page cache knows which blocks contain holes and which blocks
2836 * contain data, your filesystem can use this function to implement
2837 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2838 * entirely memory-based such as tmpfs, and filesystems which support
2839 * unwritten extents.
2840 *
Ingo Molnarf0953a12021-05-06 18:06:47 -07002841 * Return: The requested offset on success, or -ENXIO if @whence specifies
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002842 * SEEK_DATA and there is no data after @start. There is an implicit hole
2843 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2844 * and @end contain data.
2845 */
2846loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2847 loff_t end, int whence)
2848{
2849 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002850 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002851 bool seek_data = (whence == SEEK_DATA);
2852 struct page *page;
2853
2854 if (end <= start)
2855 return -ENXIO;
2856
2857 rcu_read_lock();
2858 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002859 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2860 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002861
2862 if (start < pos) {
2863 if (!seek_data)
2864 goto unlock;
2865 start = pos;
2866 }
2867
Hugh Dickinsed98b012021-04-23 14:29:00 -07002868 seek_size = seek_page_size(&xas, page);
2869 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002870 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2871 seek_data);
2872 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002873 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002874 if (start >= end)
2875 break;
2876 if (seek_size > PAGE_SIZE)
2877 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002878 if (!xa_is_value(page))
2879 put_page(page);
2880 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002881 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002882 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002883unlock:
2884 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002885 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002886 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002887 if (start > end)
2888 return end;
2889 return start;
2890}
2891
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002893#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002894/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002895 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002896 * @vmf - the vm_fault for this fault.
2897 * @page - the page to lock.
2898 * @fpin - the pointer to the file we may pin (or is already pinned).
2899 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002900 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002901 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002902 * 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 -07002903 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002904 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002905static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2906 struct file **fpin)
2907{
2908 if (trylock_page(page))
2909 return 1;
2910
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002911 /*
2912 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002913 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002914 * is supposed to work. We have way too many special cases..
2915 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002916 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2917 return 0;
2918
2919 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2920 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2921 if (__lock_page_killable(page)) {
2922 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002923 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002924 * but all fault_handlers only check for fatal signals
2925 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002926 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002927 */
2928 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002929 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002930 return 0;
2931 }
2932 } else
2933 __lock_page(page);
2934 return 1;
2935}
2936
2937
2938/*
2939 * Synchronous readahead happens when we don't even find a page in the page
2940 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2941 * to drop the mmap sem we return the file that was pinned in order for us to do
2942 * that. If we didn't pin a file then we return NULL. The file that is
2943 * returned needs to be fput()'ed when we're done with it.
2944 */
2945static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002946{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002947 struct file *file = vmf->vma->vm_file;
2948 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002949 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002950 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002951 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002952 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002953
2954 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002955 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002956 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002957 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002958 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002959
Josef Bacik2a1180f2019-03-13 11:44:18 -07002960 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002961 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002962 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002963 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002964 }
2965
Andi Kleen207d04b2011-05-24 17:12:29 -07002966 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002967 mmap_miss = READ_ONCE(ra->mmap_miss);
2968 if (mmap_miss < MMAP_LOTSAMISS * 10)
2969 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002970
2971 /*
2972 * Do we miss much more than hit in this file? If so,
2973 * stop bothering with read-ahead. It will only hurt.
2974 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002975 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002976 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002977
Wu Fengguangd30a1102009-06-16 15:31:30 -07002978 /*
2979 * mmap read-around
2980 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002981 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002982 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002983 ra->size = ra->ra_pages;
2984 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002985 ractl._index = ra->start;
2986 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002987 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002988}
2989
2990/*
2991 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002992 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002993 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002994 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002995static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2996 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002997{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002998 struct file *file = vmf->vma->vm_file;
2999 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003000 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003001 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003002 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07003003 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003004
3005 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07003006 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003007 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003008 mmap_miss = READ_ONCE(ra->mmap_miss);
3009 if (mmap_miss)
3010 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003011 if (PageReadahead(page)) {
3012 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07003013 page_cache_async_readahead(mapping, ra, file,
3014 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003015 }
3016 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003017}
3018
Randy Dunlap485bb992006-06-23 02:03:49 -07003019/**
Nick Piggin54cb8822007-07-19 01:46:59 -07003020 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07003021 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07003022 *
Nick Piggin54cb8822007-07-19 01:46:59 -07003023 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024 * mapped memory region to read in file data during a page fault.
3025 *
3026 * The goto's are kind of ugly, but this streamlines the normal case of having
3027 * it in the page cache, and handles the special cases reasonably without
3028 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003029 *
Michel Lespinassecd333a02021-04-29 10:28:25 -07003030 * If FAULT_FLAG_SPECULATIVE is set, this function runs within an rcu
3031 * read locked section and with mmap lock not held.
3032 * Otherwise, vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003033 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003034 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07003035 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003036 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003037 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003038 * has not been released.
3039 *
3040 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08003041 *
3042 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003044vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045{
3046 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08003047 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003048 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003049 struct address_space *mapping = file->f_mapping;
Michel Lespinassecd333a02021-04-29 10:28:25 -07003050 struct file_ra_state *ra = &file->f_ra;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003051 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003052 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003053 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003054 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003055 vm_fault_t ret = 0;
Jan Kara730633f2021-01-28 19:19:45 +01003056 bool mapping_locked = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003057
Michel Lespinassecd333a02021-04-29 10:28:25 -07003058 if (vmf->flags & FAULT_FLAG_SPECULATIVE) {
3059 page = find_get_page(mapping, offset);
Patrick Dalya467d8a2022-10-10 19:25:27 -07003060 if (unlikely(!page))
Michel Lespinassecd333a02021-04-29 10:28:25 -07003061 return VM_FAULT_RETRY;
3062
Patrick Dalya467d8a2022-10-10 19:25:27 -07003063 if (unlikely(PageReadahead(page)))
3064 goto page_put;
3065
Michel Lespinassecd333a02021-04-29 10:28:25 -07003066 if (!trylock_page(page))
Patrick Dalya467d8a2022-10-10 19:25:27 -07003067 goto page_put;
Michel Lespinassecd333a02021-04-29 10:28:25 -07003068
3069 if (unlikely(compound_head(page)->mapping != mapping))
3070 goto page_unlock;
3071 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
3072 if (unlikely(!PageUptodate(page)))
3073 goto page_unlock;
3074
3075 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3076 if (unlikely(offset >= max_off))
3077 goto page_unlock;
3078
3079 /*
3080 * Update readahead mmap_miss statistic.
3081 *
3082 * Note that we are not sure if finish_fault() will
3083 * manage to complete the transaction. If it fails,
3084 * we'll come back to filemap_fault() non-speculative
3085 * case which will update mmap_miss a second time.
3086 * This is not ideal, we would prefer to guarantee the
3087 * update will happen exactly once.
3088 */
3089 if (!(vmf->vma->vm_flags & VM_RAND_READ) && ra->ra_pages) {
3090 unsigned int mmap_miss = READ_ONCE(ra->mmap_miss);
3091 if (mmap_miss)
3092 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
3093 }
3094
3095 vmf->page = page;
3096 return VM_FAULT_LOCKED;
3097page_unlock:
3098 unlock_page(page);
Patrick Dalya467d8a2022-10-10 19:25:27 -07003099page_put:
3100 put_page(page);
Michel Lespinassecd333a02021-04-29 10:28:25 -07003101 return VM_FAULT_RETRY;
3102 }
3103
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003104 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3105 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07003106 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003107
Linus Torvalds1da177e2005-04-16 15:20:36 -07003108 /*
Johannes Weiner49426422013-10-16 13:46:59 -07003109 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07003110 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003111 page = find_get_page(mapping, offset);
Jan Kara730633f2021-01-28 19:19:45 +01003112 if (likely(page)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003113 /*
Jan Kara730633f2021-01-28 19:19:45 +01003114 * We found the page, so try async readahead before waiting for
3115 * the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003116 */
Jan Kara730633f2021-01-28 19:19:45 +01003117 if (!(vmf->flags & FAULT_FLAG_TRIED))
3118 fpin = do_async_mmap_readahead(vmf, page);
3119 if (unlikely(!PageUptodate(page))) {
3120 filemap_invalidate_lock_shared(mapping);
3121 mapping_locked = true;
3122 }
3123 } else {
Linus Torvaldsef00e082009-06-16 15:31:25 -07003124 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003125 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07003126 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003127 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003128 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003129retry_find:
Jan Kara730633f2021-01-28 19:19:45 +01003130 /*
3131 * See comment in filemap_create_page() why we need
3132 * invalidate_lock
3133 */
3134 if (!mapping_locked) {
3135 filemap_invalidate_lock_shared(mapping);
3136 mapping_locked = true;
3137 }
Josef Bacika75d4c32019-03-13 11:44:14 -07003138 page = pagecache_get_page(mapping, offset,
3139 FGP_CREAT|FGP_FOR_MMAP,
3140 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003141 if (!page) {
3142 if (fpin)
3143 goto out_retry;
Jan Kara730633f2021-01-28 19:19:45 +01003144 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07003145 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003146 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003147 }
3148
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003149 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3150 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003151
3152 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003153 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003154 unlock_page(page);
3155 put_page(page);
3156 goto retry_find;
3157 }
Song Liu520e5ba2019-09-23 15:37:50 -07003158 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003159
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003161 * We have a locked page in the page cache, now we need to check
3162 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163 */
Jan Kara730633f2021-01-28 19:19:45 +01003164 if (unlikely(!PageUptodate(page))) {
3165 /*
3166 * The page was in cache and uptodate and now it is not.
3167 * Strange but possible since we didn't hold the page lock all
3168 * the time. Let's drop everything get the invalidate lock and
3169 * try again.
3170 */
3171 if (!mapping_locked) {
3172 unlock_page(page);
3173 put_page(page);
3174 goto retry_find;
3175 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003176 goto page_not_uptodate;
Jan Kara730633f2021-01-28 19:19:45 +01003177 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003178
Linus Torvaldsef00e082009-06-16 15:31:25 -07003179 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003180 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003181 * time to return to the upper layer and have it re-find the vma and
3182 * redo the fault.
3183 */
3184 if (fpin) {
3185 unlock_page(page);
3186 goto out_retry;
3187 }
Jan Kara730633f2021-01-28 19:19:45 +01003188 if (mapping_locked)
3189 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003190
3191 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003192 * Found the page and have a reference on it.
3193 * We must recheck i_size under page lock.
3194 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003195 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3196 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003197 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003198 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003199 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003200 }
3201
Nick Piggind0217ac2007-07-19 01:47:03 -07003202 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003203 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003204
Linus Torvalds1da177e2005-04-16 15:20:36 -07003205page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003206 /*
3207 * Umm, take care of errors if the page isn't up-to-date.
3208 * Try to re-read it _once_. We do this synchronously,
3209 * because there really aren't any performance issues here
3210 * and we need to check for errors.
3211 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003212 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)d31fa862021-04-29 22:55:26 -07003213 error = filemap_read_page(file, mapping, page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003214 if (fpin)
3215 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003216 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003217
3218 if (!error || error == AOP_TRUNCATED_PAGE)
3219 goto retry_find;
Jan Kara730633f2021-01-28 19:19:45 +01003220 filemap_invalidate_unlock_shared(mapping);
Nick Piggind00806b2007-07-19 01:46:57 -07003221
Nick Piggind0217ac2007-07-19 01:47:03 -07003222 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003223
3224out_retry:
3225 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003226 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003227 * re-find the vma and come back and find our hopefully still populated
3228 * page.
3229 */
3230 if (page)
3231 put_page(page);
Jan Kara730633f2021-01-28 19:19:45 +01003232 if (mapping_locked)
3233 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003234 if (fpin)
3235 fput(fpin);
3236 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003237}
3238EXPORT_SYMBOL(filemap_fault);
3239
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003240static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003241{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003242 struct mm_struct *mm = vmf->vma->vm_mm;
3243
3244 /* Huge page is mapped? No need to proceed. */
3245 if (pmd_trans_huge(*vmf->pmd)) {
3246 unlock_page(page);
3247 put_page(page);
3248 return true;
3249 }
3250
3251 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
3252 vm_fault_t ret = do_set_pmd(vmf, page);
3253 if (!ret) {
3254 /* The page is mapped successfully, reference consumed. */
3255 unlock_page(page);
3256 return true;
3257 }
3258 }
3259
3260 if (pmd_none(*vmf->pmd)) {
3261 vmf->ptl = pmd_lock(mm, vmf->pmd);
3262 if (likely(pmd_none(*vmf->pmd))) {
3263 mm_inc_nr_ptes(mm);
3264 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
3265 vmf->prealloc_pte = NULL;
3266 }
3267 spin_unlock(vmf->ptl);
3268 }
3269
3270 /* See comment in handle_pte_fault() */
3271 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3272 unlock_page(page);
3273 put_page(page);
3274 return true;
3275 }
3276
3277 return false;
3278}
3279
3280static struct page *next_uptodate_page(struct page *page,
3281 struct address_space *mapping,
3282 struct xa_state *xas, pgoff_t end_pgoff)
3283{
3284 unsigned long max_idx;
3285
3286 do {
3287 if (!page)
3288 return NULL;
3289 if (xas_retry(xas, page))
3290 continue;
3291 if (xa_is_value(page))
3292 continue;
3293 if (PageLocked(page))
3294 continue;
3295 if (!page_cache_get_speculative(page))
3296 continue;
3297 /* Has the page moved or been split? */
3298 if (unlikely(page != xas_reload(xas)))
3299 goto skip;
3300 if (!PageUptodate(page) || PageReadahead(page))
3301 goto skip;
3302 if (PageHWPoison(page))
3303 goto skip;
3304 if (!trylock_page(page))
3305 goto skip;
3306 if (page->mapping != mapping)
3307 goto unlock;
3308 if (!PageUptodate(page))
3309 goto unlock;
3310 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3311 if (xas->xa_index >= max_idx)
3312 goto unlock;
3313 return page;
3314unlock:
3315 unlock_page(page);
3316skip:
3317 put_page(page);
3318 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3319
3320 return NULL;
3321}
3322
3323static inline struct page *first_map_page(struct address_space *mapping,
3324 struct xa_state *xas,
3325 pgoff_t end_pgoff)
3326{
3327 return next_uptodate_page(xas_find(xas, end_pgoff),
3328 mapping, xas, end_pgoff);
3329}
3330
3331static inline struct page *next_map_page(struct address_space *mapping,
3332 struct xa_state *xas,
3333 pgoff_t end_pgoff)
3334{
3335 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3336 mapping, xas, end_pgoff);
3337}
3338
3339vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3340 pgoff_t start_pgoff, pgoff_t end_pgoff)
3341{
3342 struct vm_area_struct *vma = vmf->vma;
3343 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003344 struct address_space *mapping = file->f_mapping;
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003345 pgoff_t last_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003346 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003347 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003348 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003349 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003350 vm_fault_t ret = (vmf->flags & FAULT_FLAG_SPECULATIVE) ?
3351 VM_FAULT_RETRY : 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003352
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003353 /* filemap_map_pages() is called within an rcu read lock already. */
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003354 head = first_map_page(mapping, &xas, end_pgoff);
3355 if (!head)
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003356 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003357
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003358 if (!(vmf->flags & FAULT_FLAG_SPECULATIVE) &&
3359 filemap_map_pmd(vmf, head))
3360 return VM_FAULT_NOPAGE;
3361
3362 if (!pte_map_lock(vmf)) {
3363 unlock_page(head);
3364 put_page(head);
3365 return VM_FAULT_RETRY;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003366 }
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003367 addr = vmf->address;
3368 last_pgoff = vmf->pgoff;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003369
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003370 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003371 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003372 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003373 goto unlock;
3374
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003375 if (mmap_miss > 0)
3376 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003377
Will Deacon9d3af4b2021-01-14 15:24:19 +00003378 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003379 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003380 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003381
3382 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003383 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003384
Will Deacon46bdb422020-11-24 18:48:26 +00003385 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003386 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003387 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003388
Will Deacon9d3af4b2021-01-14 15:24:19 +00003389 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003390 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003391 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003392 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003393 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003394unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003395 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003396 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003397 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3398 pte_unmap_unlock(vmf->pte, vmf->ptl);
Michel Lespinasse4979ff32021-04-29 10:28:25 -07003399 vmf->pte = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003400 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003401 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003402}
3403EXPORT_SYMBOL(filemap_map_pages);
3404
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003405vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003406{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003407 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003408 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003409 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003410
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003411 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003412 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003413 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003414 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003415 unlock_page(page);
3416 ret = VM_FAULT_NOPAGE;
3417 goto out;
3418 }
Jan Kara14da9202012-06-12 16:20:37 +02003419 /*
3420 * We mark the page dirty already here so that when freeze is in
3421 * progress, we are guaranteed that writeback during freezing will
3422 * see the dirty page and writeprotect it again.
3423 */
3424 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003425 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003426out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003427 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003428 return ret;
3429}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003430
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003431const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003432 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003433 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003434 .page_mkwrite = filemap_page_mkwrite,
Michel Lespinassea2138fe2021-04-29 10:28:25 -07003435 .speculative = true,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003436};
3437
3438/* This is used for a general mmap of a disk file */
3439
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003440int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441{
3442 struct address_space *mapping = file->f_mapping;
3443
3444 if (!mapping->a_ops->readpage)
3445 return -ENOEXEC;
3446 file_accessed(file);
3447 vma->vm_ops = &generic_file_vm_ops;
3448 return 0;
3449}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003450
3451/*
3452 * This is for filesystems which do not implement ->writepage.
3453 */
3454int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3455{
3456 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3457 return -EINVAL;
3458 return generic_file_mmap(file, vma);
3459}
3460#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003461vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003462{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003463 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003464}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003465int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466{
3467 return -ENOSYS;
3468}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003469int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470{
3471 return -ENOSYS;
3472}
3473#endif /* CONFIG_MMU */
3474
Arnd Bergmann453972282018-04-13 15:35:27 -07003475EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003476EXPORT_SYMBOL(generic_file_mmap);
3477EXPORT_SYMBOL(generic_file_readonly_mmap);
3478
Sasha Levin67f9fd92014-04-03 14:48:18 -07003479static struct page *wait_on_page_read(struct page *page)
3480{
3481 if (!IS_ERR(page)) {
3482 wait_on_page_locked(page);
3483 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003484 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003485 page = ERR_PTR(-EIO);
3486 }
3487 }
3488 return page;
3489}
3490
Mel Gorman32b63522016-03-15 14:55:36 -07003491static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003492 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003493 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003494 void *data,
3495 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496{
Nick Piggineb2be182007-10-16 01:24:57 -07003497 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498 int err;
3499repeat:
3500 page = find_get_page(mapping, index);
3501 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003502 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003503 if (!page)
3504 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003505 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003506 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003507 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003508 if (err == -EEXIST)
3509 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003510 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003511 return ERR_PTR(err);
3512 }
Mel Gorman32b63522016-03-15 14:55:36 -07003513
3514filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003515 if (filler)
3516 err = filler(data, page);
3517 else
3518 err = mapping->a_ops->readpage(data, page);
3519
Linus Torvalds1da177e2005-04-16 15:20:36 -07003520 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003521 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003522 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003523 }
Mel Gorman32b63522016-03-15 14:55:36 -07003524
3525 page = wait_on_page_read(page);
3526 if (IS_ERR(page))
3527 return page;
3528 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003529 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003530 if (PageUptodate(page))
3531 goto out;
3532
Mel Gormanebded022016-03-15 14:55:39 -07003533 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003534 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003535 * case a: Page is being filled and the page lock is held
3536 * case b: Read/write error clearing the page uptodate status
3537 * case c: Truncation in progress (page locked)
3538 * case d: Reclaim in progress
3539 *
3540 * Case a, the page will be up to date when the page is unlocked.
3541 * There is no need to serialise on the page lock here as the page
3542 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003543 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003544 * it's a race vs truncate race.
3545 * Case b, the page will not be up to date
3546 * Case c, the page may be truncated but in itself, the data may still
3547 * be valid after IO completes as it's a read vs truncate race. The
3548 * operation must restart if the page is not uptodate on unlock but
3549 * otherwise serialising on page lock to stabilise the mapping gives
3550 * no additional guarantees to the caller as the page lock is
3551 * released before return.
3552 * Case d, similar to truncation. If reclaim holds the page lock, it
3553 * will be a race with remove_mapping that determines if the mapping
3554 * is valid on unlock but otherwise the data is valid and there is
3555 * no need to serialise with page lock.
3556 *
3557 * As the page lock gives no additional guarantee, we optimistically
3558 * wait on the page to be unlocked and check if it's up to date and
3559 * use the page if it is. Otherwise, the page lock is required to
3560 * distinguish between the different cases. The motivation is that we
3561 * avoid spurious serialisations and wakeups when multiple processes
3562 * wait on the same page for IO to complete.
3563 */
3564 wait_on_page_locked(page);
3565 if (PageUptodate(page))
3566 goto out;
3567
3568 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003569 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003570
3571 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003572 if (!page->mapping) {
3573 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003574 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003575 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003576 }
Mel Gormanebded022016-03-15 14:55:39 -07003577
3578 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003579 if (PageUptodate(page)) {
3580 unlock_page(page);
3581 goto out;
3582 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003583
3584 /*
3585 * A previous I/O error may have been due to temporary
3586 * failures.
3587 * Clear page error before actual read, PG_error will be
3588 * set again if read page fails.
3589 */
3590 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003591 goto filler;
3592
David Howellsc855ff32007-05-09 13:42:20 +01003593out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003594 mark_page_accessed(page);
3595 return page;
3596}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003597
3598/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003599 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003600 * @mapping: the page's address_space
3601 * @index: the page index
3602 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003603 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003604 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003605 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003606 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003607 *
3608 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003609 *
Jan Kara730633f2021-01-28 19:19:45 +01003610 * The function expects mapping->invalidate_lock to be already held.
3611 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003612 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003613 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003614struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003615 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003616 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003617 void *data)
3618{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003619 return do_read_cache_page(mapping, index, filler, data,
3620 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003621}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003622EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003623
3624/**
3625 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3626 * @mapping: the page's address_space
3627 * @index: the page index
3628 * @gfp: the page allocator flags to use if allocating
3629 *
3630 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003631 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003632 *
3633 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003634 *
Jan Kara730633f2021-01-28 19:19:45 +01003635 * The function expects mapping->invalidate_lock to be already held.
3636 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003637 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003638 */
3639struct page *read_cache_page_gfp(struct address_space *mapping,
3640 pgoff_t index,
3641 gfp_t gfp)
3642{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003643 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003644}
3645EXPORT_SYMBOL(read_cache_page_gfp);
3646
Nick Pigginafddba42007-10-16 01:25:01 -07003647int pagecache_write_begin(struct file *file, struct address_space *mapping,
3648 loff_t pos, unsigned len, unsigned flags,
3649 struct page **pagep, void **fsdata)
3650{
3651 const struct address_space_operations *aops = mapping->a_ops;
3652
Nick Piggin4e02ed42008-10-29 14:00:55 -07003653 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003654 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003655}
3656EXPORT_SYMBOL(pagecache_write_begin);
3657
3658int pagecache_write_end(struct file *file, struct address_space *mapping,
3659 loff_t pos, unsigned len, unsigned copied,
3660 struct page *page, void *fsdata)
3661{
3662 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003663
Nick Piggin4e02ed42008-10-29 14:00:55 -07003664 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003665}
3666EXPORT_SYMBOL(pagecache_write_end);
3667
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003668/*
3669 * Warn about a page cache invalidation failure during a direct I/O write.
3670 */
3671void dio_warn_stale_pagecache(struct file *filp)
3672{
3673 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3674 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003675 char *path;
3676
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003677 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003678 if (__ratelimit(&_rs)) {
3679 path = file_path(filp, pathname, sizeof(pathname));
3680 if (IS_ERR(path))
3681 path = "(unknown)";
3682 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3683 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3684 current->comm);
3685 }
3686}
3687
Linus Torvalds1da177e2005-04-16 15:20:36 -07003688ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003689generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003690{
3691 struct file *file = iocb->ki_filp;
3692 struct address_space *mapping = file->f_mapping;
3693 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003694 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003695 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003696 size_t write_len;
3697 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003698
Al Viro0c949332014-03-22 06:51:37 -04003699 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003700 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003701
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003702 if (iocb->ki_flags & IOCB_NOWAIT) {
3703 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003704 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003705 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003706 return -EAGAIN;
3707 } else {
3708 written = filemap_write_and_wait_range(mapping, pos,
3709 pos + write_len - 1);
3710 if (written)
3711 goto out;
3712 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003713
3714 /*
3715 * After a write we want buffered reads to be sure to go to disk to get
3716 * the new data. We invalidate clean cached page from the region we're
3717 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003718 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003719 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003720 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003721 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003722 /*
3723 * If a page can not be invalidated, return 0 to fall back
3724 * to buffered write.
3725 */
3726 if (written) {
3727 if (written == -EBUSY)
3728 return 0;
3729 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003730 }
3731
Al Viro639a93a52017-04-13 14:10:15 -04003732 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003733
3734 /*
3735 * Finally, try again to invalidate clean pages which might have been
3736 * cached by non-direct readahead, or faulted in by get_user_pages()
3737 * if the source of the write was an mmap'ed region of the file
3738 * we're writing. Either one is a pretty crazy thing to do,
3739 * so we don't support it 100%. If this invalidation
3740 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003741 *
3742 * Most of the time we do not need this since dio_complete() will do
3743 * the invalidation for us. However there are some file systems that
3744 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003745 * them by removing it completely.
3746 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003747 * Noticeable example is a blkdev_direct_IO().
3748 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003749 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003750 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003751 if (written > 0 && mapping->nrpages &&
3752 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3753 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003754
Linus Torvalds1da177e2005-04-16 15:20:36 -07003755 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003756 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003757 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003758 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3759 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003760 mark_inode_dirty(inode);
3761 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003762 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003763 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003764 if (written != -EIOCBQUEUED)
3765 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003766out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003767 return written;
3768}
3769EXPORT_SYMBOL(generic_file_direct_write);
3770
Nick Piggineb2be182007-10-16 01:24:57 -07003771/*
3772 * Find or create a page at the given pagecache position. Return the locked
3773 * page. This function is specifically for buffered writes.
3774 */
Nick Piggin54566b22009-01-04 12:00:53 -08003775struct page *grab_cache_page_write_begin(struct address_space *mapping,
3776 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003777{
Nick Piggineb2be182007-10-16 01:24:57 -07003778 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003779 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003780
Nick Piggin54566b22009-01-04 12:00:53 -08003781 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003782 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003783
Mel Gorman2457aec2014-06-04 16:10:31 -07003784 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003785 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003786 if (page)
3787 wait_for_stable_page(page);
3788
Nick Piggineb2be182007-10-16 01:24:57 -07003789 return page;
3790}
Nick Piggin54566b22009-01-04 12:00:53 -08003791EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003792
Al Viro3b93f912014-02-11 21:34:08 -05003793ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003794 struct iov_iter *i, loff_t pos)
3795{
3796 struct address_space *mapping = file->f_mapping;
3797 const struct address_space_operations *a_ops = mapping->a_ops;
3798 long status = 0;
3799 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003800 unsigned int flags = 0;
3801
Nick Pigginafddba42007-10-16 01:25:01 -07003802 do {
3803 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003804 unsigned long offset; /* Offset into pagecache page */
3805 unsigned long bytes; /* Bytes to write to page */
3806 size_t copied; /* Bytes copied from user */
3807 void *fsdata;
3808
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003809 offset = (pos & (PAGE_SIZE - 1));
3810 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003811 iov_iter_count(i));
3812
3813again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003814 /*
3815 * Bring in the user page that we will copy from _first_.
3816 * Otherwise there's a nasty deadlock on copying from the
3817 * same page as we're writing to, without it being marked
3818 * up-to-date.
Linus Torvalds00a3d662015-10-07 08:32:38 +01003819 */
Andreas Gruenbacher30e66b12022-04-15 06:28:40 +08003820 if (unlikely(fault_in_iov_iter_readable(i, bytes))) {
Linus Torvalds00a3d662015-10-07 08:32:38 +01003821 status = -EFAULT;
3822 break;
3823 }
3824
Jan Kara296291c2015-10-22 13:32:21 -07003825 if (fatal_signal_pending(current)) {
3826 status = -EINTR;
3827 break;
3828 }
3829
Nick Piggin674b8922007-10-16 01:25:03 -07003830 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003831 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003832 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003833 break;
3834
anfei zhou931e80e2010-02-02 13:44:02 -08003835 if (mapping_writably_mapped(mapping))
3836 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003837
Al Virof0b65f32021-04-30 10:26:41 -04003838 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
Nick Pigginafddba42007-10-16 01:25:01 -07003839 flush_dcache_page(page);
3840
3841 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3842 page, fsdata);
Al Virof0b65f32021-04-30 10:26:41 -04003843 if (unlikely(status != copied)) {
3844 iov_iter_revert(i, copied - max(status, 0L));
3845 if (unlikely(status < 0))
3846 break;
3847 }
Nick Pigginafddba42007-10-16 01:25:01 -07003848 cond_resched();
3849
Al Virobc1bb412021-05-31 00:32:44 -04003850 if (unlikely(status == 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07003851 /*
Al Virobc1bb412021-05-31 00:32:44 -04003852 * A short copy made ->write_end() reject the
3853 * thing entirely. Might be memory poisoning
3854 * halfway through, might be a race with munmap,
3855 * might be severe memory pressure.
Nick Pigginafddba42007-10-16 01:25:01 -07003856 */
Al Virobc1bb412021-05-31 00:32:44 -04003857 if (copied)
3858 bytes = copied;
Nick Pigginafddba42007-10-16 01:25:01 -07003859 goto again;
3860 }
Al Virof0b65f32021-04-30 10:26:41 -04003861 pos += status;
3862 written += status;
Nick Pigginafddba42007-10-16 01:25:01 -07003863
3864 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003865 } while (iov_iter_count(i));
3866
3867 return written ? written : status;
3868}
Al Viro3b93f912014-02-11 21:34:08 -05003869EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003870
Jan Karae4dd9de2009-08-17 18:10:06 +02003871/**
Al Viro81742022014-04-03 03:17:43 -04003872 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003873 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003874 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003875 *
3876 * This function does all the work needed for actually writing data to a
3877 * file. It does all basic checks, removes SUID from the file, updates
3878 * modification times and calls proper subroutines depending on whether we
3879 * do direct IO or a standard buffered write.
3880 *
Jan Kara96087032021-04-12 15:50:21 +02003881 * It expects i_rwsem to be grabbed unless we work on a block device or similar
Jan Karae4dd9de2009-08-17 18:10:06 +02003882 * object which does not need locking at all.
3883 *
3884 * This function does *not* take care of syncing data in case of O_SYNC write.
3885 * A caller has to handle it. This is mainly due to the fact that we want to
Jan Kara96087032021-04-12 15:50:21 +02003886 * avoid syncing under i_rwsem.
Mike Rapoporta862f682019-03-05 15:48:42 -08003887 *
3888 * Return:
3889 * * number of bytes written, even for truncated writes
3890 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003891 */
Al Viro81742022014-04-03 03:17:43 -04003892ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003893{
3894 struct file *file = iocb->ki_filp;
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003895 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003896 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003897 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003898 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003899 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003900
Linus Torvalds1da177e2005-04-16 15:20:36 -07003901 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003902 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003903 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003904 if (err)
3905 goto out;
3906
Josef Bacikc3b2da32012-03-26 09:59:21 -04003907 err = file_update_time(file);
3908 if (err)
3909 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003910
Al Viro2ba48ce2015-04-09 13:52:01 -04003911 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003912 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003913
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003914 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003915 /*
3916 * If the write stopped short of completing, fall back to
3917 * buffered writes. Some filesystems do this for writes to
3918 * holes, for example. For DAX files, a buffered write will
3919 * not succeed (even if it did, DAX does not handle dirty
3920 * page-cache pages correctly).
3921 */
Al Viro0b8def92015-04-07 10:22:53 -04003922 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003923 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003924
Al Viro0b8def92015-04-07 10:22:53 -04003925 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003926 /*
Al Viro3b93f912014-02-11 21:34:08 -05003927 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003928 * then we want to return the number of bytes which were
3929 * direct-written, or the error code if that was zero. Note
3930 * that this differs from normal direct-io semantics, which
3931 * will return -EFOO even if some bytes were written.
3932 */
Al Viro60bb4522014-08-08 12:39:16 -04003933 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003934 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003935 goto out;
3936 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003937 /*
3938 * We need to ensure that the page cache pages are written to
3939 * disk and invalidated to preserve the expected O_DIRECT
3940 * semantics.
3941 */
Al Viro3b93f912014-02-11 21:34:08 -05003942 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003943 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003944 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003945 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003946 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003947 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003948 pos >> PAGE_SHIFT,
3949 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003950 } else {
3951 /*
3952 * We don't know how much we wrote, so just return
3953 * the number of bytes which were direct-written
3954 */
3955 }
3956 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003957 written = generic_perform_write(file, from, iocb->ki_pos);
3958 if (likely(written > 0))
3959 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003960 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003961out:
3962 current->backing_dev_info = NULL;
3963 return written ? written : err;
3964}
Al Viro81742022014-04-03 03:17:43 -04003965EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003966
Jan Karae4dd9de2009-08-17 18:10:06 +02003967/**
Al Viro81742022014-04-03 03:17:43 -04003968 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003969 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003970 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003971 *
Al Viro81742022014-04-03 03:17:43 -04003972 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003973 * filesystems. It takes care of syncing the file in case of O_SYNC file
Jan Kara96087032021-04-12 15:50:21 +02003974 * and acquires i_rwsem as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003975 * Return:
3976 * * negative error code if no data has been written at all of
3977 * vfs_fsync_range() failed for a synchronous write
3978 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003979 */
Al Viro81742022014-04-03 03:17:43 -04003980ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003981{
3982 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003983 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003984 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003985
Al Viro59551022016-01-22 15:40:57 -05003986 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003987 ret = generic_write_checks(iocb, from);
3988 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003989 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003990 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003991
Christoph Hellwige2592212016-04-07 08:52:01 -07003992 if (ret > 0)
3993 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003994 return ret;
3995}
Al Viro81742022014-04-03 03:17:43 -04003996EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003997
David Howellscf9a2ae2006-08-29 19:05:54 +01003998/**
3999 * try_to_release_page() - release old fs-specific metadata on a page
4000 *
4001 * @page: the page which the kernel is trying to free
4002 * @gfp_mask: memory allocation flags (and I/O mode)
4003 *
4004 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08004005 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01004006 *
David Howells266cf652009-04-03 16:42:36 +01004007 * This may also be called if PG_fscache is set on a page, indicating that the
4008 * page is known to the local caching routines.
4009 *
David Howellscf9a2ae2006-08-29 19:05:54 +01004010 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08004011 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01004012 *
Mike Rapoporta862f682019-03-05 15:48:42 -08004013 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01004014 */
4015int try_to_release_page(struct page *page, gfp_t gfp_mask)
4016{
4017 struct address_space * const mapping = page->mapping;
4018
4019 BUG_ON(!PageLocked(page));
4020 if (PageWriteback(page))
4021 return 0;
4022
4023 if (mapping && mapping->a_ops->releasepage)
4024 return mapping->a_ops->releasepage(page, gfp_mask);
4025 return try_to_free_buffers(page);
4026}
4027
4028EXPORT_SYMBOL(try_to_release_page);