blob: b9d6ebac649dfabe2903961a4528b6a4da213ee3 [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. Shutemov0aa300a2020-12-19 15:19:23 +030045#include <asm/pgalloc.h>
Will Deacon906d3502021-02-10 11:15:11 +000046#include <asm/tlbflush.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080047#include "internal.h"
48
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070049#define CREATE_TRACE_POINTS
50#include <trace/events/filemap.h>
51
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * FIXME: remove all knowledge of the buffer layer from the core VM
54 */
Jan Kara148f9482009-08-17 19:52:36 +020055#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Linus Torvalds1da177e2005-04-16 15:20:36 -070057#include <asm/mman.h>
58
59/*
60 * Shared mappings implemented 30.11.1994. It's not fully working yet,
61 * though.
62 *
63 * Shared mappings now work. 15.8.1995 Bruno.
64 *
65 * finished 'unifying' the page and buffer cache and SMP-threaded the
66 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
67 *
68 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
69 */
70
71/*
72 * Lock ordering:
73 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080074 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070076 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070077 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080079 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080080 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070082 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080083 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070084 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070085 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070087 * ->mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 * ->lock_page (access_process_vm)
89 *
Al Viroccad2362014-02-11 22:36:48 -050090 * ->i_mutex (generic_perform_write)
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070091 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060093 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110094 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070095 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080097 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 * ->anon_vma.lock (vma_adjust)
99 *
100 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700101 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700103 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700104 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700106 * ->i_pages lock (try_to_unmap_one)
Andrey Ryabininf4b7e272019-03-05 15:49:39 -0800107 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
108 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700110 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600111 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100112 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700113 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600114 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100115 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
117 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800118 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700119 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 */
121
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500122static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700123 struct page *page, void *shadow)
124{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500125 XA_STATE(xas, &mapping->i_pages, page->index);
126 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800127
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500128 mapping_set_update(&xas, mapping);
129
130 /* hugetlb pages are represented by a single entry in the xarray */
131 if (!PageHuge(page)) {
132 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700133 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500134 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700135
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700136 VM_BUG_ON_PAGE(!PageLocked(page), page);
137 VM_BUG_ON_PAGE(PageTail(page), page);
138 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700139
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500140 xas_store(&xas, shadow);
141 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200142
Jan Kara23006382017-11-15 17:37:26 -0800143 page->mapping = NULL;
144 /* Leave page->index set: truncation lookup relies upon it */
145
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200146 if (shadow) {
147 mapping->nrexceptional += nr;
148 /*
149 * Make sure the nrexceptional update is committed before
150 * the nrpages update so that final truncate racing
151 * with reclaim does not see both counters 0 at the
152 * same time and miss a shadow entry.
153 */
154 smp_wmb();
155 }
156 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700157}
158
Jan Kara5ecc4d82017-11-15 17:37:29 -0800159static void unaccount_page_cache_page(struct address_space *mapping,
160 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800162 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600164 /*
165 * if we're uptodate, flush out into the cleancache, otherwise
166 * invalidate any existing cleancache entries. We can't leave
167 * stale data around in the cleancache once our page is gone
168 */
169 if (PageUptodate(page) && PageMappedToDisk(page))
170 cleancache_put_page(page);
171 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400172 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600173
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700174 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800175 VM_BUG_ON_PAGE(page_mapped(page), page);
176 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
177 int mapcount;
178
179 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
180 current->comm, page_to_pfn(page));
181 dump_page(page, "still mapped when deleted");
182 dump_stack();
183 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
184
185 mapcount = page_mapcount(page);
186 if (mapping_exiting(mapping) &&
187 page_count(page) >= mapcount + 2) {
188 /*
189 * All vmas have already been torn down, so it's
190 * a good bet that actually the page is unmapped,
191 * and we'd prefer not to leak it: if we're wrong,
192 * some other bad page check should catch it later.
193 */
194 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700195 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800196 }
197 }
198
Jan Kara76253fb2017-11-15 17:37:22 -0800199 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800200 if (PageHuge(page))
201 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800202
Matthew Wilcox (Oracle)6c357842020-08-14 17:30:37 -0700203 nr = thp_nr_pages(page);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800204
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700205 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800206 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700207 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800208 if (PageTransHuge(page))
209 __dec_node_page_state(page, NR_SHMEM_THPS);
Song Liu99cb0db2019-09-23 15:38:00 -0700210 } else if (PageTransHuge(page)) {
211 __dec_node_page_state(page, NR_FILE_THPS);
Song Liu09d91cd2019-09-23 15:38:03 -0700212 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800213 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800214
215 /*
216 * At this point page must be either written or cleaned by
217 * truncate. Dirty page here signals a bug and loss of
218 * unwritten data.
219 *
220 * This fixes dirty accounting after removing the page entirely
221 * but leaves PageDirty set: it has no effect for truncated
222 * page and anyway will be cleared before returning page into
223 * buddy allocator.
224 */
225 if (WARN_ON_ONCE(PageDirty(page)))
226 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
227}
228
229/*
230 * Delete a page from the page cache and free it. Caller has to make
231 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700232 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800233 */
234void __delete_from_page_cache(struct page *page, void *shadow)
235{
236 struct address_space *mapping = page->mapping;
237
238 trace_mm_filemap_delete_from_page_cache(page);
239
240 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500241 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242}
243
Jan Kara59c66c52017-11-15 17:37:18 -0800244static void page_cache_free_page(struct address_space *mapping,
245 struct page *page)
246{
247 void (*freepage)(struct page *);
248
249 freepage = mapping->a_ops->freepage;
250 if (freepage)
251 freepage(page);
252
253 if (PageTransHuge(page) && !PageHuge(page)) {
Matthew Wilcox (Oracle)887b22c2020-10-15 20:05:23 -0700254 page_ref_sub(page, thp_nr_pages(page));
Jan Kara59c66c52017-11-15 17:37:18 -0800255 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
256 } else {
257 put_page(page);
258 }
259}
260
Minchan Kim702cfbf2011-03-22 16:32:43 -0700261/**
262 * delete_from_page_cache - delete page from page cache
263 * @page: the page which the kernel is trying to remove from page cache
264 *
265 * This must be called only on pages that have been verified to be in the page
266 * cache and locked. It will never put the page into the free list, the caller
267 * has a reference on the page.
268 */
269void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700271 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400272 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273
Matt Mackallcd7619d2005-05-01 08:59:01 -0700274 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700275 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700276 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700277 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500278
Jan Kara59c66c52017-11-15 17:37:18 -0800279 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700280}
281EXPORT_SYMBOL(delete_from_page_cache);
282
Jan Karaaa65c292017-11-15 17:37:33 -0800283/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500284 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800285 * @mapping: the mapping to which pages belong
286 * @pvec: pagevec with pages to delete
287 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700288 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700289 * from the mapping. The function expects @pvec to be sorted by page index
290 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700291 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800292 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700293 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800294 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700295 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800296 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500297static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800298 struct pagevec *pvec)
299{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500300 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800301 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700302 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800303 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800304
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500305 mapping_set_update(&xas, mapping);
306 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700307 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800308 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700309
310 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400311 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800312 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700313 /*
314 * A page got inserted in our range? Skip it. We have our
315 * pages locked so they are protected from being removed.
316 * If we see a page whose index is higher than ours, it
317 * means our page has been removed, which shouldn't be
318 * possible because we're holding the PageLock.
319 */
320 if (page != pvec->pages[i]) {
321 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
322 page);
323 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700324 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700325
326 WARN_ON_ONCE(!PageLocked(page));
327
328 if (page->index == xas.xa_index)
329 page->mapping = NULL;
330 /* Leave page->index set: truncation lookup relies on it */
331
332 /*
333 * Move to the next page in the vector if this is a regular
334 * page or the index is of the last sub-page of this compound
335 * page.
336 */
337 if (page->index + compound_nr(page) - 1 == xas.xa_index)
338 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500339 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800340 total_pages++;
341 }
342 mapping->nrpages -= total_pages;
343}
344
345void delete_from_page_cache_batch(struct address_space *mapping,
346 struct pagevec *pvec)
347{
348 int i;
349 unsigned long flags;
350
351 if (!pagevec_count(pvec))
352 return;
353
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700354 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800355 for (i = 0; i < pagevec_count(pvec); i++) {
356 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
357
358 unaccount_page_cache_page(mapping, pvec->pages[i]);
359 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500360 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700361 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800362
363 for (i = 0; i < pagevec_count(pvec); i++)
364 page_cache_free_page(mapping, pvec->pages[i]);
365}
366
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200367int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700368{
369 int ret = 0;
370 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700371 if (test_bit(AS_ENOSPC, &mapping->flags) &&
372 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700373 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700374 if (test_bit(AS_EIO, &mapping->flags) &&
375 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700376 ret = -EIO;
377 return ret;
378}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200379EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700380
Jeff Layton76341ca2017-07-06 07:02:22 -0400381static int filemap_check_and_keep_errors(struct address_space *mapping)
382{
383 /* Check for outstanding write errors */
384 if (test_bit(AS_EIO, &mapping->flags))
385 return -EIO;
386 if (test_bit(AS_ENOSPC, &mapping->flags))
387 return -ENOSPC;
388 return 0;
389}
390
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700392 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700393 * @mapping: address space structure to write
394 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800395 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700396 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700398 * Start writeback against all of a mapping's dirty pages that lie
399 * within the byte offsets <start, end> inclusive.
400 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700402 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 * these two operations is that if a dirty page/buffer is encountered, it must
404 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800405 *
406 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800408int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
409 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410{
411 int ret;
412 struct writeback_control wbc = {
413 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800414 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700415 .range_start = start,
416 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 };
418
Christoph Hellwigf56753a2020-09-24 08:51:40 +0200419 if (!mapping_can_writeback(mapping) ||
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700420 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 return 0;
422
Tejun Heob16b1de2015-06-02 08:39:48 -0600423 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600425 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 return ret;
427}
428
429static inline int __filemap_fdatawrite(struct address_space *mapping,
430 int sync_mode)
431{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700432 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433}
434
435int filemap_fdatawrite(struct address_space *mapping)
436{
437 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
438}
439EXPORT_SYMBOL(filemap_fdatawrite);
440
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400441int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800442 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
444 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
445}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400446EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Randy Dunlap485bb992006-06-23 02:03:49 -0700448/**
449 * filemap_flush - mostly a non-blocking flush
450 * @mapping: target address_space
451 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 * This is a mostly non-blocking flush. Not suitable for data-integrity
453 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800454 *
455 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456 */
457int filemap_flush(struct address_space *mapping)
458{
459 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
460}
461EXPORT_SYMBOL(filemap_flush);
462
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500463/**
464 * filemap_range_has_page - check if a page exists in range.
465 * @mapping: address space within which to check
466 * @start_byte: offset in bytes where the range starts
467 * @end_byte: offset in bytes where the range ends (inclusive)
468 *
469 * Find at least one page in the range supplied, usually used to check if
470 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800471 *
472 * Return: %true if at least one page exists in the specified range,
473 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500474 */
475bool filemap_range_has_page(struct address_space *mapping,
476 loff_t start_byte, loff_t end_byte)
477{
Jan Karaf7b68042017-09-06 16:21:40 -0700478 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500479 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
480 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500481
482 if (end_byte < start_byte)
483 return false;
484
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500485 rcu_read_lock();
486 for (;;) {
487 page = xas_find(&xas, max);
488 if (xas_retry(&xas, page))
489 continue;
490 /* Shadow entries don't count */
491 if (xa_is_value(page))
492 continue;
493 /*
494 * We don't need to try to pin this page; we're about to
495 * release the RCU lock anyway. It is enough to know that
496 * there was a page here recently.
497 */
498 break;
499 }
500 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500501
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500502 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500503}
504EXPORT_SYMBOL(filemap_range_has_page);
505
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400506static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800507 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300509 pgoff_t index = start_byte >> PAGE_SHIFT;
510 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 struct pagevec pvec;
512 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200514 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400515 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516
Mel Gorman86679822017-11-15 17:37:52 -0800517 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800518 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 unsigned i;
520
Jan Kara312e9d22017-11-15 17:35:05 -0800521 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800522 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800523 if (!nr_pages)
524 break;
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 for (i = 0; i < nr_pages; i++) {
527 struct page *page = pvec.pages[i];
528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400530 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531 }
532 pagevec_release(&pvec);
533 cond_resched();
534 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800535}
536
537/**
538 * filemap_fdatawait_range - wait for writeback to complete
539 * @mapping: address space structure to wait for
540 * @start_byte: offset in bytes where the range starts
541 * @end_byte: offset in bytes where the range ends (inclusive)
542 *
543 * Walk the list of under-writeback pages of the given address space
544 * in the given range and wait for all of them. Check error status of
545 * the address space and return it.
546 *
547 * Since the error status of the address space is cleared by this function,
548 * callers are responsible for checking the return value and handling and/or
549 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800550 *
551 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800552 */
553int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
554 loff_t end_byte)
555{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400556 __filemap_fdatawait_range(mapping, start_byte, end_byte);
557 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200559EXPORT_SYMBOL(filemap_fdatawait_range);
560
561/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400562 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
563 * @mapping: address space structure to wait for
564 * @start_byte: offset in bytes where the range starts
565 * @end_byte: offset in bytes where the range ends (inclusive)
566 *
567 * Walk the list of under-writeback pages of the given address space in the
568 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
569 * this function does not clear error status of the address space.
570 *
571 * Use this function if callers don't handle errors themselves. Expected
572 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
573 * fsfreeze(8)
574 */
575int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
576 loff_t start_byte, loff_t end_byte)
577{
578 __filemap_fdatawait_range(mapping, start_byte, end_byte);
579 return filemap_check_and_keep_errors(mapping);
580}
581EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
582
583/**
Jeff Laytona823e452017-07-28 07:24:43 -0400584 * file_fdatawait_range - wait for writeback to complete
585 * @file: file pointing to address space structure to wait for
586 * @start_byte: offset in bytes where the range starts
587 * @end_byte: offset in bytes where the range ends (inclusive)
588 *
589 * Walk the list of under-writeback pages of the address space that file
590 * refers to, in the given range and wait for all of them. Check error
591 * status of the address space vs. the file->f_wb_err cursor and return it.
592 *
593 * Since the error status of the file is advanced by this function,
594 * callers are responsible for checking the return value and handling and/or
595 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800596 *
597 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400598 */
599int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
600{
601 struct address_space *mapping = file->f_mapping;
602
603 __filemap_fdatawait_range(mapping, start_byte, end_byte);
604 return file_check_and_advance_wb_err(file);
605}
606EXPORT_SYMBOL(file_fdatawait_range);
607
608/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800609 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
610 * @mapping: address space structure to wait for
611 *
612 * Walk the list of under-writeback pages of the given address space
613 * and wait for all of them. Unlike filemap_fdatawait(), this function
614 * does not clear error status of the address space.
615 *
616 * Use this function if callers don't handle errors themselves. Expected
617 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
618 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800619 *
620 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800621 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400622int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800623{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400624 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400625 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800626}
Jeff Layton76341ca2017-07-06 07:02:22 -0400627EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800628
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700629/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400630static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700632 if (dax_mapping(mapping))
633 return mapping->nrexceptional;
634
635 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637
Randy Dunlap485bb992006-06-23 02:03:49 -0700638/**
639 * filemap_write_and_wait_range - write out & wait on a file range
640 * @mapping: the address_space for the pages
641 * @lstart: offset in bytes where the range starts
642 * @lend: offset in bytes where the range ends (inclusive)
643 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800644 * Write out and wait upon file offsets lstart->lend, inclusive.
645 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300646 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800647 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800648 *
649 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800650 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651int filemap_write_and_wait_range(struct address_space *mapping,
652 loff_t lstart, loff_t lend)
653{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800654 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655
Jeff Layton9326c9b2017-07-26 10:21:11 -0400656 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800657 err = __filemap_fdatawrite_range(mapping, lstart, lend,
658 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800659 /*
660 * Even if the above returned error, the pages may be
661 * written partially (e.g. -ENOSPC), so we wait for it.
662 * But the -EIO is special case, it may indicate the worst
663 * thing (e.g. bug) happened, so we avoid waiting for it.
664 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800665 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200666 int err2 = filemap_fdatawait_range(mapping,
667 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800668 if (!err)
669 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400670 } else {
671 /* Clear any previously stored errors */
672 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800673 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700674 } else {
675 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800677 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678}
Chris Masonf6995582009-04-15 13:22:37 -0400679EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680
Jeff Layton5660e132017-07-06 07:02:25 -0400681void __filemap_set_wb_err(struct address_space *mapping, int err)
682{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400683 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400684
685 trace_filemap_set_wb_err(mapping, eseq);
686}
687EXPORT_SYMBOL(__filemap_set_wb_err);
688
689/**
690 * file_check_and_advance_wb_err - report wb error (if any) that was previously
691 * and advance wb_err to current one
692 * @file: struct file on which the error is being reported
693 *
694 * When userland calls fsync (or something like nfsd does the equivalent), we
695 * want to report any writeback errors that occurred since the last fsync (or
696 * since the file was opened if there haven't been any).
697 *
698 * Grab the wb_err from the mapping. If it matches what we have in the file,
699 * then just quickly return 0. The file is all caught up.
700 *
701 * If it doesn't match, then take the mapping value, set the "seen" flag in
702 * it and try to swap it into place. If it works, or another task beat us
703 * to it with the new value, then update the f_wb_err and return the error
704 * portion. The error at this point must be reported via proper channels
705 * (a'la fsync, or NFS COMMIT operation, etc.).
706 *
707 * While we handle mapping->wb_err with atomic operations, the f_wb_err
708 * value is protected by the f_lock since we must ensure that it reflects
709 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800710 *
711 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400712 */
713int file_check_and_advance_wb_err(struct file *file)
714{
715 int err = 0;
716 errseq_t old = READ_ONCE(file->f_wb_err);
717 struct address_space *mapping = file->f_mapping;
718
719 /* Locklessly handle the common case where nothing has changed */
720 if (errseq_check(&mapping->wb_err, old)) {
721 /* Something changed, must use slow path */
722 spin_lock(&file->f_lock);
723 old = file->f_wb_err;
724 err = errseq_check_and_advance(&mapping->wb_err,
725 &file->f_wb_err);
726 trace_file_check_and_advance_wb_err(file, old);
727 spin_unlock(&file->f_lock);
728 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700729
730 /*
731 * We're mostly using this function as a drop in replacement for
732 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
733 * that the legacy code would have had on these flags.
734 */
735 clear_bit(AS_EIO, &mapping->flags);
736 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400737 return err;
738}
739EXPORT_SYMBOL(file_check_and_advance_wb_err);
740
741/**
742 * file_write_and_wait_range - write out & wait on a file range
743 * @file: file pointing to address_space with pages
744 * @lstart: offset in bytes where the range starts
745 * @lend: offset in bytes where the range ends (inclusive)
746 *
747 * Write out and wait upon file offsets lstart->lend, inclusive.
748 *
749 * Note that @lend is inclusive (describes the last byte to be written) so
750 * that this function can be used to write to the very end-of-file (end = -1).
751 *
752 * After writing out and waiting on the data, we check and advance the
753 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800754 *
755 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400756 */
757int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
758{
759 int err = 0, err2;
760 struct address_space *mapping = file->f_mapping;
761
Jeff Layton9326c9b2017-07-26 10:21:11 -0400762 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400763 err = __filemap_fdatawrite_range(mapping, lstart, lend,
764 WB_SYNC_ALL);
765 /* See comment of filemap_write_and_wait() */
766 if (err != -EIO)
767 __filemap_fdatawait_range(mapping, lstart, lend);
768 }
769 err2 = file_check_and_advance_wb_err(file);
770 if (!err)
771 err = err2;
772 return err;
773}
774EXPORT_SYMBOL(file_write_and_wait_range);
775
Randy Dunlap485bb992006-06-23 02:03:49 -0700776/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700777 * replace_page_cache_page - replace a pagecache page with a new one
778 * @old: page to be replaced
779 * @new: page to replace with
780 * @gfp_mask: allocation mode
781 *
782 * This function replaces a page in the pagecache with a new one. On
783 * success it acquires the pagecache reference for the new page and
784 * drops it for the old page. Both the old and new pages must be
785 * locked. This function does not add the new page to the LRU, the
786 * caller must do that.
787 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500788 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800789 *
790 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700791 */
792int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
793{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500794 struct address_space *mapping = old->mapping;
795 void (*freepage)(struct page *) = mapping->a_ops->freepage;
796 pgoff_t offset = old->index;
797 XA_STATE(xas, &mapping->i_pages, offset);
798 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700799
Sasha Levin309381fea2014-01-23 15:52:54 -0800800 VM_BUG_ON_PAGE(!PageLocked(old), old);
801 VM_BUG_ON_PAGE(!PageLocked(new), new);
802 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700803
Matthew Wilcox74d60952017-11-17 10:01:45 -0500804 get_page(new);
805 new->mapping = mapping;
806 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700807
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700808 mem_cgroup_migrate(old, new);
809
Matthew Wilcox74d60952017-11-17 10:01:45 -0500810 xas_lock_irqsave(&xas, flags);
811 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700812
Matthew Wilcox74d60952017-11-17 10:01:45 -0500813 old->mapping = NULL;
814 /* hugetlb pages do not participate in page cache accounting. */
815 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700816 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500817 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700818 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500819 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700820 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500821 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700822 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500823 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500824 if (freepage)
825 freepage(old);
826 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700827
Matthew Wilcox74d60952017-11-17 10:01:45 -0500828 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700829}
830EXPORT_SYMBOL_GPL(replace_page_cache_page);
831
Andrew Morton16c0cc02020-12-11 13:36:27 -0800832noinline int __add_to_page_cache_locked(struct page *page,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700833 struct address_space *mapping,
Linus Torvaldsc4cf4982020-10-16 11:31:55 -0700834 pgoff_t offset, gfp_t gfp,
Alexei Starovoitov76cd6172020-08-27 15:01:10 -0700835 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500837 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700838 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700839 int error;
Waiman Long032f8e02021-02-04 18:32:45 -0800840 bool charged = false;
Nick Piggine2867812008-07-25 19:45:30 -0700841
Sasha Levin309381fea2014-01-23 15:52:54 -0800842 VM_BUG_ON_PAGE(!PageLocked(page), page);
843 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500844 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700845
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300846 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700847 page->mapping = mapping;
848 page->index = offset;
849
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700850 if (!huge) {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700851 error = mem_cgroup_charge(page, current->mm, gfp);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700852 if (error)
853 goto error;
Waiman Long032f8e02021-02-04 18:32:45 -0800854 charged = true;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700855 }
856
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700857 gfp &= GFP_RECLAIM_MASK;
858
Matthew Wilcox74d60952017-11-17 10:01:45 -0500859 do {
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700860 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
861 void *entry, *old = NULL;
862
863 if (order > thp_order(page))
864 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
865 order, gfp);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500866 xas_lock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700867 xas_for_each_conflict(&xas, entry) {
868 old = entry;
869 if (!xa_is_value(entry)) {
870 xas_set_err(&xas, -EEXIST);
871 goto unlock;
872 }
873 }
874
875 if (old) {
876 if (shadowp)
877 *shadowp = old;
878 /* entry may have been split before we acquired lock */
879 order = xa_get_order(xas.xa, xas.xa_index);
880 if (order > thp_order(page)) {
881 xas_split(&xas, old, order);
882 xas_reset(&xas);
883 }
884 }
885
Matthew Wilcox74d60952017-11-17 10:01:45 -0500886 xas_store(&xas, page);
887 if (xas_error(&xas))
888 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700889
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700890 if (old)
Matthew Wilcox74d60952017-11-17 10:01:45 -0500891 mapping->nrexceptional--;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500892 mapping->nrpages++;
893
894 /* hugetlb pages do not participate in page cache accounting */
895 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700896 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500897unlock:
898 xas_unlock_irq(&xas);
Matthew Wilcox (Oracle)198b62f2020-10-15 20:05:20 -0700899 } while (xas_nomem(&xas, gfp));
Matthew Wilcox74d60952017-11-17 10:01:45 -0500900
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700901 if (xas_error(&xas)) {
902 error = xas_error(&xas);
Waiman Long032f8e02021-02-04 18:32:45 -0800903 if (charged)
904 mem_cgroup_uncharge(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500905 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700906 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500907
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700908 trace_mm_filemap_add_to_page_cache(page);
909 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500910error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700911 page->mapping = NULL;
912 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300913 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700914 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700916ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700917
918/**
919 * add_to_page_cache_locked - add a locked page to the pagecache
920 * @page: page to add
921 * @mapping: the page's address_space
922 * @offset: page index
923 * @gfp_mask: page allocation mode
924 *
925 * This function is used to add a page to the pagecache. It must be locked.
926 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800927 *
928 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700929 */
930int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
931 pgoff_t offset, gfp_t gfp_mask)
932{
933 return __add_to_page_cache_locked(page, mapping, offset,
934 gfp_mask, NULL);
935}
Nick Piggine2867812008-07-25 19:45:30 -0700936EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
938int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400939 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940{
Johannes Weinera5289102014-04-03 14:47:51 -0700941 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700942 int ret;
943
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800944 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700945 ret = __add_to_page_cache_locked(page, mapping, offset,
946 gfp_mask, &shadow);
947 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800948 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700949 else {
950 /*
951 * The page might have been evicted from cache only
952 * recently, in which case it should be activated like
953 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700954 * The exception is pages getting rewritten; evicting other
955 * data from the working set, only to cache data that will
956 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700957 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700958 WARN_ON_ONCE(PageActive(page));
959 if (!(gfp_mask & __GFP_WRITE) && shadow)
960 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700961 lru_cache_add(page);
962 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 return ret;
964}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300965EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966
Paul Jackson44110fe2006-03-24 03:16:04 -0800967#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700968struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800969{
Miao Xiec0ff7452010-05-24 14:32:08 -0700970 int n;
971 struct page *page;
972
Paul Jackson44110fe2006-03-24 03:16:04 -0800973 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700974 unsigned int cpuset_mems_cookie;
975 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700976 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700977 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700978 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700979 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700980
Miao Xiec0ff7452010-05-24 14:32:08 -0700981 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800982 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700983 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800984}
Nick Piggin2ae88142006-10-28 10:38:23 -0700985EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800986#endif
987
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988/*
989 * In order to wait for pages to become available there must be
990 * waitqueues associated with pages. By using a hash table of
991 * waitqueues where the bucket discipline is to maintain all
992 * waiters on the same queue and wake all when any of the pages
993 * become available, and for the woken contexts to check to be
994 * sure the appropriate page became available, this saves space
995 * at a cost of "thundering herd" phenomena during rare hash
996 * collisions.
997 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000998#define PAGE_WAIT_TABLE_BITS 8
999#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1000static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1001
1002static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003{
Nicholas Piggin62906022016-12-25 13:00:30 +10001004 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005}
Nicholas Piggin62906022016-12-25 13:00:30 +10001006
1007void __init pagecache_init(void)
1008{
1009 int i;
1010
1011 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1012 init_waitqueue_head(&page_wait_table[i]);
1013
1014 page_writeback_init();
1015}
1016
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001017/*
1018 * The page wait code treats the "wait->flags" somewhat unusually, because
Linus Torvalds5868ec22020-09-20 10:38:47 -07001019 * we have multiple different kinds of waits, not just the usual "exclusive"
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001020 * one.
1021 *
1022 * We have:
1023 *
1024 * (a) no special bits set:
1025 *
1026 * We're just waiting for the bit to be released, and when a waker
1027 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1028 * and remove it from the wait queue.
1029 *
1030 * Simple and straightforward.
1031 *
1032 * (b) WQ_FLAG_EXCLUSIVE:
1033 *
1034 * The waiter is waiting to get the lock, and only one waiter should
1035 * be woken up to avoid any thundering herd behavior. We'll set the
1036 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1037 *
1038 * This is the traditional exclusive wait.
1039 *
Linus Torvalds5868ec22020-09-20 10:38:47 -07001040 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001041 *
1042 * The waiter is waiting to get the bit, and additionally wants the
1043 * lock to be transferred to it for fair lock behavior. If the lock
1044 * cannot be taken, we stop walking the wait queue without waking
1045 * the waiter.
1046 *
1047 * This is the "fair lock handoff" case, and in addition to setting
1048 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1049 * that it now has the lock.
1050 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001051static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001052{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001053 unsigned int flags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001054 struct wait_page_key *key = arg;
1055 struct wait_page_queue *wait_page
1056 = container_of(wait, struct wait_page_queue, wait);
1057
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07001058 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +10001059 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001060
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001061 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001062 * If it's a lock handoff wait, we get the bit for it, and
1063 * stop walking (and do not wake it up) if we can't.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001064 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001065 flags = wait->flags;
1066 if (flags & WQ_FLAG_EXCLUSIVE) {
1067 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001068 return -1;
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001069 if (flags & WQ_FLAG_CUSTOM) {
1070 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1071 return -1;
1072 flags |= WQ_FLAG_DONE;
1073 }
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001074 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001075
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001076 /*
1077 * We are holding the wait-queue lock, but the waiter that
1078 * is waiting for this will be checking the flags without
1079 * any locking.
1080 *
1081 * So update the flags atomically, and wake up the waiter
1082 * afterwards to avoid any races. This store-release pairs
1083 * with the load-acquire in wait_on_page_bit_common().
1084 */
1085 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001086 wake_up_state(wait->private, mode);
1087
1088 /*
1089 * Ok, we have successfully done what we're waiting for,
1090 * and we can unconditionally remove the wait entry.
1091 *
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001092 * Note that this pairs with the "finish_wait()" in the
1093 * waiter, and has to be the absolute last thing we do.
1094 * After this list_del_init(&wait->entry) the wait entry
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001095 * might be de-allocated and the process might even have
1096 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001097 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001098 list_del_init_careful(&wait->entry);
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001099 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001100}
1101
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001102static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001103{
1104 wait_queue_head_t *q = page_waitqueue(page);
1105 struct wait_page_key key;
1106 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001107 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001108
1109 key.page = page;
1110 key.bit_nr = bit_nr;
1111 key.page_match = 0;
1112
Tim Chen11a19c72017-08-25 09:13:55 -07001113 bookmark.flags = 0;
1114 bookmark.private = NULL;
1115 bookmark.func = NULL;
1116 INIT_LIST_HEAD(&bookmark.entry);
1117
Nicholas Piggin62906022016-12-25 13:00:30 +10001118 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001119 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1120
1121 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1122 /*
1123 * Take a breather from holding the lock,
1124 * allow pages that finish wake up asynchronously
1125 * to acquire the lock and remove themselves
1126 * from wait queue
1127 */
1128 spin_unlock_irqrestore(&q->lock, flags);
1129 cpu_relax();
1130 spin_lock_irqsave(&q->lock, flags);
1131 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1132 }
1133
Nicholas Piggin62906022016-12-25 13:00:30 +10001134 /*
1135 * It is possible for other pages to have collided on the waitqueue
1136 * hash, so in that case check for a page match. That prevents a long-
1137 * term waiter
1138 *
1139 * It is still possible to miss a case here, when we woke page waiters
1140 * and removed them from the waitqueue, but there are still other
1141 * page waiters.
1142 */
1143 if (!waitqueue_active(q) || !key.page_match) {
1144 ClearPageWaiters(page);
1145 /*
1146 * It's possible to miss clearing Waiters here, when we woke
1147 * our page waiters, but the hashed waitqueue has waiters for
1148 * other pages on it.
1149 *
1150 * That's okay, it's a rare case. The next waker will clear it.
1151 */
1152 }
1153 spin_unlock_irqrestore(&q->lock, flags);
1154}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001155
1156static void wake_up_page(struct page *page, int bit)
1157{
1158 if (!PageWaiters(page))
1159 return;
1160 wake_up_page_bit(page, bit);
1161}
Nicholas Piggin62906022016-12-25 13:00:30 +10001162
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001163/*
1164 * A choice of three behaviors for wait_on_page_bit_common():
1165 */
1166enum behavior {
1167 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1168 * __lock_page() waiting on then setting PG_locked.
1169 */
1170 SHARED, /* Hold ref to page and check the bit when woken, like
1171 * wait_on_page_writeback() waiting on PG_writeback.
1172 */
1173 DROP, /* Drop ref to page before wait, no check when woken,
1174 * like put_and_wait_on_page_locked() on PG_locked.
1175 */
1176};
1177
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001178/*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001179 * Attempt to check (or get) the page bit, and mark us done
1180 * if successful.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001181 */
1182static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1183 struct wait_queue_entry *wait)
1184{
1185 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1186 if (test_and_set_bit(bit_nr, &page->flags))
1187 return false;
1188 } else if (test_bit(bit_nr, &page->flags))
1189 return false;
1190
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001191 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001192 return true;
1193}
1194
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001195/* How many times do we accept lock stealing from under a waiter? */
1196int sysctl_page_lock_unfairness = 5;
1197
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001198static inline __sched int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001199 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001200{
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001201 int unfairness = sysctl_page_lock_unfairness;
Nicholas Piggin62906022016-12-25 13:00:30 +10001202 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001203 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001204 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001205 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001206 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001207
Johannes Weinereb414682018-10-26 15:06:27 -07001208 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001209 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001210 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001211 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001212 delayacct = true;
1213 }
Johannes Weinereb414682018-10-26 15:06:27 -07001214 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001215 thrashing = true;
1216 }
1217
Nicholas Piggin62906022016-12-25 13:00:30 +10001218 init_wait(wait);
1219 wait->func = wake_page_function;
1220 wait_page.page = page;
1221 wait_page.bit_nr = bit_nr;
1222
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001223repeat:
1224 wait->flags = 0;
1225 if (behavior == EXCLUSIVE) {
1226 wait->flags = WQ_FLAG_EXCLUSIVE;
1227 if (--unfairness < 0)
1228 wait->flags |= WQ_FLAG_CUSTOM;
1229 }
1230
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001231 /*
1232 * Do one last check whether we can get the
1233 * page bit synchronously.
1234 *
1235 * Do the SetPageWaiters() marking before that
1236 * to let any waker we _just_ missed know they
1237 * need to wake us up (otherwise they'll never
1238 * even go to the slow case that looks at the
1239 * page queue), and add ourselves to the wait
1240 * queue if we need to sleep.
1241 *
1242 * This part needs to be done under the queue
1243 * lock to avoid races.
1244 */
1245 spin_lock_irq(&q->lock);
1246 SetPageWaiters(page);
1247 if (!trylock_page_bit_common(page, bit_nr, wait))
1248 __add_wait_queue_entry_tail(q, wait);
1249 spin_unlock_irq(&q->lock);
1250
1251 /*
1252 * From now on, all the logic will be based on
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001253 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1254 * see whether the page bit testing has already
1255 * been done by the wake function.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001256 *
1257 * We can drop our reference to the page.
1258 */
1259 if (behavior == DROP)
1260 put_page(page);
1261
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001262 /*
1263 * Note that until the "finish_wait()", or until
1264 * we see the WQ_FLAG_WOKEN flag, we need to
1265 * be very careful with the 'wait->flags', because
1266 * we may race with a waker that sets them.
1267 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001268 for (;;) {
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001269 unsigned int flags;
1270
Nicholas Piggin62906022016-12-25 13:00:30 +10001271 set_current_state(state);
1272
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001273 /* Loop until we've been woken or interrupted */
1274 flags = smp_load_acquire(&wait->flags);
1275 if (!(flags & WQ_FLAG_WOKEN)) {
1276 if (signal_pending_state(state, current))
1277 break;
1278
1279 io_schedule();
1280 continue;
1281 }
1282
1283 /* If we were non-exclusive, we're done */
1284 if (behavior != EXCLUSIVE)
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001285 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001286
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001287 /* If the waker got the lock for us, we're done */
1288 if (flags & WQ_FLAG_DONE)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001289 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001290
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001291 /*
1292 * Otherwise, if we're getting the lock, we need to
1293 * try to get it ourselves.
1294 *
1295 * And if that fails, we'll have to retry this all.
1296 */
1297 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1298 goto repeat;
1299
1300 wait->flags |= WQ_FLAG_DONE;
1301 break;
Nicholas Piggin62906022016-12-25 13:00:30 +10001302 }
1303
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001304 /*
1305 * If a signal happened, this 'finish_wait()' may remove the last
1306 * waiter from the wait-queues, but the PageWaiters bit will remain
1307 * set. That's ok. The next wakeup will take care of it, and trying
1308 * to do it here would be difficult and prone to races.
1309 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001310 finish_wait(q, wait);
1311
Johannes Weinereb414682018-10-26 15:06:27 -07001312 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001313 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001314 delayacct_thrashing_end();
1315 psi_memstall_leave(&pflags);
1316 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001317
Nicholas Piggin62906022016-12-25 13:00:30 +10001318 /*
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001319 * NOTE! The wait->flags weren't stable until we've done the
1320 * 'finish_wait()', and we could have exited the loop above due
1321 * to a signal, and had a wakeup event happen after the signal
1322 * test but before the 'finish_wait()'.
1323 *
1324 * So only after the finish_wait() can we reliably determine
1325 * if we got woken up or not, so we can now figure out the final
1326 * return value based on that state without races.
1327 *
1328 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1329 * waiter, but an exclusive one requires WQ_FLAG_DONE.
Nicholas Piggin62906022016-12-25 13:00:30 +10001330 */
Linus Torvalds5ef64cc2020-09-13 14:05:35 -07001331 if (behavior == EXCLUSIVE)
1332 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001333
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001334 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001335}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001337__sched void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338{
Nicholas Piggin62906022016-12-25 13:00:30 +10001339 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001340 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341}
1342EXPORT_SYMBOL(wait_on_page_bit);
1343
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001344__sched int wait_on_page_bit_killable(struct page *page, int bit_nr)
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001345{
Nicholas Piggin62906022016-12-25 13:00:30 +10001346 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001347 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001348}
David Howells4343d002017-11-02 15:27:52 +00001349EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001350
Jens Axboedd3e6d52020-05-22 09:12:09 -06001351static int __wait_on_page_locked_async(struct page *page,
1352 struct wait_page_queue *wait, bool set)
1353{
1354 struct wait_queue_head *q = page_waitqueue(page);
1355 int ret = 0;
1356
1357 wait->page = page;
1358 wait->bit_nr = PG_locked;
1359
1360 spin_lock_irq(&q->lock);
1361 __add_wait_queue_entry_tail(q, &wait->wait);
1362 SetPageWaiters(page);
1363 if (set)
1364 ret = !trylock_page(page);
1365 else
1366 ret = PageLocked(page);
1367 /*
1368 * If we were succesful now, we know we're still on the
1369 * waitqueue as we're still under the lock. This means it's
1370 * safe to remove and return success, we know the callback
1371 * isn't going to trigger.
1372 */
1373 if (!ret)
1374 __remove_wait_queue(q, &wait->wait);
1375 else
1376 ret = -EIOCBQUEUED;
1377 spin_unlock_irq(&q->lock);
1378 return ret;
1379}
1380
Jens Axboe1a0a7852020-05-22 09:18:38 -06001381static int wait_on_page_locked_async(struct page *page,
1382 struct wait_page_queue *wait)
1383{
1384 if (!PageLocked(page))
1385 return 0;
1386 return __wait_on_page_locked_async(compound_head(page), wait, false);
1387}
1388
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001390 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1391 * @page: The page to wait for.
1392 *
1393 * The caller should hold a reference on @page. They expect the page to
1394 * become unlocked relatively soon, but do not wish to hold up migration
1395 * (for example) by holding the reference while waiting for the page to
1396 * come unlocked. After this function returns, the caller should not
1397 * dereference @page.
1398 */
1399void put_and_wait_on_page_locked(struct page *page)
1400{
1401 wait_queue_head_t *q;
1402
1403 page = compound_head(page);
1404 q = page_waitqueue(page);
1405 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1406}
1407
1408/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001409 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001410 * @page: Page defining the wait queue of interest
1411 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001412 *
1413 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1414 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001415void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001416{
1417 wait_queue_head_t *q = page_waitqueue(page);
1418 unsigned long flags;
1419
1420 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001421 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001422 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001423 spin_unlock_irqrestore(&q->lock, flags);
1424}
1425EXPORT_SYMBOL_GPL(add_page_wait_queue);
1426
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001427#ifndef clear_bit_unlock_is_negative_byte
1428
1429/*
1430 * PG_waiters is the high bit in the same byte as PG_lock.
1431 *
1432 * On x86 (and on many other architectures), we can clear PG_lock and
1433 * test the sign bit at the same time. But if the architecture does
1434 * not support that special operation, we just do this all by hand
1435 * instead.
1436 *
1437 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001438 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001439 * in the same byte as PG_locked.
1440 */
1441static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1442{
1443 clear_bit_unlock(nr, mem);
1444 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001445 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001446}
1447
1448#endif
1449
David Howells385e1ca5f2009-04-03 16:42:39 +01001450/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001451 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 * @page: the page
1453 *
Miaohe Lin0e9aa672020-10-15 20:09:58 -07001454 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001456 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1458 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001459 * Note that this depends on PG_waiters being the sign bit in the byte
1460 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1461 * clear the PG_locked bit and test PG_waiters at the same time fairly
1462 * portably (architectures that do LL/SC can test any bit, while x86 can
1463 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001465void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001467 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001468 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001469 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001470 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1471 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472}
1473EXPORT_SYMBOL(unlock_page);
1474
Randy Dunlap485bb992006-06-23 02:03:49 -07001475/**
1476 * end_page_writeback - end writeback against a page
1477 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 */
1479void end_page_writeback(struct page *page)
1480{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001481 /*
1482 * TestClearPageReclaim could be used here but it is an atomic
1483 * operation and overkill in this particular case. Failing to
1484 * shuffle a page marked for immediate reclaim is too mild to
1485 * justify taking an atomic operation penalty at the end of
1486 * ever page writeback.
1487 */
1488 if (PageReclaim(page)) {
1489 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001490 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001491 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001492
Hugh Dickins073861e2020-11-24 08:46:43 -08001493 /*
1494 * Writeback does not hold a page reference of its own, relying
1495 * on truncation to wait for the clearing of PG_writeback.
1496 * But here we must make sure that the page is not freed and
1497 * reused before the wake_up_page().
1498 */
1499 get_page(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001500 if (!test_clear_page_writeback(page))
1501 BUG();
1502
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001503 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 wake_up_page(page, PG_writeback);
Hugh Dickins073861e2020-11-24 08:46:43 -08001505 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506}
1507EXPORT_SYMBOL(end_page_writeback);
1508
Matthew Wilcox57d99842014-06-04 16:07:45 -07001509/*
1510 * After completing I/O on a page, call this routine to update the page
1511 * flags appropriately
1512 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001513void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001514{
Jens Axboec11f0c02016-08-05 08:11:04 -06001515 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001516 if (!err) {
1517 SetPageUptodate(page);
1518 } else {
1519 ClearPageUptodate(page);
1520 SetPageError(page);
1521 }
1522 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001523 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001524 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001525 struct address_space *mapping;
1526
Matthew Wilcox57d99842014-06-04 16:07:45 -07001527 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001528 mapping = page_mapping(page);
1529 if (mapping)
1530 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001531 }
1532 end_page_writeback(page);
1533 }
1534}
1535EXPORT_SYMBOL_GPL(page_endio);
1536
Randy Dunlap485bb992006-06-23 02:03:49 -07001537/**
1538 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001539 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001540 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001541__sched void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542{
Nicholas Piggin62906022016-12-25 13:00:30 +10001543 struct page *page = compound_head(__page);
1544 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001545 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1546 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547}
1548EXPORT_SYMBOL(__lock_page);
1549
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001550__sched int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001551{
Nicholas Piggin62906022016-12-25 13:00:30 +10001552 struct page *page = compound_head(__page);
1553 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001554 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1555 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001556}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001557EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001558
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001559__sched int __lock_page_async(struct page *page, struct wait_page_queue *wait)
Jens Axboedd3e6d52020-05-22 09:12:09 -06001560{
1561 return __wait_on_page_locked_async(page, wait, true);
1562}
1563
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001564/*
1565 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001566 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001567 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001568 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001569 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001570 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001571 *
1572 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001573 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001574 */
Jimmy Shiudec0fd42020-11-03 00:16:37 +08001575__sched int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
Michel Lespinassed065bd82010-10-26 14:21:57 -07001576 unsigned int flags)
1577{
Peter Xu4064b982020-04-01 21:08:45 -07001578 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001579 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001580 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001581 * even though return 0.
1582 */
1583 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1584 return 0;
1585
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001586 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001587 if (flags & FAULT_FLAG_KILLABLE)
1588 wait_on_page_locked_killable(page);
1589 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001590 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001591 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001592 } else {
1593 if (flags & FAULT_FLAG_KILLABLE) {
1594 int ret;
1595
1596 ret = __lock_page_killable(page);
1597 if (ret) {
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001598 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001599 return 0;
1600 }
1601 } else
1602 __lock_page(page);
1603 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001604 }
1605}
1606
Randy Dunlap485bb992006-06-23 02:03:49 -07001607/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001608 * page_cache_next_miss() - Find the next gap in the page cache.
1609 * @mapping: Mapping.
1610 * @index: Index.
1611 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001612 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001613 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1614 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001615 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001616 * This function may be called under the rcu_read_lock. However, this will
1617 * not atomically search a snapshot of the cache at a single point in time.
1618 * For example, if a gap is created at index 5, then subsequently a gap is
1619 * created at index 10, page_cache_next_miss covering both indices may
1620 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001621 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001622 * Return: The index of the gap if found, otherwise an index outside the
1623 * range specified (in which case 'return - index >= max_scan' will be true).
1624 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001625 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001626pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001627 pgoff_t index, unsigned long max_scan)
1628{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001629 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001630
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001631 while (max_scan--) {
1632 void *entry = xas_next(&xas);
1633 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001634 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001635 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001636 break;
1637 }
1638
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001639 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001640}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001641EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001642
1643/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001644 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001645 * @mapping: Mapping.
1646 * @index: Index.
1647 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001648 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001649 * Search the range [max(index - max_scan + 1, 0), index] for the
1650 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001651 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001652 * This function may be called under the rcu_read_lock. However, this will
1653 * not atomically search a snapshot of the cache at a single point in time.
1654 * For example, if a gap is created at index 10, then subsequently a gap is
1655 * created at index 5, page_cache_prev_miss() covering both indices may
1656 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001657 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001658 * Return: The index of the gap if found, otherwise an index outside the
1659 * range specified (in which case 'index - return >= max_scan' will be true).
1660 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001661 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001662pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001663 pgoff_t index, unsigned long max_scan)
1664{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001665 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001666
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001667 while (max_scan--) {
1668 void *entry = xas_prev(&xas);
1669 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001670 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001671 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001672 break;
1673 }
1674
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001675 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001676}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001677EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001678
1679/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001680 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001681 * @mapping: the address_space to search
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001682 * @index: The page cache index.
Randy Dunlap485bb992006-06-23 02:03:49 -07001683 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001684 * Looks up the page cache slot at @mapping & @offset. If there is a
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001685 * page cache page, the head page is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001686 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001687 * If the slot holds a shadow entry of a previously evicted page, or a
1688 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001689 *
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001690 * Return: The head page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 */
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001692struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693{
Matthew Wilcox (Oracle)a6de4b42020-10-13 16:51:34 -07001694 XA_STATE(xas, &mapping->i_pages, index);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001695 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696
Nick Piggina60637c2008-07-25 19:45:31 -07001697 rcu_read_lock();
1698repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001699 xas_reset(&xas);
1700 page = xas_load(&xas);
1701 if (xas_retry(&xas, page))
1702 goto repeat;
1703 /*
1704 * A shadow entry of a recently evicted page, or a swap entry from
1705 * shmem/tmpfs. Return it without attempting to raise page count.
1706 */
1707 if (!page || xa_is_value(page))
1708 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001709
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001710 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001711 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001712
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001713 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001714 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001715 * This is part of the lockless pagecache protocol. See
1716 * include/linux/pagemap.h for details.
1717 */
1718 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001719 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001720 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001721 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001722out:
Nick Piggina60637c2008-07-25 19:45:31 -07001723 rcu_read_unlock();
1724
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 return page;
1726}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727
Randy Dunlap485bb992006-06-23 02:03:49 -07001728/**
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001729 * find_lock_entry - Locate and lock a page cache entry.
1730 * @mapping: The address_space to search.
1731 * @index: The page cache index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001732 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001733 * Looks up the page at @mapping & @index. If there is a page in the
1734 * cache, the head page is returned locked and with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001735 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001736 * If the slot holds a shadow entry of a previously evicted page, or a
1737 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001738 *
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001739 * Context: May sleep.
1740 * Return: The head page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001741 */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001742struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743{
1744 struct page *page;
1745
Linus Torvalds1da177e2005-04-16 15:20:36 -07001746repeat:
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001747 page = find_get_entry(mapping, index);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001748 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001749 lock_page(page);
1750 /* Has the page been truncated? */
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001751 if (unlikely(page->mapping != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001752 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001753 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001754 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 }
Matthew Wilcox (Oracle)63ec1972020-10-13 16:51:38 -07001756 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 return page;
1759}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001760
1761/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001762 * pagecache_get_page - Find and get a reference to a page.
1763 * @mapping: The address_space to search.
1764 * @index: The page index.
1765 * @fgp_flags: %FGP flags modify how the page is returned.
1766 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001767 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001768 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001769 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001770 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001771 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001772 * * %FGP_ACCESSED - The page will be marked accessed.
1773 * * %FGP_LOCK - The page is returned locked.
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001774 * * %FGP_HEAD - If the page is present and a THP, return the head page
1775 * rather than the exact page specified by the index.
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001776 * * %FGP_CREAT - If no page is present then a new page is allocated using
1777 * @gfp_mask and added to the page cache and the VM's LRU list.
1778 * The page is returned locked and with an increased refcount.
1779 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1780 * page is already in cache. If the page was allocated, unlock it before
1781 * returning so the caller can do the same dance.
Yang Shi605cad82020-08-06 23:19:58 -07001782 * * %FGP_WRITE - The page will be written
1783 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1784 * * %FGP_NOWAIT - Don't get blocked by page lock
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001785 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001786 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1787 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001788 *
1789 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001790 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001791 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001792 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001793struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1794 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795{
Nick Piggineb2be182007-10-16 01:24:57 -07001796 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001799 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001800 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001801 page = NULL;
1802 if (!page)
1803 goto no_page;
1804
1805 if (fgp_flags & FGP_LOCK) {
1806 if (fgp_flags & FGP_NOWAIT) {
1807 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001808 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001809 return NULL;
1810 }
1811 } else {
1812 lock_page(page);
1813 }
1814
1815 /* Has the page been truncated? */
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001816 if (unlikely(page->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001817 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001818 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001819 goto repeat;
1820 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001821 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001822 }
1823
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001824 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001825 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001826 else if (fgp_flags & FGP_WRITE) {
1827 /* Clear idle flag for buffer write */
1828 if (page_is_idle(page))
1829 clear_page_idle(page);
1830 }
Matthew Wilcox (Oracle)a8cf7f22020-10-13 16:51:41 -07001831 if (!(fgp_flags & FGP_HEAD))
1832 page = find_subpage(page, index);
Mel Gorman2457aec2014-06-04 16:10:31 -07001833
1834no_page:
1835 if (!page && (fgp_flags & FGP_CREAT)) {
1836 int err;
Christoph Hellwigf56753a2020-09-24 08:51:40 +02001837 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001838 gfp_mask |= __GFP_WRITE;
1839 if (fgp_flags & FGP_NOFS)
1840 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001841
Michal Hocko45f87de2014-12-29 20:30:35 +01001842 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001843 if (!page)
1844 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001845
Josef Bacika75d4c32019-03-13 11:44:14 -07001846 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001847 fgp_flags |= FGP_LOCK;
1848
Hugh Dickinseb39d612014-08-06 16:06:43 -07001849 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001850 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001851 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001852
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001853 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001854 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001855 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001856 page = NULL;
1857 if (err == -EEXIST)
1858 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001860
1861 /*
1862 * add_to_page_cache_lru locks the page, and for mmap we expect
1863 * an unlocked page.
1864 */
1865 if (page && (fgp_flags & FGP_FOR_MMAP))
1866 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001868
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 return page;
1870}
Mel Gorman2457aec2014-06-04 16:10:31 -07001871EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001872
1873/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001874 * find_get_entries - gang pagecache lookup
1875 * @mapping: The address_space to search
1876 * @start: The starting page cache index
1877 * @nr_entries: The maximum number of entries
1878 * @entries: Where the resulting entries are placed
1879 * @indices: The cache indices corresponding to the entries in @entries
1880 *
1881 * find_get_entries() will search for and return a group of up to
1882 * @nr_entries entries in the mapping. The entries are placed at
1883 * @entries. find_get_entries() takes a reference against any actual
1884 * pages it returns.
1885 *
1886 * The search returns a group of mapping-contiguous page cache entries
1887 * with ascending indexes. There may be holes in the indices due to
1888 * not-present pages.
1889 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001890 * Any shadow entries of evicted pages, or swap entries from
1891 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001892 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001893 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1894 * stops at that page: the caller is likely to have a better way to handle
1895 * the compound page as a whole, and then skip its extent, than repeatedly
1896 * calling find_get_entries() to return all its tails.
1897 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001898 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001899 */
1900unsigned find_get_entries(struct address_space *mapping,
1901 pgoff_t start, unsigned int nr_entries,
1902 struct page **entries, pgoff_t *indices)
1903{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001904 XA_STATE(xas, &mapping->i_pages, start);
1905 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001906 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001907
1908 if (!nr_entries)
1909 return 0;
1910
1911 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001912 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001913 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001914 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001915 /*
1916 * A shadow entry of a recently evicted page, a swap
1917 * entry from shmem/tmpfs or a DAX entry. Return it
1918 * without attempting to raise page count.
1919 */
1920 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001921 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001922
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001923 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001924 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001925
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001926 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001927 if (unlikely(page != xas_reload(&xas)))
1928 goto put_page;
1929
Hugh Dickins71725ed2020-04-06 20:07:57 -07001930 /*
1931 * Terminate early on finding a THP, to allow the caller to
1932 * handle it all at once; but continue if this is hugetlbfs.
1933 */
1934 if (PageTransHuge(page) && !PageHuge(page)) {
1935 page = find_subpage(page, xas.xa_index);
1936 nr_entries = ret + 1;
1937 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001938export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001939 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001940 entries[ret] = page;
1941 if (++ret == nr_entries)
1942 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001943 continue;
1944put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001945 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001946retry:
1947 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001948 }
1949 rcu_read_unlock();
1950 return ret;
1951}
1952
1953/**
Jan Karab947cee2017-09-06 16:21:21 -07001954 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 * @mapping: The address_space to search
1956 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001957 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958 * @nr_pages: The maximum number of pages
1959 * @pages: Where the resulting pages are placed
1960 *
Jan Karab947cee2017-09-06 16:21:21 -07001961 * find_get_pages_range() will search for and return a group of up to @nr_pages
1962 * pages in the mapping starting at index @start and up to index @end
1963 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1964 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965 *
1966 * The search returns a group of mapping-contiguous pages with ascending
1967 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001968 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001970 * Return: the number of pages which were found. If this number is
1971 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001972 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 */
Jan Karab947cee2017-09-06 16:21:21 -07001974unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1975 pgoff_t end, unsigned int nr_pages,
1976 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001978 XA_STATE(xas, &mapping->i_pages, *start);
1979 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001980 unsigned ret = 0;
1981
1982 if (unlikely(!nr_pages))
1983 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984
Nick Piggina60637c2008-07-25 19:45:31 -07001985 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001986 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001987 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001988 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001989 /* Skip over shadow, swap and DAX entries */
1990 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001991 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001992
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001993 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001994 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001995
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001996 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001997 if (unlikely(page != xas_reload(&xas)))
1998 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001999
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002000 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07002001 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002002 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07002003 goto out;
2004 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002005 continue;
2006put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002007 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002008retry:
2009 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002010 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002011
Jan Karab947cee2017-09-06 16:21:21 -07002012 /*
2013 * We come here when there is no page beyond @end. We take care to not
2014 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04002015 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07002016 * already broken anyway.
2017 */
2018 if (end == (pgoff_t)-1)
2019 *start = (pgoff_t)-1;
2020 else
2021 *start = end + 1;
2022out:
Nick Piggina60637c2008-07-25 19:45:31 -07002023 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07002024
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 return ret;
2026}
2027
Jens Axboeebf43502006-04-27 08:46:01 +02002028/**
2029 * find_get_pages_contig - gang contiguous pagecache lookup
2030 * @mapping: The address_space to search
2031 * @index: The starting page index
2032 * @nr_pages: The maximum number of pages
2033 * @pages: Where the resulting pages are placed
2034 *
2035 * find_get_pages_contig() works exactly like find_get_pages(), except
2036 * that the returned number of pages are guaranteed to be contiguous.
2037 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002038 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02002039 */
2040unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2041 unsigned int nr_pages, struct page **pages)
2042{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002043 XA_STATE(xas, &mapping->i_pages, index);
2044 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002045 unsigned int ret = 0;
2046
2047 if (unlikely(!nr_pages))
2048 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02002049
Nick Piggina60637c2008-07-25 19:45:31 -07002050 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002051 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002052 if (xas_retry(&xas, page))
2053 continue;
2054 /*
2055 * If the entry has been swapped out, we can stop looking.
2056 * No current caller is looking for DAX entries.
2057 */
2058 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002059 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07002060
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002061 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002062 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002063
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002064 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002065 if (unlikely(page != xas_reload(&xas)))
2066 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002067
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002068 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002069 if (++ret == nr_pages)
2070 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002071 continue;
2072put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002073 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04002074retry:
2075 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02002076 }
Nick Piggina60637c2008-07-25 19:45:31 -07002077 rcu_read_unlock();
2078 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02002079}
David Howellsef71c152007-05-09 02:33:44 -07002080EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02002081
Randy Dunlap485bb992006-06-23 02:03:49 -07002082/**
Jan Kara72b045a2017-11-15 17:34:33 -08002083 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07002084 * @mapping: the address_space to search
2085 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08002086 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07002087 * @tag: the tag index
2088 * @nr_pages: the maximum number of pages
2089 * @pages: where the resulting pages are placed
2090 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07002092 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08002093 *
2094 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095 */
Jan Kara72b045a2017-11-15 17:34:33 -08002096unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002097 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08002098 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002100 XA_STATE(xas, &mapping->i_pages, *index);
2101 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07002102 unsigned ret = 0;
2103
2104 if (unlikely(!nr_pages))
2105 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106
Nick Piggina60637c2008-07-25 19:45:31 -07002107 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002108 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002109 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07002110 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002111 /*
2112 * Shadow entries should never be tagged, but this iteration
2113 * is lockless so there is a window for page reclaim to evict
2114 * a page we saw tagged. Skip over it.
2115 */
2116 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07002117 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07002118
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002119 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002120 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07002121
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002122 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002123 if (unlikely(page != xas_reload(&xas)))
2124 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07002125
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002126 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08002127 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08002128 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08002129 goto out;
2130 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002131 continue;
2132put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002133 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002134retry:
2135 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002136 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002137
Jan Kara72b045a2017-11-15 17:34:33 -08002138 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002139 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002140 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002141 * iteration when there is a page at index -1 but that is already
2142 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002143 */
2144 if (end == (pgoff_t)-1)
2145 *index = (pgoff_t)-1;
2146 else
2147 *index = end + 1;
2148out:
Nick Piggina60637c2008-07-25 19:45:31 -07002149 rcu_read_unlock();
2150
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 return ret;
2152}
Jan Kara72b045a2017-11-15 17:34:33 -08002153EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002154
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002155/*
2156 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2157 * a _large_ part of the i/o request. Imagine the worst scenario:
2158 *
2159 * ---R__________________________________________B__________
2160 * ^ reading here ^ bad block(assume 4k)
2161 *
2162 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2163 * => failing the whole request => read(R) => read(R+1) =>
2164 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2165 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2166 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2167 *
2168 * It is going insane. Fix it by quickly scaling down the readahead size.
2169 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002170static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002171{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002172 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002173}
2174
Randy Dunlap485bb992006-06-23 02:03:49 -07002175/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002176 * generic_file_buffered_read - generic file read routine
2177 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05002178 * @iter: data destination
2179 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07002180 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07002182 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 *
2184 * This is really ugly. But the goto's actually try to clarify some
2185 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002186 *
2187 * Return:
2188 * * total number of bytes copied, including those the were already @written
2189 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002190 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002191ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002192 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002194 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002195 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002197 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002198 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002199 pgoff_t index;
2200 pgoff_t last_index;
2201 pgoff_t prev_index;
2202 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002203 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002204 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205
Wei Fangc2a97372016-10-07 17:01:52 -07002206 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002207 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002208 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2209
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002210 index = *ppos >> PAGE_SHIFT;
2211 prev_index = ra->prev_pos >> PAGE_SHIFT;
2212 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2213 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2214 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215
Jens Axboe13bd6912020-10-17 08:31:29 -06002216 /*
2217 * If we've already successfully copied some data, then we
2218 * can no longer safely return -EIOCBQUEUED. Hence mark
2219 * an async read NOWAIT at that point.
2220 */
2221 if (written && (iocb->ki_flags & IOCB_WAITQ))
2222 iocb->ki_flags |= IOCB_NOWAIT;
2223
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 for (;;) {
2225 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002226 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002227 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 unsigned long nr, ret;
2229
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002232 if (fatal_signal_pending(current)) {
2233 error = -EINTR;
2234 goto out;
2235 }
2236
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002238 if (!page) {
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002239 if (iocb->ki_flags & IOCB_NOIO)
Milosz Tanski3239d832017-08-29 16:13:19 +02002240 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002241 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002242 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002243 index, last_index - index);
2244 page = find_get_page(mapping, index);
2245 if (unlikely(page == NULL))
2246 goto no_cached_page;
2247 }
2248 if (PageReadahead(page)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002249 if (iocb->ki_flags & IOCB_NOIO) {
2250 put_page(page);
2251 goto out;
2252 }
Rusty Russellcf914a72007-07-19 01:48:08 -07002253 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002254 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002255 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002256 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002257 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07002258 /*
2259 * See comment in do_read_cache_page on why
2260 * wait_on_page_locked is used to avoid unnecessarily
2261 * serialisations and why it's safe.
2262 */
Jens Axboe1a0a7852020-05-22 09:18:38 -06002263 if (iocb->ki_flags & IOCB_WAITQ) {
2264 if (written) {
2265 put_page(page);
2266 goto out;
2267 }
2268 error = wait_on_page_locked_async(page,
2269 iocb->ki_waitq);
2270 } else {
2271 if (iocb->ki_flags & IOCB_NOWAIT) {
2272 put_page(page);
2273 goto would_block;
2274 }
2275 error = wait_on_page_locked_killable(page);
2276 }
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002277 if (unlikely(error))
2278 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002279 if (PageUptodate(page))
2280 goto page_ok;
2281
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002282 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002283 !mapping->a_ops->is_partially_uptodate)
2284 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002285 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002286 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002287 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002288 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002289 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002290 /* Did it get truncated before we got the lock? */
2291 if (!page->mapping)
2292 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002293 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002294 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002295 goto page_not_up_to_date_locked;
2296 unlock_page(page);
2297 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002299 /*
2300 * i_size must be checked after we know the page is Uptodate.
2301 *
2302 * Checking i_size after the check allows us to calculate
2303 * the correct value for "nr", which means the zero-filled
2304 * part of the page is not copied back to userspace (unless
2305 * another truncate extends the file - this is desired though).
2306 */
2307
2308 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002309 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002310 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002311 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002312 goto out;
2313 }
2314
2315 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002316 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002317 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002318 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002319 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002320 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002321 goto out;
2322 }
2323 }
2324 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325
2326 /* If users can be writing to this page using arbitrary
2327 * virtual addresses, take care about potential aliasing
2328 * before reading the page on the kernel side.
2329 */
2330 if (mapping_writably_mapped(mapping))
2331 flush_dcache_page(page);
2332
2333 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002334 * When a sequential read accesses a page several times,
2335 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 */
Jan Karaec0f1632007-05-06 14:49:25 -07002337 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002338 mark_page_accessed(page);
2339 prev_index = index;
2340
2341 /*
2342 * Ok, we have the page, and it's up-to-date, so
2343 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002344 */
Al Viro6e58e792014-02-03 17:07:03 -05002345
2346 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002347 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002348 index += offset >> PAGE_SHIFT;
2349 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002350 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002351
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002352 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002353 written += ret;
2354 if (!iov_iter_count(iter))
2355 goto out;
2356 if (ret < nr) {
2357 error = -EFAULT;
2358 goto out;
2359 }
2360 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002361
2362page_not_up_to_date:
2363 /* Get exclusive access to the page ... */
Jens Axboe0abed7c2020-11-16 13:36:24 -07002364 if (iocb->ki_flags & IOCB_WAITQ) {
2365 if (written) {
2366 put_page(page);
2367 goto out;
2368 }
Jens Axboe1a0a7852020-05-22 09:18:38 -06002369 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002370 } else {
Jens Axboe1a0a7852020-05-22 09:18:38 -06002371 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002372 }
Oleg Nesterov85462322008-06-08 21:20:43 +04002373 if (unlikely(error))
2374 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002375
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002376page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002377 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002378 if (!page->mapping) {
2379 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002380 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002381 continue;
2382 }
2383
2384 /* Did somebody else fill it already? */
2385 if (PageUptodate(page)) {
2386 unlock_page(page);
2387 goto page_ok;
2388 }
2389
2390readpage:
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002391 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002392 unlock_page(page);
2393 put_page(page);
2394 goto would_block;
2395 }
Jeff Moyer91803b42010-05-26 11:49:40 -04002396 /*
2397 * A previous I/O error may have been due to temporary
2398 * failures, eg. multipath errors.
2399 * PG_error will be set again if readpage fails.
2400 */
2401 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002402 /* Start the actual read. The read will unlock the page. */
2403 error = mapping->a_ops->readpage(filp, page);
2404
Zach Brown994fc28c2005-12-15 14:28:17 -08002405 if (unlikely(error)) {
2406 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002407 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002408 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002409 goto find_page;
2410 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002411 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002412 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002413
2414 if (!PageUptodate(page)) {
Jens Axboe0abed7c2020-11-16 13:36:24 -07002415 if (iocb->ki_flags & IOCB_WAITQ) {
2416 if (written) {
2417 put_page(page);
2418 goto out;
2419 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002420 error = lock_page_async(page, iocb->ki_waitq);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002421 } else {
Hao Xuc8d317a2020-09-29 20:00:45 +08002422 error = lock_page_killable(page);
Jens Axboe0abed7c2020-11-16 13:36:24 -07002423 }
Hao Xuc8d317a2020-09-29 20:00:45 +08002424
Oleg Nesterov85462322008-06-08 21:20:43 +04002425 if (unlikely(error))
2426 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002427 if (!PageUptodate(page)) {
2428 if (page->mapping == NULL) {
2429 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002430 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002431 */
2432 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002433 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002434 goto find_page;
2435 }
2436 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002437 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002438 error = -EIO;
2439 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 }
2441 unlock_page(page);
2442 }
2443
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 goto page_ok;
2445
2446readpage_error:
2447 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002448 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 goto out;
2450
2451no_cached_page:
2452 /*
2453 * Ok, it wasn't cached, so we need to create a new
2454 * page..
2455 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002456 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002457 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002458 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002459 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002461 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002462 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002464 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002465 if (error == -EEXIST) {
2466 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002468 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002469 goto out;
2470 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 goto readpage;
2472 }
2473
Milosz Tanski3239d832017-08-29 16:13:19 +02002474would_block:
2475 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002476out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002477 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002478 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002479 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002481 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002482 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002483 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002485EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002486
Randy Dunlap485bb992006-06-23 02:03:49 -07002487/**
Al Viro6abd2322014-04-04 14:20:57 -04002488 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002489 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002490 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002491 *
Al Viro6abd2322014-04-04 14:20:57 -04002492 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002493 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002494 *
2495 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2496 * be returned when no data can be read without waiting for I/O requests
2497 * to complete; it doesn't prevent readahead.
2498 *
2499 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2500 * requests shall be made for the read or for readahead. When no data
2501 * can be read, -EAGAIN shall be returned. When readahead would be
2502 * triggered, a partial, possibly empty read shall be returned.
2503 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002504 * Return:
2505 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002506 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507 */
2508ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002509generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002511 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002512 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002513
2514 if (!count)
2515 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516
Al Viro2ba48ce2015-04-09 13:52:01 -04002517 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002518 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002519 struct address_space *mapping = file->f_mapping;
2520 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002521 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522
Linus Torvalds1da177e2005-04-16 15:20:36 -07002523 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002524 if (iocb->ki_flags & IOCB_NOWAIT) {
2525 if (filemap_range_has_page(mapping, iocb->ki_pos,
2526 iocb->ki_pos + count - 1))
2527 return -EAGAIN;
2528 } else {
2529 retval = filemap_write_and_wait_range(mapping,
2530 iocb->ki_pos,
2531 iocb->ki_pos + count - 1);
2532 if (retval < 0)
2533 goto out;
2534 }
Al Viroed978a82014-03-05 22:53:04 -05002535
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002536 file_accessed(file);
2537
Al Viro5ecda132017-04-13 14:13:36 -04002538 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002539 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002540 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002541 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002542 }
Al Viro5b47d592017-05-08 13:54:47 -04002543 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002544
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002545 /*
2546 * Btrfs can have a short DIO read if we encounter
2547 * compressed extents, so if there was an error, or if
2548 * we've already read everything we wanted to, or if
2549 * there was a short read because we hit EOF, go ahead
2550 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002551 * the rest of the read. Buffered reads will not work for
2552 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002553 */
Al Viro5ecda132017-04-13 14:13:36 -04002554 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002555 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002556 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557 }
2558
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002559 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002560out:
2561 return retval;
2562}
Al Viroed978a82014-03-05 22:53:04 -05002563EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002567/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002568 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002569 * @vmf - the vm_fault for this fault.
2570 * @page - the page to lock.
2571 * @fpin - the pointer to the file we may pin (or is already pinned).
2572 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002573 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002574 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002575 * 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 -07002576 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002577 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002578static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2579 struct file **fpin)
2580{
2581 if (trylock_page(page))
2582 return 1;
2583
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002584 /*
2585 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002586 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002587 * is supposed to work. We have way too many special cases..
2588 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002589 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2590 return 0;
2591
2592 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2593 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2594 if (__lock_page_killable(page)) {
2595 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002596 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002597 * but all fault_handlers only check for fatal signals
2598 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002599 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002600 */
2601 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002602 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002603 return 0;
2604 }
2605 } else
2606 __lock_page(page);
2607 return 1;
2608}
2609
2610
2611/*
2612 * Synchronous readahead happens when we don't even find a page in the page
2613 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2614 * to drop the mmap sem we return the file that was pinned in order for us to do
2615 * that. If we didn't pin a file then we return NULL. The file that is
2616 * returned needs to be fput()'ed when we're done with it.
2617 */
2618static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002619{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002620 struct file *file = vmf->vma->vm_file;
2621 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002622 struct address_space *mapping = file->f_mapping;
David Howellsdb660d42020-10-15 20:06:31 -07002623 DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002624 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002625 unsigned int mmap_miss;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002626
2627 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002628 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002629 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002630 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002631 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002632
Josef Bacik2a1180f2019-03-13 11:44:18 -07002633 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002634 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002635 page_cache_sync_ra(&ractl, ra, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002636 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002637 }
2638
Andi Kleen207d04b2011-05-24 17:12:29 -07002639 /* Avoid banging the cache line if not needed */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002640 mmap_miss = READ_ONCE(ra->mmap_miss);
2641 if (mmap_miss < MMAP_LOTSAMISS * 10)
2642 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002643
2644 /*
2645 * Do we miss much more than hit in this file? If so,
2646 * stop bothering with read-ahead. It will only hurt.
2647 */
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002648 if (mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002649 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002650
Wu Fengguangd30a1102009-06-16 15:31:30 -07002651 /*
2652 * mmap read-around
2653 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002654 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
David Howellsdb660d42020-10-15 20:06:31 -07002655 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002656 ra->size = ra->ra_pages;
2657 ra->async_size = ra->ra_pages / 4;
David Howellsdb660d42020-10-15 20:06:31 -07002658 ractl._index = ra->start;
2659 do_page_cache_ra(&ractl, ra->size, ra->async_size);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002660 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002661}
2662
2663/*
2664 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002665 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002666 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002667 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002668static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2669 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002670{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002671 struct file *file = vmf->vma->vm_file;
2672 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002673 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002674 struct file *fpin = NULL;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002675 unsigned int mmap_miss;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002676 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002677
2678 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002679 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002680 return fpin;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002681 mmap_miss = READ_ONCE(ra->mmap_miss);
2682 if (mmap_miss)
2683 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002684 if (PageReadahead(page)) {
2685 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002686 page_cache_async_readahead(mapping, ra, file,
2687 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002688 }
2689 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002690}
2691
Randy Dunlap485bb992006-06-23 02:03:49 -07002692/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002693 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002694 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002695 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002696 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697 * mapped memory region to read in file data during a page fault.
2698 *
2699 * The goto's are kind of ugly, but this streamlines the normal case of having
2700 * it in the page cache, and handles the special cases reasonably without
2701 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002702 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002703 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002704 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002705 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002706 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002707 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002708 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002709 * has not been released.
2710 *
2711 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002712 *
2713 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002715vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716{
2717 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002718 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002719 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720 struct address_space *mapping = file->f_mapping;
2721 struct file_ra_state *ra = &file->f_ra;
2722 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002723 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002724 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002725 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002726 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002728 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2729 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002730 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731
Linus Torvalds1da177e2005-04-16 15:20:36 -07002732 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002733 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002735 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002736 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002737 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002738 * We found the page, so try async readahead before
2739 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002741 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002742 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002743 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002744 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002745 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002746 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002747 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002748retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002749 page = pagecache_get_page(mapping, offset,
2750 FGP_CREAT|FGP_FOR_MMAP,
2751 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002752 if (!page) {
2753 if (fpin)
2754 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002755 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002756 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002757 }
2758
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002759 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2760 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002761
2762 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002763 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002764 unlock_page(page);
2765 put_page(page);
2766 goto retry_find;
2767 }
Song Liu520e5ba2019-09-23 15:37:50 -07002768 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002769
Linus Torvalds1da177e2005-04-16 15:20:36 -07002770 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002771 * We have a locked page in the page cache, now we need to check
2772 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002773 */
Nick Piggind00806b2007-07-19 01:46:57 -07002774 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775 goto page_not_uptodate;
2776
Linus Torvaldsef00e082009-06-16 15:31:25 -07002777 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002778 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002779 * time to return to the upper layer and have it re-find the vma and
2780 * redo the fault.
2781 */
2782 if (fpin) {
2783 unlock_page(page);
2784 goto out_retry;
2785 }
2786
2787 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002788 * Found the page and have a reference on it.
2789 * We must recheck i_size under page lock.
2790 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002791 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2792 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002793 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002794 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002795 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002796 }
2797
Nick Piggind0217ac2007-07-19 01:47:03 -07002798 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002799 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800
Linus Torvalds1da177e2005-04-16 15:20:36 -07002801page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 /*
2803 * Umm, take care of errors if the page isn't up-to-date.
2804 * Try to re-read it _once_. We do this synchronously,
2805 * because there really aren't any performance issues here
2806 * and we need to check for errors.
2807 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002808 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002809 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002810 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002811 if (!error) {
2812 wait_on_page_locked(page);
2813 if (!PageUptodate(page))
2814 error = -EIO;
2815 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002816 if (fpin)
2817 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002818 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002819
2820 if (!error || error == AOP_TRUNCATED_PAGE)
2821 goto retry_find;
2822
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002823 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002824 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002825
2826out_retry:
2827 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002828 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002829 * re-find the vma and come back and find our hopefully still populated
2830 * page.
2831 */
2832 if (page)
2833 put_page(page);
2834 if (fpin)
2835 fput(fpin);
2836 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002837}
2838EXPORT_SYMBOL(filemap_fault);
2839
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002840static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002841{
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002842 struct mm_struct *mm = vmf->vma->vm_mm;
2843
2844 /* Huge page is mapped? No need to proceed. */
2845 if (pmd_trans_huge(*vmf->pmd)) {
2846 unlock_page(page);
2847 put_page(page);
2848 return true;
2849 }
2850
2851 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
2852 vm_fault_t ret = do_set_pmd(vmf, page);
2853 if (!ret) {
2854 /* The page is mapped successfully, reference consumed. */
2855 unlock_page(page);
2856 return true;
2857 }
2858 }
2859
2860 if (pmd_none(*vmf->pmd)) {
2861 vmf->ptl = pmd_lock(mm, vmf->pmd);
2862 if (likely(pmd_none(*vmf->pmd))) {
2863 mm_inc_nr_ptes(mm);
2864 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
2865 vmf->prealloc_pte = NULL;
2866 }
2867 spin_unlock(vmf->ptl);
2868 }
2869
2870 /* See comment in handle_pte_fault() */
2871 if (pmd_devmap_trans_unstable(vmf->pmd)) {
2872 unlock_page(page);
2873 put_page(page);
2874 return true;
2875 }
2876
2877 return false;
2878}
2879
2880static struct page *next_uptodate_page(struct page *page,
2881 struct address_space *mapping,
2882 struct xa_state *xas, pgoff_t end_pgoff)
2883{
2884 unsigned long max_idx;
2885
2886 do {
2887 if (!page)
2888 return NULL;
2889 if (xas_retry(xas, page))
2890 continue;
2891 if (xa_is_value(page))
2892 continue;
2893 if (PageLocked(page))
2894 continue;
2895 if (!page_cache_get_speculative(page))
2896 continue;
2897 /* Has the page moved or been split? */
2898 if (unlikely(page != xas_reload(xas)))
2899 goto skip;
2900 if (!PageUptodate(page) || PageReadahead(page))
2901 goto skip;
2902 if (PageHWPoison(page))
2903 goto skip;
2904 if (!trylock_page(page))
2905 goto skip;
2906 if (page->mapping != mapping)
2907 goto unlock;
2908 if (!PageUptodate(page))
2909 goto unlock;
2910 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2911 if (xas->xa_index >= max_idx)
2912 goto unlock;
2913 return page;
2914unlock:
2915 unlock_page(page);
2916skip:
2917 put_page(page);
2918 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
2919
2920 return NULL;
2921}
2922
2923static inline struct page *first_map_page(struct address_space *mapping,
2924 struct xa_state *xas,
2925 pgoff_t end_pgoff)
2926{
2927 return next_uptodate_page(xas_find(xas, end_pgoff),
2928 mapping, xas, end_pgoff);
2929}
2930
2931static inline struct page *next_map_page(struct address_space *mapping,
2932 struct xa_state *xas,
2933 pgoff_t end_pgoff)
2934{
2935 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
2936 mapping, xas, end_pgoff);
2937}
2938
2939vm_fault_t filemap_map_pages(struct vm_fault *vmf,
2940 pgoff_t start_pgoff, pgoff_t end_pgoff)
2941{
2942 struct vm_area_struct *vma = vmf->vma;
2943 struct file *file = vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002944 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002945 pgoff_t last_pgoff = start_pgoff;
Will Deacondb6cf102021-01-14 15:24:19 +00002946 unsigned long addr;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002947 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002948 struct page *head, *page;
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002949 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002950 vm_fault_t ret = 0;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002951
2952 rcu_read_lock();
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002953 head = first_map_page(mapping, &xas, end_pgoff);
2954 if (!head)
2955 goto out;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002956
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002957 if (filemap_map_pmd(vmf, head)) {
2958 ret = VM_FAULT_NOPAGE;
2959 goto out;
2960 }
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002961
Will Deacondb6cf102021-01-14 15:24:19 +00002962 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
2963 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002964 do {
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002965 page = find_subpage(head, xas.xa_index);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002966 if (PageHWPoison(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002967 goto unlock;
2968
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002969 if (mmap_miss > 0)
2970 mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002971
Will Deacondb6cf102021-01-14 15:24:19 +00002972 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002973 vmf->pte += xas.xa_index - last_pgoff;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002974 last_pgoff = xas.xa_index;
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002975
2976 if (!pte_none(*vmf->pte))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002977 goto unlock;
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002978
Will Deaconef3b7322020-11-24 18:48:26 +00002979 /* We're about to handle the fault */
Will Deacondb6cf102021-01-14 15:24:19 +00002980 if (vmf->address == addr)
Will Deaconef3b7322020-11-24 18:48:26 +00002981 ret = VM_FAULT_NOPAGE;
Will Deaconef3b7322020-11-24 18:48:26 +00002982
Will Deacondb6cf102021-01-14 15:24:19 +00002983 do_set_pte(vmf, page, addr);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002984 /* no need to invalidate: a not-present page won't be cached */
Will Deacondb6cf102021-01-14 15:24:19 +00002985 update_mmu_cache(vma, addr, vmf->pte);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002986 unlock_page(head);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002987 continue;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002988unlock:
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002989 unlock_page(head);
Matthew Wilcox (Oracle)27a83a62020-10-13 16:51:44 -07002990 put_page(head);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002991 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
2992 pte_unmap_unlock(vmf->pte, vmf->ptl);
2993out:
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002994 rcu_read_unlock();
Kirill A. Shutemove630bfa2020-08-14 17:31:27 -07002995 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
Kirill A. Shutemov0aa300a2020-12-19 15:19:23 +03002996 return ret;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002997}
2998EXPORT_SYMBOL(filemap_map_pages);
2999
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003000vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02003001{
3002 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08003003 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07003004 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02003005
Jan Kara14da9202012-06-12 16:20:37 +02003006 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08003007 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003008 lock_page(page);
3009 if (page->mapping != inode->i_mapping) {
3010 unlock_page(page);
3011 ret = VM_FAULT_NOPAGE;
3012 goto out;
3013 }
Jan Kara14da9202012-06-12 16:20:37 +02003014 /*
3015 * We mark the page dirty already here so that when freeze is in
3016 * progress, we are guaranteed that writeback during freezing will
3017 * see the dirty page and writeprotect it again.
3018 */
3019 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08003020 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003021out:
Jan Kara14da9202012-06-12 16:20:37 +02003022 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02003023 return ret;
3024}
Jan Kara4fcf1c62012-06-12 16:20:29 +02003025
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04003026const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07003027 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07003028 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02003029 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003030};
3031
3032/* This is used for a general mmap of a disk file */
3033
3034int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3035{
3036 struct address_space *mapping = file->f_mapping;
3037
3038 if (!mapping->a_ops->readpage)
3039 return -ENOEXEC;
3040 file_accessed(file);
3041 vma->vm_ops = &generic_file_vm_ops;
3042 return 0;
3043}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003044
3045/*
3046 * This is for filesystems which do not implement ->writepage.
3047 */
3048int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3049{
3050 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3051 return -EINVAL;
3052 return generic_file_mmap(file, vma);
3053}
3054#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07003055vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann45397222018-04-13 15:35:27 -07003056{
Souptick Joarder4b96a372018-10-26 15:04:03 -07003057 return VM_FAULT_SIGBUS;
Arnd Bergmann45397222018-04-13 15:35:27 -07003058}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003059int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3060{
3061 return -ENOSYS;
3062}
3063int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
3064{
3065 return -ENOSYS;
3066}
3067#endif /* CONFIG_MMU */
3068
Arnd Bergmann45397222018-04-13 15:35:27 -07003069EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003070EXPORT_SYMBOL(generic_file_mmap);
3071EXPORT_SYMBOL(generic_file_readonly_mmap);
3072
Sasha Levin67f9fd92014-04-03 14:48:18 -07003073static struct page *wait_on_page_read(struct page *page)
3074{
3075 if (!IS_ERR(page)) {
3076 wait_on_page_locked(page);
3077 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003078 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07003079 page = ERR_PTR(-EIO);
3080 }
3081 }
3082 return page;
3083}
3084
Mel Gorman32b63522016-03-15 14:55:36 -07003085static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07003086 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003087 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003088 void *data,
3089 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090{
Nick Piggineb2be182007-10-16 01:24:57 -07003091 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003092 int err;
3093repeat:
3094 page = find_get_page(mapping, index);
3095 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08003096 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003097 if (!page)
3098 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003099 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07003100 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003101 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07003102 if (err == -EEXIST)
3103 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05003104 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003105 return ERR_PTR(err);
3106 }
Mel Gorman32b63522016-03-15 14:55:36 -07003107
3108filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003109 if (filler)
3110 err = filler(data, page);
3111 else
3112 err = mapping->a_ops->readpage(data, page);
3113
Linus Torvalds1da177e2005-04-16 15:20:36 -07003114 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003115 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003116 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003117 }
Mel Gorman32b63522016-03-15 14:55:36 -07003118
3119 page = wait_on_page_read(page);
3120 if (IS_ERR(page))
3121 return page;
3122 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003123 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003124 if (PageUptodate(page))
3125 goto out;
3126
Mel Gormanebded022016-03-15 14:55:39 -07003127 /*
Miaohe Lin0e9aa672020-10-15 20:09:58 -07003128 * Page is not up to date and may be locked due to one of the following
Mel Gormanebded022016-03-15 14:55:39 -07003129 * case a: Page is being filled and the page lock is held
3130 * case b: Read/write error clearing the page uptodate status
3131 * case c: Truncation in progress (page locked)
3132 * case d: Reclaim in progress
3133 *
3134 * Case a, the page will be up to date when the page is unlocked.
3135 * There is no need to serialise on the page lock here as the page
3136 * is pinned so the lock gives no additional protection. Even if the
Randy Dunlapce89fddf2020-08-11 18:32:53 -07003137 * page is truncated, the data is still valid if PageUptodate as
Mel Gormanebded022016-03-15 14:55:39 -07003138 * it's a race vs truncate race.
3139 * Case b, the page will not be up to date
3140 * Case c, the page may be truncated but in itself, the data may still
3141 * be valid after IO completes as it's a read vs truncate race. The
3142 * operation must restart if the page is not uptodate on unlock but
3143 * otherwise serialising on page lock to stabilise the mapping gives
3144 * no additional guarantees to the caller as the page lock is
3145 * released before return.
3146 * Case d, similar to truncation. If reclaim holds the page lock, it
3147 * will be a race with remove_mapping that determines if the mapping
3148 * is valid on unlock but otherwise the data is valid and there is
3149 * no need to serialise with page lock.
3150 *
3151 * As the page lock gives no additional guarantee, we optimistically
3152 * wait on the page to be unlocked and check if it's up to date and
3153 * use the page if it is. Otherwise, the page lock is required to
3154 * distinguish between the different cases. The motivation is that we
3155 * avoid spurious serialisations and wakeups when multiple processes
3156 * wait on the same page for IO to complete.
3157 */
3158 wait_on_page_locked(page);
3159 if (PageUptodate(page))
3160 goto out;
3161
3162 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07003164
3165 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003166 if (!page->mapping) {
3167 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003168 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003169 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003170 }
Mel Gormanebded022016-03-15 14:55:39 -07003171
3172 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07003173 if (PageUptodate(page)) {
3174 unlock_page(page);
3175 goto out;
3176 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07003177
3178 /*
3179 * A previous I/O error may have been due to temporary
3180 * failures.
3181 * Clear page error before actual read, PG_error will be
3182 * set again if read page fails.
3183 */
3184 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07003185 goto filler;
3186
David Howellsc855ff32007-05-09 13:42:20 +01003187out:
Nick Piggin6fe69002007-05-06 14:49:04 -07003188 mark_page_accessed(page);
3189 return page;
3190}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003191
3192/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07003193 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003194 * @mapping: the page's address_space
3195 * @index: the page index
3196 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003197 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003198 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003199 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07003200 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003201 *
3202 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003203 *
3204 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003205 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07003206struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003207 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07003208 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003209 void *data)
3210{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07003211 return do_read_cache_page(mapping, index, filler, data,
3212 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003213}
Sasha Levin67f9fd92014-04-03 14:48:18 -07003214EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003215
3216/**
3217 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3218 * @mapping: the page's address_space
3219 * @index: the page index
3220 * @gfp: the page allocator flags to use if allocating
3221 *
3222 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06003223 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003224 *
3225 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08003226 *
3227 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003228 */
3229struct page *read_cache_page_gfp(struct address_space *mapping,
3230 pgoff_t index,
3231 gfp_t gfp)
3232{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07003233 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08003234}
3235EXPORT_SYMBOL(read_cache_page_gfp);
3236
Nick Pigginafddba42007-10-16 01:25:01 -07003237int pagecache_write_begin(struct file *file, struct address_space *mapping,
3238 loff_t pos, unsigned len, unsigned flags,
3239 struct page **pagep, void **fsdata)
3240{
3241 const struct address_space_operations *aops = mapping->a_ops;
3242
Nick Piggin4e02ed42008-10-29 14:00:55 -07003243 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003244 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003245}
3246EXPORT_SYMBOL(pagecache_write_begin);
3247
3248int pagecache_write_end(struct file *file, struct address_space *mapping,
3249 loff_t pos, unsigned len, unsigned copied,
3250 struct page *page, void *fsdata)
3251{
3252 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003253
Nick Piggin4e02ed42008-10-29 14:00:55 -07003254 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003255}
3256EXPORT_SYMBOL(pagecache_write_end);
3257
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003258/*
3259 * Warn about a page cache invalidation failure during a direct I/O write.
3260 */
3261void dio_warn_stale_pagecache(struct file *filp)
3262{
3263 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3264 char pathname[128];
3265 struct inode *inode = file_inode(filp);
3266 char *path;
3267
3268 errseq_set(&inode->i_mapping->wb_err, -EIO);
3269 if (__ratelimit(&_rs)) {
3270 path = file_path(filp, pathname, sizeof(pathname));
3271 if (IS_ERR(path))
3272 path = "(unknown)";
3273 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3274 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3275 current->comm);
3276 }
3277}
3278
Linus Torvalds1da177e2005-04-16 15:20:36 -07003279ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003280generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003281{
3282 struct file *file = iocb->ki_filp;
3283 struct address_space *mapping = file->f_mapping;
3284 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003285 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003286 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003287 size_t write_len;
3288 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289
Al Viro0c949332014-03-22 06:51:37 -04003290 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003291 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003292
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003293 if (iocb->ki_flags & IOCB_NOWAIT) {
3294 /* If there are pages to writeback, return */
3295 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003296 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003297 return -EAGAIN;
3298 } else {
3299 written = filemap_write_and_wait_range(mapping, pos,
3300 pos + write_len - 1);
3301 if (written)
3302 goto out;
3303 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003304
3305 /*
3306 * After a write we want buffered reads to be sure to go to disk to get
3307 * the new data. We invalidate clean cached page from the region we're
3308 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003309 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003310 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003311 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003312 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003313 /*
3314 * If a page can not be invalidated, return 0 to fall back
3315 * to buffered write.
3316 */
3317 if (written) {
3318 if (written == -EBUSY)
3319 return 0;
3320 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003321 }
3322
Al Viro639a93a52017-04-13 14:10:15 -04003323 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003324
3325 /*
3326 * Finally, try again to invalidate clean pages which might have been
3327 * cached by non-direct readahead, or faulted in by get_user_pages()
3328 * if the source of the write was an mmap'ed region of the file
3329 * we're writing. Either one is a pretty crazy thing to do,
3330 * so we don't support it 100%. If this invalidation
3331 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003332 *
3333 * Most of the time we do not need this since dio_complete() will do
3334 * the invalidation for us. However there are some file systems that
3335 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003336 * them by removing it completely.
3337 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003338 * Noticeable example is a blkdev_direct_IO().
3339 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003340 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003341 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003342 if (written > 0 && mapping->nrpages &&
3343 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3344 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003345
Linus Torvalds1da177e2005-04-16 15:20:36 -07003346 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003347 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003348 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003349 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3350 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003351 mark_inode_dirty(inode);
3352 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003353 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003354 }
Al Viro639a93a52017-04-13 14:10:15 -04003355 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003356out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003357 return written;
3358}
3359EXPORT_SYMBOL(generic_file_direct_write);
3360
Nick Piggineb2be182007-10-16 01:24:57 -07003361/*
3362 * Find or create a page at the given pagecache position. Return the locked
3363 * page. This function is specifically for buffered writes.
3364 */
Nick Piggin54566b22009-01-04 12:00:53 -08003365struct page *grab_cache_page_write_begin(struct address_space *mapping,
3366 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003367{
Nick Piggineb2be182007-10-16 01:24:57 -07003368 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003369 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003370
Nick Piggin54566b22009-01-04 12:00:53 -08003371 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003372 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003373
Mel Gorman2457aec2014-06-04 16:10:31 -07003374 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003375 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003376 if (page)
3377 wait_for_stable_page(page);
3378
Nick Piggineb2be182007-10-16 01:24:57 -07003379 return page;
3380}
Nick Piggin54566b22009-01-04 12:00:53 -08003381EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003382
Al Viro3b93f912014-02-11 21:34:08 -05003383ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003384 struct iov_iter *i, loff_t pos)
3385{
3386 struct address_space *mapping = file->f_mapping;
3387 const struct address_space_operations *a_ops = mapping->a_ops;
3388 long status = 0;
3389 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003390 unsigned int flags = 0;
3391
Nick Pigginafddba42007-10-16 01:25:01 -07003392 do {
3393 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003394 unsigned long offset; /* Offset into pagecache page */
3395 unsigned long bytes; /* Bytes to write to page */
3396 size_t copied; /* Bytes copied from user */
3397 void *fsdata;
3398
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003399 offset = (pos & (PAGE_SIZE - 1));
3400 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003401 iov_iter_count(i));
3402
3403again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003404 /*
3405 * Bring in the user page that we will copy from _first_.
3406 * Otherwise there's a nasty deadlock on copying from the
3407 * same page as we're writing to, without it being marked
3408 * up-to-date.
3409 *
3410 * Not only is this an optimisation, but it is also required
3411 * to check that the address is actually valid, when atomic
3412 * usercopies are used, below.
3413 */
3414 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3415 status = -EFAULT;
3416 break;
3417 }
3418
Jan Kara296291c2015-10-22 13:32:21 -07003419 if (fatal_signal_pending(current)) {
3420 status = -EINTR;
3421 break;
3422 }
3423
Nick Piggin674b8922007-10-16 01:25:03 -07003424 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003425 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003426 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003427 break;
3428
anfei zhou931e80e2010-02-02 13:44:02 -08003429 if (mapping_writably_mapped(mapping))
3430 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003431
Nick Pigginafddba42007-10-16 01:25:01 -07003432 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003433 flush_dcache_page(page);
3434
3435 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3436 page, fsdata);
3437 if (unlikely(status < 0))
3438 break;
3439 copied = status;
3440
3441 cond_resched();
3442
Nick Piggin124d3b72008-02-02 15:01:17 +01003443 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003444 if (unlikely(copied == 0)) {
3445 /*
3446 * If we were unable to copy any data at all, we must
3447 * fall back to a single segment length write.
3448 *
3449 * If we didn't fallback here, we could livelock
3450 * because not all segments in the iov can be copied at
3451 * once without a pagefault.
3452 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003453 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003454 iov_iter_single_seg_count(i));
3455 goto again;
3456 }
Nick Pigginafddba42007-10-16 01:25:01 -07003457 pos += copied;
3458 written += copied;
3459
3460 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003461 } while (iov_iter_count(i));
3462
3463 return written ? written : status;
3464}
Al Viro3b93f912014-02-11 21:34:08 -05003465EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
Jan Karae4dd9de2009-08-17 18:10:06 +02003467/**
Al Viro81742022014-04-03 03:17:43 -04003468 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003469 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003470 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003471 *
3472 * This function does all the work needed for actually writing data to a
3473 * file. It does all basic checks, removes SUID from the file, updates
3474 * modification times and calls proper subroutines depending on whether we
3475 * do direct IO or a standard buffered write.
3476 *
3477 * It expects i_mutex to be grabbed unless we work on a block device or similar
3478 * object which does not need locking at all.
3479 *
3480 * This function does *not* take care of syncing data in case of O_SYNC write.
3481 * A caller has to handle it. This is mainly due to the fact that we want to
3482 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003483 *
3484 * Return:
3485 * * number of bytes written, even for truncated writes
3486 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003487 */
Al Viro81742022014-04-03 03:17:43 -04003488ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489{
3490 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003491 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003492 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003493 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003495 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003496
Linus Torvalds1da177e2005-04-16 15:20:36 -07003497 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003498 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003499 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003500 if (err)
3501 goto out;
3502
Josef Bacikc3b2da32012-03-26 09:59:21 -04003503 err = file_update_time(file);
3504 if (err)
3505 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003506
Al Viro2ba48ce2015-04-09 13:52:01 -04003507 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003508 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003509
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003510 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003511 /*
3512 * If the write stopped short of completing, fall back to
3513 * buffered writes. Some filesystems do this for writes to
3514 * holes, for example. For DAX files, a buffered write will
3515 * not succeed (even if it did, DAX does not handle dirty
3516 * page-cache pages correctly).
3517 */
Al Viro0b8def92015-04-07 10:22:53 -04003518 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003520
Al Viro0b8def92015-04-07 10:22:53 -04003521 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003522 /*
Al Viro3b93f912014-02-11 21:34:08 -05003523 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003524 * then we want to return the number of bytes which were
3525 * direct-written, or the error code if that was zero. Note
3526 * that this differs from normal direct-io semantics, which
3527 * will return -EFOO even if some bytes were written.
3528 */
Al Viro60bb4522014-08-08 12:39:16 -04003529 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003530 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003531 goto out;
3532 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003533 /*
3534 * We need to ensure that the page cache pages are written to
3535 * disk and invalidated to preserve the expected O_DIRECT
3536 * semantics.
3537 */
Al Viro3b93f912014-02-11 21:34:08 -05003538 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003539 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003540 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003541 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003542 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003543 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003544 pos >> PAGE_SHIFT,
3545 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003546 } else {
3547 /*
3548 * We don't know how much we wrote, so just return
3549 * the number of bytes which were direct-written
3550 */
3551 }
3552 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003553 written = generic_perform_write(file, from, iocb->ki_pos);
3554 if (likely(written > 0))
3555 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003556 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003557out:
3558 current->backing_dev_info = NULL;
3559 return written ? written : err;
3560}
Al Viro81742022014-04-03 03:17:43 -04003561EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003562
Jan Karae4dd9de2009-08-17 18:10:06 +02003563/**
Al Viro81742022014-04-03 03:17:43 -04003564 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003565 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003566 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003567 *
Al Viro81742022014-04-03 03:17:43 -04003568 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003569 * filesystems. It takes care of syncing the file in case of O_SYNC file
3570 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003571 * Return:
3572 * * negative error code if no data has been written at all of
3573 * vfs_fsync_range() failed for a synchronous write
3574 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003575 */
Al Viro81742022014-04-03 03:17:43 -04003576ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003577{
3578 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003579 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003580 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003581
Al Viro59551022016-01-22 15:40:57 -05003582 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003583 ret = generic_write_checks(iocb, from);
3584 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003585 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003586 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003587
Christoph Hellwige2592212016-04-07 08:52:01 -07003588 if (ret > 0)
3589 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003590 return ret;
3591}
Al Viro81742022014-04-03 03:17:43 -04003592EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003593
David Howellscf9a2ae2006-08-29 19:05:54 +01003594/**
3595 * try_to_release_page() - release old fs-specific metadata on a page
3596 *
3597 * @page: the page which the kernel is trying to free
3598 * @gfp_mask: memory allocation flags (and I/O mode)
3599 *
3600 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003601 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003602 *
David Howells266cf652009-04-03 16:42:36 +01003603 * This may also be called if PG_fscache is set on a page, indicating that the
3604 * page is known to the local caching routines.
3605 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003606 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003607 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003608 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003609 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003610 */
3611int try_to_release_page(struct page *page, gfp_t gfp_mask)
3612{
3613 struct address_space * const mapping = page->mapping;
3614
3615 BUG_ON(!PageLocked(page));
3616 if (PageWriteback(page))
3617 return 0;
3618
3619 if (mapping && mapping->a_ops->releasepage)
3620 return mapping->a_ops->releasepage(page, gfp_mask);
3621 return try_to_free_buffers(page);
3622}
3623
3624EXPORT_SYMBOL(try_to_release_page);