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