mm/filemap: change filemap_create_page calling conventions
[linux-block.git] / mm / filemap.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8/*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
b95f1b31 13#include <linux/export.h>
1da177e4 14#include <linux/compiler.h>
f9fe48be 15#include <linux/dax.h>
1da177e4 16#include <linux/fs.h>
3f07c014 17#include <linux/sched/signal.h>
c22ce143 18#include <linux/uaccess.h>
c59ede7b 19#include <linux/capability.h>
1da177e4 20#include <linux/kernel_stat.h>
5a0e3ad6 21#include <linux/gfp.h>
1da177e4
LT
22#include <linux/mm.h>
23#include <linux/swap.h>
24#include <linux/mman.h>
25#include <linux/pagemap.h>
26#include <linux/file.h>
27#include <linux/uio.h>
cfcbfb13 28#include <linux/error-injection.h>
1da177e4
LT
29#include <linux/hash.h>
30#include <linux/writeback.h>
53253383 31#include <linux/backing-dev.h>
1da177e4
LT
32#include <linux/pagevec.h>
33#include <linux/blkdev.h>
34#include <linux/security.h>
44110fe3 35#include <linux/cpuset.h>
00501b53 36#include <linux/hugetlb.h>
8a9f3ccd 37#include <linux/memcontrol.h>
c515e1fd 38#include <linux/cleancache.h>
c7df8ad2 39#include <linux/shmem_fs.h>
f1820361 40#include <linux/rmap.h>
b1d29ba8 41#include <linux/delayacct.h>
eb414681 42#include <linux/psi.h>
d0e6a582 43#include <linux/ramfs.h>
b9306a79 44#include <linux/page_idle.h>
f9ce0be7 45#include <asm/pgalloc.h>
de591a82 46#include <asm/tlbflush.h>
0f8053a5
NP
47#include "internal.h"
48
fe0bfaaf
RJ
49#define CREATE_TRACE_POINTS
50#include <trace/events/filemap.h>
51
1da177e4 52/*
1da177e4
LT
53 * FIXME: remove all knowledge of the buffer layer from the core VM
54 */
148f948b 55#include <linux/buffer_head.h> /* for try_to_free_buffers */
1da177e4 56
1da177e4
LT
57#include <asm/mman.h>
58
59/*
60 * Shared mappings implemented 30.11.1994. It's not fully working yet,
61 * though.
62 *
63 * Shared mappings now work. 15.8.1995 Bruno.
64 *
65 * finished 'unifying' the page and buffer cache and SMP-threaded the
66 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
67 *
68 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
69 */
70
71/*
72 * Lock ordering:
73 *
c8c06efa 74 * ->i_mmap_rwsem (truncate_pagecache)
1da177e4 75 * ->private_lock (__free_pte->__set_page_dirty_buffers)
5d337b91 76 * ->swap_lock (exclusive_swap_page, others)
b93b0163 77 * ->i_pages lock
1da177e4 78 *
1b1dcc1b 79 * ->i_mutex
c8c06efa 80 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
1da177e4 81 *
c1e8d7c6 82 * ->mmap_lock
c8c06efa 83 * ->i_mmap_rwsem
b8072f09 84 * ->page_table_lock or pte_lock (various, mainly in memory.c)
b93b0163 85 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
1da177e4 86 *
c1e8d7c6 87 * ->mmap_lock
1da177e4
LT
88 * ->lock_page (access_process_vm)
89 *
ccad2365 90 * ->i_mutex (generic_perform_write)
c1e8d7c6 91 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
1da177e4 92 *
f758eeab 93 * bdi->wb.list_lock
a66979ab 94 * sb_lock (fs/fs-writeback.c)
b93b0163 95 * ->i_pages lock (__sync_single_inode)
1da177e4 96 *
c8c06efa 97 * ->i_mmap_rwsem
1da177e4
LT
98 * ->anon_vma.lock (vma_adjust)
99 *
100 * ->anon_vma.lock
b8072f09 101 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
1da177e4 102 *
b8072f09 103 * ->page_table_lock or pte_lock
5d337b91 104 * ->swap_lock (try_to_unmap_one)
1da177e4 105 * ->private_lock (try_to_unmap_one)
b93b0163 106 * ->i_pages lock (try_to_unmap_one)
15b44736
HD
107 * ->lruvec->lru_lock (follow_page->mark_page_accessed)
108 * ->lruvec->lru_lock (check_pte_range->isolate_lru_page)
1da177e4 109 * ->private_lock (page_remove_rmap->set_page_dirty)
b93b0163 110 * ->i_pages lock (page_remove_rmap->set_page_dirty)
f758eeab 111 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
250df6ed 112 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
81f8c3a4 113 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
f758eeab 114 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
250df6ed 115 * ->inode->i_lock (zap_pte_range->set_page_dirty)
1da177e4
LT
116 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
117 *
c8c06efa 118 * ->i_mmap_rwsem
9a3c531d 119 * ->tasklist_lock (memory_failure, collect_procs_ao)
1da177e4
LT
120 */
121
5c024e6a 122static void page_cache_delete(struct address_space *mapping,
91b0abe3
JW
123 struct page *page, void *shadow)
124{
5c024e6a
MW
125 XA_STATE(xas, &mapping->i_pages, page->index);
126 unsigned int nr = 1;
c70b647d 127
5c024e6a 128 mapping_set_update(&xas, mapping);
c70b647d 129
5c024e6a
MW
130 /* hugetlb pages are represented by a single entry in the xarray */
131 if (!PageHuge(page)) {
132 xas_set_order(&xas, page->index, compound_order(page));
d8c6546b 133 nr = compound_nr(page);
5c024e6a 134 }
91b0abe3 135
83929372
KS
136 VM_BUG_ON_PAGE(!PageLocked(page), page);
137 VM_BUG_ON_PAGE(PageTail(page), page);
138 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
449dd698 139
5c024e6a
MW
140 xas_store(&xas, shadow);
141 xas_init_marks(&xas);
d3798ae8 142
2300638b
JK
143 page->mapping = NULL;
144 /* Leave page->index set: truncation lookup relies upon it */
145
d3798ae8
JW
146 if (shadow) {
147 mapping->nrexceptional += nr;
148 /*
149 * Make sure the nrexceptional update is committed before
150 * the nrpages update so that final truncate racing
151 * with reclaim does not see both counters 0 at the
152 * same time and miss a shadow entry.
153 */
154 smp_wmb();
155 }
156 mapping->nrpages -= nr;
91b0abe3
JW
157}
158
5ecc4d85
JK
159static void unaccount_page_cache_page(struct address_space *mapping,
160 struct page *page)
1da177e4 161{
5ecc4d85 162 int nr;
1da177e4 163
c515e1fd
DM
164 /*
165 * if we're uptodate, flush out into the cleancache, otherwise
166 * invalidate any existing cleancache entries. We can't leave
167 * stale data around in the cleancache once our page is gone
168 */
169 if (PageUptodate(page) && PageMappedToDisk(page))
170 cleancache_put_page(page);
171 else
3167760f 172 cleancache_invalidate_page(mapping, page);
c515e1fd 173
83929372 174 VM_BUG_ON_PAGE(PageTail(page), page);
06b241f3
HD
175 VM_BUG_ON_PAGE(page_mapped(page), page);
176 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
177 int mapcount;
178
179 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
180 current->comm, page_to_pfn(page));
181 dump_page(page, "still mapped when deleted");
182 dump_stack();
183 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
184
185 mapcount = page_mapcount(page);
186 if (mapping_exiting(mapping) &&
187 page_count(page) >= mapcount + 2) {
188 /*
189 * All vmas have already been torn down, so it's
190 * a good bet that actually the page is unmapped,
191 * and we'd prefer not to leak it: if we're wrong,
192 * some other bad page check should catch it later.
193 */
194 page_mapcount_reset(page);
6d061f9f 195 page_ref_sub(page, mapcount);
06b241f3
HD
196 }
197 }
198
4165b9b4 199 /* hugetlb pages do not participate in page cache accounting. */
5ecc4d85
JK
200 if (PageHuge(page))
201 return;
09612fa6 202
6c357848 203 nr = thp_nr_pages(page);
5ecc4d85 204
0d1c2072 205 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
5ecc4d85 206 if (PageSwapBacked(page)) {
0d1c2072 207 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
5ecc4d85 208 if (PageTransHuge(page))
b8eddff8 209 __dec_lruvec_page_state(page, NR_SHMEM_THPS);
99cb0dbd 210 } else if (PageTransHuge(page)) {
b8eddff8 211 __dec_lruvec_page_state(page, NR_FILE_THPS);
09d91cda 212 filemap_nr_thps_dec(mapping);
800d8c63 213 }
5ecc4d85
JK
214
215 /*
216 * At this point page must be either written or cleaned by
217 * truncate. Dirty page here signals a bug and loss of
218 * unwritten data.
219 *
220 * This fixes dirty accounting after removing the page entirely
221 * but leaves PageDirty set: it has no effect for truncated
222 * page and anyway will be cleared before returning page into
223 * buddy allocator.
224 */
225 if (WARN_ON_ONCE(PageDirty(page)))
226 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
227}
228
229/*
230 * Delete a page from the page cache and free it. Caller has to make
231 * sure the page is locked and that nobody else uses it - or that usage
b93b0163 232 * is safe. The caller must hold the i_pages lock.
5ecc4d85
JK
233 */
234void __delete_from_page_cache(struct page *page, void *shadow)
235{
236 struct address_space *mapping = page->mapping;
237
238 trace_mm_filemap_delete_from_page_cache(page);
239
240 unaccount_page_cache_page(mapping, page);
5c024e6a 241 page_cache_delete(mapping, page, shadow);
1da177e4
LT
242}
243
59c66c5f
JK
244static void page_cache_free_page(struct address_space *mapping,
245 struct page *page)
246{
247 void (*freepage)(struct page *);
248
249 freepage = mapping->a_ops->freepage;
250 if (freepage)
251 freepage(page);
252
253 if (PageTransHuge(page) && !PageHuge(page)) {
887b22c6 254 page_ref_sub(page, thp_nr_pages(page));
59c66c5f
JK
255 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
256 } else {
257 put_page(page);
258 }
259}
260
702cfbf9
MK
261/**
262 * delete_from_page_cache - delete page from page cache
263 * @page: the page which the kernel is trying to remove from page cache
264 *
265 * This must be called only on pages that have been verified to be in the page
266 * cache and locked. It will never put the page into the free list, the caller
267 * has a reference on the page.
268 */
269void delete_from_page_cache(struct page *page)
1da177e4 270{
83929372 271 struct address_space *mapping = page_mapping(page);
c4843a75 272 unsigned long flags;
1da177e4 273
cd7619d6 274 BUG_ON(!PageLocked(page));
b93b0163 275 xa_lock_irqsave(&mapping->i_pages, flags);
62cccb8c 276 __delete_from_page_cache(page, NULL);
b93b0163 277 xa_unlock_irqrestore(&mapping->i_pages, flags);
6072d13c 278
59c66c5f 279 page_cache_free_page(mapping, page);
97cecb5a
MK
280}
281EXPORT_SYMBOL(delete_from_page_cache);
282
aa65c29c 283/*
ef8e5717 284 * page_cache_delete_batch - delete several pages from page cache
aa65c29c
JK
285 * @mapping: the mapping to which pages belong
286 * @pvec: pagevec with pages to delete
287 *
b93b0163 288 * The function walks over mapping->i_pages and removes pages passed in @pvec
4101196b
MWO
289 * from the mapping. The function expects @pvec to be sorted by page index
290 * and is optimised for it to be dense.
b93b0163 291 * It tolerates holes in @pvec (mapping entries at those indices are not
aa65c29c 292 * modified). The function expects only THP head pages to be present in the
4101196b 293 * @pvec.
aa65c29c 294 *
b93b0163 295 * The function expects the i_pages lock to be held.
aa65c29c 296 */
ef8e5717 297static void page_cache_delete_batch(struct address_space *mapping,
aa65c29c
JK
298 struct pagevec *pvec)
299{
ef8e5717 300 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
aa65c29c 301 int total_pages = 0;
4101196b 302 int i = 0;
aa65c29c 303 struct page *page;
aa65c29c 304
ef8e5717
MW
305 mapping_set_update(&xas, mapping);
306 xas_for_each(&xas, page, ULONG_MAX) {
4101196b 307 if (i >= pagevec_count(pvec))
aa65c29c 308 break;
4101196b
MWO
309
310 /* A swap/dax/shadow entry got inserted? Skip it. */
3159f943 311 if (xa_is_value(page))
aa65c29c 312 continue;
4101196b
MWO
313 /*
314 * A page got inserted in our range? Skip it. We have our
315 * pages locked so they are protected from being removed.
316 * If we see a page whose index is higher than ours, it
317 * means our page has been removed, which shouldn't be
318 * possible because we're holding the PageLock.
319 */
320 if (page != pvec->pages[i]) {
321 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
322 page);
323 continue;
324 }
325
326 WARN_ON_ONCE(!PageLocked(page));
327
328 if (page->index == xas.xa_index)
aa65c29c 329 page->mapping = NULL;
4101196b
MWO
330 /* Leave page->index set: truncation lookup relies on it */
331
332 /*
333 * Move to the next page in the vector if this is a regular
334 * page or the index is of the last sub-page of this compound
335 * page.
336 */
337 if (page->index + compound_nr(page) - 1 == xas.xa_index)
aa65c29c 338 i++;
ef8e5717 339 xas_store(&xas, NULL);
aa65c29c
JK
340 total_pages++;
341 }
342 mapping->nrpages -= total_pages;
343}
344
345void delete_from_page_cache_batch(struct address_space *mapping,
346 struct pagevec *pvec)
347{
348 int i;
349 unsigned long flags;
350
351 if (!pagevec_count(pvec))
352 return;
353
b93b0163 354 xa_lock_irqsave(&mapping->i_pages, flags);
aa65c29c
JK
355 for (i = 0; i < pagevec_count(pvec); i++) {
356 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
357
358 unaccount_page_cache_page(mapping, pvec->pages[i]);
359 }
ef8e5717 360 page_cache_delete_batch(mapping, pvec);
b93b0163 361 xa_unlock_irqrestore(&mapping->i_pages, flags);
aa65c29c
JK
362
363 for (i = 0; i < pagevec_count(pvec); i++)
364 page_cache_free_page(mapping, pvec->pages[i]);
365}
366
d72d9e2a 367int filemap_check_errors(struct address_space *mapping)
865ffef3
DM
368{
369 int ret = 0;
370 /* Check for outstanding write errors */
7fcbbaf1
JA
371 if (test_bit(AS_ENOSPC, &mapping->flags) &&
372 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
865ffef3 373 ret = -ENOSPC;
7fcbbaf1
JA
374 if (test_bit(AS_EIO, &mapping->flags) &&
375 test_and_clear_bit(AS_EIO, &mapping->flags))
865ffef3
DM
376 ret = -EIO;
377 return ret;
378}
d72d9e2a 379EXPORT_SYMBOL(filemap_check_errors);
865ffef3 380
76341cab
JL
381static int filemap_check_and_keep_errors(struct address_space *mapping)
382{
383 /* Check for outstanding write errors */
384 if (test_bit(AS_EIO, &mapping->flags))
385 return -EIO;
386 if (test_bit(AS_ENOSPC, &mapping->flags))
387 return -ENOSPC;
388 return 0;
389}
390
1da177e4 391/**
485bb99b 392 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
67be2dd1
MW
393 * @mapping: address space structure to write
394 * @start: offset in bytes where the range starts
469eb4d0 395 * @end: offset in bytes where the range ends (inclusive)
67be2dd1 396 * @sync_mode: enable synchronous operation
1da177e4 397 *
485bb99b
RD
398 * Start writeback against all of a mapping's dirty pages that lie
399 * within the byte offsets <start, end> inclusive.
400 *
1da177e4 401 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
485bb99b 402 * opposed to a regular memory cleansing writeback. The difference between
1da177e4
LT
403 * these two operations is that if a dirty page/buffer is encountered, it must
404 * be waited upon, and not just skipped over.
a862f68a
MR
405 *
406 * Return: %0 on success, negative error code otherwise.
1da177e4 407 */
ebcf28e1
AM
408int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
409 loff_t end, int sync_mode)
1da177e4
LT
410{
411 int ret;
412 struct writeback_control wbc = {
413 .sync_mode = sync_mode,
05fe478d 414 .nr_to_write = LONG_MAX,
111ebb6e
OH
415 .range_start = start,
416 .range_end = end,
1da177e4
LT
417 };
418
f56753ac 419 if (!mapping_can_writeback(mapping) ||
c3aab9a0 420 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
1da177e4
LT
421 return 0;
422
b16b1deb 423 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
1da177e4 424 ret = do_writepages(mapping, &wbc);
b16b1deb 425 wbc_detach_inode(&wbc);
1da177e4
LT
426 return ret;
427}
428
429static inline int __filemap_fdatawrite(struct address_space *mapping,
430 int sync_mode)
431{
111ebb6e 432 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
1da177e4
LT
433}
434
435int filemap_fdatawrite(struct address_space *mapping)
436{
437 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
438}
439EXPORT_SYMBOL(filemap_fdatawrite);
440
f4c0a0fd 441int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
ebcf28e1 442 loff_t end)
1da177e4
LT
443{
444 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
445}
f4c0a0fd 446EXPORT_SYMBOL(filemap_fdatawrite_range);
1da177e4 447
485bb99b
RD
448/**
449 * filemap_flush - mostly a non-blocking flush
450 * @mapping: target address_space
451 *
1da177e4
LT
452 * This is a mostly non-blocking flush. Not suitable for data-integrity
453 * purposes - I/O may not be started against all dirty pages.
a862f68a
MR
454 *
455 * Return: %0 on success, negative error code otherwise.
1da177e4
LT
456 */
457int filemap_flush(struct address_space *mapping)
458{
459 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
460}
461EXPORT_SYMBOL(filemap_flush);
462
7fc9e472
GR
463/**
464 * filemap_range_has_page - check if a page exists in range.
465 * @mapping: address space within which to check
466 * @start_byte: offset in bytes where the range starts
467 * @end_byte: offset in bytes where the range ends (inclusive)
468 *
469 * Find at least one page in the range supplied, usually used to check if
470 * direct writing in this range will trigger a writeback.
a862f68a
MR
471 *
472 * Return: %true if at least one page exists in the specified range,
473 * %false otherwise.
7fc9e472
GR
474 */
475bool filemap_range_has_page(struct address_space *mapping,
476 loff_t start_byte, loff_t end_byte)
477{
f7b68046 478 struct page *page;
8fa8e538
MW
479 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
480 pgoff_t max = end_byte >> PAGE_SHIFT;
7fc9e472
GR
481
482 if (end_byte < start_byte)
483 return false;
484
8fa8e538
MW
485 rcu_read_lock();
486 for (;;) {
487 page = xas_find(&xas, max);
488 if (xas_retry(&xas, page))
489 continue;
490 /* Shadow entries don't count */
491 if (xa_is_value(page))
492 continue;
493 /*
494 * We don't need to try to pin this page; we're about to
495 * release the RCU lock anyway. It is enough to know that
496 * there was a page here recently.
497 */
498 break;
499 }
500 rcu_read_unlock();
7fc9e472 501
8fa8e538 502 return page != NULL;
7fc9e472
GR
503}
504EXPORT_SYMBOL(filemap_range_has_page);
505
5e8fcc1a 506static void __filemap_fdatawait_range(struct address_space *mapping,
aa750fd7 507 loff_t start_byte, loff_t end_byte)
1da177e4 508{
09cbfeaf
KS
509 pgoff_t index = start_byte >> PAGE_SHIFT;
510 pgoff_t end = end_byte >> PAGE_SHIFT;
1da177e4
LT
511 struct pagevec pvec;
512 int nr_pages;
1da177e4 513
94004ed7 514 if (end_byte < start_byte)
5e8fcc1a 515 return;
1da177e4 516
86679820 517 pagevec_init(&pvec);
312e9d2f 518 while (index <= end) {
1da177e4
LT
519 unsigned i;
520
312e9d2f 521 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
67fd707f 522 end, PAGECACHE_TAG_WRITEBACK);
312e9d2f
JK
523 if (!nr_pages)
524 break;
525
1da177e4
LT
526 for (i = 0; i < nr_pages; i++) {
527 struct page *page = pvec.pages[i];
528
1da177e4 529 wait_on_page_writeback(page);
5e8fcc1a 530 ClearPageError(page);
1da177e4
LT
531 }
532 pagevec_release(&pvec);
533 cond_resched();
534 }
aa750fd7
JN
535}
536
537/**
538 * filemap_fdatawait_range - wait for writeback to complete
539 * @mapping: address space structure to wait for
540 * @start_byte: offset in bytes where the range starts
541 * @end_byte: offset in bytes where the range ends (inclusive)
542 *
543 * Walk the list of under-writeback pages of the given address space
544 * in the given range and wait for all of them. Check error status of
545 * the address space and return it.
546 *
547 * Since the error status of the address space is cleared by this function,
548 * callers are responsible for checking the return value and handling and/or
549 * reporting the error.
a862f68a
MR
550 *
551 * Return: error status of the address space.
aa750fd7
JN
552 */
553int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
554 loff_t end_byte)
555{
5e8fcc1a
JL
556 __filemap_fdatawait_range(mapping, start_byte, end_byte);
557 return filemap_check_errors(mapping);
1da177e4 558}
d3bccb6f
JK
559EXPORT_SYMBOL(filemap_fdatawait_range);
560
aa0bfcd9
RZ
561/**
562 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
563 * @mapping: address space structure to wait for
564 * @start_byte: offset in bytes where the range starts
565 * @end_byte: offset in bytes where the range ends (inclusive)
566 *
567 * Walk the list of under-writeback pages of the given address space in the
568 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
569 * this function does not clear error status of the address space.
570 *
571 * Use this function if callers don't handle errors themselves. Expected
572 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
573 * fsfreeze(8)
574 */
575int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
576 loff_t start_byte, loff_t end_byte)
577{
578 __filemap_fdatawait_range(mapping, start_byte, end_byte);
579 return filemap_check_and_keep_errors(mapping);
580}
581EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
582
a823e458
JL
583/**
584 * file_fdatawait_range - wait for writeback to complete
585 * @file: file pointing to address space structure to wait for
586 * @start_byte: offset in bytes where the range starts
587 * @end_byte: offset in bytes where the range ends (inclusive)
588 *
589 * Walk the list of under-writeback pages of the address space that file
590 * refers to, in the given range and wait for all of them. Check error
591 * status of the address space vs. the file->f_wb_err cursor and return it.
592 *
593 * Since the error status of the file is advanced by this function,
594 * callers are responsible for checking the return value and handling and/or
595 * reporting the error.
a862f68a
MR
596 *
597 * Return: error status of the address space vs. the file->f_wb_err cursor.
a823e458
JL
598 */
599int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
600{
601 struct address_space *mapping = file->f_mapping;
602
603 __filemap_fdatawait_range(mapping, start_byte, end_byte);
604 return file_check_and_advance_wb_err(file);
605}
606EXPORT_SYMBOL(file_fdatawait_range);
d3bccb6f 607
aa750fd7
JN
608/**
609 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
610 * @mapping: address space structure to wait for
611 *
612 * Walk the list of under-writeback pages of the given address space
613 * and wait for all of them. Unlike filemap_fdatawait(), this function
614 * does not clear error status of the address space.
615 *
616 * Use this function if callers don't handle errors themselves. Expected
617 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
618 * fsfreeze(8)
a862f68a
MR
619 *
620 * Return: error status of the address space.
aa750fd7 621 */
76341cab 622int filemap_fdatawait_keep_errors(struct address_space *mapping)
aa750fd7 623{
ffb959bb 624 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
76341cab 625 return filemap_check_and_keep_errors(mapping);
aa750fd7 626}
76341cab 627EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
aa750fd7 628
875d91b1 629/* Returns true if writeback might be needed or already in progress. */
9326c9b2 630static bool mapping_needs_writeback(struct address_space *mapping)
1da177e4 631{
875d91b1
KK
632 if (dax_mapping(mapping))
633 return mapping->nrexceptional;
634
635 return mapping->nrpages;
1da177e4 636}
1da177e4 637
485bb99b
RD
638/**
639 * filemap_write_and_wait_range - write out & wait on a file range
640 * @mapping: the address_space for the pages
641 * @lstart: offset in bytes where the range starts
642 * @lend: offset in bytes where the range ends (inclusive)
643 *
469eb4d0
AM
644 * Write out and wait upon file offsets lstart->lend, inclusive.
645 *
0e056eb5 646 * Note that @lend is inclusive (describes the last byte to be written) so
469eb4d0 647 * that this function can be used to write to the very end-of-file (end = -1).
a862f68a
MR
648 *
649 * Return: error status of the address space.
469eb4d0 650 */
1da177e4
LT
651int filemap_write_and_wait_range(struct address_space *mapping,
652 loff_t lstart, loff_t lend)
653{
28fd1298 654 int err = 0;
1da177e4 655
9326c9b2 656 if (mapping_needs_writeback(mapping)) {
28fd1298
OH
657 err = __filemap_fdatawrite_range(mapping, lstart, lend,
658 WB_SYNC_ALL);
ddf8f376
IW
659 /*
660 * Even if the above returned error, the pages may be
661 * written partially (e.g. -ENOSPC), so we wait for it.
662 * But the -EIO is special case, it may indicate the worst
663 * thing (e.g. bug) happened, so we avoid waiting for it.
664 */
28fd1298 665 if (err != -EIO) {
94004ed7
CH
666 int err2 = filemap_fdatawait_range(mapping,
667 lstart, lend);
28fd1298
OH
668 if (!err)
669 err = err2;
cbeaf951
JL
670 } else {
671 /* Clear any previously stored errors */
672 filemap_check_errors(mapping);
28fd1298 673 }
865ffef3
DM
674 } else {
675 err = filemap_check_errors(mapping);
1da177e4 676 }
28fd1298 677 return err;
1da177e4 678}
f6995585 679EXPORT_SYMBOL(filemap_write_and_wait_range);
1da177e4 680
5660e13d
JL
681void __filemap_set_wb_err(struct address_space *mapping, int err)
682{
3acdfd28 683 errseq_t eseq = errseq_set(&mapping->wb_err, err);
5660e13d
JL
684
685 trace_filemap_set_wb_err(mapping, eseq);
686}
687EXPORT_SYMBOL(__filemap_set_wb_err);
688
689/**
690 * file_check_and_advance_wb_err - report wb error (if any) that was previously
691 * and advance wb_err to current one
692 * @file: struct file on which the error is being reported
693 *
694 * When userland calls fsync (or something like nfsd does the equivalent), we
695 * want to report any writeback errors that occurred since the last fsync (or
696 * since the file was opened if there haven't been any).
697 *
698 * Grab the wb_err from the mapping. If it matches what we have in the file,
699 * then just quickly return 0. The file is all caught up.
700 *
701 * If it doesn't match, then take the mapping value, set the "seen" flag in
702 * it and try to swap it into place. If it works, or another task beat us
703 * to it with the new value, then update the f_wb_err and return the error
704 * portion. The error at this point must be reported via proper channels
705 * (a'la fsync, or NFS COMMIT operation, etc.).
706 *
707 * While we handle mapping->wb_err with atomic operations, the f_wb_err
708 * value is protected by the f_lock since we must ensure that it reflects
709 * the latest value swapped in for this file descriptor.
a862f68a
MR
710 *
711 * Return: %0 on success, negative error code otherwise.
5660e13d
JL
712 */
713int file_check_and_advance_wb_err(struct file *file)
714{
715 int err = 0;
716 errseq_t old = READ_ONCE(file->f_wb_err);
717 struct address_space *mapping = file->f_mapping;
718
719 /* Locklessly handle the common case where nothing has changed */
720 if (errseq_check(&mapping->wb_err, old)) {
721 /* Something changed, must use slow path */
722 spin_lock(&file->f_lock);
723 old = file->f_wb_err;
724 err = errseq_check_and_advance(&mapping->wb_err,
725 &file->f_wb_err);
726 trace_file_check_and_advance_wb_err(file, old);
727 spin_unlock(&file->f_lock);
728 }
f4e222c5
JL
729
730 /*
731 * We're mostly using this function as a drop in replacement for
732 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
733 * that the legacy code would have had on these flags.
734 */
735 clear_bit(AS_EIO, &mapping->flags);
736 clear_bit(AS_ENOSPC, &mapping->flags);
5660e13d
JL
737 return err;
738}
739EXPORT_SYMBOL(file_check_and_advance_wb_err);
740
741/**
742 * file_write_and_wait_range - write out & wait on a file range
743 * @file: file pointing to address_space with pages
744 * @lstart: offset in bytes where the range starts
745 * @lend: offset in bytes where the range ends (inclusive)
746 *
747 * Write out and wait upon file offsets lstart->lend, inclusive.
748 *
749 * Note that @lend is inclusive (describes the last byte to be written) so
750 * that this function can be used to write to the very end-of-file (end = -1).
751 *
752 * After writing out and waiting on the data, we check and advance the
753 * f_wb_err cursor to the latest value, and return any errors detected there.
a862f68a
MR
754 *
755 * Return: %0 on success, negative error code otherwise.
5660e13d
JL
756 */
757int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
758{
759 int err = 0, err2;
760 struct address_space *mapping = file->f_mapping;
761
9326c9b2 762 if (mapping_needs_writeback(mapping)) {
5660e13d
JL
763 err = __filemap_fdatawrite_range(mapping, lstart, lend,
764 WB_SYNC_ALL);
765 /* See comment of filemap_write_and_wait() */
766 if (err != -EIO)
767 __filemap_fdatawait_range(mapping, lstart, lend);
768 }
769 err2 = file_check_and_advance_wb_err(file);
770 if (!err)
771 err = err2;
772 return err;
773}
774EXPORT_SYMBOL(file_write_and_wait_range);
775
ef6a3c63
MS
776/**
777 * replace_page_cache_page - replace a pagecache page with a new one
778 * @old: page to be replaced
779 * @new: page to replace with
ef6a3c63
MS
780 *
781 * This function replaces a page in the pagecache with a new one. On
782 * success it acquires the pagecache reference for the new page and
783 * drops it for the old page. Both the old and new pages must be
784 * locked. This function does not add the new page to the LRU, the
785 * caller must do that.
786 *
74d60958 787 * The remove + add is atomic. This function cannot fail.
ef6a3c63 788 */
1f7ef657 789void replace_page_cache_page(struct page *old, struct page *new)
ef6a3c63 790{
74d60958
MW
791 struct address_space *mapping = old->mapping;
792 void (*freepage)(struct page *) = mapping->a_ops->freepage;
793 pgoff_t offset = old->index;
794 XA_STATE(xas, &mapping->i_pages, offset);
795 unsigned long flags;
ef6a3c63 796
309381fe
SL
797 VM_BUG_ON_PAGE(!PageLocked(old), old);
798 VM_BUG_ON_PAGE(!PageLocked(new), new);
799 VM_BUG_ON_PAGE(new->mapping, new);
ef6a3c63 800
74d60958
MW
801 get_page(new);
802 new->mapping = mapping;
803 new->index = offset;
ef6a3c63 804
0d1c2072
JW
805 mem_cgroup_migrate(old, new);
806
74d60958
MW
807 xas_lock_irqsave(&xas, flags);
808 xas_store(&xas, new);
4165b9b4 809
74d60958
MW
810 old->mapping = NULL;
811 /* hugetlb pages do not participate in page cache accounting. */
812 if (!PageHuge(old))
0d1c2072 813 __dec_lruvec_page_state(old, NR_FILE_PAGES);
74d60958 814 if (!PageHuge(new))
0d1c2072 815 __inc_lruvec_page_state(new, NR_FILE_PAGES);
74d60958 816 if (PageSwapBacked(old))
0d1c2072 817 __dec_lruvec_page_state(old, NR_SHMEM);
74d60958 818 if (PageSwapBacked(new))
0d1c2072 819 __inc_lruvec_page_state(new, NR_SHMEM);
74d60958 820 xas_unlock_irqrestore(&xas, flags);
74d60958
MW
821 if (freepage)
822 freepage(old);
823 put_page(old);
ef6a3c63
MS
824}
825EXPORT_SYMBOL_GPL(replace_page_cache_page);
826
16c0cc0c 827noinline int __add_to_page_cache_locked(struct page *page,
76cd6173 828 struct address_space *mapping,
c4cf498d 829 pgoff_t offset, gfp_t gfp,
76cd6173 830 void **shadowp)
1da177e4 831{
74d60958 832 XA_STATE(xas, &mapping->i_pages, offset);
00501b53 833 int huge = PageHuge(page);
e286781d 834 int error;
da74240e 835 bool charged = false;
e286781d 836
309381fe
SL
837 VM_BUG_ON_PAGE(!PageLocked(page), page);
838 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
74d60958 839 mapping_set_update(&xas, mapping);
e286781d 840
09cbfeaf 841 get_page(page);
66a0c8ee
KS
842 page->mapping = mapping;
843 page->index = offset;
844
3fea5a49 845 if (!huge) {
198b62f8 846 error = mem_cgroup_charge(page, current->mm, gfp);
3fea5a49
JW
847 if (error)
848 goto error;
da74240e 849 charged = true;
3fea5a49
JW
850 }
851
198b62f8
MWO
852 gfp &= GFP_RECLAIM_MASK;
853
74d60958 854 do {
198b62f8
MWO
855 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
856 void *entry, *old = NULL;
857
858 if (order > thp_order(page))
859 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
860 order, gfp);
74d60958 861 xas_lock_irq(&xas);
198b62f8
MWO
862 xas_for_each_conflict(&xas, entry) {
863 old = entry;
864 if (!xa_is_value(entry)) {
865 xas_set_err(&xas, -EEXIST);
866 goto unlock;
867 }
868 }
869
870 if (old) {
871 if (shadowp)
872 *shadowp = old;
873 /* entry may have been split before we acquired lock */
874 order = xa_get_order(xas.xa, xas.xa_index);
875 if (order > thp_order(page)) {
876 xas_split(&xas, old, order);
877 xas_reset(&xas);
878 }
879 }
880
74d60958
MW
881 xas_store(&xas, page);
882 if (xas_error(&xas))
883 goto unlock;
884
198b62f8 885 if (old)
74d60958 886 mapping->nrexceptional--;
74d60958
MW
887 mapping->nrpages++;
888
889 /* hugetlb pages do not participate in page cache accounting */
890 if (!huge)
0d1c2072 891 __inc_lruvec_page_state(page, NR_FILE_PAGES);
74d60958
MW
892unlock:
893 xas_unlock_irq(&xas);
198b62f8 894 } while (xas_nomem(&xas, gfp));
74d60958 895
3fea5a49
JW
896 if (xas_error(&xas)) {
897 error = xas_error(&xas);
da74240e
WL
898 if (charged)
899 mem_cgroup_uncharge(page);
74d60958 900 goto error;
3fea5a49 901 }
4165b9b4 902
66a0c8ee
KS
903 trace_mm_filemap_add_to_page_cache(page);
904 return 0;
74d60958 905error:
66a0c8ee
KS
906 page->mapping = NULL;
907 /* Leave page->index set: truncation relies upon it */
09cbfeaf 908 put_page(page);
3fea5a49 909 return error;
1da177e4 910}
cfcbfb13 911ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
a528910e
JW
912
913/**
914 * add_to_page_cache_locked - add a locked page to the pagecache
915 * @page: page to add
916 * @mapping: the page's address_space
917 * @offset: page index
918 * @gfp_mask: page allocation mode
919 *
920 * This function is used to add a page to the pagecache. It must be locked.
921 * This function does not add the page to the LRU. The caller must do that.
a862f68a
MR
922 *
923 * Return: %0 on success, negative error code otherwise.
a528910e
JW
924 */
925int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
926 pgoff_t offset, gfp_t gfp_mask)
927{
928 return __add_to_page_cache_locked(page, mapping, offset,
929 gfp_mask, NULL);
930}
e286781d 931EXPORT_SYMBOL(add_to_page_cache_locked);
1da177e4
LT
932
933int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
6daa0e28 934 pgoff_t offset, gfp_t gfp_mask)
1da177e4 935{
a528910e 936 void *shadow = NULL;
4f98a2fe
RR
937 int ret;
938
48c935ad 939 __SetPageLocked(page);
a528910e
JW
940 ret = __add_to_page_cache_locked(page, mapping, offset,
941 gfp_mask, &shadow);
942 if (unlikely(ret))
48c935ad 943 __ClearPageLocked(page);
a528910e
JW
944 else {
945 /*
946 * The page might have been evicted from cache only
947 * recently, in which case it should be activated like
948 * any other repeatedly accessed page.
f0281a00
RR
949 * The exception is pages getting rewritten; evicting other
950 * data from the working set, only to cache data that will
951 * get overwritten with something else, is a waste of memory.
a528910e 952 */
1899ad18
JW
953 WARN_ON_ONCE(PageActive(page));
954 if (!(gfp_mask & __GFP_WRITE) && shadow)
955 workingset_refault(page, shadow);
a528910e
JW
956 lru_cache_add(page);
957 }
1da177e4
LT
958 return ret;
959}
18bc0bbd 960EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
1da177e4 961
44110fe3 962#ifdef CONFIG_NUMA
2ae88149 963struct page *__page_cache_alloc(gfp_t gfp)
44110fe3 964{
c0ff7453
MX
965 int n;
966 struct page *page;
967
44110fe3 968 if (cpuset_do_page_mem_spread()) {
cc9a6c87
MG
969 unsigned int cpuset_mems_cookie;
970 do {
d26914d1 971 cpuset_mems_cookie = read_mems_allowed_begin();
cc9a6c87 972 n = cpuset_mem_spread_node();
96db800f 973 page = __alloc_pages_node(n, gfp, 0);
d26914d1 974 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
cc9a6c87 975
c0ff7453 976 return page;
44110fe3 977 }
2ae88149 978 return alloc_pages(gfp, 0);
44110fe3 979}
2ae88149 980EXPORT_SYMBOL(__page_cache_alloc);
44110fe3
PJ
981#endif
982
1da177e4
LT
983/*
984 * In order to wait for pages to become available there must be
985 * waitqueues associated with pages. By using a hash table of
986 * waitqueues where the bucket discipline is to maintain all
987 * waiters on the same queue and wake all when any of the pages
988 * become available, and for the woken contexts to check to be
989 * sure the appropriate page became available, this saves space
990 * at a cost of "thundering herd" phenomena during rare hash
991 * collisions.
992 */
62906027
NP
993#define PAGE_WAIT_TABLE_BITS 8
994#define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
995static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
996
997static wait_queue_head_t *page_waitqueue(struct page *page)
1da177e4 998{
62906027 999 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
1da177e4 1000}
1da177e4 1001
62906027 1002void __init pagecache_init(void)
1da177e4 1003{
62906027 1004 int i;
1da177e4 1005
62906027
NP
1006 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1007 init_waitqueue_head(&page_wait_table[i]);
1008
1009 page_writeback_init();
1da177e4 1010}
1da177e4 1011
5ef64cc8
LT
1012/*
1013 * The page wait code treats the "wait->flags" somewhat unusually, because
5868ec26 1014 * we have multiple different kinds of waits, not just the usual "exclusive"
5ef64cc8
LT
1015 * one.
1016 *
1017 * We have:
1018 *
1019 * (a) no special bits set:
1020 *
1021 * We're just waiting for the bit to be released, and when a waker
1022 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1023 * and remove it from the wait queue.
1024 *
1025 * Simple and straightforward.
1026 *
1027 * (b) WQ_FLAG_EXCLUSIVE:
1028 *
1029 * The waiter is waiting to get the lock, and only one waiter should
1030 * be woken up to avoid any thundering herd behavior. We'll set the
1031 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1032 *
1033 * This is the traditional exclusive wait.
1034 *
5868ec26 1035 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
5ef64cc8
LT
1036 *
1037 * The waiter is waiting to get the bit, and additionally wants the
1038 * lock to be transferred to it for fair lock behavior. If the lock
1039 * cannot be taken, we stop walking the wait queue without waking
1040 * the waiter.
1041 *
1042 * This is the "fair lock handoff" case, and in addition to setting
1043 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1044 * that it now has the lock.
1045 */
ac6424b9 1046static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
f62e00cc 1047{
5ef64cc8 1048 unsigned int flags;
62906027
NP
1049 struct wait_page_key *key = arg;
1050 struct wait_page_queue *wait_page
1051 = container_of(wait, struct wait_page_queue, wait);
1052
cdc8fcb4 1053 if (!wake_page_match(wait_page, key))
62906027 1054 return 0;
3510ca20 1055
9a1ea439 1056 /*
5ef64cc8
LT
1057 * If it's a lock handoff wait, we get the bit for it, and
1058 * stop walking (and do not wake it up) if we can't.
9a1ea439 1059 */
5ef64cc8
LT
1060 flags = wait->flags;
1061 if (flags & WQ_FLAG_EXCLUSIVE) {
1062 if (test_bit(key->bit_nr, &key->page->flags))
2a9127fc 1063 return -1;
5ef64cc8
LT
1064 if (flags & WQ_FLAG_CUSTOM) {
1065 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1066 return -1;
1067 flags |= WQ_FLAG_DONE;
1068 }
2a9127fc 1069 }
f62e00cc 1070
5ef64cc8
LT
1071 /*
1072 * We are holding the wait-queue lock, but the waiter that
1073 * is waiting for this will be checking the flags without
1074 * any locking.
1075 *
1076 * So update the flags atomically, and wake up the waiter
1077 * afterwards to avoid any races. This store-release pairs
1078 * with the load-acquire in wait_on_page_bit_common().
1079 */
1080 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
2a9127fc
LT
1081 wake_up_state(wait->private, mode);
1082
1083 /*
1084 * Ok, we have successfully done what we're waiting for,
1085 * and we can unconditionally remove the wait entry.
1086 *
5ef64cc8
LT
1087 * Note that this pairs with the "finish_wait()" in the
1088 * waiter, and has to be the absolute last thing we do.
1089 * After this list_del_init(&wait->entry) the wait entry
2a9127fc
LT
1090 * might be de-allocated and the process might even have
1091 * exited.
2a9127fc 1092 */
c6fe44d9 1093 list_del_init_careful(&wait->entry);
5ef64cc8 1094 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
f62e00cc
KM
1095}
1096
74d81bfa 1097static void wake_up_page_bit(struct page *page, int bit_nr)
cbbce822 1098{
62906027
NP
1099 wait_queue_head_t *q = page_waitqueue(page);
1100 struct wait_page_key key;
1101 unsigned long flags;
11a19c7b 1102 wait_queue_entry_t bookmark;
cbbce822 1103
62906027
NP
1104 key.page = page;
1105 key.bit_nr = bit_nr;
1106 key.page_match = 0;
1107
11a19c7b
TC
1108 bookmark.flags = 0;
1109 bookmark.private = NULL;
1110 bookmark.func = NULL;
1111 INIT_LIST_HEAD(&bookmark.entry);
1112
62906027 1113 spin_lock_irqsave(&q->lock, flags);
11a19c7b
TC
1114 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1115
1116 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1117 /*
1118 * Take a breather from holding the lock,
1119 * allow pages that finish wake up asynchronously
1120 * to acquire the lock and remove themselves
1121 * from wait queue
1122 */
1123 spin_unlock_irqrestore(&q->lock, flags);
1124 cpu_relax();
1125 spin_lock_irqsave(&q->lock, flags);
1126 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1127 }
1128
62906027
NP
1129 /*
1130 * It is possible for other pages to have collided on the waitqueue
1131 * hash, so in that case check for a page match. That prevents a long-
1132 * term waiter
1133 *
1134 * It is still possible to miss a case here, when we woke page waiters
1135 * and removed them from the waitqueue, but there are still other
1136 * page waiters.
1137 */
1138 if (!waitqueue_active(q) || !key.page_match) {
1139 ClearPageWaiters(page);
1140 /*
1141 * It's possible to miss clearing Waiters here, when we woke
1142 * our page waiters, but the hashed waitqueue has waiters for
1143 * other pages on it.
1144 *
1145 * That's okay, it's a rare case. The next waker will clear it.
1146 */
1147 }
1148 spin_unlock_irqrestore(&q->lock, flags);
1149}
74d81bfa
NP
1150
1151static void wake_up_page(struct page *page, int bit)
1152{
1153 if (!PageWaiters(page))
1154 return;
1155 wake_up_page_bit(page, bit);
1156}
62906027 1157
9a1ea439
HD
1158/*
1159 * A choice of three behaviors for wait_on_page_bit_common():
1160 */
1161enum behavior {
1162 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1163 * __lock_page() waiting on then setting PG_locked.
1164 */
1165 SHARED, /* Hold ref to page and check the bit when woken, like
1166 * wait_on_page_writeback() waiting on PG_writeback.
1167 */
1168 DROP, /* Drop ref to page before wait, no check when woken,
1169 * like put_and_wait_on_page_locked() on PG_locked.
1170 */
1171};
1172
2a9127fc 1173/*
5ef64cc8
LT
1174 * Attempt to check (or get) the page bit, and mark us done
1175 * if successful.
2a9127fc
LT
1176 */
1177static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1178 struct wait_queue_entry *wait)
1179{
1180 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1181 if (test_and_set_bit(bit_nr, &page->flags))
1182 return false;
1183 } else if (test_bit(bit_nr, &page->flags))
1184 return false;
1185
5ef64cc8 1186 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
2a9127fc
LT
1187 return true;
1188}
1189
5ef64cc8
LT
1190/* How many times do we accept lock stealing from under a waiter? */
1191int sysctl_page_lock_unfairness = 5;
1192
62906027 1193static inline int wait_on_page_bit_common(wait_queue_head_t *q,
9a1ea439 1194 struct page *page, int bit_nr, int state, enum behavior behavior)
62906027 1195{
5ef64cc8 1196 int unfairness = sysctl_page_lock_unfairness;
62906027 1197 struct wait_page_queue wait_page;
ac6424b9 1198 wait_queue_entry_t *wait = &wait_page.wait;
b1d29ba8 1199 bool thrashing = false;
9a1ea439 1200 bool delayacct = false;
eb414681 1201 unsigned long pflags;
62906027 1202
eb414681 1203 if (bit_nr == PG_locked &&
b1d29ba8 1204 !PageUptodate(page) && PageWorkingset(page)) {
9a1ea439 1205 if (!PageSwapBacked(page)) {
eb414681 1206 delayacct_thrashing_start();
9a1ea439
HD
1207 delayacct = true;
1208 }
eb414681 1209 psi_memstall_enter(&pflags);
b1d29ba8
JW
1210 thrashing = true;
1211 }
1212
62906027
NP
1213 init_wait(wait);
1214 wait->func = wake_page_function;
1215 wait_page.page = page;
1216 wait_page.bit_nr = bit_nr;
1217
5ef64cc8
LT
1218repeat:
1219 wait->flags = 0;
1220 if (behavior == EXCLUSIVE) {
1221 wait->flags = WQ_FLAG_EXCLUSIVE;
1222 if (--unfairness < 0)
1223 wait->flags |= WQ_FLAG_CUSTOM;
1224 }
1225
2a9127fc
LT
1226 /*
1227 * Do one last check whether we can get the
1228 * page bit synchronously.
1229 *
1230 * Do the SetPageWaiters() marking before that
1231 * to let any waker we _just_ missed know they
1232 * need to wake us up (otherwise they'll never
1233 * even go to the slow case that looks at the
1234 * page queue), and add ourselves to the wait
1235 * queue if we need to sleep.
1236 *
1237 * This part needs to be done under the queue
1238 * lock to avoid races.
1239 */
1240 spin_lock_irq(&q->lock);
1241 SetPageWaiters(page);
1242 if (!trylock_page_bit_common(page, bit_nr, wait))
1243 __add_wait_queue_entry_tail(q, wait);
1244 spin_unlock_irq(&q->lock);
62906027 1245
2a9127fc
LT
1246 /*
1247 * From now on, all the logic will be based on
5ef64cc8
LT
1248 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1249 * see whether the page bit testing has already
1250 * been done by the wake function.
2a9127fc
LT
1251 *
1252 * We can drop our reference to the page.
1253 */
1254 if (behavior == DROP)
1255 put_page(page);
62906027 1256
5ef64cc8
LT
1257 /*
1258 * Note that until the "finish_wait()", or until
1259 * we see the WQ_FLAG_WOKEN flag, we need to
1260 * be very careful with the 'wait->flags', because
1261 * we may race with a waker that sets them.
1262 */
2a9127fc 1263 for (;;) {
5ef64cc8
LT
1264 unsigned int flags;
1265
62906027
NP
1266 set_current_state(state);
1267
5ef64cc8
LT
1268 /* Loop until we've been woken or interrupted */
1269 flags = smp_load_acquire(&wait->flags);
1270 if (!(flags & WQ_FLAG_WOKEN)) {
1271 if (signal_pending_state(state, current))
1272 break;
1273
1274 io_schedule();
1275 continue;
1276 }
1277
1278 /* If we were non-exclusive, we're done */
1279 if (behavior != EXCLUSIVE)
a8b169af 1280 break;
9a1ea439 1281
5ef64cc8
LT
1282 /* If the waker got the lock for us, we're done */
1283 if (flags & WQ_FLAG_DONE)
9a1ea439 1284 break;
2a9127fc 1285
5ef64cc8
LT
1286 /*
1287 * Otherwise, if we're getting the lock, we need to
1288 * try to get it ourselves.
1289 *
1290 * And if that fails, we'll have to retry this all.
1291 */
1292 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1293 goto repeat;
1294
1295 wait->flags |= WQ_FLAG_DONE;
1296 break;
62906027
NP
1297 }
1298
5ef64cc8
LT
1299 /*
1300 * If a signal happened, this 'finish_wait()' may remove the last
1301 * waiter from the wait-queues, but the PageWaiters bit will remain
1302 * set. That's ok. The next wakeup will take care of it, and trying
1303 * to do it here would be difficult and prone to races.
1304 */
62906027
NP
1305 finish_wait(q, wait);
1306
eb414681 1307 if (thrashing) {
9a1ea439 1308 if (delayacct)
eb414681
JW
1309 delayacct_thrashing_end();
1310 psi_memstall_leave(&pflags);
1311 }
b1d29ba8 1312
62906027 1313 /*
5ef64cc8
LT
1314 * NOTE! The wait->flags weren't stable until we've done the
1315 * 'finish_wait()', and we could have exited the loop above due
1316 * to a signal, and had a wakeup event happen after the signal
1317 * test but before the 'finish_wait()'.
1318 *
1319 * So only after the finish_wait() can we reliably determine
1320 * if we got woken up or not, so we can now figure out the final
1321 * return value based on that state without races.
1322 *
1323 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1324 * waiter, but an exclusive one requires WQ_FLAG_DONE.
62906027 1325 */
5ef64cc8
LT
1326 if (behavior == EXCLUSIVE)
1327 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
62906027 1328
2a9127fc 1329 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
62906027
NP
1330}
1331
1332void wait_on_page_bit(struct page *page, int bit_nr)
1333{
1334 wait_queue_head_t *q = page_waitqueue(page);
9a1ea439 1335 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
62906027
NP
1336}
1337EXPORT_SYMBOL(wait_on_page_bit);
1338
1339int wait_on_page_bit_killable(struct page *page, int bit_nr)
1340{
1341 wait_queue_head_t *q = page_waitqueue(page);
9a1ea439 1342 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
cbbce822 1343}
4343d008 1344EXPORT_SYMBOL(wait_on_page_bit_killable);
cbbce822 1345
9a1ea439
HD
1346/**
1347 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1348 * @page: The page to wait for.
48054625 1349 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
9a1ea439
HD
1350 *
1351 * The caller should hold a reference on @page. They expect the page to
1352 * become unlocked relatively soon, but do not wish to hold up migration
1353 * (for example) by holding the reference while waiting for the page to
1354 * come unlocked. After this function returns, the caller should not
1355 * dereference @page.
48054625
MWO
1356 *
1357 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
9a1ea439 1358 */
48054625 1359int put_and_wait_on_page_locked(struct page *page, int state)
9a1ea439
HD
1360{
1361 wait_queue_head_t *q;
1362
1363 page = compound_head(page);
1364 q = page_waitqueue(page);
48054625 1365 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
9a1ea439
HD
1366}
1367
385e1ca5
DH
1368/**
1369 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
697f619f
RD
1370 * @page: Page defining the wait queue of interest
1371 * @waiter: Waiter to add to the queue
385e1ca5
DH
1372 *
1373 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1374 */
ac6424b9 1375void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
385e1ca5
DH
1376{
1377 wait_queue_head_t *q = page_waitqueue(page);
1378 unsigned long flags;
1379
1380 spin_lock_irqsave(&q->lock, flags);
9c3a815f 1381 __add_wait_queue_entry_tail(q, waiter);
62906027 1382 SetPageWaiters(page);
385e1ca5
DH
1383 spin_unlock_irqrestore(&q->lock, flags);
1384}
1385EXPORT_SYMBOL_GPL(add_page_wait_queue);
1386
b91e1302
LT
1387#ifndef clear_bit_unlock_is_negative_byte
1388
1389/*
1390 * PG_waiters is the high bit in the same byte as PG_lock.
1391 *
1392 * On x86 (and on many other architectures), we can clear PG_lock and
1393 * test the sign bit at the same time. But if the architecture does
1394 * not support that special operation, we just do this all by hand
1395 * instead.
1396 *
1397 * The read of PG_waiters has to be after (or concurrently with) PG_locked
ffceeb62 1398 * being cleared, but a memory barrier should be unnecessary since it is
b91e1302
LT
1399 * in the same byte as PG_locked.
1400 */
1401static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1402{
1403 clear_bit_unlock(nr, mem);
1404 /* smp_mb__after_atomic(); */
98473f9f 1405 return test_bit(PG_waiters, mem);
b91e1302
LT
1406}
1407
1408#endif
1409
1da177e4 1410/**
485bb99b 1411 * unlock_page - unlock a locked page
1da177e4
LT
1412 * @page: the page
1413 *
0e9aa675 1414 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
1da177e4 1415 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
da3dae54 1416 * mechanism between PageLocked pages and PageWriteback pages is shared.
1da177e4
LT
1417 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1418 *
b91e1302
LT
1419 * Note that this depends on PG_waiters being the sign bit in the byte
1420 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1421 * clear the PG_locked bit and test PG_waiters at the same time fairly
1422 * portably (architectures that do LL/SC can test any bit, while x86 can
1423 * test the sign bit).
1da177e4 1424 */
920c7a5d 1425void unlock_page(struct page *page)
1da177e4 1426{
b91e1302 1427 BUILD_BUG_ON(PG_waiters != 7);
48c935ad 1428 page = compound_head(page);
309381fe 1429 VM_BUG_ON_PAGE(!PageLocked(page), page);
b91e1302
LT
1430 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1431 wake_up_page_bit(page, PG_locked);
1da177e4
LT
1432}
1433EXPORT_SYMBOL(unlock_page);
1434
485bb99b
RD
1435/**
1436 * end_page_writeback - end writeback against a page
1437 * @page: the page
1da177e4
LT
1438 */
1439void end_page_writeback(struct page *page)
1440{
888cf2db
MG
1441 /*
1442 * TestClearPageReclaim could be used here but it is an atomic
1443 * operation and overkill in this particular case. Failing to
1444 * shuffle a page marked for immediate reclaim is too mild to
1445 * justify taking an atomic operation penalty at the end of
1446 * ever page writeback.
1447 */
1448 if (PageReclaim(page)) {
1449 ClearPageReclaim(page);
ac6aadb2 1450 rotate_reclaimable_page(page);
888cf2db 1451 }
ac6aadb2 1452
073861ed
HD
1453 /*
1454 * Writeback does not hold a page reference of its own, relying
1455 * on truncation to wait for the clearing of PG_writeback.
1456 * But here we must make sure that the page is not freed and
1457 * reused before the wake_up_page().
1458 */
1459 get_page(page);
ac6aadb2
MS
1460 if (!test_clear_page_writeback(page))
1461 BUG();
1462
4e857c58 1463 smp_mb__after_atomic();
1da177e4 1464 wake_up_page(page, PG_writeback);
073861ed 1465 put_page(page);
1da177e4
LT
1466}
1467EXPORT_SYMBOL(end_page_writeback);
1468
57d99845
MW
1469/*
1470 * After completing I/O on a page, call this routine to update the page
1471 * flags appropriately
1472 */
c11f0c0b 1473void page_endio(struct page *page, bool is_write, int err)
57d99845 1474{
c11f0c0b 1475 if (!is_write) {
57d99845
MW
1476 if (!err) {
1477 SetPageUptodate(page);
1478 } else {
1479 ClearPageUptodate(page);
1480 SetPageError(page);
1481 }
1482 unlock_page(page);
abf54548 1483 } else {
57d99845 1484 if (err) {
dd8416c4
MK
1485 struct address_space *mapping;
1486
57d99845 1487 SetPageError(page);
dd8416c4
MK
1488 mapping = page_mapping(page);
1489 if (mapping)
1490 mapping_set_error(mapping, err);
57d99845
MW
1491 }
1492 end_page_writeback(page);
1493 }
1494}
1495EXPORT_SYMBOL_GPL(page_endio);
1496
485bb99b
RD
1497/**
1498 * __lock_page - get a lock on the page, assuming we need to sleep to get it
87066755 1499 * @__page: the page to lock
1da177e4 1500 */
62906027 1501void __lock_page(struct page *__page)
1da177e4 1502{
62906027
NP
1503 struct page *page = compound_head(__page);
1504 wait_queue_head_t *q = page_waitqueue(page);
9a1ea439
HD
1505 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1506 EXCLUSIVE);
1da177e4
LT
1507}
1508EXPORT_SYMBOL(__lock_page);
1509
62906027 1510int __lock_page_killable(struct page *__page)
2687a356 1511{
62906027
NP
1512 struct page *page = compound_head(__page);
1513 wait_queue_head_t *q = page_waitqueue(page);
9a1ea439
HD
1514 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1515 EXCLUSIVE);
2687a356 1516}
18bc0bbd 1517EXPORT_SYMBOL_GPL(__lock_page_killable);
2687a356 1518
dd3e6d50
JA
1519int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1520{
f32b5dd7
MWO
1521 struct wait_queue_head *q = page_waitqueue(page);
1522 int ret = 0;
1523
1524 wait->page = page;
1525 wait->bit_nr = PG_locked;
1526
1527 spin_lock_irq(&q->lock);
1528 __add_wait_queue_entry_tail(q, &wait->wait);
1529 SetPageWaiters(page);
1530 ret = !trylock_page(page);
1531 /*
1532 * If we were successful now, we know we're still on the
1533 * waitqueue as we're still under the lock. This means it's
1534 * safe to remove and return success, we know the callback
1535 * isn't going to trigger.
1536 */
1537 if (!ret)
1538 __remove_wait_queue(q, &wait->wait);
1539 else
1540 ret = -EIOCBQUEUED;
1541 spin_unlock_irq(&q->lock);
1542 return ret;
dd3e6d50
JA
1543}
1544
9a95f3cf
PC
1545/*
1546 * Return values:
c1e8d7c6 1547 * 1 - page is locked; mmap_lock is still held.
9a95f3cf 1548 * 0 - page is not locked.
3e4e28c5 1549 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
9a95f3cf 1550 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
c1e8d7c6 1551 * which case mmap_lock is still held.
9a95f3cf
PC
1552 *
1553 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
c1e8d7c6 1554 * with the page locked and the mmap_lock unperturbed.
9a95f3cf 1555 */
d065bd81
ML
1556int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1557 unsigned int flags)
1558{
4064b982 1559 if (fault_flag_allow_retry_first(flags)) {
37b23e05 1560 /*
c1e8d7c6 1561 * CAUTION! In this case, mmap_lock is not released
37b23e05
KM
1562 * even though return 0.
1563 */
1564 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1565 return 0;
1566
d8ed45c5 1567 mmap_read_unlock(mm);
37b23e05
KM
1568 if (flags & FAULT_FLAG_KILLABLE)
1569 wait_on_page_locked_killable(page);
1570 else
318b275f 1571 wait_on_page_locked(page);
d065bd81 1572 return 0;
800bca7c
HL
1573 }
1574 if (flags & FAULT_FLAG_KILLABLE) {
1575 int ret;
37b23e05 1576
800bca7c
HL
1577 ret = __lock_page_killable(page);
1578 if (ret) {
1579 mmap_read_unlock(mm);
1580 return 0;
1581 }
1582 } else {
1583 __lock_page(page);
d065bd81 1584 }
800bca7c
HL
1585 return 1;
1586
d065bd81
ML
1587}
1588
e7b563bb 1589/**
0d3f9296
MW
1590 * page_cache_next_miss() - Find the next gap in the page cache.
1591 * @mapping: Mapping.
1592 * @index: Index.
1593 * @max_scan: Maximum range to search.
e7b563bb 1594 *
0d3f9296
MW
1595 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1596 * gap with the lowest index.
e7b563bb 1597 *
0d3f9296
MW
1598 * This function may be called under the rcu_read_lock. However, this will
1599 * not atomically search a snapshot of the cache at a single point in time.
1600 * For example, if a gap is created at index 5, then subsequently a gap is
1601 * created at index 10, page_cache_next_miss covering both indices may
1602 * return 10 if called under the rcu_read_lock.
e7b563bb 1603 *
0d3f9296
MW
1604 * Return: The index of the gap if found, otherwise an index outside the
1605 * range specified (in which case 'return - index >= max_scan' will be true).
1606 * In the rare case of index wrap-around, 0 will be returned.
e7b563bb 1607 */
0d3f9296 1608pgoff_t page_cache_next_miss(struct address_space *mapping,
e7b563bb
JW
1609 pgoff_t index, unsigned long max_scan)
1610{
0d3f9296 1611 XA_STATE(xas, &mapping->i_pages, index);
e7b563bb 1612
0d3f9296
MW
1613 while (max_scan--) {
1614 void *entry = xas_next(&xas);
1615 if (!entry || xa_is_value(entry))
e7b563bb 1616 break;
0d3f9296 1617 if (xas.xa_index == 0)
e7b563bb
JW
1618 break;
1619 }
1620
0d3f9296 1621 return xas.xa_index;
e7b563bb 1622}
0d3f9296 1623EXPORT_SYMBOL(page_cache_next_miss);
e7b563bb
JW
1624
1625/**
2346a560 1626 * page_cache_prev_miss() - Find the previous gap in the page cache.
0d3f9296
MW
1627 * @mapping: Mapping.
1628 * @index: Index.
1629 * @max_scan: Maximum range to search.
e7b563bb 1630 *
0d3f9296
MW
1631 * Search the range [max(index - max_scan + 1, 0), index] for the
1632 * gap with the highest index.
e7b563bb 1633 *
0d3f9296
MW
1634 * This function may be called under the rcu_read_lock. However, this will
1635 * not atomically search a snapshot of the cache at a single point in time.
1636 * For example, if a gap is created at index 10, then subsequently a gap is
1637 * created at index 5, page_cache_prev_miss() covering both indices may
1638 * return 5 if called under the rcu_read_lock.
e7b563bb 1639 *
0d3f9296
MW
1640 * Return: The index of the gap if found, otherwise an index outside the
1641 * range specified (in which case 'index - return >= max_scan' will be true).
1642 * In the rare case of wrap-around, ULONG_MAX will be returned.
e7b563bb 1643 */
0d3f9296 1644pgoff_t page_cache_prev_miss(struct address_space *mapping,
e7b563bb
JW
1645 pgoff_t index, unsigned long max_scan)
1646{
0d3f9296 1647 XA_STATE(xas, &mapping->i_pages, index);
e7b563bb 1648
0d3f9296
MW
1649 while (max_scan--) {
1650 void *entry = xas_prev(&xas);
1651 if (!entry || xa_is_value(entry))
e7b563bb 1652 break;
0d3f9296 1653 if (xas.xa_index == ULONG_MAX)
e7b563bb
JW
1654 break;
1655 }
1656
0d3f9296 1657 return xas.xa_index;
e7b563bb 1658}
0d3f9296 1659EXPORT_SYMBOL(page_cache_prev_miss);
e7b563bb 1660
485bb99b 1661/**
0cd6144a 1662 * find_get_entry - find and get a page cache entry
485bb99b 1663 * @mapping: the address_space to search
a6de4b48 1664 * @index: The page cache index.
0cd6144a
JW
1665 *
1666 * Looks up the page cache slot at @mapping & @offset. If there is a
a6de4b48 1667 * page cache page, the head page is returned with an increased refcount.
485bb99b 1668 *
139b6a6f
JW
1669 * If the slot holds a shadow entry of a previously evicted page, or a
1670 * swap entry from shmem/tmpfs, it is returned.
0cd6144a 1671 *
a6de4b48 1672 * Return: The head page or shadow entry, %NULL if nothing is found.
1da177e4 1673 */
a6de4b48 1674struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
1da177e4 1675{
a6de4b48 1676 XA_STATE(xas, &mapping->i_pages, index);
4101196b 1677 struct page *page;
1da177e4 1678
a60637c8
NP
1679 rcu_read_lock();
1680repeat:
4c7472c0
MW
1681 xas_reset(&xas);
1682 page = xas_load(&xas);
1683 if (xas_retry(&xas, page))
1684 goto repeat;
1685 /*
1686 * A shadow entry of a recently evicted page, or a swap entry from
1687 * shmem/tmpfs. Return it without attempting to raise page count.
1688 */
1689 if (!page || xa_is_value(page))
1690 goto out;
83929372 1691
4101196b 1692 if (!page_cache_get_speculative(page))
4c7472c0 1693 goto repeat;
83929372 1694
4c7472c0 1695 /*
4101196b 1696 * Has the page moved or been split?
4c7472c0
MW
1697 * This is part of the lockless pagecache protocol. See
1698 * include/linux/pagemap.h for details.
1699 */
1700 if (unlikely(page != xas_reload(&xas))) {
4101196b 1701 put_page(page);
4c7472c0 1702 goto repeat;
a60637c8 1703 }
27d20fdd 1704out:
a60637c8
NP
1705 rcu_read_unlock();
1706
1da177e4
LT
1707 return page;
1708}
1da177e4 1709
0cd6144a 1710/**
63ec1973
MWO
1711 * find_lock_entry - Locate and lock a page cache entry.
1712 * @mapping: The address_space to search.
1713 * @index: The page cache index.
0cd6144a 1714 *
63ec1973
MWO
1715 * Looks up the page at @mapping & @index. If there is a page in the
1716 * cache, the head page is returned locked and with an increased refcount.
0cd6144a 1717 *
139b6a6f
JW
1718 * If the slot holds a shadow entry of a previously evicted page, or a
1719 * swap entry from shmem/tmpfs, it is returned.
0cd6144a 1720 *
63ec1973
MWO
1721 * Context: May sleep.
1722 * Return: The head page or shadow entry, %NULL if nothing is found.
0cd6144a 1723 */
63ec1973 1724struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
1da177e4
LT
1725{
1726 struct page *page;
1727
1da177e4 1728repeat:
63ec1973 1729 page = find_get_entry(mapping, index);
4c7472c0 1730 if (page && !xa_is_value(page)) {
a60637c8
NP
1731 lock_page(page);
1732 /* Has the page been truncated? */
63ec1973 1733 if (unlikely(page->mapping != mapping)) {
a60637c8 1734 unlock_page(page);
09cbfeaf 1735 put_page(page);
a60637c8 1736 goto repeat;
1da177e4 1737 }
63ec1973 1738 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
1da177e4 1739 }
1da177e4
LT
1740 return page;
1741}
0cd6144a
JW
1742
1743/**
2294b32e
MWO
1744 * pagecache_get_page - Find and get a reference to a page.
1745 * @mapping: The address_space to search.
1746 * @index: The page index.
1747 * @fgp_flags: %FGP flags modify how the page is returned.
1748 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
1da177e4 1749 *
2294b32e 1750 * Looks up the page cache entry at @mapping & @index.
0cd6144a 1751 *
2294b32e 1752 * @fgp_flags can be zero or more of these flags:
0e056eb5 1753 *
2294b32e
MWO
1754 * * %FGP_ACCESSED - The page will be marked accessed.
1755 * * %FGP_LOCK - The page is returned locked.
a8cf7f27
MWO
1756 * * %FGP_HEAD - If the page is present and a THP, return the head page
1757 * rather than the exact page specified by the index.
2294b32e
MWO
1758 * * %FGP_CREAT - If no page is present then a new page is allocated using
1759 * @gfp_mask and added to the page cache and the VM's LRU list.
1760 * The page is returned locked and with an increased refcount.
1761 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1762 * page is already in cache. If the page was allocated, unlock it before
1763 * returning so the caller can do the same dance.
605cad83
YS
1764 * * %FGP_WRITE - The page will be written
1765 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1766 * * %FGP_NOWAIT - Don't get blocked by page lock
1da177e4 1767 *
2294b32e
MWO
1768 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1769 * if the %GFP flags specified for %FGP_CREAT are atomic.
1da177e4 1770 *
2457aec6 1771 * If there is a page cache page, it is returned with an increased refcount.
a862f68a 1772 *
2294b32e 1773 * Return: The found page or %NULL otherwise.
1da177e4 1774 */
2294b32e
MWO
1775struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1776 int fgp_flags, gfp_t gfp_mask)
1da177e4 1777{
eb2be189 1778 struct page *page;
2457aec6 1779
1da177e4 1780repeat:
2294b32e 1781 page = find_get_entry(mapping, index);
3159f943 1782 if (xa_is_value(page))
2457aec6
MG
1783 page = NULL;
1784 if (!page)
1785 goto no_page;
1786
1787 if (fgp_flags & FGP_LOCK) {
1788 if (fgp_flags & FGP_NOWAIT) {
1789 if (!trylock_page(page)) {
09cbfeaf 1790 put_page(page);
2457aec6
MG
1791 return NULL;
1792 }
1793 } else {
1794 lock_page(page);
1795 }
1796
1797 /* Has the page been truncated? */
a8cf7f27 1798 if (unlikely(page->mapping != mapping)) {
2457aec6 1799 unlock_page(page);
09cbfeaf 1800 put_page(page);
2457aec6
MG
1801 goto repeat;
1802 }
a8cf7f27 1803 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
2457aec6
MG
1804 }
1805
c16eb000 1806 if (fgp_flags & FGP_ACCESSED)
2457aec6 1807 mark_page_accessed(page);
b9306a79
YS
1808 else if (fgp_flags & FGP_WRITE) {
1809 /* Clear idle flag for buffer write */
1810 if (page_is_idle(page))
1811 clear_page_idle(page);
1812 }
a8cf7f27
MWO
1813 if (!(fgp_flags & FGP_HEAD))
1814 page = find_subpage(page, index);
2457aec6
MG
1815
1816no_page:
1817 if (!page && (fgp_flags & FGP_CREAT)) {
1818 int err;
f56753ac 1819 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
45f87de5
MH
1820 gfp_mask |= __GFP_WRITE;
1821 if (fgp_flags & FGP_NOFS)
1822 gfp_mask &= ~__GFP_FS;
2457aec6 1823
45f87de5 1824 page = __page_cache_alloc(gfp_mask);
eb2be189
NP
1825 if (!page)
1826 return NULL;
2457aec6 1827
a75d4c33 1828 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
2457aec6
MG
1829 fgp_flags |= FGP_LOCK;
1830
eb39d618 1831 /* Init accessed so avoid atomic mark_page_accessed later */
2457aec6 1832 if (fgp_flags & FGP_ACCESSED)
eb39d618 1833 __SetPageReferenced(page);
2457aec6 1834
2294b32e 1835 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
eb2be189 1836 if (unlikely(err)) {
09cbfeaf 1837 put_page(page);
eb2be189
NP
1838 page = NULL;
1839 if (err == -EEXIST)
1840 goto repeat;
1da177e4 1841 }
a75d4c33
JB
1842
1843 /*
1844 * add_to_page_cache_lru locks the page, and for mmap we expect
1845 * an unlocked page.
1846 */
1847 if (page && (fgp_flags & FGP_FOR_MMAP))
1848 unlock_page(page);
1da177e4 1849 }
2457aec6 1850
1da177e4
LT
1851 return page;
1852}
2457aec6 1853EXPORT_SYMBOL(pagecache_get_page);
1da177e4 1854
0cd6144a
JW
1855/**
1856 * find_get_entries - gang pagecache lookup
1857 * @mapping: The address_space to search
1858 * @start: The starting page cache index
1859 * @nr_entries: The maximum number of entries
1860 * @entries: Where the resulting entries are placed
1861 * @indices: The cache indices corresponding to the entries in @entries
1862 *
1863 * find_get_entries() will search for and return a group of up to
1864 * @nr_entries entries in the mapping. The entries are placed at
1865 * @entries. find_get_entries() takes a reference against any actual
1866 * pages it returns.
1867 *
1868 * The search returns a group of mapping-contiguous page cache entries
1869 * with ascending indexes. There may be holes in the indices due to
1870 * not-present pages.
1871 *
139b6a6f
JW
1872 * Any shadow entries of evicted pages, or swap entries from
1873 * shmem/tmpfs, are included in the returned array.
0cd6144a 1874 *
71725ed1
HD
1875 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1876 * stops at that page: the caller is likely to have a better way to handle
1877 * the compound page as a whole, and then skip its extent, than repeatedly
1878 * calling find_get_entries() to return all its tails.
1879 *
a862f68a 1880 * Return: the number of pages and shadow entries which were found.
0cd6144a
JW
1881 */
1882unsigned find_get_entries(struct address_space *mapping,
1883 pgoff_t start, unsigned int nr_entries,
1884 struct page **entries, pgoff_t *indices)
1885{
f280bf09
MW
1886 XA_STATE(xas, &mapping->i_pages, start);
1887 struct page *page;
0cd6144a 1888 unsigned int ret = 0;
0cd6144a
JW
1889
1890 if (!nr_entries)
1891 return 0;
1892
1893 rcu_read_lock();
f280bf09 1894 xas_for_each(&xas, page, ULONG_MAX) {
f280bf09 1895 if (xas_retry(&xas, page))
0cd6144a 1896 continue;
f280bf09
MW
1897 /*
1898 * A shadow entry of a recently evicted page, a swap
1899 * entry from shmem/tmpfs or a DAX entry. Return it
1900 * without attempting to raise page count.
1901 */
1902 if (xa_is_value(page))
0cd6144a 1903 goto export;
83929372 1904
4101196b 1905 if (!page_cache_get_speculative(page))
f280bf09 1906 goto retry;
83929372 1907
4101196b 1908 /* Has the page moved or been split? */
f280bf09
MW
1909 if (unlikely(page != xas_reload(&xas)))
1910 goto put_page;
1911
71725ed1
HD
1912 /*
1913 * Terminate early on finding a THP, to allow the caller to
1914 * handle it all at once; but continue if this is hugetlbfs.
1915 */
1916 if (PageTransHuge(page) && !PageHuge(page)) {
1917 page = find_subpage(page, xas.xa_index);
1918 nr_entries = ret + 1;
1919 }
0cd6144a 1920export:
f280bf09 1921 indices[ret] = xas.xa_index;
0cd6144a
JW
1922 entries[ret] = page;
1923 if (++ret == nr_entries)
1924 break;
f280bf09
MW
1925 continue;
1926put_page:
4101196b 1927 put_page(page);
f280bf09
MW
1928retry:
1929 xas_reset(&xas);
0cd6144a
JW
1930 }
1931 rcu_read_unlock();
1932 return ret;
1933}
1934
1da177e4 1935/**
b947cee4 1936 * find_get_pages_range - gang pagecache lookup
1da177e4
LT
1937 * @mapping: The address_space to search
1938 * @start: The starting page index
b947cee4 1939 * @end: The final page index (inclusive)
1da177e4
LT
1940 * @nr_pages: The maximum number of pages
1941 * @pages: Where the resulting pages are placed
1942 *
b947cee4
JK
1943 * find_get_pages_range() will search for and return a group of up to @nr_pages
1944 * pages in the mapping starting at index @start and up to index @end
1945 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1946 * a reference against the returned pages.
1da177e4
LT
1947 *
1948 * The search returns a group of mapping-contiguous pages with ascending
1949 * indexes. There may be holes in the indices due to not-present pages.
d72dc8a2 1950 * We also update @start to index the next page for the traversal.
1da177e4 1951 *
a862f68a
MR
1952 * Return: the number of pages which were found. If this number is
1953 * smaller than @nr_pages, the end of specified range has been
b947cee4 1954 * reached.
1da177e4 1955 */
b947cee4
JK
1956unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1957 pgoff_t end, unsigned int nr_pages,
1958 struct page **pages)
1da177e4 1959{
fd1b3cee
MW
1960 XA_STATE(xas, &mapping->i_pages, *start);
1961 struct page *page;
0fc9d104
KK
1962 unsigned ret = 0;
1963
1964 if (unlikely(!nr_pages))
1965 return 0;
a60637c8
NP
1966
1967 rcu_read_lock();
fd1b3cee 1968 xas_for_each(&xas, page, end) {
fd1b3cee 1969 if (xas_retry(&xas, page))
a60637c8 1970 continue;
fd1b3cee
MW
1971 /* Skip over shadow, swap and DAX entries */
1972 if (xa_is_value(page))
8079b1c8 1973 continue;
a60637c8 1974
4101196b 1975 if (!page_cache_get_speculative(page))
fd1b3cee 1976 goto retry;
83929372 1977
4101196b 1978 /* Has the page moved or been split? */
fd1b3cee
MW
1979 if (unlikely(page != xas_reload(&xas)))
1980 goto put_page;
1da177e4 1981
4101196b 1982 pages[ret] = find_subpage(page, xas.xa_index);
b947cee4 1983 if (++ret == nr_pages) {
5d3ee42f 1984 *start = xas.xa_index + 1;
b947cee4
JK
1985 goto out;
1986 }
fd1b3cee
MW
1987 continue;
1988put_page:
4101196b 1989 put_page(page);
fd1b3cee
MW
1990retry:
1991 xas_reset(&xas);
a60637c8 1992 }
5b280c0c 1993
b947cee4
JK
1994 /*
1995 * We come here when there is no page beyond @end. We take care to not
1996 * overflow the index @start as it confuses some of the callers. This
fd1b3cee 1997 * breaks the iteration when there is a page at index -1 but that is
b947cee4
JK
1998 * already broken anyway.
1999 */
2000 if (end == (pgoff_t)-1)
2001 *start = (pgoff_t)-1;
2002 else
2003 *start = end + 1;
2004out:
a60637c8 2005 rcu_read_unlock();
d72dc8a2 2006
1da177e4
LT
2007 return ret;
2008}
2009
ebf43500
JA
2010/**
2011 * find_get_pages_contig - gang contiguous pagecache lookup
2012 * @mapping: The address_space to search
2013 * @index: The starting page index
2014 * @nr_pages: The maximum number of pages
2015 * @pages: Where the resulting pages are placed
2016 *
2017 * find_get_pages_contig() works exactly like find_get_pages(), except
2018 * that the returned number of pages are guaranteed to be contiguous.
2019 *
a862f68a 2020 * Return: the number of pages which were found.
ebf43500
JA
2021 */
2022unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2023 unsigned int nr_pages, struct page **pages)
2024{
3ece58a2
MW
2025 XA_STATE(xas, &mapping->i_pages, index);
2026 struct page *page;
0fc9d104
KK
2027 unsigned int ret = 0;
2028
2029 if (unlikely(!nr_pages))
2030 return 0;
a60637c8
NP
2031
2032 rcu_read_lock();
3ece58a2 2033 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
3ece58a2
MW
2034 if (xas_retry(&xas, page))
2035 continue;
2036 /*
2037 * If the entry has been swapped out, we can stop looking.
2038 * No current caller is looking for DAX entries.
2039 */
2040 if (xa_is_value(page))
8079b1c8 2041 break;
ebf43500 2042
4101196b 2043 if (!page_cache_get_speculative(page))
3ece58a2 2044 goto retry;
83929372 2045
4101196b 2046 /* Has the page moved or been split? */
3ece58a2
MW
2047 if (unlikely(page != xas_reload(&xas)))
2048 goto put_page;
a60637c8 2049
4101196b 2050 pages[ret] = find_subpage(page, xas.xa_index);
0fc9d104
KK
2051 if (++ret == nr_pages)
2052 break;
3ece58a2
MW
2053 continue;
2054put_page:
4101196b 2055 put_page(page);
3ece58a2
MW
2056retry:
2057 xas_reset(&xas);
ebf43500 2058 }
a60637c8
NP
2059 rcu_read_unlock();
2060 return ret;
ebf43500 2061}
ef71c15c 2062EXPORT_SYMBOL(find_get_pages_contig);
ebf43500 2063
485bb99b 2064/**
72b045ae 2065 * find_get_pages_range_tag - find and return pages in given range matching @tag
485bb99b
RD
2066 * @mapping: the address_space to search
2067 * @index: the starting page index
72b045ae 2068 * @end: The final page index (inclusive)
485bb99b
RD
2069 * @tag: the tag index
2070 * @nr_pages: the maximum number of pages
2071 * @pages: where the resulting pages are placed
2072 *
1da177e4 2073 * Like find_get_pages, except we only return pages which are tagged with
485bb99b 2074 * @tag. We update @index to index the next page for the traversal.
a862f68a
MR
2075 *
2076 * Return: the number of pages which were found.
1da177e4 2077 */
72b045ae 2078unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
a6906972 2079 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
72b045ae 2080 struct page **pages)
1da177e4 2081{
a6906972
MW
2082 XA_STATE(xas, &mapping->i_pages, *index);
2083 struct page *page;
0fc9d104
KK
2084 unsigned ret = 0;
2085
2086 if (unlikely(!nr_pages))
2087 return 0;
a60637c8
NP
2088
2089 rcu_read_lock();
a6906972 2090 xas_for_each_marked(&xas, page, end, tag) {
a6906972 2091 if (xas_retry(&xas, page))
a60637c8 2092 continue;
a6906972
MW
2093 /*
2094 * Shadow entries should never be tagged, but this iteration
2095 * is lockless so there is a window for page reclaim to evict
2096 * a page we saw tagged. Skip over it.
2097 */
2098 if (xa_is_value(page))
139b6a6f 2099 continue;
a60637c8 2100
4101196b 2101 if (!page_cache_get_speculative(page))
a6906972 2102 goto retry;
a60637c8 2103
4101196b 2104 /* Has the page moved or been split? */
a6906972
MW
2105 if (unlikely(page != xas_reload(&xas)))
2106 goto put_page;
a60637c8 2107
4101196b 2108 pages[ret] = find_subpage(page, xas.xa_index);
72b045ae 2109 if (++ret == nr_pages) {
5d3ee42f 2110 *index = xas.xa_index + 1;
72b045ae
JK
2111 goto out;
2112 }
a6906972
MW
2113 continue;
2114put_page:
4101196b 2115 put_page(page);
a6906972
MW
2116retry:
2117 xas_reset(&xas);
a60637c8 2118 }
5b280c0c 2119
72b045ae 2120 /*
a6906972 2121 * We come here when we got to @end. We take care to not overflow the
72b045ae 2122 * index @index as it confuses some of the callers. This breaks the
a6906972
MW
2123 * iteration when there is a page at index -1 but that is already
2124 * broken anyway.
72b045ae
JK
2125 */
2126 if (end == (pgoff_t)-1)
2127 *index = (pgoff_t)-1;
2128 else
2129 *index = end + 1;
2130out:
a60637c8 2131 rcu_read_unlock();
1da177e4 2132
1da177e4
LT
2133 return ret;
2134}
72b045ae 2135EXPORT_SYMBOL(find_get_pages_range_tag);
1da177e4 2136
76d42bd9
WF
2137/*
2138 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2139 * a _large_ part of the i/o request. Imagine the worst scenario:
2140 *
2141 * ---R__________________________________________B__________
2142 * ^ reading here ^ bad block(assume 4k)
2143 *
2144 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2145 * => failing the whole request => read(R) => read(R+1) =>
2146 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2147 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2148 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2149 *
2150 * It is going insane. Fix it by quickly scaling down the readahead size.
2151 */
0f8e2db4 2152static void shrink_readahead_size_eio(struct file_ra_state *ra)
76d42bd9 2153{
76d42bd9 2154 ra->ra_pages /= 4;
76d42bd9
WF
2155}
2156
cbd59c48
MWO
2157/*
2158 * filemap_get_read_batch - Get a batch of pages for read
2159 *
2160 * Get a batch of pages which represent a contiguous range of bytes
2161 * in the file. No tail pages will be returned. If @index is in the
2162 * middle of a THP, the entire THP will be returned. The last page in
2163 * the batch may have Readahead set or be not Uptodate so that the
2164 * caller can take the appropriate action.
2165 */
2166static void filemap_get_read_batch(struct address_space *mapping,
2167 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2168{
2169 XA_STATE(xas, &mapping->i_pages, index);
2170 struct page *head;
2171
2172 rcu_read_lock();
2173 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2174 if (xas_retry(&xas, head))
2175 continue;
2176 if (xas.xa_index > max || xa_is_value(head))
2177 break;
2178 if (!page_cache_get_speculative(head))
2179 goto retry;
2180
2181 /* Has the page moved or been split? */
2182 if (unlikely(head != xas_reload(&xas)))
2183 goto put_page;
2184
2185 if (!pagevec_add(pvec, head))
2186 break;
2187 if (!PageUptodate(head))
2188 break;
2189 if (PageReadahead(head))
2190 break;
2191 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2192 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2193 continue;
2194put_page:
2195 put_page(head);
2196retry:
2197 xas_reset(&xas);
2198 }
2199 rcu_read_unlock();
2200}
2201
68430303
MWO
2202static int filemap_read_page(struct file *file, struct address_space *mapping,
2203 struct page *page)
723ef24b 2204{
723ef24b
KO
2205 int error;
2206
723ef24b 2207 /*
68430303
MWO
2208 * A previous I/O error may have been due to temporary failures,
2209 * eg. multipath errors. PG_error will be set again if readpage
2210 * fails.
723ef24b
KO
2211 */
2212 ClearPageError(page);
2213 /* Start the actual read. The read will unlock the page. */
68430303
MWO
2214 error = mapping->a_ops->readpage(file, page);
2215 if (error)
2216 return error;
2217 if (PageUptodate(page))
2218 return 0;
723ef24b 2219
68430303
MWO
2220 error = lock_page_killable(page);
2221 if (error)
2222 return error;
723ef24b 2223 if (!PageUptodate(page)) {
68430303
MWO
2224 if (page->mapping == NULL) {
2225 /* page truncated */
2226 error = AOP_TRUNCATED_PAGE;
2227 } else {
2228 shrink_readahead_size_eio(&file->f_ra);
2229 error = -EIO;
723ef24b 2230 }
723ef24b 2231 }
68430303
MWO
2232 unlock_page(page);
2233 return error;
723ef24b
KO
2234}
2235
3a6bae48
MWO
2236static struct page *filemap_update_page(struct kiocb *iocb, struct file *filp,
2237 struct iov_iter *iter, struct page *page, loff_t pos,
2238 loff_t count)
723ef24b
KO
2239{
2240 struct address_space *mapping = filp->f_mapping;
2241 struct inode *inode = mapping->host;
2242 int error;
2243
723ef24b 2244 if (iocb->ki_flags & IOCB_WAITQ) {
bd8a1f36
MWO
2245 error = lock_page_async(page, iocb->ki_waitq);
2246 if (error) {
2247 put_page(page);
2248 return ERR_PTR(error);
2249 }
723ef24b 2250 } else {
bd8a1f36
MWO
2251 if (!trylock_page(page)) {
2252 put_and_wait_on_page_locked(page, TASK_KILLABLE);
2253 return NULL;
2254 }
723ef24b 2255 }
723ef24b 2256
bd8a1f36
MWO
2257 if (!page->mapping)
2258 goto truncated;
2259 if (PageUptodate(page))
2260 goto uptodate;
723ef24b
KO
2261 if (inode->i_blkbits == PAGE_SHIFT ||
2262 !mapping->a_ops->is_partially_uptodate)
bd8a1f36 2263 goto readpage;
723ef24b
KO
2264 /* pipes can't handle partially uptodate pages */
2265 if (unlikely(iov_iter_is_pipe(iter)))
bd8a1f36 2266 goto readpage;
723ef24b 2267 if (!mapping->a_ops->is_partially_uptodate(page,
bd8a1f36
MWO
2268 pos & (thp_size(page) - 1), count))
2269 goto readpage;
2270uptodate:
723ef24b
KO
2271 unlock_page(page);
2272 return page;
2273
bd8a1f36 2274readpage:
68430303
MWO
2275 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ)) {
2276 unlock_page(page);
2277 put_page(page);
2278 return ERR_PTR(-EAGAIN);
2279 }
2280 error = filemap_read_page(iocb->ki_filp, mapping, page);
2281 if (!error)
2282 return page;
2283 put_page(page);
2284 if (error == AOP_TRUNCATED_PAGE)
2285 return NULL;
2286 return ERR_PTR(error);
bd8a1f36
MWO
2287truncated:
2288 unlock_page(page);
2289 put_page(page);
2290 return NULL;
723ef24b
KO
2291}
2292
f253e185
MWO
2293static int filemap_create_page(struct file *file,
2294 struct address_space *mapping, pgoff_t index,
2295 struct pagevec *pvec)
723ef24b 2296{
723ef24b
KO
2297 struct page *page;
2298 int error;
2299
723ef24b
KO
2300 page = page_cache_alloc(mapping);
2301 if (!page)
f253e185 2302 return -ENOMEM;
723ef24b
KO
2303
2304 error = add_to_page_cache_lru(page, mapping, index,
f253e185
MWO
2305 mapping_gfp_constraint(mapping, GFP_KERNEL));
2306 if (error == -EEXIST)
2307 error = AOP_TRUNCATED_PAGE;
2308 if (error)
2309 goto error;
2310
2311 error = filemap_read_page(file, mapping, page);
2312 if (error)
2313 goto error;
2314
2315 pagevec_add(pvec, page);
2316 return 0;
2317error:
68430303 2318 put_page(page);
f253e185 2319 return error;
723ef24b
KO
2320}
2321
3a6bae48 2322static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
ff993ba1 2323 struct pagevec *pvec)
06c04442
KO
2324{
2325 struct file *filp = iocb->ki_filp;
2326 struct address_space *mapping = filp->f_mapping;
2327 struct file_ra_state *ra = &filp->f_ra;
2328 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
cbd59c48
MWO
2329 pgoff_t last_index;
2330 int err = 0;
06c04442 2331
cbd59c48 2332 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
06c04442
KO
2333find_page:
2334 if (fatal_signal_pending(current))
2335 return -EINTR;
2336
cbd59c48 2337 filemap_get_read_batch(mapping, index, last_index, pvec);
ff993ba1 2338 if (pvec->nr)
06c04442
KO
2339 goto got_pages;
2340
2341 if (iocb->ki_flags & IOCB_NOIO)
2342 return -EAGAIN;
2343
2344 page_cache_sync_readahead(mapping, ra, filp, index, last_index - index);
2345
cbd59c48 2346 filemap_get_read_batch(mapping, index, last_index, pvec);
f253e185
MWO
2347 if (!pagevec_count(pvec)) {
2348 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2349 return -EAGAIN;
2350 err = filemap_create_page(filp, mapping,
2351 iocb->ki_pos >> PAGE_SHIFT, pvec);
2352 if (err == AOP_TRUNCATED_PAGE)
2353 goto find_page;
2354 return err;
2355 }
06c04442 2356got_pages:
cbd59c48
MWO
2357 {
2358 struct page *page = pvec->pages[pvec->nr - 1];
2359 pgoff_t pg_index = page->index;
06c04442
KO
2360 loff_t pg_pos = max(iocb->ki_pos,
2361 (loff_t) pg_index << PAGE_SHIFT);
2362 loff_t pg_count = iocb->ki_pos + iter->count - pg_pos;
2363
2364 if (PageReadahead(page)) {
2365 if (iocb->ki_flags & IOCB_NOIO) {
cbd59c48
MWO
2366 put_page(page);
2367 pvec->nr--;
06c04442 2368 err = -EAGAIN;
cbd59c48 2369 goto err;
06c04442
KO
2370 }
2371 page_cache_async_readahead(mapping, ra, filp, page,
2372 pg_index, last_index - pg_index);
2373 }
2374
2375 if (!PageUptodate(page)) {
2376 if ((iocb->ki_flags & IOCB_NOWAIT) ||
cbd59c48
MWO
2377 ((iocb->ki_flags & IOCB_WAITQ) && pvec->nr > 1)) {
2378 put_page(page);
2379 pvec->nr--;
06c04442 2380 err = -EAGAIN;
cbd59c48 2381 goto err;
06c04442
KO
2382 }
2383
3a6bae48
MWO
2384 page = filemap_update_page(iocb, filp, iter, page,
2385 pg_pos, pg_count);
06c04442 2386 if (IS_ERR_OR_NULL(page)) {
cbd59c48 2387 pvec->nr--;
06c04442 2388 err = PTR_ERR_OR_ZERO(page);
06c04442
KO
2389 }
2390 }
2391 }
2392
cbd59c48 2393err:
ff993ba1
MWO
2394 if (likely(pvec->nr))
2395 return 0;
06c04442
KO
2396 if (err)
2397 return err;
2398 /*
2399 * No pages and no error means we raced and should retry:
2400 */
2401 goto find_page;
2402}
2403
485bb99b 2404/**
47c27bc4
CH
2405 * generic_file_buffered_read - generic file read routine
2406 * @iocb: the iocb to read
6e58e79d
AV
2407 * @iter: data destination
2408 * @written: already copied
485bb99b 2409 *
1da177e4 2410 * This is a generic file read routine, and uses the
485bb99b 2411 * mapping->a_ops->readpage() function for the actual low-level stuff.
1da177e4
LT
2412 *
2413 * This is really ugly. But the goto's actually try to clarify some
2414 * of the logic when it comes to error handling etc.
a862f68a
MR
2415 *
2416 * Return:
2417 * * total number of bytes copied, including those the were already @written
2418 * * negative error code if nothing was copied
1da177e4 2419 */
d85dc2e1 2420ssize_t generic_file_buffered_read(struct kiocb *iocb,
6e58e79d 2421 struct iov_iter *iter, ssize_t written)
1da177e4 2422{
47c27bc4 2423 struct file *filp = iocb->ki_filp;
06c04442 2424 struct file_ra_state *ra = &filp->f_ra;
36e78914 2425 struct address_space *mapping = filp->f_mapping;
1da177e4 2426 struct inode *inode = mapping->host;
ff993ba1
MWO
2427 struct pagevec pvec;
2428 int i, error = 0;
06c04442
KO
2429 bool writably_mapped;
2430 loff_t isize, end_offset;
1da177e4 2431
723ef24b 2432 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
d05c5f7b 2433 return 0;
3644e2d2
KO
2434 if (unlikely(!iov_iter_count(iter)))
2435 return 0;
2436
c2a9737f 2437 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
cbd59c48 2438 pagevec_init(&pvec);
c2a9737f 2439
06c04442 2440 do {
1da177e4 2441 cond_resched();
5abf186a 2442
723ef24b 2443 /*
06c04442
KO
2444 * If we've already successfully copied some data, then we
2445 * can no longer safely return -EIOCBQUEUED. Hence mark
2446 * an async read NOWAIT at that point.
723ef24b 2447 */
06c04442 2448 if ((iocb->ki_flags & IOCB_WAITQ) && written)
723ef24b
KO
2449 iocb->ki_flags |= IOCB_NOWAIT;
2450
ff993ba1
MWO
2451 error = filemap_get_pages(iocb, iter, &pvec);
2452 if (error < 0)
06c04442 2453 break;
1da177e4 2454
06c04442
KO
2455 /*
2456 * i_size must be checked after we know the pages are Uptodate.
2457 *
2458 * Checking i_size after the check allows us to calculate
2459 * the correct value for "nr", which means the zero-filled
2460 * part of the page is not copied back to userspace (unless
2461 * another truncate extends the file - this is desired though).
2462 */
2463 isize = i_size_read(inode);
2464 if (unlikely(iocb->ki_pos >= isize))
2465 goto put_pages;
06c04442
KO
2466 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2467
06c04442
KO
2468 /*
2469 * Once we start copying data, we don't want to be touching any
2470 * cachelines that might be contended:
2471 */
2472 writably_mapped = mapping_writably_mapped(mapping);
2473
2474 /*
2475 * When a sequential read accesses a page several times, only
2476 * mark it as accessed the first time.
2477 */
2478 if (iocb->ki_pos >> PAGE_SHIFT !=
2479 ra->prev_pos >> PAGE_SHIFT)
ff993ba1 2480 mark_page_accessed(pvec.pages[0]);
06c04442 2481
ff993ba1 2482 for (i = 0; i < pagevec_count(&pvec); i++) {
cbd59c48
MWO
2483 struct page *page = pvec.pages[i];
2484 size_t page_size = thp_size(page);
2485 size_t offset = iocb->ki_pos & (page_size - 1);
2486 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2487 page_size - offset);
2488 size_t copied;
06c04442 2489
cbd59c48
MWO
2490 if (end_offset < page_offset(page))
2491 break;
2492 if (i > 0)
2493 mark_page_accessed(page);
06c04442
KO
2494 /*
2495 * If users can be writing to this page using arbitrary
2496 * virtual addresses, take care about potential aliasing
2497 * before reading the page on the kernel side.
2498 */
cbd59c48
MWO
2499 if (writably_mapped) {
2500 int j;
2501
2502 for (j = 0; j < thp_nr_pages(page); j++)
2503 flush_dcache_page(page + j);
2504 }
06c04442 2505
cbd59c48 2506 copied = copy_page_to_iter(page, offset, bytes, iter);
06c04442
KO
2507
2508 written += copied;
2509 iocb->ki_pos += copied;
2510 ra->prev_pos = iocb->ki_pos;
2511
2512 if (copied < bytes) {
2513 error = -EFAULT;
2514 break;
2515 }
1da177e4 2516 }
06c04442 2517put_pages:
ff993ba1
MWO
2518 for (i = 0; i < pagevec_count(&pvec); i++)
2519 put_page(pvec.pages[i]);
cbd59c48 2520 pagevec_reinit(&pvec);
06c04442 2521 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
1da177e4 2522
0c6aa263 2523 file_accessed(filp);
06c04442 2524
6e58e79d 2525 return written ? written : error;
1da177e4 2526}
d85dc2e1 2527EXPORT_SYMBOL_GPL(generic_file_buffered_read);
1da177e4 2528
485bb99b 2529/**
6abd2322 2530 * generic_file_read_iter - generic filesystem read routine
485bb99b 2531 * @iocb: kernel I/O control block
6abd2322 2532 * @iter: destination for the data read
485bb99b 2533 *
6abd2322 2534 * This is the "read_iter()" routine for all filesystems
1da177e4 2535 * that can use the page cache directly.
41da51bc
AG
2536 *
2537 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2538 * be returned when no data can be read without waiting for I/O requests
2539 * to complete; it doesn't prevent readahead.
2540 *
2541 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2542 * requests shall be made for the read or for readahead. When no data
2543 * can be read, -EAGAIN shall be returned. When readahead would be
2544 * triggered, a partial, possibly empty read shall be returned.
2545 *
a862f68a
MR
2546 * Return:
2547 * * number of bytes copied, even for partial reads
41da51bc 2548 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
1da177e4
LT
2549 */
2550ssize_t
ed978a81 2551generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
1da177e4 2552{
e7080a43 2553 size_t count = iov_iter_count(iter);
47c27bc4 2554 ssize_t retval = 0;
e7080a43
NS
2555
2556 if (!count)
2557 goto out; /* skip atime */
1da177e4 2558
2ba48ce5 2559 if (iocb->ki_flags & IOCB_DIRECT) {
47c27bc4 2560 struct file *file = iocb->ki_filp;
ed978a81
AV
2561 struct address_space *mapping = file->f_mapping;
2562 struct inode *inode = mapping->host;
543ade1f 2563 loff_t size;
1da177e4 2564
1da177e4 2565 size = i_size_read(inode);
6be96d3a
GR
2566 if (iocb->ki_flags & IOCB_NOWAIT) {
2567 if (filemap_range_has_page(mapping, iocb->ki_pos,
2568 iocb->ki_pos + count - 1))
2569 return -EAGAIN;
2570 } else {
2571 retval = filemap_write_and_wait_range(mapping,
2572 iocb->ki_pos,
2573 iocb->ki_pos + count - 1);
2574 if (retval < 0)
2575 goto out;
2576 }
d8d3d94b 2577
0d5b0cf2
CH
2578 file_accessed(file);
2579
5ecda137 2580 retval = mapping->a_ops->direct_IO(iocb, iter);
c3a69024 2581 if (retval >= 0) {
c64fb5c7 2582 iocb->ki_pos += retval;
5ecda137 2583 count -= retval;
9fe55eea 2584 }
ab2125df
PB
2585 if (retval != -EIOCBQUEUED)
2586 iov_iter_revert(iter, count - iov_iter_count(iter));
66f998f6 2587
9fe55eea
SW
2588 /*
2589 * Btrfs can have a short DIO read if we encounter
2590 * compressed extents, so if there was an error, or if
2591 * we've already read everything we wanted to, or if
2592 * there was a short read because we hit EOF, go ahead
2593 * and return. Otherwise fallthrough to buffered io for
fbbbad4b
MW
2594 * the rest of the read. Buffered reads will not work for
2595 * DAX files, so don't bother trying.
9fe55eea 2596 */
5ecda137 2597 if (retval < 0 || !count || iocb->ki_pos >= size ||
0d5b0cf2 2598 IS_DAX(inode))
9fe55eea 2599 goto out;
1da177e4
LT
2600 }
2601
47c27bc4 2602 retval = generic_file_buffered_read(iocb, iter, retval);
1da177e4
LT
2603out:
2604 return retval;
2605}
ed978a81 2606EXPORT_SYMBOL(generic_file_read_iter);
1da177e4 2607
1da177e4 2608#ifdef CONFIG_MMU
1da177e4 2609#define MMAP_LOTSAMISS (100)
6b4c9f44 2610/*
c1e8d7c6 2611 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
6b4c9f44
JB
2612 * @vmf - the vm_fault for this fault.
2613 * @page - the page to lock.
2614 * @fpin - the pointer to the file we may pin (or is already pinned).
2615 *
c1e8d7c6 2616 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
6b4c9f44 2617 * It differs in that it actually returns the page locked if it returns 1 and 0
c1e8d7c6 2618 * if it couldn't lock the page. If we did have to drop the mmap_lock then fpin
6b4c9f44
JB
2619 * will point to the pinned file and needs to be fput()'ed at a later point.
2620 */
2621static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2622 struct file **fpin)
2623{
2624 if (trylock_page(page))
2625 return 1;
2626
8b0f9fa2
LT
2627 /*
2628 * NOTE! This will make us return with VM_FAULT_RETRY, but with
c1e8d7c6 2629 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
8b0f9fa2
LT
2630 * is supposed to work. We have way too many special cases..
2631 */
6b4c9f44
JB
2632 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2633 return 0;
2634
2635 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2636 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2637 if (__lock_page_killable(page)) {
2638 /*
c1e8d7c6 2639 * We didn't have the right flags to drop the mmap_lock,
6b4c9f44
JB
2640 * but all fault_handlers only check for fatal signals
2641 * if we return VM_FAULT_RETRY, so we need to drop the
c1e8d7c6 2642 * mmap_lock here and return 0 if we don't have a fpin.
6b4c9f44
JB
2643 */
2644 if (*fpin == NULL)
d8ed45c5 2645 mmap_read_unlock(vmf->vma->vm_mm);
6b4c9f44
JB
2646 return 0;
2647 }
2648 } else
2649 __lock_page(page);
2650 return 1;
2651}
2652
1da177e4 2653
ef00e08e 2654/*
6b4c9f44
JB
2655 * Synchronous readahead happens when we don't even find a page in the page
2656 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2657 * to drop the mmap sem we return the file that was pinned in order for us to do
2658 * that. If we didn't pin a file then we return NULL. The file that is
2659 * returned needs to be fput()'ed when we're done with it.
ef00e08e 2660 */
6b4c9f44 2661static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
ef00e08e 2662{
2a1180f1
JB
2663 struct file *file = vmf->vma->vm_file;
2664 struct file_ra_state *ra = &file->f_ra;
ef00e08e 2665 struct address_space *mapping = file->f_mapping;
db660d46 2666 DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
6b4c9f44 2667 struct file *fpin = NULL;
e630bfac 2668 unsigned int mmap_miss;
ef00e08e
LT
2669
2670 /* If we don't want any read-ahead, don't bother */
2a1180f1 2671 if (vmf->vma->vm_flags & VM_RAND_READ)
6b4c9f44 2672 return fpin;
275b12bf 2673 if (!ra->ra_pages)
6b4c9f44 2674 return fpin;
ef00e08e 2675
2a1180f1 2676 if (vmf->vma->vm_flags & VM_SEQ_READ) {
6b4c9f44 2677 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
db660d46 2678 page_cache_sync_ra(&ractl, ra, ra->ra_pages);
6b4c9f44 2679 return fpin;
ef00e08e
LT
2680 }
2681
207d04ba 2682 /* Avoid banging the cache line if not needed */
e630bfac
KS
2683 mmap_miss = READ_ONCE(ra->mmap_miss);
2684 if (mmap_miss < MMAP_LOTSAMISS * 10)
2685 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
ef00e08e
LT
2686
2687 /*
2688 * Do we miss much more than hit in this file? If so,
2689 * stop bothering with read-ahead. It will only hurt.
2690 */
e630bfac 2691 if (mmap_miss > MMAP_LOTSAMISS)
6b4c9f44 2692 return fpin;
ef00e08e 2693
d30a1100
WF
2694 /*
2695 * mmap read-around
2696 */
6b4c9f44 2697 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
db660d46 2698 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
600e19af
RG
2699 ra->size = ra->ra_pages;
2700 ra->async_size = ra->ra_pages / 4;
db660d46
DH
2701 ractl._index = ra->start;
2702 do_page_cache_ra(&ractl, ra->size, ra->async_size);
6b4c9f44 2703 return fpin;
ef00e08e
LT
2704}
2705
2706/*
2707 * Asynchronous readahead happens when we find the page and PG_readahead,
6b4c9f44 2708 * so we want to possibly extend the readahead further. We return the file that
c1e8d7c6 2709 * was pinned if we have to drop the mmap_lock in order to do IO.
ef00e08e 2710 */
6b4c9f44
JB
2711static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2712 struct page *page)
ef00e08e 2713{
2a1180f1
JB
2714 struct file *file = vmf->vma->vm_file;
2715 struct file_ra_state *ra = &file->f_ra;
ef00e08e 2716 struct address_space *mapping = file->f_mapping;
6b4c9f44 2717 struct file *fpin = NULL;
e630bfac 2718 unsigned int mmap_miss;
2a1180f1 2719 pgoff_t offset = vmf->pgoff;
ef00e08e
LT
2720
2721 /* If we don't want any read-ahead, don't bother */
5c72feee 2722 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
6b4c9f44 2723 return fpin;
e630bfac
KS
2724 mmap_miss = READ_ONCE(ra->mmap_miss);
2725 if (mmap_miss)
2726 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
6b4c9f44
JB
2727 if (PageReadahead(page)) {
2728 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2fad6f5d
WF
2729 page_cache_async_readahead(mapping, ra, file,
2730 page, offset, ra->ra_pages);
6b4c9f44
JB
2731 }
2732 return fpin;
ef00e08e
LT
2733}
2734
485bb99b 2735/**
54cb8821 2736 * filemap_fault - read in file data for page fault handling
d0217ac0 2737 * @vmf: struct vm_fault containing details of the fault
485bb99b 2738 *
54cb8821 2739 * filemap_fault() is invoked via the vma operations vector for a
1da177e4
LT
2740 * mapped memory region to read in file data during a page fault.
2741 *
2742 * The goto's are kind of ugly, but this streamlines the normal case of having
2743 * it in the page cache, and handles the special cases reasonably without
2744 * having a lot of duplicated code.
9a95f3cf 2745 *
c1e8d7c6 2746 * vma->vm_mm->mmap_lock must be held on entry.
9a95f3cf 2747 *
c1e8d7c6 2748 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
a4985833 2749 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
9a95f3cf 2750 *
c1e8d7c6 2751 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
9a95f3cf
PC
2752 * has not been released.
2753 *
2754 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
a862f68a
MR
2755 *
2756 * Return: bitwise-OR of %VM_FAULT_ codes.
1da177e4 2757 */
2bcd6454 2758vm_fault_t filemap_fault(struct vm_fault *vmf)
1da177e4
LT
2759{
2760 int error;
11bac800 2761 struct file *file = vmf->vma->vm_file;
6b4c9f44 2762 struct file *fpin = NULL;
1da177e4
LT
2763 struct address_space *mapping = file->f_mapping;
2764 struct file_ra_state *ra = &file->f_ra;
2765 struct inode *inode = mapping->host;
ef00e08e 2766 pgoff_t offset = vmf->pgoff;
9ab2594f 2767 pgoff_t max_off;
1da177e4 2768 struct page *page;
2bcd6454 2769 vm_fault_t ret = 0;
1da177e4 2770
9ab2594f
MW
2771 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2772 if (unlikely(offset >= max_off))
5307cc1a 2773 return VM_FAULT_SIGBUS;
1da177e4 2774
1da177e4 2775 /*
49426420 2776 * Do we have something in the page cache already?
1da177e4 2777 */
ef00e08e 2778 page = find_get_page(mapping, offset);
45cac65b 2779 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
1da177e4 2780 /*
ef00e08e
LT
2781 * We found the page, so try async readahead before
2782 * waiting for the lock.
1da177e4 2783 */
6b4c9f44 2784 fpin = do_async_mmap_readahead(vmf, page);
45cac65b 2785 } else if (!page) {
ef00e08e 2786 /* No page in the page cache at all */
ef00e08e 2787 count_vm_event(PGMAJFAULT);
2262185c 2788 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
ef00e08e 2789 ret = VM_FAULT_MAJOR;
6b4c9f44 2790 fpin = do_sync_mmap_readahead(vmf);
ef00e08e 2791retry_find:
a75d4c33
JB
2792 page = pagecache_get_page(mapping, offset,
2793 FGP_CREAT|FGP_FOR_MMAP,
2794 vmf->gfp_mask);
6b4c9f44
JB
2795 if (!page) {
2796 if (fpin)
2797 goto out_retry;
e520e932 2798 return VM_FAULT_OOM;
6b4c9f44 2799 }
1da177e4
LT
2800 }
2801
6b4c9f44
JB
2802 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2803 goto out_retry;
b522c94d
ML
2804
2805 /* Did it get truncated? */
585e5a7b 2806 if (unlikely(compound_head(page)->mapping != mapping)) {
b522c94d
ML
2807 unlock_page(page);
2808 put_page(page);
2809 goto retry_find;
2810 }
520e5ba4 2811 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
b522c94d 2812
1da177e4 2813 /*
d00806b1
NP
2814 * We have a locked page in the page cache, now we need to check
2815 * that it's up-to-date. If not, it is going to be due to an error.
1da177e4 2816 */
d00806b1 2817 if (unlikely(!PageUptodate(page)))
1da177e4
LT
2818 goto page_not_uptodate;
2819
6b4c9f44 2820 /*
c1e8d7c6 2821 * We've made it this far and we had to drop our mmap_lock, now is the
6b4c9f44
JB
2822 * time to return to the upper layer and have it re-find the vma and
2823 * redo the fault.
2824 */
2825 if (fpin) {
2826 unlock_page(page);
2827 goto out_retry;
2828 }
2829
ef00e08e
LT
2830 /*
2831 * Found the page and have a reference on it.
2832 * We must recheck i_size under page lock.
2833 */
9ab2594f
MW
2834 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2835 if (unlikely(offset >= max_off)) {
d00806b1 2836 unlock_page(page);
09cbfeaf 2837 put_page(page);
5307cc1a 2838 return VM_FAULT_SIGBUS;
d00806b1
NP
2839 }
2840
d0217ac0 2841 vmf->page = page;
83c54070 2842 return ret | VM_FAULT_LOCKED;
1da177e4 2843
1da177e4 2844page_not_uptodate:
1da177e4
LT
2845 /*
2846 * Umm, take care of errors if the page isn't up-to-date.
2847 * Try to re-read it _once_. We do this synchronously,
2848 * because there really aren't any performance issues here
2849 * and we need to check for errors.
2850 */
1da177e4 2851 ClearPageError(page);
6b4c9f44 2852 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
994fc28c 2853 error = mapping->a_ops->readpage(file, page);
3ef0f720
MS
2854 if (!error) {
2855 wait_on_page_locked(page);
2856 if (!PageUptodate(page))
2857 error = -EIO;
2858 }
6b4c9f44
JB
2859 if (fpin)
2860 goto out_retry;
09cbfeaf 2861 put_page(page);
d00806b1
NP
2862
2863 if (!error || error == AOP_TRUNCATED_PAGE)
994fc28c 2864 goto retry_find;
1da177e4 2865
0f8e2db4 2866 shrink_readahead_size_eio(ra);
d0217ac0 2867 return VM_FAULT_SIGBUS;
6b4c9f44
JB
2868
2869out_retry:
2870 /*
c1e8d7c6 2871 * We dropped the mmap_lock, we need to return to the fault handler to
6b4c9f44
JB
2872 * re-find the vma and come back and find our hopefully still populated
2873 * page.
2874 */
2875 if (page)
2876 put_page(page);
2877 if (fpin)
2878 fput(fpin);
2879 return ret | VM_FAULT_RETRY;
54cb8821
NP
2880}
2881EXPORT_SYMBOL(filemap_fault);
2882
f9ce0be7 2883static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
f1820361 2884{
f9ce0be7
KS
2885 struct mm_struct *mm = vmf->vma->vm_mm;
2886
2887 /* Huge page is mapped? No need to proceed. */
2888 if (pmd_trans_huge(*vmf->pmd)) {
2889 unlock_page(page);
2890 put_page(page);
2891 return true;
2892 }
2893
2894 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
2895 vm_fault_t ret = do_set_pmd(vmf, page);
2896 if (!ret) {
2897 /* The page is mapped successfully, reference consumed. */
2898 unlock_page(page);
2899 return true;
2900 }
2901 }
2902
2903 if (pmd_none(*vmf->pmd)) {
2904 vmf->ptl = pmd_lock(mm, vmf->pmd);
2905 if (likely(pmd_none(*vmf->pmd))) {
2906 mm_inc_nr_ptes(mm);
2907 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
2908 vmf->prealloc_pte = NULL;
2909 }
2910 spin_unlock(vmf->ptl);
2911 }
2912
2913 /* See comment in handle_pte_fault() */
2914 if (pmd_devmap_trans_unstable(vmf->pmd)) {
2915 unlock_page(page);
2916 put_page(page);
2917 return true;
2918 }
2919
2920 return false;
2921}
2922
2923static struct page *next_uptodate_page(struct page *page,
2924 struct address_space *mapping,
2925 struct xa_state *xas, pgoff_t end_pgoff)
2926{
2927 unsigned long max_idx;
2928
2929 do {
2930 if (!page)
2931 return NULL;
2932 if (xas_retry(xas, page))
2933 continue;
2934 if (xa_is_value(page))
2935 continue;
2936 if (PageLocked(page))
2937 continue;
2938 if (!page_cache_get_speculative(page))
2939 continue;
2940 /* Has the page moved or been split? */
2941 if (unlikely(page != xas_reload(xas)))
2942 goto skip;
2943 if (!PageUptodate(page) || PageReadahead(page))
2944 goto skip;
2945 if (PageHWPoison(page))
2946 goto skip;
2947 if (!trylock_page(page))
2948 goto skip;
2949 if (page->mapping != mapping)
2950 goto unlock;
2951 if (!PageUptodate(page))
2952 goto unlock;
2953 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2954 if (xas->xa_index >= max_idx)
2955 goto unlock;
2956 return page;
2957unlock:
2958 unlock_page(page);
2959skip:
2960 put_page(page);
2961 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
2962
2963 return NULL;
2964}
2965
2966static inline struct page *first_map_page(struct address_space *mapping,
2967 struct xa_state *xas,
2968 pgoff_t end_pgoff)
2969{
2970 return next_uptodate_page(xas_find(xas, end_pgoff),
2971 mapping, xas, end_pgoff);
2972}
2973
2974static inline struct page *next_map_page(struct address_space *mapping,
2975 struct xa_state *xas,
2976 pgoff_t end_pgoff)
2977{
2978 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
2979 mapping, xas, end_pgoff);
2980}
2981
2982vm_fault_t filemap_map_pages(struct vm_fault *vmf,
2983 pgoff_t start_pgoff, pgoff_t end_pgoff)
2984{
2985 struct vm_area_struct *vma = vmf->vma;
2986 struct file *file = vma->vm_file;
f1820361 2987 struct address_space *mapping = file->f_mapping;
bae473a4 2988 pgoff_t last_pgoff = start_pgoff;
9d3af4b4 2989 unsigned long addr;
070e807c 2990 XA_STATE(xas, &mapping->i_pages, start_pgoff);
27a83a60 2991 struct page *head, *page;
e630bfac 2992 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
f9ce0be7 2993 vm_fault_t ret = 0;
f1820361
KS
2994
2995 rcu_read_lock();
f9ce0be7
KS
2996 head = first_map_page(mapping, &xas, end_pgoff);
2997 if (!head)
2998 goto out;
f1820361 2999
f9ce0be7
KS
3000 if (filemap_map_pmd(vmf, head)) {
3001 ret = VM_FAULT_NOPAGE;
3002 goto out;
3003 }
f1820361 3004
9d3af4b4
WD
3005 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3006 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
f9ce0be7 3007 do {
27a83a60 3008 page = find_subpage(head, xas.xa_index);
f9ce0be7 3009 if (PageHWPoison(page))
f1820361
KS
3010 goto unlock;
3011
e630bfac
KS
3012 if (mmap_miss > 0)
3013 mmap_miss--;
7267ec00 3014
9d3af4b4 3015 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
f9ce0be7 3016 vmf->pte += xas.xa_index - last_pgoff;
070e807c 3017 last_pgoff = xas.xa_index;
f9ce0be7
KS
3018
3019 if (!pte_none(*vmf->pte))
7267ec00 3020 goto unlock;
f9ce0be7 3021
46bdb427 3022 /* We're about to handle the fault */
9d3af4b4 3023 if (vmf->address == addr)
46bdb427 3024 ret = VM_FAULT_NOPAGE;
46bdb427 3025
9d3af4b4 3026 do_set_pte(vmf, page, addr);
f9ce0be7 3027 /* no need to invalidate: a not-present page won't be cached */
9d3af4b4 3028 update_mmu_cache(vma, addr, vmf->pte);
27a83a60 3029 unlock_page(head);
f9ce0be7 3030 continue;
f1820361 3031unlock:
27a83a60 3032 unlock_page(head);
27a83a60 3033 put_page(head);
f9ce0be7
KS
3034 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3035 pte_unmap_unlock(vmf->pte, vmf->ptl);
3036out:
f1820361 3037 rcu_read_unlock();
e630bfac 3038 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
f9ce0be7 3039 return ret;
f1820361
KS
3040}
3041EXPORT_SYMBOL(filemap_map_pages);
3042
2bcd6454 3043vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
4fcf1c62 3044{
5df1a672 3045 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
4fcf1c62 3046 struct page *page = vmf->page;
2bcd6454 3047 vm_fault_t ret = VM_FAULT_LOCKED;
4fcf1c62 3048
5df1a672 3049 sb_start_pagefault(mapping->host->i_sb);
11bac800 3050 file_update_time(vmf->vma->vm_file);
4fcf1c62 3051 lock_page(page);
5df1a672 3052 if (page->mapping != mapping) {
4fcf1c62
JK
3053 unlock_page(page);
3054 ret = VM_FAULT_NOPAGE;
3055 goto out;
3056 }
14da9200
JK
3057 /*
3058 * We mark the page dirty already here so that when freeze is in
3059 * progress, we are guaranteed that writeback during freezing will
3060 * see the dirty page and writeprotect it again.
3061 */
3062 set_page_dirty(page);
1d1d1a76 3063 wait_for_stable_page(page);
4fcf1c62 3064out:
5df1a672 3065 sb_end_pagefault(mapping->host->i_sb);
4fcf1c62
JK
3066 return ret;
3067}
4fcf1c62 3068
f0f37e2f 3069const struct vm_operations_struct generic_file_vm_ops = {
54cb8821 3070 .fault = filemap_fault,
f1820361 3071 .map_pages = filemap_map_pages,
4fcf1c62 3072 .page_mkwrite = filemap_page_mkwrite,
1da177e4
LT
3073};
3074
3075/* This is used for a general mmap of a disk file */
3076
3077int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3078{
3079 struct address_space *mapping = file->f_mapping;
3080
3081 if (!mapping->a_ops->readpage)
3082 return -ENOEXEC;
3083 file_accessed(file);
3084 vma->vm_ops = &generic_file_vm_ops;
3085 return 0;
3086}
1da177e4
LT
3087
3088/*
3089 * This is for filesystems which do not implement ->writepage.
3090 */
3091int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3092{
3093 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3094 return -EINVAL;
3095 return generic_file_mmap(file, vma);
3096}
3097#else
4b96a37d 3098vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
45397228 3099{
4b96a37d 3100 return VM_FAULT_SIGBUS;
45397228 3101}
1da177e4
LT
3102int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3103{
3104 return -ENOSYS;
3105}
3106int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
3107{
3108 return -ENOSYS;
3109}
3110#endif /* CONFIG_MMU */
3111
45397228 3112EXPORT_SYMBOL(filemap_page_mkwrite);
1da177e4
LT
3113EXPORT_SYMBOL(generic_file_mmap);
3114EXPORT_SYMBOL(generic_file_readonly_mmap);
3115
67f9fd91
SL
3116static struct page *wait_on_page_read(struct page *page)
3117{
3118 if (!IS_ERR(page)) {
3119 wait_on_page_locked(page);
3120 if (!PageUptodate(page)) {
09cbfeaf 3121 put_page(page);
67f9fd91
SL
3122 page = ERR_PTR(-EIO);
3123 }
3124 }
3125 return page;
3126}
3127
32b63529 3128static struct page *do_read_cache_page(struct address_space *mapping,
57f6b96c 3129 pgoff_t index,
5e5358e7 3130 int (*filler)(void *, struct page *),
0531b2aa
LT
3131 void *data,
3132 gfp_t gfp)
1da177e4 3133{
eb2be189 3134 struct page *page;
1da177e4
LT
3135 int err;
3136repeat:
3137 page = find_get_page(mapping, index);
3138 if (!page) {
453f85d4 3139 page = __page_cache_alloc(gfp);
eb2be189
NP
3140 if (!page)
3141 return ERR_PTR(-ENOMEM);
e6f67b8c 3142 err = add_to_page_cache_lru(page, mapping, index, gfp);
eb2be189 3143 if (unlikely(err)) {
09cbfeaf 3144 put_page(page);
eb2be189
NP
3145 if (err == -EEXIST)
3146 goto repeat;
22ecdb4f 3147 /* Presumably ENOMEM for xarray node */
1da177e4
LT
3148 return ERR_PTR(err);
3149 }
32b63529
MG
3150
3151filler:
6c45b454
CH
3152 if (filler)
3153 err = filler(data, page);
3154 else
3155 err = mapping->a_ops->readpage(data, page);
3156
1da177e4 3157 if (err < 0) {
09cbfeaf 3158 put_page(page);
32b63529 3159 return ERR_PTR(err);
1da177e4 3160 }
1da177e4 3161
32b63529
MG
3162 page = wait_on_page_read(page);
3163 if (IS_ERR(page))
3164 return page;
3165 goto out;
3166 }
1da177e4
LT
3167 if (PageUptodate(page))
3168 goto out;
3169
ebded027 3170 /*
0e9aa675 3171 * Page is not up to date and may be locked due to one of the following
ebded027
MG
3172 * case a: Page is being filled and the page lock is held
3173 * case b: Read/write error clearing the page uptodate status
3174 * case c: Truncation in progress (page locked)
3175 * case d: Reclaim in progress
3176 *
3177 * Case a, the page will be up to date when the page is unlocked.
3178 * There is no need to serialise on the page lock here as the page
3179 * is pinned so the lock gives no additional protection. Even if the
ce89fddf 3180 * page is truncated, the data is still valid if PageUptodate as
ebded027
MG
3181 * it's a race vs truncate race.
3182 * Case b, the page will not be up to date
3183 * Case c, the page may be truncated but in itself, the data may still
3184 * be valid after IO completes as it's a read vs truncate race. The
3185 * operation must restart if the page is not uptodate on unlock but
3186 * otherwise serialising on page lock to stabilise the mapping gives
3187 * no additional guarantees to the caller as the page lock is
3188 * released before return.
3189 * Case d, similar to truncation. If reclaim holds the page lock, it
3190 * will be a race with remove_mapping that determines if the mapping
3191 * is valid on unlock but otherwise the data is valid and there is
3192 * no need to serialise with page lock.
3193 *
3194 * As the page lock gives no additional guarantee, we optimistically
3195 * wait on the page to be unlocked and check if it's up to date and
3196 * use the page if it is. Otherwise, the page lock is required to
3197 * distinguish between the different cases. The motivation is that we
3198 * avoid spurious serialisations and wakeups when multiple processes
3199 * wait on the same page for IO to complete.
3200 */
3201 wait_on_page_locked(page);
3202 if (PageUptodate(page))
3203 goto out;
3204
3205 /* Distinguish between all the cases under the safety of the lock */
1da177e4 3206 lock_page(page);
ebded027
MG
3207
3208 /* Case c or d, restart the operation */
1da177e4
LT
3209 if (!page->mapping) {
3210 unlock_page(page);
09cbfeaf 3211 put_page(page);
32b63529 3212 goto repeat;
1da177e4 3213 }
ebded027
MG
3214
3215 /* Someone else locked and filled the page in a very small window */
1da177e4
LT
3216 if (PageUptodate(page)) {
3217 unlock_page(page);
3218 goto out;
3219 }
faffdfa0
XT
3220
3221 /*
3222 * A previous I/O error may have been due to temporary
3223 * failures.
3224 * Clear page error before actual read, PG_error will be
3225 * set again if read page fails.
3226 */
3227 ClearPageError(page);
32b63529
MG
3228 goto filler;
3229
c855ff37 3230out:
6fe6900e
NP
3231 mark_page_accessed(page);
3232 return page;
3233}
0531b2aa
LT
3234
3235/**
67f9fd91 3236 * read_cache_page - read into page cache, fill it if needed
0531b2aa
LT
3237 * @mapping: the page's address_space
3238 * @index: the page index
3239 * @filler: function to perform the read
5e5358e7 3240 * @data: first arg to filler(data, page) function, often left as NULL
0531b2aa 3241 *
0531b2aa 3242 * Read into the page cache. If a page already exists, and PageUptodate() is
67f9fd91 3243 * not set, try to fill the page and wait for it to become unlocked.
0531b2aa
LT
3244 *
3245 * If the page does not get brought uptodate, return -EIO.
a862f68a
MR
3246 *
3247 * Return: up to date page on success, ERR_PTR() on failure.
0531b2aa 3248 */
67f9fd91 3249struct page *read_cache_page(struct address_space *mapping,
0531b2aa 3250 pgoff_t index,
5e5358e7 3251 int (*filler)(void *, struct page *),
0531b2aa
LT
3252 void *data)
3253{
d322a8e5
CH
3254 return do_read_cache_page(mapping, index, filler, data,
3255 mapping_gfp_mask(mapping));
0531b2aa 3256}
67f9fd91 3257EXPORT_SYMBOL(read_cache_page);
0531b2aa
LT
3258
3259/**
3260 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3261 * @mapping: the page's address_space
3262 * @index: the page index
3263 * @gfp: the page allocator flags to use if allocating
3264 *
3265 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
e6f67b8c 3266 * any new page allocations done using the specified allocation flags.
0531b2aa
LT
3267 *
3268 * If the page does not get brought uptodate, return -EIO.
a862f68a
MR
3269 *
3270 * Return: up to date page on success, ERR_PTR() on failure.
0531b2aa
LT
3271 */
3272struct page *read_cache_page_gfp(struct address_space *mapping,
3273 pgoff_t index,
3274 gfp_t gfp)
3275{
6c45b454 3276 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
0531b2aa
LT
3277}
3278EXPORT_SYMBOL(read_cache_page_gfp);
3279
afddba49
NP
3280int pagecache_write_begin(struct file *file, struct address_space *mapping,
3281 loff_t pos, unsigned len, unsigned flags,
3282 struct page **pagep, void **fsdata)
3283{
3284 const struct address_space_operations *aops = mapping->a_ops;
3285
4e02ed4b 3286 return aops->write_begin(file, mapping, pos, len, flags,
afddba49 3287 pagep, fsdata);
afddba49
NP
3288}
3289EXPORT_SYMBOL(pagecache_write_begin);
3290
3291int pagecache_write_end(struct file *file, struct address_space *mapping,
3292 loff_t pos, unsigned len, unsigned copied,
3293 struct page *page, void *fsdata)
3294{
3295 const struct address_space_operations *aops = mapping->a_ops;
afddba49 3296
4e02ed4b 3297 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
afddba49
NP
3298}
3299EXPORT_SYMBOL(pagecache_write_end);
3300
a92853b6
KK
3301/*
3302 * Warn about a page cache invalidation failure during a direct I/O write.
3303 */
3304void dio_warn_stale_pagecache(struct file *filp)
3305{
3306 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3307 char pathname[128];
a92853b6
KK
3308 char *path;
3309
5df1a672 3310 errseq_set(&filp->f_mapping->wb_err, -EIO);
a92853b6
KK
3311 if (__ratelimit(&_rs)) {
3312 path = file_path(filp, pathname, sizeof(pathname));
3313 if (IS_ERR(path))
3314 path = "(unknown)";
3315 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3316 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3317 current->comm);
3318 }
3319}
3320
1da177e4 3321ssize_t
1af5bb49 3322generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
1da177e4
LT
3323{
3324 struct file *file = iocb->ki_filp;
3325 struct address_space *mapping = file->f_mapping;
3326 struct inode *inode = mapping->host;
1af5bb49 3327 loff_t pos = iocb->ki_pos;
1da177e4 3328 ssize_t written;
a969e903
CH
3329 size_t write_len;
3330 pgoff_t end;
1da177e4 3331
0c949334 3332 write_len = iov_iter_count(from);
09cbfeaf 3333 end = (pos + write_len - 1) >> PAGE_SHIFT;
a969e903 3334
6be96d3a
GR
3335 if (iocb->ki_flags & IOCB_NOWAIT) {
3336 /* If there are pages to writeback, return */
5df1a672 3337 if (filemap_range_has_page(file->f_mapping, pos,
35f12f0f 3338 pos + write_len - 1))
6be96d3a
GR
3339 return -EAGAIN;
3340 } else {
3341 written = filemap_write_and_wait_range(mapping, pos,
3342 pos + write_len - 1);
3343 if (written)
3344 goto out;
3345 }
a969e903
CH
3346
3347 /*
3348 * After a write we want buffered reads to be sure to go to disk to get
3349 * the new data. We invalidate clean cached page from the region we're
3350 * about to write. We do this *before* the write so that we can return
6ccfa806 3351 * without clobbering -EIOCBQUEUED from ->direct_IO().
a969e903 3352 */
55635ba7 3353 written = invalidate_inode_pages2_range(mapping,
09cbfeaf 3354 pos >> PAGE_SHIFT, end);
55635ba7
AR
3355 /*
3356 * If a page can not be invalidated, return 0 to fall back
3357 * to buffered write.
3358 */
3359 if (written) {
3360 if (written == -EBUSY)
3361 return 0;
3362 goto out;
a969e903
CH
3363 }
3364
639a93a5 3365 written = mapping->a_ops->direct_IO(iocb, from);
a969e903
CH
3366
3367 /*
3368 * Finally, try again to invalidate clean pages which might have been
3369 * cached by non-direct readahead, or faulted in by get_user_pages()
3370 * if the source of the write was an mmap'ed region of the file
3371 * we're writing. Either one is a pretty crazy thing to do,
3372 * so we don't support it 100%. If this invalidation
3373 * fails, tough, the write still worked...
332391a9
LC
3374 *
3375 * Most of the time we do not need this since dio_complete() will do
3376 * the invalidation for us. However there are some file systems that
3377 * do not end up with dio_complete() being called, so let's not break
80c1fe90
KK
3378 * them by removing it completely.
3379 *
9266a140
KK
3380 * Noticeable example is a blkdev_direct_IO().
3381 *
80c1fe90 3382 * Skip invalidation for async writes or if mapping has no pages.
a969e903 3383 */
9266a140
KK
3384 if (written > 0 && mapping->nrpages &&
3385 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3386 dio_warn_stale_pagecache(file);
a969e903 3387
1da177e4 3388 if (written > 0) {
0116651c 3389 pos += written;
639a93a5 3390 write_len -= written;
0116651c
NK
3391 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3392 i_size_write(inode, pos);
1da177e4
LT
3393 mark_inode_dirty(inode);
3394 }
5cb6c6c7 3395 iocb->ki_pos = pos;
1da177e4 3396 }
ab2125df
PB
3397 if (written != -EIOCBQUEUED)
3398 iov_iter_revert(from, write_len - iov_iter_count(from));
a969e903 3399out:
1da177e4
LT
3400 return written;
3401}
3402EXPORT_SYMBOL(generic_file_direct_write);
3403
eb2be189
NP
3404/*
3405 * Find or create a page at the given pagecache position. Return the locked
3406 * page. This function is specifically for buffered writes.
3407 */
54566b2c
NP
3408struct page *grab_cache_page_write_begin(struct address_space *mapping,
3409 pgoff_t index, unsigned flags)
eb2be189 3410{
eb2be189 3411 struct page *page;
bbddabe2 3412 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
0faa70cb 3413
54566b2c 3414 if (flags & AOP_FLAG_NOFS)
2457aec6
MG
3415 fgp_flags |= FGP_NOFS;
3416
3417 page = pagecache_get_page(mapping, index, fgp_flags,
45f87de5 3418 mapping_gfp_mask(mapping));
c585a267 3419 if (page)
2457aec6 3420 wait_for_stable_page(page);
eb2be189 3421
eb2be189
NP
3422 return page;
3423}
54566b2c 3424EXPORT_SYMBOL(grab_cache_page_write_begin);
eb2be189 3425
3b93f911 3426ssize_t generic_perform_write(struct file *file,
afddba49
NP
3427 struct iov_iter *i, loff_t pos)
3428{
3429 struct address_space *mapping = file->f_mapping;
3430 const struct address_space_operations *a_ops = mapping->a_ops;
3431 long status = 0;
3432 ssize_t written = 0;
674b892e
NP
3433 unsigned int flags = 0;
3434
afddba49
NP
3435 do {
3436 struct page *page;
afddba49
NP
3437 unsigned long offset; /* Offset into pagecache page */
3438 unsigned long bytes; /* Bytes to write to page */
3439 size_t copied; /* Bytes copied from user */
3440 void *fsdata;
3441
09cbfeaf
KS
3442 offset = (pos & (PAGE_SIZE - 1));
3443 bytes = min_t(unsigned long, PAGE_SIZE - offset,
afddba49
NP
3444 iov_iter_count(i));
3445
3446again:
00a3d660
LT
3447 /*
3448 * Bring in the user page that we will copy from _first_.
3449 * Otherwise there's a nasty deadlock on copying from the
3450 * same page as we're writing to, without it being marked
3451 * up-to-date.
3452 *
3453 * Not only is this an optimisation, but it is also required
3454 * to check that the address is actually valid, when atomic
3455 * usercopies are used, below.
3456 */
3457 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3458 status = -EFAULT;
3459 break;
3460 }
3461
296291cd
JK
3462 if (fatal_signal_pending(current)) {
3463 status = -EINTR;
3464 break;
3465 }
3466
674b892e 3467 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
afddba49 3468 &page, &fsdata);
2457aec6 3469 if (unlikely(status < 0))
afddba49
NP
3470 break;
3471
931e80e4 3472 if (mapping_writably_mapped(mapping))
3473 flush_dcache_page(page);
00a3d660 3474
afddba49 3475 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
afddba49
NP
3476 flush_dcache_page(page);
3477
3478 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3479 page, fsdata);
3480 if (unlikely(status < 0))
3481 break;
3482 copied = status;
3483
3484 cond_resched();
3485
124d3b70 3486 iov_iter_advance(i, copied);
afddba49
NP
3487 if (unlikely(copied == 0)) {
3488 /*
3489 * If we were unable to copy any data at all, we must
3490 * fall back to a single segment length write.
3491 *
3492 * If we didn't fallback here, we could livelock
3493 * because not all segments in the iov can be copied at
3494 * once without a pagefault.
3495 */
09cbfeaf 3496 bytes = min_t(unsigned long, PAGE_SIZE - offset,
afddba49
NP
3497 iov_iter_single_seg_count(i));
3498 goto again;
3499 }
afddba49
NP
3500 pos += copied;
3501 written += copied;
3502
3503 balance_dirty_pages_ratelimited(mapping);
afddba49
NP
3504 } while (iov_iter_count(i));
3505
3506 return written ? written : status;
3507}
3b93f911 3508EXPORT_SYMBOL(generic_perform_write);
1da177e4 3509
e4dd9de3 3510/**
8174202b 3511 * __generic_file_write_iter - write data to a file
e4dd9de3 3512 * @iocb: IO state structure (file, offset, etc.)
8174202b 3513 * @from: iov_iter with data to write
e4dd9de3
JK
3514 *
3515 * This function does all the work needed for actually writing data to a
3516 * file. It does all basic checks, removes SUID from the file, updates
3517 * modification times and calls proper subroutines depending on whether we
3518 * do direct IO or a standard buffered write.
3519 *
3520 * It expects i_mutex to be grabbed unless we work on a block device or similar
3521 * object which does not need locking at all.
3522 *
3523 * This function does *not* take care of syncing data in case of O_SYNC write.
3524 * A caller has to handle it. This is mainly due to the fact that we want to
3525 * avoid syncing under i_mutex.
a862f68a
MR
3526 *
3527 * Return:
3528 * * number of bytes written, even for truncated writes
3529 * * negative error code if no data has been written at all
e4dd9de3 3530 */
8174202b 3531ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
1da177e4
LT
3532{
3533 struct file *file = iocb->ki_filp;
fb5527e6 3534 struct address_space * mapping = file->f_mapping;
1da177e4 3535 struct inode *inode = mapping->host;
3b93f911 3536 ssize_t written = 0;
1da177e4 3537 ssize_t err;
3b93f911 3538 ssize_t status;
1da177e4 3539
1da177e4 3540 /* We can write back this queue in page reclaim */
de1414a6 3541 current->backing_dev_info = inode_to_bdi(inode);
5fa8e0a1 3542 err = file_remove_privs(file);
1da177e4
LT
3543 if (err)
3544 goto out;
3545
c3b2da31
JB
3546 err = file_update_time(file);
3547 if (err)
3548 goto out;
1da177e4 3549
2ba48ce5 3550 if (iocb->ki_flags & IOCB_DIRECT) {
0b8def9d 3551 loff_t pos, endbyte;
fb5527e6 3552
1af5bb49 3553 written = generic_file_direct_write(iocb, from);
1da177e4 3554 /*
fbbbad4b
MW
3555 * If the write stopped short of completing, fall back to
3556 * buffered writes. Some filesystems do this for writes to
3557 * holes, for example. For DAX files, a buffered write will
3558 * not succeed (even if it did, DAX does not handle dirty
3559 * page-cache pages correctly).
1da177e4 3560 */
0b8def9d 3561 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
fbbbad4b
MW
3562 goto out;
3563
0b8def9d 3564 status = generic_perform_write(file, from, pos = iocb->ki_pos);
fb5527e6 3565 /*
3b93f911 3566 * If generic_perform_write() returned a synchronous error
fb5527e6
JM
3567 * then we want to return the number of bytes which were
3568 * direct-written, or the error code if that was zero. Note
3569 * that this differs from normal direct-io semantics, which
3570 * will return -EFOO even if some bytes were written.
3571 */
60bb4529 3572 if (unlikely(status < 0)) {
3b93f911 3573 err = status;
fb5527e6
JM
3574 goto out;
3575 }
fb5527e6
JM
3576 /*
3577 * We need to ensure that the page cache pages are written to
3578 * disk and invalidated to preserve the expected O_DIRECT
3579 * semantics.
3580 */
3b93f911 3581 endbyte = pos + status - 1;
0b8def9d 3582 err = filemap_write_and_wait_range(mapping, pos, endbyte);
fb5527e6 3583 if (err == 0) {
0b8def9d 3584 iocb->ki_pos = endbyte + 1;
3b93f911 3585 written += status;
fb5527e6 3586 invalidate_mapping_pages(mapping,
09cbfeaf
KS
3587 pos >> PAGE_SHIFT,
3588 endbyte >> PAGE_SHIFT);
fb5527e6
JM
3589 } else {
3590 /*
3591 * We don't know how much we wrote, so just return
3592 * the number of bytes which were direct-written
3593 */
3594 }
3595 } else {
0b8def9d
AV
3596 written = generic_perform_write(file, from, iocb->ki_pos);
3597 if (likely(written > 0))
3598 iocb->ki_pos += written;
fb5527e6 3599 }
1da177e4
LT
3600out:
3601 current->backing_dev_info = NULL;
3602 return written ? written : err;
3603}
8174202b 3604EXPORT_SYMBOL(__generic_file_write_iter);
e4dd9de3 3605
e4dd9de3 3606/**
8174202b 3607 * generic_file_write_iter - write data to a file
e4dd9de3 3608 * @iocb: IO state structure
8174202b 3609 * @from: iov_iter with data to write
e4dd9de3 3610 *
8174202b 3611 * This is a wrapper around __generic_file_write_iter() to be used by most
e4dd9de3
JK
3612 * filesystems. It takes care of syncing the file in case of O_SYNC file
3613 * and acquires i_mutex as needed.
a862f68a
MR
3614 * Return:
3615 * * negative error code if no data has been written at all of
3616 * vfs_fsync_range() failed for a synchronous write
3617 * * number of bytes written, even for truncated writes
e4dd9de3 3618 */
8174202b 3619ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
1da177e4
LT
3620{
3621 struct file *file = iocb->ki_filp;
148f948b 3622 struct inode *inode = file->f_mapping->host;
1da177e4 3623 ssize_t ret;
1da177e4 3624
5955102c 3625 inode_lock(inode);
3309dd04
AV
3626 ret = generic_write_checks(iocb, from);
3627 if (ret > 0)
5f380c7f 3628 ret = __generic_file_write_iter(iocb, from);
5955102c 3629 inode_unlock(inode);
1da177e4 3630
e2592217
CH
3631 if (ret > 0)
3632 ret = generic_write_sync(iocb, ret);
1da177e4
LT
3633 return ret;
3634}
8174202b 3635EXPORT_SYMBOL(generic_file_write_iter);
1da177e4 3636
cf9a2ae8
DH
3637/**
3638 * try_to_release_page() - release old fs-specific metadata on a page
3639 *
3640 * @page: the page which the kernel is trying to free
3641 * @gfp_mask: memory allocation flags (and I/O mode)
3642 *
3643 * The address_space is to try to release any data against the page
a862f68a 3644 * (presumably at page->private).
cf9a2ae8 3645 *
266cf658
DH
3646 * This may also be called if PG_fscache is set on a page, indicating that the
3647 * page is known to the local caching routines.
3648 *
cf9a2ae8 3649 * The @gfp_mask argument specifies whether I/O may be performed to release
71baba4b 3650 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
cf9a2ae8 3651 *
a862f68a 3652 * Return: %1 if the release was successful, otherwise return zero.
cf9a2ae8
DH
3653 */
3654int try_to_release_page(struct page *page, gfp_t gfp_mask)
3655{
3656 struct address_space * const mapping = page->mapping;
3657
3658 BUG_ON(!PageLocked(page));
3659 if (PageWriteback(page))
3660 return 0;
3661
3662 if (mapping && mapping->a_ops->releasepage)
3663 return mapping->a_ops->releasepage(page, gfp_mask);
3664 return try_to_free_buffers(page);
3665}
3666
3667EXPORT_SYMBOL(try_to_release_page);