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/aio.h>
17 #include <linux/capability.h>
18 #include <linux/kernel_stat.h>
19 #include <linux/gfp.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/memcontrol.h>
35 #include <linux/cleancache.h>
38 #define CREATE_TRACE_POINTS
39 #include <trace/events/filemap.h>
42 * FIXME: remove all knowledge of the buffer layer from the core VM
44 #include <linux/buffer_head.h> /* for try_to_free_buffers */
49 * Shared mappings implemented 30.11.1994. It's not fully working yet,
52 * Shared mappings now work. 15.8.1995 Bruno.
54 * finished 'unifying' the page and buffer cache and SMP-threaded the
55 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
57 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
63 * ->i_mmap_mutex (truncate_pagecache)
64 * ->private_lock (__free_pte->__set_page_dirty_buffers)
65 * ->swap_lock (exclusive_swap_page, others)
66 * ->mapping->tree_lock
69 * ->i_mmap_mutex (truncate->unmap_mapping_range)
73 * ->page_table_lock or pte_lock (various, mainly in memory.c)
74 * ->mapping->tree_lock (arch-dependent flush_dcache_mmap_lock)
77 * ->lock_page (access_process_vm)
79 * ->i_mutex (generic_file_buffered_write)
80 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
83 * sb_lock (fs/fs-writeback.c)
84 * ->mapping->tree_lock (__sync_single_inode)
87 * ->anon_vma.lock (vma_adjust)
90 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
92 * ->page_table_lock or pte_lock
93 * ->swap_lock (try_to_unmap_one)
94 * ->private_lock (try_to_unmap_one)
95 * ->tree_lock (try_to_unmap_one)
96 * ->zone.lru_lock (follow_page->mark_page_accessed)
97 * ->zone.lru_lock (check_pte_range->isolate_lru_page)
98 * ->private_lock (page_remove_rmap->set_page_dirty)
99 * ->tree_lock (page_remove_rmap->set_page_dirty)
100 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
101 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
102 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
103 * ->inode->i_lock (zap_pte_range->set_page_dirty)
104 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
107 * ->tasklist_lock (memory_failure, collect_procs_ao)
111 * Delete a page from the page cache and free it. Caller has to make
112 * sure the page is locked and that nobody else uses it - or that usage
113 * is safe. The caller must hold the mapping's tree_lock.
115 void __delete_from_page_cache(struct page
*page
)
117 struct address_space
*mapping
= page
->mapping
;
119 trace_mm_filemap_delete_from_page_cache(page
);
121 * if we're uptodate, flush out into the cleancache, otherwise
122 * invalidate any existing cleancache entries. We can't leave
123 * stale data around in the cleancache once our page is gone
125 if (PageUptodate(page
) && PageMappedToDisk(page
))
126 cleancache_put_page(page
);
128 cleancache_invalidate_page(mapping
, page
);
130 radix_tree_delete(&mapping
->page_tree
, page
->index
);
131 page
->mapping
= NULL
;
132 /* Leave page->index set: truncation lookup relies upon it */
134 __dec_zone_page_state(page
, NR_FILE_PAGES
);
135 if (PageSwapBacked(page
))
136 __dec_zone_page_state(page
, NR_SHMEM
);
137 BUG_ON(page_mapped(page
));
140 * Some filesystems seem to re-dirty the page even after
141 * the VM has canceled the dirty bit (eg ext3 journaling).
143 * Fix it up by doing a final dirty accounting check after
144 * having removed the page entirely.
146 if (PageDirty(page
) && mapping_cap_account_dirty(mapping
)) {
147 dec_zone_page_state(page
, NR_FILE_DIRTY
);
148 dec_bdi_stat(mapping
->backing_dev_info
, BDI_RECLAIMABLE
);
153 * delete_from_page_cache - delete page from page cache
154 * @page: the page which the kernel is trying to remove from page cache
156 * This must be called only on pages that have been verified to be in the page
157 * cache and locked. It will never put the page into the free list, the caller
158 * has a reference on the page.
160 void delete_from_page_cache(struct page
*page
)
162 struct address_space
*mapping
= page
->mapping
;
163 void (*freepage
)(struct page
*);
165 BUG_ON(!PageLocked(page
));
167 freepage
= mapping
->a_ops
->freepage
;
168 spin_lock_irq(&mapping
->tree_lock
);
169 __delete_from_page_cache(page
);
170 spin_unlock_irq(&mapping
->tree_lock
);
171 mem_cgroup_uncharge_cache_page(page
);
175 page_cache_release(page
);
177 EXPORT_SYMBOL(delete_from_page_cache
);
179 static int sleep_on_page(void *word
)
185 static int sleep_on_page_killable(void *word
)
188 return fatal_signal_pending(current
) ? -EINTR
: 0;
191 static int filemap_check_errors(struct address_space
*mapping
)
194 /* Check for outstanding write errors */
195 if (test_and_clear_bit(AS_ENOSPC
, &mapping
->flags
))
197 if (test_and_clear_bit(AS_EIO
, &mapping
->flags
))
203 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
204 * @mapping: address space structure to write
205 * @start: offset in bytes where the range starts
206 * @end: offset in bytes where the range ends (inclusive)
207 * @sync_mode: enable synchronous operation
209 * Start writeback against all of a mapping's dirty pages that lie
210 * within the byte offsets <start, end> inclusive.
212 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
213 * opposed to a regular memory cleansing writeback. The difference between
214 * these two operations is that if a dirty page/buffer is encountered, it must
215 * be waited upon, and not just skipped over.
217 int __filemap_fdatawrite_range(struct address_space
*mapping
, loff_t start
,
218 loff_t end
, int sync_mode
)
221 struct writeback_control wbc
= {
222 .sync_mode
= sync_mode
,
223 .nr_to_write
= LONG_MAX
,
224 .range_start
= start
,
228 if (!mapping_cap_writeback_dirty(mapping
))
231 ret
= do_writepages(mapping
, &wbc
);
235 static inline int __filemap_fdatawrite(struct address_space
*mapping
,
238 return __filemap_fdatawrite_range(mapping
, 0, LLONG_MAX
, sync_mode
);
241 int filemap_fdatawrite(struct address_space
*mapping
)
243 return __filemap_fdatawrite(mapping
, WB_SYNC_ALL
);
245 EXPORT_SYMBOL(filemap_fdatawrite
);
247 int filemap_fdatawrite_range(struct address_space
*mapping
, loff_t start
,
250 return __filemap_fdatawrite_range(mapping
, start
, end
, WB_SYNC_ALL
);
252 EXPORT_SYMBOL(filemap_fdatawrite_range
);
255 * filemap_flush - mostly a non-blocking flush
256 * @mapping: target address_space
258 * This is a mostly non-blocking flush. Not suitable for data-integrity
259 * purposes - I/O may not be started against all dirty pages.
261 int filemap_flush(struct address_space
*mapping
)
263 return __filemap_fdatawrite(mapping
, WB_SYNC_NONE
);
265 EXPORT_SYMBOL(filemap_flush
);
268 * filemap_fdatawait_range - wait for writeback to complete
269 * @mapping: address space structure to wait for
270 * @start_byte: offset in bytes where the range starts
271 * @end_byte: offset in bytes where the range ends (inclusive)
273 * Walk the list of under-writeback pages of the given address space
274 * in the given range and wait for all of them.
276 int filemap_fdatawait_range(struct address_space
*mapping
, loff_t start_byte
,
279 pgoff_t index
= start_byte
>> PAGE_CACHE_SHIFT
;
280 pgoff_t end
= end_byte
>> PAGE_CACHE_SHIFT
;
285 if (end_byte
< start_byte
)
288 pagevec_init(&pvec
, 0);
289 while ((index
<= end
) &&
290 (nr_pages
= pagevec_lookup_tag(&pvec
, mapping
, &index
,
291 PAGECACHE_TAG_WRITEBACK
,
292 min(end
- index
, (pgoff_t
)PAGEVEC_SIZE
-1) + 1)) != 0) {
295 for (i
= 0; i
< nr_pages
; i
++) {
296 struct page
*page
= pvec
.pages
[i
];
298 /* until radix tree lookup accepts end_index */
299 if (page
->index
> end
)
302 wait_on_page_writeback(page
);
303 if (TestClearPageError(page
))
306 pagevec_release(&pvec
);
310 ret2
= filemap_check_errors(mapping
);
316 EXPORT_SYMBOL(filemap_fdatawait_range
);
319 * filemap_fdatawait - wait for all under-writeback pages to complete
320 * @mapping: address space structure to wait for
322 * Walk the list of under-writeback pages of the given address space
323 * and wait for all of them.
325 int filemap_fdatawait(struct address_space
*mapping
)
327 loff_t i_size
= i_size_read(mapping
->host
);
332 return filemap_fdatawait_range(mapping
, 0, i_size
- 1);
334 EXPORT_SYMBOL(filemap_fdatawait
);
336 int filemap_write_and_wait(struct address_space
*mapping
)
340 if (mapping
->nrpages
) {
341 err
= filemap_fdatawrite(mapping
);
343 * Even if the above returned error, the pages may be
344 * written partially (e.g. -ENOSPC), so we wait for it.
345 * But the -EIO is special case, it may indicate the worst
346 * thing (e.g. bug) happened, so we avoid waiting for it.
349 int err2
= filemap_fdatawait(mapping
);
354 err
= filemap_check_errors(mapping
);
358 EXPORT_SYMBOL(filemap_write_and_wait
);
361 * filemap_write_and_wait_range - write out & wait on a file range
362 * @mapping: the address_space for the pages
363 * @lstart: offset in bytes where the range starts
364 * @lend: offset in bytes where the range ends (inclusive)
366 * Write out and wait upon file offsets lstart->lend, inclusive.
368 * Note that `lend' is inclusive (describes the last byte to be written) so
369 * that this function can be used to write to the very end-of-file (end = -1).
371 int filemap_write_and_wait_range(struct address_space
*mapping
,
372 loff_t lstart
, loff_t lend
)
376 if (mapping
->nrpages
) {
377 err
= __filemap_fdatawrite_range(mapping
, lstart
, lend
,
379 /* See comment of filemap_write_and_wait() */
381 int err2
= filemap_fdatawait_range(mapping
,
387 err
= filemap_check_errors(mapping
);
391 EXPORT_SYMBOL(filemap_write_and_wait_range
);
394 * replace_page_cache_page - replace a pagecache page with a new one
395 * @old: page to be replaced
396 * @new: page to replace with
397 * @gfp_mask: allocation mode
399 * This function replaces a page in the pagecache with a new one. On
400 * success it acquires the pagecache reference for the new page and
401 * drops it for the old page. Both the old and new pages must be
402 * locked. This function does not add the new page to the LRU, the
403 * caller must do that.
405 * The remove + add is atomic. The only way this function can fail is
406 * memory allocation failure.
408 int replace_page_cache_page(struct page
*old
, struct page
*new, gfp_t gfp_mask
)
412 VM_BUG_ON_PAGE(!PageLocked(old
), old
);
413 VM_BUG_ON_PAGE(!PageLocked(new), new);
414 VM_BUG_ON_PAGE(new->mapping
, new);
416 error
= radix_tree_preload(gfp_mask
& ~__GFP_HIGHMEM
);
418 struct address_space
*mapping
= old
->mapping
;
419 void (*freepage
)(struct page
*);
421 pgoff_t offset
= old
->index
;
422 freepage
= mapping
->a_ops
->freepage
;
425 new->mapping
= mapping
;
428 spin_lock_irq(&mapping
->tree_lock
);
429 __delete_from_page_cache(old
);
430 error
= radix_tree_insert(&mapping
->page_tree
, offset
, new);
433 __inc_zone_page_state(new, NR_FILE_PAGES
);
434 if (PageSwapBacked(new))
435 __inc_zone_page_state(new, NR_SHMEM
);
436 spin_unlock_irq(&mapping
->tree_lock
);
437 /* mem_cgroup codes must not be called under tree_lock */
438 mem_cgroup_replace_page_cache(old
, new);
439 radix_tree_preload_end();
442 page_cache_release(old
);
447 EXPORT_SYMBOL_GPL(replace_page_cache_page
);
450 * add_to_page_cache_locked - add a locked page to the pagecache
452 * @mapping: the page's address_space
453 * @offset: page index
454 * @gfp_mask: page allocation mode
456 * This function is used to add a page to the pagecache. It must be locked.
457 * This function does not add the page to the LRU. The caller must do that.
459 int add_to_page_cache_locked(struct page
*page
, struct address_space
*mapping
,
460 pgoff_t offset
, gfp_t gfp_mask
)
464 VM_BUG_ON_PAGE(!PageLocked(page
), page
);
465 VM_BUG_ON_PAGE(PageSwapBacked(page
), page
);
467 error
= mem_cgroup_cache_charge(page
, current
->mm
,
468 gfp_mask
& GFP_RECLAIM_MASK
);
472 error
= radix_tree_maybe_preload(gfp_mask
& ~__GFP_HIGHMEM
);
474 mem_cgroup_uncharge_cache_page(page
);
478 page_cache_get(page
);
479 page
->mapping
= mapping
;
480 page
->index
= offset
;
482 spin_lock_irq(&mapping
->tree_lock
);
483 error
= radix_tree_insert(&mapping
->page_tree
, offset
, page
);
484 radix_tree_preload_end();
488 __inc_zone_page_state(page
, NR_FILE_PAGES
);
489 spin_unlock_irq(&mapping
->tree_lock
);
490 trace_mm_filemap_add_to_page_cache(page
);
493 page
->mapping
= NULL
;
494 /* Leave page->index set: truncation relies upon it */
495 spin_unlock_irq(&mapping
->tree_lock
);
496 mem_cgroup_uncharge_cache_page(page
);
497 page_cache_release(page
);
500 EXPORT_SYMBOL(add_to_page_cache_locked
);
502 int add_to_page_cache_lru(struct page
*page
, struct address_space
*mapping
,
503 pgoff_t offset
, gfp_t gfp_mask
)
507 ret
= add_to_page_cache(page
, mapping
, offset
, gfp_mask
);
509 lru_cache_add_file(page
);
512 EXPORT_SYMBOL_GPL(add_to_page_cache_lru
);
515 struct page
*__page_cache_alloc(gfp_t gfp
)
520 if (cpuset_do_page_mem_spread()) {
521 unsigned int cpuset_mems_cookie
;
523 cpuset_mems_cookie
= get_mems_allowed();
524 n
= cpuset_mem_spread_node();
525 page
= alloc_pages_exact_node(n
, gfp
, 0);
526 } while (!put_mems_allowed(cpuset_mems_cookie
) && !page
);
530 return alloc_pages(gfp
, 0);
532 EXPORT_SYMBOL(__page_cache_alloc
);
536 * In order to wait for pages to become available there must be
537 * waitqueues associated with pages. By using a hash table of
538 * waitqueues where the bucket discipline is to maintain all
539 * waiters on the same queue and wake all when any of the pages
540 * become available, and for the woken contexts to check to be
541 * sure the appropriate page became available, this saves space
542 * at a cost of "thundering herd" phenomena during rare hash
545 static wait_queue_head_t
*page_waitqueue(struct page
*page
)
547 const struct zone
*zone
= page_zone(page
);
549 return &zone
->wait_table
[hash_ptr(page
, zone
->wait_table_bits
)];
552 static inline void wake_up_page(struct page
*page
, int bit
)
554 __wake_up_bit(page_waitqueue(page
), &page
->flags
, bit
);
557 void wait_on_page_bit(struct page
*page
, int bit_nr
)
559 DEFINE_WAIT_BIT(wait
, &page
->flags
, bit_nr
);
561 if (test_bit(bit_nr
, &page
->flags
))
562 __wait_on_bit(page_waitqueue(page
), &wait
, sleep_on_page
,
563 TASK_UNINTERRUPTIBLE
);
565 EXPORT_SYMBOL(wait_on_page_bit
);
567 int wait_on_page_bit_killable(struct page
*page
, int bit_nr
)
569 DEFINE_WAIT_BIT(wait
, &page
->flags
, bit_nr
);
571 if (!test_bit(bit_nr
, &page
->flags
))
574 return __wait_on_bit(page_waitqueue(page
), &wait
,
575 sleep_on_page_killable
, TASK_KILLABLE
);
579 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
580 * @page: Page defining the wait queue of interest
581 * @waiter: Waiter to add to the queue
583 * Add an arbitrary @waiter to the wait queue for the nominated @page.
585 void add_page_wait_queue(struct page
*page
, wait_queue_t
*waiter
)
587 wait_queue_head_t
*q
= page_waitqueue(page
);
590 spin_lock_irqsave(&q
->lock
, flags
);
591 __add_wait_queue(q
, waiter
);
592 spin_unlock_irqrestore(&q
->lock
, flags
);
594 EXPORT_SYMBOL_GPL(add_page_wait_queue
);
597 * unlock_page - unlock a locked page
600 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
601 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
602 * mechananism between PageLocked pages and PageWriteback pages is shared.
603 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
605 * The mb is necessary to enforce ordering between the clear_bit and the read
606 * of the waitqueue (to avoid SMP races with a parallel wait_on_page_locked()).
608 void unlock_page(struct page
*page
)
610 VM_BUG_ON_PAGE(!PageLocked(page
), page
);
611 clear_bit_unlock(PG_locked
, &page
->flags
);
612 smp_mb__after_clear_bit();
613 wake_up_page(page
, PG_locked
);
615 EXPORT_SYMBOL(unlock_page
);
618 * end_page_writeback - end writeback against a page
621 void end_page_writeback(struct page
*page
)
623 if (TestClearPageReclaim(page
))
624 rotate_reclaimable_page(page
);
626 if (!test_clear_page_writeback(page
))
629 smp_mb__after_clear_bit();
630 wake_up_page(page
, PG_writeback
);
632 EXPORT_SYMBOL(end_page_writeback
);
635 * __lock_page - get a lock on the page, assuming we need to sleep to get it
636 * @page: the page to lock
638 void __lock_page(struct page
*page
)
640 DEFINE_WAIT_BIT(wait
, &page
->flags
, PG_locked
);
642 __wait_on_bit_lock(page_waitqueue(page
), &wait
, sleep_on_page
,
643 TASK_UNINTERRUPTIBLE
);
645 EXPORT_SYMBOL(__lock_page
);
647 int __lock_page_killable(struct page
*page
)
649 DEFINE_WAIT_BIT(wait
, &page
->flags
, PG_locked
);
651 return __wait_on_bit_lock(page_waitqueue(page
), &wait
,
652 sleep_on_page_killable
, TASK_KILLABLE
);
654 EXPORT_SYMBOL_GPL(__lock_page_killable
);
656 int __lock_page_or_retry(struct page
*page
, struct mm_struct
*mm
,
659 if (flags
& FAULT_FLAG_ALLOW_RETRY
) {
661 * CAUTION! In this case, mmap_sem is not released
662 * even though return 0.
664 if (flags
& FAULT_FLAG_RETRY_NOWAIT
)
667 up_read(&mm
->mmap_sem
);
668 if (flags
& FAULT_FLAG_KILLABLE
)
669 wait_on_page_locked_killable(page
);
671 wait_on_page_locked(page
);
674 if (flags
& FAULT_FLAG_KILLABLE
) {
677 ret
= __lock_page_killable(page
);
679 up_read(&mm
->mmap_sem
);
689 * find_get_page - find and get a page reference
690 * @mapping: the address_space to search
691 * @offset: the page index
693 * Is there a pagecache struct page at the given (mapping, offset) tuple?
694 * If yes, increment its refcount and return it; if no, return NULL.
696 struct page
*find_get_page(struct address_space
*mapping
, pgoff_t offset
)
704 pagep
= radix_tree_lookup_slot(&mapping
->page_tree
, offset
);
706 page
= radix_tree_deref_slot(pagep
);
709 if (radix_tree_exception(page
)) {
710 if (radix_tree_deref_retry(page
))
713 * Otherwise, shmem/tmpfs must be storing a swap entry
714 * here as an exceptional entry: so return it without
715 * attempting to raise page count.
719 if (!page_cache_get_speculative(page
))
723 * Has the page moved?
724 * This is part of the lockless pagecache protocol. See
725 * include/linux/pagemap.h for details.
727 if (unlikely(page
!= *pagep
)) {
728 page_cache_release(page
);
737 EXPORT_SYMBOL(find_get_page
);
740 * find_lock_page - locate, pin and lock a pagecache page
741 * @mapping: the address_space to search
742 * @offset: the page index
744 * Locates the desired pagecache page, locks it, increments its reference
745 * count and returns its address.
747 * Returns zero if the page was not present. find_lock_page() may sleep.
749 struct page
*find_lock_page(struct address_space
*mapping
, pgoff_t offset
)
754 page
= find_get_page(mapping
, offset
);
755 if (page
&& !radix_tree_exception(page
)) {
757 /* Has the page been truncated? */
758 if (unlikely(page
->mapping
!= mapping
)) {
760 page_cache_release(page
);
763 VM_BUG_ON_PAGE(page
->index
!= offset
, page
);
767 EXPORT_SYMBOL(find_lock_page
);
770 * find_or_create_page - locate or add a pagecache page
771 * @mapping: the page's address_space
772 * @index: the page's index into the mapping
773 * @gfp_mask: page allocation mode
775 * Locates a page in the pagecache. If the page is not present, a new page
776 * is allocated using @gfp_mask and is added to the pagecache and to the VM's
777 * LRU list. The returned page is locked and has its reference count
780 * find_or_create_page() may sleep, even if @gfp_flags specifies an atomic
783 * find_or_create_page() returns the desired page's address, or zero on
786 struct page
*find_or_create_page(struct address_space
*mapping
,
787 pgoff_t index
, gfp_t gfp_mask
)
792 page
= find_lock_page(mapping
, index
);
794 page
= __page_cache_alloc(gfp_mask
);
798 * We want a regular kernel memory (not highmem or DMA etc)
799 * allocation for the radix tree nodes, but we need to honour
800 * the context-specific requirements the caller has asked for.
801 * GFP_RECLAIM_MASK collects those requirements.
803 err
= add_to_page_cache_lru(page
, mapping
, index
,
804 (gfp_mask
& GFP_RECLAIM_MASK
));
806 page_cache_release(page
);
814 EXPORT_SYMBOL(find_or_create_page
);
817 * find_get_pages - gang pagecache lookup
818 * @mapping: The address_space to search
819 * @start: The starting page index
820 * @nr_pages: The maximum number of pages
821 * @pages: Where the resulting pages are placed
823 * find_get_pages() will search for and return a group of up to
824 * @nr_pages pages in the mapping. The pages are placed at @pages.
825 * find_get_pages() takes a reference against the returned pages.
827 * The search returns a group of mapping-contiguous pages with ascending
828 * indexes. There may be holes in the indices due to not-present pages.
830 * find_get_pages() returns the number of pages which were found.
832 unsigned find_get_pages(struct address_space
*mapping
, pgoff_t start
,
833 unsigned int nr_pages
, struct page
**pages
)
835 struct radix_tree_iter iter
;
839 if (unlikely(!nr_pages
))
844 radix_tree_for_each_slot(slot
, &mapping
->page_tree
, &iter
, start
) {
847 page
= radix_tree_deref_slot(slot
);
851 if (radix_tree_exception(page
)) {
852 if (radix_tree_deref_retry(page
)) {
854 * Transient condition which can only trigger
855 * when entry at index 0 moves out of or back
856 * to root: none yet gotten, safe to restart.
862 * Otherwise, shmem/tmpfs must be storing a swap entry
863 * here as an exceptional entry: so skip over it -
864 * we only reach this from invalidate_mapping_pages().
869 if (!page_cache_get_speculative(page
))
872 /* Has the page moved? */
873 if (unlikely(page
!= *slot
)) {
874 page_cache_release(page
);
879 if (++ret
== nr_pages
)
888 * find_get_pages_contig - gang contiguous pagecache lookup
889 * @mapping: The address_space to search
890 * @index: The starting page index
891 * @nr_pages: The maximum number of pages
892 * @pages: Where the resulting pages are placed
894 * find_get_pages_contig() works exactly like find_get_pages(), except
895 * that the returned number of pages are guaranteed to be contiguous.
897 * find_get_pages_contig() returns the number of pages which were found.
899 unsigned find_get_pages_contig(struct address_space
*mapping
, pgoff_t index
,
900 unsigned int nr_pages
, struct page
**pages
)
902 struct radix_tree_iter iter
;
904 unsigned int ret
= 0;
906 if (unlikely(!nr_pages
))
911 radix_tree_for_each_contig(slot
, &mapping
->page_tree
, &iter
, index
) {
914 page
= radix_tree_deref_slot(slot
);
915 /* The hole, there no reason to continue */
919 if (radix_tree_exception(page
)) {
920 if (radix_tree_deref_retry(page
)) {
922 * Transient condition which can only trigger
923 * when entry at index 0 moves out of or back
924 * to root: none yet gotten, safe to restart.
929 * Otherwise, shmem/tmpfs must be storing a swap entry
930 * here as an exceptional entry: so stop looking for
936 if (!page_cache_get_speculative(page
))
939 /* Has the page moved? */
940 if (unlikely(page
!= *slot
)) {
941 page_cache_release(page
);
946 * must check mapping and index after taking the ref.
947 * otherwise we can get both false positives and false
948 * negatives, which is just confusing to the caller.
950 if (page
->mapping
== NULL
|| page
->index
!= iter
.index
) {
951 page_cache_release(page
);
956 if (++ret
== nr_pages
)
962 EXPORT_SYMBOL(find_get_pages_contig
);
965 * find_get_pages_tag - find and return pages that match @tag
966 * @mapping: the address_space to search
967 * @index: the starting page index
968 * @tag: the tag index
969 * @nr_pages: the maximum number of pages
970 * @pages: where the resulting pages are placed
972 * Like find_get_pages, except we only return pages which are tagged with
973 * @tag. We update @index to index the next page for the traversal.
975 unsigned find_get_pages_tag(struct address_space
*mapping
, pgoff_t
*index
,
976 int tag
, unsigned int nr_pages
, struct page
**pages
)
978 struct radix_tree_iter iter
;
982 if (unlikely(!nr_pages
))
987 radix_tree_for_each_tagged(slot
, &mapping
->page_tree
,
988 &iter
, *index
, tag
) {
991 page
= radix_tree_deref_slot(slot
);
995 if (radix_tree_exception(page
)) {
996 if (radix_tree_deref_retry(page
)) {
998 * Transient condition which can only trigger
999 * when entry at index 0 moves out of or back
1000 * to root: none yet gotten, safe to restart.
1005 * This function is never used on a shmem/tmpfs
1006 * mapping, so a swap entry won't be found here.
1011 if (!page_cache_get_speculative(page
))
1014 /* Has the page moved? */
1015 if (unlikely(page
!= *slot
)) {
1016 page_cache_release(page
);
1021 if (++ret
== nr_pages
)
1028 *index
= pages
[ret
- 1]->index
+ 1;
1032 EXPORT_SYMBOL(find_get_pages_tag
);
1035 * grab_cache_page_nowait - returns locked page at given index in given cache
1036 * @mapping: target address_space
1037 * @index: the page index
1039 * Same as grab_cache_page(), but do not wait if the page is unavailable.
1040 * This is intended for speculative data generators, where the data can
1041 * be regenerated if the page couldn't be grabbed. This routine should
1042 * be safe to call while holding the lock for another page.
1044 * Clear __GFP_FS when allocating the page to avoid recursion into the fs
1045 * and deadlock against the caller's locked page.
1048 grab_cache_page_nowait(struct address_space
*mapping
, pgoff_t index
)
1050 struct page
*page
= find_get_page(mapping
, index
);
1053 if (trylock_page(page
))
1055 page_cache_release(page
);
1058 page
= __page_cache_alloc(mapping_gfp_mask(mapping
) & ~__GFP_FS
);
1059 if (page
&& add_to_page_cache_lru(page
, mapping
, index
, GFP_NOFS
)) {
1060 page_cache_release(page
);
1065 EXPORT_SYMBOL(grab_cache_page_nowait
);
1068 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1069 * a _large_ part of the i/o request. Imagine the worst scenario:
1071 * ---R__________________________________________B__________
1072 * ^ reading here ^ bad block(assume 4k)
1074 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1075 * => failing the whole request => read(R) => read(R+1) =>
1076 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1077 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1078 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1080 * It is going insane. Fix it by quickly scaling down the readahead size.
1082 static void shrink_readahead_size_eio(struct file
*filp
,
1083 struct file_ra_state
*ra
)
1089 * do_generic_file_read - generic file read routine
1090 * @filp: the file to read
1091 * @ppos: current file position
1092 * @desc: read_descriptor
1094 * This is a generic file read routine, and uses the
1095 * mapping->a_ops->readpage() function for the actual low-level stuff.
1097 * This is really ugly. But the goto's actually try to clarify some
1098 * of the logic when it comes to error handling etc.
1100 static void do_generic_file_read(struct file
*filp
, loff_t
*ppos
,
1101 read_descriptor_t
*desc
)
1103 struct address_space
*mapping
= filp
->f_mapping
;
1104 struct inode
*inode
= mapping
->host
;
1105 struct file_ra_state
*ra
= &filp
->f_ra
;
1109 unsigned long offset
; /* offset into pagecache page */
1110 unsigned int prev_offset
;
1113 index
= *ppos
>> PAGE_CACHE_SHIFT
;
1114 prev_index
= ra
->prev_pos
>> PAGE_CACHE_SHIFT
;
1115 prev_offset
= ra
->prev_pos
& (PAGE_CACHE_SIZE
-1);
1116 last_index
= (*ppos
+ desc
->count
+ PAGE_CACHE_SIZE
-1) >> PAGE_CACHE_SHIFT
;
1117 offset
= *ppos
& ~PAGE_CACHE_MASK
;
1123 unsigned long nr
, ret
;
1127 page
= find_get_page(mapping
, index
);
1129 page_cache_sync_readahead(mapping
,
1131 index
, last_index
- index
);
1132 page
= find_get_page(mapping
, index
);
1133 if (unlikely(page
== NULL
))
1134 goto no_cached_page
;
1136 if (PageReadahead(page
)) {
1137 page_cache_async_readahead(mapping
,
1139 index
, last_index
- index
);
1141 if (!PageUptodate(page
)) {
1142 if (inode
->i_blkbits
== PAGE_CACHE_SHIFT
||
1143 !mapping
->a_ops
->is_partially_uptodate
)
1144 goto page_not_up_to_date
;
1145 if (!trylock_page(page
))
1146 goto page_not_up_to_date
;
1147 /* Did it get truncated before we got the lock? */
1149 goto page_not_up_to_date_locked
;
1150 if (!mapping
->a_ops
->is_partially_uptodate(page
,
1152 goto page_not_up_to_date_locked
;
1157 * i_size must be checked after we know the page is Uptodate.
1159 * Checking i_size after the check allows us to calculate
1160 * the correct value for "nr", which means the zero-filled
1161 * part of the page is not copied back to userspace (unless
1162 * another truncate extends the file - this is desired though).
1165 isize
= i_size_read(inode
);
1166 end_index
= (isize
- 1) >> PAGE_CACHE_SHIFT
;
1167 if (unlikely(!isize
|| index
> end_index
)) {
1168 page_cache_release(page
);
1172 /* nr is the maximum number of bytes to copy from this page */
1173 nr
= PAGE_CACHE_SIZE
;
1174 if (index
== end_index
) {
1175 nr
= ((isize
- 1) & ~PAGE_CACHE_MASK
) + 1;
1177 page_cache_release(page
);
1183 /* If users can be writing to this page using arbitrary
1184 * virtual addresses, take care about potential aliasing
1185 * before reading the page on the kernel side.
1187 if (mapping_writably_mapped(mapping
))
1188 flush_dcache_page(page
);
1191 * When a sequential read accesses a page several times,
1192 * only mark it as accessed the first time.
1194 if (prev_index
!= index
|| offset
!= prev_offset
)
1195 mark_page_accessed(page
);
1199 * Ok, we have the page, and it's up-to-date, so
1200 * now we can copy it to user space...
1202 * The file_read_actor routine returns how many bytes were
1204 * NOTE! This may not be the same as how much of a user buffer
1205 * we filled up (we may be padding etc), so we can only update
1206 * "pos" here (the actor routine has to update the user buffer
1207 * pointers and the remaining count).
1209 ret
= file_read_actor(desc
, page
, offset
, nr
);
1211 index
+= offset
>> PAGE_CACHE_SHIFT
;
1212 offset
&= ~PAGE_CACHE_MASK
;
1213 prev_offset
= offset
;
1215 page_cache_release(page
);
1216 if (ret
== nr
&& desc
->count
)
1220 page_not_up_to_date
:
1221 /* Get exclusive access to the page ... */
1222 error
= lock_page_killable(page
);
1223 if (unlikely(error
))
1224 goto readpage_error
;
1226 page_not_up_to_date_locked
:
1227 /* Did it get truncated before we got the lock? */
1228 if (!page
->mapping
) {
1230 page_cache_release(page
);
1234 /* Did somebody else fill it already? */
1235 if (PageUptodate(page
)) {
1242 * A previous I/O error may have been due to temporary
1243 * failures, eg. multipath errors.
1244 * PG_error will be set again if readpage fails.
1246 ClearPageError(page
);
1247 /* Start the actual read. The read will unlock the page. */
1248 error
= mapping
->a_ops
->readpage(filp
, page
);
1250 if (unlikely(error
)) {
1251 if (error
== AOP_TRUNCATED_PAGE
) {
1252 page_cache_release(page
);
1255 goto readpage_error
;
1258 if (!PageUptodate(page
)) {
1259 error
= lock_page_killable(page
);
1260 if (unlikely(error
))
1261 goto readpage_error
;
1262 if (!PageUptodate(page
)) {
1263 if (page
->mapping
== NULL
) {
1265 * invalidate_mapping_pages got it
1268 page_cache_release(page
);
1272 shrink_readahead_size_eio(filp
, ra
);
1274 goto readpage_error
;
1282 /* UHHUH! A synchronous read error occurred. Report it */
1283 desc
->error
= error
;
1284 page_cache_release(page
);
1289 * Ok, it wasn't cached, so we need to create a new
1292 page
= page_cache_alloc_cold(mapping
);
1294 desc
->error
= -ENOMEM
;
1297 error
= add_to_page_cache_lru(page
, mapping
,
1300 page_cache_release(page
);
1301 if (error
== -EEXIST
)
1303 desc
->error
= error
;
1310 ra
->prev_pos
= prev_index
;
1311 ra
->prev_pos
<<= PAGE_CACHE_SHIFT
;
1312 ra
->prev_pos
|= prev_offset
;
1314 *ppos
= ((loff_t
)index
<< PAGE_CACHE_SHIFT
) + offset
;
1315 file_accessed(filp
);
1318 int file_read_actor(read_descriptor_t
*desc
, struct page
*page
,
1319 unsigned long offset
, unsigned long size
)
1322 unsigned long left
, count
= desc
->count
;
1328 * Faults on the destination of a read are common, so do it before
1331 if (!fault_in_pages_writeable(desc
->arg
.buf
, size
)) {
1332 kaddr
= kmap_atomic(page
);
1333 left
= __copy_to_user_inatomic(desc
->arg
.buf
,
1334 kaddr
+ offset
, size
);
1335 kunmap_atomic(kaddr
);
1340 /* Do it the slow way */
1342 left
= __copy_to_user(desc
->arg
.buf
, kaddr
+ offset
, size
);
1347 desc
->error
= -EFAULT
;
1350 desc
->count
= count
- size
;
1351 desc
->written
+= size
;
1352 desc
->arg
.buf
+= size
;
1357 * Performs necessary checks before doing a write
1358 * @iov: io vector request
1359 * @nr_segs: number of segments in the iovec
1360 * @count: number of bytes to write
1361 * @access_flags: type of access: %VERIFY_READ or %VERIFY_WRITE
1363 * Adjust number of segments and amount of bytes to write (nr_segs should be
1364 * properly initialized first). Returns appropriate error code that caller
1365 * should return or zero in case that write should be allowed.
1367 int generic_segment_checks(const struct iovec
*iov
,
1368 unsigned long *nr_segs
, size_t *count
, int access_flags
)
1372 for (seg
= 0; seg
< *nr_segs
; seg
++) {
1373 const struct iovec
*iv
= &iov
[seg
];
1376 * If any segment has a negative length, or the cumulative
1377 * length ever wraps negative then return -EINVAL.
1380 if (unlikely((ssize_t
)(cnt
|iv
->iov_len
) < 0))
1382 if (access_ok(access_flags
, iv
->iov_base
, iv
->iov_len
))
1387 cnt
-= iv
->iov_len
; /* This segment is no good */
1393 EXPORT_SYMBOL(generic_segment_checks
);
1396 * generic_file_aio_read - generic filesystem read routine
1397 * @iocb: kernel I/O control block
1398 * @iov: io vector request
1399 * @nr_segs: number of segments in the iovec
1400 * @pos: current file position
1402 * This is the "read()" routine for all filesystems
1403 * that can use the page cache directly.
1406 generic_file_aio_read(struct kiocb
*iocb
, const struct iovec
*iov
,
1407 unsigned long nr_segs
, loff_t pos
)
1409 struct file
*filp
= iocb
->ki_filp
;
1411 unsigned long seg
= 0;
1413 loff_t
*ppos
= &iocb
->ki_pos
;
1416 retval
= generic_segment_checks(iov
, &nr_segs
, &count
, VERIFY_WRITE
);
1420 /* coalesce the iovecs and go direct-to-BIO for O_DIRECT */
1421 if (filp
->f_flags
& O_DIRECT
) {
1423 struct address_space
*mapping
;
1424 struct inode
*inode
;
1426 mapping
= filp
->f_mapping
;
1427 inode
= mapping
->host
;
1429 goto out
; /* skip atime */
1430 size
= i_size_read(inode
);
1431 retval
= filemap_write_and_wait_range(mapping
, pos
,
1432 pos
+ iov_length(iov
, nr_segs
) - 1);
1434 retval
= mapping
->a_ops
->direct_IO(READ
, iocb
,
1438 *ppos
= pos
+ retval
;
1443 * Btrfs can have a short DIO read if we encounter
1444 * compressed extents, so if there was an error, or if
1445 * we've already read everything we wanted to, or if
1446 * there was a short read because we hit EOF, go ahead
1447 * and return. Otherwise fallthrough to buffered io for
1448 * the rest of the read.
1450 if (retval
< 0 || !count
|| *ppos
>= size
) {
1451 file_accessed(filp
);
1457 for (seg
= 0; seg
< nr_segs
; seg
++) {
1458 read_descriptor_t desc
;
1462 * If we did a short DIO read we need to skip the section of the
1463 * iov that we've already read data into.
1466 if (count
> iov
[seg
].iov_len
) {
1467 count
-= iov
[seg
].iov_len
;
1475 desc
.arg
.buf
= iov
[seg
].iov_base
+ offset
;
1476 desc
.count
= iov
[seg
].iov_len
- offset
;
1477 if (desc
.count
== 0)
1480 do_generic_file_read(filp
, ppos
, &desc
);
1481 retval
+= desc
.written
;
1483 retval
= retval
?: desc
.error
;
1492 EXPORT_SYMBOL(generic_file_aio_read
);
1496 * page_cache_read - adds requested page to the page cache if not already there
1497 * @file: file to read
1498 * @offset: page index
1500 * This adds the requested page to the page cache if it isn't already there,
1501 * and schedules an I/O to read in its contents from disk.
1503 static int page_cache_read(struct file
*file
, pgoff_t offset
)
1505 struct address_space
*mapping
= file
->f_mapping
;
1510 page
= page_cache_alloc_cold(mapping
);
1514 ret
= add_to_page_cache_lru(page
, mapping
, offset
, GFP_KERNEL
);
1516 ret
= mapping
->a_ops
->readpage(file
, page
);
1517 else if (ret
== -EEXIST
)
1518 ret
= 0; /* losing race to add is OK */
1520 page_cache_release(page
);
1522 } while (ret
== AOP_TRUNCATED_PAGE
);
1527 #define MMAP_LOTSAMISS (100)
1530 * Synchronous readahead happens when we don't even find
1531 * a page in the page cache at all.
1533 static void do_sync_mmap_readahead(struct vm_area_struct
*vma
,
1534 struct file_ra_state
*ra
,
1538 unsigned long ra_pages
;
1539 struct address_space
*mapping
= file
->f_mapping
;
1541 /* If we don't want any read-ahead, don't bother */
1542 if (vma
->vm_flags
& VM_RAND_READ
)
1547 if (vma
->vm_flags
& VM_SEQ_READ
) {
1548 page_cache_sync_readahead(mapping
, ra
, file
, offset
,
1553 /* Avoid banging the cache line if not needed */
1554 if (ra
->mmap_miss
< MMAP_LOTSAMISS
* 10)
1558 * Do we miss much more than hit in this file? If so,
1559 * stop bothering with read-ahead. It will only hurt.
1561 if (ra
->mmap_miss
> MMAP_LOTSAMISS
)
1567 ra_pages
= max_sane_readahead(ra
->ra_pages
);
1568 ra
->start
= max_t(long, 0, offset
- ra_pages
/ 2);
1569 ra
->size
= ra_pages
;
1570 ra
->async_size
= ra_pages
/ 4;
1571 ra_submit(ra
, mapping
, file
);
1575 * Asynchronous readahead happens when we find the page and PG_readahead,
1576 * so we want to possibly extend the readahead further..
1578 static void do_async_mmap_readahead(struct vm_area_struct
*vma
,
1579 struct file_ra_state
*ra
,
1584 struct address_space
*mapping
= file
->f_mapping
;
1586 /* If we don't want any read-ahead, don't bother */
1587 if (vma
->vm_flags
& VM_RAND_READ
)
1589 if (ra
->mmap_miss
> 0)
1591 if (PageReadahead(page
))
1592 page_cache_async_readahead(mapping
, ra
, file
,
1593 page
, offset
, ra
->ra_pages
);
1597 * filemap_fault - read in file data for page fault handling
1598 * @vma: vma in which the fault was taken
1599 * @vmf: struct vm_fault containing details of the fault
1601 * filemap_fault() is invoked via the vma operations vector for a
1602 * mapped memory region to read in file data during a page fault.
1604 * The goto's are kind of ugly, but this streamlines the normal case of having
1605 * it in the page cache, and handles the special cases reasonably without
1606 * having a lot of duplicated code.
1608 int filemap_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1611 struct file
*file
= vma
->vm_file
;
1612 struct address_space
*mapping
= file
->f_mapping
;
1613 struct file_ra_state
*ra
= &file
->f_ra
;
1614 struct inode
*inode
= mapping
->host
;
1615 pgoff_t offset
= vmf
->pgoff
;
1620 size
= (i_size_read(inode
) + PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
1622 return VM_FAULT_SIGBUS
;
1625 * Do we have something in the page cache already?
1627 page
= find_get_page(mapping
, offset
);
1628 if (likely(page
) && !(vmf
->flags
& FAULT_FLAG_TRIED
)) {
1630 * We found the page, so try async readahead before
1631 * waiting for the lock.
1633 do_async_mmap_readahead(vma
, ra
, file
, page
, offset
);
1635 /* No page in the page cache at all */
1636 do_sync_mmap_readahead(vma
, ra
, file
, offset
);
1637 count_vm_event(PGMAJFAULT
);
1638 mem_cgroup_count_vm_event(vma
->vm_mm
, PGMAJFAULT
);
1639 ret
= VM_FAULT_MAJOR
;
1641 page
= find_get_page(mapping
, offset
);
1643 goto no_cached_page
;
1646 if (!lock_page_or_retry(page
, vma
->vm_mm
, vmf
->flags
)) {
1647 page_cache_release(page
);
1648 return ret
| VM_FAULT_RETRY
;
1651 /* Did it get truncated? */
1652 if (unlikely(page
->mapping
!= mapping
)) {
1657 VM_BUG_ON_PAGE(page
->index
!= offset
, page
);
1660 * We have a locked page in the page cache, now we need to check
1661 * that it's up-to-date. If not, it is going to be due to an error.
1663 if (unlikely(!PageUptodate(page
)))
1664 goto page_not_uptodate
;
1667 * Found the page and have a reference on it.
1668 * We must recheck i_size under page lock.
1670 size
= (i_size_read(inode
) + PAGE_CACHE_SIZE
- 1) >> PAGE_CACHE_SHIFT
;
1671 if (unlikely(offset
>= size
)) {
1673 page_cache_release(page
);
1674 return VM_FAULT_SIGBUS
;
1678 return ret
| VM_FAULT_LOCKED
;
1682 * We're only likely to ever get here if MADV_RANDOM is in
1685 error
= page_cache_read(file
, offset
);
1688 * The page we want has now been added to the page cache.
1689 * In the unlikely event that someone removed it in the
1690 * meantime, we'll just come back here and read it again.
1696 * An error return from page_cache_read can result if the
1697 * system is low on memory, or a problem occurs while trying
1700 if (error
== -ENOMEM
)
1701 return VM_FAULT_OOM
;
1702 return VM_FAULT_SIGBUS
;
1706 * Umm, take care of errors if the page isn't up-to-date.
1707 * Try to re-read it _once_. We do this synchronously,
1708 * because there really aren't any performance issues here
1709 * and we need to check for errors.
1711 ClearPageError(page
);
1712 error
= mapping
->a_ops
->readpage(file
, page
);
1714 wait_on_page_locked(page
);
1715 if (!PageUptodate(page
))
1718 page_cache_release(page
);
1720 if (!error
|| error
== AOP_TRUNCATED_PAGE
)
1723 /* Things didn't work out. Return zero to tell the mm layer so. */
1724 shrink_readahead_size_eio(file
, ra
);
1725 return VM_FAULT_SIGBUS
;
1727 EXPORT_SYMBOL(filemap_fault
);
1729 int filemap_page_mkwrite(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
1731 struct page
*page
= vmf
->page
;
1732 struct inode
*inode
= file_inode(vma
->vm_file
);
1733 int ret
= VM_FAULT_LOCKED
;
1735 sb_start_pagefault(inode
->i_sb
);
1736 file_update_time(vma
->vm_file
);
1738 if (page
->mapping
!= inode
->i_mapping
) {
1740 ret
= VM_FAULT_NOPAGE
;
1744 * We mark the page dirty already here so that when freeze is in
1745 * progress, we are guaranteed that writeback during freezing will
1746 * see the dirty page and writeprotect it again.
1748 set_page_dirty(page
);
1749 wait_for_stable_page(page
);
1751 sb_end_pagefault(inode
->i_sb
);
1754 EXPORT_SYMBOL(filemap_page_mkwrite
);
1756 const struct vm_operations_struct generic_file_vm_ops
= {
1757 .fault
= filemap_fault
,
1758 .page_mkwrite
= filemap_page_mkwrite
,
1759 .remap_pages
= generic_file_remap_pages
,
1762 /* This is used for a general mmap of a disk file */
1764 int generic_file_mmap(struct file
* file
, struct vm_area_struct
* vma
)
1766 struct address_space
*mapping
= file
->f_mapping
;
1768 if (!mapping
->a_ops
->readpage
)
1770 file_accessed(file
);
1771 vma
->vm_ops
= &generic_file_vm_ops
;
1776 * This is for filesystems which do not implement ->writepage.
1778 int generic_file_readonly_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1780 if ((vma
->vm_flags
& VM_SHARED
) && (vma
->vm_flags
& VM_MAYWRITE
))
1782 return generic_file_mmap(file
, vma
);
1785 int generic_file_mmap(struct file
* file
, struct vm_area_struct
* vma
)
1789 int generic_file_readonly_mmap(struct file
* file
, struct vm_area_struct
* vma
)
1793 #endif /* CONFIG_MMU */
1795 EXPORT_SYMBOL(generic_file_mmap
);
1796 EXPORT_SYMBOL(generic_file_readonly_mmap
);
1798 static struct page
*__read_cache_page(struct address_space
*mapping
,
1800 int (*filler
)(void *, struct page
*),
1807 page
= find_get_page(mapping
, index
);
1809 page
= __page_cache_alloc(gfp
| __GFP_COLD
);
1811 return ERR_PTR(-ENOMEM
);
1812 err
= add_to_page_cache_lru(page
, mapping
, index
, gfp
);
1813 if (unlikely(err
)) {
1814 page_cache_release(page
);
1817 /* Presumably ENOMEM for radix tree node */
1818 return ERR_PTR(err
);
1820 err
= filler(data
, page
);
1822 page_cache_release(page
);
1823 page
= ERR_PTR(err
);
1829 static struct page
*do_read_cache_page(struct address_space
*mapping
,
1831 int (*filler
)(void *, struct page
*),
1840 page
= __read_cache_page(mapping
, index
, filler
, data
, gfp
);
1843 if (PageUptodate(page
))
1847 if (!page
->mapping
) {
1849 page_cache_release(page
);
1852 if (PageUptodate(page
)) {
1856 err
= filler(data
, page
);
1858 page_cache_release(page
);
1859 return ERR_PTR(err
);
1862 mark_page_accessed(page
);
1867 * read_cache_page_async - read into page cache, fill it if needed
1868 * @mapping: the page's address_space
1869 * @index: the page index
1870 * @filler: function to perform the read
1871 * @data: first arg to filler(data, page) function, often left as NULL
1873 * Same as read_cache_page, but don't wait for page to become unlocked
1874 * after submitting it to the filler.
1876 * Read into the page cache. If a page already exists, and PageUptodate() is
1877 * not set, try to fill the page but don't wait for it to become unlocked.
1879 * If the page does not get brought uptodate, return -EIO.
1881 struct page
*read_cache_page_async(struct address_space
*mapping
,
1883 int (*filler
)(void *, struct page
*),
1886 return do_read_cache_page(mapping
, index
, filler
, data
, mapping_gfp_mask(mapping
));
1888 EXPORT_SYMBOL(read_cache_page_async
);
1890 static struct page
*wait_on_page_read(struct page
*page
)
1892 if (!IS_ERR(page
)) {
1893 wait_on_page_locked(page
);
1894 if (!PageUptodate(page
)) {
1895 page_cache_release(page
);
1896 page
= ERR_PTR(-EIO
);
1903 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
1904 * @mapping: the page's address_space
1905 * @index: the page index
1906 * @gfp: the page allocator flags to use if allocating
1908 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
1909 * any new page allocations done using the specified allocation flags.
1911 * If the page does not get brought uptodate, return -EIO.
1913 struct page
*read_cache_page_gfp(struct address_space
*mapping
,
1917 filler_t
*filler
= (filler_t
*)mapping
->a_ops
->readpage
;
1919 return wait_on_page_read(do_read_cache_page(mapping
, index
, filler
, NULL
, gfp
));
1921 EXPORT_SYMBOL(read_cache_page_gfp
);
1924 * read_cache_page - read into page cache, fill it if needed
1925 * @mapping: the page's address_space
1926 * @index: the page index
1927 * @filler: function to perform the read
1928 * @data: first arg to filler(data, page) function, often left as NULL
1930 * Read into the page cache. If a page already exists, and PageUptodate() is
1931 * not set, try to fill the page then wait for it to become unlocked.
1933 * If the page does not get brought uptodate, return -EIO.
1935 struct page
*read_cache_page(struct address_space
*mapping
,
1937 int (*filler
)(void *, struct page
*),
1940 return wait_on_page_read(read_cache_page_async(mapping
, index
, filler
, data
));
1942 EXPORT_SYMBOL(read_cache_page
);
1944 static size_t __iovec_copy_from_user_inatomic(char *vaddr
,
1945 const struct iovec
*iov
, size_t base
, size_t bytes
)
1947 size_t copied
= 0, left
= 0;
1950 char __user
*buf
= iov
->iov_base
+ base
;
1951 int copy
= min(bytes
, iov
->iov_len
- base
);
1954 left
= __copy_from_user_inatomic(vaddr
, buf
, copy
);
1963 return copied
- left
;
1967 * Copy as much as we can into the page and return the number of bytes which
1968 * were successfully copied. If a fault is encountered then return the number of
1969 * bytes which were copied.
1971 size_t iov_iter_copy_from_user_atomic(struct page
*page
,
1972 struct iov_iter
*i
, unsigned long offset
, size_t bytes
)
1977 BUG_ON(!in_atomic());
1978 kaddr
= kmap_atomic(page
);
1979 if (likely(i
->nr_segs
== 1)) {
1981 char __user
*buf
= i
->iov
->iov_base
+ i
->iov_offset
;
1982 left
= __copy_from_user_inatomic(kaddr
+ offset
, buf
, bytes
);
1983 copied
= bytes
- left
;
1985 copied
= __iovec_copy_from_user_inatomic(kaddr
+ offset
,
1986 i
->iov
, i
->iov_offset
, bytes
);
1988 kunmap_atomic(kaddr
);
1992 EXPORT_SYMBOL(iov_iter_copy_from_user_atomic
);
1995 * This has the same sideeffects and return value as
1996 * iov_iter_copy_from_user_atomic().
1997 * The difference is that it attempts to resolve faults.
1998 * Page must not be locked.
2000 size_t iov_iter_copy_from_user(struct page
*page
,
2001 struct iov_iter
*i
, unsigned long offset
, size_t bytes
)
2007 if (likely(i
->nr_segs
== 1)) {
2009 char __user
*buf
= i
->iov
->iov_base
+ i
->iov_offset
;
2010 left
= __copy_from_user(kaddr
+ offset
, buf
, bytes
);
2011 copied
= bytes
- left
;
2013 copied
= __iovec_copy_from_user_inatomic(kaddr
+ offset
,
2014 i
->iov
, i
->iov_offset
, bytes
);
2019 EXPORT_SYMBOL(iov_iter_copy_from_user
);
2021 void iov_iter_advance(struct iov_iter
*i
, size_t bytes
)
2023 BUG_ON(i
->count
< bytes
);
2025 if (likely(i
->nr_segs
== 1)) {
2026 i
->iov_offset
+= bytes
;
2029 const struct iovec
*iov
= i
->iov
;
2030 size_t base
= i
->iov_offset
;
2031 unsigned long nr_segs
= i
->nr_segs
;
2034 * The !iov->iov_len check ensures we skip over unlikely
2035 * zero-length segments (without overruning the iovec).
2037 while (bytes
|| unlikely(i
->count
&& !iov
->iov_len
)) {
2040 copy
= min(bytes
, iov
->iov_len
- base
);
2041 BUG_ON(!i
->count
|| i
->count
< copy
);
2045 if (iov
->iov_len
== base
) {
2052 i
->iov_offset
= base
;
2053 i
->nr_segs
= nr_segs
;
2056 EXPORT_SYMBOL(iov_iter_advance
);
2059 * Fault in the first iovec of the given iov_iter, to a maximum length
2060 * of bytes. Returns 0 on success, or non-zero if the memory could not be
2061 * accessed (ie. because it is an invalid address).
2063 * writev-intensive code may want this to prefault several iovecs -- that
2064 * would be possible (callers must not rely on the fact that _only_ the
2065 * first iovec will be faulted with the current implementation).
2067 int iov_iter_fault_in_readable(struct iov_iter
*i
, size_t bytes
)
2069 char __user
*buf
= i
->iov
->iov_base
+ i
->iov_offset
;
2070 bytes
= min(bytes
, i
->iov
->iov_len
- i
->iov_offset
);
2071 return fault_in_pages_readable(buf
, bytes
);
2073 EXPORT_SYMBOL(iov_iter_fault_in_readable
);
2076 * Return the count of just the current iov_iter segment.
2078 size_t iov_iter_single_seg_count(const struct iov_iter
*i
)
2080 const struct iovec
*iov
= i
->iov
;
2081 if (i
->nr_segs
== 1)
2084 return min(i
->count
, iov
->iov_len
- i
->iov_offset
);
2086 EXPORT_SYMBOL(iov_iter_single_seg_count
);
2089 * Performs necessary checks before doing a write
2091 * Can adjust writing position or amount of bytes to write.
2092 * Returns appropriate error code that caller should return or
2093 * zero in case that write should be allowed.
2095 inline int generic_write_checks(struct file
*file
, loff_t
*pos
, size_t *count
, int isblk
)
2097 struct inode
*inode
= file
->f_mapping
->host
;
2098 unsigned long limit
= rlimit(RLIMIT_FSIZE
);
2100 if (unlikely(*pos
< 0))
2104 /* FIXME: this is for backwards compatibility with 2.4 */
2105 if (file
->f_flags
& O_APPEND
)
2106 *pos
= i_size_read(inode
);
2108 if (limit
!= RLIM_INFINITY
) {
2109 if (*pos
>= limit
) {
2110 send_sig(SIGXFSZ
, current
, 0);
2113 if (*count
> limit
- (typeof(limit
))*pos
) {
2114 *count
= limit
- (typeof(limit
))*pos
;
2122 if (unlikely(*pos
+ *count
> MAX_NON_LFS
&&
2123 !(file
->f_flags
& O_LARGEFILE
))) {
2124 if (*pos
>= MAX_NON_LFS
) {
2127 if (*count
> MAX_NON_LFS
- (unsigned long)*pos
) {
2128 *count
= MAX_NON_LFS
- (unsigned long)*pos
;
2133 * Are we about to exceed the fs block limit ?
2135 * If we have written data it becomes a short write. If we have
2136 * exceeded without writing data we send a signal and return EFBIG.
2137 * Linus frestrict idea will clean these up nicely..
2139 if (likely(!isblk
)) {
2140 if (unlikely(*pos
>= inode
->i_sb
->s_maxbytes
)) {
2141 if (*count
|| *pos
> inode
->i_sb
->s_maxbytes
) {
2144 /* zero-length writes at ->s_maxbytes are OK */
2147 if (unlikely(*pos
+ *count
> inode
->i_sb
->s_maxbytes
))
2148 *count
= inode
->i_sb
->s_maxbytes
- *pos
;
2152 if (bdev_read_only(I_BDEV(inode
)))
2154 isize
= i_size_read(inode
);
2155 if (*pos
>= isize
) {
2156 if (*count
|| *pos
> isize
)
2160 if (*pos
+ *count
> isize
)
2161 *count
= isize
- *pos
;
2168 EXPORT_SYMBOL(generic_write_checks
);
2170 int pagecache_write_begin(struct file
*file
, struct address_space
*mapping
,
2171 loff_t pos
, unsigned len
, unsigned flags
,
2172 struct page
**pagep
, void **fsdata
)
2174 const struct address_space_operations
*aops
= mapping
->a_ops
;
2176 return aops
->write_begin(file
, mapping
, pos
, len
, flags
,
2179 EXPORT_SYMBOL(pagecache_write_begin
);
2181 int pagecache_write_end(struct file
*file
, struct address_space
*mapping
,
2182 loff_t pos
, unsigned len
, unsigned copied
,
2183 struct page
*page
, void *fsdata
)
2185 const struct address_space_operations
*aops
= mapping
->a_ops
;
2187 mark_page_accessed(page
);
2188 return aops
->write_end(file
, mapping
, pos
, len
, copied
, page
, fsdata
);
2190 EXPORT_SYMBOL(pagecache_write_end
);
2193 generic_file_direct_write(struct kiocb
*iocb
, const struct iovec
*iov
,
2194 unsigned long *nr_segs
, loff_t pos
, loff_t
*ppos
,
2195 size_t count
, size_t ocount
)
2197 struct file
*file
= iocb
->ki_filp
;
2198 struct address_space
*mapping
= file
->f_mapping
;
2199 struct inode
*inode
= mapping
->host
;
2204 if (count
!= ocount
)
2205 *nr_segs
= iov_shorten((struct iovec
*)iov
, *nr_segs
, count
);
2207 write_len
= iov_length(iov
, *nr_segs
);
2208 end
= (pos
+ write_len
- 1) >> PAGE_CACHE_SHIFT
;
2210 written
= filemap_write_and_wait_range(mapping
, pos
, pos
+ write_len
- 1);
2215 * After a write we want buffered reads to be sure to go to disk to get
2216 * the new data. We invalidate clean cached page from the region we're
2217 * about to write. We do this *before* the write so that we can return
2218 * without clobbering -EIOCBQUEUED from ->direct_IO().
2220 if (mapping
->nrpages
) {
2221 written
= invalidate_inode_pages2_range(mapping
,
2222 pos
>> PAGE_CACHE_SHIFT
, end
);
2224 * If a page can not be invalidated, return 0 to fall back
2225 * to buffered write.
2228 if (written
== -EBUSY
)
2234 written
= mapping
->a_ops
->direct_IO(WRITE
, iocb
, iov
, pos
, *nr_segs
);
2237 * Finally, try again to invalidate clean pages which might have been
2238 * cached by non-direct readahead, or faulted in by get_user_pages()
2239 * if the source of the write was an mmap'ed region of the file
2240 * we're writing. Either one is a pretty crazy thing to do,
2241 * so we don't support it 100%. If this invalidation
2242 * fails, tough, the write still worked...
2244 if (mapping
->nrpages
) {
2245 invalidate_inode_pages2_range(mapping
,
2246 pos
>> PAGE_CACHE_SHIFT
, end
);
2251 if (pos
> i_size_read(inode
) && !S_ISBLK(inode
->i_mode
)) {
2252 i_size_write(inode
, pos
);
2253 mark_inode_dirty(inode
);
2260 EXPORT_SYMBOL(generic_file_direct_write
);
2263 * Find or create a page at the given pagecache position. Return the locked
2264 * page. This function is specifically for buffered writes.
2266 struct page
*grab_cache_page_write_begin(struct address_space
*mapping
,
2267 pgoff_t index
, unsigned flags
)
2272 gfp_t gfp_notmask
= 0;
2274 gfp_mask
= mapping_gfp_mask(mapping
);
2275 if (mapping_cap_account_dirty(mapping
))
2276 gfp_mask
|= __GFP_WRITE
;
2277 if (flags
& AOP_FLAG_NOFS
)
2278 gfp_notmask
= __GFP_FS
;
2280 page
= find_lock_page(mapping
, index
);
2284 page
= __page_cache_alloc(gfp_mask
& ~gfp_notmask
);
2287 status
= add_to_page_cache_lru(page
, mapping
, index
,
2288 GFP_KERNEL
& ~gfp_notmask
);
2289 if (unlikely(status
)) {
2290 page_cache_release(page
);
2291 if (status
== -EEXIST
)
2296 wait_for_stable_page(page
);
2299 EXPORT_SYMBOL(grab_cache_page_write_begin
);
2301 static ssize_t
generic_perform_write(struct file
*file
,
2302 struct iov_iter
*i
, loff_t pos
)
2304 struct address_space
*mapping
= file
->f_mapping
;
2305 const struct address_space_operations
*a_ops
= mapping
->a_ops
;
2307 ssize_t written
= 0;
2308 unsigned int flags
= 0;
2311 * Copies from kernel address space cannot fail (NFSD is a big user).
2313 if (segment_eq(get_fs(), KERNEL_DS
))
2314 flags
|= AOP_FLAG_UNINTERRUPTIBLE
;
2318 unsigned long offset
; /* Offset into pagecache page */
2319 unsigned long bytes
; /* Bytes to write to page */
2320 size_t copied
; /* Bytes copied from user */
2323 offset
= (pos
& (PAGE_CACHE_SIZE
- 1));
2324 bytes
= min_t(unsigned long, PAGE_CACHE_SIZE
- offset
,
2329 * Bring in the user page that we will copy from _first_.
2330 * Otherwise there's a nasty deadlock on copying from the
2331 * same page as we're writing to, without it being marked
2334 * Not only is this an optimisation, but it is also required
2335 * to check that the address is actually valid, when atomic
2336 * usercopies are used, below.
2338 if (unlikely(iov_iter_fault_in_readable(i
, bytes
))) {
2343 status
= a_ops
->write_begin(file
, mapping
, pos
, bytes
, flags
,
2345 if (unlikely(status
))
2348 if (mapping_writably_mapped(mapping
))
2349 flush_dcache_page(page
);
2351 pagefault_disable();
2352 copied
= iov_iter_copy_from_user_atomic(page
, i
, offset
, bytes
);
2354 flush_dcache_page(page
);
2356 mark_page_accessed(page
);
2357 status
= a_ops
->write_end(file
, mapping
, pos
, bytes
, copied
,
2359 if (unlikely(status
< 0))
2365 iov_iter_advance(i
, copied
);
2366 if (unlikely(copied
== 0)) {
2368 * If we were unable to copy any data at all, we must
2369 * fall back to a single segment length write.
2371 * If we didn't fallback here, we could livelock
2372 * because not all segments in the iov can be copied at
2373 * once without a pagefault.
2375 bytes
= min_t(unsigned long, PAGE_CACHE_SIZE
- offset
,
2376 iov_iter_single_seg_count(i
));
2382 balance_dirty_pages_ratelimited(mapping
);
2383 if (fatal_signal_pending(current
)) {
2387 } while (iov_iter_count(i
));
2389 return written
? written
: status
;
2393 generic_file_buffered_write(struct kiocb
*iocb
, const struct iovec
*iov
,
2394 unsigned long nr_segs
, loff_t pos
, loff_t
*ppos
,
2395 size_t count
, ssize_t written
)
2397 struct file
*file
= iocb
->ki_filp
;
2401 iov_iter_init(&i
, iov
, nr_segs
, count
, written
);
2402 status
= generic_perform_write(file
, &i
, pos
);
2404 if (likely(status
>= 0)) {
2406 *ppos
= pos
+ status
;
2409 return written
? written
: status
;
2411 EXPORT_SYMBOL(generic_file_buffered_write
);
2414 * __generic_file_aio_write - write data to a file
2415 * @iocb: IO state structure (file, offset, etc.)
2416 * @iov: vector with data to write
2417 * @nr_segs: number of segments in the vector
2418 * @ppos: position where to write
2420 * This function does all the work needed for actually writing data to a
2421 * file. It does all basic checks, removes SUID from the file, updates
2422 * modification times and calls proper subroutines depending on whether we
2423 * do direct IO or a standard buffered write.
2425 * It expects i_mutex to be grabbed unless we work on a block device or similar
2426 * object which does not need locking at all.
2428 * This function does *not* take care of syncing data in case of O_SYNC write.
2429 * A caller has to handle it. This is mainly due to the fact that we want to
2430 * avoid syncing under i_mutex.
2432 ssize_t
__generic_file_aio_write(struct kiocb
*iocb
, const struct iovec
*iov
,
2433 unsigned long nr_segs
, loff_t
*ppos
)
2435 struct file
*file
= iocb
->ki_filp
;
2436 struct address_space
* mapping
= file
->f_mapping
;
2437 size_t ocount
; /* original count */
2438 size_t count
; /* after file limit checks */
2439 struct inode
*inode
= mapping
->host
;
2445 err
= generic_segment_checks(iov
, &nr_segs
, &ocount
, VERIFY_READ
);
2452 /* We can write back this queue in page reclaim */
2453 current
->backing_dev_info
= mapping
->backing_dev_info
;
2456 err
= generic_write_checks(file
, &pos
, &count
, S_ISBLK(inode
->i_mode
));
2463 err
= file_remove_suid(file
);
2467 err
= file_update_time(file
);
2471 /* coalesce the iovecs and go direct-to-BIO for O_DIRECT */
2472 if (unlikely(file
->f_flags
& O_DIRECT
)) {
2474 ssize_t written_buffered
;
2476 written
= generic_file_direct_write(iocb
, iov
, &nr_segs
, pos
,
2477 ppos
, count
, ocount
);
2478 if (written
< 0 || written
== count
)
2481 * direct-io write to a hole: fall through to buffered I/O
2482 * for completing the rest of the request.
2486 written_buffered
= generic_file_buffered_write(iocb
, iov
,
2487 nr_segs
, pos
, ppos
, count
,
2490 * If generic_file_buffered_write() retuned a synchronous error
2491 * then we want to return the number of bytes which were
2492 * direct-written, or the error code if that was zero. Note
2493 * that this differs from normal direct-io semantics, which
2494 * will return -EFOO even if some bytes were written.
2496 if (written_buffered
< 0) {
2497 err
= written_buffered
;
2502 * We need to ensure that the page cache pages are written to
2503 * disk and invalidated to preserve the expected O_DIRECT
2506 endbyte
= pos
+ written_buffered
- written
- 1;
2507 err
= filemap_write_and_wait_range(file
->f_mapping
, pos
, endbyte
);
2509 written
= written_buffered
;
2510 invalidate_mapping_pages(mapping
,
2511 pos
>> PAGE_CACHE_SHIFT
,
2512 endbyte
>> PAGE_CACHE_SHIFT
);
2515 * We don't know how much we wrote, so just return
2516 * the number of bytes which were direct-written
2520 written
= generic_file_buffered_write(iocb
, iov
, nr_segs
,
2521 pos
, ppos
, count
, written
);
2524 current
->backing_dev_info
= NULL
;
2525 return written
? written
: err
;
2527 EXPORT_SYMBOL(__generic_file_aio_write
);
2530 * generic_file_aio_write - write data to a file
2531 * @iocb: IO state structure
2532 * @iov: vector with data to write
2533 * @nr_segs: number of segments in the vector
2534 * @pos: position in file where to write
2536 * This is a wrapper around __generic_file_aio_write() to be used by most
2537 * filesystems. It takes care of syncing the file in case of O_SYNC file
2538 * and acquires i_mutex as needed.
2540 ssize_t
generic_file_aio_write(struct kiocb
*iocb
, const struct iovec
*iov
,
2541 unsigned long nr_segs
, loff_t pos
)
2543 struct file
*file
= iocb
->ki_filp
;
2544 struct inode
*inode
= file
->f_mapping
->host
;
2547 BUG_ON(iocb
->ki_pos
!= pos
);
2549 mutex_lock(&inode
->i_mutex
);
2550 ret
= __generic_file_aio_write(iocb
, iov
, nr_segs
, &iocb
->ki_pos
);
2551 mutex_unlock(&inode
->i_mutex
);
2556 err
= generic_write_sync(file
, iocb
->ki_pos
- ret
, ret
);
2562 EXPORT_SYMBOL(generic_file_aio_write
);
2565 * try_to_release_page() - release old fs-specific metadata on a page
2567 * @page: the page which the kernel is trying to free
2568 * @gfp_mask: memory allocation flags (and I/O mode)
2570 * The address_space is to try to release any data against the page
2571 * (presumably at page->private). If the release was successful, return `1'.
2572 * Otherwise return zero.
2574 * This may also be called if PG_fscache is set on a page, indicating that the
2575 * page is known to the local caching routines.
2577 * The @gfp_mask argument specifies whether I/O may be performed to release
2578 * this page (__GFP_IO), and whether the call may block (__GFP_WAIT & __GFP_FS).
2581 int try_to_release_page(struct page
*page
, gfp_t gfp_mask
)
2583 struct address_space
* const mapping
= page
->mapping
;
2585 BUG_ON(!PageLocked(page
));
2586 if (PageWriteback(page
))
2589 if (mapping
&& mapping
->a_ops
->releasepage
)
2590 return mapping
->a_ops
->releasepage(page
, gfp_mask
);
2591 return try_to_free_buffers(page
);
2594 EXPORT_SYMBOL(try_to_release_page
);