blob: 7d78399e15aeb54f7ccab85ccd08e2dc66ee0498 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/mm/filemap.c
3 *
4 * Copyright (C) 1994-1999 Linus Torvalds
5 */
6
7/*
8 * This file handles the generic file mmap semantics used by
9 * most "normal" filesystems (but you don't /have/ to use this:
10 * the NFS filesystem used to do this differently, for example)
11 */
Paul Gortmakerb95f1b312011-10-16 02:01:52 -040012#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/compiler.h>
Ross Zwislerf9fe48b2016-01-22 15:10:40 -080014#include <linux/dax.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/fs.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070016#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080017#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/mm.h>
21#include <linux/swap.h>
22#include <linux/mman.h>
23#include <linux/pagemap.h>
24#include <linux/file.h>
25#include <linux/uio.h>
26#include <linux/hash.h>
27#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070028#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/pagevec.h>
30#include <linux/blkdev.h>
31#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080032#include <linux/cpuset.h>
Nick Piggin2f718ff2007-10-16 01:24:59 -070033#include <linux/hardirq.h> /* for BUG_ON(!in_atomic()) only */
Johannes Weiner00501b52014-08-08 14:19:20 -070034#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080035#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060036#include <linux/cleancache.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070037#include <linux/rmap.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080038#include "internal.h"
39
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070040#define CREATE_TRACE_POINTS
41#include <trace/events/filemap.h>
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * FIXME: remove all knowledge of the buffer layer from the core VM
45 */
Jan Kara148f9482009-08-17 19:52:36 +020046#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <asm/mman.h>
49
50/*
51 * Shared mappings implemented 30.11.1994. It's not fully working yet,
52 * though.
53 *
54 * Shared mappings now work. 15.8.1995 Bruno.
55 *
56 * finished 'unifying' the page and buffer cache and SMP-threaded the
57 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
58 *
59 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
60 */
61
62/*
63 * Lock ordering:
64 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080065 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070067 * ->swap_lock (exclusive_swap_page, others)
68 * ->mapping->tree_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080070 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080071 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 *
73 * ->mmap_sem
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080074 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070075 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 * ->mapping->tree_lock (arch-dependent flush_dcache_mmap_lock)
77 *
78 * ->mmap_sem
79 * ->lock_page (access_process_vm)
80 *
Al Viroccad2362014-02-11 22:36:48 -050081 * ->i_mutex (generic_perform_write)
Nick Piggin82591e62006-10-19 23:29:10 -070082 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060084 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110085 * sb_lock (fs/fs-writeback.c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 * ->mapping->tree_lock (__sync_single_inode)
87 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080088 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 * ->anon_vma.lock (vma_adjust)
90 *
91 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070092 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -070094 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -070095 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 * ->private_lock (try_to_unmap_one)
97 * ->tree_lock (try_to_unmap_one)
Mel Gormana52633d2016-07-28 15:45:28 -070098 * ->zone_lru_lock(zone) (follow_page->mark_page_accessed)
99 * ->zone_lru_lock(zone) (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 * ->private_lock (page_remove_rmap->set_page_dirty)
101 * ->tree_lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600102 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100103 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700104 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600105 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100106 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
108 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800109 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700110 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 */
112
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700113static int page_cache_tree_insert(struct address_space *mapping,
114 struct page *page, void **shadowp)
115{
116 struct radix_tree_node *node;
117 void **slot;
118 int error;
119
120 error = __radix_tree_create(&mapping->page_tree, page->index, 0,
121 &node, &slot);
122 if (error)
123 return error;
124 if (*slot) {
125 void *p;
126
127 p = radix_tree_deref_slot_protected(slot, &mapping->tree_lock);
128 if (!radix_tree_exceptional_entry(p))
129 return -EEXIST;
130
131 mapping->nrexceptional--;
132 if (!dax_mapping(mapping)) {
133 if (shadowp)
134 *shadowp = p;
135 if (node)
136 workingset_node_shadows_dec(node);
137 } else {
138 /* DAX can replace empty locked entry with a hole */
139 WARN_ON_ONCE(p !=
140 (void *)(RADIX_TREE_EXCEPTIONAL_ENTRY |
141 RADIX_DAX_ENTRY_LOCK));
142 /* DAX accounts exceptional entries as normal pages */
143 if (node)
144 workingset_node_pages_dec(node);
145 /* Wakeup waiters for exceptional entry lock */
146 dax_wake_mapping_entry_waiter(mapping, page->index,
Ross Zwisler87fa6f32017-01-10 16:57:15 -0800147 true);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700148 }
149 }
150 radix_tree_replace_slot(slot, page);
151 mapping->nrpages++;
152 if (node) {
153 workingset_node_pages_inc(node);
154 /*
155 * Don't track node that contains actual pages.
156 *
157 * Avoid acquiring the list_lru lock if already
158 * untracked. The list_empty() test is safe as
159 * node->private_list is protected by
160 * mapping->tree_lock.
161 */
162 if (!list_empty(&node->private_list))
163 list_lru_del(&workingset_shadow_nodes,
164 &node->private_list);
165 }
166 return 0;
167}
168
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700169static void page_cache_tree_delete(struct address_space *mapping,
170 struct page *page, void *shadow)
171{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700172 int i, nr = PageHuge(page) ? 1 : hpage_nr_pages(page);
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700173
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700174 VM_BUG_ON_PAGE(!PageLocked(page), page);
175 VM_BUG_ON_PAGE(PageTail(page), page);
176 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700177
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700178 for (i = 0; i < nr; i++) {
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200179 struct radix_tree_node *node;
180 void **slot;
181
182 __radix_tree_lookup(&mapping->page_tree, page->index + i,
183 &node, &slot);
184
185 radix_tree_clear_tags(&mapping->page_tree, node, slot);
186
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700187 if (!node) {
188 VM_BUG_ON_PAGE(nr != 1, page);
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200189 /*
190 * We need a node to properly account shadow
191 * entries. Don't plant any without. XXX
192 */
193 shadow = NULL;
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700194 }
Johannes Weiner449dd692014-04-03 14:47:56 -0700195
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200196 radix_tree_replace_slot(slot, shadow);
197
198 if (!node)
199 break;
200
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700201 workingset_node_pages_dec(node);
202 if (shadow)
203 workingset_node_shadows_inc(node);
204 else
205 if (__radix_tree_delete_node(&mapping->page_tree, node))
206 continue;
207
208 /*
209 * Track node that only contains shadow entries. DAX mappings
210 * contain no shadow entries and may contain other exceptional
211 * entries so skip those.
212 *
213 * Avoid acquiring the list_lru lock if already tracked.
214 * The list_empty() test is safe as node->private_list is
215 * protected by mapping->tree_lock.
216 */
217 if (!dax_mapping(mapping) && !workingset_node_pages(node) &&
218 list_empty(&node->private_list)) {
219 node->private_data = mapping;
220 list_lru_add(&workingset_shadow_nodes,
221 &node->private_list);
222 }
Johannes Weiner449dd692014-04-03 14:47:56 -0700223 }
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200224
225 if (shadow) {
226 mapping->nrexceptional += nr;
227 /*
228 * Make sure the nrexceptional update is committed before
229 * the nrpages update so that final truncate racing
230 * with reclaim does not see both counters 0 at the
231 * same time and miss a shadow entry.
232 */
233 smp_wmb();
234 }
235 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700236}
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238/*
Minchan Kime64a7822011-03-22 16:32:44 -0700239 * Delete a page from the page cache and free it. Caller has to make
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 * sure the page is locked and that nobody else uses it - or that usage
Johannes Weinerfdf1cdb2016-03-15 14:57:25 -0700241 * is safe. The caller must hold the mapping's tree_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 */
Johannes Weiner62cccb82016-03-15 14:57:22 -0700243void __delete_from_page_cache(struct page *page, void *shadow)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
245 struct address_space *mapping = page->mapping;
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700246 int nr = hpage_nr_pages(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -0700248 trace_mm_filemap_delete_from_page_cache(page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600249 /*
250 * if we're uptodate, flush out into the cleancache, otherwise
251 * invalidate any existing cleancache entries. We can't leave
252 * stale data around in the cleancache once our page is gone
253 */
254 if (PageUptodate(page) && PageMappedToDisk(page))
255 cleancache_put_page(page);
256 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400257 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600258
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700259 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800260 VM_BUG_ON_PAGE(page_mapped(page), page);
261 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
262 int mapcount;
263
264 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
265 current->comm, page_to_pfn(page));
266 dump_page(page, "still mapped when deleted");
267 dump_stack();
268 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
269
270 mapcount = page_mapcount(page);
271 if (mapping_exiting(mapping) &&
272 page_count(page) >= mapcount + 2) {
273 /*
274 * All vmas have already been torn down, so it's
275 * a good bet that actually the page is unmapped,
276 * and we'd prefer not to leak it: if we're wrong,
277 * some other bad page check should catch it later.
278 */
279 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700280 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800281 }
282 }
283
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700284 page_cache_tree_delete(mapping, page, shadow);
285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 page->mapping = NULL;
Hugh Dickinsb85e0ef2011-07-25 17:12:25 -0700287 /* Leave page->index set: truncation lookup relies upon it */
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700288
Michal Hocko4165b9b2015-06-24 16:57:24 -0700289 /* hugetlb pages do not participate in page cache accounting. */
290 if (!PageHuge(page))
Mel Gorman11fb9982016-07-28 15:46:20 -0700291 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700292 if (PageSwapBacked(page)) {
Mel Gorman11fb9982016-07-28 15:46:20 -0700293 __mod_node_page_state(page_pgdat(page), NR_SHMEM, -nr);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700294 if (PageTransHuge(page))
Mel Gorman11fb9982016-07-28 15:46:20 -0700295 __dec_node_page_state(page, NR_SHMEM_THPS);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700296 } else {
297 VM_BUG_ON_PAGE(PageTransHuge(page) && !PageHuge(page), page);
298 }
Linus Torvalds3a692792007-12-19 14:05:13 -0800299
300 /*
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700301 * At this point page must be either written or cleaned by truncate.
302 * Dirty page here signals a bug and loss of unwritten data.
Linus Torvalds3a692792007-12-19 14:05:13 -0800303 *
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700304 * This fixes dirty accounting after removing the page entirely but
305 * leaves PageDirty set: it has no effect for truncated page and
306 * anyway will be cleared before returning page into buddy allocator.
Linus Torvalds3a692792007-12-19 14:05:13 -0800307 */
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700308 if (WARN_ON_ONCE(PageDirty(page)))
Johannes Weiner62cccb82016-03-15 14:57:22 -0700309 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310}
311
Minchan Kim702cfbf2011-03-22 16:32:43 -0700312/**
313 * delete_from_page_cache - delete page from page cache
314 * @page: the page which the kernel is trying to remove from page cache
315 *
316 * This must be called only on pages that have been verified to be in the page
317 * cache and locked. It will never put the page into the free list, the caller
318 * has a reference on the page.
319 */
320void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700322 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400323 unsigned long flags;
Linus Torvalds6072d132010-12-01 13:35:19 -0500324 void (*freepage)(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Matt Mackallcd7619d2005-05-01 08:59:01 -0700326 BUG_ON(!PageLocked(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Linus Torvalds6072d132010-12-01 13:35:19 -0500328 freepage = mapping->a_ops->freepage;
Greg Thelenc4843a72015-05-22 17:13:16 -0400329
Greg Thelenc4843a72015-05-22 17:13:16 -0400330 spin_lock_irqsave(&mapping->tree_lock, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700331 __delete_from_page_cache(page, NULL);
Greg Thelenc4843a72015-05-22 17:13:16 -0400332 spin_unlock_irqrestore(&mapping->tree_lock, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500333
334 if (freepage)
335 freepage(page);
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700336
337 if (PageTransHuge(page) && !PageHuge(page)) {
338 page_ref_sub(page, HPAGE_PMD_NR);
339 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
340 } else {
341 put_page(page);
342 }
Minchan Kim97cecb52011-03-22 16:30:53 -0700343}
344EXPORT_SYMBOL(delete_from_page_cache);
345
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200346int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700347{
348 int ret = 0;
349 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700350 if (test_bit(AS_ENOSPC, &mapping->flags) &&
351 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700352 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700353 if (test_bit(AS_EIO, &mapping->flags) &&
354 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700355 ret = -EIO;
356 return ret;
357}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200358EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700361 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700362 * @mapping: address space structure to write
363 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800364 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700365 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700367 * Start writeback against all of a mapping's dirty pages that lie
368 * within the byte offsets <start, end> inclusive.
369 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700371 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 * these two operations is that if a dirty page/buffer is encountered, it must
373 * be waited upon, and not just skipped over.
374 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800375int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
376 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377{
378 int ret;
379 struct writeback_control wbc = {
380 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800381 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700382 .range_start = start,
383 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 };
385
386 if (!mapping_cap_writeback_dirty(mapping))
387 return 0;
388
Tejun Heob16b1de2015-06-02 08:39:48 -0600389 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600391 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 return ret;
393}
394
395static inline int __filemap_fdatawrite(struct address_space *mapping,
396 int sync_mode)
397{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700398 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399}
400
401int filemap_fdatawrite(struct address_space *mapping)
402{
403 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
404}
405EXPORT_SYMBOL(filemap_fdatawrite);
406
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400407int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800408 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
410 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
411}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400412EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Randy Dunlap485bb992006-06-23 02:03:49 -0700414/**
415 * filemap_flush - mostly a non-blocking flush
416 * @mapping: target address_space
417 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 * This is a mostly non-blocking flush. Not suitable for data-integrity
419 * purposes - I/O may not be started against all dirty pages.
420 */
421int filemap_flush(struct address_space *mapping)
422{
423 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
424}
425EXPORT_SYMBOL(filemap_flush);
426
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800427static int __filemap_fdatawait_range(struct address_space *mapping,
428 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300430 pgoff_t index = start_byte >> PAGE_SHIFT;
431 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 struct pagevec pvec;
433 int nr_pages;
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800434 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200436 if (end_byte < start_byte)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700437 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
439 pagevec_init(&pvec, 0);
Jan Kara7e95dd52017-11-15 17:35:05 -0800440 while (index <= end) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 unsigned i;
442
Jan Kara7e95dd52017-11-15 17:35:05 -0800443 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
Jan Kara4d93a432017-11-15 17:35:19 -0800444 end, PAGECACHE_TAG_WRITEBACK);
Jan Kara7e95dd52017-11-15 17:35:05 -0800445 if (!nr_pages)
446 break;
447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 for (i = 0; i < nr_pages; i++) {
449 struct page *page = pvec.pages[i];
450
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 wait_on_page_writeback(page);
Rik van Riel212260a2011-01-13 15:46:06 -0800452 if (TestClearPageError(page))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453 ret = -EIO;
454 }
455 pagevec_release(&pvec);
456 cond_resched();
457 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700458out:
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800459 return ret;
460}
461
462/**
463 * filemap_fdatawait_range - wait for writeback to complete
464 * @mapping: address space structure to wait for
465 * @start_byte: offset in bytes where the range starts
466 * @end_byte: offset in bytes where the range ends (inclusive)
467 *
468 * Walk the list of under-writeback pages of the given address space
469 * in the given range and wait for all of them. Check error status of
470 * the address space and return it.
471 *
472 * Since the error status of the address space is cleared by this function,
473 * callers are responsible for checking the return value and handling and/or
474 * reporting the error.
475 */
476int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
477 loff_t end_byte)
478{
479 int ret, ret2;
480
481 ret = __filemap_fdatawait_range(mapping, start_byte, end_byte);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700482 ret2 = filemap_check_errors(mapping);
483 if (!ret)
484 ret = ret2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486 return ret;
487}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200488EXPORT_SYMBOL(filemap_fdatawait_range);
489
490/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800491 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
492 * @mapping: address space structure to wait for
493 *
494 * Walk the list of under-writeback pages of the given address space
495 * and wait for all of them. Unlike filemap_fdatawait(), this function
496 * does not clear error status of the address space.
497 *
498 * Use this function if callers don't handle errors themselves. Expected
499 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
500 * fsfreeze(8)
501 */
502void filemap_fdatawait_keep_errors(struct address_space *mapping)
503{
504 loff_t i_size = i_size_read(mapping->host);
505
506 if (i_size == 0)
507 return;
508
509 __filemap_fdatawait_range(mapping, 0, i_size - 1);
510}
511
512/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700513 * filemap_fdatawait - wait for all under-writeback pages to complete
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 * @mapping: address space structure to wait for
Randy Dunlap485bb992006-06-23 02:03:49 -0700515 *
516 * Walk the list of under-writeback pages of the given address space
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800517 * and wait for all of them. Check error status of the address space
518 * and return it.
519 *
520 * Since the error status of the address space is cleared by this function,
521 * callers are responsible for checking the return value and handling and/or
522 * reporting the error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 */
524int filemap_fdatawait(struct address_space *mapping)
525{
526 loff_t i_size = i_size_read(mapping->host);
527
528 if (i_size == 0)
529 return 0;
530
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200531 return filemap_fdatawait_range(mapping, 0, i_size - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
533EXPORT_SYMBOL(filemap_fdatawait);
534
535int filemap_write_and_wait(struct address_space *mapping)
536{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800537 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Ross Zwisler7f6d5b52016-02-26 15:19:55 -0800539 if ((!dax_mapping(mapping) && mapping->nrpages) ||
540 (dax_mapping(mapping) && mapping->nrexceptional)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800541 err = filemap_fdatawrite(mapping);
542 /*
543 * Even if the above returned error, the pages may be
544 * written partially (e.g. -ENOSPC), so we wait for it.
545 * But the -EIO is special case, it may indicate the worst
546 * thing (e.g. bug) happened, so we avoid waiting for it.
547 */
548 if (err != -EIO) {
549 int err2 = filemap_fdatawait(mapping);
550 if (!err)
551 err = err2;
552 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700553 } else {
554 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800556 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557}
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800558EXPORT_SYMBOL(filemap_write_and_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Randy Dunlap485bb992006-06-23 02:03:49 -0700560/**
561 * filemap_write_and_wait_range - write out & wait on a file range
562 * @mapping: the address_space for the pages
563 * @lstart: offset in bytes where the range starts
564 * @lend: offset in bytes where the range ends (inclusive)
565 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800566 * Write out and wait upon file offsets lstart->lend, inclusive.
567 *
568 * Note that `lend' is inclusive (describes the last byte to be written) so
569 * that this function can be used to write to the very end-of-file (end = -1).
570 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571int filemap_write_and_wait_range(struct address_space *mapping,
572 loff_t lstart, loff_t lend)
573{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800574 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Ross Zwisler7f6d5b52016-02-26 15:19:55 -0800576 if ((!dax_mapping(mapping) && mapping->nrpages) ||
577 (dax_mapping(mapping) && mapping->nrexceptional)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800578 err = __filemap_fdatawrite_range(mapping, lstart, lend,
579 WB_SYNC_ALL);
580 /* See comment of filemap_write_and_wait() */
581 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200582 int err2 = filemap_fdatawait_range(mapping,
583 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800584 if (!err)
585 err = err2;
586 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700587 } else {
588 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800590 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591}
Chris Masonf6995582009-04-15 13:22:37 -0400592EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Randy Dunlap485bb992006-06-23 02:03:49 -0700594/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700595 * replace_page_cache_page - replace a pagecache page with a new one
596 * @old: page to be replaced
597 * @new: page to replace with
598 * @gfp_mask: allocation mode
599 *
600 * This function replaces a page in the pagecache with a new one. On
601 * success it acquires the pagecache reference for the new page and
602 * drops it for the old page. Both the old and new pages must be
603 * locked. This function does not add the new page to the LRU, the
604 * caller must do that.
605 *
606 * The remove + add is atomic. The only way this function can fail is
607 * memory allocation failure.
608 */
609int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
610{
611 int error;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700612
Sasha Levin309381fea2014-01-23 15:52:54 -0800613 VM_BUG_ON_PAGE(!PageLocked(old), old);
614 VM_BUG_ON_PAGE(!PageLocked(new), new);
615 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700616
Matthew Wilcoxf4c86fa2018-04-20 14:56:20 -0700617 error = radix_tree_preload(gfp_mask & GFP_RECLAIM_MASK);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700618 if (!error) {
619 struct address_space *mapping = old->mapping;
620 void (*freepage)(struct page *);
Greg Thelenc4843a72015-05-22 17:13:16 -0400621 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700622
623 pgoff_t offset = old->index;
624 freepage = mapping->a_ops->freepage;
625
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300626 get_page(new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700627 new->mapping = mapping;
628 new->index = offset;
629
Greg Thelenc4843a72015-05-22 17:13:16 -0400630 spin_lock_irqsave(&mapping->tree_lock, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700631 __delete_from_page_cache(old, NULL);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700632 error = page_cache_tree_insert(mapping, new, NULL);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700633 BUG_ON(error);
Michal Hocko4165b9b2015-06-24 16:57:24 -0700634
635 /*
636 * hugetlb pages do not participate in page cache accounting.
637 */
638 if (!PageHuge(new))
Mel Gorman11fb9982016-07-28 15:46:20 -0700639 __inc_node_page_state(new, NR_FILE_PAGES);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700640 if (PageSwapBacked(new))
Mel Gorman11fb9982016-07-28 15:46:20 -0700641 __inc_node_page_state(new, NR_SHMEM);
Greg Thelenc4843a72015-05-22 17:13:16 -0400642 spin_unlock_irqrestore(&mapping->tree_lock, flags);
Johannes Weiner6a93ca82016-03-15 14:57:19 -0700643 mem_cgroup_migrate(old, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700644 radix_tree_preload_end();
645 if (freepage)
646 freepage(old);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300647 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700648 }
649
650 return error;
651}
652EXPORT_SYMBOL_GPL(replace_page_cache_page);
653
Johannes Weinera5289102014-04-03 14:47:51 -0700654static int __add_to_page_cache_locked(struct page *page,
655 struct address_space *mapping,
656 pgoff_t offset, gfp_t gfp_mask,
657 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658{
Johannes Weiner00501b52014-08-08 14:19:20 -0700659 int huge = PageHuge(page);
660 struct mem_cgroup *memcg;
Nick Piggine2867812008-07-25 19:45:30 -0700661 int error;
662
Sasha Levin309381fea2014-01-23 15:52:54 -0800663 VM_BUG_ON_PAGE(!PageLocked(page), page);
664 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Nick Piggine2867812008-07-25 19:45:30 -0700665
Johannes Weiner00501b52014-08-08 14:19:20 -0700666 if (!huge) {
667 error = mem_cgroup_try_charge(page, current->mm,
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800668 gfp_mask, &memcg, false);
Johannes Weiner00501b52014-08-08 14:19:20 -0700669 if (error)
670 return error;
671 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
Matthew Wilcoxf4c86fa2018-04-20 14:56:20 -0700673 error = radix_tree_maybe_preload(gfp_mask & GFP_RECLAIM_MASK);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700674 if (error) {
Johannes Weiner00501b52014-08-08 14:19:20 -0700675 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800676 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700677 return error;
678 }
679
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300680 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700681 page->mapping = mapping;
682 page->index = offset;
683
684 spin_lock_irq(&mapping->tree_lock);
Johannes Weinera5289102014-04-03 14:47:51 -0700685 error = page_cache_tree_insert(mapping, page, shadowp);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700686 radix_tree_preload_end();
687 if (unlikely(error))
688 goto err_insert;
Michal Hocko4165b9b2015-06-24 16:57:24 -0700689
690 /* hugetlb pages do not participate in page cache accounting. */
691 if (!huge)
Mel Gorman11fb9982016-07-28 15:46:20 -0700692 __inc_node_page_state(page, NR_FILE_PAGES);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700693 spin_unlock_irq(&mapping->tree_lock);
Johannes Weiner00501b52014-08-08 14:19:20 -0700694 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800695 mem_cgroup_commit_charge(page, memcg, false, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700696 trace_mm_filemap_add_to_page_cache(page);
697 return 0;
698err_insert:
699 page->mapping = NULL;
700 /* Leave page->index set: truncation relies upon it */
701 spin_unlock_irq(&mapping->tree_lock);
Johannes Weiner00501b52014-08-08 14:19:20 -0700702 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800703 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300704 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 return error;
706}
Johannes Weinera5289102014-04-03 14:47:51 -0700707
708/**
709 * add_to_page_cache_locked - add a locked page to the pagecache
710 * @page: page to add
711 * @mapping: the page's address_space
712 * @offset: page index
713 * @gfp_mask: page allocation mode
714 *
715 * This function is used to add a page to the pagecache. It must be locked.
716 * This function does not add the page to the LRU. The caller must do that.
717 */
718int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
719 pgoff_t offset, gfp_t gfp_mask)
720{
721 return __add_to_page_cache_locked(page, mapping, offset,
722 gfp_mask, NULL);
723}
Nick Piggine2867812008-07-25 19:45:30 -0700724EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725
726int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400727 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728{
Johannes Weinera5289102014-04-03 14:47:51 -0700729 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700730 int ret;
731
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800732 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700733 ret = __add_to_page_cache_locked(page, mapping, offset,
734 gfp_mask, &shadow);
735 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800736 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700737 else {
738 /*
739 * The page might have been evicted from cache only
740 * recently, in which case it should be activated like
741 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700742 * The exception is pages getting rewritten; evicting other
743 * data from the working set, only to cache data that will
744 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700745 */
Rik van Rielf0281a02016-05-20 16:56:25 -0700746 if (!(gfp_mask & __GFP_WRITE) &&
747 shadow && workingset_refault(shadow)) {
Johannes Weinera5289102014-04-03 14:47:51 -0700748 SetPageActive(page);
749 workingset_activation(page);
750 } else
751 ClearPageActive(page);
752 lru_cache_add(page);
753 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 return ret;
755}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300756EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757
Paul Jackson44110fe2006-03-24 03:16:04 -0800758#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700759struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800760{
Miao Xiec0ff7452010-05-24 14:32:08 -0700761 int n;
762 struct page *page;
763
Paul Jackson44110fe2006-03-24 03:16:04 -0800764 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700765 unsigned int cpuset_mems_cookie;
766 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700767 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700768 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700769 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700770 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700771
Miao Xiec0ff7452010-05-24 14:32:08 -0700772 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800773 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700774 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800775}
Nick Piggin2ae88142006-10-28 10:38:23 -0700776EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800777#endif
778
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779/*
780 * In order to wait for pages to become available there must be
781 * waitqueues associated with pages. By using a hash table of
782 * waitqueues where the bucket discipline is to maintain all
783 * waiters on the same queue and wake all when any of the pages
784 * become available, and for the woken contexts to check to be
785 * sure the appropriate page became available, this saves space
786 * at a cost of "thundering herd" phenomena during rare hash
787 * collisions.
788 */
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000789#define PAGE_WAIT_TABLE_BITS 8
790#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
791static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
792
793static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000795 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796}
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000797
798void __init pagecache_init(void)
799{
800 int i;
801
802 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
803 init_waitqueue_head(&page_wait_table[i]);
804
805 page_writeback_init();
806}
807
808struct wait_page_key {
809 struct page *page;
810 int bit_nr;
811 int page_match;
812};
813
814struct wait_page_queue {
815 struct page *page;
816 int bit_nr;
817 wait_queue_t wait;
818};
819
820static int wake_page_function(wait_queue_t *wait, unsigned mode, int sync, void *arg)
821{
822 struct wait_page_key *key = arg;
823 struct wait_page_queue *wait_page
824 = container_of(wait, struct wait_page_queue, wait);
825
826 if (wait_page->page != key->page)
827 return 0;
828 key->page_match = 1;
829
830 if (wait_page->bit_nr != key->bit_nr)
831 return 0;
832 if (test_bit(key->bit_nr, &key->page->flags))
833 return 0;
834
835 return autoremove_wake_function(wait, mode, sync, key);
836}
837
838void wake_up_page_bit(struct page *page, int bit_nr)
839{
840 wait_queue_head_t *q = page_waitqueue(page);
841 struct wait_page_key key;
842 unsigned long flags;
843
844 key.page = page;
845 key.bit_nr = bit_nr;
846 key.page_match = 0;
847
848 spin_lock_irqsave(&q->lock, flags);
849 __wake_up_locked_key(q, TASK_NORMAL, &key);
850 /*
851 * It is possible for other pages to have collided on the waitqueue
852 * hash, so in that case check for a page match. That prevents a long-
853 * term waiter
854 *
855 * It is still possible to miss a case here, when we woke page waiters
856 * and removed them from the waitqueue, but there are still other
857 * page waiters.
858 */
859 if (!waitqueue_active(q) || !key.page_match) {
860 ClearPageWaiters(page);
861 /*
862 * It's possible to miss clearing Waiters here, when we woke
863 * our page waiters, but the hashed waitqueue has waiters for
864 * other pages on it.
865 *
866 * That's okay, it's a rare case. The next waker will clear it.
867 */
868 }
869 spin_unlock_irqrestore(&q->lock, flags);
870}
871EXPORT_SYMBOL(wake_up_page_bit);
872
873static inline int wait_on_page_bit_common(wait_queue_head_t *q,
874 struct page *page, int bit_nr, int state, bool lock)
875{
876 struct wait_page_queue wait_page;
877 wait_queue_t *wait = &wait_page.wait;
878 int ret = 0;
879
880 init_wait(wait);
881 wait->func = wake_page_function;
882 wait_page.page = page;
883 wait_page.bit_nr = bit_nr;
884
885 for (;;) {
886 spin_lock_irq(&q->lock);
887
888 if (likely(list_empty(&wait->task_list))) {
889 if (lock)
890 __add_wait_queue_tail_exclusive(q, wait);
891 else
892 __add_wait_queue(q, wait);
893 SetPageWaiters(page);
894 }
895
896 set_current_state(state);
897
898 spin_unlock_irq(&q->lock);
899
900 if (likely(test_bit(bit_nr, &page->flags))) {
901 io_schedule();
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000902 }
903
904 if (lock) {
905 if (!test_and_set_bit_lock(bit_nr, &page->flags))
906 break;
907 } else {
908 if (!test_bit(bit_nr, &page->flags))
909 break;
910 }
Linus Torvalds7394f692017-08-27 16:25:09 -0700911
912 if (unlikely(signal_pending_state(state, current))) {
913 ret = -EINTR;
914 break;
915 }
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000916 }
917
918 finish_wait(q, wait);
919
920 /*
921 * A signal could leave PageWaiters set. Clearing it here if
922 * !waitqueue_active would be possible (by open-coding finish_wait),
923 * but still fail to catch it in the case of wait hash collision. We
924 * already can fail to clear wait hash collision cases, so don't
925 * bother with signals either.
926 */
927
928 return ret;
929}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930
Harvey Harrison920c7a52008-02-04 22:29:26 -0800931void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932{
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000933 wait_queue_head_t *q = page_waitqueue(page);
934 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935}
936EXPORT_SYMBOL(wait_on_page_bit);
937
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700938int wait_on_page_bit_killable(struct page *page, int bit_nr)
939{
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000940 wait_queue_head_t *q = page_waitqueue(page);
941 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, false);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700942}
943
Linus Torvalds1da177e2005-04-16 15:20:36 -0700944/**
David Howells385e1ca5f2009-04-03 16:42:39 +0100945 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -0700946 * @page: Page defining the wait queue of interest
947 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +0100948 *
949 * Add an arbitrary @waiter to the wait queue for the nominated @page.
950 */
951void add_page_wait_queue(struct page *page, wait_queue_t *waiter)
952{
953 wait_queue_head_t *q = page_waitqueue(page);
954 unsigned long flags;
955
956 spin_lock_irqsave(&q->lock, flags);
957 __add_wait_queue(q, waiter);
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000958 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +0100959 spin_unlock_irqrestore(&q->lock, flags);
960}
961EXPORT_SYMBOL_GPL(add_page_wait_queue);
962
963/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700964 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965 * @page: the page
966 *
967 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
968 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +0900969 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
971 *
Nick Piggin8413ac92008-10-18 20:26:59 -0700972 * The mb is necessary to enforce ordering between the clear_bit and the read
973 * of the waitqueue (to avoid SMP races with a parallel wait_on_page_locked()).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 */
Harvey Harrison920c7a52008-02-04 22:29:26 -0800975void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976{
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800977 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -0800978 VM_BUG_ON_PAGE(!PageLocked(page), page);
Nick Piggin8413ac92008-10-18 20:26:59 -0700979 clear_bit_unlock(PG_locked, &page->flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100980 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981 wake_up_page(page, PG_locked);
982}
983EXPORT_SYMBOL(unlock_page);
984
Randy Dunlap485bb992006-06-23 02:03:49 -0700985/**
986 * end_page_writeback - end writeback against a page
987 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 */
989void end_page_writeback(struct page *page)
990{
Mel Gorman888cf2d2014-06-04 16:10:34 -0700991 /*
992 * TestClearPageReclaim could be used here but it is an atomic
993 * operation and overkill in this particular case. Failing to
994 * shuffle a page marked for immediate reclaim is too mild to
995 * justify taking an atomic operation penalty at the end of
996 * ever page writeback.
997 */
998 if (PageReclaim(page)) {
999 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001000 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -07001001 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -07001002
1003 if (!test_clear_page_writeback(page))
1004 BUG();
1005
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001006 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 wake_up_page(page, PG_writeback);
1008}
1009EXPORT_SYMBOL(end_page_writeback);
1010
Matthew Wilcox57d99842014-06-04 16:07:45 -07001011/*
1012 * After completing I/O on a page, call this routine to update the page
1013 * flags appropriately
1014 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001015void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001016{
Jens Axboec11f0c02016-08-05 08:11:04 -06001017 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001018 if (!err) {
1019 SetPageUptodate(page);
1020 } else {
1021 ClearPageUptodate(page);
1022 SetPageError(page);
1023 }
1024 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001025 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001026 if (err) {
Minchan Kim2c290ee2017-02-24 14:59:59 -08001027 struct address_space *mapping;
1028
Matthew Wilcox57d99842014-06-04 16:07:45 -07001029 SetPageError(page);
Minchan Kim2c290ee2017-02-24 14:59:59 -08001030 mapping = page_mapping(page);
1031 if (mapping)
1032 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001033 }
1034 end_page_writeback(page);
1035 }
1036}
1037EXPORT_SYMBOL_GPL(page_endio);
1038
Randy Dunlap485bb992006-06-23 02:03:49 -07001039/**
1040 * __lock_page - get a lock on the page, assuming we need to sleep to get it
1041 * @page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 */
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001043void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044{
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001045 struct page *page = compound_head(__page);
1046 wait_queue_head_t *q = page_waitqueue(page);
1047 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048}
1049EXPORT_SYMBOL(__lock_page);
1050
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001051int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001052{
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001053 struct page *page = compound_head(__page);
1054 wait_queue_head_t *q = page_waitqueue(page);
1055 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE, true);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001056}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001057EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001058
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001059/*
1060 * Return values:
1061 * 1 - page is locked; mmap_sem is still held.
1062 * 0 - page is not locked.
1063 * mmap_sem has been released (up_read()), unless flags had both
1064 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1065 * which case mmap_sem is still held.
1066 *
1067 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1068 * with the page locked and the mmap_sem unperturbed.
1069 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001070int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1071 unsigned int flags)
1072{
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001073 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1074 /*
1075 * CAUTION! In this case, mmap_sem is not released
1076 * even though return 0.
1077 */
1078 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1079 return 0;
1080
1081 up_read(&mm->mmap_sem);
1082 if (flags & FAULT_FLAG_KILLABLE)
1083 wait_on_page_locked_killable(page);
1084 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001085 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001086 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001087 } else {
1088 if (flags & FAULT_FLAG_KILLABLE) {
1089 int ret;
1090
1091 ret = __lock_page_killable(page);
1092 if (ret) {
1093 up_read(&mm->mmap_sem);
1094 return 0;
1095 }
1096 } else
1097 __lock_page(page);
1098 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001099 }
1100}
1101
Randy Dunlap485bb992006-06-23 02:03:49 -07001102/**
Johannes Weinere7b563b2014-04-03 14:47:44 -07001103 * page_cache_next_hole - find the next hole (not-present entry)
1104 * @mapping: mapping
1105 * @index: index
1106 * @max_scan: maximum range to search
1107 *
1108 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the
1109 * lowest indexed hole.
1110 *
1111 * Returns: the index of the hole if found, otherwise returns an index
1112 * outside of the set specified (in which case 'return - index >=
1113 * max_scan' will be true). In rare cases of index wrap-around, 0 will
1114 * be returned.
1115 *
1116 * page_cache_next_hole may be called under rcu_read_lock. However,
1117 * like radix_tree_gang_lookup, this will not atomically search a
1118 * snapshot of the tree at a single point in time. For example, if a
1119 * hole is created at index 5, then subsequently a hole is created at
1120 * index 10, page_cache_next_hole covering both indexes may return 10
1121 * if called under rcu_read_lock.
1122 */
1123pgoff_t page_cache_next_hole(struct address_space *mapping,
1124 pgoff_t index, unsigned long max_scan)
1125{
1126 unsigned long i;
1127
1128 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001129 struct page *page;
1130
1131 page = radix_tree_lookup(&mapping->page_tree, index);
1132 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001133 break;
1134 index++;
1135 if (index == 0)
1136 break;
1137 }
1138
1139 return index;
1140}
1141EXPORT_SYMBOL(page_cache_next_hole);
1142
1143/**
1144 * page_cache_prev_hole - find the prev hole (not-present entry)
1145 * @mapping: mapping
1146 * @index: index
1147 * @max_scan: maximum range to search
1148 *
1149 * Search backwards in the range [max(index-max_scan+1, 0), index] for
1150 * the first hole.
1151 *
1152 * Returns: the index of the hole if found, otherwise returns an index
1153 * outside of the set specified (in which case 'index - return >=
1154 * max_scan' will be true). In rare cases of wrap-around, ULONG_MAX
1155 * will be returned.
1156 *
1157 * page_cache_prev_hole may be called under rcu_read_lock. However,
1158 * like radix_tree_gang_lookup, this will not atomically search a
1159 * snapshot of the tree at a single point in time. For example, if a
1160 * hole is created at index 10, then subsequently a hole is created at
1161 * index 5, page_cache_prev_hole covering both indexes may return 5 if
1162 * called under rcu_read_lock.
1163 */
1164pgoff_t page_cache_prev_hole(struct address_space *mapping,
1165 pgoff_t index, unsigned long max_scan)
1166{
1167 unsigned long i;
1168
1169 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001170 struct page *page;
1171
1172 page = radix_tree_lookup(&mapping->page_tree, index);
1173 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001174 break;
1175 index--;
1176 if (index == ULONG_MAX)
1177 break;
1178 }
1179
1180 return index;
1181}
1182EXPORT_SYMBOL(page_cache_prev_hole);
1183
1184/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001185 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001186 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001187 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001188 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001189 * Looks up the page cache slot at @mapping & @offset. If there is a
1190 * page cache page, it is returned with an increased refcount.
1191 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001192 * If the slot holds a shadow entry of a previously evicted page, or a
1193 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001194 *
1195 * Otherwise, %NULL is returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001197struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198{
Nick Piggina60637c2008-07-25 19:45:31 -07001199 void **pagep;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001200 struct page *head, *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Nick Piggina60637c2008-07-25 19:45:31 -07001202 rcu_read_lock();
1203repeat:
1204 page = NULL;
1205 pagep = radix_tree_lookup_slot(&mapping->page_tree, offset);
1206 if (pagep) {
1207 page = radix_tree_deref_slot(pagep);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001208 if (unlikely(!page))
1209 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001210 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001211 if (radix_tree_deref_retry(page))
1212 goto repeat;
1213 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001214 * A shadow entry of a recently evicted page,
1215 * or a swap entry from shmem/tmpfs. Return
1216 * it without attempting to raise page count.
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001217 */
1218 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001219 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001220
1221 head = compound_head(page);
1222 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001223 goto repeat;
1224
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001225 /* The page was split under us? */
1226 if (compound_head(page) != head) {
1227 put_page(head);
1228 goto repeat;
1229 }
1230
Nick Piggina60637c2008-07-25 19:45:31 -07001231 /*
1232 * Has the page moved?
1233 * This is part of the lockless pagecache protocol. See
1234 * include/linux/pagemap.h for details.
1235 */
1236 if (unlikely(page != *pagep)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001237 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001238 goto repeat;
1239 }
1240 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001241out:
Nick Piggina60637c2008-07-25 19:45:31 -07001242 rcu_read_unlock();
1243
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 return page;
1245}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001246EXPORT_SYMBOL(find_get_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247
Randy Dunlap485bb992006-06-23 02:03:49 -07001248/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001249 * find_lock_entry - locate, pin and lock a page cache entry
1250 * @mapping: the address_space to search
1251 * @offset: the page cache index
1252 *
1253 * Looks up the page cache slot at @mapping & @offset. If there is a
1254 * page cache page, it is returned locked and with an increased
1255 * refcount.
1256 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001257 * If the slot holds a shadow entry of a previously evicted page, or a
1258 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001259 *
1260 * Otherwise, %NULL is returned.
1261 *
1262 * find_lock_entry() may sleep.
1263 */
1264struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265{
1266 struct page *page;
1267
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001269 page = find_get_entry(mapping, offset);
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001270 if (page && !radix_tree_exception(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001271 lock_page(page);
1272 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001273 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001274 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001275 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001276 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001278 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 return page;
1281}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001282EXPORT_SYMBOL(find_lock_entry);
1283
1284/**
Mel Gorman2457aec2014-06-04 16:10:31 -07001285 * pagecache_get_page - find and get a page reference
Johannes Weiner0cd61442014-04-03 14:47:46 -07001286 * @mapping: the address_space to search
1287 * @offset: the page index
Mel Gorman2457aec2014-06-04 16:10:31 -07001288 * @fgp_flags: PCG flags
Michal Hocko45f87de2014-12-29 20:30:35 +01001289 * @gfp_mask: gfp mask to use for the page cache data page allocation
Johannes Weiner0cd61442014-04-03 14:47:46 -07001290 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001291 * Looks up the page cache slot at @mapping & @offset.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001292 *
Randy Dunlap75325182014-07-30 16:08:37 -07001293 * PCG flags modify how the page is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001294 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001295 * FGP_ACCESSED: the page will be marked accessed
1296 * FGP_LOCK: Page is return locked
1297 * FGP_CREAT: If page is not present then a new page is allocated using
Michal Hocko45f87de2014-12-29 20:30:35 +01001298 * @gfp_mask and added to the page cache and the VM's LRU
1299 * list. The page is returned locked and with an increased
1300 * refcount. Otherwise, %NULL is returned.
Mel Gorman2457aec2014-06-04 16:10:31 -07001301 *
1302 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1303 * if the GFP flags specified for FGP_CREAT are atomic.
1304 *
1305 * If there is a page cache page, it is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001306 */
Mel Gorman2457aec2014-06-04 16:10:31 -07001307struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
Michal Hocko45f87de2014-12-29 20:30:35 +01001308 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309{
Nick Piggineb2be182007-10-16 01:24:57 -07001310 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001311
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312repeat:
Mel Gorman2457aec2014-06-04 16:10:31 -07001313 page = find_get_entry(mapping, offset);
1314 if (radix_tree_exceptional_entry(page))
1315 page = NULL;
1316 if (!page)
1317 goto no_page;
1318
1319 if (fgp_flags & FGP_LOCK) {
1320 if (fgp_flags & FGP_NOWAIT) {
1321 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001322 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001323 return NULL;
1324 }
1325 } else {
1326 lock_page(page);
1327 }
1328
1329 /* Has the page been truncated? */
1330 if (unlikely(page->mapping != mapping)) {
1331 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001332 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001333 goto repeat;
1334 }
1335 VM_BUG_ON_PAGE(page->index != offset, page);
1336 }
1337
1338 if (page && (fgp_flags & FGP_ACCESSED))
1339 mark_page_accessed(page);
1340
1341no_page:
1342 if (!page && (fgp_flags & FGP_CREAT)) {
1343 int err;
1344 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001345 gfp_mask |= __GFP_WRITE;
1346 if (fgp_flags & FGP_NOFS)
1347 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001348
Michal Hocko45f87de2014-12-29 20:30:35 +01001349 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001350 if (!page)
1351 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001352
1353 if (WARN_ON_ONCE(!(fgp_flags & FGP_LOCK)))
1354 fgp_flags |= FGP_LOCK;
1355
Hugh Dickinseb39d612014-08-06 16:06:43 -07001356 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001357 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001358 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001359
Matthew Wilcoxf4c86fa2018-04-20 14:56:20 -07001360 err = add_to_page_cache_lru(page, mapping, offset, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001361 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001362 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001363 page = NULL;
1364 if (err == -EEXIST)
1365 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001368
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 return page;
1370}
Mel Gorman2457aec2014-06-04 16:10:31 -07001371EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372
1373/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001374 * find_get_entries - gang pagecache lookup
1375 * @mapping: The address_space to search
1376 * @start: The starting page cache index
1377 * @nr_entries: The maximum number of entries
1378 * @entries: Where the resulting entries are placed
1379 * @indices: The cache indices corresponding to the entries in @entries
1380 *
1381 * find_get_entries() will search for and return a group of up to
1382 * @nr_entries entries in the mapping. The entries are placed at
1383 * @entries. find_get_entries() takes a reference against any actual
1384 * pages it returns.
1385 *
1386 * The search returns a group of mapping-contiguous page cache entries
1387 * with ascending indexes. There may be holes in the indices due to
1388 * not-present pages.
1389 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001390 * Any shadow entries of evicted pages, or swap entries from
1391 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001392 *
1393 * find_get_entries() returns the number of pages and shadow entries
1394 * which were found.
1395 */
1396unsigned find_get_entries(struct address_space *mapping,
1397 pgoff_t start, unsigned int nr_entries,
1398 struct page **entries, pgoff_t *indices)
1399{
1400 void **slot;
1401 unsigned int ret = 0;
1402 struct radix_tree_iter iter;
1403
1404 if (!nr_entries)
1405 return 0;
1406
1407 rcu_read_lock();
Johannes Weiner0cd61442014-04-03 14:47:46 -07001408 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001409 struct page *head, *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001410repeat:
1411 page = radix_tree_deref_slot(slot);
1412 if (unlikely(!page))
1413 continue;
1414 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001415 if (radix_tree_deref_retry(page)) {
1416 slot = radix_tree_iter_retry(&iter);
1417 continue;
1418 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001419 /*
Ross Zwislerf9fe48b2016-01-22 15:10:40 -08001420 * A shadow entry of a recently evicted page, a swap
1421 * entry from shmem/tmpfs or a DAX entry. Return it
1422 * without attempting to raise page count.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001423 */
1424 goto export;
1425 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001426
1427 head = compound_head(page);
1428 if (!page_cache_get_speculative(head))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001429 goto repeat;
1430
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001431 /* The page was split under us? */
1432 if (compound_head(page) != head) {
1433 put_page(head);
1434 goto repeat;
1435 }
1436
Johannes Weiner0cd61442014-04-03 14:47:46 -07001437 /* Has the page moved? */
1438 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001439 put_page(head);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001440 goto repeat;
1441 }
1442export:
1443 indices[ret] = iter.index;
1444 entries[ret] = page;
1445 if (++ret == nr_entries)
1446 break;
1447 }
1448 rcu_read_unlock();
1449 return ret;
1450}
1451
1452/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 * find_get_pages - gang pagecache lookup
1454 * @mapping: The address_space to search
1455 * @start: The starting page index
1456 * @nr_pages: The maximum number of pages
1457 * @pages: Where the resulting pages are placed
1458 *
1459 * find_get_pages() will search for and return a group of up to
1460 * @nr_pages pages in the mapping. The pages are placed at @pages.
1461 * find_get_pages() takes a reference against the returned pages.
1462 *
1463 * The search returns a group of mapping-contiguous pages with ascending
1464 * indexes. There may be holes in the indices due to not-present pages.
1465 *
1466 * find_get_pages() returns the number of pages which were found.
1467 */
1468unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
1469 unsigned int nr_pages, struct page **pages)
1470{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001471 struct radix_tree_iter iter;
1472 void **slot;
1473 unsigned ret = 0;
1474
1475 if (unlikely(!nr_pages))
1476 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477
Nick Piggina60637c2008-07-25 19:45:31 -07001478 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001479 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001480 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001481repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001482 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001483 if (unlikely(!page))
1484 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001485
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001486 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001487 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001488 slot = radix_tree_iter_retry(&iter);
1489 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001490 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001491 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001492 * A shadow entry of a recently evicted page,
1493 * or a swap entry from shmem/tmpfs. Skip
1494 * over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001495 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001496 continue;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001497 }
Nick Piggina60637c2008-07-25 19:45:31 -07001498
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001499 head = compound_head(page);
1500 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001501 goto repeat;
1502
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001503 /* The page was split under us? */
1504 if (compound_head(page) != head) {
1505 put_page(head);
1506 goto repeat;
1507 }
1508
Nick Piggina60637c2008-07-25 19:45:31 -07001509 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001510 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001511 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001512 goto repeat;
1513 }
1514
1515 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001516 if (++ret == nr_pages)
1517 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001518 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001519
Nick Piggina60637c2008-07-25 19:45:31 -07001520 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521 return ret;
1522}
1523
Jens Axboeebf43502006-04-27 08:46:01 +02001524/**
1525 * find_get_pages_contig - gang contiguous pagecache lookup
1526 * @mapping: The address_space to search
1527 * @index: The starting page index
1528 * @nr_pages: The maximum number of pages
1529 * @pages: Where the resulting pages are placed
1530 *
1531 * find_get_pages_contig() works exactly like find_get_pages(), except
1532 * that the returned number of pages are guaranteed to be contiguous.
1533 *
1534 * find_get_pages_contig() returns the number of pages which were found.
1535 */
1536unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1537 unsigned int nr_pages, struct page **pages)
1538{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001539 struct radix_tree_iter iter;
1540 void **slot;
1541 unsigned int ret = 0;
1542
1543 if (unlikely(!nr_pages))
1544 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001545
Nick Piggina60637c2008-07-25 19:45:31 -07001546 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001547 radix_tree_for_each_contig(slot, &mapping->page_tree, &iter, index) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001548 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001549repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001550 page = radix_tree_deref_slot(slot);
1551 /* The hole, there no reason to continue */
Nick Piggina60637c2008-07-25 19:45:31 -07001552 if (unlikely(!page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001553 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001554
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001555 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001556 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001557 slot = radix_tree_iter_retry(&iter);
1558 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001559 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001560 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001561 * A shadow entry of a recently evicted page,
1562 * or a swap entry from shmem/tmpfs. Stop
1563 * looking for contiguous pages.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001564 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001565 break;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001566 }
Nick Piggina60637c2008-07-25 19:45:31 -07001567
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001568 head = compound_head(page);
1569 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001570 goto repeat;
1571
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001572 /* The page was split under us? */
1573 if (compound_head(page) != head) {
1574 put_page(head);
1575 goto repeat;
1576 }
1577
Nick Piggina60637c2008-07-25 19:45:31 -07001578 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001579 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001580 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001581 goto repeat;
1582 }
1583
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001584 /*
1585 * must check mapping and index after taking the ref.
1586 * otherwise we can get both false positives and false
1587 * negatives, which is just confusing to the caller.
1588 */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001589 if (page->mapping == NULL || page_to_pgoff(page) != iter.index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001590 put_page(page);
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001591 break;
1592 }
1593
Nick Piggina60637c2008-07-25 19:45:31 -07001594 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001595 if (++ret == nr_pages)
1596 break;
Jens Axboeebf43502006-04-27 08:46:01 +02001597 }
Nick Piggina60637c2008-07-25 19:45:31 -07001598 rcu_read_unlock();
1599 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001600}
David Howellsef71c152007-05-09 02:33:44 -07001601EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001602
Randy Dunlap485bb992006-06-23 02:03:49 -07001603/**
Jan Karafb296a22017-11-15 17:34:33 -08001604 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001605 * @mapping: the address_space to search
1606 * @index: the starting page index
Jan Karafb296a22017-11-15 17:34:33 -08001607 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001608 * @tag: the tag index
1609 * @nr_pages: the maximum number of pages
1610 * @pages: where the resulting pages are placed
1611 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001613 * @tag. We update @index to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001614 */
Jan Karafb296a22017-11-15 17:34:33 -08001615unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
1616 pgoff_t end, int tag, unsigned int nr_pages,
1617 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001619 struct radix_tree_iter iter;
1620 void **slot;
1621 unsigned ret = 0;
1622
1623 if (unlikely(!nr_pages))
1624 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
Nick Piggina60637c2008-07-25 19:45:31 -07001626 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001627 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1628 &iter, *index, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001629 struct page *head, *page;
Jan Karafb296a22017-11-15 17:34:33 -08001630
1631 if (iter.index > end)
1632 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001633repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001634 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001635 if (unlikely(!page))
1636 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001637
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001638 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001639 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001640 slot = radix_tree_iter_retry(&iter);
1641 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001642 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001643 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001644 * A shadow entry of a recently evicted page.
1645 *
1646 * Those entries should never be tagged, but
1647 * this tree walk is lockless and the tags are
1648 * looked up in bulk, one radix tree node at a
1649 * time, so there is a sizable window for page
1650 * reclaim to evict a page we saw tagged.
1651 *
1652 * Skip over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001653 */
Johannes Weiner139b6a62014-05-06 12:50:05 -07001654 continue;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001655 }
Nick Piggina60637c2008-07-25 19:45:31 -07001656
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001657 head = compound_head(page);
1658 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001659 goto repeat;
1660
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001661 /* The page was split under us? */
1662 if (compound_head(page) != head) {
1663 put_page(head);
1664 goto repeat;
1665 }
1666
Nick Piggina60637c2008-07-25 19:45:31 -07001667 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001668 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001669 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001670 goto repeat;
1671 }
1672
1673 pages[ret] = page;
Jan Karafb296a22017-11-15 17:34:33 -08001674 if (++ret == nr_pages) {
1675 *index = pages[ret - 1]->index + 1;
1676 goto out;
1677 }
Nick Piggina60637c2008-07-25 19:45:31 -07001678 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001679
Jan Karafb296a22017-11-15 17:34:33 -08001680 /*
1681 * We come here when we got at @end. We take care to not overflow the
1682 * index @index as it confuses some of the callers. This breaks the
1683 * iteration when there is page at index -1 but that is already broken
1684 * anyway.
1685 */
1686 if (end == (pgoff_t)-1)
1687 *index = (pgoff_t)-1;
1688 else
1689 *index = end + 1;
1690out:
Nick Piggina60637c2008-07-25 19:45:31 -07001691 rcu_read_unlock();
1692
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693 return ret;
1694}
Jan Karafb296a22017-11-15 17:34:33 -08001695EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001697/**
1698 * find_get_entries_tag - find and return entries that match @tag
1699 * @mapping: the address_space to search
1700 * @start: the starting page cache index
1701 * @tag: the tag index
1702 * @nr_entries: the maximum number of entries
1703 * @entries: where the resulting entries are placed
1704 * @indices: the cache indices corresponding to the entries in @entries
1705 *
1706 * Like find_get_entries, except we only return entries which are tagged with
1707 * @tag.
1708 */
1709unsigned find_get_entries_tag(struct address_space *mapping, pgoff_t start,
1710 int tag, unsigned int nr_entries,
1711 struct page **entries, pgoff_t *indices)
1712{
1713 void **slot;
1714 unsigned int ret = 0;
1715 struct radix_tree_iter iter;
1716
1717 if (!nr_entries)
1718 return 0;
1719
1720 rcu_read_lock();
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001721 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1722 &iter, start, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001723 struct page *head, *page;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001724repeat:
1725 page = radix_tree_deref_slot(slot);
1726 if (unlikely(!page))
1727 continue;
1728 if (radix_tree_exception(page)) {
1729 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001730 slot = radix_tree_iter_retry(&iter);
1731 continue;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001732 }
1733
1734 /*
1735 * A shadow entry of a recently evicted page, a swap
1736 * entry from shmem/tmpfs or a DAX entry. Return it
1737 * without attempting to raise page count.
1738 */
1739 goto export;
1740 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001741
1742 head = compound_head(page);
1743 if (!page_cache_get_speculative(head))
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001744 goto repeat;
1745
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001746 /* The page was split under us? */
1747 if (compound_head(page) != head) {
1748 put_page(head);
1749 goto repeat;
1750 }
1751
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001752 /* Has the page moved? */
1753 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001754 put_page(head);
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001755 goto repeat;
1756 }
1757export:
1758 indices[ret] = iter.index;
1759 entries[ret] = page;
1760 if (++ret == nr_entries)
1761 break;
1762 }
1763 rcu_read_unlock();
1764 return ret;
1765}
1766EXPORT_SYMBOL(find_get_entries_tag);
1767
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001768/*
1769 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1770 * a _large_ part of the i/o request. Imagine the worst scenario:
1771 *
1772 * ---R__________________________________________B__________
1773 * ^ reading here ^ bad block(assume 4k)
1774 *
1775 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1776 * => failing the whole request => read(R) => read(R+1) =>
1777 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1778 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1779 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1780 *
1781 * It is going insane. Fix it by quickly scaling down the readahead size.
1782 */
1783static void shrink_readahead_size_eio(struct file *filp,
1784 struct file_ra_state *ra)
1785{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001786 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001787}
1788
Randy Dunlap485bb992006-06-23 02:03:49 -07001789/**
Christoph Hellwig36e78912008-02-08 04:21:24 -08001790 * do_generic_file_read - generic file read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07001791 * @filp: the file to read
1792 * @ppos: current file position
Al Viro6e58e792014-02-03 17:07:03 -05001793 * @iter: data destination
1794 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001795 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001796 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001797 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 *
1799 * This is really ugly. But the goto's actually try to clarify some
1800 * of the logic when it comes to error handling etc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 */
Al Viro6e58e792014-02-03 17:07:03 -05001802static ssize_t do_generic_file_read(struct file *filp, loff_t *ppos,
1803 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804{
Christoph Hellwig36e78912008-02-08 04:21:24 -08001805 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001807 struct file_ra_state *ra = &filp->f_ra;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001808 pgoff_t index;
1809 pgoff_t last_index;
1810 pgoff_t prev_index;
1811 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07001812 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05001813 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814
Wei Fangc2a97372016-10-07 17:01:52 -07001815 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvalds48466c42016-12-14 12:45:25 -08001816 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07001817 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
1818
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001819 index = *ppos >> PAGE_SHIFT;
1820 prev_index = ra->prev_pos >> PAGE_SHIFT;
1821 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
1822 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
1823 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825 for (;;) {
1826 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001827 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001828 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 unsigned long nr, ret;
1830
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832find_page:
Michal Hockob67c7d32017-02-03 13:13:29 -08001833 if (fatal_signal_pending(current)) {
1834 error = -EINTR;
1835 goto out;
1836 }
1837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001839 if (!page) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001840 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001841 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001842 index, last_index - index);
1843 page = find_get_page(mapping, index);
1844 if (unlikely(page == NULL))
1845 goto no_cached_page;
1846 }
1847 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001848 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001849 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001850 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001852 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07001853 /*
1854 * See comment in do_read_cache_page on why
1855 * wait_on_page_locked is used to avoid unnecessarily
1856 * serialisations and why it's safe.
1857 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07001858 error = wait_on_page_locked_killable(page);
1859 if (unlikely(error))
1860 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07001861 if (PageUptodate(page))
1862 goto page_ok;
1863
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001864 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001865 !mapping->a_ops->is_partially_uptodate)
1866 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08001867 /* pipes can't handle partially uptodate pages */
1868 if (unlikely(iter->type & ITER_PIPE))
1869 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02001870 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001871 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08001872 /* Did it get truncated before we got the lock? */
1873 if (!page->mapping)
1874 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001875 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05001876 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001877 goto page_not_up_to_date_locked;
1878 unlock_page(page);
1879 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07001881 /*
1882 * i_size must be checked after we know the page is Uptodate.
1883 *
1884 * Checking i_size after the check allows us to calculate
1885 * the correct value for "nr", which means the zero-filled
1886 * part of the page is not copied back to userspace (unless
1887 * another truncate extends the file - this is desired though).
1888 */
1889
1890 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001891 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001892 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001893 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001894 goto out;
1895 }
1896
1897 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001898 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001899 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001900 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001901 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001902 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001903 goto out;
1904 }
1905 }
1906 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907
1908 /* If users can be writing to this page using arbitrary
1909 * virtual addresses, take care about potential aliasing
1910 * before reading the page on the kernel side.
1911 */
1912 if (mapping_writably_mapped(mapping))
1913 flush_dcache_page(page);
1914
1915 /*
Jan Karaec0f1632007-05-06 14:49:25 -07001916 * When a sequential read accesses a page several times,
1917 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001918 */
Jan Karaec0f1632007-05-06 14:49:25 -07001919 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 mark_page_accessed(page);
1921 prev_index = index;
1922
1923 /*
1924 * Ok, we have the page, and it's up-to-date, so
1925 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 */
Al Viro6e58e792014-02-03 17:07:03 -05001927
1928 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001930 index += offset >> PAGE_SHIFT;
1931 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07001932 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001934 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001935 written += ret;
1936 if (!iov_iter_count(iter))
1937 goto out;
1938 if (ret < nr) {
1939 error = -EFAULT;
1940 goto out;
1941 }
1942 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001943
1944page_not_up_to_date:
1945 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04001946 error = lock_page_killable(page);
1947 if (unlikely(error))
1948 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001950page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07001951 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 if (!page->mapping) {
1953 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001954 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 continue;
1956 }
1957
1958 /* Did somebody else fill it already? */
1959 if (PageUptodate(page)) {
1960 unlock_page(page);
1961 goto page_ok;
1962 }
1963
1964readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04001965 /*
1966 * A previous I/O error may have been due to temporary
1967 * failures, eg. multipath errors.
1968 * PG_error will be set again if readpage fails.
1969 */
1970 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 /* Start the actual read. The read will unlock the page. */
1972 error = mapping->a_ops->readpage(filp, page);
1973
Zach Brown994fc28c2005-12-15 14:28:17 -08001974 if (unlikely(error)) {
1975 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001976 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001977 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08001978 goto find_page;
1979 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08001981 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982
1983 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04001984 error = lock_page_killable(page);
1985 if (unlikely(error))
1986 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001987 if (!PageUptodate(page)) {
1988 if (page->mapping == NULL) {
1989 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01001990 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 */
1992 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001993 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 goto find_page;
1995 }
1996 unlock_page(page);
Fengguang Wu7ff81072007-10-16 01:24:35 -07001997 shrink_readahead_size_eio(filp, ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04001998 error = -EIO;
1999 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 }
2001 unlock_page(page);
2002 }
2003
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 goto page_ok;
2005
2006readpage_error:
2007 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002008 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002009 goto out;
2010
2011no_cached_page:
2012 /*
2013 * Ok, it wasn't cached, so we need to create a new
2014 * page..
2015 */
Nick Piggineb2be182007-10-16 01:24:57 -07002016 page = page_cache_alloc_cold(mapping);
2017 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002018 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002019 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002021 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002022 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002024 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002025 if (error == -EEXIST) {
2026 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002028 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029 goto out;
2030 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031 goto readpage;
2032 }
2033
2034out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002035 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002036 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002037 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002039 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002040 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002041 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002042}
2043
Randy Dunlap485bb992006-06-23 02:03:49 -07002044/**
Al Viro6abd2322014-04-04 14:20:57 -04002045 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002046 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002047 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002048 *
Al Viro6abd2322014-04-04 14:20:57 -04002049 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002050 * that can use the page cache directly.
2051 */
2052ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002053generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054{
Al Viroed978a82014-03-05 22:53:04 -05002055 struct file *file = iocb->ki_filp;
2056 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002057 size_t count = iov_iter_count(iter);
2058
2059 if (!count)
2060 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002061
Al Viro2ba48ce2015-04-09 13:52:01 -04002062 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viroed978a82014-03-05 22:53:04 -05002063 struct address_space *mapping = file->f_mapping;
2064 struct inode *inode = mapping->host;
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002065 struct iov_iter data = *iter;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002066 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 size = i_size_read(inode);
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002069 retval = filemap_write_and_wait_range(mapping, iocb->ki_pos,
2070 iocb->ki_pos + count - 1);
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002071 if (retval < 0)
2072 goto out;
Al Viroed978a82014-03-05 22:53:04 -05002073
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002074 file_accessed(file);
2075
2076 retval = mapping->a_ops->direct_IO(iocb, &data);
Al Viroc3a69022016-10-10 13:26:27 -04002077 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002078 iocb->ki_pos += retval;
Al Viroed978a82014-03-05 22:53:04 -05002079 iov_iter_advance(iter, retval);
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002080 }
Josef Bacik66f998f2010-05-23 11:00:54 -04002081
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002082 /*
2083 * Btrfs can have a short DIO read if we encounter
2084 * compressed extents, so if there was an error, or if
2085 * we've already read everything we wanted to, or if
2086 * there was a short read because we hit EOF, go ahead
2087 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002088 * the rest of the read. Buffered reads will not work for
2089 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002090 */
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002091 if (retval < 0 || !iov_iter_count(iter) || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002092 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002093 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 }
2095
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002096 retval = do_generic_file_read(file, &iocb->ki_pos, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097out:
2098 return retval;
2099}
Al Viroed978a82014-03-05 22:53:04 -05002100EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101
Linus Torvalds1da177e2005-04-16 15:20:36 -07002102#ifdef CONFIG_MMU
Randy Dunlap485bb992006-06-23 02:03:49 -07002103/**
2104 * page_cache_read - adds requested page to the page cache if not already there
2105 * @file: file to read
2106 * @offset: page index
Randy Dunlap62eb3202016-02-11 16:12:58 -08002107 * @gfp_mask: memory allocation flags
Randy Dunlap485bb992006-06-23 02:03:49 -07002108 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 * This adds the requested page to the page cache if it isn't already there,
2110 * and schedules an I/O to read in its contents from disk.
2111 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002112static int page_cache_read(struct file *file, pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113{
2114 struct address_space *mapping = file->f_mapping;
Paul McQuade99dadfd2014-10-09 15:29:03 -07002115 struct page *page;
Zach Brown994fc28c2005-12-15 14:28:17 -08002116 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117
Zach Brown994fc28c2005-12-15 14:28:17 -08002118 do {
Michal Hockoc20cd452016-01-14 15:20:12 -08002119 page = __page_cache_alloc(gfp_mask|__GFP_COLD);
Zach Brown994fc28c2005-12-15 14:28:17 -08002120 if (!page)
2121 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122
Matthew Wilcoxf4c86fa2018-04-20 14:56:20 -07002123 ret = add_to_page_cache_lru(page, mapping, offset, gfp_mask);
Zach Brown994fc28c2005-12-15 14:28:17 -08002124 if (ret == 0)
2125 ret = mapping->a_ops->readpage(file, page);
2126 else if (ret == -EEXIST)
2127 ret = 0; /* losing race to add is OK */
2128
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002129 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130
Zach Brown994fc28c2005-12-15 14:28:17 -08002131 } while (ret == AOP_TRUNCATED_PAGE);
Paul McQuade99dadfd2014-10-09 15:29:03 -07002132
Zach Brown994fc28c2005-12-15 14:28:17 -08002133 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002134}
2135
2136#define MMAP_LOTSAMISS (100)
2137
Linus Torvaldsef00e082009-06-16 15:31:25 -07002138/*
2139 * Synchronous readahead happens when we don't even find
2140 * a page in the page cache at all.
2141 */
2142static void do_sync_mmap_readahead(struct vm_area_struct *vma,
2143 struct file_ra_state *ra,
2144 struct file *file,
2145 pgoff_t offset)
2146{
Linus Torvaldsef00e082009-06-16 15:31:25 -07002147 struct address_space *mapping = file->f_mapping;
2148
2149 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002150 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002151 return;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002152 if (!ra->ra_pages)
2153 return;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002154
Joe Perches64363aa2013-07-08 16:00:18 -07002155 if (vma->vm_flags & VM_SEQ_READ) {
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002156 page_cache_sync_readahead(mapping, ra, file, offset,
2157 ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002158 return;
2159 }
2160
Andi Kleen207d04b2011-05-24 17:12:29 -07002161 /* Avoid banging the cache line if not needed */
2162 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002163 ra->mmap_miss++;
2164
2165 /*
2166 * Do we miss much more than hit in this file? If so,
2167 * stop bothering with read-ahead. It will only hurt.
2168 */
2169 if (ra->mmap_miss > MMAP_LOTSAMISS)
2170 return;
2171
Wu Fengguangd30a1102009-06-16 15:31:30 -07002172 /*
2173 * mmap read-around
2174 */
Roman Gushchin600e19a2015-11-05 18:47:08 -08002175 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2176 ra->size = ra->ra_pages;
2177 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002178 ra_submit(ra, mapping, file);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002179}
2180
2181/*
2182 * Asynchronous readahead happens when we find the page and PG_readahead,
2183 * so we want to possibly extend the readahead further..
2184 */
2185static void do_async_mmap_readahead(struct vm_area_struct *vma,
2186 struct file_ra_state *ra,
2187 struct file *file,
2188 struct page *page,
2189 pgoff_t offset)
2190{
2191 struct address_space *mapping = file->f_mapping;
2192
2193 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002194 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002195 return;
2196 if (ra->mmap_miss > 0)
2197 ra->mmap_miss--;
2198 if (PageReadahead(page))
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002199 page_cache_async_readahead(mapping, ra, file,
2200 page, offset, ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002201}
2202
Randy Dunlap485bb992006-06-23 02:03:49 -07002203/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002204 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002205 * @vma: vma in which the fault was taken
2206 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002207 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002208 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209 * mapped memory region to read in file data during a page fault.
2210 *
2211 * The goto's are kind of ugly, but this streamlines the normal case of having
2212 * it in the page cache, and handles the special cases reasonably without
2213 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002214 *
2215 * vma->vm_mm->mmap_sem must be held on entry.
2216 *
2217 * If our return value has VM_FAULT_RETRY set, it's because
2218 * lock_page_or_retry() returned 0.
2219 * The mmap_sem has usually been released in this case.
2220 * See __lock_page_or_retry() for the exception.
2221 *
2222 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2223 * has not been released.
2224 *
2225 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002226 */
Nick Piggind0217ac2007-07-19 01:47:03 -07002227int filemap_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228{
2229 int error;
Nick Piggin54cb8822007-07-19 01:46:59 -07002230 struct file *file = vma->vm_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002231 struct address_space *mapping = file->f_mapping;
2232 struct file_ra_state *ra = &file->f_ra;
2233 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002234 pgoff_t offset = vmf->pgoff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 struct page *page;
Kirill A. Shutemov99e3e532014-04-07 15:37:21 -07002236 loff_t size;
Nick Piggin83c54072007-07-19 01:47:05 -07002237 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002239 size = round_up(i_size_read(inode), PAGE_SIZE);
2240 if (offset >= size >> PAGE_SHIFT)
Linus Torvalds5307cc12007-10-31 09:19:46 -07002241 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002244 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002246 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002247 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002249 * We found the page, so try async readahead before
2250 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002251 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002252 do_async_mmap_readahead(vma, ra, file, page, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002253 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002254 /* No page in the page cache at all */
2255 do_sync_mmap_readahead(vma, ra, file, offset);
2256 count_vm_event(PGMAJFAULT);
Ying Han456f9982011-05-26 16:25:38 -07002257 mem_cgroup_count_vm_event(vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002258 ret = VM_FAULT_MAJOR;
2259retry_find:
Michel Lespinasseb522c942010-10-26 14:21:56 -07002260 page = find_get_page(mapping, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002261 if (!page)
2262 goto no_cached_page;
2263 }
2264
Michel Lespinassed88c0922010-11-02 13:05:18 -07002265 if (!lock_page_or_retry(page, vma->vm_mm, vmf->flags)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002266 put_page(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07002267 return ret | VM_FAULT_RETRY;
Michel Lespinassed88c0922010-11-02 13:05:18 -07002268 }
Michel Lespinasseb522c942010-10-26 14:21:56 -07002269
2270 /* Did it get truncated? */
2271 if (unlikely(page->mapping != mapping)) {
2272 unlock_page(page);
2273 put_page(page);
2274 goto retry_find;
2275 }
Sasha Levin309381fea2014-01-23 15:52:54 -08002276 VM_BUG_ON_PAGE(page->index != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002277
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002279 * We have a locked page in the page cache, now we need to check
2280 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281 */
Nick Piggind00806b2007-07-19 01:46:57 -07002282 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002283 goto page_not_uptodate;
2284
Linus Torvaldsef00e082009-06-16 15:31:25 -07002285 /*
2286 * Found the page and have a reference on it.
2287 * We must recheck i_size under page lock.
2288 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002289 size = round_up(i_size_read(inode), PAGE_SIZE);
2290 if (unlikely(offset >= size >> PAGE_SHIFT)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002291 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002292 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002293 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002294 }
2295
Nick Piggind0217ac2007-07-19 01:47:03 -07002296 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002297 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299no_cached_page:
2300 /*
2301 * We're only likely to ever get here if MADV_RANDOM is in
2302 * effect.
2303 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002304 error = page_cache_read(file, offset, vmf->gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305
2306 /*
2307 * The page we want has now been added to the page cache.
2308 * In the unlikely event that someone removed it in the
2309 * meantime, we'll just come back here and read it again.
2310 */
2311 if (error >= 0)
2312 goto retry_find;
2313
2314 /*
2315 * An error return from page_cache_read can result if the
2316 * system is low on memory, or a problem occurs while trying
2317 * to schedule I/O.
2318 */
2319 if (error == -ENOMEM)
Nick Piggind0217ac2007-07-19 01:47:03 -07002320 return VM_FAULT_OOM;
2321 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002322
2323page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002324 /*
2325 * Umm, take care of errors if the page isn't up-to-date.
2326 * Try to re-read it _once_. We do this synchronously,
2327 * because there really aren't any performance issues here
2328 * and we need to check for errors.
2329 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002330 ClearPageError(page);
Zach Brown994fc28c2005-12-15 14:28:17 -08002331 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002332 if (!error) {
2333 wait_on_page_locked(page);
2334 if (!PageUptodate(page))
2335 error = -EIO;
2336 }
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002337 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002338
2339 if (!error || error == AOP_TRUNCATED_PAGE)
2340 goto retry_find;
2341
2342 /* Things didn't work out. Return zero to tell the mm layer so. */
2343 shrink_readahead_size_eio(file, ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002344 return VM_FAULT_SIGBUS;
Nick Piggin54cb8822007-07-19 01:46:59 -07002345}
2346EXPORT_SYMBOL(filemap_fault);
2347
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002348void filemap_map_pages(struct fault_env *fe,
2349 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002350{
2351 struct radix_tree_iter iter;
2352 void **slot;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002353 struct file *file = fe->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002354 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002355 pgoff_t last_pgoff = start_pgoff;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002356 loff_t size;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002357 struct page *head, *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002358
2359 rcu_read_lock();
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002360 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter,
2361 start_pgoff) {
2362 if (iter.index > end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002363 break;
2364repeat:
2365 page = radix_tree_deref_slot(slot);
2366 if (unlikely(!page))
2367 goto next;
2368 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07002369 if (radix_tree_deref_retry(page)) {
2370 slot = radix_tree_iter_retry(&iter);
2371 continue;
2372 }
2373 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002374 }
2375
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002376 head = compound_head(page);
2377 if (!page_cache_get_speculative(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002378 goto repeat;
2379
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002380 /* The page was split under us? */
2381 if (compound_head(page) != head) {
2382 put_page(head);
2383 goto repeat;
2384 }
2385
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002386 /* Has the page moved? */
2387 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002388 put_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002389 goto repeat;
2390 }
2391
2392 if (!PageUptodate(page) ||
2393 PageReadahead(page) ||
2394 PageHWPoison(page))
2395 goto skip;
2396 if (!trylock_page(page))
2397 goto skip;
2398
2399 if (page->mapping != mapping || !PageUptodate(page))
2400 goto unlock;
2401
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002402 size = round_up(i_size_read(mapping->host), PAGE_SIZE);
2403 if (page->index >= size >> PAGE_SHIFT)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002404 goto unlock;
2405
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002406 if (file->f_ra.mmap_miss > 0)
2407 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002408
2409 fe->address += (iter.index - last_pgoff) << PAGE_SHIFT;
2410 if (fe->pte)
2411 fe->pte += iter.index - last_pgoff;
2412 last_pgoff = iter.index;
2413 if (alloc_set_pte(fe, NULL, page))
2414 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002415 unlock_page(page);
2416 goto next;
2417unlock:
2418 unlock_page(page);
2419skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002420 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002421next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002422 /* Huge page is mapped? No need to proceed. */
2423 if (pmd_trans_huge(*fe->pmd))
2424 break;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002425 if (iter.index == end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002426 break;
2427 }
2428 rcu_read_unlock();
2429}
2430EXPORT_SYMBOL(filemap_map_pages);
2431
Jan Kara4fcf1c62012-06-12 16:20:29 +02002432int filemap_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
2433{
2434 struct page *page = vmf->page;
Al Viro496ad9a2013-01-23 17:07:38 -05002435 struct inode *inode = file_inode(vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002436 int ret = VM_FAULT_LOCKED;
2437
Jan Kara14da9202012-06-12 16:20:37 +02002438 sb_start_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002439 file_update_time(vma->vm_file);
2440 lock_page(page);
2441 if (page->mapping != inode->i_mapping) {
2442 unlock_page(page);
2443 ret = VM_FAULT_NOPAGE;
2444 goto out;
2445 }
Jan Kara14da9202012-06-12 16:20:37 +02002446 /*
2447 * We mark the page dirty already here so that when freeze is in
2448 * progress, we are guaranteed that writeback during freezing will
2449 * see the dirty page and writeprotect it again.
2450 */
2451 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002452 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002453out:
Jan Kara14da9202012-06-12 16:20:37 +02002454 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002455 return ret;
2456}
2457EXPORT_SYMBOL(filemap_page_mkwrite);
2458
Alexey Dobriyanf0f37e22009-09-27 22:29:37 +04002459const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002460 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002461 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002462 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002463};
2464
2465/* This is used for a general mmap of a disk file */
2466
2467int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2468{
2469 struct address_space *mapping = file->f_mapping;
2470
2471 if (!mapping->a_ops->readpage)
2472 return -ENOEXEC;
2473 file_accessed(file);
2474 vma->vm_ops = &generic_file_vm_ops;
2475 return 0;
2476}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477
2478/*
2479 * This is for filesystems which do not implement ->writepage.
2480 */
2481int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2482{
2483 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2484 return -EINVAL;
2485 return generic_file_mmap(file, vma);
2486}
2487#else
2488int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2489{
2490 return -ENOSYS;
2491}
2492int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2493{
2494 return -ENOSYS;
2495}
2496#endif /* CONFIG_MMU */
2497
2498EXPORT_SYMBOL(generic_file_mmap);
2499EXPORT_SYMBOL(generic_file_readonly_mmap);
2500
Sasha Levin67f9fd92014-04-03 14:48:18 -07002501static struct page *wait_on_page_read(struct page *page)
2502{
2503 if (!IS_ERR(page)) {
2504 wait_on_page_locked(page);
2505 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002506 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002507 page = ERR_PTR(-EIO);
2508 }
2509 }
2510 return page;
2511}
2512
Mel Gorman32b63522016-03-15 14:55:36 -07002513static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002514 pgoff_t index,
Sami Tolvanen4fd840d2017-08-16 14:38:13 -07002515 int (*filler)(struct file *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002516 void *data,
2517 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518{
Nick Piggineb2be182007-10-16 01:24:57 -07002519 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 int err;
2521repeat:
2522 page = find_get_page(mapping, index);
2523 if (!page) {
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002524 page = __page_cache_alloc(gfp | __GFP_COLD);
Nick Piggineb2be182007-10-16 01:24:57 -07002525 if (!page)
2526 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002527 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002528 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002529 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002530 if (err == -EEXIST)
2531 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002532 /* Presumably ENOMEM for radix tree node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002533 return ERR_PTR(err);
2534 }
Mel Gorman32b63522016-03-15 14:55:36 -07002535
2536filler:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002537 err = filler(data, page);
2538 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002539 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002540 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002541 }
Mel Gorman32b63522016-03-15 14:55:36 -07002542
2543 page = wait_on_page_read(page);
2544 if (IS_ERR(page))
2545 return page;
2546 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002547 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002548 if (PageUptodate(page))
2549 goto out;
2550
Mel Gormanebded022016-03-15 14:55:39 -07002551 /*
2552 * Page is not up to date and may be locked due one of the following
2553 * case a: Page is being filled and the page lock is held
2554 * case b: Read/write error clearing the page uptodate status
2555 * case c: Truncation in progress (page locked)
2556 * case d: Reclaim in progress
2557 *
2558 * Case a, the page will be up to date when the page is unlocked.
2559 * There is no need to serialise on the page lock here as the page
2560 * is pinned so the lock gives no additional protection. Even if the
2561 * the page is truncated, the data is still valid if PageUptodate as
2562 * it's a race vs truncate race.
2563 * Case b, the page will not be up to date
2564 * Case c, the page may be truncated but in itself, the data may still
2565 * be valid after IO completes as it's a read vs truncate race. The
2566 * operation must restart if the page is not uptodate on unlock but
2567 * otherwise serialising on page lock to stabilise the mapping gives
2568 * no additional guarantees to the caller as the page lock is
2569 * released before return.
2570 * Case d, similar to truncation. If reclaim holds the page lock, it
2571 * will be a race with remove_mapping that determines if the mapping
2572 * is valid on unlock but otherwise the data is valid and there is
2573 * no need to serialise with page lock.
2574 *
2575 * As the page lock gives no additional guarantee, we optimistically
2576 * wait on the page to be unlocked and check if it's up to date and
2577 * use the page if it is. Otherwise, the page lock is required to
2578 * distinguish between the different cases. The motivation is that we
2579 * avoid spurious serialisations and wakeups when multiple processes
2580 * wait on the same page for IO to complete.
2581 */
2582 wait_on_page_locked(page);
2583 if (PageUptodate(page))
2584 goto out;
2585
2586 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002588
2589 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002590 if (!page->mapping) {
2591 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002592 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002593 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 }
Mel Gormanebded022016-03-15 14:55:39 -07002595
2596 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002597 if (PageUptodate(page)) {
2598 unlock_page(page);
2599 goto out;
2600 }
Mel Gorman32b63522016-03-15 14:55:36 -07002601 goto filler;
2602
David Howellsc855ff32007-05-09 13:42:20 +01002603out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002604 mark_page_accessed(page);
2605 return page;
2606}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002607
2608/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002609 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002610 * @mapping: the page's address_space
2611 * @index: the page index
2612 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002613 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002614 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002615 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002616 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002617 *
2618 * If the page does not get brought uptodate, return -EIO.
2619 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002620struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002621 pgoff_t index,
Sami Tolvanen4fd840d2017-08-16 14:38:13 -07002622 int (*filler)(struct file *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002623 void *data)
2624{
2625 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2626}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002627EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002628
2629/**
2630 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2631 * @mapping: the page's address_space
2632 * @index: the page index
2633 * @gfp: the page allocator flags to use if allocating
2634 *
2635 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002636 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002637 *
2638 * If the page does not get brought uptodate, return -EIO.
2639 */
2640struct page *read_cache_page_gfp(struct address_space *mapping,
2641 pgoff_t index,
2642 gfp_t gfp)
2643{
Sami Tolvanen4fd840d2017-08-16 14:38:13 -07002644 filler_t *filler = mapping->a_ops->readpage;
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002645
Sasha Levin67f9fd92014-04-03 14:48:18 -07002646 return do_read_cache_page(mapping, index, filler, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002647}
2648EXPORT_SYMBOL(read_cache_page_gfp);
2649
Nick Piggin2f718ff2007-10-16 01:24:59 -07002650/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 * Performs necessary checks before doing a write
2652 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002653 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 * Returns appropriate error code that caller should return or
2655 * zero in case that write should be allowed.
2656 */
Al Viro3309dd02015-04-09 12:55:47 -04002657inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658{
Al Viro3309dd02015-04-09 12:55:47 -04002659 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660 struct inode *inode = file->f_mapping->host;
Jiri Slaby59e99e52010-03-05 13:41:44 -08002661 unsigned long limit = rlimit(RLIMIT_FSIZE);
Al Viro3309dd02015-04-09 12:55:47 -04002662 loff_t pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663
Al Viro3309dd02015-04-09 12:55:47 -04002664 if (!iov_iter_count(from))
2665 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002666
Al Viro0fa6b002015-04-04 04:05:48 -04002667 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002668 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002669 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670
Al Viro3309dd02015-04-09 12:55:47 -04002671 pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672
Al Viro0fa6b002015-04-04 04:05:48 -04002673 if (limit != RLIM_INFINITY) {
Al Viro3309dd02015-04-09 12:55:47 -04002674 if (iocb->ki_pos >= limit) {
Al Viro0fa6b002015-04-04 04:05:48 -04002675 send_sig(SIGXFSZ, current, 0);
2676 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677 }
Al Viro3309dd02015-04-09 12:55:47 -04002678 iov_iter_truncate(from, limit - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002679 }
2680
2681 /*
2682 * LFS rule
2683 */
Al Viro3309dd02015-04-09 12:55:47 -04002684 if (unlikely(pos + iov_iter_count(from) > MAX_NON_LFS &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002685 !(file->f_flags & O_LARGEFILE))) {
Al Viro3309dd02015-04-09 12:55:47 -04002686 if (pos >= MAX_NON_LFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002687 return -EFBIG;
Al Viro3309dd02015-04-09 12:55:47 -04002688 iov_iter_truncate(from, MAX_NON_LFS - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002689 }
2690
2691 /*
2692 * Are we about to exceed the fs block limit ?
2693 *
2694 * If we have written data it becomes a short write. If we have
2695 * exceeded without writing data we send a signal and return EFBIG.
2696 * Linus frestrict idea will clean these up nicely..
2697 */
Al Viro3309dd02015-04-09 12:55:47 -04002698 if (unlikely(pos >= inode->i_sb->s_maxbytes))
2699 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700
Al Viro3309dd02015-04-09 12:55:47 -04002701 iov_iter_truncate(from, inode->i_sb->s_maxbytes - pos);
2702 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703}
2704EXPORT_SYMBOL(generic_write_checks);
2705
Nick Pigginafddba42007-10-16 01:25:01 -07002706int pagecache_write_begin(struct file *file, struct address_space *mapping,
2707 loff_t pos, unsigned len, unsigned flags,
2708 struct page **pagep, void **fsdata)
2709{
2710 const struct address_space_operations *aops = mapping->a_ops;
2711
Nick Piggin4e02ed42008-10-29 14:00:55 -07002712 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002713 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002714}
2715EXPORT_SYMBOL(pagecache_write_begin);
2716
2717int pagecache_write_end(struct file *file, struct address_space *mapping,
2718 loff_t pos, unsigned len, unsigned copied,
2719 struct page *page, void *fsdata)
2720{
2721 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07002722
Nick Piggin4e02ed42008-10-29 14:00:55 -07002723 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002724}
2725EXPORT_SYMBOL(pagecache_write_end);
2726
Linus Torvalds1da177e2005-04-16 15:20:36 -07002727ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002728generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002729{
2730 struct file *file = iocb->ki_filp;
2731 struct address_space *mapping = file->f_mapping;
2732 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002733 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002734 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002735 size_t write_len;
2736 pgoff_t end;
Al Viro26978b82014-03-10 14:08:45 -04002737 struct iov_iter data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002738
Al Viro0c949332014-03-22 06:51:37 -04002739 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002740 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002741
Nick Piggin48b47c52009-01-06 14:40:22 -08002742 written = filemap_write_and_wait_range(mapping, pos, pos + write_len - 1);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002743 if (written)
2744 goto out;
2745
2746 /*
2747 * After a write we want buffered reads to be sure to go to disk to get
2748 * the new data. We invalidate clean cached page from the region we're
2749 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002750 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07002751 */
2752 if (mapping->nrpages) {
2753 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002754 pos >> PAGE_SHIFT, end);
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002755 /*
2756 * If a page can not be invalidated, return 0 to fall back
2757 * to buffered write.
2758 */
2759 if (written) {
2760 if (written == -EBUSY)
2761 return 0;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002762 goto out;
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002763 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002764 }
2765
Al Viro26978b82014-03-10 14:08:45 -04002766 data = *from;
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002767 written = mapping->a_ops->direct_IO(iocb, &data);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002768
2769 /*
2770 * Finally, try again to invalidate clean pages which might have been
2771 * cached by non-direct readahead, or faulted in by get_user_pages()
2772 * if the source of the write was an mmap'ed region of the file
2773 * we're writing. Either one is a pretty crazy thing to do,
2774 * so we don't support it 100%. If this invalidation
2775 * fails, tough, the write still worked...
2776 */
2777 if (mapping->nrpages) {
2778 invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002779 pos >> PAGE_SHIFT, end);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002780 }
2781
Linus Torvalds1da177e2005-04-16 15:20:36 -07002782 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07002783 pos += written;
Al Virof8579f82014-03-03 22:03:20 -05002784 iov_iter_advance(from, written);
Namhyung Kim01166512010-10-26 14:21:58 -07002785 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
2786 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 mark_inode_dirty(inode);
2788 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05002789 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002791out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002792 return written;
2793}
2794EXPORT_SYMBOL(generic_file_direct_write);
2795
Nick Piggineb2be182007-10-16 01:24:57 -07002796/*
2797 * Find or create a page at the given pagecache position. Return the locked
2798 * page. This function is specifically for buffered writes.
2799 */
Nick Piggin54566b22009-01-04 12:00:53 -08002800struct page *grab_cache_page_write_begin(struct address_space *mapping,
2801 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07002802{
Nick Piggineb2be182007-10-16 01:24:57 -07002803 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07002804 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08002805
Nick Piggin54566b22009-01-04 12:00:53 -08002806 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07002807 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07002808
Mel Gorman2457aec2014-06-04 16:10:31 -07002809 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01002810 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07002811 if (page)
2812 wait_for_stable_page(page);
2813
Nick Piggineb2be182007-10-16 01:24:57 -07002814 return page;
2815}
Nick Piggin54566b22009-01-04 12:00:53 -08002816EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07002817
Al Viro3b93f912014-02-11 21:34:08 -05002818ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07002819 struct iov_iter *i, loff_t pos)
2820{
2821 struct address_space *mapping = file->f_mapping;
2822 const struct address_space_operations *a_ops = mapping->a_ops;
2823 long status = 0;
2824 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07002825 unsigned int flags = 0;
2826
2827 /*
2828 * Copies from kernel address space cannot fail (NFSD is a big user).
2829 */
Al Viro777eda22014-12-17 04:46:46 -05002830 if (!iter_is_iovec(i))
Nick Piggin674b8922007-10-16 01:25:03 -07002831 flags |= AOP_FLAG_UNINTERRUPTIBLE;
Nick Pigginafddba42007-10-16 01:25:01 -07002832
2833 do {
2834 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07002835 unsigned long offset; /* Offset into pagecache page */
2836 unsigned long bytes; /* Bytes to write to page */
2837 size_t copied; /* Bytes copied from user */
2838 void *fsdata;
2839
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002840 offset = (pos & (PAGE_SIZE - 1));
2841 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002842 iov_iter_count(i));
2843
2844again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01002845 /*
2846 * Bring in the user page that we will copy from _first_.
2847 * Otherwise there's a nasty deadlock on copying from the
2848 * same page as we're writing to, without it being marked
2849 * up-to-date.
2850 *
2851 * Not only is this an optimisation, but it is also required
2852 * to check that the address is actually valid, when atomic
2853 * usercopies are used, below.
2854 */
2855 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
2856 status = -EFAULT;
2857 break;
2858 }
2859
Jan Kara296291c2015-10-22 13:32:21 -07002860 if (fatal_signal_pending(current)) {
2861 status = -EINTR;
2862 break;
2863 }
2864
Nick Piggin674b8922007-10-16 01:25:03 -07002865 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002866 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07002867 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07002868 break;
2869
anfei zhou931e80e2010-02-02 13:44:02 -08002870 if (mapping_writably_mapped(mapping))
2871 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01002872
Nick Pigginafddba42007-10-16 01:25:01 -07002873 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07002874 flush_dcache_page(page);
2875
2876 status = a_ops->write_end(file, mapping, pos, bytes, copied,
2877 page, fsdata);
2878 if (unlikely(status < 0))
2879 break;
2880 copied = status;
2881
2882 cond_resched();
2883
Nick Piggin124d3b72008-02-02 15:01:17 +01002884 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07002885 if (unlikely(copied == 0)) {
2886 /*
2887 * If we were unable to copy any data at all, we must
2888 * fall back to a single segment length write.
2889 *
2890 * If we didn't fallback here, we could livelock
2891 * because not all segments in the iov can be copied at
2892 * once without a pagefault.
2893 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002894 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002895 iov_iter_single_seg_count(i));
2896 goto again;
2897 }
Nick Pigginafddba42007-10-16 01:25:01 -07002898 pos += copied;
2899 written += copied;
2900
2901 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07002902 } while (iov_iter_count(i));
2903
2904 return written ? written : status;
2905}
Al Viro3b93f912014-02-11 21:34:08 -05002906EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002907
Jan Karae4dd9de2009-08-17 18:10:06 +02002908/**
Al Viro81742022014-04-03 03:17:43 -04002909 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02002910 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04002911 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02002912 *
2913 * This function does all the work needed for actually writing data to a
2914 * file. It does all basic checks, removes SUID from the file, updates
2915 * modification times and calls proper subroutines depending on whether we
2916 * do direct IO or a standard buffered write.
2917 *
2918 * It expects i_mutex to be grabbed unless we work on a block device or similar
2919 * object which does not need locking at all.
2920 *
2921 * This function does *not* take care of syncing data in case of O_SYNC write.
2922 * A caller has to handle it. This is mainly due to the fact that we want to
2923 * avoid syncing under i_mutex.
2924 */
Al Viro81742022014-04-03 03:17:43 -04002925ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002926{
2927 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002928 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002929 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05002930 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05002932 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002933
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01002935 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002936 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002937 if (err)
2938 goto out;
2939
Josef Bacikc3b2da32012-03-26 09:59:21 -04002940 err = file_update_time(file);
2941 if (err)
2942 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002943
Al Viro2ba48ce2015-04-09 13:52:01 -04002944 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04002945 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002946
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002947 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002948 /*
2949 * If the write stopped short of completing, fall back to
2950 * buffered writes. Some filesystems do this for writes to
2951 * holes, for example. For DAX files, a buffered write will
2952 * not succeed (even if it did, DAX does not handle dirty
2953 * page-cache pages correctly).
2954 */
Al Viro0b8def92015-04-07 10:22:53 -04002955 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002956 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05002957
Al Viro0b8def92015-04-07 10:22:53 -04002958 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002959 /*
Al Viro3b93f912014-02-11 21:34:08 -05002960 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002961 * then we want to return the number of bytes which were
2962 * direct-written, or the error code if that was zero. Note
2963 * that this differs from normal direct-io semantics, which
2964 * will return -EFOO even if some bytes were written.
2965 */
Al Viro60bb4522014-08-08 12:39:16 -04002966 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05002967 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002968 goto out;
2969 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002970 /*
2971 * We need to ensure that the page cache pages are written to
2972 * disk and invalidated to preserve the expected O_DIRECT
2973 * semantics.
2974 */
Al Viro3b93f912014-02-11 21:34:08 -05002975 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04002976 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002977 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04002978 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05002979 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002980 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002981 pos >> PAGE_SHIFT,
2982 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002983 } else {
2984 /*
2985 * We don't know how much we wrote, so just return
2986 * the number of bytes which were direct-written
2987 */
2988 }
2989 } else {
Al Viro0b8def92015-04-07 10:22:53 -04002990 written = generic_perform_write(file, from, iocb->ki_pos);
2991 if (likely(written > 0))
2992 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002993 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002994out:
2995 current->backing_dev_info = NULL;
2996 return written ? written : err;
2997}
Al Viro81742022014-04-03 03:17:43 -04002998EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002999
Jan Karae4dd9de2009-08-17 18:10:06 +02003000/**
Al Viro81742022014-04-03 03:17:43 -04003001 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02003002 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003003 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003004 *
Al Viro81742022014-04-03 03:17:43 -04003005 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003006 * filesystems. It takes care of syncing the file in case of O_SYNC file
3007 * and acquires i_mutex as needed.
3008 */
Al Viro81742022014-04-03 03:17:43 -04003009ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010{
3011 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003012 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003013 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003014
Al Viro59551022016-01-22 15:40:57 -05003015 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003016 ret = generic_write_checks(iocb, from);
3017 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003018 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003019 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020
Christoph Hellwige2592212016-04-07 08:52:01 -07003021 if (ret > 0)
3022 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023 return ret;
3024}
Al Viro81742022014-04-03 03:17:43 -04003025EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003026
David Howellscf9a2ae2006-08-29 19:05:54 +01003027/**
3028 * try_to_release_page() - release old fs-specific metadata on a page
3029 *
3030 * @page: the page which the kernel is trying to free
3031 * @gfp_mask: memory allocation flags (and I/O mode)
3032 *
3033 * The address_space is to try to release any data against the page
3034 * (presumably at page->private). If the release was successful, return `1'.
3035 * Otherwise return zero.
3036 *
David Howells266cf652009-04-03 16:42:36 +01003037 * This may also be called if PG_fscache is set on a page, indicating that the
3038 * page is known to the local caching routines.
3039 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003040 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003041 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003042 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003043 */
3044int try_to_release_page(struct page *page, gfp_t gfp_mask)
3045{
3046 struct address_space * const mapping = page->mapping;
3047
3048 BUG_ON(!PageLocked(page));
3049 if (PageWriteback(page))
3050 return 0;
3051
3052 if (mapping && mapping->a_ops->releasepage)
3053 return mapping->a_ops->releasepage(page, gfp_mask);
3054 return try_to_free_buffers(page);
3055}
3056
3057EXPORT_SYMBOL(try_to_release_page);