blob: 1944c631e3e660d6d06d72e8b23096d44d0183ea [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;
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700135 } else {
136 /* DAX can replace empty locked entry with a hole */
137 WARN_ON_ONCE(p !=
Ross Zwisler642261a2016-11-08 11:34:45 +1100138 dax_radix_locked_entry(0, RADIX_DAX_EMPTY));
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700139 /* Wakeup waiters for exceptional entry lock */
Ross Zwisler63e95b52016-11-08 11:32:20 +1100140 dax_wake_mapping_entry_waiter(mapping, page->index, p,
Ross Zwisler965d0042017-01-10 16:57:15 -0800141 true);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700142 }
143 }
Johannes Weiner14b46872016-12-12 16:43:52 -0800144 __radix_tree_replace(&mapping->page_tree, node, slot, page,
145 workingset_update_node, mapping);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700146 mapping->nrpages++;
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700147 return 0;
148}
149
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700150static void page_cache_tree_delete(struct address_space *mapping,
151 struct page *page, void *shadow)
152{
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800153 int i, nr;
154
155 /* hugetlb pages are represented by one entry in the radix tree */
156 nr = PageHuge(page) ? 1 : hpage_nr_pages(page);
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700157
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700158 VM_BUG_ON_PAGE(!PageLocked(page), page);
159 VM_BUG_ON_PAGE(PageTail(page), page);
160 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700161
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700162 for (i = 0; i < nr; i++) {
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200163 struct radix_tree_node *node;
164 void **slot;
165
166 __radix_tree_lookup(&mapping->page_tree, page->index + i,
167 &node, &slot);
168
Johannes Weinerdbc446b2016-12-12 16:43:55 -0800169 VM_BUG_ON_PAGE(!node && nr != 1, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700170
Johannes Weiner14b46872016-12-12 16:43:52 -0800171 radix_tree_clear_tags(&mapping->page_tree, node, slot);
172 __radix_tree_replace(&mapping->page_tree, node, slot, shadow,
173 workingset_update_node, mapping);
Johannes Weiner449dd692014-04-03 14:47:56 -0700174 }
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200175
176 if (shadow) {
177 mapping->nrexceptional += nr;
178 /*
179 * Make sure the nrexceptional update is committed before
180 * the nrpages update so that final truncate racing
181 * with reclaim does not see both counters 0 at the
182 * same time and miss a shadow entry.
183 */
184 smp_wmb();
185 }
186 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700187}
188
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189/*
Minchan Kime64a7822011-03-22 16:32:44 -0700190 * Delete a page from the page cache and free it. Caller has to make
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 * sure the page is locked and that nobody else uses it - or that usage
Johannes Weinerfdf1cdb2016-03-15 14:57:25 -0700192 * is safe. The caller must hold the mapping's tree_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 */
Johannes Weiner62cccb82016-03-15 14:57:22 -0700194void __delete_from_page_cache(struct page *page, void *shadow)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195{
196 struct address_space *mapping = page->mapping;
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700197 int nr = hpage_nr_pages(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -0700199 trace_mm_filemap_delete_from_page_cache(page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600200 /*
201 * if we're uptodate, flush out into the cleancache, otherwise
202 * invalidate any existing cleancache entries. We can't leave
203 * stale data around in the cleancache once our page is gone
204 */
205 if (PageUptodate(page) && PageMappedToDisk(page))
206 cleancache_put_page(page);
207 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400208 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600209
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700210 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800211 VM_BUG_ON_PAGE(page_mapped(page), page);
212 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
213 int mapcount;
214
215 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
216 current->comm, page_to_pfn(page));
217 dump_page(page, "still mapped when deleted");
218 dump_stack();
219 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
220
221 mapcount = page_mapcount(page);
222 if (mapping_exiting(mapping) &&
223 page_count(page) >= mapcount + 2) {
224 /*
225 * All vmas have already been torn down, so it's
226 * a good bet that actually the page is unmapped,
227 * and we'd prefer not to leak it: if we're wrong,
228 * some other bad page check should catch it later.
229 */
230 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700231 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800232 }
233 }
234
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700235 page_cache_tree_delete(mapping, page, shadow);
236
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 page->mapping = NULL;
Hugh Dickinsb85e0ef2011-07-25 17:12:25 -0700238 /* Leave page->index set: truncation lookup relies upon it */
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700239
Michal Hocko4165b9b42015-06-24 16:57:24 -0700240 /* hugetlb pages do not participate in page cache accounting. */
241 if (!PageHuge(page))
Mel Gorman11fb9982016-07-28 15:46:20 -0700242 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700243 if (PageSwapBacked(page)) {
Mel Gorman11fb9982016-07-28 15:46:20 -0700244 __mod_node_page_state(page_pgdat(page), NR_SHMEM, -nr);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700245 if (PageTransHuge(page))
Mel Gorman11fb9982016-07-28 15:46:20 -0700246 __dec_node_page_state(page, NR_SHMEM_THPS);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700247 } else {
248 VM_BUG_ON_PAGE(PageTransHuge(page) && !PageHuge(page), page);
249 }
Linus Torvalds3a692792007-12-19 14:05:13 -0800250
251 /*
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700252 * At this point page must be either written or cleaned by truncate.
253 * Dirty page here signals a bug and loss of unwritten data.
Linus Torvalds3a692792007-12-19 14:05:13 -0800254 *
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700255 * This fixes dirty accounting after removing the page entirely but
256 * leaves PageDirty set: it has no effect for truncated page and
257 * anyway will be cleared before returning page into buddy allocator.
Linus Torvalds3a692792007-12-19 14:05:13 -0800258 */
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700259 if (WARN_ON_ONCE(PageDirty(page)))
Johannes Weiner62cccb82016-03-15 14:57:22 -0700260 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261}
262
Minchan Kim702cfbf2011-03-22 16:32:43 -0700263/**
264 * delete_from_page_cache - delete page from page cache
265 * @page: the page which the kernel is trying to remove from page cache
266 *
267 * This must be called only on pages that have been verified to be in the page
268 * cache and locked. It will never put the page into the free list, the caller
269 * has a reference on the page.
270 */
271void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700273 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400274 unsigned long flags;
Linus Torvalds6072d132010-12-01 13:35:19 -0500275 void (*freepage)(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Matt Mackallcd7619d2005-05-01 08:59:01 -0700277 BUG_ON(!PageLocked(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278
Linus Torvalds6072d132010-12-01 13:35:19 -0500279 freepage = mapping->a_ops->freepage;
Greg Thelenc4843a72015-05-22 17:13:16 -0400280
Greg Thelenc4843a72015-05-22 17:13:16 -0400281 spin_lock_irqsave(&mapping->tree_lock, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700282 __delete_from_page_cache(page, NULL);
Greg Thelenc4843a72015-05-22 17:13:16 -0400283 spin_unlock_irqrestore(&mapping->tree_lock, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500284
285 if (freepage)
286 freepage(page);
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700287
288 if (PageTransHuge(page) && !PageHuge(page)) {
289 page_ref_sub(page, HPAGE_PMD_NR);
290 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
291 } else {
292 put_page(page);
293 }
Minchan Kim97cecb52011-03-22 16:30:53 -0700294}
295EXPORT_SYMBOL(delete_from_page_cache);
296
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200297int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700298{
299 int ret = 0;
300 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700301 if (test_bit(AS_ENOSPC, &mapping->flags) &&
302 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700303 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700304 if (test_bit(AS_EIO, &mapping->flags) &&
305 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700306 ret = -EIO;
307 return ret;
308}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200309EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700312 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700313 * @mapping: address space structure to write
314 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800315 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700316 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700318 * Start writeback against all of a mapping's dirty pages that lie
319 * within the byte offsets <start, end> inclusive.
320 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700322 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 * these two operations is that if a dirty page/buffer is encountered, it must
324 * be waited upon, and not just skipped over.
325 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800326int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
327 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328{
329 int ret;
330 struct writeback_control wbc = {
331 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800332 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700333 .range_start = start,
334 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 };
336
337 if (!mapping_cap_writeback_dirty(mapping))
338 return 0;
339
Tejun Heob16b1de2015-06-02 08:39:48 -0600340 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600342 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 return ret;
344}
345
346static inline int __filemap_fdatawrite(struct address_space *mapping,
347 int sync_mode)
348{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700349 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350}
351
352int filemap_fdatawrite(struct address_space *mapping)
353{
354 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
355}
356EXPORT_SYMBOL(filemap_fdatawrite);
357
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400358int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800359 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360{
361 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
362}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400363EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Randy Dunlap485bb992006-06-23 02:03:49 -0700365/**
366 * filemap_flush - mostly a non-blocking flush
367 * @mapping: target address_space
368 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 * This is a mostly non-blocking flush. Not suitable for data-integrity
370 * purposes - I/O may not be started against all dirty pages.
371 */
372int filemap_flush(struct address_space *mapping)
373{
374 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
375}
376EXPORT_SYMBOL(filemap_flush);
377
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800378static int __filemap_fdatawait_range(struct address_space *mapping,
379 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300381 pgoff_t index = start_byte >> PAGE_SHIFT;
382 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 struct pagevec pvec;
384 int nr_pages;
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800385 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200387 if (end_byte < start_byte)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700388 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
390 pagevec_init(&pvec, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 while ((index <= end) &&
392 (nr_pages = pagevec_lookup_tag(&pvec, mapping, &index,
393 PAGECACHE_TAG_WRITEBACK,
394 min(end - index, (pgoff_t)PAGEVEC_SIZE-1) + 1)) != 0) {
395 unsigned i;
396
397 for (i = 0; i < nr_pages; i++) {
398 struct page *page = pvec.pages[i];
399
400 /* until radix tree lookup accepts end_index */
401 if (page->index > end)
402 continue;
403
404 wait_on_page_writeback(page);
Rik van Riel212260a2011-01-13 15:46:06 -0800405 if (TestClearPageError(page))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 ret = -EIO;
407 }
408 pagevec_release(&pvec);
409 cond_resched();
410 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700411out:
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800412 return ret;
413}
414
415/**
416 * filemap_fdatawait_range - wait for writeback to complete
417 * @mapping: address space structure to wait for
418 * @start_byte: offset in bytes where the range starts
419 * @end_byte: offset in bytes where the range ends (inclusive)
420 *
421 * Walk the list of under-writeback pages of the given address space
422 * in the given range and wait for all of them. Check error status of
423 * the address space and return it.
424 *
425 * Since the error status of the address space is cleared by this function,
426 * callers are responsible for checking the return value and handling and/or
427 * reporting the error.
428 */
429int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
430 loff_t end_byte)
431{
432 int ret, ret2;
433
434 ret = __filemap_fdatawait_range(mapping, start_byte, end_byte);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700435 ret2 = filemap_check_errors(mapping);
436 if (!ret)
437 ret = ret2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
439 return ret;
440}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200441EXPORT_SYMBOL(filemap_fdatawait_range);
442
443/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800444 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
445 * @mapping: address space structure to wait for
446 *
447 * Walk the list of under-writeback pages of the given address space
448 * and wait for all of them. Unlike filemap_fdatawait(), this function
449 * does not clear error status of the address space.
450 *
451 * Use this function if callers don't handle errors themselves. Expected
452 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
453 * fsfreeze(8)
454 */
455void filemap_fdatawait_keep_errors(struct address_space *mapping)
456{
457 loff_t i_size = i_size_read(mapping->host);
458
459 if (i_size == 0)
460 return;
461
462 __filemap_fdatawait_range(mapping, 0, i_size - 1);
463}
464
465/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700466 * filemap_fdatawait - wait for all under-writeback pages to complete
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 * @mapping: address space structure to wait for
Randy Dunlap485bb992006-06-23 02:03:49 -0700468 *
469 * Walk the list of under-writeback pages of the given address space
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800470 * and wait for all of them. Check error status of the address space
471 * and return it.
472 *
473 * Since the error status of the address space is cleared by this function,
474 * callers are responsible for checking the return value and handling and/or
475 * reporting the error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 */
477int filemap_fdatawait(struct address_space *mapping)
478{
479 loff_t i_size = i_size_read(mapping->host);
480
481 if (i_size == 0)
482 return 0;
483
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200484 return filemap_fdatawait_range(mapping, 0, i_size - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485}
486EXPORT_SYMBOL(filemap_fdatawait);
487
488int filemap_write_and_wait(struct address_space *mapping)
489{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800490 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
Ross Zwisler7f6d5b52016-02-26 15:19:55 -0800492 if ((!dax_mapping(mapping) && mapping->nrpages) ||
493 (dax_mapping(mapping) && mapping->nrexceptional)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800494 err = filemap_fdatawrite(mapping);
495 /*
496 * Even if the above returned error, the pages may be
497 * written partially (e.g. -ENOSPC), so we wait for it.
498 * But the -EIO is special case, it may indicate the worst
499 * thing (e.g. bug) happened, so we avoid waiting for it.
500 */
501 if (err != -EIO) {
502 int err2 = filemap_fdatawait(mapping);
503 if (!err)
504 err = err2;
505 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700506 } else {
507 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800509 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510}
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800511EXPORT_SYMBOL(filemap_write_and_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Randy Dunlap485bb992006-06-23 02:03:49 -0700513/**
514 * filemap_write_and_wait_range - write out & wait on a file range
515 * @mapping: the address_space for the pages
516 * @lstart: offset in bytes where the range starts
517 * @lend: offset in bytes where the range ends (inclusive)
518 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800519 * Write out and wait upon file offsets lstart->lend, inclusive.
520 *
521 * Note that `lend' is inclusive (describes the last byte to be written) so
522 * that this function can be used to write to the very end-of-file (end = -1).
523 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524int filemap_write_and_wait_range(struct address_space *mapping,
525 loff_t lstart, loff_t lend)
526{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800527 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Ross Zwisler7f6d5b52016-02-26 15:19:55 -0800529 if ((!dax_mapping(mapping) && mapping->nrpages) ||
530 (dax_mapping(mapping) && mapping->nrexceptional)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800531 err = __filemap_fdatawrite_range(mapping, lstart, lend,
532 WB_SYNC_ALL);
533 /* See comment of filemap_write_and_wait() */
534 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200535 int err2 = filemap_fdatawait_range(mapping,
536 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800537 if (!err)
538 err = err2;
539 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700540 } else {
541 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800543 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544}
Chris Masonf6995582009-04-15 13:22:37 -0400545EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Randy Dunlap485bb992006-06-23 02:03:49 -0700547/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700548 * replace_page_cache_page - replace a pagecache page with a new one
549 * @old: page to be replaced
550 * @new: page to replace with
551 * @gfp_mask: allocation mode
552 *
553 * This function replaces a page in the pagecache with a new one. On
554 * success it acquires the pagecache reference for the new page and
555 * drops it for the old page. Both the old and new pages must be
556 * locked. This function does not add the new page to the LRU, the
557 * caller must do that.
558 *
559 * The remove + add is atomic. The only way this function can fail is
560 * memory allocation failure.
561 */
562int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
563{
564 int error;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700565
Sasha Levin309381fea2014-01-23 15:52:54 -0800566 VM_BUG_ON_PAGE(!PageLocked(old), old);
567 VM_BUG_ON_PAGE(!PageLocked(new), new);
568 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700569
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700570 error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
571 if (!error) {
572 struct address_space *mapping = old->mapping;
573 void (*freepage)(struct page *);
Greg Thelenc4843a72015-05-22 17:13:16 -0400574 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700575
576 pgoff_t offset = old->index;
577 freepage = mapping->a_ops->freepage;
578
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300579 get_page(new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700580 new->mapping = mapping;
581 new->index = offset;
582
Greg Thelenc4843a72015-05-22 17:13:16 -0400583 spin_lock_irqsave(&mapping->tree_lock, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700584 __delete_from_page_cache(old, NULL);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700585 error = page_cache_tree_insert(mapping, new, NULL);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700586 BUG_ON(error);
Michal Hocko4165b9b42015-06-24 16:57:24 -0700587
588 /*
589 * hugetlb pages do not participate in page cache accounting.
590 */
591 if (!PageHuge(new))
Mel Gorman11fb9982016-07-28 15:46:20 -0700592 __inc_node_page_state(new, NR_FILE_PAGES);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700593 if (PageSwapBacked(new))
Mel Gorman11fb9982016-07-28 15:46:20 -0700594 __inc_node_page_state(new, NR_SHMEM);
Greg Thelenc4843a72015-05-22 17:13:16 -0400595 spin_unlock_irqrestore(&mapping->tree_lock, flags);
Johannes Weiner6a93ca82016-03-15 14:57:19 -0700596 mem_cgroup_migrate(old, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700597 radix_tree_preload_end();
598 if (freepage)
599 freepage(old);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300600 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700601 }
602
603 return error;
604}
605EXPORT_SYMBOL_GPL(replace_page_cache_page);
606
Johannes Weinera5289102014-04-03 14:47:51 -0700607static int __add_to_page_cache_locked(struct page *page,
608 struct address_space *mapping,
609 pgoff_t offset, gfp_t gfp_mask,
610 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611{
Johannes Weiner00501b52014-08-08 14:19:20 -0700612 int huge = PageHuge(page);
613 struct mem_cgroup *memcg;
Nick Piggine2867812008-07-25 19:45:30 -0700614 int error;
615
Sasha Levin309381fea2014-01-23 15:52:54 -0800616 VM_BUG_ON_PAGE(!PageLocked(page), page);
617 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Nick Piggine2867812008-07-25 19:45:30 -0700618
Johannes Weiner00501b52014-08-08 14:19:20 -0700619 if (!huge) {
620 error = mem_cgroup_try_charge(page, current->mm,
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800621 gfp_mask, &memcg, false);
Johannes Weiner00501b52014-08-08 14:19:20 -0700622 if (error)
623 return error;
624 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
Jan Kara5e4c0d972013-09-11 14:26:05 -0700626 error = radix_tree_maybe_preload(gfp_mask & ~__GFP_HIGHMEM);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700627 if (error) {
Johannes Weiner00501b52014-08-08 14:19:20 -0700628 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800629 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700630 return error;
631 }
632
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300633 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700634 page->mapping = mapping;
635 page->index = offset;
636
637 spin_lock_irq(&mapping->tree_lock);
Johannes Weinera5289102014-04-03 14:47:51 -0700638 error = page_cache_tree_insert(mapping, page, shadowp);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700639 radix_tree_preload_end();
640 if (unlikely(error))
641 goto err_insert;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700642
643 /* hugetlb pages do not participate in page cache accounting. */
644 if (!huge)
Mel Gorman11fb9982016-07-28 15:46:20 -0700645 __inc_node_page_state(page, NR_FILE_PAGES);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700646 spin_unlock_irq(&mapping->tree_lock);
Johannes Weiner00501b52014-08-08 14:19:20 -0700647 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800648 mem_cgroup_commit_charge(page, memcg, false, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700649 trace_mm_filemap_add_to_page_cache(page);
650 return 0;
651err_insert:
652 page->mapping = NULL;
653 /* Leave page->index set: truncation relies upon it */
654 spin_unlock_irq(&mapping->tree_lock);
Johannes Weiner00501b52014-08-08 14:19:20 -0700655 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800656 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300657 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 return error;
659}
Johannes Weinera5289102014-04-03 14:47:51 -0700660
661/**
662 * add_to_page_cache_locked - add a locked page to the pagecache
663 * @page: page to add
664 * @mapping: the page's address_space
665 * @offset: page index
666 * @gfp_mask: page allocation mode
667 *
668 * This function is used to add a page to the pagecache. It must be locked.
669 * This function does not add the page to the LRU. The caller must do that.
670 */
671int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
672 pgoff_t offset, gfp_t gfp_mask)
673{
674 return __add_to_page_cache_locked(page, mapping, offset,
675 gfp_mask, NULL);
676}
Nick Piggine2867812008-07-25 19:45:30 -0700677EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678
679int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400680 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681{
Johannes Weinera5289102014-04-03 14:47:51 -0700682 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700683 int ret;
684
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800685 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700686 ret = __add_to_page_cache_locked(page, mapping, offset,
687 gfp_mask, &shadow);
688 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800689 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700690 else {
691 /*
692 * The page might have been evicted from cache only
693 * recently, in which case it should be activated like
694 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700695 * The exception is pages getting rewritten; evicting other
696 * data from the working set, only to cache data that will
697 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700698 */
Rik van Rielf0281a02016-05-20 16:56:25 -0700699 if (!(gfp_mask & __GFP_WRITE) &&
700 shadow && workingset_refault(shadow)) {
Johannes Weinera5289102014-04-03 14:47:51 -0700701 SetPageActive(page);
702 workingset_activation(page);
703 } else
704 ClearPageActive(page);
705 lru_cache_add(page);
706 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707 return ret;
708}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300709EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Paul Jackson44110fe2006-03-24 03:16:04 -0800711#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700712struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800713{
Miao Xiec0ff7452010-05-24 14:32:08 -0700714 int n;
715 struct page *page;
716
Paul Jackson44110fe2006-03-24 03:16:04 -0800717 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700718 unsigned int cpuset_mems_cookie;
719 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700720 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700721 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700722 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700723 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700724
Miao Xiec0ff7452010-05-24 14:32:08 -0700725 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800726 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700727 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800728}
Nick Piggin2ae88142006-10-28 10:38:23 -0700729EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800730#endif
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732/*
733 * In order to wait for pages to become available there must be
734 * waitqueues associated with pages. By using a hash table of
735 * waitqueues where the bucket discipline is to maintain all
736 * waiters on the same queue and wake all when any of the pages
737 * become available, and for the woken contexts to check to be
738 * sure the appropriate page became available, this saves space
739 * at a cost of "thundering herd" phenomena during rare hash
740 * collisions.
741 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000742#define PAGE_WAIT_TABLE_BITS 8
743#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
744static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
745
746static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
Nicholas Piggin62906022016-12-25 13:00:30 +1000748 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749}
Nicholas Piggin62906022016-12-25 13:00:30 +1000750
751void __init pagecache_init(void)
752{
753 int i;
754
755 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
756 init_waitqueue_head(&page_wait_table[i]);
757
758 page_writeback_init();
759}
760
761struct wait_page_key {
762 struct page *page;
763 int bit_nr;
764 int page_match;
765};
766
767struct wait_page_queue {
768 struct page *page;
769 int bit_nr;
770 wait_queue_t wait;
771};
772
773static int wake_page_function(wait_queue_t *wait, unsigned mode, int sync, void *arg)
774{
775 struct wait_page_key *key = arg;
776 struct wait_page_queue *wait_page
777 = container_of(wait, struct wait_page_queue, wait);
778
779 if (wait_page->page != key->page)
780 return 0;
781 key->page_match = 1;
782
783 if (wait_page->bit_nr != key->bit_nr)
784 return 0;
785 if (test_bit(key->bit_nr, &key->page->flags))
786 return 0;
787
788 return autoremove_wake_function(wait, mode, sync, key);
789}
790
Nicholas Piggin74d81bf2017-02-22 15:44:41 -0800791static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +1000792{
793 wait_queue_head_t *q = page_waitqueue(page);
794 struct wait_page_key key;
795 unsigned long flags;
796
797 key.page = page;
798 key.bit_nr = bit_nr;
799 key.page_match = 0;
800
801 spin_lock_irqsave(&q->lock, flags);
802 __wake_up_locked_key(q, TASK_NORMAL, &key);
803 /*
804 * It is possible for other pages to have collided on the waitqueue
805 * hash, so in that case check for a page match. That prevents a long-
806 * term waiter
807 *
808 * It is still possible to miss a case here, when we woke page waiters
809 * and removed them from the waitqueue, but there are still other
810 * page waiters.
811 */
812 if (!waitqueue_active(q) || !key.page_match) {
813 ClearPageWaiters(page);
814 /*
815 * It's possible to miss clearing Waiters here, when we woke
816 * our page waiters, but the hashed waitqueue has waiters for
817 * other pages on it.
818 *
819 * That's okay, it's a rare case. The next waker will clear it.
820 */
821 }
822 spin_unlock_irqrestore(&q->lock, flags);
823}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -0800824
825static void wake_up_page(struct page *page, int bit)
826{
827 if (!PageWaiters(page))
828 return;
829 wake_up_page_bit(page, bit);
830}
Nicholas Piggin62906022016-12-25 13:00:30 +1000831
832static inline int wait_on_page_bit_common(wait_queue_head_t *q,
833 struct page *page, int bit_nr, int state, bool lock)
834{
835 struct wait_page_queue wait_page;
836 wait_queue_t *wait = &wait_page.wait;
837 int ret = 0;
838
839 init_wait(wait);
840 wait->func = wake_page_function;
841 wait_page.page = page;
842 wait_page.bit_nr = bit_nr;
843
844 for (;;) {
845 spin_lock_irq(&q->lock);
846
847 if (likely(list_empty(&wait->task_list))) {
848 if (lock)
849 __add_wait_queue_tail_exclusive(q, wait);
850 else
851 __add_wait_queue(q, wait);
852 SetPageWaiters(page);
853 }
854
855 set_current_state(state);
856
857 spin_unlock_irq(&q->lock);
858
859 if (likely(test_bit(bit_nr, &page->flags))) {
860 io_schedule();
861 if (unlikely(signal_pending_state(state, current))) {
862 ret = -EINTR;
863 break;
864 }
865 }
866
867 if (lock) {
868 if (!test_and_set_bit_lock(bit_nr, &page->flags))
869 break;
870 } else {
871 if (!test_bit(bit_nr, &page->flags))
872 break;
873 }
874 }
875
876 finish_wait(q, wait);
877
878 /*
879 * A signal could leave PageWaiters set. Clearing it here if
880 * !waitqueue_active would be possible (by open-coding finish_wait),
881 * but still fail to catch it in the case of wait hash collision. We
882 * already can fail to clear wait hash collision cases, so don't
883 * bother with signals either.
884 */
885
886 return ret;
887}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Harvey Harrison920c7a52008-02-04 22:29:26 -0800889void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890{
Nicholas Piggin62906022016-12-25 13:00:30 +1000891 wait_queue_head_t *q = page_waitqueue(page);
892 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893}
894EXPORT_SYMBOL(wait_on_page_bit);
895
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700896int wait_on_page_bit_killable(struct page *page, int bit_nr)
897{
Nicholas Piggin62906022016-12-25 13:00:30 +1000898 wait_queue_head_t *q = page_waitqueue(page);
899 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, false);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700900}
901
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902/**
David Howells385e1ca5f2009-04-03 16:42:39 +0100903 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -0700904 * @page: Page defining the wait queue of interest
905 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +0100906 *
907 * Add an arbitrary @waiter to the wait queue for the nominated @page.
908 */
909void add_page_wait_queue(struct page *page, wait_queue_t *waiter)
910{
911 wait_queue_head_t *q = page_waitqueue(page);
912 unsigned long flags;
913
914 spin_lock_irqsave(&q->lock, flags);
915 __add_wait_queue(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +1000916 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +0100917 spin_unlock_irqrestore(&q->lock, flags);
918}
919EXPORT_SYMBOL_GPL(add_page_wait_queue);
920
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800921#ifndef clear_bit_unlock_is_negative_byte
922
923/*
924 * PG_waiters is the high bit in the same byte as PG_lock.
925 *
926 * On x86 (and on many other architectures), we can clear PG_lock and
927 * test the sign bit at the same time. But if the architecture does
928 * not support that special operation, we just do this all by hand
929 * instead.
930 *
931 * The read of PG_waiters has to be after (or concurrently with) PG_locked
932 * being cleared, but a memory barrier should be unneccssary since it is
933 * in the same byte as PG_locked.
934 */
935static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
936{
937 clear_bit_unlock(nr, mem);
938 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -0800939 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800940}
941
942#endif
943
David Howells385e1ca5f2009-04-03 16:42:39 +0100944/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700945 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 * @page: the page
947 *
948 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
949 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +0900950 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
952 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800953 * Note that this depends on PG_waiters being the sign bit in the byte
954 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
955 * clear the PG_locked bit and test PG_waiters at the same time fairly
956 * portably (architectures that do LL/SC can test any bit, while x86 can
957 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 */
Harvey Harrison920c7a52008-02-04 22:29:26 -0800959void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960{
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800961 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800962 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -0800963 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800964 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
965 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966}
967EXPORT_SYMBOL(unlock_page);
968
Randy Dunlap485bb992006-06-23 02:03:49 -0700969/**
970 * end_page_writeback - end writeback against a page
971 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700972 */
973void end_page_writeback(struct page *page)
974{
Mel Gorman888cf2d2014-06-04 16:10:34 -0700975 /*
976 * TestClearPageReclaim could be used here but it is an atomic
977 * operation and overkill in this particular case. Failing to
978 * shuffle a page marked for immediate reclaim is too mild to
979 * justify taking an atomic operation penalty at the end of
980 * ever page writeback.
981 */
982 if (PageReclaim(page)) {
983 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700984 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -0700985 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700986
987 if (!test_clear_page_writeback(page))
988 BUG();
989
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100990 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 wake_up_page(page, PG_writeback);
992}
993EXPORT_SYMBOL(end_page_writeback);
994
Matthew Wilcox57d99842014-06-04 16:07:45 -0700995/*
996 * After completing I/O on a page, call this routine to update the page
997 * flags appropriately
998 */
Jens Axboec11f0c02016-08-05 08:11:04 -0600999void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001000{
Jens Axboec11f0c02016-08-05 08:11:04 -06001001 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001002 if (!err) {
1003 SetPageUptodate(page);
1004 } else {
1005 ClearPageUptodate(page);
1006 SetPageError(page);
1007 }
1008 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001009 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001010 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001011 struct address_space *mapping;
1012
Matthew Wilcox57d99842014-06-04 16:07:45 -07001013 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001014 mapping = page_mapping(page);
1015 if (mapping)
1016 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001017 }
1018 end_page_writeback(page);
1019 }
1020}
1021EXPORT_SYMBOL_GPL(page_endio);
1022
Randy Dunlap485bb992006-06-23 02:03:49 -07001023/**
1024 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001025 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001026 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001027void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001028{
Nicholas Piggin62906022016-12-25 13:00:30 +10001029 struct page *page = compound_head(__page);
1030 wait_queue_head_t *q = page_waitqueue(page);
1031 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032}
1033EXPORT_SYMBOL(__lock_page);
1034
Nicholas Piggin62906022016-12-25 13:00:30 +10001035int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001036{
Nicholas Piggin62906022016-12-25 13:00:30 +10001037 struct page *page = compound_head(__page);
1038 wait_queue_head_t *q = page_waitqueue(page);
1039 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE, true);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001040}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001041EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001042
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001043/*
1044 * Return values:
1045 * 1 - page is locked; mmap_sem is still held.
1046 * 0 - page is not locked.
1047 * mmap_sem has been released (up_read()), unless flags had both
1048 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1049 * which case mmap_sem is still held.
1050 *
1051 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1052 * with the page locked and the mmap_sem unperturbed.
1053 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001054int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1055 unsigned int flags)
1056{
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001057 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1058 /*
1059 * CAUTION! In this case, mmap_sem is not released
1060 * even though return 0.
1061 */
1062 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1063 return 0;
1064
1065 up_read(&mm->mmap_sem);
1066 if (flags & FAULT_FLAG_KILLABLE)
1067 wait_on_page_locked_killable(page);
1068 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001069 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001070 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001071 } else {
1072 if (flags & FAULT_FLAG_KILLABLE) {
1073 int ret;
1074
1075 ret = __lock_page_killable(page);
1076 if (ret) {
1077 up_read(&mm->mmap_sem);
1078 return 0;
1079 }
1080 } else
1081 __lock_page(page);
1082 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001083 }
1084}
1085
Randy Dunlap485bb992006-06-23 02:03:49 -07001086/**
Johannes Weinere7b563b2014-04-03 14:47:44 -07001087 * page_cache_next_hole - find the next hole (not-present entry)
1088 * @mapping: mapping
1089 * @index: index
1090 * @max_scan: maximum range to search
1091 *
1092 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the
1093 * lowest indexed hole.
1094 *
1095 * Returns: the index of the hole if found, otherwise returns an index
1096 * outside of the set specified (in which case 'return - index >=
1097 * max_scan' will be true). In rare cases of index wrap-around, 0 will
1098 * be returned.
1099 *
1100 * page_cache_next_hole may be called under rcu_read_lock. However,
1101 * like radix_tree_gang_lookup, this will not atomically search a
1102 * snapshot of the tree at a single point in time. For example, if a
1103 * hole is created at index 5, then subsequently a hole is created at
1104 * index 10, page_cache_next_hole covering both indexes may return 10
1105 * if called under rcu_read_lock.
1106 */
1107pgoff_t page_cache_next_hole(struct address_space *mapping,
1108 pgoff_t index, unsigned long max_scan)
1109{
1110 unsigned long i;
1111
1112 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001113 struct page *page;
1114
1115 page = radix_tree_lookup(&mapping->page_tree, index);
1116 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001117 break;
1118 index++;
1119 if (index == 0)
1120 break;
1121 }
1122
1123 return index;
1124}
1125EXPORT_SYMBOL(page_cache_next_hole);
1126
1127/**
1128 * page_cache_prev_hole - find the prev hole (not-present entry)
1129 * @mapping: mapping
1130 * @index: index
1131 * @max_scan: maximum range to search
1132 *
1133 * Search backwards in the range [max(index-max_scan+1, 0), index] for
1134 * the first hole.
1135 *
1136 * Returns: the index of the hole if found, otherwise returns an index
1137 * outside of the set specified (in which case 'index - return >=
1138 * max_scan' will be true). In rare cases of wrap-around, ULONG_MAX
1139 * will be returned.
1140 *
1141 * page_cache_prev_hole may be called under rcu_read_lock. However,
1142 * like radix_tree_gang_lookup, this will not atomically search a
1143 * snapshot of the tree at a single point in time. For example, if a
1144 * hole is created at index 10, then subsequently a hole is created at
1145 * index 5, page_cache_prev_hole covering both indexes may return 5 if
1146 * called under rcu_read_lock.
1147 */
1148pgoff_t page_cache_prev_hole(struct address_space *mapping,
1149 pgoff_t index, unsigned long max_scan)
1150{
1151 unsigned long i;
1152
1153 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001154 struct page *page;
1155
1156 page = radix_tree_lookup(&mapping->page_tree, index);
1157 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001158 break;
1159 index--;
1160 if (index == ULONG_MAX)
1161 break;
1162 }
1163
1164 return index;
1165}
1166EXPORT_SYMBOL(page_cache_prev_hole);
1167
1168/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001169 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001170 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001171 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001172 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001173 * Looks up the page cache slot at @mapping & @offset. If there is a
1174 * page cache page, it is returned with an increased refcount.
1175 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001176 * If the slot holds a shadow entry of a previously evicted page, or a
1177 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001178 *
1179 * Otherwise, %NULL is returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001181struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182{
Nick Piggina60637c2008-07-25 19:45:31 -07001183 void **pagep;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001184 struct page *head, *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001185
Nick Piggina60637c2008-07-25 19:45:31 -07001186 rcu_read_lock();
1187repeat:
1188 page = NULL;
1189 pagep = radix_tree_lookup_slot(&mapping->page_tree, offset);
1190 if (pagep) {
1191 page = radix_tree_deref_slot(pagep);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001192 if (unlikely(!page))
1193 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001194 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001195 if (radix_tree_deref_retry(page))
1196 goto repeat;
1197 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001198 * A shadow entry of a recently evicted page,
1199 * or a swap entry from shmem/tmpfs. Return
1200 * it without attempting to raise page count.
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001201 */
1202 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001203 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001204
1205 head = compound_head(page);
1206 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001207 goto repeat;
1208
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001209 /* The page was split under us? */
1210 if (compound_head(page) != head) {
1211 put_page(head);
1212 goto repeat;
1213 }
1214
Nick Piggina60637c2008-07-25 19:45:31 -07001215 /*
1216 * Has the page moved?
1217 * This is part of the lockless pagecache protocol. See
1218 * include/linux/pagemap.h for details.
1219 */
1220 if (unlikely(page != *pagep)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001221 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001222 goto repeat;
1223 }
1224 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001225out:
Nick Piggina60637c2008-07-25 19:45:31 -07001226 rcu_read_unlock();
1227
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 return page;
1229}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001230EXPORT_SYMBOL(find_get_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231
Randy Dunlap485bb992006-06-23 02:03:49 -07001232/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001233 * find_lock_entry - locate, pin and lock a page cache entry
1234 * @mapping: the address_space to search
1235 * @offset: the page cache index
1236 *
1237 * Looks up the page cache slot at @mapping & @offset. If there is a
1238 * page cache page, it is returned locked and with an increased
1239 * refcount.
1240 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001241 * If the slot holds a shadow entry of a previously evicted page, or a
1242 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001243 *
1244 * Otherwise, %NULL is returned.
1245 *
1246 * find_lock_entry() may sleep.
1247 */
1248struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249{
1250 struct page *page;
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001253 page = find_get_entry(mapping, offset);
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001254 if (page && !radix_tree_exception(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001255 lock_page(page);
1256 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001257 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001258 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001259 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001260 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001262 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 return page;
1265}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001266EXPORT_SYMBOL(find_lock_entry);
1267
1268/**
Mel Gorman2457aec2014-06-04 16:10:31 -07001269 * pagecache_get_page - find and get a page reference
Johannes Weiner0cd61442014-04-03 14:47:46 -07001270 * @mapping: the address_space to search
1271 * @offset: the page index
Mel Gorman2457aec2014-06-04 16:10:31 -07001272 * @fgp_flags: PCG flags
Michal Hocko45f87de2014-12-29 20:30:35 +01001273 * @gfp_mask: gfp mask to use for the page cache data page allocation
Johannes Weiner0cd61442014-04-03 14:47:46 -07001274 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001275 * Looks up the page cache slot at @mapping & @offset.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001276 *
Randy Dunlap75325182014-07-30 16:08:37 -07001277 * PCG flags modify how the page is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001278 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001279 * FGP_ACCESSED: the page will be marked accessed
1280 * FGP_LOCK: Page is return locked
1281 * FGP_CREAT: If page is not present then a new page is allocated using
Michal Hocko45f87de2014-12-29 20:30:35 +01001282 * @gfp_mask and added to the page cache and the VM's LRU
1283 * list. The page is returned locked and with an increased
1284 * refcount. Otherwise, %NULL is returned.
Mel Gorman2457aec2014-06-04 16:10:31 -07001285 *
1286 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1287 * if the GFP flags specified for FGP_CREAT are atomic.
1288 *
1289 * If there is a page cache page, it is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001290 */
Mel Gorman2457aec2014-06-04 16:10:31 -07001291struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
Michal Hocko45f87de2014-12-29 20:30:35 +01001292 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293{
Nick Piggineb2be182007-10-16 01:24:57 -07001294 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001295
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296repeat:
Mel Gorman2457aec2014-06-04 16:10:31 -07001297 page = find_get_entry(mapping, offset);
1298 if (radix_tree_exceptional_entry(page))
1299 page = NULL;
1300 if (!page)
1301 goto no_page;
1302
1303 if (fgp_flags & FGP_LOCK) {
1304 if (fgp_flags & FGP_NOWAIT) {
1305 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001306 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001307 return NULL;
1308 }
1309 } else {
1310 lock_page(page);
1311 }
1312
1313 /* Has the page been truncated? */
1314 if (unlikely(page->mapping != mapping)) {
1315 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001316 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001317 goto repeat;
1318 }
1319 VM_BUG_ON_PAGE(page->index != offset, page);
1320 }
1321
1322 if (page && (fgp_flags & FGP_ACCESSED))
1323 mark_page_accessed(page);
1324
1325no_page:
1326 if (!page && (fgp_flags & FGP_CREAT)) {
1327 int err;
1328 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001329 gfp_mask |= __GFP_WRITE;
1330 if (fgp_flags & FGP_NOFS)
1331 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001332
Michal Hocko45f87de2014-12-29 20:30:35 +01001333 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001334 if (!page)
1335 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001336
1337 if (WARN_ON_ONCE(!(fgp_flags & FGP_LOCK)))
1338 fgp_flags |= FGP_LOCK;
1339
Hugh Dickinseb39d612014-08-06 16:06:43 -07001340 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001341 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001342 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001343
Michal Hocko45f87de2014-12-29 20:30:35 +01001344 err = add_to_page_cache_lru(page, mapping, offset,
1345 gfp_mask & GFP_RECLAIM_MASK);
Nick Piggineb2be182007-10-16 01:24:57 -07001346 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001347 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001348 page = NULL;
1349 if (err == -EEXIST)
1350 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001353
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 return page;
1355}
Mel Gorman2457aec2014-06-04 16:10:31 -07001356EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357
1358/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001359 * find_get_entries - gang pagecache lookup
1360 * @mapping: The address_space to search
1361 * @start: The starting page cache index
1362 * @nr_entries: The maximum number of entries
1363 * @entries: Where the resulting entries are placed
1364 * @indices: The cache indices corresponding to the entries in @entries
1365 *
1366 * find_get_entries() will search for and return a group of up to
1367 * @nr_entries entries in the mapping. The entries are placed at
1368 * @entries. find_get_entries() takes a reference against any actual
1369 * pages it returns.
1370 *
1371 * The search returns a group of mapping-contiguous page cache entries
1372 * with ascending indexes. There may be holes in the indices due to
1373 * not-present pages.
1374 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001375 * Any shadow entries of evicted pages, or swap entries from
1376 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001377 *
1378 * find_get_entries() returns the number of pages and shadow entries
1379 * which were found.
1380 */
1381unsigned find_get_entries(struct address_space *mapping,
1382 pgoff_t start, unsigned int nr_entries,
1383 struct page **entries, pgoff_t *indices)
1384{
1385 void **slot;
1386 unsigned int ret = 0;
1387 struct radix_tree_iter iter;
1388
1389 if (!nr_entries)
1390 return 0;
1391
1392 rcu_read_lock();
Johannes Weiner0cd61442014-04-03 14:47:46 -07001393 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001394 struct page *head, *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001395repeat:
1396 page = radix_tree_deref_slot(slot);
1397 if (unlikely(!page))
1398 continue;
1399 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001400 if (radix_tree_deref_retry(page)) {
1401 slot = radix_tree_iter_retry(&iter);
1402 continue;
1403 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001404 /*
Ross Zwislerf9fe48b2016-01-22 15:10:40 -08001405 * A shadow entry of a recently evicted page, a swap
1406 * entry from shmem/tmpfs or a DAX entry. Return it
1407 * without attempting to raise page count.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001408 */
1409 goto export;
1410 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001411
1412 head = compound_head(page);
1413 if (!page_cache_get_speculative(head))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001414 goto repeat;
1415
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001416 /* The page was split under us? */
1417 if (compound_head(page) != head) {
1418 put_page(head);
1419 goto repeat;
1420 }
1421
Johannes Weiner0cd61442014-04-03 14:47:46 -07001422 /* Has the page moved? */
1423 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001424 put_page(head);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001425 goto repeat;
1426 }
1427export:
1428 indices[ret] = iter.index;
1429 entries[ret] = page;
1430 if (++ret == nr_entries)
1431 break;
1432 }
1433 rcu_read_unlock();
1434 return ret;
1435}
1436
1437/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 * find_get_pages - gang pagecache lookup
1439 * @mapping: The address_space to search
1440 * @start: The starting page index
1441 * @nr_pages: The maximum number of pages
1442 * @pages: Where the resulting pages are placed
1443 *
1444 * find_get_pages() will search for and return a group of up to
1445 * @nr_pages pages in the mapping. The pages are placed at @pages.
1446 * find_get_pages() takes a reference against the returned pages.
1447 *
1448 * The search returns a group of mapping-contiguous pages with ascending
1449 * indexes. There may be holes in the indices due to not-present pages.
1450 *
1451 * find_get_pages() returns the number of pages which were found.
1452 */
1453unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
1454 unsigned int nr_pages, struct page **pages)
1455{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001456 struct radix_tree_iter iter;
1457 void **slot;
1458 unsigned ret = 0;
1459
1460 if (unlikely(!nr_pages))
1461 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
Nick Piggina60637c2008-07-25 19:45:31 -07001463 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001464 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001465 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001466repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001467 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001468 if (unlikely(!page))
1469 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001470
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001471 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001472 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001473 slot = radix_tree_iter_retry(&iter);
1474 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001475 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001476 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001477 * A shadow entry of a recently evicted page,
1478 * or a swap entry from shmem/tmpfs. Skip
1479 * over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001480 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001481 continue;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001482 }
Nick Piggina60637c2008-07-25 19:45:31 -07001483
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001484 head = compound_head(page);
1485 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001486 goto repeat;
1487
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001488 /* The page was split under us? */
1489 if (compound_head(page) != head) {
1490 put_page(head);
1491 goto repeat;
1492 }
1493
Nick Piggina60637c2008-07-25 19:45:31 -07001494 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001495 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001496 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001497 goto repeat;
1498 }
1499
1500 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001501 if (++ret == nr_pages)
1502 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001503 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001504
Nick Piggina60637c2008-07-25 19:45:31 -07001505 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001506 return ret;
1507}
1508
Jens Axboeebf43502006-04-27 08:46:01 +02001509/**
1510 * find_get_pages_contig - gang contiguous pagecache lookup
1511 * @mapping: The address_space to search
1512 * @index: The starting page index
1513 * @nr_pages: The maximum number of pages
1514 * @pages: Where the resulting pages are placed
1515 *
1516 * find_get_pages_contig() works exactly like find_get_pages(), except
1517 * that the returned number of pages are guaranteed to be contiguous.
1518 *
1519 * find_get_pages_contig() returns the number of pages which were found.
1520 */
1521unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1522 unsigned int nr_pages, struct page **pages)
1523{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001524 struct radix_tree_iter iter;
1525 void **slot;
1526 unsigned int ret = 0;
1527
1528 if (unlikely(!nr_pages))
1529 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001530
Nick Piggina60637c2008-07-25 19:45:31 -07001531 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001532 radix_tree_for_each_contig(slot, &mapping->page_tree, &iter, index) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001533 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001534repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001535 page = radix_tree_deref_slot(slot);
1536 /* The hole, there no reason to continue */
Nick Piggina60637c2008-07-25 19:45:31 -07001537 if (unlikely(!page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001538 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001539
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001540 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001541 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001542 slot = radix_tree_iter_retry(&iter);
1543 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001544 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001545 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001546 * A shadow entry of a recently evicted page,
1547 * or a swap entry from shmem/tmpfs. Stop
1548 * looking for contiguous pages.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001549 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001550 break;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001551 }
Nick Piggina60637c2008-07-25 19:45:31 -07001552
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001553 head = compound_head(page);
1554 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001555 goto repeat;
1556
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001557 /* The page was split under us? */
1558 if (compound_head(page) != head) {
1559 put_page(head);
1560 goto repeat;
1561 }
1562
Nick Piggina60637c2008-07-25 19:45:31 -07001563 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001564 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001565 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001566 goto repeat;
1567 }
1568
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001569 /*
1570 * must check mapping and index after taking the ref.
1571 * otherwise we can get both false positives and false
1572 * negatives, which is just confusing to the caller.
1573 */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001574 if (page->mapping == NULL || page_to_pgoff(page) != iter.index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001575 put_page(page);
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001576 break;
1577 }
1578
Nick Piggina60637c2008-07-25 19:45:31 -07001579 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001580 if (++ret == nr_pages)
1581 break;
Jens Axboeebf43502006-04-27 08:46:01 +02001582 }
Nick Piggina60637c2008-07-25 19:45:31 -07001583 rcu_read_unlock();
1584 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001585}
David Howellsef71c152007-05-09 02:33:44 -07001586EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001587
Randy Dunlap485bb992006-06-23 02:03:49 -07001588/**
1589 * find_get_pages_tag - find and return pages that match @tag
1590 * @mapping: the address_space to search
1591 * @index: the starting page index
1592 * @tag: the tag index
1593 * @nr_pages: the maximum number of pages
1594 * @pages: where the resulting pages are placed
1595 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001597 * @tag. We update @index to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598 */
1599unsigned find_get_pages_tag(struct address_space *mapping, pgoff_t *index,
1600 int tag, unsigned int nr_pages, struct page **pages)
1601{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001602 struct radix_tree_iter iter;
1603 void **slot;
1604 unsigned ret = 0;
1605
1606 if (unlikely(!nr_pages))
1607 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608
Nick Piggina60637c2008-07-25 19:45:31 -07001609 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001610 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1611 &iter, *index, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001612 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001613repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001614 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001615 if (unlikely(!page))
1616 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001617
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001618 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001619 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001620 slot = radix_tree_iter_retry(&iter);
1621 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001622 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001623 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001624 * A shadow entry of a recently evicted page.
1625 *
1626 * Those entries should never be tagged, but
1627 * this tree walk is lockless and the tags are
1628 * looked up in bulk, one radix tree node at a
1629 * time, so there is a sizable window for page
1630 * reclaim to evict a page we saw tagged.
1631 *
1632 * Skip over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001633 */
Johannes Weiner139b6a62014-05-06 12:50:05 -07001634 continue;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001635 }
Nick Piggina60637c2008-07-25 19:45:31 -07001636
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001637 head = compound_head(page);
1638 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001639 goto repeat;
1640
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001641 /* The page was split under us? */
1642 if (compound_head(page) != head) {
1643 put_page(head);
1644 goto repeat;
1645 }
1646
Nick Piggina60637c2008-07-25 19:45:31 -07001647 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001648 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001649 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001650 goto repeat;
1651 }
1652
1653 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001654 if (++ret == nr_pages)
1655 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001656 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001657
Nick Piggina60637c2008-07-25 19:45:31 -07001658 rcu_read_unlock();
1659
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660 if (ret)
1661 *index = pages[ret - 1]->index + 1;
Nick Piggina60637c2008-07-25 19:45:31 -07001662
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 return ret;
1664}
David Howellsef71c152007-05-09 02:33:44 -07001665EXPORT_SYMBOL(find_get_pages_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001667/**
1668 * find_get_entries_tag - find and return entries that match @tag
1669 * @mapping: the address_space to search
1670 * @start: the starting page cache index
1671 * @tag: the tag index
1672 * @nr_entries: the maximum number of entries
1673 * @entries: where the resulting entries are placed
1674 * @indices: the cache indices corresponding to the entries in @entries
1675 *
1676 * Like find_get_entries, except we only return entries which are tagged with
1677 * @tag.
1678 */
1679unsigned find_get_entries_tag(struct address_space *mapping, pgoff_t start,
1680 int tag, unsigned int nr_entries,
1681 struct page **entries, pgoff_t *indices)
1682{
1683 void **slot;
1684 unsigned int ret = 0;
1685 struct radix_tree_iter iter;
1686
1687 if (!nr_entries)
1688 return 0;
1689
1690 rcu_read_lock();
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001691 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1692 &iter, start, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001693 struct page *head, *page;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001694repeat:
1695 page = radix_tree_deref_slot(slot);
1696 if (unlikely(!page))
1697 continue;
1698 if (radix_tree_exception(page)) {
1699 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001700 slot = radix_tree_iter_retry(&iter);
1701 continue;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001702 }
1703
1704 /*
1705 * A shadow entry of a recently evicted page, a swap
1706 * entry from shmem/tmpfs or a DAX entry. Return it
1707 * without attempting to raise page count.
1708 */
1709 goto export;
1710 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001711
1712 head = compound_head(page);
1713 if (!page_cache_get_speculative(head))
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001714 goto repeat;
1715
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001716 /* The page was split under us? */
1717 if (compound_head(page) != head) {
1718 put_page(head);
1719 goto repeat;
1720 }
1721
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001722 /* Has the page moved? */
1723 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001724 put_page(head);
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001725 goto repeat;
1726 }
1727export:
1728 indices[ret] = iter.index;
1729 entries[ret] = page;
1730 if (++ret == nr_entries)
1731 break;
1732 }
1733 rcu_read_unlock();
1734 return ret;
1735}
1736EXPORT_SYMBOL(find_get_entries_tag);
1737
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001738/*
1739 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1740 * a _large_ part of the i/o request. Imagine the worst scenario:
1741 *
1742 * ---R__________________________________________B__________
1743 * ^ reading here ^ bad block(assume 4k)
1744 *
1745 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1746 * => failing the whole request => read(R) => read(R+1) =>
1747 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1748 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1749 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1750 *
1751 * It is going insane. Fix it by quickly scaling down the readahead size.
1752 */
1753static void shrink_readahead_size_eio(struct file *filp,
1754 struct file_ra_state *ra)
1755{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001756 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001757}
1758
Randy Dunlap485bb992006-06-23 02:03:49 -07001759/**
Christoph Hellwig36e78912008-02-08 04:21:24 -08001760 * do_generic_file_read - generic file read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07001761 * @filp: the file to read
1762 * @ppos: current file position
Al Viro6e58e792014-02-03 17:07:03 -05001763 * @iter: data destination
1764 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001765 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001767 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768 *
1769 * This is really ugly. But the goto's actually try to clarify some
1770 * of the logic when it comes to error handling etc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 */
Al Viro6e58e792014-02-03 17:07:03 -05001772static ssize_t do_generic_file_read(struct file *filp, loff_t *ppos,
1773 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774{
Christoph Hellwig36e78912008-02-08 04:21:24 -08001775 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001777 struct file_ra_state *ra = &filp->f_ra;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001778 pgoff_t index;
1779 pgoff_t last_index;
1780 pgoff_t prev_index;
1781 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07001782 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05001783 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Wei Fangc2a97372016-10-07 17:01:52 -07001785 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08001786 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07001787 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
1788
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001789 index = *ppos >> PAGE_SHIFT;
1790 prev_index = ra->prev_pos >> PAGE_SHIFT;
1791 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
1792 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
1793 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
Linus Torvalds1da177e2005-04-16 15:20:36 -07001795 for (;;) {
1796 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001797 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001798 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 unsigned long nr, ret;
1800
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08001803 if (fatal_signal_pending(current)) {
1804 error = -EINTR;
1805 goto out;
1806 }
1807
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001809 if (!page) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001810 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001811 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001812 index, last_index - index);
1813 page = find_get_page(mapping, index);
1814 if (unlikely(page == NULL))
1815 goto no_cached_page;
1816 }
1817 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001818 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001819 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001820 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001821 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001822 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07001823 /*
1824 * See comment in do_read_cache_page on why
1825 * wait_on_page_locked is used to avoid unnecessarily
1826 * serialisations and why it's safe.
1827 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07001828 error = wait_on_page_locked_killable(page);
1829 if (unlikely(error))
1830 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07001831 if (PageUptodate(page))
1832 goto page_ok;
1833
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001834 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001835 !mapping->a_ops->is_partially_uptodate)
1836 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08001837 /* pipes can't handle partially uptodate pages */
1838 if (unlikely(iter->type & ITER_PIPE))
1839 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02001840 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001841 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08001842 /* Did it get truncated before we got the lock? */
1843 if (!page->mapping)
1844 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001845 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05001846 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001847 goto page_not_up_to_date_locked;
1848 unlock_page(page);
1849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001850page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07001851 /*
1852 * i_size must be checked after we know the page is Uptodate.
1853 *
1854 * Checking i_size after the check allows us to calculate
1855 * the correct value for "nr", which means the zero-filled
1856 * part of the page is not copied back to userspace (unless
1857 * another truncate extends the file - this is desired though).
1858 */
1859
1860 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001861 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001862 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001863 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001864 goto out;
1865 }
1866
1867 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001868 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001869 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001870 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001871 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001872 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001873 goto out;
1874 }
1875 }
1876 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877
1878 /* If users can be writing to this page using arbitrary
1879 * virtual addresses, take care about potential aliasing
1880 * before reading the page on the kernel side.
1881 */
1882 if (mapping_writably_mapped(mapping))
1883 flush_dcache_page(page);
1884
1885 /*
Jan Karaec0f1632007-05-06 14:49:25 -07001886 * When a sequential read accesses a page several times,
1887 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 */
Jan Karaec0f1632007-05-06 14:49:25 -07001889 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001890 mark_page_accessed(page);
1891 prev_index = index;
1892
1893 /*
1894 * Ok, we have the page, and it's up-to-date, so
1895 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001896 */
Al Viro6e58e792014-02-03 17:07:03 -05001897
1898 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001900 index += offset >> PAGE_SHIFT;
1901 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07001902 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001904 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001905 written += ret;
1906 if (!iov_iter_count(iter))
1907 goto out;
1908 if (ret < nr) {
1909 error = -EFAULT;
1910 goto out;
1911 }
1912 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001913
1914page_not_up_to_date:
1915 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04001916 error = lock_page_killable(page);
1917 if (unlikely(error))
1918 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001919
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001920page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07001921 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922 if (!page->mapping) {
1923 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001924 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 continue;
1926 }
1927
1928 /* Did somebody else fill it already? */
1929 if (PageUptodate(page)) {
1930 unlock_page(page);
1931 goto page_ok;
1932 }
1933
1934readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04001935 /*
1936 * A previous I/O error may have been due to temporary
1937 * failures, eg. multipath errors.
1938 * PG_error will be set again if readpage fails.
1939 */
1940 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 /* Start the actual read. The read will unlock the page. */
1942 error = mapping->a_ops->readpage(filp, page);
1943
Zach Brown994fc28c2005-12-15 14:28:17 -08001944 if (unlikely(error)) {
1945 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001946 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001947 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08001948 goto find_page;
1949 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08001951 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952
1953 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04001954 error = lock_page_killable(page);
1955 if (unlikely(error))
1956 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 if (!PageUptodate(page)) {
1958 if (page->mapping == NULL) {
1959 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01001960 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 */
1962 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001963 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 goto find_page;
1965 }
1966 unlock_page(page);
Fengguang Wu7ff81072007-10-16 01:24:35 -07001967 shrink_readahead_size_eio(filp, ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04001968 error = -EIO;
1969 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001970 }
1971 unlock_page(page);
1972 }
1973
Linus Torvalds1da177e2005-04-16 15:20:36 -07001974 goto page_ok;
1975
1976readpage_error:
1977 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001978 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979 goto out;
1980
1981no_cached_page:
1982 /*
1983 * Ok, it wasn't cached, so we need to create a new
1984 * page..
1985 */
Nick Piggineb2be182007-10-16 01:24:57 -07001986 page = page_cache_alloc_cold(mapping);
1987 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05001988 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07001989 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990 }
Michal Hocko6afdb852015-06-24 16:58:06 -07001991 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08001992 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001994 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001995 if (error == -EEXIST) {
1996 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05001998 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999 goto out;
2000 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002001 goto readpage;
2002 }
2003
2004out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002005 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002006 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002007 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002009 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002010 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002011 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002012}
2013
Randy Dunlap485bb992006-06-23 02:03:49 -07002014/**
Al Viro6abd2322014-04-04 14:20:57 -04002015 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002016 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002017 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002018 *
Al Viro6abd2322014-04-04 14:20:57 -04002019 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 * that can use the page cache directly.
2021 */
2022ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002023generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024{
Al Viroed978a82014-03-05 22:53:04 -05002025 struct file *file = iocb->ki_filp;
2026 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002027 size_t count = iov_iter_count(iter);
2028
2029 if (!count)
2030 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
Al Viro2ba48ce2015-04-09 13:52:01 -04002032 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viroed978a82014-03-05 22:53:04 -05002033 struct address_space *mapping = file->f_mapping;
2034 struct inode *inode = mapping->host;
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002035 struct iov_iter data = *iter;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002036 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 size = i_size_read(inode);
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002039 retval = filemap_write_and_wait_range(mapping, iocb->ki_pos,
2040 iocb->ki_pos + count - 1);
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002041 if (retval < 0)
2042 goto out;
Al Viroed978a82014-03-05 22:53:04 -05002043
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002044 file_accessed(file);
2045
2046 retval = mapping->a_ops->direct_IO(iocb, &data);
Al Viroc3a69022016-10-10 13:26:27 -04002047 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002048 iocb->ki_pos += retval;
Al Viroed978a82014-03-05 22:53:04 -05002049 iov_iter_advance(iter, retval);
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002050 }
Josef Bacik66f998f2010-05-23 11:00:54 -04002051
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002052 /*
2053 * Btrfs can have a short DIO read if we encounter
2054 * compressed extents, so if there was an error, or if
2055 * we've already read everything we wanted to, or if
2056 * there was a short read because we hit EOF, go ahead
2057 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002058 * the rest of the read. Buffered reads will not work for
2059 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002060 */
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002061 if (retval < 0 || !iov_iter_count(iter) || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002062 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002063 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002064 }
2065
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002066 retval = do_generic_file_read(file, &iocb->ki_pos, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067out:
2068 return retval;
2069}
Al Viroed978a82014-03-05 22:53:04 -05002070EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002071
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072#ifdef CONFIG_MMU
Randy Dunlap485bb992006-06-23 02:03:49 -07002073/**
2074 * page_cache_read - adds requested page to the page cache if not already there
2075 * @file: file to read
2076 * @offset: page index
Randy Dunlap62eb3202016-02-11 16:12:58 -08002077 * @gfp_mask: memory allocation flags
Randy Dunlap485bb992006-06-23 02:03:49 -07002078 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 * This adds the requested page to the page cache if it isn't already there,
2080 * and schedules an I/O to read in its contents from disk.
2081 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002082static int page_cache_read(struct file *file, pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083{
2084 struct address_space *mapping = file->f_mapping;
Paul McQuade99dadfd2014-10-09 15:29:03 -07002085 struct page *page;
Zach Brown994fc28c2005-12-15 14:28:17 -08002086 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002087
Zach Brown994fc28c2005-12-15 14:28:17 -08002088 do {
Michal Hockoc20cd452016-01-14 15:20:12 -08002089 page = __page_cache_alloc(gfp_mask|__GFP_COLD);
Zach Brown994fc28c2005-12-15 14:28:17 -08002090 if (!page)
2091 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092
Michal Hockoc20cd452016-01-14 15:20:12 -08002093 ret = add_to_page_cache_lru(page, mapping, offset, gfp_mask & GFP_KERNEL);
Zach Brown994fc28c2005-12-15 14:28:17 -08002094 if (ret == 0)
2095 ret = mapping->a_ops->readpage(file, page);
2096 else if (ret == -EEXIST)
2097 ret = 0; /* losing race to add is OK */
2098
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002099 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100
Zach Brown994fc28c2005-12-15 14:28:17 -08002101 } while (ret == AOP_TRUNCATED_PAGE);
Paul McQuade99dadfd2014-10-09 15:29:03 -07002102
Zach Brown994fc28c2005-12-15 14:28:17 -08002103 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104}
2105
2106#define MMAP_LOTSAMISS (100)
2107
Linus Torvaldsef00e082009-06-16 15:31:25 -07002108/*
2109 * Synchronous readahead happens when we don't even find
2110 * a page in the page cache at all.
2111 */
2112static void do_sync_mmap_readahead(struct vm_area_struct *vma,
2113 struct file_ra_state *ra,
2114 struct file *file,
2115 pgoff_t offset)
2116{
Linus Torvaldsef00e082009-06-16 15:31:25 -07002117 struct address_space *mapping = file->f_mapping;
2118
2119 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002120 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002121 return;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002122 if (!ra->ra_pages)
2123 return;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002124
Joe Perches64363aa2013-07-08 16:00:18 -07002125 if (vma->vm_flags & VM_SEQ_READ) {
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002126 page_cache_sync_readahead(mapping, ra, file, offset,
2127 ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002128 return;
2129 }
2130
Andi Kleen207d04b2011-05-24 17:12:29 -07002131 /* Avoid banging the cache line if not needed */
2132 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002133 ra->mmap_miss++;
2134
2135 /*
2136 * Do we miss much more than hit in this file? If so,
2137 * stop bothering with read-ahead. It will only hurt.
2138 */
2139 if (ra->mmap_miss > MMAP_LOTSAMISS)
2140 return;
2141
Wu Fengguangd30a1102009-06-16 15:31:30 -07002142 /*
2143 * mmap read-around
2144 */
Roman Gushchin600e19a2015-11-05 18:47:08 -08002145 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2146 ra->size = ra->ra_pages;
2147 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002148 ra_submit(ra, mapping, file);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002149}
2150
2151/*
2152 * Asynchronous readahead happens when we find the page and PG_readahead,
2153 * so we want to possibly extend the readahead further..
2154 */
2155static void do_async_mmap_readahead(struct vm_area_struct *vma,
2156 struct file_ra_state *ra,
2157 struct file *file,
2158 struct page *page,
2159 pgoff_t offset)
2160{
2161 struct address_space *mapping = file->f_mapping;
2162
2163 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002164 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002165 return;
2166 if (ra->mmap_miss > 0)
2167 ra->mmap_miss--;
2168 if (PageReadahead(page))
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002169 page_cache_async_readahead(mapping, ra, file,
2170 page, offset, ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002171}
2172
Randy Dunlap485bb992006-06-23 02:03:49 -07002173/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002174 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002175 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002176 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002177 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002178 * mapped memory region to read in file data during a page fault.
2179 *
2180 * The goto's are kind of ugly, but this streamlines the normal case of having
2181 * it in the page cache, and handles the special cases reasonably without
2182 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002183 *
2184 * vma->vm_mm->mmap_sem must be held on entry.
2185 *
2186 * If our return value has VM_FAULT_RETRY set, it's because
2187 * lock_page_or_retry() returned 0.
2188 * The mmap_sem has usually been released in this case.
2189 * See __lock_page_or_retry() for the exception.
2190 *
2191 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2192 * has not been released.
2193 *
2194 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002195 */
Dave Jiang11bac802017-02-24 14:56:41 -08002196int filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197{
2198 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002199 struct file *file = vmf->vma->vm_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 struct address_space *mapping = file->f_mapping;
2201 struct file_ra_state *ra = &file->f_ra;
2202 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002203 pgoff_t offset = vmf->pgoff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002204 struct page *page;
Kirill A. Shutemov99e3e532014-04-07 15:37:21 -07002205 loff_t size;
Nick Piggin83c54072007-07-19 01:47:05 -07002206 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002208 size = round_up(i_size_read(inode), PAGE_SIZE);
2209 if (offset >= size >> PAGE_SHIFT)
Linus Torvalds5307cc12007-10-31 09:19:46 -07002210 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002211
Linus Torvalds1da177e2005-04-16 15:20:36 -07002212 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002213 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002215 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002216 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002218 * We found the page, so try async readahead before
2219 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 */
Dave Jiang11bac802017-02-24 14:56:41 -08002221 do_async_mmap_readahead(vmf->vma, ra, file, page, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002222 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002223 /* No page in the page cache at all */
Dave Jiang11bac802017-02-24 14:56:41 -08002224 do_sync_mmap_readahead(vmf->vma, ra, file, offset);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002225 count_vm_event(PGMAJFAULT);
Dave Jiang11bac802017-02-24 14:56:41 -08002226 mem_cgroup_count_vm_event(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002227 ret = VM_FAULT_MAJOR;
2228retry_find:
Michel Lespinasseb522c942010-10-26 14:21:56 -07002229 page = find_get_page(mapping, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002230 if (!page)
2231 goto no_cached_page;
2232 }
2233
Dave Jiang11bac802017-02-24 14:56:41 -08002234 if (!lock_page_or_retry(page, vmf->vma->vm_mm, vmf->flags)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002235 put_page(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07002236 return ret | VM_FAULT_RETRY;
Michel Lespinassed88c0922010-11-02 13:05:18 -07002237 }
Michel Lespinasseb522c942010-10-26 14:21:56 -07002238
2239 /* Did it get truncated? */
2240 if (unlikely(page->mapping != mapping)) {
2241 unlock_page(page);
2242 put_page(page);
2243 goto retry_find;
2244 }
Sasha Levin309381fea2014-01-23 15:52:54 -08002245 VM_BUG_ON_PAGE(page->index != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002246
Linus Torvalds1da177e2005-04-16 15:20:36 -07002247 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002248 * We have a locked page in the page cache, now we need to check
2249 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 */
Nick Piggind00806b2007-07-19 01:46:57 -07002251 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252 goto page_not_uptodate;
2253
Linus Torvaldsef00e082009-06-16 15:31:25 -07002254 /*
2255 * Found the page and have a reference on it.
2256 * We must recheck i_size under page lock.
2257 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002258 size = round_up(i_size_read(inode), PAGE_SIZE);
2259 if (unlikely(offset >= size >> PAGE_SHIFT)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002260 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002261 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002262 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002263 }
2264
Nick Piggind0217ac2007-07-19 01:47:03 -07002265 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002266 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267
Linus Torvalds1da177e2005-04-16 15:20:36 -07002268no_cached_page:
2269 /*
2270 * We're only likely to ever get here if MADV_RANDOM is in
2271 * effect.
2272 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002273 error = page_cache_read(file, offset, vmf->gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
2275 /*
2276 * The page we want has now been added to the page cache.
2277 * In the unlikely event that someone removed it in the
2278 * meantime, we'll just come back here and read it again.
2279 */
2280 if (error >= 0)
2281 goto retry_find;
2282
2283 /*
2284 * An error return from page_cache_read can result if the
2285 * system is low on memory, or a problem occurs while trying
2286 * to schedule I/O.
2287 */
2288 if (error == -ENOMEM)
Nick Piggind0217ac2007-07-19 01:47:03 -07002289 return VM_FAULT_OOM;
2290 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002291
2292page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002293 /*
2294 * Umm, take care of errors if the page isn't up-to-date.
2295 * Try to re-read it _once_. We do this synchronously,
2296 * because there really aren't any performance issues here
2297 * and we need to check for errors.
2298 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002299 ClearPageError(page);
Zach Brown994fc28c2005-12-15 14:28:17 -08002300 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002301 if (!error) {
2302 wait_on_page_locked(page);
2303 if (!PageUptodate(page))
2304 error = -EIO;
2305 }
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002306 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002307
2308 if (!error || error == AOP_TRUNCATED_PAGE)
2309 goto retry_find;
2310
2311 /* Things didn't work out. Return zero to tell the mm layer so. */
2312 shrink_readahead_size_eio(file, ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002313 return VM_FAULT_SIGBUS;
Nick Piggin54cb8822007-07-19 01:46:59 -07002314}
2315EXPORT_SYMBOL(filemap_fault);
2316
Jan Kara82b0f8c2016-12-14 15:06:58 -08002317void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002318 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002319{
2320 struct radix_tree_iter iter;
2321 void **slot;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002322 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002323 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002324 pgoff_t last_pgoff = start_pgoff;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002325 loff_t size;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002326 struct page *head, *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002327
2328 rcu_read_lock();
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002329 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter,
2330 start_pgoff) {
2331 if (iter.index > end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002332 break;
2333repeat:
2334 page = radix_tree_deref_slot(slot);
2335 if (unlikely(!page))
2336 goto next;
2337 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07002338 if (radix_tree_deref_retry(page)) {
2339 slot = radix_tree_iter_retry(&iter);
2340 continue;
2341 }
2342 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002343 }
2344
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002345 head = compound_head(page);
2346 if (!page_cache_get_speculative(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002347 goto repeat;
2348
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002349 /* The page was split under us? */
2350 if (compound_head(page) != head) {
2351 put_page(head);
2352 goto repeat;
2353 }
2354
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002355 /* Has the page moved? */
2356 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002357 put_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002358 goto repeat;
2359 }
2360
2361 if (!PageUptodate(page) ||
2362 PageReadahead(page) ||
2363 PageHWPoison(page))
2364 goto skip;
2365 if (!trylock_page(page))
2366 goto skip;
2367
2368 if (page->mapping != mapping || !PageUptodate(page))
2369 goto unlock;
2370
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002371 size = round_up(i_size_read(mapping->host), PAGE_SIZE);
2372 if (page->index >= size >> PAGE_SHIFT)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002373 goto unlock;
2374
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002375 if (file->f_ra.mmap_miss > 0)
2376 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002377
Jan Kara82b0f8c2016-12-14 15:06:58 -08002378 vmf->address += (iter.index - last_pgoff) << PAGE_SHIFT;
2379 if (vmf->pte)
2380 vmf->pte += iter.index - last_pgoff;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002381 last_pgoff = iter.index;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002382 if (alloc_set_pte(vmf, NULL, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002383 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002384 unlock_page(page);
2385 goto next;
2386unlock:
2387 unlock_page(page);
2388skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002389 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002390next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002391 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002392 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002393 break;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002394 if (iter.index == end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002395 break;
2396 }
2397 rcu_read_unlock();
2398}
2399EXPORT_SYMBOL(filemap_map_pages);
2400
Dave Jiang11bac802017-02-24 14:56:41 -08002401int filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002402{
2403 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002404 struct inode *inode = file_inode(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002405 int ret = VM_FAULT_LOCKED;
2406
Jan Kara14da9202012-06-12 16:20:37 +02002407 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002408 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002409 lock_page(page);
2410 if (page->mapping != inode->i_mapping) {
2411 unlock_page(page);
2412 ret = VM_FAULT_NOPAGE;
2413 goto out;
2414 }
Jan Kara14da9202012-06-12 16:20:37 +02002415 /*
2416 * We mark the page dirty already here so that when freeze is in
2417 * progress, we are guaranteed that writeback during freezing will
2418 * see the dirty page and writeprotect it again.
2419 */
2420 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002421 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002422out:
Jan Kara14da9202012-06-12 16:20:37 +02002423 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002424 return ret;
2425}
2426EXPORT_SYMBOL(filemap_page_mkwrite);
2427
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002428const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002429 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002430 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002431 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002432};
2433
2434/* This is used for a general mmap of a disk file */
2435
2436int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2437{
2438 struct address_space *mapping = file->f_mapping;
2439
2440 if (!mapping->a_ops->readpage)
2441 return -ENOEXEC;
2442 file_accessed(file);
2443 vma->vm_ops = &generic_file_vm_ops;
2444 return 0;
2445}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002446
2447/*
2448 * This is for filesystems which do not implement ->writepage.
2449 */
2450int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2451{
2452 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2453 return -EINVAL;
2454 return generic_file_mmap(file, vma);
2455}
2456#else
2457int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2458{
2459 return -ENOSYS;
2460}
2461int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2462{
2463 return -ENOSYS;
2464}
2465#endif /* CONFIG_MMU */
2466
2467EXPORT_SYMBOL(generic_file_mmap);
2468EXPORT_SYMBOL(generic_file_readonly_mmap);
2469
Sasha Levin67f9fd92014-04-03 14:48:18 -07002470static struct page *wait_on_page_read(struct page *page)
2471{
2472 if (!IS_ERR(page)) {
2473 wait_on_page_locked(page);
2474 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002475 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002476 page = ERR_PTR(-EIO);
2477 }
2478 }
2479 return page;
2480}
2481
Mel Gorman32b63522016-03-15 14:55:36 -07002482static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002483 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002484 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002485 void *data,
2486 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002487{
Nick Piggineb2be182007-10-16 01:24:57 -07002488 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002489 int err;
2490repeat:
2491 page = find_get_page(mapping, index);
2492 if (!page) {
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002493 page = __page_cache_alloc(gfp | __GFP_COLD);
Nick Piggineb2be182007-10-16 01:24:57 -07002494 if (!page)
2495 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002496 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002497 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002498 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002499 if (err == -EEXIST)
2500 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002501 /* Presumably ENOMEM for radix tree node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502 return ERR_PTR(err);
2503 }
Mel Gorman32b63522016-03-15 14:55:36 -07002504
2505filler:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 err = filler(data, page);
2507 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002508 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002509 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510 }
Mel Gorman32b63522016-03-15 14:55:36 -07002511
2512 page = wait_on_page_read(page);
2513 if (IS_ERR(page))
2514 return page;
2515 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002516 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002517 if (PageUptodate(page))
2518 goto out;
2519
Mel Gormanebded022016-03-15 14:55:39 -07002520 /*
2521 * Page is not up to date and may be locked due one of the following
2522 * case a: Page is being filled and the page lock is held
2523 * case b: Read/write error clearing the page uptodate status
2524 * case c: Truncation in progress (page locked)
2525 * case d: Reclaim in progress
2526 *
2527 * Case a, the page will be up to date when the page is unlocked.
2528 * There is no need to serialise on the page lock here as the page
2529 * is pinned so the lock gives no additional protection. Even if the
2530 * the page is truncated, the data is still valid if PageUptodate as
2531 * it's a race vs truncate race.
2532 * Case b, the page will not be up to date
2533 * Case c, the page may be truncated but in itself, the data may still
2534 * be valid after IO completes as it's a read vs truncate race. The
2535 * operation must restart if the page is not uptodate on unlock but
2536 * otherwise serialising on page lock to stabilise the mapping gives
2537 * no additional guarantees to the caller as the page lock is
2538 * released before return.
2539 * Case d, similar to truncation. If reclaim holds the page lock, it
2540 * will be a race with remove_mapping that determines if the mapping
2541 * is valid on unlock but otherwise the data is valid and there is
2542 * no need to serialise with page lock.
2543 *
2544 * As the page lock gives no additional guarantee, we optimistically
2545 * wait on the page to be unlocked and check if it's up to date and
2546 * use the page if it is. Otherwise, the page lock is required to
2547 * distinguish between the different cases. The motivation is that we
2548 * avoid spurious serialisations and wakeups when multiple processes
2549 * wait on the same page for IO to complete.
2550 */
2551 wait_on_page_locked(page);
2552 if (PageUptodate(page))
2553 goto out;
2554
2555 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002556 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002557
2558 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559 if (!page->mapping) {
2560 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002561 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002562 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563 }
Mel Gormanebded022016-03-15 14:55:39 -07002564
2565 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566 if (PageUptodate(page)) {
2567 unlock_page(page);
2568 goto out;
2569 }
Mel Gorman32b63522016-03-15 14:55:36 -07002570 goto filler;
2571
David Howellsc855ff32007-05-09 13:42:20 +01002572out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002573 mark_page_accessed(page);
2574 return page;
2575}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002576
2577/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002578 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002579 * @mapping: the page's address_space
2580 * @index: the page index
2581 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002582 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002583 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002584 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002585 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002586 *
2587 * If the page does not get brought uptodate, return -EIO.
2588 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002589struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002590 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002591 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002592 void *data)
2593{
2594 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2595}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002596EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002597
2598/**
2599 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2600 * @mapping: the page's address_space
2601 * @index: the page index
2602 * @gfp: the page allocator flags to use if allocating
2603 *
2604 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002605 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002606 *
2607 * If the page does not get brought uptodate, return -EIO.
2608 */
2609struct page *read_cache_page_gfp(struct address_space *mapping,
2610 pgoff_t index,
2611 gfp_t gfp)
2612{
2613 filler_t *filler = (filler_t *)mapping->a_ops->readpage;
2614
Sasha Levin67f9fd92014-04-03 14:48:18 -07002615 return do_read_cache_page(mapping, index, filler, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002616}
2617EXPORT_SYMBOL(read_cache_page_gfp);
2618
Nick Piggin2f718ff2007-10-16 01:24:59 -07002619/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002620 * Performs necessary checks before doing a write
2621 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002622 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 * Returns appropriate error code that caller should return or
2624 * zero in case that write should be allowed.
2625 */
Al Viro3309dd02015-04-09 12:55:47 -04002626inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002627{
Al Viro3309dd02015-04-09 12:55:47 -04002628 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629 struct inode *inode = file->f_mapping->host;
Jiri Slaby59e99e52010-03-05 13:41:44 -08002630 unsigned long limit = rlimit(RLIMIT_FSIZE);
Al Viro3309dd02015-04-09 12:55:47 -04002631 loff_t pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632
Al Viro3309dd02015-04-09 12:55:47 -04002633 if (!iov_iter_count(from))
2634 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
Al Viro0fa6b002015-04-04 04:05:48 -04002636 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002637 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002638 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002639
Al Viro3309dd02015-04-09 12:55:47 -04002640 pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002641
Al Viro0fa6b002015-04-04 04:05:48 -04002642 if (limit != RLIM_INFINITY) {
Al Viro3309dd02015-04-09 12:55:47 -04002643 if (iocb->ki_pos >= limit) {
Al Viro0fa6b002015-04-04 04:05:48 -04002644 send_sig(SIGXFSZ, current, 0);
2645 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002646 }
Al Viro3309dd02015-04-09 12:55:47 -04002647 iov_iter_truncate(from, limit - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002648 }
2649
2650 /*
2651 * LFS rule
2652 */
Al Viro3309dd02015-04-09 12:55:47 -04002653 if (unlikely(pos + iov_iter_count(from) > MAX_NON_LFS &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002654 !(file->f_flags & O_LARGEFILE))) {
Al Viro3309dd02015-04-09 12:55:47 -04002655 if (pos >= MAX_NON_LFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002656 return -EFBIG;
Al Viro3309dd02015-04-09 12:55:47 -04002657 iov_iter_truncate(from, MAX_NON_LFS - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002658 }
2659
2660 /*
2661 * Are we about to exceed the fs block limit ?
2662 *
2663 * If we have written data it becomes a short write. If we have
2664 * exceeded without writing data we send a signal and return EFBIG.
2665 * Linus frestrict idea will clean these up nicely..
2666 */
Al Viro3309dd02015-04-09 12:55:47 -04002667 if (unlikely(pos >= inode->i_sb->s_maxbytes))
2668 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002669
Al Viro3309dd02015-04-09 12:55:47 -04002670 iov_iter_truncate(from, inode->i_sb->s_maxbytes - pos);
2671 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672}
2673EXPORT_SYMBOL(generic_write_checks);
2674
Nick Pigginafddba42007-10-16 01:25:01 -07002675int pagecache_write_begin(struct file *file, struct address_space *mapping,
2676 loff_t pos, unsigned len, unsigned flags,
2677 struct page **pagep, void **fsdata)
2678{
2679 const struct address_space_operations *aops = mapping->a_ops;
2680
Nick Piggin4e02ed42008-10-29 14:00:55 -07002681 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002682 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002683}
2684EXPORT_SYMBOL(pagecache_write_begin);
2685
2686int pagecache_write_end(struct file *file, struct address_space *mapping,
2687 loff_t pos, unsigned len, unsigned copied,
2688 struct page *page, void *fsdata)
2689{
2690 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07002691
Nick Piggin4e02ed42008-10-29 14:00:55 -07002692 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002693}
2694EXPORT_SYMBOL(pagecache_write_end);
2695
Linus Torvalds1da177e2005-04-16 15:20:36 -07002696ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002697generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002698{
2699 struct file *file = iocb->ki_filp;
2700 struct address_space *mapping = file->f_mapping;
2701 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002702 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002703 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002704 size_t write_len;
2705 pgoff_t end;
Al Viro26978b82014-03-10 14:08:45 -04002706 struct iov_iter data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707
Al Viro0c949332014-03-22 06:51:37 -04002708 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002709 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002710
Nick Piggin48b47c52009-01-06 14:40:22 -08002711 written = filemap_write_and_wait_range(mapping, pos, pos + write_len - 1);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002712 if (written)
2713 goto out;
2714
2715 /*
2716 * After a write we want buffered reads to be sure to go to disk to get
2717 * the new data. We invalidate clean cached page from the region we're
2718 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002719 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07002720 */
2721 if (mapping->nrpages) {
2722 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002723 pos >> PAGE_SHIFT, end);
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002724 /*
2725 * If a page can not be invalidated, return 0 to fall back
2726 * to buffered write.
2727 */
2728 if (written) {
2729 if (written == -EBUSY)
2730 return 0;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002731 goto out;
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002732 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002733 }
2734
Al Viro26978b82014-03-10 14:08:45 -04002735 data = *from;
Christoph Hellwigc8b8e322016-04-07 08:51:58 -07002736 written = mapping->a_ops->direct_IO(iocb, &data);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002737
2738 /*
2739 * Finally, try again to invalidate clean pages which might have been
2740 * cached by non-direct readahead, or faulted in by get_user_pages()
2741 * if the source of the write was an mmap'ed region of the file
2742 * we're writing. Either one is a pretty crazy thing to do,
2743 * so we don't support it 100%. If this invalidation
2744 * fails, tough, the write still worked...
2745 */
2746 if (mapping->nrpages) {
2747 invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002748 pos >> PAGE_SHIFT, end);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002749 }
2750
Linus Torvalds1da177e2005-04-16 15:20:36 -07002751 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07002752 pos += written;
Al Virof8579f82014-03-03 22:03:20 -05002753 iov_iter_advance(from, written);
Namhyung Kim01166512010-10-26 14:21:58 -07002754 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
2755 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 mark_inode_dirty(inode);
2757 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05002758 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002760out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761 return written;
2762}
2763EXPORT_SYMBOL(generic_file_direct_write);
2764
Nick Piggineb2be182007-10-16 01:24:57 -07002765/*
2766 * Find or create a page at the given pagecache position. Return the locked
2767 * page. This function is specifically for buffered writes.
2768 */
Nick Piggin54566b22009-01-04 12:00:53 -08002769struct page *grab_cache_page_write_begin(struct address_space *mapping,
2770 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07002771{
Nick Piggineb2be182007-10-16 01:24:57 -07002772 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07002773 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08002774
Nick Piggin54566b22009-01-04 12:00:53 -08002775 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07002776 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07002777
Mel Gorman2457aec2014-06-04 16:10:31 -07002778 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01002779 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07002780 if (page)
2781 wait_for_stable_page(page);
2782
Nick Piggineb2be182007-10-16 01:24:57 -07002783 return page;
2784}
Nick Piggin54566b22009-01-04 12:00:53 -08002785EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07002786
Al Viro3b93f912014-02-11 21:34:08 -05002787ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07002788 struct iov_iter *i, loff_t pos)
2789{
2790 struct address_space *mapping = file->f_mapping;
2791 const struct address_space_operations *a_ops = mapping->a_ops;
2792 long status = 0;
2793 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07002794 unsigned int flags = 0;
2795
2796 /*
2797 * Copies from kernel address space cannot fail (NFSD is a big user).
2798 */
Al Viro777eda22014-12-17 04:46:46 -05002799 if (!iter_is_iovec(i))
Nick Piggin674b8922007-10-16 01:25:03 -07002800 flags |= AOP_FLAG_UNINTERRUPTIBLE;
Nick Pigginafddba42007-10-16 01:25:01 -07002801
2802 do {
2803 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07002804 unsigned long offset; /* Offset into pagecache page */
2805 unsigned long bytes; /* Bytes to write to page */
2806 size_t copied; /* Bytes copied from user */
2807 void *fsdata;
2808
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002809 offset = (pos & (PAGE_SIZE - 1));
2810 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002811 iov_iter_count(i));
2812
2813again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01002814 /*
2815 * Bring in the user page that we will copy from _first_.
2816 * Otherwise there's a nasty deadlock on copying from the
2817 * same page as we're writing to, without it being marked
2818 * up-to-date.
2819 *
2820 * Not only is this an optimisation, but it is also required
2821 * to check that the address is actually valid, when atomic
2822 * usercopies are used, below.
2823 */
2824 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
2825 status = -EFAULT;
2826 break;
2827 }
2828
Jan Kara296291c2015-10-22 13:32:21 -07002829 if (fatal_signal_pending(current)) {
2830 status = -EINTR;
2831 break;
2832 }
2833
Nick Piggin674b8922007-10-16 01:25:03 -07002834 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002835 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07002836 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07002837 break;
2838
anfei zhou931e80e2010-02-02 13:44:02 -08002839 if (mapping_writably_mapped(mapping))
2840 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01002841
Nick Pigginafddba42007-10-16 01:25:01 -07002842 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07002843 flush_dcache_page(page);
2844
2845 status = a_ops->write_end(file, mapping, pos, bytes, copied,
2846 page, fsdata);
2847 if (unlikely(status < 0))
2848 break;
2849 copied = status;
2850
2851 cond_resched();
2852
Nick Piggin124d3b72008-02-02 15:01:17 +01002853 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07002854 if (unlikely(copied == 0)) {
2855 /*
2856 * If we were unable to copy any data at all, we must
2857 * fall back to a single segment length write.
2858 *
2859 * If we didn't fallback here, we could livelock
2860 * because not all segments in the iov can be copied at
2861 * once without a pagefault.
2862 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002863 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002864 iov_iter_single_seg_count(i));
2865 goto again;
2866 }
Nick Pigginafddba42007-10-16 01:25:01 -07002867 pos += copied;
2868 written += copied;
2869
2870 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07002871 } while (iov_iter_count(i));
2872
2873 return written ? written : status;
2874}
Al Viro3b93f912014-02-11 21:34:08 -05002875EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002876
Jan Karae4dd9de2009-08-17 18:10:06 +02002877/**
Al Viro81742022014-04-03 03:17:43 -04002878 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02002879 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04002880 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02002881 *
2882 * This function does all the work needed for actually writing data to a
2883 * file. It does all basic checks, removes SUID from the file, updates
2884 * modification times and calls proper subroutines depending on whether we
2885 * do direct IO or a standard buffered write.
2886 *
2887 * It expects i_mutex to be grabbed unless we work on a block device or similar
2888 * object which does not need locking at all.
2889 *
2890 * This function does *not* take care of syncing data in case of O_SYNC write.
2891 * A caller has to handle it. This is mainly due to the fact that we want to
2892 * avoid syncing under i_mutex.
2893 */
Al Viro81742022014-04-03 03:17:43 -04002894ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895{
2896 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002897 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05002899 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002900 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05002901 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002902
Linus Torvalds1da177e2005-04-16 15:20:36 -07002903 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01002904 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002905 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002906 if (err)
2907 goto out;
2908
Josef Bacikc3b2da32012-03-26 09:59:21 -04002909 err = file_update_time(file);
2910 if (err)
2911 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002912
Al Viro2ba48ce2015-04-09 13:52:01 -04002913 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04002914 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002915
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002916 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002917 /*
2918 * If the write stopped short of completing, fall back to
2919 * buffered writes. Some filesystems do this for writes to
2920 * holes, for example. For DAX files, a buffered write will
2921 * not succeed (even if it did, DAX does not handle dirty
2922 * page-cache pages correctly).
2923 */
Al Viro0b8def92015-04-07 10:22:53 -04002924 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002925 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05002926
Al Viro0b8def92015-04-07 10:22:53 -04002927 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002928 /*
Al Viro3b93f912014-02-11 21:34:08 -05002929 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002930 * then we want to return the number of bytes which were
2931 * direct-written, or the error code if that was zero. Note
2932 * that this differs from normal direct-io semantics, which
2933 * will return -EFOO even if some bytes were written.
2934 */
Al Viro60bb4522014-08-08 12:39:16 -04002935 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05002936 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002937 goto out;
2938 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002939 /*
2940 * We need to ensure that the page cache pages are written to
2941 * disk and invalidated to preserve the expected O_DIRECT
2942 * semantics.
2943 */
Al Viro3b93f912014-02-11 21:34:08 -05002944 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04002945 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002946 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04002947 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05002948 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002949 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002950 pos >> PAGE_SHIFT,
2951 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002952 } else {
2953 /*
2954 * We don't know how much we wrote, so just return
2955 * the number of bytes which were direct-written
2956 */
2957 }
2958 } else {
Al Viro0b8def92015-04-07 10:22:53 -04002959 written = generic_perform_write(file, from, iocb->ki_pos);
2960 if (likely(written > 0))
2961 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002962 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002963out:
2964 current->backing_dev_info = NULL;
2965 return written ? written : err;
2966}
Al Viro81742022014-04-03 03:17:43 -04002967EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002968
Jan Karae4dd9de2009-08-17 18:10:06 +02002969/**
Al Viro81742022014-04-03 03:17:43 -04002970 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02002971 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04002972 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02002973 *
Al Viro81742022014-04-03 03:17:43 -04002974 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02002975 * filesystems. It takes care of syncing the file in case of O_SYNC file
2976 * and acquires i_mutex as needed.
2977 */
Al Viro81742022014-04-03 03:17:43 -04002978ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002979{
2980 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02002981 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002982 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002983
Al Viro59551022016-01-22 15:40:57 -05002984 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04002985 ret = generic_write_checks(iocb, from);
2986 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04002987 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05002988 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002989
Christoph Hellwige2592212016-04-07 08:52:01 -07002990 if (ret > 0)
2991 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002992 return ret;
2993}
Al Viro81742022014-04-03 03:17:43 -04002994EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002995
David Howellscf9a2ae2006-08-29 19:05:54 +01002996/**
2997 * try_to_release_page() - release old fs-specific metadata on a page
2998 *
2999 * @page: the page which the kernel is trying to free
3000 * @gfp_mask: memory allocation flags (and I/O mode)
3001 *
3002 * The address_space is to try to release any data against the page
3003 * (presumably at page->private). If the release was successful, return `1'.
3004 * Otherwise return zero.
3005 *
David Howells266cf652009-04-03 16:42:36 +01003006 * This may also be called if PG_fscache is set on a page, indicating that the
3007 * page is known to the local caching routines.
3008 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003009 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003010 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003011 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003012 */
3013int try_to_release_page(struct page *page, gfp_t gfp_mask)
3014{
3015 struct address_space * const mapping = page->mapping;
3016
3017 BUG_ON(!PageLocked(page));
3018 if (PageWriteback(page))
3019 return 0;
3020
3021 if (mapping && mapping->a_ops->releasepage)
3022 return mapping->a_ops->releasepage(page, gfp_mask);
3023 return try_to_free_buffers(page);
3024}
3025
3026EXPORT_SYMBOL(try_to_release_page);