blob: 38fb26e16b8595ed40fe81207701567de7fa53e8 [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,
Matthew Wilcox (Oracle)a548b612021-05-08 00:35:49 -0400124 struct folio *folio, void *shadow)
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700125{
Matthew Wilcox (Oracle)a548b612021-05-08 00:35:49 -0400126 XA_STATE(xas, &mapping->i_pages, folio->index);
127 long 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 */
Matthew Wilcox (Oracle)a548b612021-05-08 00:35:49 -0400132 if (!folio_test_hugetlb(folio)) {
133 xas_set_order(&xas, folio->index, folio_order(folio));
134 nr = folio_nr_pages(folio);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500135 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700136
Matthew Wilcox (Oracle)a548b612021-05-08 00:35:49 -0400137 VM_BUG_ON_FOLIO(!folio_test_locked(folio), folio);
138 VM_BUG_ON_FOLIO(nr != 1 && shadow, folio);
Johannes Weiner449dd692014-04-03 14:47:56 -0700139
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500140 xas_store(&xas, shadow);
141 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200142
Matthew Wilcox (Oracle)a548b612021-05-08 00:35:49 -0400143 folio->mapping = NULL;
Jan Kara23006382017-11-15 17:37:26 -0800144 /* Leave page->index set: truncation lookup relies upon it */
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200145 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700146}
147
Jan Kara5ecc4d82017-11-15 17:37:29 -0800148static void unaccount_page_cache_page(struct address_space *mapping,
149 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800151 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600153 /*
154 * if we're uptodate, flush out into the cleancache, otherwise
155 * invalidate any existing cleancache entries. We can't leave
156 * stale data around in the cleancache once our page is gone
157 */
158 if (PageUptodate(page) && PageMappedToDisk(page))
159 cleancache_put_page(page);
160 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400161 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600162
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700163 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800164 VM_BUG_ON_PAGE(page_mapped(page), page);
165 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
166 int mapcount;
167
168 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
169 current->comm, page_to_pfn(page));
170 dump_page(page, "still mapped when deleted");
171 dump_stack();
172 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
173
174 mapcount = page_mapcount(page);
175 if (mapping_exiting(mapping) &&
176 page_count(page) >= mapcount + 2) {
177 /*
178 * All vmas have already been torn down, so it's
179 * a good bet that actually the page is unmapped,
180 * and we'd prefer not to leak it: if we're wrong,
181 * some other bad page check should catch it later.
182 */
183 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700184 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800185 }
186 }
187
Jan Kara76253fb2017-11-15 17:37:22 -0800188 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800189 if (PageHuge(page))
190 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800191
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700192 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800193
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700194 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800195 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700196 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800197 if (PageTransHuge(page))
Muchun Song57b28472021-02-24 12:03:31 -0800198 __mod_lruvec_page_state(page, NR_SHMEM_THPS, -nr);
Song Liu99cb0db2019-09-23 15:38:00 -0700199 } else if (PageTransHuge(page)) {
Muchun Songbf9ecea2021-02-24 12:03:27 -0800200 __mod_lruvec_page_state(page, NR_FILE_THPS, -nr);
Song Liu09d91cd2019-09-23 15:38:03 -0700201 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800202 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800203
204 /*
205 * At this point page must be either written or cleaned by
206 * truncate. Dirty page here signals a bug and loss of
207 * unwritten data.
208 *
209 * This fixes dirty accounting after removing the page entirely
210 * but leaves PageDirty set: it has no effect for truncated
211 * page and anyway will be cleared before returning page into
212 * buddy allocator.
213 */
214 if (WARN_ON_ONCE(PageDirty(page)))
215 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
216}
217
218/*
219 * Delete a page from the page cache and free it. Caller has to make
220 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700221 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800222 */
223void __delete_from_page_cache(struct page *page, void *shadow)
224{
Matthew Wilcox (Oracle)a548b612021-05-08 00:35:49 -0400225 struct folio *folio = page_folio(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800226 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 Wilcox (Oracle)a548b612021-05-08 00:35:49 -0400231 page_cache_delete(mapping, folio, 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 Axboef8ee8902021-11-05 13:37:13 -0700649static bool filemap_range_has_writeback(struct address_space *mapping,
650 loff_t start_byte, loff_t end_byte)
651{
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;
670
671}
672
Randy Dunlap485bb992006-06-23 02:03:49 -0700673/**
Jens Axboe63135aa2021-04-29 22:55:18 -0700674 * filemap_range_needs_writeback - check if range potentially needs writeback
675 * @mapping: address space within which to check
676 * @start_byte: offset in bytes where the range starts
677 * @end_byte: offset in bytes where the range ends (inclusive)
678 *
679 * Find at least one page in the range supplied, usually used to check if
680 * direct writing in this range will trigger a writeback. Used by O_DIRECT
681 * read/write with IOCB_NOWAIT, to see if the caller needs to do
682 * filemap_write_and_wait_range() before proceeding.
683 *
684 * Return: %true if the caller should do filemap_write_and_wait_range() before
685 * doing O_DIRECT to a page in this range, %false otherwise.
686 */
687bool filemap_range_needs_writeback(struct address_space *mapping,
688 loff_t start_byte, loff_t end_byte)
689{
Jens Axboe63135aa2021-04-29 22:55:18 -0700690 if (!mapping_needs_writeback(mapping))
691 return false;
692 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
693 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
694 return false;
Jens Axboef8ee8902021-11-05 13:37:13 -0700695 return filemap_range_has_writeback(mapping, start_byte, end_byte);
Jens Axboe63135aa2021-04-29 22:55:18 -0700696}
697EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
698
699/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700700 * filemap_write_and_wait_range - write out & wait on a file range
701 * @mapping: the address_space for the pages
702 * @lstart: offset in bytes where the range starts
703 * @lend: offset in bytes where the range ends (inclusive)
704 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800705 * Write out and wait upon file offsets lstart->lend, inclusive.
706 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300707 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800708 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800709 *
710 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800711 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712int filemap_write_and_wait_range(struct address_space *mapping,
713 loff_t lstart, loff_t lend)
714{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800715 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716
Jeff Layton9326c9b2017-07-26 10:21:11 -0400717 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800718 err = __filemap_fdatawrite_range(mapping, lstart, lend,
719 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800720 /*
721 * Even if the above returned error, the pages may be
722 * written partially (e.g. -ENOSPC), so we wait for it.
723 * But the -EIO is special case, it may indicate the worst
724 * thing (e.g. bug) happened, so we avoid waiting for it.
725 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800726 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200727 int err2 = filemap_fdatawait_range(mapping,
728 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800729 if (!err)
730 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400731 } else {
732 /* Clear any previously stored errors */
733 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800734 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700735 } else {
736 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800738 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739}
Chris Masonf6995582009-04-15 13:22:37 -0400740EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
Jeff Layton5660e132017-07-06 07:02:25 -0400742void __filemap_set_wb_err(struct address_space *mapping, int err)
743{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400744 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400745
746 trace_filemap_set_wb_err(mapping, eseq);
747}
748EXPORT_SYMBOL(__filemap_set_wb_err);
749
750/**
751 * file_check_and_advance_wb_err - report wb error (if any) that was previously
752 * and advance wb_err to current one
753 * @file: struct file on which the error is being reported
754 *
755 * When userland calls fsync (or something like nfsd does the equivalent), we
756 * want to report any writeback errors that occurred since the last fsync (or
757 * since the file was opened if there haven't been any).
758 *
759 * Grab the wb_err from the mapping. If it matches what we have in the file,
760 * then just quickly return 0. The file is all caught up.
761 *
762 * If it doesn't match, then take the mapping value, set the "seen" flag in
763 * it and try to swap it into place. If it works, or another task beat us
764 * to it with the new value, then update the f_wb_err and return the error
765 * portion. The error at this point must be reported via proper channels
766 * (a'la fsync, or NFS COMMIT operation, etc.).
767 *
768 * While we handle mapping->wb_err with atomic operations, the f_wb_err
769 * value is protected by the f_lock since we must ensure that it reflects
770 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800771 *
772 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400773 */
774int file_check_and_advance_wb_err(struct file *file)
775{
776 int err = 0;
777 errseq_t old = READ_ONCE(file->f_wb_err);
778 struct address_space *mapping = file->f_mapping;
779
780 /* Locklessly handle the common case where nothing has changed */
781 if (errseq_check(&mapping->wb_err, old)) {
782 /* Something changed, must use slow path */
783 spin_lock(&file->f_lock);
784 old = file->f_wb_err;
785 err = errseq_check_and_advance(&mapping->wb_err,
786 &file->f_wb_err);
787 trace_file_check_and_advance_wb_err(file, old);
788 spin_unlock(&file->f_lock);
789 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700790
791 /*
792 * We're mostly using this function as a drop in replacement for
793 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
794 * that the legacy code would have had on these flags.
795 */
796 clear_bit(AS_EIO, &mapping->flags);
797 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400798 return err;
799}
800EXPORT_SYMBOL(file_check_and_advance_wb_err);
801
802/**
803 * file_write_and_wait_range - write out & wait on a file range
804 * @file: file pointing to address_space with pages
805 * @lstart: offset in bytes where the range starts
806 * @lend: offset in bytes where the range ends (inclusive)
807 *
808 * Write out and wait upon file offsets lstart->lend, inclusive.
809 *
810 * Note that @lend is inclusive (describes the last byte to be written) so
811 * that this function can be used to write to the very end-of-file (end = -1).
812 *
813 * After writing out and waiting on the data, we check and advance the
814 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800815 *
816 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400817 */
818int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
819{
820 int err = 0, err2;
821 struct address_space *mapping = file->f_mapping;
822
Jeff Layton9326c9b2017-07-26 10:21:11 -0400823 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400824 err = __filemap_fdatawrite_range(mapping, lstart, lend,
825 WB_SYNC_ALL);
826 /* See comment of filemap_write_and_wait() */
827 if (err != -EIO)
828 __filemap_fdatawait_range(mapping, lstart, lend);
829 }
830 err2 = file_check_and_advance_wb_err(file);
831 if (!err)
832 err = err2;
833 return err;
834}
835EXPORT_SYMBOL(file_write_and_wait_range);
836
Randy Dunlap485bb992006-06-23 02:03:49 -0700837/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700838 * replace_page_cache_page - replace a pagecache page with a new one
839 * @old: page to be replaced
840 * @new: page to replace with
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700841 *
842 * This function replaces a page in the pagecache with a new one. On
843 * success it acquires the pagecache reference for the new page and
844 * drops it for the old page. Both the old and new pages must be
845 * locked. This function does not add the new page to the LRU, the
846 * caller must do that.
847 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500848 * The remove + add is atomic. This function cannot fail.
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700849 */
Baolin Wang1f7ef652021-02-24 12:01:42 -0800850void replace_page_cache_page(struct page *old, struct page *new)
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700851{
Matthew Wilcox (Oracle)d21bba22021-05-06 18:14:59 -0400852 struct folio *fold = page_folio(old);
853 struct folio *fnew = page_folio(new);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500854 struct address_space *mapping = old->mapping;
855 void (*freepage)(struct page *) = mapping->a_ops->freepage;
856 pgoff_t offset = old->index;
857 XA_STATE(xas, &mapping->i_pages, offset);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700858
Sasha Levin309381fea2014-01-23 15:52:54 -0800859 VM_BUG_ON_PAGE(!PageLocked(old), old);
860 VM_BUG_ON_PAGE(!PageLocked(new), new);
861 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700862
Matthew Wilcox74d60952017-11-17 10:01:45 -0500863 get_page(new);
864 new->mapping = mapping;
865 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700866
Matthew Wilcox (Oracle)d21bba22021-05-06 18:14:59 -0400867 mem_cgroup_migrate(fold, fnew);
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700868
Johannes Weiner30472502021-09-02 14:53:18 -0700869 xas_lock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500870 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700871
Matthew Wilcox74d60952017-11-17 10:01:45 -0500872 old->mapping = NULL;
873 /* hugetlb pages do not participate in page cache accounting. */
874 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700875 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500876 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700877 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500878 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700879 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500880 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700881 __inc_lruvec_page_state(new, NR_SHMEM);
Johannes Weiner30472502021-09-02 14:53:18 -0700882 xas_unlock_irq(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500883 if (freepage)
884 freepage(old);
885 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700886}
887EXPORT_SYMBOL_GPL(replace_page_cache_page);
888
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500889noinline int __filemap_add_folio(struct address_space *mapping,
890 struct folio *folio, pgoff_t index, gfp_t gfp, void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891{
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500892 XA_STATE(xas, &mapping->i_pages, index);
893 int huge = folio_test_hugetlb(folio);
Nick Piggine2867812008-07-25 19:45:30 -0700894 int error;
Waiman Longda742402021-02-04 18:32:45 -0800895 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700896
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500897 VM_BUG_ON_FOLIO(!folio_test_locked(folio), folio);
898 VM_BUG_ON_FOLIO(folio_test_swapbacked(folio), folio);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500899 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700900
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500901 folio_get(folio);
902 folio->mapping = mapping;
903 folio->index = index;
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700904
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700905 if (!huge) {
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500906 error = mem_cgroup_charge(folio, NULL, gfp);
907 VM_BUG_ON_FOLIO(index & (folio_nr_pages(folio) - 1), folio);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700908 if (error)
909 goto error;
Waiman Longda742402021-02-04 18:32:45 -0800910 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700911 }
912
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700913 gfp &= GFP_RECLAIM_MASK;
914
Matthew Wilcox74d60952017-11-17 10:01:45 -0500915 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700916 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
917 void *entry, *old = NULL;
918
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500919 if (order > folio_order(folio))
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700920 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
921 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500922 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700923 xas_for_each_conflict(&xas, entry) {
924 old = entry;
925 if (!xa_is_value(entry)) {
926 xas_set_err(&xas, -EEXIST);
927 goto unlock;
928 }
929 }
930
931 if (old) {
932 if (shadowp)
933 *shadowp = old;
934 /* entry may have been split before we acquired lock */
935 order = xa_get_order(xas.xa, xas.xa_index);
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500936 if (order > folio_order(folio)) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700937 xas_split(&xas, old, order);
938 xas_reset(&xas);
939 }
940 }
941
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500942 xas_store(&xas, folio);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500943 if (xas_error(&xas))
944 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700945
Matthew Wilcox74d60952017-11-17 10:01:45 -0500946 mapping->nrpages++;
947
948 /* hugetlb pages do not participate in page cache accounting */
949 if (!huge)
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500950 __lruvec_stat_add_folio(folio, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500951unlock:
952 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700953 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500954
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700955 if (xas_error(&xas)) {
956 error = xas_error(&xas);
Waiman Longda742402021-02-04 18:32:45 -0800957 if (charged)
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500958 mem_cgroup_uncharge(folio);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500959 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700960 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500961
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500962 trace_mm_filemap_add_to_page_cache(&folio->page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700963 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500964error:
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500965 folio->mapping = NULL;
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700966 /* Leave page->index set: truncation relies upon it */
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500967 folio_put(folio);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700968 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969}
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500970ALLOW_ERROR_INJECTION(__filemap_add_folio, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700971
972/**
973 * add_to_page_cache_locked - add a locked page to the pagecache
974 * @page: page to add
975 * @mapping: the page's address_space
976 * @offset: page index
977 * @gfp_mask: page allocation mode
978 *
979 * This function is used to add a page to the pagecache. It must be locked.
980 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800981 *
982 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700983 */
984int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
985 pgoff_t offset, gfp_t gfp_mask)
986{
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500987 return __filemap_add_folio(mapping, page_folio(page), offset,
Johannes Weinera5289102014-04-03 14:47:51 -0700988 gfp_mask, NULL);
989}
Nick Piggine2867812008-07-25 19:45:30 -0700990EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500992int filemap_add_folio(struct address_space *mapping, struct folio *folio,
993 pgoff_t index, gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994{
Johannes Weinera5289102014-04-03 14:47:51 -0700995 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700996 int ret;
997
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -0500998 __folio_set_locked(folio);
999 ret = __filemap_add_folio(mapping, folio, index, gfp, &shadow);
Johannes Weinera5289102014-04-03 14:47:51 -07001000 if (unlikely(ret))
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -05001001 __folio_clear_locked(folio);
Johannes Weinera5289102014-04-03 14:47:51 -07001002 else {
1003 /*
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -05001004 * The folio might have been evicted from cache only
Johannes Weinera5289102014-04-03 14:47:51 -07001005 * recently, in which case it should be activated like
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -05001006 * any other repeatedly accessed folio.
1007 * The exception is folios getting rewritten; evicting other
Rik van Rielf0281a02016-05-20 16:56:25 -07001008 * data from the working set, only to cache data that will
1009 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -07001010 */
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -05001011 WARN_ON_ONCE(folio_test_active(folio));
1012 if (!(gfp & __GFP_WRITE) && shadow)
1013 workingset_refault(folio, shadow);
1014 folio_add_lru(folio);
Johannes Weinera5289102014-04-03 14:47:51 -07001015 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 return ret;
1017}
Matthew Wilcox (Oracle)9dd3d062020-12-08 08:56:28 -05001018EXPORT_SYMBOL_GPL(filemap_add_folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001019
Paul Jackson44110fe2006-03-24 03:16:04 -08001020#ifdef CONFIG_NUMA
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001021struct folio *filemap_alloc_folio(gfp_t gfp, unsigned int order)
Paul Jackson44110fe2006-03-24 03:16:04 -08001022{
Miao Xiec0ff7452010-05-24 14:32:08 -07001023 int n;
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001024 struct folio *folio;
Miao Xiec0ff7452010-05-24 14:32:08 -07001025
Paul Jackson44110fe2006-03-24 03:16:04 -08001026 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -07001027 unsigned int cpuset_mems_cookie;
1028 do {
Mel Gormand26914d2014-04-03 14:47:24 -07001029 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -07001030 n = cpuset_mem_spread_node();
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001031 folio = __folio_alloc_node(gfp, order, n);
1032 } while (!folio && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -07001033
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001034 return folio;
Paul Jackson44110fe2006-03-24 03:16:04 -08001035 }
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001036 return folio_alloc(gfp, order);
Paul Jackson44110fe2006-03-24 03:16:04 -08001037}
Matthew Wilcox (Oracle)bb3c5792020-12-15 23:11:07 -05001038EXPORT_SYMBOL(filemap_alloc_folio);
Paul Jackson44110fe2006-03-24 03:16:04 -08001039#endif
1040
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041/*
Jan Kara7506ae62021-05-24 13:02:30 +02001042 * filemap_invalidate_lock_two - lock invalidate_lock for two mappings
1043 *
1044 * Lock exclusively invalidate_lock of any passed mapping that is not NULL.
1045 *
1046 * @mapping1: the first mapping to lock
1047 * @mapping2: the second mapping to lock
1048 */
1049void filemap_invalidate_lock_two(struct address_space *mapping1,
1050 struct address_space *mapping2)
1051{
1052 if (mapping1 > mapping2)
1053 swap(mapping1, mapping2);
1054 if (mapping1)
1055 down_write(&mapping1->invalidate_lock);
1056 if (mapping2 && mapping1 != mapping2)
1057 down_write_nested(&mapping2->invalidate_lock, 1);
1058}
1059EXPORT_SYMBOL(filemap_invalidate_lock_two);
1060
1061/*
1062 * filemap_invalidate_unlock_two - unlock invalidate_lock for two mappings
1063 *
1064 * Unlock exclusive invalidate_lock of any passed mapping that is not NULL.
1065 *
1066 * @mapping1: the first mapping to unlock
1067 * @mapping2: the second mapping to unlock
1068 */
1069void filemap_invalidate_unlock_two(struct address_space *mapping1,
1070 struct address_space *mapping2)
1071{
1072 if (mapping1)
1073 up_write(&mapping1->invalidate_lock);
1074 if (mapping2 && mapping1 != mapping2)
1075 up_write(&mapping2->invalidate_lock);
1076}
1077EXPORT_SYMBOL(filemap_invalidate_unlock_two);
1078
1079/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 * In order to wait for pages to become available there must be
1081 * waitqueues associated with pages. By using a hash table of
1082 * waitqueues where the bucket discipline is to maintain all
1083 * waiters on the same queue and wake all when any of the pages
1084 * become available, and for the woken contexts to check to be
1085 * sure the appropriate page became available, this saves space
1086 * at a cost of "thundering herd" phenomena during rare hash
1087 * collisions.
1088 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001089#define PAGE_WAIT_TABLE_BITS 8
1090#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001091static wait_queue_head_t folio_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
Nicholas Piggin62906022016-12-25 13:00:30 +10001092
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001093static wait_queue_head_t *folio_waitqueue(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001095 return &folio_wait_table[hash_ptr(folio, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096}
Nicholas Piggin62906022016-12-25 13:00:30 +10001097
1098void __init pagecache_init(void)
1099{
1100 int i;
1101
1102 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001103 init_waitqueue_head(&folio_wait_table[i]);
Nicholas Piggin62906022016-12-25 13:00:30 +10001104
1105 page_writeback_init();
1106}
1107
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001108/*
1109 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001110 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001111 * one.
1112 *
1113 * We have:
1114 *
1115 * (a) no special bits set:
1116 *
1117 * We're just waiting for the bit to be released, and when a waker
1118 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1119 * and remove it from the wait queue.
1120 *
1121 * Simple and straightforward.
1122 *
1123 * (b) WQ_FLAG_EXCLUSIVE:
1124 *
1125 * The waiter is waiting to get the lock, and only one waiter should
1126 * be woken up to avoid any thundering herd behavior. We'll set the
1127 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1128 *
1129 * This is the traditional exclusive wait.
1130 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001131 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001132 *
1133 * The waiter is waiting to get the bit, and additionally wants the
1134 * lock to be transferred to it for fair lock behavior. If the lock
1135 * cannot be taken, we stop walking the wait queue without waking
1136 * the waiter.
1137 *
1138 * This is the "fair lock handoff" case, and in addition to setting
1139 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1140 * that it now has the lock.
1141 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001142static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001143{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001144 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001145 struct wait_page_key *key = arg;
1146 struct wait_page_queue *wait_page
1147 = container_of(wait, struct wait_page_queue, wait);
1148
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001149 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001150 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001151
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001152 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001153 * If it's a lock handoff wait, we get the bit for it, and
1154 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001155 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001156 flags = wait->flags;
1157 if (flags & WQ_FLAG_EXCLUSIVE) {
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001158 if (test_bit(key->bit_nr, &key->folio->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001159 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001160 if (flags & WQ_FLAG_CUSTOM) {
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001161 if (test_and_set_bit(key->bit_nr, &key->folio->flags))
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001162 return -1;
1163 flags |= WQ_FLAG_DONE;
1164 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001165 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001166
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001167 /*
1168 * We are holding the wait-queue lock, but the waiter that
1169 * is waiting for this will be checking the flags without
1170 * any locking.
1171 *
1172 * So update the flags atomically, and wake up the waiter
1173 * afterwards to avoid any races. This store-release pairs
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001174 * with the load-acquire in folio_wait_bit_common().
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001175 */
1176 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001177 wake_up_state(wait->private, mode);
1178
1179 /*
1180 * Ok, we have successfully done what we're waiting for,
1181 * and we can unconditionally remove the wait entry.
1182 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001183 * Note that this pairs with the "finish_wait()" in the
1184 * waiter, and has to be the absolute last thing we do.
1185 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001186 * might be de-allocated and the process might even have
1187 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001188 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001189 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001190 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001191}
1192
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001193static void folio_wake_bit(struct folio *folio, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001194{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001195 wait_queue_head_t *q = folio_waitqueue(folio);
Nicholas Piggin62906022016-12-25 13:00:30 +10001196 struct wait_page_key key;
1197 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001198 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001199
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001200 key.folio = folio;
Nicholas Piggin62906022016-12-25 13:00:30 +10001201 key.bit_nr = bit_nr;
1202 key.page_match = 0;
1203
Tim Chen11a19c72017-08-25 09:13:55 -07001204 bookmark.flags = 0;
1205 bookmark.private = NULL;
1206 bookmark.func = NULL;
1207 INIT_LIST_HEAD(&bookmark.entry);
1208
Nicholas Piggin62906022016-12-25 13:00:30 +10001209 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001210 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1211
1212 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1213 /*
1214 * Take a breather from holding the lock,
1215 * allow pages that finish wake up asynchronously
1216 * to acquire the lock and remove themselves
1217 * from wait queue
1218 */
1219 spin_unlock_irqrestore(&q->lock, flags);
1220 cpu_relax();
1221 spin_lock_irqsave(&q->lock, flags);
1222 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1223 }
1224
Nicholas Piggin62906022016-12-25 13:00:30 +10001225 /*
1226 * It is possible for other pages to have collided on the waitqueue
1227 * hash, so in that case check for a page match. That prevents a long-
1228 * term waiter
1229 *
1230 * It is still possible to miss a case here, when we woke page waiters
1231 * and removed them from the waitqueue, but there are still other
1232 * page waiters.
1233 */
1234 if (!waitqueue_active(q) || !key.page_match) {
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001235 folio_clear_waiters(folio);
Nicholas Piggin62906022016-12-25 13:00:30 +10001236 /*
1237 * It's possible to miss clearing Waiters here, when we woke
1238 * our page waiters, but the hashed waitqueue has waiters for
1239 * other pages on it.
1240 *
1241 * That's okay, it's a rare case. The next waker will clear it.
1242 */
1243 }
1244 spin_unlock_irqrestore(&q->lock, flags);
1245}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001246
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001247static void folio_wake(struct folio *folio, int bit)
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001248{
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001249 if (!folio_test_waiters(folio))
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001250 return;
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001251 folio_wake_bit(folio, bit);
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001252}
Nicholas Piggin62906022016-12-25 13:00:30 +10001253
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001254/*
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001255 * A choice of three behaviors for folio_wait_bit_common():
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001256 */
1257enum behavior {
1258 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001259 * __folio_lock() waiting on then setting PG_locked.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001260 */
1261 SHARED, /* Hold ref to page and check the bit when woken, like
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001262 * folio_wait_writeback() waiting on PG_writeback.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001263 */
1264 DROP, /* Drop ref to page before wait, no check when woken,
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001265 * like folio_put_wait_locked() on PG_locked.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001266 */
1267};
1268
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001269/*
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001270 * Attempt to check (or get) the folio flag, and mark us done
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001271 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001272 */
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001273static inline bool folio_trylock_flag(struct folio *folio, int bit_nr,
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001274 struct wait_queue_entry *wait)
1275{
1276 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001277 if (test_and_set_bit(bit_nr, &folio->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001278 return false;
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001279 } else if (test_bit(bit_nr, &folio->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001280 return false;
1281
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001282 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001283 return true;
1284}
1285
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001286/* How many times do we accept lock stealing from under a waiter? */
1287int sysctl_page_lock_unfairness = 5;
1288
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001289static inline int folio_wait_bit_common(struct folio *folio, int bit_nr,
1290 int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001291{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001292 wait_queue_head_t *q = folio_waitqueue(folio);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001293 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001294 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001295 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001296 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001297 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001298 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001299
Johannes Weinereb414682018-10-26 15:06:27 -07001300 if (bit_nr == PG_locked &&
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001301 !folio_test_uptodate(folio) && folio_test_workingset(folio)) {
1302 if (!folio_test_swapbacked(folio)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001303 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001304 delayacct = true;
1305 }
Johannes Weinereb414682018-10-26 15:06:27 -07001306 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001307 thrashing = true;
1308 }
1309
Nicholas Piggin62906022016-12-25 13:00:30 +10001310 init_wait(wait);
1311 wait->func = wake_page_function;
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001312 wait_page.folio = folio;
Nicholas Piggin62906022016-12-25 13:00:30 +10001313 wait_page.bit_nr = bit_nr;
1314
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001315repeat:
1316 wait->flags = 0;
1317 if (behavior == EXCLUSIVE) {
1318 wait->flags = WQ_FLAG_EXCLUSIVE;
1319 if (--unfairness < 0)
1320 wait->flags |= WQ_FLAG_CUSTOM;
1321 }
1322
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001323 /*
1324 * Do one last check whether we can get the
1325 * page bit synchronously.
1326 *
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001327 * Do the folio_set_waiters() marking before that
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001328 * to let any waker we _just_ missed know they
1329 * need to wake us up (otherwise they'll never
1330 * even go to the slow case that looks at the
1331 * page queue), and add ourselves to the wait
1332 * queue if we need to sleep.
1333 *
1334 * This part needs to be done under the queue
1335 * lock to avoid races.
1336 */
1337 spin_lock_irq(&q->lock);
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001338 folio_set_waiters(folio);
1339 if (!folio_trylock_flag(folio, bit_nr, wait))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001340 __add_wait_queue_entry_tail(q, wait);
1341 spin_unlock_irq(&q->lock);
1342
1343 /*
1344 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001345 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1346 * see whether the page bit testing has already
1347 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001348 *
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001349 * We can drop our reference to the folio.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001350 */
1351 if (behavior == DROP)
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001352 folio_put(folio);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001353
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001354 /*
1355 * Note that until the "finish_wait()", or until
1356 * we see the WQ_FLAG_WOKEN flag, we need to
1357 * be very careful with the 'wait->flags', because
1358 * we may race with a waker that sets them.
1359 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001360 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001361 unsigned int flags;
1362
Nicholas Piggin62906022016-12-25 13:00:30 +10001363 set_current_state(state);
1364
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001365 /* Loop until we've been woken or interrupted */
1366 flags = smp_load_acquire(&wait->flags);
1367 if (!(flags & WQ_FLAG_WOKEN)) {
1368 if (signal_pending_state(state, current))
1369 break;
1370
1371 io_schedule();
1372 continue;
1373 }
1374
1375 /* If we were non-exclusive, we're done */
1376 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001377 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001378
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001379 /* If the waker got the lock for us, we're done */
1380 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001381 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001382
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001383 /*
1384 * Otherwise, if we're getting the lock, we need to
1385 * try to get it ourselves.
1386 *
1387 * And if that fails, we'll have to retry this all.
1388 */
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001389 if (unlikely(test_and_set_bit(bit_nr, folio_flags(folio, 0))))
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001390 goto repeat;
1391
1392 wait->flags |= WQ_FLAG_DONE;
1393 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001394 }
1395
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001396 /*
1397 * If a signal happened, this 'finish_wait()' may remove the last
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001398 * waiter from the wait-queues, but the folio waiters bit will remain
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001399 * set. That's ok. The next wakeup will take care of it, and trying
1400 * to do it here would be difficult and prone to races.
1401 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001402 finish_wait(q, wait);
1403
Johannes Weinereb414682018-10-26 15:06:27 -07001404 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001405 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001406 delayacct_thrashing_end();
1407 psi_memstall_leave(&pflags);
1408 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001409
Nicholas Piggin62906022016-12-25 13:00:30 +10001410 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001411 * NOTE! The wait->flags weren't stable until we've done the
1412 * 'finish_wait()', and we could have exited the loop above due
1413 * to a signal, and had a wakeup event happen after the signal
1414 * test but before the 'finish_wait()'.
1415 *
1416 * So only after the finish_wait() can we reliably determine
1417 * if we got woken up or not, so we can now figure out the final
1418 * return value based on that state without races.
1419 *
1420 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1421 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001422 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001423 if (behavior == EXCLUSIVE)
1424 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001425
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001426 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001427}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001429void folio_wait_bit(struct folio *folio, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001431 folio_wait_bit_common(folio, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001432}
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001433EXPORT_SYMBOL(folio_wait_bit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001435int folio_wait_bit_killable(struct folio *folio, int bit_nr)
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001436{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001437 return folio_wait_bit_common(folio, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001438}
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001439EXPORT_SYMBOL(folio_wait_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001440
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441/**
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001442 * folio_put_wait_locked - Drop a reference and wait for it to be unlocked
1443 * @folio: The folio to wait for.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001444 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001445 *
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001446 * The caller should hold a reference on @folio. They expect the page to
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001447 * become unlocked relatively soon, but do not wish to hold up migration
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001448 * (for example) by holding the reference while waiting for the folio to
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001449 * come unlocked. After this function returns, the caller should not
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001450 * dereference @folio.
Matthew Wilcox (Oracle)48054622021-02-24 12:02:02 -08001451 *
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001452 * Return: 0 if the folio was unlocked or -EINTR if interrupted by a signal.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001453 */
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001454int folio_put_wait_locked(struct folio *folio, int state)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001455{
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04001456 return folio_wait_bit_common(folio, PG_locked, state, DROP);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001457}
1458
1459/**
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001460 * folio_add_wait_queue - Add an arbitrary waiter to a folio's wait queue
1461 * @folio: Folio defining the wait queue of interest
Randy Dunlap697f6192009-04-13 14:39:54 -07001462 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001463 *
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001464 * Add an arbitrary @waiter to the wait queue for the nominated @folio.
David Howells385e1ca5f2009-04-03 16:42:39 +01001465 */
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001466void folio_add_wait_queue(struct folio *folio, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001467{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001468 wait_queue_head_t *q = folio_waitqueue(folio);
David Howells385e1ca5f2009-04-03 16:42:39 +01001469 unsigned long flags;
1470
1471 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001472 __add_wait_queue_entry_tail(q, waiter);
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001473 folio_set_waiters(folio);
David Howells385e1ca5f2009-04-03 16:42:39 +01001474 spin_unlock_irqrestore(&q->lock, flags);
1475}
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001476EXPORT_SYMBOL_GPL(folio_add_wait_queue);
David Howells385e1ca5f2009-04-03 16:42:39 +01001477
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001478#ifndef clear_bit_unlock_is_negative_byte
1479
1480/*
1481 * PG_waiters is the high bit in the same byte as PG_lock.
1482 *
1483 * On x86 (and on many other architectures), we can clear PG_lock and
1484 * test the sign bit at the same time. But if the architecture does
1485 * not support that special operation, we just do this all by hand
1486 * instead.
1487 *
1488 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001489 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001490 * in the same byte as PG_locked.
1491 */
1492static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1493{
1494 clear_bit_unlock(nr, mem);
1495 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001496 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001497}
1498
1499#endif
1500
David Howells385e1ca5f2009-04-03 16:42:39 +01001501/**
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001502 * folio_unlock - Unlock a locked folio.
1503 * @folio: The folio.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 *
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001505 * Unlocks the folio and wakes up any thread sleeping on the page lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 *
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001507 * Context: May be called from interrupt or process context. May not be
1508 * called from NMI context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 */
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001510void folio_unlock(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511{
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001512 /* Bit 7 allows x86 to check the byte's sign bit */
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001513 BUILD_BUG_ON(PG_waiters != 7);
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001514 BUILD_BUG_ON(PG_locked > 7);
1515 VM_BUG_ON_FOLIO(!folio_test_locked(folio), folio);
1516 if (clear_bit_unlock_is_negative_byte(PG_locked, folio_flags(folio, 0)))
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001517 folio_wake_bit(folio, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518}
Matthew Wilcox (Oracle)4e136422020-12-07 15:44:35 -05001519EXPORT_SYMBOL(folio_unlock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520
Randy Dunlap485bb992006-06-23 02:03:49 -07001521/**
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001522 * folio_end_private_2 - Clear PG_private_2 and wake any waiters.
1523 * @folio: The folio.
David Howells73e10de2020-02-10 10:00:21 +00001524 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001525 * Clear the PG_private_2 bit on a folio and wake up any sleepers waiting for
1526 * it. The folio reference held for PG_private_2 being set is released.
David Howells73e10de2020-02-10 10:00:21 +00001527 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001528 * This is, for example, used when a netfs folio is being written to a local
1529 * disk cache, thereby allowing writes to the cache for the same folio to be
David Howells73e10de2020-02-10 10:00:21 +00001530 * serialised.
1531 */
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001532void folio_end_private_2(struct folio *folio)
David Howells73e10de2020-02-10 10:00:21 +00001533{
Matthew Wilcox (Oracle)6974d7c2021-01-15 17:14:48 -05001534 VM_BUG_ON_FOLIO(!folio_test_private_2(folio), folio);
1535 clear_bit_unlock(PG_private_2, folio_flags(folio, 0));
1536 folio_wake_bit(folio, PG_private_2);
1537 folio_put(folio);
David Howells73e10de2020-02-10 10:00:21 +00001538}
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001539EXPORT_SYMBOL(folio_end_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001540
1541/**
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001542 * folio_wait_private_2 - Wait for PG_private_2 to be cleared on a folio.
1543 * @folio: The folio to wait on.
David Howells73e10de2020-02-10 10:00:21 +00001544 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001545 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a folio.
David Howells73e10de2020-02-10 10:00:21 +00001546 */
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001547void folio_wait_private_2(struct folio *folio)
David Howells73e10de2020-02-10 10:00:21 +00001548{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001549 while (folio_test_private_2(folio))
1550 folio_wait_bit(folio, PG_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001551}
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001552EXPORT_SYMBOL(folio_wait_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001553
1554/**
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001555 * folio_wait_private_2_killable - Wait for PG_private_2 to be cleared on a folio.
1556 * @folio: The folio to wait on.
David Howells73e10de2020-02-10 10:00:21 +00001557 *
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001558 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a folio or until a
David Howells73e10de2020-02-10 10:00:21 +00001559 * fatal signal is received by the calling task.
1560 *
1561 * Return:
1562 * - 0 if successful.
1563 * - -EINTR if a fatal signal was encountered.
1564 */
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001565int folio_wait_private_2_killable(struct folio *folio)
David Howells73e10de2020-02-10 10:00:21 +00001566{
1567 int ret = 0;
1568
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001569 while (folio_test_private_2(folio)) {
1570 ret = folio_wait_bit_killable(folio, PG_private_2);
David Howells73e10de2020-02-10 10:00:21 +00001571 if (ret < 0)
1572 break;
1573 }
1574
1575 return ret;
1576}
Matthew Wilcox (Oracle)b47393f2021-04-22 22:58:32 -04001577EXPORT_SYMBOL(folio_wait_private_2_killable);
David Howells73e10de2020-02-10 10:00:21 +00001578
1579/**
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001580 * folio_end_writeback - End writeback against a folio.
1581 * @folio: The folio.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582 */
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001583void folio_end_writeback(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001585 /*
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001586 * folio_test_clear_reclaim() could be used here but it is an
1587 * atomic operation and overkill in this particular case. Failing
1588 * to shuffle a folio marked for immediate reclaim is too mild
1589 * a gain to justify taking an atomic operation penalty at the
1590 * end of every folio writeback.
Mel Gorman888cf2d2014-06-04 16:10:34 -07001591 */
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001592 if (folio_test_reclaim(folio)) {
1593 folio_clear_reclaim(folio);
Matthew Wilcox (Oracle)575ced12020-12-08 01:25:39 -05001594 folio_rotate_reclaimable(folio);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001595 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001596
Hugh Dickins073861e2020-11-24 08:46:43 -08001597 /*
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001598 * Writeback does not hold a folio reference of its own, relying
Hugh Dickins073861e2020-11-24 08:46:43 -08001599 * on truncation to wait for the clearing of PG_writeback.
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001600 * But here we must make sure that the folio is not freed and
1601 * reused before the folio_wake().
Hugh Dickins073861e2020-11-24 08:46:43 -08001602 */
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001603 folio_get(folio);
Matthew Wilcox (Oracle)269ccca32021-01-15 23:34:16 -05001604 if (!__folio_end_writeback(folio))
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001605 BUG();
1606
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001607 smp_mb__after_atomic();
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001608 folio_wake(folio, PG_writeback);
Linus Torvalds512b79312021-11-06 14:08:17 -07001609 acct_reclaim_writeback(folio);
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001610 folio_put(folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611}
Matthew Wilcox (Oracle)4268b482021-03-03 15:21:55 -05001612EXPORT_SYMBOL(folio_end_writeback);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613
Matthew Wilcox57d99842014-06-04 16:07:45 -07001614/*
1615 * After completing I/O on a page, call this routine to update the page
1616 * flags appropriately
1617 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001618void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001619{
Jens Axboec11f0c02016-08-05 08:11:04 -06001620 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001621 if (!err) {
1622 SetPageUptodate(page);
1623 } else {
1624 ClearPageUptodate(page);
1625 SetPageError(page);
1626 }
1627 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001628 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001629 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001630 struct address_space *mapping;
1631
Matthew Wilcox57d99842014-06-04 16:07:45 -07001632 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001633 mapping = page_mapping(page);
1634 if (mapping)
1635 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001636 }
1637 end_page_writeback(page);
1638 }
1639}
1640EXPORT_SYMBOL_GPL(page_endio);
1641
Randy Dunlap485bb992006-06-23 02:03:49 -07001642/**
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001643 * __folio_lock - Get a lock on the folio, assuming we need to sleep to get it.
1644 * @folio: The folio to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 */
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001646void __folio_lock(struct folio *folio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001648 folio_wait_bit_common(folio, PG_locked, TASK_UNINTERRUPTIBLE,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001649 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650}
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05001651EXPORT_SYMBOL(__folio_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001653int __folio_lock_killable(struct folio *folio)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001654{
Matthew Wilcox (Oracle)101c0bf2021-03-04 12:02:54 -05001655 return folio_wait_bit_common(folio, PG_locked, TASK_KILLABLE,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001656 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001657}
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001658EXPORT_SYMBOL_GPL(__folio_lock_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001659
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05001660static int __folio_lock_async(struct folio *folio, struct wait_page_queue *wait)
Jens Axboedd3e6d52020-05-22 09:12:09 -06001661{
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001662 struct wait_queue_head *q = folio_waitqueue(folio);
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001663 int ret = 0;
1664
Matthew Wilcox (Oracle)df4d4f122021-01-16 11:22:14 -05001665 wait->folio = folio;
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001666 wait->bit_nr = PG_locked;
1667
1668 spin_lock_irq(&q->lock);
1669 __add_wait_queue_entry_tail(q, &wait->wait);
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05001670 folio_set_waiters(folio);
1671 ret = !folio_trylock(folio);
Matthew Wilcox (Oracle)f32b5dd2021-02-24 12:02:09 -08001672 /*
1673 * If we were successful now, we know we're still on the
1674 * waitqueue as we're still under the lock. This means it's
1675 * safe to remove and return success, we know the callback
1676 * isn't going to trigger.
1677 */
1678 if (!ret)
1679 __remove_wait_queue(q, &wait->wait);
1680 else
1681 ret = -EIOCBQUEUED;
1682 spin_unlock_irq(&q->lock);
1683 return ret;
Jens Axboedd3e6d52020-05-22 09:12:09 -06001684}
1685
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001686/*
1687 * Return values:
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001688 * true - folio is locked; mmap_lock is still held.
1689 * false - folio is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001690 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001691 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001692 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001693 *
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001694 * If neither ALLOW_RETRY nor KILLABLE are set, will always return true
1695 * with the folio locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001696 */
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001697bool __folio_lock_or_retry(struct folio *folio, struct mm_struct *mm,
Michel Lespinassed065bd82010-10-26 14:21:57 -07001698 unsigned int flags)
1699{
Peter Xu4064b982020-04-01 21:08:45 -07001700 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001701 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001702 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001703 * even though return 0.
1704 */
1705 if (flags & FAULT_FLAG_RETRY_NOWAIT)
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001706 return false;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001707
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001708 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001709 if (flags & FAULT_FLAG_KILLABLE)
Matthew Wilcox (Oracle)6baa8d62021-03-04 10:21:02 -05001710 folio_wait_locked_killable(folio);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001711 else
Matthew Wilcox (Oracle)6baa8d62021-03-04 10:21:02 -05001712 folio_wait_locked(folio);
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001713 return false;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001714 }
Hailong Liu800bca72020-12-14 19:05:02 -08001715 if (flags & FAULT_FLAG_KILLABLE) {
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001716 bool ret;
Hailong Liu800bca72020-12-14 19:05:02 -08001717
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001718 ret = __folio_lock_killable(folio);
Hailong Liu800bca72020-12-14 19:05:02 -08001719 if (ret) {
1720 mmap_read_unlock(mm);
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001721 return false;
Hailong Liu800bca72020-12-14 19:05:02 -08001722 }
1723 } else {
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05001724 __folio_lock(folio);
Hailong Liu800bca72020-12-14 19:05:02 -08001725 }
Hailong Liu800bca72020-12-14 19:05:02 -08001726
Matthew Wilcox (Oracle)9138e472021-03-18 21:39:45 -04001727 return true;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001728}
1729
Randy Dunlap485bb992006-06-23 02:03:49 -07001730/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001731 * page_cache_next_miss() - Find the next gap in the page cache.
1732 * @mapping: Mapping.
1733 * @index: Index.
1734 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001735 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001736 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1737 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001738 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001739 * This function may be called under the rcu_read_lock. However, this will
1740 * not atomically search a snapshot of the cache at a single point in time.
1741 * For example, if a gap is created at index 5, then subsequently a gap is
1742 * created at index 10, page_cache_next_miss covering both indices may
1743 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001744 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001745 * Return: The index of the gap if found, otherwise an index outside the
1746 * range specified (in which case 'return - index >= max_scan' will be true).
1747 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001748 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001749pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001750 pgoff_t index, unsigned long max_scan)
1751{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001752 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001753
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001754 while (max_scan--) {
1755 void *entry = xas_next(&xas);
1756 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001757 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001758 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001759 break;
1760 }
1761
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001762 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001763}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001764EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001765
1766/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001767 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001768 * @mapping: Mapping.
1769 * @index: Index.
1770 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001771 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001772 * Search the range [max(index - max_scan + 1, 0), index] for the
1773 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001774 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001775 * This function may be called under the rcu_read_lock. However, this will
1776 * not atomically search a snapshot of the cache at a single point in time.
1777 * For example, if a gap is created at index 10, then subsequently a gap is
1778 * created at index 5, page_cache_prev_miss() covering both indices may
1779 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001780 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001781 * Return: The index of the gap if found, otherwise an index outside the
1782 * range specified (in which case 'index - return >= max_scan' will be true).
1783 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001784 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001785pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001786 pgoff_t index, unsigned long max_scan)
1787{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001788 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001789
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001790 while (max_scan--) {
1791 void *entry = xas_prev(&xas);
1792 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001793 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001794 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001795 break;
1796 }
1797
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001798 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001799}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001800EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001801
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001802/*
Matthew Wilcox (Oracle)020853b2021-05-10 16:33:22 -04001803 * Lockless page cache protocol:
1804 * On the lookup side:
1805 * 1. Load the folio from i_pages
1806 * 2. Increment the refcount if it's not zero
1807 * 3. If the folio is not found by xas_reload(), put the refcount and retry
1808 *
1809 * On the removal side:
1810 * A. Freeze the page (by zeroing the refcount if nobody else has a reference)
1811 * B. Remove the page from i_pages
1812 * C. Return the page to the page allocator
1813 *
1814 * This means that any page may have its reference count temporarily
1815 * increased by a speculative page cache (or fast GUP) lookup as it can
1816 * be allocated by another user before the RCU grace period expires.
1817 * Because the refcount temporarily acquired here may end up being the
1818 * last refcount on the page, any page allocation must be freeable by
1819 * folio_put().
1820 */
1821
1822/*
Matthew Wilcox (Oracle)bc5a3012021-02-25 17:15:40 -08001823 * mapping_get_entry - Get a page cache entry.
Randy Dunlap485bb992006-06-23 02:03:49 -07001824 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001825 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001826 *
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001827 * Looks up the page cache entry at @mapping & @index. If it is a folio,
1828 * it is returned with an increased refcount. If it is a shadow entry
1829 * of a previously evicted folio, or a swap entry from shmem/tmpfs,
1830 * it is returned without further action.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001831 *
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001832 * Return: The folio, swap or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833 */
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001834static void *mapping_get_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001836 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001837 struct folio *folio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838
Nick Piggina60637c2008-07-25 19:45:31 -07001839 rcu_read_lock();
1840repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001841 xas_reset(&xas);
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001842 folio = xas_load(&xas);
1843 if (xas_retry(&xas, folio))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001844 goto repeat;
1845 /*
1846 * A shadow entry of a recently evicted page, or a swap entry from
1847 * shmem/tmpfs. Return it without attempting to raise page count.
1848 */
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001849 if (!folio || xa_is_value(folio))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001850 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001851
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001852 if (!folio_try_get_rcu(folio))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001853 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001854
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001855 if (unlikely(folio != xas_reload(&xas))) {
1856 folio_put(folio);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001857 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001858 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001859out:
Nick Piggina60637c2008-07-25 19:45:31 -07001860 rcu_read_unlock();
1861
Matthew Wilcox (Oracle)bca65ee2020-12-15 23:22:38 -05001862 return folio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001864
Randy Dunlap485bb992006-06-23 02:03:49 -07001865/**
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001866 * __filemap_get_folio - Find and get a reference to a folio.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001867 * @mapping: The address_space to search.
1868 * @index: The page index.
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001869 * @fgp_flags: %FGP flags modify how the folio is returned.
1870 * @gfp: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001871 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001872 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001873 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001874 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001875 *
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001876 * * %FGP_ACCESSED - The folio will be marked accessed.
1877 * * %FGP_LOCK - The folio is returned locked.
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001878 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001879 * instead of allocating a new folio to replace it.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001880 * * %FGP_CREAT - If no page is present then a new page is allocated using
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001881 * @gfp and added to the page cache and the VM's LRU list.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001882 * The page is returned locked and with an increased refcount.
1883 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1884 * page is already in cache. If the page was allocated, unlock it before
1885 * returning so the caller can do the same dance.
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001886 * * %FGP_WRITE - The page will be written to by the caller.
1887 * * %FGP_NOFS - __GFP_FS will get cleared in gfp.
1888 * * %FGP_NOWAIT - Don't get blocked by page lock.
Matthew Wilcox (Oracle)b27652d92020-12-24 12:55:56 -05001889 * * %FGP_STABLE - Wait for the folio to be stable (finished writeback)
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001890 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001891 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1892 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001893 *
1894 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001895 *
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001896 * Return: The found folio or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001897 */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001898struct folio *__filemap_get_folio(struct address_space *mapping, pgoff_t index,
1899 int fgp_flags, gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900{
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001901 struct folio *folio;
Mel Gorman2457aec2014-06-04 16:10:31 -07001902
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903repeat:
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001904 folio = mapping_get_entry(mapping, index);
1905 if (xa_is_value(folio)) {
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001906 if (fgp_flags & FGP_ENTRY)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001907 return folio;
1908 folio = NULL;
Matthew Wilcox (Oracle)44835d22021-02-25 17:15:36 -08001909 }
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001910 if (!folio)
Mel Gorman2457aec2014-06-04 16:10:31 -07001911 goto no_page;
1912
1913 if (fgp_flags & FGP_LOCK) {
1914 if (fgp_flags & FGP_NOWAIT) {
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001915 if (!folio_trylock(folio)) {
1916 folio_put(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001917 return NULL;
1918 }
1919 } else {
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001920 folio_lock(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001921 }
1922
1923 /* Has the page been truncated? */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001924 if (unlikely(folio->mapping != mapping)) {
1925 folio_unlock(folio);
1926 folio_put(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001927 goto repeat;
1928 }
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001929 VM_BUG_ON_FOLIO(!folio_contains(folio, index), folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001930 }
1931
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001932 if (fgp_flags & FGP_ACCESSED)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001933 folio_mark_accessed(folio);
Yang Shib9306a72020-08-06 23:19:55 -07001934 else if (fgp_flags & FGP_WRITE) {
1935 /* Clear idle flag for buffer write */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001936 if (folio_test_idle(folio))
1937 folio_clear_idle(folio);
Yang Shib9306a72020-08-06 23:19:55 -07001938 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001939
Matthew Wilcox (Oracle)b27652d92020-12-24 12:55:56 -05001940 if (fgp_flags & FGP_STABLE)
1941 folio_wait_stable(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001942no_page:
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001943 if (!folio && (fgp_flags & FGP_CREAT)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001944 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001945 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001946 gfp |= __GFP_WRITE;
Michal Hocko45f87de2014-12-29 20:30:35 +01001947 if (fgp_flags & FGP_NOFS)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001948 gfp &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001949
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001950 folio = filemap_alloc_folio(gfp, 0);
1951 if (!folio)
Nick Piggineb2be182007-10-16 01:24:57 -07001952 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001953
Josef Bacika75d4c32019-03-13 11:44:14 -07001954 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001955 fgp_flags |= FGP_LOCK;
1956
Hugh Dickinseb39d612014-08-06 16:06:43 -07001957 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001958 if (fgp_flags & FGP_ACCESSED)
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001959 __folio_set_referenced(folio);
Mel Gorman2457aec2014-06-04 16:10:31 -07001960
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001961 err = filemap_add_folio(mapping, folio, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07001962 if (unlikely(err)) {
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001963 folio_put(folio);
1964 folio = NULL;
Nick Piggineb2be182007-10-16 01:24:57 -07001965 if (err == -EEXIST)
1966 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001968
1969 /*
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001970 * filemap_add_folio locks the page, and for mmap
1971 * we expect an unlocked page.
Josef Bacika75d4c32019-03-13 11:44:14 -07001972 */
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001973 if (folio && (fgp_flags & FGP_FOR_MMAP))
1974 folio_unlock(folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001975 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001976
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001977 return folio;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978}
Matthew Wilcox (Oracle)3f0c6a02021-03-08 11:45:35 -05001979EXPORT_SYMBOL(__filemap_get_folio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08001981static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1982 xa_mark_t mark)
1983{
1984 struct page *page;
1985
1986retry:
1987 if (mark == XA_PRESENT)
1988 page = xas_find(xas, max);
1989 else
1990 page = xas_find_marked(xas, max, mark);
1991
1992 if (xas_retry(xas, page))
1993 goto retry;
1994 /*
1995 * A shadow entry of a recently evicted page, a swap
1996 * entry from shmem/tmpfs or a DAX entry. Return it
1997 * without attempting to raise page count.
1998 */
1999 if (!page || xa_is_value(page))
2000 return page;
2001
2002 if (!page_cache_get_speculative(page))
2003 goto reset;
2004
2005 /* Has the page moved or been split? */
2006 if (unlikely(page != xas_reload(xas))) {
2007 put_page(page);
2008 goto reset;
2009 }
2010
2011 return page;
2012reset:
2013 xas_reset(xas);
2014 goto retry;
2015}
2016
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07002018 * find_get_entries - gang pagecache lookup
2019 * @mapping: The address_space to search
2020 * @start: The starting page cache index
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002021 * @end: The final page index (inclusive).
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002022 * @pvec: Where the resulting entries are placed.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002023 * @indices: The cache indices corresponding to the entries in @entries
2024 *
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002025 * find_get_entries() will search for and return a batch of entries in
2026 * the mapping. The entries are placed in @pvec. find_get_entries()
2027 * takes a reference on any actual pages it returns.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002028 *
2029 * The search returns a group of mapping-contiguous page cache entries
2030 * with ascending indexes. There may be holes in the indices due to
2031 * not-present pages.
2032 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07002033 * Any shadow entries of evicted pages, or swap entries from
2034 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002035 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07002036 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
2037 * stops at that page: the caller is likely to have a better way to handle
2038 * the compound page as a whole, and then skip its extent, than repeatedly
2039 * calling find_get_entries() to return all its tails.
2040 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002041 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07002042 */
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002043unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002044 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
Johannes Weiner0cd61442014-04-03 14:47:46 -07002045{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002046 XA_STATE(xas, &mapping->i_pages, start);
2047 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002048 unsigned int ret = 0;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002049 unsigned nr_entries = PAGEVEC_SIZE;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002050
2051 rcu_read_lock();
Matthew Wilcox (Oracle)ca122fe42021-02-25 17:16:00 -08002052 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002053 /*
2054 * Terminate early on finding a THP, to allow the caller to
2055 * handle it all at once; but continue if this is hugetlbfs.
2056 */
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002057 if (!xa_is_value(page) && PageTransHuge(page) &&
2058 !PageHuge(page)) {
Hugh Dickins71725ed2020-04-06 20:07:57 -07002059 page = find_subpage(page, xas.xa_index);
2060 nr_entries = ret + 1;
2061 }
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002062
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04002063 indices[ret] = xas.xa_index;
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002064 pvec->pages[ret] = page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002065 if (++ret == nr_entries)
2066 break;
2067 }
2068 rcu_read_unlock();
Matthew Wilcox (Oracle)cf2039a2021-02-25 17:16:11 -08002069
2070 pvec->nr = ret;
Johannes Weiner0cd61442014-04-03 14:47:46 -07002071 return ret;
2072}
2073
2074/**
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002075 * find_lock_entries - Find a batch of pagecache entries.
2076 * @mapping: The address_space to search.
2077 * @start: The starting page cache index.
2078 * @end: The final page index (inclusive).
2079 * @pvec: Where the resulting entries are placed.
2080 * @indices: The cache indices of the entries in @pvec.
2081 *
2082 * find_lock_entries() will return a batch of entries from @mapping.
2083 * Swap, shadow and DAX entries are included. Pages are returned
2084 * locked and with an incremented refcount. Pages which are locked by
2085 * somebody else or under writeback are skipped. Only the head page of
2086 * a THP is returned. Pages which are partially outside the range are
2087 * not returned.
2088 *
2089 * The entries have ascending indexes. The indices may not be consecutive
2090 * due to not-present entries, THP pages, pages which could not be locked
2091 * or pages under writeback.
2092 *
2093 * Return: The number of entries which were found.
2094 */
2095unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2096 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2097{
2098 XA_STATE(xas, &mapping->i_pages, start);
2099 struct page *page;
2100
2101 rcu_read_lock();
2102 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2103 if (!xa_is_value(page)) {
2104 if (page->index < start)
2105 goto put;
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002106 if (page->index + thp_nr_pages(page) - 1 > end)
2107 goto put;
2108 if (!trylock_page(page))
2109 goto put;
2110 if (page->mapping != mapping || PageWriteback(page))
2111 goto unlock;
2112 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2113 page);
2114 }
2115 indices[pvec->nr] = xas.xa_index;
2116 if (!pagevec_add(pvec, page))
2117 break;
2118 goto next;
2119unlock:
2120 unlock_page(page);
2121put:
2122 put_page(page);
2123next:
Hugh Dickins2d11e732021-04-23 14:28:57 -07002124 if (!xa_is_value(page) && PageTransHuge(page)) {
2125 unsigned int nr_pages = thp_nr_pages(page);
2126
2127 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
2128 xas_set(&xas, page->index + nr_pages);
2129 if (xas.xa_index < nr_pages)
2130 break;
2131 }
Matthew Wilcox (Oracle)5c211ba2021-02-25 17:15:56 -08002132 }
2133 rcu_read_unlock();
2134
2135 return pagevec_count(pvec);
2136}
2137
2138/**
Jan Karab947cee2017-09-06 16:21:21 -07002139 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 * @mapping: The address_space to search
2141 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07002142 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 * @nr_pages: The maximum number of pages
2144 * @pages: Where the resulting pages are placed
2145 *
Jan Karab947cee2017-09-06 16:21:21 -07002146 * find_get_pages_range() will search for and return a group of up to @nr_pages
2147 * pages in the mapping starting at index @start and up to index @end
2148 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2149 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 *
2151 * The search returns a group of mapping-contiguous pages with ascending
2152 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07002153 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002155 * Return: the number of pages which were found. If this number is
2156 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07002157 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 */
Jan Karab947cee2017-09-06 16:21:21 -07002159unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2160 pgoff_t end, unsigned int nr_pages,
2161 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002163 XA_STATE(xas, &mapping->i_pages, *start);
2164 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002165 unsigned ret = 0;
2166
2167 if (unlikely(!nr_pages))
2168 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
Nick Piggina60637c2008-07-25 19:45:31 -07002170 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002171 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002172 /* Skip over shadow, swap and DAX entries */
2173 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07002174 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002175
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002176 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002177 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002178 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002179 goto out;
2180 }
Nick Piggina60637c2008-07-25 19:45:31 -07002181 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002182
Jan Karab947cee2017-09-06 16:21:21 -07002183 /*
2184 * We come here when there is no page beyond @end. We take care to not
2185 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002186 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002187 * already broken anyway.
2188 */
2189 if (end == (pgoff_t)-1)
2190 *start = (pgoff_t)-1;
2191 else
2192 *start = end + 1;
2193out:
Nick Piggina60637c2008-07-25 19:45:31 -07002194 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002195
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 return ret;
2197}
2198
Jens Axboeebf43502006-04-27 08:46:01 +02002199/**
2200 * find_get_pages_contig - gang contiguous pagecache lookup
2201 * @mapping: The address_space to search
2202 * @index: The starting page index
2203 * @nr_pages: The maximum number of pages
2204 * @pages: Where the resulting pages are placed
2205 *
2206 * find_get_pages_contig() works exactly like find_get_pages(), except
2207 * that the returned number of pages are guaranteed to be contiguous.
2208 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002209 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002210 */
2211unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2212 unsigned int nr_pages, struct page **pages)
2213{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002214 XA_STATE(xas, &mapping->i_pages, index);
2215 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002216 unsigned int ret = 0;
2217
2218 if (unlikely(!nr_pages))
2219 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002220
Nick Piggina60637c2008-07-25 19:45:31 -07002221 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002222 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002223 if (xas_retry(&xas, page))
2224 continue;
2225 /*
2226 * If the entry has been swapped out, we can stop looking.
2227 * No current caller is looking for DAX entries.
2228 */
2229 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002230 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002231
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002232 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002233 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002234
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002235 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002236 if (unlikely(page != xas_reload(&xas)))
2237 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002238
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002239 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002240 if (++ret == nr_pages)
2241 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002242 continue;
2243put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002244 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002245retry:
2246 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002247 }
Nick Piggina60637c2008-07-25 19:45:31 -07002248 rcu_read_unlock();
2249 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002250}
David Howellsef71c152007-05-09 02:33:44 -07002251EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002252
Randy Dunlap485bb992006-06-23 02:03:49 -07002253/**
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002254 * find_get_pages_range_tag - Find and return head pages matching @tag.
Randy Dunlap485bb992006-06-23 02:03:49 -07002255 * @mapping: the address_space to search
2256 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002257 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002258 * @tag: the tag index
2259 * @nr_pages: the maximum number of pages
2260 * @pages: where the resulting pages are placed
2261 *
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002262 * Like find_get_pages(), except we only return head pages which are tagged
2263 * with @tag. @index is updated to the index immediately after the last
2264 * page we return, ready for the next iteration.
Mike Rapoporta862f682019-03-05 15:48:42 -08002265 *
2266 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 */
Jan Kara72b045a2017-11-15 17:34:33 -08002268unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002269 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002270 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002272 XA_STATE(xas, &mapping->i_pages, *index);
2273 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002274 unsigned ret = 0;
2275
2276 if (unlikely(!nr_pages))
2277 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278
Nick Piggina60637c2008-07-25 19:45:31 -07002279 rcu_read_lock();
Matthew Wilcox (Oracle)c7bad632021-02-25 17:15:44 -08002280 while ((page = find_get_entry(&xas, end, tag))) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002281 /*
2282 * Shadow entries should never be tagged, but this iteration
2283 * is lockless so there is a window for page reclaim to evict
2284 * a page we saw tagged. Skip over it.
2285 */
2286 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002287 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002288
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002289 pages[ret] = page;
Jan Kara72b045a2017-11-15 17:34:33 -08002290 if (++ret == nr_pages) {
Matthew Wilcox (Oracle)c49f50d2021-02-25 17:15:25 -08002291 *index = page->index + thp_nr_pages(page);
Jan Kara72b045a2017-11-15 17:34:33 -08002292 goto out;
2293 }
Nick Piggina60637c2008-07-25 19:45:31 -07002294 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002295
Jan Kara72b045a2017-11-15 17:34:33 -08002296 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002297 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002298 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002299 * iteration when there is a page at index -1 but that is already
2300 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002301 */
2302 if (end == (pgoff_t)-1)
2303 *index = (pgoff_t)-1;
2304 else
2305 *index = end + 1;
2306out:
Nick Piggina60637c2008-07-25 19:45:31 -07002307 rcu_read_unlock();
2308
Linus Torvalds1da177e2005-04-16 15:20:36 -07002309 return ret;
2310}
Jan Kara72b045a2017-11-15 17:34:33 -08002311EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002313/*
2314 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2315 * a _large_ part of the i/o request. Imagine the worst scenario:
2316 *
2317 * ---R__________________________________________B__________
2318 * ^ reading here ^ bad block(assume 4k)
2319 *
2320 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2321 * => failing the whole request => read(R) => read(R+1) =>
2322 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2323 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2324 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2325 *
2326 * It is going insane. Fix it by quickly scaling down the readahead size.
2327 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002328static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002329{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002330 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002331}
2332
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002333/*
2334 * filemap_get_read_batch - Get a batch of pages for read
2335 *
2336 * Get a batch of pages which represent a contiguous range of bytes
2337 * in the file. No tail pages will be returned. If @index is in the
2338 * middle of a THP, the entire THP will be returned. The last page in
2339 * the batch may have Readahead set or be not Uptodate so that the
2340 * caller can take the appropriate action.
2341 */
2342static void filemap_get_read_batch(struct address_space *mapping,
2343 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2344{
2345 XA_STATE(xas, &mapping->i_pages, index);
2346 struct page *head;
2347
2348 rcu_read_lock();
2349 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2350 if (xas_retry(&xas, head))
2351 continue;
2352 if (xas.xa_index > max || xa_is_value(head))
2353 break;
2354 if (!page_cache_get_speculative(head))
2355 goto retry;
2356
2357 /* Has the page moved or been split? */
2358 if (unlikely(head != xas_reload(&xas)))
2359 goto put_page;
2360
2361 if (!pagevec_add(pvec, head))
2362 break;
2363 if (!PageUptodate(head))
2364 break;
2365 if (PageReadahead(head))
2366 break;
2367 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2368 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2369 continue;
2370put_page:
2371 put_page(head);
2372retry:
2373 xas_reset(&xas);
2374 }
2375 rcu_read_unlock();
2376}
2377
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002378static int filemap_read_page(struct file *file, struct address_space *mapping,
2379 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002380{
Kent Overstreet723ef242020-12-14 19:04:52 -08002381 int error;
2382
Kent Overstreet723ef242020-12-14 19:04:52 -08002383 /*
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002384 * A previous I/O error may have been due to temporary failures,
2385 * eg. multipath errors. PG_error will be set again if readpage
2386 * fails.
Kent Overstreet723ef242020-12-14 19:04:52 -08002387 */
2388 ClearPageError(page);
2389 /* Start the actual read. The read will unlock the page. */
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002390 error = mapping->a_ops->readpage(file, page);
2391 if (error)
2392 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002393
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002394 error = wait_on_page_locked_killable(page);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002395 if (error)
2396 return error;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002397 if (PageUptodate(page))
2398 return 0;
Matthew Wilcox (Oracle)aa1ec2f2021-02-24 12:02:38 -08002399 shrink_readahead_size_eio(&file->f_ra);
2400 return -EIO;
Kent Overstreet723ef242020-12-14 19:04:52 -08002401}
2402
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002403static bool filemap_range_uptodate(struct address_space *mapping,
2404 loff_t pos, struct iov_iter *iter, struct page *page)
2405{
2406 int count;
2407
2408 if (PageUptodate(page))
2409 return true;
2410 /* pipes can't handle partially uptodate pages */
2411 if (iov_iter_is_pipe(iter))
2412 return false;
2413 if (!mapping->a_ops->is_partially_uptodate)
2414 return false;
2415 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2416 return false;
2417
2418 count = iter->count;
2419 if (page_offset(page) > pos) {
2420 count -= page_offset(page) - pos;
2421 pos = 0;
2422 } else {
2423 pos -= page_offset(page);
2424 }
2425
2426 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2427}
2428
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002429static int filemap_update_page(struct kiocb *iocb,
2430 struct address_space *mapping, struct iov_iter *iter,
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002431 struct page *page)
Kent Overstreet723ef242020-12-14 19:04:52 -08002432{
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002433 struct folio *folio = page_folio(page);
Kent Overstreet723ef242020-12-14 19:04:52 -08002434 int error;
2435
Jan Kara730633f2021-01-28 19:19:45 +01002436 if (iocb->ki_flags & IOCB_NOWAIT) {
2437 if (!filemap_invalidate_trylock_shared(mapping))
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002438 return -EAGAIN;
Jan Kara730633f2021-01-28 19:19:45 +01002439 } else {
2440 filemap_invalidate_lock_shared(mapping);
2441 }
2442
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002443 if (!folio_trylock(folio)) {
Jan Kara730633f2021-01-28 19:19:45 +01002444 error = -EAGAIN;
2445 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2446 goto unlock_mapping;
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002447 if (!(iocb->ki_flags & IOCB_WAITQ)) {
Jan Kara730633f2021-01-28 19:19:45 +01002448 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)9f2b04a2021-08-16 23:36:31 -04002449 /*
2450 * This is where we usually end up waiting for a
2451 * previously submitted readahead to finish.
2452 */
2453 folio_put_wait_locked(folio, TASK_KILLABLE);
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002454 return AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)bd8a1f32021-02-24 12:02:05 -08002455 }
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002456 error = __folio_lock_async(folio, iocb->ki_waitq);
Matthew Wilcox (Oracle)87d1d7b2021-02-24 12:02:25 -08002457 if (error)
Jan Kara730633f2021-01-28 19:19:45 +01002458 goto unlock_mapping;
Kent Overstreet723ef242020-12-14 19:04:52 -08002459 }
Kent Overstreet723ef242020-12-14 19:04:52 -08002460
Jan Kara730633f2021-01-28 19:19:45 +01002461 error = AOP_TRUNCATED_PAGE;
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002462 if (!folio->mapping)
Jan Kara730633f2021-01-28 19:19:45 +01002463 goto unlock;
Kent Overstreet723ef242020-12-14 19:04:52 -08002464
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002465 error = 0;
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002466 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, &folio->page))
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002467 goto unlock;
2468
2469 error = -EAGAIN;
2470 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2471 goto unlock;
2472
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002473 error = filemap_read_page(iocb->ki_filp, mapping, &folio->page);
Jan Kara730633f2021-01-28 19:19:45 +01002474 goto unlock_mapping;
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002475unlock:
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002476 folio_unlock(folio);
Jan Kara730633f2021-01-28 19:19:45 +01002477unlock_mapping:
2478 filemap_invalidate_unlock_shared(mapping);
2479 if (error == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)ffdc8da2020-12-30 17:58:40 -05002480 folio_put(folio);
Matthew Wilcox (Oracle)fce70da2021-02-24 12:02:28 -08002481 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002482}
2483
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002484static int filemap_create_page(struct file *file,
2485 struct address_space *mapping, pgoff_t index,
2486 struct pagevec *pvec)
Kent Overstreet723ef242020-12-14 19:04:52 -08002487{
Kent Overstreet723ef242020-12-14 19:04:52 -08002488 struct page *page;
2489 int error;
2490
Kent Overstreet723ef242020-12-14 19:04:52 -08002491 page = page_cache_alloc(mapping);
2492 if (!page)
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002493 return -ENOMEM;
Kent Overstreet723ef242020-12-14 19:04:52 -08002494
Jan Kara730633f2021-01-28 19:19:45 +01002495 /*
2496 * Protect against truncate / hole punch. Grabbing invalidate_lock here
2497 * assures we cannot instantiate and bring uptodate new pagecache pages
2498 * after evicting page cache during truncate and before actually
2499 * freeing blocks. Note that we could release invalidate_lock after
2500 * inserting the page into page cache as the locked page would then be
2501 * enough to synchronize with hole punching. But there are code paths
2502 * such as filemap_update_page() filling in partially uptodate pages or
2503 * ->readpages() that need to hold invalidate_lock while mapping blocks
2504 * for IO so let's hold the lock here as well to keep locking rules
2505 * simple.
2506 */
2507 filemap_invalidate_lock_shared(mapping);
Kent Overstreet723ef242020-12-14 19:04:52 -08002508 error = add_to_page_cache_lru(page, mapping, index,
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002509 mapping_gfp_constraint(mapping, GFP_KERNEL));
2510 if (error == -EEXIST)
2511 error = AOP_TRUNCATED_PAGE;
2512 if (error)
2513 goto error;
2514
2515 error = filemap_read_page(file, mapping, page);
2516 if (error)
2517 goto error;
2518
Jan Kara730633f2021-01-28 19:19:45 +01002519 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002520 pagevec_add(pvec, page);
2521 return 0;
2522error:
Jan Kara730633f2021-01-28 19:19:45 +01002523 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)68430302021-02-24 12:02:15 -08002524 put_page(page);
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002525 return error;
Kent Overstreet723ef242020-12-14 19:04:52 -08002526}
2527
Matthew Wilcox (Oracle)5963fe02021-02-24 12:02:32 -08002528static int filemap_readahead(struct kiocb *iocb, struct file *file,
2529 struct address_space *mapping, struct page *page,
2530 pgoff_t last_index)
2531{
2532 if (iocb->ki_flags & IOCB_NOIO)
2533 return -EAGAIN;
2534 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2535 page->index, last_index - page->index);
2536 return 0;
2537}
2538
Matthew Wilcox (Oracle)3a6bae42021-02-24 12:01:49 -08002539static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002540 struct pagevec *pvec)
Kent Overstreet06c04442020-12-14 19:04:56 -08002541{
2542 struct file *filp = iocb->ki_filp;
2543 struct address_space *mapping = filp->f_mapping;
2544 struct file_ra_state *ra = &filp->f_ra;
2545 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002546 pgoff_t last_index;
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002547 struct page *page;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002548 int err = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002549
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002550 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002551retry:
Kent Overstreet06c04442020-12-14 19:04:56 -08002552 if (fatal_signal_pending(current))
2553 return -EINTR;
2554
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002555 filemap_get_read_batch(mapping, index, last_index, pvec);
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002556 if (!pagevec_count(pvec)) {
2557 if (iocb->ki_flags & IOCB_NOIO)
2558 return -EAGAIN;
2559 page_cache_sync_readahead(mapping, ra, filp, index,
2560 last_index - index);
2561 filemap_get_read_batch(mapping, index, last_index, pvec);
2562 }
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002563 if (!pagevec_count(pvec)) {
2564 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2565 return -EAGAIN;
2566 err = filemap_create_page(filp, mapping,
2567 iocb->ki_pos >> PAGE_SHIFT, pvec);
2568 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002569 goto retry;
Matthew Wilcox (Oracle)f253e182021-02-24 12:02:18 -08002570 return err;
2571 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002572
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002573 page = pvec->pages[pagevec_count(pvec) - 1];
2574 if (PageReadahead(page)) {
2575 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2576 if (err)
2577 goto err;
2578 }
2579 if (!PageUptodate(page)) {
2580 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2581 iocb->ki_flags |= IOCB_NOWAIT;
2582 err = filemap_update_page(iocb, mapping, iter, page);
2583 if (err)
2584 goto err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002585 }
2586
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002587 return 0;
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002588err:
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002589 if (err < 0)
2590 put_page(page);
2591 if (likely(--pvec->nr))
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002592 return 0;
Matthew Wilcox (Oracle)4612aee2021-02-24 12:02:22 -08002593 if (err == AOP_TRUNCATED_PAGE)
Matthew Wilcox (Oracle)2642fca2021-02-24 12:02:35 -08002594 goto retry;
2595 return err;
Kent Overstreet06c04442020-12-14 19:04:56 -08002596}
2597
Randy Dunlap485bb992006-06-23 02:03:49 -07002598/**
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002599 * filemap_read - Read data from the page cache.
2600 * @iocb: The iocb to read.
2601 * @iter: Destination for the data.
2602 * @already_read: Number of bytes already read by the caller.
Randy Dunlap485bb992006-06-23 02:03:49 -07002603 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002604 * Copies data from the page cache. If the data is not currently present,
2605 * uses the readahead and readpage address_space operations to fetch it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002606 *
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002607 * Return: Total number of bytes copied, including those already read by
2608 * the caller. If an error happens before any bytes are copied, returns
2609 * a negative error number.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002610 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002611ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2612 ssize_t already_read)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002613{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002614 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002615 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002616 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002617 struct inode *inode = mapping->host;
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002618 struct pagevec pvec;
2619 int i, error = 0;
Kent Overstreet06c04442020-12-14 19:04:56 -08002620 bool writably_mapped;
2621 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002622
Kent Overstreet723ef242020-12-14 19:04:52 -08002623 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002624 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002625 if (unlikely(!iov_iter_count(iter)))
2626 return 0;
2627
Wei Fangc2a97372016-10-07 17:01:52 -07002628 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002629 pagevec_init(&pvec);
Wei Fangc2a97372016-10-07 17:01:52 -07002630
Kent Overstreet06c04442020-12-14 19:04:56 -08002631 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 cond_resched();
Kent Overstreet06c04442020-12-14 19:04:56 -08002633
2634 /*
2635 * If we've already successfully copied some data, then we
2636 * can no longer safely return -EIOCBQUEUED. Hence mark
2637 * an async read NOWAIT at that point.
2638 */
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002639 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
Kent Overstreet06c04442020-12-14 19:04:56 -08002640 iocb->ki_flags |= IOCB_NOWAIT;
2641
David Howells8c8387e2021-11-05 13:36:49 -07002642 if (unlikely(iocb->ki_pos >= i_size_read(inode)))
2643 break;
2644
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002645 error = filemap_get_pages(iocb, iter, &pvec);
2646 if (error < 0)
Kent Overstreet06c04442020-12-14 19:04:56 -08002647 break;
Michal Hocko5abf1862017-02-03 13:13:29 -08002648
Kent Overstreet723ef242020-12-14 19:04:52 -08002649 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002650 * i_size must be checked after we know the pages are Uptodate.
2651 *
2652 * Checking i_size after the check allows us to calculate
2653 * the correct value for "nr", which means the zero-filled
2654 * part of the page is not copied back to userspace (unless
2655 * another truncate extends the file - this is desired though).
Kent Overstreet723ef242020-12-14 19:04:52 -08002656 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002657 isize = i_size_read(inode);
2658 if (unlikely(iocb->ki_pos >= isize))
2659 goto put_pages;
Kent Overstreet06c04442020-12-14 19:04:56 -08002660 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2661
Kent Overstreet06c04442020-12-14 19:04:56 -08002662 /*
2663 * Once we start copying data, we don't want to be touching any
2664 * cachelines that might be contended:
2665 */
2666 writably_mapped = mapping_writably_mapped(mapping);
2667
2668 /*
2669 * When a sequential read accesses a page several times, only
2670 * mark it as accessed the first time.
2671 */
2672 if (iocb->ki_pos >> PAGE_SHIFT !=
2673 ra->prev_pos >> PAGE_SHIFT)
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002674 mark_page_accessed(pvec.pages[0]);
Kent Overstreet06c04442020-12-14 19:04:56 -08002675
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002676 for (i = 0; i < pagevec_count(&pvec); i++) {
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002677 struct page *page = pvec.pages[i];
2678 size_t page_size = thp_size(page);
2679 size_t offset = iocb->ki_pos & (page_size - 1);
2680 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2681 page_size - offset);
2682 size_t copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002683
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002684 if (end_offset < page_offset(page))
2685 break;
2686 if (i > 0)
2687 mark_page_accessed(page);
Kent Overstreet06c04442020-12-14 19:04:56 -08002688 /*
2689 * If users can be writing to this page using arbitrary
2690 * virtual addresses, take care about potential aliasing
2691 * before reading the page on the kernel side.
2692 */
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002693 if (writably_mapped) {
2694 int j;
Kent Overstreet06c04442020-12-14 19:04:56 -08002695
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002696 for (j = 0; j < thp_nr_pages(page); j++)
2697 flush_dcache_page(page + j);
2698 }
2699
2700 copied = copy_page_to_iter(page, offset, bytes, iter);
Kent Overstreet06c04442020-12-14 19:04:56 -08002701
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002702 already_read += copied;
Kent Overstreet06c04442020-12-14 19:04:56 -08002703 iocb->ki_pos += copied;
2704 ra->prev_pos = iocb->ki_pos;
2705
2706 if (copied < bytes) {
2707 error = -EFAULT;
2708 break;
Kent Overstreet723ef242020-12-14 19:04:52 -08002709 }
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002710 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002711put_pages:
Matthew Wilcox (Oracle)ff993ba2021-02-24 12:01:55 -08002712 for (i = 0; i < pagevec_count(&pvec); i++)
2713 put_page(pvec.pages[i]);
Matthew Wilcox (Oracle)cbd59c42021-02-24 12:01:59 -08002714 pagevec_reinit(&pvec);
Kent Overstreet06c04442020-12-14 19:04:56 -08002715 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002717 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002718
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002719 return already_read ? already_read : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720}
Christoph Hellwig87fa0f32021-02-24 12:02:42 -08002721EXPORT_SYMBOL_GPL(filemap_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722
Randy Dunlap485bb992006-06-23 02:03:49 -07002723/**
Al Viro6abd2322014-04-04 14:20:57 -04002724 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002725 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002726 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002727 *
Al Viro6abd2322014-04-04 14:20:57 -04002728 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002730 *
2731 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2732 * be returned when no data can be read without waiting for I/O requests
2733 * to complete; it doesn't prevent readahead.
2734 *
2735 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2736 * requests shall be made for the read or for readahead. When no data
2737 * can be read, -EAGAIN shall be returned. When readahead would be
2738 * triggered, a partial, possibly empty read shall be returned.
2739 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002740 * Return:
2741 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002742 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002743 */
2744ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002745generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002746{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002747 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002748 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002749
2750 if (!count)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002751 return 0; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002752
Al Viro2ba48ce2015-04-09 13:52:01 -04002753 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002754 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002755 struct address_space *mapping = file->f_mapping;
2756 struct inode *inode = mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002757
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002758 if (iocb->ki_flags & IOCB_NOWAIT) {
Jens Axboe7a60d6d2021-04-29 22:55:21 -07002759 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2760 iocb->ki_pos + count - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002761 return -EAGAIN;
2762 } else {
2763 retval = filemap_write_and_wait_range(mapping,
2764 iocb->ki_pos,
2765 iocb->ki_pos + count - 1);
2766 if (retval < 0)
Christoph Hellwig826ea862021-02-24 12:02:45 -08002767 return retval;
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002768 }
Al Viroed978a82014-03-05 22:53:04 -05002769
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002770 file_accessed(file);
2771
Al Viro5ecda132017-04-13 14:13:36 -04002772 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002773 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002774 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002775 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002776 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08002777 if (retval != -EIOCBQUEUED)
2778 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002779
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002780 /*
2781 * Btrfs can have a short DIO read if we encounter
2782 * compressed extents, so if there was an error, or if
2783 * we've already read everything we wanted to, or if
2784 * there was a short read because we hit EOF, go ahead
2785 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002786 * the rest of the read. Buffered reads will not work for
2787 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002788 */
Jens Axboe61d00172021-11-05 13:37:07 -07002789 if (retval < 0 || !count || IS_DAX(inode))
2790 return retval;
2791 if (iocb->ki_pos >= i_size_read(inode))
Christoph Hellwig826ea862021-02-24 12:02:45 -08002792 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002793 }
2794
Christoph Hellwig826ea862021-02-24 12:02:45 -08002795 return filemap_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002796}
Al Viroed978a82014-03-05 22:53:04 -05002797EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002798
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002799static inline loff_t page_seek_hole_data(struct xa_state *xas,
2800 struct address_space *mapping, struct page *page,
2801 loff_t start, loff_t end, bool seek_data)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002802{
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002803 const struct address_space_operations *ops = mapping->a_ops;
2804 size_t offset, bsz = i_blocksize(mapping->host);
2805
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002806 if (xa_is_value(page) || PageUptodate(page))
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002807 return seek_data ? start : end;
2808 if (!ops->is_partially_uptodate)
2809 return seek_data ? end : start;
2810
2811 xas_pause(xas);
2812 rcu_read_unlock();
2813 lock_page(page);
2814 if (unlikely(page->mapping != mapping))
2815 goto unlock;
2816
2817 offset = offset_in_thp(page, start) & ~(bsz - 1);
2818
2819 do {
2820 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2821 break;
2822 start = (start + bsz) & ~(bsz - 1);
2823 offset += bsz;
2824 } while (offset < thp_size(page));
2825unlock:
2826 unlock_page(page);
2827 rcu_read_lock();
2828 return start;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002829}
2830
2831static inline
2832unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2833{
2834 if (xa_is_value(page))
2835 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2836 return thp_size(page);
2837}
2838
2839/**
2840 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2841 * @mapping: Address space to search.
2842 * @start: First byte to consider.
2843 * @end: Limit of search (exclusive).
2844 * @whence: Either SEEK_HOLE or SEEK_DATA.
2845 *
2846 * If the page cache knows which blocks contain holes and which blocks
2847 * contain data, your filesystem can use this function to implement
2848 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2849 * entirely memory-based such as tmpfs, and filesystems which support
2850 * unwritten extents.
2851 *
Ingo Molnarf0953a12021-05-06 18:06:47 -07002852 * Return: The requested offset on success, or -ENXIO if @whence specifies
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002853 * SEEK_DATA and there is no data after @start. There is an implicit hole
2854 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2855 * and @end contain data.
2856 */
2857loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2858 loff_t end, int whence)
2859{
2860 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
Hugh Dickinsed98b012021-04-23 14:29:00 -07002861 pgoff_t max = (end - 1) >> PAGE_SHIFT;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002862 bool seek_data = (whence == SEEK_DATA);
2863 struct page *page;
2864
2865 if (end <= start)
2866 return -ENXIO;
2867
2868 rcu_read_lock();
2869 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
Hugh Dickinsed98b012021-04-23 14:29:00 -07002870 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2871 unsigned int seek_size;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002872
2873 if (start < pos) {
2874 if (!seek_data)
2875 goto unlock;
2876 start = pos;
2877 }
2878
Hugh Dickinsed98b012021-04-23 14:29:00 -07002879 seek_size = seek_page_size(&xas, page);
2880 pos = round_up(pos + 1, seek_size);
Matthew Wilcox (Oracle)54fa39a2021-02-25 17:15:52 -08002881 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2882 seek_data);
2883 if (start < pos)
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002884 goto unlock;
Hugh Dickinsed98b012021-04-23 14:29:00 -07002885 if (start >= end)
2886 break;
2887 if (seek_size > PAGE_SIZE)
2888 xas_set(&xas, pos >> PAGE_SHIFT);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002889 if (!xa_is_value(page))
2890 put_page(page);
2891 }
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002892 if (seek_data)
Hugh Dickinsed98b012021-04-23 14:29:00 -07002893 start = -ENXIO;
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002894unlock:
2895 rcu_read_unlock();
Hugh Dickinsed98b012021-04-23 14:29:00 -07002896 if (page && !xa_is_value(page))
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002897 put_page(page);
Matthew Wilcox (Oracle)41139aa2021-02-25 17:15:48 -08002898 if (start > end)
2899 return end;
2900 return start;
2901}
2902
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002905/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002906 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002907 * @vmf - the vm_fault for this fault.
2908 * @page - the page to lock.
2909 * @fpin - the pointer to the file we may pin (or is already pinned).
2910 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002911 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002912 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002913 * 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 -07002914 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002915 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002916static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2917 struct file **fpin)
2918{
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05002919 struct folio *folio = page_folio(page);
2920
2921 if (folio_trylock(folio))
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002922 return 1;
2923
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002924 /*
2925 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002926 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002927 * is supposed to work. We have way too many special cases..
2928 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002929 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2930 return 0;
2931
2932 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2933 if (vmf->flags & FAULT_FLAG_KILLABLE) {
Matthew Wilcox (Oracle)af7f29d2020-12-08 00:07:31 -05002934 if (__folio_lock_killable(folio)) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002935 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002936 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002937 * but all fault_handlers only check for fatal signals
2938 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002939 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002940 */
2941 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002942 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002943 return 0;
2944 }
2945 } else
Matthew Wilcox (Oracle)7c23c782021-03-01 19:38:25 -05002946 __folio_lock(folio);
2947
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002948 return 1;
2949}
2950
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002951/*
2952 * Synchronous readahead happens when we don't even find a page in the page
2953 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2954 * to drop the mmap sem we return the file that was pinned in order for us to do
2955 * that. If we didn't pin a file then we return NULL. The file that is
2956 * returned needs to be fput()'ed when we're done with it.
2957 */
2958static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002959{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002960 struct file *file = vmf->vma->vm_file;
2961 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002962 struct address_space *mapping = file->f_mapping;
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002963 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002964 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002965 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002966
2967 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002968 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002969 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002970 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002971 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002972
Josef Bacik2a1180f2019-03-13 11:44:18 -07002973 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002974 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)fcd9ae42021-04-07 21:18:55 +01002975 page_cache_sync_ra(&ractl, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002976 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002977 }
2978
Andi Kleen207d04b2011-05-24 17:12:29 -07002979 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002980 mmap_miss = READ_ONCE(ra->mmap_miss);
2981 if (mmap_miss < MMAP_LOTSAMISS * 10)
2982 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002983
2984 /*
2985 * Do we miss much more than hit in this file? If so,
2986 * stop bothering with read-ahead. It will only hurt.
2987 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002988 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002989 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002990
Wu Fengguangd30a1102009-06-16 15:31:30 -07002991 /*
2992 * mmap read-around
2993 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002994 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002995 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002996 ra->size = ra->ra_pages;
2997 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002998 ractl._index = ra->start;
2999 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003000 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003001}
3002
3003/*
3004 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003005 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003006 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07003007 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003008static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
3009 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07003010{
Josef Bacik2a1180f2019-03-13 11:44:18 -07003011 struct file *file = vmf->vma->vm_file;
3012 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003013 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003014 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003015 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07003016 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003017
3018 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07003019 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003020 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003021 mmap_miss = READ_ONCE(ra->mmap_miss);
3022 if (mmap_miss)
3023 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003024 if (PageReadahead(page)) {
3025 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07003026 page_cache_async_readahead(mapping, ra, file,
3027 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003028 }
3029 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003030}
3031
Randy Dunlap485bb992006-06-23 02:03:49 -07003032/**
Nick Piggin54cb8822007-07-19 01:46:59 -07003033 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07003034 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07003035 *
Nick Piggin54cb8822007-07-19 01:46:59 -07003036 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07003037 * mapped memory region to read in file data during a page fault.
3038 *
3039 * The goto's are kind of ugly, but this streamlines the normal case of having
3040 * it in the page cache, and handles the special cases reasonably without
3041 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003042 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003043 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003044 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003045 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07003046 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003047 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003048 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07003049 * has not been released.
3050 *
3051 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08003052 *
3053 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003054 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003055vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003056{
3057 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08003058 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003059 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003060 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003061 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07003062 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003063 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003064 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003065 vm_fault_t ret = 0;
Jan Kara730633f2021-01-28 19:19:45 +01003066 bool mapping_locked = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003067
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003068 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3069 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07003070 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003071
Linus Torvalds1da177e2005-04-16 15:20:36 -07003072 /*
Johannes Weiner49426422013-10-16 13:46:59 -07003073 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07003074 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003075 page = find_get_page(mapping, offset);
Jan Kara730633f2021-01-28 19:19:45 +01003076 if (likely(page)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07003077 /*
Jan Kara730633f2021-01-28 19:19:45 +01003078 * We found the page, so try async readahead before waiting for
3079 * the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080 */
Jan Kara730633f2021-01-28 19:19:45 +01003081 if (!(vmf->flags & FAULT_FLAG_TRIED))
3082 fpin = do_async_mmap_readahead(vmf, page);
3083 if (unlikely(!PageUptodate(page))) {
3084 filemap_invalidate_lock_shared(mapping);
3085 mapping_locked = true;
3086 }
3087 } else {
Linus Torvaldsef00e082009-06-16 15:31:25 -07003088 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07003089 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07003090 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003091 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003092 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07003093retry_find:
Jan Kara730633f2021-01-28 19:19:45 +01003094 /*
3095 * See comment in filemap_create_page() why we need
3096 * invalidate_lock
3097 */
3098 if (!mapping_locked) {
3099 filemap_invalidate_lock_shared(mapping);
3100 mapping_locked = true;
3101 }
Josef Bacika75d4c32019-03-13 11:44:14 -07003102 page = pagecache_get_page(mapping, offset,
3103 FGP_CREAT|FGP_FOR_MMAP,
3104 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003105 if (!page) {
3106 if (fpin)
3107 goto out_retry;
Jan Kara730633f2021-01-28 19:19:45 +01003108 filemap_invalidate_unlock_shared(mapping);
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07003109 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003110 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003111 }
3112
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003113 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3114 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07003115
3116 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07003117 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07003118 unlock_page(page);
3119 put_page(page);
3120 goto retry_find;
3121 }
Song Liu520e5ba2019-09-23 15:37:50 -07003122 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07003123
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124 /*
Nick Piggind00806b2007-07-19 01:46:57 -07003125 * We have a locked page in the page cache, now we need to check
3126 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003127 */
Jan Kara730633f2021-01-28 19:19:45 +01003128 if (unlikely(!PageUptodate(page))) {
3129 /*
3130 * The page was in cache and uptodate and now it is not.
3131 * Strange but possible since we didn't hold the page lock all
3132 * the time. Let's drop everything get the invalidate lock and
3133 * try again.
3134 */
3135 if (!mapping_locked) {
3136 unlock_page(page);
3137 put_page(page);
3138 goto retry_find;
3139 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003140 goto page_not_uptodate;
Jan Kara730633f2021-01-28 19:19:45 +01003141 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003142
Linus Torvaldsef00e082009-06-16 15:31:25 -07003143 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003144 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003145 * time to return to the upper layer and have it re-find the vma and
3146 * redo the fault.
3147 */
3148 if (fpin) {
3149 unlock_page(page);
3150 goto out_retry;
3151 }
Jan Kara730633f2021-01-28 19:19:45 +01003152 if (mapping_locked)
3153 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003154
3155 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07003156 * Found the page and have a reference on it.
3157 * We must recheck i_size under page lock.
3158 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07003159 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3160 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07003161 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003162 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07003163 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07003164 }
3165
Nick Piggind0217ac2007-07-19 01:47:03 -07003166 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07003167 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170 /*
3171 * Umm, take care of errors if the page isn't up-to-date.
3172 * Try to re-read it _once_. We do this synchronously,
3173 * because there really aren't any performance issues here
3174 * and we need to check for errors.
3175 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003176 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Matthew Wilcox (Oracle)d31fa862021-04-29 22:55:26 -07003177 error = filemap_read_page(file, mapping, page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003178 if (fpin)
3179 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003180 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07003181
3182 if (!error || error == AOP_TRUNCATED_PAGE)
3183 goto retry_find;
Jan Kara730633f2021-01-28 19:19:45 +01003184 filemap_invalidate_unlock_shared(mapping);
Nick Piggind00806b2007-07-19 01:46:57 -07003185
Nick Piggind0217ac2007-07-19 01:47:03 -07003186 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003187
3188out_retry:
3189 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07003190 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003191 * re-find the vma and come back and find our hopefully still populated
3192 * page.
3193 */
3194 if (page)
3195 put_page(page);
Jan Kara730633f2021-01-28 19:19:45 +01003196 if (mapping_locked)
3197 filemap_invalidate_unlock_shared(mapping);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07003198 if (fpin)
3199 fput(fpin);
3200 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07003201}
3202EXPORT_SYMBOL(filemap_fault);
3203
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003204static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003205{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003206 struct mm_struct *mm = vmf->vma->vm_mm;
3207
3208 /* Huge page is mapped? No need to proceed. */
3209 if (pmd_trans_huge(*vmf->pmd)) {
3210 unlock_page(page);
3211 put_page(page);
3212 return true;
3213 }
3214
3215 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
Yang Shie0f43fa2021-11-05 13:41:04 -07003216 vm_fault_t ret = do_set_pmd(vmf, page);
3217 if (!ret) {
3218 /* The page is mapped successfully, reference consumed. */
3219 unlock_page(page);
3220 return true;
3221 }
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003222 }
3223
Qi Zheng03c4f202021-11-05 13:38:38 -07003224 if (pmd_none(*vmf->pmd))
3225 pmd_install(mm, vmf->pmd, &vmf->prealloc_pte);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003226
3227 /* See comment in handle_pte_fault() */
3228 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3229 unlock_page(page);
3230 put_page(page);
3231 return true;
3232 }
3233
3234 return false;
3235}
3236
3237static struct page *next_uptodate_page(struct page *page,
3238 struct address_space *mapping,
3239 struct xa_state *xas, pgoff_t end_pgoff)
3240{
3241 unsigned long max_idx;
3242
3243 do {
3244 if (!page)
3245 return NULL;
3246 if (xas_retry(xas, page))
3247 continue;
3248 if (xa_is_value(page))
3249 continue;
3250 if (PageLocked(page))
3251 continue;
3252 if (!page_cache_get_speculative(page))
3253 continue;
3254 /* Has the page moved or been split? */
3255 if (unlikely(page != xas_reload(xas)))
3256 goto skip;
3257 if (!PageUptodate(page) || PageReadahead(page))
3258 goto skip;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003259 if (!trylock_page(page))
3260 goto skip;
3261 if (page->mapping != mapping)
3262 goto unlock;
3263 if (!PageUptodate(page))
3264 goto unlock;
3265 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3266 if (xas->xa_index >= max_idx)
3267 goto unlock;
3268 return page;
3269unlock:
3270 unlock_page(page);
3271skip:
3272 put_page(page);
3273 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3274
3275 return NULL;
3276}
3277
3278static inline struct page *first_map_page(struct address_space *mapping,
3279 struct xa_state *xas,
3280 pgoff_t end_pgoff)
3281{
3282 return next_uptodate_page(xas_find(xas, end_pgoff),
3283 mapping, xas, end_pgoff);
3284}
3285
3286static inline struct page *next_map_page(struct address_space *mapping,
3287 struct xa_state *xas,
3288 pgoff_t end_pgoff)
3289{
3290 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3291 mapping, xas, end_pgoff);
3292}
3293
3294vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3295 pgoff_t start_pgoff, pgoff_t end_pgoff)
3296{
3297 struct vm_area_struct *vma = vmf->vma;
3298 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003299 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07003300 pgoff_t last_pgoff = start_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003301 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003302 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003303 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003304 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003305 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003306
3307 rcu_read_lock();
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003308 head = first_map_page(mapping, &xas, end_pgoff);
3309 if (!head)
3310 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003311
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003312 if (filemap_map_pmd(vmf, head)) {
3313 ret = VM_FAULT_NOPAGE;
3314 goto out;
3315 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003316
Will Deacon9d3af4b2021-01-14 15:24:19 +00003317 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3318 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003319 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003320 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003321 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003322 goto unlock;
3323
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003324 if (mmap_miss > 0)
3325 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003326
Will Deacon9d3af4b2021-01-14 15:24:19 +00003327 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003328 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003329 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003330
3331 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003332 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003333
Will Deacon46bdb422020-11-24 18:48:26 +00003334 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003335 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003336 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003337
Will Deacon9d3af4b2021-01-14 15:24:19 +00003338 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003339 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003340 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003341 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003342 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003343unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003344 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003345 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003346 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3347 pte_unmap_unlock(vmf->pte, vmf->ptl);
3348out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003349 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003350 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003351 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003352}
3353EXPORT_SYMBOL(filemap_map_pages);
3354
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003355vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003356{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003357 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003358 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003359 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003360
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003361 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003362 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003363 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003364 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003365 unlock_page(page);
3366 ret = VM_FAULT_NOPAGE;
3367 goto out;
3368 }
Jan Kara14da9202012-06-12 16:20:37 +02003369 /*
3370 * We mark the page dirty already here so that when freeze is in
3371 * progress, we are guaranteed that writeback during freezing will
3372 * see the dirty page and writeprotect it again.
3373 */
3374 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003375 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003376out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003377 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003378 return ret;
3379}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003380
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003381const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003382 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003383 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003384 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003385};
3386
3387/* This is used for a general mmap of a disk file */
3388
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003389int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003390{
3391 struct address_space *mapping = file->f_mapping;
3392
3393 if (!mapping->a_ops->readpage)
3394 return -ENOEXEC;
3395 file_accessed(file);
3396 vma->vm_ops = &generic_file_vm_ops;
3397 return 0;
3398}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003399
3400/*
3401 * This is for filesystems which do not implement ->writepage.
3402 */
3403int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3404{
3405 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3406 return -EINVAL;
3407 return generic_file_mmap(file, vma);
3408}
3409#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003410vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003411{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003412 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003413}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003414int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003415{
3416 return -ENOSYS;
3417}
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003418int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003419{
3420 return -ENOSYS;
3421}
3422#endif /* CONFIG_MMU */
3423
Arnd Bergmann453972282018-04-13 15:35:27 -07003424EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425EXPORT_SYMBOL(generic_file_mmap);
3426EXPORT_SYMBOL(generic_file_readonly_mmap);
3427
Sasha Levin67f9fd92014-04-03 14:48:18 -07003428static struct page *wait_on_page_read(struct page *page)
3429{
3430 if (!IS_ERR(page)) {
3431 wait_on_page_locked(page);
3432 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003433 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003434 page = ERR_PTR(-EIO);
3435 }
3436 }
3437 return page;
3438}
3439
Mel Gorman32b63522016-03-15 14:55:36 -07003440static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003441 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003442 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003443 void *data,
3444 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003445{
Nick Piggineb2be182007-10-16 01:24:57 -07003446 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003447 int err;
3448repeat:
3449 page = find_get_page(mapping, index);
3450 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003451 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003452 if (!page)
3453 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003454 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003455 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003456 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003457 if (err == -EEXIST)
3458 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003459 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460 return ERR_PTR(err);
3461 }
Mel Gorman32b63522016-03-15 14:55:36 -07003462
3463filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003464 if (filler)
3465 err = filler(data, page);
3466 else
3467 err = mapping->a_ops->readpage(data, page);
3468
Linus Torvalds1da177e2005-04-16 15:20:36 -07003469 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003470 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003471 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003472 }
Mel Gorman32b63522016-03-15 14:55:36 -07003473
3474 page = wait_on_page_read(page);
3475 if (IS_ERR(page))
3476 return page;
3477 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003478 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003479 if (PageUptodate(page))
3480 goto out;
3481
Mel Gormanebded022016-03-15 14:55:39 -07003482 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003483 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003484 * case a: Page is being filled and the page lock is held
3485 * case b: Read/write error clearing the page uptodate status
3486 * case c: Truncation in progress (page locked)
3487 * case d: Reclaim in progress
3488 *
3489 * Case a, the page will be up to date when the page is unlocked.
3490 * There is no need to serialise on the page lock here as the page
3491 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003492 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003493 * it's a race vs truncate race.
3494 * Case b, the page will not be up to date
3495 * Case c, the page may be truncated but in itself, the data may still
3496 * be valid after IO completes as it's a read vs truncate race. The
3497 * operation must restart if the page is not uptodate on unlock but
3498 * otherwise serialising on page lock to stabilise the mapping gives
3499 * no additional guarantees to the caller as the page lock is
3500 * released before return.
3501 * Case d, similar to truncation. If reclaim holds the page lock, it
3502 * will be a race with remove_mapping that determines if the mapping
3503 * is valid on unlock but otherwise the data is valid and there is
3504 * no need to serialise with page lock.
3505 *
3506 * As the page lock gives no additional guarantee, we optimistically
3507 * wait on the page to be unlocked and check if it's up to date and
3508 * use the page if it is. Otherwise, the page lock is required to
3509 * distinguish between the different cases. The motivation is that we
3510 * avoid spurious serialisations and wakeups when multiple processes
3511 * wait on the same page for IO to complete.
3512 */
3513 wait_on_page_locked(page);
3514 if (PageUptodate(page))
3515 goto out;
3516
3517 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003518 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003519
3520 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003521 if (!page->mapping) {
3522 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003523 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003524 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525 }
Mel Gormanebded022016-03-15 14:55:39 -07003526
3527 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003528 if (PageUptodate(page)) {
3529 unlock_page(page);
3530 goto out;
3531 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003532
3533 /*
3534 * A previous I/O error may have been due to temporary
3535 * failures.
3536 * Clear page error before actual read, PG_error will be
3537 * set again if read page fails.
3538 */
3539 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003540 goto filler;
3541
David Howellsc855ff32007-05-09 13:42:20 +01003542out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003543 mark_page_accessed(page);
3544 return page;
3545}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003546
3547/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003548 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003549 * @mapping: the page's address_space
3550 * @index: the page index
3551 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003552 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003553 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003554 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003555 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003556 *
3557 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003558 *
Jan Kara730633f2021-01-28 19:19:45 +01003559 * The function expects mapping->invalidate_lock to be already held.
3560 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003561 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003562 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003563struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003564 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003565 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003566 void *data)
3567{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003568 return do_read_cache_page(mapping, index, filler, data,
3569 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003570}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003571EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003572
3573/**
3574 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3575 * @mapping: the page's address_space
3576 * @index: the page index
3577 * @gfp: the page allocator flags to use if allocating
3578 *
3579 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003580 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003581 *
3582 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003583 *
Jan Kara730633f2021-01-28 19:19:45 +01003584 * The function expects mapping->invalidate_lock to be already held.
3585 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003586 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003587 */
3588struct page *read_cache_page_gfp(struct address_space *mapping,
3589 pgoff_t index,
3590 gfp_t gfp)
3591{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003592 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003593}
3594EXPORT_SYMBOL(read_cache_page_gfp);
3595
Nick Pigginafddba42007-10-16 01:25:01 -07003596int pagecache_write_begin(struct file *file, struct address_space *mapping,
3597 loff_t pos, unsigned len, unsigned flags,
3598 struct page **pagep, void **fsdata)
3599{
3600 const struct address_space_operations *aops = mapping->a_ops;
3601
Nick Piggin4e02ed42008-10-29 14:00:55 -07003602 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003603 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003604}
3605EXPORT_SYMBOL(pagecache_write_begin);
3606
3607int pagecache_write_end(struct file *file, struct address_space *mapping,
3608 loff_t pos, unsigned len, unsigned copied,
3609 struct page *page, void *fsdata)
3610{
3611 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003612
Nick Piggin4e02ed42008-10-29 14:00:55 -07003613 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003614}
3615EXPORT_SYMBOL(pagecache_write_end);
3616
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003617/*
3618 * Warn about a page cache invalidation failure during a direct I/O write.
3619 */
3620void dio_warn_stale_pagecache(struct file *filp)
3621{
3622 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3623 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003624 char *path;
3625
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003626 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003627 if (__ratelimit(&_rs)) {
3628 path = file_path(filp, pathname, sizeof(pathname));
3629 if (IS_ERR(path))
3630 path = "(unknown)";
3631 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3632 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3633 current->comm);
3634 }
3635}
3636
Linus Torvalds1da177e2005-04-16 15:20:36 -07003637ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003638generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003639{
3640 struct file *file = iocb->ki_filp;
3641 struct address_space *mapping = file->f_mapping;
3642 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003643 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003644 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003645 size_t write_len;
3646 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003647
Al Viro0c949332014-03-22 06:51:37 -04003648 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003649 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003650
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003651 if (iocb->ki_flags & IOCB_NOWAIT) {
3652 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003653 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003654 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003655 return -EAGAIN;
3656 } else {
3657 written = filemap_write_and_wait_range(mapping, pos,
3658 pos + write_len - 1);
3659 if (written)
3660 goto out;
3661 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003662
3663 /*
3664 * After a write we want buffered reads to be sure to go to disk to get
3665 * the new data. We invalidate clean cached page from the region we're
3666 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003667 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003668 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003669 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003670 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003671 /*
3672 * If a page can not be invalidated, return 0 to fall back
3673 * to buffered write.
3674 */
3675 if (written) {
3676 if (written == -EBUSY)
3677 return 0;
3678 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003679 }
3680
Al Viro639a93a52017-04-13 14:10:15 -04003681 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003682
3683 /*
3684 * Finally, try again to invalidate clean pages which might have been
3685 * cached by non-direct readahead, or faulted in by get_user_pages()
3686 * if the source of the write was an mmap'ed region of the file
3687 * we're writing. Either one is a pretty crazy thing to do,
3688 * so we don't support it 100%. If this invalidation
3689 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003690 *
3691 * Most of the time we do not need this since dio_complete() will do
3692 * the invalidation for us. However there are some file systems that
3693 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003694 * them by removing it completely.
3695 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003696 * Noticeable example is a blkdev_direct_IO().
3697 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003698 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003699 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003700 if (written > 0 && mapping->nrpages &&
3701 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3702 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003703
Linus Torvalds1da177e2005-04-16 15:20:36 -07003704 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003705 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003706 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003707 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3708 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003709 mark_inode_dirty(inode);
3710 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003711 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003712 }
Pavel Begunkovab2125d2021-02-24 12:01:45 -08003713 if (written != -EIOCBQUEUED)
3714 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003715out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003716 return written;
3717}
3718EXPORT_SYMBOL(generic_file_direct_write);
3719
Al Viro3b93f912014-02-11 21:34:08 -05003720ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003721 struct iov_iter *i, loff_t pos)
3722{
3723 struct address_space *mapping = file->f_mapping;
3724 const struct address_space_operations *a_ops = mapping->a_ops;
3725 long status = 0;
3726 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003727 unsigned int flags = 0;
3728
Nick Pigginafddba42007-10-16 01:25:01 -07003729 do {
3730 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003731 unsigned long offset; /* Offset into pagecache page */
3732 unsigned long bytes; /* Bytes to write to page */
3733 size_t copied; /* Bytes copied from user */
3734 void *fsdata;
3735
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003736 offset = (pos & (PAGE_SIZE - 1));
3737 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003738 iov_iter_count(i));
3739
3740again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003741 /*
3742 * Bring in the user page that we will copy from _first_.
3743 * Otherwise there's a nasty deadlock on copying from the
3744 * same page as we're writing to, without it being marked
3745 * up-to-date.
Linus Torvalds00a3d662015-10-07 08:32:38 +01003746 */
Andreas Gruenbachera6294592021-08-02 14:54:16 +02003747 if (unlikely(fault_in_iov_iter_readable(i, bytes))) {
Linus Torvalds00a3d662015-10-07 08:32:38 +01003748 status = -EFAULT;
3749 break;
3750 }
3751
Jan Kara296291c2015-10-22 13:32:21 -07003752 if (fatal_signal_pending(current)) {
3753 status = -EINTR;
3754 break;
3755 }
3756
Nick Piggin674b8922007-10-16 01:25:03 -07003757 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003758 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003759 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003760 break;
3761
anfei zhou931e80e2010-02-02 13:44:02 -08003762 if (mapping_writably_mapped(mapping))
3763 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003764
Al Virof0b65f32021-04-30 10:26:41 -04003765 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
Nick Pigginafddba42007-10-16 01:25:01 -07003766 flush_dcache_page(page);
3767
3768 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3769 page, fsdata);
Al Virof0b65f32021-04-30 10:26:41 -04003770 if (unlikely(status != copied)) {
3771 iov_iter_revert(i, copied - max(status, 0L));
3772 if (unlikely(status < 0))
3773 break;
3774 }
Nick Pigginafddba42007-10-16 01:25:01 -07003775 cond_resched();
3776
Al Virobc1bb412021-05-31 00:32:44 -04003777 if (unlikely(status == 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07003778 /*
Al Virobc1bb412021-05-31 00:32:44 -04003779 * A short copy made ->write_end() reject the
3780 * thing entirely. Might be memory poisoning
3781 * halfway through, might be a race with munmap,
3782 * might be severe memory pressure.
Nick Pigginafddba42007-10-16 01:25:01 -07003783 */
Al Virobc1bb412021-05-31 00:32:44 -04003784 if (copied)
3785 bytes = copied;
Nick Pigginafddba42007-10-16 01:25:01 -07003786 goto again;
3787 }
Al Virof0b65f32021-04-30 10:26:41 -04003788 pos += status;
3789 written += status;
Nick Pigginafddba42007-10-16 01:25:01 -07003790
3791 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003792 } while (iov_iter_count(i));
3793
3794 return written ? written : status;
3795}
Al Viro3b93f912014-02-11 21:34:08 -05003796EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003797
Jan Karae4dd9de2009-08-17 18:10:06 +02003798/**
Al Viro81742022014-04-03 03:17:43 -04003799 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003800 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003801 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003802 *
3803 * This function does all the work needed for actually writing data to a
3804 * file. It does all basic checks, removes SUID from the file, updates
3805 * modification times and calls proper subroutines depending on whether we
3806 * do direct IO or a standard buffered write.
3807 *
Jan Kara96087032021-04-12 15:50:21 +02003808 * It expects i_rwsem to be grabbed unless we work on a block device or similar
Jan Karae4dd9de2009-08-17 18:10:06 +02003809 * object which does not need locking at all.
3810 *
3811 * This function does *not* take care of syncing data in case of O_SYNC write.
3812 * A caller has to handle it. This is mainly due to the fact that we want to
Jan Kara96087032021-04-12 15:50:21 +02003813 * avoid syncing under i_rwsem.
Mike Rapoporta862f682019-03-05 15:48:42 -08003814 *
3815 * Return:
3816 * * number of bytes written, even for truncated writes
3817 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003818 */
Al Viro81742022014-04-03 03:17:43 -04003819ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003820{
3821 struct file *file = iocb->ki_filp;
Zhiyuan Dai68d68ff2021-05-04 18:40:12 -07003822 struct address_space *mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003823 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003824 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003825 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003826 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003827
Linus Torvalds1da177e2005-04-16 15:20:36 -07003828 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003829 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003830 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003831 if (err)
3832 goto out;
3833
Josef Bacikc3b2da32012-03-26 09:59:21 -04003834 err = file_update_time(file);
3835 if (err)
3836 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003837
Al Viro2ba48ce2015-04-09 13:52:01 -04003838 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003839 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003840
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003841 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003842 /*
3843 * If the write stopped short of completing, fall back to
3844 * buffered writes. Some filesystems do this for writes to
3845 * holes, for example. For DAX files, a buffered write will
3846 * not succeed (even if it did, DAX does not handle dirty
3847 * page-cache pages correctly).
3848 */
Al Viro0b8def92015-04-07 10:22:53 -04003849 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003850 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003851
Al Viro0b8def92015-04-07 10:22:53 -04003852 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003853 /*
Al Viro3b93f912014-02-11 21:34:08 -05003854 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003855 * then we want to return the number of bytes which were
3856 * direct-written, or the error code if that was zero. Note
3857 * that this differs from normal direct-io semantics, which
3858 * will return -EFOO even if some bytes were written.
3859 */
Al Viro60bb4522014-08-08 12:39:16 -04003860 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003861 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003862 goto out;
3863 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003864 /*
3865 * We need to ensure that the page cache pages are written to
3866 * disk and invalidated to preserve the expected O_DIRECT
3867 * semantics.
3868 */
Al Viro3b93f912014-02-11 21:34:08 -05003869 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003870 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003871 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003872 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003873 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003874 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003875 pos >> PAGE_SHIFT,
3876 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003877 } else {
3878 /*
3879 * We don't know how much we wrote, so just return
3880 * the number of bytes which were direct-written
3881 */
3882 }
3883 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003884 written = generic_perform_write(file, from, iocb->ki_pos);
3885 if (likely(written > 0))
3886 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003887 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003888out:
3889 current->backing_dev_info = NULL;
3890 return written ? written : err;
3891}
Al Viro81742022014-04-03 03:17:43 -04003892EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003893
Jan Karae4dd9de2009-08-17 18:10:06 +02003894/**
Al Viro81742022014-04-03 03:17:43 -04003895 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003896 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003897 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003898 *
Al Viro81742022014-04-03 03:17:43 -04003899 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003900 * filesystems. It takes care of syncing the file in case of O_SYNC file
Jan Kara96087032021-04-12 15:50:21 +02003901 * and acquires i_rwsem as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003902 * Return:
3903 * * negative error code if no data has been written at all of
3904 * vfs_fsync_range() failed for a synchronous write
3905 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003906 */
Al Viro81742022014-04-03 03:17:43 -04003907ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003908{
3909 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003910 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003911 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003912
Al Viro59551022016-01-22 15:40:57 -05003913 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003914 ret = generic_write_checks(iocb, from);
3915 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003916 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003917 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003918
Christoph Hellwige2592212016-04-07 08:52:01 -07003919 if (ret > 0)
3920 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003921 return ret;
3922}
Al Viro81742022014-04-03 03:17:43 -04003923EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003924
David Howellscf9a2ae2006-08-29 19:05:54 +01003925/**
3926 * try_to_release_page() - release old fs-specific metadata on a page
3927 *
3928 * @page: the page which the kernel is trying to free
3929 * @gfp_mask: memory allocation flags (and I/O mode)
3930 *
3931 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003932 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003933 *
David Howells266cf652009-04-03 16:42:36 +01003934 * This may also be called if PG_fscache is set on a page, indicating that the
3935 * page is known to the local caching routines.
3936 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003937 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003938 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003939 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003940 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003941 */
3942int try_to_release_page(struct page *page, gfp_t gfp_mask)
3943{
3944 struct address_space * const mapping = page->mapping;
3945
3946 BUG_ON(!PageLocked(page));
3947 if (PageWriteback(page))
3948 return 0;
3949
3950 if (mapping && mapping->a_ops->releasepage)
3951 return mapping->a_ops->releasepage(page, gfp_mask);
3952 return try_to_free_buffers(page);
3953}
3954
3955EXPORT_SYMBOL(try_to_release_page);