blob: 44361928bbb0ce358f0f7116d48feef7e18ddbc5 [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>
Nick Piggin0f8053a2006-03-22 00:08:33 -080043#include "internal.h"
44
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070045#define CREATE_TRACE_POINTS
46#include <trace/events/filemap.h>
47
Linus Torvalds1da177e2005-04-16 15:20:36 -070048/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070049 * FIXME: remove all knowledge of the buffer layer from the core VM
50 */
Jan Kara148f9482009-08-17 19:52:36 +020051#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <asm/mman.h>
54
55/*
56 * Shared mappings implemented 30.11.1994. It's not fully working yet,
57 * though.
58 *
59 * Shared mappings now work. 15.8.1995 Bruno.
60 *
61 * finished 'unifying' the page and buffer cache and SMP-threaded the
62 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
63 *
64 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
65 */
66
67/*
68 * Lock ordering:
69 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080070 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070072 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070073 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080075 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080076 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 *
78 * ->mmap_sem
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080079 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070080 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070081 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 *
83 * ->mmap_sem
84 * ->lock_page (access_process_vm)
85 *
Al Viroccad2362014-02-11 22:36:48 -050086 * ->i_mutex (generic_perform_write)
Nick Piggin82591e62006-10-19 23:29:10 -070087 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060089 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110090 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070091 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080093 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 * ->anon_vma.lock (vma_adjust)
95 *
96 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070097 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -070099 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700100 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700102 * ->i_pages lock (try_to_unmap_one)
Andrey Ryabininf4b7e272019-03-05 15:49:39 -0800103 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
104 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700106 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600107 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100108 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700109 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600110 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100111 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
113 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800114 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700115 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 */
117
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500118static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700119 struct page *page, void *shadow)
120{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500121 XA_STATE(xas, &mapping->i_pages, page->index);
122 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800123
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500124 mapping_set_update(&xas, mapping);
125
126 /* hugetlb pages are represented by a single entry in the xarray */
127 if (!PageHuge(page)) {
128 xas_set_order(&xas, page->index, compound_order(page));
129 nr = 1U << compound_order(page);
130 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700131
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700132 VM_BUG_ON_PAGE(!PageLocked(page), page);
133 VM_BUG_ON_PAGE(PageTail(page), page);
134 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700135
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500136 xas_store(&xas, shadow);
137 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200138
Jan Kara23006382017-11-15 17:37:26 -0800139 page->mapping = NULL;
140 /* Leave page->index set: truncation lookup relies upon it */
141
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200142 if (shadow) {
143 mapping->nrexceptional += nr;
144 /*
145 * Make sure the nrexceptional update is committed before
146 * the nrpages update so that final truncate racing
147 * with reclaim does not see both counters 0 at the
148 * same time and miss a shadow entry.
149 */
150 smp_wmb();
151 }
152 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700153}
154
Jan Kara5ecc4d82017-11-15 17:37:29 -0800155static void unaccount_page_cache_page(struct address_space *mapping,
156 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800158 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600160 /*
161 * if we're uptodate, flush out into the cleancache, otherwise
162 * invalidate any existing cleancache entries. We can't leave
163 * stale data around in the cleancache once our page is gone
164 */
165 if (PageUptodate(page) && PageMappedToDisk(page))
166 cleancache_put_page(page);
167 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400168 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600169
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700170 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800171 VM_BUG_ON_PAGE(page_mapped(page), page);
172 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
173 int mapcount;
174
175 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
176 current->comm, page_to_pfn(page));
177 dump_page(page, "still mapped when deleted");
178 dump_stack();
179 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
180
181 mapcount = page_mapcount(page);
182 if (mapping_exiting(mapping) &&
183 page_count(page) >= mapcount + 2) {
184 /*
185 * All vmas have already been torn down, so it's
186 * a good bet that actually the page is unmapped,
187 * and we'd prefer not to leak it: if we're wrong,
188 * some other bad page check should catch it later.
189 */
190 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700191 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800192 }
193 }
194
Jan Kara76253fb2017-11-15 17:37:22 -0800195 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800196 if (PageHuge(page))
197 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800198
Jan Kara5ecc4d82017-11-15 17:37:29 -0800199 nr = hpage_nr_pages(page);
200
201 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
202 if (PageSwapBacked(page)) {
203 __mod_node_page_state(page_pgdat(page), NR_SHMEM, -nr);
204 if (PageTransHuge(page))
205 __dec_node_page_state(page, NR_SHMEM_THPS);
206 } else {
207 VM_BUG_ON_PAGE(PageTransHuge(page), page);
Jan Kara76253fb2017-11-15 17:37:22 -0800208 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800209
210 /*
211 * At this point page must be either written or cleaned by
212 * truncate. Dirty page here signals a bug and loss of
213 * unwritten data.
214 *
215 * This fixes dirty accounting after removing the page entirely
216 * but leaves PageDirty set: it has no effect for truncated
217 * page and anyway will be cleared before returning page into
218 * buddy allocator.
219 */
220 if (WARN_ON_ONCE(PageDirty(page)))
221 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
222}
223
224/*
225 * Delete a page from the page cache and free it. Caller has to make
226 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700227 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800228 */
229void __delete_from_page_cache(struct page *page, void *shadow)
230{
231 struct address_space *mapping = page->mapping;
232
233 trace_mm_filemap_delete_from_page_cache(page);
234
235 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500236 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237}
238
Jan Kara59c66c52017-11-15 17:37:18 -0800239static void page_cache_free_page(struct address_space *mapping,
240 struct page *page)
241{
242 void (*freepage)(struct page *);
243
244 freepage = mapping->a_ops->freepage;
245 if (freepage)
246 freepage(page);
247
248 if (PageTransHuge(page) && !PageHuge(page)) {
249 page_ref_sub(page, HPAGE_PMD_NR);
250 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
251 } else {
252 put_page(page);
253 }
254}
255
Minchan Kim702cfbf2011-03-22 16:32:43 -0700256/**
257 * delete_from_page_cache - delete page from page cache
258 * @page: the page which the kernel is trying to remove from page cache
259 *
260 * This must be called only on pages that have been verified to be in the page
261 * cache and locked. It will never put the page into the free list, the caller
262 * has a reference on the page.
263 */
264void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700266 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400267 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
Matt Mackallcd7619d2005-05-01 08:59:01 -0700269 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700270 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700271 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700272 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500273
Jan Kara59c66c52017-11-15 17:37:18 -0800274 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700275}
276EXPORT_SYMBOL(delete_from_page_cache);
277
Jan Karaaa65c292017-11-15 17:37:33 -0800278/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500279 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800280 * @mapping: the mapping to which pages belong
281 * @pvec: pagevec with pages to delete
282 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700283 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -0700284 * from the mapping. The function expects @pvec to be sorted by page index
285 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700286 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800287 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -0700288 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800289 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700290 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800291 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500292static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800293 struct pagevec *pvec)
294{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500295 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800296 int total_pages = 0;
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -0700297 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800298 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800299
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500300 mapping_set_update(&xas, mapping);
301 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -0700302 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800303 break;
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -0700304
305 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400306 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800307 continue;
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -0700308 /*
309 * A page got inserted in our range? Skip it. We have our
310 * pages locked so they are protected from being removed.
311 * If we see a page whose index is higher than ours, it
312 * means our page has been removed, which shouldn't be
313 * possible because we're holding the PageLock.
314 */
315 if (page != pvec->pages[i]) {
316 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
317 page);
318 continue;
Jan Karaaa65c292017-11-15 17:37:33 -0800319 }
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -0700320
321 WARN_ON_ONCE(!PageLocked(page));
322
323 if (page->index == xas.xa_index)
324 page->mapping = NULL;
325 /* Leave page->index set: truncation lookup relies on it */
326
327 /*
328 * Move to the next page in the vector if this is a regular
329 * page or the index is of the last sub-page of this compound
330 * page.
331 */
332 if (page->index + (1UL << compound_order(page)) - 1 ==
333 xas.xa_index)
334 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500335 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800336 total_pages++;
337 }
338 mapping->nrpages -= total_pages;
339}
340
341void delete_from_page_cache_batch(struct address_space *mapping,
342 struct pagevec *pvec)
343{
344 int i;
345 unsigned long flags;
346
347 if (!pagevec_count(pvec))
348 return;
349
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700350 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800351 for (i = 0; i < pagevec_count(pvec); i++) {
352 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
353
354 unaccount_page_cache_page(mapping, pvec->pages[i]);
355 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500356 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700357 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800358
359 for (i = 0; i < pagevec_count(pvec); i++)
360 page_cache_free_page(mapping, pvec->pages[i]);
361}
362
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200363int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700364{
365 int ret = 0;
366 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700367 if (test_bit(AS_ENOSPC, &mapping->flags) &&
368 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700369 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700370 if (test_bit(AS_EIO, &mapping->flags) &&
371 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700372 ret = -EIO;
373 return ret;
374}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200375EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700376
Jeff Layton76341ca2017-07-06 07:02:22 -0400377static int filemap_check_and_keep_errors(struct address_space *mapping)
378{
379 /* Check for outstanding write errors */
380 if (test_bit(AS_EIO, &mapping->flags))
381 return -EIO;
382 if (test_bit(AS_ENOSPC, &mapping->flags))
383 return -ENOSPC;
384 return 0;
385}
386
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700388 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700389 * @mapping: address space structure to write
390 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800391 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700392 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700394 * Start writeback against all of a mapping's dirty pages that lie
395 * within the byte offsets <start, end> inclusive.
396 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700398 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 * these two operations is that if a dirty page/buffer is encountered, it must
400 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800401 *
402 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800404int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
405 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406{
407 int ret;
408 struct writeback_control wbc = {
409 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800410 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700411 .range_start = start,
412 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 };
414
415 if (!mapping_cap_writeback_dirty(mapping))
416 return 0;
417
Tejun Heob16b1de2015-06-02 08:39:48 -0600418 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600420 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 return ret;
422}
423
424static inline int __filemap_fdatawrite(struct address_space *mapping,
425 int sync_mode)
426{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700427 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428}
429
430int filemap_fdatawrite(struct address_space *mapping)
431{
432 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
433}
434EXPORT_SYMBOL(filemap_fdatawrite);
435
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400436int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800437 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438{
439 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
440}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400441EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Randy Dunlap485bb992006-06-23 02:03:49 -0700443/**
444 * filemap_flush - mostly a non-blocking flush
445 * @mapping: target address_space
446 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 * This is a mostly non-blocking flush. Not suitable for data-integrity
448 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800449 *
450 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 */
452int filemap_flush(struct address_space *mapping)
453{
454 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
455}
456EXPORT_SYMBOL(filemap_flush);
457
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500458/**
459 * filemap_range_has_page - check if a page exists in range.
460 * @mapping: address space within which to check
461 * @start_byte: offset in bytes where the range starts
462 * @end_byte: offset in bytes where the range ends (inclusive)
463 *
464 * Find at least one page in the range supplied, usually used to check if
465 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800466 *
467 * Return: %true if at least one page exists in the specified range,
468 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500469 */
470bool filemap_range_has_page(struct address_space *mapping,
471 loff_t start_byte, loff_t end_byte)
472{
Jan Karaf7b68042017-09-06 16:21:40 -0700473 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500474 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
475 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500476
477 if (end_byte < start_byte)
478 return false;
479
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500480 rcu_read_lock();
481 for (;;) {
482 page = xas_find(&xas, max);
483 if (xas_retry(&xas, page))
484 continue;
485 /* Shadow entries don't count */
486 if (xa_is_value(page))
487 continue;
488 /*
489 * We don't need to try to pin this page; we're about to
490 * release the RCU lock anyway. It is enough to know that
491 * there was a page here recently.
492 */
493 break;
494 }
495 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500496
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500497 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500498}
499EXPORT_SYMBOL(filemap_range_has_page);
500
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400501static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800502 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300504 pgoff_t index = start_byte >> PAGE_SHIFT;
505 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 struct pagevec pvec;
507 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200509 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400510 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Mel Gorman86679822017-11-15 17:37:52 -0800512 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800513 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 unsigned i;
515
Jan Kara312e9d22017-11-15 17:35:05 -0800516 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800517 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800518 if (!nr_pages)
519 break;
520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 for (i = 0; i < nr_pages; i++) {
522 struct page *page = pvec.pages[i];
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400525 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 }
527 pagevec_release(&pvec);
528 cond_resched();
529 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800530}
531
532/**
533 * filemap_fdatawait_range - wait for writeback to complete
534 * @mapping: address space structure to wait for
535 * @start_byte: offset in bytes where the range starts
536 * @end_byte: offset in bytes where the range ends (inclusive)
537 *
538 * Walk the list of under-writeback pages of the given address space
539 * in the given range and wait for all of them. Check error status of
540 * the address space and return it.
541 *
542 * Since the error status of the address space is cleared by this function,
543 * callers are responsible for checking the return value and handling and/or
544 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800545 *
546 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800547 */
548int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
549 loff_t end_byte)
550{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400551 __filemap_fdatawait_range(mapping, start_byte, end_byte);
552 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200554EXPORT_SYMBOL(filemap_fdatawait_range);
555
556/**
Jeff Laytona823e452017-07-28 07:24:43 -0400557 * file_fdatawait_range - wait for writeback to complete
558 * @file: file pointing to address space structure to wait for
559 * @start_byte: offset in bytes where the range starts
560 * @end_byte: offset in bytes where the range ends (inclusive)
561 *
562 * Walk the list of under-writeback pages of the address space that file
563 * refers to, in the given range and wait for all of them. Check error
564 * status of the address space vs. the file->f_wb_err cursor and return it.
565 *
566 * Since the error status of the file is advanced by this function,
567 * callers are responsible for checking the return value and handling and/or
568 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800569 *
570 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400571 */
572int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
573{
574 struct address_space *mapping = file->f_mapping;
575
576 __filemap_fdatawait_range(mapping, start_byte, end_byte);
577 return file_check_and_advance_wb_err(file);
578}
579EXPORT_SYMBOL(file_fdatawait_range);
580
581/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800582 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
583 * @mapping: address space structure to wait for
584 *
585 * Walk the list of under-writeback pages of the given address space
586 * and wait for all of them. Unlike filemap_fdatawait(), this function
587 * does not clear error status of the address space.
588 *
589 * Use this function if callers don't handle errors themselves. Expected
590 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
591 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800592 *
593 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800594 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400595int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800596{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400597 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400598 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800599}
Jeff Layton76341ca2017-07-06 07:02:22 -0400600EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800601
Jeff Layton9326c9b2017-07-26 10:21:11 -0400602static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603{
Jeff Layton9326c9b2017-07-26 10:21:11 -0400604 return (!dax_mapping(mapping) && mapping->nrpages) ||
605 (dax_mapping(mapping) && mapping->nrexceptional);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
608int filemap_write_and_wait(struct address_space *mapping)
609{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800610 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Jeff Layton9326c9b2017-07-26 10:21:11 -0400612 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800613 err = filemap_fdatawrite(mapping);
614 /*
615 * Even if the above returned error, the pages may be
616 * written partially (e.g. -ENOSPC), so we wait for it.
617 * But the -EIO is special case, it may indicate the worst
618 * thing (e.g. bug) happened, so we avoid waiting for it.
619 */
620 if (err != -EIO) {
621 int err2 = filemap_fdatawait(mapping);
622 if (!err)
623 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400624 } else {
625 /* Clear any previously stored errors */
626 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800627 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700628 } else {
629 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800631 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632}
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800633EXPORT_SYMBOL(filemap_write_and_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Randy Dunlap485bb992006-06-23 02:03:49 -0700635/**
636 * filemap_write_and_wait_range - write out & wait on a file range
637 * @mapping: the address_space for the pages
638 * @lstart: offset in bytes where the range starts
639 * @lend: offset in bytes where the range ends (inclusive)
640 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800641 * Write out and wait upon file offsets lstart->lend, inclusive.
642 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300643 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800644 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800645 *
646 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800647 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648int filemap_write_and_wait_range(struct address_space *mapping,
649 loff_t lstart, loff_t lend)
650{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800651 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Jeff Layton9326c9b2017-07-26 10:21:11 -0400653 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800654 err = __filemap_fdatawrite_range(mapping, lstart, lend,
655 WB_SYNC_ALL);
656 /* See comment of filemap_write_and_wait() */
657 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200658 int err2 = filemap_fdatawait_range(mapping,
659 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800660 if (!err)
661 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400662 } else {
663 /* Clear any previously stored errors */
664 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800665 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700666 } else {
667 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800669 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
Chris Masonf6995582009-04-15 13:22:37 -0400671EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
Jeff Layton5660e132017-07-06 07:02:25 -0400673void __filemap_set_wb_err(struct address_space *mapping, int err)
674{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400675 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400676
677 trace_filemap_set_wb_err(mapping, eseq);
678}
679EXPORT_SYMBOL(__filemap_set_wb_err);
680
681/**
682 * file_check_and_advance_wb_err - report wb error (if any) that was previously
683 * and advance wb_err to current one
684 * @file: struct file on which the error is being reported
685 *
686 * When userland calls fsync (or something like nfsd does the equivalent), we
687 * want to report any writeback errors that occurred since the last fsync (or
688 * since the file was opened if there haven't been any).
689 *
690 * Grab the wb_err from the mapping. If it matches what we have in the file,
691 * then just quickly return 0. The file is all caught up.
692 *
693 * If it doesn't match, then take the mapping value, set the "seen" flag in
694 * it and try to swap it into place. If it works, or another task beat us
695 * to it with the new value, then update the f_wb_err and return the error
696 * portion. The error at this point must be reported via proper channels
697 * (a'la fsync, or NFS COMMIT operation, etc.).
698 *
699 * While we handle mapping->wb_err with atomic operations, the f_wb_err
700 * value is protected by the f_lock since we must ensure that it reflects
701 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800702 *
703 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400704 */
705int file_check_and_advance_wb_err(struct file *file)
706{
707 int err = 0;
708 errseq_t old = READ_ONCE(file->f_wb_err);
709 struct address_space *mapping = file->f_mapping;
710
711 /* Locklessly handle the common case where nothing has changed */
712 if (errseq_check(&mapping->wb_err, old)) {
713 /* Something changed, must use slow path */
714 spin_lock(&file->f_lock);
715 old = file->f_wb_err;
716 err = errseq_check_and_advance(&mapping->wb_err,
717 &file->f_wb_err);
718 trace_file_check_and_advance_wb_err(file, old);
719 spin_unlock(&file->f_lock);
720 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700721
722 /*
723 * We're mostly using this function as a drop in replacement for
724 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
725 * that the legacy code would have had on these flags.
726 */
727 clear_bit(AS_EIO, &mapping->flags);
728 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400729 return err;
730}
731EXPORT_SYMBOL(file_check_and_advance_wb_err);
732
733/**
734 * file_write_and_wait_range - write out & wait on a file range
735 * @file: file pointing to address_space with pages
736 * @lstart: offset in bytes where the range starts
737 * @lend: offset in bytes where the range ends (inclusive)
738 *
739 * Write out and wait upon file offsets lstart->lend, inclusive.
740 *
741 * Note that @lend is inclusive (describes the last byte to be written) so
742 * that this function can be used to write to the very end-of-file (end = -1).
743 *
744 * After writing out and waiting on the data, we check and advance the
745 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800746 *
747 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400748 */
749int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
750{
751 int err = 0, err2;
752 struct address_space *mapping = file->f_mapping;
753
Jeff Layton9326c9b2017-07-26 10:21:11 -0400754 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400755 err = __filemap_fdatawrite_range(mapping, lstart, lend,
756 WB_SYNC_ALL);
757 /* See comment of filemap_write_and_wait() */
758 if (err != -EIO)
759 __filemap_fdatawait_range(mapping, lstart, lend);
760 }
761 err2 = file_check_and_advance_wb_err(file);
762 if (!err)
763 err = err2;
764 return err;
765}
766EXPORT_SYMBOL(file_write_and_wait_range);
767
Randy Dunlap485bb992006-06-23 02:03:49 -0700768/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700769 * replace_page_cache_page - replace a pagecache page with a new one
770 * @old: page to be replaced
771 * @new: page to replace with
772 * @gfp_mask: allocation mode
773 *
774 * This function replaces a page in the pagecache with a new one. On
775 * success it acquires the pagecache reference for the new page and
776 * drops it for the old page. Both the old and new pages must be
777 * locked. This function does not add the new page to the LRU, the
778 * caller must do that.
779 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500780 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800781 *
782 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700783 */
784int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
785{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500786 struct address_space *mapping = old->mapping;
787 void (*freepage)(struct page *) = mapping->a_ops->freepage;
788 pgoff_t offset = old->index;
789 XA_STATE(xas, &mapping->i_pages, offset);
790 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700791
Sasha Levin309381fea2014-01-23 15:52:54 -0800792 VM_BUG_ON_PAGE(!PageLocked(old), old);
793 VM_BUG_ON_PAGE(!PageLocked(new), new);
794 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700795
Matthew Wilcox74d60952017-11-17 10:01:45 -0500796 get_page(new);
797 new->mapping = mapping;
798 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700799
Matthew Wilcox74d60952017-11-17 10:01:45 -0500800 xas_lock_irqsave(&xas, flags);
801 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700802
Matthew Wilcox74d60952017-11-17 10:01:45 -0500803 old->mapping = NULL;
804 /* hugetlb pages do not participate in page cache accounting. */
805 if (!PageHuge(old))
806 __dec_node_page_state(new, NR_FILE_PAGES);
807 if (!PageHuge(new))
808 __inc_node_page_state(new, NR_FILE_PAGES);
809 if (PageSwapBacked(old))
810 __dec_node_page_state(new, NR_SHMEM);
811 if (PageSwapBacked(new))
812 __inc_node_page_state(new, NR_SHMEM);
813 xas_unlock_irqrestore(&xas, flags);
814 mem_cgroup_migrate(old, new);
815 if (freepage)
816 freepage(old);
817 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700818
Matthew Wilcox74d60952017-11-17 10:01:45 -0500819 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700820}
821EXPORT_SYMBOL_GPL(replace_page_cache_page);
822
Johannes Weinera5289102014-04-03 14:47:51 -0700823static int __add_to_page_cache_locked(struct page *page,
824 struct address_space *mapping,
825 pgoff_t offset, gfp_t gfp_mask,
826 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500828 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700829 int huge = PageHuge(page);
830 struct mem_cgroup *memcg;
Nick Piggine2867812008-07-25 19:45:30 -0700831 int error;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500832 void *old;
Nick Piggine2867812008-07-25 19:45:30 -0700833
Sasha Levin309381fea2014-01-23 15:52:54 -0800834 VM_BUG_ON_PAGE(!PageLocked(page), page);
835 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500836 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700837
Johannes Weiner00501b52014-08-08 14:19:20 -0700838 if (!huge) {
839 error = mem_cgroup_try_charge(page, current->mm,
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800840 gfp_mask, &memcg, false);
Johannes Weiner00501b52014-08-08 14:19:20 -0700841 if (error)
842 return error;
843 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300845 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700846 page->mapping = mapping;
847 page->index = offset;
848
Matthew Wilcox74d60952017-11-17 10:01:45 -0500849 do {
850 xas_lock_irq(&xas);
851 old = xas_load(&xas);
852 if (old && !xa_is_value(old))
853 xas_set_err(&xas, -EEXIST);
854 xas_store(&xas, page);
855 if (xas_error(&xas))
856 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700857
Matthew Wilcox74d60952017-11-17 10:01:45 -0500858 if (xa_is_value(old)) {
859 mapping->nrexceptional--;
860 if (shadowp)
861 *shadowp = old;
862 }
863 mapping->nrpages++;
864
865 /* hugetlb pages do not participate in page cache accounting */
866 if (!huge)
867 __inc_node_page_state(page, NR_FILE_PAGES);
868unlock:
869 xas_unlock_irq(&xas);
870 } while (xas_nomem(&xas, gfp_mask & GFP_RECLAIM_MASK));
871
872 if (xas_error(&xas))
873 goto error;
874
Johannes Weiner00501b52014-08-08 14:19:20 -0700875 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800876 mem_cgroup_commit_charge(page, memcg, false, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700877 trace_mm_filemap_add_to_page_cache(page);
878 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500879error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700880 page->mapping = NULL;
881 /* Leave page->index set: truncation relies upon it */
Johannes Weiner00501b52014-08-08 14:19:20 -0700882 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800883 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300884 put_page(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500885 return xas_error(&xas);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700887ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700888
889/**
890 * add_to_page_cache_locked - add a locked page to the pagecache
891 * @page: page to add
892 * @mapping: the page's address_space
893 * @offset: page index
894 * @gfp_mask: page allocation mode
895 *
896 * This function is used to add a page to the pagecache. It must be locked.
897 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800898 *
899 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700900 */
901int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
902 pgoff_t offset, gfp_t gfp_mask)
903{
904 return __add_to_page_cache_locked(page, mapping, offset,
905 gfp_mask, NULL);
906}
Nick Piggine2867812008-07-25 19:45:30 -0700907EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908
909int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400910 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911{
Johannes Weinera5289102014-04-03 14:47:51 -0700912 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700913 int ret;
914
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800915 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700916 ret = __add_to_page_cache_locked(page, mapping, offset,
917 gfp_mask, &shadow);
918 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800919 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700920 else {
921 /*
922 * The page might have been evicted from cache only
923 * recently, in which case it should be activated like
924 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700925 * The exception is pages getting rewritten; evicting other
926 * data from the working set, only to cache data that will
927 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700928 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700929 WARN_ON_ONCE(PageActive(page));
930 if (!(gfp_mask & __GFP_WRITE) && shadow)
931 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700932 lru_cache_add(page);
933 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700934 return ret;
935}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300936EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Paul Jackson44110fe2006-03-24 03:16:04 -0800938#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700939struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800940{
Miao Xiec0ff7452010-05-24 14:32:08 -0700941 int n;
942 struct page *page;
943
Paul Jackson44110fe2006-03-24 03:16:04 -0800944 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700945 unsigned int cpuset_mems_cookie;
946 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700947 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700948 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700949 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700950 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700951
Miao Xiec0ff7452010-05-24 14:32:08 -0700952 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800953 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700954 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800955}
Nick Piggin2ae88142006-10-28 10:38:23 -0700956EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800957#endif
958
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959/*
960 * In order to wait for pages to become available there must be
961 * waitqueues associated with pages. By using a hash table of
962 * waitqueues where the bucket discipline is to maintain all
963 * waiters on the same queue and wake all when any of the pages
964 * become available, and for the woken contexts to check to be
965 * sure the appropriate page became available, this saves space
966 * at a cost of "thundering herd" phenomena during rare hash
967 * collisions.
968 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000969#define PAGE_WAIT_TABLE_BITS 8
970#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
971static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
972
973static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974{
Nicholas Piggin62906022016-12-25 13:00:30 +1000975 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976}
Nicholas Piggin62906022016-12-25 13:00:30 +1000977
978void __init pagecache_init(void)
979{
980 int i;
981
982 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
983 init_waitqueue_head(&page_wait_table[i]);
984
985 page_writeback_init();
986}
987
Linus Torvalds3510ca22017-08-27 13:55:12 -0700988/* This has the same layout as wait_bit_key - see fs/cachefiles/rdwr.c */
Nicholas Piggin62906022016-12-25 13:00:30 +1000989struct wait_page_key {
990 struct page *page;
991 int bit_nr;
992 int page_match;
993};
994
995struct wait_page_queue {
996 struct page *page;
997 int bit_nr;
Ingo Molnarac6424b2017-06-20 12:06:13 +0200998 wait_queue_entry_t wait;
Nicholas Piggin62906022016-12-25 13:00:30 +1000999};
1000
Ingo Molnarac6424b2017-06-20 12:06:13 +02001001static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001002{
1003 struct wait_page_key *key = arg;
1004 struct wait_page_queue *wait_page
1005 = container_of(wait, struct wait_page_queue, wait);
1006
1007 if (wait_page->page != key->page)
1008 return 0;
1009 key->page_match = 1;
1010
1011 if (wait_page->bit_nr != key->bit_nr)
1012 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001013
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001014 /*
1015 * Stop walking if it's locked.
1016 * Is this safe if put_and_wait_on_page_locked() is in use?
1017 * Yes: the waker must hold a reference to this page, and if PG_locked
1018 * has now already been set by another task, that task must also hold
1019 * a reference to the *same usage* of this page; so there is no need
1020 * to walk on to wake even the put_and_wait_on_page_locked() callers.
1021 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001022 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds3510ca22017-08-27 13:55:12 -07001023 return -1;
Nicholas Piggin62906022016-12-25 13:00:30 +10001024
1025 return autoremove_wake_function(wait, mode, sync, key);
1026}
1027
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001028static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001029{
1030 wait_queue_head_t *q = page_waitqueue(page);
1031 struct wait_page_key key;
1032 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001033 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001034
1035 key.page = page;
1036 key.bit_nr = bit_nr;
1037 key.page_match = 0;
1038
Tim Chen11a19c72017-08-25 09:13:55 -07001039 bookmark.flags = 0;
1040 bookmark.private = NULL;
1041 bookmark.func = NULL;
1042 INIT_LIST_HEAD(&bookmark.entry);
1043
Nicholas Piggin62906022016-12-25 13:00:30 +10001044 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001045 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1046
1047 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1048 /*
1049 * Take a breather from holding the lock,
1050 * allow pages that finish wake up asynchronously
1051 * to acquire the lock and remove themselves
1052 * from wait queue
1053 */
1054 spin_unlock_irqrestore(&q->lock, flags);
1055 cpu_relax();
1056 spin_lock_irqsave(&q->lock, flags);
1057 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1058 }
1059
Nicholas Piggin62906022016-12-25 13:00:30 +10001060 /*
1061 * It is possible for other pages to have collided on the waitqueue
1062 * hash, so in that case check for a page match. That prevents a long-
1063 * term waiter
1064 *
1065 * It is still possible to miss a case here, when we woke page waiters
1066 * and removed them from the waitqueue, but there are still other
1067 * page waiters.
1068 */
1069 if (!waitqueue_active(q) || !key.page_match) {
1070 ClearPageWaiters(page);
1071 /*
1072 * It's possible to miss clearing Waiters here, when we woke
1073 * our page waiters, but the hashed waitqueue has waiters for
1074 * other pages on it.
1075 *
1076 * That's okay, it's a rare case. The next waker will clear it.
1077 */
1078 }
1079 spin_unlock_irqrestore(&q->lock, flags);
1080}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001081
1082static void wake_up_page(struct page *page, int bit)
1083{
1084 if (!PageWaiters(page))
1085 return;
1086 wake_up_page_bit(page, bit);
1087}
Nicholas Piggin62906022016-12-25 13:00:30 +10001088
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001089/*
1090 * A choice of three behaviors for wait_on_page_bit_common():
1091 */
1092enum behavior {
1093 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1094 * __lock_page() waiting on then setting PG_locked.
1095 */
1096 SHARED, /* Hold ref to page and check the bit when woken, like
1097 * wait_on_page_writeback() waiting on PG_writeback.
1098 */
1099 DROP, /* Drop ref to page before wait, no check when woken,
1100 * like put_and_wait_on_page_locked() on PG_locked.
1101 */
1102};
1103
Nicholas Piggin62906022016-12-25 13:00:30 +10001104static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001105 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001106{
1107 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001108 wait_queue_entry_t *wait = &wait_page.wait;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001109 bool bit_is_set;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001110 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001111 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001112 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001113 int ret = 0;
1114
Johannes Weinereb414682018-10-26 15:06:27 -07001115 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001116 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001117 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001118 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001119 delayacct = true;
1120 }
Johannes Weinereb414682018-10-26 15:06:27 -07001121 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001122 thrashing = true;
1123 }
1124
Nicholas Piggin62906022016-12-25 13:00:30 +10001125 init_wait(wait);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001126 wait->flags = behavior == EXCLUSIVE ? WQ_FLAG_EXCLUSIVE : 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001127 wait->func = wake_page_function;
1128 wait_page.page = page;
1129 wait_page.bit_nr = bit_nr;
1130
1131 for (;;) {
1132 spin_lock_irq(&q->lock);
1133
Ingo Molnar2055da92017-06-20 12:06:46 +02001134 if (likely(list_empty(&wait->entry))) {
Linus Torvalds3510ca22017-08-27 13:55:12 -07001135 __add_wait_queue_entry_tail(q, wait);
Nicholas Piggin62906022016-12-25 13:00:30 +10001136 SetPageWaiters(page);
1137 }
1138
1139 set_current_state(state);
1140
1141 spin_unlock_irq(&q->lock);
1142
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001143 bit_is_set = test_bit(bit_nr, &page->flags);
1144 if (behavior == DROP)
1145 put_page(page);
Nicholas Piggin62906022016-12-25 13:00:30 +10001146
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001147 if (likely(bit_is_set))
1148 io_schedule();
1149
1150 if (behavior == EXCLUSIVE) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001151 if (!test_and_set_bit_lock(bit_nr, &page->flags))
1152 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001153 } else if (behavior == SHARED) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001154 if (!test_bit(bit_nr, &page->flags))
1155 break;
1156 }
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001157
Davidlohr Buesofa45f112019-01-03 15:28:55 -08001158 if (signal_pending_state(state, current)) {
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001159 ret = -EINTR;
1160 break;
1161 }
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001162
1163 if (behavior == DROP) {
1164 /*
1165 * We can no longer safely access page->flags:
1166 * even if CONFIG_MEMORY_HOTREMOVE is not enabled,
1167 * there is a risk of waiting forever on a page reused
1168 * for something that keeps it locked indefinitely.
1169 * But best check for -EINTR above before breaking.
1170 */
1171 break;
1172 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001173 }
1174
1175 finish_wait(q, wait);
1176
Johannes Weinereb414682018-10-26 15:06:27 -07001177 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001178 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001179 delayacct_thrashing_end();
1180 psi_memstall_leave(&pflags);
1181 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001182
Nicholas Piggin62906022016-12-25 13:00:30 +10001183 /*
1184 * A signal could leave PageWaiters set. Clearing it here if
1185 * !waitqueue_active would be possible (by open-coding finish_wait),
1186 * but still fail to catch it in the case of wait hash collision. We
1187 * already can fail to clear wait hash collision cases, so don't
1188 * bother with signals either.
1189 */
1190
1191 return ret;
1192}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193
Harvey Harrison920c7a52008-02-04 22:29:26 -08001194void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195{
Nicholas Piggin62906022016-12-25 13:00:30 +10001196 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001197 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198}
1199EXPORT_SYMBOL(wait_on_page_bit);
1200
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001201int wait_on_page_bit_killable(struct page *page, int bit_nr)
1202{
Nicholas Piggin62906022016-12-25 13:00:30 +10001203 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001204 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001205}
David Howells4343d002017-11-02 15:27:52 +00001206EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001207
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001209 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1210 * @page: The page to wait for.
1211 *
1212 * The caller should hold a reference on @page. They expect the page to
1213 * become unlocked relatively soon, but do not wish to hold up migration
1214 * (for example) by holding the reference while waiting for the page to
1215 * come unlocked. After this function returns, the caller should not
1216 * dereference @page.
1217 */
1218void put_and_wait_on_page_locked(struct page *page)
1219{
1220 wait_queue_head_t *q;
1221
1222 page = compound_head(page);
1223 q = page_waitqueue(page);
1224 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1225}
1226
1227/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001228 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001229 * @page: Page defining the wait queue of interest
1230 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001231 *
1232 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1233 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001234void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001235{
1236 wait_queue_head_t *q = page_waitqueue(page);
1237 unsigned long flags;
1238
1239 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001240 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001241 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001242 spin_unlock_irqrestore(&q->lock, flags);
1243}
1244EXPORT_SYMBOL_GPL(add_page_wait_queue);
1245
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001246#ifndef clear_bit_unlock_is_negative_byte
1247
1248/*
1249 * PG_waiters is the high bit in the same byte as PG_lock.
1250 *
1251 * On x86 (and on many other architectures), we can clear PG_lock and
1252 * test the sign bit at the same time. But if the architecture does
1253 * not support that special operation, we just do this all by hand
1254 * instead.
1255 *
1256 * The read of PG_waiters has to be after (or concurrently with) PG_locked
1257 * being cleared, but a memory barrier should be unneccssary since it is
1258 * in the same byte as PG_locked.
1259 */
1260static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1261{
1262 clear_bit_unlock(nr, mem);
1263 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001264 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001265}
1266
1267#endif
1268
David Howells385e1ca5f2009-04-03 16:42:39 +01001269/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001270 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 * @page: the page
1272 *
1273 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
1274 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001275 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1277 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001278 * Note that this depends on PG_waiters being the sign bit in the byte
1279 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1280 * clear the PG_locked bit and test PG_waiters at the same time fairly
1281 * portably (architectures that do LL/SC can test any bit, while x86 can
1282 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001284void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001286 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001287 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001288 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001289 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1290 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291}
1292EXPORT_SYMBOL(unlock_page);
1293
Randy Dunlap485bb992006-06-23 02:03:49 -07001294/**
1295 * end_page_writeback - end writeback against a page
1296 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001297 */
1298void end_page_writeback(struct page *page)
1299{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001300 /*
1301 * TestClearPageReclaim could be used here but it is an atomic
1302 * operation and overkill in this particular case. Failing to
1303 * shuffle a page marked for immediate reclaim is too mild to
1304 * justify taking an atomic operation penalty at the end of
1305 * ever page writeback.
1306 */
1307 if (PageReclaim(page)) {
1308 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001309 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001310 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001311
1312 if (!test_clear_page_writeback(page))
1313 BUG();
1314
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001315 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 wake_up_page(page, PG_writeback);
1317}
1318EXPORT_SYMBOL(end_page_writeback);
1319
Matthew Wilcox57d99842014-06-04 16:07:45 -07001320/*
1321 * After completing I/O on a page, call this routine to update the page
1322 * flags appropriately
1323 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001324void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001325{
Jens Axboec11f0c02016-08-05 08:11:04 -06001326 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001327 if (!err) {
1328 SetPageUptodate(page);
1329 } else {
1330 ClearPageUptodate(page);
1331 SetPageError(page);
1332 }
1333 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001334 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001335 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001336 struct address_space *mapping;
1337
Matthew Wilcox57d99842014-06-04 16:07:45 -07001338 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001339 mapping = page_mapping(page);
1340 if (mapping)
1341 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001342 }
1343 end_page_writeback(page);
1344 }
1345}
1346EXPORT_SYMBOL_GPL(page_endio);
1347
Randy Dunlap485bb992006-06-23 02:03:49 -07001348/**
1349 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001350 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001352void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353{
Nicholas Piggin62906022016-12-25 13:00:30 +10001354 struct page *page = compound_head(__page);
1355 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001356 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1357 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358}
1359EXPORT_SYMBOL(__lock_page);
1360
Nicholas Piggin62906022016-12-25 13:00:30 +10001361int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001362{
Nicholas Piggin62906022016-12-25 13:00:30 +10001363 struct page *page = compound_head(__page);
1364 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001365 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1366 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001367}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001368EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001369
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001370/*
1371 * Return values:
1372 * 1 - page is locked; mmap_sem is still held.
1373 * 0 - page is not locked.
1374 * mmap_sem has been released (up_read()), unless flags had both
1375 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1376 * which case mmap_sem is still held.
1377 *
1378 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1379 * with the page locked and the mmap_sem unperturbed.
1380 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001381int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1382 unsigned int flags)
1383{
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001384 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1385 /*
1386 * CAUTION! In this case, mmap_sem is not released
1387 * even though return 0.
1388 */
1389 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1390 return 0;
1391
1392 up_read(&mm->mmap_sem);
1393 if (flags & FAULT_FLAG_KILLABLE)
1394 wait_on_page_locked_killable(page);
1395 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001396 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001397 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001398 } else {
1399 if (flags & FAULT_FLAG_KILLABLE) {
1400 int ret;
1401
1402 ret = __lock_page_killable(page);
1403 if (ret) {
1404 up_read(&mm->mmap_sem);
1405 return 0;
1406 }
1407 } else
1408 __lock_page(page);
1409 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001410 }
1411}
1412
Randy Dunlap485bb992006-06-23 02:03:49 -07001413/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001414 * page_cache_next_miss() - Find the next gap in the page cache.
1415 * @mapping: Mapping.
1416 * @index: Index.
1417 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001418 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001419 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1420 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001421 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001422 * This function may be called under the rcu_read_lock. However, this will
1423 * not atomically search a snapshot of the cache at a single point in time.
1424 * For example, if a gap is created at index 5, then subsequently a gap is
1425 * created at index 10, page_cache_next_miss covering both indices may
1426 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001427 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001428 * Return: The index of the gap if found, otherwise an index outside the
1429 * range specified (in which case 'return - index >= max_scan' will be true).
1430 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001431 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001432pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001433 pgoff_t index, unsigned long max_scan)
1434{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001435 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001436
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001437 while (max_scan--) {
1438 void *entry = xas_next(&xas);
1439 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001440 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001441 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001442 break;
1443 }
1444
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001445 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001446}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001447EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001448
1449/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001450 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001451 * @mapping: Mapping.
1452 * @index: Index.
1453 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001454 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001455 * Search the range [max(index - max_scan + 1, 0), index] for the
1456 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001457 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001458 * This function may be called under the rcu_read_lock. However, this will
1459 * not atomically search a snapshot of the cache at a single point in time.
1460 * For example, if a gap is created at index 10, then subsequently a gap is
1461 * created at index 5, page_cache_prev_miss() covering both indices may
1462 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001463 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001464 * Return: The index of the gap if found, otherwise an index outside the
1465 * range specified (in which case 'index - return >= max_scan' will be true).
1466 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001467 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001468pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001469 pgoff_t index, unsigned long max_scan)
1470{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001471 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001472
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001473 while (max_scan--) {
1474 void *entry = xas_prev(&xas);
1475 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001476 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001477 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001478 break;
1479 }
1480
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001481 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001482}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001483EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001484
1485/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001486 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001487 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001488 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001489 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001490 * Looks up the page cache slot at @mapping & @offset. If there is a
1491 * page cache page, it is returned with an increased refcount.
1492 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001493 * If the slot holds a shadow entry of a previously evicted page, or a
1494 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001495 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001496 * Return: the found page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001498struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499{
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001500 XA_STATE(xas, &mapping->i_pages, offset);
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001501 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502
Nick Piggina60637c2008-07-25 19:45:31 -07001503 rcu_read_lock();
1504repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001505 xas_reset(&xas);
1506 page = xas_load(&xas);
1507 if (xas_retry(&xas, page))
1508 goto repeat;
1509 /*
1510 * A shadow entry of a recently evicted page, or a swap entry from
1511 * shmem/tmpfs. Return it without attempting to raise page count.
1512 */
1513 if (!page || xa_is_value(page))
1514 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001515
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001516 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001517 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001518
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001519 /*
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001520 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001521 * This is part of the lockless pagecache protocol. See
1522 * include/linux/pagemap.h for details.
1523 */
1524 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001525 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001526 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001527 }
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001528 page = find_subpage(page, offset);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001529out:
Nick Piggina60637c2008-07-25 19:45:31 -07001530 rcu_read_unlock();
1531
Linus Torvalds1da177e2005-04-16 15:20:36 -07001532 return page;
1533}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001534EXPORT_SYMBOL(find_get_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Randy Dunlap485bb992006-06-23 02:03:49 -07001536/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001537 * find_lock_entry - locate, pin and lock a page cache entry
1538 * @mapping: the address_space to search
1539 * @offset: the page cache index
1540 *
1541 * Looks up the page cache slot at @mapping & @offset. If there is a
1542 * page cache page, it is returned locked and with an increased
1543 * refcount.
1544 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001545 * If the slot holds a shadow entry of a previously evicted page, or a
1546 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001547 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001548 * find_lock_entry() may sleep.
Mike Rapoporta862f682019-03-05 15:48:42 -08001549 *
1550 * Return: the found page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001551 */
1552struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553{
1554 struct page *page;
1555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001557 page = find_get_entry(mapping, offset);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001558 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001559 lock_page(page);
1560 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001561 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001562 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001563 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001564 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001566 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 return page;
1569}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001570EXPORT_SYMBOL(find_lock_entry);
1571
1572/**
Mel Gorman2457aec2014-06-04 16:10:31 -07001573 * pagecache_get_page - find and get a page reference
Johannes Weiner0cd61442014-04-03 14:47:46 -07001574 * @mapping: the address_space to search
1575 * @offset: the page index
Mel Gorman2457aec2014-06-04 16:10:31 -07001576 * @fgp_flags: PCG flags
Michal Hocko45f87de2014-12-29 20:30:35 +01001577 * @gfp_mask: gfp mask to use for the page cache data page allocation
Johannes Weiner0cd61442014-04-03 14:47:46 -07001578 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001579 * Looks up the page cache slot at @mapping & @offset.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001580 *
Randy Dunlap75325182014-07-30 16:08:37 -07001581 * PCG flags modify how the page is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001582 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001583 * @fgp_flags can be:
1584 *
1585 * - FGP_ACCESSED: the page will be marked accessed
1586 * - FGP_LOCK: Page is return locked
1587 * - FGP_CREAT: If page is not present then a new page is allocated using
1588 * @gfp_mask and added to the page cache and the VM's LRU
1589 * list. The page is returned locked and with an increased
Mike Rapoporta862f682019-03-05 15:48:42 -08001590 * refcount.
Josef Bacika75d4c32019-03-13 11:44:14 -07001591 * - FGP_FOR_MMAP: Similar to FGP_CREAT, only we want to allow the caller to do
1592 * its own locking dance if the page is already in cache, or unlock the page
1593 * before returning if we had to add the page to pagecache.
Mel Gorman2457aec2014-06-04 16:10:31 -07001594 *
1595 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1596 * if the GFP flags specified for FGP_CREAT are atomic.
1597 *
1598 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001599 *
1600 * Return: the found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001601 */
Mel Gorman2457aec2014-06-04 16:10:31 -07001602struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
Michal Hocko45f87de2014-12-29 20:30:35 +01001603 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604{
Nick Piggineb2be182007-10-16 01:24:57 -07001605 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001606
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607repeat:
Mel Gorman2457aec2014-06-04 16:10:31 -07001608 page = find_get_entry(mapping, offset);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001609 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001610 page = NULL;
1611 if (!page)
1612 goto no_page;
1613
1614 if (fgp_flags & FGP_LOCK) {
1615 if (fgp_flags & FGP_NOWAIT) {
1616 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001617 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001618 return NULL;
1619 }
1620 } else {
1621 lock_page(page);
1622 }
1623
1624 /* Has the page been truncated? */
1625 if (unlikely(page->mapping != mapping)) {
1626 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001627 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001628 goto repeat;
1629 }
1630 VM_BUG_ON_PAGE(page->index != offset, page);
1631 }
1632
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001633 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001634 mark_page_accessed(page);
1635
1636no_page:
1637 if (!page && (fgp_flags & FGP_CREAT)) {
1638 int err;
1639 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001640 gfp_mask |= __GFP_WRITE;
1641 if (fgp_flags & FGP_NOFS)
1642 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001643
Michal Hocko45f87de2014-12-29 20:30:35 +01001644 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001645 if (!page)
1646 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001647
Josef Bacika75d4c32019-03-13 11:44:14 -07001648 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001649 fgp_flags |= FGP_LOCK;
1650
Hugh Dickinseb39d612014-08-06 16:06:43 -07001651 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001652 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001653 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001654
Matthew Wilcoxabc1be12018-04-20 14:56:20 -07001655 err = add_to_page_cache_lru(page, mapping, offset, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001656 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001657 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001658 page = NULL;
1659 if (err == -EEXIST)
1660 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001661 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001662
1663 /*
1664 * add_to_page_cache_lru locks the page, and for mmap we expect
1665 * an unlocked page.
1666 */
1667 if (page && (fgp_flags & FGP_FOR_MMAP))
1668 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001670
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 return page;
1672}
Mel Gorman2457aec2014-06-04 16:10:31 -07001673EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674
1675/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001676 * find_get_entries - gang pagecache lookup
1677 * @mapping: The address_space to search
1678 * @start: The starting page cache index
1679 * @nr_entries: The maximum number of entries
1680 * @entries: Where the resulting entries are placed
1681 * @indices: The cache indices corresponding to the entries in @entries
1682 *
1683 * find_get_entries() will search for and return a group of up to
1684 * @nr_entries entries in the mapping. The entries are placed at
1685 * @entries. find_get_entries() takes a reference against any actual
1686 * pages it returns.
1687 *
1688 * The search returns a group of mapping-contiguous page cache entries
1689 * with ascending indexes. There may be holes in the indices due to
1690 * not-present pages.
1691 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001692 * Any shadow entries of evicted pages, or swap entries from
1693 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001694 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001695 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001696 */
1697unsigned find_get_entries(struct address_space *mapping,
1698 pgoff_t start, unsigned int nr_entries,
1699 struct page **entries, pgoff_t *indices)
1700{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001701 XA_STATE(xas, &mapping->i_pages, start);
1702 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001703 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001704
1705 if (!nr_entries)
1706 return 0;
1707
1708 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001709 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001710 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001711 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001712 /*
1713 * A shadow entry of a recently evicted page, a swap
1714 * entry from shmem/tmpfs or a DAX entry. Return it
1715 * without attempting to raise page count.
1716 */
1717 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001718 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001719
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001720 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001721 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001722
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001723 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001724 if (unlikely(page != xas_reload(&xas)))
1725 goto put_page;
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001726 page = find_subpage(page, xas.xa_index);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001727
Johannes Weiner0cd61442014-04-03 14:47:46 -07001728export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001729 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001730 entries[ret] = page;
1731 if (++ret == nr_entries)
1732 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001733 continue;
1734put_page:
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001735 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001736retry:
1737 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001738 }
1739 rcu_read_unlock();
1740 return ret;
1741}
1742
1743/**
Jan Karab947cee2017-09-06 16:21:21 -07001744 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 * @mapping: The address_space to search
1746 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001747 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 * @nr_pages: The maximum number of pages
1749 * @pages: Where the resulting pages are placed
1750 *
Jan Karab947cee2017-09-06 16:21:21 -07001751 * find_get_pages_range() will search for and return a group of up to @nr_pages
1752 * pages in the mapping starting at index @start and up to index @end
1753 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1754 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 *
1756 * The search returns a group of mapping-contiguous pages with ascending
1757 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001758 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001760 * Return: the number of pages which were found. If this number is
1761 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001762 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 */
Jan Karab947cee2017-09-06 16:21:21 -07001764unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1765 pgoff_t end, unsigned int nr_pages,
1766 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001768 XA_STATE(xas, &mapping->i_pages, *start);
1769 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001770 unsigned ret = 0;
1771
1772 if (unlikely(!nr_pages))
1773 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774
Nick Piggina60637c2008-07-25 19:45:31 -07001775 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001776 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001777 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001778 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001779 /* Skip over shadow, swap and DAX entries */
1780 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001781 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001782
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001783 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001784 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001785
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001786 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001787 if (unlikely(page != xas_reload(&xas)))
1788 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001789
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001790 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001791 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001792 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001793 goto out;
1794 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001795 continue;
1796put_page:
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001797 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001798retry:
1799 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001800 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001801
Jan Karab947cee2017-09-06 16:21:21 -07001802 /*
1803 * We come here when there is no page beyond @end. We take care to not
1804 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001805 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07001806 * already broken anyway.
1807 */
1808 if (end == (pgoff_t)-1)
1809 *start = (pgoff_t)-1;
1810 else
1811 *start = end + 1;
1812out:
Nick Piggina60637c2008-07-25 19:45:31 -07001813 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07001814
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815 return ret;
1816}
1817
Jens Axboeebf43502006-04-27 08:46:01 +02001818/**
1819 * find_get_pages_contig - gang contiguous pagecache lookup
1820 * @mapping: The address_space to search
1821 * @index: The starting page index
1822 * @nr_pages: The maximum number of pages
1823 * @pages: Where the resulting pages are placed
1824 *
1825 * find_get_pages_contig() works exactly like find_get_pages(), except
1826 * that the returned number of pages are guaranteed to be contiguous.
1827 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001828 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02001829 */
1830unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1831 unsigned int nr_pages, struct page **pages)
1832{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001833 XA_STATE(xas, &mapping->i_pages, index);
1834 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001835 unsigned int ret = 0;
1836
1837 if (unlikely(!nr_pages))
1838 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001839
Nick Piggina60637c2008-07-25 19:45:31 -07001840 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001841 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001842 if (xas_retry(&xas, page))
1843 continue;
1844 /*
1845 * If the entry has been swapped out, we can stop looking.
1846 * No current caller is looking for DAX entries.
1847 */
1848 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001849 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001850
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001851 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001852 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001853
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001854 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001855 if (unlikely(page != xas_reload(&xas)))
1856 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001857
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001858 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001859 if (++ret == nr_pages)
1860 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001861 continue;
1862put_page:
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001863 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001864retry:
1865 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02001866 }
Nick Piggina60637c2008-07-25 19:45:31 -07001867 rcu_read_unlock();
1868 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001869}
David Howellsef71c152007-05-09 02:33:44 -07001870EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001871
Randy Dunlap485bb992006-06-23 02:03:49 -07001872/**
Jan Kara72b045a2017-11-15 17:34:33 -08001873 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001874 * @mapping: the address_space to search
1875 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08001876 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001877 * @tag: the tag index
1878 * @nr_pages: the maximum number of pages
1879 * @pages: where the resulting pages are placed
1880 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001881 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001882 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08001883 *
1884 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 */
Jan Kara72b045a2017-11-15 17:34:33 -08001886unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001887 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08001888 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001890 XA_STATE(xas, &mapping->i_pages, *index);
1891 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001892 unsigned ret = 0;
1893
1894 if (unlikely(!nr_pages))
1895 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896
Nick Piggina60637c2008-07-25 19:45:31 -07001897 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001898 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001899 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001900 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001901 /*
1902 * Shadow entries should never be tagged, but this iteration
1903 * is lockless so there is a window for page reclaim to evict
1904 * a page we saw tagged. Skip over it.
1905 */
1906 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07001907 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001908
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001909 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001910 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001911
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001912 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001913 if (unlikely(page != xas_reload(&xas)))
1914 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001915
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001916 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08001917 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001918 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08001919 goto out;
1920 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001921 continue;
1922put_page:
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07001923 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001924retry:
1925 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001926 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001927
Jan Kara72b045a2017-11-15 17:34:33 -08001928 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001929 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08001930 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001931 * iteration when there is a page at index -1 but that is already
1932 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08001933 */
1934 if (end == (pgoff_t)-1)
1935 *index = (pgoff_t)-1;
1936 else
1937 *index = end + 1;
1938out:
Nick Piggina60637c2008-07-25 19:45:31 -07001939 rcu_read_unlock();
1940
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 return ret;
1942}
Jan Kara72b045a2017-11-15 17:34:33 -08001943EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001945/*
1946 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1947 * a _large_ part of the i/o request. Imagine the worst scenario:
1948 *
1949 * ---R__________________________________________B__________
1950 * ^ reading here ^ bad block(assume 4k)
1951 *
1952 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1953 * => failing the whole request => read(R) => read(R+1) =>
1954 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1955 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1956 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1957 *
1958 * It is going insane. Fix it by quickly scaling down the readahead size.
1959 */
1960static void shrink_readahead_size_eio(struct file *filp,
1961 struct file_ra_state *ra)
1962{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001963 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001964}
1965
Randy Dunlap485bb992006-06-23 02:03:49 -07001966/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001967 * generic_file_buffered_read - generic file read routine
1968 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05001969 * @iter: data destination
1970 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001971 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001973 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 *
1975 * This is really ugly. But the goto's actually try to clarify some
1976 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08001977 *
1978 * Return:
1979 * * total number of bytes copied, including those the were already @written
1980 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001981 */
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001982static ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05001983 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001985 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001986 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001988 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001989 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001990 pgoff_t index;
1991 pgoff_t last_index;
1992 pgoff_t prev_index;
1993 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07001994 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05001995 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996
Wei Fangc2a97372016-10-07 17:01:52 -07001997 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08001998 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07001999 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2000
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002001 index = *ppos >> PAGE_SHIFT;
2002 prev_index = ra->prev_pos >> PAGE_SHIFT;
2003 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2004 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2005 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 for (;;) {
2008 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002009 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002010 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011 unsigned long nr, ret;
2012
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002015 if (fatal_signal_pending(current)) {
2016 error = -EINTR;
2017 goto out;
2018 }
2019
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002021 if (!page) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002022 if (iocb->ki_flags & IOCB_NOWAIT)
2023 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002024 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002025 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002026 index, last_index - index);
2027 page = find_get_page(mapping, index);
2028 if (unlikely(page == NULL))
2029 goto no_cached_page;
2030 }
2031 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07002032 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002033 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002034 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002036 if (!PageUptodate(page)) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002037 if (iocb->ki_flags & IOCB_NOWAIT) {
2038 put_page(page);
2039 goto would_block;
2040 }
2041
Mel Gormanebded022016-03-15 14:55:39 -07002042 /*
2043 * See comment in do_read_cache_page on why
2044 * wait_on_page_locked is used to avoid unnecessarily
2045 * serialisations and why it's safe.
2046 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002047 error = wait_on_page_locked_killable(page);
2048 if (unlikely(error))
2049 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002050 if (PageUptodate(page))
2051 goto page_ok;
2052
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002053 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002054 !mapping->a_ops->is_partially_uptodate)
2055 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002056 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002057 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002058 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002059 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002060 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002061 /* Did it get truncated before we got the lock? */
2062 if (!page->mapping)
2063 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002064 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002065 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002066 goto page_not_up_to_date_locked;
2067 unlock_page(page);
2068 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002069page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002070 /*
2071 * i_size must be checked after we know the page is Uptodate.
2072 *
2073 * Checking i_size after the check allows us to calculate
2074 * the correct value for "nr", which means the zero-filled
2075 * part of the page is not copied back to userspace (unless
2076 * another truncate extends the file - this is desired though).
2077 */
2078
2079 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002080 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002081 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002082 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002083 goto out;
2084 }
2085
2086 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002087 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002088 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002089 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002090 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002091 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002092 goto out;
2093 }
2094 }
2095 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096
2097 /* If users can be writing to this page using arbitrary
2098 * virtual addresses, take care about potential aliasing
2099 * before reading the page on the kernel side.
2100 */
2101 if (mapping_writably_mapped(mapping))
2102 flush_dcache_page(page);
2103
2104 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002105 * When a sequential read accesses a page several times,
2106 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 */
Jan Karaec0f1632007-05-06 14:49:25 -07002108 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 mark_page_accessed(page);
2110 prev_index = index;
2111
2112 /*
2113 * Ok, we have the page, and it's up-to-date, so
2114 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 */
Al Viro6e58e792014-02-03 17:07:03 -05002116
2117 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002119 index += offset >> PAGE_SHIFT;
2120 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002121 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002123 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002124 written += ret;
2125 if (!iov_iter_count(iter))
2126 goto out;
2127 if (ret < nr) {
2128 error = -EFAULT;
2129 goto out;
2130 }
2131 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132
2133page_not_up_to_date:
2134 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04002135 error = lock_page_killable(page);
2136 if (unlikely(error))
2137 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002139page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002140 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 if (!page->mapping) {
2142 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002143 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144 continue;
2145 }
2146
2147 /* Did somebody else fill it already? */
2148 if (PageUptodate(page)) {
2149 unlock_page(page);
2150 goto page_ok;
2151 }
2152
2153readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04002154 /*
2155 * A previous I/O error may have been due to temporary
2156 * failures, eg. multipath errors.
2157 * PG_error will be set again if readpage fails.
2158 */
2159 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 /* Start the actual read. The read will unlock the page. */
2161 error = mapping->a_ops->readpage(filp, page);
2162
Zach Brown994fc28c2005-12-15 14:28:17 -08002163 if (unlikely(error)) {
2164 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002165 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002166 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002167 goto find_page;
2168 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002170 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002171
2172 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04002173 error = lock_page_killable(page);
2174 if (unlikely(error))
2175 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176 if (!PageUptodate(page)) {
2177 if (page->mapping == NULL) {
2178 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002179 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 */
2181 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002182 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183 goto find_page;
2184 }
2185 unlock_page(page);
Fengguang Wu7ff81072007-10-16 01:24:35 -07002186 shrink_readahead_size_eio(filp, ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002187 error = -EIO;
2188 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189 }
2190 unlock_page(page);
2191 }
2192
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 goto page_ok;
2194
2195readpage_error:
2196 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002197 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 goto out;
2199
2200no_cached_page:
2201 /*
2202 * Ok, it wasn't cached, so we need to create a new
2203 * page..
2204 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002205 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002206 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002207 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002208 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002210 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002211 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002213 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002214 if (error == -EEXIST) {
2215 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002217 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 goto out;
2219 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 goto readpage;
2221 }
2222
Milosz Tanski3239d832017-08-29 16:13:19 +02002223would_block:
2224 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002226 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002227 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002228 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002229
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002230 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002231 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002232 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233}
2234
Randy Dunlap485bb992006-06-23 02:03:49 -07002235/**
Al Viro6abd2322014-04-04 14:20:57 -04002236 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002237 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002238 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002239 *
Al Viro6abd2322014-04-04 14:20:57 -04002240 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 * that can use the page cache directly.
Mike Rapoporta862f682019-03-05 15:48:42 -08002242 * Return:
2243 * * number of bytes copied, even for partial reads
2244 * * negative error code if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 */
2246ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002247generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002249 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002250 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002251
2252 if (!count)
2253 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254
Al Viro2ba48ce2015-04-09 13:52:01 -04002255 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002256 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002257 struct address_space *mapping = file->f_mapping;
2258 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002259 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002262 if (iocb->ki_flags & IOCB_NOWAIT) {
2263 if (filemap_range_has_page(mapping, iocb->ki_pos,
2264 iocb->ki_pos + count - 1))
2265 return -EAGAIN;
2266 } else {
2267 retval = filemap_write_and_wait_range(mapping,
2268 iocb->ki_pos,
2269 iocb->ki_pos + count - 1);
2270 if (retval < 0)
2271 goto out;
2272 }
Al Viroed978a82014-03-05 22:53:04 -05002273
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002274 file_accessed(file);
2275
Al Viro5ecda132017-04-13 14:13:36 -04002276 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002277 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002278 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002279 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002280 }
Al Viro5b47d592017-05-08 13:54:47 -04002281 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002282
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002283 /*
2284 * Btrfs can have a short DIO read if we encounter
2285 * compressed extents, so if there was an error, or if
2286 * we've already read everything we wanted to, or if
2287 * there was a short read because we hit EOF, go ahead
2288 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002289 * the rest of the read. Buffered reads will not work for
2290 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002291 */
Al Viro5ecda132017-04-13 14:13:36 -04002292 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002293 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002294 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295 }
2296
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002297 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298out:
2299 return retval;
2300}
Al Viroed978a82014-03-05 22:53:04 -05002301EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304#define MMAP_LOTSAMISS (100)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002305static struct file *maybe_unlock_mmap_for_io(struct vm_fault *vmf,
2306 struct file *fpin)
2307{
2308 int flags = vmf->flags;
2309
2310 if (fpin)
2311 return fpin;
2312
2313 /*
2314 * FAULT_FLAG_RETRY_NOWAIT means we don't want to wait on page locks or
2315 * anything, so we only pin the file and drop the mmap_sem if only
2316 * FAULT_FLAG_ALLOW_RETRY is set.
2317 */
2318 if ((flags & (FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_RETRY_NOWAIT)) ==
2319 FAULT_FLAG_ALLOW_RETRY) {
2320 fpin = get_file(vmf->vma->vm_file);
2321 up_read(&vmf->vma->vm_mm->mmap_sem);
2322 }
2323 return fpin;
2324}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002325
Linus Torvaldsef00e082009-06-16 15:31:25 -07002326/*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002327 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_sem
2328 * @vmf - the vm_fault for this fault.
2329 * @page - the page to lock.
2330 * @fpin - the pointer to the file we may pin (or is already pinned).
2331 *
2332 * This works similar to lock_page_or_retry in that it can drop the mmap_sem.
2333 * It differs in that it actually returns the page locked if it returns 1 and 0
2334 * if it couldn't lock the page. If we did have to drop the mmap_sem then fpin
2335 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002336 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002337static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2338 struct file **fpin)
2339{
2340 if (trylock_page(page))
2341 return 1;
2342
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002343 /*
2344 * NOTE! This will make us return with VM_FAULT_RETRY, but with
2345 * the mmap_sem still held. That's how FAULT_FLAG_RETRY_NOWAIT
2346 * is supposed to work. We have way too many special cases..
2347 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002348 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2349 return 0;
2350
2351 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2352 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2353 if (__lock_page_killable(page)) {
2354 /*
2355 * We didn't have the right flags to drop the mmap_sem,
2356 * but all fault_handlers only check for fatal signals
2357 * if we return VM_FAULT_RETRY, so we need to drop the
2358 * mmap_sem here and return 0 if we don't have a fpin.
2359 */
2360 if (*fpin == NULL)
2361 up_read(&vmf->vma->vm_mm->mmap_sem);
2362 return 0;
2363 }
2364 } else
2365 __lock_page(page);
2366 return 1;
2367}
2368
2369
2370/*
2371 * Synchronous readahead happens when we don't even find a page in the page
2372 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2373 * to drop the mmap sem we return the file that was pinned in order for us to do
2374 * that. If we didn't pin a file then we return NULL. The file that is
2375 * returned needs to be fput()'ed when we're done with it.
2376 */
2377static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002378{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002379 struct file *file = vmf->vma->vm_file;
2380 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002381 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002382 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002383 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002384
2385 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002386 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002387 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002388 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002389 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002390
Josef Bacik2a1180f2019-03-13 11:44:18 -07002391 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002392 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002393 page_cache_sync_readahead(mapping, ra, file, offset,
2394 ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002395 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002396 }
2397
Andi Kleen207d04b2011-05-24 17:12:29 -07002398 /* Avoid banging the cache line if not needed */
2399 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002400 ra->mmap_miss++;
2401
2402 /*
2403 * Do we miss much more than hit in this file? If so,
2404 * stop bothering with read-ahead. It will only hurt.
2405 */
2406 if (ra->mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002407 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002408
Wu Fengguangd30a1102009-06-16 15:31:30 -07002409 /*
2410 * mmap read-around
2411 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002412 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002413 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2414 ra->size = ra->ra_pages;
2415 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002416 ra_submit(ra, mapping, file);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002417 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002418}
2419
2420/*
2421 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002422 * so we want to possibly extend the readahead further. We return the file that
2423 * was pinned if we have to drop the mmap_sem in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002424 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002425static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2426 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002427{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002428 struct file *file = vmf->vma->vm_file;
2429 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002430 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002431 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002432 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002433
2434 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002435 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002436 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002437 if (ra->mmap_miss > 0)
2438 ra->mmap_miss--;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002439 if (PageReadahead(page)) {
2440 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002441 page_cache_async_readahead(mapping, ra, file,
2442 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002443 }
2444 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002445}
2446
Randy Dunlap485bb992006-06-23 02:03:49 -07002447/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002448 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002449 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002450 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002451 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002452 * mapped memory region to read in file data during a page fault.
2453 *
2454 * The goto's are kind of ugly, but this streamlines the normal case of having
2455 * it in the page cache, and handles the special cases reasonably without
2456 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002457 *
2458 * vma->vm_mm->mmap_sem must be held on entry.
2459 *
2460 * If our return value has VM_FAULT_RETRY set, it's because
2461 * lock_page_or_retry() returned 0.
2462 * The mmap_sem has usually been released in this case.
2463 * See __lock_page_or_retry() for the exception.
2464 *
2465 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2466 * has not been released.
2467 *
2468 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002469 *
2470 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002472vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002473{
2474 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002475 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002476 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 struct address_space *mapping = file->f_mapping;
2478 struct file_ra_state *ra = &file->f_ra;
2479 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002480 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002481 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002482 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002483 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002485 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2486 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002487 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002490 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002491 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002492 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002493 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002495 * We found the page, so try async readahead before
2496 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002497 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002498 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002499 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002500 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002501 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002502 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002503 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002504 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002505retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002506 page = pagecache_get_page(mapping, offset,
2507 FGP_CREAT|FGP_FOR_MMAP,
2508 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002509 if (!page) {
2510 if (fpin)
2511 goto out_retry;
Josef Bacika75d4c32019-03-13 11:44:14 -07002512 return vmf_error(-ENOMEM);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002513 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 }
2515
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002516 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2517 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002518
2519 /* Did it get truncated? */
2520 if (unlikely(page->mapping != mapping)) {
2521 unlock_page(page);
2522 put_page(page);
2523 goto retry_find;
2524 }
Sasha Levin309381fea2014-01-23 15:52:54 -08002525 VM_BUG_ON_PAGE(page->index != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002526
Linus Torvalds1da177e2005-04-16 15:20:36 -07002527 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002528 * We have a locked page in the page cache, now we need to check
2529 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 */
Nick Piggind00806b2007-07-19 01:46:57 -07002531 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 goto page_not_uptodate;
2533
Linus Torvaldsef00e082009-06-16 15:31:25 -07002534 /*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002535 * We've made it this far and we had to drop our mmap_sem, now is the
2536 * time to return to the upper layer and have it re-find the vma and
2537 * redo the fault.
2538 */
2539 if (fpin) {
2540 unlock_page(page);
2541 goto out_retry;
2542 }
2543
2544 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002545 * Found the page and have a reference on it.
2546 * We must recheck i_size under page lock.
2547 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002548 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2549 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002550 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002551 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002552 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002553 }
2554
Nick Piggind0217ac2007-07-19 01:47:03 -07002555 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002556 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002557
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559 /*
2560 * Umm, take care of errors if the page isn't up-to-date.
2561 * Try to re-read it _once_. We do this synchronously,
2562 * because there really aren't any performance issues here
2563 * and we need to check for errors.
2564 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002565 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002566 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002567 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002568 if (!error) {
2569 wait_on_page_locked(page);
2570 if (!PageUptodate(page))
2571 error = -EIO;
2572 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002573 if (fpin)
2574 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002575 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002576
2577 if (!error || error == AOP_TRUNCATED_PAGE)
2578 goto retry_find;
2579
2580 /* Things didn't work out. Return zero to tell the mm layer so. */
2581 shrink_readahead_size_eio(file, ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002582 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002583
2584out_retry:
2585 /*
2586 * We dropped the mmap_sem, we need to return to the fault handler to
2587 * re-find the vma and come back and find our hopefully still populated
2588 * page.
2589 */
2590 if (page)
2591 put_page(page);
2592 if (fpin)
2593 fput(fpin);
2594 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002595}
2596EXPORT_SYMBOL(filemap_fault);
2597
Jan Kara82b0f8c2016-12-14 15:06:58 -08002598void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002599 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002600{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002601 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002602 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002603 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002604 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002605 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07002606 struct page *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002607
2608 rcu_read_lock();
Matthew Wilcox070e8072018-05-17 00:08:30 -04002609 xas_for_each(&xas, page, end_pgoff) {
2610 if (xas_retry(&xas, page))
2611 continue;
2612 if (xa_is_value(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002613 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002614
Michal Hockoe0975b22018-12-28 00:38:36 -08002615 /*
2616 * Check for a locked page first, as a speculative
2617 * reference may adversely influence page migration.
2618 */
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07002619 if (PageLocked(page))
Michal Hockoe0975b22018-12-28 00:38:36 -08002620 goto next;
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07002621 if (!page_cache_get_speculative(page))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002622 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002623
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07002624 /* Has the page moved or been split? */
Matthew Wilcox070e8072018-05-17 00:08:30 -04002625 if (unlikely(page != xas_reload(&xas)))
2626 goto skip;
Matthew Wilcox5fd4ca22019-05-13 17:16:44 -07002627 page = find_subpage(page, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002628
2629 if (!PageUptodate(page) ||
2630 PageReadahead(page) ||
2631 PageHWPoison(page))
2632 goto skip;
2633 if (!trylock_page(page))
2634 goto skip;
2635
2636 if (page->mapping != mapping || !PageUptodate(page))
2637 goto unlock;
2638
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002639 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2640 if (page->index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002641 goto unlock;
2642
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002643 if (file->f_ra.mmap_miss > 0)
2644 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002645
Matthew Wilcox070e8072018-05-17 00:08:30 -04002646 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002647 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002648 vmf->pte += xas.xa_index - last_pgoff;
2649 last_pgoff = xas.xa_index;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002650 if (alloc_set_pte(vmf, NULL, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002651 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002652 unlock_page(page);
2653 goto next;
2654unlock:
2655 unlock_page(page);
2656skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002657 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002658next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002659 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002660 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002661 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002662 }
2663 rcu_read_unlock();
2664}
2665EXPORT_SYMBOL(filemap_map_pages);
2666
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002667vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002668{
2669 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002670 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002671 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002672
Jan Kara14da9202012-06-12 16:20:37 +02002673 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002674 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002675 lock_page(page);
2676 if (page->mapping != inode->i_mapping) {
2677 unlock_page(page);
2678 ret = VM_FAULT_NOPAGE;
2679 goto out;
2680 }
Jan Kara14da9202012-06-12 16:20:37 +02002681 /*
2682 * We mark the page dirty already here so that when freeze is in
2683 * progress, we are guaranteed that writeback during freezing will
2684 * see the dirty page and writeprotect it again.
2685 */
2686 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002687 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002688out:
Jan Kara14da9202012-06-12 16:20:37 +02002689 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002690 return ret;
2691}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002692
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002693const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002694 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002695 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002696 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697};
2698
2699/* This is used for a general mmap of a disk file */
2700
2701int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2702{
2703 struct address_space *mapping = file->f_mapping;
2704
2705 if (!mapping->a_ops->readpage)
2706 return -ENOEXEC;
2707 file_accessed(file);
2708 vma->vm_ops = &generic_file_vm_ops;
2709 return 0;
2710}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711
2712/*
2713 * This is for filesystems which do not implement ->writepage.
2714 */
2715int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2716{
2717 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2718 return -EINVAL;
2719 return generic_file_mmap(file, vma);
2720}
2721#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002722vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07002723{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002724 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07002725}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2727{
2728 return -ENOSYS;
2729}
2730int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2731{
2732 return -ENOSYS;
2733}
2734#endif /* CONFIG_MMU */
2735
Arnd Bergmann453972282018-04-13 15:35:27 -07002736EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002737EXPORT_SYMBOL(generic_file_mmap);
2738EXPORT_SYMBOL(generic_file_readonly_mmap);
2739
Sasha Levin67f9fd92014-04-03 14:48:18 -07002740static struct page *wait_on_page_read(struct page *page)
2741{
2742 if (!IS_ERR(page)) {
2743 wait_on_page_locked(page);
2744 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002745 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002746 page = ERR_PTR(-EIO);
2747 }
2748 }
2749 return page;
2750}
2751
Mel Gorman32b63522016-03-15 14:55:36 -07002752static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002753 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002754 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002755 void *data,
2756 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002757{
Nick Piggineb2be182007-10-16 01:24:57 -07002758 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 int err;
2760repeat:
2761 page = find_get_page(mapping, index);
2762 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08002763 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002764 if (!page)
2765 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002766 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002767 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002768 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002769 if (err == -EEXIST)
2770 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05002771 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002772 return ERR_PTR(err);
2773 }
Mel Gorman32b63522016-03-15 14:55:36 -07002774
2775filler:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776 err = filler(data, page);
2777 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002778 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002779 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780 }
Mel Gorman32b63522016-03-15 14:55:36 -07002781
2782 page = wait_on_page_read(page);
2783 if (IS_ERR(page))
2784 return page;
2785 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002786 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 if (PageUptodate(page))
2788 goto out;
2789
Mel Gormanebded022016-03-15 14:55:39 -07002790 /*
2791 * Page is not up to date and may be locked due one of the following
2792 * case a: Page is being filled and the page lock is held
2793 * case b: Read/write error clearing the page uptodate status
2794 * case c: Truncation in progress (page locked)
2795 * case d: Reclaim in progress
2796 *
2797 * Case a, the page will be up to date when the page is unlocked.
2798 * There is no need to serialise on the page lock here as the page
2799 * is pinned so the lock gives no additional protection. Even if the
2800 * the page is truncated, the data is still valid if PageUptodate as
2801 * it's a race vs truncate race.
2802 * Case b, the page will not be up to date
2803 * Case c, the page may be truncated but in itself, the data may still
2804 * be valid after IO completes as it's a read vs truncate race. The
2805 * operation must restart if the page is not uptodate on unlock but
2806 * otherwise serialising on page lock to stabilise the mapping gives
2807 * no additional guarantees to the caller as the page lock is
2808 * released before return.
2809 * Case d, similar to truncation. If reclaim holds the page lock, it
2810 * will be a race with remove_mapping that determines if the mapping
2811 * is valid on unlock but otherwise the data is valid and there is
2812 * no need to serialise with page lock.
2813 *
2814 * As the page lock gives no additional guarantee, we optimistically
2815 * wait on the page to be unlocked and check if it's up to date and
2816 * use the page if it is. Otherwise, the page lock is required to
2817 * distinguish between the different cases. The motivation is that we
2818 * avoid spurious serialisations and wakeups when multiple processes
2819 * wait on the same page for IO to complete.
2820 */
2821 wait_on_page_locked(page);
2822 if (PageUptodate(page))
2823 goto out;
2824
2825 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002826 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002827
2828 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002829 if (!page->mapping) {
2830 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002831 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002832 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 }
Mel Gormanebded022016-03-15 14:55:39 -07002834
2835 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002836 if (PageUptodate(page)) {
2837 unlock_page(page);
2838 goto out;
2839 }
Mel Gorman32b63522016-03-15 14:55:36 -07002840 goto filler;
2841
David Howellsc855ff32007-05-09 13:42:20 +01002842out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002843 mark_page_accessed(page);
2844 return page;
2845}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002846
2847/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002848 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002849 * @mapping: the page's address_space
2850 * @index: the page index
2851 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002852 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002853 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002854 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002855 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002856 *
2857 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002858 *
2859 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002860 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002861struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002862 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002863 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002864 void *data)
2865{
2866 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2867}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002868EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002869
2870/**
2871 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2872 * @mapping: the page's address_space
2873 * @index: the page index
2874 * @gfp: the page allocator flags to use if allocating
2875 *
2876 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002877 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002878 *
2879 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002880 *
2881 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002882 */
2883struct page *read_cache_page_gfp(struct address_space *mapping,
2884 pgoff_t index,
2885 gfp_t gfp)
2886{
2887 filler_t *filler = (filler_t *)mapping->a_ops->readpage;
2888
Sasha Levin67f9fd92014-04-03 14:48:18 -07002889 return do_read_cache_page(mapping, index, filler, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002890}
2891EXPORT_SYMBOL(read_cache_page_gfp);
2892
Nick Piggin2f718ff2007-10-16 01:24:59 -07002893/*
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002894 * Don't operate on ranges the page cache doesn't support, and don't exceed the
2895 * LFS limits. If pos is under the limit it becomes a short access. If it
2896 * exceeds the limit we return -EFBIG.
2897 */
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002898static int generic_write_check_limits(struct file *file, loff_t pos,
2899 loff_t *count)
2900{
Amir Goldstein646955c2019-06-05 08:04:48 -07002901 struct inode *inode = file->f_mapping->host;
2902 loff_t max_size = inode->i_sb->s_maxbytes;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002903 loff_t limit = rlimit(RLIMIT_FSIZE);
2904
2905 if (limit != RLIM_INFINITY) {
2906 if (pos >= limit) {
2907 send_sig(SIGXFSZ, current, 0);
2908 return -EFBIG;
2909 }
2910 *count = min(*count, limit - pos);
2911 }
2912
Amir Goldstein646955c2019-06-05 08:04:48 -07002913 if (!(file->f_flags & O_LARGEFILE))
2914 max_size = MAX_NON_LFS;
2915
2916 if (unlikely(pos >= max_size))
2917 return -EFBIG;
2918
2919 *count = min(*count, max_size - pos);
2920
2921 return 0;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002922}
2923
2924/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925 * Performs necessary checks before doing a write
2926 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002927 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928 * Returns appropriate error code that caller should return or
2929 * zero in case that write should be allowed.
2930 */
Al Viro3309dd02015-04-09 12:55:47 -04002931inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002932{
Al Viro3309dd02015-04-09 12:55:47 -04002933 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934 struct inode *inode = file->f_mapping->host;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002935 loff_t count;
2936 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937
Al Viro3309dd02015-04-09 12:55:47 -04002938 if (!iov_iter_count(from))
2939 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940
Al Viro0fa6b002015-04-04 04:05:48 -04002941 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002942 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002943 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002945 if ((iocb->ki_flags & IOCB_NOWAIT) && !(iocb->ki_flags & IOCB_DIRECT))
2946 return -EINVAL;
2947
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002948 count = iov_iter_count(from);
2949 ret = generic_write_check_limits(file, iocb->ki_pos, &count);
2950 if (ret)
2951 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002952
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002953 iov_iter_truncate(from, count);
Al Viro3309dd02015-04-09 12:55:47 -04002954 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955}
2956EXPORT_SYMBOL(generic_write_checks);
2957
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002958/*
2959 * Performs necessary checks before doing a clone.
2960 *
Amir Goldstein646955c2019-06-05 08:04:48 -07002961 * Can adjust amount of bytes to clone via @req_count argument.
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002962 * Returns appropriate error code that caller should return or
2963 * zero in case the clone should be allowed.
2964 */
2965int generic_remap_checks(struct file *file_in, loff_t pos_in,
2966 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11002967 loff_t *req_count, unsigned int remap_flags)
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002968{
2969 struct inode *inode_in = file_in->f_mapping->host;
2970 struct inode *inode_out = file_out->f_mapping->host;
2971 uint64_t count = *req_count;
2972 uint64_t bcount;
2973 loff_t size_in, size_out;
2974 loff_t bs = inode_out->i_sb->s_blocksize;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002975 int ret;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002976
2977 /* The start of both ranges must be aligned to an fs block. */
2978 if (!IS_ALIGNED(pos_in, bs) || !IS_ALIGNED(pos_out, bs))
2979 return -EINVAL;
2980
2981 /* Ensure offsets don't wrap. */
2982 if (pos_in + count < pos_in || pos_out + count < pos_out)
2983 return -EINVAL;
2984
2985 size_in = i_size_read(inode_in);
2986 size_out = i_size_read(inode_out);
2987
2988 /* Dedupe requires both ranges to be within EOF. */
Darrick J. Wong3d281932018-10-30 10:41:34 +11002989 if ((remap_flags & REMAP_FILE_DEDUP) &&
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002990 (pos_in >= size_in || pos_in + count > size_in ||
2991 pos_out >= size_out || pos_out + count > size_out))
2992 return -EINVAL;
2993
2994 /* Ensure the infile range is within the infile. */
2995 if (pos_in >= size_in)
2996 return -EINVAL;
2997 count = min(count, size_in - (uint64_t)pos_in);
2998
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002999 ret = generic_write_check_limits(file_out, pos_out, &count);
3000 if (ret)
3001 return ret;
3002
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003003 /*
3004 * If the user wanted us to link to the infile's EOF, round up to the
3005 * next block boundary for this check.
3006 *
3007 * Otherwise, make sure the count is also block-aligned, having
3008 * already confirmed the starting offsets' block alignment.
3009 */
3010 if (pos_in + count == size_in) {
3011 bcount = ALIGN(size_in, bs) - pos_in;
3012 } else {
3013 if (!IS_ALIGNED(count, bs))
Darrick J. Wongeca36542018-10-30 10:42:10 +11003014 count = ALIGN_DOWN(count, bs);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003015 bcount = count;
3016 }
3017
3018 /* Don't allow overlapped cloning within the same file. */
3019 if (inode_in == inode_out &&
3020 pos_out + bcount > pos_in &&
3021 pos_out < pos_in + bcount)
3022 return -EINVAL;
3023
Darrick J. Wongeca36542018-10-30 10:42:10 +11003024 /*
3025 * We shortened the request but the caller can't deal with that, so
3026 * bounce the request back to userspace.
3027 */
3028 if (*req_count != count && !(remap_flags & REMAP_FILE_CAN_SHORTEN))
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003029 return -EINVAL;
3030
Darrick J. Wongeca36542018-10-30 10:42:10 +11003031 *req_count = count;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003032 return 0;
3033}
3034
Amir Goldsteina3171352019-06-05 08:04:48 -07003035
3036/*
3037 * Performs common checks before doing a file copy/clone
3038 * from @file_in to @file_out.
3039 */
3040int generic_file_rw_checks(struct file *file_in, struct file *file_out)
3041{
3042 struct inode *inode_in = file_inode(file_in);
3043 struct inode *inode_out = file_inode(file_out);
3044
3045 /* Don't copy dirs, pipes, sockets... */
3046 if (S_ISDIR(inode_in->i_mode) || S_ISDIR(inode_out->i_mode))
3047 return -EISDIR;
3048 if (!S_ISREG(inode_in->i_mode) || !S_ISREG(inode_out->i_mode))
3049 return -EINVAL;
3050
3051 if (!(file_in->f_mode & FMODE_READ) ||
3052 !(file_out->f_mode & FMODE_WRITE) ||
3053 (file_out->f_flags & O_APPEND))
3054 return -EBADF;
3055
3056 return 0;
3057}
3058
Nick Pigginafddba42007-10-16 01:25:01 -07003059int pagecache_write_begin(struct file *file, struct address_space *mapping,
3060 loff_t pos, unsigned len, unsigned flags,
3061 struct page **pagep, void **fsdata)
3062{
3063 const struct address_space_operations *aops = mapping->a_ops;
3064
Nick Piggin4e02ed42008-10-29 14:00:55 -07003065 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003066 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003067}
3068EXPORT_SYMBOL(pagecache_write_begin);
3069
3070int pagecache_write_end(struct file *file, struct address_space *mapping,
3071 loff_t pos, unsigned len, unsigned copied,
3072 struct page *page, void *fsdata)
3073{
3074 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003075
Nick Piggin4e02ed42008-10-29 14:00:55 -07003076 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003077}
3078EXPORT_SYMBOL(pagecache_write_end);
3079
Linus Torvalds1da177e2005-04-16 15:20:36 -07003080ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003081generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003082{
3083 struct file *file = iocb->ki_filp;
3084 struct address_space *mapping = file->f_mapping;
3085 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003086 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003087 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003088 size_t write_len;
3089 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003090
Al Viro0c949332014-03-22 06:51:37 -04003091 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003092 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003093
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003094 if (iocb->ki_flags & IOCB_NOWAIT) {
3095 /* If there are pages to writeback, return */
3096 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003097 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003098 return -EAGAIN;
3099 } else {
3100 written = filemap_write_and_wait_range(mapping, pos,
3101 pos + write_len - 1);
3102 if (written)
3103 goto out;
3104 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003105
3106 /*
3107 * After a write we want buffered reads to be sure to go to disk to get
3108 * the new data. We invalidate clean cached page from the region we're
3109 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003110 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003111 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003112 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003113 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003114 /*
3115 * If a page can not be invalidated, return 0 to fall back
3116 * to buffered write.
3117 */
3118 if (written) {
3119 if (written == -EBUSY)
3120 return 0;
3121 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003122 }
3123
Al Viro639a93a52017-04-13 14:10:15 -04003124 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003125
3126 /*
3127 * Finally, try again to invalidate clean pages which might have been
3128 * cached by non-direct readahead, or faulted in by get_user_pages()
3129 * if the source of the write was an mmap'ed region of the file
3130 * we're writing. Either one is a pretty crazy thing to do,
3131 * so we don't support it 100%. If this invalidation
3132 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003133 *
3134 * Most of the time we do not need this since dio_complete() will do
3135 * the invalidation for us. However there are some file systems that
3136 * do not end up with dio_complete() being called, so let's not break
3137 * them by removing it completely
Christoph Hellwiga969e902008-07-23 21:27:04 -07003138 */
Lukas Czerner332391a2017-09-21 08:16:29 -06003139 if (mapping->nrpages)
3140 invalidate_inode_pages2_range(mapping,
3141 pos >> PAGE_SHIFT, end);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003142
Linus Torvalds1da177e2005-04-16 15:20:36 -07003143 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003144 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003145 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003146 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3147 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003148 mark_inode_dirty(inode);
3149 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003150 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003151 }
Al Viro639a93a52017-04-13 14:10:15 -04003152 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003153out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003154 return written;
3155}
3156EXPORT_SYMBOL(generic_file_direct_write);
3157
Nick Piggineb2be182007-10-16 01:24:57 -07003158/*
3159 * Find or create a page at the given pagecache position. Return the locked
3160 * page. This function is specifically for buffered writes.
3161 */
Nick Piggin54566b22009-01-04 12:00:53 -08003162struct page *grab_cache_page_write_begin(struct address_space *mapping,
3163 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003164{
Nick Piggineb2be182007-10-16 01:24:57 -07003165 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003166 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003167
Nick Piggin54566b22009-01-04 12:00:53 -08003168 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003169 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003170
Mel Gorman2457aec2014-06-04 16:10:31 -07003171 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003172 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003173 if (page)
3174 wait_for_stable_page(page);
3175
Nick Piggineb2be182007-10-16 01:24:57 -07003176 return page;
3177}
Nick Piggin54566b22009-01-04 12:00:53 -08003178EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003179
Al Viro3b93f912014-02-11 21:34:08 -05003180ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003181 struct iov_iter *i, loff_t pos)
3182{
3183 struct address_space *mapping = file->f_mapping;
3184 const struct address_space_operations *a_ops = mapping->a_ops;
3185 long status = 0;
3186 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003187 unsigned int flags = 0;
3188
Nick Pigginafddba42007-10-16 01:25:01 -07003189 do {
3190 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003191 unsigned long offset; /* Offset into pagecache page */
3192 unsigned long bytes; /* Bytes to write to page */
3193 size_t copied; /* Bytes copied from user */
3194 void *fsdata;
3195
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003196 offset = (pos & (PAGE_SIZE - 1));
3197 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003198 iov_iter_count(i));
3199
3200again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003201 /*
3202 * Bring in the user page that we will copy from _first_.
3203 * Otherwise there's a nasty deadlock on copying from the
3204 * same page as we're writing to, without it being marked
3205 * up-to-date.
3206 *
3207 * Not only is this an optimisation, but it is also required
3208 * to check that the address is actually valid, when atomic
3209 * usercopies are used, below.
3210 */
3211 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3212 status = -EFAULT;
3213 break;
3214 }
3215
Jan Kara296291c2015-10-22 13:32:21 -07003216 if (fatal_signal_pending(current)) {
3217 status = -EINTR;
3218 break;
3219 }
3220
Nick Piggin674b8922007-10-16 01:25:03 -07003221 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003222 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003223 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003224 break;
3225
anfei zhou931e80e2010-02-02 13:44:02 -08003226 if (mapping_writably_mapped(mapping))
3227 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003228
Nick Pigginafddba42007-10-16 01:25:01 -07003229 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003230 flush_dcache_page(page);
3231
3232 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3233 page, fsdata);
3234 if (unlikely(status < 0))
3235 break;
3236 copied = status;
3237
3238 cond_resched();
3239
Nick Piggin124d3b72008-02-02 15:01:17 +01003240 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003241 if (unlikely(copied == 0)) {
3242 /*
3243 * If we were unable to copy any data at all, we must
3244 * fall back to a single segment length write.
3245 *
3246 * If we didn't fallback here, we could livelock
3247 * because not all segments in the iov can be copied at
3248 * once without a pagefault.
3249 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003250 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003251 iov_iter_single_seg_count(i));
3252 goto again;
3253 }
Nick Pigginafddba42007-10-16 01:25:01 -07003254 pos += copied;
3255 written += copied;
3256
3257 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003258 } while (iov_iter_count(i));
3259
3260 return written ? written : status;
3261}
Al Viro3b93f912014-02-11 21:34:08 -05003262EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003263
Jan Karae4dd9de2009-08-17 18:10:06 +02003264/**
Al Viro81742022014-04-03 03:17:43 -04003265 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003266 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003267 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003268 *
3269 * This function does all the work needed for actually writing data to a
3270 * file. It does all basic checks, removes SUID from the file, updates
3271 * modification times and calls proper subroutines depending on whether we
3272 * do direct IO or a standard buffered write.
3273 *
3274 * It expects i_mutex to be grabbed unless we work on a block device or similar
3275 * object which does not need locking at all.
3276 *
3277 * This function does *not* take care of syncing data in case of O_SYNC write.
3278 * A caller has to handle it. This is mainly due to the fact that we want to
3279 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003280 *
3281 * Return:
3282 * * number of bytes written, even for truncated writes
3283 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003284 */
Al Viro81742022014-04-03 03:17:43 -04003285ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003286{
3287 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003288 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003290 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003291 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003292 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003293
Linus Torvalds1da177e2005-04-16 15:20:36 -07003294 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003295 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003296 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003297 if (err)
3298 goto out;
3299
Josef Bacikc3b2da32012-03-26 09:59:21 -04003300 err = file_update_time(file);
3301 if (err)
3302 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003303
Al Viro2ba48ce2015-04-09 13:52:01 -04003304 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003305 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003306
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003307 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003308 /*
3309 * If the write stopped short of completing, fall back to
3310 * buffered writes. Some filesystems do this for writes to
3311 * holes, for example. For DAX files, a buffered write will
3312 * not succeed (even if it did, DAX does not handle dirty
3313 * page-cache pages correctly).
3314 */
Al Viro0b8def92015-04-07 10:22:53 -04003315 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003316 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003317
Al Viro0b8def92015-04-07 10:22:53 -04003318 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003319 /*
Al Viro3b93f912014-02-11 21:34:08 -05003320 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003321 * then we want to return the number of bytes which were
3322 * direct-written, or the error code if that was zero. Note
3323 * that this differs from normal direct-io semantics, which
3324 * will return -EFOO even if some bytes were written.
3325 */
Al Viro60bb4522014-08-08 12:39:16 -04003326 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003327 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003328 goto out;
3329 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003330 /*
3331 * We need to ensure that the page cache pages are written to
3332 * disk and invalidated to preserve the expected O_DIRECT
3333 * semantics.
3334 */
Al Viro3b93f912014-02-11 21:34:08 -05003335 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003336 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003337 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003338 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003339 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003340 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003341 pos >> PAGE_SHIFT,
3342 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003343 } else {
3344 /*
3345 * We don't know how much we wrote, so just return
3346 * the number of bytes which were direct-written
3347 */
3348 }
3349 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003350 written = generic_perform_write(file, from, iocb->ki_pos);
3351 if (likely(written > 0))
3352 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003353 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003354out:
3355 current->backing_dev_info = NULL;
3356 return written ? written : err;
3357}
Al Viro81742022014-04-03 03:17:43 -04003358EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003359
Jan Karae4dd9de2009-08-17 18:10:06 +02003360/**
Al Viro81742022014-04-03 03:17:43 -04003361 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003362 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003363 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003364 *
Al Viro81742022014-04-03 03:17:43 -04003365 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003366 * filesystems. It takes care of syncing the file in case of O_SYNC file
3367 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003368 * Return:
3369 * * negative error code if no data has been written at all of
3370 * vfs_fsync_range() failed for a synchronous write
3371 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003372 */
Al Viro81742022014-04-03 03:17:43 -04003373ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003374{
3375 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003376 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003377 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003378
Al Viro59551022016-01-22 15:40:57 -05003379 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003380 ret = generic_write_checks(iocb, from);
3381 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003382 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003383 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003384
Christoph Hellwige2592212016-04-07 08:52:01 -07003385 if (ret > 0)
3386 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003387 return ret;
3388}
Al Viro81742022014-04-03 03:17:43 -04003389EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003390
David Howellscf9a2ae2006-08-29 19:05:54 +01003391/**
3392 * try_to_release_page() - release old fs-specific metadata on a page
3393 *
3394 * @page: the page which the kernel is trying to free
3395 * @gfp_mask: memory allocation flags (and I/O mode)
3396 *
3397 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003398 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003399 *
David Howells266cf652009-04-03 16:42:36 +01003400 * This may also be called if PG_fscache is set on a page, indicating that the
3401 * page is known to the local caching routines.
3402 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003403 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003404 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003405 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003406 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003407 */
3408int try_to_release_page(struct page *page, gfp_t gfp_mask)
3409{
3410 struct address_space * const mapping = page->mapping;
3411
3412 BUG_ON(!PageLocked(page));
3413 if (PageWriteback(page))
3414 return 0;
3415
3416 if (mapping && mapping->a_ops->releasepage)
3417 return mapping->a_ops->releasepage(page, gfp_mask);
3418 return try_to_free_buffers(page);
3419}
3420
3421EXPORT_SYMBOL(try_to_release_page);