blob: 655c9eec06b387f5e6c54e7b8d1f22e6cf79711b [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>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080034#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070035#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080036#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060037#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080038#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070039#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070040#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070041#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070042#include <linux/ramfs.h>
Yang Shib9306a72020-08-06 23:19:55 -070043#include <linux/page_idle.h>
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +030044#include <asm/pgalloc.h>
Will Deaconde591a82021-02-10 11:15:11 +000045#include <asm/tlbflush.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080046#include "internal.h"
47
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070048#define CREATE_TRACE_POINTS
49#include <trace/events/filemap.h>
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070052 * FIXME: remove all knowledge of the buffer layer from the core VM
53 */
Jan Kara148f9482009-08-17 19:52:36 +020054#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#include <asm/mman.h>
57
58/*
59 * Shared mappings implemented 30.11.1994. It's not fully working yet,
60 * though.
61 *
62 * Shared mappings now work. 15.8.1995 Bruno.
63 *
64 * finished 'unifying' the page and buffer cache and SMP-threaded the
65 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
66 *
67 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
68 */
69
70/*
71 * Lock ordering:
72 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080073 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070075 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070076 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 *
Jan Kara96087032021-04-12 15:50:21 +020078 * ->i_rwsem
Jan Kara730633f2021-01-28 19:19:45 +010079 * ->invalidate_lock (acquired by fs in truncate path)
80 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070082 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080083 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070084 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070085 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070087 * ->mmap_lock
Jan Kara730633f2021-01-28 19:19:45 +010088 * ->invalidate_lock (filemap_fault)
89 * ->lock_page (filemap_fault, access_process_vm)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 *
Jan Kara96087032021-04-12 15:50:21 +020091 * ->i_rwsem (generic_perform_write)
Andreas Gruenbacherbb523b42021-08-02 13:44:20 +020092 * ->mmap_lock (fault_in_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060094 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110095 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070096 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080098 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 * ->anon_vma.lock (vma_adjust)
100 *
101 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700102 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700104 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700105 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700107 * ->i_pages lock (try_to_unmap_one)
Hugh Dickins15b44732020-12-15 14:21:31 -0800108 * ->lruvec->lru_lock (follow_page->mark_page_accessed)
109 * ->lruvec->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700111 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600112 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100113 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700114 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600115 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100116 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
118 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800119 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700120 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 */
122
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500123static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700124 struct page *page, void *shadow)
125{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500126 XA_STATE(xas, &mapping->i_pages, page->index);
127 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800128
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500129 mapping_set_update(&xas, mapping);
130
131 /* hugetlb pages are represented by a single entry in the xarray */
132 if (!PageHuge(page)) {
133 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700134 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500135 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700136
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700137 VM_BUG_ON_PAGE(!PageLocked(page), page);
138 VM_BUG_ON_PAGE(PageTail(page), page);
139 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700140
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500141 xas_store(&xas, shadow);
142 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200143
Jan Kara23006382017-11-15 17:37:26 -0800144 page->mapping = NULL;
145 /* Leave page->index set: truncation lookup relies upon it */
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200146 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700147}
148
Jan Kara5ecc4d82017-11-15 17:37:29 -0800149static void unaccount_page_cache_page(struct address_space *mapping,
150 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800152 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600154 /*
155 * if we're uptodate, flush out into the cleancache, otherwise
156 * invalidate any existing cleancache entries. We can't leave
157 * stale data around in the cleancache once our page is gone
158 */
159 if (PageUptodate(page) && PageMappedToDisk(page))
160 cleancache_put_page(page);
161 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400162 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600163
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700164 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800165 VM_BUG_ON_PAGE(page_mapped(page), page);
166 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
167 int mapcount;
168
169 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
170 current->comm, page_to_pfn(page));
171 dump_page(page, "still mapped when deleted");
172 dump_stack();
173 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
174
175 mapcount = page_mapcount(page);
176 if (mapping_exiting(mapping) &&
177 page_count(page) >= mapcount + 2) {
178 /*
179 * All vmas have already been torn down, so it's
180 * a good bet that actually the page is unmapped,
181 * and we'd prefer not to leak it: if we're wrong,
182 * some other bad page check should catch it later.
183 */
184 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700185 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800186 }
187 }
188
Jan Kara76253fb2017-11-15 17:37:22 -0800189 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800190 if (PageHuge(page))
191 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800192
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700193 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800194
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700195 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800196 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700197 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800198 if (PageTransHuge(page))
Muchun Song57b28472021-02-24 12:03:31 -0800199 __mod_lruvec_page_state(page, NR_SHMEM_THPS, -nr);
Song Liu99cb0db2019-09-23 15:38:00 -0700200 } else if (PageTransHuge(page)) {
Muchun Songbf9ecea2021-02-24 12:03:27 -0800201 __mod_lruvec_page_state(page, NR_FILE_THPS, -nr);
Song Liu09d91cd2019-09-23 15:38:03 -0700202 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800203 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800204
205 /*
206 * At this point page must be either written or cleaned by
207 * truncate. Dirty page here signals a bug and loss of
208 * unwritten data.
209 *
210 * This fixes dirty accounting after removing the page entirely
211 * but leaves PageDirty set: it has no effect for truncated
212 * page and anyway will be cleared before returning page into
213 * buddy allocator.
214 */
215 if (WARN_ON_ONCE(PageDirty(page)))
216 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
217}
218
219/*
220 * Delete a page from the page cache and free it. Caller has to make
221 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700222 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800223 */
224void __delete_from_page_cache(struct page *page, void *shadow)
225{
226 struct address_space *mapping = page->mapping;
227
228 trace_mm_filemap_delete_from_page_cache(page);
229
230 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500231 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232}
233
Jan Kara59c66c52017-11-15 17:37:18 -0800234static void page_cache_free_page(struct address_space *mapping,
235 struct page *page)
236{
237 void (*freepage)(struct page *);
238
239 freepage = mapping->a_ops->freepage;
240 if (freepage)
241 freepage(page);
242
243 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700244 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800245 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
246 } else {
247 put_page(page);
248 }
249}
250
Minchan Kim702cfbf2011-03-22 16:32:43 -0700251/**
252 * delete_from_page_cache - delete page from page cache
253 * @page: the page which the kernel is trying to remove from page cache
254 *
255 * This must be called only on pages that have been verified to be in the page
256 * cache and locked. It will never put the page into the free list, the caller
257 * has a reference on the page.
258 */
259void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700261 struct address_space *mapping = page_mapping(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Matt Mackallcd7619d2005-05-01 08:59:01 -0700263 BUG_ON(!PageLocked(page));
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800264 spin_lock(&mapping->host->i_lock);
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);
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800268 if (mapping_shrinkable(mapping))
269 inode_add_lru(mapping->host);
270 spin_unlock(&mapping->host->i_lock);
Linus Torvalds6072d132010-12-01 13:35:19 -0500271
Jan Kara59c66c52017-11-15 17:37:18 -0800272 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700273}
274EXPORT_SYMBOL(delete_from_page_cache);
275
Jan Karaaa65c292017-11-15 17:37:33 -0800276/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500277 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800278 * @mapping: the mapping to which pages belong
279 * @pvec: pagevec with pages to delete
280 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700281 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700282 * from the mapping. The function expects @pvec to be sorted by page index
283 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700284 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800285 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700286 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800287 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700288 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800289 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500290static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800291 struct pagevec *pvec)
292{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500293 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800294 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700295 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800296 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800297
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500298 mapping_set_update(&xas, mapping);
299 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700300 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800301 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700302
303 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400304 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800305 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700306 /*
307 * A page got inserted in our range? Skip it. We have our
308 * pages locked so they are protected from being removed.
309 * If we see a page whose index is higher than ours, it
310 * means our page has been removed, which shouldn't be
311 * possible because we're holding the PageLock.
312 */
313 if (page != pvec->pages[i]) {
314 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
315 page);
316 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700317 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700318
319 WARN_ON_ONCE(!PageLocked(page));
320
321 if (page->index == xas.xa_index)
322 page->mapping = NULL;
323 /* Leave page->index set: truncation lookup relies on it */
324
325 /*
326 * Move to the next page in the vector if this is a regular
327 * page or the index is of the last sub-page of this compound
328 * page.
329 */
330 if (page->index + compound_nr(page) - 1 == xas.xa_index)
331 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500332 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800333 total_pages++;
334 }
335 mapping->nrpages -= total_pages;
336}
337
338void delete_from_page_cache_batch(struct address_space *mapping,
339 struct pagevec *pvec)
340{
341 int i;
Jan Karaaa65c292017-11-15 17:37:33 -0800342
343 if (!pagevec_count(pvec))
344 return;
345
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800346 spin_lock(&mapping->host->i_lock);
Johannes Weiner30472502021-09-02 14:53:18 -0700347 xa_lock_irq(&mapping->i_pages);
Jan Karaaa65c292017-11-15 17:37:33 -0800348 for (i = 0; i < pagevec_count(pvec); i++) {
349 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
350
351 unaccount_page_cache_page(mapping, pvec->pages[i]);
352 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500353 page_cache_delete_batch(mapping, pvec);
Johannes Weiner30472502021-09-02 14:53:18 -0700354 xa_unlock_irq(&mapping->i_pages);
Johannes Weiner51b8c1f2021-11-08 18:31:24 -0800355 if (mapping_shrinkable(mapping))
356 inode_add_lru(mapping->host);
357 spin_unlock(&mapping->host->i_lock);
Jan Karaaa65c292017-11-15 17:37:33 -0800358
359 for (i = 0; i < pagevec_count(pvec); i++)
360 page_cache_free_page(mapping, pvec->pages[i]);
361}
362
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200363int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700364{
365 int ret = 0;
366 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700367 if (test_bit(AS_ENOSPC, &mapping->flags) &&
368 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700369 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700370 if (test_bit(AS_EIO, &mapping->flags) &&
371 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700372 ret = -EIO;
373 return ret;
374}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200375EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700376
Jeff Layton76341ca2017-07-06 07:02:22 -0400377static int filemap_check_and_keep_errors(struct address_space *mapping)
378{
379 /* Check for outstanding write errors */
380 if (test_bit(AS_EIO, &mapping->flags))
381 return -EIO;
382 if (test_bit(AS_ENOSPC, &mapping->flags))
383 return -ENOSPC;
384 return 0;
385}
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387/**
Josef Bacik5a798492021-07-14 14:47:22 -0400388 * filemap_fdatawrite_wbc - start writeback on mapping dirty pages in range
389 * @mapping: address space structure to write
390 * @wbc: the writeback_control controlling the writeout
391 *
392 * Call writepages on the mapping using the provided wbc to control the
393 * writeout.
394 *
395 * Return: %0 on success, negative error code otherwise.
396 */
397int filemap_fdatawrite_wbc(struct address_space *mapping,
398 struct writeback_control *wbc)
399{
400 int ret;
401
402 if (!mapping_can_writeback(mapping) ||
403 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
404 return 0;
405
406 wbc_attach_fdatawrite_inode(wbc, mapping->host);
407 ret = do_writepages(mapping, wbc);
408 wbc_detach_inode(wbc);
409 return ret;
410}
411EXPORT_SYMBOL(filemap_fdatawrite_wbc);
412
413/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700414 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700415 * @mapping: address space structure to write
416 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800417 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700418 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700420 * Start writeback against all of a mapping's dirty pages that lie
421 * within the byte offsets <start, end> inclusive.
422 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700424 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 * these two operations is that if a dirty page/buffer is encountered, it must
426 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800427 *
428 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800430int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
431 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 struct writeback_control wbc = {
434 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800435 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700436 .range_start = start,
437 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 };
439
Josef Bacik5a798492021-07-14 14:47:22 -0400440 return filemap_fdatawrite_wbc(mapping, &wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441}
442
443static inline int __filemap_fdatawrite(struct address_space *mapping,
444 int sync_mode)
445{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700446 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447}
448
449int filemap_fdatawrite(struct address_space *mapping)
450{
451 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
452}
453EXPORT_SYMBOL(filemap_fdatawrite);
454
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400455int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800456 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457{
458 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
459}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400460EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Randy Dunlap485bb992006-06-23 02:03:49 -0700462/**
463 * filemap_flush - mostly a non-blocking flush
464 * @mapping: target address_space
465 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 * This is a mostly non-blocking flush. Not suitable for data-integrity
467 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800468 *
469 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 */
471int filemap_flush(struct address_space *mapping)
472{
473 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
474}
475EXPORT_SYMBOL(filemap_flush);
476
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500477/**
478 * filemap_range_has_page - check if a page exists in range.
479 * @mapping: address space within which to check
480 * @start_byte: offset in bytes where the range starts
481 * @end_byte: offset in bytes where the range ends (inclusive)
482 *
483 * Find at least one page in the range supplied, usually used to check if
484 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800485 *
486 * Return: %true if at least one page exists in the specified range,
487 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500488 */
489bool filemap_range_has_page(struct address_space *mapping,
490 loff_t start_byte, loff_t end_byte)
491{
Jan Karaf7b68042017-09-06 16:21:40 -0700492 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500493 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
494 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500495
496 if (end_byte < start_byte)
497 return false;
498
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500499 rcu_read_lock();
500 for (;;) {
501 page = xas_find(&xas, max);
502 if (xas_retry(&xas, page))
503 continue;
504 /* Shadow entries don't count */
505 if (xa_is_value(page))
506 continue;
507 /*
508 * We don't need to try to pin this page; we're about to
509 * release the RCU lock anyway. It is enough to know that
510 * there was a page here recently.
511 */
512 break;
513 }
514 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500515
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500516 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500517}
518EXPORT_SYMBOL(filemap_range_has_page);
519
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400520static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800521 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300523 pgoff_t index = start_byte >> PAGE_SHIFT;
524 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 struct pagevec pvec;
526 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200528 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400529 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Mel Gorman86679822017-11-15 17:37:52 -0800531 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800532 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 unsigned i;
534
Jan Kara312e9d22017-11-15 17:35:05 -0800535 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800536 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800537 if (!nr_pages)
538 break;
539
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 for (i = 0; i < nr_pages; i++) {
541 struct page *page = pvec.pages[i];
542
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400544 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 }
546 pagevec_release(&pvec);
547 cond_resched();
548 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800549}
550
551/**
552 * filemap_fdatawait_range - wait for writeback to complete
553 * @mapping: address space structure to wait for
554 * @start_byte: offset in bytes where the range starts
555 * @end_byte: offset in bytes where the range ends (inclusive)
556 *
557 * Walk the list of under-writeback pages of the given address space
558 * in the given range and wait for all of them. Check error status of
559 * the address space and return it.
560 *
561 * Since the error status of the address space is cleared by this function,
562 * callers are responsible for checking the return value and handling and/or
563 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800564 *
565 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800566 */
567int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
568 loff_t end_byte)
569{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400570 __filemap_fdatawait_range(mapping, start_byte, end_byte);
571 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200573EXPORT_SYMBOL(filemap_fdatawait_range);
574
575/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400576 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
577 * @mapping: address space structure to wait for
578 * @start_byte: offset in bytes where the range starts
579 * @end_byte: offset in bytes where the range ends (inclusive)
580 *
581 * Walk the list of under-writeback pages of the given address space in the
582 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
583 * this function does not clear error status of the address space.
584 *
585 * Use this function if callers don't handle errors themselves. Expected
586 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
587 * fsfreeze(8)
588 */
589int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
590 loff_t start_byte, loff_t end_byte)
591{
592 __filemap_fdatawait_range(mapping, start_byte, end_byte);
593 return filemap_check_and_keep_errors(mapping);
594}
595EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
596
597/**
Jeff Laytona823e452017-07-28 07:24:43 -0400598 * file_fdatawait_range - wait for writeback to complete
599 * @file: file pointing to address space structure to wait for
600 * @start_byte: offset in bytes where the range starts
601 * @end_byte: offset in bytes where the range ends (inclusive)
602 *
603 * Walk the list of under-writeback pages of the address space that file
604 * refers to, in the given range and wait for all of them. Check error
605 * status of the address space vs. the file->f_wb_err cursor and return it.
606 *
607 * Since the error status of the file is advanced by this function,
608 * callers are responsible for checking the return value and handling and/or
609 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800610 *
611 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400612 */
613int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
614{
615 struct address_space *mapping = file->f_mapping;
616
617 __filemap_fdatawait_range(mapping, start_byte, end_byte);
618 return file_check_and_advance_wb_err(file);
619}
620EXPORT_SYMBOL(file_fdatawait_range);
621
622/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800623 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
624 * @mapping: address space structure to wait for
625 *
626 * Walk the list of under-writeback pages of the given address space
627 * and wait for all of them. Unlike filemap_fdatawait(), this function
628 * does not clear error status of the address space.
629 *
630 * Use this function if callers don't handle errors themselves. Expected
631 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
632 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800633 *
634 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800635 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400636int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800637{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400638 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400639 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800640}
Jeff Layton76341ca2017-07-06 07:02:22 -0400641EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800642
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700643/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400644static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700646 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Jens Axboe4bdcd1d2021-10-28 08:47:05 -0600649bool filemap_range_has_writeback(struct address_space *mapping,
650 loff_t start_byte, loff_t end_byte)
Jens Axboef8ee8902021-11-05 13:37:13 -0700651{
652 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
653 pgoff_t max = end_byte >> PAGE_SHIFT;
654 struct page *page;
655
656 if (end_byte < start_byte)
657 return false;
658
659 rcu_read_lock();
660 xas_for_each(&xas, page, max) {
661 if (xas_retry(&xas, page))
662 continue;
663 if (xa_is_value(page))
664 continue;
665 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
666 break;
667 }
668 rcu_read_unlock();
669 return page != NULL;
Jens Axboef8ee8902021-11-05 13:37:13 -0700670}
Jens Axboe4bdcd1d2021-10-28 08:47:05 -0600671EXPORT_SYMBOL_GPL(filemap_range_has_writeback);
Jens Axboe63135aa2021-04-29 22:55:18 -0700672
673/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700674 * filemap_write_and_wait_range - write out & wait on a file range
675 * @mapping: the address_space for the pages
676 * @lstart: offset in bytes where the range starts
677 * @lend: offset in bytes where the range ends (inclusive)
678 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800679 * Write out and wait upon file offsets lstart->lend, inclusive.
680 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300681 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800682 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800683 *
684 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800685 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686int filemap_write_and_wait_range(struct address_space *mapping,
687 loff_t lstart, loff_t lend)
688{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800689 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690
Jeff Layton9326c9b2017-07-26 10:21:11 -0400691 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800692 err = __filemap_fdatawrite_range(mapping, lstart, lend,
693 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800694 /*
695 * Even if the above returned error, the pages may be
696 * written partially (e.g. -ENOSPC), so we wait for it.
697 * But the -EIO is special case, it may indicate the worst
698 * thing (e.g. bug) happened, so we avoid waiting for it.
699 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800700 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200701 int err2 = filemap_fdatawait_range(mapping,
702 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800703 if (!err)
704 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400705 } else {
706 /* Clear any previously stored errors */
707 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800708 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700709 } else {
710 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800712 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713}
Chris Masonf6995582009-04-15 13:22:37 -0400714EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715
Jeff Layton5660e132017-07-06 07:02:25 -0400716void __filemap_set_wb_err(struct address_space *mapping, int err)
717{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400718 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400719
720 trace_filemap_set_wb_err(mapping, eseq);
721}
722EXPORT_SYMBOL(__filemap_set_wb_err);
723
724/**
725 * file_check_and_advance_wb_err - report wb error (if any) that was previously
726 * and advance wb_err to current one
727 * @file: struct file on which the error is being reported
728 *
729 * When userland calls fsync (or something like nfsd does the equivalent), we
730 * want to report any writeback errors that occurred since the last fsync (or
731 * since the file was opened if there haven't been any).
732 *
733 * Grab the wb_err from the mapping. If it matches what we have in the file,
734 * then just quickly return 0. The file is all caught up.
735 *
736 * If it doesn't match, then take the mapping value, set the "seen" flag in
737 * it and try to swap it into place. If it works, or another task beat us
738 * to it with the new value, then update the f_wb_err and return the error
739 * portion. The error at this point must be reported via proper channels
740 * (a'la fsync, or NFS COMMIT operation, etc.).
741 *
742 * While we handle mapping->wb_err with atomic operations, the f_wb_err
743 * value is protected by the f_lock since we must ensure that it reflects
744 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800745 *
746 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400747 */
748int file_check_and_advance_wb_err(struct file *file)
749{
750 int err = 0;
751 errseq_t old = READ_ONCE(file->f_wb_err);
752 struct address_space *mapping = file->f_mapping;
753
754 /* Locklessly handle the common case where nothing has changed */
755 if (errseq_check(&mapping->wb_err, old)) {
756 /* Something changed, must use slow path */
757 spin_lock(&file->f_lock);
758 old = file->f_wb_err;
759 err = errseq_check_and_advance(&mapping->wb_err,
760 &file->f_wb_err);
761 trace_file_check_and_advance_wb_err(file, old);
762 spin_unlock(&file->f_lock);
763 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700764
765 /*
766 * We're mostly using this function as a drop in replacement for
767 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
768 * that the legacy code would have had on these flags.
769 */
770 clear_bit(AS_EIO, &mapping->flags);
771 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400772 return err;
773}
774EXPORT_SYMBOL(file_check_and_advance_wb_err);
775
776/**
777 * file_write_and_wait_range - write out & wait on a file range
778 * @file: file pointing to address_space with pages
779 * @lstart: offset in bytes where the range starts
780 * @lend: offset in bytes where the range ends (inclusive)
781 *
782 * Write out and wait upon file offsets lstart->lend, inclusive.
783 *
784 * Note that @lend is inclusive (describes the last byte to be written) so
785 * that this function can be used to write to the very end-of-file (end = -1).
786 *
787 * After writing out and waiting on the data, we check and advance the
788 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800789 *
790 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400791 */
792int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
793{
794 int err = 0, err2;
795 struct address_space *mapping = file->f_mapping;
796
Jeff Layton9326c9b2017-07-26 10:21:11 -0400797 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400798 err = __filemap_fdatawrite_range(mapping, lstart, lend,
799 WB_SYNC_ALL);
800 /* See comment of filemap_write_and_wait() */
801 if (err != -EIO)
802 __filemap_fdatawait_range(mapping, lstart, lend);
803 }
804 err2 = file_check_and_advance_wb_err(file);
805 if (!err)
806 err = err2;
807 return err;
808}
809EXPORT_SYMBOL(file_write_and_wait_range);
810
Randy Dunlap485bb992006-06-23 02:03:49 -0700811/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700812 * replace_page_cache_page - replace a pagecache page with a new one
813 * @old: page to be replaced
814 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700815 *
816 * This function replaces a page in the pagecache with a new one. On
817 * success it acquires the pagecache reference for the new page and
818 * drops it for the old page. Both the old and new pages must be
819 * locked. This function does not add the new page to the LRU, the
820 * caller must do that.
821 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500822 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700823 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800824void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700825{
Matthew Wilcox (Oracle)d21bba22021-05-06 18:14:59 -0400826 struct folio *fold = page_folio(old);
827 struct folio *fnew = page_folio(new);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500828 struct address_space *mapping = old->mapping;
829 void (*freepage)(struct page *) = mapping->a_ops->freepage;
830 pgoff_t offset = old->index;
831 XA_STATE(xas, &mapping->i_pages, offset);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700832
Sasha Levin309381fea2014-01-23 15:52:54 -0800833 VM_BUG_ON_PAGE(!PageLocked(old), old);
834 VM_BUG_ON_PAGE(!PageLocked(new), new);
835 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700836
Matthew Wilcox74d60952017-11-17 10:01:45 -0500837 get_page(new);
838 new->mapping = mapping;
839 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700840
Matthew Wilcox (Oracle)d21bba22021-05-06 18:14:59 -0400841 mem_cgroup_migrate(fold, fnew);
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700842
Johannes Weiner30472502021-09-02 14:53:18 -0700843 xas_lock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500844 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700845
Matthew Wilcox74d60952017-11-17 10:01:45 -0500846 old->mapping = NULL;
847 /* hugetlb pages do not participate in page cache accounting. */
848 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700849 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500850 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700851 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500852 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700853 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500854 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700855 __inc_lruvec_page_state(new, NR_SHMEM);
Johannes Weiner30472502021-09-02 14:53:18 -0700856 xas_unlock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500857 if (freepage)
858 freepage(old);
859 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700860}
861EXPORT_SYMBOL_GPL(replace_page_cache_page);
862
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500863noinline int __filemap_add_folio(struct address_space *mapping,
864 struct folio *folio, pgoff_t index, gfp_t gfp, void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865{
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500866 XA_STATE(xas, &mapping->i_pages, index);
867 int huge = folio_test_hugetlb(folio);
Nick Piggine2867812008-07-25 19:45:30 -0700868 int error;
Waiman Longda742402021-02-04 18:32:45 -0800869 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700870
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500871 VM_BUG_ON_FOLIO(!folio_test_locked(folio), folio);
872 VM_BUG_ON_FOLIO(folio_test_swapbacked(folio), folio);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500873 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700874
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500875 folio_get(folio);
876 folio->mapping = mapping;
877 folio->index = index;
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700878
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700879 if (!huge) {
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500880 error = mem_cgroup_charge(folio, NULL, gfp);
881 VM_BUG_ON_FOLIO(index & (folio_nr_pages(folio) - 1), folio);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700882 if (error)
883 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800884 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700885 }
886
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700887 gfp &= GFP_RECLAIM_MASK;
888
Matthew Wilcox74d60952017-11-17 10:01:45 -0500889 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700890 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
891 void *entry, *old = NULL;
892
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500893 if (order > folio_order(folio))
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700894 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
895 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500896 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700897 xas_for_each_conflict(&xas, entry) {
898 old = entry;
899 if (!xa_is_value(entry)) {
900 xas_set_err(&xas, -EEXIST);
901 goto unlock;
902 }
903 }
904
905 if (old) {
906 if (shadowp)
907 *shadowp = old;
908 /* entry may have been split before we acquired lock */
909 order = xa_get_order(xas.xa, xas.xa_index);
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500910 if (order > folio_order(folio)) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700911 xas_split(&xas, old, order);
912 xas_reset(&xas);
913 }
914 }
915
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500916 xas_store(&xas, folio);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500917 if (xas_error(&xas))
918 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700919
Matthew Wilcox74d60952017-11-17 10:01:45 -0500920 mapping->nrpages++;
921
922 /* hugetlb pages do not participate in page cache accounting */
923 if (!huge)
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500924 __lruvec_stat_add_folio(folio, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500925unlock:
926 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700927 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500928
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700929 if (xas_error(&xas)) {
930 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800931 if (charged)
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500932 mem_cgroup_uncharge(folio);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500933 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700934 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500935
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500936 trace_mm_filemap_add_to_page_cache(&folio->page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700937 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500938error:
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500939 folio->mapping = NULL;
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700940 /* Leave page->index set: truncation relies upon it */
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500941 folio_put(folio);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700942 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943}
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500944ALLOW_ERROR_INJECTION(__filemap_add_folio, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700945
946/**
947 * add_to_page_cache_locked - add a locked page to the pagecache
948 * @page: page to add
949 * @mapping: the page's address_space
950 * @offset: page index
951 * @gfp_mask: page allocation mode
952 *
953 * This function is used to add a page to the pagecache. It must be locked.
954 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800955 *
956 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700957 */
958int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
959 pgoff_t offset, gfp_t gfp_mask)
960{
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500961 return __filemap_add_folio(mapping, page_folio(page), offset,
Johannes Weinera5289102014-04-03 14:47:51 -0700962 gfp_mask, NULL);
963}
Nick Piggine2867812008-07-25 19:45:30 -0700964EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500966int filemap_add_folio(struct address_space *mapping, struct folio *folio,
967 pgoff_t index, gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968{
Johannes Weinera5289102014-04-03 14:47:51 -0700969 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700970 int ret;
971
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500972 __folio_set_locked(folio);
973 ret = __filemap_add_folio(mapping, folio, index, gfp, &shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700974 if (unlikely(ret))
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500975 __folio_clear_locked(folio);
Johannes Weinera5289102014-04-03 14:47:51 -0700976 else {
977 /*
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500978 * The folio might have been evicted from cache only
Johannes Weinera5289102014-04-03 14:47:51 -0700979 * recently, in which case it should be activated like
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500980 * any other repeatedly accessed folio.
981 * The exception is folios getting rewritten; evicting other
Rik van Rielf0281a02016-05-20 16:56:25 -0700982 * data from the working set, only to cache data that will
983 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700984 */
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500985 WARN_ON_ONCE(folio_test_active(folio));
986 if (!(gfp & __GFP_WRITE) && shadow)
987 workingset_refault(folio, shadow);
988 folio_add_lru(folio);
Johannes Weinera5289102014-04-03 14:47:51 -0700989 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 return ret;
991}
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500992EXPORT_SYMBOL_GPL(filemap_add_folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993
Paul Jackson44110fe2006-03-24 03:16:04 -0800994#ifdef CONFIG_NUMA
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -0500995struct folio *filemap_alloc_folio(gfp_t gfp, unsigned int order)
Paul Jackson44110fe2006-03-24 03:16:04 -0800996{
Miao Xiec0ff7452010-05-24 14:32:08 -0700997 int n;
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -0500998 struct folio *folio;
Miao Xiec0ff7452010-05-24 14:32:08 -0700999
Paul Jackson44110fe2006-03-24 03:16:04 -08001000 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -07001001 unsigned int cpuset_mems_cookie;
1002 do {
Mel Gormand26914d2014-04-03 14:47:24 -07001003 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -07001004 n = cpuset_mem_spread_node();
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001005 folio = __folio_alloc_node(gfp, order, n);
1006 } while (!folio && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -07001007
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001008 return folio;
Paul Jackson44110fe2006-03-24 03:16:04 -08001009 }
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001010 return folio_alloc(gfp, order);
Paul Jackson44110fe2006-03-24 03:16:04 -08001011}
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001012EXPORT_SYMBOL(filemap_alloc_folio);
Paul Jackson44110fe2006-03-24 03:16:04 -08001013#endif
1014
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015/*
Jan Kara7506ae62021-05-24 13:02:30 +02001016 * filemap_invalidate_lock_two - lock invalidate_lock for two mappings
1017 *
1018 * Lock exclusively invalidate_lock of any passed mapping that is not NULL.
1019 *
1020 * @mapping1: the first mapping to lock
1021 * @mapping2: the second mapping to lock
1022 */
1023void filemap_invalidate_lock_two(struct address_space *mapping1,
1024 struct address_space *mapping2)
1025{
1026 if (mapping1 > mapping2)
1027 swap(mapping1, mapping2);
1028 if (mapping1)
1029 down_write(&mapping1->invalidate_lock);
1030 if (mapping2 && mapping1 != mapping2)
1031 down_write_nested(&mapping2->invalidate_lock, 1);
1032}
1033EXPORT_SYMBOL(filemap_invalidate_lock_two);
1034
1035/*
1036 * filemap_invalidate_unlock_two - unlock invalidate_lock for two mappings
1037 *
1038 * Unlock exclusive invalidate_lock of any passed mapping that is not NULL.
1039 *
1040 * @mapping1: the first mapping to unlock
1041 * @mapping2: the second mapping to unlock
1042 */
1043void filemap_invalidate_unlock_two(struct address_space *mapping1,
1044 struct address_space *mapping2)
1045{
1046 if (mapping1)
1047 up_write(&mapping1->invalidate_lock);
1048 if (mapping2 && mapping1 != mapping2)
1049 up_write(&mapping2->invalidate_lock);
1050}
1051EXPORT_SYMBOL(filemap_invalidate_unlock_two);
1052
1053/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 * In order to wait for pages to become available there must be
1055 * waitqueues associated with pages. By using a hash table of
1056 * waitqueues where the bucket discipline is to maintain all
1057 * waiters on the same queue and wake all when any of the pages
1058 * become available, and for the woken contexts to check to be
1059 * sure the appropriate page became available, this saves space
1060 * at a cost of "thundering herd" phenomena during rare hash
1061 * collisions.
1062 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001063#define PAGE_WAIT_TABLE_BITS 8
1064#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001065static wait_queue_head_t folio_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
Nicholas Piggin62906022016-12-25 13:00:30 +10001066
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001067static wait_queue_head_t *folio_waitqueue(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001069 return &folio_wait_table[hash_ptr(folio, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070}
Nicholas Piggin62906022016-12-25 13:00:30 +10001071
1072void __init pagecache_init(void)
1073{
1074 int i;
1075
1076 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001077 init_waitqueue_head(&folio_wait_table[i]);
Nicholas Piggin62906022016-12-25 13:00:30 +10001078
1079 page_writeback_init();
1080}
1081
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001082/*
1083 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001084 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001085 * one.
1086 *
1087 * We have:
1088 *
1089 * (a) no special bits set:
1090 *
1091 * We're just waiting for the bit to be released, and when a waker
1092 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1093 * and remove it from the wait queue.
1094 *
1095 * Simple and straightforward.
1096 *
1097 * (b) WQ_FLAG_EXCLUSIVE:
1098 *
1099 * The waiter is waiting to get the lock, and only one waiter should
1100 * be woken up to avoid any thundering herd behavior. We'll set the
1101 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1102 *
1103 * This is the traditional exclusive wait.
1104 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001105 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001106 *
1107 * The waiter is waiting to get the bit, and additionally wants the
1108 * lock to be transferred to it for fair lock behavior. If the lock
1109 * cannot be taken, we stop walking the wait queue without waking
1110 * the waiter.
1111 *
1112 * This is the "fair lock handoff" case, and in addition to setting
1113 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1114 * that it now has the lock.
1115 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001116static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001117{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001118 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001119 struct wait_page_key *key = arg;
1120 struct wait_page_queue *wait_page
1121 = container_of(wait, struct wait_page_queue, wait);
1122
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001123 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001124 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001125
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001126 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001127 * If it's a lock handoff wait, we get the bit for it, and
1128 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001129 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001130 flags = wait->flags;
1131 if (flags & WQ_FLAG_EXCLUSIVE) {
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001132 if (test_bit(key->bit_nr, &key->folio->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001133 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001134 if (flags & WQ_FLAG_CUSTOM) {
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001135 if (test_and_set_bit(key->bit_nr, &key->folio->flags))
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001136 return -1;
1137 flags |= WQ_FLAG_DONE;
1138 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001139 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001140
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001141 /*
1142 * We are holding the wait-queue lock, but the waiter that
1143 * is waiting for this will be checking the flags without
1144 * any locking.
1145 *
1146 * So update the flags atomically, and wake up the waiter
1147 * afterwards to avoid any races. This store-release pairs
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001148 * with the load-acquire in folio_wait_bit_common().
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001149 */
1150 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001151 wake_up_state(wait->private, mode);
1152
1153 /*
1154 * Ok, we have successfully done what we're waiting for,
1155 * and we can unconditionally remove the wait entry.
1156 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001157 * Note that this pairs with the "finish_wait()" in the
1158 * waiter, and has to be the absolute last thing we do.
1159 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001160 * might be de-allocated and the process might even have
1161 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001162 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001163 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001164 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001165}
1166
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001167static void folio_wake_bit(struct folio *folio, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001168{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001169 wait_queue_head_t *q = folio_waitqueue(folio);
Nicholas Piggin62906022016-12-25 13:00:30 +10001170 struct wait_page_key key;
1171 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001172 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001173
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001174 key.folio = folio;
Nicholas Piggin62906022016-12-25 13:00:30 +10001175 key.bit_nr = bit_nr;
1176 key.page_match = 0;
1177
Tim Chen11a19c72017-08-25 09:13:55 -07001178 bookmark.flags = 0;
1179 bookmark.private = NULL;
1180 bookmark.func = NULL;
1181 INIT_LIST_HEAD(&bookmark.entry);
1182
Nicholas Piggin62906022016-12-25 13:00:30 +10001183 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001184 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1185
1186 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1187 /*
1188 * Take a breather from holding the lock,
1189 * allow pages that finish wake up asynchronously
1190 * to acquire the lock and remove themselves
1191 * from wait queue
1192 */
1193 spin_unlock_irqrestore(&q->lock, flags);
1194 cpu_relax();
1195 spin_lock_irqsave(&q->lock, flags);
1196 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1197 }
1198
Nicholas Piggin62906022016-12-25 13:00:30 +10001199 /*
1200 * It is possible for other pages to have collided on the waitqueue
1201 * hash, so in that case check for a page match. That prevents a long-
1202 * term waiter
1203 *
1204 * It is still possible to miss a case here, when we woke page waiters
1205 * and removed them from the waitqueue, but there are still other
1206 * page waiters.
1207 */
1208 if (!waitqueue_active(q) || !key.page_match) {
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001209 folio_clear_waiters(folio);
Nicholas Piggin62906022016-12-25 13:00:30 +10001210 /*
1211 * It's possible to miss clearing Waiters here, when we woke
1212 * our page waiters, but the hashed waitqueue has waiters for
1213 * other pages on it.
1214 *
1215 * That's okay, it's a rare case. The next waker will clear it.
1216 */
1217 }
1218 spin_unlock_irqrestore(&q->lock, flags);
1219}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001220
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001221static void folio_wake(struct folio *folio, int bit)
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001222{
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001223 if (!folio_test_waiters(folio))
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001224 return;
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001225 folio_wake_bit(folio, bit);
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001226}
Nicholas Piggin62906022016-12-25 13:00:30 +10001227
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001228/*
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001229 * A choice of three behaviors for folio_wait_bit_common():
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001230 */
1231enum behavior {
1232 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001233 * __folio_lock() waiting on then setting PG_locked.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001234 */
1235 SHARED, /* Hold ref to page and check the bit when woken, like
1236 * wait_on_page_writeback() waiting on PG_writeback.
1237 */
1238 DROP, /* Drop ref to page before wait, no check when woken,
1239 * like put_and_wait_on_page_locked() on PG_locked.
1240 */
1241};
1242
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001243/*
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001244 * Attempt to check (or get) the folio flag, and mark us done
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001245 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001246 */
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001247static inline bool folio_trylock_flag(struct folio *folio, int bit_nr,
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001248 struct wait_queue_entry *wait)
1249{
1250 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001251 if (test_and_set_bit(bit_nr, &folio->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001252 return false;
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001253 } else if (test_bit(bit_nr, &folio->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001254 return false;
1255
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001256 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001257 return true;
1258}
1259
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001260/* How many times do we accept lock stealing from under a waiter? */
1261int sysctl_page_lock_unfairness = 5;
1262
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001263static inline int folio_wait_bit_common(struct folio *folio, int bit_nr,
1264 int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001265{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001266 wait_queue_head_t *q = folio_waitqueue(folio);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001267 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001268 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001269 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001270 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001271 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001272 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001273
Johannes Weinereb414682018-10-26 15:06:27 -07001274 if (bit_nr == PG_locked &&
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001275 !folio_test_uptodate(folio) && folio_test_workingset(folio)) {
1276 if (!folio_test_swapbacked(folio)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001277 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001278 delayacct = true;
1279 }
Johannes Weinereb414682018-10-26 15:06:27 -07001280 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001281 thrashing = true;
1282 }
1283
Nicholas Piggin62906022016-12-25 13:00:30 +10001284 init_wait(wait);
1285 wait->func = wake_page_function;
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001286 wait_page.folio = folio;
Nicholas Piggin62906022016-12-25 13:00:30 +10001287 wait_page.bit_nr = bit_nr;
1288
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001289repeat:
1290 wait->flags = 0;
1291 if (behavior == EXCLUSIVE) {
1292 wait->flags = WQ_FLAG_EXCLUSIVE;
1293 if (--unfairness < 0)
1294 wait->flags |= WQ_FLAG_CUSTOM;
1295 }
1296
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001297 /*
1298 * Do one last check whether we can get the
1299 * page bit synchronously.
1300 *
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001301 * Do the folio_set_waiters() marking before that
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001302 * to let any waker we _just_ missed know they
1303 * need to wake us up (otherwise they'll never
1304 * even go to the slow case that looks at the
1305 * page queue), and add ourselves to the wait
1306 * queue if we need to sleep.
1307 *
1308 * This part needs to be done under the queue
1309 * lock to avoid races.
1310 */
1311 spin_lock_irq(&q->lock);
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001312 folio_set_waiters(folio);
1313 if (!folio_trylock_flag(folio, bit_nr, wait))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001314 __add_wait_queue_entry_tail(q, wait);
1315 spin_unlock_irq(&q->lock);
1316
1317 /*
1318 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001319 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1320 * see whether the page bit testing has already
1321 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001322 *
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001323 * We can drop our reference to the folio.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001324 */
1325 if (behavior == DROP)
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001326 folio_put(folio);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001327
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001328 /*
1329 * Note that until the "finish_wait()", or until
1330 * we see the WQ_FLAG_WOKEN flag, we need to
1331 * be very careful with the 'wait->flags', because
1332 * we may race with a waker that sets them.
1333 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001334 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001335 unsigned int flags;
1336
Nicholas Piggin62906022016-12-25 13:00:30 +10001337 set_current_state(state);
1338
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001339 /* Loop until we've been woken or interrupted */
1340 flags = smp_load_acquire(&wait->flags);
1341 if (!(flags & WQ_FLAG_WOKEN)) {
1342 if (signal_pending_state(state, current))
1343 break;
1344
1345 io_schedule();
1346 continue;
1347 }
1348
1349 /* If we were non-exclusive, we're done */
1350 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001351 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001352
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001353 /* If the waker got the lock for us, we're done */
1354 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001355 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001356
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001357 /*
1358 * Otherwise, if we're getting the lock, we need to
1359 * try to get it ourselves.
1360 *
1361 * And if that fails, we'll have to retry this all.
1362 */
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001363 if (unlikely(test_and_set_bit(bit_nr, folio_flags(folio, 0))))
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001364 goto repeat;
1365
1366 wait->flags |= WQ_FLAG_DONE;
1367 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001368 }
1369
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001370 /*
1371 * If a signal happened, this 'finish_wait()' may remove the last
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001372 * waiter from the wait-queues, but the folio waiters bit will remain
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001373 * set. That's ok. The next wakeup will take care of it, and trying
1374 * to do it here would be difficult and prone to races.
1375 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001376 finish_wait(q, wait);
1377
Johannes Weinereb414682018-10-26 15:06:27 -07001378 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001379 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001380 delayacct_thrashing_end();
1381 psi_memstall_leave(&pflags);
1382 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001383
Nicholas Piggin62906022016-12-25 13:00:30 +10001384 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001385 * NOTE! The wait->flags weren't stable until we've done the
1386 * 'finish_wait()', and we could have exited the loop above due
1387 * to a signal, and had a wakeup event happen after the signal
1388 * test but before the 'finish_wait()'.
1389 *
1390 * So only after the finish_wait() can we reliably determine
1391 * if we got woken up or not, so we can now figure out the final
1392 * return value based on that state without races.
1393 *
1394 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1395 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001396 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001397 if (behavior == EXCLUSIVE)
1398 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001399
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001400 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001401}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001403void folio_wait_bit(struct folio *folio, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001405 folio_wait_bit_common(folio, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406}
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001407EXPORT_SYMBOL(folio_wait_bit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001409int folio_wait_bit_killable(struct folio *folio, int bit_nr)
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001410{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001411 return folio_wait_bit_common(folio, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001412}
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001413EXPORT_SYMBOL(folio_wait_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001414
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001416 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1417 * @page: The page to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001418 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001419 *
1420 * The caller should hold a reference on @page. They expect the page to
1421 * become unlocked relatively soon, but do not wish to hold up migration
1422 * (for example) by holding the reference while waiting for the page to
1423 * come unlocked. After this function returns, the caller should not
1424 * dereference @page.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001425 *
1426 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001427 */
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001428int put_and_wait_on_page_locked(struct page *page, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001429{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001430 return folio_wait_bit_common(page_folio(page), PG_locked, state,
1431 DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001432}
1433
1434/**
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001435 * folio_add_wait_queue - Add an arbitrary waiter to a folio's wait queue
1436 * @folio: Folio defining the wait queue of interest
Randy Dunlap697f6192009-04-13 14:39:54 -07001437 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001438 *
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001439 * Add an arbitrary @waiter to the wait queue for the nominated @folio.
David Howells385e1ca5f2009-04-03 16:42:39 +01001440 */
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001441void folio_add_wait_queue(struct folio *folio, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001442{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001443 wait_queue_head_t *q = folio_waitqueue(folio);
David Howells385e1ca5f2009-04-03 16:42:39 +01001444 unsigned long flags;
1445
1446 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001447 __add_wait_queue_entry_tail(q, waiter);
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001448 folio_set_waiters(folio);
David Howells385e1ca5f2009-04-03 16:42:39 +01001449 spin_unlock_irqrestore(&q->lock, flags);
1450}
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001451EXPORT_SYMBOL_GPL(folio_add_wait_queue);
David Howells385e1ca5f2009-04-03 16:42:39 +01001452
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001453#ifndef clear_bit_unlock_is_negative_byte
1454
1455/*
1456 * PG_waiters is the high bit in the same byte as PG_lock.
1457 *
1458 * On x86 (and on many other architectures), we can clear PG_lock and
1459 * test the sign bit at the same time. But if the architecture does
1460 * not support that special operation, we just do this all by hand
1461 * instead.
1462 *
1463 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001464 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001465 * in the same byte as PG_locked.
1466 */
1467static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1468{
1469 clear_bit_unlock(nr, mem);
1470 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001471 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001472}
1473
1474#endif
1475
David Howells385e1ca5f2009-04-03 16:42:39 +01001476/**
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001477 * folio_unlock - Unlock a locked folio.
1478 * @folio: The folio.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479 *
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001480 * Unlocks the folio and wakes up any thread sleeping on the page lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481 *
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001482 * Context: May be called from interrupt or process context. May not be
1483 * called from NMI context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 */
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001485void folio_unlock(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486{
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001487 /* Bit 7 allows x86 to check the byte's sign bit */
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001488 BUILD_BUG_ON(PG_waiters != 7);
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001489 BUILD_BUG_ON(PG_locked > 7);
1490 VM_BUG_ON_FOLIO(!folio_test_locked(folio), folio);
1491 if (clear_bit_unlock_is_negative_byte(PG_locked, folio_flags(folio, 0)))
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001492 folio_wake_bit(folio, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493}
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001494EXPORT_SYMBOL(folio_unlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001495
Randy Dunlap485bb992006-06-23 02:03:49 -07001496/**
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001497 * folio_end_private_2 - Clear PG_private_2 and wake any waiters.
1498 * @folio: The folio.
David Howells73e10de2020-02-10 10:00:21 +00001499 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001500 * Clear the PG_private_2 bit on a folio and wake up any sleepers waiting for
1501 * it. The folio reference held for PG_private_2 being set is released.
David Howells73e10de2020-02-10 10:00:21 +00001502 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001503 * This is, for example, used when a netfs folio is being written to a local
1504 * disk cache, thereby allowing writes to the cache for the same folio to be
David Howells73e10de2020-02-10 10:00:21 +00001505 * serialised.
1506 */
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001507void folio_end_private_2(struct folio *folio)
David Howells73e10de2020-02-10 10:00:21 +00001508{
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001509 VM_BUG_ON_FOLIO(!folio_test_private_2(folio), folio);
1510 clear_bit_unlock(PG_private_2, folio_flags(folio, 0));
1511 folio_wake_bit(folio, PG_private_2);
1512 folio_put(folio);
David Howells73e10de2020-02-10 10:00:21 +00001513}
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001514EXPORT_SYMBOL(folio_end_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001515
1516/**
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001517 * folio_wait_private_2 - Wait for PG_private_2 to be cleared on a folio.
1518 * @folio: The folio to wait on.
David Howells73e10de2020-02-10 10:00:21 +00001519 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001520 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a folio.
David Howells73e10de2020-02-10 10:00:21 +00001521 */
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001522void folio_wait_private_2(struct folio *folio)
David Howells73e10de2020-02-10 10:00:21 +00001523{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001524 while (folio_test_private_2(folio))
1525 folio_wait_bit(folio, PG_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001526}
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001527EXPORT_SYMBOL(folio_wait_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001528
1529/**
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001530 * folio_wait_private_2_killable - Wait for PG_private_2 to be cleared on a folio.
1531 * @folio: The folio to wait on.
David Howells73e10de2020-02-10 10:00:21 +00001532 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001533 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a folio or until a
David Howells73e10de2020-02-10 10:00:21 +00001534 * fatal signal is received by the calling task.
1535 *
1536 * Return:
1537 * - 0 if successful.
1538 * - -EINTR if a fatal signal was encountered.
1539 */
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001540int folio_wait_private_2_killable(struct folio *folio)
David Howells73e10de2020-02-10 10:00:21 +00001541{
1542 int ret = 0;
1543
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001544 while (folio_test_private_2(folio)) {
1545 ret = folio_wait_bit_killable(folio, PG_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001546 if (ret < 0)
1547 break;
1548 }
1549
1550 return ret;
1551}
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001552EXPORT_SYMBOL(folio_wait_private_2_killable);
David Howells73e10de2020-02-10 10:00:21 +00001553
1554/**
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001555 * folio_end_writeback - End writeback against a folio.
1556 * @folio: The folio.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 */
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001558void folio_end_writeback(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001560 /*
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001561 * folio_test_clear_reclaim() could be used here but it is an
1562 * atomic operation and overkill in this particular case. Failing
1563 * to shuffle a folio marked for immediate reclaim is too mild
1564 * a gain to justify taking an atomic operation penalty at the
1565 * end of every folio writeback.
Mel Gorman888cf2d2014-06-04 16:10:34 -07001566 */
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001567 if (folio_test_reclaim(folio)) {
1568 folio_clear_reclaim(folio);
Matthew Wilcox (Oracle)575ced12020-12-08 01:25:39 -05001569 folio_rotate_reclaimable(folio);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001570 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001571
Hugh Dickins073861e2020-11-24 08:46:43 -08001572 /*
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001573 * Writeback does not hold a folio reference of its own, relying
Hugh Dickins073861e2020-11-24 08:46:43 -08001574 * on truncation to wait for the clearing of PG_writeback.
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001575 * But here we must make sure that the folio is not freed and
1576 * reused before the folio_wake().
Hugh Dickins073861e2020-11-24 08:46:43 -08001577 */
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001578 folio_get(folio);
Matthew Wilcox (Oracle)269ccca32021-01-15 23:34:16 -05001579 if (!__folio_end_writeback(folio))
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001580 BUG();
1581
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001582 smp_mb__after_atomic();
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001583 folio_wake(folio, PG_writeback);
Linus Torvalds512b79312021-11-06 14:08:17 -07001584 acct_reclaim_writeback(folio);
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001585 folio_put(folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586}
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001587EXPORT_SYMBOL(folio_end_writeback);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001588
Matthew Wilcox57d99842014-06-04 16:07:45 -07001589/*
1590 * After completing I/O on a page, call this routine to update the page
1591 * flags appropriately
1592 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001593void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001594{
Jens Axboec11f0c02016-08-05 08:11:04 -06001595 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001596 if (!err) {
1597 SetPageUptodate(page);
1598 } else {
1599 ClearPageUptodate(page);
1600 SetPageError(page);
1601 }
1602 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001603 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001604 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001605 struct address_space *mapping;
1606
Matthew Wilcox57d99842014-06-04 16:07:45 -07001607 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001608 mapping = page_mapping(page);
1609 if (mapping)
1610 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001611 }
1612 end_page_writeback(page);
1613 }
1614}
1615EXPORT_SYMBOL_GPL(page_endio);
1616
Randy Dunlap485bb992006-06-23 02:03:49 -07001617/**
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001618 * __folio_lock - Get a lock on the folio, assuming we need to sleep to get it.
1619 * @folio: The folio to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 */
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001621void __folio_lock(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001623 folio_wait_bit_common(folio, PG_locked, TASK_UNINTERRUPTIBLE,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001624 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625}
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001626EXPORT_SYMBOL(__folio_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001628int __folio_lock_killable(struct folio *folio)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001629{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001630 return folio_wait_bit_common(folio, PG_locked, TASK_KILLABLE,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001631 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001632}
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001633EXPORT_SYMBOL_GPL(__folio_lock_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001634
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05001635static int __folio_lock_async(struct folio *folio, struct wait_page_queue *wait)
Jens Axboedd3e6d52020-05-22 09:12:09 -06001636{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001637 struct wait_queue_head *q = folio_waitqueue(folio);
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001638 int ret = 0;
1639
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001640 wait->folio = folio;
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001641 wait->bit_nr = PG_locked;
1642
1643 spin_lock_irq(&q->lock);
1644 __add_wait_queue_entry_tail(q, &wait->wait);
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05001645 folio_set_waiters(folio);
1646 ret = !folio_trylock(folio);
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001647 /*
1648 * If we were successful now, we know we're still on the
1649 * waitqueue as we're still under the lock. This means it's
1650 * safe to remove and return success, we know the callback
1651 * isn't going to trigger.
1652 */
1653 if (!ret)
1654 __remove_wait_queue(q, &wait->wait);
1655 else
1656 ret = -EIOCBQUEUED;
1657 spin_unlock_irq(&q->lock);
1658 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001659}
1660
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001661/*
1662 * Return values:
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001663 * true - folio is locked; mmap_lock is still held.
1664 * false - folio is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001665 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001666 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001667 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001668 *
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001669 * If neither ALLOW_RETRY nor KILLABLE are set, will always return true
1670 * with the folio locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001671 */
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001672bool __folio_lock_or_retry(struct folio *folio, struct mm_struct *mm,
Michel Lespinassed065bd82010-10-26 14:21:57 -07001673 unsigned int flags)
1674{
Peter Xu4064b982020-04-01 21:08:45 -07001675 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001676 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001677 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001678 * even though return 0.
1679 */
1680 if (flags & FAULT_FLAG_RETRY_NOWAIT)
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001681 return false;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001682
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001683 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001684 if (flags & FAULT_FLAG_KILLABLE)
Matthew Wilcox (Oracle)6baa8d62021-03-04 10:21:02 -05001685 folio_wait_locked_killable(folio);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001686 else
Matthew Wilcox (Oracle)6baa8d62021-03-04 10:21:02 -05001687 folio_wait_locked(folio);
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001688 return false;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001689 }
Hailong Liu800bca72020-12-14 19:05:02 -08001690 if (flags & FAULT_FLAG_KILLABLE) {
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001691 bool ret;
Hailong Liu800bca72020-12-14 19:05:02 -08001692
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001693 ret = __folio_lock_killable(folio);
Hailong Liu800bca72020-12-14 19:05:02 -08001694 if (ret) {
1695 mmap_read_unlock(mm);
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001696 return false;
Hailong Liu800bca72020-12-14 19:05:02 -08001697 }
1698 } else {
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001699 __folio_lock(folio);
Hailong Liu800bca72020-12-14 19:05:02 -08001700 }
Hailong Liu800bca72020-12-14 19:05:02 -08001701
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001702 return true;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001703}
1704
Randy Dunlap485bb992006-06-23 02:03:49 -07001705/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001706 * page_cache_next_miss() - Find the next gap in the page cache.
1707 * @mapping: Mapping.
1708 * @index: Index.
1709 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001710 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001711 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1712 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001713 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001714 * This function may be called under the rcu_read_lock. However, this will
1715 * not atomically search a snapshot of the cache at a single point in time.
1716 * For example, if a gap is created at index 5, then subsequently a gap is
1717 * created at index 10, page_cache_next_miss covering both indices may
1718 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001719 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001720 * Return: The index of the gap if found, otherwise an index outside the
1721 * range specified (in which case 'return - index >= max_scan' will be true).
1722 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001723 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001724pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001725 pgoff_t index, unsigned long max_scan)
1726{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001727 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001728
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001729 while (max_scan--) {
1730 void *entry = xas_next(&xas);
1731 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001732 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001733 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001734 break;
1735 }
1736
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001737 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001738}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001739EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001740
1741/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001742 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001743 * @mapping: Mapping.
1744 * @index: Index.
1745 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001746 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001747 * Search the range [max(index - max_scan + 1, 0), index] for the
1748 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001749 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001750 * This function may be called under the rcu_read_lock. However, this will
1751 * not atomically search a snapshot of the cache at a single point in time.
1752 * For example, if a gap is created at index 10, then subsequently a gap is
1753 * created at index 5, page_cache_prev_miss() covering both indices may
1754 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001755 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001756 * Return: The index of the gap if found, otherwise an index outside the
1757 * range specified (in which case 'index - return >= max_scan' will be true).
1758 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001759 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001760pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001761 pgoff_t index, unsigned long max_scan)
1762{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001763 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001764
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001765 while (max_scan--) {
1766 void *entry = xas_prev(&xas);
1767 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001768 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001769 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001770 break;
1771 }
1772
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001773 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001774}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001775EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001776
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001777/*
Matthew Wilcox (Oracle)020853b2021-05-10 16:33:22 -04001778 * Lockless page cache protocol:
1779 * On the lookup side:
1780 * 1. Load the folio from i_pages
1781 * 2. Increment the refcount if it's not zero
1782 * 3. If the folio is not found by xas_reload(), put the refcount and retry
1783 *
1784 * On the removal side:
1785 * A. Freeze the page (by zeroing the refcount if nobody else has a reference)
1786 * B. Remove the page from i_pages
1787 * C. Return the page to the page allocator
1788 *
1789 * This means that any page may have its reference count temporarily
1790 * increased by a speculative page cache (or fast GUP) lookup as it can
1791 * be allocated by another user before the RCU grace period expires.
1792 * Because the refcount temporarily acquired here may end up being the
1793 * last refcount on the page, any page allocation must be freeable by
1794 * folio_put().
1795 */
1796
1797/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001798 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001799 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001800 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001801 *
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001802 * Looks up the page cache entry at @mapping & @index. If it is a folio,
1803 * it is returned with an increased refcount. If it is a shadow entry
1804 * of a previously evicted folio, or a swap entry from shmem/tmpfs,
1805 * it is returned without further action.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001806 *
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001807 * Return: The folio, swap or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 */
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001809static void *mapping_get_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001811 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001812 struct folio *folio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813
Nick Piggina60637c2008-07-25 19:45:31 -07001814 rcu_read_lock();
1815repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001816 xas_reset(&xas);
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001817 folio = xas_load(&xas);
1818 if (xas_retry(&xas, folio))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001819 goto repeat;
1820 /*
1821 * A shadow entry of a recently evicted page, or a swap entry from
1822 * shmem/tmpfs. Return it without attempting to raise page count.
1823 */
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001824 if (!folio || xa_is_value(folio))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001825 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001826
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001827 if (!folio_try_get_rcu(folio))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001828 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001829
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001830 if (unlikely(folio != xas_reload(&xas))) {
1831 folio_put(folio);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001832 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001833 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001834out:
Nick Piggina60637c2008-07-25 19:45:31 -07001835 rcu_read_unlock();
1836
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001837 return folio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001839
Randy Dunlap485bb992006-06-23 02:03:49 -07001840/**
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001841 * __filemap_get_folio - Find and get a reference to a folio.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001842 * @mapping: The address_space to search.
1843 * @index: The page index.
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001844 * @fgp_flags: %FGP flags modify how the folio is returned.
1845 * @gfp: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001846 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001847 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001848 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001849 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001850 *
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001851 * * %FGP_ACCESSED - The folio will be marked accessed.
1852 * * %FGP_LOCK - The folio is returned locked.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001853 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001854 * instead of allocating a new folio to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001855 * * %FGP_CREAT - If no page is present then a new page is allocated using
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001856 * @gfp and added to the page cache and the VM's LRU list.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001857 * The page is returned locked and with an increased refcount.
1858 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1859 * page is already in cache. If the page was allocated, unlock it before
1860 * returning so the caller can do the same dance.
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001861 * * %FGP_WRITE - The page will be written to by the caller.
1862 * * %FGP_NOFS - __GFP_FS will get cleared in gfp.
1863 * * %FGP_NOWAIT - Don't get blocked by page lock.
Matthew Wilcox (Oracle)b27652d92020-12-24 12:55:56 -05001864 * * %FGP_STABLE - Wait for the folio to be stable (finished writeback)
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001865 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001866 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1867 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001868 *
1869 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001870 *
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001871 * Return: The found folio or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001872 */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001873struct folio *__filemap_get_folio(struct address_space *mapping, pgoff_t index,
1874 int fgp_flags, gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001875{
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001876 struct folio *folio;
Mel Gorman2457aec2014-06-04 16:10:31 -07001877
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878repeat:
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001879 folio = mapping_get_entry(mapping, index);
1880 if (xa_is_value(folio)) {
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001881 if (fgp_flags & FGP_ENTRY)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001882 return folio;
1883 folio = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001884 }
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001885 if (!folio)
Mel Gorman2457aec2014-06-04 16:10:31 -07001886 goto no_page;
1887
1888 if (fgp_flags & FGP_LOCK) {
1889 if (fgp_flags & FGP_NOWAIT) {
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001890 if (!folio_trylock(folio)) {
1891 folio_put(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001892 return NULL;
1893 }
1894 } else {
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001895 folio_lock(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001896 }
1897
1898 /* Has the page been truncated? */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001899 if (unlikely(folio->mapping != mapping)) {
1900 folio_unlock(folio);
1901 folio_put(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001902 goto repeat;
1903 }
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001904 VM_BUG_ON_FOLIO(!folio_contains(folio, index), folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001905 }
1906
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001907 if (fgp_flags & FGP_ACCESSED)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001908 folio_mark_accessed(folio);
Yang Shib9306a72020-08-06 23:19:55 -07001909 else if (fgp_flags & FGP_WRITE) {
1910 /* Clear idle flag for buffer write */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001911 if (folio_test_idle(folio))
1912 folio_clear_idle(folio);
Yang Shib9306a72020-08-06 23:19:55 -07001913 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001914
Matthew Wilcox (Oracle)b27652d92020-12-24 12:55:56 -05001915 if (fgp_flags & FGP_STABLE)
1916 folio_wait_stable(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001917no_page:
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001918 if (!folio && (fgp_flags & FGP_CREAT)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001919 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001920 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001921 gfp |= __GFP_WRITE;
Michal Hocko45f87de2014-12-29 20:30:35 +01001922 if (fgp_flags & FGP_NOFS)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001923 gfp &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001924
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001925 folio = filemap_alloc_folio(gfp, 0);
1926 if (!folio)
Nick Piggineb2be182007-10-16 01:24:57 -07001927 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001928
Josef Bacika75d4c32019-03-13 11:44:14 -07001929 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001930 fgp_flags |= FGP_LOCK;
1931
Hugh Dickinseb39d612014-08-06 16:06:43 -07001932 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001933 if (fgp_flags & FGP_ACCESSED)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001934 __folio_set_referenced(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001935
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001936 err = filemap_add_folio(mapping, folio, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07001937 if (unlikely(err)) {
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001938 folio_put(folio);
1939 folio = NULL;
Nick Piggineb2be182007-10-16 01:24:57 -07001940 if (err == -EEXIST)
1941 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001943
1944 /*
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001945 * filemap_add_folio locks the page, and for mmap
1946 * we expect an unlocked page.
Josef Bacika75d4c32019-03-13 11:44:14 -07001947 */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001948 if (folio && (fgp_flags & FGP_FOR_MMAP))
1949 folio_unlock(folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001951
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001952 return folio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953}
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001954EXPORT_SYMBOL(__filemap_get_folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001956static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1957 xa_mark_t mark)
1958{
1959 struct page *page;
1960
1961retry:
1962 if (mark == XA_PRESENT)
1963 page = xas_find(xas, max);
1964 else
1965 page = xas_find_marked(xas, max, mark);
1966
1967 if (xas_retry(xas, page))
1968 goto retry;
1969 /*
1970 * A shadow entry of a recently evicted page, a swap
1971 * entry from shmem/tmpfs or a DAX entry. Return it
1972 * without attempting to raise page count.
1973 */
1974 if (!page || xa_is_value(page))
1975 return page;
1976
1977 if (!page_cache_get_speculative(page))
1978 goto reset;
1979
1980 /* Has the page moved or been split? */
1981 if (unlikely(page != xas_reload(xas))) {
1982 put_page(page);
1983 goto reset;
1984 }
1985
1986 return page;
1987reset:
1988 xas_reset(xas);
1989 goto retry;
1990}
1991
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001993 * find_get_entries - gang pagecache lookup
1994 * @mapping: The address_space to search
1995 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08001996 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08001997 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001998 * @indices: The cache indices corresponding to the entries in @entries
1999 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002000 * find_get_entries() will search for and return a batch of entries in
2001 * the mapping. The entries are placed in @pvec. find_get_entries()
2002 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002003 *
2004 * The search returns a group of mapping-contiguous page cache entries
2005 * with ascending indexes. There may be holes in the indices due to
2006 * not-present pages.
2007 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07002008 * Any shadow entries of evicted pages, or swap entries from
2009 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002010 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07002011 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
2012 * stops at that page: the caller is likely to have a better way to handle
2013 * the compound page as a whole, and then skip its extent, than repeatedly
2014 * calling find_get_entries() to return all its tails.
2015 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002016 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002017 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002018unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002019 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07002020{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002021 XA_STATE(xas, &mapping->i_pages, start);
2022 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002023 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002024 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002025
2026 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002027 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002028 /*
2029 * Terminate early on finding a THP, to allow the caller to
2030 * handle it all at once; but continue if this is hugetlbfs.
2031 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002032 if (!xa_is_value(page) && PageTransHuge(page) &&
2033 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002034 page = find_subpage(page, xas.xa_index);
2035 nr_entries = ret + 1;
2036 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002037
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002038 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002039 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002040 if (++ret == nr_entries)
2041 break;
2042 }
2043 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002044
2045 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002046 return ret;
2047}
2048
2049/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002050 * find_lock_entries - Find a batch of pagecache entries.
2051 * @mapping: The address_space to search.
2052 * @start: The starting page cache index.
2053 * @end: The final page index (inclusive).
2054 * @pvec: Where the resulting entries are placed.
2055 * @indices: The cache indices of the entries in @pvec.
2056 *
2057 * find_lock_entries() will return a batch of entries from @mapping.
2058 * Swap, shadow and DAX entries are included. Pages are returned
2059 * locked and with an incremented refcount. Pages which are locked by
2060 * somebody else or under writeback are skipped. Only the head page of
2061 * a THP is returned. Pages which are partially outside the range are
2062 * not returned.
2063 *
2064 * The entries have ascending indexes. The indices may not be consecutive
2065 * due to not-present entries, THP pages, pages which could not be locked
2066 * or pages under writeback.
2067 *
2068 * Return: The number of entries which were found.
2069 */
2070unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2071 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2072{
2073 XA_STATE(xas, &mapping->i_pages, start);
2074 struct page *page;
2075
2076 rcu_read_lock();
2077 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2078 if (!xa_is_value(page)) {
2079 if (page->index < start)
2080 goto put;
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002081 if (page->index + thp_nr_pages(page) - 1 > end)
2082 goto put;
2083 if (!trylock_page(page))
2084 goto put;
2085 if (page->mapping != mapping || PageWriteback(page))
2086 goto unlock;
2087 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2088 page);
2089 }
2090 indices[pvec->nr] = xas.xa_index;
2091 if (!pagevec_add(pvec, page))
2092 break;
2093 goto next;
2094unlock:
2095 unlock_page(page);
2096put:
2097 put_page(page);
2098next:
Hugh Dickins2d11e732021-04-23 14:28:57 -07002099 if (!xa_is_value(page) && PageTransHuge(page)) {
2100 unsigned int nr_pages = thp_nr_pages(page);
2101
2102 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
2103 xas_set(&xas, page->index + nr_pages);
2104 if (xas.xa_index < nr_pages)
2105 break;
2106 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002107 }
2108 rcu_read_unlock();
2109
2110 return pagevec_count(pvec);
2111}
2112
2113/**
Jan Karab947cee2017-09-06 16:21:21 -07002114 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 * @mapping: The address_space to search
2116 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002117 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 * @nr_pages: The maximum number of pages
2119 * @pages: Where the resulting pages are placed
2120 *
Jan Karab947cee2017-09-06 16:21:21 -07002121 * find_get_pages_range() will search for and return a group of up to @nr_pages
2122 * pages in the mapping starting at index @start and up to index @end
2123 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2124 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002125 *
2126 * The search returns a group of mapping-contiguous pages with ascending
2127 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002128 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002129 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002130 * Return: the number of pages which were found. If this number is
2131 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002132 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 */
Jan Karab947cee2017-09-06 16:21:21 -07002134unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2135 pgoff_t end, unsigned int nr_pages,
2136 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002138 XA_STATE(xas, &mapping->i_pages, *start);
2139 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002140 unsigned ret = 0;
2141
2142 if (unlikely(!nr_pages))
2143 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144
Nick Piggina60637c2008-07-25 19:45:31 -07002145 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002146 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002147 /* Skip over shadow, swap and DAX entries */
2148 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002149 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002150
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002151 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002152 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002153 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002154 goto out;
2155 }
Nick Piggina60637c2008-07-25 19:45:31 -07002156 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002157
Jan Karab947cee2017-09-06 16:21:21 -07002158 /*
2159 * We come here when there is no page beyond @end. We take care to not
2160 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002161 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002162 * already broken anyway.
2163 */
2164 if (end == (pgoff_t)-1)
2165 *start = (pgoff_t)-1;
2166 else
2167 *start = end + 1;
2168out:
Nick Piggina60637c2008-07-25 19:45:31 -07002169 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002170
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171 return ret;
2172}
2173
Jens Axboeebf43502006-04-27 08:46:01 +02002174/**
2175 * find_get_pages_contig - gang contiguous pagecache lookup
2176 * @mapping: The address_space to search
2177 * @index: The starting page index
2178 * @nr_pages: The maximum number of pages
2179 * @pages: Where the resulting pages are placed
2180 *
2181 * find_get_pages_contig() works exactly like find_get_pages(), except
2182 * that the returned number of pages are guaranteed to be contiguous.
2183 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002184 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002185 */
2186unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2187 unsigned int nr_pages, struct page **pages)
2188{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002189 XA_STATE(xas, &mapping->i_pages, index);
2190 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002191 unsigned int ret = 0;
2192
2193 if (unlikely(!nr_pages))
2194 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002195
Nick Piggina60637c2008-07-25 19:45:31 -07002196 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002197 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002198 if (xas_retry(&xas, page))
2199 continue;
2200 /*
2201 * If the entry has been swapped out, we can stop looking.
2202 * No current caller is looking for DAX entries.
2203 */
2204 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002205 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002206
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002207 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002208 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002209
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002210 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002211 if (unlikely(page != xas_reload(&xas)))
2212 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002213
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002214 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002215 if (++ret == nr_pages)
2216 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002217 continue;
2218put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002219 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002220retry:
2221 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002222 }
Nick Piggina60637c2008-07-25 19:45:31 -07002223 rcu_read_unlock();
2224 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002225}
David Howellsef71c152007-05-09 02:33:44 -07002226EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002227
Randy Dunlap485bb992006-06-23 02:03:49 -07002228/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002229 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002230 * @mapping: the address_space to search
2231 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002232 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002233 * @tag: the tag index
2234 * @nr_pages: the maximum number of pages
2235 * @pages: where the resulting pages are placed
2236 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002237 * Like find_get_pages(), except we only return head pages which are tagged
2238 * with @tag. @index is updated to the index immediately after the last
2239 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002240 *
2241 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 */
Jan Kara72b045a2017-11-15 17:34:33 -08002243unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002244 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002245 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002247 XA_STATE(xas, &mapping->i_pages, *index);
2248 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002249 unsigned ret = 0;
2250
2251 if (unlikely(!nr_pages))
2252 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253
Nick Piggina60637c2008-07-25 19:45:31 -07002254 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002255 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002256 /*
2257 * Shadow entries should never be tagged, but this iteration
2258 * is lockless so there is a window for page reclaim to evict
2259 * a page we saw tagged. Skip over it.
2260 */
2261 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002262 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002263
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002264 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002265 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002266 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002267 goto out;
2268 }
Nick Piggina60637c2008-07-25 19:45:31 -07002269 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002270
Jan Kara72b045a2017-11-15 17:34:33 -08002271 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002272 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002273 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002274 * iteration when there is a page at index -1 but that is already
2275 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002276 */
2277 if (end == (pgoff_t)-1)
2278 *index = (pgoff_t)-1;
2279 else
2280 *index = end + 1;
2281out:
Nick Piggina60637c2008-07-25 19:45:31 -07002282 rcu_read_unlock();
2283
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 return ret;
2285}
Jan Kara72b045a2017-11-15 17:34:33 -08002286EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002288/*
2289 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2290 * a _large_ part of the i/o request. Imagine the worst scenario:
2291 *
2292 * ---R__________________________________________B__________
2293 * ^ reading here ^ bad block(assume 4k)
2294 *
2295 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2296 * => failing the whole request => read(R) => read(R+1) =>
2297 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2298 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2299 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2300 *
2301 * It is going insane. Fix it by quickly scaling down the readahead size.
2302 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002303static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002304{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002305 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002306}
2307
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002308/*
2309 * filemap_get_read_batch - Get a batch of pages for read
2310 *
2311 * Get a batch of pages which represent a contiguous range of bytes
2312 * in the file. No tail pages will be returned. If @index is in the
2313 * middle of a THP, the entire THP will be returned. The last page in
2314 * the batch may have Readahead set or be not Uptodate so that the
2315 * caller can take the appropriate action.
2316 */
2317static void filemap_get_read_batch(struct address_space *mapping,
2318 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2319{
2320 XA_STATE(xas, &mapping->i_pages, index);
2321 struct page *head;
2322
2323 rcu_read_lock();
2324 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2325 if (xas_retry(&xas, head))
2326 continue;
2327 if (xas.xa_index > max || xa_is_value(head))
2328 break;
2329 if (!page_cache_get_speculative(head))
2330 goto retry;
2331
2332 /* Has the page moved or been split? */
2333 if (unlikely(head != xas_reload(&xas)))
2334 goto put_page;
2335
2336 if (!pagevec_add(pvec, head))
2337 break;
2338 if (!PageUptodate(head))
2339 break;
2340 if (PageReadahead(head))
2341 break;
2342 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2343 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2344 continue;
2345put_page:
2346 put_page(head);
2347retry:
2348 xas_reset(&xas);
2349 }
2350 rcu_read_unlock();
2351}
2352
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002353static int filemap_read_page(struct file *file, struct address_space *mapping,
2354 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002355{
Kent Overstreet723ef242020-12-14 19:04:52 -08002356 int error;
2357
Kent Overstreet723ef242020-12-14 19:04:52 -08002358 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002359 * A previous I/O error may have been due to temporary failures,
2360 * eg. multipath errors. PG_error will be set again if readpage
2361 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002362 */
2363 ClearPageError(page);
2364 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002365 error = mapping->a_ops->readpage(file, page);
2366 if (error)
2367 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002368
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002369 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002370 if (error)
2371 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002372 if (PageUptodate(page))
2373 return 0;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002374 shrink_readahead_size_eio(&file->f_ra);
2375 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002376}
2377
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002378static bool filemap_range_uptodate(struct address_space *mapping,
2379 loff_t pos, struct iov_iter *iter, struct page *page)
2380{
2381 int count;
2382
2383 if (PageUptodate(page))
2384 return true;
2385 /* pipes can't handle partially uptodate pages */
2386 if (iov_iter_is_pipe(iter))
2387 return false;
2388 if (!mapping->a_ops->is_partially_uptodate)
2389 return false;
2390 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2391 return false;
2392
2393 count = iter->count;
2394 if (page_offset(page) > pos) {
2395 count -= page_offset(page) - pos;
2396 pos = 0;
2397 } else {
2398 pos -= page_offset(page);
2399 }
2400
2401 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2402}
2403
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002404static int filemap_update_page(struct kiocb *iocb,
2405 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002406 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002407{
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002408 struct folio *folio = page_folio(page);
Kent Overstreet723ef242020-12-14 19:04:52 -08002409 int error;
2410
Jan Kara730633f2021-01-28 19:19:45 +01002411 if (iocb->ki_flags & IOCB_NOWAIT) {
2412 if (!filemap_invalidate_trylock_shared(mapping))
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002413 return -EAGAIN;
Jan Kara730633f2021-01-28 19:19:45 +01002414 } else {
2415 filemap_invalidate_lock_shared(mapping);
2416 }
2417
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002418 if (!folio_trylock(folio)) {
Jan Kara730633f2021-01-28 19:19:45 +01002419 error = -EAGAIN;
2420 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2421 goto unlock_mapping;
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002422 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Jan Kara730633f2021-01-28 19:19:45 +01002423 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002424 put_and_wait_on_page_locked(&folio->page, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002425 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002426 }
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002427 error = __folio_lock_async(folio, iocb->ki_waitq);
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002428 if (error)
Jan Kara730633f2021-01-28 19:19:45 +01002429 goto unlock_mapping;
Kent Overstreet723ef242020-12-14 19:04:52 -08002430 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002431
Jan Kara730633f2021-01-28 19:19:45 +01002432 error = AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002433 if (!folio->mapping)
Jan Kara730633f2021-01-28 19:19:45 +01002434 goto unlock;
Kent Overstreet723ef242020-12-14 19:04:52 -08002435
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002436 error = 0;
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002437 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, &folio->page))
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002438 goto unlock;
2439
2440 error = -EAGAIN;
2441 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2442 goto unlock;
2443
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002444 error = filemap_read_page(iocb->ki_filp, mapping, &folio->page);
Jan Kara730633f2021-01-28 19:19:45 +01002445 goto unlock_mapping;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002446unlock:
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002447 folio_unlock(folio);
Jan Kara730633f2021-01-28 19:19:45 +01002448unlock_mapping:
2449 filemap_invalidate_unlock_shared(mapping);
2450 if (error == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002451 folio_put(folio);
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002452 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002453}
2454
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002455static int filemap_create_page(struct file *file,
2456 struct address_space *mapping, pgoff_t index,
2457 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002458{
Kent Overstreet723ef242020-12-14 19:04:52 -08002459 struct page *page;
2460 int error;
2461
Kent Overstreet723ef242020-12-14 19:04:52 -08002462 page = page_cache_alloc(mapping);
2463 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002464 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002465
Jan Kara730633f2021-01-28 19:19:45 +01002466 /*
2467 * Protect against truncate / hole punch. Grabbing invalidate_lock here
2468 * assures we cannot instantiate and bring uptodate new pagecache pages
2469 * after evicting page cache during truncate and before actually
2470 * freeing blocks. Note that we could release invalidate_lock after
2471 * inserting the page into page cache as the locked page would then be
2472 * enough to synchronize with hole punching. But there are code paths
2473 * such as filemap_update_page() filling in partially uptodate pages or
2474 * ->readpages() that need to hold invalidate_lock while mapping blocks
2475 * for IO so let's hold the lock here as well to keep locking rules
2476 * simple.
2477 */
2478 filemap_invalidate_lock_shared(mapping);
Kent Overstreet723ef242020-12-14 19:04:52 -08002479 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002480 mapping_gfp_constraint(mapping, GFP_KERNEL));
2481 if (error == -EEXIST)
2482 error = AOP_TRUNCATED_PAGE;
2483 if (error)
2484 goto error;
2485
2486 error = filemap_read_page(file, mapping, page);
2487 if (error)
2488 goto error;
2489
Jan Kara730633f2021-01-28 19:19:45 +01002490 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002491 pagevec_add(pvec, page);
2492 return 0;
2493error:
Jan Kara730633f2021-01-28 19:19:45 +01002494 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002495 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002496 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002497}
2498
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002499static int filemap_readahead(struct kiocb *iocb, struct file *file,
2500 struct address_space *mapping, struct page *page,
2501 pgoff_t last_index)
2502{
2503 if (iocb->ki_flags & IOCB_NOIO)
2504 return -EAGAIN;
2505 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2506 page->index, last_index - page->index);
2507 return 0;
2508}
2509
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002510static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002511 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002512{
2513 struct file *filp = iocb->ki_filp;
2514 struct address_space *mapping = filp->f_mapping;
2515 struct file_ra_state *ra = &filp->f_ra;
2516 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002517 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002518 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002519 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002520
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002521 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002522retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002523 if (fatal_signal_pending(current))
2524 return -EINTR;
2525
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002526 filemap_get_read_batch(mapping, index, last_index, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002527 if (!pagevec_count(pvec)) {
2528 if (iocb->ki_flags & IOCB_NOIO)
2529 return -EAGAIN;
2530 page_cache_sync_readahead(mapping, ra, filp, index,
2531 last_index - index);
2532 filemap_get_read_batch(mapping, index, last_index, pvec);
2533 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002534 if (!pagevec_count(pvec)) {
2535 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2536 return -EAGAIN;
2537 err = filemap_create_page(filp, mapping,
2538 iocb->ki_pos >> PAGE_SHIFT, pvec);
2539 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002540 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002541 return err;
2542 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002543
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002544 page = pvec->pages[pagevec_count(pvec) - 1];
2545 if (PageReadahead(page)) {
2546 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2547 if (err)
2548 goto err;
2549 }
2550 if (!PageUptodate(page)) {
2551 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2552 iocb->ki_flags |= IOCB_NOWAIT;
2553 err = filemap_update_page(iocb, mapping, iter, page);
2554 if (err)
2555 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002556 }
2557
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002558 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002559err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002560 if (err < 0)
2561 put_page(page);
2562 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002563 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002564 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002565 goto retry;
2566 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002567}
2568
Randy Dunlap485bb992006-06-23 02:03:49 -07002569/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002570 * filemap_read - Read data from the page cache.
2571 * @iocb: The iocb to read.
2572 * @iter: Destination for the data.
2573 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002574 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002575 * Copies data from the page cache. If the data is not currently present,
2576 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002577 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002578 * Return: Total number of bytes copied, including those already read by
2579 * the caller. If an error happens before any bytes are copied, returns
2580 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002582ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2583 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002585 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002586 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002587 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002589 struct pagevec pvec;
2590 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002591 bool writably_mapped;
2592 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002593
Kent Overstreet723ef242020-12-14 19:04:52 -08002594 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002595 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002596 if (unlikely(!iov_iter_count(iter)))
2597 return 0;
2598
Wei Fangc2a97372016-10-07 17:01:52 -07002599 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002600 pagevec_init(&pvec);
Wei Fangc2a97372016-10-07 17:01:52 -07002601
Kent Overstreet06c04442020-12-14 19:04:56 -08002602 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 cond_resched();
Kent Overstreet06c04442020-12-14 19:04:56 -08002604
2605 /*
2606 * If we've already successfully copied some data, then we
2607 * can no longer safely return -EIOCBQUEUED. Hence mark
2608 * an async read NOWAIT at that point.
2609 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002610 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002611 iocb->ki_flags |= IOCB_NOWAIT;
2612
David Howells8c8387e2021-11-05 13:36:49 -07002613 if (unlikely(iocb->ki_pos >= i_size_read(inode)))
2614 break;
2615
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002616 error = filemap_get_pages(iocb, iter, &pvec);
2617 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002618 break;
Michal Hocko5abf1862017-02-03 13:13:29 -08002619
Kent Overstreet723ef242020-12-14 19:04:52 -08002620 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002621 * i_size must be checked after we know the pages are Uptodate.
2622 *
2623 * Checking i_size after the check allows us to calculate
2624 * the correct value for "nr", which means the zero-filled
2625 * part of the page is not copied back to userspace (unless
2626 * another truncate extends the file - this is desired though).
Kent Overstreet723ef242020-12-14 19:04:52 -08002627 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002628 isize = i_size_read(inode);
2629 if (unlikely(iocb->ki_pos >= isize))
2630 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002631 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2632
Kent Overstreet06c04442020-12-14 19:04:56 -08002633 /*
2634 * Once we start copying data, we don't want to be touching any
2635 * cachelines that might be contended:
2636 */
2637 writably_mapped = mapping_writably_mapped(mapping);
2638
2639 /*
2640 * When a sequential read accesses a page several times, only
2641 * mark it as accessed the first time.
2642 */
2643 if (iocb->ki_pos >> PAGE_SHIFT !=
2644 ra->prev_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002645 mark_page_accessed(pvec.pages[0]);
Kent Overstreet06c04442020-12-14 19:04:56 -08002646
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002647 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002648 struct page *page = pvec.pages[i];
2649 size_t page_size = thp_size(page);
2650 size_t offset = iocb->ki_pos & (page_size - 1);
2651 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2652 page_size - offset);
2653 size_t copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002654
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002655 if (end_offset < page_offset(page))
2656 break;
2657 if (i > 0)
2658 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002659 /*
2660 * If users can be writing to this page using arbitrary
2661 * virtual addresses, take care about potential aliasing
2662 * before reading the page on the kernel side.
2663 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002664 if (writably_mapped) {
2665 int j;
Kent Overstreet06c04442020-12-14 19:04:56 -08002666
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002667 for (j = 0; j < thp_nr_pages(page); j++)
2668 flush_dcache_page(page + j);
2669 }
2670
2671 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002672
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002673 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002674 iocb->ki_pos += copied;
2675 ra->prev_pos = iocb->ki_pos;
2676
2677 if (copied < bytes) {
2678 error = -EFAULT;
2679 break;
Kent Overstreet723ef242020-12-14 19:04:52 -08002680 }
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002681 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002682put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002683 for (i = 0; i < pagevec_count(&pvec); i++)
2684 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002685 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002686 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002688 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002689
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002690 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002691}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002692EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693
Randy Dunlap485bb992006-06-23 02:03:49 -07002694/**
Al Viro6abd2322014-04-04 14:20:57 -04002695 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002696 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002697 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002698 *
Al Viro6abd2322014-04-04 14:20:57 -04002699 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002701 *
2702 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2703 * be returned when no data can be read without waiting for I/O requests
2704 * to complete; it doesn't prevent readahead.
2705 *
2706 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2707 * requests shall be made for the read or for readahead. When no data
2708 * can be read, -EAGAIN shall be returned. When readahead would be
2709 * triggered, a partial, possibly empty read shall be returned.
2710 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002711 * Return:
2712 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002713 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714 */
2715ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002716generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002717{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002718 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002719 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002720
2721 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002722 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002723
Al Viro2ba48ce2015-04-09 13:52:01 -04002724 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002725 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002726 struct address_space *mapping = file->f_mapping;
2727 struct inode *inode = mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002728
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002729 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002730 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2731 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002732 return -EAGAIN;
2733 } else {
2734 retval = filemap_write_and_wait_range(mapping,
2735 iocb->ki_pos,
2736 iocb->ki_pos + count - 1);
2737 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002738 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002739 }
Al Viroed978a82014-03-05 22:53:04 -05002740
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002741 file_accessed(file);
2742
Al Viro5ecda132017-04-13 14:13:36 -04002743 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002744 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002745 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002746 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002747 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002748 if (retval != -EIOCBQUEUED)
2749 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002750
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002751 /*
2752 * Btrfs can have a short DIO read if we encounter
2753 * compressed extents, so if there was an error, or if
2754 * we've already read everything we wanted to, or if
2755 * there was a short read because we hit EOF, go ahead
2756 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002757 * the rest of the read. Buffered reads will not work for
2758 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002759 */
Jens Axboe61d00172021-11-05 13:37:07 -07002760 if (retval < 0 || !count || IS_DAX(inode))
2761 return retval;
2762 if (iocb->ki_pos >= i_size_read(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002763 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002764 }
2765
Christoph Hellwig826ea862021-02-24 12:02:45 -08002766 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767}
Al Viroed978a82014-03-05 22:53:04 -05002768EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002770static inline loff_t page_seek_hole_data(struct xa_state *xas,
2771 struct address_space *mapping, struct page *page,
2772 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002773{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002774 const struct address_space_operations *ops = mapping->a_ops;
2775 size_t offset, bsz = i_blocksize(mapping->host);
2776
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002777 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002778 return seek_data ? start : end;
2779 if (!ops->is_partially_uptodate)
2780 return seek_data ? end : start;
2781
2782 xas_pause(xas);
2783 rcu_read_unlock();
2784 lock_page(page);
2785 if (unlikely(page->mapping != mapping))
2786 goto unlock;
2787
2788 offset = offset_in_thp(page, start) & ~(bsz - 1);
2789
2790 do {
2791 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2792 break;
2793 start = (start + bsz) & ~(bsz - 1);
2794 offset += bsz;
2795 } while (offset < thp_size(page));
2796unlock:
2797 unlock_page(page);
2798 rcu_read_lock();
2799 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002800}
2801
2802static inline
2803unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2804{
2805 if (xa_is_value(page))
2806 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2807 return thp_size(page);
2808}
2809
2810/**
2811 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2812 * @mapping: Address space to search.
2813 * @start: First byte to consider.
2814 * @end: Limit of search (exclusive).
2815 * @whence: Either SEEK_HOLE or SEEK_DATA.
2816 *
2817 * If the page cache knows which blocks contain holes and which blocks
2818 * contain data, your filesystem can use this function to implement
2819 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2820 * entirely memory-based such as tmpfs, and filesystems which support
2821 * unwritten extents.
2822 *
Ingo Molnarf0953a12021-05-06 18:06:47 -07002823 * Return: The requested offset on success, or -ENXIO if @whence specifies
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002824 * SEEK_DATA and there is no data after @start. There is an implicit hole
2825 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2826 * and @end contain data.
2827 */
2828loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2829 loff_t end, int whence)
2830{
2831 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002832 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002833 bool seek_data = (whence == SEEK_DATA);
2834 struct page *page;
2835
2836 if (end <= start)
2837 return -ENXIO;
2838
2839 rcu_read_lock();
2840 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002841 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2842 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002843
2844 if (start < pos) {
2845 if (!seek_data)
2846 goto unlock;
2847 start = pos;
2848 }
2849
Hugh Dickinsed98b012021-04-23 14:29:00 -07002850 seek_size = seek_page_size(&xas, page);
2851 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002852 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2853 seek_data);
2854 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002855 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002856 if (start >= end)
2857 break;
2858 if (seek_size > PAGE_SIZE)
2859 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002860 if (!xa_is_value(page))
2861 put_page(page);
2862 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002863 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002864 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002865unlock:
2866 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002867 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002868 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002869 if (start > end)
2870 return end;
2871 return start;
2872}
2873
Linus Torvalds1da177e2005-04-16 15:20:36 -07002874#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002876/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002877 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002878 * @vmf - the vm_fault for this fault.
2879 * @page - the page to lock.
2880 * @fpin - the pointer to the file we may pin (or is already pinned).
2881 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002882 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002883 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002884 * 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 -07002885 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002886 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002887static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2888 struct file **fpin)
2889{
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05002890 struct folio *folio = page_folio(page);
2891
2892 if (folio_trylock(folio))
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002893 return 1;
2894
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002895 /*
2896 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002897 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002898 * is supposed to work. We have way too many special cases..
2899 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002900 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2901 return 0;
2902
2903 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2904 if (vmf->flags & FAULT_FLAG_KILLABLE) {
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05002905 if (__folio_lock_killable(folio)) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002906 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002907 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002908 * but all fault_handlers only check for fatal signals
2909 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002910 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002911 */
2912 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002913 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002914 return 0;
2915 }
2916 } else
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05002917 __folio_lock(folio);
2918
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002919 return 1;
2920}
2921
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002922/*
2923 * Synchronous readahead happens when we don't even find a page in the page
2924 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2925 * to drop the mmap sem we return the file that was pinned in order for us to do
2926 * that. If we didn't pin a file then we return NULL. The file that is
2927 * returned needs to be fput()'ed when we're done with it.
2928 */
2929static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002930{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002931 struct file *file = vmf->vma->vm_file;
2932 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002933 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002934 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002935 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002936 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002937
2938 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002939 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002940 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002941 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002942 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002943
Josef Bacik2a1180f2019-03-13 11:44:18 -07002944 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002945 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002946 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002947 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002948 }
2949
Andi Kleen207d04b2011-05-24 17:12:29 -07002950 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002951 mmap_miss = READ_ONCE(ra->mmap_miss);
2952 if (mmap_miss < MMAP_LOTSAMISS * 10)
2953 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002954
2955 /*
2956 * Do we miss much more than hit in this file? If so,
2957 * stop bothering with read-ahead. It will only hurt.
2958 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002959 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002960 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002961
Wu Fengguangd30a1102009-06-16 15:31:30 -07002962 /*
2963 * mmap read-around
2964 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002965 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002966 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002967 ra->size = ra->ra_pages;
2968 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002969 ractl._index = ra->start;
2970 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002971 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002972}
2973
2974/*
2975 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002976 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002977 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002978 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002979static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2980 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002981{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002982 struct file *file = vmf->vma->vm_file;
2983 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002984 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002985 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002986 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002987 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002988
2989 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002990 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002991 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002992 mmap_miss = READ_ONCE(ra->mmap_miss);
2993 if (mmap_miss)
2994 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002995 if (PageReadahead(page)) {
2996 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002997 page_cache_async_readahead(mapping, ra, file,
2998 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002999 }
3000 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003001}
3002
Randy Dunlap485bb992006-06-23 02:03:49 -07003003/**
Nick Piggin54cb8822007-07-19 01:46:59 -07003004 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07003005 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07003006 *
Nick Piggin54cb8822007-07-19 01:46:59 -07003007 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07003008 * mapped memory region to read in file data during a page fault.
3009 *
3010 * The goto's are kind of ugly, but this streamlines the normal case of having
3011 * it in the page cache, and handles the special cases reasonably without
3012 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003013 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003014 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003015 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003016 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07003017 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003018 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003019 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003020 * has not been released.
3021 *
3022 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08003023 *
3024 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003025 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003026vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003027{
3028 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08003029 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003030 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003031 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003032 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003033 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003034 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003036 vm_fault_t ret = 0;
Jan Kara730633f2021-01-28 19:19:45 +01003037 bool mapping_locked = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003038
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003039 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3040 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07003041 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003042
Linus Torvalds1da177e2005-04-16 15:20:36 -07003043 /*
Johannes Weiner49426422013-10-16 13:46:59 -07003044 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07003045 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003046 page = find_get_page(mapping, offset);
Jan Kara730633f2021-01-28 19:19:45 +01003047 if (likely(page)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003048 /*
Jan Kara730633f2021-01-28 19:19:45 +01003049 * We found the page, so try async readahead before waiting for
3050 * the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003051 */
Jan Kara730633f2021-01-28 19:19:45 +01003052 if (!(vmf->flags & FAULT_FLAG_TRIED))
3053 fpin = do_async_mmap_readahead(vmf, page);
3054 if (unlikely(!PageUptodate(page))) {
3055 filemap_invalidate_lock_shared(mapping);
3056 mapping_locked = true;
3057 }
3058 } else {
Linus Torvaldsef00e082009-06-16 15:31:25 -07003059 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003060 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07003061 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003062 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003063 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003064retry_find:
Jan Kara730633f2021-01-28 19:19:45 +01003065 /*
3066 * See comment in filemap_create_page() why we need
3067 * invalidate_lock
3068 */
3069 if (!mapping_locked) {
3070 filemap_invalidate_lock_shared(mapping);
3071 mapping_locked = true;
3072 }
Josef Bacika75d4c32019-03-13 11:44:14 -07003073 page = pagecache_get_page(mapping, offset,
3074 FGP_CREAT|FGP_FOR_MMAP,
3075 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003076 if (!page) {
3077 if (fpin)
3078 goto out_retry;
Jan Kara730633f2021-01-28 19:19:45 +01003079 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07003080 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003081 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082 }
3083
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003084 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3085 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003086
3087 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003088 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003089 unlock_page(page);
3090 put_page(page);
3091 goto retry_find;
3092 }
Song Liu520e5ba2019-09-23 15:37:50 -07003093 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003094
Linus Torvalds1da177e2005-04-16 15:20:36 -07003095 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003096 * We have a locked page in the page cache, now we need to check
3097 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003098 */
Jan Kara730633f2021-01-28 19:19:45 +01003099 if (unlikely(!PageUptodate(page))) {
3100 /*
3101 * The page was in cache and uptodate and now it is not.
3102 * Strange but possible since we didn't hold the page lock all
3103 * the time. Let's drop everything get the invalidate lock and
3104 * try again.
3105 */
3106 if (!mapping_locked) {
3107 unlock_page(page);
3108 put_page(page);
3109 goto retry_find;
3110 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003111 goto page_not_uptodate;
Jan Kara730633f2021-01-28 19:19:45 +01003112 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003113
Linus Torvaldsef00e082009-06-16 15:31:25 -07003114 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003115 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003116 * time to return to the upper layer and have it re-find the vma and
3117 * redo the fault.
3118 */
3119 if (fpin) {
3120 unlock_page(page);
3121 goto out_retry;
3122 }
Jan Kara730633f2021-01-28 19:19:45 +01003123 if (mapping_locked)
3124 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003125
3126 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003127 * Found the page and have a reference on it.
3128 * We must recheck i_size under page lock.
3129 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003130 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3131 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003132 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003133 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003134 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003135 }
3136
Nick Piggind0217ac2007-07-19 01:47:03 -07003137 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003138 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003139
Linus Torvalds1da177e2005-04-16 15:20:36 -07003140page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003141 /*
3142 * Umm, take care of errors if the page isn't up-to-date.
3143 * Try to re-read it _once_. We do this synchronously,
3144 * because there really aren't any performance issues here
3145 * and we need to check for errors.
3146 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003147 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)d31fa862021-04-29 22:55:26 -07003148 error = filemap_read_page(file, mapping, page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003149 if (fpin)
3150 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003151 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003152
3153 if (!error || error == AOP_TRUNCATED_PAGE)
3154 goto retry_find;
Jan Kara730633f2021-01-28 19:19:45 +01003155 filemap_invalidate_unlock_shared(mapping);
Nick Piggind00806b2007-07-19 01:46:57 -07003156
Nick Piggind0217ac2007-07-19 01:47:03 -07003157 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003158
3159out_retry:
3160 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003161 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003162 * re-find the vma and come back and find our hopefully still populated
3163 * page.
3164 */
3165 if (page)
3166 put_page(page);
Jan Kara730633f2021-01-28 19:19:45 +01003167 if (mapping_locked)
3168 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003169 if (fpin)
3170 fput(fpin);
3171 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003172}
3173EXPORT_SYMBOL(filemap_fault);
3174
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003175static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003176{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003177 struct mm_struct *mm = vmf->vma->vm_mm;
3178
3179 /* Huge page is mapped? No need to proceed. */
3180 if (pmd_trans_huge(*vmf->pmd)) {
3181 unlock_page(page);
3182 put_page(page);
3183 return true;
3184 }
3185
3186 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
Yang Shie0f43fa2021-11-05 13:41:04 -07003187 vm_fault_t ret = do_set_pmd(vmf, page);
3188 if (!ret) {
3189 /* The page is mapped successfully, reference consumed. */
3190 unlock_page(page);
3191 return true;
3192 }
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003193 }
3194
Qi Zheng03c4f202021-11-05 13:38:38 -07003195 if (pmd_none(*vmf->pmd))
3196 pmd_install(mm, vmf->pmd, &vmf->prealloc_pte);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003197
3198 /* See comment in handle_pte_fault() */
3199 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3200 unlock_page(page);
3201 put_page(page);
3202 return true;
3203 }
3204
3205 return false;
3206}
3207
3208static struct page *next_uptodate_page(struct page *page,
3209 struct address_space *mapping,
3210 struct xa_state *xas, pgoff_t end_pgoff)
3211{
3212 unsigned long max_idx;
3213
3214 do {
3215 if (!page)
3216 return NULL;
3217 if (xas_retry(xas, page))
3218 continue;
3219 if (xa_is_value(page))
3220 continue;
3221 if (PageLocked(page))
3222 continue;
3223 if (!page_cache_get_speculative(page))
3224 continue;
3225 /* Has the page moved or been split? */
3226 if (unlikely(page != xas_reload(xas)))
3227 goto skip;
3228 if (!PageUptodate(page) || PageReadahead(page))
3229 goto skip;
3230 if (PageHWPoison(page))
3231 goto skip;
3232 if (!trylock_page(page))
3233 goto skip;
3234 if (page->mapping != mapping)
3235 goto unlock;
3236 if (!PageUptodate(page))
3237 goto unlock;
3238 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3239 if (xas->xa_index >= max_idx)
3240 goto unlock;
3241 return page;
3242unlock:
3243 unlock_page(page);
3244skip:
3245 put_page(page);
3246 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3247
3248 return NULL;
3249}
3250
3251static inline struct page *first_map_page(struct address_space *mapping,
3252 struct xa_state *xas,
3253 pgoff_t end_pgoff)
3254{
3255 return next_uptodate_page(xas_find(xas, end_pgoff),
3256 mapping, xas, end_pgoff);
3257}
3258
3259static inline struct page *next_map_page(struct address_space *mapping,
3260 struct xa_state *xas,
3261 pgoff_t end_pgoff)
3262{
3263 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3264 mapping, xas, end_pgoff);
3265}
3266
3267vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3268 pgoff_t start_pgoff, pgoff_t end_pgoff)
3269{
3270 struct vm_area_struct *vma = vmf->vma;
3271 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003272 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07003273 pgoff_t last_pgoff = start_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003274 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003275 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003276 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003277 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003278 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003279
3280 rcu_read_lock();
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003281 head = first_map_page(mapping, &xas, end_pgoff);
3282 if (!head)
3283 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003284
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003285 if (filemap_map_pmd(vmf, head)) {
3286 ret = VM_FAULT_NOPAGE;
3287 goto out;
3288 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003289
Will Deacon9d3af4b2021-01-14 15:24:19 +00003290 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3291 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003292 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003293 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003294 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003295 goto unlock;
3296
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003297 if (mmap_miss > 0)
3298 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003299
Will Deacon9d3af4b2021-01-14 15:24:19 +00003300 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003301 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003302 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003303
3304 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003305 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003306
Will Deacon46bdb422020-11-24 18:48:26 +00003307 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003308 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003309 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003310
Will Deacon9d3af4b2021-01-14 15:24:19 +00003311 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003312 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003313 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003314 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003315 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003316unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003317 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003318 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003319 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3320 pte_unmap_unlock(vmf->pte, vmf->ptl);
3321out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003322 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003323 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003324 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003325}
3326EXPORT_SYMBOL(filemap_map_pages);
3327
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003328vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003329{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003330 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003331 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003332 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003333
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003334 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003335 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003336 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003337 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003338 unlock_page(page);
3339 ret = VM_FAULT_NOPAGE;
3340 goto out;
3341 }
Jan Kara14da9202012-06-12 16:20:37 +02003342 /*
3343 * We mark the page dirty already here so that when freeze is in
3344 * progress, we are guaranteed that writeback during freezing will
3345 * see the dirty page and writeprotect it again.
3346 */
3347 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003348 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003349out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003350 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003351 return ret;
3352}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003353
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003354const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003355 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003356 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003357 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003358};
3359
3360/* This is used for a general mmap of a disk file */
3361
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003362int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003363{
3364 struct address_space *mapping = file->f_mapping;
3365
3366 if (!mapping->a_ops->readpage)
3367 return -ENOEXEC;
3368 file_accessed(file);
3369 vma->vm_ops = &generic_file_vm_ops;
3370 return 0;
3371}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003372
3373/*
3374 * This is for filesystems which do not implement ->writepage.
3375 */
3376int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3377{
3378 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3379 return -EINVAL;
3380 return generic_file_mmap(file, vma);
3381}
3382#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003383vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003384{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003385 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003386}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003387int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003388{
3389 return -ENOSYS;
3390}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003391int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003392{
3393 return -ENOSYS;
3394}
3395#endif /* CONFIG_MMU */
3396
Arnd Bergmann453972282018-04-13 15:35:27 -07003397EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398EXPORT_SYMBOL(generic_file_mmap);
3399EXPORT_SYMBOL(generic_file_readonly_mmap);
3400
Sasha Levin67f9fd92014-04-03 14:48:18 -07003401static struct page *wait_on_page_read(struct page *page)
3402{
3403 if (!IS_ERR(page)) {
3404 wait_on_page_locked(page);
3405 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003406 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003407 page = ERR_PTR(-EIO);
3408 }
3409 }
3410 return page;
3411}
3412
Mel Gorman32b63522016-03-15 14:55:36 -07003413static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003414 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003415 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003416 void *data,
3417 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003418{
Nick Piggineb2be182007-10-16 01:24:57 -07003419 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003420 int err;
3421repeat:
3422 page = find_get_page(mapping, index);
3423 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003424 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003425 if (!page)
3426 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003427 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003428 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003429 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003430 if (err == -EEXIST)
3431 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003432 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003433 return ERR_PTR(err);
3434 }
Mel Gorman32b63522016-03-15 14:55:36 -07003435
3436filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003437 if (filler)
3438 err = filler(data, page);
3439 else
3440 err = mapping->a_ops->readpage(data, page);
3441
Linus Torvalds1da177e2005-04-16 15:20:36 -07003442 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003443 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003444 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003445 }
Mel Gorman32b63522016-03-15 14:55:36 -07003446
3447 page = wait_on_page_read(page);
3448 if (IS_ERR(page))
3449 return page;
3450 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003452 if (PageUptodate(page))
3453 goto out;
3454
Mel Gormanebded022016-03-15 14:55:39 -07003455 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003456 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003457 * case a: Page is being filled and the page lock is held
3458 * case b: Read/write error clearing the page uptodate status
3459 * case c: Truncation in progress (page locked)
3460 * case d: Reclaim in progress
3461 *
3462 * Case a, the page will be up to date when the page is unlocked.
3463 * There is no need to serialise on the page lock here as the page
3464 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003465 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003466 * it's a race vs truncate race.
3467 * Case b, the page will not be up to date
3468 * Case c, the page may be truncated but in itself, the data may still
3469 * be valid after IO completes as it's a read vs truncate race. The
3470 * operation must restart if the page is not uptodate on unlock but
3471 * otherwise serialising on page lock to stabilise the mapping gives
3472 * no additional guarantees to the caller as the page lock is
3473 * released before return.
3474 * Case d, similar to truncation. If reclaim holds the page lock, it
3475 * will be a race with remove_mapping that determines if the mapping
3476 * is valid on unlock but otherwise the data is valid and there is
3477 * no need to serialise with page lock.
3478 *
3479 * As the page lock gives no additional guarantee, we optimistically
3480 * wait on the page to be unlocked and check if it's up to date and
3481 * use the page if it is. Otherwise, the page lock is required to
3482 * distinguish between the different cases. The motivation is that we
3483 * avoid spurious serialisations and wakeups when multiple processes
3484 * wait on the same page for IO to complete.
3485 */
3486 wait_on_page_locked(page);
3487 if (PageUptodate(page))
3488 goto out;
3489
3490 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003491 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003492
3493 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494 if (!page->mapping) {
3495 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003496 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003497 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003498 }
Mel Gormanebded022016-03-15 14:55:39 -07003499
3500 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003501 if (PageUptodate(page)) {
3502 unlock_page(page);
3503 goto out;
3504 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003505
3506 /*
3507 * A previous I/O error may have been due to temporary
3508 * failures.
3509 * Clear page error before actual read, PG_error will be
3510 * set again if read page fails.
3511 */
3512 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003513 goto filler;
3514
David Howellsc855ff32007-05-09 13:42:20 +01003515out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003516 mark_page_accessed(page);
3517 return page;
3518}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003519
3520/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003521 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003522 * @mapping: the page's address_space
3523 * @index: the page index
3524 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003525 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003526 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003527 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003528 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003529 *
3530 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003531 *
Jan Kara730633f2021-01-28 19:19:45 +01003532 * The function expects mapping->invalidate_lock to be already held.
3533 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003534 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003535 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003536struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003537 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003538 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003539 void *data)
3540{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003541 return do_read_cache_page(mapping, index, filler, data,
3542 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003543}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003544EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003545
3546/**
3547 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3548 * @mapping: the page's address_space
3549 * @index: the page index
3550 * @gfp: the page allocator flags to use if allocating
3551 *
3552 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003553 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003554 *
3555 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003556 *
Jan Kara730633f2021-01-28 19:19:45 +01003557 * The function expects mapping->invalidate_lock to be already held.
3558 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003559 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003560 */
3561struct page *read_cache_page_gfp(struct address_space *mapping,
3562 pgoff_t index,
3563 gfp_t gfp)
3564{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003565 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003566}
3567EXPORT_SYMBOL(read_cache_page_gfp);
3568
Nick Pigginafddba42007-10-16 01:25:01 -07003569int pagecache_write_begin(struct file *file, struct address_space *mapping,
3570 loff_t pos, unsigned len, unsigned flags,
3571 struct page **pagep, void **fsdata)
3572{
3573 const struct address_space_operations *aops = mapping->a_ops;
3574
Nick Piggin4e02ed42008-10-29 14:00:55 -07003575 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003576 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003577}
3578EXPORT_SYMBOL(pagecache_write_begin);
3579
3580int pagecache_write_end(struct file *file, struct address_space *mapping,
3581 loff_t pos, unsigned len, unsigned copied,
3582 struct page *page, void *fsdata)
3583{
3584 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003585
Nick Piggin4e02ed42008-10-29 14:00:55 -07003586 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003587}
3588EXPORT_SYMBOL(pagecache_write_end);
3589
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003590/*
3591 * Warn about a page cache invalidation failure during a direct I/O write.
3592 */
3593void dio_warn_stale_pagecache(struct file *filp)
3594{
3595 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3596 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003597 char *path;
3598
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003599 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003600 if (__ratelimit(&_rs)) {
3601 path = file_path(filp, pathname, sizeof(pathname));
3602 if (IS_ERR(path))
3603 path = "(unknown)";
3604 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3605 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3606 current->comm);
3607 }
3608}
3609
Linus Torvalds1da177e2005-04-16 15:20:36 -07003610ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003611generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003612{
3613 struct file *file = iocb->ki_filp;
3614 struct address_space *mapping = file->f_mapping;
3615 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003616 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003617 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003618 size_t write_len;
3619 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003620
Al Viro0c949332014-03-22 06:51:37 -04003621 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003622 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003623
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003624 if (iocb->ki_flags & IOCB_NOWAIT) {
3625 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003626 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003627 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003628 return -EAGAIN;
3629 } else {
3630 written = filemap_write_and_wait_range(mapping, pos,
3631 pos + write_len - 1);
3632 if (written)
3633 goto out;
3634 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003635
3636 /*
3637 * After a write we want buffered reads to be sure to go to disk to get
3638 * the new data. We invalidate clean cached page from the region we're
3639 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003640 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003641 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003642 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003643 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003644 /*
3645 * If a page can not be invalidated, return 0 to fall back
3646 * to buffered write.
3647 */
3648 if (written) {
3649 if (written == -EBUSY)
3650 return 0;
3651 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003652 }
3653
Al Viro639a93a52017-04-13 14:10:15 -04003654 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003655
3656 /*
3657 * Finally, try again to invalidate clean pages which might have been
3658 * cached by non-direct readahead, or faulted in by get_user_pages()
3659 * if the source of the write was an mmap'ed region of the file
3660 * we're writing. Either one is a pretty crazy thing to do,
3661 * so we don't support it 100%. If this invalidation
3662 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003663 *
3664 * Most of the time we do not need this since dio_complete() will do
3665 * the invalidation for us. However there are some file systems that
3666 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003667 * them by removing it completely.
3668 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003669 * Noticeable example is a blkdev_direct_IO().
3670 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003671 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003672 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003673 if (written > 0 && mapping->nrpages &&
3674 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3675 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003676
Linus Torvalds1da177e2005-04-16 15:20:36 -07003677 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003678 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003679 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003680 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3681 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003682 mark_inode_dirty(inode);
3683 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003684 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003685 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003686 if (written != -EIOCBQUEUED)
3687 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003688out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003689 return written;
3690}
3691EXPORT_SYMBOL(generic_file_direct_write);
3692
Al Viro3b93f912014-02-11 21:34:08 -05003693ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003694 struct iov_iter *i, loff_t pos)
3695{
3696 struct address_space *mapping = file->f_mapping;
3697 const struct address_space_operations *a_ops = mapping->a_ops;
3698 long status = 0;
3699 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003700 unsigned int flags = 0;
3701
Nick Pigginafddba42007-10-16 01:25:01 -07003702 do {
3703 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003704 unsigned long offset; /* Offset into pagecache page */
3705 unsigned long bytes; /* Bytes to write to page */
3706 size_t copied; /* Bytes copied from user */
3707 void *fsdata;
3708
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003709 offset = (pos & (PAGE_SIZE - 1));
3710 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003711 iov_iter_count(i));
3712
3713again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003714 /*
3715 * Bring in the user page that we will copy from _first_.
3716 * Otherwise there's a nasty deadlock on copying from the
3717 * same page as we're writing to, without it being marked
3718 * up-to-date.
Linus Torvalds00a3d662015-10-07 08:32:38 +01003719 */
Andreas Gruenbachera6294592021-08-02 14:54:16 +02003720 if (unlikely(fault_in_iov_iter_readable(i, bytes))) {
Linus Torvalds00a3d662015-10-07 08:32:38 +01003721 status = -EFAULT;
3722 break;
3723 }
3724
Jan Kara296291c2015-10-22 13:32:21 -07003725 if (fatal_signal_pending(current)) {
3726 status = -EINTR;
3727 break;
3728 }
3729
Nick Piggin674b8922007-10-16 01:25:03 -07003730 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003731 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003732 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003733 break;
3734
anfei zhou931e80e2010-02-02 13:44:02 -08003735 if (mapping_writably_mapped(mapping))
3736 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003737
Al Virof0b65f32021-04-30 10:26:41 -04003738 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
Nick Pigginafddba42007-10-16 01:25:01 -07003739 flush_dcache_page(page);
3740
3741 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3742 page, fsdata);
Al Virof0b65f32021-04-30 10:26:41 -04003743 if (unlikely(status != copied)) {
3744 iov_iter_revert(i, copied - max(status, 0L));
3745 if (unlikely(status < 0))
3746 break;
3747 }
Nick Pigginafddba42007-10-16 01:25:01 -07003748 cond_resched();
3749
Al Virobc1bb412021-05-31 00:32:44 -04003750 if (unlikely(status == 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07003751 /*
Al Virobc1bb412021-05-31 00:32:44 -04003752 * A short copy made ->write_end() reject the
3753 * thing entirely. Might be memory poisoning
3754 * halfway through, might be a race with munmap,
3755 * might be severe memory pressure.
Nick Pigginafddba42007-10-16 01:25:01 -07003756 */
Al Virobc1bb412021-05-31 00:32:44 -04003757 if (copied)
3758 bytes = copied;
Nick Pigginafddba42007-10-16 01:25:01 -07003759 goto again;
3760 }
Al Virof0b65f32021-04-30 10:26:41 -04003761 pos += status;
3762 written += status;
Nick Pigginafddba42007-10-16 01:25:01 -07003763
3764 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003765 } while (iov_iter_count(i));
3766
3767 return written ? written : status;
3768}
Al Viro3b93f912014-02-11 21:34:08 -05003769EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003770
Jan Karae4dd9de2009-08-17 18:10:06 +02003771/**
Al Viro81742022014-04-03 03:17:43 -04003772 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003773 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003774 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003775 *
3776 * This function does all the work needed for actually writing data to a
3777 * file. It does all basic checks, removes SUID from the file, updates
3778 * modification times and calls proper subroutines depending on whether we
3779 * do direct IO or a standard buffered write.
3780 *
Jan Kara96087032021-04-12 15:50:21 +02003781 * It expects i_rwsem to be grabbed unless we work on a block device or similar
Jan Karae4dd9de2009-08-17 18:10:06 +02003782 * object which does not need locking at all.
3783 *
3784 * This function does *not* take care of syncing data in case of O_SYNC write.
3785 * A caller has to handle it. This is mainly due to the fact that we want to
Jan Kara96087032021-04-12 15:50:21 +02003786 * avoid syncing under i_rwsem.
Mike Rapoporta862f682019-03-05 15:48:42 -08003787 *
3788 * Return:
3789 * * number of bytes written, even for truncated writes
3790 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003791 */
Al Viro81742022014-04-03 03:17:43 -04003792ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003793{
3794 struct file *file = iocb->ki_filp;
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003795 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003796 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003797 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003798 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003799 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003800
Linus Torvalds1da177e2005-04-16 15:20:36 -07003801 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003802 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003803 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003804 if (err)
3805 goto out;
3806
Josef Bacikc3b2da32012-03-26 09:59:21 -04003807 err = file_update_time(file);
3808 if (err)
3809 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003810
Al Viro2ba48ce2015-04-09 13:52:01 -04003811 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003812 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003813
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003814 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003815 /*
3816 * If the write stopped short of completing, fall back to
3817 * buffered writes. Some filesystems do this for writes to
3818 * holes, for example. For DAX files, a buffered write will
3819 * not succeed (even if it did, DAX does not handle dirty
3820 * page-cache pages correctly).
3821 */
Al Viro0b8def92015-04-07 10:22:53 -04003822 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003823 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003824
Al Viro0b8def92015-04-07 10:22:53 -04003825 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003826 /*
Al Viro3b93f912014-02-11 21:34:08 -05003827 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003828 * then we want to return the number of bytes which were
3829 * direct-written, or the error code if that was zero. Note
3830 * that this differs from normal direct-io semantics, which
3831 * will return -EFOO even if some bytes were written.
3832 */
Al Viro60bb4522014-08-08 12:39:16 -04003833 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003834 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003835 goto out;
3836 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003837 /*
3838 * We need to ensure that the page cache pages are written to
3839 * disk and invalidated to preserve the expected O_DIRECT
3840 * semantics.
3841 */
Al Viro3b93f912014-02-11 21:34:08 -05003842 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003843 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003844 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003845 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003846 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003847 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003848 pos >> PAGE_SHIFT,
3849 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003850 } else {
3851 /*
3852 * We don't know how much we wrote, so just return
3853 * the number of bytes which were direct-written
3854 */
3855 }
3856 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003857 written = generic_perform_write(file, from, iocb->ki_pos);
3858 if (likely(written > 0))
3859 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003860 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003861out:
3862 current->backing_dev_info = NULL;
3863 return written ? written : err;
3864}
Al Viro81742022014-04-03 03:17:43 -04003865EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003866
Jan Karae4dd9de2009-08-17 18:10:06 +02003867/**
Al Viro81742022014-04-03 03:17:43 -04003868 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003869 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003870 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003871 *
Al Viro81742022014-04-03 03:17:43 -04003872 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003873 * filesystems. It takes care of syncing the file in case of O_SYNC file
Jan Kara96087032021-04-12 15:50:21 +02003874 * and acquires i_rwsem as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003875 * Return:
3876 * * negative error code if no data has been written at all of
3877 * vfs_fsync_range() failed for a synchronous write
3878 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003879 */
Al Viro81742022014-04-03 03:17:43 -04003880ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003881{
3882 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003883 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003884 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003885
Al Viro59551022016-01-22 15:40:57 -05003886 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003887 ret = generic_write_checks(iocb, from);
3888 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003889 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003890 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003891
Christoph Hellwige2592212016-04-07 08:52:01 -07003892 if (ret > 0)
3893 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003894 return ret;
3895}
Al Viro81742022014-04-03 03:17:43 -04003896EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003897
David Howellscf9a2ae2006-08-29 19:05:54 +01003898/**
3899 * try_to_release_page() - release old fs-specific metadata on a page
3900 *
3901 * @page: the page which the kernel is trying to free
3902 * @gfp_mask: memory allocation flags (and I/O mode)
3903 *
3904 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003905 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003906 *
David Howells266cf652009-04-03 16:42:36 +01003907 * This may also be called if PG_fscache is set on a page, indicating that the
3908 * page is known to the local caching routines.
3909 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003910 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003911 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003912 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003913 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003914 */
3915int try_to_release_page(struct page *page, gfp_t gfp_mask)
3916{
3917 struct address_space * const mapping = page->mapping;
3918
3919 BUG_ON(!PageLocked(page));
3920 if (PageWriteback(page))
3921 return 0;
3922
3923 if (mapping && mapping->a_ops->releasepage)
3924 return mapping->a_ops->releasepage(page, gfp_mask);
3925 return try_to_free_buffers(page);
3926}
3927
3928EXPORT_SYMBOL(try_to_release_page);