blob: 38e6a37336a65fe98e98b038e9085e53d3ec4384 [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))
Johannes Weinerf4129ea2020-06-03 16:01:24 -0700811 __dec_node_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500812 if (!PageHuge(new))
813 __inc_node_page_state(new, NR_FILE_PAGES);
814 if (PageSwapBacked(old))
Johannes Weinerf4129ea2020-06-03 16:01:24 -0700815 __dec_node_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500816 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);
Nick Piggine2867812008-07-25 19:45:30 -0700835 int error;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500836 void *old;
Nick Piggine2867812008-07-25 19:45:30 -0700837
Sasha Levin309381fea2014-01-23 15:52:54 -0800838 VM_BUG_ON_PAGE(!PageLocked(page), page);
839 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500840 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700841
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300842 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700843 page->mapping = mapping;
844 page->index = offset;
845
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700846 if (!huge) {
847 error = mem_cgroup_charge(page, current->mm, gfp_mask, false);
848 if (error)
849 goto error;
850 }
851
Matthew Wilcox74d60952017-11-17 10:01:45 -0500852 do {
853 xas_lock_irq(&xas);
854 old = xas_load(&xas);
855 if (old && !xa_is_value(old))
856 xas_set_err(&xas, -EEXIST);
857 xas_store(&xas, page);
858 if (xas_error(&xas))
859 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700860
Matthew Wilcox74d60952017-11-17 10:01:45 -0500861 if (xa_is_value(old)) {
862 mapping->nrexceptional--;
863 if (shadowp)
864 *shadowp = old;
865 }
866 mapping->nrpages++;
867
868 /* hugetlb pages do not participate in page cache accounting */
869 if (!huge)
870 __inc_node_page_state(page, NR_FILE_PAGES);
871unlock:
872 xas_unlock_irq(&xas);
873 } while (xas_nomem(&xas, gfp_mask & GFP_RECLAIM_MASK));
874
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700875 if (xas_error(&xas)) {
876 error = xas_error(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500877 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700878 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500879
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700880 trace_mm_filemap_add_to_page_cache(page);
881 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500882error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700883 page->mapping = NULL;
884 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300885 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700886 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700888ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700889
890/**
891 * add_to_page_cache_locked - add a locked page to the pagecache
892 * @page: page to add
893 * @mapping: the page's address_space
894 * @offset: page index
895 * @gfp_mask: page allocation mode
896 *
897 * This function is used to add a page to the pagecache. It must be locked.
898 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800899 *
900 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700901 */
902int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
903 pgoff_t offset, gfp_t gfp_mask)
904{
905 return __add_to_page_cache_locked(page, mapping, offset,
906 gfp_mask, NULL);
907}
Nick Piggine2867812008-07-25 19:45:30 -0700908EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
910int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400911 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
Johannes Weinera5289102014-04-03 14:47:51 -0700913 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700914 int ret;
915
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800916 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700917 ret = __add_to_page_cache_locked(page, mapping, offset,
918 gfp_mask, &shadow);
919 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800920 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700921 else {
922 /*
923 * The page might have been evicted from cache only
924 * recently, in which case it should be activated like
925 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700926 * The exception is pages getting rewritten; evicting other
927 * data from the working set, only to cache data that will
928 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700929 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700930 WARN_ON_ONCE(PageActive(page));
931 if (!(gfp_mask & __GFP_WRITE) && shadow)
932 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700933 lru_cache_add(page);
934 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 return ret;
936}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300937EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Paul Jackson44110fe2006-03-24 03:16:04 -0800939#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700940struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800941{
Miao Xiec0ff7452010-05-24 14:32:08 -0700942 int n;
943 struct page *page;
944
Paul Jackson44110fe2006-03-24 03:16:04 -0800945 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700946 unsigned int cpuset_mems_cookie;
947 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700948 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700949 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700950 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700951 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700952
Miao Xiec0ff7452010-05-24 14:32:08 -0700953 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800954 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700955 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800956}
Nick Piggin2ae88142006-10-28 10:38:23 -0700957EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800958#endif
959
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960/*
961 * In order to wait for pages to become available there must be
962 * waitqueues associated with pages. By using a hash table of
963 * waitqueues where the bucket discipline is to maintain all
964 * waiters on the same queue and wake all when any of the pages
965 * become available, and for the woken contexts to check to be
966 * sure the appropriate page became available, this saves space
967 * at a cost of "thundering herd" phenomena during rare hash
968 * collisions.
969 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000970#define PAGE_WAIT_TABLE_BITS 8
971#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
972static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
973
974static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975{
Nicholas Piggin62906022016-12-25 13:00:30 +1000976 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977}
Nicholas Piggin62906022016-12-25 13:00:30 +1000978
979void __init pagecache_init(void)
980{
981 int i;
982
983 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
984 init_waitqueue_head(&page_wait_table[i]);
985
986 page_writeback_init();
987}
988
Linus Torvalds3510ca22017-08-27 13:55:12 -0700989/* This has the same layout as wait_bit_key - see fs/cachefiles/rdwr.c */
Nicholas Piggin62906022016-12-25 13:00:30 +1000990struct wait_page_key {
991 struct page *page;
992 int bit_nr;
993 int page_match;
994};
995
996struct wait_page_queue {
997 struct page *page;
998 int bit_nr;
Ingo Molnarac6424b2017-06-20 12:06:13 +0200999 wait_queue_entry_t wait;
Nicholas Piggin62906022016-12-25 13:00:30 +10001000};
1001
Ingo Molnarac6424b2017-06-20 12:06:13 +02001002static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001003{
1004 struct wait_page_key *key = arg;
1005 struct wait_page_queue *wait_page
1006 = container_of(wait, struct wait_page_queue, wait);
1007
1008 if (wait_page->page != key->page)
1009 return 0;
1010 key->page_match = 1;
1011
1012 if (wait_page->bit_nr != key->bit_nr)
1013 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001014
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001015 /*
1016 * Stop walking if it's locked.
1017 * Is this safe if put_and_wait_on_page_locked() is in use?
1018 * Yes: the waker must hold a reference to this page, and if PG_locked
1019 * has now already been set by another task, that task must also hold
1020 * a reference to the *same usage* of this page; so there is no need
1021 * to walk on to wake even the put_and_wait_on_page_locked() callers.
1022 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001023 if (test_bit(key->bit_nr, &key->page->flags))
Linus Torvalds3510ca22017-08-27 13:55:12 -07001024 return -1;
Nicholas Piggin62906022016-12-25 13:00:30 +10001025
1026 return autoremove_wake_function(wait, mode, sync, key);
1027}
1028
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001029static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001030{
1031 wait_queue_head_t *q = page_waitqueue(page);
1032 struct wait_page_key key;
1033 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001034 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001035
1036 key.page = page;
1037 key.bit_nr = bit_nr;
1038 key.page_match = 0;
1039
Tim Chen11a19c72017-08-25 09:13:55 -07001040 bookmark.flags = 0;
1041 bookmark.private = NULL;
1042 bookmark.func = NULL;
1043 INIT_LIST_HEAD(&bookmark.entry);
1044
Nicholas Piggin62906022016-12-25 13:00:30 +10001045 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001046 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1047
1048 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1049 /*
1050 * Take a breather from holding the lock,
1051 * allow pages that finish wake up asynchronously
1052 * to acquire the lock and remove themselves
1053 * from wait queue
1054 */
1055 spin_unlock_irqrestore(&q->lock, flags);
1056 cpu_relax();
1057 spin_lock_irqsave(&q->lock, flags);
1058 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1059 }
1060
Nicholas Piggin62906022016-12-25 13:00:30 +10001061 /*
1062 * It is possible for other pages to have collided on the waitqueue
1063 * hash, so in that case check for a page match. That prevents a long-
1064 * term waiter
1065 *
1066 * It is still possible to miss a case here, when we woke page waiters
1067 * and removed them from the waitqueue, but there are still other
1068 * page waiters.
1069 */
1070 if (!waitqueue_active(q) || !key.page_match) {
1071 ClearPageWaiters(page);
1072 /*
1073 * It's possible to miss clearing Waiters here, when we woke
1074 * our page waiters, but the hashed waitqueue has waiters for
1075 * other pages on it.
1076 *
1077 * That's okay, it's a rare case. The next waker will clear it.
1078 */
1079 }
1080 spin_unlock_irqrestore(&q->lock, flags);
1081}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001082
1083static void wake_up_page(struct page *page, int bit)
1084{
1085 if (!PageWaiters(page))
1086 return;
1087 wake_up_page_bit(page, bit);
1088}
Nicholas Piggin62906022016-12-25 13:00:30 +10001089
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001090/*
1091 * A choice of three behaviors for wait_on_page_bit_common():
1092 */
1093enum behavior {
1094 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1095 * __lock_page() waiting on then setting PG_locked.
1096 */
1097 SHARED, /* Hold ref to page and check the bit when woken, like
1098 * wait_on_page_writeback() waiting on PG_writeback.
1099 */
1100 DROP, /* Drop ref to page before wait, no check when woken,
1101 * like put_and_wait_on_page_locked() on PG_locked.
1102 */
1103};
1104
Nicholas Piggin62906022016-12-25 13:00:30 +10001105static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001106 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001107{
1108 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001109 wait_queue_entry_t *wait = &wait_page.wait;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001110 bool bit_is_set;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001111 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001112 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001113 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001114 int ret = 0;
1115
Johannes Weinereb414682018-10-26 15:06:27 -07001116 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001117 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001118 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001119 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001120 delayacct = true;
1121 }
Johannes Weinereb414682018-10-26 15:06:27 -07001122 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001123 thrashing = true;
1124 }
1125
Nicholas Piggin62906022016-12-25 13:00:30 +10001126 init_wait(wait);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001127 wait->flags = behavior == EXCLUSIVE ? WQ_FLAG_EXCLUSIVE : 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001128 wait->func = wake_page_function;
1129 wait_page.page = page;
1130 wait_page.bit_nr = bit_nr;
1131
1132 for (;;) {
1133 spin_lock_irq(&q->lock);
1134
Ingo Molnar2055da92017-06-20 12:06:46 +02001135 if (likely(list_empty(&wait->entry))) {
Linus Torvalds3510ca22017-08-27 13:55:12 -07001136 __add_wait_queue_entry_tail(q, wait);
Nicholas Piggin62906022016-12-25 13:00:30 +10001137 SetPageWaiters(page);
1138 }
1139
1140 set_current_state(state);
1141
1142 spin_unlock_irq(&q->lock);
1143
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001144 bit_is_set = test_bit(bit_nr, &page->flags);
1145 if (behavior == DROP)
1146 put_page(page);
Nicholas Piggin62906022016-12-25 13:00:30 +10001147
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001148 if (likely(bit_is_set))
1149 io_schedule();
1150
1151 if (behavior == EXCLUSIVE) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001152 if (!test_and_set_bit_lock(bit_nr, &page->flags))
1153 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001154 } else if (behavior == SHARED) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001155 if (!test_bit(bit_nr, &page->flags))
1156 break;
1157 }
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001158
Davidlohr Buesofa45f112019-01-03 15:28:55 -08001159 if (signal_pending_state(state, current)) {
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001160 ret = -EINTR;
1161 break;
1162 }
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001163
1164 if (behavior == DROP) {
1165 /*
1166 * We can no longer safely access page->flags:
1167 * even if CONFIG_MEMORY_HOTREMOVE is not enabled,
1168 * there is a risk of waiting forever on a page reused
1169 * for something that keeps it locked indefinitely.
1170 * But best check for -EINTR above before breaking.
1171 */
1172 break;
1173 }
Nicholas Piggin62906022016-12-25 13:00:30 +10001174 }
1175
1176 finish_wait(q, wait);
1177
Johannes Weinereb414682018-10-26 15:06:27 -07001178 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001179 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001180 delayacct_thrashing_end();
1181 psi_memstall_leave(&pflags);
1182 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001183
Nicholas Piggin62906022016-12-25 13:00:30 +10001184 /*
1185 * A signal could leave PageWaiters set. Clearing it here if
1186 * !waitqueue_active would be possible (by open-coding finish_wait),
1187 * but still fail to catch it in the case of wait hash collision. We
1188 * already can fail to clear wait hash collision cases, so don't
1189 * bother with signals either.
1190 */
1191
1192 return ret;
1193}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
Harvey Harrison920c7a52008-02-04 22:29:26 -08001195void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196{
Nicholas Piggin62906022016-12-25 13:00:30 +10001197 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001198 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199}
1200EXPORT_SYMBOL(wait_on_page_bit);
1201
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001202int wait_on_page_bit_killable(struct page *page, int bit_nr)
1203{
Nicholas Piggin62906022016-12-25 13:00:30 +10001204 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001205 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001206}
David Howells4343d002017-11-02 15:27:52 +00001207EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001208
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001210 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1211 * @page: The page to wait for.
1212 *
1213 * The caller should hold a reference on @page. They expect the page to
1214 * become unlocked relatively soon, but do not wish to hold up migration
1215 * (for example) by holding the reference while waiting for the page to
1216 * come unlocked. After this function returns, the caller should not
1217 * dereference @page.
1218 */
1219void put_and_wait_on_page_locked(struct page *page)
1220{
1221 wait_queue_head_t *q;
1222
1223 page = compound_head(page);
1224 q = page_waitqueue(page);
1225 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1226}
1227
1228/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001229 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001230 * @page: Page defining the wait queue of interest
1231 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001232 *
1233 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1234 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001235void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001236{
1237 wait_queue_head_t *q = page_waitqueue(page);
1238 unsigned long flags;
1239
1240 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001241 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001242 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001243 spin_unlock_irqrestore(&q->lock, flags);
1244}
1245EXPORT_SYMBOL_GPL(add_page_wait_queue);
1246
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001247#ifndef clear_bit_unlock_is_negative_byte
1248
1249/*
1250 * PG_waiters is the high bit in the same byte as PG_lock.
1251 *
1252 * On x86 (and on many other architectures), we can clear PG_lock and
1253 * test the sign bit at the same time. But if the architecture does
1254 * not support that special operation, we just do this all by hand
1255 * instead.
1256 *
1257 * The read of PG_waiters has to be after (or concurrently with) PG_locked
1258 * being cleared, but a memory barrier should be unneccssary since it is
1259 * in the same byte as PG_locked.
1260 */
1261static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1262{
1263 clear_bit_unlock(nr, mem);
1264 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001265 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001266}
1267
1268#endif
1269
David Howells385e1ca5f2009-04-03 16:42:39 +01001270/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001271 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 * @page: the page
1273 *
1274 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
1275 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001276 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1278 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001279 * Note that this depends on PG_waiters being the sign bit in the byte
1280 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1281 * clear the PG_locked bit and test PG_waiters at the same time fairly
1282 * portably (architectures that do LL/SC can test any bit, while x86 can
1283 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001284 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001285void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001287 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001288 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001289 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001290 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1291 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292}
1293EXPORT_SYMBOL(unlock_page);
1294
Randy Dunlap485bb992006-06-23 02:03:49 -07001295/**
1296 * end_page_writeback - end writeback against a page
1297 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 */
1299void end_page_writeback(struct page *page)
1300{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001301 /*
1302 * TestClearPageReclaim could be used here but it is an atomic
1303 * operation and overkill in this particular case. Failing to
1304 * shuffle a page marked for immediate reclaim is too mild to
1305 * justify taking an atomic operation penalty at the end of
1306 * ever page writeback.
1307 */
1308 if (PageReclaim(page)) {
1309 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001310 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001311 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001312
1313 if (!test_clear_page_writeback(page))
1314 BUG();
1315
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001316 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 wake_up_page(page, PG_writeback);
1318}
1319EXPORT_SYMBOL(end_page_writeback);
1320
Matthew Wilcox57d99842014-06-04 16:07:45 -07001321/*
1322 * After completing I/O on a page, call this routine to update the page
1323 * flags appropriately
1324 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001325void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001326{
Jens Axboec11f0c02016-08-05 08:11:04 -06001327 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001328 if (!err) {
1329 SetPageUptodate(page);
1330 } else {
1331 ClearPageUptodate(page);
1332 SetPageError(page);
1333 }
1334 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001335 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001336 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001337 struct address_space *mapping;
1338
Matthew Wilcox57d99842014-06-04 16:07:45 -07001339 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001340 mapping = page_mapping(page);
1341 if (mapping)
1342 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001343 }
1344 end_page_writeback(page);
1345 }
1346}
1347EXPORT_SYMBOL_GPL(page_endio);
1348
Randy Dunlap485bb992006-06-23 02:03:49 -07001349/**
1350 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001351 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001353void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354{
Nicholas Piggin62906022016-12-25 13:00:30 +10001355 struct page *page = compound_head(__page);
1356 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001357 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1358 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359}
1360EXPORT_SYMBOL(__lock_page);
1361
Nicholas Piggin62906022016-12-25 13:00:30 +10001362int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001363{
Nicholas Piggin62906022016-12-25 13:00:30 +10001364 struct page *page = compound_head(__page);
1365 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001366 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1367 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001368}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001369EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001370
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001371/*
1372 * Return values:
1373 * 1 - page is locked; mmap_sem is still held.
1374 * 0 - page is not locked.
1375 * mmap_sem has been released (up_read()), unless flags had both
1376 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1377 * which case mmap_sem is still held.
1378 *
1379 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1380 * with the page locked and the mmap_sem unperturbed.
1381 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001382int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1383 unsigned int flags)
1384{
Peter Xu4064b982020-04-01 21:08:45 -07001385 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001386 /*
1387 * CAUTION! In this case, mmap_sem is not released
1388 * even though return 0.
1389 */
1390 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1391 return 0;
1392
1393 up_read(&mm->mmap_sem);
1394 if (flags & FAULT_FLAG_KILLABLE)
1395 wait_on_page_locked_killable(page);
1396 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001397 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001398 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001399 } else {
1400 if (flags & FAULT_FLAG_KILLABLE) {
1401 int ret;
1402
1403 ret = __lock_page_killable(page);
1404 if (ret) {
1405 up_read(&mm->mmap_sem);
1406 return 0;
1407 }
1408 } else
1409 __lock_page(page);
1410 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001411 }
1412}
1413
Randy Dunlap485bb992006-06-23 02:03:49 -07001414/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001415 * page_cache_next_miss() - Find the next gap in the page cache.
1416 * @mapping: Mapping.
1417 * @index: Index.
1418 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001419 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001420 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1421 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001422 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001423 * This function may be called under the rcu_read_lock. However, this will
1424 * not atomically search a snapshot of the cache at a single point in time.
1425 * For example, if a gap is created at index 5, then subsequently a gap is
1426 * created at index 10, page_cache_next_miss covering both indices may
1427 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001428 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001429 * Return: The index of the gap if found, otherwise an index outside the
1430 * range specified (in which case 'return - index >= max_scan' will be true).
1431 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001432 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001433pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001434 pgoff_t index, unsigned long max_scan)
1435{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001436 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001437
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001438 while (max_scan--) {
1439 void *entry = xas_next(&xas);
1440 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001441 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001442 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001443 break;
1444 }
1445
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001446 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001447}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001448EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001449
1450/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001451 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001452 * @mapping: Mapping.
1453 * @index: Index.
1454 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001455 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001456 * Search the range [max(index - max_scan + 1, 0), index] for the
1457 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001458 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001459 * This function may be called under the rcu_read_lock. However, this will
1460 * not atomically search a snapshot of the cache at a single point in time.
1461 * For example, if a gap is created at index 10, then subsequently a gap is
1462 * created at index 5, page_cache_prev_miss() covering both indices may
1463 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001464 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001465 * Return: The index of the gap if found, otherwise an index outside the
1466 * range specified (in which case 'index - return >= max_scan' will be true).
1467 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001468 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001469pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001470 pgoff_t index, unsigned long max_scan)
1471{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001472 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001473
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001474 while (max_scan--) {
1475 void *entry = xas_prev(&xas);
1476 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001477 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001478 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001479 break;
1480 }
1481
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001482 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001483}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001484EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001485
1486/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001487 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001488 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001489 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001490 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001491 * Looks up the page cache slot at @mapping & @offset. If there is a
1492 * page cache page, it is returned with an increased refcount.
1493 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001494 * If the slot holds a shadow entry of a previously evicted page, or a
1495 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001496 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001497 * Return: the found page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001498 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001499struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500{
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001501 XA_STATE(xas, &mapping->i_pages, offset);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001502 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Nick Piggina60637c2008-07-25 19:45:31 -07001504 rcu_read_lock();
1505repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001506 xas_reset(&xas);
1507 page = xas_load(&xas);
1508 if (xas_retry(&xas, page))
1509 goto repeat;
1510 /*
1511 * A shadow entry of a recently evicted page, or a swap entry from
1512 * shmem/tmpfs. Return it without attempting to raise page count.
1513 */
1514 if (!page || xa_is_value(page))
1515 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001516
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001517 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001518 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001519
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001520 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001521 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001522 * This is part of the lockless pagecache protocol. See
1523 * include/linux/pagemap.h for details.
1524 */
1525 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001526 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001527 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001528 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001529 page = find_subpage(page, offset);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001530out:
Nick Piggina60637c2008-07-25 19:45:31 -07001531 rcu_read_unlock();
1532
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 return page;
1534}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Randy Dunlap485bb992006-06-23 02:03:49 -07001536/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001537 * find_lock_entry - locate, pin and lock a page cache entry
1538 * @mapping: the address_space to search
1539 * @offset: the page cache index
1540 *
1541 * Looks up the page cache slot at @mapping & @offset. If there is a
1542 * page cache page, it is returned locked and with an increased
1543 * refcount.
1544 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001545 * If the slot holds a shadow entry of a previously evicted page, or a
1546 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001547 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001548 * find_lock_entry() may sleep.
Mike Rapoporta862f682019-03-05 15:48:42 -08001549 *
1550 * Return: the found page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001551 */
1552struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001553{
1554 struct page *page;
1555
Linus Torvalds1da177e2005-04-16 15:20:36 -07001556repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001557 page = find_get_entry(mapping, offset);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001558 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001559 lock_page(page);
1560 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001561 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001562 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001563 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001564 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001565 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001566 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001567 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 return page;
1569}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001570EXPORT_SYMBOL(find_lock_entry);
1571
1572/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001573 * pagecache_get_page - Find and get a reference to a page.
1574 * @mapping: The address_space to search.
1575 * @index: The page index.
1576 * @fgp_flags: %FGP flags modify how the page is returned.
1577 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001578 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001579 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001580 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001581 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001582 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001583 * * %FGP_ACCESSED - The page will be marked accessed.
1584 * * %FGP_LOCK - The page is returned locked.
1585 * * %FGP_CREAT - If no page is present then a new page is allocated using
1586 * @gfp_mask and added to the page cache and the VM's LRU list.
1587 * The page is returned locked and with an increased refcount.
1588 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1589 * page is already in cache. If the page was allocated, unlock it before
1590 * returning so the caller can do the same dance.
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001591 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001592 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1593 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001594 *
1595 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001596 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001597 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001598 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001599struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1600 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601{
Nick Piggineb2be182007-10-16 01:24:57 -07001602 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001603
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001605 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001606 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001607 page = NULL;
1608 if (!page)
1609 goto no_page;
1610
1611 if (fgp_flags & FGP_LOCK) {
1612 if (fgp_flags & FGP_NOWAIT) {
1613 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001614 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001615 return NULL;
1616 }
1617 } else {
1618 lock_page(page);
1619 }
1620
1621 /* Has the page been truncated? */
Song Liu31895432019-09-23 15:37:47 -07001622 if (unlikely(compound_head(page)->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001623 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001624 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001625 goto repeat;
1626 }
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001627 VM_BUG_ON_PAGE(page->index != index, page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001628 }
1629
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001630 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001631 mark_page_accessed(page);
1632
1633no_page:
1634 if (!page && (fgp_flags & FGP_CREAT)) {
1635 int err;
1636 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001637 gfp_mask |= __GFP_WRITE;
1638 if (fgp_flags & FGP_NOFS)
1639 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001640
Michal Hocko45f87de2014-12-29 20:30:35 +01001641 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001642 if (!page)
1643 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001644
Josef Bacika75d4c32019-03-13 11:44:14 -07001645 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001646 fgp_flags |= FGP_LOCK;
1647
Hugh Dickinseb39d612014-08-06 16:06:43 -07001648 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001649 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001650 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001651
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001652 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001653 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001654 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001655 page = NULL;
1656 if (err == -EEXIST)
1657 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001659
1660 /*
1661 * add_to_page_cache_lru locks the page, and for mmap we expect
1662 * an unlocked page.
1663 */
1664 if (page && (fgp_flags & FGP_FOR_MMAP))
1665 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001667
Linus Torvalds1da177e2005-04-16 15:20:36 -07001668 return page;
1669}
Mel Gorman2457aec2014-06-04 16:10:31 -07001670EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671
1672/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001673 * find_get_entries - gang pagecache lookup
1674 * @mapping: The address_space to search
1675 * @start: The starting page cache index
1676 * @nr_entries: The maximum number of entries
1677 * @entries: Where the resulting entries are placed
1678 * @indices: The cache indices corresponding to the entries in @entries
1679 *
1680 * find_get_entries() will search for and return a group of up to
1681 * @nr_entries entries in the mapping. The entries are placed at
1682 * @entries. find_get_entries() takes a reference against any actual
1683 * pages it returns.
1684 *
1685 * The search returns a group of mapping-contiguous page cache entries
1686 * with ascending indexes. There may be holes in the indices due to
1687 * not-present pages.
1688 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001689 * Any shadow entries of evicted pages, or swap entries from
1690 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001691 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001692 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1693 * stops at that page: the caller is likely to have a better way to handle
1694 * the compound page as a whole, and then skip its extent, than repeatedly
1695 * calling find_get_entries() to return all its tails.
1696 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001697 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001698 */
1699unsigned find_get_entries(struct address_space *mapping,
1700 pgoff_t start, unsigned int nr_entries,
1701 struct page **entries, pgoff_t *indices)
1702{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001703 XA_STATE(xas, &mapping->i_pages, start);
1704 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001705 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001706
1707 if (!nr_entries)
1708 return 0;
1709
1710 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001711 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001712 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001713 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001714 /*
1715 * A shadow entry of a recently evicted page, a swap
1716 * entry from shmem/tmpfs or a DAX entry. Return it
1717 * without attempting to raise page count.
1718 */
1719 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001720 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001721
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001722 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001723 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001724
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001725 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001726 if (unlikely(page != xas_reload(&xas)))
1727 goto put_page;
1728
Hugh Dickins71725ed2020-04-06 20:07:57 -07001729 /*
1730 * Terminate early on finding a THP, to allow the caller to
1731 * handle it all at once; but continue if this is hugetlbfs.
1732 */
1733 if (PageTransHuge(page) && !PageHuge(page)) {
1734 page = find_subpage(page, xas.xa_index);
1735 nr_entries = ret + 1;
1736 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001737export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001738 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001739 entries[ret] = page;
1740 if (++ret == nr_entries)
1741 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001742 continue;
1743put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001744 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001745retry:
1746 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001747 }
1748 rcu_read_unlock();
1749 return ret;
1750}
1751
1752/**
Jan Karab947cee2017-09-06 16:21:21 -07001753 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001754 * @mapping: The address_space to search
1755 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001756 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757 * @nr_pages: The maximum number of pages
1758 * @pages: Where the resulting pages are placed
1759 *
Jan Karab947cee2017-09-06 16:21:21 -07001760 * find_get_pages_range() will search for and return a group of up to @nr_pages
1761 * pages in the mapping starting at index @start and up to index @end
1762 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1763 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 *
1765 * The search returns a group of mapping-contiguous pages with ascending
1766 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001767 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001769 * Return: the number of pages which were found. If this number is
1770 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001771 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772 */
Jan Karab947cee2017-09-06 16:21:21 -07001773unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1774 pgoff_t end, unsigned int nr_pages,
1775 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001777 XA_STATE(xas, &mapping->i_pages, *start);
1778 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001779 unsigned ret = 0;
1780
1781 if (unlikely(!nr_pages))
1782 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Nick Piggina60637c2008-07-25 19:45:31 -07001784 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001785 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001786 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001787 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001788 /* Skip over shadow, swap and DAX entries */
1789 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001790 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001791
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001792 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001793 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001794
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001795 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001796 if (unlikely(page != xas_reload(&xas)))
1797 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001798
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001799 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001800 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001801 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001802 goto out;
1803 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001804 continue;
1805put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001806 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001807retry:
1808 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001809 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001810
Jan Karab947cee2017-09-06 16:21:21 -07001811 /*
1812 * We come here when there is no page beyond @end. We take care to not
1813 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001814 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07001815 * already broken anyway.
1816 */
1817 if (end == (pgoff_t)-1)
1818 *start = (pgoff_t)-1;
1819 else
1820 *start = end + 1;
1821out:
Nick Piggina60637c2008-07-25 19:45:31 -07001822 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07001823
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 return ret;
1825}
1826
Jens Axboeebf43502006-04-27 08:46:01 +02001827/**
1828 * find_get_pages_contig - gang contiguous pagecache lookup
1829 * @mapping: The address_space to search
1830 * @index: The starting page index
1831 * @nr_pages: The maximum number of pages
1832 * @pages: Where the resulting pages are placed
1833 *
1834 * find_get_pages_contig() works exactly like find_get_pages(), except
1835 * that the returned number of pages are guaranteed to be contiguous.
1836 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001837 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02001838 */
1839unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1840 unsigned int nr_pages, struct page **pages)
1841{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001842 XA_STATE(xas, &mapping->i_pages, index);
1843 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001844 unsigned int ret = 0;
1845
1846 if (unlikely(!nr_pages))
1847 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001848
Nick Piggina60637c2008-07-25 19:45:31 -07001849 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001850 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001851 if (xas_retry(&xas, page))
1852 continue;
1853 /*
1854 * If the entry has been swapped out, we can stop looking.
1855 * No current caller is looking for DAX entries.
1856 */
1857 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001858 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001859
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001860 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001861 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001862
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001863 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001864 if (unlikely(page != xas_reload(&xas)))
1865 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001866
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001867 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001868 if (++ret == nr_pages)
1869 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001870 continue;
1871put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001872 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001873retry:
1874 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02001875 }
Nick Piggina60637c2008-07-25 19:45:31 -07001876 rcu_read_unlock();
1877 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001878}
David Howellsef71c152007-05-09 02:33:44 -07001879EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001880
Randy Dunlap485bb992006-06-23 02:03:49 -07001881/**
Jan Kara72b045a2017-11-15 17:34:33 -08001882 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001883 * @mapping: the address_space to search
1884 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08001885 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001886 * @tag: the tag index
1887 * @nr_pages: the maximum number of pages
1888 * @pages: where the resulting pages are placed
1889 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001891 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08001892 *
1893 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001894 */
Jan Kara72b045a2017-11-15 17:34:33 -08001895unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001896 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08001897 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001899 XA_STATE(xas, &mapping->i_pages, *index);
1900 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001901 unsigned ret = 0;
1902
1903 if (unlikely(!nr_pages))
1904 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
Nick Piggina60637c2008-07-25 19:45:31 -07001906 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001907 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001908 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001909 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001910 /*
1911 * Shadow entries should never be tagged, but this iteration
1912 * is lockless so there is a window for page reclaim to evict
1913 * a page we saw tagged. Skip over it.
1914 */
1915 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07001916 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001917
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001918 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001919 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001920
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001921 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001922 if (unlikely(page != xas_reload(&xas)))
1923 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001924
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001925 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08001926 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001927 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08001928 goto out;
1929 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001930 continue;
1931put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001932 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001933retry:
1934 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001935 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001936
Jan Kara72b045a2017-11-15 17:34:33 -08001937 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001938 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08001939 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001940 * iteration when there is a page at index -1 but that is already
1941 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08001942 */
1943 if (end == (pgoff_t)-1)
1944 *index = (pgoff_t)-1;
1945 else
1946 *index = end + 1;
1947out:
Nick Piggina60637c2008-07-25 19:45:31 -07001948 rcu_read_unlock();
1949
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 return ret;
1951}
Jan Kara72b045a2017-11-15 17:34:33 -08001952EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001954/*
1955 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1956 * a _large_ part of the i/o request. Imagine the worst scenario:
1957 *
1958 * ---R__________________________________________B__________
1959 * ^ reading here ^ bad block(assume 4k)
1960 *
1961 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1962 * => failing the whole request => read(R) => read(R+1) =>
1963 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1964 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1965 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1966 *
1967 * It is going insane. Fix it by quickly scaling down the readahead size.
1968 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07001969static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001970{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001971 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001972}
1973
Randy Dunlap485bb992006-06-23 02:03:49 -07001974/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001975 * generic_file_buffered_read - generic file read routine
1976 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05001977 * @iter: data destination
1978 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001979 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001981 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 *
1983 * This is really ugly. But the goto's actually try to clarify some
1984 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08001985 *
1986 * Return:
1987 * * total number of bytes copied, including those the were already @written
1988 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05001990ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05001991 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001993 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001994 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001996 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02001997 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001998 pgoff_t index;
1999 pgoff_t last_index;
2000 pgoff_t prev_index;
2001 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002002 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002003 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004
Wei Fangc2a97372016-10-07 17:01:52 -07002005 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002006 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002007 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2008
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002009 index = *ppos >> PAGE_SHIFT;
2010 prev_index = ra->prev_pos >> PAGE_SHIFT;
2011 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2012 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2013 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 for (;;) {
2016 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002017 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002018 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 unsigned long nr, ret;
2020
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002022find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002023 if (fatal_signal_pending(current)) {
2024 error = -EINTR;
2025 goto out;
2026 }
2027
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002029 if (!page) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002030 if (iocb->ki_flags & IOCB_NOWAIT)
2031 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002032 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002033 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002034 index, last_index - index);
2035 page = find_get_page(mapping, index);
2036 if (unlikely(page == NULL))
2037 goto no_cached_page;
2038 }
2039 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07002040 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002041 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002042 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002044 if (!PageUptodate(page)) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002045 if (iocb->ki_flags & IOCB_NOWAIT) {
2046 put_page(page);
2047 goto would_block;
2048 }
2049
Mel Gormanebded022016-03-15 14:55:39 -07002050 /*
2051 * See comment in do_read_cache_page on why
2052 * wait_on_page_locked is used to avoid unnecessarily
2053 * serialisations and why it's safe.
2054 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002055 error = wait_on_page_locked_killable(page);
2056 if (unlikely(error))
2057 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002058 if (PageUptodate(page))
2059 goto page_ok;
2060
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002061 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002062 !mapping->a_ops->is_partially_uptodate)
2063 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002064 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002065 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002066 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002067 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002068 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002069 /* Did it get truncated before we got the lock? */
2070 if (!page->mapping)
2071 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002072 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002073 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002074 goto page_not_up_to_date_locked;
2075 unlock_page(page);
2076 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002077page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002078 /*
2079 * i_size must be checked after we know the page is Uptodate.
2080 *
2081 * Checking i_size after the check allows us to calculate
2082 * the correct value for "nr", which means the zero-filled
2083 * part of the page is not copied back to userspace (unless
2084 * another truncate extends the file - this is desired though).
2085 */
2086
2087 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002088 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002089 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002090 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002091 goto out;
2092 }
2093
2094 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002095 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002096 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002097 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002098 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002099 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002100 goto out;
2101 }
2102 }
2103 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104
2105 /* If users can be writing to this page using arbitrary
2106 * virtual addresses, take care about potential aliasing
2107 * before reading the page on the kernel side.
2108 */
2109 if (mapping_writably_mapped(mapping))
2110 flush_dcache_page(page);
2111
2112 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002113 * When a sequential read accesses a page several times,
2114 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 */
Jan Karaec0f1632007-05-06 14:49:25 -07002116 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 mark_page_accessed(page);
2118 prev_index = index;
2119
2120 /*
2121 * Ok, we have the page, and it's up-to-date, so
2122 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002123 */
Al Viro6e58e792014-02-03 17:07:03 -05002124
2125 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002126 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002127 index += offset >> PAGE_SHIFT;
2128 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002129 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002131 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002132 written += ret;
2133 if (!iov_iter_count(iter))
2134 goto out;
2135 if (ret < nr) {
2136 error = -EFAULT;
2137 goto out;
2138 }
2139 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002140
2141page_not_up_to_date:
2142 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04002143 error = lock_page_killable(page);
2144 if (unlikely(error))
2145 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002146
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002147page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002148 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 if (!page->mapping) {
2150 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002151 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 continue;
2153 }
2154
2155 /* Did somebody else fill it already? */
2156 if (PageUptodate(page)) {
2157 unlock_page(page);
2158 goto page_ok;
2159 }
2160
2161readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04002162 /*
2163 * A previous I/O error may have been due to temporary
2164 * failures, eg. multipath errors.
2165 * PG_error will be set again if readpage fails.
2166 */
2167 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 /* Start the actual read. The read will unlock the page. */
2169 error = mapping->a_ops->readpage(filp, page);
2170
Zach Brown994fc28c2005-12-15 14:28:17 -08002171 if (unlikely(error)) {
2172 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002173 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002174 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002175 goto find_page;
2176 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002178 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002179
2180 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04002181 error = lock_page_killable(page);
2182 if (unlikely(error))
2183 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 if (!PageUptodate(page)) {
2185 if (page->mapping == NULL) {
2186 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002187 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 */
2189 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002190 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 goto find_page;
2192 }
2193 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002194 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002195 error = -EIO;
2196 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 }
2198 unlock_page(page);
2199 }
2200
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 goto page_ok;
2202
2203readpage_error:
2204 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002205 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 goto out;
2207
2208no_cached_page:
2209 /*
2210 * Ok, it wasn't cached, so we need to create a new
2211 * page..
2212 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002213 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002214 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002215 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002216 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002218 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002219 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002221 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002222 if (error == -EEXIST) {
2223 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002224 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002225 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 goto out;
2227 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 goto readpage;
2229 }
2230
Milosz Tanski3239d832017-08-29 16:13:19 +02002231would_block:
2232 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002234 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002235 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002236 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002237
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002238 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002239 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002240 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002242EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243
Randy Dunlap485bb992006-06-23 02:03:49 -07002244/**
Al Viro6abd2322014-04-04 14:20:57 -04002245 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002246 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002247 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002248 *
Al Viro6abd2322014-04-04 14:20:57 -04002249 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 * that can use the page cache directly.
Mike Rapoporta862f682019-03-05 15:48:42 -08002251 * Return:
2252 * * number of bytes copied, even for partial reads
2253 * * negative error code if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 */
2255ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002256generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002258 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002259 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002260
2261 if (!count)
2262 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
Al Viro2ba48ce2015-04-09 13:52:01 -04002264 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002265 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002266 struct address_space *mapping = file->f_mapping;
2267 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002268 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002269
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002271 if (iocb->ki_flags & IOCB_NOWAIT) {
2272 if (filemap_range_has_page(mapping, iocb->ki_pos,
2273 iocb->ki_pos + count - 1))
2274 return -EAGAIN;
2275 } else {
2276 retval = filemap_write_and_wait_range(mapping,
2277 iocb->ki_pos,
2278 iocb->ki_pos + count - 1);
2279 if (retval < 0)
2280 goto out;
2281 }
Al Viroed978a82014-03-05 22:53:04 -05002282
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002283 file_accessed(file);
2284
Al Viro5ecda132017-04-13 14:13:36 -04002285 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002286 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002287 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002288 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002289 }
Al Viro5b47d592017-05-08 13:54:47 -04002290 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002291
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002292 /*
2293 * Btrfs can have a short DIO read if we encounter
2294 * compressed extents, so if there was an error, or if
2295 * we've already read everything we wanted to, or if
2296 * there was a short read because we hit EOF, go ahead
2297 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002298 * the rest of the read. Buffered reads will not work for
2299 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002300 */
Al Viro5ecda132017-04-13 14:13:36 -04002301 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002302 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002303 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002304 }
2305
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002306 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307out:
2308 return retval;
2309}
Al Viroed978a82014-03-05 22:53:04 -05002310EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002311
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002314/*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002315 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_sem
2316 * @vmf - the vm_fault for this fault.
2317 * @page - the page to lock.
2318 * @fpin - the pointer to the file we may pin (or is already pinned).
2319 *
2320 * This works similar to lock_page_or_retry in that it can drop the mmap_sem.
2321 * It differs in that it actually returns the page locked if it returns 1 and 0
2322 * if it couldn't lock the page. If we did have to drop the mmap_sem then fpin
2323 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002324 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002325static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2326 struct file **fpin)
2327{
2328 if (trylock_page(page))
2329 return 1;
2330
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002331 /*
2332 * NOTE! This will make us return with VM_FAULT_RETRY, but with
2333 * the mmap_sem still held. That's how FAULT_FLAG_RETRY_NOWAIT
2334 * is supposed to work. We have way too many special cases..
2335 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002336 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2337 return 0;
2338
2339 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2340 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2341 if (__lock_page_killable(page)) {
2342 /*
2343 * We didn't have the right flags to drop the mmap_sem,
2344 * but all fault_handlers only check for fatal signals
2345 * if we return VM_FAULT_RETRY, so we need to drop the
2346 * mmap_sem here and return 0 if we don't have a fpin.
2347 */
2348 if (*fpin == NULL)
2349 up_read(&vmf->vma->vm_mm->mmap_sem);
2350 return 0;
2351 }
2352 } else
2353 __lock_page(page);
2354 return 1;
2355}
2356
2357
2358/*
2359 * Synchronous readahead happens when we don't even find a page in the page
2360 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2361 * to drop the mmap sem we return the file that was pinned in order for us to do
2362 * that. If we didn't pin a file then we return NULL. The file that is
2363 * returned needs to be fput()'ed when we're done with it.
2364 */
2365static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002366{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002367 struct file *file = vmf->vma->vm_file;
2368 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002369 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002370 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002371 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002372
2373 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002374 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002375 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002376 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002377 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002378
Josef Bacik2a1180f2019-03-13 11:44:18 -07002379 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002380 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002381 page_cache_sync_readahead(mapping, ra, file, offset,
2382 ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002383 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002384 }
2385
Andi Kleen207d04b2011-05-24 17:12:29 -07002386 /* Avoid banging the cache line if not needed */
2387 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002388 ra->mmap_miss++;
2389
2390 /*
2391 * Do we miss much more than hit in this file? If so,
2392 * stop bothering with read-ahead. It will only hurt.
2393 */
2394 if (ra->mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002395 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002396
Wu Fengguangd30a1102009-06-16 15:31:30 -07002397 /*
2398 * mmap read-around
2399 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002400 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002401 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2402 ra->size = ra->ra_pages;
2403 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002404 ra_submit(ra, mapping, file);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002405 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002406}
2407
2408/*
2409 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002410 * so we want to possibly extend the readahead further. We return the file that
2411 * was pinned if we have to drop the mmap_sem in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002412 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002413static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2414 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002415{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002416 struct file *file = vmf->vma->vm_file;
2417 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002418 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002419 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002420 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002421
2422 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002423 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002424 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002425 if (ra->mmap_miss > 0)
2426 ra->mmap_miss--;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002427 if (PageReadahead(page)) {
2428 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002429 page_cache_async_readahead(mapping, ra, file,
2430 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002431 }
2432 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002433}
2434
Randy Dunlap485bb992006-06-23 02:03:49 -07002435/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002436 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002437 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002438 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002439 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002440 * mapped memory region to read in file data during a page fault.
2441 *
2442 * The goto's are kind of ugly, but this streamlines the normal case of having
2443 * it in the page cache, and handles the special cases reasonably without
2444 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002445 *
2446 * vma->vm_mm->mmap_sem must be held on entry.
2447 *
Yang Shia4985832019-07-11 20:55:29 -07002448 * If our return value has VM_FAULT_RETRY set, it's because the mmap_sem
2449 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002450 *
2451 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2452 * has not been released.
2453 *
2454 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002455 *
2456 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002457 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002458vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002459{
2460 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002461 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002462 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463 struct address_space *mapping = file->f_mapping;
2464 struct file_ra_state *ra = &file->f_ra;
2465 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002466 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002467 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002468 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002469 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002470
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002471 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2472 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002473 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
Linus Torvalds1da177e2005-04-16 15:20:36 -07002475 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002476 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002478 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002479 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002481 * We found the page, so try async readahead before
2482 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002483 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002484 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002485 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002486 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002487 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002488 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002489 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002490 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002491retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002492 page = pagecache_get_page(mapping, offset,
2493 FGP_CREAT|FGP_FOR_MMAP,
2494 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002495 if (!page) {
2496 if (fpin)
2497 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002498 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002499 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002500 }
2501
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002502 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2503 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002504
2505 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002506 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002507 unlock_page(page);
2508 put_page(page);
2509 goto retry_find;
2510 }
Song Liu520e5ba2019-09-23 15:37:50 -07002511 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002512
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002514 * We have a locked page in the page cache, now we need to check
2515 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516 */
Nick Piggind00806b2007-07-19 01:46:57 -07002517 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 goto page_not_uptodate;
2519
Linus Torvaldsef00e082009-06-16 15:31:25 -07002520 /*
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002521 * We've made it this far and we had to drop our mmap_sem, now is the
2522 * time to return to the upper layer and have it re-find the vma and
2523 * redo the fault.
2524 */
2525 if (fpin) {
2526 unlock_page(page);
2527 goto out_retry;
2528 }
2529
2530 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002531 * Found the page and have a reference on it.
2532 * We must recheck i_size under page lock.
2533 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002534 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2535 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002536 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002537 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002538 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002539 }
2540
Nick Piggind0217ac2007-07-19 01:47:03 -07002541 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002542 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002543
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 /*
2546 * Umm, take care of errors if the page isn't up-to-date.
2547 * Try to re-read it _once_. We do this synchronously,
2548 * because there really aren't any performance issues here
2549 * and we need to check for errors.
2550 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002551 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002552 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002553 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002554 if (!error) {
2555 wait_on_page_locked(page);
2556 if (!PageUptodate(page))
2557 error = -EIO;
2558 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002559 if (fpin)
2560 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002561 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002562
2563 if (!error || error == AOP_TRUNCATED_PAGE)
2564 goto retry_find;
2565
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002566 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002567 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002568
2569out_retry:
2570 /*
2571 * We dropped the mmap_sem, we need to return to the fault handler to
2572 * re-find the vma and come back and find our hopefully still populated
2573 * page.
2574 */
2575 if (page)
2576 put_page(page);
2577 if (fpin)
2578 fput(fpin);
2579 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002580}
2581EXPORT_SYMBOL(filemap_fault);
2582
Jan Kara82b0f8c2016-12-14 15:06:58 -08002583void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002584 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002585{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002586 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002587 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002588 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002589 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002590 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002591 struct page *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002592
2593 rcu_read_lock();
Matthew Wilcox070e8072018-05-17 00:08:30 -04002594 xas_for_each(&xas, page, end_pgoff) {
2595 if (xas_retry(&xas, page))
2596 continue;
2597 if (xa_is_value(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002598 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002599
Michal Hockoe0975b22018-12-28 00:38:36 -08002600 /*
2601 * Check for a locked page first, as a speculative
2602 * reference may adversely influence page migration.
2603 */
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002604 if (PageLocked(page))
Michal Hockoe0975b22018-12-28 00:38:36 -08002605 goto next;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002606 if (!page_cache_get_speculative(page))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002607 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002608
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002609 /* Has the page moved or been split? */
Matthew Wilcox070e8072018-05-17 00:08:30 -04002610 if (unlikely(page != xas_reload(&xas)))
2611 goto skip;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002612 page = find_subpage(page, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002613
2614 if (!PageUptodate(page) ||
2615 PageReadahead(page) ||
2616 PageHWPoison(page))
2617 goto skip;
2618 if (!trylock_page(page))
2619 goto skip;
2620
2621 if (page->mapping != mapping || !PageUptodate(page))
2622 goto unlock;
2623
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002624 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2625 if (page->index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002626 goto unlock;
2627
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002628 if (file->f_ra.mmap_miss > 0)
2629 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002630
Matthew Wilcox070e8072018-05-17 00:08:30 -04002631 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002632 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002633 vmf->pte += xas.xa_index - last_pgoff;
2634 last_pgoff = xas.xa_index;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002635 if (alloc_set_pte(vmf, NULL, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002636 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002637 unlock_page(page);
2638 goto next;
2639unlock:
2640 unlock_page(page);
2641skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002642 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002643next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002644 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002645 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002646 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002647 }
2648 rcu_read_unlock();
2649}
2650EXPORT_SYMBOL(filemap_map_pages);
2651
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002652vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002653{
2654 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002655 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002656 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002657
Jan Kara14da9202012-06-12 16:20:37 +02002658 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002659 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002660 lock_page(page);
2661 if (page->mapping != inode->i_mapping) {
2662 unlock_page(page);
2663 ret = VM_FAULT_NOPAGE;
2664 goto out;
2665 }
Jan Kara14da9202012-06-12 16:20:37 +02002666 /*
2667 * We mark the page dirty already here so that when freeze is in
2668 * progress, we are guaranteed that writeback during freezing will
2669 * see the dirty page and writeprotect it again.
2670 */
2671 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002672 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002673out:
Jan Kara14da9202012-06-12 16:20:37 +02002674 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002675 return ret;
2676}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002677
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002678const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002679 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002680 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002681 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682};
2683
2684/* This is used for a general mmap of a disk file */
2685
2686int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2687{
2688 struct address_space *mapping = file->f_mapping;
2689
2690 if (!mapping->a_ops->readpage)
2691 return -ENOEXEC;
2692 file_accessed(file);
2693 vma->vm_ops = &generic_file_vm_ops;
2694 return 0;
2695}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696
2697/*
2698 * This is for filesystems which do not implement ->writepage.
2699 */
2700int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2701{
2702 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2703 return -EINVAL;
2704 return generic_file_mmap(file, vma);
2705}
2706#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002707vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07002708{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002709 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07002710}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002711int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2712{
2713 return -ENOSYS;
2714}
2715int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2716{
2717 return -ENOSYS;
2718}
2719#endif /* CONFIG_MMU */
2720
Arnd Bergmann453972282018-04-13 15:35:27 -07002721EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002722EXPORT_SYMBOL(generic_file_mmap);
2723EXPORT_SYMBOL(generic_file_readonly_mmap);
2724
Sasha Levin67f9fd92014-04-03 14:48:18 -07002725static struct page *wait_on_page_read(struct page *page)
2726{
2727 if (!IS_ERR(page)) {
2728 wait_on_page_locked(page);
2729 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002730 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002731 page = ERR_PTR(-EIO);
2732 }
2733 }
2734 return page;
2735}
2736
Mel Gorman32b63522016-03-15 14:55:36 -07002737static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002738 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002739 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002740 void *data,
2741 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002742{
Nick Piggineb2be182007-10-16 01:24:57 -07002743 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002744 int err;
2745repeat:
2746 page = find_get_page(mapping, index);
2747 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08002748 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002749 if (!page)
2750 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002751 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002752 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002753 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002754 if (err == -EEXIST)
2755 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05002756 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002757 return ERR_PTR(err);
2758 }
Mel Gorman32b63522016-03-15 14:55:36 -07002759
2760filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002761 if (filler)
2762 err = filler(data, page);
2763 else
2764 err = mapping->a_ops->readpage(data, page);
2765
Linus Torvalds1da177e2005-04-16 15:20:36 -07002766 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002767 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002768 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769 }
Mel Gorman32b63522016-03-15 14:55:36 -07002770
2771 page = wait_on_page_read(page);
2772 if (IS_ERR(page))
2773 return page;
2774 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002775 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002776 if (PageUptodate(page))
2777 goto out;
2778
Mel Gormanebded022016-03-15 14:55:39 -07002779 /*
2780 * Page is not up to date and may be locked due one of the following
2781 * case a: Page is being filled and the page lock is held
2782 * case b: Read/write error clearing the page uptodate status
2783 * case c: Truncation in progress (page locked)
2784 * case d: Reclaim in progress
2785 *
2786 * Case a, the page will be up to date when the page is unlocked.
2787 * There is no need to serialise on the page lock here as the page
2788 * is pinned so the lock gives no additional protection. Even if the
2789 * the page is truncated, the data is still valid if PageUptodate as
2790 * it's a race vs truncate race.
2791 * Case b, the page will not be up to date
2792 * Case c, the page may be truncated but in itself, the data may still
2793 * be valid after IO completes as it's a read vs truncate race. The
2794 * operation must restart if the page is not uptodate on unlock but
2795 * otherwise serialising on page lock to stabilise the mapping gives
2796 * no additional guarantees to the caller as the page lock is
2797 * released before return.
2798 * Case d, similar to truncation. If reclaim holds the page lock, it
2799 * will be a race with remove_mapping that determines if the mapping
2800 * is valid on unlock but otherwise the data is valid and there is
2801 * no need to serialise with page lock.
2802 *
2803 * As the page lock gives no additional guarantee, we optimistically
2804 * wait on the page to be unlocked and check if it's up to date and
2805 * use the page if it is. Otherwise, the page lock is required to
2806 * distinguish between the different cases. The motivation is that we
2807 * avoid spurious serialisations and wakeups when multiple processes
2808 * wait on the same page for IO to complete.
2809 */
2810 wait_on_page_locked(page);
2811 if (PageUptodate(page))
2812 goto out;
2813
2814 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002816
2817 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818 if (!page->mapping) {
2819 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002820 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002821 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002822 }
Mel Gormanebded022016-03-15 14:55:39 -07002823
2824 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002825 if (PageUptodate(page)) {
2826 unlock_page(page);
2827 goto out;
2828 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07002829
2830 /*
2831 * A previous I/O error may have been due to temporary
2832 * failures.
2833 * Clear page error before actual read, PG_error will be
2834 * set again if read page fails.
2835 */
2836 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002837 goto filler;
2838
David Howellsc855ff32007-05-09 13:42:20 +01002839out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002840 mark_page_accessed(page);
2841 return page;
2842}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002843
2844/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002845 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002846 * @mapping: the page's address_space
2847 * @index: the page index
2848 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002849 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002850 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002851 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002852 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002853 *
2854 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002855 *
2856 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002857 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002858struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002859 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002860 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002861 void *data)
2862{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07002863 return do_read_cache_page(mapping, index, filler, data,
2864 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002865}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002866EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002867
2868/**
2869 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2870 * @mapping: the page's address_space
2871 * @index: the page index
2872 * @gfp: the page allocator flags to use if allocating
2873 *
2874 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002875 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002876 *
2877 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002878 *
2879 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002880 */
2881struct page *read_cache_page_gfp(struct address_space *mapping,
2882 pgoff_t index,
2883 gfp_t gfp)
2884{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002885 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002886}
2887EXPORT_SYMBOL(read_cache_page_gfp);
2888
Nick Piggin2f718ff2007-10-16 01:24:59 -07002889/*
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002890 * Don't operate on ranges the page cache doesn't support, and don't exceed the
2891 * LFS limits. If pos is under the limit it becomes a short access. If it
2892 * exceeds the limit we return -EFBIG.
2893 */
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002894static int generic_write_check_limits(struct file *file, loff_t pos,
2895 loff_t *count)
2896{
Amir Goldstein646955c2019-06-05 08:04:48 -07002897 struct inode *inode = file->f_mapping->host;
2898 loff_t max_size = inode->i_sb->s_maxbytes;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002899 loff_t limit = rlimit(RLIMIT_FSIZE);
2900
2901 if (limit != RLIM_INFINITY) {
2902 if (pos >= limit) {
2903 send_sig(SIGXFSZ, current, 0);
2904 return -EFBIG;
2905 }
2906 *count = min(*count, limit - pos);
2907 }
2908
Amir Goldstein646955c2019-06-05 08:04:48 -07002909 if (!(file->f_flags & O_LARGEFILE))
2910 max_size = MAX_NON_LFS;
2911
2912 if (unlikely(pos >= max_size))
2913 return -EFBIG;
2914
2915 *count = min(*count, max_size - pos);
2916
2917 return 0;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002918}
2919
2920/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002921 * Performs necessary checks before doing a write
2922 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002923 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002924 * Returns appropriate error code that caller should return or
2925 * zero in case that write should be allowed.
2926 */
Al Viro3309dd02015-04-09 12:55:47 -04002927inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928{
Al Viro3309dd02015-04-09 12:55:47 -04002929 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930 struct inode *inode = file->f_mapping->host;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002931 loff_t count;
2932 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933
Darrick J. Wongdc617f22019-08-20 07:55:16 -07002934 if (IS_SWAPFILE(inode))
2935 return -ETXTBSY;
2936
Al Viro3309dd02015-04-09 12:55:47 -04002937 if (!iov_iter_count(from))
2938 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002939
Al Viro0fa6b002015-04-04 04:05:48 -04002940 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002941 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002942 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002943
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002944 if ((iocb->ki_flags & IOCB_NOWAIT) && !(iocb->ki_flags & IOCB_DIRECT))
2945 return -EINVAL;
2946
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002947 count = iov_iter_count(from);
2948 ret = generic_write_check_limits(file, iocb->ki_pos, &count);
2949 if (ret)
2950 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002951
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002952 iov_iter_truncate(from, count);
Al Viro3309dd02015-04-09 12:55:47 -04002953 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002954}
2955EXPORT_SYMBOL(generic_write_checks);
2956
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002957/*
2958 * Performs necessary checks before doing a clone.
2959 *
Amir Goldstein646955c2019-06-05 08:04:48 -07002960 * Can adjust amount of bytes to clone via @req_count argument.
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002961 * Returns appropriate error code that caller should return or
2962 * zero in case the clone should be allowed.
2963 */
2964int generic_remap_checks(struct file *file_in, loff_t pos_in,
2965 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11002966 loff_t *req_count, unsigned int remap_flags)
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002967{
2968 struct inode *inode_in = file_in->f_mapping->host;
2969 struct inode *inode_out = file_out->f_mapping->host;
2970 uint64_t count = *req_count;
2971 uint64_t bcount;
2972 loff_t size_in, size_out;
2973 loff_t bs = inode_out->i_sb->s_blocksize;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002974 int ret;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002975
2976 /* The start of both ranges must be aligned to an fs block. */
2977 if (!IS_ALIGNED(pos_in, bs) || !IS_ALIGNED(pos_out, bs))
2978 return -EINVAL;
2979
2980 /* Ensure offsets don't wrap. */
2981 if (pos_in + count < pos_in || pos_out + count < pos_out)
2982 return -EINVAL;
2983
2984 size_in = i_size_read(inode_in);
2985 size_out = i_size_read(inode_out);
2986
2987 /* Dedupe requires both ranges to be within EOF. */
Darrick J. Wong3d281932018-10-30 10:41:34 +11002988 if ((remap_flags & REMAP_FILE_DEDUP) &&
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11002989 (pos_in >= size_in || pos_in + count > size_in ||
2990 pos_out >= size_out || pos_out + count > size_out))
2991 return -EINVAL;
2992
2993 /* Ensure the infile range is within the infile. */
2994 if (pos_in >= size_in)
2995 return -EINVAL;
2996 count = min(count, size_in - (uint64_t)pos_in);
2997
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002998 ret = generic_write_check_limits(file_out, pos_out, &count);
2999 if (ret)
3000 return ret;
3001
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003002 /*
3003 * If the user wanted us to link to the infile's EOF, round up to the
3004 * next block boundary for this check.
3005 *
3006 * Otherwise, make sure the count is also block-aligned, having
3007 * already confirmed the starting offsets' block alignment.
3008 */
3009 if (pos_in + count == size_in) {
3010 bcount = ALIGN(size_in, bs) - pos_in;
3011 } else {
3012 if (!IS_ALIGNED(count, bs))
Darrick J. Wongeca36542018-10-30 10:42:10 +11003013 count = ALIGN_DOWN(count, bs);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003014 bcount = count;
3015 }
3016
3017 /* Don't allow overlapped cloning within the same file. */
3018 if (inode_in == inode_out &&
3019 pos_out + bcount > pos_in &&
3020 pos_out < pos_in + bcount)
3021 return -EINVAL;
3022
Darrick J. Wongeca36542018-10-30 10:42:10 +11003023 /*
3024 * We shortened the request but the caller can't deal with that, so
3025 * bounce the request back to userspace.
3026 */
3027 if (*req_count != count && !(remap_flags & REMAP_FILE_CAN_SHORTEN))
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003028 return -EINVAL;
3029
Darrick J. Wongeca36542018-10-30 10:42:10 +11003030 *req_count = count;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003031 return 0;
3032}
3033
Amir Goldsteina3171352019-06-05 08:04:48 -07003034
3035/*
3036 * Performs common checks before doing a file copy/clone
3037 * from @file_in to @file_out.
3038 */
3039int generic_file_rw_checks(struct file *file_in, struct file *file_out)
3040{
3041 struct inode *inode_in = file_inode(file_in);
3042 struct inode *inode_out = file_inode(file_out);
3043
3044 /* Don't copy dirs, pipes, sockets... */
3045 if (S_ISDIR(inode_in->i_mode) || S_ISDIR(inode_out->i_mode))
3046 return -EISDIR;
3047 if (!S_ISREG(inode_in->i_mode) || !S_ISREG(inode_out->i_mode))
3048 return -EINVAL;
3049
3050 if (!(file_in->f_mode & FMODE_READ) ||
3051 !(file_out->f_mode & FMODE_WRITE) ||
3052 (file_out->f_flags & O_APPEND))
3053 return -EBADF;
3054
3055 return 0;
3056}
3057
Amir Goldstein96e6e8f2019-06-05 08:04:49 -07003058/*
3059 * Performs necessary checks before doing a file copy
3060 *
3061 * Can adjust amount of bytes to copy via @req_count argument.
3062 * Returns appropriate error code that caller should return or
3063 * zero in case the copy should be allowed.
3064 */
3065int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3066 struct file *file_out, loff_t pos_out,
3067 size_t *req_count, unsigned int flags)
3068{
3069 struct inode *inode_in = file_inode(file_in);
3070 struct inode *inode_out = file_inode(file_out);
3071 uint64_t count = *req_count;
3072 loff_t size_in;
3073 int ret;
3074
3075 ret = generic_file_rw_checks(file_in, file_out);
3076 if (ret)
3077 return ret;
3078
3079 /* Don't touch certain kinds of inodes */
3080 if (IS_IMMUTABLE(inode_out))
3081 return -EPERM;
3082
3083 if (IS_SWAPFILE(inode_in) || IS_SWAPFILE(inode_out))
3084 return -ETXTBSY;
3085
3086 /* Ensure offsets don't wrap. */
3087 if (pos_in + count < pos_in || pos_out + count < pos_out)
3088 return -EOVERFLOW;
3089
3090 /* Shorten the copy to EOF */
3091 size_in = i_size_read(inode_in);
3092 if (pos_in >= size_in)
3093 count = 0;
3094 else
3095 count = min(count, size_in - (uint64_t)pos_in);
3096
3097 ret = generic_write_check_limits(file_out, pos_out, &count);
3098 if (ret)
3099 return ret;
3100
3101 /* Don't allow overlapped copying within the same file. */
3102 if (inode_in == inode_out &&
3103 pos_out + count > pos_in &&
3104 pos_out < pos_in + count)
3105 return -EINVAL;
3106
3107 *req_count = count;
3108 return 0;
3109}
3110
Nick Pigginafddba42007-10-16 01:25:01 -07003111int pagecache_write_begin(struct file *file, struct address_space *mapping,
3112 loff_t pos, unsigned len, unsigned flags,
3113 struct page **pagep, void **fsdata)
3114{
3115 const struct address_space_operations *aops = mapping->a_ops;
3116
Nick Piggin4e02ed42008-10-29 14:00:55 -07003117 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003118 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003119}
3120EXPORT_SYMBOL(pagecache_write_begin);
3121
3122int pagecache_write_end(struct file *file, struct address_space *mapping,
3123 loff_t pos, unsigned len, unsigned copied,
3124 struct page *page, void *fsdata)
3125{
3126 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003127
Nick Piggin4e02ed42008-10-29 14:00:55 -07003128 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003129}
3130EXPORT_SYMBOL(pagecache_write_end);
3131
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003132/*
3133 * Warn about a page cache invalidation failure during a direct I/O write.
3134 */
3135void dio_warn_stale_pagecache(struct file *filp)
3136{
3137 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3138 char pathname[128];
3139 struct inode *inode = file_inode(filp);
3140 char *path;
3141
3142 errseq_set(&inode->i_mapping->wb_err, -EIO);
3143 if (__ratelimit(&_rs)) {
3144 path = file_path(filp, pathname, sizeof(pathname));
3145 if (IS_ERR(path))
3146 path = "(unknown)";
3147 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3148 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3149 current->comm);
3150 }
3151}
3152
Linus Torvalds1da177e2005-04-16 15:20:36 -07003153ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003154generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003155{
3156 struct file *file = iocb->ki_filp;
3157 struct address_space *mapping = file->f_mapping;
3158 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003159 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003160 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003161 size_t write_len;
3162 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003163
Al Viro0c949332014-03-22 06:51:37 -04003164 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003165 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003166
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003167 if (iocb->ki_flags & IOCB_NOWAIT) {
3168 /* If there are pages to writeback, return */
3169 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003170 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003171 return -EAGAIN;
3172 } else {
3173 written = filemap_write_and_wait_range(mapping, pos,
3174 pos + write_len - 1);
3175 if (written)
3176 goto out;
3177 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003178
3179 /*
3180 * After a write we want buffered reads to be sure to go to disk to get
3181 * the new data. We invalidate clean cached page from the region we're
3182 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003183 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003184 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003185 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003186 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003187 /*
3188 * If a page can not be invalidated, return 0 to fall back
3189 * to buffered write.
3190 */
3191 if (written) {
3192 if (written == -EBUSY)
3193 return 0;
3194 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003195 }
3196
Al Viro639a93a52017-04-13 14:10:15 -04003197 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003198
3199 /*
3200 * Finally, try again to invalidate clean pages which might have been
3201 * cached by non-direct readahead, or faulted in by get_user_pages()
3202 * if the source of the write was an mmap'ed region of the file
3203 * we're writing. Either one is a pretty crazy thing to do,
3204 * so we don't support it 100%. If this invalidation
3205 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003206 *
3207 * Most of the time we do not need this since dio_complete() will do
3208 * the invalidation for us. However there are some file systems that
3209 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003210 * them by removing it completely.
3211 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003212 * Noticeable example is a blkdev_direct_IO().
3213 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003214 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003215 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003216 if (written > 0 && mapping->nrpages &&
3217 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3218 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003219
Linus Torvalds1da177e2005-04-16 15:20:36 -07003220 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003221 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003222 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003223 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3224 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003225 mark_inode_dirty(inode);
3226 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003227 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003228 }
Al Viro639a93a52017-04-13 14:10:15 -04003229 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003230out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003231 return written;
3232}
3233EXPORT_SYMBOL(generic_file_direct_write);
3234
Nick Piggineb2be182007-10-16 01:24:57 -07003235/*
3236 * Find or create a page at the given pagecache position. Return the locked
3237 * page. This function is specifically for buffered writes.
3238 */
Nick Piggin54566b22009-01-04 12:00:53 -08003239struct page *grab_cache_page_write_begin(struct address_space *mapping,
3240 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003241{
Nick Piggineb2be182007-10-16 01:24:57 -07003242 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003243 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003244
Nick Piggin54566b22009-01-04 12:00:53 -08003245 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003246 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003247
Mel Gorman2457aec2014-06-04 16:10:31 -07003248 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003249 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003250 if (page)
3251 wait_for_stable_page(page);
3252
Nick Piggineb2be182007-10-16 01:24:57 -07003253 return page;
3254}
Nick Piggin54566b22009-01-04 12:00:53 -08003255EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003256
Al Viro3b93f912014-02-11 21:34:08 -05003257ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003258 struct iov_iter *i, loff_t pos)
3259{
3260 struct address_space *mapping = file->f_mapping;
3261 const struct address_space_operations *a_ops = mapping->a_ops;
3262 long status = 0;
3263 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003264 unsigned int flags = 0;
3265
Nick Pigginafddba42007-10-16 01:25:01 -07003266 do {
3267 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003268 unsigned long offset; /* Offset into pagecache page */
3269 unsigned long bytes; /* Bytes to write to page */
3270 size_t copied; /* Bytes copied from user */
3271 void *fsdata;
3272
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003273 offset = (pos & (PAGE_SIZE - 1));
3274 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003275 iov_iter_count(i));
3276
3277again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003278 /*
3279 * Bring in the user page that we will copy from _first_.
3280 * Otherwise there's a nasty deadlock on copying from the
3281 * same page as we're writing to, without it being marked
3282 * up-to-date.
3283 *
3284 * Not only is this an optimisation, but it is also required
3285 * to check that the address is actually valid, when atomic
3286 * usercopies are used, below.
3287 */
3288 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3289 status = -EFAULT;
3290 break;
3291 }
3292
Jan Kara296291c2015-10-22 13:32:21 -07003293 if (fatal_signal_pending(current)) {
3294 status = -EINTR;
3295 break;
3296 }
3297
Nick Piggin674b8922007-10-16 01:25:03 -07003298 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003299 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003300 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003301 break;
3302
anfei zhou931e80e2010-02-02 13:44:02 -08003303 if (mapping_writably_mapped(mapping))
3304 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003305
Nick Pigginafddba42007-10-16 01:25:01 -07003306 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003307 flush_dcache_page(page);
3308
3309 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3310 page, fsdata);
3311 if (unlikely(status < 0))
3312 break;
3313 copied = status;
3314
3315 cond_resched();
3316
Nick Piggin124d3b72008-02-02 15:01:17 +01003317 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003318 if (unlikely(copied == 0)) {
3319 /*
3320 * If we were unable to copy any data at all, we must
3321 * fall back to a single segment length write.
3322 *
3323 * If we didn't fallback here, we could livelock
3324 * because not all segments in the iov can be copied at
3325 * once without a pagefault.
3326 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003327 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003328 iov_iter_single_seg_count(i));
3329 goto again;
3330 }
Nick Pigginafddba42007-10-16 01:25:01 -07003331 pos += copied;
3332 written += copied;
3333
3334 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003335 } while (iov_iter_count(i));
3336
3337 return written ? written : status;
3338}
Al Viro3b93f912014-02-11 21:34:08 -05003339EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003340
Jan Karae4dd9de2009-08-17 18:10:06 +02003341/**
Al Viro81742022014-04-03 03:17:43 -04003342 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003343 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003344 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003345 *
3346 * This function does all the work needed for actually writing data to a
3347 * file. It does all basic checks, removes SUID from the file, updates
3348 * modification times and calls proper subroutines depending on whether we
3349 * do direct IO or a standard buffered write.
3350 *
3351 * It expects i_mutex to be grabbed unless we work on a block device or similar
3352 * object which does not need locking at all.
3353 *
3354 * This function does *not* take care of syncing data in case of O_SYNC write.
3355 * A caller has to handle it. This is mainly due to the fact that we want to
3356 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003357 *
3358 * Return:
3359 * * number of bytes written, even for truncated writes
3360 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003361 */
Al Viro81742022014-04-03 03:17:43 -04003362ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003363{
3364 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003365 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003366 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003367 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003368 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003369 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003370
Linus Torvalds1da177e2005-04-16 15:20:36 -07003371 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003372 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003373 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003374 if (err)
3375 goto out;
3376
Josef Bacikc3b2da32012-03-26 09:59:21 -04003377 err = file_update_time(file);
3378 if (err)
3379 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003380
Al Viro2ba48ce2015-04-09 13:52:01 -04003381 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003382 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003383
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003384 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003385 /*
3386 * If the write stopped short of completing, fall back to
3387 * buffered writes. Some filesystems do this for writes to
3388 * holes, for example. For DAX files, a buffered write will
3389 * not succeed (even if it did, DAX does not handle dirty
3390 * page-cache pages correctly).
3391 */
Al Viro0b8def92015-04-07 10:22:53 -04003392 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003393 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003394
Al Viro0b8def92015-04-07 10:22:53 -04003395 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003396 /*
Al Viro3b93f912014-02-11 21:34:08 -05003397 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003398 * then we want to return the number of bytes which were
3399 * direct-written, or the error code if that was zero. Note
3400 * that this differs from normal direct-io semantics, which
3401 * will return -EFOO even if some bytes were written.
3402 */
Al Viro60bb4522014-08-08 12:39:16 -04003403 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003404 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003405 goto out;
3406 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003407 /*
3408 * We need to ensure that the page cache pages are written to
3409 * disk and invalidated to preserve the expected O_DIRECT
3410 * semantics.
3411 */
Al Viro3b93f912014-02-11 21:34:08 -05003412 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003413 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003414 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003415 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003416 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003417 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003418 pos >> PAGE_SHIFT,
3419 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003420 } else {
3421 /*
3422 * We don't know how much we wrote, so just return
3423 * the number of bytes which were direct-written
3424 */
3425 }
3426 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003427 written = generic_perform_write(file, from, iocb->ki_pos);
3428 if (likely(written > 0))
3429 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003430 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003431out:
3432 current->backing_dev_info = NULL;
3433 return written ? written : err;
3434}
Al Viro81742022014-04-03 03:17:43 -04003435EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003436
Jan Karae4dd9de2009-08-17 18:10:06 +02003437/**
Al Viro81742022014-04-03 03:17:43 -04003438 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003439 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003440 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003441 *
Al Viro81742022014-04-03 03:17:43 -04003442 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003443 * filesystems. It takes care of syncing the file in case of O_SYNC file
3444 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003445 * Return:
3446 * * negative error code if no data has been written at all of
3447 * vfs_fsync_range() failed for a synchronous write
3448 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003449 */
Al Viro81742022014-04-03 03:17:43 -04003450ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451{
3452 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003453 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003454 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003455
Al Viro59551022016-01-22 15:40:57 -05003456 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003457 ret = generic_write_checks(iocb, from);
3458 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003459 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003460 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003461
Christoph Hellwige2592212016-04-07 08:52:01 -07003462 if (ret > 0)
3463 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003464 return ret;
3465}
Al Viro81742022014-04-03 03:17:43 -04003466EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467
David Howellscf9a2ae2006-08-29 19:05:54 +01003468/**
3469 * try_to_release_page() - release old fs-specific metadata on a page
3470 *
3471 * @page: the page which the kernel is trying to free
3472 * @gfp_mask: memory allocation flags (and I/O mode)
3473 *
3474 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003475 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003476 *
David Howells266cf652009-04-03 16:42:36 +01003477 * This may also be called if PG_fscache is set on a page, indicating that the
3478 * page is known to the local caching routines.
3479 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003480 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003481 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003482 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003483 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003484 */
3485int try_to_release_page(struct page *page, gfp_t gfp_mask)
3486{
3487 struct address_space * const mapping = page->mapping;
3488
3489 BUG_ON(!PageLocked(page));
3490 if (PageWriteback(page))
3491 return 0;
3492
3493 if (mapping && mapping->a_ops->releasepage)
3494 return mapping->a_ops->releasepage(page, gfp_mask);
3495 return try_to_free_buffers(page);
3496}
3497
3498EXPORT_SYMBOL(try_to_release_page);