blob: 80c19ee81e9515a70d4ebe04c845bf4d8ecf349a [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>
Ingo Molnar3f07c012017-02-08 18:51:30 +010016#include <linux/sched/signal.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070017#include <linux/uaccess.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080018#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#include <linux/mm.h>
22#include <linux/swap.h>
23#include <linux/mman.h>
24#include <linux/pagemap.h>
25#include <linux/file.h>
26#include <linux/uio.h>
27#include <linux/hash.h>
28#include <linux/writeback.h>
Linus Torvalds53253382007-10-18 14:47:32 -070029#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <linux/pagevec.h>
31#include <linux/blkdev.h>
32#include <linux/security.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080033#include <linux/cpuset.h>
Nick Piggin2f718ff2007-10-16 01:24:59 -070034#include <linux/hardirq.h> /* for BUG_ON(!in_atomic()) only */
Johannes Weiner00501b52014-08-08 14:19:20 -070035#include <linux/hugetlb.h>
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080036#include <linux/memcontrol.h>
Dan Magenheimerc515e1f2011-05-26 10:01:43 -060037#include <linux/cleancache.h>
Kirill A. Shutemovf1820362014-04-07 15:37:19 -070038#include <linux/rmap.h>
Nick Piggin0f8053a2006-03-22 00:08:33 -080039#include "internal.h"
40
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -070041#define CREATE_TRACE_POINTS
42#include <trace/events/filemap.h>
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 * FIXME: remove all knowledge of the buffer layer from the core VM
46 */
Jan Kara148f9482009-08-17 19:52:36 +020047#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#include <asm/mman.h>
50
51/*
52 * Shared mappings implemented 30.11.1994. It's not fully working yet,
53 * though.
54 *
55 * Shared mappings now work. 15.8.1995 Bruno.
56 *
57 * finished 'unifying' the page and buffer cache and SMP-threaded the
58 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
59 *
60 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
61 */
62
63/*
64 * Lock ordering:
65 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080066 * ->i_mmap_rwsem (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070068 * ->swap_lock (exclusive_swap_page, others)
69 * ->mapping->tree_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080071 * ->i_mutex
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080072 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 *
74 * ->mmap_sem
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080075 * ->i_mmap_rwsem
Hugh Dickinsb8072f02005-10-29 18:16:41 -070076 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077 * ->mapping->tree_lock (arch-dependent flush_dcache_mmap_lock)
78 *
79 * ->mmap_sem
80 * ->lock_page (access_process_vm)
81 *
Al Viroccad2362014-02-11 22:36:48 -050082 * ->i_mutex (generic_perform_write)
Nick Piggin82591e62006-10-19 23:29:10 -070083 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 *
Christoph Hellwigf758eea2011-04-21 18:19:44 -060085 * bdi->wb.list_lock
Dave Chinnera66979a2011-03-22 22:23:41 +110086 * sb_lock (fs/fs-writeback.c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087 * ->mapping->tree_lock (__sync_single_inode)
88 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -080089 * ->i_mmap_rwsem
Linus Torvalds1da177e2005-04-16 15:20:36 -070090 * ->anon_vma.lock (vma_adjust)
91 *
92 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070093 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -070095 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -070096 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 * ->private_lock (try_to_unmap_one)
98 * ->tree_lock (try_to_unmap_one)
Mel Gormana52633d2016-07-28 15:45:28 -070099 * ->zone_lru_lock(zone) (follow_page->mark_page_accessed)
100 * ->zone_lru_lock(zone) (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101 * ->private_lock (page_remove_rmap->set_page_dirty)
102 * ->tree_lock (page_remove_rmap->set_page_dirty)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600103 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100104 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
Johannes Weiner81f8c3a2016-03-15 14:57:04 -0700105 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
Christoph Hellwigf758eea2011-04-21 18:19:44 -0600106 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
Dave Chinner250df6e2011-03-22 22:23:36 +1100107 * ->inode->i_lock (zap_pte_range->set_page_dirty)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
109 *
Davidlohr Buesoc8c06ef2014-12-12 16:54:24 -0800110 * ->i_mmap_rwsem
Andi Kleen9a3c5312012-03-21 16:34:09 -0700111 * ->tasklist_lock (memory_failure, collect_procs_ao)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 */
113
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700114static int page_cache_tree_insert(struct address_space *mapping,
115 struct page *page, void **shadowp)
116{
117 struct radix_tree_node *node;
118 void **slot;
119 int error;
120
121 error = __radix_tree_create(&mapping->page_tree, page->index, 0,
122 &node, &slot);
123 if (error)
124 return error;
125 if (*slot) {
126 void *p;
127
128 p = radix_tree_deref_slot_protected(slot, &mapping->tree_lock);
129 if (!radix_tree_exceptional_entry(p))
130 return -EEXIST;
131
132 mapping->nrexceptional--;
133 if (!dax_mapping(mapping)) {
134 if (shadowp)
135 *shadowp = p;
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700136 } else {
137 /* DAX can replace empty locked entry with a hole */
138 WARN_ON_ONCE(p !=
Ross Zwisler642261a2016-11-08 11:34:45 +1100139 dax_radix_locked_entry(0, RADIX_DAX_EMPTY));
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700140 /* Wakeup waiters for exceptional entry lock */
Ross Zwisler63e95b52016-11-08 11:32:20 +1100141 dax_wake_mapping_entry_waiter(mapping, page->index, p,
Ross Zwisler965d0042017-01-10 16:57:15 -0800142 true);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700143 }
144 }
Johannes Weiner14b46872016-12-12 16:43:52 -0800145 __radix_tree_replace(&mapping->page_tree, node, slot, page,
146 workingset_update_node, mapping);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700147 mapping->nrpages++;
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700148 return 0;
149}
150
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700151static void page_cache_tree_delete(struct address_space *mapping,
152 struct page *page, void *shadow)
153{
Kirill A. Shutemovc70b6472016-12-12 16:43:17 -0800154 int i, nr;
155
156 /* hugetlb pages are represented by one entry in the radix tree */
157 nr = PageHuge(page) ? 1 : hpage_nr_pages(page);
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700158
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700159 VM_BUG_ON_PAGE(!PageLocked(page), page);
160 VM_BUG_ON_PAGE(PageTail(page), page);
161 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700162
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700163 for (i = 0; i < nr; i++) {
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200164 struct radix_tree_node *node;
165 void **slot;
166
167 __radix_tree_lookup(&mapping->page_tree, page->index + i,
168 &node, &slot);
169
Johannes Weinerdbc446b2016-12-12 16:43:55 -0800170 VM_BUG_ON_PAGE(!node && nr != 1, page);
Johannes Weiner449dd692014-04-03 14:47:56 -0700171
Johannes Weiner14b46872016-12-12 16:43:52 -0800172 radix_tree_clear_tags(&mapping->page_tree, node, slot);
173 __radix_tree_replace(&mapping->page_tree, node, slot, shadow,
174 workingset_update_node, mapping);
Johannes Weiner449dd692014-04-03 14:47:56 -0700175 }
Johannes Weinerd3798ae2016-10-04 22:02:08 +0200176
177 if (shadow) {
178 mapping->nrexceptional += nr;
179 /*
180 * Make sure the nrexceptional update is committed before
181 * the nrpages update so that final truncate racing
182 * with reclaim does not see both counters 0 at the
183 * same time and miss a shadow entry.
184 */
185 smp_wmb();
186 }
187 mapping->nrpages -= nr;
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700188}
189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190/*
Minchan Kime64a7822011-03-22 16:32:44 -0700191 * Delete a page from the page cache and free it. Caller has to make
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 * sure the page is locked and that nobody else uses it - or that usage
Johannes Weinerfdf1cdb2016-03-15 14:57:25 -0700193 * is safe. The caller must hold the mapping's tree_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 */
Johannes Weiner62cccb82016-03-15 14:57:22 -0700195void __delete_from_page_cache(struct page *page, void *shadow)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196{
197 struct address_space *mapping = page->mapping;
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700198 int nr = hpage_nr_pages(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Robert Jarzmikfe0bfaa2013-04-29 15:06:10 -0700200 trace_mm_filemap_delete_from_page_cache(page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600201 /*
202 * if we're uptodate, flush out into the cleancache, otherwise
203 * invalidate any existing cleancache entries. We can't leave
204 * stale data around in the cleancache once our page is gone
205 */
206 if (PageUptodate(page) && PageMappedToDisk(page))
207 cleancache_put_page(page);
208 else
Dan Magenheimer31677602011-09-21 11:56:28 -0400209 cleancache_invalidate_page(mapping, page);
Dan Magenheimerc515e1f2011-05-26 10:01:43 -0600210
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700211 VM_BUG_ON_PAGE(PageTail(page), page);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800212 VM_BUG_ON_PAGE(page_mapped(page), page);
213 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
214 int mapcount;
215
216 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
217 current->comm, page_to_pfn(page));
218 dump_page(page, "still mapped when deleted");
219 dump_stack();
220 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
221
222 mapcount = page_mapcount(page);
223 if (mapping_exiting(mapping) &&
224 page_count(page) >= mapcount + 2) {
225 /*
226 * All vmas have already been torn down, so it's
227 * a good bet that actually the page is unmapped,
228 * and we'd prefer not to leak it: if we're wrong,
229 * some other bad page check should catch it later.
230 */
231 page_mapcount_reset(page);
Joonsoo Kim6d061f92016-05-19 17:10:46 -0700232 page_ref_sub(page, mapcount);
Hugh Dickins06b241f2016-03-09 14:08:07 -0800233 }
234 }
235
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700236 page_cache_tree_delete(mapping, page, shadow);
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 page->mapping = NULL;
Hugh Dickinsb85e0ef2011-07-25 17:12:25 -0700239 /* Leave page->index set: truncation lookup relies upon it */
Johannes Weiner91b0abe2014-04-03 14:47:49 -0700240
Michal Hocko4165b9b42015-06-24 16:57:24 -0700241 /* hugetlb pages do not participate in page cache accounting. */
242 if (!PageHuge(page))
Mel Gorman11fb9982016-07-28 15:46:20 -0700243 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700244 if (PageSwapBacked(page)) {
Mel Gorman11fb9982016-07-28 15:46:20 -0700245 __mod_node_page_state(page_pgdat(page), NR_SHMEM, -nr);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700246 if (PageTransHuge(page))
Mel Gorman11fb9982016-07-28 15:46:20 -0700247 __dec_node_page_state(page, NR_SHMEM_THPS);
Kirill A. Shutemov800d8c62016-07-26 15:26:18 -0700248 } else {
249 VM_BUG_ON_PAGE(PageTransHuge(page) && !PageHuge(page), page);
250 }
Linus Torvalds3a692792007-12-19 14:05:13 -0800251
252 /*
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700253 * At this point page must be either written or cleaned by truncate.
254 * Dirty page here signals a bug and loss of unwritten data.
Linus Torvalds3a692792007-12-19 14:05:13 -0800255 *
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700256 * This fixes dirty accounting after removing the page entirely but
257 * leaves PageDirty set: it has no effect for truncated page and
258 * anyway will be cleared before returning page into buddy allocator.
Linus Torvalds3a692792007-12-19 14:05:13 -0800259 */
Konstantin Khlebnikovb9ea2512015-04-14 15:45:27 -0700260 if (WARN_ON_ONCE(PageDirty(page)))
Johannes Weiner62cccb82016-03-15 14:57:22 -0700261 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262}
263
Minchan Kim702cfbf2011-03-22 16:32:43 -0700264/**
265 * delete_from_page_cache - delete page from page cache
266 * @page: the page which the kernel is trying to remove from page cache
267 *
268 * This must be called only on pages that have been verified to be in the page
269 * cache and locked. It will never put the page into the free list, the caller
270 * has a reference on the page.
271 */
272void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700274 struct address_space *mapping = page_mapping(page);
Greg Thelenc4843a72015-05-22 17:13:16 -0400275 unsigned long flags;
Linus Torvalds6072d132010-12-01 13:35:19 -0500276 void (*freepage)(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277
Matt Mackallcd7619d2005-05-01 08:59:01 -0700278 BUG_ON(!PageLocked(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279
Linus Torvalds6072d132010-12-01 13:35:19 -0500280 freepage = mapping->a_ops->freepage;
Greg Thelenc4843a72015-05-22 17:13:16 -0400281
Greg Thelenc4843a72015-05-22 17:13:16 -0400282 spin_lock_irqsave(&mapping->tree_lock, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700283 __delete_from_page_cache(page, NULL);
Greg Thelenc4843a72015-05-22 17:13:16 -0400284 spin_unlock_irqrestore(&mapping->tree_lock, flags);
Linus Torvalds6072d132010-12-01 13:35:19 -0500285
286 if (freepage)
287 freepage(page);
Kirill A. Shutemov83929372016-07-26 15:26:04 -0700288
289 if (PageTransHuge(page) && !PageHuge(page)) {
290 page_ref_sub(page, HPAGE_PMD_NR);
291 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
292 } else {
293 put_page(page);
294 }
Minchan Kim97cecb52011-03-22 16:30:53 -0700295}
296EXPORT_SYMBOL(delete_from_page_cache);
297
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200298int filemap_check_errors(struct address_space *mapping)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700299{
300 int ret = 0;
301 /* Check for outstanding write errors */
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700302 if (test_bit(AS_ENOSPC, &mapping->flags) &&
303 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700304 ret = -ENOSPC;
Jens Axboe7fcbbaf2014-05-22 11:54:16 -0700305 if (test_bit(AS_EIO, &mapping->flags) &&
306 test_and_clear_bit(AS_EIO, &mapping->flags))
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700307 ret = -EIO;
308 return ret;
309}
Miklos Szeredid72d9e22016-07-29 14:10:57 +0200310EXPORT_SYMBOL(filemap_check_errors);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700311
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700313 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700314 * @mapping: address space structure to write
315 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800316 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700317 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700319 * Start writeback against all of a mapping's dirty pages that lie
320 * within the byte offsets <start, end> inclusive.
321 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700323 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 * these two operations is that if a dirty page/buffer is encountered, it must
325 * be waited upon, and not just skipped over.
326 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800327int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
328 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329{
330 int ret;
331 struct writeback_control wbc = {
332 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800333 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700334 .range_start = start,
335 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 };
337
338 if (!mapping_cap_writeback_dirty(mapping))
339 return 0;
340
Tejun Heob16b1de2015-06-02 08:39:48 -0600341 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 ret = do_writepages(mapping, &wbc);
Tejun Heob16b1de2015-06-02 08:39:48 -0600343 wbc_detach_inode(&wbc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 return ret;
345}
346
347static inline int __filemap_fdatawrite(struct address_space *mapping,
348 int sync_mode)
349{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700350 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351}
352
353int filemap_fdatawrite(struct address_space *mapping)
354{
355 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
356}
357EXPORT_SYMBOL(filemap_fdatawrite);
358
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400359int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800360 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361{
362 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
363}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400364EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365
Randy Dunlap485bb992006-06-23 02:03:49 -0700366/**
367 * filemap_flush - mostly a non-blocking flush
368 * @mapping: target address_space
369 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 * This is a mostly non-blocking flush. Not suitable for data-integrity
371 * purposes - I/O may not be started against all dirty pages.
372 */
373int filemap_flush(struct address_space *mapping)
374{
375 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
376}
377EXPORT_SYMBOL(filemap_flush);
378
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800379static int __filemap_fdatawait_range(struct address_space *mapping,
380 loff_t start_byte, loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300382 pgoff_t index = start_byte >> PAGE_SHIFT;
383 pgoff_t end = end_byte >> PAGE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 struct pagevec pvec;
385 int nr_pages;
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800386 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200388 if (end_byte < start_byte)
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700389 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 pagevec_init(&pvec, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 while ((index <= end) &&
393 (nr_pages = pagevec_lookup_tag(&pvec, mapping, &index,
394 PAGECACHE_TAG_WRITEBACK,
395 min(end - index, (pgoff_t)PAGEVEC_SIZE-1) + 1)) != 0) {
396 unsigned i;
397
398 for (i = 0; i < nr_pages; i++) {
399 struct page *page = pvec.pages[i];
400
401 /* until radix tree lookup accepts end_index */
402 if (page->index > end)
403 continue;
404
405 wait_on_page_writeback(page);
Rik van Riel212260a2011-01-13 15:46:06 -0800406 if (TestClearPageError(page))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 ret = -EIO;
408 }
409 pagevec_release(&pvec);
410 cond_resched();
411 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700412out:
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800413 return ret;
414}
415
416/**
417 * filemap_fdatawait_range - wait for writeback to complete
418 * @mapping: address space structure to wait for
419 * @start_byte: offset in bytes where the range starts
420 * @end_byte: offset in bytes where the range ends (inclusive)
421 *
422 * Walk the list of under-writeback pages of the given address space
423 * in the given range and wait for all of them. Check error status of
424 * the address space and return it.
425 *
426 * Since the error status of the address space is cleared by this function,
427 * callers are responsible for checking the return value and handling and/or
428 * reporting the error.
429 */
430int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
431 loff_t end_byte)
432{
433 int ret, ret2;
434
435 ret = __filemap_fdatawait_range(mapping, start_byte, end_byte);
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700436 ret2 = filemap_check_errors(mapping);
437 if (!ret)
438 ret = ret2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439
440 return ret;
441}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200442EXPORT_SYMBOL(filemap_fdatawait_range);
443
444/**
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800445 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
446 * @mapping: address space structure to wait for
447 *
448 * Walk the list of under-writeback pages of the given address space
449 * and wait for all of them. Unlike filemap_fdatawait(), this function
450 * does not clear error status of the address space.
451 *
452 * Use this function if callers don't handle errors themselves. Expected
453 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
454 * fsfreeze(8)
455 */
456void filemap_fdatawait_keep_errors(struct address_space *mapping)
457{
458 loff_t i_size = i_size_read(mapping->host);
459
460 if (i_size == 0)
461 return;
462
463 __filemap_fdatawait_range(mapping, 0, i_size - 1);
464}
465
466/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700467 * filemap_fdatawait - wait for all under-writeback pages to complete
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 * @mapping: address space structure to wait for
Randy Dunlap485bb992006-06-23 02:03:49 -0700469 *
470 * Walk the list of under-writeback pages of the given address space
Junichi Nomuraaa750fd2015-11-05 18:47:23 -0800471 * and wait for all of them. Check error status of the address space
472 * and return it.
473 *
474 * Since the error status of the address space is cleared by this function,
475 * callers are responsible for checking the return value and handling and/or
476 * reporting the error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 */
478int filemap_fdatawait(struct address_space *mapping)
479{
480 loff_t i_size = i_size_read(mapping->host);
481
482 if (i_size == 0)
483 return 0;
484
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200485 return filemap_fdatawait_range(mapping, 0, i_size - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487EXPORT_SYMBOL(filemap_fdatawait);
488
489int filemap_write_and_wait(struct address_space *mapping)
490{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800491 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492
Ross Zwisler7f6d5b52016-02-26 15:19:55 -0800493 if ((!dax_mapping(mapping) && mapping->nrpages) ||
494 (dax_mapping(mapping) && mapping->nrexceptional)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800495 err = filemap_fdatawrite(mapping);
496 /*
497 * Even if the above returned error, the pages may be
498 * written partially (e.g. -ENOSPC), so we wait for it.
499 * But the -EIO is special case, it may indicate the worst
500 * thing (e.g. bug) happened, so we avoid waiting for it.
501 */
502 if (err != -EIO) {
503 int err2 = filemap_fdatawait(mapping);
504 if (!err)
505 err = err2;
506 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700507 } else {
508 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800510 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511}
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800512EXPORT_SYMBOL(filemap_write_and_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Randy Dunlap485bb992006-06-23 02:03:49 -0700514/**
515 * filemap_write_and_wait_range - write out & wait on a file range
516 * @mapping: the address_space for the pages
517 * @lstart: offset in bytes where the range starts
518 * @lend: offset in bytes where the range ends (inclusive)
519 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800520 * Write out and wait upon file offsets lstart->lend, inclusive.
521 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -0300522 * Note that @lend is inclusive (describes the last byte to be written) so
Andrew Morton469eb4d2006-03-24 03:17:45 -0800523 * that this function can be used to write to the very end-of-file (end = -1).
524 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525int filemap_write_and_wait_range(struct address_space *mapping,
526 loff_t lstart, loff_t lend)
527{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800528 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
Ross Zwisler7f6d5b52016-02-26 15:19:55 -0800530 if ((!dax_mapping(mapping) && mapping->nrpages) ||
531 (dax_mapping(mapping) && mapping->nrexceptional)) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800532 err = __filemap_fdatawrite_range(mapping, lstart, lend,
533 WB_SYNC_ALL);
534 /* See comment of filemap_write_and_wait() */
535 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200536 int err2 = filemap_fdatawait_range(mapping,
537 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800538 if (!err)
539 err = err2;
540 }
Dmitry Monakhov865ffef32013-04-29 15:08:42 -0700541 } else {
542 err = filemap_check_errors(mapping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800544 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545}
Chris Masonf6995582009-04-15 13:22:37 -0400546EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Randy Dunlap485bb992006-06-23 02:03:49 -0700548/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700549 * replace_page_cache_page - replace a pagecache page with a new one
550 * @old: page to be replaced
551 * @new: page to replace with
552 * @gfp_mask: allocation mode
553 *
554 * This function replaces a page in the pagecache with a new one. On
555 * success it acquires the pagecache reference for the new page and
556 * drops it for the old page. Both the old and new pages must be
557 * locked. This function does not add the new page to the LRU, the
558 * caller must do that.
559 *
560 * The remove + add is atomic. The only way this function can fail is
561 * memory allocation failure.
562 */
563int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
564{
565 int error;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700566
Sasha Levin309381fea2014-01-23 15:52:54 -0800567 VM_BUG_ON_PAGE(!PageLocked(old), old);
568 VM_BUG_ON_PAGE(!PageLocked(new), new);
569 VM_BUG_ON_PAGE(new->mapping, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700570
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700571 error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
572 if (!error) {
573 struct address_space *mapping = old->mapping;
574 void (*freepage)(struct page *);
Greg Thelenc4843a72015-05-22 17:13:16 -0400575 unsigned long flags;
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700576
577 pgoff_t offset = old->index;
578 freepage = mapping->a_ops->freepage;
579
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300580 get_page(new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700581 new->mapping = mapping;
582 new->index = offset;
583
Greg Thelenc4843a72015-05-22 17:13:16 -0400584 spin_lock_irqsave(&mapping->tree_lock, flags);
Johannes Weiner62cccb82016-03-15 14:57:22 -0700585 __delete_from_page_cache(old, NULL);
Johannes Weiner22f2ac52016-09-30 15:11:29 -0700586 error = page_cache_tree_insert(mapping, new, NULL);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700587 BUG_ON(error);
Michal Hocko4165b9b42015-06-24 16:57:24 -0700588
589 /*
590 * hugetlb pages do not participate in page cache accounting.
591 */
592 if (!PageHuge(new))
Mel Gorman11fb9982016-07-28 15:46:20 -0700593 __inc_node_page_state(new, NR_FILE_PAGES);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700594 if (PageSwapBacked(new))
Mel Gorman11fb9982016-07-28 15:46:20 -0700595 __inc_node_page_state(new, NR_SHMEM);
Greg Thelenc4843a72015-05-22 17:13:16 -0400596 spin_unlock_irqrestore(&mapping->tree_lock, flags);
Johannes Weiner6a93ca82016-03-15 14:57:19 -0700597 mem_cgroup_migrate(old, new);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700598 radix_tree_preload_end();
599 if (freepage)
600 freepage(old);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300601 put_page(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700602 }
603
604 return error;
605}
606EXPORT_SYMBOL_GPL(replace_page_cache_page);
607
Johannes Weinera5289102014-04-03 14:47:51 -0700608static int __add_to_page_cache_locked(struct page *page,
609 struct address_space *mapping,
610 pgoff_t offset, gfp_t gfp_mask,
611 void **shadowp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612{
Johannes Weiner00501b52014-08-08 14:19:20 -0700613 int huge = PageHuge(page);
614 struct mem_cgroup *memcg;
Nick Piggine2867812008-07-25 19:45:30 -0700615 int error;
616
Sasha Levin309381fea2014-01-23 15:52:54 -0800617 VM_BUG_ON_PAGE(!PageLocked(page), page);
618 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
Nick Piggine2867812008-07-25 19:45:30 -0700619
Johannes Weiner00501b52014-08-08 14:19:20 -0700620 if (!huge) {
621 error = mem_cgroup_try_charge(page, current->mm,
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800622 gfp_mask, &memcg, false);
Johannes Weiner00501b52014-08-08 14:19:20 -0700623 if (error)
624 return error;
625 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
Jan Kara5e4c0d972013-09-11 14:26:05 -0700627 error = radix_tree_maybe_preload(gfp_mask & ~__GFP_HIGHMEM);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700628 if (error) {
Johannes Weiner00501b52014-08-08 14:19:20 -0700629 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800630 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700631 return error;
632 }
633
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300634 get_page(page);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700635 page->mapping = mapping;
636 page->index = offset;
637
638 spin_lock_irq(&mapping->tree_lock);
Johannes Weinera5289102014-04-03 14:47:51 -0700639 error = page_cache_tree_insert(mapping, page, shadowp);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700640 radix_tree_preload_end();
641 if (unlikely(error))
642 goto err_insert;
Michal Hocko4165b9b42015-06-24 16:57:24 -0700643
644 /* hugetlb pages do not participate in page cache accounting. */
645 if (!huge)
Mel Gorman11fb9982016-07-28 15:46:20 -0700646 __inc_node_page_state(page, NR_FILE_PAGES);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700647 spin_unlock_irq(&mapping->tree_lock);
Johannes Weiner00501b52014-08-08 14:19:20 -0700648 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800649 mem_cgroup_commit_charge(page, memcg, false, false);
Kirill A. Shutemov66a0c8e2013-09-12 15:13:59 -0700650 trace_mm_filemap_add_to_page_cache(page);
651 return 0;
652err_insert:
653 page->mapping = NULL;
654 /* Leave page->index set: truncation relies upon it */
655 spin_unlock_irq(&mapping->tree_lock);
Johannes Weiner00501b52014-08-08 14:19:20 -0700656 if (!huge)
Kirill A. Shutemovf627c2f2016-01-15 16:52:20 -0800657 mem_cgroup_cancel_charge(page, memcg, false);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300658 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 return error;
660}
Johannes Weinera5289102014-04-03 14:47:51 -0700661
662/**
663 * add_to_page_cache_locked - add a locked page to the pagecache
664 * @page: page to add
665 * @mapping: the page's address_space
666 * @offset: page index
667 * @gfp_mask: page allocation mode
668 *
669 * This function is used to add a page to the pagecache. It must be locked.
670 * This function does not add the page to the LRU. The caller must do that.
671 */
672int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
673 pgoff_t offset, gfp_t gfp_mask)
674{
675 return __add_to_page_cache_locked(page, mapping, offset,
676 gfp_mask, NULL);
677}
Nick Piggine2867812008-07-25 19:45:30 -0700678EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679
680int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400681 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682{
Johannes Weinera5289102014-04-03 14:47:51 -0700683 void *shadow = NULL;
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700684 int ret;
685
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800686 __SetPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700687 ret = __add_to_page_cache_locked(page, mapping, offset,
688 gfp_mask, &shadow);
689 if (unlikely(ret))
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800690 __ClearPageLocked(page);
Johannes Weinera5289102014-04-03 14:47:51 -0700691 else {
692 /*
693 * The page might have been evicted from cache only
694 * recently, in which case it should be activated like
695 * any other repeatedly accessed page.
Rik van Rielf0281a02016-05-20 16:56:25 -0700696 * The exception is pages getting rewritten; evicting other
697 * data from the working set, only to cache data that will
698 * get overwritten with something else, is a waste of memory.
Johannes Weinera5289102014-04-03 14:47:51 -0700699 */
Rik van Rielf0281a02016-05-20 16:56:25 -0700700 if (!(gfp_mask & __GFP_WRITE) &&
701 shadow && workingset_refault(shadow)) {
Johannes Weinera5289102014-04-03 14:47:51 -0700702 SetPageActive(page);
703 workingset_activation(page);
704 } else
705 ClearPageActive(page);
706 lru_cache_add(page);
707 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 return ret;
709}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300710EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Paul Jackson44110fe2006-03-24 03:16:04 -0800712#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700713struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800714{
Miao Xiec0ff7452010-05-24 14:32:08 -0700715 int n;
716 struct page *page;
717
Paul Jackson44110fe2006-03-24 03:16:04 -0800718 if (cpuset_do_page_mem_spread()) {
Mel Gormancc9a6c82012-03-21 16:34:11 -0700719 unsigned int cpuset_mems_cookie;
720 do {
Mel Gormand26914d2014-04-03 14:47:24 -0700721 cpuset_mems_cookie = read_mems_allowed_begin();
Mel Gormancc9a6c82012-03-21 16:34:11 -0700722 n = cpuset_mem_spread_node();
Vlastimil Babka96db8002015-09-08 15:03:50 -0700723 page = __alloc_pages_node(n, gfp, 0);
Mel Gormand26914d2014-04-03 14:47:24 -0700724 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
Mel Gormancc9a6c82012-03-21 16:34:11 -0700725
Miao Xiec0ff7452010-05-24 14:32:08 -0700726 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800727 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700728 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800729}
Nick Piggin2ae88142006-10-28 10:38:23 -0700730EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800731#endif
732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733/*
734 * In order to wait for pages to become available there must be
735 * waitqueues associated with pages. By using a hash table of
736 * waitqueues where the bucket discipline is to maintain all
737 * waiters on the same queue and wake all when any of the pages
738 * become available, and for the woken contexts to check to be
739 * sure the appropriate page became available, this saves space
740 * at a cost of "thundering herd" phenomena during rare hash
741 * collisions.
742 */
Nicholas Piggin62906022016-12-25 13:00:30 +1000743#define PAGE_WAIT_TABLE_BITS 8
744#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
745static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
746
747static wait_queue_head_t *page_waitqueue(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748{
Nicholas Piggin62906022016-12-25 13:00:30 +1000749 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750}
Nicholas Piggin62906022016-12-25 13:00:30 +1000751
752void __init pagecache_init(void)
753{
754 int i;
755
756 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
757 init_waitqueue_head(&page_wait_table[i]);
758
759 page_writeback_init();
760}
761
762struct wait_page_key {
763 struct page *page;
764 int bit_nr;
765 int page_match;
766};
767
768struct wait_page_queue {
769 struct page *page;
770 int bit_nr;
Ingo Molnarac6424b2017-06-20 12:06:13 +0200771 wait_queue_entry_t wait;
Nicholas Piggin62906022016-12-25 13:00:30 +1000772};
773
Ingo Molnarac6424b2017-06-20 12:06:13 +0200774static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
Nicholas Piggin62906022016-12-25 13:00:30 +1000775{
776 struct wait_page_key *key = arg;
777 struct wait_page_queue *wait_page
778 = container_of(wait, struct wait_page_queue, wait);
779
780 if (wait_page->page != key->page)
781 return 0;
782 key->page_match = 1;
783
784 if (wait_page->bit_nr != key->bit_nr)
785 return 0;
786 if (test_bit(key->bit_nr, &key->page->flags))
787 return 0;
788
789 return autoremove_wake_function(wait, mode, sync, key);
790}
791
Nicholas Piggin74d81bf2017-02-22 15:44:41 -0800792static void wake_up_page_bit(struct page *page, int bit_nr)
Nicholas Piggin62906022016-12-25 13:00:30 +1000793{
794 wait_queue_head_t *q = page_waitqueue(page);
795 struct wait_page_key key;
796 unsigned long flags;
797
798 key.page = page;
799 key.bit_nr = bit_nr;
800 key.page_match = 0;
801
802 spin_lock_irqsave(&q->lock, flags);
803 __wake_up_locked_key(q, TASK_NORMAL, &key);
804 /*
805 * It is possible for other pages to have collided on the waitqueue
806 * hash, so in that case check for a page match. That prevents a long-
807 * term waiter
808 *
809 * It is still possible to miss a case here, when we woke page waiters
810 * and removed them from the waitqueue, but there are still other
811 * page waiters.
812 */
813 if (!waitqueue_active(q) || !key.page_match) {
814 ClearPageWaiters(page);
815 /*
816 * It's possible to miss clearing Waiters here, when we woke
817 * our page waiters, but the hashed waitqueue has waiters for
818 * other pages on it.
819 *
820 * That's okay, it's a rare case. The next waker will clear it.
821 */
822 }
823 spin_unlock_irqrestore(&q->lock, flags);
824}
Nicholas Piggin74d81bf2017-02-22 15:44:41 -0800825
826static void wake_up_page(struct page *page, int bit)
827{
828 if (!PageWaiters(page))
829 return;
830 wake_up_page_bit(page, bit);
831}
Nicholas Piggin62906022016-12-25 13:00:30 +1000832
833static inline int wait_on_page_bit_common(wait_queue_head_t *q,
834 struct page *page, int bit_nr, int state, bool lock)
835{
836 struct wait_page_queue wait_page;
Ingo Molnarac6424b2017-06-20 12:06:13 +0200837 wait_queue_entry_t *wait = &wait_page.wait;
Nicholas Piggin62906022016-12-25 13:00:30 +1000838 int ret = 0;
839
840 init_wait(wait);
841 wait->func = wake_page_function;
842 wait_page.page = page;
843 wait_page.bit_nr = bit_nr;
844
845 for (;;) {
846 spin_lock_irq(&q->lock);
847
848 if (likely(list_empty(&wait->task_list))) {
849 if (lock)
Ingo Molnarac6424b2017-06-20 12:06:13 +0200850 __add_wait_queue_entry_tail_exclusive(q, wait);
Nicholas Piggin62906022016-12-25 13:00:30 +1000851 else
852 __add_wait_queue(q, wait);
853 SetPageWaiters(page);
854 }
855
856 set_current_state(state);
857
858 spin_unlock_irq(&q->lock);
859
860 if (likely(test_bit(bit_nr, &page->flags))) {
861 io_schedule();
862 if (unlikely(signal_pending_state(state, current))) {
863 ret = -EINTR;
864 break;
865 }
866 }
867
868 if (lock) {
869 if (!test_and_set_bit_lock(bit_nr, &page->flags))
870 break;
871 } else {
872 if (!test_bit(bit_nr, &page->flags))
873 break;
874 }
875 }
876
877 finish_wait(q, wait);
878
879 /*
880 * A signal could leave PageWaiters set. Clearing it here if
881 * !waitqueue_active would be possible (by open-coding finish_wait),
882 * but still fail to catch it in the case of wait hash collision. We
883 * already can fail to clear wait hash collision cases, so don't
884 * bother with signals either.
885 */
886
887 return ret;
888}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889
Harvey Harrison920c7a52008-02-04 22:29:26 -0800890void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891{
Nicholas Piggin62906022016-12-25 13:00:30 +1000892 wait_queue_head_t *q = page_waitqueue(page);
893 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894}
895EXPORT_SYMBOL(wait_on_page_bit);
896
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700897int wait_on_page_bit_killable(struct page *page, int bit_nr)
898{
Nicholas Piggin62906022016-12-25 13:00:30 +1000899 wait_queue_head_t *q = page_waitqueue(page);
900 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, false);
KOSAKI Motohirof62e00c2011-05-24 17:11:29 -0700901}
902
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903/**
David Howells385e1ca5f2009-04-03 16:42:39 +0100904 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -0700905 * @page: Page defining the wait queue of interest
906 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +0100907 *
908 * Add an arbitrary @waiter to the wait queue for the nominated @page.
909 */
Ingo Molnarac6424b2017-06-20 12:06:13 +0200910void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
David Howells385e1ca5f2009-04-03 16:42:39 +0100911{
912 wait_queue_head_t *q = page_waitqueue(page);
913 unsigned long flags;
914
915 spin_lock_irqsave(&q->lock, flags);
916 __add_wait_queue(q, waiter);
Nicholas Piggin62906022016-12-25 13:00:30 +1000917 SetPageWaiters(page);
David Howells385e1ca5f2009-04-03 16:42:39 +0100918 spin_unlock_irqrestore(&q->lock, flags);
919}
920EXPORT_SYMBOL_GPL(add_page_wait_queue);
921
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800922#ifndef clear_bit_unlock_is_negative_byte
923
924/*
925 * PG_waiters is the high bit in the same byte as PG_lock.
926 *
927 * On x86 (and on many other architectures), we can clear PG_lock and
928 * test the sign bit at the same time. But if the architecture does
929 * not support that special operation, we just do this all by hand
930 * instead.
931 *
932 * The read of PG_waiters has to be after (or concurrently with) PG_locked
933 * being cleared, but a memory barrier should be unneccssary since it is
934 * in the same byte as PG_locked.
935 */
936static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
937{
938 clear_bit_unlock(nr, mem);
939 /* smp_mb__after_atomic(); */
Olof Johansson98473f92016-12-29 14:16:07 -0800940 return test_bit(PG_waiters, mem);
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800941}
942
943#endif
944
David Howells385e1ca5f2009-04-03 16:42:39 +0100945/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700946 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 * @page: the page
948 *
949 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
950 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
Masanari Iidada3dae52014-09-09 01:27:23 +0900951 * mechanism between PageLocked pages and PageWriteback pages is shared.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
953 *
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800954 * Note that this depends on PG_waiters being the sign bit in the byte
955 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
956 * clear the PG_locked bit and test PG_waiters at the same time fairly
957 * portably (architectures that do LL/SC can test any bit, while x86 can
958 * test the sign bit).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 */
Harvey Harrison920c7a52008-02-04 22:29:26 -0800960void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961{
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800962 BUILD_BUG_ON(PG_waiters != 7);
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800963 page = compound_head(page);
Sasha Levin309381fea2014-01-23 15:52:54 -0800964 VM_BUG_ON_PAGE(!PageLocked(page), page);
Linus Torvaldsb91e1302016-12-27 11:40:38 -0800965 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
966 wake_up_page_bit(page, PG_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967}
968EXPORT_SYMBOL(unlock_page);
969
Randy Dunlap485bb992006-06-23 02:03:49 -0700970/**
971 * end_page_writeback - end writeback against a page
972 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 */
974void end_page_writeback(struct page *page)
975{
Mel Gorman888cf2d2014-06-04 16:10:34 -0700976 /*
977 * TestClearPageReclaim could be used here but it is an atomic
978 * operation and overkill in this particular case. Failing to
979 * shuffle a page marked for immediate reclaim is too mild to
980 * justify taking an atomic operation penalty at the end of
981 * ever page writeback.
982 */
983 if (PageReclaim(page)) {
984 ClearPageReclaim(page);
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700985 rotate_reclaimable_page(page);
Mel Gorman888cf2d2014-06-04 16:10:34 -0700986 }
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700987
988 if (!test_clear_page_writeback(page))
989 BUG();
990
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100991 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 wake_up_page(page, PG_writeback);
993}
994EXPORT_SYMBOL(end_page_writeback);
995
Matthew Wilcox57d99842014-06-04 16:07:45 -0700996/*
997 * After completing I/O on a page, call this routine to update the page
998 * flags appropriately
999 */
Jens Axboec11f0c02016-08-05 08:11:04 -06001000void page_endio(struct page *page, bool is_write, int err)
Matthew Wilcox57d99842014-06-04 16:07:45 -07001001{
Jens Axboec11f0c02016-08-05 08:11:04 -06001002 if (!is_write) {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001003 if (!err) {
1004 SetPageUptodate(page);
1005 } else {
1006 ClearPageUptodate(page);
1007 SetPageError(page);
1008 }
1009 unlock_page(page);
Mike Christieabf54542016-08-04 14:23:34 -06001010 } else {
Matthew Wilcox57d99842014-06-04 16:07:45 -07001011 if (err) {
Minchan Kimdd8416c2017-02-24 14:59:59 -08001012 struct address_space *mapping;
1013
Matthew Wilcox57d99842014-06-04 16:07:45 -07001014 SetPageError(page);
Minchan Kimdd8416c2017-02-24 14:59:59 -08001015 mapping = page_mapping(page);
1016 if (mapping)
1017 mapping_set_error(mapping, err);
Matthew Wilcox57d99842014-06-04 16:07:45 -07001018 }
1019 end_page_writeback(page);
1020 }
1021}
1022EXPORT_SYMBOL_GPL(page_endio);
1023
Randy Dunlap485bb992006-06-23 02:03:49 -07001024/**
1025 * __lock_page - get a lock on the page, assuming we need to sleep to get it
Randy Dunlap87066752017-02-22 15:44:44 -08001026 * @__page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -07001027 */
Nicholas Piggin62906022016-12-25 13:00:30 +10001028void __lock_page(struct page *__page)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001029{
Nicholas Piggin62906022016-12-25 13:00:30 +10001030 struct page *page = compound_head(__page);
1031 wait_queue_head_t *q = page_waitqueue(page);
1032 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033}
1034EXPORT_SYMBOL(__lock_page);
1035
Nicholas Piggin62906022016-12-25 13:00:30 +10001036int __lock_page_killable(struct page *__page)
Matthew Wilcox2687a352007-12-06 11:18:49 -05001037{
Nicholas Piggin62906022016-12-25 13:00:30 +10001038 struct page *page = compound_head(__page);
1039 wait_queue_head_t *q = page_waitqueue(page);
1040 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE, true);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001041}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +03001042EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -05001043
Paul Cassella9a95f3c2014-08-06 16:07:24 -07001044/*
1045 * Return values:
1046 * 1 - page is locked; mmap_sem is still held.
1047 * 0 - page is not locked.
1048 * mmap_sem has been released (up_read()), unless flags had both
1049 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1050 * which case mmap_sem is still held.
1051 *
1052 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1053 * with the page locked and the mmap_sem unperturbed.
1054 */
Michel Lespinassed065bd82010-10-26 14:21:57 -07001055int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1056 unsigned int flags)
1057{
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001058 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1059 /*
1060 * CAUTION! In this case, mmap_sem is not released
1061 * even though return 0.
1062 */
1063 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1064 return 0;
1065
1066 up_read(&mm->mmap_sem);
1067 if (flags & FAULT_FLAG_KILLABLE)
1068 wait_on_page_locked_killable(page);
1069 else
Gleb Natapov318b2752011-03-22 16:30:51 -07001070 wait_on_page_locked(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001071 return 0;
KOSAKI Motohiro37b23e02011-05-24 17:11:30 -07001072 } else {
1073 if (flags & FAULT_FLAG_KILLABLE) {
1074 int ret;
1075
1076 ret = __lock_page_killable(page);
1077 if (ret) {
1078 up_read(&mm->mmap_sem);
1079 return 0;
1080 }
1081 } else
1082 __lock_page(page);
1083 return 1;
Michel Lespinassed065bd82010-10-26 14:21:57 -07001084 }
1085}
1086
Randy Dunlap485bb992006-06-23 02:03:49 -07001087/**
Johannes Weinere7b563b2014-04-03 14:47:44 -07001088 * page_cache_next_hole - find the next hole (not-present entry)
1089 * @mapping: mapping
1090 * @index: index
1091 * @max_scan: maximum range to search
1092 *
1093 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the
1094 * lowest indexed hole.
1095 *
1096 * Returns: the index of the hole if found, otherwise returns an index
1097 * outside of the set specified (in which case 'return - index >=
1098 * max_scan' will be true). In rare cases of index wrap-around, 0 will
1099 * be returned.
1100 *
1101 * page_cache_next_hole may be called under rcu_read_lock. However,
1102 * like radix_tree_gang_lookup, this will not atomically search a
1103 * snapshot of the tree at a single point in time. For example, if a
1104 * hole is created at index 5, then subsequently a hole is created at
1105 * index 10, page_cache_next_hole covering both indexes may return 10
1106 * if called under rcu_read_lock.
1107 */
1108pgoff_t page_cache_next_hole(struct address_space *mapping,
1109 pgoff_t index, unsigned long max_scan)
1110{
1111 unsigned long i;
1112
1113 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001114 struct page *page;
1115
1116 page = radix_tree_lookup(&mapping->page_tree, index);
1117 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001118 break;
1119 index++;
1120 if (index == 0)
1121 break;
1122 }
1123
1124 return index;
1125}
1126EXPORT_SYMBOL(page_cache_next_hole);
1127
1128/**
1129 * page_cache_prev_hole - find the prev hole (not-present entry)
1130 * @mapping: mapping
1131 * @index: index
1132 * @max_scan: maximum range to search
1133 *
1134 * Search backwards in the range [max(index-max_scan+1, 0), index] for
1135 * the first hole.
1136 *
1137 * Returns: the index of the hole if found, otherwise returns an index
1138 * outside of the set specified (in which case 'index - return >=
1139 * max_scan' will be true). In rare cases of wrap-around, ULONG_MAX
1140 * will be returned.
1141 *
1142 * page_cache_prev_hole may be called under rcu_read_lock. However,
1143 * like radix_tree_gang_lookup, this will not atomically search a
1144 * snapshot of the tree at a single point in time. For example, if a
1145 * hole is created at index 10, then subsequently a hole is created at
1146 * index 5, page_cache_prev_hole covering both indexes may return 5 if
1147 * called under rcu_read_lock.
1148 */
1149pgoff_t page_cache_prev_hole(struct address_space *mapping,
1150 pgoff_t index, unsigned long max_scan)
1151{
1152 unsigned long i;
1153
1154 for (i = 0; i < max_scan; i++) {
Johannes Weiner0cd61442014-04-03 14:47:46 -07001155 struct page *page;
1156
1157 page = radix_tree_lookup(&mapping->page_tree, index);
1158 if (!page || radix_tree_exceptional_entry(page))
Johannes Weinere7b563b2014-04-03 14:47:44 -07001159 break;
1160 index--;
1161 if (index == ULONG_MAX)
1162 break;
1163 }
1164
1165 return index;
1166}
1167EXPORT_SYMBOL(page_cache_prev_hole);
1168
1169/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001170 * find_get_entry - find and get a page cache entry
Randy Dunlap485bb992006-06-23 02:03:49 -07001171 * @mapping: the address_space to search
Johannes Weiner0cd61442014-04-03 14:47:46 -07001172 * @offset: the page cache index
Randy Dunlap485bb992006-06-23 02:03:49 -07001173 *
Johannes Weiner0cd61442014-04-03 14:47:46 -07001174 * Looks up the page cache slot at @mapping & @offset. If there is a
1175 * page cache page, it is returned with an increased refcount.
1176 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001177 * If the slot holds a shadow entry of a previously evicted page, or a
1178 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001179 *
1180 * Otherwise, %NULL is returned.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 */
Johannes Weiner0cd61442014-04-03 14:47:46 -07001182struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183{
Nick Piggina60637c2008-07-25 19:45:31 -07001184 void **pagep;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001185 struct page *head, *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186
Nick Piggina60637c2008-07-25 19:45:31 -07001187 rcu_read_lock();
1188repeat:
1189 page = NULL;
1190 pagep = radix_tree_lookup_slot(&mapping->page_tree, offset);
1191 if (pagep) {
1192 page = radix_tree_deref_slot(pagep);
Nick Piggin27d20fd2010-11-11 14:05:19 -08001193 if (unlikely(!page))
1194 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001195 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001196 if (radix_tree_deref_retry(page))
1197 goto repeat;
1198 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001199 * A shadow entry of a recently evicted page,
1200 * or a swap entry from shmem/tmpfs. Return
1201 * it without attempting to raise page count.
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001202 */
1203 goto out;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001204 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001205
1206 head = compound_head(page);
1207 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001208 goto repeat;
1209
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001210 /* The page was split under us? */
1211 if (compound_head(page) != head) {
1212 put_page(head);
1213 goto repeat;
1214 }
1215
Nick Piggina60637c2008-07-25 19:45:31 -07001216 /*
1217 * Has the page moved?
1218 * This is part of the lockless pagecache protocol. See
1219 * include/linux/pagemap.h for details.
1220 */
1221 if (unlikely(page != *pagep)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001222 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001223 goto repeat;
1224 }
1225 }
Nick Piggin27d20fd2010-11-11 14:05:19 -08001226out:
Nick Piggina60637c2008-07-25 19:45:31 -07001227 rcu_read_unlock();
1228
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 return page;
1230}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001231EXPORT_SYMBOL(find_get_entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232
Randy Dunlap485bb992006-06-23 02:03:49 -07001233/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001234 * find_lock_entry - locate, pin and lock a page cache entry
1235 * @mapping: the address_space to search
1236 * @offset: the page cache index
1237 *
1238 * Looks up the page cache slot at @mapping & @offset. If there is a
1239 * page cache page, it is returned locked and with an increased
1240 * refcount.
1241 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001242 * If the slot holds a shadow entry of a previously evicted page, or a
1243 * swap entry from shmem/tmpfs, it is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001244 *
1245 * Otherwise, %NULL is returned.
1246 *
1247 * find_lock_entry() may sleep.
1248 */
1249struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250{
1251 struct page *page;
1252
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253repeat:
Johannes Weiner0cd61442014-04-03 14:47:46 -07001254 page = find_get_entry(mapping, offset);
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001255 if (page && !radix_tree_exception(page)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001256 lock_page(page);
1257 /* Has the page been truncated? */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001258 if (unlikely(page_mapping(page) != mapping)) {
Nick Piggina60637c2008-07-25 19:45:31 -07001259 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001260 put_page(page);
Nick Piggina60637c2008-07-25 19:45:31 -07001261 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001263 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 return page;
1266}
Johannes Weiner0cd61442014-04-03 14:47:46 -07001267EXPORT_SYMBOL(find_lock_entry);
1268
1269/**
Mel Gorman2457aec2014-06-04 16:10:31 -07001270 * pagecache_get_page - find and get a page reference
Johannes Weiner0cd61442014-04-03 14:47:46 -07001271 * @mapping: the address_space to search
1272 * @offset: the page index
Mel Gorman2457aec2014-06-04 16:10:31 -07001273 * @fgp_flags: PCG flags
Michal Hocko45f87de2014-12-29 20:30:35 +01001274 * @gfp_mask: gfp mask to use for the page cache data page allocation
Johannes Weiner0cd61442014-04-03 14:47:46 -07001275 *
Mel Gorman2457aec2014-06-04 16:10:31 -07001276 * Looks up the page cache slot at @mapping & @offset.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001277 *
Randy Dunlap75325182014-07-30 16:08:37 -07001278 * PCG flags modify how the page is returned.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001279 *
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03001280 * @fgp_flags can be:
1281 *
1282 * - FGP_ACCESSED: the page will be marked accessed
1283 * - FGP_LOCK: Page is return locked
1284 * - FGP_CREAT: If page is not present then a new page is allocated using
1285 * @gfp_mask and added to the page cache and the VM's LRU
1286 * list. The page is returned locked and with an increased
1287 * refcount. Otherwise, NULL is returned.
Mel Gorman2457aec2014-06-04 16:10:31 -07001288 *
1289 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1290 * if the GFP flags specified for FGP_CREAT are atomic.
1291 *
1292 * If there is a page cache page, it is returned with an increased refcount.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001293 */
Mel Gorman2457aec2014-06-04 16:10:31 -07001294struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
Michal Hocko45f87de2014-12-29 20:30:35 +01001295 int fgp_flags, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296{
Nick Piggineb2be182007-10-16 01:24:57 -07001297 struct page *page;
Mel Gorman2457aec2014-06-04 16:10:31 -07001298
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299repeat:
Mel Gorman2457aec2014-06-04 16:10:31 -07001300 page = find_get_entry(mapping, offset);
1301 if (radix_tree_exceptional_entry(page))
1302 page = NULL;
1303 if (!page)
1304 goto no_page;
1305
1306 if (fgp_flags & FGP_LOCK) {
1307 if (fgp_flags & FGP_NOWAIT) {
1308 if (!trylock_page(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001309 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001310 return NULL;
1311 }
1312 } else {
1313 lock_page(page);
1314 }
1315
1316 /* Has the page been truncated? */
1317 if (unlikely(page->mapping != mapping)) {
1318 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001319 put_page(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001320 goto repeat;
1321 }
1322 VM_BUG_ON_PAGE(page->index != offset, page);
1323 }
1324
1325 if (page && (fgp_flags & FGP_ACCESSED))
1326 mark_page_accessed(page);
1327
1328no_page:
1329 if (!page && (fgp_flags & FGP_CREAT)) {
1330 int err;
1331 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
Michal Hocko45f87de2014-12-29 20:30:35 +01001332 gfp_mask |= __GFP_WRITE;
1333 if (fgp_flags & FGP_NOFS)
1334 gfp_mask &= ~__GFP_FS;
Mel Gorman2457aec2014-06-04 16:10:31 -07001335
Michal Hocko45f87de2014-12-29 20:30:35 +01001336 page = __page_cache_alloc(gfp_mask);
Nick Piggineb2be182007-10-16 01:24:57 -07001337 if (!page)
1338 return NULL;
Mel Gorman2457aec2014-06-04 16:10:31 -07001339
1340 if (WARN_ON_ONCE(!(fgp_flags & FGP_LOCK)))
1341 fgp_flags |= FGP_LOCK;
1342
Hugh Dickinseb39d612014-08-06 16:06:43 -07001343 /* Init accessed so avoid atomic mark_page_accessed later */
Mel Gorman2457aec2014-06-04 16:10:31 -07001344 if (fgp_flags & FGP_ACCESSED)
Hugh Dickinseb39d612014-08-06 16:06:43 -07001345 __SetPageReferenced(page);
Mel Gorman2457aec2014-06-04 16:10:31 -07001346
Michal Hocko45f87de2014-12-29 20:30:35 +01001347 err = add_to_page_cache_lru(page, mapping, offset,
1348 gfp_mask & GFP_RECLAIM_MASK);
Nick Piggineb2be182007-10-16 01:24:57 -07001349 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001350 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07001351 page = NULL;
1352 if (err == -EEXIST)
1353 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 }
Mel Gorman2457aec2014-06-04 16:10:31 -07001356
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 return page;
1358}
Mel Gorman2457aec2014-06-04 16:10:31 -07001359EXPORT_SYMBOL(pagecache_get_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360
1361/**
Johannes Weiner0cd61442014-04-03 14:47:46 -07001362 * find_get_entries - gang pagecache lookup
1363 * @mapping: The address_space to search
1364 * @start: The starting page cache index
1365 * @nr_entries: The maximum number of entries
1366 * @entries: Where the resulting entries are placed
1367 * @indices: The cache indices corresponding to the entries in @entries
1368 *
1369 * find_get_entries() will search for and return a group of up to
1370 * @nr_entries entries in the mapping. The entries are placed at
1371 * @entries. find_get_entries() takes a reference against any actual
1372 * pages it returns.
1373 *
1374 * The search returns a group of mapping-contiguous page cache entries
1375 * with ascending indexes. There may be holes in the indices due to
1376 * not-present pages.
1377 *
Johannes Weiner139b6a62014-05-06 12:50:05 -07001378 * Any shadow entries of evicted pages, or swap entries from
1379 * shmem/tmpfs, are included in the returned array.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001380 *
1381 * find_get_entries() returns the number of pages and shadow entries
1382 * which were found.
1383 */
1384unsigned find_get_entries(struct address_space *mapping,
1385 pgoff_t start, unsigned int nr_entries,
1386 struct page **entries, pgoff_t *indices)
1387{
1388 void **slot;
1389 unsigned int ret = 0;
1390 struct radix_tree_iter iter;
1391
1392 if (!nr_entries)
1393 return 0;
1394
1395 rcu_read_lock();
Johannes Weiner0cd61442014-04-03 14:47:46 -07001396 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001397 struct page *head, *page;
Johannes Weiner0cd61442014-04-03 14:47:46 -07001398repeat:
1399 page = radix_tree_deref_slot(slot);
1400 if (unlikely(!page))
1401 continue;
1402 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001403 if (radix_tree_deref_retry(page)) {
1404 slot = radix_tree_iter_retry(&iter);
1405 continue;
1406 }
Johannes Weiner0cd61442014-04-03 14:47:46 -07001407 /*
Ross Zwislerf9fe48b2016-01-22 15:10:40 -08001408 * A shadow entry of a recently evicted page, a swap
1409 * entry from shmem/tmpfs or a DAX entry. Return it
1410 * without attempting to raise page count.
Johannes Weiner0cd61442014-04-03 14:47:46 -07001411 */
1412 goto export;
1413 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001414
1415 head = compound_head(page);
1416 if (!page_cache_get_speculative(head))
Johannes Weiner0cd61442014-04-03 14:47:46 -07001417 goto repeat;
1418
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001419 /* The page was split under us? */
1420 if (compound_head(page) != head) {
1421 put_page(head);
1422 goto repeat;
1423 }
1424
Johannes Weiner0cd61442014-04-03 14:47:46 -07001425 /* Has the page moved? */
1426 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001427 put_page(head);
Johannes Weiner0cd61442014-04-03 14:47:46 -07001428 goto repeat;
1429 }
1430export:
1431 indices[ret] = iter.index;
1432 entries[ret] = page;
1433 if (++ret == nr_entries)
1434 break;
1435 }
1436 rcu_read_unlock();
1437 return ret;
1438}
1439
1440/**
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 * find_get_pages - gang pagecache lookup
1442 * @mapping: The address_space to search
1443 * @start: The starting page index
1444 * @nr_pages: The maximum number of pages
1445 * @pages: Where the resulting pages are placed
1446 *
1447 * find_get_pages() will search for and return a group of up to
1448 * @nr_pages pages in the mapping. The pages are placed at @pages.
1449 * find_get_pages() takes a reference against the returned pages.
1450 *
1451 * The search returns a group of mapping-contiguous pages with ascending
1452 * indexes. There may be holes in the indices due to not-present pages.
1453 *
1454 * find_get_pages() returns the number of pages which were found.
1455 */
1456unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
1457 unsigned int nr_pages, struct page **pages)
1458{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001459 struct radix_tree_iter iter;
1460 void **slot;
1461 unsigned ret = 0;
1462
1463 if (unlikely(!nr_pages))
1464 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001465
Nick Piggina60637c2008-07-25 19:45:31 -07001466 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001467 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001468 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001469repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001470 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001471 if (unlikely(!page))
1472 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001473
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001474 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001475 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001476 slot = radix_tree_iter_retry(&iter);
1477 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001478 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001479 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001480 * A shadow entry of a recently evicted page,
1481 * or a swap entry from shmem/tmpfs. Skip
1482 * over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001483 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001484 continue;
Nick Piggin27d20fd2010-11-11 14:05:19 -08001485 }
Nick Piggina60637c2008-07-25 19:45:31 -07001486
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001487 head = compound_head(page);
1488 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001489 goto repeat;
1490
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001491 /* The page was split under us? */
1492 if (compound_head(page) != head) {
1493 put_page(head);
1494 goto repeat;
1495 }
1496
Nick Piggina60637c2008-07-25 19:45:31 -07001497 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001498 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001499 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001500 goto repeat;
1501 }
1502
1503 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001504 if (++ret == nr_pages)
1505 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001506 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001507
Nick Piggina60637c2008-07-25 19:45:31 -07001508 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509 return ret;
1510}
1511
Jens Axboeebf43502006-04-27 08:46:01 +02001512/**
1513 * find_get_pages_contig - gang contiguous pagecache lookup
1514 * @mapping: The address_space to search
1515 * @index: The starting page index
1516 * @nr_pages: The maximum number of pages
1517 * @pages: Where the resulting pages are placed
1518 *
1519 * find_get_pages_contig() works exactly like find_get_pages(), except
1520 * that the returned number of pages are guaranteed to be contiguous.
1521 *
1522 * find_get_pages_contig() returns the number of pages which were found.
1523 */
1524unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1525 unsigned int nr_pages, struct page **pages)
1526{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001527 struct radix_tree_iter iter;
1528 void **slot;
1529 unsigned int ret = 0;
1530
1531 if (unlikely(!nr_pages))
1532 return 0;
Jens Axboeebf43502006-04-27 08:46:01 +02001533
Nick Piggina60637c2008-07-25 19:45:31 -07001534 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001535 radix_tree_for_each_contig(slot, &mapping->page_tree, &iter, index) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001536 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001537repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001538 page = radix_tree_deref_slot(slot);
1539 /* The hole, there no reason to continue */
Nick Piggina60637c2008-07-25 19:45:31 -07001540 if (unlikely(!page))
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001541 break;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001542
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001543 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001544 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001545 slot = radix_tree_iter_retry(&iter);
1546 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001547 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001548 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001549 * A shadow entry of a recently evicted page,
1550 * or a swap entry from shmem/tmpfs. Stop
1551 * looking for contiguous pages.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001552 */
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001553 break;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001554 }
Nick Piggina60637c2008-07-25 19:45:31 -07001555
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001556 head = compound_head(page);
1557 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001558 goto repeat;
1559
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001560 /* The page was split under us? */
1561 if (compound_head(page) != head) {
1562 put_page(head);
1563 goto repeat;
1564 }
1565
Nick Piggina60637c2008-07-25 19:45:31 -07001566 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001567 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001568 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001569 goto repeat;
1570 }
1571
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001572 /*
1573 * must check mapping and index after taking the ref.
1574 * otherwise we can get both false positives and false
1575 * negatives, which is just confusing to the caller.
1576 */
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001577 if (page->mapping == NULL || page_to_pgoff(page) != iter.index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001578 put_page(page);
Nick Piggin9cbb4cb2011-01-13 15:45:51 -08001579 break;
1580 }
1581
Nick Piggina60637c2008-07-25 19:45:31 -07001582 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001583 if (++ret == nr_pages)
1584 break;
Jens Axboeebf43502006-04-27 08:46:01 +02001585 }
Nick Piggina60637c2008-07-25 19:45:31 -07001586 rcu_read_unlock();
1587 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +02001588}
David Howellsef71c152007-05-09 02:33:44 -07001589EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +02001590
Randy Dunlap485bb992006-06-23 02:03:49 -07001591/**
1592 * find_get_pages_tag - find and return pages that match @tag
1593 * @mapping: the address_space to search
1594 * @index: the starting page index
1595 * @tag: the tag index
1596 * @nr_pages: the maximum number of pages
1597 * @pages: where the resulting pages are placed
1598 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001599 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -07001600 * @tag. We update @index to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001601 */
1602unsigned find_get_pages_tag(struct address_space *mapping, pgoff_t *index,
1603 int tag, unsigned int nr_pages, struct page **pages)
1604{
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001605 struct radix_tree_iter iter;
1606 void **slot;
1607 unsigned ret = 0;
1608
1609 if (unlikely(!nr_pages))
1610 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001611
Nick Piggina60637c2008-07-25 19:45:31 -07001612 rcu_read_lock();
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001613 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1614 &iter, *index, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001615 struct page *head, *page;
Nick Piggina60637c2008-07-25 19:45:31 -07001616repeat:
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001617 page = radix_tree_deref_slot(slot);
Nick Piggina60637c2008-07-25 19:45:31 -07001618 if (unlikely(!page))
1619 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -07001620
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001621 if (radix_tree_exception(page)) {
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001622 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001623 slot = radix_tree_iter_retry(&iter);
1624 continue;
Hugh Dickins8079b1c2011-08-03 16:21:28 -07001625 }
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001626 /*
Johannes Weiner139b6a62014-05-06 12:50:05 -07001627 * A shadow entry of a recently evicted page.
1628 *
1629 * Those entries should never be tagged, but
1630 * this tree walk is lockless and the tags are
1631 * looked up in bulk, one radix tree node at a
1632 * time, so there is a sizable window for page
1633 * reclaim to evict a page we saw tagged.
1634 *
1635 * Skip over it.
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001636 */
Johannes Weiner139b6a62014-05-06 12:50:05 -07001637 continue;
Hugh Dickinsa2c16d62011-08-03 16:21:19 -07001638 }
Nick Piggina60637c2008-07-25 19:45:31 -07001639
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001640 head = compound_head(page);
1641 if (!page_cache_get_speculative(head))
Nick Piggina60637c2008-07-25 19:45:31 -07001642 goto repeat;
1643
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001644 /* The page was split under us? */
1645 if (compound_head(page) != head) {
1646 put_page(head);
1647 goto repeat;
1648 }
1649
Nick Piggina60637c2008-07-25 19:45:31 -07001650 /* Has the page moved? */
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001651 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001652 put_page(head);
Nick Piggina60637c2008-07-25 19:45:31 -07001653 goto repeat;
1654 }
1655
1656 pages[ret] = page;
Konstantin Khlebnikov0fc9d102012-03-28 14:42:54 -07001657 if (++ret == nr_pages)
1658 break;
Nick Piggina60637c2008-07-25 19:45:31 -07001659 }
Hugh Dickins5b280c02011-03-22 16:33:07 -07001660
Nick Piggina60637c2008-07-25 19:45:31 -07001661 rcu_read_unlock();
1662
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 if (ret)
1664 *index = pages[ret - 1]->index + 1;
Nick Piggina60637c2008-07-25 19:45:31 -07001665
Linus Torvalds1da177e2005-04-16 15:20:36 -07001666 return ret;
1667}
David Howellsef71c152007-05-09 02:33:44 -07001668EXPORT_SYMBOL(find_get_pages_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001670/**
1671 * find_get_entries_tag - find and return entries that match @tag
1672 * @mapping: the address_space to search
1673 * @start: the starting page cache index
1674 * @tag: the tag index
1675 * @nr_entries: the maximum number of entries
1676 * @entries: where the resulting entries are placed
1677 * @indices: the cache indices corresponding to the entries in @entries
1678 *
1679 * Like find_get_entries, except we only return entries which are tagged with
1680 * @tag.
1681 */
1682unsigned find_get_entries_tag(struct address_space *mapping, pgoff_t start,
1683 int tag, unsigned int nr_entries,
1684 struct page **entries, pgoff_t *indices)
1685{
1686 void **slot;
1687 unsigned int ret = 0;
1688 struct radix_tree_iter iter;
1689
1690 if (!nr_entries)
1691 return 0;
1692
1693 rcu_read_lock();
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001694 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1695 &iter, start, tag) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001696 struct page *head, *page;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001697repeat:
1698 page = radix_tree_deref_slot(slot);
1699 if (unlikely(!page))
1700 continue;
1701 if (radix_tree_exception(page)) {
1702 if (radix_tree_deref_retry(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07001703 slot = radix_tree_iter_retry(&iter);
1704 continue;
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001705 }
1706
1707 /*
1708 * A shadow entry of a recently evicted page, a swap
1709 * entry from shmem/tmpfs or a DAX entry. Return it
1710 * without attempting to raise page count.
1711 */
1712 goto export;
1713 }
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001714
1715 head = compound_head(page);
1716 if (!page_cache_get_speculative(head))
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001717 goto repeat;
1718
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001719 /* The page was split under us? */
1720 if (compound_head(page) != head) {
1721 put_page(head);
1722 goto repeat;
1723 }
1724
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001725 /* Has the page moved? */
1726 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07001727 put_page(head);
Ross Zwisler7e7f7742016-01-22 15:10:44 -08001728 goto repeat;
1729 }
1730export:
1731 indices[ret] = iter.index;
1732 entries[ret] = page;
1733 if (++ret == nr_entries)
1734 break;
1735 }
1736 rcu_read_unlock();
1737 return ret;
1738}
1739EXPORT_SYMBOL(find_get_entries_tag);
1740
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001741/*
1742 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1743 * a _large_ part of the i/o request. Imagine the worst scenario:
1744 *
1745 * ---R__________________________________________B__________
1746 * ^ reading here ^ bad block(assume 4k)
1747 *
1748 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1749 * => failing the whole request => read(R) => read(R+1) =>
1750 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1751 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1752 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1753 *
1754 * It is going insane. Fix it by quickly scaling down the readahead size.
1755 */
1756static void shrink_readahead_size_eio(struct file *filp,
1757 struct file_ra_state *ra)
1758{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001759 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001760}
1761
Randy Dunlap485bb992006-06-23 02:03:49 -07001762/**
Christoph Hellwig36e78912008-02-08 04:21:24 -08001763 * do_generic_file_read - generic file read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07001764 * @filp: the file to read
1765 * @ppos: current file position
Al Viro6e58e792014-02-03 17:07:03 -05001766 * @iter: data destination
1767 * @written: already copied
Randy Dunlap485bb992006-06-23 02:03:49 -07001768 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001770 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001771 *
1772 * This is really ugly. But the goto's actually try to clarify some
1773 * of the logic when it comes to error handling etc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001774 */
Al Viro6e58e792014-02-03 17:07:03 -05001775static ssize_t do_generic_file_read(struct file *filp, loff_t *ppos,
1776 struct iov_iter *iter, ssize_t written)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001777{
Christoph Hellwig36e78912008-02-08 04:21:24 -08001778 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001779 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001780 struct file_ra_state *ra = &filp->f_ra;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001781 pgoff_t index;
1782 pgoff_t last_index;
1783 pgoff_t prev_index;
1784 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07001785 unsigned int prev_offset;
Al Viro6e58e792014-02-03 17:07:03 -05001786 int error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001787
Wei Fangc2a97372016-10-07 17:01:52 -07001788 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
Linus Torvaldsd05c5f72016-12-14 12:45:25 -08001789 return 0;
Wei Fangc2a97372016-10-07 17:01:52 -07001790 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
1791
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001792 index = *ppos >> PAGE_SHIFT;
1793 prev_index = ra->prev_pos >> PAGE_SHIFT;
1794 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
1795 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
1796 offset = *ppos & ~PAGE_MASK;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 for (;;) {
1799 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001800 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001801 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 unsigned long nr, ret;
1803
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805find_page:
Michal Hocko5abf1862017-02-03 13:13:29 -08001806 if (fatal_signal_pending(current)) {
1807 error = -EINTR;
1808 goto out;
1809 }
1810
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001812 if (!page) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001813 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001814 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001815 index, last_index - index);
1816 page = find_get_page(mapping, index);
1817 if (unlikely(page == NULL))
1818 goto no_cached_page;
1819 }
1820 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001821 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001822 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001823 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001824 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001825 if (!PageUptodate(page)) {
Mel Gormanebded022016-03-15 14:55:39 -07001826 /*
1827 * See comment in do_read_cache_page on why
1828 * wait_on_page_locked is used to avoid unnecessarily
1829 * serialisations and why it's safe.
1830 */
Bart Van Asschec4b209a2016-10-07 16:58:33 -07001831 error = wait_on_page_locked_killable(page);
1832 if (unlikely(error))
1833 goto readpage_error;
Mel Gormanebded022016-03-15 14:55:39 -07001834 if (PageUptodate(page))
1835 goto page_ok;
1836
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001837 if (inode->i_blkbits == PAGE_SHIFT ||
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001838 !mapping->a_ops->is_partially_uptodate)
1839 goto page_not_up_to_date;
Eryu Guan6d6d36b2016-11-01 15:43:07 +08001840 /* pipes can't handle partially uptodate pages */
1841 if (unlikely(iter->type & ITER_PIPE))
1842 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02001843 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001844 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08001845 /* Did it get truncated before we got the lock? */
1846 if (!page->mapping)
1847 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001848 if (!mapping->a_ops->is_partially_uptodate(page,
Al Viro6e58e792014-02-03 17:07:03 -05001849 offset, iter->count))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001850 goto page_not_up_to_date_locked;
1851 unlock_page(page);
1852 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07001854 /*
1855 * i_size must be checked after we know the page is Uptodate.
1856 *
1857 * Checking i_size after the check allows us to calculate
1858 * the correct value for "nr", which means the zero-filled
1859 * part of the page is not copied back to userspace (unless
1860 * another truncate extends the file - this is desired though).
1861 */
1862
1863 isize = i_size_read(inode);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001864 end_index = (isize - 1) >> PAGE_SHIFT;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001865 if (unlikely(!isize || index > end_index)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001866 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001867 goto out;
1868 }
1869
1870 /* nr is the maximum number of bytes to copy from this page */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001871 nr = PAGE_SIZE;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001872 if (index == end_index) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001873 nr = ((isize - 1) & ~PAGE_MASK) + 1;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001874 if (nr <= offset) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001875 put_page(page);
NeilBrowna32ea1e2007-07-17 04:03:04 -07001876 goto out;
1877 }
1878 }
1879 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880
1881 /* If users can be writing to this page using arbitrary
1882 * virtual addresses, take care about potential aliasing
1883 * before reading the page on the kernel side.
1884 */
1885 if (mapping_writably_mapped(mapping))
1886 flush_dcache_page(page);
1887
1888 /*
Jan Karaec0f1632007-05-06 14:49:25 -07001889 * When a sequential read accesses a page several times,
1890 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891 */
Jan Karaec0f1632007-05-06 14:49:25 -07001892 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 mark_page_accessed(page);
1894 prev_index = index;
1895
1896 /*
1897 * Ok, we have the page, and it's up-to-date, so
1898 * now we can copy it to user space...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001899 */
Al Viro6e58e792014-02-03 17:07:03 -05001900
1901 ret = copy_page_to_iter(page, offset, nr, iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902 offset += ret;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001903 index += offset >> PAGE_SHIFT;
1904 offset &= ~PAGE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07001905 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001906
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001907 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001908 written += ret;
1909 if (!iov_iter_count(iter))
1910 goto out;
1911 if (ret < nr) {
1912 error = -EFAULT;
1913 goto out;
1914 }
1915 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001916
1917page_not_up_to_date:
1918 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04001919 error = lock_page_killable(page);
1920 if (unlikely(error))
1921 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001923page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07001924 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925 if (!page->mapping) {
1926 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001927 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 continue;
1929 }
1930
1931 /* Did somebody else fill it already? */
1932 if (PageUptodate(page)) {
1933 unlock_page(page);
1934 goto page_ok;
1935 }
1936
1937readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04001938 /*
1939 * A previous I/O error may have been due to temporary
1940 * failures, eg. multipath errors.
1941 * PG_error will be set again if readpage fails.
1942 */
1943 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001944 /* Start the actual read. The read will unlock the page. */
1945 error = mapping->a_ops->readpage(filp, page);
1946
Zach Brown994fc28c2005-12-15 14:28:17 -08001947 if (unlikely(error)) {
1948 if (error == AOP_TRUNCATED_PAGE) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001949 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001950 error = 0;
Zach Brown994fc28c2005-12-15 14:28:17 -08001951 goto find_page;
1952 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08001954 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955
1956 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04001957 error = lock_page_killable(page);
1958 if (unlikely(error))
1959 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001960 if (!PageUptodate(page)) {
1961 if (page->mapping == NULL) {
1962 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01001963 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 */
1965 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001966 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 goto find_page;
1968 }
1969 unlock_page(page);
Fengguang Wu7ff81072007-10-16 01:24:35 -07001970 shrink_readahead_size_eio(filp, ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04001971 error = -EIO;
1972 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001973 }
1974 unlock_page(page);
1975 }
1976
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 goto page_ok;
1978
1979readpage_error:
1980 /* UHHUH! A synchronous read error occurred. Report it */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001981 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001982 goto out;
1983
1984no_cached_page:
1985 /*
1986 * Ok, it wasn't cached, so we need to create a new
1987 * page..
1988 */
Nick Piggineb2be182007-10-16 01:24:57 -07001989 page = page_cache_alloc_cold(mapping);
1990 if (!page) {
Al Viro6e58e792014-02-03 17:07:03 -05001991 error = -ENOMEM;
Nick Piggineb2be182007-10-16 01:24:57 -07001992 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993 }
Michal Hocko6afdb852015-06-24 16:58:06 -07001994 error = add_to_page_cache_lru(page, mapping, index,
Michal Hockoc62d2552015-11-06 16:28:49 -08001995 mapping_gfp_constraint(mapping, GFP_KERNEL));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996 if (error) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001997 put_page(page);
Al Viro6e58e792014-02-03 17:07:03 -05001998 if (error == -EEXIST) {
1999 error = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000 goto find_page;
Al Viro6e58e792014-02-03 17:07:03 -05002001 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002 goto out;
2003 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 goto readpage;
2005 }
2006
2007out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07002008 ra->prev_pos = prev_index;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002009 ra->prev_pos <<= PAGE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07002010 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002011
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002012 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07002013 file_accessed(filp);
Al Viro6e58e792014-02-03 17:07:03 -05002014 return written ? written : error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015}
2016
Randy Dunlap485bb992006-06-23 02:03:49 -07002017/**
Al Viro6abd2322014-04-04 14:20:57 -04002018 * generic_file_read_iter - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07002019 * @iocb: kernel I/O control block
Al Viro6abd2322014-04-04 14:20:57 -04002020 * @iter: destination for the data read
Randy Dunlap485bb992006-06-23 02:03:49 -07002021 *
Al Viro6abd2322014-04-04 14:20:57 -04002022 * This is the "read_iter()" routine for all filesystems
Linus Torvalds1da177e2005-04-16 15:20:36 -07002023 * that can use the page cache directly.
2024 */
2025ssize_t
Al Viroed978a82014-03-05 22:53:04 -05002026generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002027{
Al Viroed978a82014-03-05 22:53:04 -05002028 struct file *file = iocb->ki_filp;
2029 ssize_t retval = 0;
Nicolai Stangee7080a42016-03-25 14:22:14 -07002030 size_t count = iov_iter_count(iter);
2031
2032 if (!count)
2033 goto out; /* skip atime */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034
Al Viro2ba48ce2015-04-09 13:52:01 -04002035 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viroed978a82014-03-05 22:53:04 -05002036 struct address_space *mapping = file->f_mapping;
2037 struct inode *inode = mapping->host;
Badari Pulavarty543ade12006-09-30 23:28:48 -07002038 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002039
Linus Torvalds1da177e2005-04-16 15:20:36 -07002040 size = i_size_read(inode);
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002041 retval = filemap_write_and_wait_range(mapping, iocb->ki_pos,
2042 iocb->ki_pos + count - 1);
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002043 if (retval < 0)
2044 goto out;
Al Viroed978a82014-03-05 22:53:04 -05002045
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002046 file_accessed(file);
2047
Al Viro5ecda132017-04-13 14:13:36 -04002048 retval = mapping->a_ops->direct_IO(iocb, iter);
Al Viroc3a69022016-10-10 13:26:27 -04002049 if (retval >= 0) {
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002050 iocb->ki_pos += retval;
Al Viro5ecda132017-04-13 14:13:36 -04002051 count -= retval;
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002052 }
Al Viro5b47d592017-05-08 13:54:47 -04002053 iov_iter_revert(iter, count - iov_iter_count(iter));
Josef Bacik66f998f2010-05-23 11:00:54 -04002054
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002055 /*
2056 * Btrfs can have a short DIO read if we encounter
2057 * compressed extents, so if there was an error, or if
2058 * we've already read everything we wanted to, or if
2059 * there was a short read because we hit EOF, go ahead
2060 * and return. Otherwise fallthrough to buffered io for
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002061 * the rest of the read. Buffered reads will not work for
2062 * DAX files, so don't bother trying.
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002063 */
Al Viro5ecda132017-04-13 14:13:36 -04002064 if (retval < 0 || !count || iocb->ki_pos >= size ||
Christoph Hellwig0d5b0cf2016-10-03 09:48:08 +11002065 IS_DAX(inode))
Steven Whitehouse9fe55ee2014-01-24 14:42:22 +00002066 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 }
2068
Christoph Hellwigc64fb5c2016-04-07 08:51:55 -07002069 retval = do_generic_file_read(file, &iocb->ki_pos, iter, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070out:
2071 return retval;
2072}
Al Viroed978a82014-03-05 22:53:04 -05002073EXPORT_SYMBOL(generic_file_read_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074
Linus Torvalds1da177e2005-04-16 15:20:36 -07002075#ifdef CONFIG_MMU
Randy Dunlap485bb992006-06-23 02:03:49 -07002076/**
2077 * page_cache_read - adds requested page to the page cache if not already there
2078 * @file: file to read
2079 * @offset: page index
Randy Dunlap62eb3202016-02-11 16:12:58 -08002080 * @gfp_mask: memory allocation flags
Randy Dunlap485bb992006-06-23 02:03:49 -07002081 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07002082 * This adds the requested page to the page cache if it isn't already there,
2083 * and schedules an I/O to read in its contents from disk.
2084 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002085static int page_cache_read(struct file *file, pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002086{
2087 struct address_space *mapping = file->f_mapping;
Paul McQuade99dadfd2014-10-09 15:29:03 -07002088 struct page *page;
Zach Brown994fc28c2005-12-15 14:28:17 -08002089 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002090
Zach Brown994fc28c2005-12-15 14:28:17 -08002091 do {
Michal Hockoc20cd452016-01-14 15:20:12 -08002092 page = __page_cache_alloc(gfp_mask|__GFP_COLD);
Zach Brown994fc28c2005-12-15 14:28:17 -08002093 if (!page)
2094 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002095
Michal Hockoc20cd452016-01-14 15:20:12 -08002096 ret = add_to_page_cache_lru(page, mapping, offset, gfp_mask & GFP_KERNEL);
Zach Brown994fc28c2005-12-15 14:28:17 -08002097 if (ret == 0)
2098 ret = mapping->a_ops->readpage(file, page);
2099 else if (ret == -EEXIST)
2100 ret = 0; /* losing race to add is OK */
2101
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002102 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103
Zach Brown994fc28c2005-12-15 14:28:17 -08002104 } while (ret == AOP_TRUNCATED_PAGE);
Paul McQuade99dadfd2014-10-09 15:29:03 -07002105
Zach Brown994fc28c2005-12-15 14:28:17 -08002106 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107}
2108
2109#define MMAP_LOTSAMISS (100)
2110
Linus Torvaldsef00e082009-06-16 15:31:25 -07002111/*
2112 * Synchronous readahead happens when we don't even find
2113 * a page in the page cache at all.
2114 */
2115static void do_sync_mmap_readahead(struct vm_area_struct *vma,
2116 struct file_ra_state *ra,
2117 struct file *file,
2118 pgoff_t offset)
2119{
Linus Torvaldsef00e082009-06-16 15:31:25 -07002120 struct address_space *mapping = file->f_mapping;
2121
2122 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002123 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002124 return;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002125 if (!ra->ra_pages)
2126 return;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002127
Joe Perches64363aa2013-07-08 16:00:18 -07002128 if (vma->vm_flags & VM_SEQ_READ) {
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07002129 page_cache_sync_readahead(mapping, ra, file, offset,
2130 ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002131 return;
2132 }
2133
Andi Kleen207d04b2011-05-24 17:12:29 -07002134 /* Avoid banging the cache line if not needed */
2135 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002136 ra->mmap_miss++;
2137
2138 /*
2139 * Do we miss much more than hit in this file? If so,
2140 * stop bothering with read-ahead. It will only hurt.
2141 */
2142 if (ra->mmap_miss > MMAP_LOTSAMISS)
2143 return;
2144
Wu Fengguangd30a1102009-06-16 15:31:30 -07002145 /*
2146 * mmap read-around
2147 */
Roman Gushchin600e19a2015-11-05 18:47:08 -08002148 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2149 ra->size = ra->ra_pages;
2150 ra->async_size = ra->ra_pages / 4;
Wu Fengguang275b12b2011-05-24 17:12:28 -07002151 ra_submit(ra, mapping, file);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002152}
2153
2154/*
2155 * Asynchronous readahead happens when we find the page and PG_readahead,
2156 * so we want to possibly extend the readahead further..
2157 */
2158static void do_async_mmap_readahead(struct vm_area_struct *vma,
2159 struct file_ra_state *ra,
2160 struct file *file,
2161 struct page *page,
2162 pgoff_t offset)
2163{
2164 struct address_space *mapping = file->f_mapping;
2165
2166 /* If we don't want any read-ahead, don't bother */
Joe Perches64363aa2013-07-08 16:00:18 -07002167 if (vma->vm_flags & VM_RAND_READ)
Linus Torvaldsef00e082009-06-16 15:31:25 -07002168 return;
2169 if (ra->mmap_miss > 0)
2170 ra->mmap_miss--;
2171 if (PageReadahead(page))
Wu Fengguang2fad6f52009-06-16 15:31:29 -07002172 page_cache_async_readahead(mapping, ra, file,
2173 page, offset, ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002174}
2175
Randy Dunlap485bb992006-06-23 02:03:49 -07002176/**
Nick Piggin54cb8822007-07-19 01:46:59 -07002177 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac2007-07-19 01:47:03 -07002178 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07002179 *
Nick Piggin54cb8822007-07-19 01:46:59 -07002180 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181 * mapped memory region to read in file data during a page fault.
2182 *
2183 * The goto's are kind of ugly, but this streamlines the normal case of having
2184 * it in the page cache, and handles the special cases reasonably without
2185 * having a lot of duplicated code.
Paul Cassella9a95f3c2014-08-06 16:07:24 -07002186 *
2187 * vma->vm_mm->mmap_sem must be held on entry.
2188 *
2189 * If our return value has VM_FAULT_RETRY set, it's because
2190 * lock_page_or_retry() returned 0.
2191 * The mmap_sem has usually been released in this case.
2192 * See __lock_page_or_retry() for the exception.
2193 *
2194 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2195 * has not been released.
2196 *
2197 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 */
Dave Jiang11bac802017-02-24 14:56:41 -08002199int filemap_fault(struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200{
2201 int error;
Dave Jiang11bac802017-02-24 14:56:41 -08002202 struct file *file = vmf->vma->vm_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 struct address_space *mapping = file->f_mapping;
2204 struct file_ra_state *ra = &file->f_ra;
2205 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07002206 pgoff_t offset = vmf->pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002207 pgoff_t max_off;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 struct page *page;
Nick Piggin83c54072007-07-19 01:47:05 -07002209 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002210
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002211 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2212 if (unlikely(offset >= max_off))
Linus Torvalds5307cc12007-10-31 09:19:46 -07002213 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214
Linus Torvalds1da177e2005-04-16 15:20:36 -07002215 /*
Johannes Weiner49426422013-10-16 13:46:59 -07002216 * Do we have something in the page cache already?
Linus Torvalds1da177e2005-04-16 15:20:36 -07002217 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07002218 page = find_get_page(mapping, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002219 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07002221 * We found the page, so try async readahead before
2222 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 */
Dave Jiang11bac802017-02-24 14:56:41 -08002224 do_async_mmap_readahead(vmf->vma, ra, file, page, offset);
Shaohua Li45cac652012-10-08 16:32:19 -07002225 } else if (!page) {
Linus Torvaldsef00e082009-06-16 15:31:25 -07002226 /* No page in the page cache at all */
Dave Jiang11bac802017-02-24 14:56:41 -08002227 do_sync_mmap_readahead(vmf->vma, ra, file, offset);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002228 count_vm_event(PGMAJFAULT);
Dave Jiang11bac802017-02-24 14:56:41 -08002229 mem_cgroup_count_vm_event(vmf->vma->vm_mm, PGMAJFAULT);
Linus Torvaldsef00e082009-06-16 15:31:25 -07002230 ret = VM_FAULT_MAJOR;
2231retry_find:
Michel Lespinasseb522c942010-10-26 14:21:56 -07002232 page = find_get_page(mapping, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233 if (!page)
2234 goto no_cached_page;
2235 }
2236
Dave Jiang11bac802017-02-24 14:56:41 -08002237 if (!lock_page_or_retry(page, vmf->vma->vm_mm, vmf->flags)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002238 put_page(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07002239 return ret | VM_FAULT_RETRY;
Michel Lespinassed88c0922010-11-02 13:05:18 -07002240 }
Michel Lespinasseb522c942010-10-26 14:21:56 -07002241
2242 /* Did it get truncated? */
2243 if (unlikely(page->mapping != mapping)) {
2244 unlock_page(page);
2245 put_page(page);
2246 goto retry_find;
2247 }
Sasha Levin309381fea2014-01-23 15:52:54 -08002248 VM_BUG_ON_PAGE(page->index != offset, page);
Michel Lespinasseb522c942010-10-26 14:21:56 -07002249
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 /*
Nick Piggind00806b2007-07-19 01:46:57 -07002251 * We have a locked page in the page cache, now we need to check
2252 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002253 */
Nick Piggind00806b2007-07-19 01:46:57 -07002254 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002255 goto page_not_uptodate;
2256
Linus Torvaldsef00e082009-06-16 15:31:25 -07002257 /*
2258 * Found the page and have a reference on it.
2259 * We must recheck i_size under page lock.
2260 */
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002261 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2262 if (unlikely(offset >= max_off)) {
Nick Piggind00806b2007-07-19 01:46:57 -07002263 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002264 put_page(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07002265 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07002266 }
2267
Nick Piggind0217ac2007-07-19 01:47:03 -07002268 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07002269 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270
Linus Torvalds1da177e2005-04-16 15:20:36 -07002271no_cached_page:
2272 /*
2273 * We're only likely to ever get here if MADV_RANDOM is in
2274 * effect.
2275 */
Michal Hockoc20cd452016-01-14 15:20:12 -08002276 error = page_cache_read(file, offset, vmf->gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002277
2278 /*
2279 * The page we want has now been added to the page cache.
2280 * In the unlikely event that someone removed it in the
2281 * meantime, we'll just come back here and read it again.
2282 */
2283 if (error >= 0)
2284 goto retry_find;
2285
2286 /*
2287 * An error return from page_cache_read can result if the
2288 * system is low on memory, or a problem occurs while trying
2289 * to schedule I/O.
2290 */
2291 if (error == -ENOMEM)
Nick Piggind0217ac2007-07-19 01:47:03 -07002292 return VM_FAULT_OOM;
2293 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002294
2295page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002296 /*
2297 * Umm, take care of errors if the page isn't up-to-date.
2298 * Try to re-read it _once_. We do this synchronously,
2299 * because there really aren't any performance issues here
2300 * and we need to check for errors.
2301 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 ClearPageError(page);
Zach Brown994fc28c2005-12-15 14:28:17 -08002303 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07002304 if (!error) {
2305 wait_on_page_locked(page);
2306 if (!PageUptodate(page))
2307 error = -EIO;
2308 }
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002309 put_page(page);
Nick Piggind00806b2007-07-19 01:46:57 -07002310
2311 if (!error || error == AOP_TRUNCATED_PAGE)
2312 goto retry_find;
2313
2314 /* Things didn't work out. Return zero to tell the mm layer so. */
2315 shrink_readahead_size_eio(file, ra);
Nick Piggind0217ac2007-07-19 01:47:03 -07002316 return VM_FAULT_SIGBUS;
Nick Piggin54cb8822007-07-19 01:46:59 -07002317}
2318EXPORT_SYMBOL(filemap_fault);
2319
Jan Kara82b0f8c2016-12-14 15:06:58 -08002320void filemap_map_pages(struct vm_fault *vmf,
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002321 pgoff_t start_pgoff, pgoff_t end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002322{
2323 struct radix_tree_iter iter;
2324 void **slot;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002325 struct file *file = vmf->vma->vm_file;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002326 struct address_space *mapping = file->f_mapping;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002327 pgoff_t last_pgoff = start_pgoff;
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002328 unsigned long max_idx;
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002329 struct page *head, *page;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002330
2331 rcu_read_lock();
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002332 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter,
2333 start_pgoff) {
2334 if (iter.index > end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002335 break;
2336repeat:
2337 page = radix_tree_deref_slot(slot);
2338 if (unlikely(!page))
2339 goto next;
2340 if (radix_tree_exception(page)) {
Matthew Wilcox2cf938a2016-03-17 14:22:03 -07002341 if (radix_tree_deref_retry(page)) {
2342 slot = radix_tree_iter_retry(&iter);
2343 continue;
2344 }
2345 goto next;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002346 }
2347
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002348 head = compound_head(page);
2349 if (!page_cache_get_speculative(head))
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002350 goto repeat;
2351
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002352 /* The page was split under us? */
2353 if (compound_head(page) != head) {
2354 put_page(head);
2355 goto repeat;
2356 }
2357
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002358 /* Has the page moved? */
2359 if (unlikely(page != *slot)) {
Kirill A. Shutemov83929372016-07-26 15:26:04 -07002360 put_page(head);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002361 goto repeat;
2362 }
2363
2364 if (!PageUptodate(page) ||
2365 PageReadahead(page) ||
2366 PageHWPoison(page))
2367 goto skip;
2368 if (!trylock_page(page))
2369 goto skip;
2370
2371 if (page->mapping != mapping || !PageUptodate(page))
2372 goto unlock;
2373
Matthew Wilcox9ab25942017-05-03 14:53:29 -07002374 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2375 if (page->index >= max_idx)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002376 goto unlock;
2377
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002378 if (file->f_ra.mmap_miss > 0)
2379 file->f_ra.mmap_miss--;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002380
Jan Kara82b0f8c2016-12-14 15:06:58 -08002381 vmf->address += (iter.index - last_pgoff) << PAGE_SHIFT;
2382 if (vmf->pte)
2383 vmf->pte += iter.index - last_pgoff;
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002384 last_pgoff = iter.index;
Jan Kara82b0f8c2016-12-14 15:06:58 -08002385 if (alloc_set_pte(vmf, NULL, page))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002386 goto unlock;
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002387 unlock_page(page);
2388 goto next;
2389unlock:
2390 unlock_page(page);
2391skip:
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002392 put_page(page);
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002393next:
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002394 /* Huge page is mapped? No need to proceed. */
Jan Kara82b0f8c2016-12-14 15:06:58 -08002395 if (pmd_trans_huge(*vmf->pmd))
Kirill A. Shutemov7267ec002016-07-26 15:25:23 -07002396 break;
Kirill A. Shutemovbae473a2016-07-26 15:25:20 -07002397 if (iter.index == end_pgoff)
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002398 break;
2399 }
2400 rcu_read_unlock();
2401}
2402EXPORT_SYMBOL(filemap_map_pages);
2403
Dave Jiang11bac802017-02-24 14:56:41 -08002404int filemap_page_mkwrite(struct vm_fault *vmf)
Jan Kara4fcf1c62012-06-12 16:20:29 +02002405{
2406 struct page *page = vmf->page;
Dave Jiang11bac802017-02-24 14:56:41 -08002407 struct inode *inode = file_inode(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002408 int ret = VM_FAULT_LOCKED;
2409
Jan Kara14da9202012-06-12 16:20:37 +02002410 sb_start_pagefault(inode->i_sb);
Dave Jiang11bac802017-02-24 14:56:41 -08002411 file_update_time(vmf->vma->vm_file);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002412 lock_page(page);
2413 if (page->mapping != inode->i_mapping) {
2414 unlock_page(page);
2415 ret = VM_FAULT_NOPAGE;
2416 goto out;
2417 }
Jan Kara14da9202012-06-12 16:20:37 +02002418 /*
2419 * We mark the page dirty already here so that when freeze is in
2420 * progress, we are guaranteed that writeback during freezing will
2421 * see the dirty page and writeprotect it again.
2422 */
2423 set_page_dirty(page);
Darrick J. Wong1d1d1a72013-02-21 16:42:51 -08002424 wait_for_stable_page(page);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002425out:
Jan Kara14da9202012-06-12 16:20:37 +02002426 sb_end_pagefault(inode->i_sb);
Jan Kara4fcf1c62012-06-12 16:20:29 +02002427 return ret;
2428}
2429EXPORT_SYMBOL(filemap_page_mkwrite);
2430
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04002431const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07002432 .fault = filemap_fault,
Kirill A. Shutemovf1820362014-04-07 15:37:19 -07002433 .map_pages = filemap_map_pages,
Jan Kara4fcf1c62012-06-12 16:20:29 +02002434 .page_mkwrite = filemap_page_mkwrite,
Linus Torvalds1da177e2005-04-16 15:20:36 -07002435};
2436
2437/* This is used for a general mmap of a disk file */
2438
2439int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2440{
2441 struct address_space *mapping = file->f_mapping;
2442
2443 if (!mapping->a_ops->readpage)
2444 return -ENOEXEC;
2445 file_accessed(file);
2446 vma->vm_ops = &generic_file_vm_ops;
2447 return 0;
2448}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449
2450/*
2451 * This is for filesystems which do not implement ->writepage.
2452 */
2453int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2454{
2455 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2456 return -EINVAL;
2457 return generic_file_mmap(file, vma);
2458}
2459#else
2460int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2461{
2462 return -ENOSYS;
2463}
2464int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2465{
2466 return -ENOSYS;
2467}
2468#endif /* CONFIG_MMU */
2469
2470EXPORT_SYMBOL(generic_file_mmap);
2471EXPORT_SYMBOL(generic_file_readonly_mmap);
2472
Sasha Levin67f9fd92014-04-03 14:48:18 -07002473static struct page *wait_on_page_read(struct page *page)
2474{
2475 if (!IS_ERR(page)) {
2476 wait_on_page_locked(page);
2477 if (!PageUptodate(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002478 put_page(page);
Sasha Levin67f9fd92014-04-03 14:48:18 -07002479 page = ERR_PTR(-EIO);
2480 }
2481 }
2482 return page;
2483}
2484
Mel Gorman32b63522016-03-15 14:55:36 -07002485static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07002486 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002487 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002488 void *data,
2489 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002490{
Nick Piggineb2be182007-10-16 01:24:57 -07002491 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002492 int err;
2493repeat:
2494 page = find_get_page(mapping, index);
2495 if (!page) {
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002496 page = __page_cache_alloc(gfp | __GFP_COLD);
Nick Piggineb2be182007-10-16 01:24:57 -07002497 if (!page)
2498 return ERR_PTR(-ENOMEM);
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002499 err = add_to_page_cache_lru(page, mapping, index, gfp);
Nick Piggineb2be182007-10-16 01:24:57 -07002500 if (unlikely(err)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002501 put_page(page);
Nick Piggineb2be182007-10-16 01:24:57 -07002502 if (err == -EEXIST)
2503 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002504 /* Presumably ENOMEM for radix tree node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002505 return ERR_PTR(err);
2506 }
Mel Gorman32b63522016-03-15 14:55:36 -07002507
2508filler:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002509 err = filler(data, page);
2510 if (err < 0) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002511 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002512 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002513 }
Mel Gorman32b63522016-03-15 14:55:36 -07002514
2515 page = wait_on_page_read(page);
2516 if (IS_ERR(page))
2517 return page;
2518 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002519 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002520 if (PageUptodate(page))
2521 goto out;
2522
Mel Gormanebded022016-03-15 14:55:39 -07002523 /*
2524 * Page is not up to date and may be locked due one of the following
2525 * case a: Page is being filled and the page lock is held
2526 * case b: Read/write error clearing the page uptodate status
2527 * case c: Truncation in progress (page locked)
2528 * case d: Reclaim in progress
2529 *
2530 * Case a, the page will be up to date when the page is unlocked.
2531 * There is no need to serialise on the page lock here as the page
2532 * is pinned so the lock gives no additional protection. Even if the
2533 * the page is truncated, the data is still valid if PageUptodate as
2534 * it's a race vs truncate race.
2535 * Case b, the page will not be up to date
2536 * Case c, the page may be truncated but in itself, the data may still
2537 * be valid after IO completes as it's a read vs truncate race. The
2538 * operation must restart if the page is not uptodate on unlock but
2539 * otherwise serialising on page lock to stabilise the mapping gives
2540 * no additional guarantees to the caller as the page lock is
2541 * released before return.
2542 * Case d, similar to truncation. If reclaim holds the page lock, it
2543 * will be a race with remove_mapping that determines if the mapping
2544 * is valid on unlock but otherwise the data is valid and there is
2545 * no need to serialise with page lock.
2546 *
2547 * As the page lock gives no additional guarantee, we optimistically
2548 * wait on the page to be unlocked and check if it's up to date and
2549 * use the page if it is. Otherwise, the page lock is required to
2550 * distinguish between the different cases. The motivation is that we
2551 * avoid spurious serialisations and wakeups when multiple processes
2552 * wait on the same page for IO to complete.
2553 */
2554 wait_on_page_locked(page);
2555 if (PageUptodate(page))
2556 goto out;
2557
2558 /* Distinguish between all the cases under the safety of the lock */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002559 lock_page(page);
Mel Gormanebded022016-03-15 14:55:39 -07002560
2561 /* Case c or d, restart the operation */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002562 if (!page->mapping) {
2563 unlock_page(page);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002564 put_page(page);
Mel Gorman32b63522016-03-15 14:55:36 -07002565 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002566 }
Mel Gormanebded022016-03-15 14:55:39 -07002567
2568 /* Someone else locked and filled the page in a very small window */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002569 if (PageUptodate(page)) {
2570 unlock_page(page);
2571 goto out;
2572 }
Mel Gorman32b63522016-03-15 14:55:36 -07002573 goto filler;
2574
David Howellsc855ff32007-05-09 13:42:20 +01002575out:
Nick Piggin6fe69002007-05-06 14:49:04 -07002576 mark_page_accessed(page);
2577 return page;
2578}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002579
2580/**
Sasha Levin67f9fd92014-04-03 14:48:18 -07002581 * read_cache_page - read into page cache, fill it if needed
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002582 * @mapping: the page's address_space
2583 * @index: the page index
2584 * @filler: function to perform the read
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002585 * @data: first arg to filler(data, page) function, often left as NULL
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002586 *
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002587 * Read into the page cache. If a page already exists, and PageUptodate() is
Sasha Levin67f9fd92014-04-03 14:48:18 -07002588 * not set, try to fill the page and wait for it to become unlocked.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002589 *
2590 * If the page does not get brought uptodate, return -EIO.
2591 */
Sasha Levin67f9fd92014-04-03 14:48:18 -07002592struct page *read_cache_page(struct address_space *mapping,
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002593 pgoff_t index,
Hugh Dickins5e5358e2011-07-25 17:12:23 -07002594 int (*filler)(void *, struct page *),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002595 void *data)
2596{
2597 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2598}
Sasha Levin67f9fd92014-04-03 14:48:18 -07002599EXPORT_SYMBOL(read_cache_page);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002600
2601/**
2602 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2603 * @mapping: the page's address_space
2604 * @index: the page index
2605 * @gfp: the page allocator flags to use if allocating
2606 *
2607 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
Dave Kleikampe6f67b82011-12-21 11:05:48 -06002608 * any new page allocations done using the specified allocation flags.
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002609 *
2610 * If the page does not get brought uptodate, return -EIO.
2611 */
2612struct page *read_cache_page_gfp(struct address_space *mapping,
2613 pgoff_t index,
2614 gfp_t gfp)
2615{
2616 filler_t *filler = (filler_t *)mapping->a_ops->readpage;
2617
Sasha Levin67f9fd92014-04-03 14:48:18 -07002618 return do_read_cache_page(mapping, index, filler, NULL, gfp);
Linus Torvalds0531b2a2010-01-27 09:20:03 -08002619}
2620EXPORT_SYMBOL(read_cache_page_gfp);
2621
Nick Piggin2f718ff2007-10-16 01:24:59 -07002622/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002623 * Performs necessary checks before doing a write
2624 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002625 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002626 * Returns appropriate error code that caller should return or
2627 * zero in case that write should be allowed.
2628 */
Al Viro3309dd02015-04-09 12:55:47 -04002629inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002630{
Al Viro3309dd02015-04-09 12:55:47 -04002631 struct file *file = iocb->ki_filp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002632 struct inode *inode = file->f_mapping->host;
Jiri Slaby59e99e52010-03-05 13:41:44 -08002633 unsigned long limit = rlimit(RLIMIT_FSIZE);
Al Viro3309dd02015-04-09 12:55:47 -04002634 loff_t pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
Al Viro3309dd02015-04-09 12:55:47 -04002636 if (!iov_iter_count(from))
2637 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002638
Al Viro0fa6b002015-04-04 04:05:48 -04002639 /* FIXME: this is for backwards compatibility with 2.4 */
Al Viro2ba48ce2015-04-09 13:52:01 -04002640 if (iocb->ki_flags & IOCB_APPEND)
Al Viro3309dd02015-04-09 12:55:47 -04002641 iocb->ki_pos = i_size_read(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002642
Al Viro3309dd02015-04-09 12:55:47 -04002643 pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002644
Al Viro0fa6b002015-04-04 04:05:48 -04002645 if (limit != RLIM_INFINITY) {
Al Viro3309dd02015-04-09 12:55:47 -04002646 if (iocb->ki_pos >= limit) {
Al Viro0fa6b002015-04-04 04:05:48 -04002647 send_sig(SIGXFSZ, current, 0);
2648 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002649 }
Al Viro3309dd02015-04-09 12:55:47 -04002650 iov_iter_truncate(from, limit - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002651 }
2652
2653 /*
2654 * LFS rule
2655 */
Al Viro3309dd02015-04-09 12:55:47 -04002656 if (unlikely(pos + iov_iter_count(from) > MAX_NON_LFS &&
Linus Torvalds1da177e2005-04-16 15:20:36 -07002657 !(file->f_flags & O_LARGEFILE))) {
Al Viro3309dd02015-04-09 12:55:47 -04002658 if (pos >= MAX_NON_LFS)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002659 return -EFBIG;
Al Viro3309dd02015-04-09 12:55:47 -04002660 iov_iter_truncate(from, MAX_NON_LFS - (unsigned long)pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002661 }
2662
2663 /*
2664 * Are we about to exceed the fs block limit ?
2665 *
2666 * If we have written data it becomes a short write. If we have
2667 * exceeded without writing data we send a signal and return EFBIG.
2668 * Linus frestrict idea will clean these up nicely..
2669 */
Al Viro3309dd02015-04-09 12:55:47 -04002670 if (unlikely(pos >= inode->i_sb->s_maxbytes))
2671 return -EFBIG;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672
Al Viro3309dd02015-04-09 12:55:47 -04002673 iov_iter_truncate(from, inode->i_sb->s_maxbytes - pos);
2674 return iov_iter_count(from);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002675}
2676EXPORT_SYMBOL(generic_write_checks);
2677
Nick Pigginafddba42007-10-16 01:25:01 -07002678int pagecache_write_begin(struct file *file, struct address_space *mapping,
2679 loff_t pos, unsigned len, unsigned flags,
2680 struct page **pagep, void **fsdata)
2681{
2682 const struct address_space_operations *aops = mapping->a_ops;
2683
Nick Piggin4e02ed42008-10-29 14:00:55 -07002684 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002685 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002686}
2687EXPORT_SYMBOL(pagecache_write_begin);
2688
2689int pagecache_write_end(struct file *file, struct address_space *mapping,
2690 loff_t pos, unsigned len, unsigned copied,
2691 struct page *page, void *fsdata)
2692{
2693 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07002694
Nick Piggin4e02ed42008-10-29 14:00:55 -07002695 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002696}
2697EXPORT_SYMBOL(pagecache_write_end);
2698
Linus Torvalds1da177e2005-04-16 15:20:36 -07002699ssize_t
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002700generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002701{
2702 struct file *file = iocb->ki_filp;
2703 struct address_space *mapping = file->f_mapping;
2704 struct inode *inode = mapping->host;
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002705 loff_t pos = iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002706 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002707 size_t write_len;
2708 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002709
Al Viro0c949332014-03-22 06:51:37 -04002710 write_len = iov_iter_count(from);
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002711 end = (pos + write_len - 1) >> PAGE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002712
Nick Piggin48b47c52009-01-06 14:40:22 -08002713 written = filemap_write_and_wait_range(mapping, pos, pos + write_len - 1);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002714 if (written)
2715 goto out;
2716
2717 /*
2718 * After a write we want buffered reads to be sure to go to disk to get
2719 * the new data. We invalidate clean cached page from the region we're
2720 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002721 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07002722 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07002723 written = invalidate_inode_pages2_range(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002724 pos >> PAGE_SHIFT, end);
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07002725 /*
2726 * If a page can not be invalidated, return 0 to fall back
2727 * to buffered write.
2728 */
2729 if (written) {
2730 if (written == -EBUSY)
2731 return 0;
2732 goto out;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002733 }
2734
Al Viro639a93a52017-04-13 14:10:15 -04002735 written = mapping->a_ops->direct_IO(iocb, from);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002736
2737 /*
2738 * Finally, try again to invalidate clean pages which might have been
2739 * cached by non-direct readahead, or faulted in by get_user_pages()
2740 * if the source of the write was an mmap'ed region of the file
2741 * we're writing. Either one is a pretty crazy thing to do,
2742 * so we don't support it 100%. If this invalidation
2743 * fails, tough, the write still worked...
2744 */
Andrey Ryabinin55635ba2017-05-03 14:55:59 -07002745 invalidate_inode_pages2_range(mapping,
2746 pos >> PAGE_SHIFT, end);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002747
Linus Torvalds1da177e2005-04-16 15:20:36 -07002748 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07002749 pos += written;
Al Viro639a93a52017-04-13 14:10:15 -04002750 write_len -= written;
Namhyung Kim01166512010-10-26 14:21:58 -07002751 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
2752 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002753 mark_inode_dirty(inode);
2754 }
Al Viro5cb6c6c2014-02-11 20:58:20 -05002755 iocb->ki_pos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002756 }
Al Viro639a93a52017-04-13 14:10:15 -04002757 iov_iter_revert(from, write_len - iov_iter_count(from));
Christoph Hellwiga969e902008-07-23 21:27:04 -07002758out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002759 return written;
2760}
2761EXPORT_SYMBOL(generic_file_direct_write);
2762
Nick Piggineb2be182007-10-16 01:24:57 -07002763/*
2764 * Find or create a page at the given pagecache position. Return the locked
2765 * page. This function is specifically for buffered writes.
2766 */
Nick Piggin54566b22009-01-04 12:00:53 -08002767struct page *grab_cache_page_write_begin(struct address_space *mapping,
2768 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07002769{
Nick Piggineb2be182007-10-16 01:24:57 -07002770 struct page *page;
Johannes Weinerbbddabe2016-05-20 16:56:28 -07002771 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
Johannes Weiner0faa70c2012-01-10 15:07:53 -08002772
Nick Piggin54566b22009-01-04 12:00:53 -08002773 if (flags & AOP_FLAG_NOFS)
Mel Gorman2457aec2014-06-04 16:10:31 -07002774 fgp_flags |= FGP_NOFS;
Nick Piggineb2be182007-10-16 01:24:57 -07002775
Mel Gorman2457aec2014-06-04 16:10:31 -07002776 page = pagecache_get_page(mapping, index, fgp_flags,
Michal Hocko45f87de2014-12-29 20:30:35 +01002777 mapping_gfp_mask(mapping));
Mel Gorman2457aec2014-06-04 16:10:31 -07002778 if (page)
2779 wait_for_stable_page(page);
2780
Nick Piggineb2be182007-10-16 01:24:57 -07002781 return page;
2782}
Nick Piggin54566b22009-01-04 12:00:53 -08002783EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07002784
Al Viro3b93f912014-02-11 21:34:08 -05002785ssize_t generic_perform_write(struct file *file,
Nick Pigginafddba42007-10-16 01:25:01 -07002786 struct iov_iter *i, loff_t pos)
2787{
2788 struct address_space *mapping = file->f_mapping;
2789 const struct address_space_operations *a_ops = mapping->a_ops;
2790 long status = 0;
2791 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07002792 unsigned int flags = 0;
2793
Nick Pigginafddba42007-10-16 01:25:01 -07002794 do {
2795 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07002796 unsigned long offset; /* Offset into pagecache page */
2797 unsigned long bytes; /* Bytes to write to page */
2798 size_t copied; /* Bytes copied from user */
2799 void *fsdata;
2800
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002801 offset = (pos & (PAGE_SIZE - 1));
2802 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002803 iov_iter_count(i));
2804
2805again:
Linus Torvalds00a3d662015-10-07 08:32:38 +01002806 /*
2807 * Bring in the user page that we will copy from _first_.
2808 * Otherwise there's a nasty deadlock on copying from the
2809 * same page as we're writing to, without it being marked
2810 * up-to-date.
2811 *
2812 * Not only is this an optimisation, but it is also required
2813 * to check that the address is actually valid, when atomic
2814 * usercopies are used, below.
2815 */
2816 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
2817 status = -EFAULT;
2818 break;
2819 }
2820
Jan Kara296291c2015-10-22 13:32:21 -07002821 if (fatal_signal_pending(current)) {
2822 status = -EINTR;
2823 break;
2824 }
2825
Nick Piggin674b8922007-10-16 01:25:03 -07002826 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002827 &page, &fsdata);
Mel Gorman2457aec2014-06-04 16:10:31 -07002828 if (unlikely(status < 0))
Nick Pigginafddba42007-10-16 01:25:01 -07002829 break;
2830
anfei zhou931e80e2010-02-02 13:44:02 -08002831 if (mapping_writably_mapped(mapping))
2832 flush_dcache_page(page);
Linus Torvalds00a3d662015-10-07 08:32:38 +01002833
Nick Pigginafddba42007-10-16 01:25:01 -07002834 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
Nick Pigginafddba42007-10-16 01:25:01 -07002835 flush_dcache_page(page);
2836
2837 status = a_ops->write_end(file, mapping, pos, bytes, copied,
2838 page, fsdata);
2839 if (unlikely(status < 0))
2840 break;
2841 copied = status;
2842
2843 cond_resched();
2844
Nick Piggin124d3b72008-02-02 15:01:17 +01002845 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07002846 if (unlikely(copied == 0)) {
2847 /*
2848 * If we were unable to copy any data at all, we must
2849 * fall back to a single segment length write.
2850 *
2851 * If we didn't fallback here, we could livelock
2852 * because not all segments in the iov can be copied at
2853 * once without a pagefault.
2854 */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002855 bytes = min_t(unsigned long, PAGE_SIZE - offset,
Nick Pigginafddba42007-10-16 01:25:01 -07002856 iov_iter_single_seg_count(i));
2857 goto again;
2858 }
Nick Pigginafddba42007-10-16 01:25:01 -07002859 pos += copied;
2860 written += copied;
2861
2862 balance_dirty_pages_ratelimited(mapping);
Nick Pigginafddba42007-10-16 01:25:01 -07002863 } while (iov_iter_count(i));
2864
2865 return written ? written : status;
2866}
Al Viro3b93f912014-02-11 21:34:08 -05002867EXPORT_SYMBOL(generic_perform_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002868
Jan Karae4dd9de2009-08-17 18:10:06 +02002869/**
Al Viro81742022014-04-03 03:17:43 -04002870 * __generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02002871 * @iocb: IO state structure (file, offset, etc.)
Al Viro81742022014-04-03 03:17:43 -04002872 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02002873 *
2874 * This function does all the work needed for actually writing data to a
2875 * file. It does all basic checks, removes SUID from the file, updates
2876 * modification times and calls proper subroutines depending on whether we
2877 * do direct IO or a standard buffered write.
2878 *
2879 * It expects i_mutex to be grabbed unless we work on a block device or similar
2880 * object which does not need locking at all.
2881 *
2882 * This function does *not* take care of syncing data in case of O_SYNC write.
2883 * A caller has to handle it. This is mainly due to the fact that we want to
2884 * avoid syncing under i_mutex.
2885 */
Al Viro81742022014-04-03 03:17:43 -04002886ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002887{
2888 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002889 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002890 struct inode *inode = mapping->host;
Al Viro3b93f912014-02-11 21:34:08 -05002891 ssize_t written = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002892 ssize_t err;
Al Viro3b93f912014-02-11 21:34:08 -05002893 ssize_t status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002894
Linus Torvalds1da177e2005-04-16 15:20:36 -07002895 /* We can write back this queue in page reclaim */
Christoph Hellwigde1414a2015-01-14 10:42:36 +01002896 current->backing_dev_info = inode_to_bdi(inode);
Jan Kara5fa8e0a2015-05-21 16:05:53 +02002897 err = file_remove_privs(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002898 if (err)
2899 goto out;
2900
Josef Bacikc3b2da32012-03-26 09:59:21 -04002901 err = file_update_time(file);
2902 if (err)
2903 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002904
Al Viro2ba48ce2015-04-09 13:52:01 -04002905 if (iocb->ki_flags & IOCB_DIRECT) {
Al Viro0b8def92015-04-07 10:22:53 -04002906 loff_t pos, endbyte;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002907
Christoph Hellwig1af5bb42016-04-07 08:51:56 -07002908 written = generic_file_direct_write(iocb, from);
Matthew Wilcoxfbbbad42015-02-16 15:58:53 -08002909 /*
2910 * If the write stopped short of completing, fall back to
2911 * buffered writes. Some filesystems do this for writes to
2912 * holes, for example. For DAX files, a buffered write will
2913 * not succeed (even if it did, DAX does not handle dirty
2914 * page-cache pages correctly).
2915 */
Al Viro0b8def92015-04-07 10:22:53 -04002916 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002917 goto out;
Al Viro3b93f912014-02-11 21:34:08 -05002918
Al Viro0b8def92015-04-07 10:22:53 -04002919 status = generic_perform_write(file, from, pos = iocb->ki_pos);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002920 /*
Al Viro3b93f912014-02-11 21:34:08 -05002921 * If generic_perform_write() returned a synchronous error
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002922 * then we want to return the number of bytes which were
2923 * direct-written, or the error code if that was zero. Note
2924 * that this differs from normal direct-io semantics, which
2925 * will return -EFOO even if some bytes were written.
2926 */
Al Viro60bb4522014-08-08 12:39:16 -04002927 if (unlikely(status < 0)) {
Al Viro3b93f912014-02-11 21:34:08 -05002928 err = status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002929 goto out;
2930 }
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002931 /*
2932 * We need to ensure that the page cache pages are written to
2933 * disk and invalidated to preserve the expected O_DIRECT
2934 * semantics.
2935 */
Al Viro3b93f912014-02-11 21:34:08 -05002936 endbyte = pos + status - 1;
Al Viro0b8def92015-04-07 10:22:53 -04002937 err = filemap_write_and_wait_range(mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002938 if (err == 0) {
Al Viro0b8def92015-04-07 10:22:53 -04002939 iocb->ki_pos = endbyte + 1;
Al Viro3b93f912014-02-11 21:34:08 -05002940 written += status;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002941 invalidate_mapping_pages(mapping,
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03002942 pos >> PAGE_SHIFT,
2943 endbyte >> PAGE_SHIFT);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002944 } else {
2945 /*
2946 * We don't know how much we wrote, so just return
2947 * the number of bytes which were direct-written
2948 */
2949 }
2950 } else {
Al Viro0b8def92015-04-07 10:22:53 -04002951 written = generic_perform_write(file, from, iocb->ki_pos);
2952 if (likely(written > 0))
2953 iocb->ki_pos += written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002954 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002955out:
2956 current->backing_dev_info = NULL;
2957 return written ? written : err;
2958}
Al Viro81742022014-04-03 03:17:43 -04002959EXPORT_SYMBOL(__generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002960
Jan Karae4dd9de2009-08-17 18:10:06 +02002961/**
Al Viro81742022014-04-03 03:17:43 -04002962 * generic_file_write_iter - write data to a file
Jan Karae4dd9de2009-08-17 18:10:06 +02002963 * @iocb: IO state structure
Al Viro81742022014-04-03 03:17:43 -04002964 * @from: iov_iter with data to write
Jan Karae4dd9de2009-08-17 18:10:06 +02002965 *
Al Viro81742022014-04-03 03:17:43 -04002966 * This is a wrapper around __generic_file_write_iter() to be used by most
Jan Karae4dd9de2009-08-17 18:10:06 +02002967 * filesystems. It takes care of syncing the file in case of O_SYNC file
2968 * and acquires i_mutex as needed.
2969 */
Al Viro81742022014-04-03 03:17:43 -04002970ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002971{
2972 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02002973 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002974 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002975
Al Viro59551022016-01-22 15:40:57 -05002976 inode_lock(inode);
Al Viro3309dd02015-04-09 12:55:47 -04002977 ret = generic_write_checks(iocb, from);
2978 if (ret > 0)
Al Viro5f380c72015-04-07 11:28:12 -04002979 ret = __generic_file_write_iter(iocb, from);
Al Viro59551022016-01-22 15:40:57 -05002980 inode_unlock(inode);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002981
Christoph Hellwige2592212016-04-07 08:52:01 -07002982 if (ret > 0)
2983 ret = generic_write_sync(iocb, ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002984 return ret;
2985}
Al Viro81742022014-04-03 03:17:43 -04002986EXPORT_SYMBOL(generic_file_write_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002987
David Howellscf9a2ae2006-08-29 19:05:54 +01002988/**
2989 * try_to_release_page() - release old fs-specific metadata on a page
2990 *
2991 * @page: the page which the kernel is trying to free
2992 * @gfp_mask: memory allocation flags (and I/O mode)
2993 *
2994 * The address_space is to try to release any data against the page
mchehab@s-opensource.com0e056eb2017-03-30 17:11:36 -03002995 * (presumably at page->private). If the release was successful, return '1'.
David Howellscf9a2ae2006-08-29 19:05:54 +01002996 * Otherwise return zero.
2997 *
David Howells266cf652009-04-03 16:42:36 +01002998 * This may also be called if PG_fscache is set on a page, indicating that the
2999 * page is known to the local caching routines.
3000 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003001 * The @gfp_mask argument specifies whether I/O may be performed to release
Mel Gorman71baba42015-11-06 16:28:28 -08003002 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01003003 *
David Howellscf9a2ae2006-08-29 19:05:54 +01003004 */
3005int try_to_release_page(struct page *page, gfp_t gfp_mask)
3006{
3007 struct address_space * const mapping = page->mapping;
3008
3009 BUG_ON(!PageLocked(page));
3010 if (PageWriteback(page))
3011 return 0;
3012
3013 if (mapping && mapping->a_ops->releasepage)
3014 return mapping->a_ops->releasepage(page, gfp_mask);
3015 return try_to_free_buffers(page);
3016}
3017
3018EXPORT_SYMBOL(try_to_release_page);