blob: 0b301103ea80e4c82dbc0aab9dc817b2d413b1ff [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));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700129 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500130 }
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 Wilcox (Oracle)41011962019-09-23 15:34:52 -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 Wilcox (Oracle)41011962019-09-23 15:34:52 -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 Wilcox (Oracle)41011962019-09-23 15:34:52 -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 Wilcox (Oracle)41011962019-09-23 15:34:52 -0700302 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800303 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -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 Wilcox (Oracle)41011962019-09-23 15:34:52 -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;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700319 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -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 + compound_nr(page) - 1 == xas.xa_index)
333 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500334 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800335 total_pages++;
336 }
337 mapping->nrpages -= total_pages;
338}
339
340void delete_from_page_cache_batch(struct address_space *mapping,
341 struct pagevec *pvec)
342{
343 int i;
344 unsigned long flags;
345
346 if (!pagevec_count(pvec))
347 return;
348
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700349 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800350 for (i = 0; i < pagevec_count(pvec); i++) {
351 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
352
353 unaccount_page_cache_page(mapping, pvec->pages[i]);
354 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500355 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700356 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800357
358 for (i = 0; i < pagevec_count(pvec); i++)
359 page_cache_free_page(mapping, pvec->pages[i]);
360}
361
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200362int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700363{
364 int ret = 0;
365 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700366 if (test_bit(AS_ENOSPC, &mapping->flags) &&
367 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700368 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700369 if (test_bit(AS_EIO, &mapping->flags) &&
370 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700371 ret = -EIO;
372 return ret;
373}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200374EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700375
Jeff Layton76341ca2017-07-06 07:02:22 -0400376static int filemap_check_and_keep_errors(struct address_space *mapping)
377{
378 /* Check for outstanding write errors */
379 if (test_bit(AS_EIO, &mapping->flags))
380 return -EIO;
381 if (test_bit(AS_ENOSPC, &mapping->flags))
382 return -ENOSPC;
383 return 0;
384}
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700387 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700388 * @mapping: address space structure to write
389 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800390 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700391 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700393 * Start writeback against all of a mapping's dirty pages that lie
394 * within the byte offsets <start, end> inclusive.
395 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700397 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 * these two operations is that if a dirty page/buffer is encountered, it must
399 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800400 *
401 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800403int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
404 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
406 int ret;
407 struct writeback_control wbc = {
408 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800409 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700410 .range_start = start,
411 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 };
413
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700414 if (!mapping_cap_writeback_dirty(mapping) ||
415 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 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/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400557 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
558 * @mapping: 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 given address space in the
563 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
564 * this function does not clear error status of the address space.
565 *
566 * Use this function if callers don't handle errors themselves. Expected
567 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
568 * fsfreeze(8)
569 */
570int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
571 loff_t start_byte, loff_t end_byte)
572{
573 __filemap_fdatawait_range(mapping, start_byte, end_byte);
574 return filemap_check_and_keep_errors(mapping);
575}
576EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
577
578/**
Jeff Laytona823e452017-07-28 07:24:43 -0400579 * file_fdatawait_range - wait for writeback to complete
580 * @file: file pointing to address space structure to wait for
581 * @start_byte: offset in bytes where the range starts
582 * @end_byte: offset in bytes where the range ends (inclusive)
583 *
584 * Walk the list of under-writeback pages of the address space that file
585 * refers to, in the given range and wait for all of them. Check error
586 * status of the address space vs. the file->f_wb_err cursor and return it.
587 *
588 * Since the error status of the file is advanced by this function,
589 * callers are responsible for checking the return value and handling and/or
590 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800591 *
592 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400593 */
594int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
595{
596 struct address_space *mapping = file->f_mapping;
597
598 __filemap_fdatawait_range(mapping, start_byte, end_byte);
599 return file_check_and_advance_wb_err(file);
600}
601EXPORT_SYMBOL(file_fdatawait_range);
602
603/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800604 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
605 * @mapping: address space structure to wait for
606 *
607 * Walk the list of under-writeback pages of the given address space
608 * and wait for all of them. Unlike filemap_fdatawait(), this function
609 * does not clear error status of the address space.
610 *
611 * Use this function if callers don't handle errors themselves. Expected
612 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
613 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800614 *
615 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800616 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400617int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800618{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400619 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400620 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800621}
Jeff Layton76341ca2017-07-06 07:02:22 -0400622EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800623
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700624/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400625static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700627 if (dax_mapping(mapping))
628 return mapping->nrexceptional;
629
630 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
633int filemap_write_and_wait(struct address_space *mapping)
634{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800635 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Jeff Layton9326c9b2017-07-26 10:21:11 -0400637 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800638 err = filemap_fdatawrite(mapping);
639 /*
640 * Even if the above returned error, the pages may be
641 * written partially (e.g. -ENOSPC), so we wait for it.
642 * But the -EIO is special case, it may indicate the worst
643 * thing (e.g. bug) happened, so we avoid waiting for it.
644 */
645 if (err != -EIO) {
646 int err2 = filemap_fdatawait(mapping);
647 if (!err)
648 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400649 } else {
650 /* Clear any previously stored errors */
651 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800652 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700653 } else {
654 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800656 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657}
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800658EXPORT_SYMBOL(filemap_write_and_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Randy Dunlap485bb992006-06-23 02:03:49 -0700660/**
661 * filemap_write_and_wait_range - write out & wait on a file range
662 * @mapping: the address_space for the pages
663 * @lstart: offset in bytes where the range starts
664 * @lend: offset in bytes where the range ends (inclusive)
665 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800666 * Write out and wait upon file offsets lstart->lend, inclusive.
667 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300668 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800669 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800670 *
671 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800672 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673int filemap_write_and_wait_range(struct address_space *mapping,
674 loff_t lstart, loff_t lend)
675{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800676 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Jeff Layton9326c9b2017-07-26 10:21:11 -0400678 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800679 err = __filemap_fdatawrite_range(mapping, lstart, lend,
680 WB_SYNC_ALL);
681 /* See comment of filemap_write_and_wait() */
682 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200683 int err2 = filemap_fdatawait_range(mapping,
684 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800685 if (!err)
686 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400687 } else {
688 /* Clear any previously stored errors */
689 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800690 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700691 } else {
692 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800694 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695}
Chris Masonf6995582009-04-15 13:22:37 -0400696EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
Jeff Layton5660e132017-07-06 07:02:25 -0400698void __filemap_set_wb_err(struct address_space *mapping, int err)
699{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400700 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400701
702 trace_filemap_set_wb_err(mapping, eseq);
703}
704EXPORT_SYMBOL(__filemap_set_wb_err);
705
706/**
707 * file_check_and_advance_wb_err - report wb error (if any) that was previously
708 * and advance wb_err to current one
709 * @file: struct file on which the error is being reported
710 *
711 * When userland calls fsync (or something like nfsd does the equivalent), we
712 * want to report any writeback errors that occurred since the last fsync (or
713 * since the file was opened if there haven't been any).
714 *
715 * Grab the wb_err from the mapping. If it matches what we have in the file,
716 * then just quickly return 0. The file is all caught up.
717 *
718 * If it doesn't match, then take the mapping value, set the "seen" flag in
719 * it and try to swap it into place. If it works, or another task beat us
720 * to it with the new value, then update the f_wb_err and return the error
721 * portion. The error at this point must be reported via proper channels
722 * (a'la fsync, or NFS COMMIT operation, etc.).
723 *
724 * While we handle mapping->wb_err with atomic operations, the f_wb_err
725 * value is protected by the f_lock since we must ensure that it reflects
726 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800727 *
728 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400729 */
730int file_check_and_advance_wb_err(struct file *file)
731{
732 int err = 0;
733 errseq_t old = READ_ONCE(file->f_wb_err);
734 struct address_space *mapping = file->f_mapping;
735
736 /* Locklessly handle the common case where nothing has changed */
737 if (errseq_check(&mapping->wb_err, old)) {
738 /* Something changed, must use slow path */
739 spin_lock(&file->f_lock);
740 old = file->f_wb_err;
741 err = errseq_check_and_advance(&mapping->wb_err,
742 &file->f_wb_err);
743 trace_file_check_and_advance_wb_err(file, old);
744 spin_unlock(&file->f_lock);
745 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700746
747 /*
748 * We're mostly using this function as a drop in replacement for
749 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
750 * that the legacy code would have had on these flags.
751 */
752 clear_bit(AS_EIO, &mapping->flags);
753 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400754 return err;
755}
756EXPORT_SYMBOL(file_check_and_advance_wb_err);
757
758/**
759 * file_write_and_wait_range - write out & wait on a file range
760 * @file: file pointing to address_space with pages
761 * @lstart: offset in bytes where the range starts
762 * @lend: offset in bytes where the range ends (inclusive)
763 *
764 * Write out and wait upon file offsets lstart->lend, inclusive.
765 *
766 * Note that @lend is inclusive (describes the last byte to be written) so
767 * that this function can be used to write to the very end-of-file (end = -1).
768 *
769 * After writing out and waiting on the data, we check and advance the
770 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800771 *
772 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400773 */
774int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
775{
776 int err = 0, err2;
777 struct address_space *mapping = file->f_mapping;
778
Jeff Layton9326c9b2017-07-26 10:21:11 -0400779 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400780 err = __filemap_fdatawrite_range(mapping, lstart, lend,
781 WB_SYNC_ALL);
782 /* See comment of filemap_write_and_wait() */
783 if (err != -EIO)
784 __filemap_fdatawait_range(mapping, lstart, lend);
785 }
786 err2 = file_check_and_advance_wb_err(file);
787 if (!err)
788 err = err2;
789 return err;
790}
791EXPORT_SYMBOL(file_write_and_wait_range);
792
Randy Dunlap485bb992006-06-23 02:03:49 -0700793/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700794 * replace_page_cache_page - replace a pagecache page with a new one
795 * @old: page to be replaced
796 * @new: page to replace with
797 * @gfp_mask: allocation mode
798 *
799 * This function replaces a page in the pagecache with a new one. On
800 * success it acquires the pagecache reference for the new page and
801 * drops it for the old page. Both the old and new pages must be
802 * locked. This function does not add the new page to the LRU, the
803 * caller must do that.
804 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500805 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800806 *
807 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700808 */
809int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
810{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500811 struct address_space *mapping = old->mapping;
812 void (*freepage)(struct page *) = mapping->a_ops->freepage;
813 pgoff_t offset = old->index;
814 XA_STATE(xas, &mapping->i_pages, offset);
815 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700816
Sasha Levin309381fea2014-01-23 15:52:54 -0800817 VM_BUG_ON_PAGE(!PageLocked(old), old);
818 VM_BUG_ON_PAGE(!PageLocked(new), new);
819 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700820
Matthew Wilcox74d60952017-11-17 10:01:45 -0500821 get_page(new);
822 new->mapping = mapping;
823 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700824
Matthew Wilcox74d60952017-11-17 10:01:45 -0500825 xas_lock_irqsave(&xas, flags);
826 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700827
Matthew Wilcox74d60952017-11-17 10:01:45 -0500828 old->mapping = NULL;
829 /* hugetlb pages do not participate in page cache accounting. */
830 if (!PageHuge(old))
831 __dec_node_page_state(new, NR_FILE_PAGES);
832 if (!PageHuge(new))
833 __inc_node_page_state(new, NR_FILE_PAGES);
834 if (PageSwapBacked(old))
835 __dec_node_page_state(new, NR_SHMEM);
836 if (PageSwapBacked(new))
837 __inc_node_page_state(new, NR_SHMEM);
838 xas_unlock_irqrestore(&xas, flags);
839 mem_cgroup_migrate(old, new);
840 if (freepage)
841 freepage(old);
842 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700843
Matthew Wilcox74d60952017-11-17 10:01:45 -0500844 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700845}
846EXPORT_SYMBOL_GPL(replace_page_cache_page);
847
Johannes Weinera5289102014-04-03 14:47:51 -0700848static int __add_to_page_cache_locked(struct page *page,
849 struct address_space *mapping,
850 pgoff_t offset, gfp_t gfp_mask,
851 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700852{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500853 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700854 int huge = PageHuge(page);
855 struct mem_cgroup *memcg;
Nick Piggine2867812008-07-25 19:45:30 -0700856 int error;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500857 void *old;
Nick Piggine2867812008-07-25 19:45:30 -0700858
Sasha Levin309381fea2014-01-23 15:52:54 -0800859 VM_BUG_ON_PAGE(!PageLocked(page), page);
860 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500861 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700862
Johannes Weiner00501b52014-08-08 14:19:20 -0700863 if (!huge) {
864 error = mem_cgroup_try_charge(page, current->mm,
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800865 gfp_mask, &memcg, false);
Johannes Weiner00501b52014-08-08 14:19:20 -0700866 if (error)
867 return error;
868 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300870 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700871 page->mapping = mapping;
872 page->index = offset;
873
Matthew Wilcox74d60952017-11-17 10:01:45 -0500874 do {
875 xas_lock_irq(&xas);
876 old = xas_load(&xas);
877 if (old && !xa_is_value(old))
878 xas_set_err(&xas, -EEXIST);
879 xas_store(&xas, page);
880 if (xas_error(&xas))
881 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700882
Matthew Wilcox74d60952017-11-17 10:01:45 -0500883 if (xa_is_value(old)) {
884 mapping->nrexceptional--;
885 if (shadowp)
886 *shadowp = old;
887 }
888 mapping->nrpages++;
889
890 /* hugetlb pages do not participate in page cache accounting */
891 if (!huge)
892 __inc_node_page_state(page, NR_FILE_PAGES);
893unlock:
894 xas_unlock_irq(&xas);
895 } while (xas_nomem(&xas, gfp_mask & GFP_RECLAIM_MASK));
896
897 if (xas_error(&xas))
898 goto error;
899
Johannes Weiner00501b52014-08-08 14:19:20 -0700900 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800901 mem_cgroup_commit_charge(page, memcg, false, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700902 trace_mm_filemap_add_to_page_cache(page);
903 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500904error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700905 page->mapping = NULL;
906 /* Leave page->index set: truncation relies upon it */
Johannes Weiner00501b52014-08-08 14:19:20 -0700907 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800908 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300909 put_page(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500910 return xas_error(&xas);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700912ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700913
914/**
915 * add_to_page_cache_locked - add a locked page to the pagecache
916 * @page: page to add
917 * @mapping: the page's address_space
918 * @offset: page index
919 * @gfp_mask: page allocation mode
920 *
921 * This function is used to add a page to the pagecache. It must be locked.
922 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800923 *
924 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700925 */
926int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
927 pgoff_t offset, gfp_t gfp_mask)
928{
929 return __add_to_page_cache_locked(page, mapping, offset,
930 gfp_mask, NULL);
931}
Nick Piggine2867812008-07-25 19:45:30 -0700932EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
934int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400935 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936{
Johannes Weinera5289102014-04-03 14:47:51 -0700937 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700938 int ret;
939
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800940 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700941 ret = __add_to_page_cache_locked(page, mapping, offset,
942 gfp_mask, &shadow);
943 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800944 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700945 else {
946 /*
947 * The page might have been evicted from cache only
948 * recently, in which case it should be activated like
949 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700950 * The exception is pages getting rewritten; evicting other
951 * data from the working set, only to cache data that will
952 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700953 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700954 WARN_ON_ONCE(PageActive(page));
955 if (!(gfp_mask & __GFP_WRITE) && shadow)
956 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700957 lru_cache_add(page);
958 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 return ret;
960}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300961EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
Paul Jackson44110fe2006-03-24 03:16:04 -0800963#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700964struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800965{
Miao Xiec0ff7452010-05-24 14:32:08 -0700966 int n;
967 struct page *page;
968
Paul Jackson44110fe2006-03-24 03:16:04 -0800969 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700970 unsigned int cpuset_mems_cookie;
971 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700972 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700973 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700974 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700975 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700976
Miao Xiec0ff7452010-05-24 14:32:08 -0700977 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800978 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700979 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800980}
Nick Piggin2ae88142006-10-28 10:38:23 -0700981EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800982#endif
983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984/*
985 * In order to wait for pages to become available there must be
986 * waitqueues associated with pages. By using a hash table of
987 * waitqueues where the bucket discipline is to maintain all
988 * waiters on the same queue and wake all when any of the pages
989 * become available, and for the woken contexts to check to be
990 * sure the appropriate page became available, this saves space
991 * at a cost of "thundering herd" phenomena during rare hash
992 * collisions.
993 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000994#define PAGE_WAIT_TABLE_BITS 8
995#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
996static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
997
998static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700999{
Nicholas Piggin62906022016-12-25 13:00:30 +10001000 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001}
Nicholas Piggin62906022016-12-25 13:00:30 +10001002
1003void __init pagecache_init(void)
1004{
1005 int i;
1006
1007 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1008 init_waitqueue_head(&page_wait_table[i]);
1009
1010 page_writeback_init();
1011}
1012
Linus Torvalds3510ca22017-08-27 13:55:12 -07001013/* This has the same layout as wait_bit_key - see fs/cachefiles/rdwr.c */
Nicholas Piggin62906022016-12-25 13:00:30 +10001014struct wait_page_key {
1015 struct page *page;
1016 int bit_nr;
1017 int page_match;
1018};
1019
1020struct wait_page_queue {
1021 struct page *page;
1022 int bit_nr;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001023 wait_queue_entry_t wait;
Nicholas Piggin62906022016-12-25 13:00:30 +10001024};
1025
Ingo Molnarac6424b2017-06-20 12:06:13 +02001026static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001027{
1028 struct wait_page_key *key = arg;
1029 struct wait_page_queue *wait_page
1030 = container_of(wait, struct wait_page_queue, wait);
1031
1032 if (wait_page->page != key->page)
1033 return 0;
1034 key->page_match = 1;
1035
1036 if (wait_page->bit_nr != key->bit_nr)
1037 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001038
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001039 /*
1040 * Stop walking if it's locked.
1041 * Is this safe if put_and_wait_on_page_locked() is in use?
1042 * Yes: the waker must hold a reference to this page, and if PG_locked
1043 * has now already been set by another task, that task must also hold
1044 * a reference to the *same usage* of this page; so there is no need
1045 * to walk on to wake even the put_and_wait_on_page_locked() callers.
1046 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001047 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds3510ca22017-08-27 13:55:12 -07001048 return -1;
Nicholas Piggin62906022016-12-25 13:00:30 +10001049
1050 return autoremove_wake_function(wait, mode, sync, key);
1051}
1052
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001053static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001054{
1055 wait_queue_head_t *q = page_waitqueue(page);
1056 struct wait_page_key key;
1057 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001058 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001059
1060 key.page = page;
1061 key.bit_nr = bit_nr;
1062 key.page_match = 0;
1063
Tim Chen11a19c72017-08-25 09:13:55 -07001064 bookmark.flags = 0;
1065 bookmark.private = NULL;
1066 bookmark.func = NULL;
1067 INIT_LIST_HEAD(&bookmark.entry);
1068
Nicholas Piggin62906022016-12-25 13:00:30 +10001069 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001070 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1071
1072 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1073 /*
1074 * Take a breather from holding the lock,
1075 * allow pages that finish wake up asynchronously
1076 * to acquire the lock and remove themselves
1077 * from wait queue
1078 */
1079 spin_unlock_irqrestore(&q->lock, flags);
1080 cpu_relax();
1081 spin_lock_irqsave(&q->lock, flags);
1082 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1083 }
1084
Nicholas Piggin62906022016-12-25 13:00:30 +10001085 /*
1086 * It is possible for other pages to have collided on the waitqueue
1087 * hash, so in that case check for a page match. That prevents a long-
1088 * term waiter
1089 *
1090 * It is still possible to miss a case here, when we woke page waiters
1091 * and removed them from the waitqueue, but there are still other
1092 * page waiters.
1093 */
1094 if (!waitqueue_active(q) || !key.page_match) {
1095 ClearPageWaiters(page);
1096 /*
1097 * It's possible to miss clearing Waiters here, when we woke
1098 * our page waiters, but the hashed waitqueue has waiters for
1099 * other pages on it.
1100 *
1101 * That's okay, it's a rare case. The next waker will clear it.
1102 */
1103 }
1104 spin_unlock_irqrestore(&q->lock, flags);
1105}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001106
1107static void wake_up_page(struct page *page, int bit)
1108{
1109 if (!PageWaiters(page))
1110 return;
1111 wake_up_page_bit(page, bit);
1112}
Nicholas Piggin62906022016-12-25 13:00:30 +10001113
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001114/*
1115 * A choice of three behaviors for wait_on_page_bit_common():
1116 */
1117enum behavior {
1118 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1119 * __lock_page() waiting on then setting PG_locked.
1120 */
1121 SHARED, /* Hold ref to page and check the bit when woken, like
1122 * wait_on_page_writeback() waiting on PG_writeback.
1123 */
1124 DROP, /* Drop ref to page before wait, no check when woken,
1125 * like put_and_wait_on_page_locked() on PG_locked.
1126 */
1127};
1128
Nicholas Piggin62906022016-12-25 13:00:30 +10001129static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001130 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001131{
1132 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001133 wait_queue_entry_t *wait = &wait_page.wait;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001134 bool bit_is_set;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001135 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001136 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001137 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001138 int ret = 0;
1139
Johannes Weinereb414682018-10-26 15:06:27 -07001140 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001141 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001142 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001143 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001144 delayacct = true;
1145 }
Johannes Weinereb414682018-10-26 15:06:27 -07001146 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001147 thrashing = true;
1148 }
1149
Nicholas Piggin62906022016-12-25 13:00:30 +10001150 init_wait(wait);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001151 wait->flags = behavior == EXCLUSIVE ? WQ_FLAG_EXCLUSIVE : 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001152 wait->func = wake_page_function;
1153 wait_page.page = page;
1154 wait_page.bit_nr = bit_nr;
1155
1156 for (;;) {
1157 spin_lock_irq(&q->lock);
1158
Ingo Molnar2055da92017-06-20 12:06:46 +02001159 if (likely(list_empty(&wait->entry))) {
Linus Torvalds3510ca22017-08-27 13:55:12 -07001160 __add_wait_queue_entry_tail(q, wait);
Nicholas Piggin62906022016-12-25 13:00:30 +10001161 SetPageWaiters(page);
1162 }
1163
1164 set_current_state(state);
1165
1166 spin_unlock_irq(&q->lock);
1167
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001168 bit_is_set = test_bit(bit_nr, &page->flags);
1169 if (behavior == DROP)
1170 put_page(page);
Nicholas Piggin62906022016-12-25 13:00:30 +10001171
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001172 if (likely(bit_is_set))
1173 io_schedule();
1174
1175 if (behavior == EXCLUSIVE) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001176 if (!test_and_set_bit_lock(bit_nr, &page->flags))
1177 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001178 } else if (behavior == SHARED) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001179 if (!test_bit(bit_nr, &page->flags))
1180 break;
1181 }
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001182
Davidlohr Buesofa45f112019-01-03 15:28:55 -08001183 if (signal_pending_state(state, current)) {
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001184 ret = -EINTR;
1185 break;
1186 }
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001187
1188 if (behavior == DROP) {
1189 /*
1190 * We can no longer safely access page->flags:
1191 * even if CONFIG_MEMORY_HOTREMOVE is not enabled,
1192 * there is a risk of waiting forever on a page reused
1193 * for something that keeps it locked indefinitely.
1194 * But best check for -EINTR above before breaking.
1195 */
1196 break;
1197 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001198 }
1199
1200 finish_wait(q, wait);
1201
Johannes Weinereb414682018-10-26 15:06:27 -07001202 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001203 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001204 delayacct_thrashing_end();
1205 psi_memstall_leave(&pflags);
1206 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001207
Nicholas Piggin62906022016-12-25 13:00:30 +10001208 /*
1209 * A signal could leave PageWaiters set. Clearing it here if
1210 * !waitqueue_active would be possible (by open-coding finish_wait),
1211 * but still fail to catch it in the case of wait hash collision. We
1212 * already can fail to clear wait hash collision cases, so don't
1213 * bother with signals either.
1214 */
1215
1216 return ret;
1217}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218
Harvey Harrison920c7a52008-02-04 22:29:26 -08001219void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220{
Nicholas Piggin62906022016-12-25 13:00:30 +10001221 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001222 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223}
1224EXPORT_SYMBOL(wait_on_page_bit);
1225
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001226int wait_on_page_bit_killable(struct page *page, int bit_nr)
1227{
Nicholas Piggin62906022016-12-25 13:00:30 +10001228 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001229 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001230}
David Howells4343d002017-11-02 15:27:52 +00001231EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001232
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001234 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1235 * @page: The page to wait for.
1236 *
1237 * The caller should hold a reference on @page. They expect the page to
1238 * become unlocked relatively soon, but do not wish to hold up migration
1239 * (for example) by holding the reference while waiting for the page to
1240 * come unlocked. After this function returns, the caller should not
1241 * dereference @page.
1242 */
1243void put_and_wait_on_page_locked(struct page *page)
1244{
1245 wait_queue_head_t *q;
1246
1247 page = compound_head(page);
1248 q = page_waitqueue(page);
1249 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1250}
1251
1252/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001253 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001254 * @page: Page defining the wait queue of interest
1255 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001256 *
1257 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1258 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001259void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001260{
1261 wait_queue_head_t *q = page_waitqueue(page);
1262 unsigned long flags;
1263
1264 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001265 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001266 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001267 spin_unlock_irqrestore(&q->lock, flags);
1268}
1269EXPORT_SYMBOL_GPL(add_page_wait_queue);
1270
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001271#ifndef clear_bit_unlock_is_negative_byte
1272
1273/*
1274 * PG_waiters is the high bit in the same byte as PG_lock.
1275 *
1276 * On x86 (and on many other architectures), we can clear PG_lock and
1277 * test the sign bit at the same time. But if the architecture does
1278 * not support that special operation, we just do this all by hand
1279 * instead.
1280 *
1281 * The read of PG_waiters has to be after (or concurrently with) PG_locked
1282 * being cleared, but a memory barrier should be unneccssary since it is
1283 * in the same byte as PG_locked.
1284 */
1285static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1286{
1287 clear_bit_unlock(nr, mem);
1288 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001289 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001290}
1291
1292#endif
1293
David Howells385e1ca5f2009-04-03 16:42:39 +01001294/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001295 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 * @page: the page
1297 *
1298 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
1299 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001300 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1302 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001303 * Note that this depends on PG_waiters being the sign bit in the byte
1304 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1305 * clear the PG_locked bit and test PG_waiters at the same time fairly
1306 * portably (architectures that do LL/SC can test any bit, while x86 can
1307 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001309void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001311 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001312 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001313 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001314 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1315 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316}
1317EXPORT_SYMBOL(unlock_page);
1318
Randy Dunlap485bb992006-06-23 02:03:49 -07001319/**
1320 * end_page_writeback - end writeback against a page
1321 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 */
1323void end_page_writeback(struct page *page)
1324{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001325 /*
1326 * TestClearPageReclaim could be used here but it is an atomic
1327 * operation and overkill in this particular case. Failing to
1328 * shuffle a page marked for immediate reclaim is too mild to
1329 * justify taking an atomic operation penalty at the end of
1330 * ever page writeback.
1331 */
1332 if (PageReclaim(page)) {
1333 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001334 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001335 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001336
1337 if (!test_clear_page_writeback(page))
1338 BUG();
1339
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001340 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 wake_up_page(page, PG_writeback);
1342}
1343EXPORT_SYMBOL(end_page_writeback);
1344
Matthew Wilcox57d99842014-06-04 16:07:45 -07001345/*
1346 * After completing I/O on a page, call this routine to update the page
1347 * flags appropriately
1348 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001349void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001350{
Jens Axboec11f0c02016-08-05 08:11:04 -06001351 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001352 if (!err) {
1353 SetPageUptodate(page);
1354 } else {
1355 ClearPageUptodate(page);
1356 SetPageError(page);
1357 }
1358 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001359 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001360 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001361 struct address_space *mapping;
1362
Matthew Wilcox57d99842014-06-04 16:07:45 -07001363 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001364 mapping = page_mapping(page);
1365 if (mapping)
1366 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001367 }
1368 end_page_writeback(page);
1369 }
1370}
1371EXPORT_SYMBOL_GPL(page_endio);
1372
Randy Dunlap485bb992006-06-23 02:03:49 -07001373/**
1374 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001375 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001377void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378{
Nicholas Piggin62906022016-12-25 13:00:30 +10001379 struct page *page = compound_head(__page);
1380 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001381 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1382 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383}
1384EXPORT_SYMBOL(__lock_page);
1385
Nicholas Piggin62906022016-12-25 13:00:30 +10001386int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001387{
Nicholas Piggin62906022016-12-25 13:00:30 +10001388 struct page *page = compound_head(__page);
1389 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001390 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1391 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001392}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001393EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001394
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001395/*
1396 * Return values:
1397 * 1 - page is locked; mmap_sem is still held.
1398 * 0 - page is not locked.
1399 * mmap_sem has been released (up_read()), unless flags had both
1400 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1401 * which case mmap_sem is still held.
1402 *
1403 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1404 * with the page locked and the mmap_sem unperturbed.
1405 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001406int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1407 unsigned int flags)
1408{
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001409 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1410 /*
1411 * CAUTION! In this case, mmap_sem is not released
1412 * even though return 0.
1413 */
1414 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1415 return 0;
1416
1417 up_read(&mm->mmap_sem);
1418 if (flags & FAULT_FLAG_KILLABLE)
1419 wait_on_page_locked_killable(page);
1420 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001421 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001422 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001423 } else {
1424 if (flags & FAULT_FLAG_KILLABLE) {
1425 int ret;
1426
1427 ret = __lock_page_killable(page);
1428 if (ret) {
1429 up_read(&mm->mmap_sem);
1430 return 0;
1431 }
1432 } else
1433 __lock_page(page);
1434 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001435 }
1436}
1437
Randy Dunlap485bb992006-06-23 02:03:49 -07001438/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001439 * page_cache_next_miss() - Find the next gap in the page cache.
1440 * @mapping: Mapping.
1441 * @index: Index.
1442 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001443 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001444 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1445 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001446 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001447 * This function may be called under the rcu_read_lock. However, this will
1448 * not atomically search a snapshot of the cache at a single point in time.
1449 * For example, if a gap is created at index 5, then subsequently a gap is
1450 * created at index 10, page_cache_next_miss covering both indices may
1451 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001452 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001453 * Return: The index of the gap if found, otherwise an index outside the
1454 * range specified (in which case 'return - index >= max_scan' will be true).
1455 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001456 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001457pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001458 pgoff_t index, unsigned long max_scan)
1459{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001460 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001461
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001462 while (max_scan--) {
1463 void *entry = xas_next(&xas);
1464 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001465 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001466 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001467 break;
1468 }
1469
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001470 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001471}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001472EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001473
1474/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001475 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001476 * @mapping: Mapping.
1477 * @index: Index.
1478 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001479 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001480 * Search the range [max(index - max_scan + 1, 0), index] for the
1481 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001482 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001483 * This function may be called under the rcu_read_lock. However, this will
1484 * not atomically search a snapshot of the cache at a single point in time.
1485 * For example, if a gap is created at index 10, then subsequently a gap is
1486 * created at index 5, page_cache_prev_miss() covering both indices may
1487 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001488 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001489 * Return: The index of the gap if found, otherwise an index outside the
1490 * range specified (in which case 'index - return >= max_scan' will be true).
1491 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001492 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001493pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001494 pgoff_t index, unsigned long max_scan)
1495{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001496 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001497
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001498 while (max_scan--) {
1499 void *entry = xas_prev(&xas);
1500 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001501 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001502 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001503 break;
1504 }
1505
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001506 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001507}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001508EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001509
1510/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001511 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001512 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001513 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001514 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001515 * Looks up the page cache slot at @mapping & @offset. If there is a
1516 * page cache page, it is returned with an increased refcount.
1517 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001518 * If the slot holds a shadow entry of a previously evicted page, or a
1519 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001520 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001521 * Return: the found page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001523struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524{
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001525 XA_STATE(xas, &mapping->i_pages, offset);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001526 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527
Nick Piggina60637c2008-07-25 19:45:31 -07001528 rcu_read_lock();
1529repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001530 xas_reset(&xas);
1531 page = xas_load(&xas);
1532 if (xas_retry(&xas, page))
1533 goto repeat;
1534 /*
1535 * A shadow entry of a recently evicted page, or a swap entry from
1536 * shmem/tmpfs. Return it without attempting to raise page count.
1537 */
1538 if (!page || xa_is_value(page))
1539 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001540
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001541 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001542 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001543
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001544 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001545 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001546 * This is part of the lockless pagecache protocol. See
1547 * include/linux/pagemap.h for details.
1548 */
1549 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001550 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001551 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001552 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001553 page = find_subpage(page, offset);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001554out:
Nick Piggina60637c2008-07-25 19:45:31 -07001555 rcu_read_unlock();
1556
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 return page;
1558}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001559EXPORT_SYMBOL(find_get_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560
Randy Dunlap485bb992006-06-23 02:03:49 -07001561/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001562 * find_lock_entry - locate, pin and lock a page cache entry
1563 * @mapping: the address_space to search
1564 * @offset: the page cache index
1565 *
1566 * Looks up the page cache slot at @mapping & @offset. If there is a
1567 * page cache page, it is returned locked and with an increased
1568 * refcount.
1569 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001570 * If the slot holds a shadow entry of a previously evicted page, or a
1571 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001572 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001573 * find_lock_entry() may sleep.
Mike Rapoporta862f682019-03-05 15:48:42 -08001574 *
1575 * Return: the found page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001576 */
1577struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578{
1579 struct page *page;
1580
Linus Torvalds1da177e2005-04-16 15:20:36 -07001581repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001582 page = find_get_entry(mapping, offset);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001583 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001584 lock_page(page);
1585 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001586 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001587 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001588 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001589 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001591 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001593 return page;
1594}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001595EXPORT_SYMBOL(find_lock_entry);
1596
1597/**
Mel Gorman2457aec2014-06-04 16:10:31 -07001598 * pagecache_get_page - find and get a page reference
Johannes Weiner0cd61442014-04-03 14:47:46 -07001599 * @mapping: the address_space to search
1600 * @offset: the page index
Mel Gorman2457aec2014-06-04 16:10:31 -07001601 * @fgp_flags: PCG flags
Michal Hocko45f87de2014-12-29 20:30:35 +01001602 * @gfp_mask: gfp mask to use for the page cache data page allocation
Johannes Weiner0cd61442014-04-03 14:47:46 -07001603 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001604 * Looks up the page cache slot at @mapping & @offset.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001605 *
Randy Dunlap75325182014-07-30 16:08:37 -07001606 * PCG flags modify how the page is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001607 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001608 * @fgp_flags can be:
1609 *
1610 * - FGP_ACCESSED: the page will be marked accessed
1611 * - FGP_LOCK: Page is return locked
1612 * - FGP_CREAT: If page is not present then a new page is allocated using
1613 * @gfp_mask and added to the page cache and the VM's LRU
1614 * list. The page is returned locked and with an increased
Mike Rapoporta862f682019-03-05 15:48:42 -08001615 * refcount.
Josef Bacika75d4c32019-03-13 11:44:14 -07001616 * - FGP_FOR_MMAP: Similar to FGP_CREAT, only we want to allow the caller to do
1617 * its own locking dance if the page is already in cache, or unlock the page
1618 * before returning if we had to add the page to pagecache.
Mel Gorman2457aec2014-06-04 16:10:31 -07001619 *
1620 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1621 * if the GFP flags specified for FGP_CREAT are atomic.
1622 *
1623 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001624 *
1625 * Return: the found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001626 */
Mel Gorman2457aec2014-06-04 16:10:31 -07001627struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
Michal Hocko45f87de2014-12-29 20:30:35 +01001628 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629{
Nick Piggineb2be182007-10-16 01:24:57 -07001630 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001631
Linus Torvalds1da177e2005-04-16 15:20:36 -07001632repeat:
Mel Gorman2457aec2014-06-04 16:10:31 -07001633 page = find_get_entry(mapping, offset);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001634 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001635 page = NULL;
1636 if (!page)
1637 goto no_page;
1638
1639 if (fgp_flags & FGP_LOCK) {
1640 if (fgp_flags & FGP_NOWAIT) {
1641 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001642 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001643 return NULL;
1644 }
1645 } else {
1646 lock_page(page);
1647 }
1648
1649 /* Has the page been truncated? */
Song Liu31895432019-09-23 15:37:47 -07001650 if (unlikely(compound_head(page)->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001651 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001652 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001653 goto repeat;
1654 }
1655 VM_BUG_ON_PAGE(page->index != offset, page);
1656 }
1657
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001658 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001659 mark_page_accessed(page);
1660
1661no_page:
1662 if (!page && (fgp_flags & FGP_CREAT)) {
1663 int err;
1664 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001665 gfp_mask |= __GFP_WRITE;
1666 if (fgp_flags & FGP_NOFS)
1667 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001668
Michal Hocko45f87de2014-12-29 20:30:35 +01001669 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001670 if (!page)
1671 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001672
Josef Bacika75d4c32019-03-13 11:44:14 -07001673 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001674 fgp_flags |= FGP_LOCK;
1675
Hugh Dickinseb39d612014-08-06 16:06:43 -07001676 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001677 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001678 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001679
Matthew Wilcoxabc1be12018-04-20 14:56:20 -07001680 err = add_to_page_cache_lru(page, mapping, offset, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001681 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001682 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001683 page = NULL;
1684 if (err == -EEXIST)
1685 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001686 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001687
1688 /*
1689 * add_to_page_cache_lru locks the page, and for mmap we expect
1690 * an unlocked page.
1691 */
1692 if (page && (fgp_flags & FGP_FOR_MMAP))
1693 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001695
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696 return page;
1697}
Mel Gorman2457aec2014-06-04 16:10:31 -07001698EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699
1700/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001701 * find_get_entries - gang pagecache lookup
1702 * @mapping: The address_space to search
1703 * @start: The starting page cache index
1704 * @nr_entries: The maximum number of entries
1705 * @entries: Where the resulting entries are placed
1706 * @indices: The cache indices corresponding to the entries in @entries
1707 *
1708 * find_get_entries() will search for and return a group of up to
1709 * @nr_entries entries in the mapping. The entries are placed at
1710 * @entries. find_get_entries() takes a reference against any actual
1711 * pages it returns.
1712 *
1713 * The search returns a group of mapping-contiguous page cache entries
1714 * with ascending indexes. There may be holes in the indices due to
1715 * not-present pages.
1716 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001717 * Any shadow entries of evicted pages, or swap entries from
1718 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001719 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001720 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001721 */
1722unsigned find_get_entries(struct address_space *mapping,
1723 pgoff_t start, unsigned int nr_entries,
1724 struct page **entries, pgoff_t *indices)
1725{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001726 XA_STATE(xas, &mapping->i_pages, start);
1727 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001728 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001729
1730 if (!nr_entries)
1731 return 0;
1732
1733 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001734 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001735 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001736 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001737 /*
1738 * A shadow entry of a recently evicted page, a swap
1739 * entry from shmem/tmpfs or a DAX entry. Return it
1740 * without attempting to raise page count.
1741 */
1742 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001743 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001744
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001745 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001746 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001747
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001748 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001749 if (unlikely(page != xas_reload(&xas)))
1750 goto put_page;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001751 page = find_subpage(page, xas.xa_index);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001752
Johannes Weiner0cd61442014-04-03 14:47:46 -07001753export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001754 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001755 entries[ret] = page;
1756 if (++ret == nr_entries)
1757 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001758 continue;
1759put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001760 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001761retry:
1762 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001763 }
1764 rcu_read_unlock();
1765 return ret;
1766}
1767
1768/**
Jan Karab947cee2017-09-06 16:21:21 -07001769 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770 * @mapping: The address_space to search
1771 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001772 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 * @nr_pages: The maximum number of pages
1774 * @pages: Where the resulting pages are placed
1775 *
Jan Karab947cee2017-09-06 16:21:21 -07001776 * find_get_pages_range() will search for and return a group of up to @nr_pages
1777 * pages in the mapping starting at index @start and up to index @end
1778 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1779 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 *
1781 * The search returns a group of mapping-contiguous pages with ascending
1782 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001783 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001785 * Return: the number of pages which were found. If this number is
1786 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001787 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 */
Jan Karab947cee2017-09-06 16:21:21 -07001789unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1790 pgoff_t end, unsigned int nr_pages,
1791 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001793 XA_STATE(xas, &mapping->i_pages, *start);
1794 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001795 unsigned ret = 0;
1796
1797 if (unlikely(!nr_pages))
1798 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799
Nick Piggina60637c2008-07-25 19:45:31 -07001800 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001801 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001802 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001803 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001804 /* Skip over shadow, swap and DAX entries */
1805 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001806 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001807
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001808 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001809 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001810
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001811 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001812 if (unlikely(page != xas_reload(&xas)))
1813 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001814
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001815 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001816 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001817 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001818 goto out;
1819 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001820 continue;
1821put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001822 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001823retry:
1824 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001825 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001826
Jan Karab947cee2017-09-06 16:21:21 -07001827 /*
1828 * We come here when there is no page beyond @end. We take care to not
1829 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001830 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07001831 * already broken anyway.
1832 */
1833 if (end == (pgoff_t)-1)
1834 *start = (pgoff_t)-1;
1835 else
1836 *start = end + 1;
1837out:
Nick Piggina60637c2008-07-25 19:45:31 -07001838 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07001839
Linus Torvalds1da177e2005-04-16 15:20:36 -07001840 return ret;
1841}
1842
Jens Axboeebf43502006-04-27 08:46:01 +02001843/**
1844 * find_get_pages_contig - gang contiguous pagecache lookup
1845 * @mapping: The address_space to search
1846 * @index: The starting page index
1847 * @nr_pages: The maximum number of pages
1848 * @pages: Where the resulting pages are placed
1849 *
1850 * find_get_pages_contig() works exactly like find_get_pages(), except
1851 * that the returned number of pages are guaranteed to be contiguous.
1852 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001853 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02001854 */
1855unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1856 unsigned int nr_pages, struct page **pages)
1857{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001858 XA_STATE(xas, &mapping->i_pages, index);
1859 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001860 unsigned int ret = 0;
1861
1862 if (unlikely(!nr_pages))
1863 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001864
Nick Piggina60637c2008-07-25 19:45:31 -07001865 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001866 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001867 if (xas_retry(&xas, page))
1868 continue;
1869 /*
1870 * If the entry has been swapped out, we can stop looking.
1871 * No current caller is looking for DAX entries.
1872 */
1873 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001874 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001875
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001876 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001877 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001878
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001879 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001880 if (unlikely(page != xas_reload(&xas)))
1881 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001882
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001883 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001884 if (++ret == nr_pages)
1885 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001886 continue;
1887put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001888 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001889retry:
1890 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02001891 }
Nick Piggina60637c2008-07-25 19:45:31 -07001892 rcu_read_unlock();
1893 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001894}
David Howellsef71c152007-05-09 02:33:44 -07001895EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001896
Randy Dunlap485bb992006-06-23 02:03:49 -07001897/**
Jan Kara72b045a2017-11-15 17:34:33 -08001898 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001899 * @mapping: the address_space to search
1900 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08001901 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001902 * @tag: the tag index
1903 * @nr_pages: the maximum number of pages
1904 * @pages: where the resulting pages are placed
1905 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001907 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08001908 *
1909 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 */
Jan Kara72b045a2017-11-15 17:34:33 -08001911unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001912 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08001913 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001915 XA_STATE(xas, &mapping->i_pages, *index);
1916 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001917 unsigned ret = 0;
1918
1919 if (unlikely(!nr_pages))
1920 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921
Nick Piggina60637c2008-07-25 19:45:31 -07001922 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001923 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001924 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001925 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001926 /*
1927 * Shadow entries should never be tagged, but this iteration
1928 * is lockless so there is a window for page reclaim to evict
1929 * a page we saw tagged. Skip over it.
1930 */
1931 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07001932 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001933
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001934 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001935 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001936
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001937 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001938 if (unlikely(page != xas_reload(&xas)))
1939 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001940
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001941 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08001942 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001943 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08001944 goto out;
1945 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001946 continue;
1947put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001948 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001949retry:
1950 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001951 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001952
Jan Kara72b045a2017-11-15 17:34:33 -08001953 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001954 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08001955 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001956 * iteration when there is a page at index -1 but that is already
1957 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08001958 */
1959 if (end == (pgoff_t)-1)
1960 *index = (pgoff_t)-1;
1961 else
1962 *index = end + 1;
1963out:
Nick Piggina60637c2008-07-25 19:45:31 -07001964 rcu_read_unlock();
1965
Linus Torvalds1da177e2005-04-16 15:20:36 -07001966 return ret;
1967}
Jan Kara72b045a2017-11-15 17:34:33 -08001968EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001970/*
1971 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1972 * a _large_ part of the i/o request. Imagine the worst scenario:
1973 *
1974 * ---R__________________________________________B__________
1975 * ^ reading here ^ bad block(assume 4k)
1976 *
1977 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1978 * => failing the whole request => read(R) => read(R+1) =>
1979 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1980 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1981 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1982 *
1983 * It is going insane. Fix it by quickly scaling down the readahead size.
1984 */
1985static void shrink_readahead_size_eio(struct file *filp,
1986 struct file_ra_state *ra)
1987{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001988 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001989}
1990
Randy Dunlap485bb992006-06-23 02:03:49 -07001991/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001992 * generic_file_buffered_read - generic file read routine
1993 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05001994 * @iter: data destination
1995 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001996 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001998 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 *
2000 * This is really ugly. But the goto's actually try to clarify some
2001 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002002 *
2003 * Return:
2004 * * total number of bytes copied, including those the were already @written
2005 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 */
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002007static ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002008 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002010 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002011 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002013 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002014 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002015 pgoff_t index;
2016 pgoff_t last_index;
2017 pgoff_t prev_index;
2018 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002019 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002020 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021
Wei Fangc2a97372016-10-07 17:01:52 -07002022 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002023 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002024 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2025
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002026 index = *ppos >> PAGE_SHIFT;
2027 prev_index = ra->prev_pos >> PAGE_SHIFT;
2028 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2029 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2030 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 for (;;) {
2033 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002034 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002035 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002036 unsigned long nr, ret;
2037
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002040 if (fatal_signal_pending(current)) {
2041 error = -EINTR;
2042 goto out;
2043 }
2044
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002046 if (!page) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002047 if (iocb->ki_flags & IOCB_NOWAIT)
2048 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002049 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002050 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002051 index, last_index - index);
2052 page = find_get_page(mapping, index);
2053 if (unlikely(page == NULL))
2054 goto no_cached_page;
2055 }
2056 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07002057 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002058 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002059 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002061 if (!PageUptodate(page)) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002062 if (iocb->ki_flags & IOCB_NOWAIT) {
2063 put_page(page);
2064 goto would_block;
2065 }
2066
Mel Gormanebded022016-03-15 14:55:39 -07002067 /*
2068 * See comment in do_read_cache_page on why
2069 * wait_on_page_locked is used to avoid unnecessarily
2070 * serialisations and why it's safe.
2071 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002072 error = wait_on_page_locked_killable(page);
2073 if (unlikely(error))
2074 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002075 if (PageUptodate(page))
2076 goto page_ok;
2077
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002078 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002079 !mapping->a_ops->is_partially_uptodate)
2080 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002081 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002082 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002083 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002084 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002085 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002086 /* Did it get truncated before we got the lock? */
2087 if (!page->mapping)
2088 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002089 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002090 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002091 goto page_not_up_to_date_locked;
2092 unlock_page(page);
2093 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002095 /*
2096 * i_size must be checked after we know the page is Uptodate.
2097 *
2098 * Checking i_size after the check allows us to calculate
2099 * the correct value for "nr", which means the zero-filled
2100 * part of the page is not copied back to userspace (unless
2101 * another truncate extends the file - this is desired though).
2102 */
2103
2104 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002105 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002106 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002107 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002108 goto out;
2109 }
2110
2111 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002112 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002113 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002114 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002115 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002116 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002117 goto out;
2118 }
2119 }
2120 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
2122 /* If users can be writing to this page using arbitrary
2123 * virtual addresses, take care about potential aliasing
2124 * before reading the page on the kernel side.
2125 */
2126 if (mapping_writably_mapped(mapping))
2127 flush_dcache_page(page);
2128
2129 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002130 * When a sequential read accesses a page several times,
2131 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002132 */
Jan Karaec0f1632007-05-06 14:49:25 -07002133 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134 mark_page_accessed(page);
2135 prev_index = index;
2136
2137 /*
2138 * Ok, we have the page, and it's up-to-date, so
2139 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140 */
Al Viro6e58e792014-02-03 17:07:03 -05002141
2142 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002143 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002144 index += offset >> PAGE_SHIFT;
2145 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002146 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002148 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002149 written += ret;
2150 if (!iov_iter_count(iter))
2151 goto out;
2152 if (ret < nr) {
2153 error = -EFAULT;
2154 goto out;
2155 }
2156 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002157
2158page_not_up_to_date:
2159 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04002160 error = lock_page_killable(page);
2161 if (unlikely(error))
2162 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002163
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002164page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002165 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 if (!page->mapping) {
2167 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002168 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 continue;
2170 }
2171
2172 /* Did somebody else fill it already? */
2173 if (PageUptodate(page)) {
2174 unlock_page(page);
2175 goto page_ok;
2176 }
2177
2178readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04002179 /*
2180 * A previous I/O error may have been due to temporary
2181 * failures, eg. multipath errors.
2182 * PG_error will be set again if readpage fails.
2183 */
2184 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002185 /* Start the actual read. The read will unlock the page. */
2186 error = mapping->a_ops->readpage(filp, page);
2187
Zach Brown994fc28c2005-12-15 14:28:17 -08002188 if (unlikely(error)) {
2189 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002190 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002191 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002192 goto find_page;
2193 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002194 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002195 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196
2197 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04002198 error = lock_page_killable(page);
2199 if (unlikely(error))
2200 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 if (!PageUptodate(page)) {
2202 if (page->mapping == NULL) {
2203 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002204 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 */
2206 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002207 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 goto find_page;
2209 }
2210 unlock_page(page);
Fengguang Wu7ff81072007-10-16 01:24:35 -07002211 shrink_readahead_size_eio(filp, ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002212 error = -EIO;
2213 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 }
2215 unlock_page(page);
2216 }
2217
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218 goto page_ok;
2219
2220readpage_error:
2221 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002222 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 goto out;
2224
2225no_cached_page:
2226 /*
2227 * Ok, it wasn't cached, so we need to create a new
2228 * page..
2229 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002230 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002231 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002232 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002233 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002235 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002236 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002238 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002239 if (error == -EEXIST) {
2240 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002242 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 goto out;
2244 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 goto readpage;
2246 }
2247
Milosz Tanski3239d832017-08-29 16:13:19 +02002248would_block:
2249 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002251 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002252 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002253 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002255 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002256 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002257 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258}
2259
Randy Dunlap485bb992006-06-23 02:03:49 -07002260/**
Al Viro6abd2322014-04-04 14:20:57 -04002261 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002262 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002263 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002264 *
Al Viro6abd2322014-04-04 14:20:57 -04002265 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002266 * that can use the page cache directly.
Mike Rapoporta862f682019-03-05 15:48:42 -08002267 * Return:
2268 * * number of bytes copied, even for partial reads
2269 * * negative error code if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 */
2271ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002272generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002274 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002275 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002276
2277 if (!count)
2278 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279
Al Viro2ba48ce2015-04-09 13:52:01 -04002280 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002281 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002282 struct address_space *mapping = file->f_mapping;
2283 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002284 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002287 if (iocb->ki_flags & IOCB_NOWAIT) {
2288 if (filemap_range_has_page(mapping, iocb->ki_pos,
2289 iocb->ki_pos + count - 1))
2290 return -EAGAIN;
2291 } else {
2292 retval = filemap_write_and_wait_range(mapping,
2293 iocb->ki_pos,
2294 iocb->ki_pos + count - 1);
2295 if (retval < 0)
2296 goto out;
2297 }
Al Viroed978a82014-03-05 22:53:04 -05002298
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002299 file_accessed(file);
2300
Al Viro5ecda132017-04-13 14:13:36 -04002301 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002302 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002303 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002304 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002305 }
Al Viro5b47d592017-05-08 13:54:47 -04002306 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002307
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002308 /*
2309 * Btrfs can have a short DIO read if we encounter
2310 * compressed extents, so if there was an error, or if
2311 * we've already read everything we wanted to, or if
2312 * there was a short read because we hit EOF, go ahead
2313 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002314 * the rest of the read. Buffered reads will not work for
2315 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002316 */
Al Viro5ecda132017-04-13 14:13:36 -04002317 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002318 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002319 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002320 }
2321
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002322 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323out:
2324 return retval;
2325}
Al Viroed978a82014-03-05 22:53:04 -05002326EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329#define MMAP_LOTSAMISS (100)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002330static struct file *maybe_unlock_mmap_for_io(struct vm_fault *vmf,
2331 struct file *fpin)
2332{
2333 int flags = vmf->flags;
2334
2335 if (fpin)
2336 return fpin;
2337
2338 /*
2339 * FAULT_FLAG_RETRY_NOWAIT means we don't want to wait on page locks or
2340 * anything, so we only pin the file and drop the mmap_sem if only
2341 * FAULT_FLAG_ALLOW_RETRY is set.
2342 */
2343 if ((flags & (FAULT_FLAG_ALLOW_RETRY | FAULT_FLAG_RETRY_NOWAIT)) ==
2344 FAULT_FLAG_ALLOW_RETRY) {
2345 fpin = get_file(vmf->vma->vm_file);
2346 up_read(&vmf->vma->vm_mm->mmap_sem);
2347 }
2348 return fpin;
2349}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350
Linus Torvaldsef00e082009-06-16 15:31:25 -07002351/*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002352 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_sem
2353 * @vmf - the vm_fault for this fault.
2354 * @page - the page to lock.
2355 * @fpin - the pointer to the file we may pin (or is already pinned).
2356 *
2357 * This works similar to lock_page_or_retry in that it can drop the mmap_sem.
2358 * It differs in that it actually returns the page locked if it returns 1 and 0
2359 * if it couldn't lock the page. If we did have to drop the mmap_sem then fpin
2360 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002361 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002362static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2363 struct file **fpin)
2364{
2365 if (trylock_page(page))
2366 return 1;
2367
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002368 /*
2369 * NOTE! This will make us return with VM_FAULT_RETRY, but with
2370 * the mmap_sem still held. That's how FAULT_FLAG_RETRY_NOWAIT
2371 * is supposed to work. We have way too many special cases..
2372 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002373 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2374 return 0;
2375
2376 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2377 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2378 if (__lock_page_killable(page)) {
2379 /*
2380 * We didn't have the right flags to drop the mmap_sem,
2381 * but all fault_handlers only check for fatal signals
2382 * if we return VM_FAULT_RETRY, so we need to drop the
2383 * mmap_sem here and return 0 if we don't have a fpin.
2384 */
2385 if (*fpin == NULL)
2386 up_read(&vmf->vma->vm_mm->mmap_sem);
2387 return 0;
2388 }
2389 } else
2390 __lock_page(page);
2391 return 1;
2392}
2393
2394
2395/*
2396 * Synchronous readahead happens when we don't even find a page in the page
2397 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2398 * to drop the mmap sem we return the file that was pinned in order for us to do
2399 * that. If we didn't pin a file then we return NULL. The file that is
2400 * returned needs to be fput()'ed when we're done with it.
2401 */
2402static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002403{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002404 struct file *file = vmf->vma->vm_file;
2405 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002406 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002407 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002408 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002409
2410 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002411 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002412 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002413 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002414 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002415
Josef Bacik2a1180f2019-03-13 11:44:18 -07002416 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002417 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002418 page_cache_sync_readahead(mapping, ra, file, offset,
2419 ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002420 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002421 }
2422
Andi Kleen207d04b2011-05-24 17:12:29 -07002423 /* Avoid banging the cache line if not needed */
2424 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002425 ra->mmap_miss++;
2426
2427 /*
2428 * Do we miss much more than hit in this file? If so,
2429 * stop bothering with read-ahead. It will only hurt.
2430 */
2431 if (ra->mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002432 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002433
Wu Fengguangd30a1102009-06-16 15:31:30 -07002434 /*
2435 * mmap read-around
2436 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002437 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002438 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2439 ra->size = ra->ra_pages;
2440 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002441 ra_submit(ra, mapping, file);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002442 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002443}
2444
2445/*
2446 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002447 * so we want to possibly extend the readahead further. We return the file that
2448 * was pinned if we have to drop the mmap_sem in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002449 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002450static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2451 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002452{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002453 struct file *file = vmf->vma->vm_file;
2454 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002455 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002456 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002457 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002458
2459 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002460 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002461 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002462 if (ra->mmap_miss > 0)
2463 ra->mmap_miss--;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002464 if (PageReadahead(page)) {
2465 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002466 page_cache_async_readahead(mapping, ra, file,
2467 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002468 }
2469 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002470}
2471
Randy Dunlap485bb992006-06-23 02:03:49 -07002472/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002473 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002474 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002475 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002476 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 * mapped memory region to read in file data during a page fault.
2478 *
2479 * The goto's are kind of ugly, but this streamlines the normal case of having
2480 * it in the page cache, and handles the special cases reasonably without
2481 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002482 *
2483 * vma->vm_mm->mmap_sem must be held on entry.
2484 *
Yang Shia4985832019-07-11 20:55:29 -07002485 * If our return value has VM_FAULT_RETRY set, it's because the mmap_sem
2486 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002487 *
2488 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2489 * has not been released.
2490 *
2491 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002492 *
2493 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002494 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002495vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002496{
2497 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002498 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002499 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 struct address_space *mapping = file->f_mapping;
2501 struct file_ra_state *ra = &file->f_ra;
2502 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002503 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002504 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002506 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002507
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002508 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2509 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002510 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002511
Linus Torvalds1da177e2005-04-16 15:20:36 -07002512 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002513 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002514 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002515 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002516 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002518 * We found the page, so try async readahead before
2519 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002521 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002522 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002523 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002524 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002525 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002526 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002527 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002528retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002529 page = pagecache_get_page(mapping, offset,
2530 FGP_CREAT|FGP_FOR_MMAP,
2531 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002532 if (!page) {
2533 if (fpin)
2534 goto out_retry;
Josef Bacika75d4c32019-03-13 11:44:14 -07002535 return vmf_error(-ENOMEM);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002536 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 }
2538
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002539 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2540 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002541
2542 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002543 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002544 unlock_page(page);
2545 put_page(page);
2546 goto retry_find;
2547 }
Sasha Levin309381fea2014-01-23 15:52:54 -08002548 VM_BUG_ON_PAGE(page->index != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002549
Linus Torvalds1da177e2005-04-16 15:20:36 -07002550 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002551 * We have a locked page in the page cache, now we need to check
2552 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 */
Nick Piggind00806b2007-07-19 01:46:57 -07002554 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 goto page_not_uptodate;
2556
Linus Torvaldsef00e082009-06-16 15:31:25 -07002557 /*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002558 * We've made it this far and we had to drop our mmap_sem, now is the
2559 * time to return to the upper layer and have it re-find the vma and
2560 * redo the fault.
2561 */
2562 if (fpin) {
2563 unlock_page(page);
2564 goto out_retry;
2565 }
2566
2567 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002568 * Found the page and have a reference on it.
2569 * We must recheck i_size under page lock.
2570 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002571 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2572 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002573 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002574 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002575 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002576 }
2577
Nick Piggind0217ac2007-07-19 01:47:03 -07002578 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002579 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002580
Linus Torvalds1da177e2005-04-16 15:20:36 -07002581page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582 /*
2583 * Umm, take care of errors if the page isn't up-to-date.
2584 * Try to re-read it _once_. We do this synchronously,
2585 * because there really aren't any performance issues here
2586 * and we need to check for errors.
2587 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002588 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002589 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002590 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002591 if (!error) {
2592 wait_on_page_locked(page);
2593 if (!PageUptodate(page))
2594 error = -EIO;
2595 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002596 if (fpin)
2597 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002598 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002599
2600 if (!error || error == AOP_TRUNCATED_PAGE)
2601 goto retry_find;
2602
2603 /* Things didn't work out. Return zero to tell the mm layer so. */
2604 shrink_readahead_size_eio(file, ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002605 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002606
2607out_retry:
2608 /*
2609 * We dropped the mmap_sem, we need to return to the fault handler to
2610 * re-find the vma and come back and find our hopefully still populated
2611 * page.
2612 */
2613 if (page)
2614 put_page(page);
2615 if (fpin)
2616 fput(fpin);
2617 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002618}
2619EXPORT_SYMBOL(filemap_fault);
2620
Jan Kara82b0f8c2016-12-14 15:06:58 -08002621void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002622 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002623{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002624 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002625 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002626 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002627 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002628 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002629 struct page *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002630
2631 rcu_read_lock();
Matthew Wilcox070e8072018-05-17 00:08:30 -04002632 xas_for_each(&xas, page, end_pgoff) {
2633 if (xas_retry(&xas, page))
2634 continue;
2635 if (xa_is_value(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002636 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002637
Michal Hockoe0975b22018-12-28 00:38:36 -08002638 /*
2639 * Check for a locked page first, as a speculative
2640 * reference may adversely influence page migration.
2641 */
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002642 if (PageLocked(page))
Michal Hockoe0975b22018-12-28 00:38:36 -08002643 goto next;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002644 if (!page_cache_get_speculative(page))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002645 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002646
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002647 /* Has the page moved or been split? */
Matthew Wilcox070e8072018-05-17 00:08:30 -04002648 if (unlikely(page != xas_reload(&xas)))
2649 goto skip;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002650 page = find_subpage(page, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002651
2652 if (!PageUptodate(page) ||
2653 PageReadahead(page) ||
2654 PageHWPoison(page))
2655 goto skip;
2656 if (!trylock_page(page))
2657 goto skip;
2658
2659 if (page->mapping != mapping || !PageUptodate(page))
2660 goto unlock;
2661
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002662 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2663 if (page->index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002664 goto unlock;
2665
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002666 if (file->f_ra.mmap_miss > 0)
2667 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002668
Matthew Wilcox070e8072018-05-17 00:08:30 -04002669 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002670 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002671 vmf->pte += xas.xa_index - last_pgoff;
2672 last_pgoff = xas.xa_index;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002673 if (alloc_set_pte(vmf, NULL, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002674 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002675 unlock_page(page);
2676 goto next;
2677unlock:
2678 unlock_page(page);
2679skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002680 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002681next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002682 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002683 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002684 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002685 }
2686 rcu_read_unlock();
2687}
2688EXPORT_SYMBOL(filemap_map_pages);
2689
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002690vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002691{
2692 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002693 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002694 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002695
Jan Kara14da9202012-06-12 16:20:37 +02002696 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002697 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002698 lock_page(page);
2699 if (page->mapping != inode->i_mapping) {
2700 unlock_page(page);
2701 ret = VM_FAULT_NOPAGE;
2702 goto out;
2703 }
Jan Kara14da9202012-06-12 16:20:37 +02002704 /*
2705 * We mark the page dirty already here so that when freeze is in
2706 * progress, we are guaranteed that writeback during freezing will
2707 * see the dirty page and writeprotect it again.
2708 */
2709 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002710 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002711out:
Jan Kara14da9202012-06-12 16:20:37 +02002712 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002713 return ret;
2714}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002715
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002716const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002717 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002718 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002719 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002720};
2721
2722/* This is used for a general mmap of a disk file */
2723
2724int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2725{
2726 struct address_space *mapping = file->f_mapping;
2727
2728 if (!mapping->a_ops->readpage)
2729 return -ENOEXEC;
2730 file_accessed(file);
2731 vma->vm_ops = &generic_file_vm_ops;
2732 return 0;
2733}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734
2735/*
2736 * This is for filesystems which do not implement ->writepage.
2737 */
2738int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2739{
2740 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2741 return -EINVAL;
2742 return generic_file_mmap(file, vma);
2743}
2744#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002745vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07002746{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002747 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07002748}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2750{
2751 return -ENOSYS;
2752}
2753int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2754{
2755 return -ENOSYS;
2756}
2757#endif /* CONFIG_MMU */
2758
Arnd Bergmann453972282018-04-13 15:35:27 -07002759EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002760EXPORT_SYMBOL(generic_file_mmap);
2761EXPORT_SYMBOL(generic_file_readonly_mmap);
2762
Sasha Levin67f9fd92014-04-03 14:48:18 -07002763static struct page *wait_on_page_read(struct page *page)
2764{
2765 if (!IS_ERR(page)) {
2766 wait_on_page_locked(page);
2767 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002768 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002769 page = ERR_PTR(-EIO);
2770 }
2771 }
2772 return page;
2773}
2774
Mel Gorman32b63522016-03-15 14:55:36 -07002775static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002776 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002777 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002778 void *data,
2779 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780{
Nick Piggineb2be182007-10-16 01:24:57 -07002781 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782 int err;
2783repeat:
2784 page = find_get_page(mapping, index);
2785 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08002786 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002787 if (!page)
2788 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002789 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002790 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002791 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002792 if (err == -EEXIST)
2793 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05002794 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002795 return ERR_PTR(err);
2796 }
Mel Gorman32b63522016-03-15 14:55:36 -07002797
2798filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002799 if (filler)
2800 err = filler(data, page);
2801 else
2802 err = mapping->a_ops->readpage(data, page);
2803
Linus Torvalds1da177e2005-04-16 15:20:36 -07002804 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002805 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002806 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807 }
Mel Gorman32b63522016-03-15 14:55:36 -07002808
2809 page = wait_on_page_read(page);
2810 if (IS_ERR(page))
2811 return page;
2812 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002814 if (PageUptodate(page))
2815 goto out;
2816
Mel Gormanebded022016-03-15 14:55:39 -07002817 /*
2818 * Page is not up to date and may be locked due one of the following
2819 * case a: Page is being filled and the page lock is held
2820 * case b: Read/write error clearing the page uptodate status
2821 * case c: Truncation in progress (page locked)
2822 * case d: Reclaim in progress
2823 *
2824 * Case a, the page will be up to date when the page is unlocked.
2825 * There is no need to serialise on the page lock here as the page
2826 * is pinned so the lock gives no additional protection. Even if the
2827 * the page is truncated, the data is still valid if PageUptodate as
2828 * it's a race vs truncate race.
2829 * Case b, the page will not be up to date
2830 * Case c, the page may be truncated but in itself, the data may still
2831 * be valid after IO completes as it's a read vs truncate race. The
2832 * operation must restart if the page is not uptodate on unlock but
2833 * otherwise serialising on page lock to stabilise the mapping gives
2834 * no additional guarantees to the caller as the page lock is
2835 * released before return.
2836 * Case d, similar to truncation. If reclaim holds the page lock, it
2837 * will be a race with remove_mapping that determines if the mapping
2838 * is valid on unlock but otherwise the data is valid and there is
2839 * no need to serialise with page lock.
2840 *
2841 * As the page lock gives no additional guarantee, we optimistically
2842 * wait on the page to be unlocked and check if it's up to date and
2843 * use the page if it is. Otherwise, the page lock is required to
2844 * distinguish between the different cases. The motivation is that we
2845 * avoid spurious serialisations and wakeups when multiple processes
2846 * wait on the same page for IO to complete.
2847 */
2848 wait_on_page_locked(page);
2849 if (PageUptodate(page))
2850 goto out;
2851
2852 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002854
2855 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002856 if (!page->mapping) {
2857 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002858 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002859 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002860 }
Mel Gormanebded022016-03-15 14:55:39 -07002861
2862 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002863 if (PageUptodate(page)) {
2864 unlock_page(page);
2865 goto out;
2866 }
Mel Gorman32b63522016-03-15 14:55:36 -07002867 goto filler;
2868
David Howellsc855ff32007-05-09 13:42:20 +01002869out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002870 mark_page_accessed(page);
2871 return page;
2872}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002873
2874/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002875 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002876 * @mapping: the page's address_space
2877 * @index: the page index
2878 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002879 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002880 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002881 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002882 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002883 *
2884 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002885 *
2886 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002887 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002888struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002889 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002890 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002891 void *data)
2892{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07002893 return do_read_cache_page(mapping, index, filler, data,
2894 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002895}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002896EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002897
2898/**
2899 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2900 * @mapping: the page's address_space
2901 * @index: the page index
2902 * @gfp: the page allocator flags to use if allocating
2903 *
2904 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002905 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002906 *
2907 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002908 *
2909 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002910 */
2911struct page *read_cache_page_gfp(struct address_space *mapping,
2912 pgoff_t index,
2913 gfp_t gfp)
2914{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002915 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002916}
2917EXPORT_SYMBOL(read_cache_page_gfp);
2918
Nick Piggin2f718ff2007-10-16 01:24:59 -07002919/*
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002920 * Don't operate on ranges the page cache doesn't support, and don't exceed the
2921 * LFS limits. If pos is under the limit it becomes a short access. If it
2922 * exceeds the limit we return -EFBIG.
2923 */
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002924static int generic_write_check_limits(struct file *file, loff_t pos,
2925 loff_t *count)
2926{
Amir Goldstein646955c2019-06-05 08:04:48 -07002927 struct inode *inode = file->f_mapping->host;
2928 loff_t max_size = inode->i_sb->s_maxbytes;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002929 loff_t limit = rlimit(RLIMIT_FSIZE);
2930
2931 if (limit != RLIM_INFINITY) {
2932 if (pos >= limit) {
2933 send_sig(SIGXFSZ, current, 0);
2934 return -EFBIG;
2935 }
2936 *count = min(*count, limit - pos);
2937 }
2938
Amir Goldstein646955c2019-06-05 08:04:48 -07002939 if (!(file->f_flags & O_LARGEFILE))
2940 max_size = MAX_NON_LFS;
2941
2942 if (unlikely(pos >= max_size))
2943 return -EFBIG;
2944
2945 *count = min(*count, max_size - pos);
2946
2947 return 0;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002948}
2949
2950/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951 * Performs necessary checks before doing a write
2952 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002953 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954 * Returns appropriate error code that caller should return or
2955 * zero in case that write should be allowed.
2956 */
Al Viro3309dd02015-04-09 12:55:47 -04002957inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002958{
Al Viro3309dd02015-04-09 12:55:47 -04002959 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960 struct inode *inode = file->f_mapping->host;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002961 loff_t count;
2962 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002963
Darrick J. Wongdc617f22019-08-20 07:55:16 -07002964 if (IS_SWAPFILE(inode))
2965 return -ETXTBSY;
2966
Al Viro3309dd02015-04-09 12:55:47 -04002967 if (!iov_iter_count(from))
2968 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002969
Al Viro0fa6b002015-04-04 04:05:48 -04002970 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002971 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002972 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002973
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002974 if ((iocb->ki_flags & IOCB_NOWAIT) && !(iocb->ki_flags & IOCB_DIRECT))
2975 return -EINVAL;
2976
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002977 count = iov_iter_count(from);
2978 ret = generic_write_check_limits(file, iocb->ki_pos, &count);
2979 if (ret)
2980 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002982 iov_iter_truncate(from, count);
Al Viro3309dd02015-04-09 12:55:47 -04002983 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984}
2985EXPORT_SYMBOL(generic_write_checks);
2986
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002987/*
2988 * Performs necessary checks before doing a clone.
2989 *
Amir Goldstein646955c2019-06-05 08:04:48 -07002990 * Can adjust amount of bytes to clone via @req_count argument.
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002991 * Returns appropriate error code that caller should return or
2992 * zero in case the clone should be allowed.
2993 */
2994int generic_remap_checks(struct file *file_in, loff_t pos_in,
2995 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11002996 loff_t *req_count, unsigned int remap_flags)
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002997{
2998 struct inode *inode_in = file_in->f_mapping->host;
2999 struct inode *inode_out = file_out->f_mapping->host;
3000 uint64_t count = *req_count;
3001 uint64_t bcount;
3002 loff_t size_in, size_out;
3003 loff_t bs = inode_out->i_sb->s_blocksize;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003004 int ret;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003005
3006 /* The start of both ranges must be aligned to an fs block. */
3007 if (!IS_ALIGNED(pos_in, bs) || !IS_ALIGNED(pos_out, bs))
3008 return -EINVAL;
3009
3010 /* Ensure offsets don't wrap. */
3011 if (pos_in + count < pos_in || pos_out + count < pos_out)
3012 return -EINVAL;
3013
3014 size_in = i_size_read(inode_in);
3015 size_out = i_size_read(inode_out);
3016
3017 /* Dedupe requires both ranges to be within EOF. */
Darrick J. Wong3d281932018-10-30 10:41:34 +11003018 if ((remap_flags & REMAP_FILE_DEDUP) &&
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003019 (pos_in >= size_in || pos_in + count > size_in ||
3020 pos_out >= size_out || pos_out + count > size_out))
3021 return -EINVAL;
3022
3023 /* Ensure the infile range is within the infile. */
3024 if (pos_in >= size_in)
3025 return -EINVAL;
3026 count = min(count, size_in - (uint64_t)pos_in);
3027
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003028 ret = generic_write_check_limits(file_out, pos_out, &count);
3029 if (ret)
3030 return ret;
3031
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003032 /*
3033 * If the user wanted us to link to the infile's EOF, round up to the
3034 * next block boundary for this check.
3035 *
3036 * Otherwise, make sure the count is also block-aligned, having
3037 * already confirmed the starting offsets' block alignment.
3038 */
3039 if (pos_in + count == size_in) {
3040 bcount = ALIGN(size_in, bs) - pos_in;
3041 } else {
3042 if (!IS_ALIGNED(count, bs))
Darrick J. Wongeca36542018-10-30 10:42:10 +11003043 count = ALIGN_DOWN(count, bs);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003044 bcount = count;
3045 }
3046
3047 /* Don't allow overlapped cloning within the same file. */
3048 if (inode_in == inode_out &&
3049 pos_out + bcount > pos_in &&
3050 pos_out < pos_in + bcount)
3051 return -EINVAL;
3052
Darrick J. Wongeca36542018-10-30 10:42:10 +11003053 /*
3054 * We shortened the request but the caller can't deal with that, so
3055 * bounce the request back to userspace.
3056 */
3057 if (*req_count != count && !(remap_flags & REMAP_FILE_CAN_SHORTEN))
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003058 return -EINVAL;
3059
Darrick J. Wongeca36542018-10-30 10:42:10 +11003060 *req_count = count;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003061 return 0;
3062}
3063
Amir Goldsteina3171352019-06-05 08:04:48 -07003064
3065/*
3066 * Performs common checks before doing a file copy/clone
3067 * from @file_in to @file_out.
3068 */
3069int generic_file_rw_checks(struct file *file_in, struct file *file_out)
3070{
3071 struct inode *inode_in = file_inode(file_in);
3072 struct inode *inode_out = file_inode(file_out);
3073
3074 /* Don't copy dirs, pipes, sockets... */
3075 if (S_ISDIR(inode_in->i_mode) || S_ISDIR(inode_out->i_mode))
3076 return -EISDIR;
3077 if (!S_ISREG(inode_in->i_mode) || !S_ISREG(inode_out->i_mode))
3078 return -EINVAL;
3079
3080 if (!(file_in->f_mode & FMODE_READ) ||
3081 !(file_out->f_mode & FMODE_WRITE) ||
3082 (file_out->f_flags & O_APPEND))
3083 return -EBADF;
3084
3085 return 0;
3086}
3087
Amir Goldstein96e6e8f2019-06-05 08:04:49 -07003088/*
3089 * Performs necessary checks before doing a file copy
3090 *
3091 * Can adjust amount of bytes to copy via @req_count argument.
3092 * Returns appropriate error code that caller should return or
3093 * zero in case the copy should be allowed.
3094 */
3095int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3096 struct file *file_out, loff_t pos_out,
3097 size_t *req_count, unsigned int flags)
3098{
3099 struct inode *inode_in = file_inode(file_in);
3100 struct inode *inode_out = file_inode(file_out);
3101 uint64_t count = *req_count;
3102 loff_t size_in;
3103 int ret;
3104
3105 ret = generic_file_rw_checks(file_in, file_out);
3106 if (ret)
3107 return ret;
3108
3109 /* Don't touch certain kinds of inodes */
3110 if (IS_IMMUTABLE(inode_out))
3111 return -EPERM;
3112
3113 if (IS_SWAPFILE(inode_in) || IS_SWAPFILE(inode_out))
3114 return -ETXTBSY;
3115
3116 /* Ensure offsets don't wrap. */
3117 if (pos_in + count < pos_in || pos_out + count < pos_out)
3118 return -EOVERFLOW;
3119
3120 /* Shorten the copy to EOF */
3121 size_in = i_size_read(inode_in);
3122 if (pos_in >= size_in)
3123 count = 0;
3124 else
3125 count = min(count, size_in - (uint64_t)pos_in);
3126
3127 ret = generic_write_check_limits(file_out, pos_out, &count);
3128 if (ret)
3129 return ret;
3130
3131 /* Don't allow overlapped copying within the same file. */
3132 if (inode_in == inode_out &&
3133 pos_out + count > pos_in &&
3134 pos_out < pos_in + count)
3135 return -EINVAL;
3136
3137 *req_count = count;
3138 return 0;
3139}
3140
Nick Pigginafddba42007-10-16 01:25:01 -07003141int pagecache_write_begin(struct file *file, struct address_space *mapping,
3142 loff_t pos, unsigned len, unsigned flags,
3143 struct page **pagep, void **fsdata)
3144{
3145 const struct address_space_operations *aops = mapping->a_ops;
3146
Nick Piggin4e02ed42008-10-29 14:00:55 -07003147 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003148 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003149}
3150EXPORT_SYMBOL(pagecache_write_begin);
3151
3152int pagecache_write_end(struct file *file, struct address_space *mapping,
3153 loff_t pos, unsigned len, unsigned copied,
3154 struct page *page, void *fsdata)
3155{
3156 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003157
Nick Piggin4e02ed42008-10-29 14:00:55 -07003158 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003159}
3160EXPORT_SYMBOL(pagecache_write_end);
3161
Linus Torvalds1da177e2005-04-16 15:20:36 -07003162ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003163generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003164{
3165 struct file *file = iocb->ki_filp;
3166 struct address_space *mapping = file->f_mapping;
3167 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003168 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003169 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003170 size_t write_len;
3171 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003172
Al Viro0c949332014-03-22 06:51:37 -04003173 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003174 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003175
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003176 if (iocb->ki_flags & IOCB_NOWAIT) {
3177 /* If there are pages to writeback, return */
3178 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003179 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003180 return -EAGAIN;
3181 } else {
3182 written = filemap_write_and_wait_range(mapping, pos,
3183 pos + write_len - 1);
3184 if (written)
3185 goto out;
3186 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003187
3188 /*
3189 * After a write we want buffered reads to be sure to go to disk to get
3190 * the new data. We invalidate clean cached page from the region we're
3191 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003192 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003193 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003194 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003195 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003196 /*
3197 * If a page can not be invalidated, return 0 to fall back
3198 * to buffered write.
3199 */
3200 if (written) {
3201 if (written == -EBUSY)
3202 return 0;
3203 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003204 }
3205
Al Viro639a93a52017-04-13 14:10:15 -04003206 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003207
3208 /*
3209 * Finally, try again to invalidate clean pages which might have been
3210 * cached by non-direct readahead, or faulted in by get_user_pages()
3211 * if the source of the write was an mmap'ed region of the file
3212 * we're writing. Either one is a pretty crazy thing to do,
3213 * so we don't support it 100%. If this invalidation
3214 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003215 *
3216 * Most of the time we do not need this since dio_complete() will do
3217 * the invalidation for us. However there are some file systems that
3218 * do not end up with dio_complete() being called, so let's not break
3219 * them by removing it completely
Christoph Hellwiga969e902008-07-23 21:27:04 -07003220 */
Lukas Czerner332391a2017-09-21 08:16:29 -06003221 if (mapping->nrpages)
3222 invalidate_inode_pages2_range(mapping,
3223 pos >> PAGE_SHIFT, end);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003224
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003226 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003227 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003228 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3229 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003230 mark_inode_dirty(inode);
3231 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003232 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003233 }
Al Viro639a93a52017-04-13 14:10:15 -04003234 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003235out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003236 return written;
3237}
3238EXPORT_SYMBOL(generic_file_direct_write);
3239
Nick Piggineb2be182007-10-16 01:24:57 -07003240/*
3241 * Find or create a page at the given pagecache position. Return the locked
3242 * page. This function is specifically for buffered writes.
3243 */
Nick Piggin54566b22009-01-04 12:00:53 -08003244struct page *grab_cache_page_write_begin(struct address_space *mapping,
3245 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003246{
Nick Piggineb2be182007-10-16 01:24:57 -07003247 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003248 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003249
Nick Piggin54566b22009-01-04 12:00:53 -08003250 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003251 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003252
Mel Gorman2457aec2014-06-04 16:10:31 -07003253 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003254 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003255 if (page)
3256 wait_for_stable_page(page);
3257
Nick Piggineb2be182007-10-16 01:24:57 -07003258 return page;
3259}
Nick Piggin54566b22009-01-04 12:00:53 -08003260EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003261
Al Viro3b93f912014-02-11 21:34:08 -05003262ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003263 struct iov_iter *i, loff_t pos)
3264{
3265 struct address_space *mapping = file->f_mapping;
3266 const struct address_space_operations *a_ops = mapping->a_ops;
3267 long status = 0;
3268 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003269 unsigned int flags = 0;
3270
Nick Pigginafddba42007-10-16 01:25:01 -07003271 do {
3272 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003273 unsigned long offset; /* Offset into pagecache page */
3274 unsigned long bytes; /* Bytes to write to page */
3275 size_t copied; /* Bytes copied from user */
3276 void *fsdata;
3277
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003278 offset = (pos & (PAGE_SIZE - 1));
3279 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003280 iov_iter_count(i));
3281
3282again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003283 /*
3284 * Bring in the user page that we will copy from _first_.
3285 * Otherwise there's a nasty deadlock on copying from the
3286 * same page as we're writing to, without it being marked
3287 * up-to-date.
3288 *
3289 * Not only is this an optimisation, but it is also required
3290 * to check that the address is actually valid, when atomic
3291 * usercopies are used, below.
3292 */
3293 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3294 status = -EFAULT;
3295 break;
3296 }
3297
Jan Kara296291c2015-10-22 13:32:21 -07003298 if (fatal_signal_pending(current)) {
3299 status = -EINTR;
3300 break;
3301 }
3302
Nick Piggin674b8922007-10-16 01:25:03 -07003303 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003304 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003305 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003306 break;
3307
anfei zhou931e80e2010-02-02 13:44:02 -08003308 if (mapping_writably_mapped(mapping))
3309 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003310
Nick Pigginafddba42007-10-16 01:25:01 -07003311 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003312 flush_dcache_page(page);
3313
3314 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3315 page, fsdata);
3316 if (unlikely(status < 0))
3317 break;
3318 copied = status;
3319
3320 cond_resched();
3321
Nick Piggin124d3b72008-02-02 15:01:17 +01003322 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003323 if (unlikely(copied == 0)) {
3324 /*
3325 * If we were unable to copy any data at all, we must
3326 * fall back to a single segment length write.
3327 *
3328 * If we didn't fallback here, we could livelock
3329 * because not all segments in the iov can be copied at
3330 * once without a pagefault.
3331 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003332 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003333 iov_iter_single_seg_count(i));
3334 goto again;
3335 }
Nick Pigginafddba42007-10-16 01:25:01 -07003336 pos += copied;
3337 written += copied;
3338
3339 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003340 } while (iov_iter_count(i));
3341
3342 return written ? written : status;
3343}
Al Viro3b93f912014-02-11 21:34:08 -05003344EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003345
Jan Karae4dd9de2009-08-17 18:10:06 +02003346/**
Al Viro81742022014-04-03 03:17:43 -04003347 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003348 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003349 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003350 *
3351 * This function does all the work needed for actually writing data to a
3352 * file. It does all basic checks, removes SUID from the file, updates
3353 * modification times and calls proper subroutines depending on whether we
3354 * do direct IO or a standard buffered write.
3355 *
3356 * It expects i_mutex to be grabbed unless we work on a block device or similar
3357 * object which does not need locking at all.
3358 *
3359 * This function does *not* take care of syncing data in case of O_SYNC write.
3360 * A caller has to handle it. This is mainly due to the fact that we want to
3361 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003362 *
3363 * Return:
3364 * * number of bytes written, even for truncated writes
3365 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003366 */
Al Viro81742022014-04-03 03:17:43 -04003367ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003368{
3369 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003370 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003372 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003373 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003374 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003375
Linus Torvalds1da177e2005-04-16 15:20:36 -07003376 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003377 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003378 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003379 if (err)
3380 goto out;
3381
Josef Bacikc3b2da32012-03-26 09:59:21 -04003382 err = file_update_time(file);
3383 if (err)
3384 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003385
Al Viro2ba48ce2015-04-09 13:52:01 -04003386 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003387 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003388
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003389 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003390 /*
3391 * If the write stopped short of completing, fall back to
3392 * buffered writes. Some filesystems do this for writes to
3393 * holes, for example. For DAX files, a buffered write will
3394 * not succeed (even if it did, DAX does not handle dirty
3395 * page-cache pages correctly).
3396 */
Al Viro0b8def92015-04-07 10:22:53 -04003397 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003399
Al Viro0b8def92015-04-07 10:22:53 -04003400 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003401 /*
Al Viro3b93f912014-02-11 21:34:08 -05003402 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003403 * then we want to return the number of bytes which were
3404 * direct-written, or the error code if that was zero. Note
3405 * that this differs from normal direct-io semantics, which
3406 * will return -EFOO even if some bytes were written.
3407 */
Al Viro60bb4522014-08-08 12:39:16 -04003408 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003409 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003410 goto out;
3411 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003412 /*
3413 * We need to ensure that the page cache pages are written to
3414 * disk and invalidated to preserve the expected O_DIRECT
3415 * semantics.
3416 */
Al Viro3b93f912014-02-11 21:34:08 -05003417 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003418 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003419 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003420 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003421 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003422 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003423 pos >> PAGE_SHIFT,
3424 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003425 } else {
3426 /*
3427 * We don't know how much we wrote, so just return
3428 * the number of bytes which were direct-written
3429 */
3430 }
3431 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003432 written = generic_perform_write(file, from, iocb->ki_pos);
3433 if (likely(written > 0))
3434 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003435 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003436out:
3437 current->backing_dev_info = NULL;
3438 return written ? written : err;
3439}
Al Viro81742022014-04-03 03:17:43 -04003440EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003441
Jan Karae4dd9de2009-08-17 18:10:06 +02003442/**
Al Viro81742022014-04-03 03:17:43 -04003443 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003444 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003445 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003446 *
Al Viro81742022014-04-03 03:17:43 -04003447 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003448 * filesystems. It takes care of syncing the file in case of O_SYNC file
3449 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003450 * Return:
3451 * * negative error code if no data has been written at all of
3452 * vfs_fsync_range() failed for a synchronous write
3453 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003454 */
Al Viro81742022014-04-03 03:17:43 -04003455ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003456{
3457 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003458 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003459 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003460
Al Viro59551022016-01-22 15:40:57 -05003461 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003462 ret = generic_write_checks(iocb, from);
3463 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003464 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003465 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
Christoph Hellwige2592212016-04-07 08:52:01 -07003467 if (ret > 0)
3468 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003469 return ret;
3470}
Al Viro81742022014-04-03 03:17:43 -04003471EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003472
David Howellscf9a2ae2006-08-29 19:05:54 +01003473/**
3474 * try_to_release_page() - release old fs-specific metadata on a page
3475 *
3476 * @page: the page which the kernel is trying to free
3477 * @gfp_mask: memory allocation flags (and I/O mode)
3478 *
3479 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003480 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003481 *
David Howells266cf652009-04-03 16:42:36 +01003482 * This may also be called if PG_fscache is set on a page, indicating that the
3483 * page is known to the local caching routines.
3484 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003485 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003486 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003487 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003488 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003489 */
3490int try_to_release_page(struct page *page, gfp_t gfp_mask)
3491{
3492 struct address_space * const mapping = page->mapping;
3493
3494 BUG_ON(!PageLocked(page));
3495 if (PageWriteback(page))
3496 return 0;
3497
3498 if (mapping && mapping->a_ops->releasepage)
3499 return mapping->a_ops->releasepage(page, gfp_mask);
3500 return try_to_free_buffers(page);
3501}
3502
3503EXPORT_SYMBOL(try_to_release_page);