4 * Copyright (C) 1994-1999 Linus Torvalds
8 * This file handles the generic file mmap semantics used by
9 * most "normal" filesystems (but you don't /have/ to use this:
10 * the NFS filesystem used to do this differently, for example)
12 #include <linux/export.h>
13 #include <linux/compiler.h>
14 #include <linux/dax.h>
16 #include <linux/sched/signal.h>
17 #include <linux/uaccess.h>
18 #include <linux/capability.h>
19 #include <linux/kernel_stat.h>
20 #include <linux/gfp.h>
22 #include <linux/swap.h>
23 #include <linux/mman.h>
24 #include <linux/pagemap.h>
25 #include <linux/file.h>
26 #include <linux/uio.h>
27 #include <linux/hash.h>
28 #include <linux/writeback.h>
29 #include <linux/backing-dev.h>
30 #include <linux/pagevec.h>
31 #include <linux/blkdev.h>
32 #include <linux/security.h>
33 #include <linux/cpuset.h>
34 #include <linux/hugetlb.h>
35 #include <linux/memcontrol.h>
36 #include <linux/cleancache.h>
37 #include <linux/shmem_fs.h>
38 #include <linux/rmap.h>
41 #define CREATE_TRACE_POINTS
42 #include <trace/events/filemap.h>
45 * FIXME: remove all knowledge of the buffer layer from the core VM
47 #include <linux/buffer_head.h> /* for try_to_free_buffers */
52 * Shared mappings implemented 30.11.1994. It's not fully working yet,
55 * Shared mappings now work. 15.8.1995 Bruno.
57 * finished 'unifying' the page and buffer cache and SMP-threaded the
66 * ->i_mmap_rwsem (truncate_pagecache)
67 * ->private_lock (__free_pte->__set_page_dirty_buffers)
68 * ->swap_lock (exclusive_swap_page, others)
72 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
76 * ->page_table_lock or pte_lock (various, mainly in memory.c)
77 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
80 * ->lock_page (access_process_vm)
82 * ->i_mutex (generic_perform_write)
83 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
86 * sb_lock (fs/fs-writeback.c)
87 * ->i_pages lock (__sync_single_inode)
90 * ->anon_vma.lock (vma_adjust)
93 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
95 * ->page_table_lock or pte_lock
96 * ->swap_lock (try_to_unmap_one)
97 * ->private_lock (try_to_unmap_one)
98 * ->i_pages lock (try_to_unmap_one)
99 * ->zone_lru_lock(zone) (follow_page->mark_page_accessed)
100 * ->zone_lru_lock(zone) (check_pte_range->isolate_lru_page)
101 * ->private_lock (page_remove_rmap->set_page_dirty)
102 * ->i_pages lock (page_remove_rmap->set_page_dirty)
103 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
104 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
105 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
106 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
107 * ->inode->i_lock (zap_pte_range->set_page_dirty)
108 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
111 * ->tasklist_lock (memory_failure, collect_procs_ao)
114 static int page_cache_tree_insert(struct address_space *mapping,
115 struct page *page, void **shadowp)
117 struct radix_tree_node *node;
121 error = __radix_tree_create(&mapping->i_pages, page->index, 0,
128 p = radix_tree_deref_slot_protected(slot,
129 &mapping->i_pages.xa_lock);
130 if (!radix_tree_exceptional_entry(p))
133 mapping->nrexceptional--;
137 __radix_tree_replace(&mapping->i_pages, node, slot, page,
138 workingset_lookup_update(mapping));
143 static void page_cache_tree_delete(struct address_space *mapping,
144 struct page *page, void *shadow)
148 /* hugetlb pages are represented by one entry in the radix tree */
149 nr = PageHuge(page) ? 1 : hpage_nr_pages(page);
151 VM_BUG_ON_PAGE(!PageLocked(page), page);
152 VM_BUG_ON_PAGE(PageTail(page), page);
153 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
155 for (i = 0; i < nr; i++) {
156 struct radix_tree_node *node;
159 __radix_tree_lookup(&mapping->i_pages, page->index + i,
162 VM_BUG_ON_PAGE(!node && nr != 1, page);
164 radix_tree_clear_tags(&mapping->i_pages, node, slot);
165 __radix_tree_replace(&mapping->i_pages, node, slot, shadow,
166 workingset_lookup_update(mapping));
169 page->mapping = NULL;
170 /* Leave page->index set: truncation lookup relies upon it */
173 mapping->nrexceptional += nr;
175 * Make sure the nrexceptional update is committed before
176 * the nrpages update so that final truncate racing
177 * with reclaim does not see both counters 0 at the
178 * same time and miss a shadow entry.
182 mapping->nrpages -= nr;
185 static void unaccount_page_cache_page(struct address_space *mapping,
191 * if we're uptodate, flush out into the cleancache, otherwise
192 * invalidate any existing cleancache entries. We can't leave
193 * stale data around in the cleancache once our page is gone
195 if (PageUptodate(page) && PageMappedToDisk(page))
196 cleancache_put_page(page);
198 cleancache_invalidate_page(mapping, page);
200 VM_BUG_ON_PAGE(PageTail(page), page);
201 VM_BUG_ON_PAGE(page_mapped(page), page);
202 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
205 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
206 current->comm, page_to_pfn(page));
207 dump_page(page, "still mapped when deleted");
209 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
211 mapcount = page_mapcount(page);
212 if (mapping_exiting(mapping) &&
213 page_count(page) >= mapcount + 2) {
215 * All vmas have already been torn down, so it's
216 * a good bet that actually the page is unmapped,
217 * and we'd prefer not to leak it: if we're wrong,
218 * some other bad page check should catch it later.
220 page_mapcount_reset(page);
221 page_ref_sub(page, mapcount);
225 /* hugetlb pages do not participate in page cache accounting. */
229 nr = hpage_nr_pages(page);
231 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
232 if (PageSwapBacked(page)) {
233 __mod_node_page_state(page_pgdat(page), NR_SHMEM, -nr);
234 if (PageTransHuge(page))
235 __dec_node_page_state(page, NR_SHMEM_THPS);
237 VM_BUG_ON_PAGE(PageTransHuge(page), page);
241 * At this point page must be either written or cleaned by
242 * truncate. Dirty page here signals a bug and loss of
245 * This fixes dirty accounting after removing the page entirely
246 * but leaves PageDirty set: it has no effect for truncated
247 * page and anyway will be cleared before returning page into
250 if (WARN_ON_ONCE(PageDirty(page)))
251 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
255 * Delete a page from the page cache and free it. Caller has to make
256 * sure the page is locked and that nobody else uses it - or that usage
257 * is safe. The caller must hold the i_pages lock.
259 void __delete_from_page_cache(struct page *page, void *shadow)
261 struct address_space *mapping = page->mapping;
263 trace_mm_filemap_delete_from_page_cache(page);
265 unaccount_page_cache_page(mapping, page);
266 page_cache_tree_delete(mapping, page, shadow);
269 static void page_cache_free_page(struct address_space *mapping,
272 void (*freepage)(struct page *);
274 freepage = mapping->a_ops->freepage;
278 if (PageTransHuge(page) && !PageHuge(page)) {
279 page_ref_sub(page, HPAGE_PMD_NR);
280 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
287 * delete_from_page_cache - delete page from page cache
288 * @page: the page which the kernel is trying to remove from page cache
290 * This must be called only on pages that have been verified to be in the page
291 * cache and locked. It will never put the page into the free list, the caller
292 * has a reference on the page.
294 void delete_from_page_cache(struct page *page)
296 struct address_space *mapping = page_mapping(page);
299 BUG_ON(!PageLocked(page));
300 xa_lock_irqsave(&mapping->i_pages, flags);
301 __delete_from_page_cache(page, NULL);
302 xa_unlock_irqrestore(&mapping->i_pages, flags);
304 page_cache_free_page(mapping, page);
306 EXPORT_SYMBOL(delete_from_page_cache);
309 * page_cache_tree_delete_batch - delete several pages from page cache
310 * @mapping: the mapping to which pages belong
311 * @pvec: pagevec with pages to delete
313 * The function walks over mapping->i_pages and removes pages passed in @pvec
314 * from the mapping. The function expects @pvec to be sorted by page index.
315 * It tolerates holes in @pvec (mapping entries at those indices are not
316 * modified). The function expects only THP head pages to be present in the
317 * @pvec and takes care to delete all corresponding tail pages from the
320 * The function expects the i_pages lock to be held.
323 page_cache_tree_delete_batch(struct address_space *mapping,
324 struct pagevec *pvec)
326 struct radix_tree_iter iter;
329 int i = 0, tail_pages = 0;
333 start = pvec->pages[0]->index;
334 radix_tree_for_each_slot(slot, &mapping->i_pages, &iter, start) {
335 if (i >= pagevec_count(pvec) && !tail_pages)
337 page = radix_tree_deref_slot_protected(slot,
338 &mapping->i_pages.xa_lock);
339 if (radix_tree_exceptional_entry(page))
343 * Some page got inserted in our range? Skip it. We
344 * have our pages locked so they are protected from
347 if (page != pvec->pages[i])
349 WARN_ON_ONCE(!PageLocked(page));
350 if (PageTransHuge(page) && !PageHuge(page))
351 tail_pages = HPAGE_PMD_NR - 1;
352 page->mapping = NULL;
354 * Leave page->index set: truncation lookup relies
361 radix_tree_clear_tags(&mapping->i_pages, iter.node, slot);
362 __radix_tree_replace(&mapping->i_pages, iter.node, slot, NULL,
363 workingset_lookup_update(mapping));
366 mapping->nrpages -= total_pages;
369 void delete_from_page_cache_batch(struct address_space *mapping,
370 struct pagevec *pvec)
375 if (!pagevec_count(pvec))
378 xa_lock_irqsave(&mapping->i_pages, flags);
379 for (i = 0; i < pagevec_count(pvec); i++) {
380 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
382 unaccount_page_cache_page(mapping, pvec->pages[i]);
384 page_cache_tree_delete_batch(mapping, pvec);
385 xa_unlock_irqrestore(&mapping->i_pages, flags);
387 for (i = 0; i < pagevec_count(pvec); i++)
388 page_cache_free_page(mapping, pvec->pages[i]);
391 int filemap_check_errors(struct address_space *mapping)
394 /* Check for outstanding write errors */
395 if (test_bit(AS_ENOSPC, &mapping->flags) &&
396 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
398 if (test_bit(AS_EIO, &mapping->flags) &&
399 test_and_clear_bit(AS_EIO, &mapping->flags))
403 EXPORT_SYMBOL(filemap_check_errors);
405 static int filemap_check_and_keep_errors(struct address_space *mapping)
407 /* Check for outstanding write errors */
408 if (test_bit(AS_EIO, &mapping->flags))
410 if (test_bit(AS_ENOSPC, &mapping->flags))
416 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
417 * @mapping: address space structure to write
418 * @start: offset in bytes where the range starts
419 * @end: offset in bytes where the range ends (inclusive)
420 * @sync_mode: enable synchronous operation
422 * Start writeback against all of a mapping's dirty pages that lie
423 * within the byte offsets <start, end> inclusive.
425 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
426 * opposed to a regular memory cleansing writeback. The difference between
427 * these two operations is that if a dirty page/buffer is encountered, it must
428 * be waited upon, and not just skipped over.
430 int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
431 loff_t end, int sync_mode)
434 struct writeback_control wbc = {
435 .sync_mode = sync_mode,
436 .nr_to_write = LONG_MAX,
437 .range_start = start,
441 if (!mapping_cap_writeback_dirty(mapping))
444 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
445 ret = do_writepages(mapping, &wbc);
446 wbc_detach_inode(&wbc);
450 static inline int __filemap_fdatawrite(struct address_space *mapping,
453 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
456 int filemap_fdatawrite(struct address_space *mapping)
458 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
460 EXPORT_SYMBOL(filemap_fdatawrite);
462 int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
465 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
467 EXPORT_SYMBOL(filemap_fdatawrite_range);
470 * filemap_flush - mostly a non-blocking flush
471 * @mapping: target address_space
473 * This is a mostly non-blocking flush. Not suitable for data-integrity
474 * purposes - I/O may not be started against all dirty pages.
476 int filemap_flush(struct address_space *mapping)
478 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
480 EXPORT_SYMBOL(filemap_flush);
483 * filemap_range_has_page - check if a page exists in range.
484 * @mapping: address space within which to check
485 * @start_byte: offset in bytes where the range starts
486 * @end_byte: offset in bytes where the range ends (inclusive)
488 * Find at least one page in the range supplied, usually used to check if
489 * direct writing in this range will trigger a writeback.
491 bool filemap_range_has_page(struct address_space *mapping,
492 loff_t start_byte, loff_t end_byte)
494 pgoff_t index = start_byte >> PAGE_SHIFT;
495 pgoff_t end = end_byte >> PAGE_SHIFT;
498 if (end_byte < start_byte)
501 if (mapping->nrpages == 0)
504 if (!find_get_pages_range(mapping, &index, end, 1, &page))
509 EXPORT_SYMBOL(filemap_range_has_page);
511 static void __filemap_fdatawait_range(struct address_space *mapping,
512 loff_t start_byte, loff_t end_byte)
514 pgoff_t index = start_byte >> PAGE_SHIFT;
515 pgoff_t end = end_byte >> PAGE_SHIFT;
519 if (end_byte < start_byte)
523 while (index <= end) {
526 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
527 end, PAGECACHE_TAG_WRITEBACK);
531 for (i = 0; i < nr_pages; i++) {
532 struct page *page = pvec.pages[i];
534 wait_on_page_writeback(page);
535 ClearPageError(page);
537 pagevec_release(&pvec);
543 * filemap_fdatawait_range - wait for writeback to complete
544 * @mapping: address space structure to wait for
545 * @start_byte: offset in bytes where the range starts
546 * @end_byte: offset in bytes where the range ends (inclusive)
548 * Walk the list of under-writeback pages of the given address space
549 * in the given range and wait for all of them. Check error status of
550 * the address space and return it.
552 * Since the error status of the address space is cleared by this function,
553 * callers are responsible for checking the return value and handling and/or
554 * reporting the error.
556 int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
559 __filemap_fdatawait_range(mapping, start_byte, end_byte);
560 return filemap_check_errors(mapping);
562 EXPORT_SYMBOL(filemap_fdatawait_range);
565 * file_fdatawait_range - wait for writeback to complete
566 * @file: file pointing to address space structure to wait for
567 * @start_byte: offset in bytes where the range starts
568 * @end_byte: offset in bytes where the range ends (inclusive)
570 * Walk the list of under-writeback pages of the address space that file
571 * refers to, in the given range and wait for all of them. Check error
572 * status of the address space vs. the file->f_wb_err cursor and return it.
574 * Since the error status of the file is advanced by this function,
575 * callers are responsible for checking the return value and handling and/or
576 * reporting the error.
578 int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
580 struct address_space *mapping = file->f_mapping;
582 __filemap_fdatawait_range(mapping, start_byte, end_byte);
583 return file_check_and_advance_wb_err(file);
585 EXPORT_SYMBOL(file_fdatawait_range);
588 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
589 * @mapping: address space structure to wait for
591 * Walk the list of under-writeback pages of the given address space
592 * and wait for all of them. Unlike filemap_fdatawait(), this function
593 * does not clear error status of the address space.
595 * Use this function if callers don't handle errors themselves. Expected
596 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
599 int filemap_fdatawait_keep_errors(struct address_space *mapping)
601 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
602 return filemap_check_and_keep_errors(mapping);
604 EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
606 static bool mapping_needs_writeback(struct address_space *mapping)
608 return (!dax_mapping(mapping) && mapping->nrpages) ||
609 (dax_mapping(mapping) && mapping->nrexceptional);
612 int filemap_write_and_wait(struct address_space *mapping)
616 if (mapping_needs_writeback(mapping)) {
617 err = filemap_fdatawrite(mapping);
619 * Even if the above returned error, the pages may be
620 * written partially (e.g. -ENOSPC), so we wait for it.
621 * But the -EIO is special case, it may indicate the worst
622 * thing (e.g. bug) happened, so we avoid waiting for it.
625 int err2 = filemap_fdatawait(mapping);
629 /* Clear any previously stored errors */
630 filemap_check_errors(mapping);
633 err = filemap_check_errors(mapping);
637 EXPORT_SYMBOL(filemap_write_and_wait);
640 * filemap_write_and_wait_range - write out & wait on a file range
641 * @mapping: the address_space for the pages
642 * @lstart: offset in bytes where the range starts
643 * @lend: offset in bytes where the range ends (inclusive)
645 * Write out and wait upon file offsets lstart->lend, inclusive.
647 * Note that @lend is inclusive (describes the last byte to be written) so
648 * that this function can be used to write to the very end-of-file (end = -1).
650 int filemap_write_and_wait_range(struct address_space *mapping,
651 loff_t lstart, loff_t lend)
655 if (mapping_needs_writeback(mapping)) {
656 err = __filemap_fdatawrite_range(mapping, lstart, lend,
658 /* See comment of filemap_write_and_wait() */
660 int err2 = filemap_fdatawait_range(mapping,
665 /* Clear any previously stored errors */
666 filemap_check_errors(mapping);
669 err = filemap_check_errors(mapping);
673 EXPORT_SYMBOL(filemap_write_and_wait_range);
675 void __filemap_set_wb_err(struct address_space *mapping, int err)
677 errseq_t eseq = errseq_set(&mapping->wb_err, err);
679 trace_filemap_set_wb_err(mapping, eseq);
681 EXPORT_SYMBOL(__filemap_set_wb_err);
684 * file_check_and_advance_wb_err - report wb error (if any) that was previously
685 * and advance wb_err to current one
686 * @file: struct file on which the error is being reported
688 * When userland calls fsync (or something like nfsd does the equivalent), we
689 * want to report any writeback errors that occurred since the last fsync (or
690 * since the file was opened if there haven't been any).
692 * Grab the wb_err from the mapping. If it matches what we have in the file,
693 * then just quickly return 0. The file is all caught up.
695 * If it doesn't match, then take the mapping value, set the "seen" flag in
696 * it and try to swap it into place. If it works, or another task beat us
697 * to it with the new value, then update the f_wb_err and return the error
698 * portion. The error at this point must be reported via proper channels
699 * (a'la fsync, or NFS COMMIT operation, etc.).
701 * While we handle mapping->wb_err with atomic operations, the f_wb_err
702 * value is protected by the f_lock since we must ensure that it reflects
703 * the latest value swapped in for this file descriptor.
705 int file_check_and_advance_wb_err(struct file *file)
708 errseq_t old = READ_ONCE(file->f_wb_err);
709 struct address_space *mapping = file->f_mapping;
711 /* Locklessly handle the common case where nothing has changed */
712 if (errseq_check(&mapping->wb_err, old)) {
713 /* Something changed, must use slow path */
714 spin_lock(&file->f_lock);
715 old = file->f_wb_err;
716 err = errseq_check_and_advance(&mapping->wb_err,
718 trace_file_check_and_advance_wb_err(file, old);
719 spin_unlock(&file->f_lock);
723 * We're mostly using this function as a drop in replacement for
724 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
725 * that the legacy code would have had on these flags.
727 clear_bit(AS_EIO, &mapping->flags);
728 clear_bit(AS_ENOSPC, &mapping->flags);
731 EXPORT_SYMBOL(file_check_and_advance_wb_err);
734 * file_write_and_wait_range - write out & wait on a file range
735 * @file: file pointing to address_space with pages
736 * @lstart: offset in bytes where the range starts
737 * @lend: offset in bytes where the range ends (inclusive)
739 * Write out and wait upon file offsets lstart->lend, inclusive.
741 * Note that @lend is inclusive (describes the last byte to be written) so
742 * that this function can be used to write to the very end-of-file (end = -1).
744 * After writing out and waiting on the data, we check and advance the
745 * f_wb_err cursor to the latest value, and return any errors detected there.
747 int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
750 struct address_space *mapping = file->f_mapping;
752 if (mapping_needs_writeback(mapping)) {
753 err = __filemap_fdatawrite_range(mapping, lstart, lend,
755 /* See comment of filemap_write_and_wait() */
757 __filemap_fdatawait_range(mapping, lstart, lend);
759 err2 = file_check_and_advance_wb_err(file);
764 EXPORT_SYMBOL(file_write_and_wait_range);
767 * replace_page_cache_page - replace a pagecache page with a new one
768 * @old: page to be replaced
769 * @new: page to replace with
770 * @gfp_mask: allocation mode
772 * This function replaces a page in the pagecache with a new one. On
773 * success it acquires the pagecache reference for the new page and
774 * drops it for the old page. Both the old and new pages must be
775 * locked. This function does not add the new page to the LRU, the
776 * caller must do that.
778 * The remove + add is atomic. The only way this function can fail is
779 * memory allocation failure.
781 int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
785 VM_BUG_ON_PAGE(!PageLocked(old), old);
786 VM_BUG_ON_PAGE(!PageLocked(new), new);
787 VM_BUG_ON_PAGE(new->mapping, new);
789 error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
791 struct address_space *mapping = old->mapping;
792 void (*freepage)(struct page *);
795 pgoff_t offset = old->index;
796 freepage = mapping->a_ops->freepage;
799 new->mapping = mapping;
802 xa_lock_irqsave(&mapping->i_pages, flags);
803 __delete_from_page_cache(old, NULL);
804 error = page_cache_tree_insert(mapping, new, NULL);
808 * hugetlb pages do not participate in page cache accounting.
811 __inc_node_page_state(new, NR_FILE_PAGES);
812 if (PageSwapBacked(new))
813 __inc_node_page_state(new, NR_SHMEM);
814 xa_unlock_irqrestore(&mapping->i_pages, flags);
815 mem_cgroup_migrate(old, new);
816 radix_tree_preload_end();
824 EXPORT_SYMBOL_GPL(replace_page_cache_page);
826 static int __add_to_page_cache_locked(struct page *page,
827 struct address_space *mapping,
828 pgoff_t offset, gfp_t gfp_mask,
831 int huge = PageHuge(page);
832 struct mem_cgroup *memcg;
835 VM_BUG_ON_PAGE(!PageLocked(page), page);
836 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
839 error = mem_cgroup_try_charge(page, current->mm,
840 gfp_mask, &memcg, false);
845 error = radix_tree_maybe_preload(gfp_mask & ~__GFP_HIGHMEM);
848 mem_cgroup_cancel_charge(page, memcg, false);
853 page->mapping = mapping;
854 page->index = offset;
856 xa_lock_irq(&mapping->i_pages);
857 error = page_cache_tree_insert(mapping, page, shadowp);
858 radix_tree_preload_end();
862 /* hugetlb pages do not participate in page cache accounting. */
864 __inc_node_page_state(page, NR_FILE_PAGES);
865 xa_unlock_irq(&mapping->i_pages);
867 mem_cgroup_commit_charge(page, memcg, false, false);
868 trace_mm_filemap_add_to_page_cache(page);
871 page->mapping = NULL;
872 /* Leave page->index set: truncation relies upon it */
873 xa_unlock_irq(&mapping->i_pages);
875 mem_cgroup_cancel_charge(page, memcg, false);
881 * add_to_page_cache_locked - add a locked page to the pagecache
883 * @mapping: the page's address_space
884 * @offset: page index
885 * @gfp_mask: page allocation mode
887 * This function is used to add a page to the pagecache. It must be locked.
888 * This function does not add the page to the LRU. The caller must do that.
890 int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
891 pgoff_t offset, gfp_t gfp_mask)
893 return __add_to_page_cache_locked(page, mapping, offset,
896 EXPORT_SYMBOL(add_to_page_cache_locked);
898 int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
899 pgoff_t offset, gfp_t gfp_mask)
904 __SetPageLocked(page);
905 ret = __add_to_page_cache_locked(page, mapping, offset,
908 __ClearPageLocked(page);
911 * The page might have been evicted from cache only
912 * recently, in which case it should be activated like
913 * any other repeatedly accessed page.
914 * The exception is pages getting rewritten; evicting other
915 * data from the working set, only to cache data that will
916 * get overwritten with something else, is a waste of memory.
918 if (!(gfp_mask & __GFP_WRITE) &&
919 shadow && workingset_refault(shadow)) {
921 workingset_activation(page);
923 ClearPageActive(page);
928 EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
931 struct page *__page_cache_alloc(gfp_t gfp)
936 if (cpuset_do_page_mem_spread()) {
937 unsigned int cpuset_mems_cookie;
939 cpuset_mems_cookie = read_mems_allowed_begin();
940 n = cpuset_mem_spread_node();
941 page = __alloc_pages_node(n, gfp, 0);
942 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
946 return alloc_pages(gfp, 0);
948 EXPORT_SYMBOL(__page_cache_alloc);
952 * In order to wait for pages to become available there must be
953 * waitqueues associated with pages. By using a hash table of
954 * waitqueues where the bucket discipline is to maintain all
955 * waiters on the same queue and wake all when any of the pages
956 * become available, and for the woken contexts to check to be
957 * sure the appropriate page became available, this saves space
958 * at a cost of "thundering herd" phenomena during rare hash
961 #define PAGE_WAIT_TABLE_BITS 8
962 #define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
963 static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
965 static wait_queue_head_t *page_waitqueue(struct page *page)
967 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
970 void __init pagecache_init(void)
974 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
975 init_waitqueue_head(&page_wait_table[i]);
977 page_writeback_init();
980 /* This has the same layout as wait_bit_key - see fs/cachefiles/rdwr.c */
981 struct wait_page_key {
987 struct wait_page_queue {
990 wait_queue_entry_t wait;
993 static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
995 struct wait_page_key *key = arg;
996 struct wait_page_queue *wait_page
997 = container_of(wait, struct wait_page_queue, wait);
999 if (wait_page->page != key->page)
1001 key->page_match = 1;
1003 if (wait_page->bit_nr != key->bit_nr)
1006 /* Stop walking if it's locked */
1007 if (test_bit(key->bit_nr, &key->page->flags))
1010 return autoremove_wake_function(wait, mode, sync, key);
1013 static void wake_up_page_bit(struct page *page, int bit_nr)
1015 wait_queue_head_t *q = page_waitqueue(page);
1016 struct wait_page_key key;
1017 unsigned long flags;
1018 wait_queue_entry_t bookmark;
1021 key.bit_nr = bit_nr;
1025 bookmark.private = NULL;
1026 bookmark.func = NULL;
1027 INIT_LIST_HEAD(&bookmark.entry);
1029 spin_lock_irqsave(&q->lock, flags);
1030 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1032 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1034 * Take a breather from holding the lock,
1035 * allow pages that finish wake up asynchronously
1036 * to acquire the lock and remove themselves
1039 spin_unlock_irqrestore(&q->lock, flags);
1041 spin_lock_irqsave(&q->lock, flags);
1042 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1046 * It is possible for other pages to have collided on the waitqueue
1047 * hash, so in that case check for a page match. That prevents a long-
1050 * It is still possible to miss a case here, when we woke page waiters
1051 * and removed them from the waitqueue, but there are still other
1054 if (!waitqueue_active(q) || !key.page_match) {
1055 ClearPageWaiters(page);
1057 * It's possible to miss clearing Waiters here, when we woke
1058 * our page waiters, but the hashed waitqueue has waiters for
1059 * other pages on it.
1061 * That's okay, it's a rare case. The next waker will clear it.
1064 spin_unlock_irqrestore(&q->lock, flags);
1067 static void wake_up_page(struct page *page, int bit)
1069 if (!PageWaiters(page))
1071 wake_up_page_bit(page, bit);
1074 static inline int wait_on_page_bit_common(wait_queue_head_t *q,
1075 struct page *page, int bit_nr, int state, bool lock)
1077 struct wait_page_queue wait_page;
1078 wait_queue_entry_t *wait = &wait_page.wait;
1082 wait->flags = lock ? WQ_FLAG_EXCLUSIVE : 0;
1083 wait->func = wake_page_function;
1084 wait_page.page = page;
1085 wait_page.bit_nr = bit_nr;
1088 spin_lock_irq(&q->lock);
1090 if (likely(list_empty(&wait->entry))) {
1091 __add_wait_queue_entry_tail(q, wait);
1092 SetPageWaiters(page);
1095 set_current_state(state);
1097 spin_unlock_irq(&q->lock);
1099 if (likely(test_bit(bit_nr, &page->flags))) {
1104 if (!test_and_set_bit_lock(bit_nr, &page->flags))
1107 if (!test_bit(bit_nr, &page->flags))
1111 if (unlikely(signal_pending_state(state, current))) {
1117 finish_wait(q, wait);
1120 * A signal could leave PageWaiters set. Clearing it here if
1121 * !waitqueue_active would be possible (by open-coding finish_wait),
1122 * but still fail to catch it in the case of wait hash collision. We
1123 * already can fail to clear wait hash collision cases, so don't
1124 * bother with signals either.
1130 void wait_on_page_bit(struct page *page, int bit_nr)
1132 wait_queue_head_t *q = page_waitqueue(page);
1133 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, false);
1135 EXPORT_SYMBOL(wait_on_page_bit);
1137 int wait_on_page_bit_killable(struct page *page, int bit_nr)
1139 wait_queue_head_t *q = page_waitqueue(page);
1140 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, false);
1142 EXPORT_SYMBOL(wait_on_page_bit_killable);
1145 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
1146 * @page: Page defining the wait queue of interest
1147 * @waiter: Waiter to add to the queue
1149 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1151 void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
1153 wait_queue_head_t *q = page_waitqueue(page);
1154 unsigned long flags;
1156 spin_lock_irqsave(&q->lock, flags);
1157 __add_wait_queue_entry_tail(q, waiter);
1158 SetPageWaiters(page);
1159 spin_unlock_irqrestore(&q->lock, flags);
1161 EXPORT_SYMBOL_GPL(add_page_wait_queue);
1163 #ifndef clear_bit_unlock_is_negative_byte
1166 * PG_waiters is the high bit in the same byte as PG_lock.
1168 * On x86 (and on many other architectures), we can clear PG_lock and
1169 * test the sign bit at the same time. But if the architecture does
1170 * not support that special operation, we just do this all by hand
1173 * The read of PG_waiters has to be after (or concurrently with) PG_locked
1174 * being cleared, but a memory barrier should be unneccssary since it is
1175 * in the same byte as PG_locked.
1177 static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1179 clear_bit_unlock(nr, mem);
1180 /* smp_mb__after_atomic(); */
1181 return test_bit(PG_waiters, mem);
1187 * unlock_page - unlock a locked page
1190 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
1191 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
1192 * mechanism between PageLocked pages and PageWriteback pages is shared.
1193 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1195 * Note that this depends on PG_waiters being the sign bit in the byte
1196 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1197 * clear the PG_locked bit and test PG_waiters at the same time fairly
1198 * portably (architectures that do LL/SC can test any bit, while x86 can
1199 * test the sign bit).
1201 void unlock_page(struct page *page)
1203 BUILD_BUG_ON(PG_waiters != 7);
1204 page = compound_head(page);
1205 VM_BUG_ON_PAGE(!PageLocked(page), page);
1206 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1207 wake_up_page_bit(page, PG_locked);
1209 EXPORT_SYMBOL(unlock_page);
1212 * end_page_writeback - end writeback against a page
1215 void end_page_writeback(struct page *page)
1218 * TestClearPageReclaim could be used here but it is an atomic
1219 * operation and overkill in this particular case. Failing to
1220 * shuffle a page marked for immediate reclaim is too mild to
1221 * justify taking an atomic operation penalty at the end of
1222 * ever page writeback.
1224 if (PageReclaim(page)) {
1225 ClearPageReclaim(page);
1226 rotate_reclaimable_page(page);
1229 if (!test_clear_page_writeback(page))
1232 smp_mb__after_atomic();
1233 wake_up_page(page, PG_writeback);
1235 EXPORT_SYMBOL(end_page_writeback);
1238 * After completing I/O on a page, call this routine to update the page
1239 * flags appropriately
1241 void page_endio(struct page *page, bool is_write, int err)
1245 SetPageUptodate(page);
1247 ClearPageUptodate(page);
1253 struct address_space *mapping;
1256 mapping = page_mapping(page);
1258 mapping_set_error(mapping, err);
1260 end_page_writeback(page);
1263 EXPORT_SYMBOL_GPL(page_endio);
1266 * __lock_page - get a lock on the page, assuming we need to sleep to get it
1267 * @__page: the page to lock
1269 void __lock_page(struct page *__page)
1271 struct page *page = compound_head(__page);
1272 wait_queue_head_t *q = page_waitqueue(page);
1273 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, true);
1275 EXPORT_SYMBOL(__lock_page);
1277 int __lock_page_killable(struct page *__page)
1279 struct page *page = compound_head(__page);
1280 wait_queue_head_t *q = page_waitqueue(page);
1281 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE, true);
1283 EXPORT_SYMBOL_GPL(__lock_page_killable);
1287 * 1 - page is locked; mmap_sem is still held.
1288 * 0 - page is not locked.
1289 * mmap_sem has been released (up_read()), unless flags had both
1290 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1291 * which case mmap_sem is still held.
1293 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1294 * with the page locked and the mmap_sem unperturbed.
1296 int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1299 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1301 * CAUTION! In this case, mmap_sem is not released
1302 * even though return 0.
1304 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1307 up_read(&mm->mmap_sem);
1308 if (flags & FAULT_FLAG_KILLABLE)
1309 wait_on_page_locked_killable(page);
1311 wait_on_page_locked(page);
1314 if (flags & FAULT_FLAG_KILLABLE) {
1317 ret = __lock_page_killable(page);
1319 up_read(&mm->mmap_sem);
1329 * page_cache_next_hole - find the next hole (not-present entry)
1332 * @max_scan: maximum range to search
1334 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the
1335 * lowest indexed hole.
1337 * Returns: the index of the hole if found, otherwise returns an index
1338 * outside of the set specified (in which case 'return - index >=
1339 * max_scan' will be true). In rare cases of index wrap-around, 0 will
1342 * page_cache_next_hole may be called under rcu_read_lock. However,
1343 * like radix_tree_gang_lookup, this will not atomically search a
1344 * snapshot of the tree at a single point in time. For example, if a
1345 * hole is created at index 5, then subsequently a hole is created at
1346 * index 10, page_cache_next_hole covering both indexes may return 10
1347 * if called under rcu_read_lock.
1349 pgoff_t page_cache_next_hole(struct address_space *mapping,
1350 pgoff_t index, unsigned long max_scan)
1354 for (i = 0; i < max_scan; i++) {
1357 page = radix_tree_lookup(&mapping->i_pages, index);
1358 if (!page || radix_tree_exceptional_entry(page))
1367 EXPORT_SYMBOL(page_cache_next_hole);
1370 * page_cache_prev_hole - find the prev hole (not-present entry)
1373 * @max_scan: maximum range to search
1375 * Search backwards in the range [max(index-max_scan+1, 0), index] for
1378 * Returns: the index of the hole if found, otherwise returns an index
1379 * outside of the set specified (in which case 'index - return >=
1380 * max_scan' will be true). In rare cases of wrap-around, ULONG_MAX
1383 * page_cache_prev_hole may be called under rcu_read_lock. However,
1384 * like radix_tree_gang_lookup, this will not atomically search a
1385 * snapshot of the tree at a single point in time. For example, if a
1386 * hole is created at index 10, then subsequently a hole is created at
1387 * index 5, page_cache_prev_hole covering both indexes may return 5 if
1388 * called under rcu_read_lock.
1390 pgoff_t page_cache_prev_hole(struct address_space *mapping,
1391 pgoff_t index, unsigned long max_scan)
1395 for (i = 0; i < max_scan; i++) {
1398 page = radix_tree_lookup(&mapping->i_pages, index);
1399 if (!page || radix_tree_exceptional_entry(page))
1402 if (index == ULONG_MAX)
1408 EXPORT_SYMBOL(page_cache_prev_hole);
1411 * find_get_entry - find and get a page cache entry
1412 * @mapping: the address_space to search
1413 * @offset: the page cache index
1415 * Looks up the page cache slot at @mapping & @offset. If there is a
1416 * page cache page, it is returned with an increased refcount.
1418 * If the slot holds a shadow entry of a previously evicted page, or a
1419 * swap entry from shmem/tmpfs, it is returned.
1421 * Otherwise, %NULL is returned.
1423 struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
1426 struct page *head, *page;
1431 pagep = radix_tree_lookup_slot(&mapping->i_pages, offset);
1433 page = radix_tree_deref_slot(pagep);
1434 if (unlikely(!page))
1436 if (radix_tree_exception(page)) {
1437 if (radix_tree_deref_retry(page))
1440 * A shadow entry of a recently evicted page,
1441 * or a swap entry from shmem/tmpfs. Return
1442 * it without attempting to raise page count.
1447 head = compound_head(page);
1448 if (!page_cache_get_speculative(head))
1451 /* The page was split under us? */
1452 if (compound_head(page) != head) {
1458 * Has the page moved?
1459 * This is part of the lockless pagecache protocol. See
1460 * include/linux/pagemap.h for details.
1462 if (unlikely(page != *pagep)) {
1472 EXPORT_SYMBOL(find_get_entry);
1475 * find_lock_entry - locate, pin and lock a page cache entry
1476 * @mapping: the address_space to search
1477 * @offset: the page cache index
1479 * Looks up the page cache slot at @mapping & @offset. If there is a
1480 * page cache page, it is returned locked and with an increased
1483 * If the slot holds a shadow entry of a previously evicted page, or a
1484 * swap entry from shmem/tmpfs, it is returned.
1486 * Otherwise, %NULL is returned.
1488 * find_lock_entry() may sleep.
1490 struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
1495 page = find_get_entry(mapping, offset);
1496 if (page && !radix_tree_exception(page)) {
1498 /* Has the page been truncated? */
1499 if (unlikely(page_mapping(page) != mapping)) {
1504 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
1508 EXPORT_SYMBOL(find_lock_entry);
1511 * pagecache_get_page - find and get a page reference
1512 * @mapping: the address_space to search
1513 * @offset: the page index
1514 * @fgp_flags: PCG flags
1515 * @gfp_mask: gfp mask to use for the page cache data page allocation
1517 * Looks up the page cache slot at @mapping & @offset.
1519 * PCG flags modify how the page is returned.
1521 * @fgp_flags can be:
1523 * - FGP_ACCESSED: the page will be marked accessed
1524 * - FGP_LOCK: Page is return locked
1525 * - FGP_CREAT: If page is not present then a new page is allocated using
1526 * @gfp_mask and added to the page cache and the VM's LRU
1527 * list. The page is returned locked and with an increased
1528 * refcount. Otherwise, NULL is returned.
1530 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1531 * if the GFP flags specified for FGP_CREAT are atomic.
1533 * If there is a page cache page, it is returned with an increased refcount.
1535 struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
1536 int fgp_flags, gfp_t gfp_mask)
1541 page = find_get_entry(mapping, offset);
1542 if (radix_tree_exceptional_entry(page))
1547 if (fgp_flags & FGP_LOCK) {
1548 if (fgp_flags & FGP_NOWAIT) {
1549 if (!trylock_page(page)) {
1557 /* Has the page been truncated? */
1558 if (unlikely(page->mapping != mapping)) {
1563 VM_BUG_ON_PAGE(page->index != offset, page);
1566 if (page && (fgp_flags & FGP_ACCESSED))
1567 mark_page_accessed(page);
1570 if (!page && (fgp_flags & FGP_CREAT)) {
1572 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
1573 gfp_mask |= __GFP_WRITE;
1574 if (fgp_flags & FGP_NOFS)
1575 gfp_mask &= ~__GFP_FS;
1577 page = __page_cache_alloc(gfp_mask);
1581 if (WARN_ON_ONCE(!(fgp_flags & FGP_LOCK)))
1582 fgp_flags |= FGP_LOCK;
1584 /* Init accessed so avoid atomic mark_page_accessed later */
1585 if (fgp_flags & FGP_ACCESSED)
1586 __SetPageReferenced(page);
1588 err = add_to_page_cache_lru(page, mapping, offset,
1589 gfp_mask & GFP_RECLAIM_MASK);
1590 if (unlikely(err)) {
1600 EXPORT_SYMBOL(pagecache_get_page);
1603 * find_get_entries - gang pagecache lookup
1604 * @mapping: The address_space to search
1605 * @start: The starting page cache index
1606 * @nr_entries: The maximum number of entries
1607 * @entries: Where the resulting entries are placed
1608 * @indices: The cache indices corresponding to the entries in @entries
1610 * find_get_entries() will search for and return a group of up to
1611 * @nr_entries entries in the mapping. The entries are placed at
1612 * @entries. find_get_entries() takes a reference against any actual
1615 * The search returns a group of mapping-contiguous page cache entries
1616 * with ascending indexes. There may be holes in the indices due to
1617 * not-present pages.
1619 * Any shadow entries of evicted pages, or swap entries from
1620 * shmem/tmpfs, are included in the returned array.
1622 * find_get_entries() returns the number of pages and shadow entries
1625 unsigned find_get_entries(struct address_space *mapping,
1626 pgoff_t start, unsigned int nr_entries,
1627 struct page **entries, pgoff_t *indices)
1630 unsigned int ret = 0;
1631 struct radix_tree_iter iter;
1637 radix_tree_for_each_slot(slot, &mapping->i_pages, &iter, start) {
1638 struct page *head, *page;
1640 page = radix_tree_deref_slot(slot);
1641 if (unlikely(!page))
1643 if (radix_tree_exception(page)) {
1644 if (radix_tree_deref_retry(page)) {
1645 slot = radix_tree_iter_retry(&iter);
1649 * A shadow entry of a recently evicted page, a swap
1650 * entry from shmem/tmpfs or a DAX entry. Return it
1651 * without attempting to raise page count.
1656 head = compound_head(page);
1657 if (!page_cache_get_speculative(head))
1660 /* The page was split under us? */
1661 if (compound_head(page) != head) {
1666 /* Has the page moved? */
1667 if (unlikely(page != *slot)) {
1672 indices[ret] = iter.index;
1673 entries[ret] = page;
1674 if (++ret == nr_entries)
1682 * find_get_pages_range - gang pagecache lookup
1683 * @mapping: The address_space to search
1684 * @start: The starting page index
1685 * @end: The final page index (inclusive)
1686 * @nr_pages: The maximum number of pages
1687 * @pages: Where the resulting pages are placed
1689 * find_get_pages_range() will search for and return a group of up to @nr_pages
1690 * pages in the mapping starting at index @start and up to index @end
1691 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1692 * a reference against the returned pages.
1694 * The search returns a group of mapping-contiguous pages with ascending
1695 * indexes. There may be holes in the indices due to not-present pages.
1696 * We also update @start to index the next page for the traversal.
1698 * find_get_pages_range() returns the number of pages which were found. If this
1699 * number is smaller than @nr_pages, the end of specified range has been
1702 unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1703 pgoff_t end, unsigned int nr_pages,
1704 struct page **pages)
1706 struct radix_tree_iter iter;
1710 if (unlikely(!nr_pages))
1714 radix_tree_for_each_slot(slot, &mapping->i_pages, &iter, *start) {
1715 struct page *head, *page;
1717 if (iter.index > end)
1720 page = radix_tree_deref_slot(slot);
1721 if (unlikely(!page))
1724 if (radix_tree_exception(page)) {
1725 if (radix_tree_deref_retry(page)) {
1726 slot = radix_tree_iter_retry(&iter);
1730 * A shadow entry of a recently evicted page,
1731 * or a swap entry from shmem/tmpfs. Skip
1737 head = compound_head(page);
1738 if (!page_cache_get_speculative(head))
1741 /* The page was split under us? */
1742 if (compound_head(page) != head) {
1747 /* Has the page moved? */
1748 if (unlikely(page != *slot)) {
1754 if (++ret == nr_pages) {
1755 *start = pages[ret - 1]->index + 1;
1761 * We come here when there is no page beyond @end. We take care to not
1762 * overflow the index @start as it confuses some of the callers. This
1763 * breaks the iteration when there is page at index -1 but that is
1764 * already broken anyway.
1766 if (end == (pgoff_t)-1)
1767 *start = (pgoff_t)-1;
1777 * find_get_pages_contig - gang contiguous pagecache lookup
1778 * @mapping: The address_space to search
1779 * @index: The starting page index
1780 * @nr_pages: The maximum number of pages
1781 * @pages: Where the resulting pages are placed
1783 * find_get_pages_contig() works exactly like find_get_pages(), except
1784 * that the returned number of pages are guaranteed to be contiguous.
1786 * find_get_pages_contig() returns the number of pages which were found.
1788 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1789 unsigned int nr_pages, struct page **pages)
1791 struct radix_tree_iter iter;
1793 unsigned int ret = 0;
1795 if (unlikely(!nr_pages))
1799 radix_tree_for_each_contig(slot, &mapping->i_pages, &iter, index) {
1800 struct page *head, *page;
1802 page = radix_tree_deref_slot(slot);
1803 /* The hole, there no reason to continue */
1804 if (unlikely(!page))
1807 if (radix_tree_exception(page)) {
1808 if (radix_tree_deref_retry(page)) {
1809 slot = radix_tree_iter_retry(&iter);
1813 * A shadow entry of a recently evicted page,
1814 * or a swap entry from shmem/tmpfs. Stop
1815 * looking for contiguous pages.
1820 head = compound_head(page);
1821 if (!page_cache_get_speculative(head))
1824 /* The page was split under us? */
1825 if (compound_head(page) != head) {
1830 /* Has the page moved? */
1831 if (unlikely(page != *slot)) {
1837 * must check mapping and index after taking the ref.
1838 * otherwise we can get both false positives and false
1839 * negatives, which is just confusing to the caller.
1841 if (page->mapping == NULL || page_to_pgoff(page) != iter.index) {
1847 if (++ret == nr_pages)
1853 EXPORT_SYMBOL(find_get_pages_contig);
1856 * find_get_pages_range_tag - find and return pages in given range matching @tag
1857 * @mapping: the address_space to search
1858 * @index: the starting page index
1859 * @end: The final page index (inclusive)
1860 * @tag: the tag index
1861 * @nr_pages: the maximum number of pages
1862 * @pages: where the resulting pages are placed
1864 * Like find_get_pages, except we only return pages which are tagged with
1865 * @tag. We update @index to index the next page for the traversal.
1867 unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
1868 pgoff_t end, int tag, unsigned int nr_pages,
1869 struct page **pages)
1871 struct radix_tree_iter iter;
1875 if (unlikely(!nr_pages))
1879 radix_tree_for_each_tagged(slot, &mapping->i_pages, &iter, *index, tag) {
1880 struct page *head, *page;
1882 if (iter.index > end)
1885 page = radix_tree_deref_slot(slot);
1886 if (unlikely(!page))
1889 if (radix_tree_exception(page)) {
1890 if (radix_tree_deref_retry(page)) {
1891 slot = radix_tree_iter_retry(&iter);
1895 * A shadow entry of a recently evicted page.
1897 * Those entries should never be tagged, but
1898 * this tree walk is lockless and the tags are
1899 * looked up in bulk, one radix tree node at a
1900 * time, so there is a sizable window for page
1901 * reclaim to evict a page we saw tagged.
1908 head = compound_head(page);
1909 if (!page_cache_get_speculative(head))
1912 /* The page was split under us? */
1913 if (compound_head(page) != head) {
1918 /* Has the page moved? */
1919 if (unlikely(page != *slot)) {
1925 if (++ret == nr_pages) {
1926 *index = pages[ret - 1]->index + 1;
1932 * We come here when we got at @end. We take care to not overflow the
1933 * index @index as it confuses some of the callers. This breaks the
1934 * iteration when there is page at index -1 but that is already broken
1937 if (end == (pgoff_t)-1)
1938 *index = (pgoff_t)-1;
1946 EXPORT_SYMBOL(find_get_pages_range_tag);
1949 * find_get_entries_tag - find and return entries that match @tag
1950 * @mapping: the address_space to search
1951 * @start: the starting page cache index
1952 * @tag: the tag index
1953 * @nr_entries: the maximum number of entries
1954 * @entries: where the resulting entries are placed
1955 * @indices: the cache indices corresponding to the entries in @entries
1957 * Like find_get_entries, except we only return entries which are tagged with
1960 unsigned find_get_entries_tag(struct address_space *mapping, pgoff_t start,
1961 int tag, unsigned int nr_entries,
1962 struct page **entries, pgoff_t *indices)
1965 unsigned int ret = 0;
1966 struct radix_tree_iter iter;
1972 radix_tree_for_each_tagged(slot, &mapping->i_pages, &iter, start, tag) {
1973 struct page *head, *page;
1975 page = radix_tree_deref_slot(slot);
1976 if (unlikely(!page))
1978 if (radix_tree_exception(page)) {
1979 if (radix_tree_deref_retry(page)) {
1980 slot = radix_tree_iter_retry(&iter);
1985 * A shadow entry of a recently evicted page, a swap
1986 * entry from shmem/tmpfs or a DAX entry. Return it
1987 * without attempting to raise page count.
1992 head = compound_head(page);
1993 if (!page_cache_get_speculative(head))
1996 /* The page was split under us? */
1997 if (compound_head(page) != head) {
2002 /* Has the page moved? */
2003 if (unlikely(page != *slot)) {
2008 indices[ret] = iter.index;
2009 entries[ret] = page;
2010 if (++ret == nr_entries)
2016 EXPORT_SYMBOL(find_get_entries_tag);
2019 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2020 * a _large_ part of the i/o request. Imagine the worst scenario:
2022 * ---R__________________________________________B__________
2023 * ^ reading here ^ bad block(assume 4k)
2025 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2026 * => failing the whole request => read(R) => read(R+1) =>
2027 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2028 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2029 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2031 * It is going insane. Fix it by quickly scaling down the readahead size.
2033 static void shrink_readahead_size_eio(struct file *filp,
2034 struct file_ra_state *ra)
2040 * generic_file_buffered_read - generic file read routine
2041 * @iocb: the iocb to read
2042 * @iter: data destination
2043 * @written: already copied
2045 * This is a generic file read routine, and uses the
2046 * mapping->a_ops->readpage() function for the actual low-level stuff.
2048 * This is really ugly. But the goto's actually try to clarify some
2049 * of the logic when it comes to error handling etc.
2051 static ssize_t generic_file_buffered_read(struct kiocb *iocb,
2052 struct iov_iter *iter, ssize_t written)
2054 struct file *filp = iocb->ki_filp;
2055 struct address_space *mapping = filp->f_mapping;
2056 struct inode *inode = mapping->host;
2057 struct file_ra_state *ra = &filp->f_ra;
2058 loff_t *ppos = &iocb->ki_pos;
2062 unsigned long offset; /* offset into pagecache page */
2063 unsigned int prev_offset;
2066 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
2068 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2070 index = *ppos >> PAGE_SHIFT;
2071 prev_index = ra->prev_pos >> PAGE_SHIFT;
2072 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2073 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2074 offset = *ppos & ~PAGE_MASK;
2080 unsigned long nr, ret;
2084 if (fatal_signal_pending(current)) {
2089 page = find_get_page(mapping, index);
2091 if (iocb->ki_flags & IOCB_NOWAIT)
2093 page_cache_sync_readahead(mapping,
2095 index, last_index - index);
2096 page = find_get_page(mapping, index);
2097 if (unlikely(page == NULL))
2098 goto no_cached_page;
2100 if (PageReadahead(page)) {
2101 page_cache_async_readahead(mapping,
2103 index, last_index - index);
2105 if (!PageUptodate(page)) {
2106 if (iocb->ki_flags & IOCB_NOWAIT) {
2112 * See comment in do_read_cache_page on why
2113 * wait_on_page_locked is used to avoid unnecessarily
2114 * serialisations and why it's safe.
2116 error = wait_on_page_locked_killable(page);
2117 if (unlikely(error))
2118 goto readpage_error;
2119 if (PageUptodate(page))
2122 if (inode->i_blkbits == PAGE_SHIFT ||
2123 !mapping->a_ops->is_partially_uptodate)
2124 goto page_not_up_to_date;
2125 /* pipes can't handle partially uptodate pages */
2126 if (unlikely(iter->type & ITER_PIPE))
2127 goto page_not_up_to_date;
2128 if (!trylock_page(page))
2129 goto page_not_up_to_date;
2130 /* Did it get truncated before we got the lock? */
2132 goto page_not_up_to_date_locked;
2133 if (!mapping->a_ops->is_partially_uptodate(page,
2134 offset, iter->count))
2135 goto page_not_up_to_date_locked;
2140 * i_size must be checked after we know the page is Uptodate.
2142 * Checking i_size after the check allows us to calculate
2143 * the correct value for "nr", which means the zero-filled
2144 * part of the page is not copied back to userspace (unless
2145 * another truncate extends the file - this is desired though).
2148 isize = i_size_read(inode);
2149 end_index = (isize - 1) >> PAGE_SHIFT;
2150 if (unlikely(!isize || index > end_index)) {
2155 /* nr is the maximum number of bytes to copy from this page */
2157 if (index == end_index) {
2158 nr = ((isize - 1) & ~PAGE_MASK) + 1;
2166 /* If users can be writing to this page using arbitrary
2167 * virtual addresses, take care about potential aliasing
2168 * before reading the page on the kernel side.
2170 if (mapping_writably_mapped(mapping))
2171 flush_dcache_page(page);
2174 * When a sequential read accesses a page several times,
2175 * only mark it as accessed the first time.
2177 if (prev_index != index || offset != prev_offset)
2178 mark_page_accessed(page);
2182 * Ok, we have the page, and it's up-to-date, so
2183 * now we can copy it to user space...
2186 ret = copy_page_to_iter(page, offset, nr, iter);
2188 index += offset >> PAGE_SHIFT;
2189 offset &= ~PAGE_MASK;
2190 prev_offset = offset;
2194 if (!iov_iter_count(iter))
2202 page_not_up_to_date:
2203 /* Get exclusive access to the page ... */
2204 error = lock_page_killable(page);
2205 if (unlikely(error))
2206 goto readpage_error;
2208 page_not_up_to_date_locked:
2209 /* Did it get truncated before we got the lock? */
2210 if (!page->mapping) {
2216 /* Did somebody else fill it already? */
2217 if (PageUptodate(page)) {
2224 * A previous I/O error may have been due to temporary
2225 * failures, eg. multipath errors.
2226 * PG_error will be set again if readpage fails.
2228 ClearPageError(page);
2229 /* Start the actual read. The read will unlock the page. */
2230 error = mapping->a_ops->readpage(filp, page);
2232 if (unlikely(error)) {
2233 if (error == AOP_TRUNCATED_PAGE) {
2238 goto readpage_error;
2241 if (!PageUptodate(page)) {
2242 error = lock_page_killable(page);
2243 if (unlikely(error))
2244 goto readpage_error;
2245 if (!PageUptodate(page)) {
2246 if (page->mapping == NULL) {
2248 * invalidate_mapping_pages got it
2255 shrink_readahead_size_eio(filp, ra);
2257 goto readpage_error;
2265 /* UHHUH! A synchronous read error occurred. Report it */
2271 * Ok, it wasn't cached, so we need to create a new
2274 page = page_cache_alloc(mapping);
2279 error = add_to_page_cache_lru(page, mapping, index,
2280 mapping_gfp_constraint(mapping, GFP_KERNEL));
2283 if (error == -EEXIST) {
2295 ra->prev_pos = prev_index;
2296 ra->prev_pos <<= PAGE_SHIFT;
2297 ra->prev_pos |= prev_offset;
2299 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
2300 file_accessed(filp);
2301 return written ? written : error;
2305 * generic_file_read_iter - generic filesystem read routine
2306 * @iocb: kernel I/O control block
2307 * @iter: destination for the data read
2309 * This is the "read_iter()" routine for all filesystems
2310 * that can use the page cache directly.
2313 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
2315 size_t count = iov_iter_count(iter);
2319 goto out; /* skip atime */
2321 if (iocb->ki_flags & IOCB_DIRECT) {
2322 struct file *file = iocb->ki_filp;
2323 struct address_space *mapping = file->f_mapping;
2324 struct inode *inode = mapping->host;
2327 size = i_size_read(inode);
2328 if (iocb->ki_flags & IOCB_NOWAIT) {
2329 if (filemap_range_has_page(mapping, iocb->ki_pos,
2330 iocb->ki_pos + count - 1))
2333 retval = filemap_write_and_wait_range(mapping,
2335 iocb->ki_pos + count - 1);
2340 file_accessed(file);
2342 retval = mapping->a_ops->direct_IO(iocb, iter);
2344 iocb->ki_pos += retval;
2347 iov_iter_revert(iter, count - iov_iter_count(iter));
2350 * Btrfs can have a short DIO read if we encounter
2351 * compressed extents, so if there was an error, or if
2352 * we've already read everything we wanted to, or if
2353 * there was a short read because we hit EOF, go ahead
2354 * and return. Otherwise fallthrough to buffered io for
2355 * the rest of the read. Buffered reads will not work for
2356 * DAX files, so don't bother trying.
2358 if (retval < 0 || !count || iocb->ki_pos >= size ||
2363 retval = generic_file_buffered_read(iocb, iter, retval);
2367 EXPORT_SYMBOL(generic_file_read_iter);
2371 * page_cache_read - adds requested page to the page cache if not already there
2372 * @file: file to read
2373 * @offset: page index
2374 * @gfp_mask: memory allocation flags
2376 * This adds the requested page to the page cache if it isn't already there,
2377 * and schedules an I/O to read in its contents from disk.
2379 static int page_cache_read(struct file *file, pgoff_t offset, gfp_t gfp_mask)
2381 struct address_space *mapping = file->f_mapping;
2386 page = __page_cache_alloc(gfp_mask);
2390 ret = add_to_page_cache_lru(page, mapping, offset, gfp_mask & GFP_KERNEL);
2392 ret = mapping->a_ops->readpage(file, page);
2393 else if (ret == -EEXIST)
2394 ret = 0; /* losing race to add is OK */
2398 } while (ret == AOP_TRUNCATED_PAGE);
2403 #define MMAP_LOTSAMISS (100)
2406 * Synchronous readahead happens when we don't even find
2407 * a page in the page cache at all.
2409 static void do_sync_mmap_readahead(struct vm_area_struct *vma,
2410 struct file_ra_state *ra,
2414 struct address_space *mapping = file->f_mapping;
2416 /* If we don't want any read-ahead, don't bother */
2417 if (vma->vm_flags & VM_RAND_READ)
2422 if (vma->vm_flags & VM_SEQ_READ) {
2423 page_cache_sync_readahead(mapping, ra, file, offset,
2428 /* Avoid banging the cache line if not needed */
2429 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
2433 * Do we miss much more than hit in this file? If so,
2434 * stop bothering with read-ahead. It will only hurt.
2436 if (ra->mmap_miss > MMAP_LOTSAMISS)
2442 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2443 ra->size = ra->ra_pages;
2444 ra->async_size = ra->ra_pages / 4;
2445 ra_submit(ra, mapping, file);
2449 * Asynchronous readahead happens when we find the page and PG_readahead,
2450 * so we want to possibly extend the readahead further..
2452 static void do_async_mmap_readahead(struct vm_area_struct *vma,
2453 struct file_ra_state *ra,
2458 struct address_space *mapping = file->f_mapping;
2460 /* If we don't want any read-ahead, don't bother */
2461 if (vma->vm_flags & VM_RAND_READ)
2463 if (ra->mmap_miss > 0)
2465 if (PageReadahead(page))
2466 page_cache_async_readahead(mapping, ra, file,
2467 page, offset, ra->ra_pages);
2471 * filemap_fault - read in file data for page fault handling
2472 * @vmf: struct vm_fault containing details of the fault
2474 * filemap_fault() is invoked via the vma operations vector for a
2475 * mapped memory region to read in file data during a page fault.
2477 * The goto's are kind of ugly, but this streamlines the normal case of having
2478 * it in the page cache, and handles the special cases reasonably without
2479 * having a lot of duplicated code.
2481 * vma->vm_mm->mmap_sem must be held on entry.
2483 * If our return value has VM_FAULT_RETRY set, it's because
2484 * lock_page_or_retry() returned 0.
2485 * The mmap_sem has usually been released in this case.
2486 * See __lock_page_or_retry() for the exception.
2488 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2489 * has not been released.
2491 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
2493 int filemap_fault(struct vm_fault *vmf)
2496 struct file *file = vmf->vma->vm_file;
2497 struct address_space *mapping = file->f_mapping;
2498 struct file_ra_state *ra = &file->f_ra;
2499 struct inode *inode = mapping->host;
2500 pgoff_t offset = vmf->pgoff;
2505 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2506 if (unlikely(offset >= max_off))
2507 return VM_FAULT_SIGBUS;
2510 * Do we have something in the page cache already?
2512 page = find_get_page(mapping, offset);
2513 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
2515 * We found the page, so try async readahead before
2516 * waiting for the lock.
2518 do_async_mmap_readahead(vmf->vma, ra, file, page, offset);
2520 /* No page in the page cache at all */
2521 do_sync_mmap_readahead(vmf->vma, ra, file, offset);
2522 count_vm_event(PGMAJFAULT);
2523 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
2524 ret = VM_FAULT_MAJOR;
2526 page = find_get_page(mapping, offset);
2528 goto no_cached_page;
2531 if (!lock_page_or_retry(page, vmf->vma->vm_mm, vmf->flags)) {
2533 return ret | VM_FAULT_RETRY;
2536 /* Did it get truncated? */
2537 if (unlikely(page->mapping != mapping)) {
2542 VM_BUG_ON_PAGE(page->index != offset, page);
2545 * We have a locked page in the page cache, now we need to check
2546 * that it's up-to-date. If not, it is going to be due to an error.
2548 if (unlikely(!PageUptodate(page)))
2549 goto page_not_uptodate;
2552 * Found the page and have a reference on it.
2553 * We must recheck i_size under page lock.
2555 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2556 if (unlikely(offset >= max_off)) {
2559 return VM_FAULT_SIGBUS;
2563 return ret | VM_FAULT_LOCKED;
2567 * We're only likely to ever get here if MADV_RANDOM is in
2570 error = page_cache_read(file, offset, vmf->gfp_mask);
2573 * The page we want has now been added to the page cache.
2574 * In the unlikely event that someone removed it in the
2575 * meantime, we'll just come back here and read it again.
2581 * An error return from page_cache_read can result if the
2582 * system is low on memory, or a problem occurs while trying
2585 if (error == -ENOMEM)
2586 return VM_FAULT_OOM;
2587 return VM_FAULT_SIGBUS;
2591 * Umm, take care of errors if the page isn't up-to-date.
2592 * Try to re-read it _once_. We do this synchronously,
2593 * because there really aren't any performance issues here
2594 * and we need to check for errors.
2596 ClearPageError(page);
2597 error = mapping->a_ops->readpage(file, page);
2599 wait_on_page_locked(page);
2600 if (!PageUptodate(page))
2605 if (!error || error == AOP_TRUNCATED_PAGE)
2608 /* Things didn't work out. Return zero to tell the mm layer so. */
2609 shrink_readahead_size_eio(file, ra);
2610 return VM_FAULT_SIGBUS;
2612 EXPORT_SYMBOL(filemap_fault);
2614 void filemap_map_pages(struct vm_fault *vmf,
2615 pgoff_t start_pgoff, pgoff_t end_pgoff)
2617 struct radix_tree_iter iter;
2619 struct file *file = vmf->vma->vm_file;
2620 struct address_space *mapping = file->f_mapping;
2621 pgoff_t last_pgoff = start_pgoff;
2622 unsigned long max_idx;
2623 struct page *head, *page;
2626 radix_tree_for_each_slot(slot, &mapping->i_pages, &iter, start_pgoff) {
2627 if (iter.index > end_pgoff)
2630 page = radix_tree_deref_slot(slot);
2631 if (unlikely(!page))
2633 if (radix_tree_exception(page)) {
2634 if (radix_tree_deref_retry(page)) {
2635 slot = radix_tree_iter_retry(&iter);
2641 head = compound_head(page);
2642 if (!page_cache_get_speculative(head))
2645 /* The page was split under us? */
2646 if (compound_head(page) != head) {
2651 /* Has the page moved? */
2652 if (unlikely(page != *slot)) {
2657 if (!PageUptodate(page) ||
2658 PageReadahead(page) ||
2661 if (!trylock_page(page))
2664 if (page->mapping != mapping || !PageUptodate(page))
2667 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2668 if (page->index >= max_idx)
2671 if (file->f_ra.mmap_miss > 0)
2672 file->f_ra.mmap_miss--;
2674 vmf->address += (iter.index - last_pgoff) << PAGE_SHIFT;
2676 vmf->pte += iter.index - last_pgoff;
2677 last_pgoff = iter.index;
2678 if (alloc_set_pte(vmf, NULL, page))
2687 /* Huge page is mapped? No need to proceed. */
2688 if (pmd_trans_huge(*vmf->pmd))
2690 if (iter.index == end_pgoff)
2695 EXPORT_SYMBOL(filemap_map_pages);
2697 int filemap_page_mkwrite(struct vm_fault *vmf)
2699 struct page *page = vmf->page;
2700 struct inode *inode = file_inode(vmf->vma->vm_file);
2701 int ret = VM_FAULT_LOCKED;
2703 sb_start_pagefault(inode->i_sb);
2704 file_update_time(vmf->vma->vm_file);
2706 if (page->mapping != inode->i_mapping) {
2708 ret = VM_FAULT_NOPAGE;
2712 * We mark the page dirty already here so that when freeze is in
2713 * progress, we are guaranteed that writeback during freezing will
2714 * see the dirty page and writeprotect it again.
2716 set_page_dirty(page);
2717 wait_for_stable_page(page);
2719 sb_end_pagefault(inode->i_sb);
2722 EXPORT_SYMBOL(filemap_page_mkwrite);
2724 const struct vm_operations_struct generic_file_vm_ops = {
2725 .fault = filemap_fault,
2726 .map_pages = filemap_map_pages,
2727 .page_mkwrite = filemap_page_mkwrite,
2730 /* This is used for a general mmap of a disk file */
2732 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2734 struct address_space *mapping = file->f_mapping;
2736 if (!mapping->a_ops->readpage)
2738 file_accessed(file);
2739 vma->vm_ops = &generic_file_vm_ops;
2744 * This is for filesystems which do not implement ->writepage.
2746 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2748 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2750 return generic_file_mmap(file, vma);
2753 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2757 int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2761 #endif /* CONFIG_MMU */
2763 EXPORT_SYMBOL(generic_file_mmap);
2764 EXPORT_SYMBOL(generic_file_readonly_mmap);
2766 static struct page *wait_on_page_read(struct page *page)
2768 if (!IS_ERR(page)) {
2769 wait_on_page_locked(page);
2770 if (!PageUptodate(page)) {
2772 page = ERR_PTR(-EIO);
2778 static struct page *do_read_cache_page(struct address_space *mapping,
2780 int (*filler)(void *, struct page *),
2787 page = find_get_page(mapping, index);
2789 page = __page_cache_alloc(gfp);
2791 return ERR_PTR(-ENOMEM);
2792 err = add_to_page_cache_lru(page, mapping, index, gfp);
2793 if (unlikely(err)) {
2797 /* Presumably ENOMEM for radix tree node */
2798 return ERR_PTR(err);
2802 err = filler(data, page);
2805 return ERR_PTR(err);
2808 page = wait_on_page_read(page);
2813 if (PageUptodate(page))
2817 * Page is not up to date and may be locked due one of the following
2818 * case a: Page is being filled and the page lock is held
2819 * case b: Read/write error clearing the page uptodate status
2820 * case c: Truncation in progress (page locked)
2821 * case d: Reclaim in progress
2823 * Case a, the page will be up to date when the page is unlocked.
2824 * There is no need to serialise on the page lock here as the page
2825 * is pinned so the lock gives no additional protection. Even if the
2826 * the page is truncated, the data is still valid if PageUptodate as
2827 * it's a race vs truncate race.
2828 * Case b, the page will not be up to date
2829 * Case c, the page may be truncated but in itself, the data may still
2830 * be valid after IO completes as it's a read vs truncate race. The
2831 * operation must restart if the page is not uptodate on unlock but
2832 * otherwise serialising on page lock to stabilise the mapping gives
2833 * no additional guarantees to the caller as the page lock is
2834 * released before return.
2835 * Case d, similar to truncation. If reclaim holds the page lock, it
2836 * will be a race with remove_mapping that determines if the mapping
2837 * is valid on unlock but otherwise the data is valid and there is
2838 * no need to serialise with page lock.
2840 * As the page lock gives no additional guarantee, we optimistically
2841 * wait on the page to be unlocked and check if it's up to date and
2842 * use the page if it is. Otherwise, the page lock is required to
2843 * distinguish between the different cases. The motivation is that we
2844 * avoid spurious serialisations and wakeups when multiple processes
2845 * wait on the same page for IO to complete.
2847 wait_on_page_locked(page);
2848 if (PageUptodate(page))
2851 /* Distinguish between all the cases under the safety of the lock */
2854 /* Case c or d, restart the operation */
2855 if (!page->mapping) {
2861 /* Someone else locked and filled the page in a very small window */
2862 if (PageUptodate(page)) {
2869 mark_page_accessed(page);
2874 * read_cache_page - read into page cache, fill it if needed
2875 * @mapping: the page's address_space
2876 * @index: the page index
2877 * @filler: function to perform the read
2878 * @data: first arg to filler(data, page) function, often left as NULL
2880 * Read into the page cache. If a page already exists, and PageUptodate() is
2881 * not set, try to fill the page and wait for it to become unlocked.
2883 * If the page does not get brought uptodate, return -EIO.
2885 struct page *read_cache_page(struct address_space *mapping,
2887 int (*filler)(void *, struct page *),
2890 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2892 EXPORT_SYMBOL(read_cache_page);
2895 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2896 * @mapping: the page's address_space
2897 * @index: the page index
2898 * @gfp: the page allocator flags to use if allocating
2900 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
2901 * any new page allocations done using the specified allocation flags.
2903 * If the page does not get brought uptodate, return -EIO.
2905 struct page *read_cache_page_gfp(struct address_space *mapping,
2909 filler_t *filler = (filler_t *)mapping->a_ops->readpage;
2911 return do_read_cache_page(mapping, index, filler, NULL, gfp);
2913 EXPORT_SYMBOL(read_cache_page_gfp);
2916 * Performs necessary checks before doing a write
2918 * Can adjust writing position or amount of bytes to write.
2919 * Returns appropriate error code that caller should return or
2920 * zero in case that write should be allowed.
2922 inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
2924 struct file *file = iocb->ki_filp;
2925 struct inode *inode = file->f_mapping->host;
2926 unsigned long limit = rlimit(RLIMIT_FSIZE);
2929 if (!iov_iter_count(from))
2932 /* FIXME: this is for backwards compatibility with 2.4 */
2933 if (iocb->ki_flags & IOCB_APPEND)
2934 iocb->ki_pos = i_size_read(inode);
2938 if ((iocb->ki_flags & IOCB_NOWAIT) && !(iocb->ki_flags & IOCB_DIRECT))
2941 if (limit != RLIM_INFINITY) {
2942 if (iocb->ki_pos >= limit) {
2943 send_sig(SIGXFSZ, current, 0);
2946 iov_iter_truncate(from, limit - (unsigned long)pos);
2952 if (unlikely(pos + iov_iter_count(from) > MAX_NON_LFS &&
2953 !(file->f_flags & O_LARGEFILE))) {
2954 if (pos >= MAX_NON_LFS)
2956 iov_iter_truncate(from, MAX_NON_LFS - (unsigned long)pos);
2960 * Are we about to exceed the fs block limit ?
2962 * If we have written data it becomes a short write. If we have
2963 * exceeded without writing data we send a signal and return EFBIG.
2964 * Linus frestrict idea will clean these up nicely..
2966 if (unlikely(pos >= inode->i_sb->s_maxbytes))
2969 iov_iter_truncate(from, inode->i_sb->s_maxbytes - pos);
2970 return iov_iter_count(from);
2972 EXPORT_SYMBOL(generic_write_checks);
2974 int pagecache_write_begin(struct file *file, struct address_space *mapping,
2975 loff_t pos, unsigned len, unsigned flags,
2976 struct page **pagep, void **fsdata)
2978 const struct address_space_operations *aops = mapping->a_ops;
2980 return aops->write_begin(file, mapping, pos, len, flags,
2983 EXPORT_SYMBOL(pagecache_write_begin);
2985 int pagecache_write_end(struct file *file, struct address_space *mapping,
2986 loff_t pos, unsigned len, unsigned copied,
2987 struct page *page, void *fsdata)
2989 const struct address_space_operations *aops = mapping->a_ops;
2991 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
2993 EXPORT_SYMBOL(pagecache_write_end);
2996 generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
2998 struct file *file = iocb->ki_filp;
2999 struct address_space *mapping = file->f_mapping;
3000 struct inode *inode = mapping->host;
3001 loff_t pos = iocb->ki_pos;
3006 write_len = iov_iter_count(from);
3007 end = (pos + write_len - 1) >> PAGE_SHIFT;
3009 if (iocb->ki_flags & IOCB_NOWAIT) {
3010 /* If there are pages to writeback, return */
3011 if (filemap_range_has_page(inode->i_mapping, pos,
3012 pos + iov_iter_count(from)))
3015 written = filemap_write_and_wait_range(mapping, pos,
3016 pos + write_len - 1);
3022 * After a write we want buffered reads to be sure to go to disk to get
3023 * the new data. We invalidate clean cached page from the region we're
3024 * about to write. We do this *before* the write so that we can return
3025 * without clobbering -EIOCBQUEUED from ->direct_IO().
3027 written = invalidate_inode_pages2_range(mapping,
3028 pos >> PAGE_SHIFT, end);
3030 * If a page can not be invalidated, return 0 to fall back
3031 * to buffered write.
3034 if (written == -EBUSY)
3039 written = mapping->a_ops->direct_IO(iocb, from);
3042 * Finally, try again to invalidate clean pages which might have been
3043 * cached by non-direct readahead, or faulted in by get_user_pages()
3044 * if the source of the write was an mmap'ed region of the file
3045 * we're writing. Either one is a pretty crazy thing to do,
3046 * so we don't support it 100%. If this invalidation
3047 * fails, tough, the write still worked...
3049 * Most of the time we do not need this since dio_complete() will do
3050 * the invalidation for us. However there are some file systems that
3051 * do not end up with dio_complete() being called, so let's not break
3052 * them by removing it completely
3054 if (mapping->nrpages)
3055 invalidate_inode_pages2_range(mapping,
3056 pos >> PAGE_SHIFT, end);
3060 write_len -= written;
3061 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3062 i_size_write(inode, pos);
3063 mark_inode_dirty(inode);
3067 iov_iter_revert(from, write_len - iov_iter_count(from));
3071 EXPORT_SYMBOL(generic_file_direct_write);
3074 * Find or create a page at the given pagecache position. Return the locked
3075 * page. This function is specifically for buffered writes.
3077 struct page *grab_cache_page_write_begin(struct address_space *mapping,
3078 pgoff_t index, unsigned flags)
3081 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
3083 if (flags & AOP_FLAG_NOFS)
3084 fgp_flags |= FGP_NOFS;
3086 page = pagecache_get_page(mapping, index, fgp_flags,
3087 mapping_gfp_mask(mapping));
3089 wait_for_stable_page(page);
3093 EXPORT_SYMBOL(grab_cache_page_write_begin);
3095 ssize_t generic_perform_write(struct file *file,
3096 struct iov_iter *i, loff_t pos)
3098 struct address_space *mapping = file->f_mapping;
3099 const struct address_space_operations *a_ops = mapping->a_ops;
3101 ssize_t written = 0;
3102 unsigned int flags = 0;
3106 unsigned long offset; /* Offset into pagecache page */
3107 unsigned long bytes; /* Bytes to write to page */
3108 size_t copied; /* Bytes copied from user */
3111 offset = (pos & (PAGE_SIZE - 1));
3112 bytes = min_t(unsigned long, PAGE_SIZE - offset,
3117 * Bring in the user page that we will copy from _first_.
3118 * Otherwise there's a nasty deadlock on copying from the
3119 * same page as we're writing to, without it being marked
3122 * Not only is this an optimisation, but it is also required
3123 * to check that the address is actually valid, when atomic
3124 * usercopies are used, below.
3126 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3131 if (fatal_signal_pending(current)) {
3136 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
3138 if (unlikely(status < 0))
3141 if (mapping_writably_mapped(mapping))
3142 flush_dcache_page(page);
3144 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
3145 flush_dcache_page(page);
3147 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3149 if (unlikely(status < 0))
3155 iov_iter_advance(i, copied);
3156 if (unlikely(copied == 0)) {
3158 * If we were unable to copy any data at all, we must
3159 * fall back to a single segment length write.
3161 * If we didn't fallback here, we could livelock
3162 * because not all segments in the iov can be copied at
3163 * once without a pagefault.
3165 bytes = min_t(unsigned long, PAGE_SIZE - offset,
3166 iov_iter_single_seg_count(i));
3172 balance_dirty_pages_ratelimited(mapping);
3173 } while (iov_iter_count(i));
3175 return written ? written : status;
3177 EXPORT_SYMBOL(generic_perform_write);
3180 * __generic_file_write_iter - write data to a file
3181 * @iocb: IO state structure (file, offset, etc.)
3182 * @from: iov_iter with data to write
3184 * This function does all the work needed for actually writing data to a
3185 * file. It does all basic checks, removes SUID from the file, updates
3186 * modification times and calls proper subroutines depending on whether we
3187 * do direct IO or a standard buffered write.
3189 * It expects i_mutex to be grabbed unless we work on a block device or similar
3190 * object which does not need locking at all.
3192 * This function does *not* take care of syncing data in case of O_SYNC write.
3193 * A caller has to handle it. This is mainly due to the fact that we want to
3194 * avoid syncing under i_mutex.
3196 ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3198 struct file *file = iocb->ki_filp;
3199 struct address_space * mapping = file->f_mapping;
3200 struct inode *inode = mapping->host;
3201 ssize_t written = 0;
3205 /* We can write back this queue in page reclaim */
3206 current->backing_dev_info = inode_to_bdi(inode);
3207 err = file_remove_privs(file);
3211 err = file_update_time(file);
3215 if (iocb->ki_flags & IOCB_DIRECT) {
3216 loff_t pos, endbyte;
3218 written = generic_file_direct_write(iocb, from);
3220 * If the write stopped short of completing, fall back to
3221 * buffered writes. Some filesystems do this for writes to
3222 * holes, for example. For DAX files, a buffered write will
3223 * not succeed (even if it did, DAX does not handle dirty
3224 * page-cache pages correctly).
3226 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
3229 status = generic_perform_write(file, from, pos = iocb->ki_pos);
3231 * If generic_perform_write() returned a synchronous error
3232 * then we want to return the number of bytes which were
3233 * direct-written, or the error code if that was zero. Note
3234 * that this differs from normal direct-io semantics, which
3235 * will return -EFOO even if some bytes were written.
3237 if (unlikely(status < 0)) {
3242 * We need to ensure that the page cache pages are written to
3243 * disk and invalidated to preserve the expected O_DIRECT
3246 endbyte = pos + status - 1;
3247 err = filemap_write_and_wait_range(mapping, pos, endbyte);
3249 iocb->ki_pos = endbyte + 1;
3251 invalidate_mapping_pages(mapping,
3253 endbyte >> PAGE_SHIFT);
3256 * We don't know how much we wrote, so just return
3257 * the number of bytes which were direct-written
3261 written = generic_perform_write(file, from, iocb->ki_pos);
3262 if (likely(written > 0))
3263 iocb->ki_pos += written;
3266 current->backing_dev_info = NULL;
3267 return written ? written : err;
3269 EXPORT_SYMBOL(__generic_file_write_iter);
3272 * generic_file_write_iter - write data to a file
3273 * @iocb: IO state structure
3274 * @from: iov_iter with data to write
3276 * This is a wrapper around __generic_file_write_iter() to be used by most
3277 * filesystems. It takes care of syncing the file in case of O_SYNC file
3278 * and acquires i_mutex as needed.
3280 ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3282 struct file *file = iocb->ki_filp;
3283 struct inode *inode = file->f_mapping->host;
3287 ret = generic_write_checks(iocb, from);
3289 ret = __generic_file_write_iter(iocb, from);
3290 inode_unlock(inode);
3293 ret = generic_write_sync(iocb, ret);
3296 EXPORT_SYMBOL(generic_file_write_iter);
3299 * try_to_release_page() - release old fs-specific metadata on a page
3301 * @page: the page which the kernel is trying to free
3302 * @gfp_mask: memory allocation flags (and I/O mode)
3304 * The address_space is to try to release any data against the page
3305 * (presumably at page->private). If the release was successful, return '1'.
3306 * Otherwise return zero.
3308 * This may also be called if PG_fscache is set on a page, indicating that the
3309 * page is known to the local caching routines.
3311 * The @gfp_mask argument specifies whether I/O may be performed to release
3312 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
3315 int try_to_release_page(struct page *page, gfp_t gfp_mask)
3317 struct address_space * const mapping = page->mapping;
3319 BUG_ON(!PageLocked(page));
3320 if (PageWriteback(page))
3323 if (mapping && mapping->a_ops->releasepage)
3324 return mapping->a_ops->releasepage(page, gfp_mask);
3325 return try_to_free_buffers(page);
3328 EXPORT_SYMBOL(try_to_release_page);