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