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>
15 #include <linux/uaccess.h>
16 #include <linux/capability.h>
17 #include <linux/kernel_stat.h>
18 #include <linux/gfp.h>
20 #include <linux/swap.h>
21 #include <linux/mman.h>
22 #include <linux/pagemap.h>
23 #include <linux/file.h>
24 #include <linux/uio.h>
25 #include <linux/hash.h>
26 #include <linux/writeback.h>
27 #include <linux/backing-dev.h>
28 #include <linux/pagevec.h>
29 #include <linux/blkdev.h>
30 #include <linux/security.h>
31 #include <linux/cpuset.h>
32 #include <linux/hardirq.h> /* for BUG_ON(!in_atomic()) only */
33 #include <linux/hugetlb.h>
34 #include <linux/memcontrol.h>
35 #include <linux/cleancache.h>
36 #include <linux/rmap.h>
39 #define CREATE_TRACE_POINTS
40 #include <trace/events/filemap.h>
43 * FIXME: remove all knowledge of the buffer layer from the core VM
45 #include <linux/buffer_head.h> /* for try_to_free_buffers */
50 * Shared mappings implemented 30.11.1994. It's not fully working yet,
53 * Shared mappings now work. 15.8.1995 Bruno.
55 * finished 'unifying' the page and buffer cache and SMP-threaded the
64 * ->i_mmap_rwsem (truncate_pagecache)
65 * ->private_lock (__free_pte->__set_page_dirty_buffers)
66 * ->swap_lock (exclusive_swap_page, others)
67 * ->mapping->tree_lock
70 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
74 * ->page_table_lock or pte_lock (various, mainly in memory.c)
75 * ->mapping->tree_lock (arch-dependent flush_dcache_mmap_lock)
78 * ->lock_page (access_process_vm)
80 * ->i_mutex (generic_perform_write)
81 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
84 * sb_lock (fs/fs-writeback.c)
85 * ->mapping->tree_lock (__sync_single_inode)
88 * ->anon_vma.lock (vma_adjust)
91 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
93 * ->page_table_lock or pte_lock
94 * ->swap_lock (try_to_unmap_one)
95 * ->private_lock (try_to_unmap_one)
96 * ->tree_lock (try_to_unmap_one)
97 * ->zone.lru_lock (follow_page->mark_page_accessed)
98 * ->zone.lru_lock (check_pte_range->isolate_lru_page)
99 * ->private_lock (page_remove_rmap->set_page_dirty)
100 * ->tree_lock (page_remove_rmap->set_page_dirty)
101 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
102 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
103 * ->memcg->move_lock (page_remove_rmap->mem_cgroup_begin_page_stat)
104 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
105 * ->inode->i_lock (zap_pte_range->set_page_dirty)
106 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
109 * ->tasklist_lock (memory_failure, collect_procs_ao)
112 static void page_cache_tree_delete(struct address_space *mapping,
113 struct page *page, void *shadow)
115 struct radix_tree_node *node;
121 VM_BUG_ON(!PageLocked(page));
123 __radix_tree_lookup(&mapping->page_tree, page->index, &node, &slot);
126 mapping->nrshadows++;
128 * Make sure the nrshadows update is committed before
129 * the nrpages update so that final truncate racing
130 * with reclaim does not see both counters 0 at the
131 * same time and miss a shadow entry.
138 /* Clear direct pointer tags in root node */
139 mapping->page_tree.gfp_mask &= __GFP_BITS_MASK;
140 radix_tree_replace_slot(slot, shadow);
144 /* Clear tree tags for the removed page */
146 offset = index & RADIX_TREE_MAP_MASK;
147 for (tag = 0; tag < RADIX_TREE_MAX_TAGS; tag++) {
148 if (test_bit(offset, node->tags[tag]))
149 radix_tree_tag_clear(&mapping->page_tree, index, tag);
152 /* Delete page, swap shadow entry */
153 radix_tree_replace_slot(slot, shadow);
154 workingset_node_pages_dec(node);
156 workingset_node_shadows_inc(node);
158 if (__radix_tree_delete_node(&mapping->page_tree, node))
162 * Track node that only contains shadow entries.
164 * Avoid acquiring the list_lru lock if already tracked. The
165 * list_empty() test is safe as node->private_list is
166 * protected by mapping->tree_lock.
168 if (!workingset_node_pages(node) &&
169 list_empty(&node->private_list)) {
170 node->private_data = mapping;
171 list_lru_add(&workingset_shadow_nodes, &node->private_list);
176 * Delete a page from the page cache and free it. Caller has to make
177 * sure the page is locked and that nobody else uses it - or that usage
178 * is safe. The caller must hold the mapping's tree_lock and
179 * mem_cgroup_begin_page_stat().
181 void __delete_from_page_cache(struct page *page, void *shadow,
182 struct mem_cgroup *memcg)
184 struct address_space *mapping = page->mapping;
186 trace_mm_filemap_delete_from_page_cache(page);
188 * if we're uptodate, flush out into the cleancache, otherwise
189 * invalidate any existing cleancache entries. We can't leave
190 * stale data around in the cleancache once our page is gone
192 if (PageUptodate(page) && PageMappedToDisk(page))
193 cleancache_put_page(page);
195 cleancache_invalidate_page(mapping, page);
197 page_cache_tree_delete(mapping, page, shadow);
199 page->mapping = NULL;
200 /* Leave page->index set: truncation lookup relies upon it */
202 /* hugetlb pages do not participate in page cache accounting. */
204 __dec_zone_page_state(page, NR_FILE_PAGES);
205 if (PageSwapBacked(page))
206 __dec_zone_page_state(page, NR_SHMEM);
207 VM_BUG_ON_PAGE(page_mapped(page), page);
210 * At this point page must be either written or cleaned by truncate.
211 * Dirty page here signals a bug and loss of unwritten data.
213 * This fixes dirty accounting after removing the page entirely but
214 * leaves PageDirty set: it has no effect for truncated page and
215 * anyway will be cleared before returning page into buddy allocator.
217 if (WARN_ON_ONCE(PageDirty(page)))
218 account_page_cleaned(page, mapping, memcg,
219 inode_to_wb(mapping->host));
223 * delete_from_page_cache - delete page from page cache
224 * @page: the page which the kernel is trying to remove from page cache
226 * This must be called only on pages that have been verified to be in the page
227 * cache and locked. It will never put the page into the free list, the caller
228 * has a reference on the page.
230 void delete_from_page_cache(struct page *page)
232 struct address_space *mapping = page->mapping;
233 struct mem_cgroup *memcg;
236 void (*freepage)(struct page *);
238 BUG_ON(!PageLocked(page));
240 freepage = mapping->a_ops->freepage;
242 memcg = mem_cgroup_begin_page_stat(page);
243 spin_lock_irqsave(&mapping->tree_lock, flags);
244 __delete_from_page_cache(page, NULL, memcg);
245 spin_unlock_irqrestore(&mapping->tree_lock, flags);
246 mem_cgroup_end_page_stat(memcg);
250 page_cache_release(page);
252 EXPORT_SYMBOL(delete_from_page_cache);
254 static int filemap_check_errors(struct address_space *mapping)
257 /* Check for outstanding write errors */
258 if (test_bit(AS_ENOSPC, &mapping->flags) &&
259 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
261 if (test_bit(AS_EIO, &mapping->flags) &&
262 test_and_clear_bit(AS_EIO, &mapping->flags))
268 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
269 * @mapping: address space structure to write
270 * @start: offset in bytes where the range starts
271 * @end: offset in bytes where the range ends (inclusive)
272 * @sync_mode: enable synchronous operation
274 * Start writeback against all of a mapping's dirty pages that lie
275 * within the byte offsets <start, end> inclusive.
277 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
278 * opposed to a regular memory cleansing writeback. The difference between
279 * these two operations is that if a dirty page/buffer is encountered, it must
280 * be waited upon, and not just skipped over.
282 int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
283 loff_t end, int sync_mode)
286 struct writeback_control wbc = {
287 .sync_mode = sync_mode,
288 .nr_to_write = LONG_MAX,
289 .range_start = start,
293 if (!mapping_cap_writeback_dirty(mapping))
296 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
297 ret = do_writepages(mapping, &wbc);
298 wbc_detach_inode(&wbc);
302 static inline int __filemap_fdatawrite(struct address_space *mapping,
305 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
308 int filemap_fdatawrite(struct address_space *mapping)
310 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
312 EXPORT_SYMBOL(filemap_fdatawrite);
314 int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
317 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
319 EXPORT_SYMBOL(filemap_fdatawrite_range);
322 * filemap_flush - mostly a non-blocking flush
323 * @mapping: target address_space
325 * This is a mostly non-blocking flush. Not suitable for data-integrity
326 * purposes - I/O may not be started against all dirty pages.
328 int filemap_flush(struct address_space *mapping)
330 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
332 EXPORT_SYMBOL(filemap_flush);
334 static int __filemap_fdatawait_range(struct address_space *mapping,
335 loff_t start_byte, loff_t end_byte)
337 pgoff_t index = start_byte >> PAGE_CACHE_SHIFT;
338 pgoff_t end = end_byte >> PAGE_CACHE_SHIFT;
343 if (end_byte < start_byte)
346 pagevec_init(&pvec, 0);
347 while ((index <= end) &&
348 (nr_pages = pagevec_lookup_tag(&pvec, mapping, &index,
349 PAGECACHE_TAG_WRITEBACK,
350 min(end - index, (pgoff_t)PAGEVEC_SIZE-1) + 1)) != 0) {
353 for (i = 0; i < nr_pages; i++) {
354 struct page *page = pvec.pages[i];
356 /* until radix tree lookup accepts end_index */
357 if (page->index > end)
360 wait_on_page_writeback(page);
361 if (TestClearPageError(page))
364 pagevec_release(&pvec);
372 * filemap_fdatawait_range - wait for writeback to complete
373 * @mapping: address space structure to wait for
374 * @start_byte: offset in bytes where the range starts
375 * @end_byte: offset in bytes where the range ends (inclusive)
377 * Walk the list of under-writeback pages of the given address space
378 * in the given range and wait for all of them. Check error status of
379 * the address space and return it.
381 * Since the error status of the address space is cleared by this function,
382 * callers are responsible for checking the return value and handling and/or
383 * reporting the error.
385 int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
390 ret = __filemap_fdatawait_range(mapping, start_byte, end_byte);
391 ret2 = filemap_check_errors(mapping);
397 EXPORT_SYMBOL(filemap_fdatawait_range);
400 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
401 * @mapping: address space structure to wait for
403 * Walk the list of under-writeback pages of the given address space
404 * and wait for all of them. Unlike filemap_fdatawait(), this function
405 * does not clear error status of the address space.
407 * Use this function if callers don't handle errors themselves. Expected
408 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
411 void filemap_fdatawait_keep_errors(struct address_space *mapping)
413 loff_t i_size = i_size_read(mapping->host);
418 __filemap_fdatawait_range(mapping, 0, i_size - 1);
422 * filemap_fdatawait - wait for all under-writeback pages to complete
423 * @mapping: address space structure to wait for
425 * Walk the list of under-writeback pages of the given address space
426 * and wait for all of them. Check error status of the address space
429 * Since the error status of the address space is cleared by this function,
430 * callers are responsible for checking the return value and handling and/or
431 * reporting the error.
433 int filemap_fdatawait(struct address_space *mapping)
435 loff_t i_size = i_size_read(mapping->host);
440 return filemap_fdatawait_range(mapping, 0, i_size - 1);
442 EXPORT_SYMBOL(filemap_fdatawait);
444 int filemap_write_and_wait(struct address_space *mapping)
448 if (mapping->nrpages) {
449 err = filemap_fdatawrite(mapping);
451 * Even if the above returned error, the pages may be
452 * written partially (e.g. -ENOSPC), so we wait for it.
453 * But the -EIO is special case, it may indicate the worst
454 * thing (e.g. bug) happened, so we avoid waiting for it.
457 int err2 = filemap_fdatawait(mapping);
462 err = filemap_check_errors(mapping);
466 EXPORT_SYMBOL(filemap_write_and_wait);
469 * filemap_write_and_wait_range - write out & wait on a file range
470 * @mapping: the address_space for the pages
471 * @lstart: offset in bytes where the range starts
472 * @lend: offset in bytes where the range ends (inclusive)
474 * Write out and wait upon file offsets lstart->lend, inclusive.
476 * Note that `lend' is inclusive (describes the last byte to be written) so
477 * that this function can be used to write to the very end-of-file (end = -1).
479 int filemap_write_and_wait_range(struct address_space *mapping,
480 loff_t lstart, loff_t lend)
484 if (mapping->nrpages) {
485 err = __filemap_fdatawrite_range(mapping, lstart, lend,
487 /* See comment of filemap_write_and_wait() */
489 int err2 = filemap_fdatawait_range(mapping,
495 err = filemap_check_errors(mapping);
499 EXPORT_SYMBOL(filemap_write_and_wait_range);
502 * replace_page_cache_page - replace a pagecache page with a new one
503 * @old: page to be replaced
504 * @new: page to replace with
505 * @gfp_mask: allocation mode
507 * This function replaces a page in the pagecache with a new one. On
508 * success it acquires the pagecache reference for the new page and
509 * drops it for the old page. Both the old and new pages must be
510 * locked. This function does not add the new page to the LRU, the
511 * caller must do that.
513 * The remove + add is atomic. The only way this function can fail is
514 * memory allocation failure.
516 int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
520 VM_BUG_ON_PAGE(!PageLocked(old), old);
521 VM_BUG_ON_PAGE(!PageLocked(new), new);
522 VM_BUG_ON_PAGE(new->mapping, new);
524 error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
526 struct address_space *mapping = old->mapping;
527 void (*freepage)(struct page *);
528 struct mem_cgroup *memcg;
531 pgoff_t offset = old->index;
532 freepage = mapping->a_ops->freepage;
535 new->mapping = mapping;
538 memcg = mem_cgroup_begin_page_stat(old);
539 spin_lock_irqsave(&mapping->tree_lock, flags);
540 __delete_from_page_cache(old, NULL, memcg);
541 error = radix_tree_insert(&mapping->page_tree, offset, new);
546 * hugetlb pages do not participate in page cache accounting.
549 __inc_zone_page_state(new, NR_FILE_PAGES);
550 if (PageSwapBacked(new))
551 __inc_zone_page_state(new, NR_SHMEM);
552 spin_unlock_irqrestore(&mapping->tree_lock, flags);
553 mem_cgroup_end_page_stat(memcg);
554 mem_cgroup_replace_page(old, new);
555 radix_tree_preload_end();
558 page_cache_release(old);
563 EXPORT_SYMBOL_GPL(replace_page_cache_page);
565 static int page_cache_tree_insert(struct address_space *mapping,
566 struct page *page, void **shadowp)
568 struct radix_tree_node *node;
572 error = __radix_tree_create(&mapping->page_tree, page->index,
579 p = radix_tree_deref_slot_protected(slot, &mapping->tree_lock);
580 if (!radix_tree_exceptional_entry(p))
584 mapping->nrshadows--;
586 workingset_node_shadows_dec(node);
588 radix_tree_replace_slot(slot, page);
591 workingset_node_pages_inc(node);
593 * Don't track node that contains actual pages.
595 * Avoid acquiring the list_lru lock if already
596 * untracked. The list_empty() test is safe as
597 * node->private_list is protected by
598 * mapping->tree_lock.
600 if (!list_empty(&node->private_list))
601 list_lru_del(&workingset_shadow_nodes,
602 &node->private_list);
607 static int __add_to_page_cache_locked(struct page *page,
608 struct address_space *mapping,
609 pgoff_t offset, gfp_t gfp_mask,
612 int huge = PageHuge(page);
613 struct mem_cgroup *memcg;
616 VM_BUG_ON_PAGE(!PageLocked(page), page);
617 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
620 error = mem_cgroup_try_charge(page, current->mm,
621 gfp_mask, &memcg, false);
626 error = radix_tree_maybe_preload(gfp_mask & ~__GFP_HIGHMEM);
629 mem_cgroup_cancel_charge(page, memcg, false);
633 page_cache_get(page);
634 page->mapping = mapping;
635 page->index = offset;
637 spin_lock_irq(&mapping->tree_lock);
638 error = page_cache_tree_insert(mapping, page, shadowp);
639 radix_tree_preload_end();
643 /* hugetlb pages do not participate in page cache accounting. */
645 __inc_zone_page_state(page, NR_FILE_PAGES);
646 spin_unlock_irq(&mapping->tree_lock);
648 mem_cgroup_commit_charge(page, memcg, false, false);
649 trace_mm_filemap_add_to_page_cache(page);
652 page->mapping = NULL;
653 /* Leave page->index set: truncation relies upon it */
654 spin_unlock_irq(&mapping->tree_lock);
656 mem_cgroup_cancel_charge(page, memcg, false);
657 page_cache_release(page);
662 * add_to_page_cache_locked - add a locked page to the pagecache
664 * @mapping: the page's address_space
665 * @offset: page index
666 * @gfp_mask: page allocation mode
668 * This function is used to add a page to the pagecache. It must be locked.
669 * This function does not add the page to the LRU. The caller must do that.
671 int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
672 pgoff_t offset, gfp_t gfp_mask)
674 return __add_to_page_cache_locked(page, mapping, offset,
677 EXPORT_SYMBOL(add_to_page_cache_locked);
679 int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
680 pgoff_t offset, gfp_t gfp_mask)
685 __SetPageLocked(page);
686 ret = __add_to_page_cache_locked(page, mapping, offset,
689 __ClearPageLocked(page);
692 * The page might have been evicted from cache only
693 * recently, in which case it should be activated like
694 * any other repeatedly accessed page.
696 if (shadow && workingset_refault(shadow)) {
698 workingset_activation(page);
700 ClearPageActive(page);
705 EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
708 struct page *__page_cache_alloc(gfp_t gfp)
713 if (cpuset_do_page_mem_spread()) {
714 unsigned int cpuset_mems_cookie;
716 cpuset_mems_cookie = read_mems_allowed_begin();
717 n = cpuset_mem_spread_node();
718 page = __alloc_pages_node(n, gfp, 0);
719 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
723 return alloc_pages(gfp, 0);
725 EXPORT_SYMBOL(__page_cache_alloc);
729 * In order to wait for pages to become available there must be
730 * waitqueues associated with pages. By using a hash table of
731 * waitqueues where the bucket discipline is to maintain all
732 * waiters on the same queue and wake all when any of the pages
733 * become available, and for the woken contexts to check to be
734 * sure the appropriate page became available, this saves space
735 * at a cost of "thundering herd" phenomena during rare hash
738 wait_queue_head_t *page_waitqueue(struct page *page)
740 const struct zone *zone = page_zone(page);
742 return &zone->wait_table[hash_ptr(page, zone->wait_table_bits)];
744 EXPORT_SYMBOL(page_waitqueue);
746 void wait_on_page_bit(struct page *page, int bit_nr)
748 DEFINE_WAIT_BIT(wait, &page->flags, bit_nr);
750 if (test_bit(bit_nr, &page->flags))
751 __wait_on_bit(page_waitqueue(page), &wait, bit_wait_io,
752 TASK_UNINTERRUPTIBLE);
754 EXPORT_SYMBOL(wait_on_page_bit);
756 int wait_on_page_bit_killable(struct page *page, int bit_nr)
758 DEFINE_WAIT_BIT(wait, &page->flags, bit_nr);
760 if (!test_bit(bit_nr, &page->flags))
763 return __wait_on_bit(page_waitqueue(page), &wait,
764 bit_wait_io, TASK_KILLABLE);
767 int wait_on_page_bit_killable_timeout(struct page *page,
768 int bit_nr, unsigned long timeout)
770 DEFINE_WAIT_BIT(wait, &page->flags, bit_nr);
772 wait.key.timeout = jiffies + timeout;
773 if (!test_bit(bit_nr, &page->flags))
775 return __wait_on_bit(page_waitqueue(page), &wait,
776 bit_wait_io_timeout, TASK_KILLABLE);
778 EXPORT_SYMBOL_GPL(wait_on_page_bit_killable_timeout);
781 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
782 * @page: Page defining the wait queue of interest
783 * @waiter: Waiter to add to the queue
785 * Add an arbitrary @waiter to the wait queue for the nominated @page.
787 void add_page_wait_queue(struct page *page, wait_queue_t *waiter)
789 wait_queue_head_t *q = page_waitqueue(page);
792 spin_lock_irqsave(&q->lock, flags);
793 __add_wait_queue(q, waiter);
794 spin_unlock_irqrestore(&q->lock, flags);
796 EXPORT_SYMBOL_GPL(add_page_wait_queue);
799 * unlock_page - unlock a locked page
802 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
803 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
804 * mechanism between PageLocked pages and PageWriteback pages is shared.
805 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
807 * The mb is necessary to enforce ordering between the clear_bit and the read
808 * of the waitqueue (to avoid SMP races with a parallel wait_on_page_locked()).
810 void unlock_page(struct page *page)
812 page = compound_head(page);
813 VM_BUG_ON_PAGE(!PageLocked(page), page);
814 clear_bit_unlock(PG_locked, &page->flags);
815 smp_mb__after_atomic();
816 wake_up_page(page, PG_locked);
818 EXPORT_SYMBOL(unlock_page);
821 * end_page_writeback - end writeback against a page
824 void end_page_writeback(struct page *page)
827 * TestClearPageReclaim could be used here but it is an atomic
828 * operation and overkill in this particular case. Failing to
829 * shuffle a page marked for immediate reclaim is too mild to
830 * justify taking an atomic operation penalty at the end of
831 * ever page writeback.
833 if (PageReclaim(page)) {
834 ClearPageReclaim(page);
835 rotate_reclaimable_page(page);
838 if (!test_clear_page_writeback(page))
841 smp_mb__after_atomic();
842 wake_up_page(page, PG_writeback);
844 EXPORT_SYMBOL(end_page_writeback);
847 * After completing I/O on a page, call this routine to update the page
848 * flags appropriately
850 void page_endio(struct page *page, int rw, int err)
854 SetPageUptodate(page);
856 ClearPageUptodate(page);
860 } else { /* rw == WRITE */
864 mapping_set_error(page->mapping, err);
866 end_page_writeback(page);
869 EXPORT_SYMBOL_GPL(page_endio);
872 * __lock_page - get a lock on the page, assuming we need to sleep to get it
873 * @page: the page to lock
875 void __lock_page(struct page *page)
877 struct page *page_head = compound_head(page);
878 DEFINE_WAIT_BIT(wait, &page_head->flags, PG_locked);
880 __wait_on_bit_lock(page_waitqueue(page_head), &wait, bit_wait_io,
881 TASK_UNINTERRUPTIBLE);
883 EXPORT_SYMBOL(__lock_page);
885 int __lock_page_killable(struct page *page)
887 struct page *page_head = compound_head(page);
888 DEFINE_WAIT_BIT(wait, &page_head->flags, PG_locked);
890 return __wait_on_bit_lock(page_waitqueue(page_head), &wait,
891 bit_wait_io, TASK_KILLABLE);
893 EXPORT_SYMBOL_GPL(__lock_page_killable);
897 * 1 - page is locked; mmap_sem is still held.
898 * 0 - page is not locked.
899 * mmap_sem has been released (up_read()), unless flags had both
900 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
901 * which case mmap_sem is still held.
903 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
904 * with the page locked and the mmap_sem unperturbed.
906 int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
909 if (flags & FAULT_FLAG_ALLOW_RETRY) {
911 * CAUTION! In this case, mmap_sem is not released
912 * even though return 0.
914 if (flags & FAULT_FLAG_RETRY_NOWAIT)
917 up_read(&mm->mmap_sem);
918 if (flags & FAULT_FLAG_KILLABLE)
919 wait_on_page_locked_killable(page);
921 wait_on_page_locked(page);
924 if (flags & FAULT_FLAG_KILLABLE) {
927 ret = __lock_page_killable(page);
929 up_read(&mm->mmap_sem);
939 * page_cache_next_hole - find the next hole (not-present entry)
942 * @max_scan: maximum range to search
944 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the
945 * lowest indexed hole.
947 * Returns: the index of the hole if found, otherwise returns an index
948 * outside of the set specified (in which case 'return - index >=
949 * max_scan' will be true). In rare cases of index wrap-around, 0 will
952 * page_cache_next_hole may be called under rcu_read_lock. However,
953 * like radix_tree_gang_lookup, this will not atomically search a
954 * snapshot of the tree at a single point in time. For example, if a
955 * hole is created at index 5, then subsequently a hole is created at
956 * index 10, page_cache_next_hole covering both indexes may return 10
957 * if called under rcu_read_lock.
959 pgoff_t page_cache_next_hole(struct address_space *mapping,
960 pgoff_t index, unsigned long max_scan)
964 for (i = 0; i < max_scan; i++) {
967 page = radix_tree_lookup(&mapping->page_tree, index);
968 if (!page || radix_tree_exceptional_entry(page))
977 EXPORT_SYMBOL(page_cache_next_hole);
980 * page_cache_prev_hole - find the prev hole (not-present entry)
983 * @max_scan: maximum range to search
985 * Search backwards in the range [max(index-max_scan+1, 0), index] for
988 * Returns: the index of the hole if found, otherwise returns an index
989 * outside of the set specified (in which case 'index - return >=
990 * max_scan' will be true). In rare cases of wrap-around, ULONG_MAX
993 * page_cache_prev_hole may be called under rcu_read_lock. However,
994 * like radix_tree_gang_lookup, this will not atomically search a
995 * snapshot of the tree at a single point in time. For example, if a
996 * hole is created at index 10, then subsequently a hole is created at
997 * index 5, page_cache_prev_hole covering both indexes may return 5 if
998 * called under rcu_read_lock.
1000 pgoff_t page_cache_prev_hole(struct address_space *mapping,
1001 pgoff_t index, unsigned long max_scan)
1005 for (i = 0; i < max_scan; i++) {
1008 page = radix_tree_lookup(&mapping->page_tree, index);
1009 if (!page || radix_tree_exceptional_entry(page))
1012 if (index == ULONG_MAX)
1018 EXPORT_SYMBOL(page_cache_prev_hole);
1021 * find_get_entry - find and get a page cache entry
1022 * @mapping: the address_space to search
1023 * @offset: the page cache index
1025 * Looks up the page cache slot at @mapping & @offset. If there is a
1026 * page cache page, it is returned with an increased refcount.
1028 * If the slot holds a shadow entry of a previously evicted page, or a
1029 * swap entry from shmem/tmpfs, it is returned.
1031 * Otherwise, %NULL is returned.
1033 struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
1041 pagep = radix_tree_lookup_slot(&mapping->page_tree, offset);
1043 page = radix_tree_deref_slot(pagep);
1044 if (unlikely(!page))
1046 if (radix_tree_exception(page)) {
1047 if (radix_tree_deref_retry(page))
1050 * A shadow entry of a recently evicted page,
1051 * or a swap entry from shmem/tmpfs. Return
1052 * it without attempting to raise page count.
1056 if (!page_cache_get_speculative(page))
1060 * Has the page moved?
1061 * This is part of the lockless pagecache protocol. See
1062 * include/linux/pagemap.h for details.
1064 if (unlikely(page != *pagep)) {
1065 page_cache_release(page);
1074 EXPORT_SYMBOL(find_get_entry);
1077 * find_lock_entry - locate, pin and lock a page cache entry
1078 * @mapping: the address_space to search
1079 * @offset: the page cache index
1081 * Looks up the page cache slot at @mapping & @offset. If there is a
1082 * page cache page, it is returned locked and with an increased
1085 * If the slot holds a shadow entry of a previously evicted page, or a
1086 * swap entry from shmem/tmpfs, it is returned.
1088 * Otherwise, %NULL is returned.
1090 * find_lock_entry() may sleep.
1092 struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
1097 page = find_get_entry(mapping, offset);
1098 if (page && !radix_tree_exception(page)) {
1100 /* Has the page been truncated? */
1101 if (unlikely(page->mapping != mapping)) {
1103 page_cache_release(page);
1106 VM_BUG_ON_PAGE(page->index != offset, page);
1110 EXPORT_SYMBOL(find_lock_entry);
1113 * pagecache_get_page - find and get a page reference
1114 * @mapping: the address_space to search
1115 * @offset: the page index
1116 * @fgp_flags: PCG flags
1117 * @gfp_mask: gfp mask to use for the page cache data page allocation
1119 * Looks up the page cache slot at @mapping & @offset.
1121 * PCG flags modify how the page is returned.
1123 * FGP_ACCESSED: the page will be marked accessed
1124 * FGP_LOCK: Page is return locked
1125 * FGP_CREAT: If page is not present then a new page is allocated using
1126 * @gfp_mask and added to the page cache and the VM's LRU
1127 * list. The page is returned locked and with an increased
1128 * refcount. Otherwise, %NULL is returned.
1130 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1131 * if the GFP flags specified for FGP_CREAT are atomic.
1133 * If there is a page cache page, it is returned with an increased refcount.
1135 struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
1136 int fgp_flags, gfp_t gfp_mask)
1141 page = find_get_entry(mapping, offset);
1142 if (radix_tree_exceptional_entry(page))
1147 if (fgp_flags & FGP_LOCK) {
1148 if (fgp_flags & FGP_NOWAIT) {
1149 if (!trylock_page(page)) {
1150 page_cache_release(page);
1157 /* Has the page been truncated? */
1158 if (unlikely(page->mapping != mapping)) {
1160 page_cache_release(page);
1163 VM_BUG_ON_PAGE(page->index != offset, page);
1166 if (page && (fgp_flags & FGP_ACCESSED))
1167 mark_page_accessed(page);
1170 if (!page && (fgp_flags & FGP_CREAT)) {
1172 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
1173 gfp_mask |= __GFP_WRITE;
1174 if (fgp_flags & FGP_NOFS)
1175 gfp_mask &= ~__GFP_FS;
1177 page = __page_cache_alloc(gfp_mask);
1181 if (WARN_ON_ONCE(!(fgp_flags & FGP_LOCK)))
1182 fgp_flags |= FGP_LOCK;
1184 /* Init accessed so avoid atomic mark_page_accessed later */
1185 if (fgp_flags & FGP_ACCESSED)
1186 __SetPageReferenced(page);
1188 err = add_to_page_cache_lru(page, mapping, offset,
1189 gfp_mask & GFP_RECLAIM_MASK);
1190 if (unlikely(err)) {
1191 page_cache_release(page);
1200 EXPORT_SYMBOL(pagecache_get_page);
1203 * find_get_entries - gang pagecache lookup
1204 * @mapping: The address_space to search
1205 * @start: The starting page cache index
1206 * @nr_entries: The maximum number of entries
1207 * @entries: Where the resulting entries are placed
1208 * @indices: The cache indices corresponding to the entries in @entries
1210 * find_get_entries() will search for and return a group of up to
1211 * @nr_entries entries in the mapping. The entries are placed at
1212 * @entries. find_get_entries() takes a reference against any actual
1215 * The search returns a group of mapping-contiguous page cache entries
1216 * with ascending indexes. There may be holes in the indices due to
1217 * not-present pages.
1219 * Any shadow entries of evicted pages, or swap entries from
1220 * shmem/tmpfs, are included in the returned array.
1222 * find_get_entries() returns the number of pages and shadow entries
1225 unsigned find_get_entries(struct address_space *mapping,
1226 pgoff_t start, unsigned int nr_entries,
1227 struct page **entries, pgoff_t *indices)
1230 unsigned int ret = 0;
1231 struct radix_tree_iter iter;
1238 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
1241 page = radix_tree_deref_slot(slot);
1242 if (unlikely(!page))
1244 if (radix_tree_exception(page)) {
1245 if (radix_tree_deref_retry(page))
1248 * A shadow entry of a recently evicted page,
1249 * or a swap entry from shmem/tmpfs. Return
1250 * it without attempting to raise page count.
1254 if (!page_cache_get_speculative(page))
1257 /* Has the page moved? */
1258 if (unlikely(page != *slot)) {
1259 page_cache_release(page);
1263 indices[ret] = iter.index;
1264 entries[ret] = page;
1265 if (++ret == nr_entries)
1273 * find_get_pages - gang pagecache lookup
1274 * @mapping: The address_space to search
1275 * @start: The starting page index
1276 * @nr_pages: The maximum number of pages
1277 * @pages: Where the resulting pages are placed
1279 * find_get_pages() will search for and return a group of up to
1280 * @nr_pages pages in the mapping. The pages are placed at @pages.
1281 * find_get_pages() takes a reference against the returned pages.
1283 * The search returns a group of mapping-contiguous pages with ascending
1284 * indexes. There may be holes in the indices due to not-present pages.
1286 * find_get_pages() returns the number of pages which were found.
1288 unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
1289 unsigned int nr_pages, struct page **pages)
1291 struct radix_tree_iter iter;
1295 if (unlikely(!nr_pages))
1300 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
1303 page = radix_tree_deref_slot(slot);
1304 if (unlikely(!page))
1307 if (radix_tree_exception(page)) {
1308 if (radix_tree_deref_retry(page)) {
1310 * Transient condition which can only trigger
1311 * when entry at index 0 moves out of or back
1312 * to root: none yet gotten, safe to restart.
1314 WARN_ON(iter.index);
1318 * A shadow entry of a recently evicted page,
1319 * or a swap entry from shmem/tmpfs. Skip
1325 if (!page_cache_get_speculative(page))
1328 /* Has the page moved? */
1329 if (unlikely(page != *slot)) {
1330 page_cache_release(page);
1335 if (++ret == nr_pages)
1344 * find_get_pages_contig - gang contiguous pagecache lookup
1345 * @mapping: The address_space to search
1346 * @index: The starting page index
1347 * @nr_pages: The maximum number of pages
1348 * @pages: Where the resulting pages are placed
1350 * find_get_pages_contig() works exactly like find_get_pages(), except
1351 * that the returned number of pages are guaranteed to be contiguous.
1353 * find_get_pages_contig() returns the number of pages which were found.
1355 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1356 unsigned int nr_pages, struct page **pages)
1358 struct radix_tree_iter iter;
1360 unsigned int ret = 0;
1362 if (unlikely(!nr_pages))
1367 radix_tree_for_each_contig(slot, &mapping->page_tree, &iter, index) {
1370 page = radix_tree_deref_slot(slot);
1371 /* The hole, there no reason to continue */
1372 if (unlikely(!page))
1375 if (radix_tree_exception(page)) {
1376 if (radix_tree_deref_retry(page)) {
1378 * Transient condition which can only trigger
1379 * when entry at index 0 moves out of or back
1380 * to root: none yet gotten, safe to restart.
1385 * A shadow entry of a recently evicted page,
1386 * or a swap entry from shmem/tmpfs. Stop
1387 * looking for contiguous pages.
1392 if (!page_cache_get_speculative(page))
1395 /* Has the page moved? */
1396 if (unlikely(page != *slot)) {
1397 page_cache_release(page);
1402 * must check mapping and index after taking the ref.
1403 * otherwise we can get both false positives and false
1404 * negatives, which is just confusing to the caller.
1406 if (page->mapping == NULL || page->index != iter.index) {
1407 page_cache_release(page);
1412 if (++ret == nr_pages)
1418 EXPORT_SYMBOL(find_get_pages_contig);
1421 * find_get_pages_tag - find and return pages that match @tag
1422 * @mapping: the address_space to search
1423 * @index: the starting page index
1424 * @tag: the tag index
1425 * @nr_pages: the maximum number of pages
1426 * @pages: where the resulting pages are placed
1428 * Like find_get_pages, except we only return pages which are tagged with
1429 * @tag. We update @index to index the next page for the traversal.
1431 unsigned find_get_pages_tag(struct address_space *mapping, pgoff_t *index,
1432 int tag, unsigned int nr_pages, struct page **pages)
1434 struct radix_tree_iter iter;
1438 if (unlikely(!nr_pages))
1443 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1444 &iter, *index, tag) {
1447 page = radix_tree_deref_slot(slot);
1448 if (unlikely(!page))
1451 if (radix_tree_exception(page)) {
1452 if (radix_tree_deref_retry(page)) {
1454 * Transient condition which can only trigger
1455 * when entry at index 0 moves out of or back
1456 * to root: none yet gotten, safe to restart.
1461 * A shadow entry of a recently evicted page.
1463 * Those entries should never be tagged, but
1464 * this tree walk is lockless and the tags are
1465 * looked up in bulk, one radix tree node at a
1466 * time, so there is a sizable window for page
1467 * reclaim to evict a page we saw tagged.
1474 if (!page_cache_get_speculative(page))
1477 /* Has the page moved? */
1478 if (unlikely(page != *slot)) {
1479 page_cache_release(page);
1484 if (++ret == nr_pages)
1491 *index = pages[ret - 1]->index + 1;
1495 EXPORT_SYMBOL(find_get_pages_tag);
1498 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1499 * a _large_ part of the i/o request. Imagine the worst scenario:
1501 * ---R__________________________________________B__________
1502 * ^ reading here ^ bad block(assume 4k)
1504 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1505 * => failing the whole request => read(R) => read(R+1) =>
1506 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1507 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1508 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1510 * It is going insane. Fix it by quickly scaling down the readahead size.
1512 static void shrink_readahead_size_eio(struct file *filp,
1513 struct file_ra_state *ra)
1519 * do_generic_file_read - generic file read routine
1520 * @filp: the file to read
1521 * @ppos: current file position
1522 * @iter: data destination
1523 * @written: already copied
1525 * This is a generic file read routine, and uses the
1526 * mapping->a_ops->readpage() function for the actual low-level stuff.
1528 * This is really ugly. But the goto's actually try to clarify some
1529 * of the logic when it comes to error handling etc.
1531 static ssize_t do_generic_file_read(struct file *filp, loff_t *ppos,
1532 struct iov_iter *iter, ssize_t written)
1534 struct address_space *mapping = filp->f_mapping;
1535 struct inode *inode = mapping->host;
1536 struct file_ra_state *ra = &filp->f_ra;
1540 unsigned long offset; /* offset into pagecache page */
1541 unsigned int prev_offset;
1544 index = *ppos >> PAGE_CACHE_SHIFT;
1545 prev_index = ra->prev_pos >> PAGE_CACHE_SHIFT;
1546 prev_offset = ra->prev_pos & (PAGE_CACHE_SIZE-1);
1547 last_index = (*ppos + iter->count + PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT;
1548 offset = *ppos & ~PAGE_CACHE_MASK;
1554 unsigned long nr, ret;
1558 page = find_get_page(mapping, index);
1560 page_cache_sync_readahead(mapping,
1562 index, last_index - index);
1563 page = find_get_page(mapping, index);
1564 if (unlikely(page == NULL))
1565 goto no_cached_page;
1567 if (PageReadahead(page)) {
1568 page_cache_async_readahead(mapping,
1570 index, last_index - index);
1572 if (!PageUptodate(page)) {
1573 if (inode->i_blkbits == PAGE_CACHE_SHIFT ||
1574 !mapping->a_ops->is_partially_uptodate)
1575 goto page_not_up_to_date;
1576 if (!trylock_page(page))
1577 goto page_not_up_to_date;
1578 /* Did it get truncated before we got the lock? */
1580 goto page_not_up_to_date_locked;
1581 if (!mapping->a_ops->is_partially_uptodate(page,
1582 offset, iter->count))
1583 goto page_not_up_to_date_locked;
1588 * i_size must be checked after we know the page is Uptodate.
1590 * Checking i_size after the check allows us to calculate
1591 * the correct value for "nr", which means the zero-filled
1592 * part of the page is not copied back to userspace (unless
1593 * another truncate extends the file - this is desired though).
1596 isize = i_size_read(inode);
1597 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
1598 if (unlikely(!isize || index > end_index)) {
1599 page_cache_release(page);
1603 /* nr is the maximum number of bytes to copy from this page */
1604 nr = PAGE_CACHE_SIZE;
1605 if (index == end_index) {
1606 nr = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
1608 page_cache_release(page);
1614 /* If users can be writing to this page using arbitrary
1615 * virtual addresses, take care about potential aliasing
1616 * before reading the page on the kernel side.
1618 if (mapping_writably_mapped(mapping))
1619 flush_dcache_page(page);
1622 * When a sequential read accesses a page several times,
1623 * only mark it as accessed the first time.
1625 if (prev_index != index || offset != prev_offset)
1626 mark_page_accessed(page);
1630 * Ok, we have the page, and it's up-to-date, so
1631 * now we can copy it to user space...
1634 ret = copy_page_to_iter(page, offset, nr, iter);
1636 index += offset >> PAGE_CACHE_SHIFT;
1637 offset &= ~PAGE_CACHE_MASK;
1638 prev_offset = offset;
1640 page_cache_release(page);
1642 if (!iov_iter_count(iter))
1650 page_not_up_to_date:
1651 /* Get exclusive access to the page ... */
1652 error = lock_page_killable(page);
1653 if (unlikely(error))
1654 goto readpage_error;
1656 page_not_up_to_date_locked:
1657 /* Did it get truncated before we got the lock? */
1658 if (!page->mapping) {
1660 page_cache_release(page);
1664 /* Did somebody else fill it already? */
1665 if (PageUptodate(page)) {
1672 * A previous I/O error may have been due to temporary
1673 * failures, eg. multipath errors.
1674 * PG_error will be set again if readpage fails.
1676 ClearPageError(page);
1677 /* Start the actual read. The read will unlock the page. */
1678 error = mapping->a_ops->readpage(filp, page);
1680 if (unlikely(error)) {
1681 if (error == AOP_TRUNCATED_PAGE) {
1682 page_cache_release(page);
1686 goto readpage_error;
1689 if (!PageUptodate(page)) {
1690 error = lock_page_killable(page);
1691 if (unlikely(error))
1692 goto readpage_error;
1693 if (!PageUptodate(page)) {
1694 if (page->mapping == NULL) {
1696 * invalidate_mapping_pages got it
1699 page_cache_release(page);
1703 shrink_readahead_size_eio(filp, ra);
1705 goto readpage_error;
1713 /* UHHUH! A synchronous read error occurred. Report it */
1714 page_cache_release(page);
1719 * Ok, it wasn't cached, so we need to create a new
1722 page = page_cache_alloc_cold(mapping);
1727 error = add_to_page_cache_lru(page, mapping, index,
1728 mapping_gfp_constraint(mapping, GFP_KERNEL));
1730 page_cache_release(page);
1731 if (error == -EEXIST) {
1741 ra->prev_pos = prev_index;
1742 ra->prev_pos <<= PAGE_CACHE_SHIFT;
1743 ra->prev_pos |= prev_offset;
1745 *ppos = ((loff_t)index << PAGE_CACHE_SHIFT) + offset;
1746 file_accessed(filp);
1747 return written ? written : error;
1751 * generic_file_read_iter - generic filesystem read routine
1752 * @iocb: kernel I/O control block
1753 * @iter: destination for the data read
1755 * This is the "read_iter()" routine for all filesystems
1756 * that can use the page cache directly.
1759 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
1761 struct file *file = iocb->ki_filp;
1763 loff_t *ppos = &iocb->ki_pos;
1766 if (iocb->ki_flags & IOCB_DIRECT) {
1767 struct address_space *mapping = file->f_mapping;
1768 struct inode *inode = mapping->host;
1769 size_t count = iov_iter_count(iter);
1773 goto out; /* skip atime */
1774 size = i_size_read(inode);
1775 retval = filemap_write_and_wait_range(mapping, pos,
1778 struct iov_iter data = *iter;
1779 retval = mapping->a_ops->direct_IO(iocb, &data, pos);
1783 *ppos = pos + retval;
1784 iov_iter_advance(iter, retval);
1788 * Btrfs can have a short DIO read if we encounter
1789 * compressed extents, so if there was an error, or if
1790 * we've already read everything we wanted to, or if
1791 * there was a short read because we hit EOF, go ahead
1792 * and return. Otherwise fallthrough to buffered io for
1793 * the rest of the read. Buffered reads will not work for
1794 * DAX files, so don't bother trying.
1796 if (retval < 0 || !iov_iter_count(iter) || *ppos >= size ||
1798 file_accessed(file);
1803 retval = do_generic_file_read(file, ppos, iter, retval);
1807 EXPORT_SYMBOL(generic_file_read_iter);
1811 * page_cache_read - adds requested page to the page cache if not already there
1812 * @file: file to read
1813 * @offset: page index
1815 * This adds the requested page to the page cache if it isn't already there,
1816 * and schedules an I/O to read in its contents from disk.
1818 static int page_cache_read(struct file *file, pgoff_t offset, gfp_t gfp_mask)
1820 struct address_space *mapping = file->f_mapping;
1825 page = __page_cache_alloc(gfp_mask|__GFP_COLD);
1829 ret = add_to_page_cache_lru(page, mapping, offset, gfp_mask & GFP_KERNEL);
1831 ret = mapping->a_ops->readpage(file, page);
1832 else if (ret == -EEXIST)
1833 ret = 0; /* losing race to add is OK */
1835 page_cache_release(page);
1837 } while (ret == AOP_TRUNCATED_PAGE);
1842 #define MMAP_LOTSAMISS (100)
1845 * Synchronous readahead happens when we don't even find
1846 * a page in the page cache at all.
1848 static void do_sync_mmap_readahead(struct vm_area_struct *vma,
1849 struct file_ra_state *ra,
1853 struct address_space *mapping = file->f_mapping;
1855 /* If we don't want any read-ahead, don't bother */
1856 if (vma->vm_flags & VM_RAND_READ)
1861 if (vma->vm_flags & VM_SEQ_READ) {
1862 page_cache_sync_readahead(mapping, ra, file, offset,
1867 /* Avoid banging the cache line if not needed */
1868 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
1872 * Do we miss much more than hit in this file? If so,
1873 * stop bothering with read-ahead. It will only hurt.
1875 if (ra->mmap_miss > MMAP_LOTSAMISS)
1881 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
1882 ra->size = ra->ra_pages;
1883 ra->async_size = ra->ra_pages / 4;
1884 ra_submit(ra, mapping, file);
1888 * Asynchronous readahead happens when we find the page and PG_readahead,
1889 * so we want to possibly extend the readahead further..
1891 static void do_async_mmap_readahead(struct vm_area_struct *vma,
1892 struct file_ra_state *ra,
1897 struct address_space *mapping = file->f_mapping;
1899 /* If we don't want any read-ahead, don't bother */
1900 if (vma->vm_flags & VM_RAND_READ)
1902 if (ra->mmap_miss > 0)
1904 if (PageReadahead(page))
1905 page_cache_async_readahead(mapping, ra, file,
1906 page, offset, ra->ra_pages);
1910 * filemap_fault - read in file data for page fault handling
1911 * @vma: vma in which the fault was taken
1912 * @vmf: struct vm_fault containing details of the fault
1914 * filemap_fault() is invoked via the vma operations vector for a
1915 * mapped memory region to read in file data during a page fault.
1917 * The goto's are kind of ugly, but this streamlines the normal case of having
1918 * it in the page cache, and handles the special cases reasonably without
1919 * having a lot of duplicated code.
1921 * vma->vm_mm->mmap_sem must be held on entry.
1923 * If our return value has VM_FAULT_RETRY set, it's because
1924 * lock_page_or_retry() returned 0.
1925 * The mmap_sem has usually been released in this case.
1926 * See __lock_page_or_retry() for the exception.
1928 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
1929 * has not been released.
1931 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
1933 int filemap_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1936 struct file *file = vma->vm_file;
1937 struct address_space *mapping = file->f_mapping;
1938 struct file_ra_state *ra = &file->f_ra;
1939 struct inode *inode = mapping->host;
1940 pgoff_t offset = vmf->pgoff;
1945 size = round_up(i_size_read(inode), PAGE_CACHE_SIZE);
1946 if (offset >= size >> PAGE_CACHE_SHIFT)
1947 return VM_FAULT_SIGBUS;
1950 * Do we have something in the page cache already?
1952 page = find_get_page(mapping, offset);
1953 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
1955 * We found the page, so try async readahead before
1956 * waiting for the lock.
1958 do_async_mmap_readahead(vma, ra, file, page, offset);
1960 /* No page in the page cache at all */
1961 do_sync_mmap_readahead(vma, ra, file, offset);
1962 count_vm_event(PGMAJFAULT);
1963 mem_cgroup_count_vm_event(vma->vm_mm, PGMAJFAULT);
1964 ret = VM_FAULT_MAJOR;
1966 page = find_get_page(mapping, offset);
1968 goto no_cached_page;
1971 if (!lock_page_or_retry(page, vma->vm_mm, vmf->flags)) {
1972 page_cache_release(page);
1973 return ret | VM_FAULT_RETRY;
1976 /* Did it get truncated? */
1977 if (unlikely(page->mapping != mapping)) {
1982 VM_BUG_ON_PAGE(page->index != offset, page);
1985 * We have a locked page in the page cache, now we need to check
1986 * that it's up-to-date. If not, it is going to be due to an error.
1988 if (unlikely(!PageUptodate(page)))
1989 goto page_not_uptodate;
1992 * Found the page and have a reference on it.
1993 * We must recheck i_size under page lock.
1995 size = round_up(i_size_read(inode), PAGE_CACHE_SIZE);
1996 if (unlikely(offset >= size >> PAGE_CACHE_SHIFT)) {
1998 page_cache_release(page);
1999 return VM_FAULT_SIGBUS;
2003 return ret | VM_FAULT_LOCKED;
2007 * We're only likely to ever get here if MADV_RANDOM is in
2010 error = page_cache_read(file, offset, vmf->gfp_mask);
2013 * The page we want has now been added to the page cache.
2014 * In the unlikely event that someone removed it in the
2015 * meantime, we'll just come back here and read it again.
2021 * An error return from page_cache_read can result if the
2022 * system is low on memory, or a problem occurs while trying
2025 if (error == -ENOMEM)
2026 return VM_FAULT_OOM;
2027 return VM_FAULT_SIGBUS;
2031 * Umm, take care of errors if the page isn't up-to-date.
2032 * Try to re-read it _once_. We do this synchronously,
2033 * because there really aren't any performance issues here
2034 * and we need to check for errors.
2036 ClearPageError(page);
2037 error = mapping->a_ops->readpage(file, page);
2039 wait_on_page_locked(page);
2040 if (!PageUptodate(page))
2043 page_cache_release(page);
2045 if (!error || error == AOP_TRUNCATED_PAGE)
2048 /* Things didn't work out. Return zero to tell the mm layer so. */
2049 shrink_readahead_size_eio(file, ra);
2050 return VM_FAULT_SIGBUS;
2052 EXPORT_SYMBOL(filemap_fault);
2054 void filemap_map_pages(struct vm_area_struct *vma, struct vm_fault *vmf)
2056 struct radix_tree_iter iter;
2058 struct file *file = vma->vm_file;
2059 struct address_space *mapping = file->f_mapping;
2062 unsigned long address = (unsigned long) vmf->virtual_address;
2067 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, vmf->pgoff) {
2068 if (iter.index > vmf->max_pgoff)
2071 page = radix_tree_deref_slot(slot);
2072 if (unlikely(!page))
2074 if (radix_tree_exception(page)) {
2075 if (radix_tree_deref_retry(page))
2081 if (!page_cache_get_speculative(page))
2084 /* Has the page moved? */
2085 if (unlikely(page != *slot)) {
2086 page_cache_release(page);
2090 if (!PageUptodate(page) ||
2091 PageReadahead(page) ||
2094 if (!trylock_page(page))
2097 if (page->mapping != mapping || !PageUptodate(page))
2100 size = round_up(i_size_read(mapping->host), PAGE_CACHE_SIZE);
2101 if (page->index >= size >> PAGE_CACHE_SHIFT)
2104 pte = vmf->pte + page->index - vmf->pgoff;
2105 if (!pte_none(*pte))
2108 if (file->f_ra.mmap_miss > 0)
2109 file->f_ra.mmap_miss--;
2110 addr = address + (page->index - vmf->pgoff) * PAGE_SIZE;
2111 do_set_pte(vma, addr, page, pte, false, false);
2117 page_cache_release(page);
2119 if (iter.index == vmf->max_pgoff)
2124 EXPORT_SYMBOL(filemap_map_pages);
2126 int filemap_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
2128 struct page *page = vmf->page;
2129 struct inode *inode = file_inode(vma->vm_file);
2130 int ret = VM_FAULT_LOCKED;
2132 sb_start_pagefault(inode->i_sb);
2133 file_update_time(vma->vm_file);
2135 if (page->mapping != inode->i_mapping) {
2137 ret = VM_FAULT_NOPAGE;
2141 * We mark the page dirty already here so that when freeze is in
2142 * progress, we are guaranteed that writeback during freezing will
2143 * see the dirty page and writeprotect it again.
2145 set_page_dirty(page);
2146 wait_for_stable_page(page);
2148 sb_end_pagefault(inode->i_sb);
2151 EXPORT_SYMBOL(filemap_page_mkwrite);
2153 const struct vm_operations_struct generic_file_vm_ops = {
2154 .fault = filemap_fault,
2155 .map_pages = filemap_map_pages,
2156 .page_mkwrite = filemap_page_mkwrite,
2159 /* This is used for a general mmap of a disk file */
2161 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2163 struct address_space *mapping = file->f_mapping;
2165 if (!mapping->a_ops->readpage)
2167 file_accessed(file);
2168 vma->vm_ops = &generic_file_vm_ops;
2173 * This is for filesystems which do not implement ->writepage.
2175 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2177 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2179 return generic_file_mmap(file, vma);
2182 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2186 int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2190 #endif /* CONFIG_MMU */
2192 EXPORT_SYMBOL(generic_file_mmap);
2193 EXPORT_SYMBOL(generic_file_readonly_mmap);
2195 static struct page *wait_on_page_read(struct page *page)
2197 if (!IS_ERR(page)) {
2198 wait_on_page_locked(page);
2199 if (!PageUptodate(page)) {
2200 page_cache_release(page);
2201 page = ERR_PTR(-EIO);
2207 static struct page *__read_cache_page(struct address_space *mapping,
2209 int (*filler)(void *, struct page *),
2216 page = find_get_page(mapping, index);
2218 page = __page_cache_alloc(gfp | __GFP_COLD);
2220 return ERR_PTR(-ENOMEM);
2221 err = add_to_page_cache_lru(page, mapping, index, gfp);
2222 if (unlikely(err)) {
2223 page_cache_release(page);
2226 /* Presumably ENOMEM for radix tree node */
2227 return ERR_PTR(err);
2229 err = filler(data, page);
2231 page_cache_release(page);
2232 page = ERR_PTR(err);
2234 page = wait_on_page_read(page);
2240 static struct page *do_read_cache_page(struct address_space *mapping,
2242 int (*filler)(void *, struct page *),
2251 page = __read_cache_page(mapping, index, filler, data, gfp);
2254 if (PageUptodate(page))
2258 if (!page->mapping) {
2260 page_cache_release(page);
2263 if (PageUptodate(page)) {
2267 err = filler(data, page);
2269 page_cache_release(page);
2270 return ERR_PTR(err);
2272 page = wait_on_page_read(page);
2277 mark_page_accessed(page);
2282 * read_cache_page - read into page cache, fill it if needed
2283 * @mapping: the page's address_space
2284 * @index: the page index
2285 * @filler: function to perform the read
2286 * @data: first arg to filler(data, page) function, often left as NULL
2288 * Read into the page cache. If a page already exists, and PageUptodate() is
2289 * not set, try to fill the page and wait for it to become unlocked.
2291 * If the page does not get brought uptodate, return -EIO.
2293 struct page *read_cache_page(struct address_space *mapping,
2295 int (*filler)(void *, struct page *),
2298 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2300 EXPORT_SYMBOL(read_cache_page);
2303 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2304 * @mapping: the page's address_space
2305 * @index: the page index
2306 * @gfp: the page allocator flags to use if allocating
2308 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
2309 * any new page allocations done using the specified allocation flags.
2311 * If the page does not get brought uptodate, return -EIO.
2313 struct page *read_cache_page_gfp(struct address_space *mapping,
2317 filler_t *filler = (filler_t *)mapping->a_ops->readpage;
2319 return do_read_cache_page(mapping, index, filler, NULL, gfp);
2321 EXPORT_SYMBOL(read_cache_page_gfp);
2324 * Performs necessary checks before doing a write
2326 * Can adjust writing position or amount of bytes to write.
2327 * Returns appropriate error code that caller should return or
2328 * zero in case that write should be allowed.
2330 inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
2332 struct file *file = iocb->ki_filp;
2333 struct inode *inode = file->f_mapping->host;
2334 unsigned long limit = rlimit(RLIMIT_FSIZE);
2337 if (!iov_iter_count(from))
2340 /* FIXME: this is for backwards compatibility with 2.4 */
2341 if (iocb->ki_flags & IOCB_APPEND)
2342 iocb->ki_pos = i_size_read(inode);
2346 if (limit != RLIM_INFINITY) {
2347 if (iocb->ki_pos >= limit) {
2348 send_sig(SIGXFSZ, current, 0);
2351 iov_iter_truncate(from, limit - (unsigned long)pos);
2357 if (unlikely(pos + iov_iter_count(from) > MAX_NON_LFS &&
2358 !(file->f_flags & O_LARGEFILE))) {
2359 if (pos >= MAX_NON_LFS)
2361 iov_iter_truncate(from, MAX_NON_LFS - (unsigned long)pos);
2365 * Are we about to exceed the fs block limit ?
2367 * If we have written data it becomes a short write. If we have
2368 * exceeded without writing data we send a signal and return EFBIG.
2369 * Linus frestrict idea will clean these up nicely..
2371 if (unlikely(pos >= inode->i_sb->s_maxbytes))
2374 iov_iter_truncate(from, inode->i_sb->s_maxbytes - pos);
2375 return iov_iter_count(from);
2377 EXPORT_SYMBOL(generic_write_checks);
2379 int pagecache_write_begin(struct file *file, struct address_space *mapping,
2380 loff_t pos, unsigned len, unsigned flags,
2381 struct page **pagep, void **fsdata)
2383 const struct address_space_operations *aops = mapping->a_ops;
2385 return aops->write_begin(file, mapping, pos, len, flags,
2388 EXPORT_SYMBOL(pagecache_write_begin);
2390 int pagecache_write_end(struct file *file, struct address_space *mapping,
2391 loff_t pos, unsigned len, unsigned copied,
2392 struct page *page, void *fsdata)
2394 const struct address_space_operations *aops = mapping->a_ops;
2396 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
2398 EXPORT_SYMBOL(pagecache_write_end);
2401 generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from, loff_t pos)
2403 struct file *file = iocb->ki_filp;
2404 struct address_space *mapping = file->f_mapping;
2405 struct inode *inode = mapping->host;
2409 struct iov_iter data;
2411 write_len = iov_iter_count(from);
2412 end = (pos + write_len - 1) >> PAGE_CACHE_SHIFT;
2414 written = filemap_write_and_wait_range(mapping, pos, pos + write_len - 1);
2419 * After a write we want buffered reads to be sure to go to disk to get
2420 * the new data. We invalidate clean cached page from the region we're
2421 * about to write. We do this *before* the write so that we can return
2422 * without clobbering -EIOCBQUEUED from ->direct_IO().
2424 if (mapping->nrpages) {
2425 written = invalidate_inode_pages2_range(mapping,
2426 pos >> PAGE_CACHE_SHIFT, end);
2428 * If a page can not be invalidated, return 0 to fall back
2429 * to buffered write.
2432 if (written == -EBUSY)
2439 written = mapping->a_ops->direct_IO(iocb, &data, pos);
2442 * Finally, try again to invalidate clean pages which might have been
2443 * cached by non-direct readahead, or faulted in by get_user_pages()
2444 * if the source of the write was an mmap'ed region of the file
2445 * we're writing. Either one is a pretty crazy thing to do,
2446 * so we don't support it 100%. If this invalidation
2447 * fails, tough, the write still worked...
2449 if (mapping->nrpages) {
2450 invalidate_inode_pages2_range(mapping,
2451 pos >> PAGE_CACHE_SHIFT, end);
2456 iov_iter_advance(from, written);
2457 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
2458 i_size_write(inode, pos);
2459 mark_inode_dirty(inode);
2466 EXPORT_SYMBOL(generic_file_direct_write);
2469 * Find or create a page at the given pagecache position. Return the locked
2470 * page. This function is specifically for buffered writes.
2472 struct page *grab_cache_page_write_begin(struct address_space *mapping,
2473 pgoff_t index, unsigned flags)
2476 int fgp_flags = FGP_LOCK|FGP_ACCESSED|FGP_WRITE|FGP_CREAT;
2478 if (flags & AOP_FLAG_NOFS)
2479 fgp_flags |= FGP_NOFS;
2481 page = pagecache_get_page(mapping, index, fgp_flags,
2482 mapping_gfp_mask(mapping));
2484 wait_for_stable_page(page);
2488 EXPORT_SYMBOL(grab_cache_page_write_begin);
2490 ssize_t generic_perform_write(struct file *file,
2491 struct iov_iter *i, loff_t pos)
2493 struct address_space *mapping = file->f_mapping;
2494 const struct address_space_operations *a_ops = mapping->a_ops;
2496 ssize_t written = 0;
2497 unsigned int flags = 0;
2500 * Copies from kernel address space cannot fail (NFSD is a big user).
2502 if (!iter_is_iovec(i))
2503 flags |= AOP_FLAG_UNINTERRUPTIBLE;
2507 unsigned long offset; /* Offset into pagecache page */
2508 unsigned long bytes; /* Bytes to write to page */
2509 size_t copied; /* Bytes copied from user */
2512 offset = (pos & (PAGE_CACHE_SIZE - 1));
2513 bytes = min_t(unsigned long, PAGE_CACHE_SIZE - offset,
2518 * Bring in the user page that we will copy from _first_.
2519 * Otherwise there's a nasty deadlock on copying from the
2520 * same page as we're writing to, without it being marked
2523 * Not only is this an optimisation, but it is also required
2524 * to check that the address is actually valid, when atomic
2525 * usercopies are used, below.
2527 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
2532 if (fatal_signal_pending(current)) {
2537 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
2539 if (unlikely(status < 0))
2542 if (mapping_writably_mapped(mapping))
2543 flush_dcache_page(page);
2545 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
2546 flush_dcache_page(page);
2548 status = a_ops->write_end(file, mapping, pos, bytes, copied,
2550 if (unlikely(status < 0))
2556 iov_iter_advance(i, copied);
2557 if (unlikely(copied == 0)) {
2559 * If we were unable to copy any data at all, we must
2560 * fall back to a single segment length write.
2562 * If we didn't fallback here, we could livelock
2563 * because not all segments in the iov can be copied at
2564 * once without a pagefault.
2566 bytes = min_t(unsigned long, PAGE_CACHE_SIZE - offset,
2567 iov_iter_single_seg_count(i));
2573 balance_dirty_pages_ratelimited(mapping);
2574 } while (iov_iter_count(i));
2576 return written ? written : status;
2578 EXPORT_SYMBOL(generic_perform_write);
2581 * __generic_file_write_iter - write data to a file
2582 * @iocb: IO state structure (file, offset, etc.)
2583 * @from: iov_iter with data to write
2585 * This function does all the work needed for actually writing data to a
2586 * file. It does all basic checks, removes SUID from the file, updates
2587 * modification times and calls proper subroutines depending on whether we
2588 * do direct IO or a standard buffered write.
2590 * It expects i_mutex to be grabbed unless we work on a block device or similar
2591 * object which does not need locking at all.
2593 * This function does *not* take care of syncing data in case of O_SYNC write.
2594 * A caller has to handle it. This is mainly due to the fact that we want to
2595 * avoid syncing under i_mutex.
2597 ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
2599 struct file *file = iocb->ki_filp;
2600 struct address_space * mapping = file->f_mapping;
2601 struct inode *inode = mapping->host;
2602 ssize_t written = 0;
2606 /* We can write back this queue in page reclaim */
2607 current->backing_dev_info = inode_to_bdi(inode);
2608 err = file_remove_privs(file);
2612 err = file_update_time(file);
2616 if (iocb->ki_flags & IOCB_DIRECT) {
2617 loff_t pos, endbyte;
2619 written = generic_file_direct_write(iocb, from, iocb->ki_pos);
2621 * If the write stopped short of completing, fall back to
2622 * buffered writes. Some filesystems do this for writes to
2623 * holes, for example. For DAX files, a buffered write will
2624 * not succeed (even if it did, DAX does not handle dirty
2625 * page-cache pages correctly).
2627 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
2630 status = generic_perform_write(file, from, pos = iocb->ki_pos);
2632 * If generic_perform_write() returned a synchronous error
2633 * then we want to return the number of bytes which were
2634 * direct-written, or the error code if that was zero. Note
2635 * that this differs from normal direct-io semantics, which
2636 * will return -EFOO even if some bytes were written.
2638 if (unlikely(status < 0)) {
2643 * We need to ensure that the page cache pages are written to
2644 * disk and invalidated to preserve the expected O_DIRECT
2647 endbyte = pos + status - 1;
2648 err = filemap_write_and_wait_range(mapping, pos, endbyte);
2650 iocb->ki_pos = endbyte + 1;
2652 invalidate_mapping_pages(mapping,
2653 pos >> PAGE_CACHE_SHIFT,
2654 endbyte >> PAGE_CACHE_SHIFT);
2657 * We don't know how much we wrote, so just return
2658 * the number of bytes which were direct-written
2662 written = generic_perform_write(file, from, iocb->ki_pos);
2663 if (likely(written > 0))
2664 iocb->ki_pos += written;
2667 current->backing_dev_info = NULL;
2668 return written ? written : err;
2670 EXPORT_SYMBOL(__generic_file_write_iter);
2673 * generic_file_write_iter - write data to a file
2674 * @iocb: IO state structure
2675 * @from: iov_iter with data to write
2677 * This is a wrapper around __generic_file_write_iter() to be used by most
2678 * filesystems. It takes care of syncing the file in case of O_SYNC file
2679 * and acquires i_mutex as needed.
2681 ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
2683 struct file *file = iocb->ki_filp;
2684 struct inode *inode = file->f_mapping->host;
2687 mutex_lock(&inode->i_mutex);
2688 ret = generic_write_checks(iocb, from);
2690 ret = __generic_file_write_iter(iocb, from);
2691 mutex_unlock(&inode->i_mutex);
2696 err = generic_write_sync(file, iocb->ki_pos - ret, ret);
2702 EXPORT_SYMBOL(generic_file_write_iter);
2705 * try_to_release_page() - release old fs-specific metadata on a page
2707 * @page: the page which the kernel is trying to free
2708 * @gfp_mask: memory allocation flags (and I/O mode)
2710 * The address_space is to try to release any data against the page
2711 * (presumably at page->private). If the release was successful, return `1'.
2712 * Otherwise return zero.
2714 * This may also be called if PG_fscache is set on a page, indicating that the
2715 * page is known to the local caching routines.
2717 * The @gfp_mask argument specifies whether I/O may be performed to release
2718 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
2721 int try_to_release_page(struct page *page, gfp_t gfp_mask)
2723 struct address_space * const mapping = page->mapping;
2725 BUG_ON(!PageLocked(page));
2726 if (PageWriteback(page))
2729 if (mapping && mapping->a_ops->releasepage)
2730 return mapping->a_ops->releasepage(page, gfp_mask);
2731 return try_to_free_buffers(page);
2734 EXPORT_SYMBOL(try_to_release_page);