blob: db7705c6bd1b7b5d7d708ccc86be794a9a2eac35 [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 */
Johannes Weinera2383322018-10-26 15:06:04 -0700746 WARN_ON_ONCE(PageActive(page));
747 if (!(gfp_mask & __GFP_WRITE) && shadow)
748 workingset_refault(page, shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700749 lru_cache_add(page);
750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 return ret;
752}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300753EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Paul Jackson44110fe2006-03-24 03:16:04 -0800755#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700756struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800757{
Miao Xiec0ff7452010-05-24 14:32:08 -0700758 int n;
759 struct page *page;
760
Paul Jackson44110fe2006-03-24 03:16:04 -0800761 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700762 unsigned int cpuset_mems_cookie;
763 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700764 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700765 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700766 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700767 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700768
Miao Xiec0ff7452010-05-24 14:32:08 -0700769 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800770 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700771 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800772}
Nick Piggin2ae88142006-10-28 10:38:23 -0700773EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800774#endif
775
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776/*
777 * In order to wait for pages to become available there must be
778 * waitqueues associated with pages. By using a hash table of
779 * waitqueues where the bucket discipline is to maintain all
780 * waiters on the same queue and wake all when any of the pages
781 * become available, and for the woken contexts to check to be
782 * sure the appropriate page became available, this saves space
783 * at a cost of "thundering herd" phenomena during rare hash
784 * collisions.
785 */
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000786#define PAGE_WAIT_TABLE_BITS 8
787#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
788static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
789
790static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791{
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000792 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793}
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000794
795void __init pagecache_init(void)
796{
797 int i;
798
799 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
800 init_waitqueue_head(&page_wait_table[i]);
801
802 page_writeback_init();
803}
804
805struct wait_page_key {
806 struct page *page;
807 int bit_nr;
808 int page_match;
809};
810
811struct wait_page_queue {
812 struct page *page;
813 int bit_nr;
814 wait_queue_t wait;
815};
816
817static int wake_page_function(wait_queue_t *wait, unsigned mode, int sync, void *arg)
818{
819 struct wait_page_key *key = arg;
820 struct wait_page_queue *wait_page
821 = container_of(wait, struct wait_page_queue, wait);
822
823 if (wait_page->page != key->page)
824 return 0;
825 key->page_match = 1;
826
827 if (wait_page->bit_nr != key->bit_nr)
828 return 0;
829 if (test_bit(key->bit_nr, &key->page->flags))
830 return 0;
831
832 return autoremove_wake_function(wait, mode, sync, key);
833}
834
835void wake_up_page_bit(struct page *page, int bit_nr)
836{
837 wait_queue_head_t *q = page_waitqueue(page);
838 struct wait_page_key key;
839 unsigned long flags;
840
841 key.page = page;
842 key.bit_nr = bit_nr;
843 key.page_match = 0;
844
845 spin_lock_irqsave(&q->lock, flags);
846 __wake_up_locked_key(q, TASK_NORMAL, &key);
847 /*
848 * It is possible for other pages to have collided on the waitqueue
849 * hash, so in that case check for a page match. That prevents a long-
850 * term waiter
851 *
852 * It is still possible to miss a case here, when we woke page waiters
853 * and removed them from the waitqueue, but there are still other
854 * page waiters.
855 */
856 if (!waitqueue_active(q) || !key.page_match) {
857 ClearPageWaiters(page);
858 /*
859 * It's possible to miss clearing Waiters here, when we woke
860 * our page waiters, but the hashed waitqueue has waiters for
861 * other pages on it.
862 *
863 * That's okay, it's a rare case. The next waker will clear it.
864 */
865 }
866 spin_unlock_irqrestore(&q->lock, flags);
867}
868EXPORT_SYMBOL(wake_up_page_bit);
869
870static inline int wait_on_page_bit_common(wait_queue_head_t *q,
871 struct page *page, int bit_nr, int state, bool lock)
872{
873 struct wait_page_queue wait_page;
874 wait_queue_t *wait = &wait_page.wait;
875 int ret = 0;
876
877 init_wait(wait);
878 wait->func = wake_page_function;
879 wait_page.page = page;
880 wait_page.bit_nr = bit_nr;
881
882 for (;;) {
883 spin_lock_irq(&q->lock);
884
885 if (likely(list_empty(&wait->task_list))) {
886 if (lock)
887 __add_wait_queue_tail_exclusive(q, wait);
888 else
889 __add_wait_queue(q, wait);
890 SetPageWaiters(page);
891 }
892
893 set_current_state(state);
894
895 spin_unlock_irq(&q->lock);
896
897 if (likely(test_bit(bit_nr, &page->flags))) {
898 io_schedule();
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000899 }
900
901 if (lock) {
902 if (!test_and_set_bit_lock(bit_nr, &page->flags))
903 break;
904 } else {
905 if (!test_bit(bit_nr, &page->flags))
906 break;
907 }
Linus Torvalds7394f692017-08-27 16:25:09 -0700908
909 if (unlikely(signal_pending_state(state, current))) {
910 ret = -EINTR;
911 break;
912 }
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000913 }
914
915 finish_wait(q, wait);
916
917 /*
918 * A signal could leave PageWaiters set. Clearing it here if
919 * !waitqueue_active would be possible (by open-coding finish_wait),
920 * but still fail to catch it in the case of wait hash collision. We
921 * already can fail to clear wait hash collision cases, so don't
922 * bother with signals either.
923 */
924
925 return ret;
926}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Harvey Harrison920c7a52008-02-04 22:29:26 -0800928void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929{
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000930 wait_queue_head_t *q = page_waitqueue(page);
931 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932}
933EXPORT_SYMBOL(wait_on_page_bit);
934
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700935int wait_on_page_bit_killable(struct page *page, int bit_nr)
936{
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000937 wait_queue_head_t *q = page_waitqueue(page);
938 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, false);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700939}
940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941/**
David Howells385e1ca5f2009-04-03 16:42:39 +0100942 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -0700943 * @page: Page defining the wait queue of interest
944 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +0100945 *
946 * Add an arbitrary @waiter to the wait queue for the nominated @page.
947 */
948void add_page_wait_queue(struct page *page, wait_queue_t *waiter)
949{
950 wait_queue_head_t *q = page_waitqueue(page);
951 unsigned long flags;
952
953 spin_lock_irqsave(&q->lock, flags);
954 __add_wait_queue(q, waiter);
Nicholas Piggin49e19db2016-12-25 13:00:30 +1000955 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +0100956 spin_unlock_irqrestore(&q->lock, flags);
957}
958EXPORT_SYMBOL_GPL(add_page_wait_queue);
959
960/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700961 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 * @page: the page
963 *
964 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
965 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +0900966 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
968 *
Nick Piggin8413ac92008-10-18 20:26:59 -0700969 * The mb is necessary to enforce ordering between the clear_bit and the read
970 * of the waitqueue (to avoid SMP races with a parallel wait_on_page_locked()).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 */
Harvey Harrison920c7a52008-02-04 22:29:26 -0800972void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973{
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800974 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -0800975 VM_BUG_ON_PAGE(!PageLocked(page), page);
Nick Piggin8413ac92008-10-18 20:26:59 -0700976 clear_bit_unlock(PG_locked, &page->flags);
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100977 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 wake_up_page(page, PG_locked);
979}
980EXPORT_SYMBOL(unlock_page);
981
Randy Dunlap485bb992006-06-23 02:03:49 -0700982/**
983 * end_page_writeback - end writeback against a page
984 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 */
986void end_page_writeback(struct page *page)
987{
Mel Gorman888cf2d2014-06-04 16:10:34 -0700988 /*
989 * TestClearPageReclaim could be used here but it is an atomic
990 * operation and overkill in this particular case. Failing to
991 * shuffle a page marked for immediate reclaim is too mild to
992 * justify taking an atomic operation penalty at the end of
993 * ever page writeback.
994 */
995 if (PageReclaim(page)) {
996 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700997 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -0700998 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700999
1000 if (!test_clear_page_writeback(page))
1001 BUG();
1002
Peter Zijlstra4e857c52014-03-17 18:06:10 +01001003 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 wake_up_page(page, PG_writeback);
1005}
1006EXPORT_SYMBOL(end_page_writeback);
1007
Matthew Wilcox57d99842014-06-04 16:07:45 -07001008/*
1009 * After completing I/O on a page, call this routine to update the page
1010 * flags appropriately
1011 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001012void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001013{
Jens Axboec11f0c02016-08-05 08:11:04 -06001014 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001015 if (!err) {
1016 SetPageUptodate(page);
1017 } else {
1018 ClearPageUptodate(page);
1019 SetPageError(page);
1020 }
1021 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001022 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001023 if (err) {
Minchan Kim2c290ee2017-02-24 14:59:59 -08001024 struct address_space *mapping;
1025
Matthew Wilcox57d99842014-06-04 16:07:45 -07001026 SetPageError(page);
Minchan Kim2c290ee2017-02-24 14:59:59 -08001027 mapping = page_mapping(page);
1028 if (mapping)
1029 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001030 }
1031 end_page_writeback(page);
1032 }
1033}
1034EXPORT_SYMBOL_GPL(page_endio);
1035
Randy Dunlap485bb992006-06-23 02:03:49 -07001036/**
1037 * __lock_page - get a lock on the page, assuming we need to sleep to get it
1038 * @page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 */
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001040void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041{
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001042 struct page *page = compound_head(__page);
1043 wait_queue_head_t *q = page_waitqueue(page);
1044 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045}
1046EXPORT_SYMBOL(__lock_page);
1047
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001048int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001049{
Nicholas Piggin49e19db2016-12-25 13:00:30 +10001050 struct page *page = compound_head(__page);
1051 wait_queue_head_t *q = page_waitqueue(page);
1052 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE, true);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001053}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001054EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001055
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001056/*
1057 * Return values:
1058 * 1 - page is locked; mmap_sem is still held.
1059 * 0 - page is not locked.
1060 * mmap_sem has been released (up_read()), unless flags had both
1061 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1062 * which case mmap_sem is still held.
1063 *
1064 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1065 * with the page locked and the mmap_sem unperturbed.
1066 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001067int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1068 unsigned int flags)
1069{
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001070 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1071 /*
1072 * CAUTION! In this case, mmap_sem is not released
1073 * even though return 0.
1074 */
1075 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1076 return 0;
1077
1078 up_read(&mm->mmap_sem);
1079 if (flags & FAULT_FLAG_KILLABLE)
1080 wait_on_page_locked_killable(page);
1081 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001082 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001083 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001084 } else {
1085 if (flags & FAULT_FLAG_KILLABLE) {
1086 int ret;
1087
1088 ret = __lock_page_killable(page);
1089 if (ret) {
1090 up_read(&mm->mmap_sem);
1091 return 0;
1092 }
1093 } else
1094 __lock_page(page);
1095 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001096 }
1097}
1098
Randy Dunlap485bb992006-06-23 02:03:49 -07001099/**
Johannes Weinere7b563b2014-04-03 14:47:44 -07001100 * page_cache_next_hole - find the next hole (not-present entry)
1101 * @mapping: mapping
1102 * @index: index
1103 * @max_scan: maximum range to search
1104 *
1105 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the
1106 * lowest indexed hole.
1107 *
1108 * Returns: the index of the hole if found, otherwise returns an index
1109 * outside of the set specified (in which case 'return - index >=
1110 * max_scan' will be true). In rare cases of index wrap-around, 0 will
1111 * be returned.
1112 *
1113 * page_cache_next_hole may be called under rcu_read_lock. However,
1114 * like radix_tree_gang_lookup, this will not atomically search a
1115 * snapshot of the tree at a single point in time. For example, if a
1116 * hole is created at index 5, then subsequently a hole is created at
1117 * index 10, page_cache_next_hole covering both indexes may return 10
1118 * if called under rcu_read_lock.
1119 */
1120pgoff_t page_cache_next_hole(struct address_space *mapping,
1121 pgoff_t index, unsigned long max_scan)
1122{
1123 unsigned long i;
1124
1125 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001126 struct page *page;
1127
1128 page = radix_tree_lookup(&mapping->page_tree, index);
1129 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001130 break;
1131 index++;
1132 if (index == 0)
1133 break;
1134 }
1135
1136 return index;
1137}
1138EXPORT_SYMBOL(page_cache_next_hole);
1139
1140/**
1141 * page_cache_prev_hole - find the prev hole (not-present entry)
1142 * @mapping: mapping
1143 * @index: index
1144 * @max_scan: maximum range to search
1145 *
1146 * Search backwards in the range [max(index-max_scan+1, 0), index] for
1147 * the first hole.
1148 *
1149 * Returns: the index of the hole if found, otherwise returns an index
1150 * outside of the set specified (in which case 'index - return >=
1151 * max_scan' will be true). In rare cases of wrap-around, ULONG_MAX
1152 * will be returned.
1153 *
1154 * page_cache_prev_hole may be called under rcu_read_lock. However,
1155 * like radix_tree_gang_lookup, this will not atomically search a
1156 * snapshot of the tree at a single point in time. For example, if a
1157 * hole is created at index 10, then subsequently a hole is created at
1158 * index 5, page_cache_prev_hole covering both indexes may return 5 if
1159 * called under rcu_read_lock.
1160 */
1161pgoff_t page_cache_prev_hole(struct address_space *mapping,
1162 pgoff_t index, unsigned long max_scan)
1163{
1164 unsigned long i;
1165
1166 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001167 struct page *page;
1168
1169 page = radix_tree_lookup(&mapping->page_tree, index);
1170 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001171 break;
1172 index--;
1173 if (index == ULONG_MAX)
1174 break;
1175 }
1176
1177 return index;
1178}
1179EXPORT_SYMBOL(page_cache_prev_hole);
1180
1181/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001182 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001183 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001184 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001185 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001186 * Looks up the page cache slot at @mapping & @offset. If there is a
1187 * page cache page, it is returned with an increased refcount.
1188 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001189 * If the slot holds a shadow entry of a previously evicted page, or a
1190 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001191 *
1192 * Otherwise, %NULL is returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001194struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001195{
Nick Piggina60637c2008-07-25 19:45:31 -07001196 void **pagep;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001197 struct page *head, *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001198
Nick Piggina60637c2008-07-25 19:45:31 -07001199 rcu_read_lock();
1200repeat:
1201 page = NULL;
1202 pagep = radix_tree_lookup_slot(&mapping->page_tree, offset);
1203 if (pagep) {
1204 page = radix_tree_deref_slot(pagep);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001205 if (unlikely(!page))
1206 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001207 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001208 if (radix_tree_deref_retry(page))
1209 goto repeat;
1210 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001211 * A shadow entry of a recently evicted page,
1212 * or a swap entry from shmem/tmpfs. Return
1213 * it without attempting to raise page count.
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001214 */
1215 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001216 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001217
1218 head = compound_head(page);
1219 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001220 goto repeat;
1221
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001222 /* The page was split under us? */
1223 if (compound_head(page) != head) {
1224 put_page(head);
1225 goto repeat;
1226 }
1227
Nick Piggina60637c2008-07-25 19:45:31 -07001228 /*
1229 * Has the page moved?
1230 * This is part of the lockless pagecache protocol. See
1231 * include/linux/pagemap.h for details.
1232 */
1233 if (unlikely(page != *pagep)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001234 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001235 goto repeat;
1236 }
1237 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001238out:
Nick Piggina60637c2008-07-25 19:45:31 -07001239 rcu_read_unlock();
1240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 return page;
1242}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001243EXPORT_SYMBOL(find_get_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244
Randy Dunlap485bb992006-06-23 02:03:49 -07001245/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001246 * find_lock_entry - locate, pin and lock a page cache entry
1247 * @mapping: the address_space to search
1248 * @offset: the page cache index
1249 *
1250 * Looks up the page cache slot at @mapping & @offset. If there is a
1251 * page cache page, it is returned locked and with an increased
1252 * refcount.
1253 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001254 * If the slot holds a shadow entry of a previously evicted page, or a
1255 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001256 *
1257 * Otherwise, %NULL is returned.
1258 *
1259 * find_lock_entry() may sleep.
1260 */
1261struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262{
1263 struct page *page;
1264
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001266 page = find_get_entry(mapping, offset);
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001267 if (page && !radix_tree_exception(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001268 lock_page(page);
1269 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001270 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001271 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001272 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001273 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001275 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 return page;
1278}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001279EXPORT_SYMBOL(find_lock_entry);
1280
1281/**
Mel Gorman2457aec2014-06-04 16:10:31 -07001282 * pagecache_get_page - find and get a page reference
Johannes Weiner0cd61442014-04-03 14:47:46 -07001283 * @mapping: the address_space to search
1284 * @offset: the page index
Mel Gorman2457aec2014-06-04 16:10:31 -07001285 * @fgp_flags: PCG flags
Michal Hocko45f87de2014-12-29 20:30:35 +01001286 * @gfp_mask: gfp mask to use for the page cache data page allocation
Johannes Weiner0cd61442014-04-03 14:47:46 -07001287 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001288 * Looks up the page cache slot at @mapping & @offset.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001289 *
Randy Dunlap75325182014-07-30 16:08:37 -07001290 * PCG flags modify how the page is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001291 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001292 * FGP_ACCESSED: the page will be marked accessed
1293 * FGP_LOCK: Page is return locked
1294 * FGP_CREAT: If page is not present then a new page is allocated using
Michal Hocko45f87de2014-12-29 20:30:35 +01001295 * @gfp_mask and added to the page cache and the VM's LRU
1296 * list. The page is returned locked and with an increased
1297 * refcount. Otherwise, %NULL is returned.
Mel Gorman2457aec2014-06-04 16:10:31 -07001298 *
1299 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1300 * if the GFP flags specified for FGP_CREAT are atomic.
1301 *
1302 * If there is a page cache page, it is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001303 */
Mel Gorman2457aec2014-06-04 16:10:31 -07001304struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
Michal Hocko45f87de2014-12-29 20:30:35 +01001305 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001306{
Nick Piggineb2be182007-10-16 01:24:57 -07001307 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001308
Linus Torvalds1da177e2005-04-16 15:20:36 -07001309repeat:
Mel Gorman2457aec2014-06-04 16:10:31 -07001310 page = find_get_entry(mapping, offset);
1311 if (radix_tree_exceptional_entry(page))
1312 page = NULL;
1313 if (!page)
1314 goto no_page;
1315
1316 if (fgp_flags & FGP_LOCK) {
1317 if (fgp_flags & FGP_NOWAIT) {
1318 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001319 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001320 return NULL;
1321 }
1322 } else {
1323 lock_page(page);
1324 }
1325
1326 /* Has the page been truncated? */
1327 if (unlikely(page->mapping != mapping)) {
1328 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001329 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001330 goto repeat;
1331 }
1332 VM_BUG_ON_PAGE(page->index != offset, page);
1333 }
1334
1335 if (page && (fgp_flags & FGP_ACCESSED))
1336 mark_page_accessed(page);
1337
1338no_page:
1339 if (!page && (fgp_flags & FGP_CREAT)) {
1340 int err;
1341 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001342 gfp_mask |= __GFP_WRITE;
1343 if (fgp_flags & FGP_NOFS)
1344 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001345
Michal Hocko45f87de2014-12-29 20:30:35 +01001346 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001347 if (!page)
1348 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001349
1350 if (WARN_ON_ONCE(!(fgp_flags & FGP_LOCK)))
1351 fgp_flags |= FGP_LOCK;
1352
Hugh Dickinseb39d612014-08-06 16:06:43 -07001353 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001354 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001355 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001356
Matthew Wilcoxf4c86fa2018-04-20 14:56:20 -07001357 err = add_to_page_cache_lru(page, mapping, offset, gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001358 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001359 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001360 page = NULL;
1361 if (err == -EEXIST)
1362 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001365
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 return page;
1367}
Mel Gorman2457aec2014-06-04 16:10:31 -07001368EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
1370/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001371 * find_get_entries - gang pagecache lookup
1372 * @mapping: The address_space to search
1373 * @start: The starting page cache index
1374 * @nr_entries: The maximum number of entries
1375 * @entries: Where the resulting entries are placed
1376 * @indices: The cache indices corresponding to the entries in @entries
1377 *
1378 * find_get_entries() will search for and return a group of up to
1379 * @nr_entries entries in the mapping. The entries are placed at
1380 * @entries. find_get_entries() takes a reference against any actual
1381 * pages it returns.
1382 *
1383 * The search returns a group of mapping-contiguous page cache entries
1384 * with ascending indexes. There may be holes in the indices due to
1385 * not-present pages.
1386 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001387 * Any shadow entries of evicted pages, or swap entries from
1388 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001389 *
1390 * find_get_entries() returns the number of pages and shadow entries
1391 * which were found.
1392 */
1393unsigned find_get_entries(struct address_space *mapping,
1394 pgoff_t start, unsigned int nr_entries,
1395 struct page **entries, pgoff_t *indices)
1396{
1397 void **slot;
1398 unsigned int ret = 0;
1399 struct radix_tree_iter iter;
1400
1401 if (!nr_entries)
1402 return 0;
1403
1404 rcu_read_lock();
Johannes Weiner0cd61442014-04-03 14:47:46 -07001405 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001406 struct page *head, *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001407repeat:
1408 page = radix_tree_deref_slot(slot);
1409 if (unlikely(!page))
1410 continue;
1411 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001412 if (radix_tree_deref_retry(page)) {
1413 slot = radix_tree_iter_retry(&iter);
1414 continue;
1415 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001416 /*
Ross Zwislerf9fe48b2016-01-22 15:10:40 -08001417 * A shadow entry of a recently evicted page, a swap
1418 * entry from shmem/tmpfs or a DAX entry. Return it
1419 * without attempting to raise page count.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001420 */
1421 goto export;
1422 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001423
1424 head = compound_head(page);
1425 if (!page_cache_get_speculative(head))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001426 goto repeat;
1427
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001428 /* The page was split under us? */
1429 if (compound_head(page) != head) {
1430 put_page(head);
1431 goto repeat;
1432 }
1433
Johannes Weiner0cd61442014-04-03 14:47:46 -07001434 /* Has the page moved? */
1435 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001436 put_page(head);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001437 goto repeat;
1438 }
1439export:
1440 indices[ret] = iter.index;
1441 entries[ret] = page;
1442 if (++ret == nr_entries)
1443 break;
1444 }
1445 rcu_read_unlock();
1446 return ret;
1447}
1448
1449/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450 * find_get_pages - gang pagecache lookup
1451 * @mapping: The address_space to search
1452 * @start: The starting page index
1453 * @nr_pages: The maximum number of pages
1454 * @pages: Where the resulting pages are placed
1455 *
1456 * find_get_pages() will search for and return a group of up to
1457 * @nr_pages pages in the mapping. The pages are placed at @pages.
1458 * find_get_pages() takes a reference against the returned pages.
1459 *
1460 * The search returns a group of mapping-contiguous pages with ascending
1461 * indexes. There may be holes in the indices due to not-present pages.
1462 *
1463 * find_get_pages() returns the number of pages which were found.
1464 */
1465unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
1466 unsigned int nr_pages, struct page **pages)
1467{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001468 struct radix_tree_iter iter;
1469 void **slot;
1470 unsigned ret = 0;
1471
1472 if (unlikely(!nr_pages))
1473 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474
Nick Piggina60637c2008-07-25 19:45:31 -07001475 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001476 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001477 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001478repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001479 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001480 if (unlikely(!page))
1481 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001482
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001483 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001484 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001485 slot = radix_tree_iter_retry(&iter);
1486 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001487 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001488 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001489 * A shadow entry of a recently evicted page,
1490 * or a swap entry from shmem/tmpfs. Skip
1491 * over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001492 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001493 continue;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001494 }
Nick Piggina60637c2008-07-25 19:45:31 -07001495
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001496 head = compound_head(page);
1497 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001498 goto repeat;
1499
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001500 /* The page was split under us? */
1501 if (compound_head(page) != head) {
1502 put_page(head);
1503 goto repeat;
1504 }
1505
Nick Piggina60637c2008-07-25 19:45:31 -07001506 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001507 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001508 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001509 goto repeat;
1510 }
1511
1512 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001513 if (++ret == nr_pages)
1514 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001515 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001516
Nick Piggina60637c2008-07-25 19:45:31 -07001517 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 return ret;
1519}
1520
Jens Axboeebf43502006-04-27 08:46:01 +02001521/**
1522 * find_get_pages_contig - gang contiguous pagecache lookup
1523 * @mapping: The address_space to search
1524 * @index: The starting page index
1525 * @nr_pages: The maximum number of pages
1526 * @pages: Where the resulting pages are placed
1527 *
1528 * find_get_pages_contig() works exactly like find_get_pages(), except
1529 * that the returned number of pages are guaranteed to be contiguous.
1530 *
1531 * find_get_pages_contig() returns the number of pages which were found.
1532 */
1533unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1534 unsigned int nr_pages, struct page **pages)
1535{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001536 struct radix_tree_iter iter;
1537 void **slot;
1538 unsigned int ret = 0;
1539
1540 if (unlikely(!nr_pages))
1541 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001542
Nick Piggina60637c2008-07-25 19:45:31 -07001543 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001544 radix_tree_for_each_contig(slot, &mapping->page_tree, &iter, index) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001545 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001546repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001547 page = radix_tree_deref_slot(slot);
1548 /* The hole, there no reason to continue */
Nick Piggina60637c2008-07-25 19:45:31 -07001549 if (unlikely(!page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001550 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001551
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001552 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001553 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001554 slot = radix_tree_iter_retry(&iter);
1555 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001556 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001557 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001558 * A shadow entry of a recently evicted page,
1559 * or a swap entry from shmem/tmpfs. Stop
1560 * looking for contiguous pages.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001561 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001562 break;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001563 }
Nick Piggina60637c2008-07-25 19:45:31 -07001564
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001565 head = compound_head(page);
1566 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001567 goto repeat;
1568
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001569 /* The page was split under us? */
1570 if (compound_head(page) != head) {
1571 put_page(head);
1572 goto repeat;
1573 }
1574
Nick Piggina60637c2008-07-25 19:45:31 -07001575 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001576 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001577 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001578 goto repeat;
1579 }
1580
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001581 /*
1582 * must check mapping and index after taking the ref.
1583 * otherwise we can get both false positives and false
1584 * negatives, which is just confusing to the caller.
1585 */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001586 if (page->mapping == NULL || page_to_pgoff(page) != iter.index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001587 put_page(page);
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001588 break;
1589 }
1590
Nick Piggina60637c2008-07-25 19:45:31 -07001591 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001592 if (++ret == nr_pages)
1593 break;
Jens Axboeebf43502006-04-27 08:46:01 +02001594 }
Nick Piggina60637c2008-07-25 19:45:31 -07001595 rcu_read_unlock();
1596 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001597}
David Howellsef71c152007-05-09 02:33:44 -07001598EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001599
Randy Dunlap485bb992006-06-23 02:03:49 -07001600/**
Jan Karafb296a22017-11-15 17:34:33 -08001601 * find_get_pages_range_tag - find and return pages in given range matching @tag
Randy Dunlap485bb992006-06-23 02:03:49 -07001602 * @mapping: the address_space to search
1603 * @index: the starting page index
Jan Karafb296a22017-11-15 17:34:33 -08001604 * @end: The final page index (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -07001605 * @tag: the tag index
1606 * @nr_pages: the maximum number of pages
1607 * @pages: where the resulting pages are placed
1608 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001610 * @tag. We update @index to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611 */
Jan Karafb296a22017-11-15 17:34:33 -08001612unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
1613 pgoff_t end, int tag, unsigned int nr_pages,
1614 struct page **pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001616 struct radix_tree_iter iter;
1617 void **slot;
1618 unsigned ret = 0;
1619
1620 if (unlikely(!nr_pages))
1621 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622
Nick Piggina60637c2008-07-25 19:45:31 -07001623 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001624 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1625 &iter, *index, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001626 struct page *head, *page;
Jan Karafb296a22017-11-15 17:34:33 -08001627
1628 if (iter.index > end)
1629 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001630repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001631 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001632 if (unlikely(!page))
1633 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001634
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001635 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001636 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001637 slot = radix_tree_iter_retry(&iter);
1638 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001639 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001640 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001641 * A shadow entry of a recently evicted page.
1642 *
1643 * Those entries should never be tagged, but
1644 * this tree walk is lockless and the tags are
1645 * looked up in bulk, one radix tree node at a
1646 * time, so there is a sizable window for page
1647 * reclaim to evict a page we saw tagged.
1648 *
1649 * Skip over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001650 */
Johannes Weiner139b6a62014-05-06 12:50:05 -07001651 continue;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001652 }
Nick Piggina60637c2008-07-25 19:45:31 -07001653
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001654 head = compound_head(page);
1655 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001656 goto repeat;
1657
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001658 /* The page was split under us? */
1659 if (compound_head(page) != head) {
1660 put_page(head);
1661 goto repeat;
1662 }
1663
Nick Piggina60637c2008-07-25 19:45:31 -07001664 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001665 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001666 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001667 goto repeat;
1668 }
1669
1670 pages[ret] = page;
Jan Karafb296a22017-11-15 17:34:33 -08001671 if (++ret == nr_pages) {
1672 *index = pages[ret - 1]->index + 1;
1673 goto out;
1674 }
Nick Piggina60637c2008-07-25 19:45:31 -07001675 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001676
Jan Karafb296a22017-11-15 17:34:33 -08001677 /*
1678 * We come here when we got at @end. We take care to not overflow the
1679 * index @index as it confuses some of the callers. This breaks the
1680 * iteration when there is page at index -1 but that is already broken
1681 * anyway.
1682 */
1683 if (end == (pgoff_t)-1)
1684 *index = (pgoff_t)-1;
1685 else
1686 *index = end + 1;
1687out:
Nick Piggina60637c2008-07-25 19:45:31 -07001688 rcu_read_unlock();
1689
Linus Torvalds1da177e2005-04-16 15:20:36 -07001690 return ret;
1691}
Jan Karafb296a22017-11-15 17:34:33 -08001692EXPORT_SYMBOL(find_get_pages_range_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001693
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001694/**
1695 * find_get_entries_tag - find and return entries that match @tag
1696 * @mapping: the address_space to search
1697 * @start: the starting page cache index
1698 * @tag: the tag index
1699 * @nr_entries: the maximum number of entries
1700 * @entries: where the resulting entries are placed
1701 * @indices: the cache indices corresponding to the entries in @entries
1702 *
1703 * Like find_get_entries, except we only return entries which are tagged with
1704 * @tag.
1705 */
1706unsigned find_get_entries_tag(struct address_space *mapping, pgoff_t start,
1707 int tag, unsigned int nr_entries,
1708 struct page **entries, pgoff_t *indices)
1709{
1710 void **slot;
1711 unsigned int ret = 0;
1712 struct radix_tree_iter iter;
1713
1714 if (!nr_entries)
1715 return 0;
1716
1717 rcu_read_lock();
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001718 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1719 &iter, start, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001720 struct page *head, *page;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001721repeat:
1722 page = radix_tree_deref_slot(slot);
1723 if (unlikely(!page))
1724 continue;
1725 if (radix_tree_exception(page)) {
1726 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001727 slot = radix_tree_iter_retry(&iter);
1728 continue;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001729 }
1730
1731 /*
1732 * A shadow entry of a recently evicted page, a swap
1733 * entry from shmem/tmpfs or a DAX entry. Return it
1734 * without attempting to raise page count.
1735 */
1736 goto export;
1737 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001738
1739 head = compound_head(page);
1740 if (!page_cache_get_speculative(head))
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001741 goto repeat;
1742
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001743 /* The page was split under us? */
1744 if (compound_head(page) != head) {
1745 put_page(head);
1746 goto repeat;
1747 }
1748
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001749 /* Has the page moved? */
1750 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001751 put_page(head);
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001752 goto repeat;
1753 }
1754export:
1755 indices[ret] = iter.index;
1756 entries[ret] = page;
1757 if (++ret == nr_entries)
1758 break;
1759 }
1760 rcu_read_unlock();
1761 return ret;
1762}
1763EXPORT_SYMBOL(find_get_entries_tag);
1764
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001765/*
1766 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1767 * a _large_ part of the i/o request. Imagine the worst scenario:
1768 *
1769 * ---R__________________________________________B__________
1770 * ^ reading here ^ bad block(assume 4k)
1771 *
1772 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1773 * => failing the whole request => read(R) => read(R+1) =>
1774 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1775 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1776 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1777 *
1778 * It is going insane. Fix it by quickly scaling down the readahead size.
1779 */
1780static void shrink_readahead_size_eio(struct file *filp,
1781 struct file_ra_state *ra)
1782{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001783 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001784}
1785
Randy Dunlap485bb992006-06-23 02:03:49 -07001786/**
Christoph Hellwig36e78912008-02-08 04:21:24 -08001787 * do_generic_file_read - generic file read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07001788 * @filp: the file to read
1789 * @ppos: current file position
Al Viro6e58e792014-02-03 17:07:03 -05001790 * @iter: data destination
1791 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001792 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001794 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 *
1796 * This is really ugly. But the goto's actually try to clarify some
1797 * of the logic when it comes to error handling etc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 */
Al Viro6e58e792014-02-03 17:07:03 -05001799static ssize_t do_generic_file_read(struct file *filp, loff_t *ppos,
1800 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801{
Christoph Hellwig36e78912008-02-08 04:21:24 -08001802 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001803 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001804 struct file_ra_state *ra = &filp->f_ra;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001805 pgoff_t index;
1806 pgoff_t last_index;
1807 pgoff_t prev_index;
1808 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07001809 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05001810 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811
Wei Fangc2a97372016-10-07 17:01:52 -07001812 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvalds48466c42016-12-14 12:45:25 -08001813 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07001814 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
1815
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001816 index = *ppos >> PAGE_SHIFT;
1817 prev_index = ra->prev_pos >> PAGE_SHIFT;
1818 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
1819 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
1820 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821
Linus Torvalds1da177e2005-04-16 15:20:36 -07001822 for (;;) {
1823 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001824 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001825 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 unsigned long nr, ret;
1827
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829find_page:
Michal Hockob67c7d32017-02-03 13:13:29 -08001830 if (fatal_signal_pending(current)) {
1831 error = -EINTR;
1832 goto out;
1833 }
1834
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001836 if (!page) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001837 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001838 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001839 index, last_index - index);
1840 page = find_get_page(mapping, index);
1841 if (unlikely(page == NULL))
1842 goto no_cached_page;
1843 }
1844 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001845 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001846 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001847 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001848 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001849 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07001850 /*
1851 * See comment in do_read_cache_page on why
1852 * wait_on_page_locked is used to avoid unnecessarily
1853 * serialisations and why it's safe.
1854 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07001855 error = wait_on_page_locked_killable(page);
1856 if (unlikely(error))
1857 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07001858 if (PageUptodate(page))
1859 goto page_ok;
1860
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001861 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001862 !mapping->a_ops->is_partially_uptodate)
1863 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08001864 /* pipes can't handle partially uptodate pages */
1865 if (unlikely(iter->type & ITER_PIPE))
1866 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02001867 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001868 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08001869 /* Did it get truncated before we got the lock? */
1870 if (!page->mapping)
1871 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001872 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05001873 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001874 goto page_not_up_to_date_locked;
1875 unlock_page(page);
1876 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07001878 /*
1879 * i_size must be checked after we know the page is Uptodate.
1880 *
1881 * Checking i_size after the check allows us to calculate
1882 * the correct value for "nr", which means the zero-filled
1883 * part of the page is not copied back to userspace (unless
1884 * another truncate extends the file - this is desired though).
1885 */
1886
1887 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001888 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001889 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001890 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001891 goto out;
1892 }
1893
1894 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001895 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001896 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001897 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001898 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001899 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001900 goto out;
1901 }
1902 }
1903 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001904
1905 /* If users can be writing to this page using arbitrary
1906 * virtual addresses, take care about potential aliasing
1907 * before reading the page on the kernel side.
1908 */
1909 if (mapping_writably_mapped(mapping))
1910 flush_dcache_page(page);
1911
1912 /*
Jan Karaec0f1632007-05-06 14:49:25 -07001913 * When a sequential read accesses a page several times,
1914 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001915 */
Jan Karaec0f1632007-05-06 14:49:25 -07001916 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 mark_page_accessed(page);
1918 prev_index = index;
1919
1920 /*
1921 * Ok, we have the page, and it's up-to-date, so
1922 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923 */
Al Viro6e58e792014-02-03 17:07:03 -05001924
1925 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001927 index += offset >> PAGE_SHIFT;
1928 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07001929 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001931 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001932 written += ret;
1933 if (!iov_iter_count(iter))
1934 goto out;
1935 if (ret < nr) {
1936 error = -EFAULT;
1937 goto out;
1938 }
1939 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001940
1941page_not_up_to_date:
1942 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04001943 error = lock_page_killable(page);
1944 if (unlikely(error))
1945 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001946
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001947page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07001948 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949 if (!page->mapping) {
1950 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001951 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 continue;
1953 }
1954
1955 /* Did somebody else fill it already? */
1956 if (PageUptodate(page)) {
1957 unlock_page(page);
1958 goto page_ok;
1959 }
1960
1961readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04001962 /*
1963 * A previous I/O error may have been due to temporary
1964 * failures, eg. multipath errors.
1965 * PG_error will be set again if readpage fails.
1966 */
1967 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 /* Start the actual read. The read will unlock the page. */
1969 error = mapping->a_ops->readpage(filp, page);
1970
Zach Brown994fc28c2005-12-15 14:28:17 -08001971 if (unlikely(error)) {
1972 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001973 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001974 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08001975 goto find_page;
1976 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08001978 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
1980 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04001981 error = lock_page_killable(page);
1982 if (unlikely(error))
1983 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001984 if (!PageUptodate(page)) {
1985 if (page->mapping == NULL) {
1986 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01001987 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988 */
1989 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001990 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001991 goto find_page;
1992 }
1993 unlock_page(page);
Fengguang Wu7ff81072007-10-16 01:24:35 -07001994 shrink_readahead_size_eio(filp, ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04001995 error = -EIO;
1996 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 }
1998 unlock_page(page);
1999 }
2000
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 goto page_ok;
2002
2003readpage_error:
2004 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002005 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006 goto out;
2007
2008no_cached_page:
2009 /*
2010 * Ok, it wasn't cached, so we need to create a new
2011 * page..
2012 */
Nick Piggineb2be182007-10-16 01:24:57 -07002013 page = page_cache_alloc_cold(mapping);
2014 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05002015 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07002016 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017 }
Michal Hocko6afdb852015-06-24 16:58:06 -07002018 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08002019 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002021 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05002022 if (error == -EEXIST) {
2023 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002025 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 goto out;
2027 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 goto readpage;
2029 }
2030
2031out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002032 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002033 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002034 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002035
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002036 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002037 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002038 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039}
2040
Randy Dunlap485bb992006-06-23 02:03:49 -07002041/**
Al Viro6abd2322014-04-04 14:20:57 -04002042 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002043 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002044 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002045 *
Al Viro6abd2322014-04-04 14:20:57 -04002046 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002047 * that can use the page cache directly.
2048 */
2049ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002050generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002051{
Al Viroed978a82014-03-05 22:53:04 -05002052 struct file *file = iocb->ki_filp;
2053 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002054 size_t count = iov_iter_count(iter);
2055
2056 if (!count)
2057 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058
Al Viro2ba48ce2015-04-09 13:52:01 -04002059 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viroed978a82014-03-05 22:53:04 -05002060 struct address_space *mapping = file->f_mapping;
2061 struct inode *inode = mapping->host;
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002062 struct iov_iter data = *iter;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002063 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064
Linus Torvalds1da177e2005-04-16 15:20:36 -07002065 size = i_size_read(inode);
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002066 retval = filemap_write_and_wait_range(mapping, iocb->ki_pos,
2067 iocb->ki_pos + count - 1);
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002068 if (retval < 0)
2069 goto out;
Al Viroed978a82014-03-05 22:53:04 -05002070
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002071 file_accessed(file);
2072
2073 retval = mapping->a_ops->direct_IO(iocb, &data);
Al Viroc3a69022016-10-10 13:26:27 -04002074 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002075 iocb->ki_pos += retval;
Al Viroed978a82014-03-05 22:53:04 -05002076 iov_iter_advance(iter, retval);
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002077 }
Josef Bacik66f998f2010-05-23 11:00:54 -04002078
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002079 /*
2080 * Btrfs can have a short DIO read if we encounter
2081 * compressed extents, so if there was an error, or if
2082 * we've already read everything we wanted to, or if
2083 * there was a short read because we hit EOF, go ahead
2084 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002085 * the rest of the read. Buffered reads will not work for
2086 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002087 */
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002088 if (retval < 0 || !iov_iter_count(iter) || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002089 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002090 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 }
2092
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002093 retval = do_generic_file_read(file, &iocb->ki_pos, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094out:
2095 return retval;
2096}
Al Viroed978a82014-03-05 22:53:04 -05002097EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002098
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099#ifdef CONFIG_MMU
Randy Dunlap485bb992006-06-23 02:03:49 -07002100/**
2101 * page_cache_read - adds requested page to the page cache if not already there
2102 * @file: file to read
2103 * @offset: page index
Randy Dunlap62eb3202016-02-11 16:12:58 -08002104 * @gfp_mask: memory allocation flags
Randy Dunlap485bb992006-06-23 02:03:49 -07002105 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 * This adds the requested page to the page cache if it isn't already there,
2107 * and schedules an I/O to read in its contents from disk.
2108 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002109static int page_cache_read(struct file *file, pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002110{
2111 struct address_space *mapping = file->f_mapping;
Paul McQuade99dadfd2014-10-09 15:29:03 -07002112 struct page *page;
Zach Brown994fc28c2005-12-15 14:28:17 -08002113 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114
Zach Brown994fc28c2005-12-15 14:28:17 -08002115 do {
Michal Hockoc20cd452016-01-14 15:20:12 -08002116 page = __page_cache_alloc(gfp_mask|__GFP_COLD);
Zach Brown994fc28c2005-12-15 14:28:17 -08002117 if (!page)
2118 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002119
Matthew Wilcoxf4c86fa2018-04-20 14:56:20 -07002120 ret = add_to_page_cache_lru(page, mapping, offset, gfp_mask);
Zach Brown994fc28c2005-12-15 14:28:17 -08002121 if (ret == 0)
2122 ret = mapping->a_ops->readpage(file, page);
2123 else if (ret == -EEXIST)
2124 ret = 0; /* losing race to add is OK */
2125
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002126 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002127
Zach Brown994fc28c2005-12-15 14:28:17 -08002128 } while (ret == AOP_TRUNCATED_PAGE);
Paul McQuade99dadfd2014-10-09 15:29:03 -07002129
Zach Brown994fc28c2005-12-15 14:28:17 -08002130 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131}
2132
2133#define MMAP_LOTSAMISS (100)
2134
Linus Torvaldsef00e082009-06-16 15:31:25 -07002135/*
2136 * Synchronous readahead happens when we don't even find
2137 * a page in the page cache at all.
2138 */
2139static void do_sync_mmap_readahead(struct vm_area_struct *vma,
2140 struct file_ra_state *ra,
2141 struct file *file,
2142 pgoff_t offset)
2143{
Linus Torvaldsef00e082009-06-16 15:31:25 -07002144 struct address_space *mapping = file->f_mapping;
2145
2146 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002147 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002148 return;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002149 if (!ra->ra_pages)
2150 return;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002151
Joe Perches64363aa2013-07-08 16:00:18 -07002152 if (vma->vm_flags & VM_SEQ_READ) {
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002153 page_cache_sync_readahead(mapping, ra, file, offset,
2154 ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002155 return;
2156 }
2157
Andi Kleen207d04b2011-05-24 17:12:29 -07002158 /* Avoid banging the cache line if not needed */
2159 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002160 ra->mmap_miss++;
2161
2162 /*
2163 * Do we miss much more than hit in this file? If so,
2164 * stop bothering with read-ahead. It will only hurt.
2165 */
2166 if (ra->mmap_miss > MMAP_LOTSAMISS)
2167 return;
2168
Wu Fengguangd30a1102009-06-16 15:31:30 -07002169 /*
2170 * mmap read-around
2171 */
Roman Gushchin600e19a2015-11-05 18:47:08 -08002172 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2173 ra->size = ra->ra_pages;
2174 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002175 ra_submit(ra, mapping, file);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002176}
2177
2178/*
2179 * Asynchronous readahead happens when we find the page and PG_readahead,
2180 * so we want to possibly extend the readahead further..
2181 */
2182static void do_async_mmap_readahead(struct vm_area_struct *vma,
2183 struct file_ra_state *ra,
2184 struct file *file,
2185 struct page *page,
2186 pgoff_t offset)
2187{
2188 struct address_space *mapping = file->f_mapping;
2189
2190 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002191 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002192 return;
2193 if (ra->mmap_miss > 0)
2194 ra->mmap_miss--;
2195 if (PageReadahead(page))
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002196 page_cache_async_readahead(mapping, ra, file,
2197 page, offset, ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002198}
2199
Randy Dunlap485bb992006-06-23 02:03:49 -07002200/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002201 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002202 * @vma: vma in which the fault was taken
2203 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002204 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002205 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002206 * mapped memory region to read in file data during a page fault.
2207 *
2208 * The goto's are kind of ugly, but this streamlines the normal case of having
2209 * it in the page cache, and handles the special cases reasonably without
2210 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002211 *
2212 * vma->vm_mm->mmap_sem must be held on entry.
2213 *
2214 * If our return value has VM_FAULT_RETRY set, it's because
2215 * lock_page_or_retry() returned 0.
2216 * The mmap_sem has usually been released in this case.
2217 * See __lock_page_or_retry() for the exception.
2218 *
2219 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2220 * has not been released.
2221 *
2222 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 */
Nick Piggind0217ac2007-07-19 01:47:03 -07002224int filemap_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002225{
2226 int error;
Nick Piggin54cb8822007-07-19 01:46:59 -07002227 struct file *file = vma->vm_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002228 struct address_space *mapping = file->f_mapping;
2229 struct file_ra_state *ra = &file->f_ra;
2230 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002231 pgoff_t offset = vmf->pgoff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 struct page *page;
Kirill A. Shutemov99e3e532014-04-07 15:37:21 -07002233 loff_t size;
Nick Piggin83c54072007-07-19 01:47:05 -07002234 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002236 size = round_up(i_size_read(inode), PAGE_SIZE);
2237 if (offset >= size >> PAGE_SHIFT)
Linus Torvalds5307cc12007-10-31 09:19:46 -07002238 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002239
Linus Torvalds1da177e2005-04-16 15:20:36 -07002240 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002241 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002242 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002243 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002244 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002246 * We found the page, so try async readahead before
2247 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002248 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002249 do_async_mmap_readahead(vma, ra, file, page, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002250 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002251 /* No page in the page cache at all */
2252 do_sync_mmap_readahead(vma, ra, file, offset);
2253 count_vm_event(PGMAJFAULT);
Ying Han456f9982011-05-26 16:25:38 -07002254 mem_cgroup_count_vm_event(vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002255 ret = VM_FAULT_MAJOR;
2256retry_find:
Michel Lespinasseb522c942010-10-26 14:21:56 -07002257 page = find_get_page(mapping, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 if (!page)
2259 goto no_cached_page;
2260 }
2261
Michel Lespinassed88c0922010-11-02 13:05:18 -07002262 if (!lock_page_or_retry(page, vma->vm_mm, vmf->flags)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002263 put_page(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07002264 return ret | VM_FAULT_RETRY;
Michel Lespinassed88c0922010-11-02 13:05:18 -07002265 }
Michel Lespinasseb522c942010-10-26 14:21:56 -07002266
2267 /* Did it get truncated? */
2268 if (unlikely(page->mapping != mapping)) {
2269 unlock_page(page);
2270 put_page(page);
2271 goto retry_find;
2272 }
Sasha Levin309381fea2014-01-23 15:52:54 -08002273 VM_BUG_ON_PAGE(page->index != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002274
Linus Torvalds1da177e2005-04-16 15:20:36 -07002275 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002276 * We have a locked page in the page cache, now we need to check
2277 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278 */
Nick Piggind00806b2007-07-19 01:46:57 -07002279 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002280 goto page_not_uptodate;
2281
Linus Torvaldsef00e082009-06-16 15:31:25 -07002282 /*
2283 * Found the page and have a reference on it.
2284 * We must recheck i_size under page lock.
2285 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002286 size = round_up(i_size_read(inode), PAGE_SIZE);
2287 if (unlikely(offset >= size >> PAGE_SHIFT)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002288 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002289 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002290 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002291 }
2292
Nick Piggind0217ac2007-07-19 01:47:03 -07002293 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002294 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002295
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296no_cached_page:
2297 /*
2298 * We're only likely to ever get here if MADV_RANDOM is in
2299 * effect.
2300 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002301 error = page_cache_read(file, offset, vmf->gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302
2303 /*
2304 * The page we want has now been added to the page cache.
2305 * In the unlikely event that someone removed it in the
2306 * meantime, we'll just come back here and read it again.
2307 */
2308 if (error >= 0)
2309 goto retry_find;
2310
2311 /*
2312 * An error return from page_cache_read can result if the
2313 * system is low on memory, or a problem occurs while trying
2314 * to schedule I/O.
2315 */
2316 if (error == -ENOMEM)
Nick Piggind0217ac2007-07-19 01:47:03 -07002317 return VM_FAULT_OOM;
2318 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002319
2320page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002321 /*
2322 * Umm, take care of errors if the page isn't up-to-date.
2323 * Try to re-read it _once_. We do this synchronously,
2324 * because there really aren't any performance issues here
2325 * and we need to check for errors.
2326 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002327 ClearPageError(page);
Zach Brown994fc28c2005-12-15 14:28:17 -08002328 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002329 if (!error) {
2330 wait_on_page_locked(page);
2331 if (!PageUptodate(page))
2332 error = -EIO;
2333 }
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002334 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002335
2336 if (!error || error == AOP_TRUNCATED_PAGE)
2337 goto retry_find;
2338
2339 /* Things didn't work out. Return zero to tell the mm layer so. */
2340 shrink_readahead_size_eio(file, ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002341 return VM_FAULT_SIGBUS;
Nick Piggin54cb8822007-07-19 01:46:59 -07002342}
2343EXPORT_SYMBOL(filemap_fault);
2344
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002345void filemap_map_pages(struct fault_env *fe,
2346 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002347{
2348 struct radix_tree_iter iter;
2349 void **slot;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002350 struct file *file = fe->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002351 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002352 pgoff_t last_pgoff = start_pgoff;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002353 loff_t size;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002354 struct page *head, *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002355
2356 rcu_read_lock();
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002357 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter,
2358 start_pgoff) {
2359 if (iter.index > end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002360 break;
2361repeat:
2362 page = radix_tree_deref_slot(slot);
2363 if (unlikely(!page))
2364 goto next;
2365 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07002366 if (radix_tree_deref_retry(page)) {
2367 slot = radix_tree_iter_retry(&iter);
2368 continue;
2369 }
2370 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002371 }
2372
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002373 head = compound_head(page);
2374 if (!page_cache_get_speculative(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002375 goto repeat;
2376
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002377 /* The page was split under us? */
2378 if (compound_head(page) != head) {
2379 put_page(head);
2380 goto repeat;
2381 }
2382
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002383 /* Has the page moved? */
2384 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002385 put_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002386 goto repeat;
2387 }
2388
2389 if (!PageUptodate(page) ||
2390 PageReadahead(page) ||
2391 PageHWPoison(page))
2392 goto skip;
2393 if (!trylock_page(page))
2394 goto skip;
2395
2396 if (page->mapping != mapping || !PageUptodate(page))
2397 goto unlock;
2398
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002399 size = round_up(i_size_read(mapping->host), PAGE_SIZE);
2400 if (page->index >= size >> PAGE_SHIFT)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002401 goto unlock;
2402
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002403 if (file->f_ra.mmap_miss > 0)
2404 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002405
2406 fe->address += (iter.index - last_pgoff) << PAGE_SHIFT;
2407 if (fe->pte)
2408 fe->pte += iter.index - last_pgoff;
2409 last_pgoff = iter.index;
2410 if (alloc_set_pte(fe, NULL, page))
2411 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002412 unlock_page(page);
2413 goto next;
2414unlock:
2415 unlock_page(page);
2416skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002417 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002418next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002419 /* Huge page is mapped? No need to proceed. */
2420 if (pmd_trans_huge(*fe->pmd))
2421 break;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002422 if (iter.index == end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002423 break;
2424 }
2425 rcu_read_unlock();
2426}
2427EXPORT_SYMBOL(filemap_map_pages);
2428
Jan Kara4fcf1c62012-06-12 16:20:29 +02002429int filemap_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
2430{
2431 struct page *page = vmf->page;
Al Viro496ad9a2013-01-23 17:07:38 -05002432 struct inode *inode = file_inode(vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002433 int ret = VM_FAULT_LOCKED;
2434
Jan Kara14da9202012-06-12 16:20:37 +02002435 sb_start_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002436 file_update_time(vma->vm_file);
2437 lock_page(page);
2438 if (page->mapping != inode->i_mapping) {
2439 unlock_page(page);
2440 ret = VM_FAULT_NOPAGE;
2441 goto out;
2442 }
Jan Kara14da9202012-06-12 16:20:37 +02002443 /*
2444 * We mark the page dirty already here so that when freeze is in
2445 * progress, we are guaranteed that writeback during freezing will
2446 * see the dirty page and writeprotect it again.
2447 */
2448 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002449 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002450out:
Jan Kara14da9202012-06-12 16:20:37 +02002451 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002452 return ret;
2453}
2454EXPORT_SYMBOL(filemap_page_mkwrite);
2455
Alexey Dobriyanf0f37e22009-09-27 22:29:37 +04002456const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002457 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002458 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002459 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002460};
2461
2462/* This is used for a general mmap of a disk file */
2463
2464int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2465{
2466 struct address_space *mapping = file->f_mapping;
2467
2468 if (!mapping->a_ops->readpage)
2469 return -ENOEXEC;
2470 file_accessed(file);
2471 vma->vm_ops = &generic_file_vm_ops;
2472 return 0;
2473}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474
2475/*
2476 * This is for filesystems which do not implement ->writepage.
2477 */
2478int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2479{
2480 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2481 return -EINVAL;
2482 return generic_file_mmap(file, vma);
2483}
2484#else
2485int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2486{
2487 return -ENOSYS;
2488}
2489int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2490{
2491 return -ENOSYS;
2492}
2493#endif /* CONFIG_MMU */
2494
2495EXPORT_SYMBOL(generic_file_mmap);
2496EXPORT_SYMBOL(generic_file_readonly_mmap);
2497
Sasha Levin67f9fd92014-04-03 14:48:18 -07002498static struct page *wait_on_page_read(struct page *page)
2499{
2500 if (!IS_ERR(page)) {
2501 wait_on_page_locked(page);
2502 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002503 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002504 page = ERR_PTR(-EIO);
2505 }
2506 }
2507 return page;
2508}
2509
Mel Gorman32b63522016-03-15 14:55:36 -07002510static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002511 pgoff_t index,
Sami Tolvanen4fd840d2017-08-16 14:38:13 -07002512 int (*filler)(struct file *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002513 void *data,
2514 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002515{
Nick Piggineb2be182007-10-16 01:24:57 -07002516 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 int err;
2518repeat:
2519 page = find_get_page(mapping, index);
2520 if (!page) {
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002521 page = __page_cache_alloc(gfp | __GFP_COLD);
Nick Piggineb2be182007-10-16 01:24:57 -07002522 if (!page)
2523 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002524 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002525 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002526 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002527 if (err == -EEXIST)
2528 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002529 /* Presumably ENOMEM for radix tree node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002530 return ERR_PTR(err);
2531 }
Mel Gorman32b63522016-03-15 14:55:36 -07002532
2533filler:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002534 err = filler(data, page);
2535 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002536 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002537 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002538 }
Mel Gorman32b63522016-03-15 14:55:36 -07002539
2540 page = wait_on_page_read(page);
2541 if (IS_ERR(page))
2542 return page;
2543 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002544 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002545 if (PageUptodate(page))
2546 goto out;
2547
Mel Gormanebded022016-03-15 14:55:39 -07002548 /*
2549 * Page is not up to date and may be locked due one of the following
2550 * case a: Page is being filled and the page lock is held
2551 * case b: Read/write error clearing the page uptodate status
2552 * case c: Truncation in progress (page locked)
2553 * case d: Reclaim in progress
2554 *
2555 * Case a, the page will be up to date when the page is unlocked.
2556 * There is no need to serialise on the page lock here as the page
2557 * is pinned so the lock gives no additional protection. Even if the
2558 * the page is truncated, the data is still valid if PageUptodate as
2559 * it's a race vs truncate race.
2560 * Case b, the page will not be up to date
2561 * Case c, the page may be truncated but in itself, the data may still
2562 * be valid after IO completes as it's a read vs truncate race. The
2563 * operation must restart if the page is not uptodate on unlock but
2564 * otherwise serialising on page lock to stabilise the mapping gives
2565 * no additional guarantees to the caller as the page lock is
2566 * released before return.
2567 * Case d, similar to truncation. If reclaim holds the page lock, it
2568 * will be a race with remove_mapping that determines if the mapping
2569 * is valid on unlock but otherwise the data is valid and there is
2570 * no need to serialise with page lock.
2571 *
2572 * As the page lock gives no additional guarantee, we optimistically
2573 * wait on the page to be unlocked and check if it's up to date and
2574 * use the page if it is. Otherwise, the page lock is required to
2575 * distinguish between the different cases. The motivation is that we
2576 * avoid spurious serialisations and wakeups when multiple processes
2577 * wait on the same page for IO to complete.
2578 */
2579 wait_on_page_locked(page);
2580 if (PageUptodate(page))
2581 goto out;
2582
2583 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002584 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002585
2586 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002587 if (!page->mapping) {
2588 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002589 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002590 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002591 }
Mel Gormanebded022016-03-15 14:55:39 -07002592
2593 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 if (PageUptodate(page)) {
2595 unlock_page(page);
2596 goto out;
2597 }
Mel Gorman32b63522016-03-15 14:55:36 -07002598 goto filler;
2599
David Howellsc855ff32007-05-09 13:42:20 +01002600out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002601 mark_page_accessed(page);
2602 return page;
2603}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002604
2605/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002606 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002607 * @mapping: the page's address_space
2608 * @index: the page index
2609 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002610 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002611 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002612 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002613 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002614 *
2615 * If the page does not get brought uptodate, return -EIO.
2616 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002617struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002618 pgoff_t index,
Sami Tolvanen4fd840d2017-08-16 14:38:13 -07002619 int (*filler)(struct file *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002620 void *data)
2621{
2622 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2623}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002624EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002625
2626/**
2627 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2628 * @mapping: the page's address_space
2629 * @index: the page index
2630 * @gfp: the page allocator flags to use if allocating
2631 *
2632 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002633 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002634 *
2635 * If the page does not get brought uptodate, return -EIO.
2636 */
2637struct page *read_cache_page_gfp(struct address_space *mapping,
2638 pgoff_t index,
2639 gfp_t gfp)
2640{
Sami Tolvanen4fd840d2017-08-16 14:38:13 -07002641 filler_t *filler = mapping->a_ops->readpage;
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002642
Sasha Levin67f9fd92014-04-03 14:48:18 -07002643 return do_read_cache_page(mapping, index, filler, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002644}
2645EXPORT_SYMBOL(read_cache_page_gfp);
2646
Nick Piggin2f718ff2007-10-16 01:24:59 -07002647/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 * Performs necessary checks before doing a write
2649 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002650 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 * Returns appropriate error code that caller should return or
2652 * zero in case that write should be allowed.
2653 */
Al Viro3309dd02015-04-09 12:55:47 -04002654inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002655{
Al Viro3309dd02015-04-09 12:55:47 -04002656 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 struct inode *inode = file->f_mapping->host;
Jiri Slaby59e99e52010-03-05 13:41:44 -08002658 unsigned long limit = rlimit(RLIMIT_FSIZE);
Al Viro3309dd02015-04-09 12:55:47 -04002659 loff_t pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002660
Al Viro3309dd02015-04-09 12:55:47 -04002661 if (!iov_iter_count(from))
2662 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002663
Al Viro0fa6b002015-04-04 04:05:48 -04002664 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002665 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002666 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002667
Al Viro3309dd02015-04-09 12:55:47 -04002668 pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669
Al Viro0fa6b002015-04-04 04:05:48 -04002670 if (limit != RLIM_INFINITY) {
Al Viro3309dd02015-04-09 12:55:47 -04002671 if (iocb->ki_pos >= limit) {
Al Viro0fa6b002015-04-04 04:05:48 -04002672 send_sig(SIGXFSZ, current, 0);
2673 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002674 }
Al Viro3309dd02015-04-09 12:55:47 -04002675 iov_iter_truncate(from, limit - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002676 }
2677
2678 /*
2679 * LFS rule
2680 */
Al Viro3309dd02015-04-09 12:55:47 -04002681 if (unlikely(pos + iov_iter_count(from) > MAX_NON_LFS &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002682 !(file->f_flags & O_LARGEFILE))) {
Al Viro3309dd02015-04-09 12:55:47 -04002683 if (pos >= MAX_NON_LFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002684 return -EFBIG;
Al Viro3309dd02015-04-09 12:55:47 -04002685 iov_iter_truncate(from, MAX_NON_LFS - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002686 }
2687
2688 /*
2689 * Are we about to exceed the fs block limit ?
2690 *
2691 * If we have written data it becomes a short write. If we have
2692 * exceeded without writing data we send a signal and return EFBIG.
2693 * Linus frestrict idea will clean these up nicely..
2694 */
Al Viro3309dd02015-04-09 12:55:47 -04002695 if (unlikely(pos >= inode->i_sb->s_maxbytes))
2696 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002697
Al Viro3309dd02015-04-09 12:55:47 -04002698 iov_iter_truncate(from, inode->i_sb->s_maxbytes - pos);
2699 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002700}
2701EXPORT_SYMBOL(generic_write_checks);
2702
Nick Pigginafddba42007-10-16 01:25:01 -07002703int pagecache_write_begin(struct file *file, struct address_space *mapping,
2704 loff_t pos, unsigned len, unsigned flags,
2705 struct page **pagep, void **fsdata)
2706{
2707 const struct address_space_operations *aops = mapping->a_ops;
2708
Nick Piggin4e02ed42008-10-29 14:00:55 -07002709 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002710 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002711}
2712EXPORT_SYMBOL(pagecache_write_begin);
2713
2714int pagecache_write_end(struct file *file, struct address_space *mapping,
2715 loff_t pos, unsigned len, unsigned copied,
2716 struct page *page, void *fsdata)
2717{
2718 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07002719
Nick Piggin4e02ed42008-10-29 14:00:55 -07002720 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002721}
2722EXPORT_SYMBOL(pagecache_write_end);
2723
Linus Torvalds1da177e2005-04-16 15:20:36 -07002724ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002725generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002726{
2727 struct file *file = iocb->ki_filp;
2728 struct address_space *mapping = file->f_mapping;
2729 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002730 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002731 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002732 size_t write_len;
2733 pgoff_t end;
Al Viro26978b82014-03-10 14:08:45 -04002734 struct iov_iter data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002735
Al Viro0c949332014-03-22 06:51:37 -04002736 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002737 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002738
Nick Piggin48b47c52009-01-06 14:40:22 -08002739 written = filemap_write_and_wait_range(mapping, pos, pos + write_len - 1);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002740 if (written)
2741 goto out;
2742
2743 /*
2744 * After a write we want buffered reads to be sure to go to disk to get
2745 * the new data. We invalidate clean cached page from the region we're
2746 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002747 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07002748 */
2749 if (mapping->nrpages) {
2750 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002751 pos >> PAGE_SHIFT, end);
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002752 /*
2753 * If a page can not be invalidated, return 0 to fall back
2754 * to buffered write.
2755 */
2756 if (written) {
2757 if (written == -EBUSY)
2758 return 0;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002759 goto out;
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002760 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002761 }
2762
Al Viro26978b82014-03-10 14:08:45 -04002763 data = *from;
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002764 written = mapping->a_ops->direct_IO(iocb, &data);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002765
2766 /*
2767 * Finally, try again to invalidate clean pages which might have been
2768 * cached by non-direct readahead, or faulted in by get_user_pages()
2769 * if the source of the write was an mmap'ed region of the file
2770 * we're writing. Either one is a pretty crazy thing to do,
2771 * so we don't support it 100%. If this invalidation
2772 * fails, tough, the write still worked...
2773 */
2774 if (mapping->nrpages) {
2775 invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002776 pos >> PAGE_SHIFT, end);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002777 }
2778
Linus Torvalds1da177e2005-04-16 15:20:36 -07002779 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07002780 pos += written;
Al Virof8579f82014-03-03 22:03:20 -05002781 iov_iter_advance(from, written);
Namhyung Kim01166512010-10-26 14:21:58 -07002782 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
2783 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002784 mark_inode_dirty(inode);
2785 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05002786 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002787 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002788out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002789 return written;
2790}
2791EXPORT_SYMBOL(generic_file_direct_write);
2792
Nick Piggineb2be182007-10-16 01:24:57 -07002793/*
2794 * Find or create a page at the given pagecache position. Return the locked
2795 * page. This function is specifically for buffered writes.
2796 */
Nick Piggin54566b22009-01-04 12:00:53 -08002797struct page *grab_cache_page_write_begin(struct address_space *mapping,
2798 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07002799{
Nick Piggineb2be182007-10-16 01:24:57 -07002800 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07002801 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08002802
Nick Piggin54566b22009-01-04 12:00:53 -08002803 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07002804 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07002805
Mel Gorman2457aec2014-06-04 16:10:31 -07002806 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01002807 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07002808 if (page)
2809 wait_for_stable_page(page);
2810
Nick Piggineb2be182007-10-16 01:24:57 -07002811 return page;
2812}
Nick Piggin54566b22009-01-04 12:00:53 -08002813EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07002814
Al Viro3b93f912014-02-11 21:34:08 -05002815ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07002816 struct iov_iter *i, loff_t pos)
2817{
2818 struct address_space *mapping = file->f_mapping;
2819 const struct address_space_operations *a_ops = mapping->a_ops;
2820 long status = 0;
2821 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07002822 unsigned int flags = 0;
2823
2824 /*
2825 * Copies from kernel address space cannot fail (NFSD is a big user).
2826 */
Al Viro777eda22014-12-17 04:46:46 -05002827 if (!iter_is_iovec(i))
Nick Piggin674b8922007-10-16 01:25:03 -07002828 flags |= AOP_FLAG_UNINTERRUPTIBLE;
Nick Pigginafddba42007-10-16 01:25:01 -07002829
2830 do {
2831 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07002832 unsigned long offset; /* Offset into pagecache page */
2833 unsigned long bytes; /* Bytes to write to page */
2834 size_t copied; /* Bytes copied from user */
2835 void *fsdata;
2836
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002837 offset = (pos & (PAGE_SIZE - 1));
2838 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002839 iov_iter_count(i));
2840
2841again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01002842 /*
2843 * Bring in the user page that we will copy from _first_.
2844 * Otherwise there's a nasty deadlock on copying from the
2845 * same page as we're writing to, without it being marked
2846 * up-to-date.
2847 *
2848 * Not only is this an optimisation, but it is also required
2849 * to check that the address is actually valid, when atomic
2850 * usercopies are used, below.
2851 */
2852 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
2853 status = -EFAULT;
2854 break;
2855 }
2856
Jan Kara296291c2015-10-22 13:32:21 -07002857 if (fatal_signal_pending(current)) {
2858 status = -EINTR;
2859 break;
2860 }
2861
Nick Piggin674b8922007-10-16 01:25:03 -07002862 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002863 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07002864 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07002865 break;
2866
anfei zhou931e80e2010-02-02 13:44:02 -08002867 if (mapping_writably_mapped(mapping))
2868 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01002869
Nick Pigginafddba42007-10-16 01:25:01 -07002870 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07002871 flush_dcache_page(page);
2872
2873 status = a_ops->write_end(file, mapping, pos, bytes, copied,
2874 page, fsdata);
2875 if (unlikely(status < 0))
2876 break;
2877 copied = status;
2878
2879 cond_resched();
2880
Nick Piggin124d3b72008-02-02 15:01:17 +01002881 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07002882 if (unlikely(copied == 0)) {
2883 /*
2884 * If we were unable to copy any data at all, we must
2885 * fall back to a single segment length write.
2886 *
2887 * If we didn't fallback here, we could livelock
2888 * because not all segments in the iov can be copied at
2889 * once without a pagefault.
2890 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002891 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002892 iov_iter_single_seg_count(i));
2893 goto again;
2894 }
Nick Pigginafddba42007-10-16 01:25:01 -07002895 pos += copied;
2896 written += copied;
2897
2898 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07002899 } while (iov_iter_count(i));
2900
2901 return written ? written : status;
2902}
Al Viro3b93f912014-02-11 21:34:08 -05002903EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904
Jan Karae4dd9de2009-08-17 18:10:06 +02002905/**
Al Viro81742022014-04-03 03:17:43 -04002906 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02002907 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04002908 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02002909 *
2910 * This function does all the work needed for actually writing data to a
2911 * file. It does all basic checks, removes SUID from the file, updates
2912 * modification times and calls proper subroutines depending on whether we
2913 * do direct IO or a standard buffered write.
2914 *
2915 * It expects i_mutex to be grabbed unless we work on a block device or similar
2916 * object which does not need locking at all.
2917 *
2918 * This function does *not* take care of syncing data in case of O_SYNC write.
2919 * A caller has to handle it. This is mainly due to the fact that we want to
2920 * avoid syncing under i_mutex.
2921 */
Al Viro81742022014-04-03 03:17:43 -04002922ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002923{
2924 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002925 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002926 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05002927 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002928 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05002929 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002930
Linus Torvalds1da177e2005-04-16 15:20:36 -07002931 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01002932 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002933 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002934 if (err)
2935 goto out;
2936
Josef Bacikc3b2da32012-03-26 09:59:21 -04002937 err = file_update_time(file);
2938 if (err)
2939 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002940
Al Viro2ba48ce2015-04-09 13:52:01 -04002941 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04002942 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002943
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002944 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002945 /*
2946 * If the write stopped short of completing, fall back to
2947 * buffered writes. Some filesystems do this for writes to
2948 * holes, for example. For DAX files, a buffered write will
2949 * not succeed (even if it did, DAX does not handle dirty
2950 * page-cache pages correctly).
2951 */
Al Viro0b8def92015-04-07 10:22:53 -04002952 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002953 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05002954
Al Viro0b8def92015-04-07 10:22:53 -04002955 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002956 /*
Al Viro3b93f912014-02-11 21:34:08 -05002957 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002958 * then we want to return the number of bytes which were
2959 * direct-written, or the error code if that was zero. Note
2960 * that this differs from normal direct-io semantics, which
2961 * will return -EFOO even if some bytes were written.
2962 */
Al Viro60bb4522014-08-08 12:39:16 -04002963 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05002964 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002965 goto out;
2966 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002967 /*
2968 * We need to ensure that the page cache pages are written to
2969 * disk and invalidated to preserve the expected O_DIRECT
2970 * semantics.
2971 */
Al Viro3b93f912014-02-11 21:34:08 -05002972 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04002973 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002974 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04002975 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05002976 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002977 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002978 pos >> PAGE_SHIFT,
2979 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002980 } else {
2981 /*
2982 * We don't know how much we wrote, so just return
2983 * the number of bytes which were direct-written
2984 */
2985 }
2986 } else {
Al Viro0b8def92015-04-07 10:22:53 -04002987 written = generic_perform_write(file, from, iocb->ki_pos);
2988 if (likely(written > 0))
2989 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002990 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002991out:
2992 current->backing_dev_info = NULL;
2993 return written ? written : err;
2994}
Al Viro81742022014-04-03 03:17:43 -04002995EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002996
Jan Karae4dd9de2009-08-17 18:10:06 +02002997/**
Al Viro81742022014-04-03 03:17:43 -04002998 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02002999 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04003000 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02003001 *
Al Viro81742022014-04-03 03:17:43 -04003002 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02003003 * filesystems. It takes care of syncing the file in case of O_SYNC file
3004 * and acquires i_mutex as needed.
3005 */
Al Viro81742022014-04-03 03:17:43 -04003006ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003007{
3008 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02003009 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003010 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003011
Al Viro59551022016-01-22 15:40:57 -05003012 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04003013 ret = generic_write_checks(iocb, from);
3014 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04003015 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05003016 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003017
Christoph Hellwige2592212016-04-07 08:52:01 -07003018 if (ret > 0)
3019 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003020 return ret;
3021}
Al Viro81742022014-04-03 03:17:43 -04003022EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003023
David Howellscf9a2ae2006-08-29 19:05:54 +01003024/**
3025 * try_to_release_page() - release old fs-specific metadata on a page
3026 *
3027 * @page: the page which the kernel is trying to free
3028 * @gfp_mask: memory allocation flags (and I/O mode)
3029 *
3030 * The address_space is to try to release any data against the page
3031 * (presumably at page->private). If the release was successful, return `1'.
3032 * Otherwise return zero.
3033 *
David Howells266cf652009-04-03 16:42:36 +01003034 * This may also be called if PG_fscache is set on a page, indicating that the
3035 * page is known to the local caching routines.
3036 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003037 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003038 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003039 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003040 */
3041int try_to_release_page(struct page *page, gfp_t gfp_mask)
3042{
3043 struct address_space * const mapping = page->mapping;
3044
3045 BUG_ON(!PageLocked(page));
3046 if (PageWriteback(page))
3047 return 0;
3048
3049 if (mapping && mapping->a_ops->releasepage)
3050 return mapping->a_ops->releasepage(page, gfp_mask);
3051 return try_to_free_buffers(page);
3052}
3053
3054EXPORT_SYMBOL(try_to_release_page);