blob: 8c3d3e233d372bcf553584202de4ef0cd0a2460b [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8/*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040013#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070014#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080015#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/fs.h>
Ingo Molnar3f07c012017-02-08 18:51:30 +010017#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070018#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080019#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090021#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022#include <linux/mm.h>
23#include <linux/swap.h>
24#include <linux/mman.h>
25#include <linux/pagemap.h>
26#include <linux/file.h>
27#include <linux/uio.h>
Josef Bacikcfcbfb12019-05-13 17:21:04 -070028#include <linux/error-injection.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/hash.h>
30#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070031#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080035#include <linux/cpuset.h>
Johannes Weiner00501b52014-08-08 14:19:20 -070036#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080037#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060038#include <linux/cleancache.h>
Mel Gormanc7df8ad2017-11-15 17:37:41 -080039#include <linux/shmem_fs.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070040#include <linux/rmap.h>
Johannes Weinerb1d29ba2018-10-26 15:06:08 -070041#include <linux/delayacct.h>
Johannes Weinereb414682018-10-26 15:06:27 -070042#include <linux/psi.h>
Ben Dooksd0e6a582019-10-18 20:20:20 -070043#include <linux/ramfs.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080044#include "internal.h"
45
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070046#define CREATE_TRACE_POINTS
47#include <trace/events/filemap.h>
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070050 * FIXME: remove all knowledge of the buffer layer from the core VM
51 */
Jan Kara148f9482009-08-17 19:52:36 +020052#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <asm/mman.h>
55
56/*
57 * Shared mappings implemented 30.11.1994. It's not fully working yet,
58 * though.
59 *
60 * Shared mappings now work. 15.8.1995 Bruno.
61 *
62 * finished 'unifying' the page and buffer cache and SMP-threaded the
63 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
64 *
65 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
66 */
67
68/*
69 * Lock ordering:
70 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080071 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070073 * ->swap_lock (exclusive_swap_page, others)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070074 * ->i_pages lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080076 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080077 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070079 * ->mmap_lock
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080080 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070081 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070082 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070084 * ->mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 * ->lock_page (access_process_vm)
86 *
Al Viroccad2362014-02-11 22:36:48 -050087 * ->i_mutex (generic_perform_write)
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -070088 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060090 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110091 * sb_lock (fs/fs-writeback.c)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -070092 * ->i_pages lock (__sync_single_inode)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080094 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * ->anon_vma.lock (vma_adjust)
96 *
97 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070098 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700100 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -0700101 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 * ->private_lock (try_to_unmap_one)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700103 * ->i_pages lock (try_to_unmap_one)
Andrey Ryabininf4b7e272019-03-05 15:49:39 -0800104 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
105 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 * ->private_lock (page_remove_rmap->set_page_dirty)
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700107 * ->i_pages lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600108 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100109 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700110 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600111 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100112 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
114 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800115 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700116 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 */
118
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500119static void page_cache_delete(struct address_space *mapping,
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700120 struct page *page, void *shadow)
121{
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500122 XA_STATE(xas, &mapping->i_pages, page->index);
123 unsigned int nr = 1;
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800124
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500125 mapping_set_update(&xas, mapping);
126
127 /* hugetlb pages are represented by a single entry in the xarray */
128 if (!PageHuge(page)) {
129 xas_set_order(&xas, page->index, compound_order(page));
Matthew Wilcox (Oracle)d8c65462019-09-23 15:34:30 -0700130 nr = compound_nr(page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500131 }
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700132
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700133 VM_BUG_ON_PAGE(!PageLocked(page), page);
134 VM_BUG_ON_PAGE(PageTail(page), page);
135 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700136
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500137 xas_store(&xas, shadow);
138 xas_init_marks(&xas);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200139
Jan Kara23006382017-11-15 17:37:26 -0800140 page->mapping = NULL;
141 /* Leave page->index set: truncation lookup relies upon it */
142
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200143 if (shadow) {
144 mapping->nrexceptional += nr;
145 /*
146 * Make sure the nrexceptional update is committed before
147 * the nrpages update so that final truncate racing
148 * with reclaim does not see both counters 0 at the
149 * same time and miss a shadow entry.
150 */
151 smp_wmb();
152 }
153 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700154}
155
Jan Kara5ecc4d82017-11-15 17:37:29 -0800156static void unaccount_page_cache_page(struct address_space *mapping,
157 struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
Jan Kara5ecc4d82017-11-15 17:37:29 -0800159 int nr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600161 /*
162 * if we're uptodate, flush out into the cleancache, otherwise
163 * invalidate any existing cleancache entries. We can't leave
164 * stale data around in the cleancache once our page is gone
165 */
166 if (PageUptodate(page) && PageMappedToDisk(page))
167 cleancache_put_page(page);
168 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400169 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600170
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700171 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800172 VM_BUG_ON_PAGE(page_mapped(page), page);
173 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
174 int mapcount;
175
176 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
177 current->comm, page_to_pfn(page));
178 dump_page(page, "still mapped when deleted");
179 dump_stack();
180 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
181
182 mapcount = page_mapcount(page);
183 if (mapping_exiting(mapping) &&
184 page_count(page) >= mapcount + 2) {
185 /*
186 * All vmas have already been torn down, so it's
187 * a good bet that actually the page is unmapped,
188 * and we'd prefer not to leak it: if we're wrong,
189 * some other bad page check should catch it later.
190 */
191 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700192 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800193 }
194 }
195
Jan Kara76253fb2017-11-15 17:37:22 -0800196 /* hugetlb pages do not participate in page cache accounting. */
Jan Kara5ecc4d82017-11-15 17:37:29 -0800197 if (PageHuge(page))
198 return;
Jan Kara76253fb2017-11-15 17:37:22 -0800199
Jan Kara5ecc4d82017-11-15 17:37:29 -0800200 nr = hpage_nr_pages(page);
201
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700202 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800203 if (PageSwapBacked(page)) {
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700204 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
Jan Kara5ecc4d82017-11-15 17:37:29 -0800205 if (PageTransHuge(page))
206 __dec_node_page_state(page, NR_SHMEM_THPS);
Song Liu99cb0db2019-09-23 15:38:00 -0700207 } else if (PageTransHuge(page)) {
208 __dec_node_page_state(page, NR_FILE_THPS);
Song Liu09d91cd2019-09-23 15:38:03 -0700209 filemap_nr_thps_dec(mapping);
Jan Kara76253fb2017-11-15 17:37:22 -0800210 }
Jan Kara5ecc4d82017-11-15 17:37:29 -0800211
212 /*
213 * At this point page must be either written or cleaned by
214 * truncate. Dirty page here signals a bug and loss of
215 * unwritten data.
216 *
217 * This fixes dirty accounting after removing the page entirely
218 * but leaves PageDirty set: it has no effect for truncated
219 * page and anyway will be cleared before returning page into
220 * buddy allocator.
221 */
222 if (WARN_ON_ONCE(PageDirty(page)))
223 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
224}
225
226/*
227 * Delete a page from the page cache and free it. Caller has to make
228 * sure the page is locked and that nobody else uses it - or that usage
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700229 * is safe. The caller must hold the i_pages lock.
Jan Kara5ecc4d82017-11-15 17:37:29 -0800230 */
231void __delete_from_page_cache(struct page *page, void *shadow)
232{
233 struct address_space *mapping = page->mapping;
234
235 trace_mm_filemap_delete_from_page_cache(page);
236
237 unaccount_page_cache_page(mapping, page);
Matthew Wilcox5c024e6a2017-11-21 09:17:59 -0500238 page_cache_delete(mapping, page, shadow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239}
240
Jan Kara59c66c52017-11-15 17:37:18 -0800241static void page_cache_free_page(struct address_space *mapping,
242 struct page *page)
243{
244 void (*freepage)(struct page *);
245
246 freepage = mapping->a_ops->freepage;
247 if (freepage)
248 freepage(page);
249
250 if (PageTransHuge(page) && !PageHuge(page)) {
251 page_ref_sub(page, HPAGE_PMD_NR);
252 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
253 } else {
254 put_page(page);
255 }
256}
257
Minchan Kim702cfbf2011-03-22 16:32:43 -0700258/**
259 * delete_from_page_cache - delete page from page cache
260 * @page: the page which the kernel is trying to remove from page cache
261 *
262 * This must be called only on pages that have been verified to be in the page
263 * cache and locked. It will never put the page into the free list, the caller
264 * has a reference on the page.
265 */
266void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700268 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400269 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Matt Mackallcd7619d2005-05-01 08:59:01 -0700271 BUG_ON(!PageLocked(page));
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700272 xa_lock_irqsave(&mapping->i_pages, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700273 __delete_from_page_cache(page, NULL);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700274 xa_unlock_irqrestore(&mapping->i_pages, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500275
Jan Kara59c66c52017-11-15 17:37:18 -0800276 page_cache_free_page(mapping, page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700277}
278EXPORT_SYMBOL(delete_from_page_cache);
279
Jan Karaaa65c292017-11-15 17:37:33 -0800280/*
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500281 * page_cache_delete_batch - delete several pages from page cache
Jan Karaaa65c292017-11-15 17:37:33 -0800282 * @mapping: the mapping to which pages belong
283 * @pvec: pagevec with pages to delete
284 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700285 * The function walks over mapping->i_pages and removes pages passed in @pvec
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700286 * from the mapping. The function expects @pvec to be sorted by page index
287 * and is optimised for it to be dense.
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700288 * It tolerates holes in @pvec (mapping entries at those indices are not
Jan Karaaa65c292017-11-15 17:37:33 -0800289 * modified). The function expects only THP head pages to be present in the
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700290 * @pvec.
Jan Karaaa65c292017-11-15 17:37:33 -0800291 *
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700292 * The function expects the i_pages lock to be held.
Jan Karaaa65c292017-11-15 17:37:33 -0800293 */
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500294static void page_cache_delete_batch(struct address_space *mapping,
Jan Karaaa65c292017-11-15 17:37:33 -0800295 struct pagevec *pvec)
296{
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500297 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
Jan Karaaa65c292017-11-15 17:37:33 -0800298 int total_pages = 0;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700299 int i = 0;
Jan Karaaa65c292017-11-15 17:37:33 -0800300 struct page *page;
Jan Karaaa65c292017-11-15 17:37:33 -0800301
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500302 mapping_set_update(&xas, mapping);
303 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700304 if (i >= pagevec_count(pvec))
Jan Karaaa65c292017-11-15 17:37:33 -0800305 break;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700306
307 /* A swap/dax/shadow entry got inserted? Skip it. */
Matthew Wilcox3159f942017-11-03 13:30:42 -0400308 if (xa_is_value(page))
Jan Karaaa65c292017-11-15 17:37:33 -0800309 continue;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700310 /*
311 * A page got inserted in our range? Skip it. We have our
312 * pages locked so they are protected from being removed.
313 * If we see a page whose index is higher than ours, it
314 * means our page has been removed, which shouldn't be
315 * possible because we're holding the PageLock.
316 */
317 if (page != pvec->pages[i]) {
318 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
319 page);
320 continue;
Linus Torvalds69bf4b62019-07-05 19:55:18 -0700321 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -0700322
323 WARN_ON_ONCE(!PageLocked(page));
324
325 if (page->index == xas.xa_index)
326 page->mapping = NULL;
327 /* Leave page->index set: truncation lookup relies on it */
328
329 /*
330 * Move to the next page in the vector if this is a regular
331 * page or the index is of the last sub-page of this compound
332 * page.
333 */
334 if (page->index + compound_nr(page) - 1 == xas.xa_index)
335 i++;
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500336 xas_store(&xas, NULL);
Jan Karaaa65c292017-11-15 17:37:33 -0800337 total_pages++;
338 }
339 mapping->nrpages -= total_pages;
340}
341
342void delete_from_page_cache_batch(struct address_space *mapping,
343 struct pagevec *pvec)
344{
345 int i;
346 unsigned long flags;
347
348 if (!pagevec_count(pvec))
349 return;
350
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700351 xa_lock_irqsave(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800352 for (i = 0; i < pagevec_count(pvec); i++) {
353 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
354
355 unaccount_page_cache_page(mapping, pvec->pages[i]);
356 }
Matthew Wilcoxef8e5712017-12-04 03:59:45 -0500357 page_cache_delete_batch(mapping, pvec);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700358 xa_unlock_irqrestore(&mapping->i_pages, flags);
Jan Karaaa65c292017-11-15 17:37:33 -0800359
360 for (i = 0; i < pagevec_count(pvec); i++)
361 page_cache_free_page(mapping, pvec->pages[i]);
362}
363
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200364int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700365{
366 int ret = 0;
367 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700368 if (test_bit(AS_ENOSPC, &mapping->flags) &&
369 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700370 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700371 if (test_bit(AS_EIO, &mapping->flags) &&
372 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700373 ret = -EIO;
374 return ret;
375}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200376EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700377
Jeff Layton76341ca2017-07-06 07:02:22 -0400378static int filemap_check_and_keep_errors(struct address_space *mapping)
379{
380 /* Check for outstanding write errors */
381 if (test_bit(AS_EIO, &mapping->flags))
382 return -EIO;
383 if (test_bit(AS_ENOSPC, &mapping->flags))
384 return -ENOSPC;
385 return 0;
386}
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700389 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700390 * @mapping: address space structure to write
391 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800392 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700393 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700395 * Start writeback against all of a mapping's dirty pages that lie
396 * within the byte offsets <start, end> inclusive.
397 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700399 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 * these two operations is that if a dirty page/buffer is encountered, it must
401 * be waited upon, and not just skipped over.
Mike Rapoporta862f682019-03-05 15:48:42 -0800402 *
403 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800405int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
406 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407{
408 int ret;
409 struct writeback_control wbc = {
410 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800411 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700412 .range_start = start,
413 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414 };
415
Konstantin Khlebnikovc3aab9a02019-09-23 15:34:45 -0700416 if (!mapping_cap_writeback_dirty(mapping) ||
417 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 return 0;
419
Tejun Heob16b1de2015-06-02 08:39:48 -0600420 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600422 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 return ret;
424}
425
426static inline int __filemap_fdatawrite(struct address_space *mapping,
427 int sync_mode)
428{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700429 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430}
431
432int filemap_fdatawrite(struct address_space *mapping)
433{
434 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
435}
436EXPORT_SYMBOL(filemap_fdatawrite);
437
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400438int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800439 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
441 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
442}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400443EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Randy Dunlap485bb992006-06-23 02:03:49 -0700445/**
446 * filemap_flush - mostly a non-blocking flush
447 * @mapping: target address_space
448 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 * This is a mostly non-blocking flush. Not suitable for data-integrity
450 * purposes - I/O may not be started against all dirty pages.
Mike Rapoporta862f682019-03-05 15:48:42 -0800451 *
452 * Return: %0 on success, negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 */
454int filemap_flush(struct address_space *mapping)
455{
456 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
457}
458EXPORT_SYMBOL(filemap_flush);
459
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500460/**
461 * filemap_range_has_page - check if a page exists in range.
462 * @mapping: address space within which to check
463 * @start_byte: offset in bytes where the range starts
464 * @end_byte: offset in bytes where the range ends (inclusive)
465 *
466 * Find at least one page in the range supplied, usually used to check if
467 * direct writing in this range will trigger a writeback.
Mike Rapoporta862f682019-03-05 15:48:42 -0800468 *
469 * Return: %true if at least one page exists in the specified range,
470 * %false otherwise.
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500471 */
472bool filemap_range_has_page(struct address_space *mapping,
473 loff_t start_byte, loff_t end_byte)
474{
Jan Karaf7b68042017-09-06 16:21:40 -0700475 struct page *page;
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500476 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
477 pgoff_t max = end_byte >> PAGE_SHIFT;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500478
479 if (end_byte < start_byte)
480 return false;
481
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500482 rcu_read_lock();
483 for (;;) {
484 page = xas_find(&xas, max);
485 if (xas_retry(&xas, page))
486 continue;
487 /* Shadow entries don't count */
488 if (xa_is_value(page))
489 continue;
490 /*
491 * We don't need to try to pin this page; we're about to
492 * release the RCU lock anyway. It is enough to know that
493 * there was a page here recently.
494 */
495 break;
496 }
497 rcu_read_unlock();
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500498
Matthew Wilcox8fa8e532018-01-16 06:26:49 -0500499 return page != NULL;
Goldwyn Rodrigues7fc9e472017-06-20 07:05:41 -0500500}
501EXPORT_SYMBOL(filemap_range_has_page);
502
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400503static void __filemap_fdatawait_range(struct address_space *mapping,
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800504 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300506 pgoff_t index = start_byte >> PAGE_SHIFT;
507 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 struct pagevec pvec;
509 int nr_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200511 if (end_byte < start_byte)
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400512 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Mel Gorman86679822017-11-15 17:37:52 -0800514 pagevec_init(&pvec);
Jan Kara312e9d22017-11-15 17:35:05 -0800515 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 unsigned i;
517
Jan Kara312e9d22017-11-15 17:35:05 -0800518 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara67fd7072017-11-15 17:35:19 -0800519 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara312e9d22017-11-15 17:35:05 -0800520 if (!nr_pages)
521 break;
522
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 for (i = 0; i < nr_pages; i++) {
524 struct page *page = pvec.pages[i];
525
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526 wait_on_page_writeback(page);
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400527 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528 }
529 pagevec_release(&pvec);
530 cond_resched();
531 }
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800532}
533
534/**
535 * filemap_fdatawait_range - wait for writeback to complete
536 * @mapping: address space structure to wait for
537 * @start_byte: offset in bytes where the range starts
538 * @end_byte: offset in bytes where the range ends (inclusive)
539 *
540 * Walk the list of under-writeback pages of the given address space
541 * in the given range and wait for all of them. Check error status of
542 * the address space and return it.
543 *
544 * Since the error status of the address space is cleared by this function,
545 * callers are responsible for checking the return value and handling and/or
546 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800547 *
548 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800549 */
550int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
551 loff_t end_byte)
552{
Jeff Layton5e8fcc12017-07-06 07:02:24 -0400553 __filemap_fdatawait_range(mapping, start_byte, end_byte);
554 return filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200556EXPORT_SYMBOL(filemap_fdatawait_range);
557
558/**
Ross Zwisleraa0bfcd2019-06-20 17:05:37 -0400559 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
560 * @mapping: address space structure to wait for
561 * @start_byte: offset in bytes where the range starts
562 * @end_byte: offset in bytes where the range ends (inclusive)
563 *
564 * Walk the list of under-writeback pages of the given address space in the
565 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
566 * this function does not clear error status of the address space.
567 *
568 * Use this function if callers don't handle errors themselves. Expected
569 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
570 * fsfreeze(8)
571 */
572int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
573 loff_t start_byte, loff_t end_byte)
574{
575 __filemap_fdatawait_range(mapping, start_byte, end_byte);
576 return filemap_check_and_keep_errors(mapping);
577}
578EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
579
580/**
Jeff Laytona823e452017-07-28 07:24:43 -0400581 * file_fdatawait_range - wait for writeback to complete
582 * @file: file pointing to address space structure to wait for
583 * @start_byte: offset in bytes where the range starts
584 * @end_byte: offset in bytes where the range ends (inclusive)
585 *
586 * Walk the list of under-writeback pages of the address space that file
587 * refers to, in the given range and wait for all of them. Check error
588 * status of the address space vs. the file->f_wb_err cursor and return it.
589 *
590 * Since the error status of the file is advanced by this function,
591 * callers are responsible for checking the return value and handling and/or
592 * reporting the error.
Mike Rapoporta862f682019-03-05 15:48:42 -0800593 *
594 * Return: error status of the address space vs. the file->f_wb_err cursor.
Jeff Laytona823e452017-07-28 07:24:43 -0400595 */
596int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
597{
598 struct address_space *mapping = file->f_mapping;
599
600 __filemap_fdatawait_range(mapping, start_byte, end_byte);
601 return file_check_and_advance_wb_err(file);
602}
603EXPORT_SYMBOL(file_fdatawait_range);
604
605/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800606 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
607 * @mapping: address space structure to wait for
608 *
609 * Walk the list of under-writeback pages of the given address space
610 * and wait for all of them. Unlike filemap_fdatawait(), this function
611 * does not clear error status of the address space.
612 *
613 * Use this function if callers don't handle errors themselves. Expected
614 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
615 * fsfreeze(8)
Mike Rapoporta862f682019-03-05 15:48:42 -0800616 *
617 * Return: error status of the address space.
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800618 */
Jeff Layton76341ca2017-07-06 07:02:22 -0400619int filemap_fdatawait_keep_errors(struct address_space *mapping)
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800620{
Jeff Laytonffb959b2017-07-31 10:29:38 -0400621 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
Jeff Layton76341ca2017-07-06 07:02:22 -0400622 return filemap_check_and_keep_errors(mapping);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800623}
Jeff Layton76341ca2017-07-06 07:02:22 -0400624EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800625
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700626/* Returns true if writeback might be needed or already in progress. */
Jeff Layton9326c9b2017-07-26 10:21:11 -0400627static bool mapping_needs_writeback(struct address_space *mapping)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628{
Konstantin Khlebnikov875d91b2019-09-23 15:34:48 -0700629 if (dax_mapping(mapping))
630 return mapping->nrexceptional;
631
632 return mapping->nrpages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Randy Dunlap485bb992006-06-23 02:03:49 -0700635/**
636 * filemap_write_and_wait_range - write out & wait on a file range
637 * @mapping: the address_space for the pages
638 * @lstart: offset in bytes where the range starts
639 * @lend: offset in bytes where the range ends (inclusive)
640 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800641 * Write out and wait upon file offsets lstart->lend, inclusive.
642 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300643 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800644 * that this function can be used to write to the very end-of-file (end = -1).
Mike Rapoporta862f682019-03-05 15:48:42 -0800645 *
646 * Return: error status of the address space.
Andrew Morton469eb4d2006-03-24 03:17:45 -0800647 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648int filemap_write_and_wait_range(struct address_space *mapping,
649 loff_t lstart, loff_t lend)
650{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800651 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652
Jeff Layton9326c9b2017-07-26 10:21:11 -0400653 if (mapping_needs_writeback(mapping)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800654 err = __filemap_fdatawrite_range(mapping, lstart, lend,
655 WB_SYNC_ALL);
Ira Weinyddf8f372020-01-30 22:12:07 -0800656 /*
657 * Even if the above returned error, the pages may be
658 * written partially (e.g. -ENOSPC), so we wait for it.
659 * But the -EIO is special case, it may indicate the worst
660 * thing (e.g. bug) happened, so we avoid waiting for it.
661 */
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800662 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200663 int err2 = filemap_fdatawait_range(mapping,
664 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800665 if (!err)
666 err = err2;
Jeff Laytoncbeaf952017-07-06 07:02:23 -0400667 } else {
668 /* Clear any previously stored errors */
669 filemap_check_errors(mapping);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800670 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700671 } else {
672 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800674 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675}
Chris Masonf6995582009-04-15 13:22:37 -0400676EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Jeff Layton5660e132017-07-06 07:02:25 -0400678void __filemap_set_wb_err(struct address_space *mapping, int err)
679{
Jeff Layton3acdfd22017-07-24 06:22:15 -0400680 errseq_t eseq = errseq_set(&mapping->wb_err, err);
Jeff Layton5660e132017-07-06 07:02:25 -0400681
682 trace_filemap_set_wb_err(mapping, eseq);
683}
684EXPORT_SYMBOL(__filemap_set_wb_err);
685
686/**
687 * file_check_and_advance_wb_err - report wb error (if any) that was previously
688 * and advance wb_err to current one
689 * @file: struct file on which the error is being reported
690 *
691 * When userland calls fsync (or something like nfsd does the equivalent), we
692 * want to report any writeback errors that occurred since the last fsync (or
693 * since the file was opened if there haven't been any).
694 *
695 * Grab the wb_err from the mapping. If it matches what we have in the file,
696 * then just quickly return 0. The file is all caught up.
697 *
698 * If it doesn't match, then take the mapping value, set the "seen" flag in
699 * it and try to swap it into place. If it works, or another task beat us
700 * to it with the new value, then update the f_wb_err and return the error
701 * portion. The error at this point must be reported via proper channels
702 * (a'la fsync, or NFS COMMIT operation, etc.).
703 *
704 * While we handle mapping->wb_err with atomic operations, the f_wb_err
705 * value is protected by the f_lock since we must ensure that it reflects
706 * the latest value swapped in for this file descriptor.
Mike Rapoporta862f682019-03-05 15:48:42 -0800707 *
708 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400709 */
710int file_check_and_advance_wb_err(struct file *file)
711{
712 int err = 0;
713 errseq_t old = READ_ONCE(file->f_wb_err);
714 struct address_space *mapping = file->f_mapping;
715
716 /* Locklessly handle the common case where nothing has changed */
717 if (errseq_check(&mapping->wb_err, old)) {
718 /* Something changed, must use slow path */
719 spin_lock(&file->f_lock);
720 old = file->f_wb_err;
721 err = errseq_check_and_advance(&mapping->wb_err,
722 &file->f_wb_err);
723 trace_file_check_and_advance_wb_err(file, old);
724 spin_unlock(&file->f_lock);
725 }
Jeff Laytonf4e222c2017-10-03 16:15:25 -0700726
727 /*
728 * We're mostly using this function as a drop in replacement for
729 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
730 * that the legacy code would have had on these flags.
731 */
732 clear_bit(AS_EIO, &mapping->flags);
733 clear_bit(AS_ENOSPC, &mapping->flags);
Jeff Layton5660e132017-07-06 07:02:25 -0400734 return err;
735}
736EXPORT_SYMBOL(file_check_and_advance_wb_err);
737
738/**
739 * file_write_and_wait_range - write out & wait on a file range
740 * @file: file pointing to address_space with pages
741 * @lstart: offset in bytes where the range starts
742 * @lend: offset in bytes where the range ends (inclusive)
743 *
744 * Write out and wait upon file offsets lstart->lend, inclusive.
745 *
746 * Note that @lend is inclusive (describes the last byte to be written) so
747 * that this function can be used to write to the very end-of-file (end = -1).
748 *
749 * After writing out and waiting on the data, we check and advance the
750 * f_wb_err cursor to the latest value, and return any errors detected there.
Mike Rapoporta862f682019-03-05 15:48:42 -0800751 *
752 * Return: %0 on success, negative error code otherwise.
Jeff Layton5660e132017-07-06 07:02:25 -0400753 */
754int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
755{
756 int err = 0, err2;
757 struct address_space *mapping = file->f_mapping;
758
Jeff Layton9326c9b2017-07-26 10:21:11 -0400759 if (mapping_needs_writeback(mapping)) {
Jeff Layton5660e132017-07-06 07:02:25 -0400760 err = __filemap_fdatawrite_range(mapping, lstart, lend,
761 WB_SYNC_ALL);
762 /* See comment of filemap_write_and_wait() */
763 if (err != -EIO)
764 __filemap_fdatawait_range(mapping, lstart, lend);
765 }
766 err2 = file_check_and_advance_wb_err(file);
767 if (!err)
768 err = err2;
769 return err;
770}
771EXPORT_SYMBOL(file_write_and_wait_range);
772
Randy Dunlap485bb992006-06-23 02:03:49 -0700773/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700774 * replace_page_cache_page - replace a pagecache page with a new one
775 * @old: page to be replaced
776 * @new: page to replace with
777 * @gfp_mask: allocation mode
778 *
779 * This function replaces a page in the pagecache with a new one. On
780 * success it acquires the pagecache reference for the new page and
781 * drops it for the old page. Both the old and new pages must be
782 * locked. This function does not add the new page to the LRU, the
783 * caller must do that.
784 *
Matthew Wilcox74d60952017-11-17 10:01:45 -0500785 * The remove + add is atomic. This function cannot fail.
Mike Rapoporta862f682019-03-05 15:48:42 -0800786 *
787 * Return: %0
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700788 */
789int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
790{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500791 struct address_space *mapping = old->mapping;
792 void (*freepage)(struct page *) = mapping->a_ops->freepage;
793 pgoff_t offset = old->index;
794 XA_STATE(xas, &mapping->i_pages, offset);
795 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700796
Sasha Levin309381fea2014-01-23 15:52:54 -0800797 VM_BUG_ON_PAGE(!PageLocked(old), old);
798 VM_BUG_ON_PAGE(!PageLocked(new), new);
799 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700800
Matthew Wilcox74d60952017-11-17 10:01:45 -0500801 get_page(new);
802 new->mapping = mapping;
803 new->index = offset;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700804
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700805 mem_cgroup_migrate(old, new);
806
Matthew Wilcox74d60952017-11-17 10:01:45 -0500807 xas_lock_irqsave(&xas, flags);
808 xas_store(&xas, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700809
Matthew Wilcox74d60952017-11-17 10:01:45 -0500810 old->mapping = NULL;
811 /* hugetlb pages do not participate in page cache accounting. */
812 if (!PageHuge(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700813 __dec_lruvec_page_state(old, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500814 if (!PageHuge(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700815 __inc_lruvec_page_state(new, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500816 if (PageSwapBacked(old))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700817 __dec_lruvec_page_state(old, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500818 if (PageSwapBacked(new))
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700819 __inc_lruvec_page_state(new, NR_SHMEM);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500820 xas_unlock_irqrestore(&xas, flags);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500821 if (freepage)
822 freepage(old);
823 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700824
Matthew Wilcox74d60952017-11-17 10:01:45 -0500825 return 0;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700826}
827EXPORT_SYMBOL_GPL(replace_page_cache_page);
828
Johannes Weinera5289102014-04-03 14:47:51 -0700829static int __add_to_page_cache_locked(struct page *page,
830 struct address_space *mapping,
831 pgoff_t offset, gfp_t gfp_mask,
832 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833{
Matthew Wilcox74d60952017-11-17 10:01:45 -0500834 XA_STATE(xas, &mapping->i_pages, offset);
Johannes Weiner00501b52014-08-08 14:19:20 -0700835 int huge = PageHuge(page);
Nick Piggine2867812008-07-25 19:45:30 -0700836 int error;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500837 void *old;
Nick Piggine2867812008-07-25 19:45:30 -0700838
Sasha Levin309381fea2014-01-23 15:52:54 -0800839 VM_BUG_ON_PAGE(!PageLocked(page), page);
840 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500841 mapping_set_update(&xas, mapping);
Nick Piggine2867812008-07-25 19:45:30 -0700842
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300843 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700844 page->mapping = mapping;
845 page->index = offset;
846
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700847 if (!huge) {
Johannes Weinerd9eb1ea2020-06-03 16:02:24 -0700848 error = mem_cgroup_charge(page, current->mm, gfp_mask);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700849 if (error)
850 goto error;
851 }
852
Matthew Wilcox74d60952017-11-17 10:01:45 -0500853 do {
854 xas_lock_irq(&xas);
855 old = xas_load(&xas);
856 if (old && !xa_is_value(old))
857 xas_set_err(&xas, -EEXIST);
858 xas_store(&xas, page);
859 if (xas_error(&xas))
860 goto unlock;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700861
Matthew Wilcox74d60952017-11-17 10:01:45 -0500862 if (xa_is_value(old)) {
863 mapping->nrexceptional--;
864 if (shadowp)
865 *shadowp = old;
866 }
867 mapping->nrpages++;
868
869 /* hugetlb pages do not participate in page cache accounting */
870 if (!huge)
Johannes Weiner0d1c2072020-06-03 16:01:54 -0700871 __inc_lruvec_page_state(page, NR_FILE_PAGES);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500872unlock:
873 xas_unlock_irq(&xas);
874 } while (xas_nomem(&xas, gfp_mask & GFP_RECLAIM_MASK));
875
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700876 if (xas_error(&xas)) {
877 error = xas_error(&xas);
Matthew Wilcox74d60952017-11-17 10:01:45 -0500878 goto error;
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700879 }
Matthew Wilcox74d60952017-11-17 10:01:45 -0500880
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700881 trace_mm_filemap_add_to_page_cache(page);
882 return 0;
Matthew Wilcox74d60952017-11-17 10:01:45 -0500883error:
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700884 page->mapping = NULL;
885 /* Leave page->index set: truncation relies upon it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300886 put_page(page);
Johannes Weiner3fea5a42020-06-03 16:01:41 -0700887 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
Josef Bacikcfcbfb12019-05-13 17:21:04 -0700889ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
Johannes Weinera5289102014-04-03 14:47:51 -0700890
891/**
892 * add_to_page_cache_locked - add a locked page to the pagecache
893 * @page: page to add
894 * @mapping: the page's address_space
895 * @offset: page index
896 * @gfp_mask: page allocation mode
897 *
898 * This function is used to add a page to the pagecache. It must be locked.
899 * This function does not add the page to the LRU. The caller must do that.
Mike Rapoporta862f682019-03-05 15:48:42 -0800900 *
901 * Return: %0 on success, negative error code otherwise.
Johannes Weinera5289102014-04-03 14:47:51 -0700902 */
903int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
904 pgoff_t offset, gfp_t gfp_mask)
905{
906 return __add_to_page_cache_locked(page, mapping, offset,
907 gfp_mask, NULL);
908}
Nick Piggine2867812008-07-25 19:45:30 -0700909EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910
911int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400912 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
Johannes Weinera5289102014-04-03 14:47:51 -0700914 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700915 int ret;
916
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800917 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700918 ret = __add_to_page_cache_locked(page, mapping, offset,
919 gfp_mask, &shadow);
920 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800921 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700922 else {
923 /*
924 * The page might have been evicted from cache only
925 * recently, in which case it should be activated like
926 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700927 * The exception is pages getting rewritten; evicting other
928 * data from the working set, only to cache data that will
929 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700930 */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700931 WARN_ON_ONCE(PageActive(page));
932 if (!(gfp_mask & __GFP_WRITE) && shadow)
933 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700934 lru_cache_add(page);
935 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 return ret;
937}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300938EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
Paul Jackson44110fe2006-03-24 03:16:04 -0800940#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700941struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800942{
Miao Xiec0ff7452010-05-24 14:32:08 -0700943 int n;
944 struct page *page;
945
Paul Jackson44110fe2006-03-24 03:16:04 -0800946 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700947 unsigned int cpuset_mems_cookie;
948 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700949 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700950 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700951 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700952 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700953
Miao Xiec0ff7452010-05-24 14:32:08 -0700954 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800955 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700956 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800957}
Nick Piggin2ae88142006-10-28 10:38:23 -0700958EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800959#endif
960
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961/*
962 * In order to wait for pages to become available there must be
963 * waitqueues associated with pages. By using a hash table of
964 * waitqueues where the bucket discipline is to maintain all
965 * waiters on the same queue and wake all when any of the pages
966 * become available, and for the woken contexts to check to be
967 * sure the appropriate page became available, this saves space
968 * at a cost of "thundering herd" phenomena during rare hash
969 * collisions.
970 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000971#define PAGE_WAIT_TABLE_BITS 8
972#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
973static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
974
975static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
Nicholas Piggin62906022016-12-25 13:00:30 +1000977 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978}
Nicholas Piggin62906022016-12-25 13:00:30 +1000979
980void __init pagecache_init(void)
981{
982 int i;
983
984 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
985 init_waitqueue_head(&page_wait_table[i]);
986
987 page_writeback_init();
988}
989
Linus Torvalds3510ca22017-08-27 13:55:12 -0700990/* This has the same layout as wait_bit_key - see fs/cachefiles/rdwr.c */
Nicholas Piggin62906022016-12-25 13:00:30 +1000991struct wait_page_key {
992 struct page *page;
993 int bit_nr;
994 int page_match;
995};
996
997struct wait_page_queue {
998 struct page *page;
999 int bit_nr;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001000 wait_queue_entry_t wait;
Nicholas Piggin62906022016-12-25 13:00:30 +10001001};
1002
Ingo Molnarac6424b2017-06-20 12:06:13 +02001003static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +10001004{
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001005 int ret;
Nicholas Piggin62906022016-12-25 13:00:30 +10001006 struct wait_page_key *key = arg;
1007 struct wait_page_queue *wait_page
1008 = container_of(wait, struct wait_page_queue, wait);
1009
1010 if (wait_page->page != key->page)
1011 return 0;
1012 key->page_match = 1;
1013
1014 if (wait_page->bit_nr != key->bit_nr)
1015 return 0;
Linus Torvalds3510ca22017-08-27 13:55:12 -07001016
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001017 /*
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001018 * If it's an exclusive wait, we get the bit for it, and
1019 * stop walking if we can't.
1020 *
1021 * If it's a non-exclusive wait, then the fact that this
1022 * wake function was called means that the bit already
1023 * was cleared, and we don't care if somebody then
1024 * re-took it.
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001025 */
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001026 ret = 0;
1027 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1028 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1029 return -1;
1030 ret = 1;
1031 }
1032 wait->flags |= WQ_FLAG_WOKEN;
Nicholas Piggin62906022016-12-25 13:00:30 +10001033
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001034 wake_up_state(wait->private, mode);
1035
1036 /*
1037 * Ok, we have successfully done what we're waiting for,
1038 * and we can unconditionally remove the wait entry.
1039 *
1040 * Note that this has to be the absolute last thing we do,
1041 * since after list_del_init(&wait->entry) the wait entry
1042 * might be de-allocated and the process might even have
1043 * exited.
1044 *
1045 * We _really_ should have a "list_del_init_careful()" to
1046 * properly pair with the unlocked "list_empty_careful()"
1047 * in finish_wait().
1048 */
1049 smp_mb();
1050 list_del_init(&wait->entry);
1051 return ret;
Nicholas Piggin62906022016-12-25 13:00:30 +10001052}
1053
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001054static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +10001055{
1056 wait_queue_head_t *q = page_waitqueue(page);
1057 struct wait_page_key key;
1058 unsigned long flags;
Tim Chen11a19c72017-08-25 09:13:55 -07001059 wait_queue_entry_t bookmark;
Nicholas Piggin62906022016-12-25 13:00:30 +10001060
1061 key.page = page;
1062 key.bit_nr = bit_nr;
1063 key.page_match = 0;
1064
Tim Chen11a19c72017-08-25 09:13:55 -07001065 bookmark.flags = 0;
1066 bookmark.private = NULL;
1067 bookmark.func = NULL;
1068 INIT_LIST_HEAD(&bookmark.entry);
1069
Nicholas Piggin62906022016-12-25 13:00:30 +10001070 spin_lock_irqsave(&q->lock, flags);
Tim Chen11a19c72017-08-25 09:13:55 -07001071 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1072
1073 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1074 /*
1075 * Take a breather from holding the lock,
1076 * allow pages that finish wake up asynchronously
1077 * to acquire the lock and remove themselves
1078 * from wait queue
1079 */
1080 spin_unlock_irqrestore(&q->lock, flags);
1081 cpu_relax();
1082 spin_lock_irqsave(&q->lock, flags);
1083 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1084 }
1085
Nicholas Piggin62906022016-12-25 13:00:30 +10001086 /*
1087 * It is possible for other pages to have collided on the waitqueue
1088 * hash, so in that case check for a page match. That prevents a long-
1089 * term waiter
1090 *
1091 * It is still possible to miss a case here, when we woke page waiters
1092 * and removed them from the waitqueue, but there are still other
1093 * page waiters.
1094 */
1095 if (!waitqueue_active(q) || !key.page_match) {
1096 ClearPageWaiters(page);
1097 /*
1098 * It's possible to miss clearing Waiters here, when we woke
1099 * our page waiters, but the hashed waitqueue has waiters for
1100 * other pages on it.
1101 *
1102 * That's okay, it's a rare case. The next waker will clear it.
1103 */
1104 }
1105 spin_unlock_irqrestore(&q->lock, flags);
1106}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -08001107
1108static void wake_up_page(struct page *page, int bit)
1109{
1110 if (!PageWaiters(page))
1111 return;
1112 wake_up_page_bit(page, bit);
1113}
Nicholas Piggin62906022016-12-25 13:00:30 +10001114
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001115/*
1116 * A choice of three behaviors for wait_on_page_bit_common():
1117 */
1118enum behavior {
1119 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1120 * __lock_page() waiting on then setting PG_locked.
1121 */
1122 SHARED, /* Hold ref to page and check the bit when woken, like
1123 * wait_on_page_writeback() waiting on PG_writeback.
1124 */
1125 DROP, /* Drop ref to page before wait, no check when woken,
1126 * like put_and_wait_on_page_locked() on PG_locked.
1127 */
1128};
1129
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001130/*
1131 * Attempt to check (or get) the page bit, and mark the
1132 * waiter woken if successful.
1133 */
1134static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1135 struct wait_queue_entry *wait)
1136{
1137 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1138 if (test_and_set_bit(bit_nr, &page->flags))
1139 return false;
1140 } else if (test_bit(bit_nr, &page->flags))
1141 return false;
1142
1143 wait->flags |= WQ_FLAG_WOKEN;
1144 return true;
1145}
1146
Nicholas Piggin62906022016-12-25 13:00:30 +10001147static inline int wait_on_page_bit_common(wait_queue_head_t *q,
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001148 struct page *page, int bit_nr, int state, enum behavior behavior)
Nicholas Piggin62906022016-12-25 13:00:30 +10001149{
1150 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +02001151 wait_queue_entry_t *wait = &wait_page.wait;
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001152 bool thrashing = false;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001153 bool delayacct = false;
Johannes Weinereb414682018-10-26 15:06:27 -07001154 unsigned long pflags;
Nicholas Piggin62906022016-12-25 13:00:30 +10001155
Johannes Weinereb414682018-10-26 15:06:27 -07001156 if (bit_nr == PG_locked &&
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001157 !PageUptodate(page) && PageWorkingset(page)) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001158 if (!PageSwapBacked(page)) {
Johannes Weinereb414682018-10-26 15:06:27 -07001159 delayacct_thrashing_start();
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001160 delayacct = true;
1161 }
Johannes Weinereb414682018-10-26 15:06:27 -07001162 psi_memstall_enter(&pflags);
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001163 thrashing = true;
1164 }
1165
Nicholas Piggin62906022016-12-25 13:00:30 +10001166 init_wait(wait);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001167 wait->flags = behavior == EXCLUSIVE ? WQ_FLAG_EXCLUSIVE : 0;
Nicholas Piggin62906022016-12-25 13:00:30 +10001168 wait->func = wake_page_function;
1169 wait_page.page = page;
1170 wait_page.bit_nr = bit_nr;
1171
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001172 /*
1173 * Do one last check whether we can get the
1174 * page bit synchronously.
1175 *
1176 * Do the SetPageWaiters() marking before that
1177 * to let any waker we _just_ missed know they
1178 * need to wake us up (otherwise they'll never
1179 * even go to the slow case that looks at the
1180 * page queue), and add ourselves to the wait
1181 * queue if we need to sleep.
1182 *
1183 * This part needs to be done under the queue
1184 * lock to avoid races.
1185 */
1186 spin_lock_irq(&q->lock);
1187 SetPageWaiters(page);
1188 if (!trylock_page_bit_common(page, bit_nr, wait))
1189 __add_wait_queue_entry_tail(q, wait);
1190 spin_unlock_irq(&q->lock);
1191
1192 /*
1193 * From now on, all the logic will be based on
1194 * the WQ_FLAG_WOKEN flag, and the and the page
1195 * bit testing (and setting) will be - or has
1196 * already been - done by the wake function.
1197 *
1198 * We can drop our reference to the page.
1199 */
1200 if (behavior == DROP)
1201 put_page(page);
1202
Nicholas Piggin62906022016-12-25 13:00:30 +10001203 for (;;) {
Nicholas Piggin62906022016-12-25 13:00:30 +10001204 set_current_state(state);
1205
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001206 if (signal_pending_state(state, current))
Linus Torvaldsa8b169a2017-08-27 16:25:09 -07001207 break;
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001208
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001209 if (wait->flags & WQ_FLAG_WOKEN)
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001210 break;
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001211
1212 io_schedule();
Nicholas Piggin62906022016-12-25 13:00:30 +10001213 }
1214
1215 finish_wait(q, wait);
1216
Johannes Weinereb414682018-10-26 15:06:27 -07001217 if (thrashing) {
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001218 if (delayacct)
Johannes Weinereb414682018-10-26 15:06:27 -07001219 delayacct_thrashing_end();
1220 psi_memstall_leave(&pflags);
1221 }
Johannes Weinerb1d29ba2018-10-26 15:06:08 -07001222
Nicholas Piggin62906022016-12-25 13:00:30 +10001223 /*
1224 * A signal could leave PageWaiters set. Clearing it here if
1225 * !waitqueue_active would be possible (by open-coding finish_wait),
1226 * but still fail to catch it in the case of wait hash collision. We
1227 * already can fail to clear wait hash collision cases, so don't
1228 * bother with signals either.
1229 */
1230
Linus Torvalds2a9127f2020-07-23 10:16:49 -07001231 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
Nicholas Piggin62906022016-12-25 13:00:30 +10001232}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233
Harvey Harrison920c7a52008-02-04 22:29:26 -08001234void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001235{
Nicholas Piggin62906022016-12-25 13:00:30 +10001236 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001237 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238}
1239EXPORT_SYMBOL(wait_on_page_bit);
1240
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001241int wait_on_page_bit_killable(struct page *page, int bit_nr)
1242{
Nicholas Piggin62906022016-12-25 13:00:30 +10001243 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001244 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001245}
David Howells4343d002017-11-02 15:27:52 +00001246EXPORT_SYMBOL(wait_on_page_bit_killable);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -07001247
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248/**
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001249 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1250 * @page: The page to wait for.
1251 *
1252 * The caller should hold a reference on @page. They expect the page to
1253 * become unlocked relatively soon, but do not wish to hold up migration
1254 * (for example) by holding the reference while waiting for the page to
1255 * come unlocked. After this function returns, the caller should not
1256 * dereference @page.
1257 */
1258void put_and_wait_on_page_locked(struct page *page)
1259{
1260 wait_queue_head_t *q;
1261
1262 page = compound_head(page);
1263 q = page_waitqueue(page);
1264 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1265}
1266
1267/**
David Howells385e1ca5f2009-04-03 16:42:39 +01001268 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -07001269 * @page: Page defining the wait queue of interest
1270 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +01001271 *
1272 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1273 */
Ingo Molnarac6424b2017-06-20 12:06:13 +02001274void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +01001275{
1276 wait_queue_head_t *q = page_waitqueue(page);
1277 unsigned long flags;
1278
1279 spin_lock_irqsave(&q->lock, flags);
Linus Torvalds9c3a8152017-08-28 16:45:40 -07001280 __add_wait_queue_entry_tail(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +10001281 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +01001282 spin_unlock_irqrestore(&q->lock, flags);
1283}
1284EXPORT_SYMBOL_GPL(add_page_wait_queue);
1285
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001286#ifndef clear_bit_unlock_is_negative_byte
1287
1288/*
1289 * PG_waiters is the high bit in the same byte as PG_lock.
1290 *
1291 * On x86 (and on many other architectures), we can clear PG_lock and
1292 * test the sign bit at the same time. But if the architecture does
1293 * not support that special operation, we just do this all by hand
1294 * instead.
1295 *
1296 * The read of PG_waiters has to be after (or concurrently with) PG_locked
Ethon Paulffceeb62020-06-04 16:49:22 -07001297 * being cleared, but a memory barrier should be unnecessary since it is
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001298 * in the same byte as PG_locked.
1299 */
1300static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1301{
1302 clear_bit_unlock(nr, mem);
1303 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -08001304 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001305}
1306
1307#endif
1308
David Howells385e1ca5f2009-04-03 16:42:39 +01001309/**
Randy Dunlap485bb992006-06-23 02:03:49 -07001310 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311 * @page: the page
1312 *
1313 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
1314 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +09001315 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1317 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001318 * Note that this depends on PG_waiters being the sign bit in the byte
1319 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1320 * clear the PG_locked bit and test PG_waiters at the same time fairly
1321 * portably (architectures that do LL/SC can test any bit, while x86 can
1322 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001324void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325{
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001326 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -08001327 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -08001328 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -08001329 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1330 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331}
1332EXPORT_SYMBOL(unlock_page);
1333
Randy Dunlap485bb992006-06-23 02:03:49 -07001334/**
1335 * end_page_writeback - end writeback against a page
1336 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 */
1338void end_page_writeback(struct page *page)
1339{
Mel Gorman888cf2d2014-06-04 16:10:34 -07001340 /*
1341 * TestClearPageReclaim could be used here but it is an atomic
1342 * operation and overkill in this particular case. Failing to
1343 * shuffle a page marked for immediate reclaim is too mild to
1344 * justify taking an atomic operation penalty at the end of
1345 * ever page writeback.
1346 */
1347 if (PageReclaim(page)) {
1348 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001349 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001350 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001351
1352 if (!test_clear_page_writeback(page))
1353 BUG();
1354
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001355 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 wake_up_page(page, PG_writeback);
1357}
1358EXPORT_SYMBOL(end_page_writeback);
1359
Matthew Wilcox57d99842014-06-04 16:07:45 -07001360/*
1361 * After completing I/O on a page, call this routine to update the page
1362 * flags appropriately
1363 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001364void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001365{
Jens Axboec11f0c02016-08-05 08:11:04 -06001366 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001367 if (!err) {
1368 SetPageUptodate(page);
1369 } else {
1370 ClearPageUptodate(page);
1371 SetPageError(page);
1372 }
1373 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001374 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001375 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001376 struct address_space *mapping;
1377
Matthew Wilcox57d99842014-06-04 16:07:45 -07001378 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001379 mapping = page_mapping(page);
1380 if (mapping)
1381 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001382 }
1383 end_page_writeback(page);
1384 }
1385}
1386EXPORT_SYMBOL_GPL(page_endio);
1387
Randy Dunlap485bb992006-06-23 02:03:49 -07001388/**
1389 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001390 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001392void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393{
Nicholas Piggin62906022016-12-25 13:00:30 +10001394 struct page *page = compound_head(__page);
1395 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001396 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1397 EXCLUSIVE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398}
1399EXPORT_SYMBOL(__lock_page);
1400
Nicholas Piggin62906022016-12-25 13:00:30 +10001401int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001402{
Nicholas Piggin62906022016-12-25 13:00:30 +10001403 struct page *page = compound_head(__page);
1404 wait_queue_head_t *q = page_waitqueue(page);
Hugh Dickins9a1ea432018-12-28 00:36:14 -08001405 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1406 EXCLUSIVE);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001407}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001408EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001409
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001410/*
1411 * Return values:
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001412 * 1 - page is locked; mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001413 * 0 - page is not locked.
Michel Lespinasse3e4e28c2020-06-08 21:33:51 -07001414 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001415 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001416 * which case mmap_lock is still held.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001417 *
1418 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001419 * with the page locked and the mmap_lock unperturbed.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001420 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001421int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1422 unsigned int flags)
1423{
Peter Xu4064b982020-04-01 21:08:45 -07001424 if (fault_flag_allow_retry_first(flags)) {
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001425 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07001426 * CAUTION! In this case, mmap_lock is not released
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001427 * even though return 0.
1428 */
1429 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1430 return 0;
1431
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001432 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001433 if (flags & FAULT_FLAG_KILLABLE)
1434 wait_on_page_locked_killable(page);
1435 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001436 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001437 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001438 } else {
1439 if (flags & FAULT_FLAG_KILLABLE) {
1440 int ret;
1441
1442 ret = __lock_page_killable(page);
1443 if (ret) {
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07001444 mmap_read_unlock(mm);
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001445 return 0;
1446 }
1447 } else
1448 __lock_page(page);
1449 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001450 }
1451}
1452
Randy Dunlap485bb992006-06-23 02:03:49 -07001453/**
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001454 * page_cache_next_miss() - Find the next gap in the page cache.
1455 * @mapping: Mapping.
1456 * @index: Index.
1457 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001458 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001459 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1460 * gap with the lowest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001461 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001462 * This function may be called under the rcu_read_lock. However, this will
1463 * not atomically search a snapshot of the cache at a single point in time.
1464 * For example, if a gap is created at index 5, then subsequently a gap is
1465 * created at index 10, page_cache_next_miss covering both indices may
1466 * return 10 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001467 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001468 * Return: The index of the gap if found, otherwise an index outside the
1469 * range specified (in which case 'return - index >= max_scan' will be true).
1470 * In the rare case of index wrap-around, 0 will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001471 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001472pgoff_t page_cache_next_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001473 pgoff_t index, unsigned long max_scan)
1474{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001475 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001476
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001477 while (max_scan--) {
1478 void *entry = xas_next(&xas);
1479 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001480 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001481 if (xas.xa_index == 0)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001482 break;
1483 }
1484
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001485 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001486}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001487EXPORT_SYMBOL(page_cache_next_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001488
1489/**
Laurent Dufour2346a562019-05-13 17:21:29 -07001490 * page_cache_prev_miss() - Find the previous gap in the page cache.
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001491 * @mapping: Mapping.
1492 * @index: Index.
1493 * @max_scan: Maximum range to search.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001494 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001495 * Search the range [max(index - max_scan + 1, 0), index] for the
1496 * gap with the highest index.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001497 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001498 * This function may be called under the rcu_read_lock. However, this will
1499 * not atomically search a snapshot of the cache at a single point in time.
1500 * For example, if a gap is created at index 10, then subsequently a gap is
1501 * created at index 5, page_cache_prev_miss() covering both indices may
1502 * return 5 if called under the rcu_read_lock.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001503 *
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001504 * Return: The index of the gap if found, otherwise an index outside the
1505 * range specified (in which case 'index - return >= max_scan' will be true).
1506 * In the rare case of wrap-around, ULONG_MAX will be returned.
Johannes Weinere7b563b2014-04-03 14:47:44 -07001507 */
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001508pgoff_t page_cache_prev_miss(struct address_space *mapping,
Johannes Weinere7b563b2014-04-03 14:47:44 -07001509 pgoff_t index, unsigned long max_scan)
1510{
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001511 XA_STATE(xas, &mapping->i_pages, index);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001512
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001513 while (max_scan--) {
1514 void *entry = xas_prev(&xas);
1515 if (!entry || xa_is_value(entry))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001516 break;
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001517 if (xas.xa_index == ULONG_MAX)
Johannes Weinere7b563b2014-04-03 14:47:44 -07001518 break;
1519 }
1520
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001521 return xas.xa_index;
Johannes Weinere7b563b2014-04-03 14:47:44 -07001522}
Matthew Wilcox0d3f9292017-11-21 14:07:06 -05001523EXPORT_SYMBOL(page_cache_prev_miss);
Johannes Weinere7b563b2014-04-03 14:47:44 -07001524
1525/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001526 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001527 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001528 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001529 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001530 * Looks up the page cache slot at @mapping & @offset. If there is a
1531 * page cache page, it is returned with an increased refcount.
1532 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001533 * If the slot holds a shadow entry of a previously evicted page, or a
1534 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001535 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001536 * Return: the found page or shadow entry, %NULL if nothing is found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001538struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001539{
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001540 XA_STATE(xas, &mapping->i_pages, offset);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001541 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542
Nick Piggina60637c2008-07-25 19:45:31 -07001543 rcu_read_lock();
1544repeat:
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001545 xas_reset(&xas);
1546 page = xas_load(&xas);
1547 if (xas_retry(&xas, page))
1548 goto repeat;
1549 /*
1550 * A shadow entry of a recently evicted page, or a swap entry from
1551 * shmem/tmpfs. Return it without attempting to raise page count.
1552 */
1553 if (!page || xa_is_value(page))
1554 goto out;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001555
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001556 if (!page_cache_get_speculative(page))
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001557 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001558
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001559 /*
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001560 * Has the page moved or been split?
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001561 * This is part of the lockless pagecache protocol. See
1562 * include/linux/pagemap.h for details.
1563 */
1564 if (unlikely(page != xas_reload(&xas))) {
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001565 put_page(page);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001566 goto repeat;
Nick Piggina60637c2008-07-25 19:45:31 -07001567 }
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001568 page = find_subpage(page, offset);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001569out:
Nick Piggina60637c2008-07-25 19:45:31 -07001570 rcu_read_unlock();
1571
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 return page;
1573}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Randy Dunlap485bb992006-06-23 02:03:49 -07001575/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001576 * find_lock_entry - locate, pin and lock a page cache entry
1577 * @mapping: the address_space to search
1578 * @offset: the page cache index
1579 *
1580 * Looks up the page cache slot at @mapping & @offset. If there is a
1581 * page cache page, it is returned locked and with an increased
1582 * refcount.
1583 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001584 * If the slot holds a shadow entry of a previously evicted page, or a
1585 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001586 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001587 * find_lock_entry() may sleep.
Mike Rapoporta862f682019-03-05 15:48:42 -08001588 *
1589 * Return: the found page or shadow entry, %NULL if nothing is found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001590 */
1591struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001592{
1593 struct page *page;
1594
Linus Torvalds1da177e2005-04-16 15:20:36 -07001595repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001596 page = find_get_entry(mapping, offset);
Matthew Wilcox4c7472c2018-05-16 16:12:50 -04001597 if (page && !xa_is_value(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001598 lock_page(page);
1599 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001600 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001601 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001602 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001603 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001605 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 return page;
1608}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001609EXPORT_SYMBOL(find_lock_entry);
1610
1611/**
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001612 * pagecache_get_page - Find and get a reference to a page.
1613 * @mapping: The address_space to search.
1614 * @index: The page index.
1615 * @fgp_flags: %FGP flags modify how the page is returned.
1616 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001617 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001618 * Looks up the page cache entry at @mapping & @index.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001619 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001620 * @fgp_flags can be zero or more of these flags:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001621 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001622 * * %FGP_ACCESSED - The page will be marked accessed.
1623 * * %FGP_LOCK - The page is returned locked.
1624 * * %FGP_CREAT - If no page is present then a new page is allocated using
1625 * @gfp_mask and added to the page cache and the VM's LRU list.
1626 * The page is returned locked and with an increased refcount.
1627 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1628 * page is already in cache. If the page was allocated, unlock it before
1629 * returning so the caller can do the same dance.
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001630 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001631 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1632 * if the %GFP flags specified for %FGP_CREAT are atomic.
Mel Gorman2457aec2014-06-04 16:10:31 -07001633 *
1634 * If there is a page cache page, it is returned with an increased refcount.
Mike Rapoporta862f682019-03-05 15:48:42 -08001635 *
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001636 * Return: The found page or %NULL otherwise.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001637 */
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001638struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1639 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640{
Nick Piggineb2be182007-10-16 01:24:57 -07001641 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001642
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643repeat:
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001644 page = find_get_entry(mapping, index);
Matthew Wilcox3159f942017-11-03 13:30:42 -04001645 if (xa_is_value(page))
Mel Gorman2457aec2014-06-04 16:10:31 -07001646 page = NULL;
1647 if (!page)
1648 goto no_page;
1649
1650 if (fgp_flags & FGP_LOCK) {
1651 if (fgp_flags & FGP_NOWAIT) {
1652 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001653 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001654 return NULL;
1655 }
1656 } else {
1657 lock_page(page);
1658 }
1659
1660 /* Has the page been truncated? */
Song Liu31895432019-09-23 15:37:47 -07001661 if (unlikely(compound_head(page)->mapping != mapping)) {
Mel Gorman2457aec2014-06-04 16:10:31 -07001662 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001663 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001664 goto repeat;
1665 }
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001666 VM_BUG_ON_PAGE(page->index != index, page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001667 }
1668
Kirill Tkhaic16eb002018-12-28 00:37:35 -08001669 if (fgp_flags & FGP_ACCESSED)
Mel Gorman2457aec2014-06-04 16:10:31 -07001670 mark_page_accessed(page);
1671
1672no_page:
1673 if (!page && (fgp_flags & FGP_CREAT)) {
1674 int err;
1675 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001676 gfp_mask |= __GFP_WRITE;
1677 if (fgp_flags & FGP_NOFS)
1678 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001679
Michal Hocko45f87de2014-12-29 20:30:35 +01001680 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001681 if (!page)
1682 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001683
Josef Bacika75d4c32019-03-13 11:44:14 -07001684 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
Mel Gorman2457aec2014-06-04 16:10:31 -07001685 fgp_flags |= FGP_LOCK;
1686
Hugh Dickinseb39d612014-08-06 16:06:43 -07001687 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001688 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001689 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001690
Matthew Wilcox (Oracle)2294b322020-04-01 21:05:07 -07001691 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001692 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001693 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001694 page = NULL;
1695 if (err == -EEXIST)
1696 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001697 }
Josef Bacika75d4c32019-03-13 11:44:14 -07001698
1699 /*
1700 * add_to_page_cache_lru locks the page, and for mmap we expect
1701 * an unlocked page.
1702 */
1703 if (page && (fgp_flags & FGP_FOR_MMAP))
1704 unlock_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001706
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707 return page;
1708}
Mel Gorman2457aec2014-06-04 16:10:31 -07001709EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001710
1711/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001712 * find_get_entries - gang pagecache lookup
1713 * @mapping: The address_space to search
1714 * @start: The starting page cache index
1715 * @nr_entries: The maximum number of entries
1716 * @entries: Where the resulting entries are placed
1717 * @indices: The cache indices corresponding to the entries in @entries
1718 *
1719 * find_get_entries() will search for and return a group of up to
1720 * @nr_entries entries in the mapping. The entries are placed at
1721 * @entries. find_get_entries() takes a reference against any actual
1722 * pages it returns.
1723 *
1724 * The search returns a group of mapping-contiguous page cache entries
1725 * with ascending indexes. There may be holes in the indices due to
1726 * not-present pages.
1727 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001728 * Any shadow entries of evicted pages, or swap entries from
1729 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001730 *
Hugh Dickins71725ed2020-04-06 20:07:57 -07001731 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1732 * stops at that page: the caller is likely to have a better way to handle
1733 * the compound page as a whole, and then skip its extent, than repeatedly
1734 * calling find_get_entries() to return all its tails.
1735 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001736 * Return: the number of pages and shadow entries which were found.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001737 */
1738unsigned find_get_entries(struct address_space *mapping,
1739 pgoff_t start, unsigned int nr_entries,
1740 struct page **entries, pgoff_t *indices)
1741{
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001742 XA_STATE(xas, &mapping->i_pages, start);
1743 struct page *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001744 unsigned int ret = 0;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001745
1746 if (!nr_entries)
1747 return 0;
1748
1749 rcu_read_lock();
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001750 xas_for_each(&xas, page, ULONG_MAX) {
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001751 if (xas_retry(&xas, page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001752 continue;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001753 /*
1754 * A shadow entry of a recently evicted page, a swap
1755 * entry from shmem/tmpfs or a DAX entry. Return it
1756 * without attempting to raise page count.
1757 */
1758 if (xa_is_value(page))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001759 goto export;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001760
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001761 if (!page_cache_get_speculative(page))
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001762 goto retry;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001763
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001764 /* Has the page moved or been split? */
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001765 if (unlikely(page != xas_reload(&xas)))
1766 goto put_page;
1767
Hugh Dickins71725ed2020-04-06 20:07:57 -07001768 /*
1769 * Terminate early on finding a THP, to allow the caller to
1770 * handle it all at once; but continue if this is hugetlbfs.
1771 */
1772 if (PageTransHuge(page) && !PageHuge(page)) {
1773 page = find_subpage(page, xas.xa_index);
1774 nr_entries = ret + 1;
1775 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001776export:
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001777 indices[ret] = xas.xa_index;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001778 entries[ret] = page;
1779 if (++ret == nr_entries)
1780 break;
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001781 continue;
1782put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001783 put_page(page);
Matthew Wilcoxf280bf02018-05-16 17:20:45 -04001784retry:
1785 xas_reset(&xas);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001786 }
1787 rcu_read_unlock();
1788 return ret;
1789}
1790
1791/**
Jan Karab947cee2017-09-06 16:21:21 -07001792 * find_get_pages_range - gang pagecache lookup
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 * @mapping: The address_space to search
1794 * @start: The starting page index
Jan Karab947cee2017-09-06 16:21:21 -07001795 * @end: The final page index (inclusive)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 * @nr_pages: The maximum number of pages
1797 * @pages: Where the resulting pages are placed
1798 *
Jan Karab947cee2017-09-06 16:21:21 -07001799 * find_get_pages_range() will search for and return a group of up to @nr_pages
1800 * pages in the mapping starting at index @start and up to index @end
1801 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1802 * a reference against the returned pages.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 *
1804 * The search returns a group of mapping-contiguous pages with ascending
1805 * indexes. There may be holes in the indices due to not-present pages.
Jan Karad72dc8a2017-09-06 16:21:18 -07001806 * We also update @start to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001808 * Return: the number of pages which were found. If this number is
1809 * smaller than @nr_pages, the end of specified range has been
Jan Karab947cee2017-09-06 16:21:21 -07001810 * reached.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 */
Jan Karab947cee2017-09-06 16:21:21 -07001812unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1813 pgoff_t end, unsigned int nr_pages,
1814 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001815{
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001816 XA_STATE(xas, &mapping->i_pages, *start);
1817 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001818 unsigned ret = 0;
1819
1820 if (unlikely(!nr_pages))
1821 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822
Nick Piggina60637c2008-07-25 19:45:31 -07001823 rcu_read_lock();
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001824 xas_for_each(&xas, page, end) {
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001825 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001826 continue;
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001827 /* Skip over shadow, swap and DAX entries */
1828 if (xa_is_value(page))
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001829 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001830
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001831 if (!page_cache_get_speculative(page))
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001832 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001833
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001834 /* Has the page moved or been split? */
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001835 if (unlikely(page != xas_reload(&xas)))
1836 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001837
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001838 pages[ret] = find_subpage(page, xas.xa_index);
Jan Karab947cee2017-09-06 16:21:21 -07001839 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001840 *start = xas.xa_index + 1;
Jan Karab947cee2017-09-06 16:21:21 -07001841 goto out;
1842 }
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001843 continue;
1844put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001845 put_page(page);
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001846retry:
1847 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001848 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001849
Jan Karab947cee2017-09-06 16:21:21 -07001850 /*
1851 * We come here when there is no page beyond @end. We take care to not
1852 * overflow the index @start as it confuses some of the callers. This
Matthew Wilcoxfd1b3ce2018-05-16 17:38:56 -04001853 * breaks the iteration when there is a page at index -1 but that is
Jan Karab947cee2017-09-06 16:21:21 -07001854 * already broken anyway.
1855 */
1856 if (end == (pgoff_t)-1)
1857 *start = (pgoff_t)-1;
1858 else
1859 *start = end + 1;
1860out:
Nick Piggina60637c2008-07-25 19:45:31 -07001861 rcu_read_unlock();
Jan Karad72dc8a2017-09-06 16:21:18 -07001862
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863 return ret;
1864}
1865
Jens Axboeebf43502006-04-27 08:46:01 +02001866/**
1867 * find_get_pages_contig - gang contiguous pagecache lookup
1868 * @mapping: The address_space to search
1869 * @index: The starting page index
1870 * @nr_pages: The maximum number of pages
1871 * @pages: Where the resulting pages are placed
1872 *
1873 * find_get_pages_contig() works exactly like find_get_pages(), except
1874 * that the returned number of pages are guaranteed to be contiguous.
1875 *
Mike Rapoporta862f682019-03-05 15:48:42 -08001876 * Return: the number of pages which were found.
Jens Axboeebf43502006-04-27 08:46:01 +02001877 */
1878unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1879 unsigned int nr_pages, struct page **pages)
1880{
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001881 XA_STATE(xas, &mapping->i_pages, index);
1882 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001883 unsigned int ret = 0;
1884
1885 if (unlikely(!nr_pages))
1886 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001887
Nick Piggina60637c2008-07-25 19:45:31 -07001888 rcu_read_lock();
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001889 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001890 if (xas_retry(&xas, page))
1891 continue;
1892 /*
1893 * If the entry has been swapped out, we can stop looking.
1894 * No current caller is looking for DAX entries.
1895 */
1896 if (xa_is_value(page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001897 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001898
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001899 if (!page_cache_get_speculative(page))
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001900 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001901
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001902 /* Has the page moved or been split? */
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001903 if (unlikely(page != xas_reload(&xas)))
1904 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001905
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001906 pages[ret] = find_subpage(page, xas.xa_index);
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001907 if (++ret == nr_pages)
1908 break;
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001909 continue;
1910put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001911 put_page(page);
Matthew Wilcox3ece58a2018-05-16 18:00:33 -04001912retry:
1913 xas_reset(&xas);
Jens Axboeebf43502006-04-27 08:46:01 +02001914 }
Nick Piggina60637c2008-07-25 19:45:31 -07001915 rcu_read_unlock();
1916 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001917}
David Howellsef71c152007-05-09 02:33:44 -07001918EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001919
Randy Dunlap485bb992006-06-23 02:03:49 -07001920/**
Jan Kara72b045a2017-11-15 17:34:33 -08001921 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001922 * @mapping: the address_space to search
1923 * @index: the starting page index
Jan Kara72b045a2017-11-15 17:34:33 -08001924 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001925 * @tag: the tag index
1926 * @nr_pages: the maximum number of pages
1927 * @pages: where the resulting pages are placed
1928 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001930 * @tag. We update @index to index the next page for the traversal.
Mike Rapoporta862f682019-03-05 15:48:42 -08001931 *
1932 * Return: the number of pages which were found.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933 */
Jan Kara72b045a2017-11-15 17:34:33 -08001934unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001935 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
Jan Kara72b045a2017-11-15 17:34:33 -08001936 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937{
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001938 XA_STATE(xas, &mapping->i_pages, *index);
1939 struct page *page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001940 unsigned ret = 0;
1941
1942 if (unlikely(!nr_pages))
1943 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944
Nick Piggina60637c2008-07-25 19:45:31 -07001945 rcu_read_lock();
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001946 xas_for_each_marked(&xas, page, end, tag) {
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001947 if (xas_retry(&xas, page))
Nick Piggina60637c2008-07-25 19:45:31 -07001948 continue;
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001949 /*
1950 * Shadow entries should never be tagged, but this iteration
1951 * is lockless so there is a window for page reclaim to evict
1952 * a page we saw tagged. Skip over it.
1953 */
1954 if (xa_is_value(page))
Johannes Weiner139b6a62014-05-06 12:50:05 -07001955 continue;
Nick Piggina60637c2008-07-25 19:45:31 -07001956
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001957 if (!page_cache_get_speculative(page))
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001958 goto retry;
Nick Piggina60637c2008-07-25 19:45:31 -07001959
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001960 /* Has the page moved or been split? */
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001961 if (unlikely(page != xas_reload(&xas)))
1962 goto put_page;
Nick Piggina60637c2008-07-25 19:45:31 -07001963
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001964 pages[ret] = find_subpage(page, xas.xa_index);
Jan Kara72b045a2017-11-15 17:34:33 -08001965 if (++ret == nr_pages) {
Yu Zhao5d3ee422019-03-05 15:49:17 -08001966 *index = xas.xa_index + 1;
Jan Kara72b045a2017-11-15 17:34:33 -08001967 goto out;
1968 }
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001969 continue;
1970put_page:
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07001971 put_page(page);
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001972retry:
1973 xas_reset(&xas);
Nick Piggina60637c2008-07-25 19:45:31 -07001974 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001975
Jan Kara72b045a2017-11-15 17:34:33 -08001976 /*
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001977 * We come here when we got to @end. We take care to not overflow the
Jan Kara72b045a2017-11-15 17:34:33 -08001978 * index @index as it confuses some of the callers. This breaks the
Matthew Wilcoxa6906972018-05-16 18:12:54 -04001979 * iteration when there is a page at index -1 but that is already
1980 * broken anyway.
Jan Kara72b045a2017-11-15 17:34:33 -08001981 */
1982 if (end == (pgoff_t)-1)
1983 *index = (pgoff_t)-1;
1984 else
1985 *index = end + 1;
1986out:
Nick Piggina60637c2008-07-25 19:45:31 -07001987 rcu_read_unlock();
1988
Linus Torvalds1da177e2005-04-16 15:20:36 -07001989 return ret;
1990}
Jan Kara72b045a2017-11-15 17:34:33 -08001991EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001993/*
1994 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1995 * a _large_ part of the i/o request. Imagine the worst scenario:
1996 *
1997 * ---R__________________________________________B__________
1998 * ^ reading here ^ bad block(assume 4k)
1999 *
2000 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2001 * => failing the whole request => read(R) => read(R+1) =>
2002 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2003 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2004 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2005 *
2006 * It is going insane. Fix it by quickly scaling down the readahead size.
2007 */
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002008static void shrink_readahead_size_eio(struct file_ra_state *ra)
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002009{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002010 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07002011}
2012
Randy Dunlap485bb992006-06-23 02:03:49 -07002013/**
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002014 * generic_file_buffered_read - generic file read routine
2015 * @iocb: the iocb to read
Al Viro6e58e792014-02-03 17:07:03 -05002016 * @iter: data destination
2017 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07002018 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07002020 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 *
2022 * This is really ugly. But the goto's actually try to clarify some
2023 * of the logic when it comes to error handling etc.
Mike Rapoporta862f682019-03-05 15:48:42 -08002024 *
2025 * Return:
2026 * * total number of bytes copied, including those the were already @written
2027 * * negative error code if nothing was copied
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 */
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002029ssize_t generic_file_buffered_read(struct kiocb *iocb,
Al Viro6e58e792014-02-03 17:07:03 -05002030 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031{
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002032 struct file *filp = iocb->ki_filp;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002033 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08002035 struct file_ra_state *ra = &filp->f_ra;
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002036 loff_t *ppos = &iocb->ki_pos;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002037 pgoff_t index;
2038 pgoff_t last_index;
2039 pgoff_t prev_index;
2040 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07002041 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05002042 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043
Wei Fangc2a97372016-10-07 17:01:52 -07002044 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08002045 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07002046 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2047
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002048 index = *ppos >> PAGE_SHIFT;
2049 prev_index = ra->prev_pos >> PAGE_SHIFT;
2050 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2051 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2052 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 for (;;) {
2055 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07002056 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002057 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058 unsigned long nr, ret;
2059
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08002062 if (fatal_signal_pending(current)) {
2063 error = -EINTR;
2064 goto out;
2065 }
2066
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002068 if (!page) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002069 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
Milosz Tanski3239d832017-08-29 16:13:19 +02002070 goto would_block;
Rusty Russellcf914a72007-07-19 01:48:08 -07002071 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002072 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002073 index, last_index - index);
2074 page = find_get_page(mapping, index);
2075 if (unlikely(page == NULL))
2076 goto no_cached_page;
2077 }
2078 if (PageReadahead(page)) {
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002079 if (iocb->ki_flags & IOCB_NOIO) {
2080 put_page(page);
2081 goto out;
2082 }
Rusty Russellcf914a72007-07-19 01:48:08 -07002083 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07002084 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07002085 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002087 if (!PageUptodate(page)) {
Milosz Tanski3239d832017-08-29 16:13:19 +02002088 if (iocb->ki_flags & IOCB_NOWAIT) {
2089 put_page(page);
2090 goto would_block;
2091 }
2092
Mel Gormanebded022016-03-15 14:55:39 -07002093 /*
2094 * See comment in do_read_cache_page on why
2095 * wait_on_page_locked is used to avoid unnecessarily
2096 * serialisations and why it's safe.
2097 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07002098 error = wait_on_page_locked_killable(page);
2099 if (unlikely(error))
2100 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07002101 if (PageUptodate(page))
2102 goto page_ok;
2103
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002104 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002105 !mapping->a_ops->is_partially_uptodate)
2106 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002107 /* pipes can't handle partially uptodate pages */
David Howells00e23702018-10-22 13:07:28 +01002108 if (unlikely(iov_iter_is_pipe(iter)))
Eryu Guan6d6d36b2016-11-01 15:43:07 +08002109 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02002110 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002111 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08002112 /* Did it get truncated before we got the lock? */
2113 if (!page->mapping)
2114 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002115 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05002116 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002117 goto page_not_up_to_date_locked;
2118 unlock_page(page);
2119 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002120page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07002121 /*
2122 * i_size must be checked after we know the page is Uptodate.
2123 *
2124 * Checking i_size after the check allows us to calculate
2125 * the correct value for "nr", which means the zero-filled
2126 * part of the page is not copied back to userspace (unless
2127 * another truncate extends the file - this is desired though).
2128 */
2129
2130 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002131 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002132 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002133 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002134 goto out;
2135 }
2136
2137 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002138 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002139 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002140 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07002141 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002142 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07002143 goto out;
2144 }
2145 }
2146 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002147
2148 /* If users can be writing to this page using arbitrary
2149 * virtual addresses, take care about potential aliasing
2150 * before reading the page on the kernel side.
2151 */
2152 if (mapping_writably_mapped(mapping))
2153 flush_dcache_page(page);
2154
2155 /*
Jan Karaec0f1632007-05-06 14:49:25 -07002156 * When a sequential read accesses a page several times,
2157 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 */
Jan Karaec0f1632007-05-06 14:49:25 -07002159 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002160 mark_page_accessed(page);
2161 prev_index = index;
2162
2163 /*
2164 * Ok, we have the page, and it's up-to-date, so
2165 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 */
Al Viro6e58e792014-02-03 17:07:03 -05002167
2168 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002170 index += offset >> PAGE_SHIFT;
2171 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07002172 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002173
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002174 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002175 written += ret;
2176 if (!iov_iter_count(iter))
2177 goto out;
2178 if (ret < nr) {
2179 error = -EFAULT;
2180 goto out;
2181 }
2182 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002183
2184page_not_up_to_date:
2185 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04002186 error = lock_page_killable(page);
2187 if (unlikely(error))
2188 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07002190page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07002191 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002192 if (!page->mapping) {
2193 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002194 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 continue;
2196 }
2197
2198 /* Did somebody else fill it already? */
2199 if (PageUptodate(page)) {
2200 unlock_page(page);
2201 goto page_ok;
2202 }
2203
2204readpage:
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002205 if (iocb->ki_flags & IOCB_NOIO) {
2206 unlock_page(page);
2207 put_page(page);
2208 goto would_block;
2209 }
Jeff Moyer91803b42010-05-26 11:49:40 -04002210 /*
2211 * A previous I/O error may have been due to temporary
2212 * failures, eg. multipath errors.
2213 * PG_error will be set again if readpage fails.
2214 */
2215 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 /* Start the actual read. The read will unlock the page. */
2217 error = mapping->a_ops->readpage(filp, page);
2218
Zach Brown994fc28c2005-12-15 14:28:17 -08002219 if (unlikely(error)) {
2220 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002221 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002222 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08002223 goto find_page;
2224 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08002226 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002227
2228 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04002229 error = lock_page_killable(page);
2230 if (unlikely(error))
2231 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 if (!PageUptodate(page)) {
2233 if (page->mapping == NULL) {
2234 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01002235 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07002236 */
2237 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002238 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239 goto find_page;
2240 }
2241 unlock_page(page);
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002242 shrink_readahead_size_eio(ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04002243 error = -EIO;
2244 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 }
2246 unlock_page(page);
2247 }
2248
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 goto page_ok;
2250
2251readpage_error:
2252 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002253 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 goto out;
2255
2256no_cached_page:
2257 /*
2258 * Ok, it wasn't cached, so we need to create a new
2259 * page..
2260 */
Mel Gorman453f85d2017-11-15 17:38:03 -08002261 page = page_cache_alloc(mapping);
Nick Piggineb2be182007-10-16 01:24:57 -07002262 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002263 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002264 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002265 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002266 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002267 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002269 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002270 if (error == -EEXIST) {
2271 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002272 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002273 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274 goto out;
2275 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 goto readpage;
2277 }
2278
Milosz Tanski3239d832017-08-29 16:13:19 +02002279would_block:
2280 error = -EAGAIN;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002282 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002283 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002284 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002285
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002286 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002287 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002288 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002289}
Goldwyn Rodriguesd85dc2e2019-08-30 12:09:24 -05002290EXPORT_SYMBOL_GPL(generic_file_buffered_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
Randy Dunlap485bb992006-06-23 02:03:49 -07002292/**
Al Viro6abd2322014-04-04 14:20:57 -04002293 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002294 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002295 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002296 *
Al Viro6abd2322014-04-04 14:20:57 -04002297 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 * that can use the page cache directly.
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002299 *
2300 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2301 * be returned when no data can be read without waiting for I/O requests
2302 * to complete; it doesn't prevent readahead.
2303 *
2304 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2305 * requests shall be made for the read or for readahead. When no data
2306 * can be read, -EAGAIN shall be returned. When readahead would be
2307 * triggered, a partial, possibly empty read shall be returned.
2308 *
Mike Rapoporta862f682019-03-05 15:48:42 -08002309 * Return:
2310 * * number of bytes copied, even for partial reads
Andreas Gruenbacher41da51b2019-11-21 23:25:07 +00002311 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
Linus Torvalds1da177e2005-04-16 15:20:36 -07002312 */
2313ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002314generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315{
Nicolai Stangee7080a42016-03-25 14:22:14 -07002316 size_t count = iov_iter_count(iter);
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002317 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002318
2319 if (!count)
2320 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321
Al Viro2ba48ce2015-04-09 13:52:01 -04002322 if (iocb->ki_flags & IOCB_DIRECT) {
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002323 struct file *file = iocb->ki_filp;
Al Viroed978a82014-03-05 22:53:04 -05002324 struct address_space *mapping = file->f_mapping;
2325 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002326 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327
Linus Torvalds1da177e2005-04-16 15:20:36 -07002328 size = i_size_read(inode);
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05002329 if (iocb->ki_flags & IOCB_NOWAIT) {
2330 if (filemap_range_has_page(mapping, iocb->ki_pos,
2331 iocb->ki_pos + count - 1))
2332 return -EAGAIN;
2333 } else {
2334 retval = filemap_write_and_wait_range(mapping,
2335 iocb->ki_pos,
2336 iocb->ki_pos + count - 1);
2337 if (retval < 0)
2338 goto out;
2339 }
Al Viroed978a82014-03-05 22:53:04 -05002340
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002341 file_accessed(file);
2342
Al Viro5ecda132017-04-13 14:13:36 -04002343 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002344 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002345 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002346 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002347 }
Al Viro5b47d592017-05-08 13:54:47 -04002348 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002349
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002350 /*
2351 * Btrfs can have a short DIO read if we encounter
2352 * compressed extents, so if there was an error, or if
2353 * we've already read everything we wanted to, or if
2354 * there was a short read because we hit EOF, go ahead
2355 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002356 * the rest of the read. Buffered reads will not work for
2357 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002358 */
Al Viro5ecda132017-04-13 14:13:36 -04002359 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002360 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002361 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002362 }
2363
Christoph Hellwig47c27bc2017-08-29 16:13:18 +02002364 retval = generic_file_buffered_read(iocb, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002365out:
2366 return retval;
2367}
Al Viroed978a82014-03-05 22:53:04 -05002368EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002369
Linus Torvalds1da177e2005-04-16 15:20:36 -07002370#ifdef CONFIG_MMU
Linus Torvalds1da177e2005-04-16 15:20:36 -07002371#define MMAP_LOTSAMISS (100)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002372/*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002373 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002374 * @vmf - the vm_fault for this fault.
2375 * @page - the page to lock.
2376 * @fpin - the pointer to the file we may pin (or is already pinned).
2377 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002378 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002379 * It differs in that it actually returns the page locked if it returns 1 and 0
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002380 * 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 -07002381 * will point to the pinned file and needs to be fput()'ed at a later point.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002382 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002383static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2384 struct file **fpin)
2385{
2386 if (trylock_page(page))
2387 return 1;
2388
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002389 /*
2390 * NOTE! This will make us return with VM_FAULT_RETRY, but with
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002391 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
Linus Torvalds8b0f9fa2019-03-15 11:26:07 -07002392 * is supposed to work. We have way too many special cases..
2393 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002394 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2395 return 0;
2396
2397 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2398 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2399 if (__lock_page_killable(page)) {
2400 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002401 * We didn't have the right flags to drop the mmap_lock,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002402 * but all fault_handlers only check for fatal signals
2403 * if we return VM_FAULT_RETRY, so we need to drop the
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002404 * mmap_lock here and return 0 if we don't have a fpin.
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002405 */
2406 if (*fpin == NULL)
Michel Lespinassed8ed45c2020-06-08 21:33:25 -07002407 mmap_read_unlock(vmf->vma->vm_mm);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002408 return 0;
2409 }
2410 } else
2411 __lock_page(page);
2412 return 1;
2413}
2414
2415
2416/*
2417 * Synchronous readahead happens when we don't even find a page in the page
2418 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2419 * to drop the mmap sem we return the file that was pinned in order for us to do
2420 * that. If we didn't pin a file then we return NULL. The file that is
2421 * returned needs to be fput()'ed when we're done with it.
2422 */
2423static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002424{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002425 struct file *file = vmf->vma->vm_file;
2426 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002427 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002428 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002429 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002430
2431 /* If we don't want any read-ahead, don't bother */
Josef Bacik2a1180f2019-03-13 11:44:18 -07002432 if (vmf->vma->vm_flags & VM_RAND_READ)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002433 return fpin;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002434 if (!ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002435 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002436
Josef Bacik2a1180f2019-03-13 11:44:18 -07002437 if (vmf->vma->vm_flags & VM_SEQ_READ) {
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002438 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002439 page_cache_sync_readahead(mapping, ra, file, offset,
2440 ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002441 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002442 }
2443
Andi Kleen207d04b2011-05-24 17:12:29 -07002444 /* Avoid banging the cache line if not needed */
2445 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002446 ra->mmap_miss++;
2447
2448 /*
2449 * Do we miss much more than hit in this file? If so,
2450 * stop bothering with read-ahead. It will only hurt.
2451 */
2452 if (ra->mmap_miss > MMAP_LOTSAMISS)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002453 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002454
Wu Fengguangd30a1102009-06-16 15:31:30 -07002455 /*
2456 * mmap read-around
2457 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002458 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Roman Gushchin600e19a2015-11-05 18:47:08 -08002459 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2460 ra->size = ra->ra_pages;
2461 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002462 ra_submit(ra, mapping, file);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002463 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002464}
2465
2466/*
2467 * Asynchronous readahead happens when we find the page and PG_readahead,
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002468 * so we want to possibly extend the readahead further. We return the file that
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002469 * was pinned if we have to drop the mmap_lock in order to do IO.
Linus Torvaldsef00e082009-06-16 15:31:25 -07002470 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002471static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2472 struct page *page)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002473{
Josef Bacik2a1180f2019-03-13 11:44:18 -07002474 struct file *file = vmf->vma->vm_file;
2475 struct file_ra_state *ra = &file->f_ra;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002476 struct address_space *mapping = file->f_mapping;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002477 struct file *fpin = NULL;
Josef Bacik2a1180f2019-03-13 11:44:18 -07002478 pgoff_t offset = vmf->pgoff;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002479
2480 /* If we don't want any read-ahead, don't bother */
Jan Kara5c72fee2020-04-01 21:04:40 -07002481 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002482 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002483 if (ra->mmap_miss > 0)
2484 ra->mmap_miss--;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002485 if (PageReadahead(page)) {
2486 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002487 page_cache_async_readahead(mapping, ra, file,
2488 page, offset, ra->ra_pages);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002489 }
2490 return fpin;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002491}
2492
Randy Dunlap485bb992006-06-23 02:03:49 -07002493/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002494 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002495 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002496 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002497 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002498 * mapped memory region to read in file data during a page fault.
2499 *
2500 * The goto's are kind of ugly, but this streamlines the normal case of having
2501 * it in the page cache, and handles the special cases reasonably without
2502 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002503 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002504 * vma->vm_mm->mmap_lock must be held on entry.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002505 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002506 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
Yang Shia4985832019-07-11 20:55:29 -07002507 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002508 *
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002509 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002510 * has not been released.
2511 *
2512 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Mike Rapoporta862f682019-03-05 15:48:42 -08002513 *
2514 * Return: bitwise-OR of %VM_FAULT_ codes.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515 */
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002516vm_fault_t filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517{
2518 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002519 struct file *file = vmf->vma->vm_file;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002520 struct file *fpin = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002521 struct address_space *mapping = file->f_mapping;
2522 struct file_ra_state *ra = &file->f_ra;
2523 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002524 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002525 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002526 struct page *page;
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002527 vm_fault_t ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002528
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002529 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2530 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002531 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002534 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002535 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002536 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002537 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002539 * We found the page, so try async readahead before
2540 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541 */
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002542 fpin = do_async_mmap_readahead(vmf, page);
Shaohua Li45cac652012-10-08 16:32:19 -07002543 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002544 /* No page in the page cache at all */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002545 count_vm_event(PGMAJFAULT);
Roman Gushchin22621852017-07-06 15:40:25 -07002546 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002547 ret = VM_FAULT_MAJOR;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002548 fpin = do_sync_mmap_readahead(vmf);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002549retry_find:
Josef Bacika75d4c32019-03-13 11:44:14 -07002550 page = pagecache_get_page(mapping, offset,
2551 FGP_CREAT|FGP_FOR_MMAP,
2552 vmf->gfp_mask);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002553 if (!page) {
2554 if (fpin)
2555 goto out_retry;
Matthew Wilcox (Oracle)e520e932020-04-01 21:04:53 -07002556 return VM_FAULT_OOM;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002557 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002558 }
2559
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002560 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2561 goto out_retry;
Michel Lespinasseb522c942010-10-26 14:21:56 -07002562
2563 /* Did it get truncated? */
Song Liu585e5a72019-09-23 15:37:44 -07002564 if (unlikely(compound_head(page)->mapping != mapping)) {
Michel Lespinasseb522c942010-10-26 14:21:56 -07002565 unlock_page(page);
2566 put_page(page);
2567 goto retry_find;
2568 }
Song Liu520e5ba2019-09-23 15:37:50 -07002569 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002570
Linus Torvalds1da177e2005-04-16 15:20:36 -07002571 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002572 * We have a locked page in the page cache, now we need to check
2573 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002574 */
Nick Piggind00806b2007-07-19 01:46:57 -07002575 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002576 goto page_not_uptodate;
2577
Linus Torvaldsef00e082009-06-16 15:31:25 -07002578 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002579 * We've made it this far and we had to drop our mmap_lock, now is the
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002580 * time to return to the upper layer and have it re-find the vma and
2581 * redo the fault.
2582 */
2583 if (fpin) {
2584 unlock_page(page);
2585 goto out_retry;
2586 }
2587
2588 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002589 * Found the page and have a reference on it.
2590 * We must recheck i_size under page lock.
2591 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002592 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2593 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002594 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002595 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002596 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002597 }
2598
Nick Piggind0217ac2007-07-19 01:47:03 -07002599 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002600 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002601
Linus Torvalds1da177e2005-04-16 15:20:36 -07002602page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002603 /*
2604 * Umm, take care of errors if the page isn't up-to-date.
2605 * Try to re-read it _once_. We do this synchronously,
2606 * because there really aren't any performance issues here
2607 * and we need to check for errors.
2608 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002609 ClearPageError(page);
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002610 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
Zach Brown994fc28c2005-12-15 14:28:17 -08002611 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002612 if (!error) {
2613 wait_on_page_locked(page);
2614 if (!PageUptodate(page))
2615 error = -EIO;
2616 }
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002617 if (fpin)
2618 goto out_retry;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002619 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002620
2621 if (!error || error == AOP_TRUNCATED_PAGE)
2622 goto retry_find;
2623
Souptick Joarder0f8e2db2020-04-01 21:04:50 -07002624 shrink_readahead_size_eio(ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002625 return VM_FAULT_SIGBUS;
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002626
2627out_retry:
2628 /*
Michel Lespinassec1e8d7c2020-06-08 21:33:54 -07002629 * We dropped the mmap_lock, we need to return to the fault handler to
Josef Bacik6b4c9f42019-03-13 11:44:22 -07002630 * re-find the vma and come back and find our hopefully still populated
2631 * page.
2632 */
2633 if (page)
2634 put_page(page);
2635 if (fpin)
2636 fput(fpin);
2637 return ret | VM_FAULT_RETRY;
Nick Piggin54cb8822007-07-19 01:46:59 -07002638}
2639EXPORT_SYMBOL(filemap_fault);
2640
Jan Kara82b0f8c2016-12-14 15:06:58 -08002641void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002642 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002643{
Jan Kara82b0f8c2016-12-14 15:06:58 -08002644 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002645 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002646 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002647 unsigned long max_idx;
Matthew Wilcox070e8072018-05-17 00:08:30 -04002648 XA_STATE(xas, &mapping->i_pages, start_pgoff);
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002649 struct page *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002650
2651 rcu_read_lock();
Matthew Wilcox070e8072018-05-17 00:08:30 -04002652 xas_for_each(&xas, page, end_pgoff) {
2653 if (xas_retry(&xas, page))
2654 continue;
2655 if (xa_is_value(page))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002656 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002657
Michal Hockoe0975b22018-12-28 00:38:36 -08002658 /*
2659 * Check for a locked page first, as a speculative
2660 * reference may adversely influence page migration.
2661 */
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002662 if (PageLocked(page))
Michal Hockoe0975b22018-12-28 00:38:36 -08002663 goto next;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002664 if (!page_cache_get_speculative(page))
Matthew Wilcox070e8072018-05-17 00:08:30 -04002665 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002666
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002667 /* Has the page moved or been split? */
Matthew Wilcox070e8072018-05-17 00:08:30 -04002668 if (unlikely(page != xas_reload(&xas)))
2669 goto skip;
Matthew Wilcox (Oracle)41011962019-09-23 15:34:52 -07002670 page = find_subpage(page, xas.xa_index);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002671
2672 if (!PageUptodate(page) ||
2673 PageReadahead(page) ||
2674 PageHWPoison(page))
2675 goto skip;
2676 if (!trylock_page(page))
2677 goto skip;
2678
2679 if (page->mapping != mapping || !PageUptodate(page))
2680 goto unlock;
2681
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002682 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2683 if (page->index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002684 goto unlock;
2685
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002686 if (file->f_ra.mmap_miss > 0)
2687 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002688
Matthew Wilcox070e8072018-05-17 00:08:30 -04002689 vmf->address += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002690 if (vmf->pte)
Matthew Wilcox070e8072018-05-17 00:08:30 -04002691 vmf->pte += xas.xa_index - last_pgoff;
2692 last_pgoff = xas.xa_index;
Johannes Weiner9d82c692020-06-03 16:02:04 -07002693 if (alloc_set_pte(vmf, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002694 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002695 unlock_page(page);
2696 goto next;
2697unlock:
2698 unlock_page(page);
2699skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002700 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002701next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002702 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002703 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002704 break;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002705 }
2706 rcu_read_unlock();
2707}
2708EXPORT_SYMBOL(filemap_map_pages);
2709
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002710vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002711{
2712 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002713 struct inode *inode = file_inode(vmf->vma->vm_file);
Souptick Joarder2bcd6452018-06-07 17:08:00 -07002714 vm_fault_t ret = VM_FAULT_LOCKED;
Jan Kara4fcf1c62012-06-12 16:20:29 +02002715
Jan Kara14da9202012-06-12 16:20:37 +02002716 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002717 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002718 lock_page(page);
2719 if (page->mapping != inode->i_mapping) {
2720 unlock_page(page);
2721 ret = VM_FAULT_NOPAGE;
2722 goto out;
2723 }
Jan Kara14da9202012-06-12 16:20:37 +02002724 /*
2725 * We mark the page dirty already here so that when freeze is in
2726 * progress, we are guaranteed that writeback during freezing will
2727 * see the dirty page and writeprotect it again.
2728 */
2729 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002730 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002731out:
Jan Kara14da9202012-06-12 16:20:37 +02002732 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002733 return ret;
2734}
Jan Kara4fcf1c62012-06-12 16:20:29 +02002735
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002736const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002737 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002738 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002739 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002740};
2741
2742/* This is used for a general mmap of a disk file */
2743
2744int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2745{
2746 struct address_space *mapping = file->f_mapping;
2747
2748 if (!mapping->a_ops->readpage)
2749 return -ENOEXEC;
2750 file_accessed(file);
2751 vma->vm_ops = &generic_file_vm_ops;
2752 return 0;
2753}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002754
2755/*
2756 * This is for filesystems which do not implement ->writepage.
2757 */
2758int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2759{
2760 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2761 return -EINVAL;
2762 return generic_file_mmap(file, vma);
2763}
2764#else
Souptick Joarder4b96a372018-10-26 15:04:03 -07002765vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
Arnd Bergmann45397222018-04-13 15:35:27 -07002766{
Souptick Joarder4b96a372018-10-26 15:04:03 -07002767 return VM_FAULT_SIGBUS;
Arnd Bergmann45397222018-04-13 15:35:27 -07002768}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002769int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2770{
2771 return -ENOSYS;
2772}
2773int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2774{
2775 return -ENOSYS;
2776}
2777#endif /* CONFIG_MMU */
2778
Arnd Bergmann45397222018-04-13 15:35:27 -07002779EXPORT_SYMBOL(filemap_page_mkwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002780EXPORT_SYMBOL(generic_file_mmap);
2781EXPORT_SYMBOL(generic_file_readonly_mmap);
2782
Sasha Levin67f9fd92014-04-03 14:48:18 -07002783static struct page *wait_on_page_read(struct page *page)
2784{
2785 if (!IS_ERR(page)) {
2786 wait_on_page_locked(page);
2787 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002788 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002789 page = ERR_PTR(-EIO);
2790 }
2791 }
2792 return page;
2793}
2794
Mel Gorman32b63522016-03-15 14:55:36 -07002795static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002796 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002797 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002798 void *data,
2799 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002800{
Nick Piggineb2be182007-10-16 01:24:57 -07002801 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002802 int err;
2803repeat:
2804 page = find_get_page(mapping, index);
2805 if (!page) {
Mel Gorman453f85d2017-11-15 17:38:03 -08002806 page = __page_cache_alloc(gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002807 if (!page)
2808 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002809 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002810 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002811 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002812 if (err == -EEXIST)
2813 goto repeat;
Matthew Wilcox22ecdb42017-12-04 04:02:00 -05002814 /* Presumably ENOMEM for xarray node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002815 return ERR_PTR(err);
2816 }
Mel Gorman32b63522016-03-15 14:55:36 -07002817
2818filler:
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002819 if (filler)
2820 err = filler(data, page);
2821 else
2822 err = mapping->a_ops->readpage(data, page);
2823
Linus Torvalds1da177e2005-04-16 15:20:36 -07002824 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002825 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002826 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002827 }
Mel Gorman32b63522016-03-15 14:55:36 -07002828
2829 page = wait_on_page_read(page);
2830 if (IS_ERR(page))
2831 return page;
2832 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002833 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002834 if (PageUptodate(page))
2835 goto out;
2836
Mel Gormanebded022016-03-15 14:55:39 -07002837 /*
2838 * Page is not up to date and may be locked due one of the following
2839 * case a: Page is being filled and the page lock is held
2840 * case b: Read/write error clearing the page uptodate status
2841 * case c: Truncation in progress (page locked)
2842 * case d: Reclaim in progress
2843 *
2844 * Case a, the page will be up to date when the page is unlocked.
2845 * There is no need to serialise on the page lock here as the page
2846 * is pinned so the lock gives no additional protection. Even if the
2847 * the page is truncated, the data is still valid if PageUptodate as
2848 * it's a race vs truncate race.
2849 * Case b, the page will not be up to date
2850 * Case c, the page may be truncated but in itself, the data may still
2851 * be valid after IO completes as it's a read vs truncate race. The
2852 * operation must restart if the page is not uptodate on unlock but
2853 * otherwise serialising on page lock to stabilise the mapping gives
2854 * no additional guarantees to the caller as the page lock is
2855 * released before return.
2856 * Case d, similar to truncation. If reclaim holds the page lock, it
2857 * will be a race with remove_mapping that determines if the mapping
2858 * is valid on unlock but otherwise the data is valid and there is
2859 * no need to serialise with page lock.
2860 *
2861 * As the page lock gives no additional guarantee, we optimistically
2862 * wait on the page to be unlocked and check if it's up to date and
2863 * use the page if it is. Otherwise, the page lock is required to
2864 * distinguish between the different cases. The motivation is that we
2865 * avoid spurious serialisations and wakeups when multiple processes
2866 * wait on the same page for IO to complete.
2867 */
2868 wait_on_page_locked(page);
2869 if (PageUptodate(page))
2870 goto out;
2871
2872 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002873 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002874
2875 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876 if (!page->mapping) {
2877 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002878 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002879 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002880 }
Mel Gormanebded022016-03-15 14:55:39 -07002881
2882 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002883 if (PageUptodate(page)) {
2884 unlock_page(page);
2885 goto out;
2886 }
Xianting Tianfaffdfa2020-04-01 21:04:47 -07002887
2888 /*
2889 * A previous I/O error may have been due to temporary
2890 * failures.
2891 * Clear page error before actual read, PG_error will be
2892 * set again if read page fails.
2893 */
2894 ClearPageError(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002895 goto filler;
2896
David Howellsc855ff32007-05-09 13:42:20 +01002897out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002898 mark_page_accessed(page);
2899 return page;
2900}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002901
2902/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002903 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002904 * @mapping: the page's address_space
2905 * @index: the page index
2906 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002907 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002908 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002909 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002910 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002911 *
2912 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002913 *
2914 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002915 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002916struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002917 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002918 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002919 void *data)
2920{
Christoph Hellwigd322a8e2019-07-11 20:55:17 -07002921 return do_read_cache_page(mapping, index, filler, data,
2922 mapping_gfp_mask(mapping));
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002923}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002924EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002925
2926/**
2927 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2928 * @mapping: the page's address_space
2929 * @index: the page index
2930 * @gfp: the page allocator flags to use if allocating
2931 *
2932 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002933 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002934 *
2935 * If the page does not get brought uptodate, return -EIO.
Mike Rapoporta862f682019-03-05 15:48:42 -08002936 *
2937 * Return: up to date page on success, ERR_PTR() on failure.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002938 */
2939struct page *read_cache_page_gfp(struct address_space *mapping,
2940 pgoff_t index,
2941 gfp_t gfp)
2942{
Christoph Hellwig6c45b452019-07-11 20:55:20 -07002943 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002944}
2945EXPORT_SYMBOL(read_cache_page_gfp);
2946
Nick Piggin2f718ff2007-10-16 01:24:59 -07002947/*
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002948 * Don't operate on ranges the page cache doesn't support, and don't exceed the
2949 * LFS limits. If pos is under the limit it becomes a short access. If it
2950 * exceeds the limit we return -EFBIG.
2951 */
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002952static int generic_write_check_limits(struct file *file, loff_t pos,
2953 loff_t *count)
2954{
Amir Goldstein646955c2019-06-05 08:04:48 -07002955 struct inode *inode = file->f_mapping->host;
2956 loff_t max_size = inode->i_sb->s_maxbytes;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002957 loff_t limit = rlimit(RLIMIT_FSIZE);
2958
2959 if (limit != RLIM_INFINITY) {
2960 if (pos >= limit) {
2961 send_sig(SIGXFSZ, current, 0);
2962 return -EFBIG;
2963 }
2964 *count = min(*count, limit - pos);
2965 }
2966
Amir Goldstein646955c2019-06-05 08:04:48 -07002967 if (!(file->f_flags & O_LARGEFILE))
2968 max_size = MAX_NON_LFS;
2969
2970 if (unlikely(pos >= max_size))
2971 return -EFBIG;
2972
2973 *count = min(*count, max_size - pos);
2974
2975 return 0;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002976}
2977
2978/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979 * Performs necessary checks before doing a write
2980 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002981 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 * Returns appropriate error code that caller should return or
2983 * zero in case that write should be allowed.
2984 */
Al Viro3309dd02015-04-09 12:55:47 -04002985inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002986{
Al Viro3309dd02015-04-09 12:55:47 -04002987 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002988 struct inode *inode = file->f_mapping->host;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11002989 loff_t count;
2990 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991
Darrick J. Wongdc617f22019-08-20 07:55:16 -07002992 if (IS_SWAPFILE(inode))
2993 return -ETXTBSY;
2994
Al Viro3309dd02015-04-09 12:55:47 -04002995 if (!iov_iter_count(from))
2996 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002997
Al Viro0fa6b002015-04-04 04:05:48 -04002998 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002999 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04003000 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003001
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003002 if ((iocb->ki_flags & IOCB_NOWAIT) && !(iocb->ki_flags & IOCB_DIRECT))
3003 return -EINVAL;
3004
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003005 count = iov_iter_count(from);
3006 ret = generic_write_check_limits(file, iocb->ki_pos, &count);
3007 if (ret)
3008 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003009
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003010 iov_iter_truncate(from, count);
Al Viro3309dd02015-04-09 12:55:47 -04003011 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003012}
3013EXPORT_SYMBOL(generic_write_checks);
3014
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003015/*
3016 * Performs necessary checks before doing a clone.
3017 *
Amir Goldstein646955c2019-06-05 08:04:48 -07003018 * Can adjust amount of bytes to clone via @req_count argument.
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003019 * Returns appropriate error code that caller should return or
3020 * zero in case the clone should be allowed.
3021 */
3022int generic_remap_checks(struct file *file_in, loff_t pos_in,
3023 struct file *file_out, loff_t pos_out,
Darrick J. Wong42ec3d42018-10-30 10:41:49 +11003024 loff_t *req_count, unsigned int remap_flags)
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003025{
3026 struct inode *inode_in = file_in->f_mapping->host;
3027 struct inode *inode_out = file_out->f_mapping->host;
3028 uint64_t count = *req_count;
3029 uint64_t bcount;
3030 loff_t size_in, size_out;
3031 loff_t bs = inode_out->i_sb->s_blocksize;
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003032 int ret;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003033
3034 /* The start of both ranges must be aligned to an fs block. */
3035 if (!IS_ALIGNED(pos_in, bs) || !IS_ALIGNED(pos_out, bs))
3036 return -EINVAL;
3037
3038 /* Ensure offsets don't wrap. */
3039 if (pos_in + count < pos_in || pos_out + count < pos_out)
3040 return -EINVAL;
3041
3042 size_in = i_size_read(inode_in);
3043 size_out = i_size_read(inode_out);
3044
3045 /* Dedupe requires both ranges to be within EOF. */
Darrick J. Wong3d281932018-10-30 10:41:34 +11003046 if ((remap_flags & REMAP_FILE_DEDUP) &&
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003047 (pos_in >= size_in || pos_in + count > size_in ||
3048 pos_out >= size_out || pos_out + count > size_out))
3049 return -EINVAL;
3050
3051 /* Ensure the infile range is within the infile. */
3052 if (pos_in >= size_in)
3053 return -EINVAL;
3054 count = min(count, size_in - (uint64_t)pos_in);
3055
Darrick J. Wong9fd91a90cb2018-10-30 10:40:46 +11003056 ret = generic_write_check_limits(file_out, pos_out, &count);
3057 if (ret)
3058 return ret;
3059
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003060 /*
3061 * If the user wanted us to link to the infile's EOF, round up to the
3062 * next block boundary for this check.
3063 *
3064 * Otherwise, make sure the count is also block-aligned, having
3065 * already confirmed the starting offsets' block alignment.
3066 */
3067 if (pos_in + count == size_in) {
3068 bcount = ALIGN(size_in, bs) - pos_in;
3069 } else {
3070 if (!IS_ALIGNED(count, bs))
Darrick J. Wongeca36542018-10-30 10:42:10 +11003071 count = ALIGN_DOWN(count, bs);
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003072 bcount = count;
3073 }
3074
3075 /* Don't allow overlapped cloning within the same file. */
3076 if (inode_in == inode_out &&
3077 pos_out + bcount > pos_in &&
3078 pos_out < pos_in + bcount)
3079 return -EINVAL;
3080
Darrick J. Wongeca36542018-10-30 10:42:10 +11003081 /*
3082 * We shortened the request but the caller can't deal with that, so
3083 * bounce the request back to userspace.
3084 */
3085 if (*req_count != count && !(remap_flags & REMAP_FILE_CAN_SHORTEN))
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003086 return -EINVAL;
3087
Darrick J. Wongeca36542018-10-30 10:42:10 +11003088 *req_count = count;
Darrick J. Wong1383a7e2018-10-30 10:40:31 +11003089 return 0;
3090}
3091
Amir Goldsteina3171352019-06-05 08:04:48 -07003092
3093/*
3094 * Performs common checks before doing a file copy/clone
3095 * from @file_in to @file_out.
3096 */
3097int generic_file_rw_checks(struct file *file_in, struct file *file_out)
3098{
3099 struct inode *inode_in = file_inode(file_in);
3100 struct inode *inode_out = file_inode(file_out);
3101
3102 /* Don't copy dirs, pipes, sockets... */
3103 if (S_ISDIR(inode_in->i_mode) || S_ISDIR(inode_out->i_mode))
3104 return -EISDIR;
3105 if (!S_ISREG(inode_in->i_mode) || !S_ISREG(inode_out->i_mode))
3106 return -EINVAL;
3107
3108 if (!(file_in->f_mode & FMODE_READ) ||
3109 !(file_out->f_mode & FMODE_WRITE) ||
3110 (file_out->f_flags & O_APPEND))
3111 return -EBADF;
3112
3113 return 0;
3114}
3115
Amir Goldstein96e6e8f2019-06-05 08:04:49 -07003116/*
3117 * Performs necessary checks before doing a file copy
3118 *
3119 * Can adjust amount of bytes to copy via @req_count argument.
3120 * Returns appropriate error code that caller should return or
3121 * zero in case the copy should be allowed.
3122 */
3123int generic_copy_file_checks(struct file *file_in, loff_t pos_in,
3124 struct file *file_out, loff_t pos_out,
3125 size_t *req_count, unsigned int flags)
3126{
3127 struct inode *inode_in = file_inode(file_in);
3128 struct inode *inode_out = file_inode(file_out);
3129 uint64_t count = *req_count;
3130 loff_t size_in;
3131 int ret;
3132
3133 ret = generic_file_rw_checks(file_in, file_out);
3134 if (ret)
3135 return ret;
3136
3137 /* Don't touch certain kinds of inodes */
3138 if (IS_IMMUTABLE(inode_out))
3139 return -EPERM;
3140
3141 if (IS_SWAPFILE(inode_in) || IS_SWAPFILE(inode_out))
3142 return -ETXTBSY;
3143
3144 /* Ensure offsets don't wrap. */
3145 if (pos_in + count < pos_in || pos_out + count < pos_out)
3146 return -EOVERFLOW;
3147
3148 /* Shorten the copy to EOF */
3149 size_in = i_size_read(inode_in);
3150 if (pos_in >= size_in)
3151 count = 0;
3152 else
3153 count = min(count, size_in - (uint64_t)pos_in);
3154
3155 ret = generic_write_check_limits(file_out, pos_out, &count);
3156 if (ret)
3157 return ret;
3158
3159 /* Don't allow overlapped copying within the same file. */
3160 if (inode_in == inode_out &&
3161 pos_out + count > pos_in &&
3162 pos_out < pos_in + count)
3163 return -EINVAL;
3164
3165 *req_count = count;
3166 return 0;
3167}
3168
Nick Pigginafddba42007-10-16 01:25:01 -07003169int pagecache_write_begin(struct file *file, struct address_space *mapping,
3170 loff_t pos, unsigned len, unsigned flags,
3171 struct page **pagep, void **fsdata)
3172{
3173 const struct address_space_operations *aops = mapping->a_ops;
3174
Nick Piggin4e02ed42008-10-29 14:00:55 -07003175 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003176 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003177}
3178EXPORT_SYMBOL(pagecache_write_begin);
3179
3180int pagecache_write_end(struct file *file, struct address_space *mapping,
3181 loff_t pos, unsigned len, unsigned copied,
3182 struct page *page, void *fsdata)
3183{
3184 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07003185
Nick Piggin4e02ed42008-10-29 14:00:55 -07003186 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07003187}
3188EXPORT_SYMBOL(pagecache_write_end);
3189
Konstantin Khlebnikova92853b2019-11-30 17:49:44 -08003190/*
3191 * Warn about a page cache invalidation failure during a direct I/O write.
3192 */
3193void dio_warn_stale_pagecache(struct file *filp)
3194{
3195 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3196 char pathname[128];
3197 struct inode *inode = file_inode(filp);
3198 char *path;
3199
3200 errseq_set(&inode->i_mapping->wb_err, -EIO);
3201 if (__ratelimit(&_rs)) {
3202 path = file_path(filp, pathname, sizeof(pathname));
3203 if (IS_ERR(path))
3204 path = "(unknown)";
3205 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3206 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3207 current->comm);
3208 }
3209}
3210
Linus Torvalds1da177e2005-04-16 15:20:36 -07003211ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003212generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003213{
3214 struct file *file = iocb->ki_filp;
3215 struct address_space *mapping = file->f_mapping;
3216 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003217 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003218 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003219 size_t write_len;
3220 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003221
Al Viro0c949332014-03-22 06:51:37 -04003222 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003223 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003224
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003225 if (iocb->ki_flags & IOCB_NOWAIT) {
3226 /* If there are pages to writeback, return */
3227 if (filemap_range_has_page(inode->i_mapping, pos,
zhengbin35f12f02019-03-05 15:44:21 -08003228 pos + write_len - 1))
Goldwyn Rodrigues6be96d32017-06-20 07:05:44 -05003229 return -EAGAIN;
3230 } else {
3231 written = filemap_write_and_wait_range(mapping, pos,
3232 pos + write_len - 1);
3233 if (written)
3234 goto out;
3235 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07003236
3237 /*
3238 * After a write we want buffered reads to be sure to go to disk to get
3239 * the new data. We invalidate clean cached page from the region we're
3240 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07003241 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07003242 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003243 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003244 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07003245 /*
3246 * If a page can not be invalidated, return 0 to fall back
3247 * to buffered write.
3248 */
3249 if (written) {
3250 if (written == -EBUSY)
3251 return 0;
3252 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07003253 }
3254
Al Viro639a93a52017-04-13 14:10:15 -04003255 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003256
3257 /*
3258 * Finally, try again to invalidate clean pages which might have been
3259 * cached by non-direct readahead, or faulted in by get_user_pages()
3260 * if the source of the write was an mmap'ed region of the file
3261 * we're writing. Either one is a pretty crazy thing to do,
3262 * so we don't support it 100%. If this invalidation
3263 * fails, tough, the write still worked...
Lukas Czerner332391a2017-09-21 08:16:29 -06003264 *
3265 * Most of the time we do not need this since dio_complete() will do
3266 * the invalidation for us. However there are some file systems that
3267 * do not end up with dio_complete() being called, so let's not break
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003268 * them by removing it completely.
3269 *
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003270 * Noticeable example is a blkdev_direct_IO().
3271 *
Konstantin Khlebnikov80c1fe92019-11-30 17:49:41 -08003272 * Skip invalidation for async writes or if mapping has no pages.
Christoph Hellwiga969e902008-07-23 21:27:04 -07003273 */
Konstantin Khlebnikov9266a142019-11-30 17:49:47 -08003274 if (written > 0 && mapping->nrpages &&
3275 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3276 dio_warn_stale_pagecache(file);
Christoph Hellwiga969e902008-07-23 21:27:04 -07003277
Linus Torvalds1da177e2005-04-16 15:20:36 -07003278 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07003279 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04003280 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07003281 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3282 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003283 mark_inode_dirty(inode);
3284 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05003285 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003286 }
Al Viro639a93a52017-04-13 14:10:15 -04003287 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07003288out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07003289 return written;
3290}
3291EXPORT_SYMBOL(generic_file_direct_write);
3292
Nick Piggineb2be182007-10-16 01:24:57 -07003293/*
3294 * Find or create a page at the given pagecache position. Return the locked
3295 * page. This function is specifically for buffered writes.
3296 */
Nick Piggin54566b22009-01-04 12:00:53 -08003297struct page *grab_cache_page_write_begin(struct address_space *mapping,
3298 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07003299{
Nick Piggineb2be182007-10-16 01:24:57 -07003300 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07003301 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08003302
Nick Piggin54566b22009-01-04 12:00:53 -08003303 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07003304 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07003305
Mel Gorman2457aec2014-06-04 16:10:31 -07003306 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01003307 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07003308 if (page)
3309 wait_for_stable_page(page);
3310
Nick Piggineb2be182007-10-16 01:24:57 -07003311 return page;
3312}
Nick Piggin54566b22009-01-04 12:00:53 -08003313EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07003314
Al Viro3b93f912014-02-11 21:34:08 -05003315ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07003316 struct iov_iter *i, loff_t pos)
3317{
3318 struct address_space *mapping = file->f_mapping;
3319 const struct address_space_operations *a_ops = mapping->a_ops;
3320 long status = 0;
3321 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07003322 unsigned int flags = 0;
3323
Nick Pigginafddba42007-10-16 01:25:01 -07003324 do {
3325 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07003326 unsigned long offset; /* Offset into pagecache page */
3327 unsigned long bytes; /* Bytes to write to page */
3328 size_t copied; /* Bytes copied from user */
3329 void *fsdata;
3330
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003331 offset = (pos & (PAGE_SIZE - 1));
3332 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003333 iov_iter_count(i));
3334
3335again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01003336 /*
3337 * Bring in the user page that we will copy from _first_.
3338 * Otherwise there's a nasty deadlock on copying from the
3339 * same page as we're writing to, without it being marked
3340 * up-to-date.
3341 *
3342 * Not only is this an optimisation, but it is also required
3343 * to check that the address is actually valid, when atomic
3344 * usercopies are used, below.
3345 */
3346 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3347 status = -EFAULT;
3348 break;
3349 }
3350
Jan Kara296291c2015-10-22 13:32:21 -07003351 if (fatal_signal_pending(current)) {
3352 status = -EINTR;
3353 break;
3354 }
3355
Nick Piggin674b8922007-10-16 01:25:03 -07003356 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07003357 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07003358 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07003359 break;
3360
anfei zhou931e80e2010-02-02 13:44:02 -08003361 if (mapping_writably_mapped(mapping))
3362 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01003363
Nick Pigginafddba42007-10-16 01:25:01 -07003364 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07003365 flush_dcache_page(page);
3366
3367 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3368 page, fsdata);
3369 if (unlikely(status < 0))
3370 break;
3371 copied = status;
3372
3373 cond_resched();
3374
Nick Piggin124d3b72008-02-02 15:01:17 +01003375 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07003376 if (unlikely(copied == 0)) {
3377 /*
3378 * If we were unable to copy any data at all, we must
3379 * fall back to a single segment length write.
3380 *
3381 * If we didn't fallback here, we could livelock
3382 * because not all segments in the iov can be copied at
3383 * once without a pagefault.
3384 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003385 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07003386 iov_iter_single_seg_count(i));
3387 goto again;
3388 }
Nick Pigginafddba42007-10-16 01:25:01 -07003389 pos += copied;
3390 written += copied;
3391
3392 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07003393 } while (iov_iter_count(i));
3394
3395 return written ? written : status;
3396}
Al Viro3b93f912014-02-11 21:34:08 -05003397EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003398
Jan Karae4dd9de2009-08-17 18:10:06 +02003399/**
Al Viro81742022014-04-03 03:17:43 -04003400 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003401 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04003402 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003403 *
3404 * This function does all the work needed for actually writing data to a
3405 * file. It does all basic checks, removes SUID from the file, updates
3406 * modification times and calls proper subroutines depending on whether we
3407 * do direct IO or a standard buffered write.
3408 *
3409 * It expects i_mutex to be grabbed unless we work on a block device or similar
3410 * object which does not need locking at all.
3411 *
3412 * This function does *not* take care of syncing data in case of O_SYNC write.
3413 * A caller has to handle it. This is mainly due to the fact that we want to
3414 * avoid syncing under i_mutex.
Mike Rapoporta862f682019-03-05 15:48:42 -08003415 *
3416 * Return:
3417 * * number of bytes written, even for truncated writes
3418 * * negative error code if no data has been written at all
Jan Karae4dd9de2009-08-17 18:10:06 +02003419 */
Al Viro81742022014-04-03 03:17:43 -04003420ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003421{
3422 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003423 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003424 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05003425 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003426 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05003427 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003428
Linus Torvalds1da177e2005-04-16 15:20:36 -07003429 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01003430 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02003431 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003432 if (err)
3433 goto out;
3434
Josef Bacikc3b2da32012-03-26 09:59:21 -04003435 err = file_update_time(file);
3436 if (err)
3437 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003438
Al Viro2ba48ce2015-04-09 13:52:01 -04003439 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04003440 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003441
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07003442 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08003443 /*
3444 * If the write stopped short of completing, fall back to
3445 * buffered writes. Some filesystems do this for writes to
3446 * holes, for example. For DAX files, a buffered write will
3447 * not succeed (even if it did, DAX does not handle dirty
3448 * page-cache pages correctly).
3449 */
Al Viro0b8def92015-04-07 10:22:53 -04003450 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07003451 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05003452
Al Viro0b8def92015-04-07 10:22:53 -04003453 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003454 /*
Al Viro3b93f912014-02-11 21:34:08 -05003455 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003456 * then we want to return the number of bytes which were
3457 * direct-written, or the error code if that was zero. Note
3458 * that this differs from normal direct-io semantics, which
3459 * will return -EFOO even if some bytes were written.
3460 */
Al Viro60bb4522014-08-08 12:39:16 -04003461 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05003462 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003463 goto out;
3464 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003465 /*
3466 * We need to ensure that the page cache pages are written to
3467 * disk and invalidated to preserve the expected O_DIRECT
3468 * semantics.
3469 */
Al Viro3b93f912014-02-11 21:34:08 -05003470 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04003471 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003472 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04003473 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05003474 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003475 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03003476 pos >> PAGE_SHIFT,
3477 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003478 } else {
3479 /*
3480 * We don't know how much we wrote, so just return
3481 * the number of bytes which were direct-written
3482 */
3483 }
3484 } else {
Al Viro0b8def92015-04-07 10:22:53 -04003485 written = generic_perform_write(file, from, iocb->ki_pos);
3486 if (likely(written > 0))
3487 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07003488 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003489out:
3490 current->backing_dev_info = NULL;
3491 return written ? written : err;
3492}
Al Viro81742022014-04-03 03:17:43 -04003493EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003494
Jan Karae4dd9de2009-08-17 18:10:06 +02003495/**
Al Viro81742022014-04-03 03:17:43 -04003496 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003497 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003498 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003499 *
Al Viro81742022014-04-03 03:17:43 -04003500 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003501 * filesystems. It takes care of syncing the file in case of O_SYNC file
3502 * and acquires i_mutex as needed.
Mike Rapoporta862f682019-03-05 15:48:42 -08003503 * Return:
3504 * * negative error code if no data has been written at all of
3505 * vfs_fsync_range() failed for a synchronous write
3506 * * number of bytes written, even for truncated writes
Jan Karae4dd9de2009-08-17 18:10:06 +02003507 */
Al Viro81742022014-04-03 03:17:43 -04003508ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003509{
3510 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003511 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003512 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513
Al Viro59551022016-01-22 15:40:57 -05003514 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003515 ret = generic_write_checks(iocb, from);
3516 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003517 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003518 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003519
Christoph Hellwige2592212016-04-07 08:52:01 -07003520 if (ret > 0)
3521 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003522 return ret;
3523}
Al Viro81742022014-04-03 03:17:43 -04003524EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003525
David Howellscf9a2ae2006-08-29 19:05:54 +01003526/**
3527 * try_to_release_page() - release old fs-specific metadata on a page
3528 *
3529 * @page: the page which the kernel is trying to free
3530 * @gfp_mask: memory allocation flags (and I/O mode)
3531 *
3532 * The address_space is to try to release any data against the page
Mike Rapoporta862f682019-03-05 15:48:42 -08003533 * (presumably at page->private).
David Howellscf9a2ae2006-08-29 19:05:54 +01003534 *
David Howells266cf652009-04-03 16:42:36 +01003535 * This may also be called if PG_fscache is set on a page, indicating that the
3536 * page is known to the local caching routines.
3537 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003538 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003539 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003540 *
Mike Rapoporta862f682019-03-05 15:48:42 -08003541 * Return: %1 if the release was successful, otherwise return zero.
David Howellscf9a2ae2006-08-29 19:05:54 +01003542 */
3543int try_to_release_page(struct page *page, gfp_t gfp_mask)
3544{
3545 struct address_space * const mapping = page->mapping;
3546
3547 BUG_ON(!PageLocked(page));
3548 if (PageWriteback(page))
3549 return 0;
3550
3551 if (mapping && mapping->a_ops->releasepage)
3552 return mapping->a_ops->releasepage(page, gfp_mask);
3553 return try_to_free_buffers(page);
3554}
3555
3556EXPORT_SYMBOL(try_to_release_page);