blob: fb7a8d9b560331c578d78f6f2a6bc5406957833a [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8/*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080015#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/fs.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010017#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070018#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080019#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mm.h>
23#include <linux/swap.h>
24#include <linux/mman.h>
25#include <linux/pagemap.h>
26#include <linux/file.h>
27#include <linux/uio.h>
Josef Bacikcfcbfb12019-05-13 17:21:04 -070028#include <linux/error-injection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/hash.h>
30#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070031#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080035#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070036#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080037#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060038#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080039#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070040#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070041#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070042#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070043#include <linux/ramfs.h>
Yang Shib9306a72020-08-06 23:19:55 -070044#include <linux/page_idle.h>
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +030045#include <asm/pgalloc.h>
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 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080078 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080079 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070081 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080082 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070083 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070084 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070086 * ->mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 * ->lock_page (access_process_vm)
88 *
Al Viroccad2362014-02-11 22:36:48 -050089 * ->i_mutex (generic_perform_write)
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070090 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060092 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110093 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070094 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080096 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 * ->anon_vma.lock (vma_adjust)
98 *
99 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700100 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700102 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700103 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700105 * ->i_pages lock (try_to_unmap_one)
Hugh Dickins15b44732020-12-15 14:21:31 -0800106 * ->lruvec->lru_lock (follow_page->mark_page_accessed)
107 * ->lruvec->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700109 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600110 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100111 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700112 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600113 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100114 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
116 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800117 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700118 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 */
120
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500121static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700122 struct page *page, void *shadow)
123{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500124 XA_STATE(xas, &mapping->i_pages, page->index);
125 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800126
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500127 mapping_set_update(&xas, mapping);
128
129 /* hugetlb pages are represented by a single entry in the xarray */
130 if (!PageHuge(page)) {
131 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700132 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500133 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700134
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700135 VM_BUG_ON_PAGE(!PageLocked(page), page);
136 VM_BUG_ON_PAGE(PageTail(page), page);
137 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700138
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500139 xas_store(&xas, shadow);
140 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200141
Jan Kara23006382017-11-15 17:37:26 -0800142 page->mapping = NULL;
143 /* Leave page->index set: truncation lookup relies upon it */
144
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200145 if (shadow) {
146 mapping->nrexceptional += nr;
147 /*
148 * Make sure the nrexceptional update is committed before
149 * the nrpages update so that final truncate racing
150 * with reclaim does not see both counters 0 at the
151 * same time and miss a shadow entry.
152 */
153 smp_wmb();
154 }
155 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700156}
157
Jan Kara5ecc4d82017-11-15 17:37:29 -0800158static void unaccount_page_cache_page(struct address_space *mapping,
159 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800161 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600163 /*
164 * if we're uptodate, flush out into the cleancache, otherwise
165 * invalidate any existing cleancache entries. We can't leave
166 * stale data around in the cleancache once our page is gone
167 */
168 if (PageUptodate(page) && PageMappedToDisk(page))
169 cleancache_put_page(page);
170 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400171 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600172
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700173 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800174 VM_BUG_ON_PAGE(page_mapped(page), page);
175 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
176 int mapcount;
177
178 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
179 current->comm, page_to_pfn(page));
180 dump_page(page, "still mapped when deleted");
181 dump_stack();
182 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
183
184 mapcount = page_mapcount(page);
185 if (mapping_exiting(mapping) &&
186 page_count(page) >= mapcount + 2) {
187 /*
188 * All vmas have already been torn down, so it's
189 * a good bet that actually the page is unmapped,
190 * and we'd prefer not to leak it: if we're wrong,
191 * some other bad page check should catch it later.
192 */
193 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700194 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800195 }
196 }
197
Jan Kara76253fb2017-11-15 17:37:22 -0800198 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800199 if (PageHuge(page))
200 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800201
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700202 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800203
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700204 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800205 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700206 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800207 if (PageTransHuge(page))
Johannes Weinerb8eddff2020-12-14 19:06:20 -0800208 __dec_lruvec_page_state(page, NR_SHMEM_THPS);
Song Liu99cb0db2019-09-23 15:38:00 -0700209 } else if (PageTransHuge(page)) {
Johannes Weinerb8eddff2020-12-14 19:06:20 -0800210 __dec_lruvec_page_state(page, NR_FILE_THPS);
Song Liu09d91cd2019-09-23 15:38:03 -0700211 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800212 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800213
214 /*
215 * At this point page must be either written or cleaned by
216 * truncate. Dirty page here signals a bug and loss of
217 * unwritten data.
218 *
219 * This fixes dirty accounting after removing the page entirely
220 * but leaves PageDirty set: it has no effect for truncated
221 * page and anyway will be cleared before returning page into
222 * buddy allocator.
223 */
224 if (WARN_ON_ONCE(PageDirty(page)))
225 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
226}
227
228/*
229 * Delete a page from the page cache and free it. Caller has to make
230 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700231 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800232 */
233void __delete_from_page_cache(struct page *page, void *shadow)
234{
235 struct address_space *mapping = page->mapping;
236
237 trace_mm_filemap_delete_from_page_cache(page);
238
239 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500240 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241}
242
Jan Kara59c66c52017-11-15 17:37:18 -0800243static void page_cache_free_page(struct address_space *mapping,
244 struct page *page)
245{
246 void (*freepage)(struct page *);
247
248 freepage = mapping->a_ops->freepage;
249 if (freepage)
250 freepage(page);
251
252 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700253 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800254 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
255 } else {
256 put_page(page);
257 }
258}
259
Minchan Kim702cfbf2011-03-22 16:32:43 -0700260/**
261 * delete_from_page_cache - delete page from page cache
262 * @page: the page which the kernel is trying to remove from page cache
263 *
264 * This must be called only on pages that have been verified to be in the page
265 * cache and locked. It will never put the page into the free list, the caller
266 * has a reference on the page.
267 */
268void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700270 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400271 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Matt Mackallcd7619d2005-05-01 08:59:01 -0700273 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700274 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700275 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700276 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500277
Jan Kara59c66c52017-11-15 17:37:18 -0800278 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700279}
280EXPORT_SYMBOL(delete_from_page_cache);
281
Jan Karaaa65c292017-11-15 17:37:33 -0800282/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500283 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800284 * @mapping: the mapping to which pages belong
285 * @pvec: pagevec with pages to delete
286 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700287 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700288 * from the mapping. The function expects @pvec to be sorted by page index
289 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700290 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800291 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700292 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800293 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700294 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800295 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500296static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800297 struct pagevec *pvec)
298{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500299 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800300 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700301 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800302 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800303
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500304 mapping_set_update(&xas, mapping);
305 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700306 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800307 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700308
309 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400310 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800311 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700312 /*
313 * A page got inserted in our range? Skip it. We have our
314 * pages locked so they are protected from being removed.
315 * If we see a page whose index is higher than ours, it
316 * means our page has been removed, which shouldn't be
317 * possible because we're holding the PageLock.
318 */
319 if (page != pvec->pages[i]) {
320 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
321 page);
322 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700323 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700324
325 WARN_ON_ONCE(!PageLocked(page));
326
327 if (page->index == xas.xa_index)
328 page->mapping = NULL;
329 /* Leave page->index set: truncation lookup relies on it */
330
331 /*
332 * Move to the next page in the vector if this is a regular
333 * page or the index is of the last sub-page of this compound
334 * page.
335 */
336 if (page->index + compound_nr(page) - 1 == xas.xa_index)
337 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500338 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800339 total_pages++;
340 }
341 mapping->nrpages -= total_pages;
342}
343
344void delete_from_page_cache_batch(struct address_space *mapping,
345 struct pagevec *pvec)
346{
347 int i;
348 unsigned long flags;
349
350 if (!pagevec_count(pvec))
351 return;
352
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700353 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800354 for (i = 0; i < pagevec_count(pvec); i++) {
355 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
356
357 unaccount_page_cache_page(mapping, pvec->pages[i]);
358 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500359 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700360 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800361
362 for (i = 0; i < pagevec_count(pvec); i++)
363 page_cache_free_page(mapping, pvec->pages[i]);
364}
365
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200366int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700367{
368 int ret = 0;
369 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700370 if (test_bit(AS_ENOSPC, &mapping->flags) &&
371 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700372 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700373 if (test_bit(AS_EIO, &mapping->flags) &&
374 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700375 ret = -EIO;
376 return ret;
377}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200378EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700379
Jeff Layton76341ca2017-07-06 07:02:22 -0400380static int filemap_check_and_keep_errors(struct address_space *mapping)
381{
382 /* Check for outstanding write errors */
383 if (test_bit(AS_EIO, &mapping->flags))
384 return -EIO;
385 if (test_bit(AS_ENOSPC, &mapping->flags))
386 return -ENOSPC;
387 return 0;
388}
389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700391 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700392 * @mapping: address space structure to write
393 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800394 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700395 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700397 * Start writeback against all of a mapping's dirty pages that lie
398 * within the byte offsets <start, end> inclusive.
399 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700401 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 * these two operations is that if a dirty page/buffer is encountered, it must
403 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800404 *
405 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800407int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
408 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
410 int ret;
411 struct writeback_control wbc = {
412 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800413 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700414 .range_start = start,
415 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 };
417
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200418 if (!mapping_can_writeback(mapping) ||
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700419 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 return 0;
421
Tejun Heob16b1de2015-06-02 08:39:48 -0600422 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600424 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 return ret;
426}
427
428static inline int __filemap_fdatawrite(struct address_space *mapping,
429 int sync_mode)
430{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700431 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432}
433
434int filemap_fdatawrite(struct address_space *mapping)
435{
436 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
437}
438EXPORT_SYMBOL(filemap_fdatawrite);
439
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400440int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800441 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
443 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
444}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400445EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Randy Dunlap485bb992006-06-23 02:03:49 -0700447/**
448 * filemap_flush - mostly a non-blocking flush
449 * @mapping: target address_space
450 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 * This is a mostly non-blocking flush. Not suitable for data-integrity
452 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800453 *
454 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 */
456int filemap_flush(struct address_space *mapping)
457{
458 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
459}
460EXPORT_SYMBOL(filemap_flush);
461
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500462/**
463 * filemap_range_has_page - check if a page exists in range.
464 * @mapping: address space within which to check
465 * @start_byte: offset in bytes where the range starts
466 * @end_byte: offset in bytes where the range ends (inclusive)
467 *
468 * Find at least one page in the range supplied, usually used to check if
469 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800470 *
471 * Return: %true if at least one page exists in the specified range,
472 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500473 */
474bool filemap_range_has_page(struct address_space *mapping,
475 loff_t start_byte, loff_t end_byte)
476{
Jan Karaf7b68042017-09-06 16:21:40 -0700477 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500478 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
479 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500480
481 if (end_byte < start_byte)
482 return false;
483
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500484 rcu_read_lock();
485 for (;;) {
486 page = xas_find(&xas, max);
487 if (xas_retry(&xas, page))
488 continue;
489 /* Shadow entries don't count */
490 if (xa_is_value(page))
491 continue;
492 /*
493 * We don't need to try to pin this page; we're about to
494 * release the RCU lock anyway. It is enough to know that
495 * there was a page here recently.
496 */
497 break;
498 }
499 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500500
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500501 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500502}
503EXPORT_SYMBOL(filemap_range_has_page);
504
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400505static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800506 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300508 pgoff_t index = start_byte >> PAGE_SHIFT;
509 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 struct pagevec pvec;
511 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200513 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400514 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
Mel Gorman86679822017-11-15 17:37:52 -0800516 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800517 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 unsigned i;
519
Jan Kara312e9d22017-11-15 17:35:05 -0800520 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800521 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800522 if (!nr_pages)
523 break;
524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 for (i = 0; i < nr_pages; i++) {
526 struct page *page = pvec.pages[i];
527
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400529 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 }
531 pagevec_release(&pvec);
532 cond_resched();
533 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800534}
535
536/**
537 * filemap_fdatawait_range - wait for writeback to complete
538 * @mapping: address space structure to wait for
539 * @start_byte: offset in bytes where the range starts
540 * @end_byte: offset in bytes where the range ends (inclusive)
541 *
542 * Walk the list of under-writeback pages of the given address space
543 * in the given range and wait for all of them. Check error status of
544 * the address space and return it.
545 *
546 * Since the error status of the address space is cleared by this function,
547 * callers are responsible for checking the return value and handling and/or
548 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800549 *
550 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800551 */
552int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
553 loff_t end_byte)
554{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400555 __filemap_fdatawait_range(mapping, start_byte, end_byte);
556 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200558EXPORT_SYMBOL(filemap_fdatawait_range);
559
560/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400561 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
562 * @mapping: address space structure to wait for
563 * @start_byte: offset in bytes where the range starts
564 * @end_byte: offset in bytes where the range ends (inclusive)
565 *
566 * Walk the list of under-writeback pages of the given address space in the
567 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
568 * this function does not clear error status of the address space.
569 *
570 * Use this function if callers don't handle errors themselves. Expected
571 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
572 * fsfreeze(8)
573 */
574int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
575 loff_t start_byte, loff_t end_byte)
576{
577 __filemap_fdatawait_range(mapping, start_byte, end_byte);
578 return filemap_check_and_keep_errors(mapping);
579}
580EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
581
582/**
Jeff Laytona823e452017-07-28 07:24:43 -0400583 * file_fdatawait_range - wait for writeback to complete
584 * @file: file pointing to address space structure to wait for
585 * @start_byte: offset in bytes where the range starts
586 * @end_byte: offset in bytes where the range ends (inclusive)
587 *
588 * Walk the list of under-writeback pages of the address space that file
589 * refers to, in the given range and wait for all of them. Check error
590 * status of the address space vs. the file->f_wb_err cursor and return it.
591 *
592 * Since the error status of the file is advanced by this function,
593 * callers are responsible for checking the return value and handling and/or
594 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800595 *
596 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400597 */
598int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
599{
600 struct address_space *mapping = file->f_mapping;
601
602 __filemap_fdatawait_range(mapping, start_byte, end_byte);
603 return file_check_and_advance_wb_err(file);
604}
605EXPORT_SYMBOL(file_fdatawait_range);
606
607/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800608 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
609 * @mapping: address space structure to wait for
610 *
611 * Walk the list of under-writeback pages of the given address space
612 * and wait for all of them. Unlike filemap_fdatawait(), this function
613 * does not clear error status of the address space.
614 *
615 * Use this function if callers don't handle errors themselves. Expected
616 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
617 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800618 *
619 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800620 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400621int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800622{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400623 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400624 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800625}
Jeff Layton76341ca2017-07-06 07:02:22 -0400626EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800627
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700628/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400629static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700631 if (dax_mapping(mapping))
632 return mapping->nrexceptional;
633
634 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Randy Dunlap485bb992006-06-23 02:03:49 -0700637/**
638 * filemap_write_and_wait_range - write out & wait on a file range
639 * @mapping: the address_space for the pages
640 * @lstart: offset in bytes where the range starts
641 * @lend: offset in bytes where the range ends (inclusive)
642 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800643 * Write out and wait upon file offsets lstart->lend, inclusive.
644 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300645 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800646 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800647 *
648 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800649 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650int filemap_write_and_wait_range(struct address_space *mapping,
651 loff_t lstart, loff_t lend)
652{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800653 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Jeff Layton9326c9b2017-07-26 10:21:11 -0400655 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800656 err = __filemap_fdatawrite_range(mapping, lstart, lend,
657 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800658 /*
659 * Even if the above returned error, the pages may be
660 * written partially (e.g. -ENOSPC), so we wait for it.
661 * But the -EIO is special case, it may indicate the worst
662 * thing (e.g. bug) happened, so we avoid waiting for it.
663 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800664 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200665 int err2 = filemap_fdatawait_range(mapping,
666 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800667 if (!err)
668 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400669 } else {
670 /* Clear any previously stored errors */
671 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800672 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700673 } else {
674 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800676 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
Chris Masonf6995582009-04-15 13:22:37 -0400678EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
Jeff Layton5660e132017-07-06 07:02:25 -0400680void __filemap_set_wb_err(struct address_space *mapping, int err)
681{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400682 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400683
684 trace_filemap_set_wb_err(mapping, eseq);
685}
686EXPORT_SYMBOL(__filemap_set_wb_err);
687
688/**
689 * file_check_and_advance_wb_err - report wb error (if any) that was previously
690 * and advance wb_err to current one
691 * @file: struct file on which the error is being reported
692 *
693 * When userland calls fsync (or something like nfsd does the equivalent), we
694 * want to report any writeback errors that occurred since the last fsync (or
695 * since the file was opened if there haven't been any).
696 *
697 * Grab the wb_err from the mapping. If it matches what we have in the file,
698 * then just quickly return 0. The file is all caught up.
699 *
700 * If it doesn't match, then take the mapping value, set the "seen" flag in
701 * it and try to swap it into place. If it works, or another task beat us
702 * to it with the new value, then update the f_wb_err and return the error
703 * portion. The error at this point must be reported via proper channels
704 * (a'la fsync, or NFS COMMIT operation, etc.).
705 *
706 * While we handle mapping->wb_err with atomic operations, the f_wb_err
707 * value is protected by the f_lock since we must ensure that it reflects
708 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800709 *
710 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400711 */
712int file_check_and_advance_wb_err(struct file *file)
713{
714 int err = 0;
715 errseq_t old = READ_ONCE(file->f_wb_err);
716 struct address_space *mapping = file->f_mapping;
717
718 /* Locklessly handle the common case where nothing has changed */
719 if (errseq_check(&mapping->wb_err, old)) {
720 /* Something changed, must use slow path */
721 spin_lock(&file->f_lock);
722 old = file->f_wb_err;
723 err = errseq_check_and_advance(&mapping->wb_err,
724 &file->f_wb_err);
725 trace_file_check_and_advance_wb_err(file, old);
726 spin_unlock(&file->f_lock);
727 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700728
729 /*
730 * We're mostly using this function as a drop in replacement for
731 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
732 * that the legacy code would have had on these flags.
733 */
734 clear_bit(AS_EIO, &mapping->flags);
735 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400736 return err;
737}
738EXPORT_SYMBOL(file_check_and_advance_wb_err);
739
740/**
741 * file_write_and_wait_range - write out & wait on a file range
742 * @file: file pointing to address_space with pages
743 * @lstart: offset in bytes where the range starts
744 * @lend: offset in bytes where the range ends (inclusive)
745 *
746 * Write out and wait upon file offsets lstart->lend, inclusive.
747 *
748 * Note that @lend is inclusive (describes the last byte to be written) so
749 * that this function can be used to write to the very end-of-file (end = -1).
750 *
751 * After writing out and waiting on the data, we check and advance the
752 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800753 *
754 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400755 */
756int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
757{
758 int err = 0, err2;
759 struct address_space *mapping = file->f_mapping;
760
Jeff Layton9326c9b2017-07-26 10:21:11 -0400761 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400762 err = __filemap_fdatawrite_range(mapping, lstart, lend,
763 WB_SYNC_ALL);
764 /* See comment of filemap_write_and_wait() */
765 if (err != -EIO)
766 __filemap_fdatawait_range(mapping, lstart, lend);
767 }
768 err2 = file_check_and_advance_wb_err(file);
769 if (!err)
770 err = err2;
771 return err;
772}
773EXPORT_SYMBOL(file_write_and_wait_range);
774
Randy Dunlap485bb992006-06-23 02:03:49 -0700775/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700776 * replace_page_cache_page - replace a pagecache page with a new one
777 * @old: page to be replaced
778 * @new: page to replace with
779 * @gfp_mask: allocation mode
780 *
781 * This function replaces a page in the pagecache with a new one. On
782 * success it acquires the pagecache reference for the new page and
783 * drops it for the old page. Both the old and new pages must be
784 * locked. This function does not add the new page to the LRU, the
785 * caller must do that.
786 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500787 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800788 *
789 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700790 */
791int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
792{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500793 struct address_space *mapping = old->mapping;
794 void (*freepage)(struct page *) = mapping->a_ops->freepage;
795 pgoff_t offset = old->index;
796 XA_STATE(xas, &mapping->i_pages, offset);
797 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700798
Sasha Levin309381fea2014-01-23 15:52:54 -0800799 VM_BUG_ON_PAGE(!PageLocked(old), old);
800 VM_BUG_ON_PAGE(!PageLocked(new), new);
801 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700802
Matthew Wilcox74d60952017-11-17 10:01:45 -0500803 get_page(new);
804 new->mapping = mapping;
805 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700806
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700807 mem_cgroup_migrate(old, new);
808
Matthew Wilcox74d60952017-11-17 10:01:45 -0500809 xas_lock_irqsave(&xas, flags);
810 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700811
Matthew Wilcox74d60952017-11-17 10:01:45 -0500812 old->mapping = NULL;
813 /* hugetlb pages do not participate in page cache accounting. */
814 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700815 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500816 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700817 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500818 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700819 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500820 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700821 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500822 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500823 if (freepage)
824 freepage(old);
825 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700826
Matthew Wilcox74d60952017-11-17 10:01:45 -0500827 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700828}
829EXPORT_SYMBOL_GPL(replace_page_cache_page);
830
Andrew Morton16c0cc02020-12-11 13:36:27 -0800831noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700832 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700833 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700834 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500836 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700837 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700838 int error;
839
Sasha Levin309381fea2014-01-23 15:52:54 -0800840 VM_BUG_ON_PAGE(!PageLocked(page), page);
841 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500842 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700843
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300844 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700845 page->mapping = mapping;
846 page->index = offset;
847
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700848 if (!huge) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700849 error = mem_cgroup_charge(page, current->mm, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700850 if (error)
851 goto error;
852 }
853
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700854 gfp &= GFP_RECLAIM_MASK;
855
Matthew Wilcox74d60952017-11-17 10:01:45 -0500856 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700857 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
858 void *entry, *old = NULL;
859
860 if (order > thp_order(page))
861 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
862 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500863 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700864 xas_for_each_conflict(&xas, entry) {
865 old = entry;
866 if (!xa_is_value(entry)) {
867 xas_set_err(&xas, -EEXIST);
868 goto unlock;
869 }
870 }
871
872 if (old) {
873 if (shadowp)
874 *shadowp = old;
875 /* entry may have been split before we acquired lock */
876 order = xa_get_order(xas.xa, xas.xa_index);
877 if (order > thp_order(page)) {
878 xas_split(&xas, old, order);
879 xas_reset(&xas);
880 }
881 }
882
Matthew Wilcox74d60952017-11-17 10:01:45 -0500883 xas_store(&xas, page);
884 if (xas_error(&xas))
885 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700886
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700887 if (old)
Matthew Wilcox74d60952017-11-17 10:01:45 -0500888 mapping->nrexceptional--;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500889 mapping->nrpages++;
890
891 /* hugetlb pages do not participate in page cache accounting */
892 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700893 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500894unlock:
895 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700896 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500897
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700898 if (xas_error(&xas)) {
899 error = xas_error(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500900 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700901 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500902
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700903 trace_mm_filemap_add_to_page_cache(page);
904 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500905error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700906 page->mapping = NULL;
907 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300908 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700909 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700911ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700912
913/**
914 * add_to_page_cache_locked - add a locked page to the pagecache
915 * @page: page to add
916 * @mapping: the page's address_space
917 * @offset: page index
918 * @gfp_mask: page allocation mode
919 *
920 * This function is used to add a page to the pagecache. It must be locked.
921 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800922 *
923 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700924 */
925int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
926 pgoff_t offset, gfp_t gfp_mask)
927{
928 return __add_to_page_cache_locked(page, mapping, offset,
929 gfp_mask, NULL);
930}
Nick Piggine2867812008-07-25 19:45:30 -0700931EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932
933int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400934 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935{
Johannes Weinera5289102014-04-03 14:47:51 -0700936 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700937 int ret;
938
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800939 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700940 ret = __add_to_page_cache_locked(page, mapping, offset,
941 gfp_mask, &shadow);
942 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800943 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700944 else {
945 /*
946 * The page might have been evicted from cache only
947 * recently, in which case it should be activated like
948 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700949 * The exception is pages getting rewritten; evicting other
950 * data from the working set, only to cache data that will
951 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700952 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700953 WARN_ON_ONCE(PageActive(page));
954 if (!(gfp_mask & __GFP_WRITE) && shadow)
955 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700956 lru_cache_add(page);
957 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 return ret;
959}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300960EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961
Paul Jackson44110fe2006-03-24 03:16:04 -0800962#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700963struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800964{
Miao Xiec0ff7452010-05-24 14:32:08 -0700965 int n;
966 struct page *page;
967
Paul Jackson44110fe2006-03-24 03:16:04 -0800968 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700969 unsigned int cpuset_mems_cookie;
970 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700971 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700972 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700973 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700974 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700975
Miao Xiec0ff7452010-05-24 14:32:08 -0700976 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800977 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700978 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800979}
Nick Piggin2ae88142006-10-28 10:38:23 -0700980EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800981#endif
982
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983/*
984 * In order to wait for pages to become available there must be
985 * waitqueues associated with pages. By using a hash table of
986 * waitqueues where the bucket discipline is to maintain all
987 * waiters on the same queue and wake all when any of the pages
988 * become available, and for the woken contexts to check to be
989 * sure the appropriate page became available, this saves space
990 * at a cost of "thundering herd" phenomena during rare hash
991 * collisions.
992 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000993#define PAGE_WAIT_TABLE_BITS 8
994#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
995static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
996
997static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998{
Nicholas Piggin62906022016-12-25 13:00:30 +1000999 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000}
Nicholas Piggin62906022016-12-25 13:00:30 +10001001
1002void __init pagecache_init(void)
1003{
1004 int i;
1005
1006 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1007 init_waitqueue_head(&page_wait_table[i]);
1008
1009 page_writeback_init();
1010}
1011
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001012/*
1013 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001014 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001015 * one.
1016 *
1017 * We have:
1018 *
1019 * (a) no special bits set:
1020 *
1021 * We're just waiting for the bit to be released, and when a waker
1022 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1023 * and remove it from the wait queue.
1024 *
1025 * Simple and straightforward.
1026 *
1027 * (b) WQ_FLAG_EXCLUSIVE:
1028 *
1029 * The waiter is waiting to get the lock, and only one waiter should
1030 * be woken up to avoid any thundering herd behavior. We'll set the
1031 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1032 *
1033 * This is the traditional exclusive wait.
1034 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001035 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001036 *
1037 * The waiter is waiting to get the bit, and additionally wants the
1038 * lock to be transferred to it for fair lock behavior. If the lock
1039 * cannot be taken, we stop walking the wait queue without waking
1040 * the waiter.
1041 *
1042 * This is the "fair lock handoff" case, and in addition to setting
1043 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1044 * that it now has the lock.
1045 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001046static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001047{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001048 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001049 struct wait_page_key *key = arg;
1050 struct wait_page_queue *wait_page
1051 = container_of(wait, struct wait_page_queue, wait);
1052
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001053 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001054 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001055
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001056 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001057 * If it's a lock handoff wait, we get the bit for it, and
1058 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001059 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001060 flags = wait->flags;
1061 if (flags & WQ_FLAG_EXCLUSIVE) {
1062 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001063 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001064 if (flags & WQ_FLAG_CUSTOM) {
1065 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1066 return -1;
1067 flags |= WQ_FLAG_DONE;
1068 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001069 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001070
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001071 /*
1072 * We are holding the wait-queue lock, but the waiter that
1073 * is waiting for this will be checking the flags without
1074 * any locking.
1075 *
1076 * So update the flags atomically, and wake up the waiter
1077 * afterwards to avoid any races. This store-release pairs
1078 * with the load-acquire in wait_on_page_bit_common().
1079 */
1080 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001081 wake_up_state(wait->private, mode);
1082
1083 /*
1084 * Ok, we have successfully done what we're waiting for,
1085 * and we can unconditionally remove the wait entry.
1086 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001087 * Note that this pairs with the "finish_wait()" in the
1088 * waiter, and has to be the absolute last thing we do.
1089 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001090 * might be de-allocated and the process might even have
1091 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001092 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001093 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001094 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001095}
1096
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001097static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001098{
1099 wait_queue_head_t *q = page_waitqueue(page);
1100 struct wait_page_key key;
1101 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001102 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001103
1104 key.page = page;
1105 key.bit_nr = bit_nr;
1106 key.page_match = 0;
1107
Tim Chen11a19c72017-08-25 09:13:55 -07001108 bookmark.flags = 0;
1109 bookmark.private = NULL;
1110 bookmark.func = NULL;
1111 INIT_LIST_HEAD(&bookmark.entry);
1112
Nicholas Piggin62906022016-12-25 13:00:30 +10001113 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001114 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1115
1116 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1117 /*
1118 * Take a breather from holding the lock,
1119 * allow pages that finish wake up asynchronously
1120 * to acquire the lock and remove themselves
1121 * from wait queue
1122 */
1123 spin_unlock_irqrestore(&q->lock, flags);
1124 cpu_relax();
1125 spin_lock_irqsave(&q->lock, flags);
1126 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1127 }
1128
Nicholas Piggin62906022016-12-25 13:00:30 +10001129 /*
1130 * It is possible for other pages to have collided on the waitqueue
1131 * hash, so in that case check for a page match. That prevents a long-
1132 * term waiter
1133 *
1134 * It is still possible to miss a case here, when we woke page waiters
1135 * and removed them from the waitqueue, but there are still other
1136 * page waiters.
1137 */
1138 if (!waitqueue_active(q) || !key.page_match) {
1139 ClearPageWaiters(page);
1140 /*
1141 * It's possible to miss clearing Waiters here, when we woke
1142 * our page waiters, but the hashed waitqueue has waiters for
1143 * other pages on it.
1144 *
1145 * That's okay, it's a rare case. The next waker will clear it.
1146 */
1147 }
1148 spin_unlock_irqrestore(&q->lock, flags);
1149}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001150
1151static void wake_up_page(struct page *page, int bit)
1152{
1153 if (!PageWaiters(page))
1154 return;
1155 wake_up_page_bit(page, bit);
1156}
Nicholas Piggin62906022016-12-25 13:00:30 +10001157
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001158/*
1159 * A choice of three behaviors for wait_on_page_bit_common():
1160 */
1161enum behavior {
1162 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1163 * __lock_page() waiting on then setting PG_locked.
1164 */
1165 SHARED, /* Hold ref to page and check the bit when woken, like
1166 * wait_on_page_writeback() waiting on PG_writeback.
1167 */
1168 DROP, /* Drop ref to page before wait, no check when woken,
1169 * like put_and_wait_on_page_locked() on PG_locked.
1170 */
1171};
1172
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001173/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001174 * Attempt to check (or get) the page bit, and mark us done
1175 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001176 */
1177static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1178 struct wait_queue_entry *wait)
1179{
1180 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1181 if (test_and_set_bit(bit_nr, &page->flags))
1182 return false;
1183 } else if (test_bit(bit_nr, &page->flags))
1184 return false;
1185
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001186 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001187 return true;
1188}
1189
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001190/* How many times do we accept lock stealing from under a waiter? */
1191int sysctl_page_lock_unfairness = 5;
1192
Nicholas Piggin62906022016-12-25 13:00:30 +10001193static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001194 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001195{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001196 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001197 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001198 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001199 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001200 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001201 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001202
Johannes Weinereb414682018-10-26 15:06:27 -07001203 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001204 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001205 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001206 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001207 delayacct = true;
1208 }
Johannes Weinereb414682018-10-26 15:06:27 -07001209 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001210 thrashing = true;
1211 }
1212
Nicholas Piggin62906022016-12-25 13:00:30 +10001213 init_wait(wait);
1214 wait->func = wake_page_function;
1215 wait_page.page = page;
1216 wait_page.bit_nr = bit_nr;
1217
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001218repeat:
1219 wait->flags = 0;
1220 if (behavior == EXCLUSIVE) {
1221 wait->flags = WQ_FLAG_EXCLUSIVE;
1222 if (--unfairness < 0)
1223 wait->flags |= WQ_FLAG_CUSTOM;
1224 }
1225
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001226 /*
1227 * Do one last check whether we can get the
1228 * page bit synchronously.
1229 *
1230 * Do the SetPageWaiters() marking before that
1231 * to let any waker we _just_ missed know they
1232 * need to wake us up (otherwise they'll never
1233 * even go to the slow case that looks at the
1234 * page queue), and add ourselves to the wait
1235 * queue if we need to sleep.
1236 *
1237 * This part needs to be done under the queue
1238 * lock to avoid races.
1239 */
1240 spin_lock_irq(&q->lock);
1241 SetPageWaiters(page);
1242 if (!trylock_page_bit_common(page, bit_nr, wait))
1243 __add_wait_queue_entry_tail(q, wait);
1244 spin_unlock_irq(&q->lock);
1245
1246 /*
1247 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001248 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1249 * see whether the page bit testing has already
1250 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001251 *
1252 * We can drop our reference to the page.
1253 */
1254 if (behavior == DROP)
1255 put_page(page);
1256
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001257 /*
1258 * Note that until the "finish_wait()", or until
1259 * we see the WQ_FLAG_WOKEN flag, we need to
1260 * be very careful with the 'wait->flags', because
1261 * we may race with a waker that sets them.
1262 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001263 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001264 unsigned int flags;
1265
Nicholas Piggin62906022016-12-25 13:00:30 +10001266 set_current_state(state);
1267
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001268 /* Loop until we've been woken or interrupted */
1269 flags = smp_load_acquire(&wait->flags);
1270 if (!(flags & WQ_FLAG_WOKEN)) {
1271 if (signal_pending_state(state, current))
1272 break;
1273
1274 io_schedule();
1275 continue;
1276 }
1277
1278 /* If we were non-exclusive, we're done */
1279 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001280 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001281
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001282 /* If the waker got the lock for us, we're done */
1283 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001284 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001285
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001286 /*
1287 * Otherwise, if we're getting the lock, we need to
1288 * try to get it ourselves.
1289 *
1290 * And if that fails, we'll have to retry this all.
1291 */
1292 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1293 goto repeat;
1294
1295 wait->flags |= WQ_FLAG_DONE;
1296 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001297 }
1298
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001299 /*
1300 * If a signal happened, this 'finish_wait()' may remove the last
1301 * waiter from the wait-queues, but the PageWaiters bit will remain
1302 * set. That's ok. The next wakeup will take care of it, and trying
1303 * to do it here would be difficult and prone to races.
1304 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001305 finish_wait(q, wait);
1306
Johannes Weinereb414682018-10-26 15:06:27 -07001307 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001308 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001309 delayacct_thrashing_end();
1310 psi_memstall_leave(&pflags);
1311 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001312
Nicholas Piggin62906022016-12-25 13:00:30 +10001313 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001314 * NOTE! The wait->flags weren't stable until we've done the
1315 * 'finish_wait()', and we could have exited the loop above due
1316 * to a signal, and had a wakeup event happen after the signal
1317 * test but before the 'finish_wait()'.
1318 *
1319 * So only after the finish_wait() can we reliably determine
1320 * if we got woken up or not, so we can now figure out the final
1321 * return value based on that state without races.
1322 *
1323 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1324 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001325 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001326 if (behavior == EXCLUSIVE)
1327 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001328
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001329 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001330}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331
Harvey Harrison920c7a52008-02-04 22:29:26 -08001332void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333{
Nicholas Piggin62906022016-12-25 13:00:30 +10001334 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001335 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336}
1337EXPORT_SYMBOL(wait_on_page_bit);
1338
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001339int wait_on_page_bit_killable(struct page *page, int bit_nr)
1340{
Nicholas Piggin62906022016-12-25 13:00:30 +10001341 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001342 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001343}
David Howells4343d002017-11-02 15:27:52 +00001344EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001345
Jens Axboedd3e6d52020-05-22 09:12:09 -06001346static int __wait_on_page_locked_async(struct page *page,
1347 struct wait_page_queue *wait, bool set)
1348{
1349 struct wait_queue_head *q = page_waitqueue(page);
1350 int ret = 0;
1351
1352 wait->page = page;
1353 wait->bit_nr = PG_locked;
1354
1355 spin_lock_irq(&q->lock);
1356 __add_wait_queue_entry_tail(q, &wait->wait);
1357 SetPageWaiters(page);
1358 if (set)
1359 ret = !trylock_page(page);
1360 else
1361 ret = PageLocked(page);
1362 /*
Haitao Shi8958b242020-12-15 20:47:26 -08001363 * If we were successful now, we know we're still on the
Jens Axboedd3e6d52020-05-22 09:12:09 -06001364 * waitqueue as we're still under the lock. This means it's
1365 * safe to remove and return success, we know the callback
1366 * isn't going to trigger.
1367 */
1368 if (!ret)
1369 __remove_wait_queue(q, &wait->wait);
1370 else
1371 ret = -EIOCBQUEUED;
1372 spin_unlock_irq(&q->lock);
1373 return ret;
1374}
1375
Jens Axboe1a0a7852020-05-22 09:18:38 -06001376static int wait_on_page_locked_async(struct page *page,
1377 struct wait_page_queue *wait)
1378{
1379 if (!PageLocked(page))
1380 return 0;
1381 return __wait_on_page_locked_async(compound_head(page), wait, false);
1382}
1383
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001385 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1386 * @page: The page to wait for.
1387 *
1388 * The caller should hold a reference on @page. They expect the page to
1389 * become unlocked relatively soon, but do not wish to hold up migration
1390 * (for example) by holding the reference while waiting for the page to
1391 * come unlocked. After this function returns, the caller should not
1392 * dereference @page.
1393 */
1394void put_and_wait_on_page_locked(struct page *page)
1395{
1396 wait_queue_head_t *q;
1397
1398 page = compound_head(page);
1399 q = page_waitqueue(page);
1400 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1401}
1402
1403/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001404 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001405 * @page: Page defining the wait queue of interest
1406 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001407 *
1408 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1409 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001410void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001411{
1412 wait_queue_head_t *q = page_waitqueue(page);
1413 unsigned long flags;
1414
1415 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001416 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001417 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001418 spin_unlock_irqrestore(&q->lock, flags);
1419}
1420EXPORT_SYMBOL_GPL(add_page_wait_queue);
1421
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001422#ifndef clear_bit_unlock_is_negative_byte
1423
1424/*
1425 * PG_waiters is the high bit in the same byte as PG_lock.
1426 *
1427 * On x86 (and on many other architectures), we can clear PG_lock and
1428 * test the sign bit at the same time. But if the architecture does
1429 * not support that special operation, we just do this all by hand
1430 * instead.
1431 *
1432 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001433 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001434 * in the same byte as PG_locked.
1435 */
1436static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1437{
1438 clear_bit_unlock(nr, mem);
1439 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001440 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001441}
1442
1443#endif
1444
David Howells385e1ca5f2009-04-03 16:42:39 +01001445/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001446 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001447 * @page: the page
1448 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001449 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001451 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1453 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001454 * Note that this depends on PG_waiters being the sign bit in the byte
1455 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1456 * clear the PG_locked bit and test PG_waiters at the same time fairly
1457 * portably (architectures that do LL/SC can test any bit, while x86 can
1458 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001460void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001462 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001463 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001464 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001465 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1466 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001467}
1468EXPORT_SYMBOL(unlock_page);
1469
Randy Dunlap485bb992006-06-23 02:03:49 -07001470/**
1471 * end_page_writeback - end writeback against a page
1472 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001473 */
1474void end_page_writeback(struct page *page)
1475{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001476 /*
1477 * TestClearPageReclaim could be used here but it is an atomic
1478 * operation and overkill in this particular case. Failing to
1479 * shuffle a page marked for immediate reclaim is too mild to
1480 * justify taking an atomic operation penalty at the end of
1481 * ever page writeback.
1482 */
1483 if (PageReclaim(page)) {
1484 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001485 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001486 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001487
Hugh Dickins073861e2020-11-24 08:46:43 -08001488 /*
1489 * Writeback does not hold a page reference of its own, relying
1490 * on truncation to wait for the clearing of PG_writeback.
1491 * But here we must make sure that the page is not freed and
1492 * reused before the wake_up_page().
1493 */
1494 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001495 if (!test_clear_page_writeback(page))
1496 BUG();
1497
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001498 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001500 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
1502EXPORT_SYMBOL(end_page_writeback);
1503
Matthew Wilcox57d99842014-06-04 16:07:45 -07001504/*
1505 * After completing I/O on a page, call this routine to update the page
1506 * flags appropriately
1507 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001508void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001509{
Jens Axboec11f0c02016-08-05 08:11:04 -06001510 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001511 if (!err) {
1512 SetPageUptodate(page);
1513 } else {
1514 ClearPageUptodate(page);
1515 SetPageError(page);
1516 }
1517 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001518 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001519 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001520 struct address_space *mapping;
1521
Matthew Wilcox57d99842014-06-04 16:07:45 -07001522 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001523 mapping = page_mapping(page);
1524 if (mapping)
1525 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001526 }
1527 end_page_writeback(page);
1528 }
1529}
1530EXPORT_SYMBOL_GPL(page_endio);
1531
Randy Dunlap485bb992006-06-23 02:03:49 -07001532/**
1533 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001534 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001536void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537{
Nicholas Piggin62906022016-12-25 13:00:30 +10001538 struct page *page = compound_head(__page);
1539 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001540 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1541 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542}
1543EXPORT_SYMBOL(__lock_page);
1544
Nicholas Piggin62906022016-12-25 13:00:30 +10001545int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001546{
Nicholas Piggin62906022016-12-25 13:00:30 +10001547 struct page *page = compound_head(__page);
1548 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001549 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1550 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001551}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001552EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001553
Jens Axboedd3e6d52020-05-22 09:12:09 -06001554int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1555{
1556 return __wait_on_page_locked_async(page, wait, true);
1557}
1558
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001559/*
1560 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001561 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001562 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001563 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001564 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001565 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001566 *
1567 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001568 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001569 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001570int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1571 unsigned int flags)
1572{
Peter Xu4064b982020-04-01 21:08:45 -07001573 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001574 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001575 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001576 * even though return 0.
1577 */
1578 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1579 return 0;
1580
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001581 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001582 if (flags & FAULT_FLAG_KILLABLE)
1583 wait_on_page_locked_killable(page);
1584 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001585 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001586 return 0;
1587 }
Hailong Liu800bca72020-12-14 19:05:02 -08001588 if (flags & FAULT_FLAG_KILLABLE) {
1589 int ret;
1590
1591 ret = __lock_page_killable(page);
1592 if (ret) {
1593 mmap_read_unlock(mm);
1594 return 0;
1595 }
1596 } else {
1597 __lock_page(page);
1598 }
1599 return 1;
1600
Michel Lespinassed065bd82010-10-26 14:21:57 -07001601}
1602
Randy Dunlap485bb992006-06-23 02:03:49 -07001603/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001604 * page_cache_next_miss() - Find the next gap in the page cache.
1605 * @mapping: Mapping.
1606 * @index: Index.
1607 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001608 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001609 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1610 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001611 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001612 * This function may be called under the rcu_read_lock. However, this will
1613 * not atomically search a snapshot of the cache at a single point in time.
1614 * For example, if a gap is created at index 5, then subsequently a gap is
1615 * created at index 10, page_cache_next_miss covering both indices may
1616 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001617 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001618 * Return: The index of the gap if found, otherwise an index outside the
1619 * range specified (in which case 'return - index >= max_scan' will be true).
1620 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001621 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001622pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001623 pgoff_t index, unsigned long max_scan)
1624{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001625 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001626
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001627 while (max_scan--) {
1628 void *entry = xas_next(&xas);
1629 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001630 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001631 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001632 break;
1633 }
1634
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001635 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001636}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001637EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001638
1639/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001640 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001641 * @mapping: Mapping.
1642 * @index: Index.
1643 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001644 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001645 * Search the range [max(index - max_scan + 1, 0), index] for the
1646 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001647 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001648 * This function may be called under the rcu_read_lock. However, this will
1649 * not atomically search a snapshot of the cache at a single point in time.
1650 * For example, if a gap is created at index 10, then subsequently a gap is
1651 * created at index 5, page_cache_prev_miss() covering both indices may
1652 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001653 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001654 * Return: The index of the gap if found, otherwise an index outside the
1655 * range specified (in which case 'index - return >= max_scan' will be true).
1656 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001657 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001658pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001659 pgoff_t index, unsigned long max_scan)
1660{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001661 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001662
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001663 while (max_scan--) {
1664 void *entry = xas_prev(&xas);
1665 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001666 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001667 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001668 break;
1669 }
1670
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001671 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001672}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001673EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001674
1675/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001676 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001677 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001678 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001679 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001680 * Looks up the page cache slot at @mapping & @offset. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001681 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001682 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001683 * If the slot holds a shadow entry of a previously evicted page, or a
1684 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001685 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001686 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687 */
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001688struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001689{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001690 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001691 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692
Nick Piggina60637c2008-07-25 19:45:31 -07001693 rcu_read_lock();
1694repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001695 xas_reset(&xas);
1696 page = xas_load(&xas);
1697 if (xas_retry(&xas, page))
1698 goto repeat;
1699 /*
1700 * A shadow entry of a recently evicted page, or a swap entry from
1701 * shmem/tmpfs. Return it without attempting to raise page count.
1702 */
1703 if (!page || xa_is_value(page))
1704 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001705
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001706 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001707 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001708
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001709 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001710 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001711 * This is part of the lockless pagecache protocol. See
1712 * include/linux/pagemap.h for details.
1713 */
1714 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001715 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001716 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001717 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001718out:
Nick Piggina60637c2008-07-25 19:45:31 -07001719 rcu_read_unlock();
1720
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 return page;
1722}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723
Randy Dunlap485bb992006-06-23 02:03:49 -07001724/**
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001725 * find_lock_entry - Locate and lock a page cache entry.
1726 * @mapping: The address_space to search.
1727 * @index: The page cache index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001728 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001729 * Looks up the page at @mapping & @index. If there is a page in the
1730 * cache, the head page is returned locked and with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001731 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001732 * If the slot holds a shadow entry of a previously evicted page, or a
1733 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001734 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001735 * Context: May sleep.
1736 * Return: The head page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001737 */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001738struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739{
1740 struct page *page;
1741
Linus Torvalds1da177e2005-04-16 15:20:36 -07001742repeat:
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001743 page = find_get_entry(mapping, index);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001744 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001745 lock_page(page);
1746 /* Has the page been truncated? */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001747 if (unlikely(page->mapping != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001748 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001749 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001750 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001751 }
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001752 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 return page;
1755}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001756
1757/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001758 * pagecache_get_page - Find and get a reference to a page.
1759 * @mapping: The address_space to search.
1760 * @index: The page index.
1761 * @fgp_flags: %FGP flags modify how the page is returned.
1762 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001763 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001764 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001765 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001766 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001767 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001768 * * %FGP_ACCESSED - The page will be marked accessed.
1769 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001770 * * %FGP_HEAD - If the page is present and a THP, return the head page
1771 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001772 * * %FGP_CREAT - If no page is present then a new page is allocated using
1773 * @gfp_mask and added to the page cache and the VM's LRU list.
1774 * The page is returned locked and with an increased refcount.
1775 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1776 * page is already in cache. If the page was allocated, unlock it before
1777 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001778 * * %FGP_WRITE - The page will be written
1779 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1780 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001781 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001782 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1783 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001784 *
1785 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001786 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001787 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001788 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001789struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1790 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001791{
Nick Piggineb2be182007-10-16 01:24:57 -07001792 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001793
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001795 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001796 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001797 page = NULL;
1798 if (!page)
1799 goto no_page;
1800
1801 if (fgp_flags & FGP_LOCK) {
1802 if (fgp_flags & FGP_NOWAIT) {
1803 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001804 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001805 return NULL;
1806 }
1807 } else {
1808 lock_page(page);
1809 }
1810
1811 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001812 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001813 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001814 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001815 goto repeat;
1816 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001817 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001818 }
1819
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001820 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001821 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001822 else if (fgp_flags & FGP_WRITE) {
1823 /* Clear idle flag for buffer write */
1824 if (page_is_idle(page))
1825 clear_page_idle(page);
1826 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001827 if (!(fgp_flags & FGP_HEAD))
1828 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001829
1830no_page:
1831 if (!page && (fgp_flags & FGP_CREAT)) {
1832 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001833 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001834 gfp_mask |= __GFP_WRITE;
1835 if (fgp_flags & FGP_NOFS)
1836 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001837
Michal Hocko45f87de2014-12-29 20:30:35 +01001838 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001839 if (!page)
1840 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001841
Josef Bacika75d4c32019-03-13 11:44:14 -07001842 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001843 fgp_flags |= FGP_LOCK;
1844
Hugh Dickinseb39d612014-08-06 16:06:43 -07001845 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001846 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001847 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001848
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001849 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001850 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001851 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001852 page = NULL;
1853 if (err == -EEXIST)
1854 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001856
1857 /*
1858 * add_to_page_cache_lru locks the page, and for mmap we expect
1859 * an unlocked page.
1860 */
1861 if (page && (fgp_flags & FGP_FOR_MMAP))
1862 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001864
Linus Torvalds1da177e2005-04-16 15:20:36 -07001865 return page;
1866}
Mel Gorman2457aec2014-06-04 16:10:31 -07001867EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001868
1869/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001870 * find_get_entries - gang pagecache lookup
1871 * @mapping: The address_space to search
1872 * @start: The starting page cache index
1873 * @nr_entries: The maximum number of entries
1874 * @entries: Where the resulting entries are placed
1875 * @indices: The cache indices corresponding to the entries in @entries
1876 *
1877 * find_get_entries() will search for and return a group of up to
1878 * @nr_entries entries in the mapping. The entries are placed at
1879 * @entries. find_get_entries() takes a reference against any actual
1880 * pages it returns.
1881 *
1882 * The search returns a group of mapping-contiguous page cache entries
1883 * with ascending indexes. There may be holes in the indices due to
1884 * not-present pages.
1885 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001886 * Any shadow entries of evicted pages, or swap entries from
1887 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001888 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001889 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1890 * stops at that page: the caller is likely to have a better way to handle
1891 * the compound page as a whole, and then skip its extent, than repeatedly
1892 * calling find_get_entries() to return all its tails.
1893 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001894 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001895 */
1896unsigned find_get_entries(struct address_space *mapping,
1897 pgoff_t start, unsigned int nr_entries,
1898 struct page **entries, pgoff_t *indices)
1899{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001900 XA_STATE(xas, &mapping->i_pages, start);
1901 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001902 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001903
1904 if (!nr_entries)
1905 return 0;
1906
1907 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001908 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001909 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001910 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001911 /*
1912 * A shadow entry of a recently evicted page, a swap
1913 * entry from shmem/tmpfs or a DAX entry. Return it
1914 * without attempting to raise page count.
1915 */
1916 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001917 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001918
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001919 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001920 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001921
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001922 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001923 if (unlikely(page != xas_reload(&xas)))
1924 goto put_page;
1925
Hugh Dickins71725ed2020-04-06 20:07:57 -07001926 /*
1927 * Terminate early on finding a THP, to allow the caller to
1928 * handle it all at once; but continue if this is hugetlbfs.
1929 */
1930 if (PageTransHuge(page) && !PageHuge(page)) {
1931 page = find_subpage(page, xas.xa_index);
1932 nr_entries = ret + 1;
1933 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001934export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001935 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001936 entries[ret] = page;
1937 if (++ret == nr_entries)
1938 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001939 continue;
1940put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001941 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001942retry:
1943 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001944 }
1945 rcu_read_unlock();
1946 return ret;
1947}
1948
1949/**
Jan Karab947cee2017-09-06 16:21:21 -07001950 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951 * @mapping: The address_space to search
1952 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001953 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 * @nr_pages: The maximum number of pages
1955 * @pages: Where the resulting pages are placed
1956 *
Jan Karab947cee2017-09-06 16:21:21 -07001957 * find_get_pages_range() will search for and return a group of up to @nr_pages
1958 * pages in the mapping starting at index @start and up to index @end
1959 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1960 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 *
1962 * The search returns a group of mapping-contiguous pages with ascending
1963 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001964 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001966 * Return: the number of pages which were found. If this number is
1967 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001968 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 */
Jan Karab947cee2017-09-06 16:21:21 -07001970unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1971 pgoff_t end, unsigned int nr_pages,
1972 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001974 XA_STATE(xas, &mapping->i_pages, *start);
1975 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001976 unsigned ret = 0;
1977
1978 if (unlikely(!nr_pages))
1979 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980
Nick Piggina60637c2008-07-25 19:45:31 -07001981 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001982 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001983 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001984 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001985 /* Skip over shadow, swap and DAX entries */
1986 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001987 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001988
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001989 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001990 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001991
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001992 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001993 if (unlikely(page != xas_reload(&xas)))
1994 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001995
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001996 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001997 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001998 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001999 goto out;
2000 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002001 continue;
2002put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002003 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002004retry:
2005 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002006 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002007
Jan Karab947cee2017-09-06 16:21:21 -07002008 /*
2009 * We come here when there is no page beyond @end. We take care to not
2010 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002011 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002012 * already broken anyway.
2013 */
2014 if (end == (pgoff_t)-1)
2015 *start = (pgoff_t)-1;
2016 else
2017 *start = end + 1;
2018out:
Nick Piggina60637c2008-07-25 19:45:31 -07002019 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 return ret;
2022}
2023
Jens Axboeebf43502006-04-27 08:46:01 +02002024/**
2025 * find_get_pages_contig - gang contiguous pagecache lookup
2026 * @mapping: The address_space to search
2027 * @index: The starting page index
2028 * @nr_pages: The maximum number of pages
2029 * @pages: Where the resulting pages are placed
2030 *
2031 * find_get_pages_contig() works exactly like find_get_pages(), except
2032 * that the returned number of pages are guaranteed to be contiguous.
2033 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002034 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002035 */
2036unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2037 unsigned int nr_pages, struct page **pages)
2038{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002039 XA_STATE(xas, &mapping->i_pages, index);
2040 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002041 unsigned int ret = 0;
2042
2043 if (unlikely(!nr_pages))
2044 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002045
Nick Piggina60637c2008-07-25 19:45:31 -07002046 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002047 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002048 if (xas_retry(&xas, page))
2049 continue;
2050 /*
2051 * If the entry has been swapped out, we can stop looking.
2052 * No current caller is looking for DAX entries.
2053 */
2054 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002055 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002056
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002057 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002058 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002059
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002060 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002061 if (unlikely(page != xas_reload(&xas)))
2062 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002063
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002064 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002065 if (++ret == nr_pages)
2066 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002067 continue;
2068put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002069 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002070retry:
2071 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002072 }
Nick Piggina60637c2008-07-25 19:45:31 -07002073 rcu_read_unlock();
2074 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002075}
David Howellsef71c152007-05-09 02:33:44 -07002076EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002077
Randy Dunlap485bb992006-06-23 02:03:49 -07002078/**
Jan Kara72b045a2017-11-15 17:34:33 -08002079 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07002080 * @mapping: the address_space to search
2081 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002082 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002083 * @tag: the tag index
2084 * @nr_pages: the maximum number of pages
2085 * @pages: where the resulting pages are placed
2086 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07002088 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08002089 *
2090 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 */
Jan Kara72b045a2017-11-15 17:34:33 -08002092unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002093 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002094 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002096 XA_STATE(xas, &mapping->i_pages, *index);
2097 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002098 unsigned ret = 0;
2099
2100 if (unlikely(!nr_pages))
2101 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102
Nick Piggina60637c2008-07-25 19:45:31 -07002103 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002104 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002105 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07002106 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002107 /*
2108 * Shadow entries should never be tagged, but this iteration
2109 * is lockless so there is a window for page reclaim to evict
2110 * a page we saw tagged. Skip over it.
2111 */
2112 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002113 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002114
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002115 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002116 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002117
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002118 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002119 if (unlikely(page != xas_reload(&xas)))
2120 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002121
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002122 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08002123 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002124 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08002125 goto out;
2126 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002127 continue;
2128put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002129 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002130retry:
2131 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002132 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002133
Jan Kara72b045a2017-11-15 17:34:33 -08002134 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002135 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002136 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002137 * iteration when there is a page at index -1 but that is already
2138 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002139 */
2140 if (end == (pgoff_t)-1)
2141 *index = (pgoff_t)-1;
2142 else
2143 *index = end + 1;
2144out:
Nick Piggina60637c2008-07-25 19:45:31 -07002145 rcu_read_unlock();
2146
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147 return ret;
2148}
Jan Kara72b045a2017-11-15 17:34:33 -08002149EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002151/*
2152 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2153 * a _large_ part of the i/o request. Imagine the worst scenario:
2154 *
2155 * ---R__________________________________________B__________
2156 * ^ reading here ^ bad block(assume 4k)
2157 *
2158 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2159 * => failing the whole request => read(R) => read(R+1) =>
2160 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2161 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2162 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2163 *
2164 * It is going insane. Fix it by quickly scaling down the readahead size.
2165 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002166static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002167{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002168 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002169}
2170
Kent Overstreet723ef242020-12-14 19:04:52 -08002171static int lock_page_for_iocb(struct kiocb *iocb, struct page *page)
2172{
2173 if (iocb->ki_flags & IOCB_WAITQ)
2174 return lock_page_async(page, iocb->ki_waitq);
2175 else if (iocb->ki_flags & IOCB_NOWAIT)
2176 return trylock_page(page) ? 0 : -EAGAIN;
2177 else
2178 return lock_page_killable(page);
2179}
2180
Kent Overstreet723ef242020-12-14 19:04:52 -08002181static struct page *
2182generic_file_buffered_read_readpage(struct kiocb *iocb,
2183 struct file *filp,
2184 struct address_space *mapping,
2185 struct page *page)
2186{
2187 struct file_ra_state *ra = &filp->f_ra;
2188 int error;
2189
2190 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
2191 unlock_page(page);
2192 put_page(page);
2193 return ERR_PTR(-EAGAIN);
2194 }
2195
2196 /*
2197 * A previous I/O error may have been due to temporary
2198 * failures, eg. multipath errors.
2199 * PG_error will be set again if readpage fails.
2200 */
2201 ClearPageError(page);
2202 /* Start the actual read. The read will unlock the page. */
2203 error = mapping->a_ops->readpage(filp, page);
2204
2205 if (unlikely(error)) {
2206 put_page(page);
2207 return error != AOP_TRUNCATED_PAGE ? ERR_PTR(error) : NULL;
2208 }
2209
2210 if (!PageUptodate(page)) {
2211 error = lock_page_for_iocb(iocb, page);
2212 if (unlikely(error)) {
2213 put_page(page);
2214 return ERR_PTR(error);
2215 }
2216 if (!PageUptodate(page)) {
2217 if (page->mapping == NULL) {
2218 /*
2219 * invalidate_mapping_pages got it
2220 */
2221 unlock_page(page);
2222 put_page(page);
2223 return NULL;
2224 }
2225 unlock_page(page);
2226 shrink_readahead_size_eio(ra);
2227 put_page(page);
2228 return ERR_PTR(-EIO);
2229 }
2230 unlock_page(page);
2231 }
2232
2233 return page;
2234}
2235
2236static struct page *
2237generic_file_buffered_read_pagenotuptodate(struct kiocb *iocb,
2238 struct file *filp,
2239 struct iov_iter *iter,
2240 struct page *page,
2241 loff_t pos, loff_t count)
2242{
2243 struct address_space *mapping = filp->f_mapping;
2244 struct inode *inode = mapping->host;
2245 int error;
2246
2247 /*
2248 * See comment in do_read_cache_page on why
2249 * wait_on_page_locked is used to avoid unnecessarily
2250 * serialisations and why it's safe.
2251 */
2252 if (iocb->ki_flags & IOCB_WAITQ) {
2253 error = wait_on_page_locked_async(page,
2254 iocb->ki_waitq);
2255 } else {
2256 error = wait_on_page_locked_killable(page);
2257 }
2258 if (unlikely(error)) {
2259 put_page(page);
2260 return ERR_PTR(error);
2261 }
2262 if (PageUptodate(page))
2263 return page;
2264
2265 if (inode->i_blkbits == PAGE_SHIFT ||
2266 !mapping->a_ops->is_partially_uptodate)
2267 goto page_not_up_to_date;
2268 /* pipes can't handle partially uptodate pages */
2269 if (unlikely(iov_iter_is_pipe(iter)))
2270 goto page_not_up_to_date;
2271 if (!trylock_page(page))
2272 goto page_not_up_to_date;
2273 /* Did it get truncated before we got the lock? */
2274 if (!page->mapping)
2275 goto page_not_up_to_date_locked;
2276 if (!mapping->a_ops->is_partially_uptodate(page,
2277 pos & ~PAGE_MASK, count))
2278 goto page_not_up_to_date_locked;
2279 unlock_page(page);
2280 return page;
2281
2282page_not_up_to_date:
2283 /* Get exclusive access to the page ... */
2284 error = lock_page_for_iocb(iocb, page);
2285 if (unlikely(error)) {
2286 put_page(page);
2287 return ERR_PTR(error);
2288 }
2289
2290page_not_up_to_date_locked:
2291 /* Did it get truncated before we got the lock? */
2292 if (!page->mapping) {
2293 unlock_page(page);
2294 put_page(page);
2295 return NULL;
2296 }
2297
2298 /* Did somebody else fill it already? */
2299 if (PageUptodate(page)) {
2300 unlock_page(page);
2301 return page;
2302 }
2303
2304 return generic_file_buffered_read_readpage(iocb, filp, mapping, page);
2305}
2306
2307static struct page *
2308generic_file_buffered_read_no_cached_page(struct kiocb *iocb,
2309 struct iov_iter *iter)
2310{
2311 struct file *filp = iocb->ki_filp;
2312 struct address_space *mapping = filp->f_mapping;
2313 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
2314 struct page *page;
2315 int error;
2316
2317 if (iocb->ki_flags & IOCB_NOIO)
2318 return ERR_PTR(-EAGAIN);
2319
2320 /*
2321 * Ok, it wasn't cached, so we need to create a new
2322 * page..
2323 */
2324 page = page_cache_alloc(mapping);
2325 if (!page)
2326 return ERR_PTR(-ENOMEM);
2327
2328 error = add_to_page_cache_lru(page, mapping, index,
2329 mapping_gfp_constraint(mapping, GFP_KERNEL));
2330 if (error) {
2331 put_page(page);
2332 return error != -EEXIST ? ERR_PTR(error) : NULL;
2333 }
2334
2335 return generic_file_buffered_read_readpage(iocb, filp, mapping, page);
2336}
2337
Kent Overstreet06c04442020-12-14 19:04:56 -08002338static int generic_file_buffered_read_get_pages(struct kiocb *iocb,
2339 struct iov_iter *iter,
2340 struct page **pages,
2341 unsigned int nr)
2342{
2343 struct file *filp = iocb->ki_filp;
2344 struct address_space *mapping = filp->f_mapping;
2345 struct file_ra_state *ra = &filp->f_ra;
2346 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
2347 pgoff_t last_index = (iocb->ki_pos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2348 int i, j, nr_got, err = 0;
2349
2350 nr = min_t(unsigned long, last_index - index, nr);
2351find_page:
2352 if (fatal_signal_pending(current))
2353 return -EINTR;
2354
2355 nr_got = find_get_pages_contig(mapping, index, nr, pages);
2356 if (nr_got)
2357 goto got_pages;
2358
2359 if (iocb->ki_flags & IOCB_NOIO)
2360 return -EAGAIN;
2361
2362 page_cache_sync_readahead(mapping, ra, filp, index, last_index - index);
2363
2364 nr_got = find_get_pages_contig(mapping, index, nr, pages);
2365 if (nr_got)
2366 goto got_pages;
2367
2368 pages[0] = generic_file_buffered_read_no_cached_page(iocb, iter);
2369 err = PTR_ERR_OR_ZERO(pages[0]);
2370 if (!IS_ERR_OR_NULL(pages[0]))
2371 nr_got = 1;
2372got_pages:
2373 for (i = 0; i < nr_got; i++) {
2374 struct page *page = pages[i];
2375 pgoff_t pg_index = index + i;
2376 loff_t pg_pos = max(iocb->ki_pos,
2377 (loff_t) pg_index << PAGE_SHIFT);
2378 loff_t pg_count = iocb->ki_pos + iter->count - pg_pos;
2379
2380 if (PageReadahead(page)) {
2381 if (iocb->ki_flags & IOCB_NOIO) {
2382 for (j = i; j < nr_got; j++)
2383 put_page(pages[j]);
2384 nr_got = i;
2385 err = -EAGAIN;
2386 break;
2387 }
2388 page_cache_async_readahead(mapping, ra, filp, page,
2389 pg_index, last_index - pg_index);
2390 }
2391
2392 if (!PageUptodate(page)) {
2393 if ((iocb->ki_flags & IOCB_NOWAIT) ||
2394 ((iocb->ki_flags & IOCB_WAITQ) && i)) {
2395 for (j = i; j < nr_got; j++)
2396 put_page(pages[j]);
2397 nr_got = i;
2398 err = -EAGAIN;
2399 break;
2400 }
2401
2402 page = generic_file_buffered_read_pagenotuptodate(iocb,
2403 filp, iter, page, pg_pos, pg_count);
2404 if (IS_ERR_OR_NULL(page)) {
2405 for (j = i + 1; j < nr_got; j++)
2406 put_page(pages[j]);
2407 nr_got = i;
2408 err = PTR_ERR_OR_ZERO(page);
2409 break;
2410 }
2411 }
2412 }
2413
2414 if (likely(nr_got))
2415 return nr_got;
2416 if (err)
2417 return err;
2418 /*
2419 * No pages and no error means we raced and should retry:
2420 */
2421 goto find_page;
2422}
2423
Randy Dunlap485bb992006-06-23 02:03:49 -07002424/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002425 * generic_file_buffered_read - generic file read routine
2426 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05002427 * @iter: data destination
2428 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07002429 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002430 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07002431 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432 *
2433 * This is really ugly. But the goto's actually try to clarify some
2434 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002435 *
2436 * Return:
2437 * * total number of bytes copied, including those the were already @written
2438 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002439 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002440ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002441 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002442{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002443 struct file *filp = iocb->ki_filp;
Kent Overstreet06c04442020-12-14 19:04:56 -08002444 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002445 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446 struct inode *inode = mapping->host;
Kent Overstreet06c04442020-12-14 19:04:56 -08002447 struct page *pages_onstack[PAGEVEC_SIZE], **pages = NULL;
2448 unsigned int nr_pages = min_t(unsigned int, 512,
2449 ((iocb->ki_pos + iter->count + PAGE_SIZE - 1) >> PAGE_SHIFT) -
2450 (iocb->ki_pos >> PAGE_SHIFT));
2451 int i, pg_nr, error = 0;
2452 bool writably_mapped;
2453 loff_t isize, end_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002454
Kent Overstreet723ef242020-12-14 19:04:52 -08002455 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002456 return 0;
Kent Overstreet3644e2d2020-12-18 04:07:11 -05002457 if (unlikely(!iov_iter_count(iter)))
2458 return 0;
2459
Wei Fangc2a97372016-10-07 17:01:52 -07002460 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2461
Kent Overstreet06c04442020-12-14 19:04:56 -08002462 if (nr_pages > ARRAY_SIZE(pages_onstack))
2463 pages = kmalloc_array(nr_pages, sizeof(void *), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002464
Kent Overstreet06c04442020-12-14 19:04:56 -08002465 if (!pages) {
2466 pages = pages_onstack;
2467 nr_pages = min_t(unsigned int, nr_pages, ARRAY_SIZE(pages_onstack));
2468 }
Jens Axboe13bd6912020-10-17 08:31:29 -06002469
Kent Overstreet06c04442020-12-14 19:04:56 -08002470 do {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 cond_resched();
Kent Overstreet06c04442020-12-14 19:04:56 -08002472
2473 /*
2474 * If we've already successfully copied some data, then we
2475 * can no longer safely return -EIOCBQUEUED. Hence mark
2476 * an async read NOWAIT at that point.
2477 */
2478 if ((iocb->ki_flags & IOCB_WAITQ) && written)
2479 iocb->ki_flags |= IOCB_NOWAIT;
2480
2481 i = 0;
2482 pg_nr = generic_file_buffered_read_get_pages(iocb, iter,
2483 pages, nr_pages);
2484 if (pg_nr < 0) {
2485 error = pg_nr;
2486 break;
Michal Hocko5abf1862017-02-03 13:13:29 -08002487 }
2488
Kent Overstreet723ef242020-12-14 19:04:52 -08002489 /*
Kent Overstreet06c04442020-12-14 19:04:56 -08002490 * i_size must be checked after we know the pages are Uptodate.
2491 *
2492 * Checking i_size after the check allows us to calculate
2493 * the correct value for "nr", which means the zero-filled
2494 * part of the page is not copied back to userspace (unless
2495 * another truncate extends the file - this is desired though).
Kent Overstreet723ef242020-12-14 19:04:52 -08002496 */
Kent Overstreet06c04442020-12-14 19:04:56 -08002497 isize = i_size_read(inode);
2498 if (unlikely(iocb->ki_pos >= isize))
2499 goto put_pages;
Kent Overstreet723ef242020-12-14 19:04:52 -08002500
Kent Overstreet06c04442020-12-14 19:04:56 -08002501 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2502
2503 while ((iocb->ki_pos >> PAGE_SHIFT) + pg_nr >
2504 (end_offset + PAGE_SIZE - 1) >> PAGE_SHIFT)
2505 put_page(pages[--pg_nr]);
2506
2507 /*
2508 * Once we start copying data, we don't want to be touching any
2509 * cachelines that might be contended:
2510 */
2511 writably_mapped = mapping_writably_mapped(mapping);
2512
2513 /*
2514 * When a sequential read accesses a page several times, only
2515 * mark it as accessed the first time.
2516 */
2517 if (iocb->ki_pos >> PAGE_SHIFT !=
2518 ra->prev_pos >> PAGE_SHIFT)
2519 mark_page_accessed(pages[0]);
2520 for (i = 1; i < pg_nr; i++)
2521 mark_page_accessed(pages[i]);
2522
2523 for (i = 0; i < pg_nr; i++) {
2524 unsigned int offset = iocb->ki_pos & ~PAGE_MASK;
2525 unsigned int bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2526 PAGE_SIZE - offset);
2527 unsigned int copied;
2528
2529 /*
2530 * If users can be writing to this page using arbitrary
2531 * virtual addresses, take care about potential aliasing
2532 * before reading the page on the kernel side.
2533 */
2534 if (writably_mapped)
2535 flush_dcache_page(pages[i]);
2536
2537 copied = copy_page_to_iter(pages[i], offset, bytes, iter);
2538
2539 written += copied;
2540 iocb->ki_pos += copied;
2541 ra->prev_pos = iocb->ki_pos;
2542
2543 if (copied < bytes) {
2544 error = -EFAULT;
2545 break;
Kent Overstreet723ef242020-12-14 19:04:52 -08002546 }
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002547 }
Kent Overstreet06c04442020-12-14 19:04:56 -08002548put_pages:
2549 for (i = 0; i < pg_nr; i++)
2550 put_page(pages[i]);
2551 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002552
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002553 file_accessed(filp);
Kent Overstreet06c04442020-12-14 19:04:56 -08002554
2555 if (pages != pages_onstack)
2556 kfree(pages);
Kent Overstreet723ef242020-12-14 19:04:52 -08002557
Al Viro6e58e792014-02-03 17:07:03 -05002558 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002560EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002561
Randy Dunlap485bb992006-06-23 02:03:49 -07002562/**
Al Viro6abd2322014-04-04 14:20:57 -04002563 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002564 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002565 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002566 *
Al Viro6abd2322014-04-04 14:20:57 -04002567 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002569 *
2570 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2571 * be returned when no data can be read without waiting for I/O requests
2572 * to complete; it doesn't prevent readahead.
2573 *
2574 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2575 * requests shall be made for the read or for readahead. When no data
2576 * can be read, -EAGAIN shall be returned. When readahead would be
2577 * triggered, a partial, possibly empty read shall be returned.
2578 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002579 * Return:
2580 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002581 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 */
2583ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002584generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002586 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002587 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002588
2589 if (!count)
2590 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591
Al Viro2ba48ce2015-04-09 13:52:01 -04002592 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002593 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002594 struct address_space *mapping = file->f_mapping;
2595 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002596 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002599 if (iocb->ki_flags & IOCB_NOWAIT) {
2600 if (filemap_range_has_page(mapping, iocb->ki_pos,
2601 iocb->ki_pos + count - 1))
2602 return -EAGAIN;
2603 } else {
2604 retval = filemap_write_and_wait_range(mapping,
2605 iocb->ki_pos,
2606 iocb->ki_pos + count - 1);
2607 if (retval < 0)
2608 goto out;
2609 }
Al Viroed978a82014-03-05 22:53:04 -05002610
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002611 file_accessed(file);
2612
Al Viro5ecda132017-04-13 14:13:36 -04002613 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002614 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002615 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002616 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002617 }
Al Viro5b47d592017-05-08 13:54:47 -04002618 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002619
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002620 /*
2621 * Btrfs can have a short DIO read if we encounter
2622 * compressed extents, so if there was an error, or if
2623 * we've already read everything we wanted to, or if
2624 * there was a short read because we hit EOF, go ahead
2625 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002626 * the rest of the read. Buffered reads will not work for
2627 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002628 */
Al Viro5ecda132017-04-13 14:13:36 -04002629 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002630 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002631 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 }
2633
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002634 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635out:
2636 return retval;
2637}
Al Viroed978a82014-03-05 22:53:04 -05002638EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002642/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002643 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002644 * @vmf - the vm_fault for this fault.
2645 * @page - the page to lock.
2646 * @fpin - the pointer to the file we may pin (or is already pinned).
2647 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002648 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002649 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002650 * 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 -07002651 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002652 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002653static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2654 struct file **fpin)
2655{
2656 if (trylock_page(page))
2657 return 1;
2658
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002659 /*
2660 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002661 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002662 * is supposed to work. We have way too many special cases..
2663 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002664 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2665 return 0;
2666
2667 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2668 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2669 if (__lock_page_killable(page)) {
2670 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002671 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002672 * but all fault_handlers only check for fatal signals
2673 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002674 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002675 */
2676 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002677 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002678 return 0;
2679 }
2680 } else
2681 __lock_page(page);
2682 return 1;
2683}
2684
2685
2686/*
2687 * Synchronous readahead happens when we don't even find a page in the page
2688 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2689 * to drop the mmap sem we return the file that was pinned in order for us to do
2690 * that. If we didn't pin a file then we return NULL. The file that is
2691 * returned needs to be fput()'ed when we're done with it.
2692 */
2693static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002694{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002695 struct file *file = vmf->vma->vm_file;
2696 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002697 struct address_space *mapping = file->f_mapping;
David Howellsdb660d42020-10-15 20:06:31 -07002698 DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002699 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002700 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002701
2702 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002703 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002704 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002705 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002706 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002707
Josef Bacik2a1180f2019-03-13 11:44:18 -07002708 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002709 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002710 page_cache_sync_ra(&ractl, ra, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002711 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002712 }
2713
Andi Kleen207d04b2011-05-24 17:12:29 -07002714 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002715 mmap_miss = READ_ONCE(ra->mmap_miss);
2716 if (mmap_miss < MMAP_LOTSAMISS * 10)
2717 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002718
2719 /*
2720 * Do we miss much more than hit in this file? If so,
2721 * stop bothering with read-ahead. It will only hurt.
2722 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002723 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002724 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002725
Wu Fengguangd30a1102009-06-16 15:31:30 -07002726 /*
2727 * mmap read-around
2728 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002729 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002730 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002731 ra->size = ra->ra_pages;
2732 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002733 ractl._index = ra->start;
2734 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002735 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002736}
2737
2738/*
2739 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002740 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002741 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002742 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002743static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2744 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002745{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002746 struct file *file = vmf->vma->vm_file;
2747 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002748 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002749 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002750 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002751 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002752
2753 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002754 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002755 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002756 mmap_miss = READ_ONCE(ra->mmap_miss);
2757 if (mmap_miss)
2758 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002759 if (PageReadahead(page)) {
2760 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002761 page_cache_async_readahead(mapping, ra, file,
2762 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002763 }
2764 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002765}
2766
Randy Dunlap485bb992006-06-23 02:03:49 -07002767/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002768 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002769 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002770 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002771 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 * mapped memory region to read in file data during a page fault.
2773 *
2774 * The goto's are kind of ugly, but this streamlines the normal case of having
2775 * it in the page cache, and handles the special cases reasonably without
2776 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002777 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002778 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002779 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002780 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002781 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002782 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002783 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002784 * has not been released.
2785 *
2786 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002787 *
2788 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002790vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002791{
2792 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002793 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002794 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 struct address_space *mapping = file->f_mapping;
2796 struct file_ra_state *ra = &file->f_ra;
2797 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002798 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002799 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002801 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002803 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2804 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002805 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002806
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002808 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002809 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002810 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002811 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002812 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002813 * We found the page, so try async readahead before
2814 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002816 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002817 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002818 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002819 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002820 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002821 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002822 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002823retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002824 page = pagecache_get_page(mapping, offset,
2825 FGP_CREAT|FGP_FOR_MMAP,
2826 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002827 if (!page) {
2828 if (fpin)
2829 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002830 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002831 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002832 }
2833
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002834 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2835 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002836
2837 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002838 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002839 unlock_page(page);
2840 put_page(page);
2841 goto retry_find;
2842 }
Song Liu520e5ba2019-09-23 15:37:50 -07002843 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002844
Linus Torvalds1da177e2005-04-16 15:20:36 -07002845 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002846 * We have a locked page in the page cache, now we need to check
2847 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848 */
Nick Piggind00806b2007-07-19 01:46:57 -07002849 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002850 goto page_not_uptodate;
2851
Linus Torvaldsef00e082009-06-16 15:31:25 -07002852 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002853 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002854 * time to return to the upper layer and have it re-find the vma and
2855 * redo the fault.
2856 */
2857 if (fpin) {
2858 unlock_page(page);
2859 goto out_retry;
2860 }
2861
2862 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002863 * Found the page and have a reference on it.
2864 * We must recheck i_size under page lock.
2865 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002866 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2867 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002868 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002869 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002870 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002871 }
2872
Nick Piggind0217ac2007-07-19 01:47:03 -07002873 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002874 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002875
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002877 /*
2878 * Umm, take care of errors if the page isn't up-to-date.
2879 * Try to re-read it _once_. We do this synchronously,
2880 * because there really aren't any performance issues here
2881 * and we need to check for errors.
2882 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002884 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002885 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002886 if (!error) {
2887 wait_on_page_locked(page);
2888 if (!PageUptodate(page))
2889 error = -EIO;
2890 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002891 if (fpin)
2892 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002893 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002894
2895 if (!error || error == AOP_TRUNCATED_PAGE)
2896 goto retry_find;
2897
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002898 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002899 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002900
2901out_retry:
2902 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002903 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002904 * re-find the vma and come back and find our hopefully still populated
2905 * page.
2906 */
2907 if (page)
2908 put_page(page);
2909 if (fpin)
2910 fput(fpin);
2911 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002912}
2913EXPORT_SYMBOL(filemap_fault);
2914
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03002915static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002916{
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03002917 struct mm_struct *mm = vmf->vma->vm_mm;
2918
2919 /* Huge page is mapped? No need to proceed. */
2920 if (pmd_trans_huge(*vmf->pmd)) {
2921 unlock_page(page);
2922 put_page(page);
2923 return true;
2924 }
2925
2926 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
2927 vm_fault_t ret = do_set_pmd(vmf, page);
2928 if (!ret) {
2929 /* The page is mapped successfully, reference consumed. */
2930 unlock_page(page);
2931 return true;
2932 }
2933 }
2934
2935 if (pmd_none(*vmf->pmd)) {
2936 vmf->ptl = pmd_lock(mm, vmf->pmd);
2937 if (likely(pmd_none(*vmf->pmd))) {
2938 mm_inc_nr_ptes(mm);
2939 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
2940 vmf->prealloc_pte = NULL;
2941 }
2942 spin_unlock(vmf->ptl);
2943 }
2944
2945 /* See comment in handle_pte_fault() */
2946 if (pmd_devmap_trans_unstable(vmf->pmd)) {
2947 unlock_page(page);
2948 put_page(page);
2949 return true;
2950 }
2951
2952 return false;
2953}
2954
2955static struct page *next_uptodate_page(struct page *page,
2956 struct address_space *mapping,
2957 struct xa_state *xas, pgoff_t end_pgoff)
2958{
2959 unsigned long max_idx;
2960
2961 do {
2962 if (!page)
2963 return NULL;
2964 if (xas_retry(xas, page))
2965 continue;
2966 if (xa_is_value(page))
2967 continue;
2968 if (PageLocked(page))
2969 continue;
2970 if (!page_cache_get_speculative(page))
2971 continue;
2972 /* Has the page moved or been split? */
2973 if (unlikely(page != xas_reload(xas)))
2974 goto skip;
2975 if (!PageUptodate(page) || PageReadahead(page))
2976 goto skip;
2977 if (PageHWPoison(page))
2978 goto skip;
2979 if (!trylock_page(page))
2980 goto skip;
2981 if (page->mapping != mapping)
2982 goto unlock;
2983 if (!PageUptodate(page))
2984 goto unlock;
2985 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2986 if (xas->xa_index >= max_idx)
2987 goto unlock;
2988 return page;
2989unlock:
2990 unlock_page(page);
2991skip:
2992 put_page(page);
2993 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
2994
2995 return NULL;
2996}
2997
2998static inline struct page *first_map_page(struct address_space *mapping,
2999 struct xa_state *xas,
3000 pgoff_t end_pgoff)
3001{
3002 return next_uptodate_page(xas_find(xas, end_pgoff),
3003 mapping, xas, end_pgoff);
3004}
3005
3006static inline struct page *next_map_page(struct address_space *mapping,
3007 struct xa_state *xas,
3008 pgoff_t end_pgoff)
3009{
3010 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3011 mapping, xas, end_pgoff);
3012}
3013
3014vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3015 pgoff_t start_pgoff, pgoff_t end_pgoff)
3016{
3017 struct vm_area_struct *vma = vmf->vma;
3018 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003019 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07003020 pgoff_t last_pgoff = start_pgoff;
Will Deacon9d3af4b2021-01-14 15:24:19 +00003021 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003022 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003023 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003024 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003025 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003026
3027 rcu_read_lock();
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003028 head = first_map_page(mapping, &xas, end_pgoff);
3029 if (!head)
3030 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003031
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003032 if (filemap_map_pmd(vmf, head)) {
3033 ret = VM_FAULT_NOPAGE;
3034 goto out;
3035 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003036
Will Deacon9d3af4b2021-01-14 15:24:19 +00003037 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3038 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003039 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003040 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003041 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003042 goto unlock;
3043
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003044 if (mmap_miss > 0)
3045 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003046
Will Deacon9d3af4b2021-01-14 15:24:19 +00003047 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003048 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04003049 last_pgoff = xas.xa_index;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003050
3051 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07003052 goto unlock;
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003053
Will Deacon46bdb422020-11-24 18:48:26 +00003054 /* We're about to handle the fault */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003055 if (vmf->address == addr)
Will Deacon46bdb422020-11-24 18:48:26 +00003056 ret = VM_FAULT_NOPAGE;
Will Deacon46bdb422020-11-24 18:48:26 +00003057
Will Deacon9d3af4b2021-01-14 15:24:19 +00003058 do_set_pte(vmf, page, addr);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003059 /* no need to invalidate: a not-present page won't be cached */
Will Deacon9d3af4b2021-01-14 15:24:19 +00003060 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003061 unlock_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003062 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003063unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003064 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07003065 put_page(head);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003066 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3067 pte_unmap_unlock(vmf->pte, vmf->ptl);
3068out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003069 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07003070 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemovf9ce0be2020-12-19 15:19:23 +03003071 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003072}
3073EXPORT_SYMBOL(filemap_map_pages);
3074
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003075vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003076{
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003077 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003078 struct page *page = vmf->page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003079 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003080
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003081 sb_start_pagefault(mapping->host->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003082 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003083 lock_page(page);
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003084 if (page->mapping != mapping) {
Jan Kara4fcf1c62012-06-12 16:20:29 +02003085 unlock_page(page);
3086 ret = VM_FAULT_NOPAGE;
3087 goto out;
3088 }
Jan Kara14da9202012-06-12 16:20:37 +02003089 /*
3090 * We mark the page dirty already here so that when freeze is in
3091 * progress, we are guaranteed that writeback during freezing will
3092 * see the dirty page and writeprotect it again.
3093 */
3094 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003095 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003096out:
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003097 sb_end_pagefault(mapping->host->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003098 return ret;
3099}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003100
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003101const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003102 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003103 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003104 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105};
3106
3107/* This is used for a general mmap of a disk file */
3108
3109int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3110{
3111 struct address_space *mapping = file->f_mapping;
3112
3113 if (!mapping->a_ops->readpage)
3114 return -ENOEXEC;
3115 file_accessed(file);
3116 vma->vm_ops = &generic_file_vm_ops;
3117 return 0;
3118}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003119
3120/*
3121 * This is for filesystems which do not implement ->writepage.
3122 */
3123int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3124{
3125 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3126 return -EINVAL;
3127 return generic_file_mmap(file, vma);
3128}
3129#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003130vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07003131{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003132 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07003133}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003134int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3135{
3136 return -ENOSYS;
3137}
3138int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
3139{
3140 return -ENOSYS;
3141}
3142#endif /* CONFIG_MMU */
3143
Arnd Bergmann453972282018-04-13 15:35:27 -07003144EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003145EXPORT_SYMBOL(generic_file_mmap);
3146EXPORT_SYMBOL(generic_file_readonly_mmap);
3147
Sasha Levin67f9fd92014-04-03 14:48:18 -07003148static struct page *wait_on_page_read(struct page *page)
3149{
3150 if (!IS_ERR(page)) {
3151 wait_on_page_locked(page);
3152 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003153 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003154 page = ERR_PTR(-EIO);
3155 }
3156 }
3157 return page;
3158}
3159
Mel Gorman32b63522016-03-15 14:55:36 -07003160static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003161 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003162 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003163 void *data,
3164 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165{
Nick Piggineb2be182007-10-16 01:24:57 -07003166 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003167 int err;
3168repeat:
3169 page = find_get_page(mapping, index);
3170 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003171 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003172 if (!page)
3173 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003174 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003175 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003176 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003177 if (err == -EEXIST)
3178 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003179 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003180 return ERR_PTR(err);
3181 }
Mel Gorman32b63522016-03-15 14:55:36 -07003182
3183filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003184 if (filler)
3185 err = filler(data, page);
3186 else
3187 err = mapping->a_ops->readpage(data, page);
3188
Linus Torvalds1da177e2005-04-16 15:20:36 -07003189 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003190 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003191 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003192 }
Mel Gorman32b63522016-03-15 14:55:36 -07003193
3194 page = wait_on_page_read(page);
3195 if (IS_ERR(page))
3196 return page;
3197 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003199 if (PageUptodate(page))
3200 goto out;
3201
Mel Gormanebded022016-03-15 14:55:39 -07003202 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003203 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003204 * case a: Page is being filled and the page lock is held
3205 * case b: Read/write error clearing the page uptodate status
3206 * case c: Truncation in progress (page locked)
3207 * case d: Reclaim in progress
3208 *
3209 * Case a, the page will be up to date when the page is unlocked.
3210 * There is no need to serialise on the page lock here as the page
3211 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003212 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003213 * it's a race vs truncate race.
3214 * Case b, the page will not be up to date
3215 * Case c, the page may be truncated but in itself, the data may still
3216 * be valid after IO completes as it's a read vs truncate race. The
3217 * operation must restart if the page is not uptodate on unlock but
3218 * otherwise serialising on page lock to stabilise the mapping gives
3219 * no additional guarantees to the caller as the page lock is
3220 * released before return.
3221 * Case d, similar to truncation. If reclaim holds the page lock, it
3222 * will be a race with remove_mapping that determines if the mapping
3223 * is valid on unlock but otherwise the data is valid and there is
3224 * no need to serialise with page lock.
3225 *
3226 * As the page lock gives no additional guarantee, we optimistically
3227 * wait on the page to be unlocked and check if it's up to date and
3228 * use the page if it is. Otherwise, the page lock is required to
3229 * distinguish between the different cases. The motivation is that we
3230 * avoid spurious serialisations and wakeups when multiple processes
3231 * wait on the same page for IO to complete.
3232 */
3233 wait_on_page_locked(page);
3234 if (PageUptodate(page))
3235 goto out;
3236
3237 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003238 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003239
3240 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003241 if (!page->mapping) {
3242 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003243 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003244 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003245 }
Mel Gormanebded022016-03-15 14:55:39 -07003246
3247 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003248 if (PageUptodate(page)) {
3249 unlock_page(page);
3250 goto out;
3251 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003252
3253 /*
3254 * A previous I/O error may have been due to temporary
3255 * failures.
3256 * Clear page error before actual read, PG_error will be
3257 * set again if read page fails.
3258 */
3259 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003260 goto filler;
3261
David Howellsc855ff32007-05-09 13:42:20 +01003262out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003263 mark_page_accessed(page);
3264 return page;
3265}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003266
3267/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003268 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003269 * @mapping: the page's address_space
3270 * @index: the page index
3271 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003272 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003273 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003274 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003275 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003276 *
3277 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003278 *
3279 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003280 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003281struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003282 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003283 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003284 void *data)
3285{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003286 return do_read_cache_page(mapping, index, filler, data,
3287 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003288}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003289EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003290
3291/**
3292 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3293 * @mapping: the page's address_space
3294 * @index: the page index
3295 * @gfp: the page allocator flags to use if allocating
3296 *
3297 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003298 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003299 *
3300 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003301 *
3302 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003303 */
3304struct page *read_cache_page_gfp(struct address_space *mapping,
3305 pgoff_t index,
3306 gfp_t gfp)
3307{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003308 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003309}
3310EXPORT_SYMBOL(read_cache_page_gfp);
3311
Nick Pigginafddba42007-10-16 01:25:01 -07003312int pagecache_write_begin(struct file *file, struct address_space *mapping,
3313 loff_t pos, unsigned len, unsigned flags,
3314 struct page **pagep, void **fsdata)
3315{
3316 const struct address_space_operations *aops = mapping->a_ops;
3317
Nick Piggin4e02ed42008-10-29 14:00:55 -07003318 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003319 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003320}
3321EXPORT_SYMBOL(pagecache_write_begin);
3322
3323int pagecache_write_end(struct file *file, struct address_space *mapping,
3324 loff_t pos, unsigned len, unsigned copied,
3325 struct page *page, void *fsdata)
3326{
3327 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003328
Nick Piggin4e02ed42008-10-29 14:00:55 -07003329 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003330}
3331EXPORT_SYMBOL(pagecache_write_end);
3332
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003333/*
3334 * Warn about a page cache invalidation failure during a direct I/O write.
3335 */
3336void dio_warn_stale_pagecache(struct file *filp)
3337{
3338 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3339 char pathname[128];
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003340 char *path;
3341
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003342 errseq_set(&filp->f_mapping->wb_err, -EIO);
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003343 if (__ratelimit(&_rs)) {
3344 path = file_path(filp, pathname, sizeof(pathname));
3345 if (IS_ERR(path))
3346 path = "(unknown)";
3347 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3348 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3349 current->comm);
3350 }
3351}
3352
Linus Torvalds1da177e2005-04-16 15:20:36 -07003353ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003354generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003355{
3356 struct file *file = iocb->ki_filp;
3357 struct address_space *mapping = file->f_mapping;
3358 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003359 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003360 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003361 size_t write_len;
3362 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003363
Al Viro0c949332014-03-22 06:51:37 -04003364 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003365 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003366
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003367 if (iocb->ki_flags & IOCB_NOWAIT) {
3368 /* If there are pages to writeback, return */
Christoph Hellwig5df1a672020-11-16 14:33:37 +01003369 if (filemap_range_has_page(file->f_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003370 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003371 return -EAGAIN;
3372 } else {
3373 written = filemap_write_and_wait_range(mapping, pos,
3374 pos + write_len - 1);
3375 if (written)
3376 goto out;
3377 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003378
3379 /*
3380 * After a write we want buffered reads to be sure to go to disk to get
3381 * the new data. We invalidate clean cached page from the region we're
3382 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003383 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003384 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003385 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003386 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003387 /*
3388 * If a page can not be invalidated, return 0 to fall back
3389 * to buffered write.
3390 */
3391 if (written) {
3392 if (written == -EBUSY)
3393 return 0;
3394 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003395 }
3396
Al Viro639a93a52017-04-13 14:10:15 -04003397 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003398
3399 /*
3400 * Finally, try again to invalidate clean pages which might have been
3401 * cached by non-direct readahead, or faulted in by get_user_pages()
3402 * if the source of the write was an mmap'ed region of the file
3403 * we're writing. Either one is a pretty crazy thing to do,
3404 * so we don't support it 100%. If this invalidation
3405 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003406 *
3407 * Most of the time we do not need this since dio_complete() will do
3408 * the invalidation for us. However there are some file systems that
3409 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003410 * them by removing it completely.
3411 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003412 * Noticeable example is a blkdev_direct_IO().
3413 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003414 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003415 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003416 if (written > 0 && mapping->nrpages &&
3417 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3418 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003419
Linus Torvalds1da177e2005-04-16 15:20:36 -07003420 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003421 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003422 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003423 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3424 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003425 mark_inode_dirty(inode);
3426 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003427 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428 }
Al Viro639a93a52017-04-13 14:10:15 -04003429 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003430out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431 return written;
3432}
3433EXPORT_SYMBOL(generic_file_direct_write);
3434
Nick Piggineb2be182007-10-16 01:24:57 -07003435/*
3436 * Find or create a page at the given pagecache position. Return the locked
3437 * page. This function is specifically for buffered writes.
3438 */
Nick Piggin54566b22009-01-04 12:00:53 -08003439struct page *grab_cache_page_write_begin(struct address_space *mapping,
3440 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003441{
Nick Piggineb2be182007-10-16 01:24:57 -07003442 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003443 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003444
Nick Piggin54566b22009-01-04 12:00:53 -08003445 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003446 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003447
Mel Gorman2457aec2014-06-04 16:10:31 -07003448 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003449 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003450 if (page)
3451 wait_for_stable_page(page);
3452
Nick Piggineb2be182007-10-16 01:24:57 -07003453 return page;
3454}
Nick Piggin54566b22009-01-04 12:00:53 -08003455EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003456
Al Viro3b93f912014-02-11 21:34:08 -05003457ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003458 struct iov_iter *i, loff_t pos)
3459{
3460 struct address_space *mapping = file->f_mapping;
3461 const struct address_space_operations *a_ops = mapping->a_ops;
3462 long status = 0;
3463 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003464 unsigned int flags = 0;
3465
Nick Pigginafddba42007-10-16 01:25:01 -07003466 do {
3467 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003468 unsigned long offset; /* Offset into pagecache page */
3469 unsigned long bytes; /* Bytes to write to page */
3470 size_t copied; /* Bytes copied from user */
3471 void *fsdata;
3472
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003473 offset = (pos & (PAGE_SIZE - 1));
3474 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003475 iov_iter_count(i));
3476
3477again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003478 /*
3479 * Bring in the user page that we will copy from _first_.
3480 * Otherwise there's a nasty deadlock on copying from the
3481 * same page as we're writing to, without it being marked
3482 * up-to-date.
3483 *
3484 * Not only is this an optimisation, but it is also required
3485 * to check that the address is actually valid, when atomic
3486 * usercopies are used, below.
3487 */
3488 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3489 status = -EFAULT;
3490 break;
3491 }
3492
Jan Kara296291c2015-10-22 13:32:21 -07003493 if (fatal_signal_pending(current)) {
3494 status = -EINTR;
3495 break;
3496 }
3497
Nick Piggin674b8922007-10-16 01:25:03 -07003498 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003499 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003500 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003501 break;
3502
anfei zhou931e80e2010-02-02 13:44:02 -08003503 if (mapping_writably_mapped(mapping))
3504 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003505
Nick Pigginafddba42007-10-16 01:25:01 -07003506 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003507 flush_dcache_page(page);
3508
3509 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3510 page, fsdata);
3511 if (unlikely(status < 0))
3512 break;
3513 copied = status;
3514
3515 cond_resched();
3516
Nick Piggin124d3b72008-02-02 15:01:17 +01003517 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003518 if (unlikely(copied == 0)) {
3519 /*
3520 * If we were unable to copy any data at all, we must
3521 * fall back to a single segment length write.
3522 *
3523 * If we didn't fallback here, we could livelock
3524 * because not all segments in the iov can be copied at
3525 * once without a pagefault.
3526 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003527 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003528 iov_iter_single_seg_count(i));
3529 goto again;
3530 }
Nick Pigginafddba42007-10-16 01:25:01 -07003531 pos += copied;
3532 written += copied;
3533
3534 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003535 } while (iov_iter_count(i));
3536
3537 return written ? written : status;
3538}
Al Viro3b93f912014-02-11 21:34:08 -05003539EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003540
Jan Karae4dd9de2009-08-17 18:10:06 +02003541/**
Al Viro81742022014-04-03 03:17:43 -04003542 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003543 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003544 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003545 *
3546 * This function does all the work needed for actually writing data to a
3547 * file. It does all basic checks, removes SUID from the file, updates
3548 * modification times and calls proper subroutines depending on whether we
3549 * do direct IO or a standard buffered write.
3550 *
3551 * It expects i_mutex to be grabbed unless we work on a block device or similar
3552 * object which does not need locking at all.
3553 *
3554 * This function does *not* take care of syncing data in case of O_SYNC write.
3555 * A caller has to handle it. This is mainly due to the fact that we want to
3556 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003557 *
3558 * Return:
3559 * * number of bytes written, even for truncated writes
3560 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003561 */
Al Viro81742022014-04-03 03:17:43 -04003562ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003563{
3564 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003565 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003566 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003567 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003568 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003569 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003570
Linus Torvalds1da177e2005-04-16 15:20:36 -07003571 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003572 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003573 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003574 if (err)
3575 goto out;
3576
Josef Bacikc3b2da32012-03-26 09:59:21 -04003577 err = file_update_time(file);
3578 if (err)
3579 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580
Al Viro2ba48ce2015-04-09 13:52:01 -04003581 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003582 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003583
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003584 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003585 /*
3586 * If the write stopped short of completing, fall back to
3587 * buffered writes. Some filesystems do this for writes to
3588 * holes, for example. For DAX files, a buffered write will
3589 * not succeed (even if it did, DAX does not handle dirty
3590 * page-cache pages correctly).
3591 */
Al Viro0b8def92015-04-07 10:22:53 -04003592 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003594
Al Viro0b8def92015-04-07 10:22:53 -04003595 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003596 /*
Al Viro3b93f912014-02-11 21:34:08 -05003597 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003598 * then we want to return the number of bytes which were
3599 * direct-written, or the error code if that was zero. Note
3600 * that this differs from normal direct-io semantics, which
3601 * will return -EFOO even if some bytes were written.
3602 */
Al Viro60bb4522014-08-08 12:39:16 -04003603 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003604 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003605 goto out;
3606 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003607 /*
3608 * We need to ensure that the page cache pages are written to
3609 * disk and invalidated to preserve the expected O_DIRECT
3610 * semantics.
3611 */
Al Viro3b93f912014-02-11 21:34:08 -05003612 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003613 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003614 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003615 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003616 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003617 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003618 pos >> PAGE_SHIFT,
3619 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003620 } else {
3621 /*
3622 * We don't know how much we wrote, so just return
3623 * the number of bytes which were direct-written
3624 */
3625 }
3626 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003627 written = generic_perform_write(file, from, iocb->ki_pos);
3628 if (likely(written > 0))
3629 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003630 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003631out:
3632 current->backing_dev_info = NULL;
3633 return written ? written : err;
3634}
Al Viro81742022014-04-03 03:17:43 -04003635EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003636
Jan Karae4dd9de2009-08-17 18:10:06 +02003637/**
Al Viro81742022014-04-03 03:17:43 -04003638 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003639 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003640 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003641 *
Al Viro81742022014-04-03 03:17:43 -04003642 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003643 * filesystems. It takes care of syncing the file in case of O_SYNC file
3644 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003645 * Return:
3646 * * negative error code if no data has been written at all of
3647 * vfs_fsync_range() failed for a synchronous write
3648 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003649 */
Al Viro81742022014-04-03 03:17:43 -04003650ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003651{
3652 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003653 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003654 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003655
Al Viro59551022016-01-22 15:40:57 -05003656 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003657 ret = generic_write_checks(iocb, from);
3658 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003659 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003660 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003661
Christoph Hellwige2592212016-04-07 08:52:01 -07003662 if (ret > 0)
3663 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003664 return ret;
3665}
Al Viro81742022014-04-03 03:17:43 -04003666EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003667
David Howellscf9a2ae2006-08-29 19:05:54 +01003668/**
3669 * try_to_release_page() - release old fs-specific metadata on a page
3670 *
3671 * @page: the page which the kernel is trying to free
3672 * @gfp_mask: memory allocation flags (and I/O mode)
3673 *
3674 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003675 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003676 *
David Howells266cf652009-04-03 16:42:36 +01003677 * This may also be called if PG_fscache is set on a page, indicating that the
3678 * page is known to the local caching routines.
3679 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003680 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003681 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003682 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003683 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003684 */
3685int try_to_release_page(struct page *page, gfp_t gfp_mask)
3686{
3687 struct address_space * const mapping = page->mapping;
3688
3689 BUG_ON(!PageLocked(page));
3690 if (PageWriteback(page))
3691 return 0;
3692
3693 if (mapping && mapping->a_ops->releasepage)
3694 return mapping->a_ops->releasepage(page, gfp_mask);
3695 return try_to_free_buffers(page);
3696}
3697
3698EXPORT_SYMBOL(try_to_release_page);