blob: 4c8e64d104bda524c94aadc8a93d2788d323dc95 [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8/*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080015#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/fs.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010017#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070018#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080019#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mm.h>
23#include <linux/swap.h>
24#include <linux/mman.h>
25#include <linux/pagemap.h>
26#include <linux/file.h>
27#include <linux/uio.h>
Josef Bacikcfcbfb12019-05-13 17:21:04 -070028#include <linux/error-injection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/hash.h>
30#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070031#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080035#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070036#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080037#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060038#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080039#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070040#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070041#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070042#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070043#include <linux/ramfs.h>
Yang Shib9306a72020-08-06 23:19:55 -070044#include <linux/page_idle.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080045#include "internal.h"
46
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070047#define CREATE_TRACE_POINTS
48#include <trace/events/filemap.h>
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 * FIXME: remove all knowledge of the buffer layer from the core VM
52 */
Jan Kara148f9482009-08-17 19:52:36 +020053#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <asm/mman.h>
56
57/*
58 * Shared mappings implemented 30.11.1994. It's not fully working yet,
59 * though.
60 *
61 * Shared mappings now work. 15.8.1995 Bruno.
62 *
63 * finished 'unifying' the page and buffer cache and SMP-threaded the
64 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
65 *
66 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
67 */
68
69/*
70 * Lock ordering:
71 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080072 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070074 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070075 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080077 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080078 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070080 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080081 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070082 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070083 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070085 * ->mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 * ->lock_page (access_process_vm)
87 *
Al Viroccad2362014-02-11 22:36:48 -050088 * ->i_mutex (generic_perform_write)
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070089 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060091 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110092 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070093 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080095 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * ->anon_vma.lock (vma_adjust)
97 *
98 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070099 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700101 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700102 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700104 * ->i_pages lock (try_to_unmap_one)
Andrey Ryabininf4b7e272019-03-05 15:49:39 -0800105 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
106 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700108 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600109 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100110 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700111 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600112 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100113 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
115 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800116 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700117 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118 */
119
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500120static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700121 struct page *page, void *shadow)
122{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500123 XA_STATE(xas, &mapping->i_pages, page->index);
124 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800125
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500126 mapping_set_update(&xas, mapping);
127
128 /* hugetlb pages are represented by a single entry in the xarray */
129 if (!PageHuge(page)) {
130 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700131 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500132 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700133
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700134 VM_BUG_ON_PAGE(!PageLocked(page), page);
135 VM_BUG_ON_PAGE(PageTail(page), page);
136 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700137
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500138 xas_store(&xas, shadow);
139 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200140
Jan Kara23006382017-11-15 17:37:26 -0800141 page->mapping = NULL;
142 /* Leave page->index set: truncation lookup relies upon it */
143
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200144 if (shadow) {
145 mapping->nrexceptional += nr;
146 /*
147 * Make sure the nrexceptional update is committed before
148 * the nrpages update so that final truncate racing
149 * with reclaim does not see both counters 0 at the
150 * same time and miss a shadow entry.
151 */
152 smp_wmb();
153 }
154 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700155}
156
Jan Kara5ecc4d82017-11-15 17:37:29 -0800157static void unaccount_page_cache_page(struct address_space *mapping,
158 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800160 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600162 /*
163 * if we're uptodate, flush out into the cleancache, otherwise
164 * invalidate any existing cleancache entries. We can't leave
165 * stale data around in the cleancache once our page is gone
166 */
167 if (PageUptodate(page) && PageMappedToDisk(page))
168 cleancache_put_page(page);
169 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400170 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600171
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700172 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800173 VM_BUG_ON_PAGE(page_mapped(page), page);
174 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
175 int mapcount;
176
177 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
178 current->comm, page_to_pfn(page));
179 dump_page(page, "still mapped when deleted");
180 dump_stack();
181 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
182
183 mapcount = page_mapcount(page);
184 if (mapping_exiting(mapping) &&
185 page_count(page) >= mapcount + 2) {
186 /*
187 * All vmas have already been torn down, so it's
188 * a good bet that actually the page is unmapped,
189 * and we'd prefer not to leak it: if we're wrong,
190 * some other bad page check should catch it later.
191 */
192 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700193 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800194 }
195 }
196
Jan Kara76253fb2017-11-15 17:37:22 -0800197 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800198 if (PageHuge(page))
199 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800200
Jan Kara5ecc4d82017-11-15 17:37:29 -0800201 nr = hpage_nr_pages(page);
202
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700203 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800204 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700205 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800206 if (PageTransHuge(page))
207 __dec_node_page_state(page, NR_SHMEM_THPS);
Song Liu99cb0db2019-09-23 15:38:00 -0700208 } else if (PageTransHuge(page)) {
209 __dec_node_page_state(page, NR_FILE_THPS);
Song Liu09d91cd2019-09-23 15:38:03 -0700210 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800211 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800212
213 /*
214 * At this point page must be either written or cleaned by
215 * truncate. Dirty page here signals a bug and loss of
216 * unwritten data.
217 *
218 * This fixes dirty accounting after removing the page entirely
219 * but leaves PageDirty set: it has no effect for truncated
220 * page and anyway will be cleared before returning page into
221 * buddy allocator.
222 */
223 if (WARN_ON_ONCE(PageDirty(page)))
224 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
225}
226
227/*
228 * Delete a page from the page cache and free it. Caller has to make
229 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700230 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800231 */
232void __delete_from_page_cache(struct page *page, void *shadow)
233{
234 struct address_space *mapping = page->mapping;
235
236 trace_mm_filemap_delete_from_page_cache(page);
237
238 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500239 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240}
241
Jan Kara59c66c52017-11-15 17:37:18 -0800242static void page_cache_free_page(struct address_space *mapping,
243 struct page *page)
244{
245 void (*freepage)(struct page *);
246
247 freepage = mapping->a_ops->freepage;
248 if (freepage)
249 freepage(page);
250
251 if (PageTransHuge(page) && !PageHuge(page)) {
252 page_ref_sub(page, HPAGE_PMD_NR);
253 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
254 } else {
255 put_page(page);
256 }
257}
258
Minchan Kim702cfbf2011-03-22 16:32:43 -0700259/**
260 * delete_from_page_cache - delete page from page cache
261 * @page: the page which the kernel is trying to remove from page cache
262 *
263 * This must be called only on pages that have been verified to be in the page
264 * cache and locked. It will never put the page into the free list, the caller
265 * has a reference on the page.
266 */
267void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700269 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400270 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Matt Mackallcd7619d2005-05-01 08:59:01 -0700272 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700273 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700274 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700275 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500276
Jan Kara59c66c52017-11-15 17:37:18 -0800277 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700278}
279EXPORT_SYMBOL(delete_from_page_cache);
280
Jan Karaaa65c292017-11-15 17:37:33 -0800281/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500282 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800283 * @mapping: the mapping to which pages belong
284 * @pvec: pagevec with pages to delete
285 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700286 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700287 * from the mapping. The function expects @pvec to be sorted by page index
288 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700289 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800290 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700291 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800292 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700293 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800294 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500295static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800296 struct pagevec *pvec)
297{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500298 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800299 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700300 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800301 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800302
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500303 mapping_set_update(&xas, mapping);
304 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700305 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800306 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700307
308 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400309 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800310 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700311 /*
312 * A page got inserted in our range? Skip it. We have our
313 * pages locked so they are protected from being removed.
314 * If we see a page whose index is higher than ours, it
315 * means our page has been removed, which shouldn't be
316 * possible because we're holding the PageLock.
317 */
318 if (page != pvec->pages[i]) {
319 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
320 page);
321 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700322 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700323
324 WARN_ON_ONCE(!PageLocked(page));
325
326 if (page->index == xas.xa_index)
327 page->mapping = NULL;
328 /* Leave page->index set: truncation lookup relies on it */
329
330 /*
331 * Move to the next page in the vector if this is a regular
332 * page or the index is of the last sub-page of this compound
333 * page.
334 */
335 if (page->index + compound_nr(page) - 1 == xas.xa_index)
336 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500337 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800338 total_pages++;
339 }
340 mapping->nrpages -= total_pages;
341}
342
343void delete_from_page_cache_batch(struct address_space *mapping,
344 struct pagevec *pvec)
345{
346 int i;
347 unsigned long flags;
348
349 if (!pagevec_count(pvec))
350 return;
351
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700352 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800353 for (i = 0; i < pagevec_count(pvec); i++) {
354 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
355
356 unaccount_page_cache_page(mapping, pvec->pages[i]);
357 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500358 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700359 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800360
361 for (i = 0; i < pagevec_count(pvec); i++)
362 page_cache_free_page(mapping, pvec->pages[i]);
363}
364
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200365int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700366{
367 int ret = 0;
368 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700369 if (test_bit(AS_ENOSPC, &mapping->flags) &&
370 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700371 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700372 if (test_bit(AS_EIO, &mapping->flags) &&
373 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700374 ret = -EIO;
375 return ret;
376}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200377EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700378
Jeff Layton76341ca2017-07-06 07:02:22 -0400379static int filemap_check_and_keep_errors(struct address_space *mapping)
380{
381 /* Check for outstanding write errors */
382 if (test_bit(AS_EIO, &mapping->flags))
383 return -EIO;
384 if (test_bit(AS_ENOSPC, &mapping->flags))
385 return -ENOSPC;
386 return 0;
387}
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700390 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700391 * @mapping: address space structure to write
392 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800393 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700394 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700396 * Start writeback against all of a mapping's dirty pages that lie
397 * within the byte offsets <start, end> inclusive.
398 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700400 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 * these two operations is that if a dirty page/buffer is encountered, it must
402 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800403 *
404 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800406int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
407 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408{
409 int ret;
410 struct writeback_control wbc = {
411 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800412 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700413 .range_start = start,
414 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 };
416
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700417 if (!mapping_cap_writeback_dirty(mapping) ||
418 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 return 0;
420
Tejun Heob16b1de2015-06-02 08:39:48 -0600421 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600423 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 return ret;
425}
426
427static inline int __filemap_fdatawrite(struct address_space *mapping,
428 int sync_mode)
429{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700430 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
432
433int filemap_fdatawrite(struct address_space *mapping)
434{
435 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
436}
437EXPORT_SYMBOL(filemap_fdatawrite);
438
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400439int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800440 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441{
442 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
443}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400444EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445
Randy Dunlap485bb992006-06-23 02:03:49 -0700446/**
447 * filemap_flush - mostly a non-blocking flush
448 * @mapping: target address_space
449 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 * This is a mostly non-blocking flush. Not suitable for data-integrity
451 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800452 *
453 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 */
455int filemap_flush(struct address_space *mapping)
456{
457 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
458}
459EXPORT_SYMBOL(filemap_flush);
460
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500461/**
462 * filemap_range_has_page - check if a page exists in range.
463 * @mapping: address space within which to check
464 * @start_byte: offset in bytes where the range starts
465 * @end_byte: offset in bytes where the range ends (inclusive)
466 *
467 * Find at least one page in the range supplied, usually used to check if
468 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800469 *
470 * Return: %true if at least one page exists in the specified range,
471 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500472 */
473bool filemap_range_has_page(struct address_space *mapping,
474 loff_t start_byte, loff_t end_byte)
475{
Jan Karaf7b68042017-09-06 16:21:40 -0700476 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500477 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
478 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500479
480 if (end_byte < start_byte)
481 return false;
482
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500483 rcu_read_lock();
484 for (;;) {
485 page = xas_find(&xas, max);
486 if (xas_retry(&xas, page))
487 continue;
488 /* Shadow entries don't count */
489 if (xa_is_value(page))
490 continue;
491 /*
492 * We don't need to try to pin this page; we're about to
493 * release the RCU lock anyway. It is enough to know that
494 * there was a page here recently.
495 */
496 break;
497 }
498 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500499
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500500 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500501}
502EXPORT_SYMBOL(filemap_range_has_page);
503
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400504static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800505 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300507 pgoff_t index = start_byte >> PAGE_SHIFT;
508 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 struct pagevec pvec;
510 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200512 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400513 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Mel Gorman86679822017-11-15 17:37:52 -0800515 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800516 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 unsigned i;
518
Jan Kara312e9d22017-11-15 17:35:05 -0800519 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800520 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800521 if (!nr_pages)
522 break;
523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 for (i = 0; i < nr_pages; i++) {
525 struct page *page = pvec.pages[i];
526
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400528 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 }
530 pagevec_release(&pvec);
531 cond_resched();
532 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800533}
534
535/**
536 * filemap_fdatawait_range - wait for writeback to complete
537 * @mapping: address space structure to wait for
538 * @start_byte: offset in bytes where the range starts
539 * @end_byte: offset in bytes where the range ends (inclusive)
540 *
541 * Walk the list of under-writeback pages of the given address space
542 * in the given range and wait for all of them. Check error status of
543 * the address space and return it.
544 *
545 * Since the error status of the address space is cleared by this function,
546 * callers are responsible for checking the return value and handling and/or
547 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800548 *
549 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800550 */
551int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
552 loff_t end_byte)
553{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400554 __filemap_fdatawait_range(mapping, start_byte, end_byte);
555 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200557EXPORT_SYMBOL(filemap_fdatawait_range);
558
559/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400560 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
561 * @mapping: address space structure to wait for
562 * @start_byte: offset in bytes where the range starts
563 * @end_byte: offset in bytes where the range ends (inclusive)
564 *
565 * Walk the list of under-writeback pages of the given address space in the
566 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
567 * this function does not clear error status of the address space.
568 *
569 * Use this function if callers don't handle errors themselves. Expected
570 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
571 * fsfreeze(8)
572 */
573int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
574 loff_t start_byte, loff_t end_byte)
575{
576 __filemap_fdatawait_range(mapping, start_byte, end_byte);
577 return filemap_check_and_keep_errors(mapping);
578}
579EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
580
581/**
Jeff Laytona823e452017-07-28 07:24:43 -0400582 * file_fdatawait_range - wait for writeback to complete
583 * @file: file pointing to address space structure to wait for
584 * @start_byte: offset in bytes where the range starts
585 * @end_byte: offset in bytes where the range ends (inclusive)
586 *
587 * Walk the list of under-writeback pages of the address space that file
588 * refers to, in the given range and wait for all of them. Check error
589 * status of the address space vs. the file->f_wb_err cursor and return it.
590 *
591 * Since the error status of the file is advanced by this function,
592 * callers are responsible for checking the return value and handling and/or
593 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800594 *
595 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400596 */
597int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
598{
599 struct address_space *mapping = file->f_mapping;
600
601 __filemap_fdatawait_range(mapping, start_byte, end_byte);
602 return file_check_and_advance_wb_err(file);
603}
604EXPORT_SYMBOL(file_fdatawait_range);
605
606/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800607 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
608 * @mapping: address space structure to wait for
609 *
610 * Walk the list of under-writeback pages of the given address space
611 * and wait for all of them. Unlike filemap_fdatawait(), this function
612 * does not clear error status of the address space.
613 *
614 * Use this function if callers don't handle errors themselves. Expected
615 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
616 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800617 *
618 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800619 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400620int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800621{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400622 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400623 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800624}
Jeff Layton76341ca2017-07-06 07:02:22 -0400625EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800626
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700627/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400628static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700630 if (dax_mapping(mapping))
631 return mapping->nrexceptional;
632
633 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
Randy Dunlap485bb992006-06-23 02:03:49 -0700636/**
637 * filemap_write_and_wait_range - write out & wait on a file range
638 * @mapping: the address_space for the pages
639 * @lstart: offset in bytes where the range starts
640 * @lend: offset in bytes where the range ends (inclusive)
641 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800642 * Write out and wait upon file offsets lstart->lend, inclusive.
643 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300644 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800645 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800646 *
647 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800648 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649int filemap_write_and_wait_range(struct address_space *mapping,
650 loff_t lstart, loff_t lend)
651{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800652 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
Jeff Layton9326c9b2017-07-26 10:21:11 -0400654 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800655 err = __filemap_fdatawrite_range(mapping, lstart, lend,
656 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800657 /*
658 * Even if the above returned error, the pages may be
659 * written partially (e.g. -ENOSPC), so we wait for it.
660 * But the -EIO is special case, it may indicate the worst
661 * thing (e.g. bug) happened, so we avoid waiting for it.
662 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800663 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200664 int err2 = filemap_fdatawait_range(mapping,
665 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800666 if (!err)
667 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400668 } else {
669 /* Clear any previously stored errors */
670 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800671 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700672 } else {
673 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800675 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
Chris Masonf6995582009-04-15 13:22:37 -0400677EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
Jeff Layton5660e132017-07-06 07:02:25 -0400679void __filemap_set_wb_err(struct address_space *mapping, int err)
680{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400681 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400682
683 trace_filemap_set_wb_err(mapping, eseq);
684}
685EXPORT_SYMBOL(__filemap_set_wb_err);
686
687/**
688 * file_check_and_advance_wb_err - report wb error (if any) that was previously
689 * and advance wb_err to current one
690 * @file: struct file on which the error is being reported
691 *
692 * When userland calls fsync (or something like nfsd does the equivalent), we
693 * want to report any writeback errors that occurred since the last fsync (or
694 * since the file was opened if there haven't been any).
695 *
696 * Grab the wb_err from the mapping. If it matches what we have in the file,
697 * then just quickly return 0. The file is all caught up.
698 *
699 * If it doesn't match, then take the mapping value, set the "seen" flag in
700 * it and try to swap it into place. If it works, or another task beat us
701 * to it with the new value, then update the f_wb_err and return the error
702 * portion. The error at this point must be reported via proper channels
703 * (a'la fsync, or NFS COMMIT operation, etc.).
704 *
705 * While we handle mapping->wb_err with atomic operations, the f_wb_err
706 * value is protected by the f_lock since we must ensure that it reflects
707 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800708 *
709 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400710 */
711int file_check_and_advance_wb_err(struct file *file)
712{
713 int err = 0;
714 errseq_t old = READ_ONCE(file->f_wb_err);
715 struct address_space *mapping = file->f_mapping;
716
717 /* Locklessly handle the common case where nothing has changed */
718 if (errseq_check(&mapping->wb_err, old)) {
719 /* Something changed, must use slow path */
720 spin_lock(&file->f_lock);
721 old = file->f_wb_err;
722 err = errseq_check_and_advance(&mapping->wb_err,
723 &file->f_wb_err);
724 trace_file_check_and_advance_wb_err(file, old);
725 spin_unlock(&file->f_lock);
726 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700727
728 /*
729 * We're mostly using this function as a drop in replacement for
730 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
731 * that the legacy code would have had on these flags.
732 */
733 clear_bit(AS_EIO, &mapping->flags);
734 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400735 return err;
736}
737EXPORT_SYMBOL(file_check_and_advance_wb_err);
738
739/**
740 * file_write_and_wait_range - write out & wait on a file range
741 * @file: file pointing to address_space with pages
742 * @lstart: offset in bytes where the range starts
743 * @lend: offset in bytes where the range ends (inclusive)
744 *
745 * Write out and wait upon file offsets lstart->lend, inclusive.
746 *
747 * Note that @lend is inclusive (describes the last byte to be written) so
748 * that this function can be used to write to the very end-of-file (end = -1).
749 *
750 * After writing out and waiting on the data, we check and advance the
751 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800752 *
753 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400754 */
755int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
756{
757 int err = 0, err2;
758 struct address_space *mapping = file->f_mapping;
759
Jeff Layton9326c9b2017-07-26 10:21:11 -0400760 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400761 err = __filemap_fdatawrite_range(mapping, lstart, lend,
762 WB_SYNC_ALL);
763 /* See comment of filemap_write_and_wait() */
764 if (err != -EIO)
765 __filemap_fdatawait_range(mapping, lstart, lend);
766 }
767 err2 = file_check_and_advance_wb_err(file);
768 if (!err)
769 err = err2;
770 return err;
771}
772EXPORT_SYMBOL(file_write_and_wait_range);
773
Randy Dunlap485bb992006-06-23 02:03:49 -0700774/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700775 * replace_page_cache_page - replace a pagecache page with a new one
776 * @old: page to be replaced
777 * @new: page to replace with
778 * @gfp_mask: allocation mode
779 *
780 * This function replaces a page in the pagecache with a new one. On
781 * success it acquires the pagecache reference for the new page and
782 * drops it for the old page. Both the old and new pages must be
783 * locked. This function does not add the new page to the LRU, the
784 * caller must do that.
785 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500786 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800787 *
788 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700789 */
790int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
791{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500792 struct address_space *mapping = old->mapping;
793 void (*freepage)(struct page *) = mapping->a_ops->freepage;
794 pgoff_t offset = old->index;
795 XA_STATE(xas, &mapping->i_pages, offset);
796 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700797
Sasha Levin309381fea2014-01-23 15:52:54 -0800798 VM_BUG_ON_PAGE(!PageLocked(old), old);
799 VM_BUG_ON_PAGE(!PageLocked(new), new);
800 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700801
Matthew Wilcox74d60952017-11-17 10:01:45 -0500802 get_page(new);
803 new->mapping = mapping;
804 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700805
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700806 mem_cgroup_migrate(old, new);
807
Matthew Wilcox74d60952017-11-17 10:01:45 -0500808 xas_lock_irqsave(&xas, flags);
809 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700810
Matthew Wilcox74d60952017-11-17 10:01:45 -0500811 old->mapping = NULL;
812 /* hugetlb pages do not participate in page cache accounting. */
813 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700814 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500815 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700816 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500817 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700818 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500819 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700820 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500821 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500822 if (freepage)
823 freepage(old);
824 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700825
Matthew Wilcox74d60952017-11-17 10:01:45 -0500826 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700827}
828EXPORT_SYMBOL_GPL(replace_page_cache_page);
829
Johannes Weinera5289102014-04-03 14:47:51 -0700830static int __add_to_page_cache_locked(struct page *page,
831 struct address_space *mapping,
832 pgoff_t offset, gfp_t gfp_mask,
833 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500835 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700836 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700837 int error;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500838 void *old;
Nick Piggine2867812008-07-25 19:45:30 -0700839
Sasha Levin309381fea2014-01-23 15:52:54 -0800840 VM_BUG_ON_PAGE(!PageLocked(page), page);
841 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500842 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700843
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300844 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700845 page->mapping = mapping;
846 page->index = offset;
847
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700848 if (!huge) {
Johannes Weinerd9eb1ea2020-06-03 16:02:24 -0700849 error = mem_cgroup_charge(page, current->mm, gfp_mask);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700850 if (error)
851 goto error;
852 }
853
Matthew Wilcox74d60952017-11-17 10:01:45 -0500854 do {
855 xas_lock_irq(&xas);
856 old = xas_load(&xas);
857 if (old && !xa_is_value(old))
858 xas_set_err(&xas, -EEXIST);
859 xas_store(&xas, page);
860 if (xas_error(&xas))
861 goto unlock;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700862
Matthew Wilcox74d60952017-11-17 10:01:45 -0500863 if (xa_is_value(old)) {
864 mapping->nrexceptional--;
865 if (shadowp)
866 *shadowp = old;
867 }
868 mapping->nrpages++;
869
870 /* hugetlb pages do not participate in page cache accounting */
871 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700872 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500873unlock:
874 xas_unlock_irq(&xas);
875 } while (xas_nomem(&xas, gfp_mask & GFP_RECLAIM_MASK));
876
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700877 if (xas_error(&xas)) {
878 error = xas_error(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500879 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700880 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500881
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700882 trace_mm_filemap_add_to_page_cache(page);
883 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500884error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700885 page->mapping = NULL;
886 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300887 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700888 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700890ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700891
892/**
893 * add_to_page_cache_locked - add a locked page to the pagecache
894 * @page: page to add
895 * @mapping: the page's address_space
896 * @offset: page index
897 * @gfp_mask: page allocation mode
898 *
899 * This function is used to add a page to the pagecache. It must be locked.
900 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800901 *
902 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700903 */
904int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
905 pgoff_t offset, gfp_t gfp_mask)
906{
907 return __add_to_page_cache_locked(page, mapping, offset,
908 gfp_mask, NULL);
909}
Nick Piggine2867812008-07-25 19:45:30 -0700910EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700911
912int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400913 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914{
Johannes Weinera5289102014-04-03 14:47:51 -0700915 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700916 int ret;
917
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800918 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700919 ret = __add_to_page_cache_locked(page, mapping, offset,
920 gfp_mask, &shadow);
921 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800922 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700923 else {
924 /*
925 * The page might have been evicted from cache only
926 * recently, in which case it should be activated like
927 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700928 * The exception is pages getting rewritten; evicting other
929 * data from the working set, only to cache data that will
930 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700931 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700932 WARN_ON_ONCE(PageActive(page));
933 if (!(gfp_mask & __GFP_WRITE) && shadow)
934 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700935 lru_cache_add(page);
936 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 return ret;
938}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300939EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Paul Jackson44110fe2006-03-24 03:16:04 -0800941#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700942struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800943{
Miao Xiec0ff7452010-05-24 14:32:08 -0700944 int n;
945 struct page *page;
946
Paul Jackson44110fe2006-03-24 03:16:04 -0800947 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700948 unsigned int cpuset_mems_cookie;
949 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700950 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700951 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700952 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700953 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700954
Miao Xiec0ff7452010-05-24 14:32:08 -0700955 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800956 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700957 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800958}
Nick Piggin2ae88142006-10-28 10:38:23 -0700959EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800960#endif
961
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962/*
963 * In order to wait for pages to become available there must be
964 * waitqueues associated with pages. By using a hash table of
965 * waitqueues where the bucket discipline is to maintain all
966 * waiters on the same queue and wake all when any of the pages
967 * become available, and for the woken contexts to check to be
968 * sure the appropriate page became available, this saves space
969 * at a cost of "thundering herd" phenomena during rare hash
970 * collisions.
971 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000972#define PAGE_WAIT_TABLE_BITS 8
973#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
974static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
975
976static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977{
Nicholas Piggin62906022016-12-25 13:00:30 +1000978 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979}
Nicholas Piggin62906022016-12-25 13:00:30 +1000980
981void __init pagecache_init(void)
982{
983 int i;
984
985 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
986 init_waitqueue_head(&page_wait_table[i]);
987
988 page_writeback_init();
989}
990
Ingo Molnarac6424b2017-06-20 12:06:13 +0200991static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +1000992{
Linus Torvalds2a9127f2020-07-23 10:16:49 -0700993 int ret;
Nicholas Piggin62906022016-12-25 13:00:30 +1000994 struct wait_page_key *key = arg;
995 struct wait_page_queue *wait_page
996 = container_of(wait, struct wait_page_queue, wait);
997
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -0700998 if (!wake_page_match(wait_page, key))
Nicholas Piggin62906022016-12-25 13:00:30 +1000999 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001000
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001001 /*
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001002 * If it's an exclusive wait, we get the bit for it, and
1003 * stop walking if we can't.
1004 *
1005 * If it's a non-exclusive wait, then the fact that this
1006 * wake function was called means that the bit already
1007 * was cleared, and we don't care if somebody then
1008 * re-took it.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001009 */
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001010 ret = 0;
1011 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1012 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1013 return -1;
1014 ret = 1;
1015 }
1016 wait->flags |= WQ_FLAG_WOKEN;
Nicholas Piggin62906022016-12-25 13:00:30 +10001017
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001018 wake_up_state(wait->private, mode);
1019
1020 /*
1021 * Ok, we have successfully done what we're waiting for,
1022 * and we can unconditionally remove the wait entry.
1023 *
1024 * Note that this has to be the absolute last thing we do,
1025 * since after list_del_init(&wait->entry) the wait entry
1026 * might be de-allocated and the process might even have
1027 * exited.
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001028 */
Linus Torvaldsc6fe44d2020-07-23 12:33:41 -07001029 list_del_init_careful(&wait->entry);
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001030 return ret;
Nicholas Piggin62906022016-12-25 13:00:30 +10001031}
1032
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001033static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001034{
1035 wait_queue_head_t *q = page_waitqueue(page);
1036 struct wait_page_key key;
1037 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001038 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001039
1040 key.page = page;
1041 key.bit_nr = bit_nr;
1042 key.page_match = 0;
1043
Tim Chen11a19c72017-08-25 09:13:55 -07001044 bookmark.flags = 0;
1045 bookmark.private = NULL;
1046 bookmark.func = NULL;
1047 INIT_LIST_HEAD(&bookmark.entry);
1048
Nicholas Piggin62906022016-12-25 13:00:30 +10001049 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001050 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1051
1052 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1053 /*
1054 * Take a breather from holding the lock,
1055 * allow pages that finish wake up asynchronously
1056 * to acquire the lock and remove themselves
1057 * from wait queue
1058 */
1059 spin_unlock_irqrestore(&q->lock, flags);
1060 cpu_relax();
1061 spin_lock_irqsave(&q->lock, flags);
1062 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1063 }
1064
Nicholas Piggin62906022016-12-25 13:00:30 +10001065 /*
1066 * It is possible for other pages to have collided on the waitqueue
1067 * hash, so in that case check for a page match. That prevents a long-
1068 * term waiter
1069 *
1070 * It is still possible to miss a case here, when we woke page waiters
1071 * and removed them from the waitqueue, but there are still other
1072 * page waiters.
1073 */
1074 if (!waitqueue_active(q) || !key.page_match) {
1075 ClearPageWaiters(page);
1076 /*
1077 * It's possible to miss clearing Waiters here, when we woke
1078 * our page waiters, but the hashed waitqueue has waiters for
1079 * other pages on it.
1080 *
1081 * That's okay, it's a rare case. The next waker will clear it.
1082 */
1083 }
1084 spin_unlock_irqrestore(&q->lock, flags);
1085}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001086
1087static void wake_up_page(struct page *page, int bit)
1088{
1089 if (!PageWaiters(page))
1090 return;
1091 wake_up_page_bit(page, bit);
1092}
Nicholas Piggin62906022016-12-25 13:00:30 +10001093
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001094/*
1095 * A choice of three behaviors for wait_on_page_bit_common():
1096 */
1097enum behavior {
1098 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1099 * __lock_page() waiting on then setting PG_locked.
1100 */
1101 SHARED, /* Hold ref to page and check the bit when woken, like
1102 * wait_on_page_writeback() waiting on PG_writeback.
1103 */
1104 DROP, /* Drop ref to page before wait, no check when woken,
1105 * like put_and_wait_on_page_locked() on PG_locked.
1106 */
1107};
1108
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001109/*
1110 * Attempt to check (or get) the page bit, and mark the
1111 * waiter woken if successful.
1112 */
1113static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1114 struct wait_queue_entry *wait)
1115{
1116 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1117 if (test_and_set_bit(bit_nr, &page->flags))
1118 return false;
1119 } else if (test_bit(bit_nr, &page->flags))
1120 return false;
1121
1122 wait->flags |= WQ_FLAG_WOKEN;
1123 return true;
1124}
1125
Nicholas Piggin62906022016-12-25 13:00:30 +10001126static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001127 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001128{
1129 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001130 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001131 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001132 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001133 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001134
Johannes Weinereb414682018-10-26 15:06:27 -07001135 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001136 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001137 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001138 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001139 delayacct = true;
1140 }
Johannes Weinereb414682018-10-26 15:06:27 -07001141 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001142 thrashing = true;
1143 }
1144
Nicholas Piggin62906022016-12-25 13:00:30 +10001145 init_wait(wait);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001146 wait->flags = behavior == EXCLUSIVE ? WQ_FLAG_EXCLUSIVE : 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001147 wait->func = wake_page_function;
1148 wait_page.page = page;
1149 wait_page.bit_nr = bit_nr;
1150
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001151 /*
1152 * Do one last check whether we can get the
1153 * page bit synchronously.
1154 *
1155 * Do the SetPageWaiters() marking before that
1156 * to let any waker we _just_ missed know they
1157 * need to wake us up (otherwise they'll never
1158 * even go to the slow case that looks at the
1159 * page queue), and add ourselves to the wait
1160 * queue if we need to sleep.
1161 *
1162 * This part needs to be done under the queue
1163 * lock to avoid races.
1164 */
1165 spin_lock_irq(&q->lock);
1166 SetPageWaiters(page);
1167 if (!trylock_page_bit_common(page, bit_nr, wait))
1168 __add_wait_queue_entry_tail(q, wait);
1169 spin_unlock_irq(&q->lock);
1170
1171 /*
1172 * From now on, all the logic will be based on
1173 * the WQ_FLAG_WOKEN flag, and the and the page
1174 * bit testing (and setting) will be - or has
1175 * already been - done by the wake function.
1176 *
1177 * We can drop our reference to the page.
1178 */
1179 if (behavior == DROP)
1180 put_page(page);
1181
Nicholas Piggin62906022016-12-25 13:00:30 +10001182 for (;;) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001183 set_current_state(state);
1184
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001185 if (signal_pending_state(state, current))
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001186 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001187
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001188 if (wait->flags & WQ_FLAG_WOKEN)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001189 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001190
1191 io_schedule();
Nicholas Piggin62906022016-12-25 13:00:30 +10001192 }
1193
1194 finish_wait(q, wait);
1195
Johannes Weinereb414682018-10-26 15:06:27 -07001196 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001197 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001198 delayacct_thrashing_end();
1199 psi_memstall_leave(&pflags);
1200 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001201
Nicholas Piggin62906022016-12-25 13:00:30 +10001202 /*
1203 * A signal could leave PageWaiters set. Clearing it here if
1204 * !waitqueue_active would be possible (by open-coding finish_wait),
1205 * but still fail to catch it in the case of wait hash collision. We
1206 * already can fail to clear wait hash collision cases, so don't
1207 * bother with signals either.
1208 */
1209
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001210 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001211}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001212
Harvey Harrison920c7a52008-02-04 22:29:26 -08001213void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214{
Nicholas Piggin62906022016-12-25 13:00:30 +10001215 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001216 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217}
1218EXPORT_SYMBOL(wait_on_page_bit);
1219
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001220int wait_on_page_bit_killable(struct page *page, int bit_nr)
1221{
Nicholas Piggin62906022016-12-25 13:00:30 +10001222 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001223 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001224}
David Howells4343d002017-11-02 15:27:52 +00001225EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001226
Jens Axboedd3e6d52020-05-22 09:12:09 -06001227static int __wait_on_page_locked_async(struct page *page,
1228 struct wait_page_queue *wait, bool set)
1229{
1230 struct wait_queue_head *q = page_waitqueue(page);
1231 int ret = 0;
1232
1233 wait->page = page;
1234 wait->bit_nr = PG_locked;
1235
1236 spin_lock_irq(&q->lock);
1237 __add_wait_queue_entry_tail(q, &wait->wait);
1238 SetPageWaiters(page);
1239 if (set)
1240 ret = !trylock_page(page);
1241 else
1242 ret = PageLocked(page);
1243 /*
1244 * If we were succesful now, we know we're still on the
1245 * waitqueue as we're still under the lock. This means it's
1246 * safe to remove and return success, we know the callback
1247 * isn't going to trigger.
1248 */
1249 if (!ret)
1250 __remove_wait_queue(q, &wait->wait);
1251 else
1252 ret = -EIOCBQUEUED;
1253 spin_unlock_irq(&q->lock);
1254 return ret;
1255}
1256
Jens Axboe1a0a7852020-05-22 09:18:38 -06001257static int wait_on_page_locked_async(struct page *page,
1258 struct wait_page_queue *wait)
1259{
1260 if (!PageLocked(page))
1261 return 0;
1262 return __wait_on_page_locked_async(compound_head(page), wait, false);
1263}
1264
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001266 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1267 * @page: The page to wait for.
1268 *
1269 * The caller should hold a reference on @page. They expect the page to
1270 * become unlocked relatively soon, but do not wish to hold up migration
1271 * (for example) by holding the reference while waiting for the page to
1272 * come unlocked. After this function returns, the caller should not
1273 * dereference @page.
1274 */
1275void put_and_wait_on_page_locked(struct page *page)
1276{
1277 wait_queue_head_t *q;
1278
1279 page = compound_head(page);
1280 q = page_waitqueue(page);
1281 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1282}
1283
1284/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001285 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001286 * @page: Page defining the wait queue of interest
1287 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001288 *
1289 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1290 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001291void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001292{
1293 wait_queue_head_t *q = page_waitqueue(page);
1294 unsigned long flags;
1295
1296 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001297 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001298 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001299 spin_unlock_irqrestore(&q->lock, flags);
1300}
1301EXPORT_SYMBOL_GPL(add_page_wait_queue);
1302
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001303#ifndef clear_bit_unlock_is_negative_byte
1304
1305/*
1306 * PG_waiters is the high bit in the same byte as PG_lock.
1307 *
1308 * On x86 (and on many other architectures), we can clear PG_lock and
1309 * test the sign bit at the same time. But if the architecture does
1310 * not support that special operation, we just do this all by hand
1311 * instead.
1312 *
1313 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001314 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001315 * in the same byte as PG_locked.
1316 */
1317static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1318{
1319 clear_bit_unlock(nr, mem);
1320 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001321 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001322}
1323
1324#endif
1325
David Howells385e1ca5f2009-04-03 16:42:39 +01001326/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001327 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 * @page: the page
1329 *
1330 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
1331 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001332 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1334 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001335 * Note that this depends on PG_waiters being the sign bit in the byte
1336 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1337 * clear the PG_locked bit and test PG_waiters at the same time fairly
1338 * portably (architectures that do LL/SC can test any bit, while x86 can
1339 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001341void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001343 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001344 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001345 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001346 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1347 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348}
1349EXPORT_SYMBOL(unlock_page);
1350
Randy Dunlap485bb992006-06-23 02:03:49 -07001351/**
1352 * end_page_writeback - end writeback against a page
1353 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 */
1355void end_page_writeback(struct page *page)
1356{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001357 /*
1358 * TestClearPageReclaim could be used here but it is an atomic
1359 * operation and overkill in this particular case. Failing to
1360 * shuffle a page marked for immediate reclaim is too mild to
1361 * justify taking an atomic operation penalty at the end of
1362 * ever page writeback.
1363 */
1364 if (PageReclaim(page)) {
1365 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001366 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001367 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001368
1369 if (!test_clear_page_writeback(page))
1370 BUG();
1371
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001372 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 wake_up_page(page, PG_writeback);
1374}
1375EXPORT_SYMBOL(end_page_writeback);
1376
Matthew Wilcox57d99842014-06-04 16:07:45 -07001377/*
1378 * After completing I/O on a page, call this routine to update the page
1379 * flags appropriately
1380 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001381void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001382{
Jens Axboec11f0c02016-08-05 08:11:04 -06001383 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001384 if (!err) {
1385 SetPageUptodate(page);
1386 } else {
1387 ClearPageUptodate(page);
1388 SetPageError(page);
1389 }
1390 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001391 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001392 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001393 struct address_space *mapping;
1394
Matthew Wilcox57d99842014-06-04 16:07:45 -07001395 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001396 mapping = page_mapping(page);
1397 if (mapping)
1398 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001399 }
1400 end_page_writeback(page);
1401 }
1402}
1403EXPORT_SYMBOL_GPL(page_endio);
1404
Randy Dunlap485bb992006-06-23 02:03:49 -07001405/**
1406 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001407 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001409void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410{
Nicholas Piggin62906022016-12-25 13:00:30 +10001411 struct page *page = compound_head(__page);
1412 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001413 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1414 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415}
1416EXPORT_SYMBOL(__lock_page);
1417
Nicholas Piggin62906022016-12-25 13:00:30 +10001418int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001419{
Nicholas Piggin62906022016-12-25 13:00:30 +10001420 struct page *page = compound_head(__page);
1421 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001422 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1423 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001424}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001425EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001426
Jens Axboedd3e6d52020-05-22 09:12:09 -06001427int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1428{
1429 return __wait_on_page_locked_async(page, wait, true);
1430}
1431
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001432/*
1433 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001434 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001435 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001436 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001437 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001438 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001439 *
1440 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001441 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001442 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001443int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1444 unsigned int flags)
1445{
Peter Xu4064b982020-04-01 21:08:45 -07001446 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001447 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001448 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001449 * even though return 0.
1450 */
1451 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1452 return 0;
1453
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001454 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001455 if (flags & FAULT_FLAG_KILLABLE)
1456 wait_on_page_locked_killable(page);
1457 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001458 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001459 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001460 } else {
1461 if (flags & FAULT_FLAG_KILLABLE) {
1462 int ret;
1463
1464 ret = __lock_page_killable(page);
1465 if (ret) {
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001466 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001467 return 0;
1468 }
1469 } else
1470 __lock_page(page);
1471 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001472 }
1473}
1474
Randy Dunlap485bb992006-06-23 02:03:49 -07001475/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001476 * page_cache_next_miss() - Find the next gap in the page cache.
1477 * @mapping: Mapping.
1478 * @index: Index.
1479 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001480 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001481 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1482 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001483 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001484 * This function may be called under the rcu_read_lock. However, this will
1485 * not atomically search a snapshot of the cache at a single point in time.
1486 * For example, if a gap is created at index 5, then subsequently a gap is
1487 * created at index 10, page_cache_next_miss covering both indices may
1488 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001489 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001490 * Return: The index of the gap if found, otherwise an index outside the
1491 * range specified (in which case 'return - index >= max_scan' will be true).
1492 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001493 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001494pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001495 pgoff_t index, unsigned long max_scan)
1496{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001497 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001498
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001499 while (max_scan--) {
1500 void *entry = xas_next(&xas);
1501 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001502 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001503 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001504 break;
1505 }
1506
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001507 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001508}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001509EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001510
1511/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001512 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001513 * @mapping: Mapping.
1514 * @index: Index.
1515 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001516 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001517 * Search the range [max(index - max_scan + 1, 0), index] for the
1518 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001519 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001520 * This function may be called under the rcu_read_lock. However, this will
1521 * not atomically search a snapshot of the cache at a single point in time.
1522 * For example, if a gap is created at index 10, then subsequently a gap is
1523 * created at index 5, page_cache_prev_miss() covering both indices may
1524 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001525 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001526 * Return: The index of the gap if found, otherwise an index outside the
1527 * range specified (in which case 'index - return >= max_scan' will be true).
1528 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001529 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001530pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001531 pgoff_t index, unsigned long max_scan)
1532{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001533 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001534
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001535 while (max_scan--) {
1536 void *entry = xas_prev(&xas);
1537 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001538 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001539 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001540 break;
1541 }
1542
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001543 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001544}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001545EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001546
1547/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001548 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001549 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001550 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001551 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001552 * Looks up the page cache slot at @mapping & @offset. If there is a
1553 * page cache page, it is returned with an increased refcount.
1554 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001555 * If the slot holds a shadow entry of a previously evicted page, or a
1556 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001557 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001558 * Return: the found page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001559 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001560struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561{
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001562 XA_STATE(xas, &mapping->i_pages, offset);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001563 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564
Nick Piggina60637c2008-07-25 19:45:31 -07001565 rcu_read_lock();
1566repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001567 xas_reset(&xas);
1568 page = xas_load(&xas);
1569 if (xas_retry(&xas, page))
1570 goto repeat;
1571 /*
1572 * A shadow entry of a recently evicted page, or a swap entry from
1573 * shmem/tmpfs. Return it without attempting to raise page count.
1574 */
1575 if (!page || xa_is_value(page))
1576 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001577
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001578 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001579 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001580
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001581 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001582 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001583 * This is part of the lockless pagecache protocol. See
1584 * include/linux/pagemap.h for details.
1585 */
1586 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001587 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001588 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001589 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001590 page = find_subpage(page, offset);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001591out:
Nick Piggina60637c2008-07-25 19:45:31 -07001592 rcu_read_unlock();
1593
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 return page;
1595}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596
Randy Dunlap485bb992006-06-23 02:03:49 -07001597/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001598 * find_lock_entry - locate, pin and lock a page cache entry
1599 * @mapping: the address_space to search
1600 * @offset: the page cache index
1601 *
1602 * Looks up the page cache slot at @mapping & @offset. If there is a
1603 * page cache page, it is returned locked and with an increased
1604 * refcount.
1605 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001606 * If the slot holds a shadow entry of a previously evicted page, or a
1607 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001608 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001609 * find_lock_entry() may sleep.
Mike Rapoporta862f682019-03-05 15:48:42 -08001610 *
1611 * Return: the found page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001612 */
1613struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614{
1615 struct page *page;
1616
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001618 page = find_get_entry(mapping, offset);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001619 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001620 lock_page(page);
1621 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001622 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001623 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001624 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001625 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001627 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001628 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001629 return page;
1630}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001631EXPORT_SYMBOL(find_lock_entry);
1632
1633/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001634 * pagecache_get_page - Find and get a reference to a page.
1635 * @mapping: The address_space to search.
1636 * @index: The page index.
1637 * @fgp_flags: %FGP flags modify how the page is returned.
1638 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001639 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001640 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001641 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001642 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001643 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001644 * * %FGP_ACCESSED - The page will be marked accessed.
1645 * * %FGP_LOCK - The page is returned locked.
1646 * * %FGP_CREAT - If no page is present then a new page is allocated using
1647 * @gfp_mask and added to the page cache and the VM's LRU list.
1648 * The page is returned locked and with an increased refcount.
1649 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1650 * page is already in cache. If the page was allocated, unlock it before
1651 * returning so the caller can do the same dance.
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001652 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001653 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1654 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001655 *
1656 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001657 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001658 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001659 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001660struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1661 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662{
Nick Piggineb2be182007-10-16 01:24:57 -07001663 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001664
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001666 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001667 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001668 page = NULL;
1669 if (!page)
1670 goto no_page;
1671
1672 if (fgp_flags & FGP_LOCK) {
1673 if (fgp_flags & FGP_NOWAIT) {
1674 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001675 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001676 return NULL;
1677 }
1678 } else {
1679 lock_page(page);
1680 }
1681
1682 /* Has the page been truncated? */
Song Liu31895432019-09-23 15:37:47 -07001683 if (unlikely(compound_head(page)->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001684 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001685 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001686 goto repeat;
1687 }
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001688 VM_BUG_ON_PAGE(page->index != index, page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001689 }
1690
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001691 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001692 mark_page_accessed(page);
Yang Shib9306a72020-08-06 23:19:55 -07001693 else if (fgp_flags & FGP_WRITE) {
1694 /* Clear idle flag for buffer write */
1695 if (page_is_idle(page))
1696 clear_page_idle(page);
1697 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001698
1699no_page:
1700 if (!page && (fgp_flags & FGP_CREAT)) {
1701 int err;
1702 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001703 gfp_mask |= __GFP_WRITE;
1704 if (fgp_flags & FGP_NOFS)
1705 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001706
Michal Hocko45f87de2014-12-29 20:30:35 +01001707 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001708 if (!page)
1709 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001710
Josef Bacika75d4c32019-03-13 11:44:14 -07001711 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001712 fgp_flags |= FGP_LOCK;
1713
Hugh Dickinseb39d612014-08-06 16:06:43 -07001714 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001715 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001716 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001717
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001718 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001719 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001720 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001721 page = NULL;
1722 if (err == -EEXIST)
1723 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001724 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001725
1726 /*
1727 * add_to_page_cache_lru locks the page, and for mmap we expect
1728 * an unlocked page.
1729 */
1730 if (page && (fgp_flags & FGP_FOR_MMAP))
1731 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001732 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001733
Linus Torvalds1da177e2005-04-16 15:20:36 -07001734 return page;
1735}
Mel Gorman2457aec2014-06-04 16:10:31 -07001736EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737
1738/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001739 * find_get_entries - gang pagecache lookup
1740 * @mapping: The address_space to search
1741 * @start: The starting page cache index
1742 * @nr_entries: The maximum number of entries
1743 * @entries: Where the resulting entries are placed
1744 * @indices: The cache indices corresponding to the entries in @entries
1745 *
1746 * find_get_entries() will search for and return a group of up to
1747 * @nr_entries entries in the mapping. The entries are placed at
1748 * @entries. find_get_entries() takes a reference against any actual
1749 * pages it returns.
1750 *
1751 * The search returns a group of mapping-contiguous page cache entries
1752 * with ascending indexes. There may be holes in the indices due to
1753 * not-present pages.
1754 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001755 * Any shadow entries of evicted pages, or swap entries from
1756 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001757 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001758 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1759 * stops at that page: the caller is likely to have a better way to handle
1760 * the compound page as a whole, and then skip its extent, than repeatedly
1761 * calling find_get_entries() to return all its tails.
1762 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001763 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001764 */
1765unsigned find_get_entries(struct address_space *mapping,
1766 pgoff_t start, unsigned int nr_entries,
1767 struct page **entries, pgoff_t *indices)
1768{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001769 XA_STATE(xas, &mapping->i_pages, start);
1770 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001771 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001772
1773 if (!nr_entries)
1774 return 0;
1775
1776 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001777 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001778 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001779 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001780 /*
1781 * A shadow entry of a recently evicted page, a swap
1782 * entry from shmem/tmpfs or a DAX entry. Return it
1783 * without attempting to raise page count.
1784 */
1785 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001786 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001787
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001788 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001789 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001790
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001791 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001792 if (unlikely(page != xas_reload(&xas)))
1793 goto put_page;
1794
Hugh Dickins71725ed2020-04-06 20:07:57 -07001795 /*
1796 * Terminate early on finding a THP, to allow the caller to
1797 * handle it all at once; but continue if this is hugetlbfs.
1798 */
1799 if (PageTransHuge(page) && !PageHuge(page)) {
1800 page = find_subpage(page, xas.xa_index);
1801 nr_entries = ret + 1;
1802 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001803export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001804 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001805 entries[ret] = page;
1806 if (++ret == nr_entries)
1807 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001808 continue;
1809put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001810 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001811retry:
1812 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001813 }
1814 rcu_read_unlock();
1815 return ret;
1816}
1817
1818/**
Jan Karab947cee2017-09-06 16:21:21 -07001819 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 * @mapping: The address_space to search
1821 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001822 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 * @nr_pages: The maximum number of pages
1824 * @pages: Where the resulting pages are placed
1825 *
Jan Karab947cee2017-09-06 16:21:21 -07001826 * find_get_pages_range() will search for and return a group of up to @nr_pages
1827 * pages in the mapping starting at index @start and up to index @end
1828 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1829 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 *
1831 * The search returns a group of mapping-contiguous pages with ascending
1832 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001833 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001835 * Return: the number of pages which were found. If this number is
1836 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001837 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 */
Jan Karab947cee2017-09-06 16:21:21 -07001839unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1840 pgoff_t end, unsigned int nr_pages,
1841 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001842{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001843 XA_STATE(xas, &mapping->i_pages, *start);
1844 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001845 unsigned ret = 0;
1846
1847 if (unlikely(!nr_pages))
1848 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001849
Nick Piggina60637c2008-07-25 19:45:31 -07001850 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001851 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001852 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001853 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001854 /* Skip over shadow, swap and DAX entries */
1855 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001856 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001857
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001858 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001859 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001860
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001861 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001862 if (unlikely(page != xas_reload(&xas)))
1863 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001864
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001865 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001866 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001867 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001868 goto out;
1869 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001870 continue;
1871put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001872 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001873retry:
1874 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001875 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001876
Jan Karab947cee2017-09-06 16:21:21 -07001877 /*
1878 * We come here when there is no page beyond @end. We take care to not
1879 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001880 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07001881 * already broken anyway.
1882 */
1883 if (end == (pgoff_t)-1)
1884 *start = (pgoff_t)-1;
1885 else
1886 *start = end + 1;
1887out:
Nick Piggina60637c2008-07-25 19:45:31 -07001888 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07001889
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 return ret;
1891}
1892
Jens Axboeebf43502006-04-27 08:46:01 +02001893/**
1894 * find_get_pages_contig - gang contiguous pagecache lookup
1895 * @mapping: The address_space to search
1896 * @index: The starting page index
1897 * @nr_pages: The maximum number of pages
1898 * @pages: Where the resulting pages are placed
1899 *
1900 * find_get_pages_contig() works exactly like find_get_pages(), except
1901 * that the returned number of pages are guaranteed to be contiguous.
1902 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001903 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02001904 */
1905unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1906 unsigned int nr_pages, struct page **pages)
1907{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001908 XA_STATE(xas, &mapping->i_pages, index);
1909 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001910 unsigned int ret = 0;
1911
1912 if (unlikely(!nr_pages))
1913 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001914
Nick Piggina60637c2008-07-25 19:45:31 -07001915 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001916 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001917 if (xas_retry(&xas, page))
1918 continue;
1919 /*
1920 * If the entry has been swapped out, we can stop looking.
1921 * No current caller is looking for DAX entries.
1922 */
1923 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001924 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001925
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001926 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001927 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001928
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001929 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001930 if (unlikely(page != xas_reload(&xas)))
1931 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001932
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001933 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001934 if (++ret == nr_pages)
1935 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001936 continue;
1937put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001938 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001939retry:
1940 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02001941 }
Nick Piggina60637c2008-07-25 19:45:31 -07001942 rcu_read_unlock();
1943 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001944}
David Howellsef71c152007-05-09 02:33:44 -07001945EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001946
Randy Dunlap485bb992006-06-23 02:03:49 -07001947/**
Jan Kara72b045a2017-11-15 17:34:33 -08001948 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001949 * @mapping: the address_space to search
1950 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08001951 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001952 * @tag: the tag index
1953 * @nr_pages: the maximum number of pages
1954 * @pages: where the resulting pages are placed
1955 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001957 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08001958 *
1959 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 */
Jan Kara72b045a2017-11-15 17:34:33 -08001961unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001962 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08001963 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001965 XA_STATE(xas, &mapping->i_pages, *index);
1966 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001967 unsigned ret = 0;
1968
1969 if (unlikely(!nr_pages))
1970 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971
Nick Piggina60637c2008-07-25 19:45:31 -07001972 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001973 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001974 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001975 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001976 /*
1977 * Shadow entries should never be tagged, but this iteration
1978 * is lockless so there is a window for page reclaim to evict
1979 * a page we saw tagged. Skip over it.
1980 */
1981 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07001982 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001983
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001984 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001985 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001986
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001987 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001988 if (unlikely(page != xas_reload(&xas)))
1989 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001990
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001991 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08001992 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001993 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08001994 goto out;
1995 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001996 continue;
1997put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001998 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001999retry:
2000 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07002001 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07002002
Jan Kara72b045a2017-11-15 17:34:33 -08002003 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002004 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08002005 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04002006 * iteration when there is a page at index -1 but that is already
2007 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08002008 */
2009 if (end == (pgoff_t)-1)
2010 *index = (pgoff_t)-1;
2011 else
2012 *index = end + 1;
2013out:
Nick Piggina60637c2008-07-25 19:45:31 -07002014 rcu_read_unlock();
2015
Linus Torvalds1da177e2005-04-16 15:20:36 -07002016 return ret;
2017}
Jan Kara72b045a2017-11-15 17:34:33 -08002018EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002020/*
2021 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2022 * a _large_ part of the i/o request. Imagine the worst scenario:
2023 *
2024 * ---R__________________________________________B__________
2025 * ^ reading here ^ bad block(assume 4k)
2026 *
2027 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2028 * => failing the whole request => read(R) => read(R+1) =>
2029 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2030 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2031 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2032 *
2033 * It is going insane. Fix it by quickly scaling down the readahead size.
2034 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002035static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002036{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002037 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002038}
2039
Randy Dunlap485bb992006-06-23 02:03:49 -07002040/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002041 * generic_file_buffered_read - generic file read routine
2042 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05002043 * @iter: data destination
2044 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07002045 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07002047 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 *
2049 * This is really ugly. But the goto's actually try to clarify some
2050 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002051 *
2052 * Return:
2053 * * total number of bytes copied, including those the were already @written
2054 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002056ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002057 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002059 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002060 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002062 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002063 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002064 pgoff_t index;
2065 pgoff_t last_index;
2066 pgoff_t prev_index;
2067 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002068 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002069 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070
Wei Fangc2a97372016-10-07 17:01:52 -07002071 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002072 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002073 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2074
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002075 index = *ppos >> PAGE_SHIFT;
2076 prev_index = ra->prev_pos >> PAGE_SHIFT;
2077 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2078 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2079 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002080
Linus Torvalds1da177e2005-04-16 15:20:36 -07002081 for (;;) {
2082 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002083 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002084 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 unsigned long nr, ret;
2086
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002089 if (fatal_signal_pending(current)) {
2090 error = -EINTR;
2091 goto out;
2092 }
2093
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002095 if (!page) {
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002096 if (iocb->ki_flags & IOCB_NOIO)
Milosz Tanski3239d832017-08-29 16:13:19 +02002097 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002098 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002099 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002100 index, last_index - index);
2101 page = find_get_page(mapping, index);
2102 if (unlikely(page == NULL))
2103 goto no_cached_page;
2104 }
2105 if (PageReadahead(page)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002106 if (iocb->ki_flags & IOCB_NOIO) {
2107 put_page(page);
2108 goto out;
2109 }
Rusty Russellcf914a72007-07-19 01:48:08 -07002110 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002111 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002112 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002114 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07002115 /*
2116 * See comment in do_read_cache_page on why
2117 * wait_on_page_locked is used to avoid unnecessarily
2118 * serialisations and why it's safe.
2119 */
Jens Axboe1a0a7852020-05-22 09:18:38 -06002120 if (iocb->ki_flags & IOCB_WAITQ) {
2121 if (written) {
2122 put_page(page);
2123 goto out;
2124 }
2125 error = wait_on_page_locked_async(page,
2126 iocb->ki_waitq);
2127 } else {
2128 if (iocb->ki_flags & IOCB_NOWAIT) {
2129 put_page(page);
2130 goto would_block;
2131 }
2132 error = wait_on_page_locked_killable(page);
2133 }
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002134 if (unlikely(error))
2135 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002136 if (PageUptodate(page))
2137 goto page_ok;
2138
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002139 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002140 !mapping->a_ops->is_partially_uptodate)
2141 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002142 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002143 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002144 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002145 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002146 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002147 /* Did it get truncated before we got the lock? */
2148 if (!page->mapping)
2149 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002150 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002151 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002152 goto page_not_up_to_date_locked;
2153 unlock_page(page);
2154 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002155page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002156 /*
2157 * i_size must be checked after we know the page is Uptodate.
2158 *
2159 * Checking i_size after the check allows us to calculate
2160 * the correct value for "nr", which means the zero-filled
2161 * part of the page is not copied back to userspace (unless
2162 * another truncate extends the file - this is desired though).
2163 */
2164
2165 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002166 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002167 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002168 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002169 goto out;
2170 }
2171
2172 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002173 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002174 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002175 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002176 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002177 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002178 goto out;
2179 }
2180 }
2181 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182
2183 /* If users can be writing to this page using arbitrary
2184 * virtual addresses, take care about potential aliasing
2185 * before reading the page on the kernel side.
2186 */
2187 if (mapping_writably_mapped(mapping))
2188 flush_dcache_page(page);
2189
2190 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002191 * When a sequential read accesses a page several times,
2192 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193 */
Jan Karaec0f1632007-05-06 14:49:25 -07002194 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 mark_page_accessed(page);
2196 prev_index = index;
2197
2198 /*
2199 * Ok, we have the page, and it's up-to-date, so
2200 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002201 */
Al Viro6e58e792014-02-03 17:07:03 -05002202
2203 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002205 index += offset >> PAGE_SHIFT;
2206 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002207 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002209 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002210 written += ret;
2211 if (!iov_iter_count(iter))
2212 goto out;
2213 if (ret < nr) {
2214 error = -EFAULT;
2215 goto out;
2216 }
2217 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002218
2219page_not_up_to_date:
2220 /* Get exclusive access to the page ... */
Jens Axboe1a0a7852020-05-22 09:18:38 -06002221 if (iocb->ki_flags & IOCB_WAITQ)
2222 error = lock_page_async(page, iocb->ki_waitq);
2223 else
2224 error = lock_page_killable(page);
Oleg Nesterov85462322008-06-08 21:20:43 +04002225 if (unlikely(error))
2226 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002228page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002229 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 if (!page->mapping) {
2231 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002232 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 continue;
2234 }
2235
2236 /* Did somebody else fill it already? */
2237 if (PageUptodate(page)) {
2238 unlock_page(page);
2239 goto page_ok;
2240 }
2241
2242readpage:
Linus Torvaldscdc8fcb2020-08-03 13:01:22 -07002243 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002244 unlock_page(page);
2245 put_page(page);
2246 goto would_block;
2247 }
Jeff Moyer91803b42010-05-26 11:49:40 -04002248 /*
2249 * A previous I/O error may have been due to temporary
2250 * failures, eg. multipath errors.
2251 * PG_error will be set again if readpage fails.
2252 */
2253 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 /* Start the actual read. The read will unlock the page. */
2255 error = mapping->a_ops->readpage(filp, page);
2256
Zach Brown994fc28c2005-12-15 14:28:17 -08002257 if (unlikely(error)) {
2258 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002259 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002260 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002261 goto find_page;
2262 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002264 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265
2266 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04002267 error = lock_page_killable(page);
2268 if (unlikely(error))
2269 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 if (!PageUptodate(page)) {
2271 if (page->mapping == NULL) {
2272 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002273 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 */
2275 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002276 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277 goto find_page;
2278 }
2279 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002280 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002281 error = -EIO;
2282 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 }
2284 unlock_page(page);
2285 }
2286
Linus Torvalds1da177e2005-04-16 15:20:36 -07002287 goto page_ok;
2288
2289readpage_error:
2290 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002291 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002292 goto out;
2293
2294no_cached_page:
2295 /*
2296 * Ok, it wasn't cached, so we need to create a new
2297 * page..
2298 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002299 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002300 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002301 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002302 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002303 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002304 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002305 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002306 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002307 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002308 if (error == -EEXIST) {
2309 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002310 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002311 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 goto out;
2313 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002314 goto readpage;
2315 }
2316
Milosz Tanski3239d832017-08-29 16:13:19 +02002317would_block:
2318 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002320 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002321 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002322 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002323
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002324 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002325 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002326 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002328EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002329
Randy Dunlap485bb992006-06-23 02:03:49 -07002330/**
Al Viro6abd2322014-04-04 14:20:57 -04002331 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002332 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002333 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002334 *
Al Viro6abd2322014-04-04 14:20:57 -04002335 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002336 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002337 *
2338 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2339 * be returned when no data can be read without waiting for I/O requests
2340 * to complete; it doesn't prevent readahead.
2341 *
2342 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2343 * requests shall be made for the read or for readahead. When no data
2344 * can be read, -EAGAIN shall be returned. When readahead would be
2345 * triggered, a partial, possibly empty read shall be returned.
2346 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002347 * Return:
2348 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002349 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002350 */
2351ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002352generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002353{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002354 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002355 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002356
2357 if (!count)
2358 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002359
Al Viro2ba48ce2015-04-09 13:52:01 -04002360 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002361 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002362 struct address_space *mapping = file->f_mapping;
2363 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002364 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365
Linus Torvalds1da177e2005-04-16 15:20:36 -07002366 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002367 if (iocb->ki_flags & IOCB_NOWAIT) {
2368 if (filemap_range_has_page(mapping, iocb->ki_pos,
2369 iocb->ki_pos + count - 1))
2370 return -EAGAIN;
2371 } else {
2372 retval = filemap_write_and_wait_range(mapping,
2373 iocb->ki_pos,
2374 iocb->ki_pos + count - 1);
2375 if (retval < 0)
2376 goto out;
2377 }
Al Viroed978a82014-03-05 22:53:04 -05002378
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002379 file_accessed(file);
2380
Al Viro5ecda132017-04-13 14:13:36 -04002381 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002382 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002383 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002384 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002385 }
Al Viro5b47d592017-05-08 13:54:47 -04002386 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002387
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002388 /*
2389 * Btrfs can have a short DIO read if we encounter
2390 * compressed extents, so if there was an error, or if
2391 * we've already read everything we wanted to, or if
2392 * there was a short read because we hit EOF, go ahead
2393 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002394 * the rest of the read. Buffered reads will not work for
2395 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002396 */
Al Viro5ecda132017-04-13 14:13:36 -04002397 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002398 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002399 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002400 }
2401
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002402 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002403out:
2404 return retval;
2405}
Al Viroed978a82014-03-05 22:53:04 -05002406EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002407
Linus Torvalds1da177e2005-04-16 15:20:36 -07002408#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002409#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002410/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002411 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002412 * @vmf - the vm_fault for this fault.
2413 * @page - the page to lock.
2414 * @fpin - the pointer to the file we may pin (or is already pinned).
2415 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002416 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002417 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002418 * if it couldn't lock the page. If we did have to drop the mmap_lock then fpin
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002419 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002420 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002421static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2422 struct file **fpin)
2423{
2424 if (trylock_page(page))
2425 return 1;
2426
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002427 /*
2428 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002429 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002430 * is supposed to work. We have way too many special cases..
2431 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002432 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2433 return 0;
2434
2435 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2436 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2437 if (__lock_page_killable(page)) {
2438 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002439 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002440 * but all fault_handlers only check for fatal signals
2441 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002442 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002443 */
2444 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002445 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002446 return 0;
2447 }
2448 } else
2449 __lock_page(page);
2450 return 1;
2451}
2452
2453
2454/*
2455 * Synchronous readahead happens when we don't even find a page in the page
2456 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2457 * to drop the mmap sem we return the file that was pinned in order for us to do
2458 * that. If we didn't pin a file then we return NULL. The file that is
2459 * returned needs to be fput()'ed when we're done with it.
2460 */
2461static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002462{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002463 struct file *file = vmf->vma->vm_file;
2464 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002465 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002466 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002467 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002468
2469 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002470 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002471 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002472 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002473 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002474
Josef Bacik2a1180f2019-03-13 11:44:18 -07002475 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002476 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002477 page_cache_sync_readahead(mapping, ra, file, offset,
2478 ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002479 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002480 }
2481
Andi Kleen207d04b2011-05-24 17:12:29 -07002482 /* Avoid banging the cache line if not needed */
2483 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002484 ra->mmap_miss++;
2485
2486 /*
2487 * Do we miss much more than hit in this file? If so,
2488 * stop bothering with read-ahead. It will only hurt.
2489 */
2490 if (ra->mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002491 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002492
Wu Fengguangd30a1102009-06-16 15:31:30 -07002493 /*
2494 * mmap read-around
2495 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002496 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002497 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2498 ra->size = ra->ra_pages;
2499 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002500 ra_submit(ra, mapping, file);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002501 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002502}
2503
2504/*
2505 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002506 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002507 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002508 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002509static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2510 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002511{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002512 struct file *file = vmf->vma->vm_file;
2513 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002514 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002515 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002516 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002517
2518 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002519 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002520 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002521 if (ra->mmap_miss > 0)
2522 ra->mmap_miss--;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002523 if (PageReadahead(page)) {
2524 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002525 page_cache_async_readahead(mapping, ra, file,
2526 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002527 }
2528 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002529}
2530
Randy Dunlap485bb992006-06-23 02:03:49 -07002531/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002532 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002533 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002534 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002535 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002536 * mapped memory region to read in file data during a page fault.
2537 *
2538 * The goto's are kind of ugly, but this streamlines the normal case of having
2539 * it in the page cache, and handles the special cases reasonably without
2540 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002541 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002542 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002543 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002544 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002545 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002546 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002547 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002548 * has not been released.
2549 *
2550 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002551 *
2552 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002553 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002554vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002555{
2556 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002557 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002558 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559 struct address_space *mapping = file->f_mapping;
2560 struct file_ra_state *ra = &file->f_ra;
2561 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002562 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002563 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002564 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002565 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002567 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2568 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002569 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002570
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002572 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002573 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002574 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002575 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002577 * We found the page, so try async readahead before
2578 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002579 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002580 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002581 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002582 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002583 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002584 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002585 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002586 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002587retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002588 page = pagecache_get_page(mapping, offset,
2589 FGP_CREAT|FGP_FOR_MMAP,
2590 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002591 if (!page) {
2592 if (fpin)
2593 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002594 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002595 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002596 }
2597
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002598 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2599 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002600
2601 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002602 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002603 unlock_page(page);
2604 put_page(page);
2605 goto retry_find;
2606 }
Song Liu520e5ba2019-09-23 15:37:50 -07002607 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002608
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002610 * We have a locked page in the page cache, now we need to check
2611 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002612 */
Nick Piggind00806b2007-07-19 01:46:57 -07002613 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002614 goto page_not_uptodate;
2615
Linus Torvaldsef00e082009-06-16 15:31:25 -07002616 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002617 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002618 * time to return to the upper layer and have it re-find the vma and
2619 * redo the fault.
2620 */
2621 if (fpin) {
2622 unlock_page(page);
2623 goto out_retry;
2624 }
2625
2626 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002627 * Found the page and have a reference on it.
2628 * We must recheck i_size under page lock.
2629 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002630 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2631 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002632 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002633 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002634 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002635 }
2636
Nick Piggind0217ac2007-07-19 01:47:03 -07002637 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002638 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
Linus Torvalds1da177e2005-04-16 15:20:36 -07002640page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641 /*
2642 * Umm, take care of errors if the page isn't up-to-date.
2643 * Try to re-read it _once_. We do this synchronously,
2644 * because there really aren't any performance issues here
2645 * and we need to check for errors.
2646 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002647 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002648 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002649 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002650 if (!error) {
2651 wait_on_page_locked(page);
2652 if (!PageUptodate(page))
2653 error = -EIO;
2654 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002655 if (fpin)
2656 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002657 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002658
2659 if (!error || error == AOP_TRUNCATED_PAGE)
2660 goto retry_find;
2661
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002662 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002663 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002664
2665out_retry:
2666 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002667 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002668 * re-find the vma and come back and find our hopefully still populated
2669 * page.
2670 */
2671 if (page)
2672 put_page(page);
2673 if (fpin)
2674 fput(fpin);
2675 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002676}
2677EXPORT_SYMBOL(filemap_fault);
2678
Jan Kara82b0f8c2016-12-14 15:06:58 -08002679void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002680 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002681{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002682 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002683 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002684 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002685 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002686 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002687 struct page *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002688
2689 rcu_read_lock();
Matthew Wilcox070e8072018-05-17 00:08:30 -04002690 xas_for_each(&xas, page, end_pgoff) {
2691 if (xas_retry(&xas, page))
2692 continue;
2693 if (xa_is_value(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002694 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002695
Michal Hockoe0975b22018-12-28 00:38:36 -08002696 /*
2697 * Check for a locked page first, as a speculative
2698 * reference may adversely influence page migration.
2699 */
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002700 if (PageLocked(page))
Michal Hockoe0975b22018-12-28 00:38:36 -08002701 goto next;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002702 if (!page_cache_get_speculative(page))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002703 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002704
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002705 /* Has the page moved or been split? */
Matthew Wilcox070e8072018-05-17 00:08:30 -04002706 if (unlikely(page != xas_reload(&xas)))
2707 goto skip;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002708 page = find_subpage(page, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002709
2710 if (!PageUptodate(page) ||
2711 PageReadahead(page) ||
2712 PageHWPoison(page))
2713 goto skip;
2714 if (!trylock_page(page))
2715 goto skip;
2716
2717 if (page->mapping != mapping || !PageUptodate(page))
2718 goto unlock;
2719
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002720 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2721 if (page->index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002722 goto unlock;
2723
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002724 if (file->f_ra.mmap_miss > 0)
2725 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002726
Matthew Wilcox070e8072018-05-17 00:08:30 -04002727 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002728 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002729 vmf->pte += xas.xa_index - last_pgoff;
2730 last_pgoff = xas.xa_index;
Johannes Weiner9d82c692020-06-03 16:02:04 -07002731 if (alloc_set_pte(vmf, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002732 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002733 unlock_page(page);
2734 goto next;
2735unlock:
2736 unlock_page(page);
2737skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002738 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002739next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002740 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002741 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002742 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002743 }
2744 rcu_read_unlock();
2745}
2746EXPORT_SYMBOL(filemap_map_pages);
2747
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002748vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002749{
2750 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002751 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002752 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002753
Jan Kara14da9202012-06-12 16:20:37 +02002754 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002755 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002756 lock_page(page);
2757 if (page->mapping != inode->i_mapping) {
2758 unlock_page(page);
2759 ret = VM_FAULT_NOPAGE;
2760 goto out;
2761 }
Jan Kara14da9202012-06-12 16:20:37 +02002762 /*
2763 * We mark the page dirty already here so that when freeze is in
2764 * progress, we are guaranteed that writeback during freezing will
2765 * see the dirty page and writeprotect it again.
2766 */
2767 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002768 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002769out:
Jan Kara14da9202012-06-12 16:20:37 +02002770 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002771 return ret;
2772}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002773
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002774const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002775 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002776 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002777 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002778};
2779
2780/* This is used for a general mmap of a disk file */
2781
2782int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2783{
2784 struct address_space *mapping = file->f_mapping;
2785
2786 if (!mapping->a_ops->readpage)
2787 return -ENOEXEC;
2788 file_accessed(file);
2789 vma->vm_ops = &generic_file_vm_ops;
2790 return 0;
2791}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792
2793/*
2794 * This is for filesystems which do not implement ->writepage.
2795 */
2796int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2797{
2798 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2799 return -EINVAL;
2800 return generic_file_mmap(file, vma);
2801}
2802#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002803vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann453972282018-04-13 15:35:27 -07002804{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002805 return VM_FAULT_SIGBUS;
Arnd Bergmann453972282018-04-13 15:35:27 -07002806}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002807int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2808{
2809 return -ENOSYS;
2810}
2811int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2812{
2813 return -ENOSYS;
2814}
2815#endif /* CONFIG_MMU */
2816
Arnd Bergmann453972282018-04-13 15:35:27 -07002817EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002818EXPORT_SYMBOL(generic_file_mmap);
2819EXPORT_SYMBOL(generic_file_readonly_mmap);
2820
Sasha Levin67f9fd92014-04-03 14:48:18 -07002821static struct page *wait_on_page_read(struct page *page)
2822{
2823 if (!IS_ERR(page)) {
2824 wait_on_page_locked(page);
2825 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002826 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002827 page = ERR_PTR(-EIO);
2828 }
2829 }
2830 return page;
2831}
2832
Mel Gorman32b63522016-03-15 14:55:36 -07002833static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002834 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002835 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002836 void *data,
2837 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002838{
Nick Piggineb2be182007-10-16 01:24:57 -07002839 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002840 int err;
2841repeat:
2842 page = find_get_page(mapping, index);
2843 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08002844 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002845 if (!page)
2846 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002847 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002848 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002849 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002850 if (err == -EEXIST)
2851 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05002852 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 return ERR_PTR(err);
2854 }
Mel Gorman32b63522016-03-15 14:55:36 -07002855
2856filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002857 if (filler)
2858 err = filler(data, page);
2859 else
2860 err = mapping->a_ops->readpage(data, page);
2861
Linus Torvalds1da177e2005-04-16 15:20:36 -07002862 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002863 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002864 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002865 }
Mel Gorman32b63522016-03-15 14:55:36 -07002866
2867 page = wait_on_page_read(page);
2868 if (IS_ERR(page))
2869 return page;
2870 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002871 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002872 if (PageUptodate(page))
2873 goto out;
2874
Mel Gormanebded022016-03-15 14:55:39 -07002875 /*
2876 * Page is not up to date and may be locked due one of the following
2877 * case a: Page is being filled and the page lock is held
2878 * case b: Read/write error clearing the page uptodate status
2879 * case c: Truncation in progress (page locked)
2880 * case d: Reclaim in progress
2881 *
2882 * Case a, the page will be up to date when the page is unlocked.
2883 * There is no need to serialise on the page lock here as the page
2884 * is pinned so the lock gives no additional protection. Even if the
2885 * the page is truncated, the data is still valid if PageUptodate as
2886 * it's a race vs truncate race.
2887 * Case b, the page will not be up to date
2888 * Case c, the page may be truncated but in itself, the data may still
2889 * be valid after IO completes as it's a read vs truncate race. The
2890 * operation must restart if the page is not uptodate on unlock but
2891 * otherwise serialising on page lock to stabilise the mapping gives
2892 * no additional guarantees to the caller as the page lock is
2893 * released before return.
2894 * Case d, similar to truncation. If reclaim holds the page lock, it
2895 * will be a race with remove_mapping that determines if the mapping
2896 * is valid on unlock but otherwise the data is valid and there is
2897 * no need to serialise with page lock.
2898 *
2899 * As the page lock gives no additional guarantee, we optimistically
2900 * wait on the page to be unlocked and check if it's up to date and
2901 * use the page if it is. Otherwise, the page lock is required to
2902 * distinguish between the different cases. The motivation is that we
2903 * avoid spurious serialisations and wakeups when multiple processes
2904 * wait on the same page for IO to complete.
2905 */
2906 wait_on_page_locked(page);
2907 if (PageUptodate(page))
2908 goto out;
2909
2910 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002911 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002912
2913 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002914 if (!page->mapping) {
2915 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002916 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002917 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002918 }
Mel Gormanebded022016-03-15 14:55:39 -07002919
2920 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002921 if (PageUptodate(page)) {
2922 unlock_page(page);
2923 goto out;
2924 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07002925
2926 /*
2927 * A previous I/O error may have been due to temporary
2928 * failures.
2929 * Clear page error before actual read, PG_error will be
2930 * set again if read page fails.
2931 */
2932 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002933 goto filler;
2934
David Howellsc855ff32007-05-09 13:42:20 +01002935out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002936 mark_page_accessed(page);
2937 return page;
2938}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002939
2940/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002941 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002942 * @mapping: the page's address_space
2943 * @index: the page index
2944 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002945 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002946 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002947 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002948 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002949 *
2950 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002951 *
2952 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002953 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002954struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002955 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002956 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002957 void *data)
2958{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07002959 return do_read_cache_page(mapping, index, filler, data,
2960 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002961}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002962EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002963
2964/**
2965 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2966 * @mapping: the page's address_space
2967 * @index: the page index
2968 * @gfp: the page allocator flags to use if allocating
2969 *
2970 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002971 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002972 *
2973 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002974 *
2975 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002976 */
2977struct page *read_cache_page_gfp(struct address_space *mapping,
2978 pgoff_t index,
2979 gfp_t gfp)
2980{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002981 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002982}
2983EXPORT_SYMBOL(read_cache_page_gfp);
2984
Nick Piggin2f718ff2007-10-16 01:24:59 -07002985/*
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002986 * Don't operate on ranges the page cache doesn't support, and don't exceed the
2987 * LFS limits. If pos is under the limit it becomes a short access. If it
2988 * exceeds the limit we return -EFBIG.
2989 */
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002990static int generic_write_check_limits(struct file *file, loff_t pos,
2991 loff_t *count)
2992{
Amir Goldstein646955c2019-06-05 08:04:48 -07002993 struct inode *inode = file->f_mapping->host;
2994 loff_t max_size = inode->i_sb->s_maxbytes;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002995 loff_t limit = rlimit(RLIMIT_FSIZE);
2996
2997 if (limit != RLIM_INFINITY) {
2998 if (pos >= limit) {
2999 send_sig(SIGXFSZ, current, 0);
3000 return -EFBIG;
3001 }
3002 *count = min(*count, limit - pos);
3003 }
3004
Amir Goldstein646955c2019-06-05 08:04:48 -07003005 if (!(file->f_flags & O_LARGEFILE))
3006 max_size = MAX_NON_LFS;
3007
3008 if (unlikely(pos >= max_size))
3009 return -EFBIG;
3010
3011 *count = min(*count, max_size - pos);
3012
3013 return 0;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003014}
3015
3016/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017 * Performs necessary checks before doing a write
3018 *
Randy Dunlap485bb992006-06-23 02:03:49 -07003019 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020 * Returns appropriate error code that caller should return or
3021 * zero in case that write should be allowed.
3022 */
Al Viro3309dd02015-04-09 12:55:47 -04003023inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003024{
Al Viro3309dd02015-04-09 12:55:47 -04003025 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026 struct inode *inode = file->f_mapping->host;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003027 loff_t count;
3028 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003029
Darrick J. Wongdc617f22019-08-20 07:55:16 -07003030 if (IS_SWAPFILE(inode))
3031 return -ETXTBSY;
3032
Al Viro3309dd02015-04-09 12:55:47 -04003033 if (!iov_iter_count(from))
3034 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003035
Al Viro0fa6b002015-04-04 04:05:48 -04003036 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04003037 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04003038 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003039
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003040 if ((iocb->ki_flags & IOCB_NOWAIT) && !(iocb->ki_flags & IOCB_DIRECT))
3041 return -EINVAL;
3042
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003043 count = iov_iter_count(from);
3044 ret = generic_write_check_limits(file, iocb->ki_pos, &count);
3045 if (ret)
3046 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003047
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003048 iov_iter_truncate(from, count);
Al Viro3309dd02015-04-09 12:55:47 -04003049 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003050}
3051EXPORT_SYMBOL(generic_write_checks);
3052
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003053/*
3054 * Performs necessary checks before doing a clone.
3055 *
Amir Goldstein646955c2019-06-05 08:04:48 -07003056 * Can adjust amount of bytes to clone via @req_count argument.
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003057 * Returns appropriate error code that caller should return or
3058 * zero in case the clone should be allowed.
3059 */
3060int generic_remap_checks(struct file *file_in, loff_t pos_in,
3061 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11003062 loff_t *req_count, unsigned int remap_flags)
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003063{
3064 struct inode *inode_in = file_in->f_mapping->host;
3065 struct inode *inode_out = file_out->f_mapping->host;
3066 uint64_t count = *req_count;
3067 uint64_t bcount;
3068 loff_t size_in, size_out;
3069 loff_t bs = inode_out->i_sb->s_blocksize;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003070 int ret;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003071
3072 /* The start of both ranges must be aligned to an fs block. */
3073 if (!IS_ALIGNED(pos_in, bs) || !IS_ALIGNED(pos_out, bs))
3074 return -EINVAL;
3075
3076 /* Ensure offsets don't wrap. */
3077 if (pos_in + count < pos_in || pos_out + count < pos_out)
3078 return -EINVAL;
3079
3080 size_in = i_size_read(inode_in);
3081 size_out = i_size_read(inode_out);
3082
3083 /* Dedupe requires both ranges to be within EOF. */
Darrick J. Wong3d281932018-10-30 10:41:34 +11003084 if ((remap_flags & REMAP_FILE_DEDUP) &&
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003085 (pos_in >= size_in || pos_in + count > size_in ||
3086 pos_out >= size_out || pos_out + count > size_out))
3087 return -EINVAL;
3088
3089 /* Ensure the infile range is within the infile. */
3090 if (pos_in >= size_in)
3091 return -EINVAL;
3092 count = min(count, size_in - (uint64_t)pos_in);
3093
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003094 ret = generic_write_check_limits(file_out, pos_out, &count);
3095 if (ret)
3096 return ret;
3097
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003098 /*
3099 * If the user wanted us to link to the infile's EOF, round up to the
3100 * next block boundary for this check.
3101 *
3102 * Otherwise, make sure the count is also block-aligned, having
3103 * already confirmed the starting offsets' block alignment.
3104 */
3105 if (pos_in + count == size_in) {
3106 bcount = ALIGN(size_in, bs) - pos_in;
3107 } else {
3108 if (!IS_ALIGNED(count, bs))
Darrick J. Wongeca36542018-10-30 10:42:10 +11003109 count = ALIGN_DOWN(count, bs);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003110 bcount = count;
3111 }
3112
3113 /* Don't allow overlapped cloning within the same file. */
3114 if (inode_in == inode_out &&
3115 pos_out + bcount > pos_in &&
3116 pos_out < pos_in + bcount)
3117 return -EINVAL;
3118
Darrick J. Wongeca36542018-10-30 10:42:10 +11003119 /*
3120 * We shortened the request but the caller can't deal with that, so
3121 * bounce the request back to userspace.
3122 */
3123 if (*req_count != count && !(remap_flags & REMAP_FILE_CAN_SHORTEN))
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003124 return -EINVAL;
3125
Darrick J. Wongeca36542018-10-30 10:42:10 +11003126 *req_count = count;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003127 return 0;
3128}
3129
Amir Goldsteina3171352019-06-05 08:04:48 -07003130
3131/*
3132 * Performs common checks before doing a file copy/clone
3133 * from @file_in to @file_out.
3134 */
3135int generic_file_rw_checks(struct file *file_in, struct file *file_out)
3136{
3137 struct inode *inode_in = file_inode(file_in);
3138 struct inode *inode_out = file_inode(file_out);
3139
3140 /* Don't copy dirs, pipes, sockets... */
3141 if (S_ISDIR(inode_in->i_mode) || S_ISDIR(inode_out->i_mode))
3142 return -EISDIR;
3143 if (!S_ISREG(inode_in->i_mode) || !S_ISREG(inode_out->i_mode))
3144 return -EINVAL;
3145
3146 if (!(file_in->f_mode & FMODE_READ) ||
3147 !(file_out->f_mode & FMODE_WRITE) ||
3148 (file_out->f_flags & O_APPEND))
3149 return -EBADF;
3150
3151 return 0;
3152}
3153
Amir Goldstein96e6e8f2019-06-05 08:04:49 -07003154/*
3155 * Performs necessary checks before doing a file copy
3156 *
3157 * Can adjust amount of bytes to copy via @req_count argument.
3158 * Returns appropriate error code that caller should return or
3159 * zero in case the copy should be allowed.
3160 */
3161int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3162 struct file *file_out, loff_t pos_out,
3163 size_t *req_count, unsigned int flags)
3164{
3165 struct inode *inode_in = file_inode(file_in);
3166 struct inode *inode_out = file_inode(file_out);
3167 uint64_t count = *req_count;
3168 loff_t size_in;
3169 int ret;
3170
3171 ret = generic_file_rw_checks(file_in, file_out);
3172 if (ret)
3173 return ret;
3174
3175 /* Don't touch certain kinds of inodes */
3176 if (IS_IMMUTABLE(inode_out))
3177 return -EPERM;
3178
3179 if (IS_SWAPFILE(inode_in) || IS_SWAPFILE(inode_out))
3180 return -ETXTBSY;
3181
3182 /* Ensure offsets don't wrap. */
3183 if (pos_in + count < pos_in || pos_out + count < pos_out)
3184 return -EOVERFLOW;
3185
3186 /* Shorten the copy to EOF */
3187 size_in = i_size_read(inode_in);
3188 if (pos_in >= size_in)
3189 count = 0;
3190 else
3191 count = min(count, size_in - (uint64_t)pos_in);
3192
3193 ret = generic_write_check_limits(file_out, pos_out, &count);
3194 if (ret)
3195 return ret;
3196
3197 /* Don't allow overlapped copying within the same file. */
3198 if (inode_in == inode_out &&
3199 pos_out + count > pos_in &&
3200 pos_out < pos_in + count)
3201 return -EINVAL;
3202
3203 *req_count = count;
3204 return 0;
3205}
3206
Nick Pigginafddba42007-10-16 01:25:01 -07003207int pagecache_write_begin(struct file *file, struct address_space *mapping,
3208 loff_t pos, unsigned len, unsigned flags,
3209 struct page **pagep, void **fsdata)
3210{
3211 const struct address_space_operations *aops = mapping->a_ops;
3212
Nick Piggin4e02ed42008-10-29 14:00:55 -07003213 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003214 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003215}
3216EXPORT_SYMBOL(pagecache_write_begin);
3217
3218int pagecache_write_end(struct file *file, struct address_space *mapping,
3219 loff_t pos, unsigned len, unsigned copied,
3220 struct page *page, void *fsdata)
3221{
3222 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003223
Nick Piggin4e02ed42008-10-29 14:00:55 -07003224 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003225}
3226EXPORT_SYMBOL(pagecache_write_end);
3227
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003228/*
3229 * Warn about a page cache invalidation failure during a direct I/O write.
3230 */
3231void dio_warn_stale_pagecache(struct file *filp)
3232{
3233 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3234 char pathname[128];
3235 struct inode *inode = file_inode(filp);
3236 char *path;
3237
3238 errseq_set(&inode->i_mapping->wb_err, -EIO);
3239 if (__ratelimit(&_rs)) {
3240 path = file_path(filp, pathname, sizeof(pathname));
3241 if (IS_ERR(path))
3242 path = "(unknown)";
3243 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3244 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3245 current->comm);
3246 }
3247}
3248
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003250generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003251{
3252 struct file *file = iocb->ki_filp;
3253 struct address_space *mapping = file->f_mapping;
3254 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003255 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003256 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003257 size_t write_len;
3258 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259
Al Viro0c949332014-03-22 06:51:37 -04003260 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003261 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003262
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003263 if (iocb->ki_flags & IOCB_NOWAIT) {
3264 /* If there are pages to writeback, return */
3265 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003266 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003267 return -EAGAIN;
3268 } else {
3269 written = filemap_write_and_wait_range(mapping, pos,
3270 pos + write_len - 1);
3271 if (written)
3272 goto out;
3273 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003274
3275 /*
3276 * After a write we want buffered reads to be sure to go to disk to get
3277 * the new data. We invalidate clean cached page from the region we're
3278 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003279 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003280 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003281 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003282 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003283 /*
3284 * If a page can not be invalidated, return 0 to fall back
3285 * to buffered write.
3286 */
3287 if (written) {
3288 if (written == -EBUSY)
3289 return 0;
3290 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003291 }
3292
Al Viro639a93a52017-04-13 14:10:15 -04003293 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003294
3295 /*
3296 * Finally, try again to invalidate clean pages which might have been
3297 * cached by non-direct readahead, or faulted in by get_user_pages()
3298 * if the source of the write was an mmap'ed region of the file
3299 * we're writing. Either one is a pretty crazy thing to do,
3300 * so we don't support it 100%. If this invalidation
3301 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003302 *
3303 * Most of the time we do not need this since dio_complete() will do
3304 * the invalidation for us. However there are some file systems that
3305 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003306 * them by removing it completely.
3307 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003308 * Noticeable example is a blkdev_direct_IO().
3309 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003310 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003311 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003312 if (written > 0 && mapping->nrpages &&
3313 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3314 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003315
Linus Torvalds1da177e2005-04-16 15:20:36 -07003316 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003317 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003318 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003319 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3320 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003321 mark_inode_dirty(inode);
3322 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003323 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003324 }
Al Viro639a93a52017-04-13 14:10:15 -04003325 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003326out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003327 return written;
3328}
3329EXPORT_SYMBOL(generic_file_direct_write);
3330
Nick Piggineb2be182007-10-16 01:24:57 -07003331/*
3332 * Find or create a page at the given pagecache position. Return the locked
3333 * page. This function is specifically for buffered writes.
3334 */
Nick Piggin54566b22009-01-04 12:00:53 -08003335struct page *grab_cache_page_write_begin(struct address_space *mapping,
3336 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003337{
Nick Piggineb2be182007-10-16 01:24:57 -07003338 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003339 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003340
Nick Piggin54566b22009-01-04 12:00:53 -08003341 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003342 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003343
Mel Gorman2457aec2014-06-04 16:10:31 -07003344 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003345 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003346 if (page)
3347 wait_for_stable_page(page);
3348
Nick Piggineb2be182007-10-16 01:24:57 -07003349 return page;
3350}
Nick Piggin54566b22009-01-04 12:00:53 -08003351EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003352
Al Viro3b93f912014-02-11 21:34:08 -05003353ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003354 struct iov_iter *i, loff_t pos)
3355{
3356 struct address_space *mapping = file->f_mapping;
3357 const struct address_space_operations *a_ops = mapping->a_ops;
3358 long status = 0;
3359 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003360 unsigned int flags = 0;
3361
Nick Pigginafddba42007-10-16 01:25:01 -07003362 do {
3363 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003364 unsigned long offset; /* Offset into pagecache page */
3365 unsigned long bytes; /* Bytes to write to page */
3366 size_t copied; /* Bytes copied from user */
3367 void *fsdata;
3368
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003369 offset = (pos & (PAGE_SIZE - 1));
3370 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003371 iov_iter_count(i));
3372
3373again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003374 /*
3375 * Bring in the user page that we will copy from _first_.
3376 * Otherwise there's a nasty deadlock on copying from the
3377 * same page as we're writing to, without it being marked
3378 * up-to-date.
3379 *
3380 * Not only is this an optimisation, but it is also required
3381 * to check that the address is actually valid, when atomic
3382 * usercopies are used, below.
3383 */
3384 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3385 status = -EFAULT;
3386 break;
3387 }
3388
Jan Kara296291c2015-10-22 13:32:21 -07003389 if (fatal_signal_pending(current)) {
3390 status = -EINTR;
3391 break;
3392 }
3393
Nick Piggin674b8922007-10-16 01:25:03 -07003394 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003395 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003396 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003397 break;
3398
anfei zhou931e80e2010-02-02 13:44:02 -08003399 if (mapping_writably_mapped(mapping))
3400 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003401
Nick Pigginafddba42007-10-16 01:25:01 -07003402 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003403 flush_dcache_page(page);
3404
3405 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3406 page, fsdata);
3407 if (unlikely(status < 0))
3408 break;
3409 copied = status;
3410
3411 cond_resched();
3412
Nick Piggin124d3b72008-02-02 15:01:17 +01003413 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003414 if (unlikely(copied == 0)) {
3415 /*
3416 * If we were unable to copy any data at all, we must
3417 * fall back to a single segment length write.
3418 *
3419 * If we didn't fallback here, we could livelock
3420 * because not all segments in the iov can be copied at
3421 * once without a pagefault.
3422 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003423 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003424 iov_iter_single_seg_count(i));
3425 goto again;
3426 }
Nick Pigginafddba42007-10-16 01:25:01 -07003427 pos += copied;
3428 written += copied;
3429
3430 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003431 } while (iov_iter_count(i));
3432
3433 return written ? written : status;
3434}
Al Viro3b93f912014-02-11 21:34:08 -05003435EXPORT_SYMBOL(generic_perform_write);
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 (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003440 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003441 *
3442 * This function does all the work needed for actually writing data to a
3443 * file. It does all basic checks, removes SUID from the file, updates
3444 * modification times and calls proper subroutines depending on whether we
3445 * do direct IO or a standard buffered write.
3446 *
3447 * It expects i_mutex to be grabbed unless we work on a block device or similar
3448 * object which does not need locking at all.
3449 *
3450 * This function does *not* take care of syncing data in case of O_SYNC write.
3451 * A caller has to handle it. This is mainly due to the fact that we want to
3452 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003453 *
3454 * Return:
3455 * * number of bytes written, even for truncated writes
3456 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003457 */
Al Viro81742022014-04-03 03:17:43 -04003458ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003459{
3460 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003461 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003462 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003463 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003464 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003465 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003466
Linus Torvalds1da177e2005-04-16 15:20:36 -07003467 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003468 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003469 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003470 if (err)
3471 goto out;
3472
Josef Bacikc3b2da32012-03-26 09:59:21 -04003473 err = file_update_time(file);
3474 if (err)
3475 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003476
Al Viro2ba48ce2015-04-09 13:52:01 -04003477 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003478 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003479
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003480 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003481 /*
3482 * If the write stopped short of completing, fall back to
3483 * buffered writes. Some filesystems do this for writes to
3484 * holes, for example. For DAX files, a buffered write will
3485 * not succeed (even if it did, DAX does not handle dirty
3486 * page-cache pages correctly).
3487 */
Al Viro0b8def92015-04-07 10:22:53 -04003488 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003490
Al Viro0b8def92015-04-07 10:22:53 -04003491 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003492 /*
Al Viro3b93f912014-02-11 21:34:08 -05003493 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003494 * then we want to return the number of bytes which were
3495 * direct-written, or the error code if that was zero. Note
3496 * that this differs from normal direct-io semantics, which
3497 * will return -EFOO even if some bytes were written.
3498 */
Al Viro60bb4522014-08-08 12:39:16 -04003499 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003500 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003501 goto out;
3502 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003503 /*
3504 * We need to ensure that the page cache pages are written to
3505 * disk and invalidated to preserve the expected O_DIRECT
3506 * semantics.
3507 */
Al Viro3b93f912014-02-11 21:34:08 -05003508 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003509 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003510 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003511 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003512 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003513 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003514 pos >> PAGE_SHIFT,
3515 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003516 } else {
3517 /*
3518 * We don't know how much we wrote, so just return
3519 * the number of bytes which were direct-written
3520 */
3521 }
3522 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003523 written = generic_perform_write(file, from, iocb->ki_pos);
3524 if (likely(written > 0))
3525 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003526 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003527out:
3528 current->backing_dev_info = NULL;
3529 return written ? written : err;
3530}
Al Viro81742022014-04-03 03:17:43 -04003531EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003532
Jan Karae4dd9de2009-08-17 18:10:06 +02003533/**
Al Viro81742022014-04-03 03:17:43 -04003534 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003535 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003536 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003537 *
Al Viro81742022014-04-03 03:17:43 -04003538 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003539 * filesystems. It takes care of syncing the file in case of O_SYNC file
3540 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003541 * Return:
3542 * * negative error code if no data has been written at all of
3543 * vfs_fsync_range() failed for a synchronous write
3544 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003545 */
Al Viro81742022014-04-03 03:17:43 -04003546ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003547{
3548 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003549 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003550 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003551
Al Viro59551022016-01-22 15:40:57 -05003552 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003553 ret = generic_write_checks(iocb, from);
3554 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003555 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003556 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003557
Christoph Hellwige2592212016-04-07 08:52:01 -07003558 if (ret > 0)
3559 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003560 return ret;
3561}
Al Viro81742022014-04-03 03:17:43 -04003562EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003563
David Howellscf9a2ae2006-08-29 19:05:54 +01003564/**
3565 * try_to_release_page() - release old fs-specific metadata on a page
3566 *
3567 * @page: the page which the kernel is trying to free
3568 * @gfp_mask: memory allocation flags (and I/O mode)
3569 *
3570 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003571 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003572 *
David Howells266cf652009-04-03 16:42:36 +01003573 * This may also be called if PG_fscache is set on a page, indicating that the
3574 * page is known to the local caching routines.
3575 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003576 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003577 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003578 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003579 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003580 */
3581int try_to_release_page(struct page *page, gfp_t gfp_mask)
3582{
3583 struct address_space * const mapping = page->mapping;
3584
3585 BUG_ON(!PageLocked(page));
3586 if (PageWriteback(page))
3587 return 0;
3588
3589 if (mapping && mapping->a_ops->releasepage)
3590 return mapping->a_ops->releasepage(page, gfp_mask);
3591 return try_to_free_buffers(page);
3592}
3593
3594EXPORT_SYMBOL(try_to_release_page);