ipv4, ipv6: ensure raw socket message is big enough to hold an IP header
[linux/fpc-iii.git] / mm / filemap.c
blob3afa2a58acf073b77e3a4cf8a1a1f6f73d497843
1 /*
2 * linux/mm/filemap.c
4 * Copyright (C) 1994-1999 Linus Torvalds
5 */
7 /*
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>
15 #include <linux/fs.h>
16 #include <linux/uaccess.h>
17 #include <linux/capability.h>
18 #include <linux/kernel_stat.h>
19 #include <linux/gfp.h>
20 #include <linux/mm.h>
21 #include <linux/swap.h>
22 #include <linux/mman.h>
23 #include <linux/pagemap.h>
24 #include <linux/file.h>
25 #include <linux/uio.h>
26 #include <linux/hash.h>
27 #include <linux/writeback.h>
28 #include <linux/backing-dev.h>
29 #include <linux/pagevec.h>
30 #include <linux/blkdev.h>
31 #include <linux/security.h>
32 #include <linux/cpuset.h>
33 #include <linux/hardirq.h> /* for BUG_ON(!in_atomic()) only */
34 #include <linux/hugetlb.h>
35 #include <linux/memcontrol.h>
36 #include <linux/cleancache.h>
37 #include <linux/rmap.h>
38 #include "internal.h"
40 #define CREATE_TRACE_POINTS
41 #include <trace/events/filemap.h>
44 * FIXME: remove all knowledge of the buffer layer from the core VM
46 #include <linux/buffer_head.h> /* for try_to_free_buffers */
48 #include <asm/mman.h>
51 * Shared mappings implemented 30.11.1994. It's not fully working yet,
52 * though.
54 * Shared mappings now work. 15.8.1995 Bruno.
56 * finished 'unifying' the page and buffer cache and SMP-threaded the
57 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
59 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
63 * Lock ordering:
65 * ->i_mmap_rwsem (truncate_pagecache)
66 * ->private_lock (__free_pte->__set_page_dirty_buffers)
67 * ->swap_lock (exclusive_swap_page, others)
68 * ->mapping->tree_lock
70 * ->i_mutex
71 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
73 * ->mmap_sem
74 * ->i_mmap_rwsem
75 * ->page_table_lock or pte_lock (various, mainly in memory.c)
76 * ->mapping->tree_lock (arch-dependent flush_dcache_mmap_lock)
78 * ->mmap_sem
79 * ->lock_page (access_process_vm)
81 * ->i_mutex (generic_perform_write)
82 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
84 * bdi->wb.list_lock
85 * sb_lock (fs/fs-writeback.c)
86 * ->mapping->tree_lock (__sync_single_inode)
88 * ->i_mmap_rwsem
89 * ->anon_vma.lock (vma_adjust)
91 * ->anon_vma.lock
92 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
94 * ->page_table_lock or pte_lock
95 * ->swap_lock (try_to_unmap_one)
96 * ->private_lock (try_to_unmap_one)
97 * ->tree_lock (try_to_unmap_one)
98 * ->zone_lru_lock(zone) (follow_page->mark_page_accessed)
99 * ->zone_lru_lock(zone) (check_pte_range->isolate_lru_page)
100 * ->private_lock (page_remove_rmap->set_page_dirty)
101 * ->tree_lock (page_remove_rmap->set_page_dirty)
102 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
103 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
104 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
105 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
106 * ->inode->i_lock (zap_pte_range->set_page_dirty)
107 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
109 * ->i_mmap_rwsem
110 * ->tasklist_lock (memory_failure, collect_procs_ao)
113 static int page_cache_tree_insert(struct address_space *mapping,
114 struct page *page, void **shadowp)
116 struct radix_tree_node *node;
117 void **slot;
118 int error;
120 error = __radix_tree_create(&mapping->page_tree, page->index, 0,
121 &node, &slot);
122 if (error)
123 return error;
124 if (*slot) {
125 void *p;
127 p = radix_tree_deref_slot_protected(slot, &mapping->tree_lock);
128 if (!radix_tree_exceptional_entry(p))
129 return -EEXIST;
131 mapping->nrexceptional--;
132 if (!dax_mapping(mapping)) {
133 if (shadowp)
134 *shadowp = p;
135 } else {
136 /* DAX can replace empty locked entry with a hole */
137 WARN_ON_ONCE(p !=
138 dax_radix_locked_entry(0, RADIX_DAX_EMPTY));
139 /* Wakeup waiters for exceptional entry lock */
140 dax_wake_mapping_entry_waiter(mapping, page->index, p,
141 true);
144 __radix_tree_replace(&mapping->page_tree, node, slot, page,
145 workingset_update_node, mapping);
146 mapping->nrpages++;
147 return 0;
150 static void page_cache_tree_delete(struct address_space *mapping,
151 struct page *page, void *shadow)
153 int i, nr;
155 /* hugetlb pages are represented by one entry in the radix tree */
156 nr = PageHuge(page) ? 1 : hpage_nr_pages(page);
158 VM_BUG_ON_PAGE(!PageLocked(page), page);
159 VM_BUG_ON_PAGE(PageTail(page), page);
160 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
162 for (i = 0; i < nr; i++) {
163 struct radix_tree_node *node;
164 void **slot;
166 __radix_tree_lookup(&mapping->page_tree, page->index + i,
167 &node, &slot);
169 VM_BUG_ON_PAGE(!node && nr != 1, page);
171 radix_tree_clear_tags(&mapping->page_tree, node, slot);
172 __radix_tree_replace(&mapping->page_tree, node, slot, shadow,
173 workingset_update_node, mapping);
176 if (shadow) {
177 mapping->nrexceptional += nr;
179 * Make sure the nrexceptional update is committed before
180 * the nrpages update so that final truncate racing
181 * with reclaim does not see both counters 0 at the
182 * same time and miss a shadow entry.
184 smp_wmb();
186 mapping->nrpages -= nr;
190 * Delete a page from the page cache and free it. Caller has to make
191 * sure the page is locked and that nobody else uses it - or that usage
192 * is safe. The caller must hold the mapping's tree_lock.
194 void __delete_from_page_cache(struct page *page, void *shadow)
196 struct address_space *mapping = page->mapping;
197 int nr = hpage_nr_pages(page);
199 trace_mm_filemap_delete_from_page_cache(page);
201 * if we're uptodate, flush out into the cleancache, otherwise
202 * invalidate any existing cleancache entries. We can't leave
203 * stale data around in the cleancache once our page is gone
205 if (PageUptodate(page) && PageMappedToDisk(page))
206 cleancache_put_page(page);
207 else
208 cleancache_invalidate_page(mapping, page);
210 VM_BUG_ON_PAGE(PageTail(page), page);
211 VM_BUG_ON_PAGE(page_mapped(page), page);
212 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
213 int mapcount;
215 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
216 current->comm, page_to_pfn(page));
217 dump_page(page, "still mapped when deleted");
218 dump_stack();
219 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
221 mapcount = page_mapcount(page);
222 if (mapping_exiting(mapping) &&
223 page_count(page) >= mapcount + 2) {
225 * All vmas have already been torn down, so it's
226 * a good bet that actually the page is unmapped,
227 * and we'd prefer not to leak it: if we're wrong,
228 * some other bad page check should catch it later.
230 page_mapcount_reset(page);
231 page_ref_sub(page, mapcount);
235 page_cache_tree_delete(mapping, page, shadow);
237 page->mapping = NULL;
238 /* Leave page->index set: truncation lookup relies upon it */
240 /* hugetlb pages do not participate in page cache accounting. */
241 if (!PageHuge(page))
242 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
243 if (PageSwapBacked(page)) {
244 __mod_node_page_state(page_pgdat(page), NR_SHMEM, -nr);
245 if (PageTransHuge(page))
246 __dec_node_page_state(page, NR_SHMEM_THPS);
247 } else {
248 VM_BUG_ON_PAGE(PageTransHuge(page) && !PageHuge(page), page);
252 * At this point page must be either written or cleaned by truncate.
253 * Dirty page here signals a bug and loss of unwritten data.
255 * This fixes dirty accounting after removing the page entirely but
256 * leaves PageDirty set: it has no effect for truncated page and
257 * anyway will be cleared before returning page into buddy allocator.
259 if (WARN_ON_ONCE(PageDirty(page)))
260 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
264 * delete_from_page_cache - delete page from page cache
265 * @page: the page which the kernel is trying to remove from page cache
267 * This must be called only on pages that have been verified to be in the page
268 * cache and locked. It will never put the page into the free list, the caller
269 * has a reference on the page.
271 void delete_from_page_cache(struct page *page)
273 struct address_space *mapping = page_mapping(page);
274 unsigned long flags;
275 void (*freepage)(struct page *);
277 BUG_ON(!PageLocked(page));
279 freepage = mapping->a_ops->freepage;
281 spin_lock_irqsave(&mapping->tree_lock, flags);
282 __delete_from_page_cache(page, NULL);
283 spin_unlock_irqrestore(&mapping->tree_lock, flags);
285 if (freepage)
286 freepage(page);
288 if (PageTransHuge(page) && !PageHuge(page)) {
289 page_ref_sub(page, HPAGE_PMD_NR);
290 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
291 } else {
292 put_page(page);
295 EXPORT_SYMBOL(delete_from_page_cache);
297 int filemap_check_errors(struct address_space *mapping)
299 int ret = 0;
300 /* Check for outstanding write errors */
301 if (test_bit(AS_ENOSPC, &mapping->flags) &&
302 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
303 ret = -ENOSPC;
304 if (test_bit(AS_EIO, &mapping->flags) &&
305 test_and_clear_bit(AS_EIO, &mapping->flags))
306 ret = -EIO;
307 return ret;
309 EXPORT_SYMBOL(filemap_check_errors);
312 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
313 * @mapping: address space structure to write
314 * @start: offset in bytes where the range starts
315 * @end: offset in bytes where the range ends (inclusive)
316 * @sync_mode: enable synchronous operation
318 * Start writeback against all of a mapping's dirty pages that lie
319 * within the byte offsets <start, end> inclusive.
321 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
322 * opposed to a regular memory cleansing writeback. The difference between
323 * these two operations is that if a dirty page/buffer is encountered, it must
324 * be waited upon, and not just skipped over.
326 int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
327 loff_t end, int sync_mode)
329 int ret;
330 struct writeback_control wbc = {
331 .sync_mode = sync_mode,
332 .nr_to_write = LONG_MAX,
333 .range_start = start,
334 .range_end = end,
337 if (!mapping_cap_writeback_dirty(mapping))
338 return 0;
340 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
341 ret = do_writepages(mapping, &wbc);
342 wbc_detach_inode(&wbc);
343 return ret;
346 static inline int __filemap_fdatawrite(struct address_space *mapping,
347 int sync_mode)
349 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
352 int filemap_fdatawrite(struct address_space *mapping)
354 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
356 EXPORT_SYMBOL(filemap_fdatawrite);
358 int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
359 loff_t end)
361 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
363 EXPORT_SYMBOL(filemap_fdatawrite_range);
366 * filemap_flush - mostly a non-blocking flush
367 * @mapping: target address_space
369 * This is a mostly non-blocking flush. Not suitable for data-integrity
370 * purposes - I/O may not be started against all dirty pages.
372 int filemap_flush(struct address_space *mapping)
374 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
376 EXPORT_SYMBOL(filemap_flush);
378 static int __filemap_fdatawait_range(struct address_space *mapping,
379 loff_t start_byte, loff_t end_byte)
381 pgoff_t index = start_byte >> PAGE_SHIFT;
382 pgoff_t end = end_byte >> PAGE_SHIFT;
383 struct pagevec pvec;
384 int nr_pages;
385 int ret = 0;
387 if (end_byte < start_byte)
388 goto out;
390 pagevec_init(&pvec, 0);
391 while ((index <= end) &&
392 (nr_pages = pagevec_lookup_tag(&pvec, mapping, &index,
393 PAGECACHE_TAG_WRITEBACK,
394 min(end - index, (pgoff_t)PAGEVEC_SIZE-1) + 1)) != 0) {
395 unsigned i;
397 for (i = 0; i < nr_pages; i++) {
398 struct page *page = pvec.pages[i];
400 /* until radix tree lookup accepts end_index */
401 if (page->index > end)
402 continue;
404 wait_on_page_writeback(page);
405 if (TestClearPageError(page))
406 ret = -EIO;
408 pagevec_release(&pvec);
409 cond_resched();
411 out:
412 return ret;
416 * filemap_fdatawait_range - wait for writeback to complete
417 * @mapping: address space structure to wait for
418 * @start_byte: offset in bytes where the range starts
419 * @end_byte: offset in bytes where the range ends (inclusive)
421 * Walk the list of under-writeback pages of the given address space
422 * in the given range and wait for all of them. Check error status of
423 * the address space and return it.
425 * Since the error status of the address space is cleared by this function,
426 * callers are responsible for checking the return value and handling and/or
427 * reporting the error.
429 int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
430 loff_t end_byte)
432 int ret, ret2;
434 ret = __filemap_fdatawait_range(mapping, start_byte, end_byte);
435 ret2 = filemap_check_errors(mapping);
436 if (!ret)
437 ret = ret2;
439 return ret;
441 EXPORT_SYMBOL(filemap_fdatawait_range);
444 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
445 * @mapping: address space structure to wait for
447 * Walk the list of under-writeback pages of the given address space
448 * and wait for all of them. Unlike filemap_fdatawait(), this function
449 * does not clear error status of the address space.
451 * Use this function if callers don't handle errors themselves. Expected
452 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
453 * fsfreeze(8)
455 void filemap_fdatawait_keep_errors(struct address_space *mapping)
457 loff_t i_size = i_size_read(mapping->host);
459 if (i_size == 0)
460 return;
462 __filemap_fdatawait_range(mapping, 0, i_size - 1);
466 * filemap_fdatawait - wait for all under-writeback pages to complete
467 * @mapping: address space structure to wait for
469 * Walk the list of under-writeback pages of the given address space
470 * and wait for all of them. Check error status of the address space
471 * and return it.
473 * Since the error status of the address space is cleared by this function,
474 * callers are responsible for checking the return value and handling and/or
475 * reporting the error.
477 int filemap_fdatawait(struct address_space *mapping)
479 loff_t i_size = i_size_read(mapping->host);
481 if (i_size == 0)
482 return 0;
484 return filemap_fdatawait_range(mapping, 0, i_size - 1);
486 EXPORT_SYMBOL(filemap_fdatawait);
488 int filemap_write_and_wait(struct address_space *mapping)
490 int err = 0;
492 if ((!dax_mapping(mapping) && mapping->nrpages) ||
493 (dax_mapping(mapping) && mapping->nrexceptional)) {
494 err = filemap_fdatawrite(mapping);
496 * Even if the above returned error, the pages may be
497 * written partially (e.g. -ENOSPC), so we wait for it.
498 * But the -EIO is special case, it may indicate the worst
499 * thing (e.g. bug) happened, so we avoid waiting for it.
501 if (err != -EIO) {
502 int err2 = filemap_fdatawait(mapping);
503 if (!err)
504 err = err2;
506 } else {
507 err = filemap_check_errors(mapping);
509 return err;
511 EXPORT_SYMBOL(filemap_write_and_wait);
514 * filemap_write_and_wait_range - write out & wait on a file range
515 * @mapping: the address_space for the pages
516 * @lstart: offset in bytes where the range starts
517 * @lend: offset in bytes where the range ends (inclusive)
519 * Write out and wait upon file offsets lstart->lend, inclusive.
521 * Note that `lend' is inclusive (describes the last byte to be written) so
522 * that this function can be used to write to the very end-of-file (end = -1).
524 int filemap_write_and_wait_range(struct address_space *mapping,
525 loff_t lstart, loff_t lend)
527 int err = 0;
529 if ((!dax_mapping(mapping) && mapping->nrpages) ||
530 (dax_mapping(mapping) && mapping->nrexceptional)) {
531 err = __filemap_fdatawrite_range(mapping, lstart, lend,
532 WB_SYNC_ALL);
533 /* See comment of filemap_write_and_wait() */
534 if (err != -EIO) {
535 int err2 = filemap_fdatawait_range(mapping,
536 lstart, lend);
537 if (!err)
538 err = err2;
540 } else {
541 err = filemap_check_errors(mapping);
543 return err;
545 EXPORT_SYMBOL(filemap_write_and_wait_range);
548 * replace_page_cache_page - replace a pagecache page with a new one
549 * @old: page to be replaced
550 * @new: page to replace with
551 * @gfp_mask: allocation mode
553 * This function replaces a page in the pagecache with a new one. On
554 * success it acquires the pagecache reference for the new page and
555 * drops it for the old page. Both the old and new pages must be
556 * locked. This function does not add the new page to the LRU, the
557 * caller must do that.
559 * The remove + add is atomic. The only way this function can fail is
560 * memory allocation failure.
562 int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
564 int error;
566 VM_BUG_ON_PAGE(!PageLocked(old), old);
567 VM_BUG_ON_PAGE(!PageLocked(new), new);
568 VM_BUG_ON_PAGE(new->mapping, new);
570 error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
571 if (!error) {
572 struct address_space *mapping = old->mapping;
573 void (*freepage)(struct page *);
574 unsigned long flags;
576 pgoff_t offset = old->index;
577 freepage = mapping->a_ops->freepage;
579 get_page(new);
580 new->mapping = mapping;
581 new->index = offset;
583 spin_lock_irqsave(&mapping->tree_lock, flags);
584 __delete_from_page_cache(old, NULL);
585 error = page_cache_tree_insert(mapping, new, NULL);
586 BUG_ON(error);
589 * hugetlb pages do not participate in page cache accounting.
591 if (!PageHuge(new))
592 __inc_node_page_state(new, NR_FILE_PAGES);
593 if (PageSwapBacked(new))
594 __inc_node_page_state(new, NR_SHMEM);
595 spin_unlock_irqrestore(&mapping->tree_lock, flags);
596 mem_cgroup_migrate(old, new);
597 radix_tree_preload_end();
598 if (freepage)
599 freepage(old);
600 put_page(old);
603 return error;
605 EXPORT_SYMBOL_GPL(replace_page_cache_page);
607 static int __add_to_page_cache_locked(struct page *page,
608 struct address_space *mapping,
609 pgoff_t offset, gfp_t gfp_mask,
610 void **shadowp)
612 int huge = PageHuge(page);
613 struct mem_cgroup *memcg;
614 int error;
616 VM_BUG_ON_PAGE(!PageLocked(page), page);
617 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
619 if (!huge) {
620 error = mem_cgroup_try_charge(page, current->mm,
621 gfp_mask, &memcg, false);
622 if (error)
623 return error;
626 error = radix_tree_maybe_preload(gfp_mask & ~__GFP_HIGHMEM);
627 if (error) {
628 if (!huge)
629 mem_cgroup_cancel_charge(page, memcg, false);
630 return error;
633 get_page(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();
640 if (unlikely(error))
641 goto err_insert;
643 /* hugetlb pages do not participate in page cache accounting. */
644 if (!huge)
645 __inc_node_page_state(page, NR_FILE_PAGES);
646 spin_unlock_irq(&mapping->tree_lock);
647 if (!huge)
648 mem_cgroup_commit_charge(page, memcg, false, false);
649 trace_mm_filemap_add_to_page_cache(page);
650 return 0;
651 err_insert:
652 page->mapping = NULL;
653 /* Leave page->index set: truncation relies upon it */
654 spin_unlock_irq(&mapping->tree_lock);
655 if (!huge)
656 mem_cgroup_cancel_charge(page, memcg, false);
657 put_page(page);
658 return error;
662 * add_to_page_cache_locked - add a locked page to the pagecache
663 * @page: page to add
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,
675 gfp_mask, NULL);
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)
682 void *shadow = NULL;
683 int ret;
685 __SetPageLocked(page);
686 ret = __add_to_page_cache_locked(page, mapping, offset,
687 gfp_mask, &shadow);
688 if (unlikely(ret))
689 __ClearPageLocked(page);
690 else {
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.
695 * The exception is pages getting rewritten; evicting other
696 * data from the working set, only to cache data that will
697 * get overwritten with something else, is a waste of memory.
699 if (!(gfp_mask & __GFP_WRITE) &&
700 shadow && workingset_refault(shadow)) {
701 SetPageActive(page);
702 workingset_activation(page);
703 } else
704 ClearPageActive(page);
705 lru_cache_add(page);
707 return ret;
709 EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
711 #ifdef CONFIG_NUMA
712 struct page *__page_cache_alloc(gfp_t gfp)
714 int n;
715 struct page *page;
717 if (cpuset_do_page_mem_spread()) {
718 unsigned int cpuset_mems_cookie;
719 do {
720 cpuset_mems_cookie = read_mems_allowed_begin();
721 n = cpuset_mem_spread_node();
722 page = __alloc_pages_node(n, gfp, 0);
723 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
725 return page;
727 return alloc_pages(gfp, 0);
729 EXPORT_SYMBOL(__page_cache_alloc);
730 #endif
733 * In order to wait for pages to become available there must be
734 * waitqueues associated with pages. By using a hash table of
735 * waitqueues where the bucket discipline is to maintain all
736 * waiters on the same queue and wake all when any of the pages
737 * become available, and for the woken contexts to check to be
738 * sure the appropriate page became available, this saves space
739 * at a cost of "thundering herd" phenomena during rare hash
740 * collisions.
742 #define PAGE_WAIT_TABLE_BITS 8
743 #define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
744 static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
746 static wait_queue_head_t *page_waitqueue(struct page *page)
748 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
751 void __init pagecache_init(void)
753 int i;
755 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
756 init_waitqueue_head(&page_wait_table[i]);
758 page_writeback_init();
761 struct wait_page_key {
762 struct page *page;
763 int bit_nr;
764 int page_match;
767 struct wait_page_queue {
768 struct page *page;
769 int bit_nr;
770 wait_queue_t wait;
773 static int wake_page_function(wait_queue_t *wait, unsigned mode, int sync, void *arg)
775 struct wait_page_key *key = arg;
776 struct wait_page_queue *wait_page
777 = container_of(wait, struct wait_page_queue, wait);
779 if (wait_page->page != key->page)
780 return 0;
781 key->page_match = 1;
783 if (wait_page->bit_nr != key->bit_nr)
784 return 0;
785 if (test_bit(key->bit_nr, &key->page->flags))
786 return 0;
788 return autoremove_wake_function(wait, mode, sync, key);
791 void wake_up_page_bit(struct page *page, int bit_nr)
793 wait_queue_head_t *q = page_waitqueue(page);
794 struct wait_page_key key;
795 unsigned long flags;
797 key.page = page;
798 key.bit_nr = bit_nr;
799 key.page_match = 0;
801 spin_lock_irqsave(&q->lock, flags);
802 __wake_up_locked_key(q, TASK_NORMAL, &key);
804 * It is possible for other pages to have collided on the waitqueue
805 * hash, so in that case check for a page match. That prevents a long-
806 * term waiter
808 * It is still possible to miss a case here, when we woke page waiters
809 * and removed them from the waitqueue, but there are still other
810 * page waiters.
812 if (!waitqueue_active(q) || !key.page_match) {
813 ClearPageWaiters(page);
815 * It's possible to miss clearing Waiters here, when we woke
816 * our page waiters, but the hashed waitqueue has waiters for
817 * other pages on it.
819 * That's okay, it's a rare case. The next waker will clear it.
822 spin_unlock_irqrestore(&q->lock, flags);
824 EXPORT_SYMBOL(wake_up_page_bit);
826 static inline int wait_on_page_bit_common(wait_queue_head_t *q,
827 struct page *page, int bit_nr, int state, bool lock)
829 struct wait_page_queue wait_page;
830 wait_queue_t *wait = &wait_page.wait;
831 int ret = 0;
833 init_wait(wait);
834 wait->func = wake_page_function;
835 wait_page.page = page;
836 wait_page.bit_nr = bit_nr;
838 for (;;) {
839 spin_lock_irq(&q->lock);
841 if (likely(list_empty(&wait->task_list))) {
842 if (lock)
843 __add_wait_queue_tail_exclusive(q, wait);
844 else
845 __add_wait_queue(q, wait);
846 SetPageWaiters(page);
849 set_current_state(state);
851 spin_unlock_irq(&q->lock);
853 if (likely(test_bit(bit_nr, &page->flags))) {
854 io_schedule();
855 if (unlikely(signal_pending_state(state, current))) {
856 ret = -EINTR;
857 break;
861 if (lock) {
862 if (!test_and_set_bit_lock(bit_nr, &page->flags))
863 break;
864 } else {
865 if (!test_bit(bit_nr, &page->flags))
866 break;
870 finish_wait(q, wait);
873 * A signal could leave PageWaiters set. Clearing it here if
874 * !waitqueue_active would be possible (by open-coding finish_wait),
875 * but still fail to catch it in the case of wait hash collision. We
876 * already can fail to clear wait hash collision cases, so don't
877 * bother with signals either.
880 return ret;
883 void wait_on_page_bit(struct page *page, int bit_nr)
885 wait_queue_head_t *q = page_waitqueue(page);
886 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, false);
888 EXPORT_SYMBOL(wait_on_page_bit);
890 int wait_on_page_bit_killable(struct page *page, int bit_nr)
892 wait_queue_head_t *q = page_waitqueue(page);
893 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, false);
897 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
898 * @page: Page defining the wait queue of interest
899 * @waiter: Waiter to add to the queue
901 * Add an arbitrary @waiter to the wait queue for the nominated @page.
903 void add_page_wait_queue(struct page *page, wait_queue_t *waiter)
905 wait_queue_head_t *q = page_waitqueue(page);
906 unsigned long flags;
908 spin_lock_irqsave(&q->lock, flags);
909 __add_wait_queue(q, waiter);
910 SetPageWaiters(page);
911 spin_unlock_irqrestore(&q->lock, flags);
913 EXPORT_SYMBOL_GPL(add_page_wait_queue);
915 #ifndef clear_bit_unlock_is_negative_byte
918 * PG_waiters is the high bit in the same byte as PG_lock.
920 * On x86 (and on many other architectures), we can clear PG_lock and
921 * test the sign bit at the same time. But if the architecture does
922 * not support that special operation, we just do this all by hand
923 * instead.
925 * The read of PG_waiters has to be after (or concurrently with) PG_locked
926 * being cleared, but a memory barrier should be unneccssary since it is
927 * in the same byte as PG_locked.
929 static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
931 clear_bit_unlock(nr, mem);
932 /* smp_mb__after_atomic(); */
933 return test_bit(PG_waiters, mem);
936 #endif
939 * unlock_page - unlock a locked page
940 * @page: the page
942 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
943 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
944 * mechanism between PageLocked pages and PageWriteback pages is shared.
945 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
947 * Note that this depends on PG_waiters being the sign bit in the byte
948 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
949 * clear the PG_locked bit and test PG_waiters at the same time fairly
950 * portably (architectures that do LL/SC can test any bit, while x86 can
951 * test the sign bit).
953 void unlock_page(struct page *page)
955 BUILD_BUG_ON(PG_waiters != 7);
956 page = compound_head(page);
957 VM_BUG_ON_PAGE(!PageLocked(page), page);
958 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
959 wake_up_page_bit(page, PG_locked);
961 EXPORT_SYMBOL(unlock_page);
964 * end_page_writeback - end writeback against a page
965 * @page: the page
967 void end_page_writeback(struct page *page)
970 * TestClearPageReclaim could be used here but it is an atomic
971 * operation and overkill in this particular case. Failing to
972 * shuffle a page marked for immediate reclaim is too mild to
973 * justify taking an atomic operation penalty at the end of
974 * ever page writeback.
976 if (PageReclaim(page)) {
977 ClearPageReclaim(page);
978 rotate_reclaimable_page(page);
981 if (!test_clear_page_writeback(page))
982 BUG();
984 smp_mb__after_atomic();
985 wake_up_page(page, PG_writeback);
987 EXPORT_SYMBOL(end_page_writeback);
990 * After completing I/O on a page, call this routine to update the page
991 * flags appropriately
993 void page_endio(struct page *page, bool is_write, int err)
995 if (!is_write) {
996 if (!err) {
997 SetPageUptodate(page);
998 } else {
999 ClearPageUptodate(page);
1000 SetPageError(page);
1002 unlock_page(page);
1003 } else {
1004 if (err) {
1005 struct address_space *mapping;
1007 SetPageError(page);
1008 mapping = page_mapping(page);
1009 if (mapping)
1010 mapping_set_error(mapping, err);
1012 end_page_writeback(page);
1015 EXPORT_SYMBOL_GPL(page_endio);
1018 * __lock_page - get a lock on the page, assuming we need to sleep to get it
1019 * @page: the page to lock
1021 void __lock_page(struct page *__page)
1023 struct page *page = compound_head(__page);
1024 wait_queue_head_t *q = page_waitqueue(page);
1025 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, true);
1027 EXPORT_SYMBOL(__lock_page);
1029 int __lock_page_killable(struct page *__page)
1031 struct page *page = compound_head(__page);
1032 wait_queue_head_t *q = page_waitqueue(page);
1033 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE, true);
1035 EXPORT_SYMBOL_GPL(__lock_page_killable);
1038 * Return values:
1039 * 1 - page is locked; mmap_sem is still held.
1040 * 0 - page is not locked.
1041 * mmap_sem has been released (up_read()), unless flags had both
1042 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1043 * which case mmap_sem is still held.
1045 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1046 * with the page locked and the mmap_sem unperturbed.
1048 int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1049 unsigned int flags)
1051 if (flags & FAULT_FLAG_ALLOW_RETRY) {
1053 * CAUTION! In this case, mmap_sem is not released
1054 * even though return 0.
1056 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1057 return 0;
1059 up_read(&mm->mmap_sem);
1060 if (flags & FAULT_FLAG_KILLABLE)
1061 wait_on_page_locked_killable(page);
1062 else
1063 wait_on_page_locked(page);
1064 return 0;
1065 } else {
1066 if (flags & FAULT_FLAG_KILLABLE) {
1067 int ret;
1069 ret = __lock_page_killable(page);
1070 if (ret) {
1071 up_read(&mm->mmap_sem);
1072 return 0;
1074 } else
1075 __lock_page(page);
1076 return 1;
1081 * page_cache_next_hole - find the next hole (not-present entry)
1082 * @mapping: mapping
1083 * @index: index
1084 * @max_scan: maximum range to search
1086 * Search the set [index, min(index+max_scan-1, MAX_INDEX)] for the
1087 * lowest indexed hole.
1089 * Returns: the index of the hole if found, otherwise returns an index
1090 * outside of the set specified (in which case 'return - index >=
1091 * max_scan' will be true). In rare cases of index wrap-around, 0 will
1092 * be returned.
1094 * page_cache_next_hole may be called under rcu_read_lock. However,
1095 * like radix_tree_gang_lookup, this will not atomically search a
1096 * snapshot of the tree at a single point in time. For example, if a
1097 * hole is created at index 5, then subsequently a hole is created at
1098 * index 10, page_cache_next_hole covering both indexes may return 10
1099 * if called under rcu_read_lock.
1101 pgoff_t page_cache_next_hole(struct address_space *mapping,
1102 pgoff_t index, unsigned long max_scan)
1104 unsigned long i;
1106 for (i = 0; i < max_scan; i++) {
1107 struct page *page;
1109 page = radix_tree_lookup(&mapping->page_tree, index);
1110 if (!page || radix_tree_exceptional_entry(page))
1111 break;
1112 index++;
1113 if (index == 0)
1114 break;
1117 return index;
1119 EXPORT_SYMBOL(page_cache_next_hole);
1122 * page_cache_prev_hole - find the prev hole (not-present entry)
1123 * @mapping: mapping
1124 * @index: index
1125 * @max_scan: maximum range to search
1127 * Search backwards in the range [max(index-max_scan+1, 0), index] for
1128 * the first hole.
1130 * Returns: the index of the hole if found, otherwise returns an index
1131 * outside of the set specified (in which case 'index - return >=
1132 * max_scan' will be true). In rare cases of wrap-around, ULONG_MAX
1133 * will be returned.
1135 * page_cache_prev_hole may be called under rcu_read_lock. However,
1136 * like radix_tree_gang_lookup, this will not atomically search a
1137 * snapshot of the tree at a single point in time. For example, if a
1138 * hole is created at index 10, then subsequently a hole is created at
1139 * index 5, page_cache_prev_hole covering both indexes may return 5 if
1140 * called under rcu_read_lock.
1142 pgoff_t page_cache_prev_hole(struct address_space *mapping,
1143 pgoff_t index, unsigned long max_scan)
1145 unsigned long i;
1147 for (i = 0; i < max_scan; i++) {
1148 struct page *page;
1150 page = radix_tree_lookup(&mapping->page_tree, index);
1151 if (!page || radix_tree_exceptional_entry(page))
1152 break;
1153 index--;
1154 if (index == ULONG_MAX)
1155 break;
1158 return index;
1160 EXPORT_SYMBOL(page_cache_prev_hole);
1163 * find_get_entry - find and get a page cache entry
1164 * @mapping: the address_space to search
1165 * @offset: the page cache index
1167 * Looks up the page cache slot at @mapping & @offset. If there is a
1168 * page cache page, it is returned with an increased refcount.
1170 * If the slot holds a shadow entry of a previously evicted page, or a
1171 * swap entry from shmem/tmpfs, it is returned.
1173 * Otherwise, %NULL is returned.
1175 struct page *find_get_entry(struct address_space *mapping, pgoff_t offset)
1177 void **pagep;
1178 struct page *head, *page;
1180 rcu_read_lock();
1181 repeat:
1182 page = NULL;
1183 pagep = radix_tree_lookup_slot(&mapping->page_tree, offset);
1184 if (pagep) {
1185 page = radix_tree_deref_slot(pagep);
1186 if (unlikely(!page))
1187 goto out;
1188 if (radix_tree_exception(page)) {
1189 if (radix_tree_deref_retry(page))
1190 goto repeat;
1192 * A shadow entry of a recently evicted page,
1193 * or a swap entry from shmem/tmpfs. Return
1194 * it without attempting to raise page count.
1196 goto out;
1199 head = compound_head(page);
1200 if (!page_cache_get_speculative(head))
1201 goto repeat;
1203 /* The page was split under us? */
1204 if (compound_head(page) != head) {
1205 put_page(head);
1206 goto repeat;
1210 * Has the page moved?
1211 * This is part of the lockless pagecache protocol. See
1212 * include/linux/pagemap.h for details.
1214 if (unlikely(page != *pagep)) {
1215 put_page(head);
1216 goto repeat;
1219 out:
1220 rcu_read_unlock();
1222 return page;
1224 EXPORT_SYMBOL(find_get_entry);
1227 * find_lock_entry - locate, pin and lock a page cache entry
1228 * @mapping: the address_space to search
1229 * @offset: the page cache index
1231 * Looks up the page cache slot at @mapping & @offset. If there is a
1232 * page cache page, it is returned locked and with an increased
1233 * refcount.
1235 * If the slot holds a shadow entry of a previously evicted page, or a
1236 * swap entry from shmem/tmpfs, it is returned.
1238 * Otherwise, %NULL is returned.
1240 * find_lock_entry() may sleep.
1242 struct page *find_lock_entry(struct address_space *mapping, pgoff_t offset)
1244 struct page *page;
1246 repeat:
1247 page = find_get_entry(mapping, offset);
1248 if (page && !radix_tree_exception(page)) {
1249 lock_page(page);
1250 /* Has the page been truncated? */
1251 if (unlikely(page_mapping(page) != mapping)) {
1252 unlock_page(page);
1253 put_page(page);
1254 goto repeat;
1256 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
1258 return page;
1260 EXPORT_SYMBOL(find_lock_entry);
1263 * pagecache_get_page - find and get a page reference
1264 * @mapping: the address_space to search
1265 * @offset: the page index
1266 * @fgp_flags: PCG flags
1267 * @gfp_mask: gfp mask to use for the page cache data page allocation
1269 * Looks up the page cache slot at @mapping & @offset.
1271 * PCG flags modify how the page is returned.
1273 * FGP_ACCESSED: the page will be marked accessed
1274 * FGP_LOCK: Page is return locked
1275 * FGP_CREAT: If page is not present then a new page is allocated using
1276 * @gfp_mask and added to the page cache and the VM's LRU
1277 * list. The page is returned locked and with an increased
1278 * refcount. Otherwise, %NULL is returned.
1280 * If FGP_LOCK or FGP_CREAT are specified then the function may sleep even
1281 * if the GFP flags specified for FGP_CREAT are atomic.
1283 * If there is a page cache page, it is returned with an increased refcount.
1285 struct page *pagecache_get_page(struct address_space *mapping, pgoff_t offset,
1286 int fgp_flags, gfp_t gfp_mask)
1288 struct page *page;
1290 repeat:
1291 page = find_get_entry(mapping, offset);
1292 if (radix_tree_exceptional_entry(page))
1293 page = NULL;
1294 if (!page)
1295 goto no_page;
1297 if (fgp_flags & FGP_LOCK) {
1298 if (fgp_flags & FGP_NOWAIT) {
1299 if (!trylock_page(page)) {
1300 put_page(page);
1301 return NULL;
1303 } else {
1304 lock_page(page);
1307 /* Has the page been truncated? */
1308 if (unlikely(page->mapping != mapping)) {
1309 unlock_page(page);
1310 put_page(page);
1311 goto repeat;
1313 VM_BUG_ON_PAGE(page->index != offset, page);
1316 if (page && (fgp_flags & FGP_ACCESSED))
1317 mark_page_accessed(page);
1319 no_page:
1320 if (!page && (fgp_flags & FGP_CREAT)) {
1321 int err;
1322 if ((fgp_flags & FGP_WRITE) && mapping_cap_account_dirty(mapping))
1323 gfp_mask |= __GFP_WRITE;
1324 if (fgp_flags & FGP_NOFS)
1325 gfp_mask &= ~__GFP_FS;
1327 page = __page_cache_alloc(gfp_mask);
1328 if (!page)
1329 return NULL;
1331 if (WARN_ON_ONCE(!(fgp_flags & FGP_LOCK)))
1332 fgp_flags |= FGP_LOCK;
1334 /* Init accessed so avoid atomic mark_page_accessed later */
1335 if (fgp_flags & FGP_ACCESSED)
1336 __SetPageReferenced(page);
1338 err = add_to_page_cache_lru(page, mapping, offset,
1339 gfp_mask & GFP_RECLAIM_MASK);
1340 if (unlikely(err)) {
1341 put_page(page);
1342 page = NULL;
1343 if (err == -EEXIST)
1344 goto repeat;
1348 return page;
1350 EXPORT_SYMBOL(pagecache_get_page);
1353 * find_get_entries - gang pagecache lookup
1354 * @mapping: The address_space to search
1355 * @start: The starting page cache index
1356 * @nr_entries: The maximum number of entries
1357 * @entries: Where the resulting entries are placed
1358 * @indices: The cache indices corresponding to the entries in @entries
1360 * find_get_entries() will search for and return a group of up to
1361 * @nr_entries entries in the mapping. The entries are placed at
1362 * @entries. find_get_entries() takes a reference against any actual
1363 * pages it returns.
1365 * The search returns a group of mapping-contiguous page cache entries
1366 * with ascending indexes. There may be holes in the indices due to
1367 * not-present pages.
1369 * Any shadow entries of evicted pages, or swap entries from
1370 * shmem/tmpfs, are included in the returned array.
1372 * find_get_entries() returns the number of pages and shadow entries
1373 * which were found.
1375 unsigned find_get_entries(struct address_space *mapping,
1376 pgoff_t start, unsigned int nr_entries,
1377 struct page **entries, pgoff_t *indices)
1379 void **slot;
1380 unsigned int ret = 0;
1381 struct radix_tree_iter iter;
1383 if (!nr_entries)
1384 return 0;
1386 rcu_read_lock();
1387 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
1388 struct page *head, *page;
1389 repeat:
1390 page = radix_tree_deref_slot(slot);
1391 if (unlikely(!page))
1392 continue;
1393 if (radix_tree_exception(page)) {
1394 if (radix_tree_deref_retry(page)) {
1395 slot = radix_tree_iter_retry(&iter);
1396 continue;
1399 * A shadow entry of a recently evicted page, a swap
1400 * entry from shmem/tmpfs or a DAX entry. Return it
1401 * without attempting to raise page count.
1403 goto export;
1406 head = compound_head(page);
1407 if (!page_cache_get_speculative(head))
1408 goto repeat;
1410 /* The page was split under us? */
1411 if (compound_head(page) != head) {
1412 put_page(head);
1413 goto repeat;
1416 /* Has the page moved? */
1417 if (unlikely(page != *slot)) {
1418 put_page(head);
1419 goto repeat;
1421 export:
1422 indices[ret] = iter.index;
1423 entries[ret] = page;
1424 if (++ret == nr_entries)
1425 break;
1427 rcu_read_unlock();
1428 return ret;
1432 * find_get_pages - gang pagecache lookup
1433 * @mapping: The address_space to search
1434 * @start: The starting page index
1435 * @nr_pages: The maximum number of pages
1436 * @pages: Where the resulting pages are placed
1438 * find_get_pages() will search for and return a group of up to
1439 * @nr_pages pages in the mapping. The pages are placed at @pages.
1440 * find_get_pages() takes a reference against the returned pages.
1442 * The search returns a group of mapping-contiguous pages with ascending
1443 * indexes. There may be holes in the indices due to not-present pages.
1445 * find_get_pages() returns the number of pages which were found.
1447 unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
1448 unsigned int nr_pages, struct page **pages)
1450 struct radix_tree_iter iter;
1451 void **slot;
1452 unsigned ret = 0;
1454 if (unlikely(!nr_pages))
1455 return 0;
1457 rcu_read_lock();
1458 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter, start) {
1459 struct page *head, *page;
1460 repeat:
1461 page = radix_tree_deref_slot(slot);
1462 if (unlikely(!page))
1463 continue;
1465 if (radix_tree_exception(page)) {
1466 if (radix_tree_deref_retry(page)) {
1467 slot = radix_tree_iter_retry(&iter);
1468 continue;
1471 * A shadow entry of a recently evicted page,
1472 * or a swap entry from shmem/tmpfs. Skip
1473 * over it.
1475 continue;
1478 head = compound_head(page);
1479 if (!page_cache_get_speculative(head))
1480 goto repeat;
1482 /* The page was split under us? */
1483 if (compound_head(page) != head) {
1484 put_page(head);
1485 goto repeat;
1488 /* Has the page moved? */
1489 if (unlikely(page != *slot)) {
1490 put_page(head);
1491 goto repeat;
1494 pages[ret] = page;
1495 if (++ret == nr_pages)
1496 break;
1499 rcu_read_unlock();
1500 return ret;
1504 * find_get_pages_contig - gang contiguous pagecache lookup
1505 * @mapping: The address_space to search
1506 * @index: The starting page index
1507 * @nr_pages: The maximum number of pages
1508 * @pages: Where the resulting pages are placed
1510 * find_get_pages_contig() works exactly like find_get_pages(), except
1511 * that the returned number of pages are guaranteed to be contiguous.
1513 * find_get_pages_contig() returns the number of pages which were found.
1515 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
1516 unsigned int nr_pages, struct page **pages)
1518 struct radix_tree_iter iter;
1519 void **slot;
1520 unsigned int ret = 0;
1522 if (unlikely(!nr_pages))
1523 return 0;
1525 rcu_read_lock();
1526 radix_tree_for_each_contig(slot, &mapping->page_tree, &iter, index) {
1527 struct page *head, *page;
1528 repeat:
1529 page = radix_tree_deref_slot(slot);
1530 /* The hole, there no reason to continue */
1531 if (unlikely(!page))
1532 break;
1534 if (radix_tree_exception(page)) {
1535 if (radix_tree_deref_retry(page)) {
1536 slot = radix_tree_iter_retry(&iter);
1537 continue;
1540 * A shadow entry of a recently evicted page,
1541 * or a swap entry from shmem/tmpfs. Stop
1542 * looking for contiguous pages.
1544 break;
1547 head = compound_head(page);
1548 if (!page_cache_get_speculative(head))
1549 goto repeat;
1551 /* The page was split under us? */
1552 if (compound_head(page) != head) {
1553 put_page(head);
1554 goto repeat;
1557 /* Has the page moved? */
1558 if (unlikely(page != *slot)) {
1559 put_page(head);
1560 goto repeat;
1564 * must check mapping and index after taking the ref.
1565 * otherwise we can get both false positives and false
1566 * negatives, which is just confusing to the caller.
1568 if (page->mapping == NULL || page_to_pgoff(page) != iter.index) {
1569 put_page(page);
1570 break;
1573 pages[ret] = page;
1574 if (++ret == nr_pages)
1575 break;
1577 rcu_read_unlock();
1578 return ret;
1580 EXPORT_SYMBOL(find_get_pages_contig);
1583 * find_get_pages_tag - find and return pages that match @tag
1584 * @mapping: the address_space to search
1585 * @index: the starting page index
1586 * @tag: the tag index
1587 * @nr_pages: the maximum number of pages
1588 * @pages: where the resulting pages are placed
1590 * Like find_get_pages, except we only return pages which are tagged with
1591 * @tag. We update @index to index the next page for the traversal.
1593 unsigned find_get_pages_tag(struct address_space *mapping, pgoff_t *index,
1594 int tag, unsigned int nr_pages, struct page **pages)
1596 struct radix_tree_iter iter;
1597 void **slot;
1598 unsigned ret = 0;
1600 if (unlikely(!nr_pages))
1601 return 0;
1603 rcu_read_lock();
1604 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1605 &iter, *index, tag) {
1606 struct page *head, *page;
1607 repeat:
1608 page = radix_tree_deref_slot(slot);
1609 if (unlikely(!page))
1610 continue;
1612 if (radix_tree_exception(page)) {
1613 if (radix_tree_deref_retry(page)) {
1614 slot = radix_tree_iter_retry(&iter);
1615 continue;
1618 * A shadow entry of a recently evicted page.
1620 * Those entries should never be tagged, but
1621 * this tree walk is lockless and the tags are
1622 * looked up in bulk, one radix tree node at a
1623 * time, so there is a sizable window for page
1624 * reclaim to evict a page we saw tagged.
1626 * Skip over it.
1628 continue;
1631 head = compound_head(page);
1632 if (!page_cache_get_speculative(head))
1633 goto repeat;
1635 /* The page was split under us? */
1636 if (compound_head(page) != head) {
1637 put_page(head);
1638 goto repeat;
1641 /* Has the page moved? */
1642 if (unlikely(page != *slot)) {
1643 put_page(head);
1644 goto repeat;
1647 pages[ret] = page;
1648 if (++ret == nr_pages)
1649 break;
1652 rcu_read_unlock();
1654 if (ret)
1655 *index = pages[ret - 1]->index + 1;
1657 return ret;
1659 EXPORT_SYMBOL(find_get_pages_tag);
1662 * find_get_entries_tag - find and return entries that match @tag
1663 * @mapping: the address_space to search
1664 * @start: the starting page cache index
1665 * @tag: the tag index
1666 * @nr_entries: the maximum number of entries
1667 * @entries: where the resulting entries are placed
1668 * @indices: the cache indices corresponding to the entries in @entries
1670 * Like find_get_entries, except we only return entries which are tagged with
1671 * @tag.
1673 unsigned find_get_entries_tag(struct address_space *mapping, pgoff_t start,
1674 int tag, unsigned int nr_entries,
1675 struct page **entries, pgoff_t *indices)
1677 void **slot;
1678 unsigned int ret = 0;
1679 struct radix_tree_iter iter;
1681 if (!nr_entries)
1682 return 0;
1684 rcu_read_lock();
1685 radix_tree_for_each_tagged(slot, &mapping->page_tree,
1686 &iter, start, tag) {
1687 struct page *head, *page;
1688 repeat:
1689 page = radix_tree_deref_slot(slot);
1690 if (unlikely(!page))
1691 continue;
1692 if (radix_tree_exception(page)) {
1693 if (radix_tree_deref_retry(page)) {
1694 slot = radix_tree_iter_retry(&iter);
1695 continue;
1699 * A shadow entry of a recently evicted page, a swap
1700 * entry from shmem/tmpfs or a DAX entry. Return it
1701 * without attempting to raise page count.
1703 goto export;
1706 head = compound_head(page);
1707 if (!page_cache_get_speculative(head))
1708 goto repeat;
1710 /* The page was split under us? */
1711 if (compound_head(page) != head) {
1712 put_page(head);
1713 goto repeat;
1716 /* Has the page moved? */
1717 if (unlikely(page != *slot)) {
1718 put_page(head);
1719 goto repeat;
1721 export:
1722 indices[ret] = iter.index;
1723 entries[ret] = page;
1724 if (++ret == nr_entries)
1725 break;
1727 rcu_read_unlock();
1728 return ret;
1730 EXPORT_SYMBOL(find_get_entries_tag);
1733 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1734 * a _large_ part of the i/o request. Imagine the worst scenario:
1736 * ---R__________________________________________B__________
1737 * ^ reading here ^ bad block(assume 4k)
1739 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1740 * => failing the whole request => read(R) => read(R+1) =>
1741 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1742 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1743 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1745 * It is going insane. Fix it by quickly scaling down the readahead size.
1747 static void shrink_readahead_size_eio(struct file *filp,
1748 struct file_ra_state *ra)
1750 ra->ra_pages /= 4;
1754 * do_generic_file_read - generic file read routine
1755 * @filp: the file to read
1756 * @ppos: current file position
1757 * @iter: data destination
1758 * @written: already copied
1760 * This is a generic file read routine, and uses the
1761 * mapping->a_ops->readpage() function for the actual low-level stuff.
1763 * This is really ugly. But the goto's actually try to clarify some
1764 * of the logic when it comes to error handling etc.
1766 static ssize_t do_generic_file_read(struct file *filp, loff_t *ppos,
1767 struct iov_iter *iter, ssize_t written)
1769 struct address_space *mapping = filp->f_mapping;
1770 struct inode *inode = mapping->host;
1771 struct file_ra_state *ra = &filp->f_ra;
1772 pgoff_t index;
1773 pgoff_t last_index;
1774 pgoff_t prev_index;
1775 unsigned long offset; /* offset into pagecache page */
1776 unsigned int prev_offset;
1777 int error = 0;
1779 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
1780 return 0;
1781 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
1783 index = *ppos >> PAGE_SHIFT;
1784 prev_index = ra->prev_pos >> PAGE_SHIFT;
1785 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
1786 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
1787 offset = *ppos & ~PAGE_MASK;
1789 for (;;) {
1790 struct page *page;
1791 pgoff_t end_index;
1792 loff_t isize;
1793 unsigned long nr, ret;
1795 cond_resched();
1796 find_page:
1797 if (fatal_signal_pending(current)) {
1798 error = -EINTR;
1799 goto out;
1802 page = find_get_page(mapping, index);
1803 if (!page) {
1804 page_cache_sync_readahead(mapping,
1805 ra, filp,
1806 index, last_index - index);
1807 page = find_get_page(mapping, index);
1808 if (unlikely(page == NULL))
1809 goto no_cached_page;
1811 if (PageReadahead(page)) {
1812 page_cache_async_readahead(mapping,
1813 ra, filp, page,
1814 index, last_index - index);
1816 if (!PageUptodate(page)) {
1818 * See comment in do_read_cache_page on why
1819 * wait_on_page_locked is used to avoid unnecessarily
1820 * serialisations and why it's safe.
1822 error = wait_on_page_locked_killable(page);
1823 if (unlikely(error))
1824 goto readpage_error;
1825 if (PageUptodate(page))
1826 goto page_ok;
1828 if (inode->i_blkbits == PAGE_SHIFT ||
1829 !mapping->a_ops->is_partially_uptodate)
1830 goto page_not_up_to_date;
1831 /* pipes can't handle partially uptodate pages */
1832 if (unlikely(iter->type & ITER_PIPE))
1833 goto page_not_up_to_date;
1834 if (!trylock_page(page))
1835 goto page_not_up_to_date;
1836 /* Did it get truncated before we got the lock? */
1837 if (!page->mapping)
1838 goto page_not_up_to_date_locked;
1839 if (!mapping->a_ops->is_partially_uptodate(page,
1840 offset, iter->count))
1841 goto page_not_up_to_date_locked;
1842 unlock_page(page);
1844 page_ok:
1846 * i_size must be checked after we know the page is Uptodate.
1848 * Checking i_size after the check allows us to calculate
1849 * the correct value for "nr", which means the zero-filled
1850 * part of the page is not copied back to userspace (unless
1851 * another truncate extends the file - this is desired though).
1854 isize = i_size_read(inode);
1855 end_index = (isize - 1) >> PAGE_SHIFT;
1856 if (unlikely(!isize || index > end_index)) {
1857 put_page(page);
1858 goto out;
1861 /* nr is the maximum number of bytes to copy from this page */
1862 nr = PAGE_SIZE;
1863 if (index == end_index) {
1864 nr = ((isize - 1) & ~PAGE_MASK) + 1;
1865 if (nr <= offset) {
1866 put_page(page);
1867 goto out;
1870 nr = nr - offset;
1872 /* If users can be writing to this page using arbitrary
1873 * virtual addresses, take care about potential aliasing
1874 * before reading the page on the kernel side.
1876 if (mapping_writably_mapped(mapping))
1877 flush_dcache_page(page);
1880 * When a sequential read accesses a page several times,
1881 * only mark it as accessed the first time.
1883 if (prev_index != index || offset != prev_offset)
1884 mark_page_accessed(page);
1885 prev_index = index;
1888 * Ok, we have the page, and it's up-to-date, so
1889 * now we can copy it to user space...
1892 ret = copy_page_to_iter(page, offset, nr, iter);
1893 offset += ret;
1894 index += offset >> PAGE_SHIFT;
1895 offset &= ~PAGE_MASK;
1896 prev_offset = offset;
1898 put_page(page);
1899 written += ret;
1900 if (!iov_iter_count(iter))
1901 goto out;
1902 if (ret < nr) {
1903 error = -EFAULT;
1904 goto out;
1906 continue;
1908 page_not_up_to_date:
1909 /* Get exclusive access to the page ... */
1910 error = lock_page_killable(page);
1911 if (unlikely(error))
1912 goto readpage_error;
1914 page_not_up_to_date_locked:
1915 /* Did it get truncated before we got the lock? */
1916 if (!page->mapping) {
1917 unlock_page(page);
1918 put_page(page);
1919 continue;
1922 /* Did somebody else fill it already? */
1923 if (PageUptodate(page)) {
1924 unlock_page(page);
1925 goto page_ok;
1928 readpage:
1930 * A previous I/O error may have been due to temporary
1931 * failures, eg. multipath errors.
1932 * PG_error will be set again if readpage fails.
1934 ClearPageError(page);
1935 /* Start the actual read. The read will unlock the page. */
1936 error = mapping->a_ops->readpage(filp, page);
1938 if (unlikely(error)) {
1939 if (error == AOP_TRUNCATED_PAGE) {
1940 put_page(page);
1941 error = 0;
1942 goto find_page;
1944 goto readpage_error;
1947 if (!PageUptodate(page)) {
1948 error = lock_page_killable(page);
1949 if (unlikely(error))
1950 goto readpage_error;
1951 if (!PageUptodate(page)) {
1952 if (page->mapping == NULL) {
1954 * invalidate_mapping_pages got it
1956 unlock_page(page);
1957 put_page(page);
1958 goto find_page;
1960 unlock_page(page);
1961 shrink_readahead_size_eio(filp, ra);
1962 error = -EIO;
1963 goto readpage_error;
1965 unlock_page(page);
1968 goto page_ok;
1970 readpage_error:
1971 /* UHHUH! A synchronous read error occurred. Report it */
1972 put_page(page);
1973 goto out;
1975 no_cached_page:
1977 * Ok, it wasn't cached, so we need to create a new
1978 * page..
1980 page = page_cache_alloc_cold(mapping);
1981 if (!page) {
1982 error = -ENOMEM;
1983 goto out;
1985 error = add_to_page_cache_lru(page, mapping, index,
1986 mapping_gfp_constraint(mapping, GFP_KERNEL));
1987 if (error) {
1988 put_page(page);
1989 if (error == -EEXIST) {
1990 error = 0;
1991 goto find_page;
1993 goto out;
1995 goto readpage;
1998 out:
1999 ra->prev_pos = prev_index;
2000 ra->prev_pos <<= PAGE_SHIFT;
2001 ra->prev_pos |= prev_offset;
2003 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
2004 file_accessed(filp);
2005 return written ? written : error;
2009 * generic_file_read_iter - generic filesystem read routine
2010 * @iocb: kernel I/O control block
2011 * @iter: destination for the data read
2013 * This is the "read_iter()" routine for all filesystems
2014 * that can use the page cache directly.
2016 ssize_t
2017 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
2019 struct file *file = iocb->ki_filp;
2020 ssize_t retval = 0;
2021 size_t count = iov_iter_count(iter);
2023 if (!count)
2024 goto out; /* skip atime */
2026 if (iocb->ki_flags & IOCB_DIRECT) {
2027 struct address_space *mapping = file->f_mapping;
2028 struct inode *inode = mapping->host;
2029 struct iov_iter data = *iter;
2030 loff_t size;
2032 size = i_size_read(inode);
2033 retval = filemap_write_and_wait_range(mapping, iocb->ki_pos,
2034 iocb->ki_pos + count - 1);
2035 if (retval < 0)
2036 goto out;
2038 file_accessed(file);
2040 retval = mapping->a_ops->direct_IO(iocb, &data);
2041 if (retval >= 0) {
2042 iocb->ki_pos += retval;
2043 iov_iter_advance(iter, retval);
2047 * Btrfs can have a short DIO read if we encounter
2048 * compressed extents, so if there was an error, or if
2049 * we've already read everything we wanted to, or if
2050 * there was a short read because we hit EOF, go ahead
2051 * and return. Otherwise fallthrough to buffered io for
2052 * the rest of the read. Buffered reads will not work for
2053 * DAX files, so don't bother trying.
2055 if (retval < 0 || !iov_iter_count(iter) || iocb->ki_pos >= size ||
2056 IS_DAX(inode))
2057 goto out;
2060 retval = do_generic_file_read(file, &iocb->ki_pos, iter, retval);
2061 out:
2062 return retval;
2064 EXPORT_SYMBOL(generic_file_read_iter);
2066 #ifdef CONFIG_MMU
2068 * page_cache_read - adds requested page to the page cache if not already there
2069 * @file: file to read
2070 * @offset: page index
2071 * @gfp_mask: memory allocation flags
2073 * This adds the requested page to the page cache if it isn't already there,
2074 * and schedules an I/O to read in its contents from disk.
2076 static int page_cache_read(struct file *file, pgoff_t offset, gfp_t gfp_mask)
2078 struct address_space *mapping = file->f_mapping;
2079 struct page *page;
2080 int ret;
2082 do {
2083 page = __page_cache_alloc(gfp_mask|__GFP_COLD);
2084 if (!page)
2085 return -ENOMEM;
2087 ret = add_to_page_cache_lru(page, mapping, offset, gfp_mask & GFP_KERNEL);
2088 if (ret == 0)
2089 ret = mapping->a_ops->readpage(file, page);
2090 else if (ret == -EEXIST)
2091 ret = 0; /* losing race to add is OK */
2093 put_page(page);
2095 } while (ret == AOP_TRUNCATED_PAGE);
2097 return ret;
2100 #define MMAP_LOTSAMISS (100)
2103 * Synchronous readahead happens when we don't even find
2104 * a page in the page cache at all.
2106 static void do_sync_mmap_readahead(struct vm_area_struct *vma,
2107 struct file_ra_state *ra,
2108 struct file *file,
2109 pgoff_t offset)
2111 struct address_space *mapping = file->f_mapping;
2113 /* If we don't want any read-ahead, don't bother */
2114 if (vma->vm_flags & VM_RAND_READ)
2115 return;
2116 if (!ra->ra_pages)
2117 return;
2119 if (vma->vm_flags & VM_SEQ_READ) {
2120 page_cache_sync_readahead(mapping, ra, file, offset,
2121 ra->ra_pages);
2122 return;
2125 /* Avoid banging the cache line if not needed */
2126 if (ra->mmap_miss < MMAP_LOTSAMISS * 10)
2127 ra->mmap_miss++;
2130 * Do we miss much more than hit in this file? If so,
2131 * stop bothering with read-ahead. It will only hurt.
2133 if (ra->mmap_miss > MMAP_LOTSAMISS)
2134 return;
2137 * mmap read-around
2139 ra->start = max_t(long, 0, offset - ra->ra_pages / 2);
2140 ra->size = ra->ra_pages;
2141 ra->async_size = ra->ra_pages / 4;
2142 ra_submit(ra, mapping, file);
2146 * Asynchronous readahead happens when we find the page and PG_readahead,
2147 * so we want to possibly extend the readahead further..
2149 static void do_async_mmap_readahead(struct vm_area_struct *vma,
2150 struct file_ra_state *ra,
2151 struct file *file,
2152 struct page *page,
2153 pgoff_t offset)
2155 struct address_space *mapping = file->f_mapping;
2157 /* If we don't want any read-ahead, don't bother */
2158 if (vma->vm_flags & VM_RAND_READ)
2159 return;
2160 if (ra->mmap_miss > 0)
2161 ra->mmap_miss--;
2162 if (PageReadahead(page))
2163 page_cache_async_readahead(mapping, ra, file,
2164 page, offset, ra->ra_pages);
2168 * filemap_fault - read in file data for page fault handling
2169 * @vma: vma in which the fault was taken
2170 * @vmf: struct vm_fault containing details of the fault
2172 * filemap_fault() is invoked via the vma operations vector for a
2173 * mapped memory region to read in file data during a page fault.
2175 * The goto's are kind of ugly, but this streamlines the normal case of having
2176 * it in the page cache, and handles the special cases reasonably without
2177 * having a lot of duplicated code.
2179 * vma->vm_mm->mmap_sem must be held on entry.
2181 * If our return value has VM_FAULT_RETRY set, it's because
2182 * lock_page_or_retry() returned 0.
2183 * The mmap_sem has usually been released in this case.
2184 * See __lock_page_or_retry() for the exception.
2186 * If our return value does not have VM_FAULT_RETRY set, the mmap_sem
2187 * has not been released.
2189 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
2191 int filemap_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
2193 int error;
2194 struct file *file = vma->vm_file;
2195 struct address_space *mapping = file->f_mapping;
2196 struct file_ra_state *ra = &file->f_ra;
2197 struct inode *inode = mapping->host;
2198 pgoff_t offset = vmf->pgoff;
2199 struct page *page;
2200 loff_t size;
2201 int ret = 0;
2203 size = round_up(i_size_read(inode), PAGE_SIZE);
2204 if (offset >= size >> PAGE_SHIFT)
2205 return VM_FAULT_SIGBUS;
2208 * Do we have something in the page cache already?
2210 page = find_get_page(mapping, offset);
2211 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
2213 * We found the page, so try async readahead before
2214 * waiting for the lock.
2216 do_async_mmap_readahead(vma, ra, file, page, offset);
2217 } else if (!page) {
2218 /* No page in the page cache at all */
2219 do_sync_mmap_readahead(vma, ra, file, offset);
2220 count_vm_event(PGMAJFAULT);
2221 mem_cgroup_count_vm_event(vma->vm_mm, PGMAJFAULT);
2222 ret = VM_FAULT_MAJOR;
2223 retry_find:
2224 page = find_get_page(mapping, offset);
2225 if (!page)
2226 goto no_cached_page;
2229 if (!lock_page_or_retry(page, vma->vm_mm, vmf->flags)) {
2230 put_page(page);
2231 return ret | VM_FAULT_RETRY;
2234 /* Did it get truncated? */
2235 if (unlikely(page->mapping != mapping)) {
2236 unlock_page(page);
2237 put_page(page);
2238 goto retry_find;
2240 VM_BUG_ON_PAGE(page->index != offset, page);
2243 * We have a locked page in the page cache, now we need to check
2244 * that it's up-to-date. If not, it is going to be due to an error.
2246 if (unlikely(!PageUptodate(page)))
2247 goto page_not_uptodate;
2250 * Found the page and have a reference on it.
2251 * We must recheck i_size under page lock.
2253 size = round_up(i_size_read(inode), PAGE_SIZE);
2254 if (unlikely(offset >= size >> PAGE_SHIFT)) {
2255 unlock_page(page);
2256 put_page(page);
2257 return VM_FAULT_SIGBUS;
2260 vmf->page = page;
2261 return ret | VM_FAULT_LOCKED;
2263 no_cached_page:
2265 * We're only likely to ever get here if MADV_RANDOM is in
2266 * effect.
2268 error = page_cache_read(file, offset, vmf->gfp_mask);
2271 * The page we want has now been added to the page cache.
2272 * In the unlikely event that someone removed it in the
2273 * meantime, we'll just come back here and read it again.
2275 if (error >= 0)
2276 goto retry_find;
2279 * An error return from page_cache_read can result if the
2280 * system is low on memory, or a problem occurs while trying
2281 * to schedule I/O.
2283 if (error == -ENOMEM)
2284 return VM_FAULT_OOM;
2285 return VM_FAULT_SIGBUS;
2287 page_not_uptodate:
2289 * Umm, take care of errors if the page isn't up-to-date.
2290 * Try to re-read it _once_. We do this synchronously,
2291 * because there really aren't any performance issues here
2292 * and we need to check for errors.
2294 ClearPageError(page);
2295 error = mapping->a_ops->readpage(file, page);
2296 if (!error) {
2297 wait_on_page_locked(page);
2298 if (!PageUptodate(page))
2299 error = -EIO;
2301 put_page(page);
2303 if (!error || error == AOP_TRUNCATED_PAGE)
2304 goto retry_find;
2306 /* Things didn't work out. Return zero to tell the mm layer so. */
2307 shrink_readahead_size_eio(file, ra);
2308 return VM_FAULT_SIGBUS;
2310 EXPORT_SYMBOL(filemap_fault);
2312 void filemap_map_pages(struct vm_fault *vmf,
2313 pgoff_t start_pgoff, pgoff_t end_pgoff)
2315 struct radix_tree_iter iter;
2316 void **slot;
2317 struct file *file = vmf->vma->vm_file;
2318 struct address_space *mapping = file->f_mapping;
2319 pgoff_t last_pgoff = start_pgoff;
2320 loff_t size;
2321 struct page *head, *page;
2323 rcu_read_lock();
2324 radix_tree_for_each_slot(slot, &mapping->page_tree, &iter,
2325 start_pgoff) {
2326 if (iter.index > end_pgoff)
2327 break;
2328 repeat:
2329 page = radix_tree_deref_slot(slot);
2330 if (unlikely(!page))
2331 goto next;
2332 if (radix_tree_exception(page)) {
2333 if (radix_tree_deref_retry(page)) {
2334 slot = radix_tree_iter_retry(&iter);
2335 continue;
2337 goto next;
2340 head = compound_head(page);
2341 if (!page_cache_get_speculative(head))
2342 goto repeat;
2344 /* The page was split under us? */
2345 if (compound_head(page) != head) {
2346 put_page(head);
2347 goto repeat;
2350 /* Has the page moved? */
2351 if (unlikely(page != *slot)) {
2352 put_page(head);
2353 goto repeat;
2356 if (!PageUptodate(page) ||
2357 PageReadahead(page) ||
2358 PageHWPoison(page))
2359 goto skip;
2360 if (!trylock_page(page))
2361 goto skip;
2363 if (page->mapping != mapping || !PageUptodate(page))
2364 goto unlock;
2366 size = round_up(i_size_read(mapping->host), PAGE_SIZE);
2367 if (page->index >= size >> PAGE_SHIFT)
2368 goto unlock;
2370 if (file->f_ra.mmap_miss > 0)
2371 file->f_ra.mmap_miss--;
2373 vmf->address += (iter.index - last_pgoff) << PAGE_SHIFT;
2374 if (vmf->pte)
2375 vmf->pte += iter.index - last_pgoff;
2376 last_pgoff = iter.index;
2377 if (alloc_set_pte(vmf, NULL, page))
2378 goto unlock;
2379 unlock_page(page);
2380 goto next;
2381 unlock:
2382 unlock_page(page);
2383 skip:
2384 put_page(page);
2385 next:
2386 /* Huge page is mapped? No need to proceed. */
2387 if (pmd_trans_huge(*vmf->pmd))
2388 break;
2389 if (iter.index == end_pgoff)
2390 break;
2392 rcu_read_unlock();
2394 EXPORT_SYMBOL(filemap_map_pages);
2396 int filemap_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf)
2398 struct page *page = vmf->page;
2399 struct inode *inode = file_inode(vma->vm_file);
2400 int ret = VM_FAULT_LOCKED;
2402 sb_start_pagefault(inode->i_sb);
2403 file_update_time(vma->vm_file);
2404 lock_page(page);
2405 if (page->mapping != inode->i_mapping) {
2406 unlock_page(page);
2407 ret = VM_FAULT_NOPAGE;
2408 goto out;
2411 * We mark the page dirty already here so that when freeze is in
2412 * progress, we are guaranteed that writeback during freezing will
2413 * see the dirty page and writeprotect it again.
2415 set_page_dirty(page);
2416 wait_for_stable_page(page);
2417 out:
2418 sb_end_pagefault(inode->i_sb);
2419 return ret;
2421 EXPORT_SYMBOL(filemap_page_mkwrite);
2423 const struct vm_operations_struct generic_file_vm_ops = {
2424 .fault = filemap_fault,
2425 .map_pages = filemap_map_pages,
2426 .page_mkwrite = filemap_page_mkwrite,
2429 /* This is used for a general mmap of a disk file */
2431 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2433 struct address_space *mapping = file->f_mapping;
2435 if (!mapping->a_ops->readpage)
2436 return -ENOEXEC;
2437 file_accessed(file);
2438 vma->vm_ops = &generic_file_vm_ops;
2439 return 0;
2443 * This is for filesystems which do not implement ->writepage.
2445 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
2447 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
2448 return -EINVAL;
2449 return generic_file_mmap(file, vma);
2451 #else
2452 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
2454 return -ENOSYS;
2456 int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
2458 return -ENOSYS;
2460 #endif /* CONFIG_MMU */
2462 EXPORT_SYMBOL(generic_file_mmap);
2463 EXPORT_SYMBOL(generic_file_readonly_mmap);
2465 static struct page *wait_on_page_read(struct page *page)
2467 if (!IS_ERR(page)) {
2468 wait_on_page_locked(page);
2469 if (!PageUptodate(page)) {
2470 put_page(page);
2471 page = ERR_PTR(-EIO);
2474 return page;
2477 static struct page *do_read_cache_page(struct address_space *mapping,
2478 pgoff_t index,
2479 int (*filler)(void *, struct page *),
2480 void *data,
2481 gfp_t gfp)
2483 struct page *page;
2484 int err;
2485 repeat:
2486 page = find_get_page(mapping, index);
2487 if (!page) {
2488 page = __page_cache_alloc(gfp | __GFP_COLD);
2489 if (!page)
2490 return ERR_PTR(-ENOMEM);
2491 err = add_to_page_cache_lru(page, mapping, index, gfp);
2492 if (unlikely(err)) {
2493 put_page(page);
2494 if (err == -EEXIST)
2495 goto repeat;
2496 /* Presumably ENOMEM for radix tree node */
2497 return ERR_PTR(err);
2500 filler:
2501 err = filler(data, page);
2502 if (err < 0) {
2503 put_page(page);
2504 return ERR_PTR(err);
2507 page = wait_on_page_read(page);
2508 if (IS_ERR(page))
2509 return page;
2510 goto out;
2512 if (PageUptodate(page))
2513 goto out;
2516 * Page is not up to date and may be locked due one of the following
2517 * case a: Page is being filled and the page lock is held
2518 * case b: Read/write error clearing the page uptodate status
2519 * case c: Truncation in progress (page locked)
2520 * case d: Reclaim in progress
2522 * Case a, the page will be up to date when the page is unlocked.
2523 * There is no need to serialise on the page lock here as the page
2524 * is pinned so the lock gives no additional protection. Even if the
2525 * the page is truncated, the data is still valid if PageUptodate as
2526 * it's a race vs truncate race.
2527 * Case b, the page will not be up to date
2528 * Case c, the page may be truncated but in itself, the data may still
2529 * be valid after IO completes as it's a read vs truncate race. The
2530 * operation must restart if the page is not uptodate on unlock but
2531 * otherwise serialising on page lock to stabilise the mapping gives
2532 * no additional guarantees to the caller as the page lock is
2533 * released before return.
2534 * Case d, similar to truncation. If reclaim holds the page lock, it
2535 * will be a race with remove_mapping that determines if the mapping
2536 * is valid on unlock but otherwise the data is valid and there is
2537 * no need to serialise with page lock.
2539 * As the page lock gives no additional guarantee, we optimistically
2540 * wait on the page to be unlocked and check if it's up to date and
2541 * use the page if it is. Otherwise, the page lock is required to
2542 * distinguish between the different cases. The motivation is that we
2543 * avoid spurious serialisations and wakeups when multiple processes
2544 * wait on the same page for IO to complete.
2546 wait_on_page_locked(page);
2547 if (PageUptodate(page))
2548 goto out;
2550 /* Distinguish between all the cases under the safety of the lock */
2551 lock_page(page);
2553 /* Case c or d, restart the operation */
2554 if (!page->mapping) {
2555 unlock_page(page);
2556 put_page(page);
2557 goto repeat;
2560 /* Someone else locked and filled the page in a very small window */
2561 if (PageUptodate(page)) {
2562 unlock_page(page);
2563 goto out;
2565 goto filler;
2567 out:
2568 mark_page_accessed(page);
2569 return page;
2573 * read_cache_page - read into page cache, fill it if needed
2574 * @mapping: the page's address_space
2575 * @index: the page index
2576 * @filler: function to perform the read
2577 * @data: first arg to filler(data, page) function, often left as NULL
2579 * Read into the page cache. If a page already exists, and PageUptodate() is
2580 * not set, try to fill the page and wait for it to become unlocked.
2582 * If the page does not get brought uptodate, return -EIO.
2584 struct page *read_cache_page(struct address_space *mapping,
2585 pgoff_t index,
2586 int (*filler)(void *, struct page *),
2587 void *data)
2589 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
2591 EXPORT_SYMBOL(read_cache_page);
2594 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
2595 * @mapping: the page's address_space
2596 * @index: the page index
2597 * @gfp: the page allocator flags to use if allocating
2599 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
2600 * any new page allocations done using the specified allocation flags.
2602 * If the page does not get brought uptodate, return -EIO.
2604 struct page *read_cache_page_gfp(struct address_space *mapping,
2605 pgoff_t index,
2606 gfp_t gfp)
2608 filler_t *filler = (filler_t *)mapping->a_ops->readpage;
2610 return do_read_cache_page(mapping, index, filler, NULL, gfp);
2612 EXPORT_SYMBOL(read_cache_page_gfp);
2615 * Performs necessary checks before doing a write
2617 * Can adjust writing position or amount of bytes to write.
2618 * Returns appropriate error code that caller should return or
2619 * zero in case that write should be allowed.
2621 inline ssize_t generic_write_checks(struct kiocb *iocb, struct iov_iter *from)
2623 struct file *file = iocb->ki_filp;
2624 struct inode *inode = file->f_mapping->host;
2625 unsigned long limit = rlimit(RLIMIT_FSIZE);
2626 loff_t pos;
2628 if (!iov_iter_count(from))
2629 return 0;
2631 /* FIXME: this is for backwards compatibility with 2.4 */
2632 if (iocb->ki_flags & IOCB_APPEND)
2633 iocb->ki_pos = i_size_read(inode);
2635 pos = iocb->ki_pos;
2637 if (limit != RLIM_INFINITY) {
2638 if (iocb->ki_pos >= limit) {
2639 send_sig(SIGXFSZ, current, 0);
2640 return -EFBIG;
2642 iov_iter_truncate(from, limit - (unsigned long)pos);
2646 * LFS rule
2648 if (unlikely(pos + iov_iter_count(from) > MAX_NON_LFS &&
2649 !(file->f_flags & O_LARGEFILE))) {
2650 if (pos >= MAX_NON_LFS)
2651 return -EFBIG;
2652 iov_iter_truncate(from, MAX_NON_LFS - (unsigned long)pos);
2656 * Are we about to exceed the fs block limit ?
2658 * If we have written data it becomes a short write. If we have
2659 * exceeded without writing data we send a signal and return EFBIG.
2660 * Linus frestrict idea will clean these up nicely..
2662 if (unlikely(pos >= inode->i_sb->s_maxbytes))
2663 return -EFBIG;
2665 iov_iter_truncate(from, inode->i_sb->s_maxbytes - pos);
2666 return iov_iter_count(from);
2668 EXPORT_SYMBOL(generic_write_checks);
2670 int pagecache_write_begin(struct file *file, struct address_space *mapping,
2671 loff_t pos, unsigned len, unsigned flags,
2672 struct page **pagep, void **fsdata)
2674 const struct address_space_operations *aops = mapping->a_ops;
2676 return aops->write_begin(file, mapping, pos, len, flags,
2677 pagep, fsdata);
2679 EXPORT_SYMBOL(pagecache_write_begin);
2681 int pagecache_write_end(struct file *file, struct address_space *mapping,
2682 loff_t pos, unsigned len, unsigned copied,
2683 struct page *page, void *fsdata)
2685 const struct address_space_operations *aops = mapping->a_ops;
2687 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
2689 EXPORT_SYMBOL(pagecache_write_end);
2691 ssize_t
2692 generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
2694 struct file *file = iocb->ki_filp;
2695 struct address_space *mapping = file->f_mapping;
2696 struct inode *inode = mapping->host;
2697 loff_t pos = iocb->ki_pos;
2698 ssize_t written;
2699 size_t write_len;
2700 pgoff_t end;
2701 struct iov_iter data;
2703 write_len = iov_iter_count(from);
2704 end = (pos + write_len - 1) >> PAGE_SHIFT;
2706 written = filemap_write_and_wait_range(mapping, pos, pos + write_len - 1);
2707 if (written)
2708 goto out;
2711 * After a write we want buffered reads to be sure to go to disk to get
2712 * the new data. We invalidate clean cached page from the region we're
2713 * about to write. We do this *before* the write so that we can return
2714 * without clobbering -EIOCBQUEUED from ->direct_IO().
2716 if (mapping->nrpages) {
2717 written = invalidate_inode_pages2_range(mapping,
2718 pos >> PAGE_SHIFT, end);
2720 * If a page can not be invalidated, return 0 to fall back
2721 * to buffered write.
2723 if (written) {
2724 if (written == -EBUSY)
2725 return 0;
2726 goto out;
2730 data = *from;
2731 written = mapping->a_ops->direct_IO(iocb, &data);
2734 * Finally, try again to invalidate clean pages which might have been
2735 * cached by non-direct readahead, or faulted in by get_user_pages()
2736 * if the source of the write was an mmap'ed region of the file
2737 * we're writing. Either one is a pretty crazy thing to do,
2738 * so we don't support it 100%. If this invalidation
2739 * fails, tough, the write still worked...
2741 if (mapping->nrpages) {
2742 invalidate_inode_pages2_range(mapping,
2743 pos >> PAGE_SHIFT, end);
2746 if (written > 0) {
2747 pos += written;
2748 iov_iter_advance(from, written);
2749 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
2750 i_size_write(inode, pos);
2751 mark_inode_dirty(inode);
2753 iocb->ki_pos = pos;
2755 out:
2756 return written;
2758 EXPORT_SYMBOL(generic_file_direct_write);
2761 * Find or create a page at the given pagecache position. Return the locked
2762 * page. This function is specifically for buffered writes.
2764 struct page *grab_cache_page_write_begin(struct address_space *mapping,
2765 pgoff_t index, unsigned flags)
2767 struct page *page;
2768 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
2770 if (flags & AOP_FLAG_NOFS)
2771 fgp_flags |= FGP_NOFS;
2773 page = pagecache_get_page(mapping, index, fgp_flags,
2774 mapping_gfp_mask(mapping));
2775 if (page)
2776 wait_for_stable_page(page);
2778 return page;
2780 EXPORT_SYMBOL(grab_cache_page_write_begin);
2782 ssize_t generic_perform_write(struct file *file,
2783 struct iov_iter *i, loff_t pos)
2785 struct address_space *mapping = file->f_mapping;
2786 const struct address_space_operations *a_ops = mapping->a_ops;
2787 long status = 0;
2788 ssize_t written = 0;
2789 unsigned int flags = 0;
2792 * Copies from kernel address space cannot fail (NFSD is a big user).
2794 if (!iter_is_iovec(i))
2795 flags |= AOP_FLAG_UNINTERRUPTIBLE;
2797 do {
2798 struct page *page;
2799 unsigned long offset; /* Offset into pagecache page */
2800 unsigned long bytes; /* Bytes to write to page */
2801 size_t copied; /* Bytes copied from user */
2802 void *fsdata;
2804 offset = (pos & (PAGE_SIZE - 1));
2805 bytes = min_t(unsigned long, PAGE_SIZE - offset,
2806 iov_iter_count(i));
2808 again:
2810 * Bring in the user page that we will copy from _first_.
2811 * Otherwise there's a nasty deadlock on copying from the
2812 * same page as we're writing to, without it being marked
2813 * up-to-date.
2815 * Not only is this an optimisation, but it is also required
2816 * to check that the address is actually valid, when atomic
2817 * usercopies are used, below.
2819 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
2820 status = -EFAULT;
2821 break;
2824 if (fatal_signal_pending(current)) {
2825 status = -EINTR;
2826 break;
2829 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
2830 &page, &fsdata);
2831 if (unlikely(status < 0))
2832 break;
2834 if (mapping_writably_mapped(mapping))
2835 flush_dcache_page(page);
2837 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
2838 flush_dcache_page(page);
2840 status = a_ops->write_end(file, mapping, pos, bytes, copied,
2841 page, fsdata);
2842 if (unlikely(status < 0))
2843 break;
2844 copied = status;
2846 cond_resched();
2848 iov_iter_advance(i, copied);
2849 if (unlikely(copied == 0)) {
2851 * If we were unable to copy any data at all, we must
2852 * fall back to a single segment length write.
2854 * If we didn't fallback here, we could livelock
2855 * because not all segments in the iov can be copied at
2856 * once without a pagefault.
2858 bytes = min_t(unsigned long, PAGE_SIZE - offset,
2859 iov_iter_single_seg_count(i));
2860 goto again;
2862 pos += copied;
2863 written += copied;
2865 balance_dirty_pages_ratelimited(mapping);
2866 } while (iov_iter_count(i));
2868 return written ? written : status;
2870 EXPORT_SYMBOL(generic_perform_write);
2873 * __generic_file_write_iter - write data to a file
2874 * @iocb: IO state structure (file, offset, etc.)
2875 * @from: iov_iter with data to write
2877 * This function does all the work needed for actually writing data to a
2878 * file. It does all basic checks, removes SUID from the file, updates
2879 * modification times and calls proper subroutines depending on whether we
2880 * do direct IO or a standard buffered write.
2882 * It expects i_mutex to be grabbed unless we work on a block device or similar
2883 * object which does not need locking at all.
2885 * This function does *not* take care of syncing data in case of O_SYNC write.
2886 * A caller has to handle it. This is mainly due to the fact that we want to
2887 * avoid syncing under i_mutex.
2889 ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
2891 struct file *file = iocb->ki_filp;
2892 struct address_space * mapping = file->f_mapping;
2893 struct inode *inode = mapping->host;
2894 ssize_t written = 0;
2895 ssize_t err;
2896 ssize_t status;
2898 /* We can write back this queue in page reclaim */
2899 current->backing_dev_info = inode_to_bdi(inode);
2900 err = file_remove_privs(file);
2901 if (err)
2902 goto out;
2904 err = file_update_time(file);
2905 if (err)
2906 goto out;
2908 if (iocb->ki_flags & IOCB_DIRECT) {
2909 loff_t pos, endbyte;
2911 written = generic_file_direct_write(iocb, from);
2913 * If the write stopped short of completing, fall back to
2914 * buffered writes. Some filesystems do this for writes to
2915 * holes, for example. For DAX files, a buffered write will
2916 * not succeed (even if it did, DAX does not handle dirty
2917 * page-cache pages correctly).
2919 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
2920 goto out;
2922 status = generic_perform_write(file, from, pos = iocb->ki_pos);
2924 * If generic_perform_write() returned a synchronous error
2925 * then we want to return the number of bytes which were
2926 * direct-written, or the error code if that was zero. Note
2927 * that this differs from normal direct-io semantics, which
2928 * will return -EFOO even if some bytes were written.
2930 if (unlikely(status < 0)) {
2931 err = status;
2932 goto out;
2935 * We need to ensure that the page cache pages are written to
2936 * disk and invalidated to preserve the expected O_DIRECT
2937 * semantics.
2939 endbyte = pos + status - 1;
2940 err = filemap_write_and_wait_range(mapping, pos, endbyte);
2941 if (err == 0) {
2942 iocb->ki_pos = endbyte + 1;
2943 written += status;
2944 invalidate_mapping_pages(mapping,
2945 pos >> PAGE_SHIFT,
2946 endbyte >> PAGE_SHIFT);
2947 } else {
2949 * We don't know how much we wrote, so just return
2950 * the number of bytes which were direct-written
2953 } else {
2954 written = generic_perform_write(file, from, iocb->ki_pos);
2955 if (likely(written > 0))
2956 iocb->ki_pos += written;
2958 out:
2959 current->backing_dev_info = NULL;
2960 return written ? written : err;
2962 EXPORT_SYMBOL(__generic_file_write_iter);
2965 * generic_file_write_iter - write data to a file
2966 * @iocb: IO state structure
2967 * @from: iov_iter with data to write
2969 * This is a wrapper around __generic_file_write_iter() to be used by most
2970 * filesystems. It takes care of syncing the file in case of O_SYNC file
2971 * and acquires i_mutex as needed.
2973 ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
2975 struct file *file = iocb->ki_filp;
2976 struct inode *inode = file->f_mapping->host;
2977 ssize_t ret;
2979 inode_lock(inode);
2980 ret = generic_write_checks(iocb, from);
2981 if (ret > 0)
2982 ret = __generic_file_write_iter(iocb, from);
2983 inode_unlock(inode);
2985 if (ret > 0)
2986 ret = generic_write_sync(iocb, ret);
2987 return ret;
2989 EXPORT_SYMBOL(generic_file_write_iter);
2992 * try_to_release_page() - release old fs-specific metadata on a page
2994 * @page: the page which the kernel is trying to free
2995 * @gfp_mask: memory allocation flags (and I/O mode)
2997 * The address_space is to try to release any data against the page
2998 * (presumably at page->private). If the release was successful, return `1'.
2999 * Otherwise return zero.
3001 * This may also be called if PG_fscache is set on a page, indicating that the
3002 * page is known to the local caching routines.
3004 * The @gfp_mask argument specifies whether I/O may be performed to release
3005 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
3008 int try_to_release_page(struct page *page, gfp_t gfp_mask)
3010 struct address_space * const mapping = page->mapping;
3012 BUG_ON(!PageLocked(page));
3013 if (PageWriteback(page))
3014 return 0;
3016 if (mapping && mapping->a_ops->releasepage)
3017 return mapping->a_ops->releasepage(page, gfp_mask);
3018 return try_to_free_buffers(page);
3021 EXPORT_SYMBOL(try_to_release_page);