1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright (C) 1994-1999 Linus Torvalds
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)
13 #include <linux/export.h>
14 #include <linux/compiler.h>
15 #include <linux/dax.h>
17 #include <linux/sched/signal.h>
18 #include <linux/uaccess.h>
19 #include <linux/capability.h>
20 #include <linux/kernel_stat.h>
21 #include <linux/gfp.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>
28 #include <linux/error-injection.h>
29 #include <linux/hash.h>
30 #include <linux/writeback.h>
31 #include <linux/backing-dev.h>
32 #include <linux/pagevec.h>
33 #include <linux/security.h>
34 #include <linux/cpuset.h>
35 #include <linux/hugetlb.h>
36 #include <linux/memcontrol.h>
37 #include <linux/cleancache.h>
38 #include <linux/shmem_fs.h>
39 #include <linux/rmap.h>
40 #include <linux/delayacct.h>
41 #include <linux/psi.h>
42 #include <linux/ramfs.h>
43 #include <linux/page_idle.h>
44 #include <asm/pgalloc.h>
45 #include <asm/tlbflush.h>
48 #define CREATE_TRACE_POINTS
49 #include <trace/events/filemap.h>
52 * FIXME: remove all knowledge of the buffer layer from the core VM
54 #include <linux/buffer_head.h> /* for try_to_free_buffers */
59 * Shared mappings implemented 30.11.1994. It's not fully working yet,
62 * Shared mappings now work. 15.8.1995 Bruno.
64 * finished 'unifying' the page and buffer cache and SMP-threaded the
73 * ->i_mmap_rwsem (truncate_pagecache)
74 * ->private_lock (__free_pte->__set_page_dirty_buffers)
75 * ->swap_lock (exclusive_swap_page, others)
79 * ->invalidate_lock (acquired by fs in truncate path)
80 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
84 * ->page_table_lock or pte_lock (various, mainly in memory.c)
85 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
88 * ->invalidate_lock (filemap_fault)
89 * ->lock_page (filemap_fault, access_process_vm)
91 * ->i_rwsem (generic_perform_write)
92 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
95 * sb_lock (fs/fs-writeback.c)
96 * ->i_pages lock (__sync_single_inode)
99 * ->anon_vma.lock (vma_adjust)
102 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
104 * ->page_table_lock or pte_lock
105 * ->swap_lock (try_to_unmap_one)
106 * ->private_lock (try_to_unmap_one)
107 * ->i_pages lock (try_to_unmap_one)
108 * ->lruvec->lru_lock (follow_page->mark_page_accessed)
109 * ->lruvec->lru_lock (check_pte_range->isolate_lru_page)
110 * ->private_lock (page_remove_rmap->set_page_dirty)
111 * ->i_pages lock (page_remove_rmap->set_page_dirty)
112 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
113 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
114 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
115 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
116 * ->inode->i_lock (zap_pte_range->set_page_dirty)
117 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
120 * ->tasklist_lock (memory_failure, collect_procs_ao)
123 static void page_cache_delete(struct address_space *mapping,
124 struct page *page, void *shadow)
126 XA_STATE(xas, &mapping->i_pages, page->index);
129 mapping_set_update(&xas, mapping);
131 /* hugetlb pages are represented by a single entry in the xarray */
132 if (!PageHuge(page)) {
133 xas_set_order(&xas, page->index, compound_order(page));
134 nr = compound_nr(page);
137 VM_BUG_ON_PAGE(!PageLocked(page), page);
138 VM_BUG_ON_PAGE(PageTail(page), page);
139 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
141 xas_store(&xas, shadow);
142 xas_init_marks(&xas);
144 page->mapping = NULL;
145 /* Leave page->index set: truncation lookup relies upon it */
146 mapping->nrpages -= nr;
149 static void unaccount_page_cache_page(struct address_space *mapping,
155 * if we're uptodate, flush out into the cleancache, otherwise
156 * invalidate any existing cleancache entries. We can't leave
157 * stale data around in the cleancache once our page is gone
159 if (PageUptodate(page) && PageMappedToDisk(page))
160 cleancache_put_page(page);
162 cleancache_invalidate_page(mapping, page);
164 VM_BUG_ON_PAGE(PageTail(page), page);
165 VM_BUG_ON_PAGE(page_mapped(page), page);
166 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
169 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
170 current->comm, page_to_pfn(page));
171 dump_page(page, "still mapped when deleted");
173 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
175 mapcount = page_mapcount(page);
176 if (mapping_exiting(mapping) &&
177 page_count(page) >= mapcount + 2) {
179 * All vmas have already been torn down, so it's
180 * a good bet that actually the page is unmapped,
181 * and we'd prefer not to leak it: if we're wrong,
182 * some other bad page check should catch it later.
184 page_mapcount_reset(page);
185 page_ref_sub(page, mapcount);
189 /* hugetlb pages do not participate in page cache accounting. */
193 nr = thp_nr_pages(page);
195 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
196 if (PageSwapBacked(page)) {
197 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
198 if (PageTransHuge(page))
199 __mod_lruvec_page_state(page, NR_SHMEM_THPS, -nr);
200 } else if (PageTransHuge(page)) {
201 __mod_lruvec_page_state(page, NR_FILE_THPS, -nr);
202 filemap_nr_thps_dec(mapping);
206 * At this point page must be either written or cleaned by
207 * truncate. Dirty page here signals a bug and loss of
210 * This fixes dirty accounting after removing the page entirely
211 * but leaves PageDirty set: it has no effect for truncated
212 * page and anyway will be cleared before returning page into
215 if (WARN_ON_ONCE(PageDirty(page)))
216 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
220 * Delete a page from the page cache and free it. Caller has to make
221 * sure the page is locked and that nobody else uses it - or that usage
222 * is safe. The caller must hold the i_pages lock.
224 void __delete_from_page_cache(struct page *page, void *shadow)
226 struct address_space *mapping = page->mapping;
228 trace_mm_filemap_delete_from_page_cache(page);
230 unaccount_page_cache_page(mapping, page);
231 page_cache_delete(mapping, page, shadow);
234 static void page_cache_free_page(struct address_space *mapping,
237 void (*freepage)(struct page *);
239 freepage = mapping->a_ops->freepage;
243 if (PageTransHuge(page) && !PageHuge(page)) {
244 page_ref_sub(page, thp_nr_pages(page));
245 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
252 * delete_from_page_cache - delete page from page cache
253 * @page: the page which the kernel is trying to remove from page cache
255 * This must be called only on pages that have been verified to be in the page
256 * cache and locked. It will never put the page into the free list, the caller
257 * has a reference on the page.
259 void delete_from_page_cache(struct page *page)
261 struct address_space *mapping = page_mapping(page);
263 BUG_ON(!PageLocked(page));
264 xa_lock_irq(&mapping->i_pages);
265 __delete_from_page_cache(page, NULL);
266 xa_unlock_irq(&mapping->i_pages);
268 page_cache_free_page(mapping, page);
270 EXPORT_SYMBOL(delete_from_page_cache);
273 * page_cache_delete_batch - delete several pages from page cache
274 * @mapping: the mapping to which pages belong
275 * @pvec: pagevec with pages to delete
277 * The function walks over mapping->i_pages and removes pages passed in @pvec
278 * from the mapping. The function expects @pvec to be sorted by page index
279 * and is optimised for it to be dense.
280 * It tolerates holes in @pvec (mapping entries at those indices are not
281 * modified). The function expects only THP head pages to be present in the
284 * The function expects the i_pages lock to be held.
286 static void page_cache_delete_batch(struct address_space *mapping,
287 struct pagevec *pvec)
289 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
294 mapping_set_update(&xas, mapping);
295 xas_for_each(&xas, page, ULONG_MAX) {
296 if (i >= pagevec_count(pvec))
299 /* A swap/dax/shadow entry got inserted? Skip it. */
300 if (xa_is_value(page))
303 * A page got inserted in our range? Skip it. We have our
304 * pages locked so they are protected from being removed.
305 * If we see a page whose index is higher than ours, it
306 * means our page has been removed, which shouldn't be
307 * possible because we're holding the PageLock.
309 if (page != pvec->pages[i]) {
310 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
315 WARN_ON_ONCE(!PageLocked(page));
317 if (page->index == xas.xa_index)
318 page->mapping = NULL;
319 /* Leave page->index set: truncation lookup relies on it */
322 * Move to the next page in the vector if this is a regular
323 * page or the index is of the last sub-page of this compound
326 if (page->index + compound_nr(page) - 1 == xas.xa_index)
328 xas_store(&xas, NULL);
331 mapping->nrpages -= total_pages;
334 void delete_from_page_cache_batch(struct address_space *mapping,
335 struct pagevec *pvec)
339 if (!pagevec_count(pvec))
342 xa_lock_irq(&mapping->i_pages);
343 for (i = 0; i < pagevec_count(pvec); i++) {
344 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
346 unaccount_page_cache_page(mapping, pvec->pages[i]);
348 page_cache_delete_batch(mapping, pvec);
349 xa_unlock_irq(&mapping->i_pages);
351 for (i = 0; i < pagevec_count(pvec); i++)
352 page_cache_free_page(mapping, pvec->pages[i]);
355 int filemap_check_errors(struct address_space *mapping)
358 /* Check for outstanding write errors */
359 if (test_bit(AS_ENOSPC, &mapping->flags) &&
360 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
362 if (test_bit(AS_EIO, &mapping->flags) &&
363 test_and_clear_bit(AS_EIO, &mapping->flags))
367 EXPORT_SYMBOL(filemap_check_errors);
369 static int filemap_check_and_keep_errors(struct address_space *mapping)
371 /* Check for outstanding write errors */
372 if (test_bit(AS_EIO, &mapping->flags))
374 if (test_bit(AS_ENOSPC, &mapping->flags))
380 * filemap_fdatawrite_wbc - start writeback on mapping dirty pages in range
381 * @mapping: address space structure to write
382 * @wbc: the writeback_control controlling the writeout
384 * Call writepages on the mapping using the provided wbc to control the
387 * Return: %0 on success, negative error code otherwise.
389 int filemap_fdatawrite_wbc(struct address_space *mapping,
390 struct writeback_control *wbc)
394 if (!mapping_can_writeback(mapping) ||
395 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
398 wbc_attach_fdatawrite_inode(wbc, mapping->host);
399 ret = do_writepages(mapping, wbc);
400 wbc_detach_inode(wbc);
403 EXPORT_SYMBOL(filemap_fdatawrite_wbc);
406 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
407 * @mapping: address space structure to write
408 * @start: offset in bytes where the range starts
409 * @end: offset in bytes where the range ends (inclusive)
410 * @sync_mode: enable synchronous operation
412 * Start writeback against all of a mapping's dirty pages that lie
413 * within the byte offsets <start, end> inclusive.
415 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
416 * opposed to a regular memory cleansing writeback. The difference between
417 * these two operations is that if a dirty page/buffer is encountered, it must
418 * be waited upon, and not just skipped over.
420 * Return: %0 on success, negative error code otherwise.
422 int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
423 loff_t end, int sync_mode)
425 struct writeback_control wbc = {
426 .sync_mode = sync_mode,
427 .nr_to_write = LONG_MAX,
428 .range_start = start,
432 return filemap_fdatawrite_wbc(mapping, &wbc);
435 static inline int __filemap_fdatawrite(struct address_space *mapping,
438 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
441 int filemap_fdatawrite(struct address_space *mapping)
443 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
445 EXPORT_SYMBOL(filemap_fdatawrite);
447 int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
450 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
452 EXPORT_SYMBOL(filemap_fdatawrite_range);
455 * filemap_flush - mostly a non-blocking flush
456 * @mapping: target address_space
458 * This is a mostly non-blocking flush. Not suitable for data-integrity
459 * purposes - I/O may not be started against all dirty pages.
461 * Return: %0 on success, negative error code otherwise.
463 int filemap_flush(struct address_space *mapping)
465 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
467 EXPORT_SYMBOL(filemap_flush);
470 * filemap_range_has_page - check if a page exists in range.
471 * @mapping: address space within which to check
472 * @start_byte: offset in bytes where the range starts
473 * @end_byte: offset in bytes where the range ends (inclusive)
475 * Find at least one page in the range supplied, usually used to check if
476 * direct writing in this range will trigger a writeback.
478 * Return: %true if at least one page exists in the specified range,
481 bool filemap_range_has_page(struct address_space *mapping,
482 loff_t start_byte, loff_t end_byte)
485 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
486 pgoff_t max = end_byte >> PAGE_SHIFT;
488 if (end_byte < start_byte)
493 page = xas_find(&xas, max);
494 if (xas_retry(&xas, page))
496 /* Shadow entries don't count */
497 if (xa_is_value(page))
500 * We don't need to try to pin this page; we're about to
501 * release the RCU lock anyway. It is enough to know that
502 * there was a page here recently.
510 EXPORT_SYMBOL(filemap_range_has_page);
512 static void __filemap_fdatawait_range(struct address_space *mapping,
513 loff_t start_byte, loff_t end_byte)
515 pgoff_t index = start_byte >> PAGE_SHIFT;
516 pgoff_t end = end_byte >> PAGE_SHIFT;
520 if (end_byte < start_byte)
524 while (index <= end) {
527 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
528 end, PAGECACHE_TAG_WRITEBACK);
532 for (i = 0; i < nr_pages; i++) {
533 struct page *page = pvec.pages[i];
535 wait_on_page_writeback(page);
536 ClearPageError(page);
538 pagevec_release(&pvec);
544 * filemap_fdatawait_range - wait for writeback to complete
545 * @mapping: address space structure to wait for
546 * @start_byte: offset in bytes where the range starts
547 * @end_byte: offset in bytes where the range ends (inclusive)
549 * Walk the list of under-writeback pages of the given address space
550 * in the given range and wait for all of them. Check error status of
551 * the address space and return it.
553 * Since the error status of the address space is cleared by this function,
554 * callers are responsible for checking the return value and handling and/or
555 * reporting the error.
557 * Return: error status of the address space.
559 int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
562 __filemap_fdatawait_range(mapping, start_byte, end_byte);
563 return filemap_check_errors(mapping);
565 EXPORT_SYMBOL(filemap_fdatawait_range);
568 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
569 * @mapping: address space structure to wait for
570 * @start_byte: offset in bytes where the range starts
571 * @end_byte: offset in bytes where the range ends (inclusive)
573 * Walk the list of under-writeback pages of the given address space in the
574 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
575 * this function does not clear error status of the address space.
577 * Use this function if callers don't handle errors themselves. Expected
578 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
581 int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
582 loff_t start_byte, loff_t end_byte)
584 __filemap_fdatawait_range(mapping, start_byte, end_byte);
585 return filemap_check_and_keep_errors(mapping);
587 EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
590 * file_fdatawait_range - wait for writeback to complete
591 * @file: file pointing to address space structure to wait for
592 * @start_byte: offset in bytes where the range starts
593 * @end_byte: offset in bytes where the range ends (inclusive)
595 * Walk the list of under-writeback pages of the address space that file
596 * refers to, in the given range and wait for all of them. Check error
597 * status of the address space vs. the file->f_wb_err cursor and return it.
599 * Since the error status of the file is advanced by this function,
600 * callers are responsible for checking the return value and handling and/or
601 * reporting the error.
603 * Return: error status of the address space vs. the file->f_wb_err cursor.
605 int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
607 struct address_space *mapping = file->f_mapping;
609 __filemap_fdatawait_range(mapping, start_byte, end_byte);
610 return file_check_and_advance_wb_err(file);
612 EXPORT_SYMBOL(file_fdatawait_range);
615 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
616 * @mapping: address space structure to wait for
618 * Walk the list of under-writeback pages of the given address space
619 * and wait for all of them. Unlike filemap_fdatawait(), this function
620 * does not clear error status of the address space.
622 * Use this function if callers don't handle errors themselves. Expected
623 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
626 * Return: error status of the address space.
628 int filemap_fdatawait_keep_errors(struct address_space *mapping)
630 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
631 return filemap_check_and_keep_errors(mapping);
633 EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
635 /* Returns true if writeback might be needed or already in progress. */
636 static bool mapping_needs_writeback(struct address_space *mapping)
638 return mapping->nrpages;
642 * filemap_range_needs_writeback - check if range potentially needs writeback
643 * @mapping: address space within which to check
644 * @start_byte: offset in bytes where the range starts
645 * @end_byte: offset in bytes where the range ends (inclusive)
647 * Find at least one page in the range supplied, usually used to check if
648 * direct writing in this range will trigger a writeback. Used by O_DIRECT
649 * read/write with IOCB_NOWAIT, to see if the caller needs to do
650 * filemap_write_and_wait_range() before proceeding.
652 * Return: %true if the caller should do filemap_write_and_wait_range() before
653 * doing O_DIRECT to a page in this range, %false otherwise.
655 bool filemap_range_needs_writeback(struct address_space *mapping,
656 loff_t start_byte, loff_t end_byte)
658 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
659 pgoff_t max = end_byte >> PAGE_SHIFT;
662 if (!mapping_needs_writeback(mapping))
664 if (!mapping_tagged(mapping, PAGECACHE_TAG_DIRTY) &&
665 !mapping_tagged(mapping, PAGECACHE_TAG_WRITEBACK))
667 if (end_byte < start_byte)
671 xas_for_each(&xas, page, max) {
672 if (xas_retry(&xas, page))
674 if (xa_is_value(page))
676 if (PageDirty(page) || PageLocked(page) || PageWriteback(page))
682 EXPORT_SYMBOL_GPL(filemap_range_needs_writeback);
685 * filemap_write_and_wait_range - write out & wait on a file range
686 * @mapping: the address_space for the pages
687 * @lstart: offset in bytes where the range starts
688 * @lend: offset in bytes where the range ends (inclusive)
690 * Write out and wait upon file offsets lstart->lend, inclusive.
692 * Note that @lend is inclusive (describes the last byte to be written) so
693 * that this function can be used to write to the very end-of-file (end = -1).
695 * Return: error status of the address space.
697 int filemap_write_and_wait_range(struct address_space *mapping,
698 loff_t lstart, loff_t lend)
702 if (mapping_needs_writeback(mapping)) {
703 err = __filemap_fdatawrite_range(mapping, lstart, lend,
706 * Even if the above returned error, the pages may be
707 * written partially (e.g. -ENOSPC), so we wait for it.
708 * But the -EIO is special case, it may indicate the worst
709 * thing (e.g. bug) happened, so we avoid waiting for it.
712 int err2 = filemap_fdatawait_range(mapping,
717 /* Clear any previously stored errors */
718 filemap_check_errors(mapping);
721 err = filemap_check_errors(mapping);
725 EXPORT_SYMBOL(filemap_write_and_wait_range);
727 void __filemap_set_wb_err(struct address_space *mapping, int err)
729 errseq_t eseq = errseq_set(&mapping->wb_err, err);
731 trace_filemap_set_wb_err(mapping, eseq);
733 EXPORT_SYMBOL(__filemap_set_wb_err);
736 * file_check_and_advance_wb_err - report wb error (if any) that was previously
737 * and advance wb_err to current one
738 * @file: struct file on which the error is being reported
740 * When userland calls fsync (or something like nfsd does the equivalent), we
741 * want to report any writeback errors that occurred since the last fsync (or
742 * since the file was opened if there haven't been any).
744 * Grab the wb_err from the mapping. If it matches what we have in the file,
745 * then just quickly return 0. The file is all caught up.
747 * If it doesn't match, then take the mapping value, set the "seen" flag in
748 * it and try to swap it into place. If it works, or another task beat us
749 * to it with the new value, then update the f_wb_err and return the error
750 * portion. The error at this point must be reported via proper channels
751 * (a'la fsync, or NFS COMMIT operation, etc.).
753 * While we handle mapping->wb_err with atomic operations, the f_wb_err
754 * value is protected by the f_lock since we must ensure that it reflects
755 * the latest value swapped in for this file descriptor.
757 * Return: %0 on success, negative error code otherwise.
759 int file_check_and_advance_wb_err(struct file *file)
762 errseq_t old = READ_ONCE(file->f_wb_err);
763 struct address_space *mapping = file->f_mapping;
765 /* Locklessly handle the common case where nothing has changed */
766 if (errseq_check(&mapping->wb_err, old)) {
767 /* Something changed, must use slow path */
768 spin_lock(&file->f_lock);
769 old = file->f_wb_err;
770 err = errseq_check_and_advance(&mapping->wb_err,
772 trace_file_check_and_advance_wb_err(file, old);
773 spin_unlock(&file->f_lock);
777 * We're mostly using this function as a drop in replacement for
778 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
779 * that the legacy code would have had on these flags.
781 clear_bit(AS_EIO, &mapping->flags);
782 clear_bit(AS_ENOSPC, &mapping->flags);
785 EXPORT_SYMBOL(file_check_and_advance_wb_err);
788 * file_write_and_wait_range - write out & wait on a file range
789 * @file: file pointing to address_space with pages
790 * @lstart: offset in bytes where the range starts
791 * @lend: offset in bytes where the range ends (inclusive)
793 * Write out and wait upon file offsets lstart->lend, inclusive.
795 * Note that @lend is inclusive (describes the last byte to be written) so
796 * that this function can be used to write to the very end-of-file (end = -1).
798 * After writing out and waiting on the data, we check and advance the
799 * f_wb_err cursor to the latest value, and return any errors detected there.
801 * Return: %0 on success, negative error code otherwise.
803 int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
806 struct address_space *mapping = file->f_mapping;
808 if (mapping_needs_writeback(mapping)) {
809 err = __filemap_fdatawrite_range(mapping, lstart, lend,
811 /* See comment of filemap_write_and_wait() */
813 __filemap_fdatawait_range(mapping, lstart, lend);
815 err2 = file_check_and_advance_wb_err(file);
820 EXPORT_SYMBOL(file_write_and_wait_range);
823 * replace_page_cache_page - replace a pagecache page with a new one
824 * @old: page to be replaced
825 * @new: page to replace with
827 * This function replaces a page in the pagecache with a new one. On
828 * success it acquires the pagecache reference for the new page and
829 * drops it for the old page. Both the old and new pages must be
830 * locked. This function does not add the new page to the LRU, the
831 * caller must do that.
833 * The remove + add is atomic. This function cannot fail.
835 void replace_page_cache_page(struct page *old, struct page *new)
837 struct address_space *mapping = old->mapping;
838 void (*freepage)(struct page *) = mapping->a_ops->freepage;
839 pgoff_t offset = old->index;
840 XA_STATE(xas, &mapping->i_pages, offset);
842 VM_BUG_ON_PAGE(!PageLocked(old), old);
843 VM_BUG_ON_PAGE(!PageLocked(new), new);
844 VM_BUG_ON_PAGE(new->mapping, new);
847 new->mapping = mapping;
850 mem_cgroup_migrate(old, new);
853 xas_store(&xas, new);
856 /* hugetlb pages do not participate in page cache accounting. */
858 __dec_lruvec_page_state(old, NR_FILE_PAGES);
860 __inc_lruvec_page_state(new, NR_FILE_PAGES);
861 if (PageSwapBacked(old))
862 __dec_lruvec_page_state(old, NR_SHMEM);
863 if (PageSwapBacked(new))
864 __inc_lruvec_page_state(new, NR_SHMEM);
865 xas_unlock_irq(&xas);
870 EXPORT_SYMBOL_GPL(replace_page_cache_page);
872 noinline int __add_to_page_cache_locked(struct page *page,
873 struct address_space *mapping,
874 pgoff_t offset, gfp_t gfp,
877 XA_STATE(xas, &mapping->i_pages, offset);
878 int huge = PageHuge(page);
880 bool charged = false;
882 VM_BUG_ON_PAGE(!PageLocked(page), page);
883 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
884 mapping_set_update(&xas, mapping);
887 page->mapping = mapping;
888 page->index = offset;
891 error = mem_cgroup_charge(page, NULL, gfp);
897 gfp &= GFP_RECLAIM_MASK;
900 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
901 void *entry, *old = NULL;
903 if (order > thp_order(page))
904 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
907 xas_for_each_conflict(&xas, entry) {
909 if (!xa_is_value(entry)) {
910 xas_set_err(&xas, -EEXIST);
918 /* entry may have been split before we acquired lock */
919 order = xa_get_order(xas.xa, xas.xa_index);
920 if (order > thp_order(page)) {
921 xas_split(&xas, old, order);
926 xas_store(&xas, page);
932 /* hugetlb pages do not participate in page cache accounting */
934 __inc_lruvec_page_state(page, NR_FILE_PAGES);
936 xas_unlock_irq(&xas);
937 } while (xas_nomem(&xas, gfp));
939 if (xas_error(&xas)) {
940 error = xas_error(&xas);
942 mem_cgroup_uncharge(page);
946 trace_mm_filemap_add_to_page_cache(page);
949 page->mapping = NULL;
950 /* Leave page->index set: truncation relies upon it */
954 ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
957 * add_to_page_cache_locked - add a locked page to the pagecache
959 * @mapping: the page's address_space
960 * @offset: page index
961 * @gfp_mask: page allocation mode
963 * This function is used to add a page to the pagecache. It must be locked.
964 * This function does not add the page to the LRU. The caller must do that.
966 * Return: %0 on success, negative error code otherwise.
968 int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
969 pgoff_t offset, gfp_t gfp_mask)
971 return __add_to_page_cache_locked(page, mapping, offset,
974 EXPORT_SYMBOL(add_to_page_cache_locked);
976 int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
977 pgoff_t offset, gfp_t gfp_mask)
982 __SetPageLocked(page);
983 ret = __add_to_page_cache_locked(page, mapping, offset,
986 __ClearPageLocked(page);
989 * The page might have been evicted from cache only
990 * recently, in which case it should be activated like
991 * any other repeatedly accessed page.
992 * The exception is pages getting rewritten; evicting other
993 * data from the working set, only to cache data that will
994 * get overwritten with something else, is a waste of memory.
996 WARN_ON_ONCE(PageActive(page));
997 if (!(gfp_mask & __GFP_WRITE) && shadow)
998 workingset_refault(page, shadow);
1003 EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
1006 struct page *__page_cache_alloc(gfp_t gfp)
1011 if (cpuset_do_page_mem_spread()) {
1012 unsigned int cpuset_mems_cookie;
1014 cpuset_mems_cookie = read_mems_allowed_begin();
1015 n = cpuset_mem_spread_node();
1016 page = __alloc_pages_node(n, gfp, 0);
1017 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
1021 return alloc_pages(gfp, 0);
1023 EXPORT_SYMBOL(__page_cache_alloc);
1027 * filemap_invalidate_lock_two - lock invalidate_lock for two mappings
1029 * Lock exclusively invalidate_lock of any passed mapping that is not NULL.
1031 * @mapping1: the first mapping to lock
1032 * @mapping2: the second mapping to lock
1034 void filemap_invalidate_lock_two(struct address_space *mapping1,
1035 struct address_space *mapping2)
1037 if (mapping1 > mapping2)
1038 swap(mapping1, mapping2);
1040 down_write(&mapping1->invalidate_lock);
1041 if (mapping2 && mapping1 != mapping2)
1042 down_write_nested(&mapping2->invalidate_lock, 1);
1044 EXPORT_SYMBOL(filemap_invalidate_lock_two);
1047 * filemap_invalidate_unlock_two - unlock invalidate_lock for two mappings
1049 * Unlock exclusive invalidate_lock of any passed mapping that is not NULL.
1051 * @mapping1: the first mapping to unlock
1052 * @mapping2: the second mapping to unlock
1054 void filemap_invalidate_unlock_two(struct address_space *mapping1,
1055 struct address_space *mapping2)
1058 up_write(&mapping1->invalidate_lock);
1059 if (mapping2 && mapping1 != mapping2)
1060 up_write(&mapping2->invalidate_lock);
1062 EXPORT_SYMBOL(filemap_invalidate_unlock_two);
1065 * In order to wait for pages to become available there must be
1066 * waitqueues associated with pages. By using a hash table of
1067 * waitqueues where the bucket discipline is to maintain all
1068 * waiters on the same queue and wake all when any of the pages
1069 * become available, and for the woken contexts to check to be
1070 * sure the appropriate page became available, this saves space
1071 * at a cost of "thundering herd" phenomena during rare hash
1074 #define PAGE_WAIT_TABLE_BITS 8
1075 #define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1076 static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1078 static wait_queue_head_t *page_waitqueue(struct page *page)
1080 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
1083 void __init pagecache_init(void)
1087 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1088 init_waitqueue_head(&page_wait_table[i]);
1090 page_writeback_init();
1094 * The page wait code treats the "wait->flags" somewhat unusually, because
1095 * we have multiple different kinds of waits, not just the usual "exclusive"
1100 * (a) no special bits set:
1102 * We're just waiting for the bit to be released, and when a waker
1103 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1104 * and remove it from the wait queue.
1106 * Simple and straightforward.
1108 * (b) WQ_FLAG_EXCLUSIVE:
1110 * The waiter is waiting to get the lock, and only one waiter should
1111 * be woken up to avoid any thundering herd behavior. We'll set the
1112 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1114 * This is the traditional exclusive wait.
1116 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
1118 * The waiter is waiting to get the bit, and additionally wants the
1119 * lock to be transferred to it for fair lock behavior. If the lock
1120 * cannot be taken, we stop walking the wait queue without waking
1123 * This is the "fair lock handoff" case, and in addition to setting
1124 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1125 * that it now has the lock.
1127 static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
1130 struct wait_page_key *key = arg;
1131 struct wait_page_queue *wait_page
1132 = container_of(wait, struct wait_page_queue, wait);
1134 if (!wake_page_match(wait_page, key))
1138 * If it's a lock handoff wait, we get the bit for it, and
1139 * stop walking (and do not wake it up) if we can't.
1141 flags = wait->flags;
1142 if (flags & WQ_FLAG_EXCLUSIVE) {
1143 if (test_bit(key->bit_nr, &key->page->flags))
1145 if (flags & WQ_FLAG_CUSTOM) {
1146 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1148 flags |= WQ_FLAG_DONE;
1153 * We are holding the wait-queue lock, but the waiter that
1154 * is waiting for this will be checking the flags without
1157 * So update the flags atomically, and wake up the waiter
1158 * afterwards to avoid any races. This store-release pairs
1159 * with the load-acquire in wait_on_page_bit_common().
1161 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
1162 wake_up_state(wait->private, mode);
1165 * Ok, we have successfully done what we're waiting for,
1166 * and we can unconditionally remove the wait entry.
1168 * Note that this pairs with the "finish_wait()" in the
1169 * waiter, and has to be the absolute last thing we do.
1170 * After this list_del_init(&wait->entry) the wait entry
1171 * might be de-allocated and the process might even have
1174 list_del_init_careful(&wait->entry);
1175 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
1178 static void wake_up_page_bit(struct page *page, int bit_nr)
1180 wait_queue_head_t *q = page_waitqueue(page);
1181 struct wait_page_key key;
1182 unsigned long flags;
1183 wait_queue_entry_t bookmark;
1186 key.bit_nr = bit_nr;
1190 bookmark.private = NULL;
1191 bookmark.func = NULL;
1192 INIT_LIST_HEAD(&bookmark.entry);
1194 spin_lock_irqsave(&q->lock, flags);
1195 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1197 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1199 * Take a breather from holding the lock,
1200 * allow pages that finish wake up asynchronously
1201 * to acquire the lock and remove themselves
1204 spin_unlock_irqrestore(&q->lock, flags);
1206 spin_lock_irqsave(&q->lock, flags);
1207 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1211 * It is possible for other pages to have collided on the waitqueue
1212 * hash, so in that case check for a page match. That prevents a long-
1215 * It is still possible to miss a case here, when we woke page waiters
1216 * and removed them from the waitqueue, but there are still other
1219 if (!waitqueue_active(q) || !key.page_match) {
1220 ClearPageWaiters(page);
1222 * It's possible to miss clearing Waiters here, when we woke
1223 * our page waiters, but the hashed waitqueue has waiters for
1224 * other pages on it.
1226 * That's okay, it's a rare case. The next waker will clear it.
1229 spin_unlock_irqrestore(&q->lock, flags);
1232 static void wake_up_page(struct page *page, int bit)
1234 if (!PageWaiters(page))
1236 wake_up_page_bit(page, bit);
1240 * A choice of three behaviors for wait_on_page_bit_common():
1243 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1244 * __lock_page() waiting on then setting PG_locked.
1246 SHARED, /* Hold ref to page and check the bit when woken, like
1247 * wait_on_page_writeback() waiting on PG_writeback.
1249 DROP, /* Drop ref to page before wait, no check when woken,
1250 * like put_and_wait_on_page_locked() on PG_locked.
1255 * Attempt to check (or get) the page bit, and mark us done
1258 static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1259 struct wait_queue_entry *wait)
1261 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1262 if (test_and_set_bit(bit_nr, &page->flags))
1264 } else if (test_bit(bit_nr, &page->flags))
1267 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
1271 /* How many times do we accept lock stealing from under a waiter? */
1272 int sysctl_page_lock_unfairness = 5;
1274 static inline int wait_on_page_bit_common(wait_queue_head_t *q,
1275 struct page *page, int bit_nr, int state, enum behavior behavior)
1277 int unfairness = sysctl_page_lock_unfairness;
1278 struct wait_page_queue wait_page;
1279 wait_queue_entry_t *wait = &wait_page.wait;
1280 bool thrashing = false;
1281 bool delayacct = false;
1282 unsigned long pflags;
1284 if (bit_nr == PG_locked &&
1285 !PageUptodate(page) && PageWorkingset(page)) {
1286 if (!PageSwapBacked(page)) {
1287 delayacct_thrashing_start();
1290 psi_memstall_enter(&pflags);
1295 wait->func = wake_page_function;
1296 wait_page.page = page;
1297 wait_page.bit_nr = bit_nr;
1301 if (behavior == EXCLUSIVE) {
1302 wait->flags = WQ_FLAG_EXCLUSIVE;
1303 if (--unfairness < 0)
1304 wait->flags |= WQ_FLAG_CUSTOM;
1308 * Do one last check whether we can get the
1309 * page bit synchronously.
1311 * Do the SetPageWaiters() marking before that
1312 * to let any waker we _just_ missed know they
1313 * need to wake us up (otherwise they'll never
1314 * even go to the slow case that looks at the
1315 * page queue), and add ourselves to the wait
1316 * queue if we need to sleep.
1318 * This part needs to be done under the queue
1319 * lock to avoid races.
1321 spin_lock_irq(&q->lock);
1322 SetPageWaiters(page);
1323 if (!trylock_page_bit_common(page, bit_nr, wait))
1324 __add_wait_queue_entry_tail(q, wait);
1325 spin_unlock_irq(&q->lock);
1328 * From now on, all the logic will be based on
1329 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1330 * see whether the page bit testing has already
1331 * been done by the wake function.
1333 * We can drop our reference to the page.
1335 if (behavior == DROP)
1339 * Note that until the "finish_wait()", or until
1340 * we see the WQ_FLAG_WOKEN flag, we need to
1341 * be very careful with the 'wait->flags', because
1342 * we may race with a waker that sets them.
1347 set_current_state(state);
1349 /* Loop until we've been woken or interrupted */
1350 flags = smp_load_acquire(&wait->flags);
1351 if (!(flags & WQ_FLAG_WOKEN)) {
1352 if (signal_pending_state(state, current))
1359 /* If we were non-exclusive, we're done */
1360 if (behavior != EXCLUSIVE)
1363 /* If the waker got the lock for us, we're done */
1364 if (flags & WQ_FLAG_DONE)
1368 * Otherwise, if we're getting the lock, we need to
1369 * try to get it ourselves.
1371 * And if that fails, we'll have to retry this all.
1373 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1376 wait->flags |= WQ_FLAG_DONE;
1381 * If a signal happened, this 'finish_wait()' may remove the last
1382 * waiter from the wait-queues, but the PageWaiters bit will remain
1383 * set. That's ok. The next wakeup will take care of it, and trying
1384 * to do it here would be difficult and prone to races.
1386 finish_wait(q, wait);
1390 delayacct_thrashing_end();
1391 psi_memstall_leave(&pflags);
1395 * NOTE! The wait->flags weren't stable until we've done the
1396 * 'finish_wait()', and we could have exited the loop above due
1397 * to a signal, and had a wakeup event happen after the signal
1398 * test but before the 'finish_wait()'.
1400 * So only after the finish_wait() can we reliably determine
1401 * if we got woken up or not, so we can now figure out the final
1402 * return value based on that state without races.
1404 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1405 * waiter, but an exclusive one requires WQ_FLAG_DONE.
1407 if (behavior == EXCLUSIVE)
1408 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
1410 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
1413 void wait_on_page_bit(struct page *page, int bit_nr)
1415 wait_queue_head_t *q = page_waitqueue(page);
1416 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
1418 EXPORT_SYMBOL(wait_on_page_bit);
1420 int wait_on_page_bit_killable(struct page *page, int bit_nr)
1422 wait_queue_head_t *q = page_waitqueue(page);
1423 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
1425 EXPORT_SYMBOL(wait_on_page_bit_killable);
1428 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1429 * @page: The page to wait for.
1430 * @state: The sleep state (TASK_KILLABLE, TASK_UNINTERRUPTIBLE, etc).
1432 * The caller should hold a reference on @page. They expect the page to
1433 * become unlocked relatively soon, but do not wish to hold up migration
1434 * (for example) by holding the reference while waiting for the page to
1435 * come unlocked. After this function returns, the caller should not
1436 * dereference @page.
1438 * Return: 0 if the page was unlocked or -EINTR if interrupted by a signal.
1440 int put_and_wait_on_page_locked(struct page *page, int state)
1442 wait_queue_head_t *q;
1444 page = compound_head(page);
1445 q = page_waitqueue(page);
1446 return wait_on_page_bit_common(q, page, PG_locked, state, DROP);
1450 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
1451 * @page: Page defining the wait queue of interest
1452 * @waiter: Waiter to add to the queue
1454 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1456 void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
1458 wait_queue_head_t *q = page_waitqueue(page);
1459 unsigned long flags;
1461 spin_lock_irqsave(&q->lock, flags);
1462 __add_wait_queue_entry_tail(q, waiter);
1463 SetPageWaiters(page);
1464 spin_unlock_irqrestore(&q->lock, flags);
1466 EXPORT_SYMBOL_GPL(add_page_wait_queue);
1468 #ifndef clear_bit_unlock_is_negative_byte
1471 * PG_waiters is the high bit in the same byte as PG_lock.
1473 * On x86 (and on many other architectures), we can clear PG_lock and
1474 * test the sign bit at the same time. But if the architecture does
1475 * not support that special operation, we just do this all by hand
1478 * The read of PG_waiters has to be after (or concurrently with) PG_locked
1479 * being cleared, but a memory barrier should be unnecessary since it is
1480 * in the same byte as PG_locked.
1482 static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1484 clear_bit_unlock(nr, mem);
1485 /* smp_mb__after_atomic(); */
1486 return test_bit(PG_waiters, mem);
1492 * unlock_page - unlock a locked page
1495 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
1496 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
1497 * mechanism between PageLocked pages and PageWriteback pages is shared.
1498 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1500 * Note that this depends on PG_waiters being the sign bit in the byte
1501 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1502 * clear the PG_locked bit and test PG_waiters at the same time fairly
1503 * portably (architectures that do LL/SC can test any bit, while x86 can
1504 * test the sign bit).
1506 void unlock_page(struct page *page)
1508 BUILD_BUG_ON(PG_waiters != 7);
1509 page = compound_head(page);
1510 VM_BUG_ON_PAGE(!PageLocked(page), page);
1511 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1512 wake_up_page_bit(page, PG_locked);
1514 EXPORT_SYMBOL(unlock_page);
1517 * end_page_private_2 - Clear PG_private_2 and release any waiters
1520 * Clear the PG_private_2 bit on a page and wake up any sleepers waiting for
1521 * this. The page ref held for PG_private_2 being set is released.
1523 * This is, for example, used when a netfs page is being written to a local
1524 * disk cache, thereby allowing writes to the cache for the same page to be
1527 void end_page_private_2(struct page *page)
1529 page = compound_head(page);
1530 VM_BUG_ON_PAGE(!PagePrivate2(page), page);
1531 clear_bit_unlock(PG_private_2, &page->flags);
1532 wake_up_page_bit(page, PG_private_2);
1535 EXPORT_SYMBOL(end_page_private_2);
1538 * wait_on_page_private_2 - Wait for PG_private_2 to be cleared on a page
1539 * @page: The page to wait on
1541 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page.
1543 void wait_on_page_private_2(struct page *page)
1545 page = compound_head(page);
1546 while (PagePrivate2(page))
1547 wait_on_page_bit(page, PG_private_2);
1549 EXPORT_SYMBOL(wait_on_page_private_2);
1552 * wait_on_page_private_2_killable - Wait for PG_private_2 to be cleared on a page
1553 * @page: The page to wait on
1555 * Wait for PG_private_2 (aka PG_fscache) to be cleared on a page or until a
1556 * fatal signal is received by the calling task.
1559 * - 0 if successful.
1560 * - -EINTR if a fatal signal was encountered.
1562 int wait_on_page_private_2_killable(struct page *page)
1566 page = compound_head(page);
1567 while (PagePrivate2(page)) {
1568 ret = wait_on_page_bit_killable(page, PG_private_2);
1575 EXPORT_SYMBOL(wait_on_page_private_2_killable);
1578 * end_page_writeback - end writeback against a page
1581 void end_page_writeback(struct page *page)
1584 * TestClearPageReclaim could be used here but it is an atomic
1585 * operation and overkill in this particular case. Failing to
1586 * shuffle a page marked for immediate reclaim is too mild to
1587 * justify taking an atomic operation penalty at the end of
1588 * ever page writeback.
1590 if (PageReclaim(page)) {
1591 ClearPageReclaim(page);
1592 rotate_reclaimable_page(page);
1596 * Writeback does not hold a page reference of its own, relying
1597 * on truncation to wait for the clearing of PG_writeback.
1598 * But here we must make sure that the page is not freed and
1599 * reused before the wake_up_page().
1602 if (!test_clear_page_writeback(page))
1605 smp_mb__after_atomic();
1606 wake_up_page(page, PG_writeback);
1609 EXPORT_SYMBOL(end_page_writeback);
1612 * After completing I/O on a page, call this routine to update the page
1613 * flags appropriately
1615 void page_endio(struct page *page, bool is_write, int err)
1619 SetPageUptodate(page);
1621 ClearPageUptodate(page);
1627 struct address_space *mapping;
1630 mapping = page_mapping(page);
1632 mapping_set_error(mapping, err);
1634 end_page_writeback(page);
1637 EXPORT_SYMBOL_GPL(page_endio);
1640 * __lock_page - get a lock on the page, assuming we need to sleep to get it
1641 * @__page: the page to lock
1643 void __lock_page(struct page *__page)
1645 struct page *page = compound_head(__page);
1646 wait_queue_head_t *q = page_waitqueue(page);
1647 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1650 EXPORT_SYMBOL(__lock_page);
1652 int __lock_page_killable(struct page *__page)
1654 struct page *page = compound_head(__page);
1655 wait_queue_head_t *q = page_waitqueue(page);
1656 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1659 EXPORT_SYMBOL_GPL(__lock_page_killable);
1661 int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1663 struct wait_queue_head *q = page_waitqueue(page);
1667 wait->bit_nr = PG_locked;
1669 spin_lock_irq(&q->lock);
1670 __add_wait_queue_entry_tail(q, &wait->wait);
1671 SetPageWaiters(page);
1672 ret = !trylock_page(page);
1674 * If we were successful now, we know we're still on the
1675 * waitqueue as we're still under the lock. This means it's
1676 * safe to remove and return success, we know the callback
1677 * isn't going to trigger.
1680 __remove_wait_queue(q, &wait->wait);
1683 spin_unlock_irq(&q->lock);
1689 * 1 - page is locked; mmap_lock is still held.
1690 * 0 - page is not locked.
1691 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
1692 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1693 * which case mmap_lock is still held.
1695 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1696 * with the page locked and the mmap_lock unperturbed.
1698 int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1701 if (fault_flag_allow_retry_first(flags)) {
1703 * CAUTION! In this case, mmap_lock is not released
1704 * even though return 0.
1706 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1709 mmap_read_unlock(mm);
1710 if (flags & FAULT_FLAG_KILLABLE)
1711 wait_on_page_locked_killable(page);
1713 wait_on_page_locked(page);
1716 if (flags & FAULT_FLAG_KILLABLE) {
1719 ret = __lock_page_killable(page);
1721 mmap_read_unlock(mm);
1732 * page_cache_next_miss() - Find the next gap in the page cache.
1733 * @mapping: Mapping.
1735 * @max_scan: Maximum range to search.
1737 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1738 * gap with the lowest index.
1740 * This function may be called under the rcu_read_lock. However, this will
1741 * not atomically search a snapshot of the cache at a single point in time.
1742 * For example, if a gap is created at index 5, then subsequently a gap is
1743 * created at index 10, page_cache_next_miss covering both indices may
1744 * return 10 if called under the rcu_read_lock.
1746 * Return: The index of the gap if found, otherwise an index outside the
1747 * range specified (in which case 'return - index >= max_scan' will be true).
1748 * In the rare case of index wrap-around, 0 will be returned.
1750 pgoff_t page_cache_next_miss(struct address_space *mapping,
1751 pgoff_t index, unsigned long max_scan)
1753 XA_STATE(xas, &mapping->i_pages, index);
1755 while (max_scan--) {
1756 void *entry = xas_next(&xas);
1757 if (!entry || xa_is_value(entry))
1759 if (xas.xa_index == 0)
1763 return xas.xa_index;
1765 EXPORT_SYMBOL(page_cache_next_miss);
1768 * page_cache_prev_miss() - Find the previous gap in the page cache.
1769 * @mapping: Mapping.
1771 * @max_scan: Maximum range to search.
1773 * Search the range [max(index - max_scan + 1, 0), index] for the
1774 * gap with the highest index.
1776 * This function may be called under the rcu_read_lock. However, this will
1777 * not atomically search a snapshot of the cache at a single point in time.
1778 * For example, if a gap is created at index 10, then subsequently a gap is
1779 * created at index 5, page_cache_prev_miss() covering both indices may
1780 * return 5 if called under the rcu_read_lock.
1782 * Return: The index of the gap if found, otherwise an index outside the
1783 * range specified (in which case 'index - return >= max_scan' will be true).
1784 * In the rare case of wrap-around, ULONG_MAX will be returned.
1786 pgoff_t page_cache_prev_miss(struct address_space *mapping,
1787 pgoff_t index, unsigned long max_scan)
1789 XA_STATE(xas, &mapping->i_pages, index);
1791 while (max_scan--) {
1792 void *entry = xas_prev(&xas);
1793 if (!entry || xa_is_value(entry))
1795 if (xas.xa_index == ULONG_MAX)
1799 return xas.xa_index;
1801 EXPORT_SYMBOL(page_cache_prev_miss);
1804 * mapping_get_entry - Get a page cache entry.
1805 * @mapping: the address_space to search
1806 * @index: The page cache index.
1808 * Looks up the page cache slot at @mapping & @index. If there is a
1809 * page cache page, the head page is returned with an increased refcount.
1811 * If the slot holds a shadow entry of a previously evicted page, or a
1812 * swap entry from shmem/tmpfs, it is returned.
1814 * Return: The head page or shadow entry, %NULL if nothing is found.
1816 static struct page *mapping_get_entry(struct address_space *mapping,
1819 XA_STATE(xas, &mapping->i_pages, index);
1825 page = xas_load(&xas);
1826 if (xas_retry(&xas, page))
1829 * A shadow entry of a recently evicted page, or a swap entry from
1830 * shmem/tmpfs. Return it without attempting to raise page count.
1832 if (!page || xa_is_value(page))
1835 if (!page_cache_get_speculative(page))
1839 * Has the page moved or been split?
1840 * This is part of the lockless pagecache protocol. See
1841 * include/linux/pagemap.h for details.
1843 if (unlikely(page != xas_reload(&xas))) {
1854 * pagecache_get_page - Find and get a reference to a page.
1855 * @mapping: The address_space to search.
1856 * @index: The page index.
1857 * @fgp_flags: %FGP flags modify how the page is returned.
1858 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
1860 * Looks up the page cache entry at @mapping & @index.
1862 * @fgp_flags can be zero or more of these flags:
1864 * * %FGP_ACCESSED - The page will be marked accessed.
1865 * * %FGP_LOCK - The page is returned locked.
1866 * * %FGP_HEAD - If the page is present and a THP, return the head page
1867 * rather than the exact page specified by the index.
1868 * * %FGP_ENTRY - If there is a shadow / swap / DAX entry, return it
1869 * instead of allocating a new page to replace it.
1870 * * %FGP_CREAT - If no page is present then a new page is allocated using
1871 * @gfp_mask and added to the page cache and the VM's LRU list.
1872 * The page is returned locked and with an increased refcount.
1873 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1874 * page is already in cache. If the page was allocated, unlock it before
1875 * returning so the caller can do the same dance.
1876 * * %FGP_WRITE - The page will be written
1877 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1878 * * %FGP_NOWAIT - Don't get blocked by page lock
1880 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1881 * if the %GFP flags specified for %FGP_CREAT are atomic.
1883 * If there is a page cache page, it is returned with an increased refcount.
1885 * Return: The found page or %NULL otherwise.
1887 struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1888 int fgp_flags, gfp_t gfp_mask)
1893 page = mapping_get_entry(mapping, index);
1894 if (xa_is_value(page)) {
1895 if (fgp_flags & FGP_ENTRY)
1902 if (fgp_flags & FGP_LOCK) {
1903 if (fgp_flags & FGP_NOWAIT) {
1904 if (!trylock_page(page)) {
1912 /* Has the page been truncated? */
1913 if (unlikely(page->mapping != mapping)) {
1918 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
1921 if (fgp_flags & FGP_ACCESSED)
1922 mark_page_accessed(page);
1923 else if (fgp_flags & FGP_WRITE) {
1924 /* Clear idle flag for buffer write */
1925 if (page_is_idle(page))
1926 clear_page_idle(page);
1928 if (!(fgp_flags & FGP_HEAD))
1929 page = find_subpage(page, index);
1932 if (!page && (fgp_flags & FGP_CREAT)) {
1934 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
1935 gfp_mask |= __GFP_WRITE;
1936 if (fgp_flags & FGP_NOFS)
1937 gfp_mask &= ~__GFP_FS;
1939 page = __page_cache_alloc(gfp_mask);
1943 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
1944 fgp_flags |= FGP_LOCK;
1946 /* Init accessed so avoid atomic mark_page_accessed later */
1947 if (fgp_flags & FGP_ACCESSED)
1948 __SetPageReferenced(page);
1950 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
1951 if (unlikely(err)) {
1959 * add_to_page_cache_lru locks the page, and for mmap we expect
1962 if (page && (fgp_flags & FGP_FOR_MMAP))
1968 EXPORT_SYMBOL(pagecache_get_page);
1970 static inline struct page *find_get_entry(struct xa_state *xas, pgoff_t max,
1976 if (mark == XA_PRESENT)
1977 page = xas_find(xas, max);
1979 page = xas_find_marked(xas, max, mark);
1981 if (xas_retry(xas, page))
1984 * A shadow entry of a recently evicted page, a swap
1985 * entry from shmem/tmpfs or a DAX entry. Return it
1986 * without attempting to raise page count.
1988 if (!page || xa_is_value(page))
1991 if (!page_cache_get_speculative(page))
1994 /* Has the page moved or been split? */
1995 if (unlikely(page != xas_reload(xas))) {
2007 * find_get_entries - gang pagecache lookup
2008 * @mapping: The address_space to search
2009 * @start: The starting page cache index
2010 * @end: The final page index (inclusive).
2011 * @pvec: Where the resulting entries are placed.
2012 * @indices: The cache indices corresponding to the entries in @entries
2014 * find_get_entries() will search for and return a batch of entries in
2015 * the mapping. The entries are placed in @pvec. find_get_entries()
2016 * takes a reference on any actual pages it returns.
2018 * The search returns a group of mapping-contiguous page cache entries
2019 * with ascending indexes. There may be holes in the indices due to
2020 * not-present pages.
2022 * Any shadow entries of evicted pages, or swap entries from
2023 * shmem/tmpfs, are included in the returned array.
2025 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
2026 * stops at that page: the caller is likely to have a better way to handle
2027 * the compound page as a whole, and then skip its extent, than repeatedly
2028 * calling find_get_entries() to return all its tails.
2030 * Return: the number of pages and shadow entries which were found.
2032 unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
2033 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2035 XA_STATE(xas, &mapping->i_pages, start);
2037 unsigned int ret = 0;
2038 unsigned nr_entries = PAGEVEC_SIZE;
2041 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2043 * Terminate early on finding a THP, to allow the caller to
2044 * handle it all at once; but continue if this is hugetlbfs.
2046 if (!xa_is_value(page) && PageTransHuge(page) &&
2048 page = find_subpage(page, xas.xa_index);
2049 nr_entries = ret + 1;
2052 indices[ret] = xas.xa_index;
2053 pvec->pages[ret] = page;
2054 if (++ret == nr_entries)
2064 * find_lock_entries - Find a batch of pagecache entries.
2065 * @mapping: The address_space to search.
2066 * @start: The starting page cache index.
2067 * @end: The final page index (inclusive).
2068 * @pvec: Where the resulting entries are placed.
2069 * @indices: The cache indices of the entries in @pvec.
2071 * find_lock_entries() will return a batch of entries from @mapping.
2072 * Swap, shadow and DAX entries are included. Pages are returned
2073 * locked and with an incremented refcount. Pages which are locked by
2074 * somebody else or under writeback are skipped. Only the head page of
2075 * a THP is returned. Pages which are partially outside the range are
2078 * The entries have ascending indexes. The indices may not be consecutive
2079 * due to not-present entries, THP pages, pages which could not be locked
2080 * or pages under writeback.
2082 * Return: The number of entries which were found.
2084 unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
2085 pgoff_t end, struct pagevec *pvec, pgoff_t *indices)
2087 XA_STATE(xas, &mapping->i_pages, start);
2091 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2092 if (!xa_is_value(page)) {
2093 if (page->index < start)
2095 VM_BUG_ON_PAGE(page->index != xas.xa_index, page);
2096 if (page->index + thp_nr_pages(page) - 1 > end)
2098 if (!trylock_page(page))
2100 if (page->mapping != mapping || PageWriteback(page))
2102 VM_BUG_ON_PAGE(!thp_contains(page, xas.xa_index),
2105 indices[pvec->nr] = xas.xa_index;
2106 if (!pagevec_add(pvec, page))
2114 if (!xa_is_value(page) && PageTransHuge(page)) {
2115 unsigned int nr_pages = thp_nr_pages(page);
2117 /* Final THP may cross MAX_LFS_FILESIZE on 32-bit */
2118 xas_set(&xas, page->index + nr_pages);
2119 if (xas.xa_index < nr_pages)
2125 return pagevec_count(pvec);
2129 * find_get_pages_range - gang pagecache lookup
2130 * @mapping: The address_space to search
2131 * @start: The starting page index
2132 * @end: The final page index (inclusive)
2133 * @nr_pages: The maximum number of pages
2134 * @pages: Where the resulting pages are placed
2136 * find_get_pages_range() will search for and return a group of up to @nr_pages
2137 * pages in the mapping starting at index @start and up to index @end
2138 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
2139 * a reference against the returned pages.
2141 * The search returns a group of mapping-contiguous pages with ascending
2142 * indexes. There may be holes in the indices due to not-present pages.
2143 * We also update @start to index the next page for the traversal.
2145 * Return: the number of pages which were found. If this number is
2146 * smaller than @nr_pages, the end of specified range has been
2149 unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
2150 pgoff_t end, unsigned int nr_pages,
2151 struct page **pages)
2153 XA_STATE(xas, &mapping->i_pages, *start);
2157 if (unlikely(!nr_pages))
2161 while ((page = find_get_entry(&xas, end, XA_PRESENT))) {
2162 /* Skip over shadow, swap and DAX entries */
2163 if (xa_is_value(page))
2166 pages[ret] = find_subpage(page, xas.xa_index);
2167 if (++ret == nr_pages) {
2168 *start = xas.xa_index + 1;
2174 * We come here when there is no page beyond @end. We take care to not
2175 * overflow the index @start as it confuses some of the callers. This
2176 * breaks the iteration when there is a page at index -1 but that is
2177 * already broken anyway.
2179 if (end == (pgoff_t)-1)
2180 *start = (pgoff_t)-1;
2190 * find_get_pages_contig - gang contiguous pagecache lookup
2191 * @mapping: The address_space to search
2192 * @index: The starting page index
2193 * @nr_pages: The maximum number of pages
2194 * @pages: Where the resulting pages are placed
2196 * find_get_pages_contig() works exactly like find_get_pages(), except
2197 * that the returned number of pages are guaranteed to be contiguous.
2199 * Return: the number of pages which were found.
2201 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2202 unsigned int nr_pages, struct page **pages)
2204 XA_STATE(xas, &mapping->i_pages, index);
2206 unsigned int ret = 0;
2208 if (unlikely(!nr_pages))
2212 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
2213 if (xas_retry(&xas, page))
2216 * If the entry has been swapped out, we can stop looking.
2217 * No current caller is looking for DAX entries.
2219 if (xa_is_value(page))
2222 if (!page_cache_get_speculative(page))
2225 /* Has the page moved or been split? */
2226 if (unlikely(page != xas_reload(&xas)))
2229 pages[ret] = find_subpage(page, xas.xa_index);
2230 if (++ret == nr_pages)
2241 EXPORT_SYMBOL(find_get_pages_contig);
2244 * find_get_pages_range_tag - Find and return head pages matching @tag.
2245 * @mapping: the address_space to search
2246 * @index: the starting page index
2247 * @end: The final page index (inclusive)
2248 * @tag: the tag index
2249 * @nr_pages: the maximum number of pages
2250 * @pages: where the resulting pages are placed
2252 * Like find_get_pages(), except we only return head pages which are tagged
2253 * with @tag. @index is updated to the index immediately after the last
2254 * page we return, ready for the next iteration.
2256 * Return: the number of pages which were found.
2258 unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
2259 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
2260 struct page **pages)
2262 XA_STATE(xas, &mapping->i_pages, *index);
2266 if (unlikely(!nr_pages))
2270 while ((page = find_get_entry(&xas, end, tag))) {
2272 * Shadow entries should never be tagged, but this iteration
2273 * is lockless so there is a window for page reclaim to evict
2274 * a page we saw tagged. Skip over it.
2276 if (xa_is_value(page))
2280 if (++ret == nr_pages) {
2281 *index = page->index + thp_nr_pages(page);
2287 * We come here when we got to @end. We take care to not overflow the
2288 * index @index as it confuses some of the callers. This breaks the
2289 * iteration when there is a page at index -1 but that is already
2292 if (end == (pgoff_t)-1)
2293 *index = (pgoff_t)-1;
2301 EXPORT_SYMBOL(find_get_pages_range_tag);
2304 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2305 * a _large_ part of the i/o request. Imagine the worst scenario:
2307 * ---R__________________________________________B__________
2308 * ^ reading here ^ bad block(assume 4k)
2310 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2311 * => failing the whole request => read(R) => read(R+1) =>
2312 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2313 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2314 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2316 * It is going insane. Fix it by quickly scaling down the readahead size.
2318 static void shrink_readahead_size_eio(struct file_ra_state *ra)
2324 * filemap_get_read_batch - Get a batch of pages for read
2326 * Get a batch of pages which represent a contiguous range of bytes
2327 * in the file. No tail pages will be returned. If @index is in the
2328 * middle of a THP, the entire THP will be returned. The last page in
2329 * the batch may have Readahead set or be not Uptodate so that the
2330 * caller can take the appropriate action.
2332 static void filemap_get_read_batch(struct address_space *mapping,
2333 pgoff_t index, pgoff_t max, struct pagevec *pvec)
2335 XA_STATE(xas, &mapping->i_pages, index);
2339 for (head = xas_load(&xas); head; head = xas_next(&xas)) {
2340 if (xas_retry(&xas, head))
2342 if (xas.xa_index > max || xa_is_value(head))
2344 if (!page_cache_get_speculative(head))
2347 /* Has the page moved or been split? */
2348 if (unlikely(head != xas_reload(&xas)))
2351 if (!pagevec_add(pvec, head))
2353 if (!PageUptodate(head))
2355 if (PageReadahead(head))
2357 xas.xa_index = head->index + thp_nr_pages(head) - 1;
2358 xas.xa_offset = (xas.xa_index >> xas.xa_shift) & XA_CHUNK_MASK;
2368 static int filemap_read_page(struct file *file, struct address_space *mapping,
2374 * A previous I/O error may have been due to temporary failures,
2375 * eg. multipath errors. PG_error will be set again if readpage
2378 ClearPageError(page);
2379 /* Start the actual read. The read will unlock the page. */
2380 error = mapping->a_ops->readpage(file, page);
2384 error = wait_on_page_locked_killable(page);
2387 if (PageUptodate(page))
2389 shrink_readahead_size_eio(&file->f_ra);
2393 static bool filemap_range_uptodate(struct address_space *mapping,
2394 loff_t pos, struct iov_iter *iter, struct page *page)
2398 if (PageUptodate(page))
2400 /* pipes can't handle partially uptodate pages */
2401 if (iov_iter_is_pipe(iter))
2403 if (!mapping->a_ops->is_partially_uptodate)
2405 if (mapping->host->i_blkbits >= (PAGE_SHIFT + thp_order(page)))
2408 count = iter->count;
2409 if (page_offset(page) > pos) {
2410 count -= page_offset(page) - pos;
2413 pos -= page_offset(page);
2416 return mapping->a_ops->is_partially_uptodate(page, pos, count);
2419 static int filemap_update_page(struct kiocb *iocb,
2420 struct address_space *mapping, struct iov_iter *iter,
2425 if (iocb->ki_flags & IOCB_NOWAIT) {
2426 if (!filemap_invalidate_trylock_shared(mapping))
2429 filemap_invalidate_lock_shared(mapping);
2432 if (!trylock_page(page)) {
2434 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_NOIO))
2435 goto unlock_mapping;
2436 if (!(iocb->ki_flags & IOCB_WAITQ)) {
2437 filemap_invalidate_unlock_shared(mapping);
2438 put_and_wait_on_page_locked(page, TASK_KILLABLE);
2439 return AOP_TRUNCATED_PAGE;
2441 error = __lock_page_async(page, iocb->ki_waitq);
2443 goto unlock_mapping;
2446 error = AOP_TRUNCATED_PAGE;
2451 if (filemap_range_uptodate(mapping, iocb->ki_pos, iter, page))
2455 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT | IOCB_WAITQ))
2458 error = filemap_read_page(iocb->ki_filp, mapping, page);
2459 goto unlock_mapping;
2463 filemap_invalidate_unlock_shared(mapping);
2464 if (error == AOP_TRUNCATED_PAGE)
2469 static int filemap_create_page(struct file *file,
2470 struct address_space *mapping, pgoff_t index,
2471 struct pagevec *pvec)
2476 page = page_cache_alloc(mapping);
2481 * Protect against truncate / hole punch. Grabbing invalidate_lock here
2482 * assures we cannot instantiate and bring uptodate new pagecache pages
2483 * after evicting page cache during truncate and before actually
2484 * freeing blocks. Note that we could release invalidate_lock after
2485 * inserting the page into page cache as the locked page would then be
2486 * enough to synchronize with hole punching. But there are code paths
2487 * such as filemap_update_page() filling in partially uptodate pages or
2488 * ->readpages() that need to hold invalidate_lock while mapping blocks
2489 * for IO so let's hold the lock here as well to keep locking rules
2492 filemap_invalidate_lock_shared(mapping);
2493 error = add_to_page_cache_lru(page, mapping, index,
2494 mapping_gfp_constraint(mapping, GFP_KERNEL));
2495 if (error == -EEXIST)
2496 error = AOP_TRUNCATED_PAGE;
2500 error = filemap_read_page(file, mapping, page);
2504 filemap_invalidate_unlock_shared(mapping);
2505 pagevec_add(pvec, page);
2508 filemap_invalidate_unlock_shared(mapping);
2513 static int filemap_readahead(struct kiocb *iocb, struct file *file,
2514 struct address_space *mapping, struct page *page,
2517 if (iocb->ki_flags & IOCB_NOIO)
2519 page_cache_async_readahead(mapping, &file->f_ra, file, page,
2520 page->index, last_index - page->index);
2524 static int filemap_get_pages(struct kiocb *iocb, struct iov_iter *iter,
2525 struct pagevec *pvec)
2527 struct file *filp = iocb->ki_filp;
2528 struct address_space *mapping = filp->f_mapping;
2529 struct file_ra_state *ra = &filp->f_ra;
2530 pgoff_t index = iocb->ki_pos >> PAGE_SHIFT;
2535 last_index = DIV_ROUND_UP(iocb->ki_pos + iter->count, PAGE_SIZE);
2537 if (fatal_signal_pending(current))
2540 filemap_get_read_batch(mapping, index, last_index, pvec);
2541 if (!pagevec_count(pvec)) {
2542 if (iocb->ki_flags & IOCB_NOIO)
2544 page_cache_sync_readahead(mapping, ra, filp, index,
2545 last_index - index);
2546 filemap_get_read_batch(mapping, index, last_index, pvec);
2548 if (!pagevec_count(pvec)) {
2549 if (iocb->ki_flags & (IOCB_NOWAIT | IOCB_WAITQ))
2551 err = filemap_create_page(filp, mapping,
2552 iocb->ki_pos >> PAGE_SHIFT, pvec);
2553 if (err == AOP_TRUNCATED_PAGE)
2558 page = pvec->pages[pagevec_count(pvec) - 1];
2559 if (PageReadahead(page)) {
2560 err = filemap_readahead(iocb, filp, mapping, page, last_index);
2564 if (!PageUptodate(page)) {
2565 if ((iocb->ki_flags & IOCB_WAITQ) && pagevec_count(pvec) > 1)
2566 iocb->ki_flags |= IOCB_NOWAIT;
2567 err = filemap_update_page(iocb, mapping, iter, page);
2576 if (likely(--pvec->nr))
2578 if (err == AOP_TRUNCATED_PAGE)
2584 * filemap_read - Read data from the page cache.
2585 * @iocb: The iocb to read.
2586 * @iter: Destination for the data.
2587 * @already_read: Number of bytes already read by the caller.
2589 * Copies data from the page cache. If the data is not currently present,
2590 * uses the readahead and readpage address_space operations to fetch it.
2592 * Return: Total number of bytes copied, including those already read by
2593 * the caller. If an error happens before any bytes are copied, returns
2594 * a negative error number.
2596 ssize_t filemap_read(struct kiocb *iocb, struct iov_iter *iter,
2597 ssize_t already_read)
2599 struct file *filp = iocb->ki_filp;
2600 struct file_ra_state *ra = &filp->f_ra;
2601 struct address_space *mapping = filp->f_mapping;
2602 struct inode *inode = mapping->host;
2603 struct pagevec pvec;
2605 bool writably_mapped;
2606 loff_t isize, end_offset;
2608 if (unlikely(iocb->ki_pos >= inode->i_sb->s_maxbytes))
2610 if (unlikely(!iov_iter_count(iter)))
2613 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2614 pagevec_init(&pvec);
2620 * If we've already successfully copied some data, then we
2621 * can no longer safely return -EIOCBQUEUED. Hence mark
2622 * an async read NOWAIT at that point.
2624 if ((iocb->ki_flags & IOCB_WAITQ) && already_read)
2625 iocb->ki_flags |= IOCB_NOWAIT;
2627 error = filemap_get_pages(iocb, iter, &pvec);
2632 * i_size must be checked after we know the pages are Uptodate.
2634 * Checking i_size after the check allows us to calculate
2635 * the correct value for "nr", which means the zero-filled
2636 * part of the page is not copied back to userspace (unless
2637 * another truncate extends the file - this is desired though).
2639 isize = i_size_read(inode);
2640 if (unlikely(iocb->ki_pos >= isize))
2642 end_offset = min_t(loff_t, isize, iocb->ki_pos + iter->count);
2645 * Once we start copying data, we don't want to be touching any
2646 * cachelines that might be contended:
2648 writably_mapped = mapping_writably_mapped(mapping);
2651 * When a sequential read accesses a page several times, only
2652 * mark it as accessed the first time.
2654 if (iocb->ki_pos >> PAGE_SHIFT !=
2655 ra->prev_pos >> PAGE_SHIFT)
2656 mark_page_accessed(pvec.pages[0]);
2658 for (i = 0; i < pagevec_count(&pvec); i++) {
2659 struct page *page = pvec.pages[i];
2660 size_t page_size = thp_size(page);
2661 size_t offset = iocb->ki_pos & (page_size - 1);
2662 size_t bytes = min_t(loff_t, end_offset - iocb->ki_pos,
2663 page_size - offset);
2666 if (end_offset < page_offset(page))
2669 mark_page_accessed(page);
2671 * If users can be writing to this page using arbitrary
2672 * virtual addresses, take care about potential aliasing
2673 * before reading the page on the kernel side.
2675 if (writably_mapped) {
2678 for (j = 0; j < thp_nr_pages(page); j++)
2679 flush_dcache_page(page + j);
2682 copied = copy_page_to_iter(page, offset, bytes, iter);
2684 already_read += copied;
2685 iocb->ki_pos += copied;
2686 ra->prev_pos = iocb->ki_pos;
2688 if (copied < bytes) {
2694 for (i = 0; i < pagevec_count(&pvec); i++)
2695 put_page(pvec.pages[i]);
2696 pagevec_reinit(&pvec);
2697 } while (iov_iter_count(iter) && iocb->ki_pos < isize && !error);
2699 file_accessed(filp);
2701 return already_read ? already_read : error;
2703 EXPORT_SYMBOL_GPL(filemap_read);
2706 * generic_file_read_iter - generic filesystem read routine
2707 * @iocb: kernel I/O control block
2708 * @iter: destination for the data read
2710 * This is the "read_iter()" routine for all filesystems
2711 * that can use the page cache directly.
2713 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2714 * be returned when no data can be read without waiting for I/O requests
2715 * to complete; it doesn't prevent readahead.
2717 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2718 * requests shall be made for the read or for readahead. When no data
2719 * can be read, -EAGAIN shall be returned. When readahead would be
2720 * triggered, a partial, possibly empty read shall be returned.
2723 * * number of bytes copied, even for partial reads
2724 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
2727 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
2729 size_t count = iov_iter_count(iter);
2733 return 0; /* skip atime */
2735 if (iocb->ki_flags & IOCB_DIRECT) {
2736 struct file *file = iocb->ki_filp;
2737 struct address_space *mapping = file->f_mapping;
2738 struct inode *inode = mapping->host;
2741 size = i_size_read(inode);
2742 if (iocb->ki_flags & IOCB_NOWAIT) {
2743 if (filemap_range_needs_writeback(mapping, iocb->ki_pos,
2744 iocb->ki_pos + count - 1))
2747 retval = filemap_write_and_wait_range(mapping,
2749 iocb->ki_pos + count - 1);
2754 file_accessed(file);
2756 retval = mapping->a_ops->direct_IO(iocb, iter);
2758 iocb->ki_pos += retval;
2761 if (retval != -EIOCBQUEUED)
2762 iov_iter_revert(iter, count - iov_iter_count(iter));
2765 * Btrfs can have a short DIO read if we encounter
2766 * compressed extents, so if there was an error, or if
2767 * we've already read everything we wanted to, or if
2768 * there was a short read because we hit EOF, go ahead
2769 * and return. Otherwise fallthrough to buffered io for
2770 * the rest of the read. Buffered reads will not work for
2771 * DAX files, so don't bother trying.
2773 if (retval < 0 || !count || iocb->ki_pos >= size ||
2778 return filemap_read(iocb, iter, retval);
2780 EXPORT_SYMBOL(generic_file_read_iter);
2782 static inline loff_t page_seek_hole_data(struct xa_state *xas,
2783 struct address_space *mapping, struct page *page,
2784 loff_t start, loff_t end, bool seek_data)
2786 const struct address_space_operations *ops = mapping->a_ops;
2787 size_t offset, bsz = i_blocksize(mapping->host);
2789 if (xa_is_value(page) || PageUptodate(page))
2790 return seek_data ? start : end;
2791 if (!ops->is_partially_uptodate)
2792 return seek_data ? end : start;
2797 if (unlikely(page->mapping != mapping))
2800 offset = offset_in_thp(page, start) & ~(bsz - 1);
2803 if (ops->is_partially_uptodate(page, offset, bsz) == seek_data)
2805 start = (start + bsz) & ~(bsz - 1);
2807 } while (offset < thp_size(page));
2815 unsigned int seek_page_size(struct xa_state *xas, struct page *page)
2817 if (xa_is_value(page))
2818 return PAGE_SIZE << xa_get_order(xas->xa, xas->xa_index);
2819 return thp_size(page);
2823 * mapping_seek_hole_data - Seek for SEEK_DATA / SEEK_HOLE in the page cache.
2824 * @mapping: Address space to search.
2825 * @start: First byte to consider.
2826 * @end: Limit of search (exclusive).
2827 * @whence: Either SEEK_HOLE or SEEK_DATA.
2829 * If the page cache knows which blocks contain holes and which blocks
2830 * contain data, your filesystem can use this function to implement
2831 * SEEK_HOLE and SEEK_DATA. This is useful for filesystems which are
2832 * entirely memory-based such as tmpfs, and filesystems which support
2833 * unwritten extents.
2835 * Return: The requested offset on success, or -ENXIO if @whence specifies
2836 * SEEK_DATA and there is no data after @start. There is an implicit hole
2837 * after @end - 1, so SEEK_HOLE returns @end if all the bytes between @start
2838 * and @end contain data.
2840 loff_t mapping_seek_hole_data(struct address_space *mapping, loff_t start,
2841 loff_t end, int whence)
2843 XA_STATE(xas, &mapping->i_pages, start >> PAGE_SHIFT);
2844 pgoff_t max = (end - 1) >> PAGE_SHIFT;
2845 bool seek_data = (whence == SEEK_DATA);
2852 while ((page = find_get_entry(&xas, max, XA_PRESENT))) {
2853 loff_t pos = (u64)xas.xa_index << PAGE_SHIFT;
2854 unsigned int seek_size;
2862 seek_size = seek_page_size(&xas, page);
2863 pos = round_up(pos + 1, seek_size);
2864 start = page_seek_hole_data(&xas, mapping, page, start, pos,
2870 if (seek_size > PAGE_SIZE)
2871 xas_set(&xas, pos >> PAGE_SHIFT);
2872 if (!xa_is_value(page))
2879 if (page && !xa_is_value(page))
2887 #define MMAP_LOTSAMISS (100)
2889 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
2890 * @vmf - the vm_fault for this fault.
2891 * @page - the page to lock.
2892 * @fpin - the pointer to the file we may pin (or is already pinned).
2894 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
2895 * It differs in that it actually returns the page locked if it returns 1 and 0
2896 * if it couldn't lock the page. If we did have to drop the mmap_lock then fpin
2897 * will point to the pinned file and needs to be fput()'ed at a later point.
2899 static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2902 if (trylock_page(page))
2906 * NOTE! This will make us return with VM_FAULT_RETRY, but with
2907 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
2908 * is supposed to work. We have way too many special cases..
2910 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2913 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2914 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2915 if (__lock_page_killable(page)) {
2917 * We didn't have the right flags to drop the mmap_lock,
2918 * but all fault_handlers only check for fatal signals
2919 * if we return VM_FAULT_RETRY, so we need to drop the
2920 * mmap_lock here and return 0 if we don't have a fpin.
2923 mmap_read_unlock(vmf->vma->vm_mm);
2933 * Synchronous readahead happens when we don't even find a page in the page
2934 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2935 * to drop the mmap sem we return the file that was pinned in order for us to do
2936 * that. If we didn't pin a file then we return NULL. The file that is
2937 * returned needs to be fput()'ed when we're done with it.
2939 static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
2941 struct file *file = vmf->vma->vm_file;
2942 struct file_ra_state *ra = &file->f_ra;
2943 struct address_space *mapping = file->f_mapping;
2944 DEFINE_READAHEAD(ractl, file, ra, mapping, vmf->pgoff);
2945 struct file *fpin = NULL;
2946 unsigned int mmap_miss;
2948 /* If we don't want any read-ahead, don't bother */
2949 if (vmf->vma->vm_flags & VM_RAND_READ)
2954 if (vmf->vma->vm_flags & VM_SEQ_READ) {
2955 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2956 page_cache_sync_ra(&ractl, ra->ra_pages);
2960 /* Avoid banging the cache line if not needed */
2961 mmap_miss = READ_ONCE(ra->mmap_miss);
2962 if (mmap_miss < MMAP_LOTSAMISS * 10)
2963 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
2966 * Do we miss much more than hit in this file? If so,
2967 * stop bothering with read-ahead. It will only hurt.
2969 if (mmap_miss > MMAP_LOTSAMISS)
2975 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2976 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
2977 ra->size = ra->ra_pages;
2978 ra->async_size = ra->ra_pages / 4;
2979 ractl._index = ra->start;
2980 do_page_cache_ra(&ractl, ra->size, ra->async_size);
2985 * Asynchronous readahead happens when we find the page and PG_readahead,
2986 * so we want to possibly extend the readahead further. We return the file that
2987 * was pinned if we have to drop the mmap_lock in order to do IO.
2989 static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2992 struct file *file = vmf->vma->vm_file;
2993 struct file_ra_state *ra = &file->f_ra;
2994 struct address_space *mapping = file->f_mapping;
2995 struct file *fpin = NULL;
2996 unsigned int mmap_miss;
2997 pgoff_t offset = vmf->pgoff;
2999 /* If we don't want any read-ahead, don't bother */
3000 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
3002 mmap_miss = READ_ONCE(ra->mmap_miss);
3004 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
3005 if (PageReadahead(page)) {
3006 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
3007 page_cache_async_readahead(mapping, ra, file,
3008 page, offset, ra->ra_pages);
3014 * filemap_fault - read in file data for page fault handling
3015 * @vmf: struct vm_fault containing details of the fault
3017 * filemap_fault() is invoked via the vma operations vector for a
3018 * mapped memory region to read in file data during a page fault.
3020 * The goto's are kind of ugly, but this streamlines the normal case of having
3021 * it in the page cache, and handles the special cases reasonably without
3022 * having a lot of duplicated code.
3024 * vma->vm_mm->mmap_lock must be held on entry.
3026 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
3027 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
3029 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
3030 * has not been released.
3032 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
3034 * Return: bitwise-OR of %VM_FAULT_ codes.
3036 vm_fault_t filemap_fault(struct vm_fault *vmf)
3039 struct file *file = vmf->vma->vm_file;
3040 struct file *fpin = NULL;
3041 struct address_space *mapping = file->f_mapping;
3042 struct inode *inode = mapping->host;
3043 pgoff_t offset = vmf->pgoff;
3047 bool mapping_locked = false;
3049 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3050 if (unlikely(offset >= max_off))
3051 return VM_FAULT_SIGBUS;
3054 * Do we have something in the page cache already?
3056 page = find_get_page(mapping, offset);
3059 * We found the page, so try async readahead before waiting for
3062 if (!(vmf->flags & FAULT_FLAG_TRIED))
3063 fpin = do_async_mmap_readahead(vmf, page);
3064 if (unlikely(!PageUptodate(page))) {
3065 filemap_invalidate_lock_shared(mapping);
3066 mapping_locked = true;
3069 /* No page in the page cache at all */
3070 count_vm_event(PGMAJFAULT);
3071 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
3072 ret = VM_FAULT_MAJOR;
3073 fpin = do_sync_mmap_readahead(vmf);
3076 * See comment in filemap_create_page() why we need
3079 if (!mapping_locked) {
3080 filemap_invalidate_lock_shared(mapping);
3081 mapping_locked = true;
3083 page = pagecache_get_page(mapping, offset,
3084 FGP_CREAT|FGP_FOR_MMAP,
3089 filemap_invalidate_unlock_shared(mapping);
3090 return VM_FAULT_OOM;
3094 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
3097 /* Did it get truncated? */
3098 if (unlikely(compound_head(page)->mapping != mapping)) {
3103 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
3106 * We have a locked page in the page cache, now we need to check
3107 * that it's up-to-date. If not, it is going to be due to an error.
3109 if (unlikely(!PageUptodate(page))) {
3111 * The page was in cache and uptodate and now it is not.
3112 * Strange but possible since we didn't hold the page lock all
3113 * the time. Let's drop everything get the invalidate lock and
3116 if (!mapping_locked) {
3121 goto page_not_uptodate;
3125 * We've made it this far and we had to drop our mmap_lock, now is the
3126 * time to return to the upper layer and have it re-find the vma and
3134 filemap_invalidate_unlock_shared(mapping);
3137 * Found the page and have a reference on it.
3138 * We must recheck i_size under page lock.
3140 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
3141 if (unlikely(offset >= max_off)) {
3144 return VM_FAULT_SIGBUS;
3148 return ret | VM_FAULT_LOCKED;
3152 * Umm, take care of errors if the page isn't up-to-date.
3153 * Try to re-read it _once_. We do this synchronously,
3154 * because there really aren't any performance issues here
3155 * and we need to check for errors.
3157 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
3158 error = filemap_read_page(file, mapping, page);
3163 if (!error || error == AOP_TRUNCATED_PAGE)
3165 filemap_invalidate_unlock_shared(mapping);
3167 return VM_FAULT_SIGBUS;
3171 * We dropped the mmap_lock, we need to return to the fault handler to
3172 * re-find the vma and come back and find our hopefully still populated
3178 filemap_invalidate_unlock_shared(mapping);
3181 return ret | VM_FAULT_RETRY;
3183 EXPORT_SYMBOL(filemap_fault);
3185 static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
3187 struct mm_struct *mm = vmf->vma->vm_mm;
3189 /* Huge page is mapped? No need to proceed. */
3190 if (pmd_trans_huge(*vmf->pmd)) {
3196 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
3197 vm_fault_t ret = do_set_pmd(vmf, page);
3199 /* The page is mapped successfully, reference consumed. */
3205 if (pmd_none(*vmf->pmd)) {
3206 vmf->ptl = pmd_lock(mm, vmf->pmd);
3207 if (likely(pmd_none(*vmf->pmd))) {
3209 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
3210 vmf->prealloc_pte = NULL;
3212 spin_unlock(vmf->ptl);
3215 /* See comment in handle_pte_fault() */
3216 if (pmd_devmap_trans_unstable(vmf->pmd)) {
3225 static struct page *next_uptodate_page(struct page *page,
3226 struct address_space *mapping,
3227 struct xa_state *xas, pgoff_t end_pgoff)
3229 unsigned long max_idx;
3234 if (xas_retry(xas, page))
3236 if (xa_is_value(page))
3238 if (PageLocked(page))
3240 if (!page_cache_get_speculative(page))
3242 /* Has the page moved or been split? */
3243 if (unlikely(page != xas_reload(xas)))
3245 if (!PageUptodate(page) || PageReadahead(page))
3247 if (PageHWPoison(page))
3249 if (!trylock_page(page))
3251 if (page->mapping != mapping)
3253 if (!PageUptodate(page))
3255 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
3256 if (xas->xa_index >= max_idx)
3263 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
3268 static inline struct page *first_map_page(struct address_space *mapping,
3269 struct xa_state *xas,
3272 return next_uptodate_page(xas_find(xas, end_pgoff),
3273 mapping, xas, end_pgoff);
3276 static inline struct page *next_map_page(struct address_space *mapping,
3277 struct xa_state *xas,
3280 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
3281 mapping, xas, end_pgoff);
3284 vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3285 pgoff_t start_pgoff, pgoff_t end_pgoff)
3287 struct vm_area_struct *vma = vmf->vma;
3288 struct file *file = vma->vm_file;
3289 struct address_space *mapping = file->f_mapping;
3290 pgoff_t last_pgoff = start_pgoff;
3292 XA_STATE(xas, &mapping->i_pages, start_pgoff);
3293 struct page *head, *page;
3294 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
3298 head = first_map_page(mapping, &xas, end_pgoff);
3302 if (filemap_map_pmd(vmf, head)) {
3303 ret = VM_FAULT_NOPAGE;
3307 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3308 vmf->pte = pte_offset_map_lock(vma->vm_mm, vmf->pmd, addr, &vmf->ptl);
3310 page = find_subpage(head, xas.xa_index);
3311 if (PageHWPoison(page))
3317 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
3318 vmf->pte += xas.xa_index - last_pgoff;
3319 last_pgoff = xas.xa_index;
3321 if (!pte_none(*vmf->pte))
3324 /* We're about to handle the fault */
3325 if (vmf->address == addr)
3326 ret = VM_FAULT_NOPAGE;
3328 do_set_pte(vmf, page, addr);
3329 /* no need to invalidate: a not-present page won't be cached */
3330 update_mmu_cache(vma, addr, vmf->pte);
3336 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3337 pte_unmap_unlock(vmf->pte, vmf->ptl);
3340 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
3343 EXPORT_SYMBOL(filemap_map_pages);
3345 vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
3347 struct address_space *mapping = vmf->vma->vm_file->f_mapping;
3348 struct page *page = vmf->page;
3349 vm_fault_t ret = VM_FAULT_LOCKED;
3351 sb_start_pagefault(mapping->host->i_sb);
3352 file_update_time(vmf->vma->vm_file);
3354 if (page->mapping != mapping) {
3356 ret = VM_FAULT_NOPAGE;
3360 * We mark the page dirty already here so that when freeze is in
3361 * progress, we are guaranteed that writeback during freezing will
3362 * see the dirty page and writeprotect it again.
3364 set_page_dirty(page);
3365 wait_for_stable_page(page);
3367 sb_end_pagefault(mapping->host->i_sb);
3371 const struct vm_operations_struct generic_file_vm_ops = {
3372 .fault = filemap_fault,
3373 .map_pages = filemap_map_pages,
3374 .page_mkwrite = filemap_page_mkwrite,
3377 /* This is used for a general mmap of a disk file */
3379 int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
3381 struct address_space *mapping = file->f_mapping;
3383 if (!mapping->a_ops->readpage)
3385 file_accessed(file);
3386 vma->vm_ops = &generic_file_vm_ops;
3391 * This is for filesystems which do not implement ->writepage.
3393 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3395 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3397 return generic_file_mmap(file, vma);
3400 vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
3402 return VM_FAULT_SIGBUS;
3404 int generic_file_mmap(struct file *file, struct vm_area_struct *vma)
3408 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3412 #endif /* CONFIG_MMU */
3414 EXPORT_SYMBOL(filemap_page_mkwrite);
3415 EXPORT_SYMBOL(generic_file_mmap);
3416 EXPORT_SYMBOL(generic_file_readonly_mmap);
3418 static struct page *wait_on_page_read(struct page *page)
3420 if (!IS_ERR(page)) {
3421 wait_on_page_locked(page);
3422 if (!PageUptodate(page)) {
3424 page = ERR_PTR(-EIO);
3430 static struct page *do_read_cache_page(struct address_space *mapping,
3432 int (*filler)(void *, struct page *),
3439 page = find_get_page(mapping, index);
3441 page = __page_cache_alloc(gfp);
3443 return ERR_PTR(-ENOMEM);
3444 err = add_to_page_cache_lru(page, mapping, index, gfp);
3445 if (unlikely(err)) {
3449 /* Presumably ENOMEM for xarray node */
3450 return ERR_PTR(err);
3455 err = filler(data, page);
3457 err = mapping->a_ops->readpage(data, page);
3461 return ERR_PTR(err);
3464 page = wait_on_page_read(page);
3469 if (PageUptodate(page))
3473 * Page is not up to date and may be locked due to one of the following
3474 * case a: Page is being filled and the page lock is held
3475 * case b: Read/write error clearing the page uptodate status
3476 * case c: Truncation in progress (page locked)
3477 * case d: Reclaim in progress
3479 * Case a, the page will be up to date when the page is unlocked.
3480 * There is no need to serialise on the page lock here as the page
3481 * is pinned so the lock gives no additional protection. Even if the
3482 * page is truncated, the data is still valid if PageUptodate as
3483 * it's a race vs truncate race.
3484 * Case b, the page will not be up to date
3485 * Case c, the page may be truncated but in itself, the data may still
3486 * be valid after IO completes as it's a read vs truncate race. The
3487 * operation must restart if the page is not uptodate on unlock but
3488 * otherwise serialising on page lock to stabilise the mapping gives
3489 * no additional guarantees to the caller as the page lock is
3490 * released before return.
3491 * Case d, similar to truncation. If reclaim holds the page lock, it
3492 * will be a race with remove_mapping that determines if the mapping
3493 * is valid on unlock but otherwise the data is valid and there is
3494 * no need to serialise with page lock.
3496 * As the page lock gives no additional guarantee, we optimistically
3497 * wait on the page to be unlocked and check if it's up to date and
3498 * use the page if it is. Otherwise, the page lock is required to
3499 * distinguish between the different cases. The motivation is that we
3500 * avoid spurious serialisations and wakeups when multiple processes
3501 * wait on the same page for IO to complete.
3503 wait_on_page_locked(page);
3504 if (PageUptodate(page))
3507 /* Distinguish between all the cases under the safety of the lock */
3510 /* Case c or d, restart the operation */
3511 if (!page->mapping) {
3517 /* Someone else locked and filled the page in a very small window */
3518 if (PageUptodate(page)) {
3524 * A previous I/O error may have been due to temporary
3526 * Clear page error before actual read, PG_error will be
3527 * set again if read page fails.
3529 ClearPageError(page);
3533 mark_page_accessed(page);
3538 * read_cache_page - read into page cache, fill it if needed
3539 * @mapping: the page's address_space
3540 * @index: the page index
3541 * @filler: function to perform the read
3542 * @data: first arg to filler(data, page) function, often left as NULL
3544 * Read into the page cache. If a page already exists, and PageUptodate() is
3545 * not set, try to fill the page and wait for it to become unlocked.
3547 * If the page does not get brought uptodate, return -EIO.
3549 * The function expects mapping->invalidate_lock to be already held.
3551 * Return: up to date page on success, ERR_PTR() on failure.
3553 struct page *read_cache_page(struct address_space *mapping,
3555 int (*filler)(void *, struct page *),
3558 return do_read_cache_page(mapping, index, filler, data,
3559 mapping_gfp_mask(mapping));
3561 EXPORT_SYMBOL(read_cache_page);
3564 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3565 * @mapping: the page's address_space
3566 * @index: the page index
3567 * @gfp: the page allocator flags to use if allocating
3569 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
3570 * any new page allocations done using the specified allocation flags.
3572 * If the page does not get brought uptodate, return -EIO.
3574 * The function expects mapping->invalidate_lock to be already held.
3576 * Return: up to date page on success, ERR_PTR() on failure.
3578 struct page *read_cache_page_gfp(struct address_space *mapping,
3582 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
3584 EXPORT_SYMBOL(read_cache_page_gfp);
3586 int pagecache_write_begin(struct file *file, struct address_space *mapping,
3587 loff_t pos, unsigned len, unsigned flags,
3588 struct page **pagep, void **fsdata)
3590 const struct address_space_operations *aops = mapping->a_ops;
3592 return aops->write_begin(file, mapping, pos, len, flags,
3595 EXPORT_SYMBOL(pagecache_write_begin);
3597 int pagecache_write_end(struct file *file, struct address_space *mapping,
3598 loff_t pos, unsigned len, unsigned copied,
3599 struct page *page, void *fsdata)
3601 const struct address_space_operations *aops = mapping->a_ops;
3603 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
3605 EXPORT_SYMBOL(pagecache_write_end);
3608 * Warn about a page cache invalidation failure during a direct I/O write.
3610 void dio_warn_stale_pagecache(struct file *filp)
3612 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3616 errseq_set(&filp->f_mapping->wb_err, -EIO);
3617 if (__ratelimit(&_rs)) {
3618 path = file_path(filp, pathname, sizeof(pathname));
3621 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3622 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3628 generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
3630 struct file *file = iocb->ki_filp;
3631 struct address_space *mapping = file->f_mapping;
3632 struct inode *inode = mapping->host;
3633 loff_t pos = iocb->ki_pos;
3638 write_len = iov_iter_count(from);
3639 end = (pos + write_len - 1) >> PAGE_SHIFT;
3641 if (iocb->ki_flags & IOCB_NOWAIT) {
3642 /* If there are pages to writeback, return */
3643 if (filemap_range_has_page(file->f_mapping, pos,
3644 pos + write_len - 1))
3647 written = filemap_write_and_wait_range(mapping, pos,
3648 pos + write_len - 1);
3654 * After a write we want buffered reads to be sure to go to disk to get
3655 * the new data. We invalidate clean cached page from the region we're
3656 * about to write. We do this *before* the write so that we can return
3657 * without clobbering -EIOCBQUEUED from ->direct_IO().
3659 written = invalidate_inode_pages2_range(mapping,
3660 pos >> PAGE_SHIFT, end);
3662 * If a page can not be invalidated, return 0 to fall back
3663 * to buffered write.
3666 if (written == -EBUSY)
3671 written = mapping->a_ops->direct_IO(iocb, from);
3674 * Finally, try again to invalidate clean pages which might have been
3675 * cached by non-direct readahead, or faulted in by get_user_pages()
3676 * if the source of the write was an mmap'ed region of the file
3677 * we're writing. Either one is a pretty crazy thing to do,
3678 * so we don't support it 100%. If this invalidation
3679 * fails, tough, the write still worked...
3681 * Most of the time we do not need this since dio_complete() will do
3682 * the invalidation for us. However there are some file systems that
3683 * do not end up with dio_complete() being called, so let's not break
3684 * them by removing it completely.
3686 * Noticeable example is a blkdev_direct_IO().
3688 * Skip invalidation for async writes or if mapping has no pages.
3690 if (written > 0 && mapping->nrpages &&
3691 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3692 dio_warn_stale_pagecache(file);
3696 write_len -= written;
3697 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3698 i_size_write(inode, pos);
3699 mark_inode_dirty(inode);
3703 if (written != -EIOCBQUEUED)
3704 iov_iter_revert(from, write_len - iov_iter_count(from));
3708 EXPORT_SYMBOL(generic_file_direct_write);
3711 * Find or create a page at the given pagecache position. Return the locked
3712 * page. This function is specifically for buffered writes.
3714 struct page *grab_cache_page_write_begin(struct address_space *mapping,
3715 pgoff_t index, unsigned flags)
3718 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
3720 if (flags & AOP_FLAG_NOFS)
3721 fgp_flags |= FGP_NOFS;
3723 page = pagecache_get_page(mapping, index, fgp_flags,
3724 mapping_gfp_mask(mapping));
3726 wait_for_stable_page(page);
3730 EXPORT_SYMBOL(grab_cache_page_write_begin);
3732 ssize_t generic_perform_write(struct file *file,
3733 struct iov_iter *i, loff_t pos)
3735 struct address_space *mapping = file->f_mapping;
3736 const struct address_space_operations *a_ops = mapping->a_ops;
3738 ssize_t written = 0;
3739 unsigned int flags = 0;
3743 unsigned long offset; /* Offset into pagecache page */
3744 unsigned long bytes; /* Bytes to write to page */
3745 size_t copied; /* Bytes copied from user */
3748 offset = (pos & (PAGE_SIZE - 1));
3749 bytes = min_t(unsigned long, PAGE_SIZE - offset,
3754 * Bring in the user page that we will copy from _first_.
3755 * Otherwise there's a nasty deadlock on copying from the
3756 * same page as we're writing to, without it being marked
3759 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3764 if (fatal_signal_pending(current)) {
3769 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
3771 if (unlikely(status < 0))
3774 if (mapping_writably_mapped(mapping))
3775 flush_dcache_page(page);
3777 copied = copy_page_from_iter_atomic(page, offset, bytes, i);
3778 flush_dcache_page(page);
3780 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3782 if (unlikely(status != copied)) {
3783 iov_iter_revert(i, copied - max(status, 0L));
3784 if (unlikely(status < 0))
3789 if (unlikely(status == 0)) {
3791 * A short copy made ->write_end() reject the
3792 * thing entirely. Might be memory poisoning
3793 * halfway through, might be a race with munmap,
3794 * might be severe memory pressure.
3803 balance_dirty_pages_ratelimited(mapping);
3804 } while (iov_iter_count(i));
3806 return written ? written : status;
3808 EXPORT_SYMBOL(generic_perform_write);
3811 * __generic_file_write_iter - write data to a file
3812 * @iocb: IO state structure (file, offset, etc.)
3813 * @from: iov_iter with data to write
3815 * This function does all the work needed for actually writing data to a
3816 * file. It does all basic checks, removes SUID from the file, updates
3817 * modification times and calls proper subroutines depending on whether we
3818 * do direct IO or a standard buffered write.
3820 * It expects i_rwsem to be grabbed unless we work on a block device or similar
3821 * object which does not need locking at all.
3823 * This function does *not* take care of syncing data in case of O_SYNC write.
3824 * A caller has to handle it. This is mainly due to the fact that we want to
3825 * avoid syncing under i_rwsem.
3828 * * number of bytes written, even for truncated writes
3829 * * negative error code if no data has been written at all
3831 ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3833 struct file *file = iocb->ki_filp;
3834 struct address_space *mapping = file->f_mapping;
3835 struct inode *inode = mapping->host;
3836 ssize_t written = 0;
3840 /* We can write back this queue in page reclaim */
3841 current->backing_dev_info = inode_to_bdi(inode);
3842 err = file_remove_privs(file);
3846 err = file_update_time(file);
3850 if (iocb->ki_flags & IOCB_DIRECT) {
3851 loff_t pos, endbyte;
3853 written = generic_file_direct_write(iocb, from);
3855 * If the write stopped short of completing, fall back to
3856 * buffered writes. Some filesystems do this for writes to
3857 * holes, for example. For DAX files, a buffered write will
3858 * not succeed (even if it did, DAX does not handle dirty
3859 * page-cache pages correctly).
3861 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
3864 status = generic_perform_write(file, from, pos = iocb->ki_pos);
3866 * If generic_perform_write() returned a synchronous error
3867 * then we want to return the number of bytes which were
3868 * direct-written, or the error code if that was zero. Note
3869 * that this differs from normal direct-io semantics, which
3870 * will return -EFOO even if some bytes were written.
3872 if (unlikely(status < 0)) {
3877 * We need to ensure that the page cache pages are written to
3878 * disk and invalidated to preserve the expected O_DIRECT
3881 endbyte = pos + status - 1;
3882 err = filemap_write_and_wait_range(mapping, pos, endbyte);
3884 iocb->ki_pos = endbyte + 1;
3886 invalidate_mapping_pages(mapping,
3888 endbyte >> PAGE_SHIFT);
3891 * We don't know how much we wrote, so just return
3892 * the number of bytes which were direct-written
3896 written = generic_perform_write(file, from, iocb->ki_pos);
3897 if (likely(written > 0))
3898 iocb->ki_pos += written;
3901 current->backing_dev_info = NULL;
3902 return written ? written : err;
3904 EXPORT_SYMBOL(__generic_file_write_iter);
3907 * generic_file_write_iter - write data to a file
3908 * @iocb: IO state structure
3909 * @from: iov_iter with data to write
3911 * This is a wrapper around __generic_file_write_iter() to be used by most
3912 * filesystems. It takes care of syncing the file in case of O_SYNC file
3913 * and acquires i_rwsem as needed.
3915 * * negative error code if no data has been written at all of
3916 * vfs_fsync_range() failed for a synchronous write
3917 * * number of bytes written, even for truncated writes
3919 ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3921 struct file *file = iocb->ki_filp;
3922 struct inode *inode = file->f_mapping->host;
3926 ret = generic_write_checks(iocb, from);
3928 ret = __generic_file_write_iter(iocb, from);
3929 inode_unlock(inode);
3932 ret = generic_write_sync(iocb, ret);
3935 EXPORT_SYMBOL(generic_file_write_iter);
3938 * try_to_release_page() - release old fs-specific metadata on a page
3940 * @page: the page which the kernel is trying to free
3941 * @gfp_mask: memory allocation flags (and I/O mode)
3943 * The address_space is to try to release any data against the page
3944 * (presumably at page->private).
3946 * This may also be called if PG_fscache is set on a page, indicating that the
3947 * page is known to the local caching routines.
3949 * The @gfp_mask argument specifies whether I/O may be performed to release
3950 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
3952 * Return: %1 if the release was successful, otherwise return zero.
3954 int try_to_release_page(struct page *page, gfp_t gfp_mask)
3956 struct address_space * const mapping = page->mapping;
3958 BUG_ON(!PageLocked(page));
3959 if (PageWriteback(page))
3962 if (mapping && mapping->a_ops->releasepage)
3963 return mapping->a_ops->releasepage(page, gfp_mask);
3964 return try_to_free_buffers(page);
3967 EXPORT_SYMBOL(try_to_release_page);