blob: ad82672a9941fae7151b203f194898b9ef8b04f9 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8/*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080015#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/fs.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010017#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070018#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080019#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mm.h>
23#include <linux/swap.h>
24#include <linux/mman.h>
25#include <linux/pagemap.h>
26#include <linux/file.h>
27#include <linux/uio.h>
Josef Bacikcfcbfb12019-05-13 17:21:04 -070028#include <linux/error-injection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/hash.h>
30#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070031#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080035#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070036#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080037#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060038#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080039#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070040#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070041#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070042#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070043#include <linux/ramfs.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080044#include "internal.h"
45
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070046#define CREATE_TRACE_POINTS
47#include <trace/events/filemap.h>
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 * FIXME: remove all knowledge of the buffer layer from the core VM
51 */
Jan Kara148f9482009-08-17 19:52:36 +020052#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <asm/mman.h>
55
56/*
57 * Shared mappings implemented 30.11.1994. It's not fully working yet,
58 * though.
59 *
60 * Shared mappings now work. 15.8.1995 Bruno.
61 *
62 * finished 'unifying' the page and buffer cache and SMP-threaded the
63 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
64 *
65 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
66 */
67
68/*
69 * Lock ordering:
70 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080071 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070073 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070074 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080076 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080077 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 *
79 * ->mmap_sem
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080080 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070081 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070082 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 *
84 * ->mmap_sem
85 * ->lock_page (access_process_vm)
86 *
Al Viroccad2362014-02-11 22:36:48 -050087 * ->i_mutex (generic_perform_write)
Nick Piggin82591e62006-10-19 23:29:10 -070088 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060090 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110091 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070092 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080094 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * ->anon_vma.lock (vma_adjust)
96 *
97 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070098 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700100 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700101 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700103 * ->i_pages lock (try_to_unmap_one)
Andrey Ryabininf4b7e272019-03-05 15:49:39 -0800104 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
105 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700107 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600108 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100109 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700110 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600111 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100112 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
114 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800115 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700116 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 */
118
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500119static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700120 struct page *page, void *shadow)
121{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500122 XA_STATE(xas, &mapping->i_pages, page->index);
123 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800124
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500125 mapping_set_update(&xas, mapping);
126
127 /* hugetlb pages are represented by a single entry in the xarray */
128 if (!PageHuge(page)) {
129 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700130 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500131 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700132
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700133 VM_BUG_ON_PAGE(!PageLocked(page), page);
134 VM_BUG_ON_PAGE(PageTail(page), page);
135 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700136
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500137 xas_store(&xas, shadow);
138 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200139
Jan Kara23006382017-11-15 17:37:26 -0800140 page->mapping = NULL;
141 /* Leave page->index set: truncation lookup relies upon it */
142
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200143 if (shadow) {
144 mapping->nrexceptional += nr;
145 /*
146 * Make sure the nrexceptional update is committed before
147 * the nrpages update so that final truncate racing
148 * with reclaim does not see both counters 0 at the
149 * same time and miss a shadow entry.
150 */
151 smp_wmb();
152 }
153 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700154}
155
Jan Kara5ecc4d82017-11-15 17:37:29 -0800156static void unaccount_page_cache_page(struct address_space *mapping,
157 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800159 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600161 /*
162 * if we're uptodate, flush out into the cleancache, otherwise
163 * invalidate any existing cleancache entries. We can't leave
164 * stale data around in the cleancache once our page is gone
165 */
166 if (PageUptodate(page) && PageMappedToDisk(page))
167 cleancache_put_page(page);
168 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400169 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600170
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700171 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800172 VM_BUG_ON_PAGE(page_mapped(page), page);
173 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
174 int mapcount;
175
176 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
177 current->comm, page_to_pfn(page));
178 dump_page(page, "still mapped when deleted");
179 dump_stack();
180 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
181
182 mapcount = page_mapcount(page);
183 if (mapping_exiting(mapping) &&
184 page_count(page) >= mapcount + 2) {
185 /*
186 * All vmas have already been torn down, so it's
187 * a good bet that actually the page is unmapped,
188 * and we'd prefer not to leak it: if we're wrong,
189 * some other bad page check should catch it later.
190 */
191 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700192 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800193 }
194 }
195
Jan Kara76253fb2017-11-15 17:37:22 -0800196 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800197 if (PageHuge(page))
198 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800199
Jan Kara5ecc4d82017-11-15 17:37:29 -0800200 nr = hpage_nr_pages(page);
201
202 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
203 if (PageSwapBacked(page)) {
204 __mod_node_page_state(page_pgdat(page), NR_SHMEM, -nr);
205 if (PageTransHuge(page))
206 __dec_node_page_state(page, NR_SHMEM_THPS);
Song Liu99cb0db2019-09-23 15:38:00 -0700207 } else if (PageTransHuge(page)) {
208 __dec_node_page_state(page, NR_FILE_THPS);
Song Liu09d91cd2019-09-23 15:38:03 -0700209 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800210 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800211
212 /*
213 * At this point page must be either written or cleaned by
214 * truncate. Dirty page here signals a bug and loss of
215 * unwritten data.
216 *
217 * This fixes dirty accounting after removing the page entirely
218 * but leaves PageDirty set: it has no effect for truncated
219 * page and anyway will be cleared before returning page into
220 * buddy allocator.
221 */
222 if (WARN_ON_ONCE(PageDirty(page)))
223 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
224}
225
226/*
227 * Delete a page from the page cache and free it. Caller has to make
228 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700229 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800230 */
231void __delete_from_page_cache(struct page *page, void *shadow)
232{
233 struct address_space *mapping = page->mapping;
234
235 trace_mm_filemap_delete_from_page_cache(page);
236
237 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500238 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239}
240
Jan Kara59c66c52017-11-15 17:37:18 -0800241static void page_cache_free_page(struct address_space *mapping,
242 struct page *page)
243{
244 void (*freepage)(struct page *);
245
246 freepage = mapping->a_ops->freepage;
247 if (freepage)
248 freepage(page);
249
250 if (PageTransHuge(page) && !PageHuge(page)) {
251 page_ref_sub(page, HPAGE_PMD_NR);
252 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
253 } else {
254 put_page(page);
255 }
256}
257
Minchan Kim702cfbf2011-03-22 16:32:43 -0700258/**
259 * delete_from_page_cache - delete page from page cache
260 * @page: the page which the kernel is trying to remove from page cache
261 *
262 * This must be called only on pages that have been verified to be in the page
263 * cache and locked. It will never put the page into the free list, the caller
264 * has a reference on the page.
265 */
266void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700268 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400269 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Matt Mackallcd7619d2005-05-01 08:59:01 -0700271 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700272 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700273 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700274 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500275
Jan Kara59c66c52017-11-15 17:37:18 -0800276 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700277}
278EXPORT_SYMBOL(delete_from_page_cache);
279
Jan Karaaa65c292017-11-15 17:37:33 -0800280/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500281 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800282 * @mapping: the mapping to which pages belong
283 * @pvec: pagevec with pages to delete
284 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700285 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700286 * from the mapping. The function expects @pvec to be sorted by page index
287 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700288 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800289 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700290 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800291 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700292 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800293 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500294static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800295 struct pagevec *pvec)
296{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500297 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800298 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700299 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800300 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800301
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500302 mapping_set_update(&xas, mapping);
303 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700304 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800305 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700306
307 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400308 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800309 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700310 /*
311 * A page got inserted in our range? Skip it. We have our
312 * pages locked so they are protected from being removed.
313 * If we see a page whose index is higher than ours, it
314 * means our page has been removed, which shouldn't be
315 * possible because we're holding the PageLock.
316 */
317 if (page != pvec->pages[i]) {
318 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
319 page);
320 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700321 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700322
323 WARN_ON_ONCE(!PageLocked(page));
324
325 if (page->index == xas.xa_index)
326 page->mapping = NULL;
327 /* Leave page->index set: truncation lookup relies on it */
328
329 /*
330 * Move to the next page in the vector if this is a regular
331 * page or the index is of the last sub-page of this compound
332 * page.
333 */
334 if (page->index + compound_nr(page) - 1 == xas.xa_index)
335 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500336 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800337 total_pages++;
338 }
339 mapping->nrpages -= total_pages;
340}
341
342void delete_from_page_cache_batch(struct address_space *mapping,
343 struct pagevec *pvec)
344{
345 int i;
346 unsigned long flags;
347
348 if (!pagevec_count(pvec))
349 return;
350
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700351 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800352 for (i = 0; i < pagevec_count(pvec); i++) {
353 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
354
355 unaccount_page_cache_page(mapping, pvec->pages[i]);
356 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500357 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700358 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800359
360 for (i = 0; i < pagevec_count(pvec); i++)
361 page_cache_free_page(mapping, pvec->pages[i]);
362}
363
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200364int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700365{
366 int ret = 0;
367 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700368 if (test_bit(AS_ENOSPC, &mapping->flags) &&
369 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700370 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700371 if (test_bit(AS_EIO, &mapping->flags) &&
372 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700373 ret = -EIO;
374 return ret;
375}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200376EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700377
Jeff Layton76341ca2017-07-06 07:02:22 -0400378static int filemap_check_and_keep_errors(struct address_space *mapping)
379{
380 /* Check for outstanding write errors */
381 if (test_bit(AS_EIO, &mapping->flags))
382 return -EIO;
383 if (test_bit(AS_ENOSPC, &mapping->flags))
384 return -ENOSPC;
385 return 0;
386}
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700389 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700390 * @mapping: address space structure to write
391 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800392 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700393 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700395 * Start writeback against all of a mapping's dirty pages that lie
396 * within the byte offsets <start, end> inclusive.
397 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700399 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 * these two operations is that if a dirty page/buffer is encountered, it must
401 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800402 *
403 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800405int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
406 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407{
408 int ret;
409 struct writeback_control wbc = {
410 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800411 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700412 .range_start = start,
413 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 };
415
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700416 if (!mapping_cap_writeback_dirty(mapping) ||
417 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 return 0;
419
Tejun Heob16b1de2015-06-02 08:39:48 -0600420 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600422 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 return ret;
424}
425
426static inline int __filemap_fdatawrite(struct address_space *mapping,
427 int sync_mode)
428{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700429 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430}
431
432int filemap_fdatawrite(struct address_space *mapping)
433{
434 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
435}
436EXPORT_SYMBOL(filemap_fdatawrite);
437
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400438int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800439 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
441 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
442}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400443EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Randy Dunlap485bb992006-06-23 02:03:49 -0700445/**
446 * filemap_flush - mostly a non-blocking flush
447 * @mapping: target address_space
448 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 * This is a mostly non-blocking flush. Not suitable for data-integrity
450 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800451 *
452 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 */
454int filemap_flush(struct address_space *mapping)
455{
456 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
457}
458EXPORT_SYMBOL(filemap_flush);
459
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500460/**
461 * filemap_range_has_page - check if a page exists in range.
462 * @mapping: address space within which to check
463 * @start_byte: offset in bytes where the range starts
464 * @end_byte: offset in bytes where the range ends (inclusive)
465 *
466 * Find at least one page in the range supplied, usually used to check if
467 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800468 *
469 * Return: %true if at least one page exists in the specified range,
470 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500471 */
472bool filemap_range_has_page(struct address_space *mapping,
473 loff_t start_byte, loff_t end_byte)
474{
Jan Karaf7b68042017-09-06 16:21:40 -0700475 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500476 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
477 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500478
479 if (end_byte < start_byte)
480 return false;
481
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500482 rcu_read_lock();
483 for (;;) {
484 page = xas_find(&xas, max);
485 if (xas_retry(&xas, page))
486 continue;
487 /* Shadow entries don't count */
488 if (xa_is_value(page))
489 continue;
490 /*
491 * We don't need to try to pin this page; we're about to
492 * release the RCU lock anyway. It is enough to know that
493 * there was a page here recently.
494 */
495 break;
496 }
497 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500498
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500499 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500500}
501EXPORT_SYMBOL(filemap_range_has_page);
502
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400503static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800504 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300506 pgoff_t index = start_byte >> PAGE_SHIFT;
507 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 struct pagevec pvec;
509 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200511 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400512 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Mel Gorman86679822017-11-15 17:37:52 -0800514 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800515 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 unsigned i;
517
Jan Kara312e9d22017-11-15 17:35:05 -0800518 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800519 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800520 if (!nr_pages)
521 break;
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 for (i = 0; i < nr_pages; i++) {
524 struct page *page = pvec.pages[i];
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400527 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 }
529 pagevec_release(&pvec);
530 cond_resched();
531 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800532}
533
534/**
535 * filemap_fdatawait_range - wait for writeback to complete
536 * @mapping: address space structure to wait for
537 * @start_byte: offset in bytes where the range starts
538 * @end_byte: offset in bytes where the range ends (inclusive)
539 *
540 * Walk the list of under-writeback pages of the given address space
541 * in the given range and wait for all of them. Check error status of
542 * the address space and return it.
543 *
544 * Since the error status of the address space is cleared by this function,
545 * callers are responsible for checking the return value and handling and/or
546 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800547 *
548 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800549 */
550int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
551 loff_t end_byte)
552{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400553 __filemap_fdatawait_range(mapping, start_byte, end_byte);
554 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200556EXPORT_SYMBOL(filemap_fdatawait_range);
557
558/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400559 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
560 * @mapping: address space structure to wait for
561 * @start_byte: offset in bytes where the range starts
562 * @end_byte: offset in bytes where the range ends (inclusive)
563 *
564 * Walk the list of under-writeback pages of the given address space in the
565 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
566 * this function does not clear error status of the address space.
567 *
568 * Use this function if callers don't handle errors themselves. Expected
569 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
570 * fsfreeze(8)
571 */
572int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
573 loff_t start_byte, loff_t end_byte)
574{
575 __filemap_fdatawait_range(mapping, start_byte, end_byte);
576 return filemap_check_and_keep_errors(mapping);
577}
578EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
579
580/**
Jeff Laytona823e452017-07-28 07:24:43 -0400581 * file_fdatawait_range - wait for writeback to complete
582 * @file: file pointing to address space structure to wait for
583 * @start_byte: offset in bytes where the range starts
584 * @end_byte: offset in bytes where the range ends (inclusive)
585 *
586 * Walk the list of under-writeback pages of the address space that file
587 * refers to, in the given range and wait for all of them. Check error
588 * status of the address space vs. the file->f_wb_err cursor and return it.
589 *
590 * Since the error status of the file is advanced by this function,
591 * callers are responsible for checking the return value and handling and/or
592 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800593 *
594 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400595 */
596int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
597{
598 struct address_space *mapping = file->f_mapping;
599
600 __filemap_fdatawait_range(mapping, start_byte, end_byte);
601 return file_check_and_advance_wb_err(file);
602}
603EXPORT_SYMBOL(file_fdatawait_range);
604
605/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800606 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
607 * @mapping: address space structure to wait for
608 *
609 * Walk the list of under-writeback pages of the given address space
610 * and wait for all of them. Unlike filemap_fdatawait(), this function
611 * does not clear error status of the address space.
612 *
613 * Use this function if callers don't handle errors themselves. Expected
614 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
615 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800616 *
617 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800618 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400619int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800620{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400621 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400622 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800623}
Jeff Layton76341ca2017-07-06 07:02:22 -0400624EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800625
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700626/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400627static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700629 if (dax_mapping(mapping))
630 return mapping->nrexceptional;
631
632 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Randy Dunlap485bb992006-06-23 02:03:49 -0700635/**
636 * filemap_write_and_wait_range - write out & wait on a file range
637 * @mapping: the address_space for the pages
638 * @lstart: offset in bytes where the range starts
639 * @lend: offset in bytes where the range ends (inclusive)
640 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800641 * Write out and wait upon file offsets lstart->lend, inclusive.
642 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300643 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800644 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800645 *
646 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800647 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648int filemap_write_and_wait_range(struct address_space *mapping,
649 loff_t lstart, loff_t lend)
650{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800651 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Jeff Layton9326c9b2017-07-26 10:21:11 -0400653 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800654 err = __filemap_fdatawrite_range(mapping, lstart, lend,
655 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800656 /*
657 * Even if the above returned error, the pages may be
658 * written partially (e.g. -ENOSPC), so we wait for it.
659 * But the -EIO is special case, it may indicate the worst
660 * thing (e.g. bug) happened, so we avoid waiting for it.
661 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800662 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200663 int err2 = filemap_fdatawait_range(mapping,
664 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800665 if (!err)
666 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400667 } else {
668 /* Clear any previously stored errors */
669 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800670 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700671 } else {
672 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800674 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675}
Chris Masonf6995582009-04-15 13:22:37 -0400676EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Jeff Layton5660e132017-07-06 07:02:25 -0400678void __filemap_set_wb_err(struct address_space *mapping, int err)
679{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400680 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400681
682 trace_filemap_set_wb_err(mapping, eseq);
683}
684EXPORT_SYMBOL(__filemap_set_wb_err);
685
686/**
687 * file_check_and_advance_wb_err - report wb error (if any) that was previously
688 * and advance wb_err to current one
689 * @file: struct file on which the error is being reported
690 *
691 * When userland calls fsync (or something like nfsd does the equivalent), we
692 * want to report any writeback errors that occurred since the last fsync (or
693 * since the file was opened if there haven't been any).
694 *
695 * Grab the wb_err from the mapping. If it matches what we have in the file,
696 * then just quickly return 0. The file is all caught up.
697 *
698 * If it doesn't match, then take the mapping value, set the "seen" flag in
699 * it and try to swap it into place. If it works, or another task beat us
700 * to it with the new value, then update the f_wb_err and return the error
701 * portion. The error at this point must be reported via proper channels
702 * (a'la fsync, or NFS COMMIT operation, etc.).
703 *
704 * While we handle mapping->wb_err with atomic operations, the f_wb_err
705 * value is protected by the f_lock since we must ensure that it reflects
706 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800707 *
708 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400709 */
710int file_check_and_advance_wb_err(struct file *file)
711{
712 int err = 0;
713 errseq_t old = READ_ONCE(file->f_wb_err);
714 struct address_space *mapping = file->f_mapping;
715
716 /* Locklessly handle the common case where nothing has changed */
717 if (errseq_check(&mapping->wb_err, old)) {
718 /* Something changed, must use slow path */
719 spin_lock(&file->f_lock);
720 old = file->f_wb_err;
721 err = errseq_check_and_advance(&mapping->wb_err,
722 &file->f_wb_err);
723 trace_file_check_and_advance_wb_err(file, old);
724 spin_unlock(&file->f_lock);
725 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700726
727 /*
728 * We're mostly using this function as a drop in replacement for
729 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
730 * that the legacy code would have had on these flags.
731 */
732 clear_bit(AS_EIO, &mapping->flags);
733 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400734 return err;
735}
736EXPORT_SYMBOL(file_check_and_advance_wb_err);
737
738/**
739 * file_write_and_wait_range - write out & wait on a file range
740 * @file: file pointing to address_space with pages
741 * @lstart: offset in bytes where the range starts
742 * @lend: offset in bytes where the range ends (inclusive)
743 *
744 * Write out and wait upon file offsets lstart->lend, inclusive.
745 *
746 * Note that @lend is inclusive (describes the last byte to be written) so
747 * that this function can be used to write to the very end-of-file (end = -1).
748 *
749 * After writing out and waiting on the data, we check and advance the
750 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800751 *
752 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400753 */
754int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
755{
756 int err = 0, err2;
757 struct address_space *mapping = file->f_mapping;
758
Jeff Layton9326c9b2017-07-26 10:21:11 -0400759 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400760 err = __filemap_fdatawrite_range(mapping, lstart, lend,
761 WB_SYNC_ALL);
762 /* See comment of filemap_write_and_wait() */
763 if (err != -EIO)
764 __filemap_fdatawait_range(mapping, lstart, lend);
765 }
766 err2 = file_check_and_advance_wb_err(file);
767 if (!err)
768 err = err2;
769 return err;
770}
771EXPORT_SYMBOL(file_write_and_wait_range);
772
Randy Dunlap485bb992006-06-23 02:03:49 -0700773/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700774 * replace_page_cache_page - replace a pagecache page with a new one
775 * @old: page to be replaced
776 * @new: page to replace with
777 * @gfp_mask: allocation mode
778 *
779 * This function replaces a page in the pagecache with a new one. On
780 * success it acquires the pagecache reference for the new page and
781 * drops it for the old page. Both the old and new pages must be
782 * locked. This function does not add the new page to the LRU, the
783 * caller must do that.
784 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500785 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800786 *
787 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700788 */
789int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
790{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500791 struct address_space *mapping = old->mapping;
792 void (*freepage)(struct page *) = mapping->a_ops->freepage;
793 pgoff_t offset = old->index;
794 XA_STATE(xas, &mapping->i_pages, offset);
795 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700796
Sasha Levin309381fea2014-01-23 15:52:54 -0800797 VM_BUG_ON_PAGE(!PageLocked(old), old);
798 VM_BUG_ON_PAGE(!PageLocked(new), new);
799 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700800
Matthew Wilcox74d60952017-11-17 10:01:45 -0500801 get_page(new);
802 new->mapping = mapping;
803 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700804
Matthew Wilcox74d60952017-11-17 10:01:45 -0500805 xas_lock_irqsave(&xas, flags);
806 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700807
Matthew Wilcox74d60952017-11-17 10:01:45 -0500808 old->mapping = NULL;
809 /* hugetlb pages do not participate in page cache accounting. */
810 if (!PageHuge(old))
811 __dec_node_page_state(new, NR_FILE_PAGES);
812 if (!PageHuge(new))
813 __inc_node_page_state(new, NR_FILE_PAGES);
814 if (PageSwapBacked(old))
815 __dec_node_page_state(new, NR_SHMEM);
816 if (PageSwapBacked(new))
817 __inc_node_page_state(new, NR_SHMEM);
818 xas_unlock_irqrestore(&xas, flags);
819 mem_cgroup_migrate(old, new);
820 if (freepage)
821 freepage(old);
822 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700823
Matthew Wilcox74d60952017-11-17 10:01:45 -0500824 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700825}
826EXPORT_SYMBOL_GPL(replace_page_cache_page);
827
Johannes Weinera5289102014-04-03 14:47:51 -0700828static int __add_to_page_cache_locked(struct page *page,
829 struct address_space *mapping,
830 pgoff_t offset, gfp_t gfp_mask,
831 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500833 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700834 int huge = PageHuge(page);
835 struct mem_cgroup *memcg;
Nick Piggine2867812008-07-25 19:45:30 -0700836 int error;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500837 void *old;
Nick Piggine2867812008-07-25 19:45:30 -0700838
Sasha Levin309381fea2014-01-23 15:52:54 -0800839 VM_BUG_ON_PAGE(!PageLocked(page), page);
840 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500841 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700842
Johannes Weiner00501b52014-08-08 14:19:20 -0700843 if (!huge) {
844 error = mem_cgroup_try_charge(page, current->mm,
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800845 gfp_mask, &memcg, false);
Johannes Weiner00501b52014-08-08 14:19:20 -0700846 if (error)
847 return error;
848 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300850 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700851 page->mapping = mapping;
852 page->index = offset;
853
Matthew Wilcox74d60952017-11-17 10:01:45 -0500854 do {
855 xas_lock_irq(&xas);
856 old = xas_load(&xas);
857 if (old && !xa_is_value(old))
858 xas_set_err(&xas, -EEXIST);
859 xas_store(&xas, page);
860 if (xas_error(&xas))
861 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700862
Matthew Wilcox74d60952017-11-17 10:01:45 -0500863 if (xa_is_value(old)) {
864 mapping->nrexceptional--;
865 if (shadowp)
866 *shadowp = old;
867 }
868 mapping->nrpages++;
869
870 /* hugetlb pages do not participate in page cache accounting */
871 if (!huge)
872 __inc_node_page_state(page, NR_FILE_PAGES);
873unlock:
874 xas_unlock_irq(&xas);
875 } while (xas_nomem(&xas, gfp_mask & GFP_RECLAIM_MASK));
876
877 if (xas_error(&xas))
878 goto error;
879
Johannes Weiner00501b52014-08-08 14:19:20 -0700880 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800881 mem_cgroup_commit_charge(page, memcg, false, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700882 trace_mm_filemap_add_to_page_cache(page);
883 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500884error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700885 page->mapping = NULL;
886 /* Leave page->index set: truncation relies upon it */
Johannes Weiner00501b52014-08-08 14:19:20 -0700887 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800888 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300889 put_page(page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500890 return xas_error(&xas);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700892ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700893
894/**
895 * add_to_page_cache_locked - add a locked page to the pagecache
896 * @page: page to add
897 * @mapping: the page's address_space
898 * @offset: page index
899 * @gfp_mask: page allocation mode
900 *
901 * This function is used to add a page to the pagecache. It must be locked.
902 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800903 *
904 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700905 */
906int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
907 pgoff_t offset, gfp_t gfp_mask)
908{
909 return __add_to_page_cache_locked(page, mapping, offset,
910 gfp_mask, NULL);
911}
Nick Piggine2867812008-07-25 19:45:30 -0700912EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
914int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400915 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916{
Johannes Weinera5289102014-04-03 14:47:51 -0700917 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700918 int ret;
919
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800920 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700921 ret = __add_to_page_cache_locked(page, mapping, offset,
922 gfp_mask, &shadow);
923 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800924 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700925 else {
926 /*
927 * The page might have been evicted from cache only
928 * recently, in which case it should be activated like
929 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700930 * The exception is pages getting rewritten; evicting other
931 * data from the working set, only to cache data that will
932 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700933 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700934 WARN_ON_ONCE(PageActive(page));
935 if (!(gfp_mask & __GFP_WRITE) && shadow)
936 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700937 lru_cache_add(page);
938 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 return ret;
940}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300941EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942
Paul Jackson44110fe2006-03-24 03:16:04 -0800943#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700944struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800945{
Miao Xiec0ff7452010-05-24 14:32:08 -0700946 int n;
947 struct page *page;
948
Paul Jackson44110fe2006-03-24 03:16:04 -0800949 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700950 unsigned int cpuset_mems_cookie;
951 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700952 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700953 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700954 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700955 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700956
Miao Xiec0ff7452010-05-24 14:32:08 -0700957 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800958 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700959 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800960}
Nick Piggin2ae88142006-10-28 10:38:23 -0700961EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800962#endif
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964/*
965 * In order to wait for pages to become available there must be
966 * waitqueues associated with pages. By using a hash table of
967 * waitqueues where the bucket discipline is to maintain all
968 * waiters on the same queue and wake all when any of the pages
969 * become available, and for the woken contexts to check to be
970 * sure the appropriate page became available, this saves space
971 * at a cost of "thundering herd" phenomena during rare hash
972 * collisions.
973 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000974#define PAGE_WAIT_TABLE_BITS 8
975#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
976static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
977
978static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
Nicholas Piggin62906022016-12-25 13:00:30 +1000980 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981}
Nicholas Piggin62906022016-12-25 13:00:30 +1000982
983void __init pagecache_init(void)
984{
985 int i;
986
987 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
988 init_waitqueue_head(&page_wait_table[i]);
989
990 page_writeback_init();
991}
992
Linus Torvalds3510ca22017-08-27 13:55:12 -0700993/* This has the same layout as wait_bit_key - see fs/cachefiles/rdwr.c */
Nicholas Piggin62906022016-12-25 13:00:30 +1000994struct wait_page_key {
995 struct page *page;
996 int bit_nr;
997 int page_match;
998};
999
1000struct wait_page_queue {
1001 struct page *page;
1002 int bit_nr;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001003 wait_queue_entry_t wait;
Nicholas Piggin62906022016-12-25 13:00:30 +10001004};
1005
Ingo Molnarac6424b2017-06-20 12:06:13 +02001006static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001007{
1008 struct wait_page_key *key = arg;
1009 struct wait_page_queue *wait_page
1010 = container_of(wait, struct wait_page_queue, wait);
1011
1012 if (wait_page->page != key->page)
1013 return 0;
1014 key->page_match = 1;
1015
1016 if (wait_page->bit_nr != key->bit_nr)
1017 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001018
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001019 /*
1020 * Stop walking if it's locked.
1021 * Is this safe if put_and_wait_on_page_locked() is in use?
1022 * Yes: the waker must hold a reference to this page, and if PG_locked
1023 * has now already been set by another task, that task must also hold
1024 * a reference to the *same usage* of this page; so there is no need
1025 * to walk on to wake even the put_and_wait_on_page_locked() callers.
1026 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001027 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds3510ca22017-08-27 13:55:12 -07001028 return -1;
Nicholas Piggin62906022016-12-25 13:00:30 +10001029
1030 return autoremove_wake_function(wait, mode, sync, key);
1031}
1032
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001033static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001034{
1035 wait_queue_head_t *q = page_waitqueue(page);
1036 struct wait_page_key key;
1037 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001038 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001039
1040 key.page = page;
1041 key.bit_nr = bit_nr;
1042 key.page_match = 0;
1043
Tim Chen11a19c72017-08-25 09:13:55 -07001044 bookmark.flags = 0;
1045 bookmark.private = NULL;
1046 bookmark.func = NULL;
1047 INIT_LIST_HEAD(&bookmark.entry);
1048
Nicholas Piggin62906022016-12-25 13:00:30 +10001049 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001050 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1051
1052 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1053 /*
1054 * Take a breather from holding the lock,
1055 * allow pages that finish wake up asynchronously
1056 * to acquire the lock and remove themselves
1057 * from wait queue
1058 */
1059 spin_unlock_irqrestore(&q->lock, flags);
1060 cpu_relax();
1061 spin_lock_irqsave(&q->lock, flags);
1062 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1063 }
1064
Nicholas Piggin62906022016-12-25 13:00:30 +10001065 /*
1066 * It is possible for other pages to have collided on the waitqueue
1067 * hash, so in that case check for a page match. That prevents a long-
1068 * term waiter
1069 *
1070 * It is still possible to miss a case here, when we woke page waiters
1071 * and removed them from the waitqueue, but there are still other
1072 * page waiters.
1073 */
1074 if (!waitqueue_active(q) || !key.page_match) {
1075 ClearPageWaiters(page);
1076 /*
1077 * It's possible to miss clearing Waiters here, when we woke
1078 * our page waiters, but the hashed waitqueue has waiters for
1079 * other pages on it.
1080 *
1081 * That's okay, it's a rare case. The next waker will clear it.
1082 */
1083 }
1084 spin_unlock_irqrestore(&q->lock, flags);
1085}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001086
1087static void wake_up_page(struct page *page, int bit)
1088{
1089 if (!PageWaiters(page))
1090 return;
1091 wake_up_page_bit(page, bit);
1092}
Nicholas Piggin62906022016-12-25 13:00:30 +10001093
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001094/*
1095 * A choice of three behaviors for wait_on_page_bit_common():
1096 */
1097enum behavior {
1098 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1099 * __lock_page() waiting on then setting PG_locked.
1100 */
1101 SHARED, /* Hold ref to page and check the bit when woken, like
1102 * wait_on_page_writeback() waiting on PG_writeback.
1103 */
1104 DROP, /* Drop ref to page before wait, no check when woken,
1105 * like put_and_wait_on_page_locked() on PG_locked.
1106 */
1107};
1108
Nicholas Piggin62906022016-12-25 13:00:30 +10001109static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001110 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001111{
1112 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001113 wait_queue_entry_t *wait = &wait_page.wait;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001114 bool bit_is_set;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001115 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001116 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001117 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001118 int ret = 0;
1119
Johannes Weinereb414682018-10-26 15:06:27 -07001120 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001121 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001122 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001123 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001124 delayacct = true;
1125 }
Johannes Weinereb414682018-10-26 15:06:27 -07001126 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001127 thrashing = true;
1128 }
1129
Nicholas Piggin62906022016-12-25 13:00:30 +10001130 init_wait(wait);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001131 wait->flags = behavior == EXCLUSIVE ? WQ_FLAG_EXCLUSIVE : 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001132 wait->func = wake_page_function;
1133 wait_page.page = page;
1134 wait_page.bit_nr = bit_nr;
1135
1136 for (;;) {
1137 spin_lock_irq(&q->lock);
1138
Ingo Molnar2055da92017-06-20 12:06:46 +02001139 if (likely(list_empty(&wait->entry))) {
Linus Torvalds3510ca22017-08-27 13:55:12 -07001140 __add_wait_queue_entry_tail(q, wait);
Nicholas Piggin62906022016-12-25 13:00:30 +10001141 SetPageWaiters(page);
1142 }
1143
1144 set_current_state(state);
1145
1146 spin_unlock_irq(&q->lock);
1147
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001148 bit_is_set = test_bit(bit_nr, &page->flags);
1149 if (behavior == DROP)
1150 put_page(page);
Nicholas Piggin62906022016-12-25 13:00:30 +10001151
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001152 if (likely(bit_is_set))
1153 io_schedule();
1154
1155 if (behavior == EXCLUSIVE) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001156 if (!test_and_set_bit_lock(bit_nr, &page->flags))
1157 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001158 } else if (behavior == SHARED) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001159 if (!test_bit(bit_nr, &page->flags))
1160 break;
1161 }
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001162
Davidlohr Buesofa45f112019-01-03 15:28:55 -08001163 if (signal_pending_state(state, current)) {
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001164 ret = -EINTR;
1165 break;
1166 }
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001167
1168 if (behavior == DROP) {
1169 /*
1170 * We can no longer safely access page->flags:
1171 * even if CONFIG_MEMORY_HOTREMOVE is not enabled,
1172 * there is a risk of waiting forever on a page reused
1173 * for something that keeps it locked indefinitely.
1174 * But best check for -EINTR above before breaking.
1175 */
1176 break;
1177 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001178 }
1179
1180 finish_wait(q, wait);
1181
Johannes Weinereb414682018-10-26 15:06:27 -07001182 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001183 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001184 delayacct_thrashing_end();
1185 psi_memstall_leave(&pflags);
1186 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001187
Nicholas Piggin62906022016-12-25 13:00:30 +10001188 /*
1189 * A signal could leave PageWaiters set. Clearing it here if
1190 * !waitqueue_active would be possible (by open-coding finish_wait),
1191 * but still fail to catch it in the case of wait hash collision. We
1192 * already can fail to clear wait hash collision cases, so don't
1193 * bother with signals either.
1194 */
1195
1196 return ret;
1197}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Harvey Harrison920c7a52008-02-04 22:29:26 -08001199void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200{
Nicholas Piggin62906022016-12-25 13:00:30 +10001201 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001202 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203}
1204EXPORT_SYMBOL(wait_on_page_bit);
1205
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001206int wait_on_page_bit_killable(struct page *page, int bit_nr)
1207{
Nicholas Piggin62906022016-12-25 13:00:30 +10001208 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001209 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001210}
David Howells4343d002017-11-02 15:27:52 +00001211EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001212
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001214 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1215 * @page: The page to wait for.
1216 *
1217 * The caller should hold a reference on @page. They expect the page to
1218 * become unlocked relatively soon, but do not wish to hold up migration
1219 * (for example) by holding the reference while waiting for the page to
1220 * come unlocked. After this function returns, the caller should not
1221 * dereference @page.
1222 */
1223void put_and_wait_on_page_locked(struct page *page)
1224{
1225 wait_queue_head_t *q;
1226
1227 page = compound_head(page);
1228 q = page_waitqueue(page);
1229 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1230}
1231
1232/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001233 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001234 * @page: Page defining the wait queue of interest
1235 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001236 *
1237 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1238 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001239void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001240{
1241 wait_queue_head_t *q = page_waitqueue(page);
1242 unsigned long flags;
1243
1244 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001245 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001246 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001247 spin_unlock_irqrestore(&q->lock, flags);
1248}
1249EXPORT_SYMBOL_GPL(add_page_wait_queue);
1250
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001251#ifndef clear_bit_unlock_is_negative_byte
1252
1253/*
1254 * PG_waiters is the high bit in the same byte as PG_lock.
1255 *
1256 * On x86 (and on many other architectures), we can clear PG_lock and
1257 * test the sign bit at the same time. But if the architecture does
1258 * not support that special operation, we just do this all by hand
1259 * instead.
1260 *
1261 * The read of PG_waiters has to be after (or concurrently with) PG_locked
1262 * being cleared, but a memory barrier should be unneccssary since it is
1263 * in the same byte as PG_locked.
1264 */
1265static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1266{
1267 clear_bit_unlock(nr, mem);
1268 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001269 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001270}
1271
1272#endif
1273
David Howells385e1ca5f2009-04-03 16:42:39 +01001274/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001275 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 * @page: the page
1277 *
1278 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
1279 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001280 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1282 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001283 * Note that this depends on PG_waiters being the sign bit in the byte
1284 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1285 * clear the PG_locked bit and test PG_waiters at the same time fairly
1286 * portably (architectures that do LL/SC can test any bit, while x86 can
1287 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001289void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001291 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001292 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001293 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001294 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1295 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296}
1297EXPORT_SYMBOL(unlock_page);
1298
Randy Dunlap485bb992006-06-23 02:03:49 -07001299/**
1300 * end_page_writeback - end writeback against a page
1301 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 */
1303void end_page_writeback(struct page *page)
1304{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001305 /*
1306 * TestClearPageReclaim could be used here but it is an atomic
1307 * operation and overkill in this particular case. Failing to
1308 * shuffle a page marked for immediate reclaim is too mild to
1309 * justify taking an atomic operation penalty at the end of
1310 * ever page writeback.
1311 */
1312 if (PageReclaim(page)) {
1313 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001314 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001315 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001316
1317 if (!test_clear_page_writeback(page))
1318 BUG();
1319
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001320 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 wake_up_page(page, PG_writeback);
1322}
1323EXPORT_SYMBOL(end_page_writeback);
1324
Matthew Wilcox57d99842014-06-04 16:07:45 -07001325/*
1326 * After completing I/O on a page, call this routine to update the page
1327 * flags appropriately
1328 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001329void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001330{
Jens Axboec11f0c02016-08-05 08:11:04 -06001331 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001332 if (!err) {
1333 SetPageUptodate(page);
1334 } else {
1335 ClearPageUptodate(page);
1336 SetPageError(page);
1337 }
1338 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001339 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001340 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001341 struct address_space *mapping;
1342
Matthew Wilcox57d99842014-06-04 16:07:45 -07001343 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001344 mapping = page_mapping(page);
1345 if (mapping)
1346 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001347 }
1348 end_page_writeback(page);
1349 }
1350}
1351EXPORT_SYMBOL_GPL(page_endio);
1352
Randy Dunlap485bb992006-06-23 02:03:49 -07001353/**
1354 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001355 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001357void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358{
Nicholas Piggin62906022016-12-25 13:00:30 +10001359 struct page *page = compound_head(__page);
1360 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001361 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1362 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363}
1364EXPORT_SYMBOL(__lock_page);
1365
Nicholas Piggin62906022016-12-25 13:00:30 +10001366int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001367{
Nicholas Piggin62906022016-12-25 13:00:30 +10001368 struct page *page = compound_head(__page);
1369 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001370 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1371 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001372}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001373EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001374
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001375/*
1376 * Return values:
1377 * 1 - page is locked; mmap_sem is still held.
1378 * 0 - page is not locked.
1379 * mmap_sem has been released (up_read()), unless flags had both
1380 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1381 * which case mmap_sem is still held.
1382 *
1383 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1384 * with the page locked and the mmap_sem unperturbed.
1385 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001386int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1387 unsigned int flags)
1388{
Peter Xu4064b982020-04-01 21:08:45 -07001389 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001390 /*
1391 * CAUTION! In this case, mmap_sem is not released
1392 * even though return 0.
1393 */
1394 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1395 return 0;
1396
1397 up_read(&mm->mmap_sem);
1398 if (flags & FAULT_FLAG_KILLABLE)
1399 wait_on_page_locked_killable(page);
1400 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001401 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001402 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001403 } else {
1404 if (flags & FAULT_FLAG_KILLABLE) {
1405 int ret;
1406
1407 ret = __lock_page_killable(page);
1408 if (ret) {
1409 up_read(&mm->mmap_sem);
1410 return 0;
1411 }
1412 } else
1413 __lock_page(page);
1414 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001415 }
1416}
1417
Randy Dunlap485bb992006-06-23 02:03:49 -07001418/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001419 * page_cache_next_miss() - Find the next gap in the page cache.
1420 * @mapping: Mapping.
1421 * @index: Index.
1422 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001423 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001424 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1425 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001426 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001427 * This function may be called under the rcu_read_lock. However, this will
1428 * not atomically search a snapshot of the cache at a single point in time.
1429 * For example, if a gap is created at index 5, then subsequently a gap is
1430 * created at index 10, page_cache_next_miss covering both indices may
1431 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001432 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001433 * Return: The index of the gap if found, otherwise an index outside the
1434 * range specified (in which case 'return - index >= max_scan' will be true).
1435 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001436 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001437pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001438 pgoff_t index, unsigned long max_scan)
1439{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001440 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001441
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001442 while (max_scan--) {
1443 void *entry = xas_next(&xas);
1444 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001445 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001446 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001447 break;
1448 }
1449
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001450 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001451}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001452EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001453
1454/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001455 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001456 * @mapping: Mapping.
1457 * @index: Index.
1458 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001459 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001460 * Search the range [max(index - max_scan + 1, 0), index] for the
1461 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001462 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001463 * This function may be called under the rcu_read_lock. However, this will
1464 * not atomically search a snapshot of the cache at a single point in time.
1465 * For example, if a gap is created at index 10, then subsequently a gap is
1466 * created at index 5, page_cache_prev_miss() covering both indices may
1467 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001468 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001469 * Return: The index of the gap if found, otherwise an index outside the
1470 * range specified (in which case 'index - return >= max_scan' will be true).
1471 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001472 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001473pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001474 pgoff_t index, unsigned long max_scan)
1475{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001476 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001477
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001478 while (max_scan--) {
1479 void *entry = xas_prev(&xas);
1480 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001481 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001482 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001483 break;
1484 }
1485
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001486 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001487}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001488EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001489
1490/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001491 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001492 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001493 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001494 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001495 * Looks up the page cache slot at @mapping & @offset. If there is a
1496 * page cache page, it is returned with an increased refcount.
1497 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001498 * If the slot holds a shadow entry of a previously evicted page, or a
1499 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001500 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001501 * Return: the found page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001502 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001503struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001505 XA_STATE(xas, &mapping->i_pages, offset);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001506 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507
Nick Piggina60637c2008-07-25 19:45:31 -07001508 rcu_read_lock();
1509repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001510 xas_reset(&xas);
1511 page = xas_load(&xas);
1512 if (xas_retry(&xas, page))
1513 goto repeat;
1514 /*
1515 * A shadow entry of a recently evicted page, or a swap entry from
1516 * shmem/tmpfs. Return it without attempting to raise page count.
1517 */
1518 if (!page || xa_is_value(page))
1519 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001520
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001521 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001522 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001523
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001524 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001525 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001526 * This is part of the lockless pagecache protocol. See
1527 * include/linux/pagemap.h for details.
1528 */
1529 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001530 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001531 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001532 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001533 page = find_subpage(page, offset);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001534out:
Nick Piggina60637c2008-07-25 19:45:31 -07001535 rcu_read_unlock();
1536
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 return page;
1538}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539
Randy Dunlap485bb992006-06-23 02:03:49 -07001540/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001541 * find_lock_entry - locate, pin and lock a page cache entry
1542 * @mapping: the address_space to search
1543 * @offset: the page cache index
1544 *
1545 * Looks up the page cache slot at @mapping & @offset. If there is a
1546 * page cache page, it is returned locked and with an increased
1547 * refcount.
1548 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001549 * If the slot holds a shadow entry of a previously evicted page, or a
1550 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001551 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001552 * find_lock_entry() may sleep.
Mike Rapoporta862f682019-03-05 15:48:42 -08001553 *
1554 * Return: the found page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001555 */
1556struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557{
1558 struct page *page;
1559
Linus Torvalds1da177e2005-04-16 15:20:36 -07001560repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001561 page = find_get_entry(mapping, offset);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001562 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001563 lock_page(page);
1564 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001565 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001566 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001567 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001568 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001569 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001570 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 return page;
1573}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001574EXPORT_SYMBOL(find_lock_entry);
1575
1576/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001577 * pagecache_get_page - Find and get a reference to a page.
1578 * @mapping: The address_space to search.
1579 * @index: The page index.
1580 * @fgp_flags: %FGP flags modify how the page is returned.
1581 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001582 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001583 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001584 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001585 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001586 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001587 * * %FGP_ACCESSED - The page will be marked accessed.
1588 * * %FGP_LOCK - The page is returned locked.
1589 * * %FGP_CREAT - If no page is present then a new page is allocated using
1590 * @gfp_mask and added to the page cache and the VM's LRU list.
1591 * The page is returned locked and with an increased refcount.
1592 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1593 * page is already in cache. If the page was allocated, unlock it before
1594 * returning so the caller can do the same dance.
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001595 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001596 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1597 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001598 *
1599 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001600 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001601 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001602 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001603struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1604 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605{
Nick Piggineb2be182007-10-16 01:24:57 -07001606 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001607
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001609 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001610 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001611 page = NULL;
1612 if (!page)
1613 goto no_page;
1614
1615 if (fgp_flags & FGP_LOCK) {
1616 if (fgp_flags & FGP_NOWAIT) {
1617 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001618 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001619 return NULL;
1620 }
1621 } else {
1622 lock_page(page);
1623 }
1624
1625 /* Has the page been truncated? */
Song Liu31895432019-09-23 15:37:47 -07001626 if (unlikely(compound_head(page)->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001627 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001628 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001629 goto repeat;
1630 }
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001631 VM_BUG_ON_PAGE(page->index != index, page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001632 }
1633
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001634 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001635 mark_page_accessed(page);
1636
1637no_page:
1638 if (!page && (fgp_flags & FGP_CREAT)) {
1639 int err;
1640 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001641 gfp_mask |= __GFP_WRITE;
1642 if (fgp_flags & FGP_NOFS)
1643 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001644
Michal Hocko45f87de2014-12-29 20:30:35 +01001645 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001646 if (!page)
1647 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001648
Josef Bacika75d4c32019-03-13 11:44:14 -07001649 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001650 fgp_flags |= FGP_LOCK;
1651
Hugh Dickinseb39d612014-08-06 16:06:43 -07001652 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001653 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001654 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001655
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001656 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001657 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001658 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001659 page = NULL;
1660 if (err == -EEXIST)
1661 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001663
1664 /*
1665 * add_to_page_cache_lru locks the page, and for mmap we expect
1666 * an unlocked page.
1667 */
1668 if (page && (fgp_flags & FGP_FOR_MMAP))
1669 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001670 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001671
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672 return page;
1673}
Mel Gorman2457aec2014-06-04 16:10:31 -07001674EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001675
1676/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001677 * find_get_entries - gang pagecache lookup
1678 * @mapping: The address_space to search
1679 * @start: The starting page cache index
1680 * @nr_entries: The maximum number of entries
1681 * @entries: Where the resulting entries are placed
1682 * @indices: The cache indices corresponding to the entries in @entries
1683 *
1684 * find_get_entries() will search for and return a group of up to
1685 * @nr_entries entries in the mapping. The entries are placed at
1686 * @entries. find_get_entries() takes a reference against any actual
1687 * pages it returns.
1688 *
1689 * The search returns a group of mapping-contiguous page cache entries
1690 * with ascending indexes. There may be holes in the indices due to
1691 * not-present pages.
1692 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001693 * Any shadow entries of evicted pages, or swap entries from
1694 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001695 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001696 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1697 * stops at that page: the caller is likely to have a better way to handle
1698 * the compound page as a whole, and then skip its extent, than repeatedly
1699 * calling find_get_entries() to return all its tails.
1700 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001701 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001702 */
1703unsigned find_get_entries(struct address_space *mapping,
1704 pgoff_t start, unsigned int nr_entries,
1705 struct page **entries, pgoff_t *indices)
1706{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001707 XA_STATE(xas, &mapping->i_pages, start);
1708 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001709 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001710
1711 if (!nr_entries)
1712 return 0;
1713
1714 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001715 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001716 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001717 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001718 /*
1719 * A shadow entry of a recently evicted page, a swap
1720 * entry from shmem/tmpfs or a DAX entry. Return it
1721 * without attempting to raise page count.
1722 */
1723 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001724 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001725
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001726 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001727 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001728
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001729 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001730 if (unlikely(page != xas_reload(&xas)))
1731 goto put_page;
1732
Hugh Dickins71725ed2020-04-06 20:07:57 -07001733 /*
1734 * Terminate early on finding a THP, to allow the caller to
1735 * handle it all at once; but continue if this is hugetlbfs.
1736 */
1737 if (PageTransHuge(page) && !PageHuge(page)) {
1738 page = find_subpage(page, xas.xa_index);
1739 nr_entries = ret + 1;
1740 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001741export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001742 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001743 entries[ret] = page;
1744 if (++ret == nr_entries)
1745 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001746 continue;
1747put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001748 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001749retry:
1750 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001751 }
1752 rcu_read_unlock();
1753 return ret;
1754}
1755
1756/**
Jan Karab947cee2017-09-06 16:21:21 -07001757 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001758 * @mapping: The address_space to search
1759 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001760 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001761 * @nr_pages: The maximum number of pages
1762 * @pages: Where the resulting pages are placed
1763 *
Jan Karab947cee2017-09-06 16:21:21 -07001764 * find_get_pages_range() will search for and return a group of up to @nr_pages
1765 * pages in the mapping starting at index @start and up to index @end
1766 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1767 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 *
1769 * The search returns a group of mapping-contiguous pages with ascending
1770 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001771 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001773 * Return: the number of pages which were found. If this number is
1774 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001775 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 */
Jan Karab947cee2017-09-06 16:21:21 -07001777unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1778 pgoff_t end, unsigned int nr_pages,
1779 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001781 XA_STATE(xas, &mapping->i_pages, *start);
1782 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001783 unsigned ret = 0;
1784
1785 if (unlikely(!nr_pages))
1786 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
Nick Piggina60637c2008-07-25 19:45:31 -07001788 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001789 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001790 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001791 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001792 /* Skip over shadow, swap and DAX entries */
1793 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001794 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001795
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001796 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001797 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001798
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001799 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001800 if (unlikely(page != xas_reload(&xas)))
1801 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001802
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001803 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001804 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001805 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001806 goto out;
1807 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001808 continue;
1809put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001810 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001811retry:
1812 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001813 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001814
Jan Karab947cee2017-09-06 16:21:21 -07001815 /*
1816 * We come here when there is no page beyond @end. We take care to not
1817 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001818 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07001819 * already broken anyway.
1820 */
1821 if (end == (pgoff_t)-1)
1822 *start = (pgoff_t)-1;
1823 else
1824 *start = end + 1;
1825out:
Nick Piggina60637c2008-07-25 19:45:31 -07001826 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07001827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 return ret;
1829}
1830
Jens Axboeebf43502006-04-27 08:46:01 +02001831/**
1832 * find_get_pages_contig - gang contiguous pagecache lookup
1833 * @mapping: The address_space to search
1834 * @index: The starting page index
1835 * @nr_pages: The maximum number of pages
1836 * @pages: Where the resulting pages are placed
1837 *
1838 * find_get_pages_contig() works exactly like find_get_pages(), except
1839 * that the returned number of pages are guaranteed to be contiguous.
1840 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001841 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02001842 */
1843unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1844 unsigned int nr_pages, struct page **pages)
1845{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001846 XA_STATE(xas, &mapping->i_pages, index);
1847 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001848 unsigned int ret = 0;
1849
1850 if (unlikely(!nr_pages))
1851 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001852
Nick Piggina60637c2008-07-25 19:45:31 -07001853 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001854 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001855 if (xas_retry(&xas, page))
1856 continue;
1857 /*
1858 * If the entry has been swapped out, we can stop looking.
1859 * No current caller is looking for DAX entries.
1860 */
1861 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001862 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001863
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001864 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001865 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001866
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001867 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001868 if (unlikely(page != xas_reload(&xas)))
1869 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001870
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001871 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001872 if (++ret == nr_pages)
1873 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001874 continue;
1875put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001876 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001877retry:
1878 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02001879 }
Nick Piggina60637c2008-07-25 19:45:31 -07001880 rcu_read_unlock();
1881 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001882}
David Howellsef71c152007-05-09 02:33:44 -07001883EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001884
Randy Dunlap485bb992006-06-23 02:03:49 -07001885/**
Jan Kara72b045a2017-11-15 17:34:33 -08001886 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001887 * @mapping: the address_space to search
1888 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08001889 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001890 * @tag: the tag index
1891 * @nr_pages: the maximum number of pages
1892 * @pages: where the resulting pages are placed
1893 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001895 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08001896 *
1897 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 */
Jan Kara72b045a2017-11-15 17:34:33 -08001899unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001900 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08001901 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001903 XA_STATE(xas, &mapping->i_pages, *index);
1904 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001905 unsigned ret = 0;
1906
1907 if (unlikely(!nr_pages))
1908 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909
Nick Piggina60637c2008-07-25 19:45:31 -07001910 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001911 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001912 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001913 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001914 /*
1915 * Shadow entries should never be tagged, but this iteration
1916 * is lockless so there is a window for page reclaim to evict
1917 * a page we saw tagged. Skip over it.
1918 */
1919 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07001920 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001921
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001922 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001923 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001924
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001925 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001926 if (unlikely(page != xas_reload(&xas)))
1927 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001928
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001929 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08001930 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001931 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08001932 goto out;
1933 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001934 continue;
1935put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001936 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001937retry:
1938 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001939 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001940
Jan Kara72b045a2017-11-15 17:34:33 -08001941 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001942 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08001943 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001944 * iteration when there is a page at index -1 but that is already
1945 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08001946 */
1947 if (end == (pgoff_t)-1)
1948 *index = (pgoff_t)-1;
1949 else
1950 *index = end + 1;
1951out:
Nick Piggina60637c2008-07-25 19:45:31 -07001952 rcu_read_unlock();
1953
Linus Torvalds1da177e2005-04-16 15:20:36 -07001954 return ret;
1955}
Jan Kara72b045a2017-11-15 17:34:33 -08001956EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001958/*
1959 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1960 * a _large_ part of the i/o request. Imagine the worst scenario:
1961 *
1962 * ---R__________________________________________B__________
1963 * ^ reading here ^ bad block(assume 4k)
1964 *
1965 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1966 * => failing the whole request => read(R) => read(R+1) =>
1967 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1968 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1969 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1970 *
1971 * It is going insane. Fix it by quickly scaling down the readahead size.
1972 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07001973static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001974{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001975 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001976}
1977
Randy Dunlap485bb992006-06-23 02:03:49 -07001978/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001979 * generic_file_buffered_read - generic file read routine
1980 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05001981 * @iter: data destination
1982 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001983 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001985 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 *
1987 * This is really ugly. But the goto's actually try to clarify some
1988 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08001989 *
1990 * Return:
1991 * * total number of bytes copied, including those the were already @written
1992 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05001994ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05001995 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001997 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001998 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002000 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002001 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002002 pgoff_t index;
2003 pgoff_t last_index;
2004 pgoff_t prev_index;
2005 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002006 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002007 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
Wei Fangc2a97372016-10-07 17:01:52 -07002009 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002010 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002011 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2012
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002013 index = *ppos >> PAGE_SHIFT;
2014 prev_index = ra->prev_pos >> PAGE_SHIFT;
2015 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2016 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2017 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002018
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 for (;;) {
2020 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002021 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002022 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 unsigned long nr, ret;
2024
Linus Torvalds1da177e2005-04-16 15:20:36 -07002025 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002027 if (fatal_signal_pending(current)) {
2028 error = -EINTR;
2029 goto out;
2030 }
2031
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002033 if (!page) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002034 if (iocb->ki_flags & IOCB_NOWAIT)
2035 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002036 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002037 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002038 index, last_index - index);
2039 page = find_get_page(mapping, index);
2040 if (unlikely(page == NULL))
2041 goto no_cached_page;
2042 }
2043 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07002044 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002045 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002046 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002048 if (!PageUptodate(page)) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002049 if (iocb->ki_flags & IOCB_NOWAIT) {
2050 put_page(page);
2051 goto would_block;
2052 }
2053
Mel Gormanebded022016-03-15 14:55:39 -07002054 /*
2055 * See comment in do_read_cache_page on why
2056 * wait_on_page_locked is used to avoid unnecessarily
2057 * serialisations and why it's safe.
2058 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002059 error = wait_on_page_locked_killable(page);
2060 if (unlikely(error))
2061 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002062 if (PageUptodate(page))
2063 goto page_ok;
2064
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002065 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002066 !mapping->a_ops->is_partially_uptodate)
2067 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002068 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002069 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002070 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002071 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002072 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002073 /* Did it get truncated before we got the lock? */
2074 if (!page->mapping)
2075 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002076 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002077 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002078 goto page_not_up_to_date_locked;
2079 unlock_page(page);
2080 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002082 /*
2083 * i_size must be checked after we know the page is Uptodate.
2084 *
2085 * Checking i_size after the check allows us to calculate
2086 * the correct value for "nr", which means the zero-filled
2087 * part of the page is not copied back to userspace (unless
2088 * another truncate extends the file - this is desired though).
2089 */
2090
2091 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002092 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002093 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002094 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002095 goto out;
2096 }
2097
2098 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002099 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002100 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002101 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002102 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002103 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002104 goto out;
2105 }
2106 }
2107 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108
2109 /* If users can be writing to this page using arbitrary
2110 * virtual addresses, take care about potential aliasing
2111 * before reading the page on the kernel side.
2112 */
2113 if (mapping_writably_mapped(mapping))
2114 flush_dcache_page(page);
2115
2116 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002117 * When a sequential read accesses a page several times,
2118 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119 */
Jan Karaec0f1632007-05-06 14:49:25 -07002120 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121 mark_page_accessed(page);
2122 prev_index = index;
2123
2124 /*
2125 * Ok, we have the page, and it's up-to-date, so
2126 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127 */
Al Viro6e58e792014-02-03 17:07:03 -05002128
2129 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002131 index += offset >> PAGE_SHIFT;
2132 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002133 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002135 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002136 written += ret;
2137 if (!iov_iter_count(iter))
2138 goto out;
2139 if (ret < nr) {
2140 error = -EFAULT;
2141 goto out;
2142 }
2143 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002144
2145page_not_up_to_date:
2146 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04002147 error = lock_page_killable(page);
2148 if (unlikely(error))
2149 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002151page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002152 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 if (!page->mapping) {
2154 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002155 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002156 continue;
2157 }
2158
2159 /* Did somebody else fill it already? */
2160 if (PageUptodate(page)) {
2161 unlock_page(page);
2162 goto page_ok;
2163 }
2164
2165readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04002166 /*
2167 * A previous I/O error may have been due to temporary
2168 * failures, eg. multipath errors.
2169 * PG_error will be set again if readpage fails.
2170 */
2171 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002172 /* Start the actual read. The read will unlock the page. */
2173 error = mapping->a_ops->readpage(filp, page);
2174
Zach Brown994fc28c2005-12-15 14:28:17 -08002175 if (unlikely(error)) {
2176 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002177 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002178 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002179 goto find_page;
2180 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002182 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183
2184 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04002185 error = lock_page_killable(page);
2186 if (unlikely(error))
2187 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 if (!PageUptodate(page)) {
2189 if (page->mapping == NULL) {
2190 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002191 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 */
2193 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002194 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 goto find_page;
2196 }
2197 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002198 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002199 error = -EIO;
2200 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 }
2202 unlock_page(page);
2203 }
2204
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 goto page_ok;
2206
2207readpage_error:
2208 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002209 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210 goto out;
2211
2212no_cached_page:
2213 /*
2214 * Ok, it wasn't cached, so we need to create a new
2215 * page..
2216 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002217 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002218 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002219 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002220 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002222 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002223 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002225 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002226 if (error == -EEXIST) {
2227 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002229 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 goto out;
2231 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 goto readpage;
2233 }
2234
Milosz Tanski3239d832017-08-29 16:13:19 +02002235would_block:
2236 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002238 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002239 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002240 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002242 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002243 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002244 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002246EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247
Randy Dunlap485bb992006-06-23 02:03:49 -07002248/**
Al Viro6abd2322014-04-04 14:20:57 -04002249 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002250 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002251 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002252 *
Al Viro6abd2322014-04-04 14:20:57 -04002253 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 * that can use the page cache directly.
Mike Rapoporta862f682019-03-05 15:48:42 -08002255 * Return:
2256 * * number of bytes copied, even for partial reads
2257 * * negative error code if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 */
2259ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002260generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002262 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002263 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002264
2265 if (!count)
2266 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267
Al Viro2ba48ce2015-04-09 13:52:01 -04002268 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002269 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002270 struct address_space *mapping = file->f_mapping;
2271 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002272 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002275 if (iocb->ki_flags & IOCB_NOWAIT) {
2276 if (filemap_range_has_page(mapping, iocb->ki_pos,
2277 iocb->ki_pos + count - 1))
2278 return -EAGAIN;
2279 } else {
2280 retval = filemap_write_and_wait_range(mapping,
2281 iocb->ki_pos,
2282 iocb->ki_pos + count - 1);
2283 if (retval < 0)
2284 goto out;
2285 }
Al Viroed978a82014-03-05 22:53:04 -05002286
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002287 file_accessed(file);
2288
Al Viro5ecda132017-04-13 14:13:36 -04002289 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002290 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002291 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002292 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002293 }
Al Viro5b47d592017-05-08 13:54:47 -04002294 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002295
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002296 /*
2297 * Btrfs can have a short DIO read if we encounter
2298 * compressed extents, so if there was an error, or if
2299 * we've already read everything we wanted to, or if
2300 * there was a short read because we hit EOF, go ahead
2301 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002302 * the rest of the read. Buffered reads will not work for
2303 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002304 */
Al Viro5ecda132017-04-13 14:13:36 -04002305 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002306 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002307 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002308 }
2309
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002310 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311out:
2312 return retval;
2313}
Al Viroed978a82014-03-05 22:53:04 -05002314EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315
Linus Torvalds1da177e2005-04-16 15:20:36 -07002316#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002317#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002318/*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002319 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_sem
2320 * @vmf - the vm_fault for this fault.
2321 * @page - the page to lock.
2322 * @fpin - the pointer to the file we may pin (or is already pinned).
2323 *
2324 * This works similar to lock_page_or_retry in that it can drop the mmap_sem.
2325 * It differs in that it actually returns the page locked if it returns 1 and 0
2326 * if it couldn't lock the page. If we did have to drop the mmap_sem then fpin
2327 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002328 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002329static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2330 struct file **fpin)
2331{
2332 if (trylock_page(page))
2333 return 1;
2334
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002335 /*
2336 * NOTE! This will make us return with VM_FAULT_RETRY, but with
2337 * the mmap_sem still held. That's how FAULT_FLAG_RETRY_NOWAIT
2338 * is supposed to work. We have way too many special cases..
2339 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002340 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2341 return 0;
2342
2343 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2344 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2345 if (__lock_page_killable(page)) {
2346 /*
2347 * We didn't have the right flags to drop the mmap_sem,
2348 * but all fault_handlers only check for fatal signals
2349 * if we return VM_FAULT_RETRY, so we need to drop the
2350 * mmap_sem here and return 0 if we don't have a fpin.
2351 */
2352 if (*fpin == NULL)
2353 up_read(&vmf->vma->vm_mm->mmap_sem);
2354 return 0;
2355 }
2356 } else
2357 __lock_page(page);
2358 return 1;
2359}
2360
2361
2362/*
2363 * Synchronous readahead happens when we don't even find a page in the page
2364 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2365 * to drop the mmap sem we return the file that was pinned in order for us to do
2366 * that. If we didn't pin a file then we return NULL. The file that is
2367 * returned needs to be fput()'ed when we're done with it.
2368 */
2369static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002370{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002371 struct file *file = vmf->vma->vm_file;
2372 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002373 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002374 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002375 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002376
2377 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002378 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002379 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002380 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002381 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002382
Josef Bacik2a1180f2019-03-13 11:44:18 -07002383 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002384 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002385 page_cache_sync_readahead(mapping, ra, file, offset,
2386 ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002387 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002388 }
2389
Andi Kleen207d04b2011-05-24 17:12:29 -07002390 /* Avoid banging the cache line if not needed */
2391 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002392 ra->mmap_miss++;
2393
2394 /*
2395 * Do we miss much more than hit in this file? If so,
2396 * stop bothering with read-ahead. It will only hurt.
2397 */
2398 if (ra->mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002399 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002400
Wu Fengguangd30a1102009-06-16 15:31:30 -07002401 /*
2402 * mmap read-around
2403 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002404 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002405 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2406 ra->size = ra->ra_pages;
2407 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002408 ra_submit(ra, mapping, file);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002409 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002410}
2411
2412/*
2413 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002414 * so we want to possibly extend the readahead further. We return the file that
2415 * was pinned if we have to drop the mmap_sem in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002416 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002417static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2418 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002419{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002420 struct file *file = vmf->vma->vm_file;
2421 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002422 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002423 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002424 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002425
2426 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002427 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002428 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002429 if (ra->mmap_miss > 0)
2430 ra->mmap_miss--;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002431 if (PageReadahead(page)) {
2432 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002433 page_cache_async_readahead(mapping, ra, file,
2434 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002435 }
2436 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002437}
2438
Randy Dunlap485bb992006-06-23 02:03:49 -07002439/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002440 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002441 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002442 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002443 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 * mapped memory region to read in file data during a page fault.
2445 *
2446 * The goto's are kind of ugly, but this streamlines the normal case of having
2447 * it in the page cache, and handles the special cases reasonably without
2448 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002449 *
2450 * vma->vm_mm->mmap_sem must be held on entry.
2451 *
Yang Shia4985832019-07-11 20:55:29 -07002452 * If our return value has VM_FAULT_RETRY set, it's because the mmap_sem
2453 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002454 *
2455 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2456 * has not been released.
2457 *
2458 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002459 *
2460 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002461 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002462vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463{
2464 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002465 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002466 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002467 struct address_space *mapping = file->f_mapping;
2468 struct file_ra_state *ra = &file->f_ra;
2469 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002470 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002471 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002472 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002473 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002475 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2476 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002477 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002478
Linus Torvalds1da177e2005-04-16 15:20:36 -07002479 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002480 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002481 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002482 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002483 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002484 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002485 * We found the page, so try async readahead before
2486 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002488 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002489 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002490 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002491 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002492 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002493 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002494 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002495retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002496 page = pagecache_get_page(mapping, offset,
2497 FGP_CREAT|FGP_FOR_MMAP,
2498 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002499 if (!page) {
2500 if (fpin)
2501 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002502 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002503 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 }
2505
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002506 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2507 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002508
2509 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002510 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002511 unlock_page(page);
2512 put_page(page);
2513 goto retry_find;
2514 }
Song Liu520e5ba2019-09-23 15:37:50 -07002515 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002516
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002518 * We have a locked page in the page cache, now we need to check
2519 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 */
Nick Piggind00806b2007-07-19 01:46:57 -07002521 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002522 goto page_not_uptodate;
2523
Linus Torvaldsef00e082009-06-16 15:31:25 -07002524 /*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002525 * We've made it this far and we had to drop our mmap_sem, now is the
2526 * time to return to the upper layer and have it re-find the vma and
2527 * redo the fault.
2528 */
2529 if (fpin) {
2530 unlock_page(page);
2531 goto out_retry;
2532 }
2533
2534 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002535 * Found the page and have a reference on it.
2536 * We must recheck i_size under page lock.
2537 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002538 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2539 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002540 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002541 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002542 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002543 }
2544
Nick Piggind0217ac2007-07-19 01:47:03 -07002545 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002546 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002549 /*
2550 * Umm, take care of errors if the page isn't up-to-date.
2551 * Try to re-read it _once_. We do this synchronously,
2552 * because there really aren't any performance issues here
2553 * and we need to check for errors.
2554 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002556 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002557 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002558 if (!error) {
2559 wait_on_page_locked(page);
2560 if (!PageUptodate(page))
2561 error = -EIO;
2562 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002563 if (fpin)
2564 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002565 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002566
2567 if (!error || error == AOP_TRUNCATED_PAGE)
2568 goto retry_find;
2569
2570 /* Things didn't work out. Return zero to tell the mm layer so. */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002571 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002572 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002573
2574out_retry:
2575 /*
2576 * We dropped the mmap_sem, we need to return to the fault handler to
2577 * re-find the vma and come back and find our hopefully still populated
2578 * page.
2579 */
2580 if (page)
2581 put_page(page);
2582 if (fpin)
2583 fput(fpin);
2584 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002585}
2586EXPORT_SYMBOL(filemap_fault);
2587
Jan Kara82b0f8c2016-12-14 15:06:58 -08002588void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002589 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002590{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002591 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002592 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002593 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002594 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002595 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002596 struct page *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002597
2598 rcu_read_lock();
Matthew Wilcox070e8072018-05-17 00:08:30 -04002599 xas_for_each(&xas, page, end_pgoff) {
2600 if (xas_retry(&xas, page))
2601 continue;
2602 if (xa_is_value(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002603 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002604
Michal Hockoe0975b22018-12-28 00:38:36 -08002605 /*
2606 * Check for a locked page first, as a speculative
2607 * reference may adversely influence page migration.
2608 */
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002609 if (PageLocked(page))
Michal Hockoe0975b22018-12-28 00:38:36 -08002610 goto next;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002611 if (!page_cache_get_speculative(page))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002612 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002613
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002614 /* Has the page moved or been split? */
Matthew Wilcox070e8072018-05-17 00:08:30 -04002615 if (unlikely(page != xas_reload(&xas)))
2616 goto skip;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002617 page = find_subpage(page, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002618
2619 if (!PageUptodate(page) ||
2620 PageReadahead(page) ||
2621 PageHWPoison(page))
2622 goto skip;
2623 if (!trylock_page(page))
2624 goto skip;
2625
2626 if (page->mapping != mapping || !PageUptodate(page))
2627 goto unlock;
2628
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002629 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2630 if (page->index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002631 goto unlock;
2632
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002633 if (file->f_ra.mmap_miss > 0)
2634 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002635
Matthew Wilcox070e8072018-05-17 00:08:30 -04002636 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002637 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002638 vmf->pte += xas.xa_index - last_pgoff;
2639 last_pgoff = xas.xa_index;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002640 if (alloc_set_pte(vmf, NULL, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002641 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002642 unlock_page(page);
2643 goto next;
2644unlock:
2645 unlock_page(page);
2646skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002647 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002648next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002649 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002650 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002651 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002652 }
2653 rcu_read_unlock();
2654}
2655EXPORT_SYMBOL(filemap_map_pages);
2656
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002657vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002658{
2659 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002660 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002661 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002662
Jan Kara14da9202012-06-12 16:20:37 +02002663 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002664 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002665 lock_page(page);
2666 if (page->mapping != inode->i_mapping) {
2667 unlock_page(page);
2668 ret = VM_FAULT_NOPAGE;
2669 goto out;
2670 }
Jan Kara14da9202012-06-12 16:20:37 +02002671 /*
2672 * We mark the page dirty already here so that when freeze is in
2673 * progress, we are guaranteed that writeback during freezing will
2674 * see the dirty page and writeprotect it again.
2675 */
2676 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002677 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002678out:
Jan Kara14da9202012-06-12 16:20:37 +02002679 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002680 return ret;
2681}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002682
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002683const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002684 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002685 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002686 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687};
2688
2689/* This is used for a general mmap of a disk file */
2690
2691int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2692{
2693 struct address_space *mapping = file->f_mapping;
2694
2695 if (!mapping->a_ops->readpage)
2696 return -ENOEXEC;
2697 file_accessed(file);
2698 vma->vm_ops = &generic_file_vm_ops;
2699 return 0;
2700}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701
2702/*
2703 * This is for filesystems which do not implement ->writepage.
2704 */
2705int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2706{
2707 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2708 return -EINVAL;
2709 return generic_file_mmap(file, vma);
2710}
2711#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002712vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07002713{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002714 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07002715}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002716int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2717{
2718 return -ENOSYS;
2719}
2720int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2721{
2722 return -ENOSYS;
2723}
2724#endif /* CONFIG_MMU */
2725
Arnd Bergmann453972282018-04-13 15:35:27 -07002726EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727EXPORT_SYMBOL(generic_file_mmap);
2728EXPORT_SYMBOL(generic_file_readonly_mmap);
2729
Sasha Levin67f9fd92014-04-03 14:48:18 -07002730static struct page *wait_on_page_read(struct page *page)
2731{
2732 if (!IS_ERR(page)) {
2733 wait_on_page_locked(page);
2734 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002735 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002736 page = ERR_PTR(-EIO);
2737 }
2738 }
2739 return page;
2740}
2741
Mel Gorman32b63522016-03-15 14:55:36 -07002742static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002743 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002744 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002745 void *data,
2746 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002747{
Nick Piggineb2be182007-10-16 01:24:57 -07002748 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002749 int err;
2750repeat:
2751 page = find_get_page(mapping, index);
2752 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08002753 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002754 if (!page)
2755 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002756 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002757 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002758 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002759 if (err == -EEXIST)
2760 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05002761 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002762 return ERR_PTR(err);
2763 }
Mel Gorman32b63522016-03-15 14:55:36 -07002764
2765filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002766 if (filler)
2767 err = filler(data, page);
2768 else
2769 err = mapping->a_ops->readpage(data, page);
2770
Linus Torvalds1da177e2005-04-16 15:20:36 -07002771 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002772 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002773 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002774 }
Mel Gorman32b63522016-03-15 14:55:36 -07002775
2776 page = wait_on_page_read(page);
2777 if (IS_ERR(page))
2778 return page;
2779 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002781 if (PageUptodate(page))
2782 goto out;
2783
Mel Gormanebded022016-03-15 14:55:39 -07002784 /*
2785 * Page is not up to date and may be locked due one of the following
2786 * case a: Page is being filled and the page lock is held
2787 * case b: Read/write error clearing the page uptodate status
2788 * case c: Truncation in progress (page locked)
2789 * case d: Reclaim in progress
2790 *
2791 * Case a, the page will be up to date when the page is unlocked.
2792 * There is no need to serialise on the page lock here as the page
2793 * is pinned so the lock gives no additional protection. Even if the
2794 * the page is truncated, the data is still valid if PageUptodate as
2795 * it's a race vs truncate race.
2796 * Case b, the page will not be up to date
2797 * Case c, the page may be truncated but in itself, the data may still
2798 * be valid after IO completes as it's a read vs truncate race. The
2799 * operation must restart if the page is not uptodate on unlock but
2800 * otherwise serialising on page lock to stabilise the mapping gives
2801 * no additional guarantees to the caller as the page lock is
2802 * released before return.
2803 * Case d, similar to truncation. If reclaim holds the page lock, it
2804 * will be a race with remove_mapping that determines if the mapping
2805 * is valid on unlock but otherwise the data is valid and there is
2806 * no need to serialise with page lock.
2807 *
2808 * As the page lock gives no additional guarantee, we optimistically
2809 * wait on the page to be unlocked and check if it's up to date and
2810 * use the page if it is. Otherwise, the page lock is required to
2811 * distinguish between the different cases. The motivation is that we
2812 * avoid spurious serialisations and wakeups when multiple processes
2813 * wait on the same page for IO to complete.
2814 */
2815 wait_on_page_locked(page);
2816 if (PageUptodate(page))
2817 goto out;
2818
2819 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002820 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002821
2822 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002823 if (!page->mapping) {
2824 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002825 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002826 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827 }
Mel Gormanebded022016-03-15 14:55:39 -07002828
2829 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002830 if (PageUptodate(page)) {
2831 unlock_page(page);
2832 goto out;
2833 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07002834
2835 /*
2836 * A previous I/O error may have been due to temporary
2837 * failures.
2838 * Clear page error before actual read, PG_error will be
2839 * set again if read page fails.
2840 */
2841 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002842 goto filler;
2843
David Howellsc855ff32007-05-09 13:42:20 +01002844out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002845 mark_page_accessed(page);
2846 return page;
2847}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002848
2849/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002850 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002851 * @mapping: the page's address_space
2852 * @index: the page index
2853 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002854 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002855 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002856 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002857 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002858 *
2859 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002860 *
2861 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002862 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002863struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002864 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002865 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002866 void *data)
2867{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07002868 return do_read_cache_page(mapping, index, filler, data,
2869 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002870}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002871EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002872
2873/**
2874 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2875 * @mapping: the page's address_space
2876 * @index: the page index
2877 * @gfp: the page allocator flags to use if allocating
2878 *
2879 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002880 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002881 *
2882 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002883 *
2884 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002885 */
2886struct page *read_cache_page_gfp(struct address_space *mapping,
2887 pgoff_t index,
2888 gfp_t gfp)
2889{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002890 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002891}
2892EXPORT_SYMBOL(read_cache_page_gfp);
2893
Nick Piggin2f718ff2007-10-16 01:24:59 -07002894/*
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002895 * Don't operate on ranges the page cache doesn't support, and don't exceed the
2896 * LFS limits. If pos is under the limit it becomes a short access. If it
2897 * exceeds the limit we return -EFBIG.
2898 */
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002899static int generic_write_check_limits(struct file *file, loff_t pos,
2900 loff_t *count)
2901{
Amir Goldstein646955c2019-06-05 08:04:48 -07002902 struct inode *inode = file->f_mapping->host;
2903 loff_t max_size = inode->i_sb->s_maxbytes;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002904 loff_t limit = rlimit(RLIMIT_FSIZE);
2905
2906 if (limit != RLIM_INFINITY) {
2907 if (pos >= limit) {
2908 send_sig(SIGXFSZ, current, 0);
2909 return -EFBIG;
2910 }
2911 *count = min(*count, limit - pos);
2912 }
2913
Amir Goldstein646955c2019-06-05 08:04:48 -07002914 if (!(file->f_flags & O_LARGEFILE))
2915 max_size = MAX_NON_LFS;
2916
2917 if (unlikely(pos >= max_size))
2918 return -EFBIG;
2919
2920 *count = min(*count, max_size - pos);
2921
2922 return 0;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002923}
2924
2925/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002926 * Performs necessary checks before doing a write
2927 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002928 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929 * Returns appropriate error code that caller should return or
2930 * zero in case that write should be allowed.
2931 */
Al Viro3309dd02015-04-09 12:55:47 -04002932inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933{
Al Viro3309dd02015-04-09 12:55:47 -04002934 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002935 struct inode *inode = file->f_mapping->host;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002936 loff_t count;
2937 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002938
Darrick J. Wongdc617f22019-08-20 07:55:16 -07002939 if (IS_SWAPFILE(inode))
2940 return -ETXTBSY;
2941
Al Viro3309dd02015-04-09 12:55:47 -04002942 if (!iov_iter_count(from))
2943 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002944
Al Viro0fa6b002015-04-04 04:05:48 -04002945 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002946 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002947 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002948
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002949 if ((iocb->ki_flags & IOCB_NOWAIT) && !(iocb->ki_flags & IOCB_DIRECT))
2950 return -EINVAL;
2951
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002952 count = iov_iter_count(from);
2953 ret = generic_write_check_limits(file, iocb->ki_pos, &count);
2954 if (ret)
2955 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002956
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002957 iov_iter_truncate(from, count);
Al Viro3309dd02015-04-09 12:55:47 -04002958 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002959}
2960EXPORT_SYMBOL(generic_write_checks);
2961
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002962/*
2963 * Performs necessary checks before doing a clone.
2964 *
Amir Goldstein646955c2019-06-05 08:04:48 -07002965 * Can adjust amount of bytes to clone via @req_count argument.
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002966 * Returns appropriate error code that caller should return or
2967 * zero in case the clone should be allowed.
2968 */
2969int generic_remap_checks(struct file *file_in, loff_t pos_in,
2970 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11002971 loff_t *req_count, unsigned int remap_flags)
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002972{
2973 struct inode *inode_in = file_in->f_mapping->host;
2974 struct inode *inode_out = file_out->f_mapping->host;
2975 uint64_t count = *req_count;
2976 uint64_t bcount;
2977 loff_t size_in, size_out;
2978 loff_t bs = inode_out->i_sb->s_blocksize;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002979 int ret;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002980
2981 /* The start of both ranges must be aligned to an fs block. */
2982 if (!IS_ALIGNED(pos_in, bs) || !IS_ALIGNED(pos_out, bs))
2983 return -EINVAL;
2984
2985 /* Ensure offsets don't wrap. */
2986 if (pos_in + count < pos_in || pos_out + count < pos_out)
2987 return -EINVAL;
2988
2989 size_in = i_size_read(inode_in);
2990 size_out = i_size_read(inode_out);
2991
2992 /* Dedupe requires both ranges to be within EOF. */
Darrick J. Wong3d281932018-10-30 10:41:34 +11002993 if ((remap_flags & REMAP_FILE_DEDUP) &&
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002994 (pos_in >= size_in || pos_in + count > size_in ||
2995 pos_out >= size_out || pos_out + count > size_out))
2996 return -EINVAL;
2997
2998 /* Ensure the infile range is within the infile. */
2999 if (pos_in >= size_in)
3000 return -EINVAL;
3001 count = min(count, size_in - (uint64_t)pos_in);
3002
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003003 ret = generic_write_check_limits(file_out, pos_out, &count);
3004 if (ret)
3005 return ret;
3006
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003007 /*
3008 * If the user wanted us to link to the infile's EOF, round up to the
3009 * next block boundary for this check.
3010 *
3011 * Otherwise, make sure the count is also block-aligned, having
3012 * already confirmed the starting offsets' block alignment.
3013 */
3014 if (pos_in + count == size_in) {
3015 bcount = ALIGN(size_in, bs) - pos_in;
3016 } else {
3017 if (!IS_ALIGNED(count, bs))
Darrick J. Wongeca36542018-10-30 10:42:10 +11003018 count = ALIGN_DOWN(count, bs);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003019 bcount = count;
3020 }
3021
3022 /* Don't allow overlapped cloning within the same file. */
3023 if (inode_in == inode_out &&
3024 pos_out + bcount > pos_in &&
3025 pos_out < pos_in + bcount)
3026 return -EINVAL;
3027
Darrick J. Wongeca36542018-10-30 10:42:10 +11003028 /*
3029 * We shortened the request but the caller can't deal with that, so
3030 * bounce the request back to userspace.
3031 */
3032 if (*req_count != count && !(remap_flags & REMAP_FILE_CAN_SHORTEN))
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003033 return -EINVAL;
3034
Darrick J. Wongeca36542018-10-30 10:42:10 +11003035 *req_count = count;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003036 return 0;
3037}
3038
Amir Goldsteina3171352019-06-05 08:04:48 -07003039
3040/*
3041 * Performs common checks before doing a file copy/clone
3042 * from @file_in to @file_out.
3043 */
3044int generic_file_rw_checks(struct file *file_in, struct file *file_out)
3045{
3046 struct inode *inode_in = file_inode(file_in);
3047 struct inode *inode_out = file_inode(file_out);
3048
3049 /* Don't copy dirs, pipes, sockets... */
3050 if (S_ISDIR(inode_in->i_mode) || S_ISDIR(inode_out->i_mode))
3051 return -EISDIR;
3052 if (!S_ISREG(inode_in->i_mode) || !S_ISREG(inode_out->i_mode))
3053 return -EINVAL;
3054
3055 if (!(file_in->f_mode & FMODE_READ) ||
3056 !(file_out->f_mode & FMODE_WRITE) ||
3057 (file_out->f_flags & O_APPEND))
3058 return -EBADF;
3059
3060 return 0;
3061}
3062
Amir Goldstein96e6e8f2019-06-05 08:04:49 -07003063/*
3064 * Performs necessary checks before doing a file copy
3065 *
3066 * Can adjust amount of bytes to copy via @req_count argument.
3067 * Returns appropriate error code that caller should return or
3068 * zero in case the copy should be allowed.
3069 */
3070int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3071 struct file *file_out, loff_t pos_out,
3072 size_t *req_count, unsigned int flags)
3073{
3074 struct inode *inode_in = file_inode(file_in);
3075 struct inode *inode_out = file_inode(file_out);
3076 uint64_t count = *req_count;
3077 loff_t size_in;
3078 int ret;
3079
3080 ret = generic_file_rw_checks(file_in, file_out);
3081 if (ret)
3082 return ret;
3083
3084 /* Don't touch certain kinds of inodes */
3085 if (IS_IMMUTABLE(inode_out))
3086 return -EPERM;
3087
3088 if (IS_SWAPFILE(inode_in) || IS_SWAPFILE(inode_out))
3089 return -ETXTBSY;
3090
3091 /* Ensure offsets don't wrap. */
3092 if (pos_in + count < pos_in || pos_out + count < pos_out)
3093 return -EOVERFLOW;
3094
3095 /* Shorten the copy to EOF */
3096 size_in = i_size_read(inode_in);
3097 if (pos_in >= size_in)
3098 count = 0;
3099 else
3100 count = min(count, size_in - (uint64_t)pos_in);
3101
3102 ret = generic_write_check_limits(file_out, pos_out, &count);
3103 if (ret)
3104 return ret;
3105
3106 /* Don't allow overlapped copying within the same file. */
3107 if (inode_in == inode_out &&
3108 pos_out + count > pos_in &&
3109 pos_out < pos_in + count)
3110 return -EINVAL;
3111
3112 *req_count = count;
3113 return 0;
3114}
3115
Nick Pigginafddba42007-10-16 01:25:01 -07003116int pagecache_write_begin(struct file *file, struct address_space *mapping,
3117 loff_t pos, unsigned len, unsigned flags,
3118 struct page **pagep, void **fsdata)
3119{
3120 const struct address_space_operations *aops = mapping->a_ops;
3121
Nick Piggin4e02ed42008-10-29 14:00:55 -07003122 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003123 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003124}
3125EXPORT_SYMBOL(pagecache_write_begin);
3126
3127int pagecache_write_end(struct file *file, struct address_space *mapping,
3128 loff_t pos, unsigned len, unsigned copied,
3129 struct page *page, void *fsdata)
3130{
3131 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003132
Nick Piggin4e02ed42008-10-29 14:00:55 -07003133 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003134}
3135EXPORT_SYMBOL(pagecache_write_end);
3136
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003137/*
3138 * Warn about a page cache invalidation failure during a direct I/O write.
3139 */
3140void dio_warn_stale_pagecache(struct file *filp)
3141{
3142 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3143 char pathname[128];
3144 struct inode *inode = file_inode(filp);
3145 char *path;
3146
3147 errseq_set(&inode->i_mapping->wb_err, -EIO);
3148 if (__ratelimit(&_rs)) {
3149 path = file_path(filp, pathname, sizeof(pathname));
3150 if (IS_ERR(path))
3151 path = "(unknown)";
3152 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3153 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3154 current->comm);
3155 }
3156}
3157
Linus Torvalds1da177e2005-04-16 15:20:36 -07003158ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003159generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160{
3161 struct file *file = iocb->ki_filp;
3162 struct address_space *mapping = file->f_mapping;
3163 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003164 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003165 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003166 size_t write_len;
3167 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003168
Al Viro0c949332014-03-22 06:51:37 -04003169 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003170 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003171
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003172 if (iocb->ki_flags & IOCB_NOWAIT) {
3173 /* If there are pages to writeback, return */
3174 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003175 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003176 return -EAGAIN;
3177 } else {
3178 written = filemap_write_and_wait_range(mapping, pos,
3179 pos + write_len - 1);
3180 if (written)
3181 goto out;
3182 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003183
3184 /*
3185 * After a write we want buffered reads to be sure to go to disk to get
3186 * the new data. We invalidate clean cached page from the region we're
3187 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003188 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003189 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003190 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003191 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003192 /*
3193 * If a page can not be invalidated, return 0 to fall back
3194 * to buffered write.
3195 */
3196 if (written) {
3197 if (written == -EBUSY)
3198 return 0;
3199 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003200 }
3201
Al Viro639a93a52017-04-13 14:10:15 -04003202 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003203
3204 /*
3205 * Finally, try again to invalidate clean pages which might have been
3206 * cached by non-direct readahead, or faulted in by get_user_pages()
3207 * if the source of the write was an mmap'ed region of the file
3208 * we're writing. Either one is a pretty crazy thing to do,
3209 * so we don't support it 100%. If this invalidation
3210 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003211 *
3212 * Most of the time we do not need this since dio_complete() will do
3213 * the invalidation for us. However there are some file systems that
3214 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003215 * them by removing it completely.
3216 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003217 * Noticeable example is a blkdev_direct_IO().
3218 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003219 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003220 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003221 if (written > 0 && mapping->nrpages &&
3222 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3223 dio_warn_stale_pagecache(file);
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);