ACPI: thinkpad-acpi: trivial fix to documentation
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / mm / filemap.c
blob14ca63f772ff8ea98097afed63c6c1e0570c784a
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/module.h>
13 #include <linux/slab.h>
14 #include <linux/compiler.h>
15 #include <linux/fs.h>
16 #include <linux/uaccess.h>
17 #include <linux/aio.h>
18 #include <linux/capability.h>
19 #include <linux/kernel_stat.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/pagevec.h>
29 #include <linux/blkdev.h>
30 #include <linux/security.h>
31 #include <linux/syscalls.h>
32 #include <linux/cpuset.h>
33 #include "filemap.h"
34 #include "internal.h"
37 * FIXME: remove all knowledge of the buffer layer from the core VM
39 #include <linux/buffer_head.h> /* for generic_osync_inode */
41 #include <asm/mman.h>
43 static ssize_t
44 generic_file_direct_IO(int rw, struct kiocb *iocb, const struct iovec *iov,
45 loff_t offset, unsigned long nr_segs);
48 * Shared mappings implemented 30.11.1994. It's not fully working yet,
49 * though.
51 * Shared mappings now work. 15.8.1995 Bruno.
53 * finished 'unifying' the page and buffer cache and SMP-threaded the
54 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
56 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
60 * Lock ordering:
62 * ->i_mmap_lock (vmtruncate)
63 * ->private_lock (__free_pte->__set_page_dirty_buffers)
64 * ->swap_lock (exclusive_swap_page, others)
65 * ->mapping->tree_lock
67 * ->i_mutex
68 * ->i_mmap_lock (truncate->unmap_mapping_range)
70 * ->mmap_sem
71 * ->i_mmap_lock
72 * ->page_table_lock or pte_lock (various, mainly in memory.c)
73 * ->mapping->tree_lock (arch-dependent flush_dcache_mmap_lock)
75 * ->mmap_sem
76 * ->lock_page (access_process_vm)
78 * ->i_mutex (generic_file_buffered_write)
79 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
81 * ->i_mutex
82 * ->i_alloc_sem (various)
84 * ->inode_lock
85 * ->sb_lock (fs/fs-writeback.c)
86 * ->mapping->tree_lock (__sync_single_inode)
88 * ->i_mmap_lock
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 (follow_page->mark_page_accessed)
99 * ->zone.lru_lock (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 * ->inode_lock (page_remove_rmap->set_page_dirty)
103 * ->inode_lock (zap_pte_range->set_page_dirty)
104 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
106 * ->task->proc_lock
107 * ->dcache_lock (proc_pid_lookup)
111 * Remove 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 a write_lock on the mapping's tree_lock.
115 void __remove_from_page_cache(struct page *page)
117 struct address_space *mapping = page->mapping;
119 radix_tree_delete(&mapping->page_tree, page->index);
120 page->mapping = NULL;
121 mapping->nrpages--;
122 __dec_zone_page_state(page, NR_FILE_PAGES);
123 BUG_ON(page_mapped(page));
126 void remove_from_page_cache(struct page *page)
128 struct address_space *mapping = page->mapping;
130 BUG_ON(!PageLocked(page));
132 write_lock_irq(&mapping->tree_lock);
133 __remove_from_page_cache(page);
134 write_unlock_irq(&mapping->tree_lock);
137 static int sync_page(void *word)
139 struct address_space *mapping;
140 struct page *page;
142 page = container_of((unsigned long *)word, struct page, flags);
145 * page_mapping() is being called without PG_locked held.
146 * Some knowledge of the state and use of the page is used to
147 * reduce the requirements down to a memory barrier.
148 * The danger here is of a stale page_mapping() return value
149 * indicating a struct address_space different from the one it's
150 * associated with when it is associated with one.
151 * After smp_mb(), it's either the correct page_mapping() for
152 * the page, or an old page_mapping() and the page's own
153 * page_mapping() has gone NULL.
154 * The ->sync_page() address_space operation must tolerate
155 * page_mapping() going NULL. By an amazing coincidence,
156 * this comes about because none of the users of the page
157 * in the ->sync_page() methods make essential use of the
158 * page_mapping(), merely passing the page down to the backing
159 * device's unplug functions when it's non-NULL, which in turn
160 * ignore it for all cases but swap, where only page_private(page) is
161 * of interest. When page_mapping() does go NULL, the entire
162 * call stack gracefully ignores the page and returns.
163 * -- wli
165 smp_mb();
166 mapping = page_mapping(page);
167 if (mapping && mapping->a_ops && mapping->a_ops->sync_page)
168 mapping->a_ops->sync_page(page);
169 io_schedule();
170 return 0;
174 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
175 * @mapping: address space structure to write
176 * @start: offset in bytes where the range starts
177 * @end: offset in bytes where the range ends (inclusive)
178 * @sync_mode: enable synchronous operation
180 * Start writeback against all of a mapping's dirty pages that lie
181 * within the byte offsets <start, end> inclusive.
183 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
184 * opposed to a regular memory cleansing writeback. The difference between
185 * these two operations is that if a dirty page/buffer is encountered, it must
186 * be waited upon, and not just skipped over.
188 int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
189 loff_t end, int sync_mode)
191 int ret;
192 struct writeback_control wbc = {
193 .sync_mode = sync_mode,
194 .nr_to_write = mapping->nrpages * 2,
195 .range_start = start,
196 .range_end = end,
199 if (!mapping_cap_writeback_dirty(mapping))
200 return 0;
202 ret = do_writepages(mapping, &wbc);
203 return ret;
206 static inline int __filemap_fdatawrite(struct address_space *mapping,
207 int sync_mode)
209 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
212 int filemap_fdatawrite(struct address_space *mapping)
214 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
216 EXPORT_SYMBOL(filemap_fdatawrite);
218 static int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
219 loff_t end)
221 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
225 * filemap_flush - mostly a non-blocking flush
226 * @mapping: target address_space
228 * This is a mostly non-blocking flush. Not suitable for data-integrity
229 * purposes - I/O may not be started against all dirty pages.
231 int filemap_flush(struct address_space *mapping)
233 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
235 EXPORT_SYMBOL(filemap_flush);
238 * wait_on_page_writeback_range - wait for writeback to complete
239 * @mapping: target address_space
240 * @start: beginning page index
241 * @end: ending page index
243 * Wait for writeback to complete against pages indexed by start->end
244 * inclusive
246 int wait_on_page_writeback_range(struct address_space *mapping,
247 pgoff_t start, pgoff_t end)
249 struct pagevec pvec;
250 int nr_pages;
251 int ret = 0;
252 pgoff_t index;
254 if (end < start)
255 return 0;
257 pagevec_init(&pvec, 0);
258 index = start;
259 while ((index <= end) &&
260 (nr_pages = pagevec_lookup_tag(&pvec, mapping, &index,
261 PAGECACHE_TAG_WRITEBACK,
262 min(end - index, (pgoff_t)PAGEVEC_SIZE-1) + 1)) != 0) {
263 unsigned i;
265 for (i = 0; i < nr_pages; i++) {
266 struct page *page = pvec.pages[i];
268 /* until radix tree lookup accepts end_index */
269 if (page->index > end)
270 continue;
272 wait_on_page_writeback(page);
273 if (PageError(page))
274 ret = -EIO;
276 pagevec_release(&pvec);
277 cond_resched();
280 /* Check for outstanding write errors */
281 if (test_and_clear_bit(AS_ENOSPC, &mapping->flags))
282 ret = -ENOSPC;
283 if (test_and_clear_bit(AS_EIO, &mapping->flags))
284 ret = -EIO;
286 return ret;
290 * sync_page_range - write and wait on all pages in the passed range
291 * @inode: target inode
292 * @mapping: target address_space
293 * @pos: beginning offset in pages to write
294 * @count: number of bytes to write
296 * Write and wait upon all the pages in the passed range. This is a "data
297 * integrity" operation. It waits upon in-flight writeout before starting and
298 * waiting upon new writeout. If there was an IO error, return it.
300 * We need to re-take i_mutex during the generic_osync_inode list walk because
301 * it is otherwise livelockable.
303 int sync_page_range(struct inode *inode, struct address_space *mapping,
304 loff_t pos, loff_t count)
306 pgoff_t start = pos >> PAGE_CACHE_SHIFT;
307 pgoff_t end = (pos + count - 1) >> PAGE_CACHE_SHIFT;
308 int ret;
310 if (!mapping_cap_writeback_dirty(mapping) || !count)
311 return 0;
312 ret = filemap_fdatawrite_range(mapping, pos, pos + count - 1);
313 if (ret == 0) {
314 mutex_lock(&inode->i_mutex);
315 ret = generic_osync_inode(inode, mapping, OSYNC_METADATA);
316 mutex_unlock(&inode->i_mutex);
318 if (ret == 0)
319 ret = wait_on_page_writeback_range(mapping, start, end);
320 return ret;
322 EXPORT_SYMBOL(sync_page_range);
325 * sync_page_range_nolock
326 * @inode: target inode
327 * @mapping: target address_space
328 * @pos: beginning offset in pages to write
329 * @count: number of bytes to write
331 * Note: Holding i_mutex across sync_page_range_nolock() is not a good idea
332 * as it forces O_SYNC writers to different parts of the same file
333 * to be serialised right until io completion.
335 int sync_page_range_nolock(struct inode *inode, struct address_space *mapping,
336 loff_t pos, loff_t count)
338 pgoff_t start = pos >> PAGE_CACHE_SHIFT;
339 pgoff_t end = (pos + count - 1) >> PAGE_CACHE_SHIFT;
340 int ret;
342 if (!mapping_cap_writeback_dirty(mapping) || !count)
343 return 0;
344 ret = filemap_fdatawrite_range(mapping, pos, pos + count - 1);
345 if (ret == 0)
346 ret = generic_osync_inode(inode, mapping, OSYNC_METADATA);
347 if (ret == 0)
348 ret = wait_on_page_writeback_range(mapping, start, end);
349 return ret;
351 EXPORT_SYMBOL(sync_page_range_nolock);
354 * filemap_fdatawait - wait for all under-writeback pages to complete
355 * @mapping: address space structure to wait for
357 * Walk the list of under-writeback pages of the given address space
358 * and wait for all of them.
360 int filemap_fdatawait(struct address_space *mapping)
362 loff_t i_size = i_size_read(mapping->host);
364 if (i_size == 0)
365 return 0;
367 return wait_on_page_writeback_range(mapping, 0,
368 (i_size - 1) >> PAGE_CACHE_SHIFT);
370 EXPORT_SYMBOL(filemap_fdatawait);
372 int filemap_write_and_wait(struct address_space *mapping)
374 int err = 0;
376 if (mapping->nrpages) {
377 err = filemap_fdatawrite(mapping);
379 * Even if the above returned error, the pages may be
380 * written partially (e.g. -ENOSPC), so we wait for it.
381 * But the -EIO is special case, it may indicate the worst
382 * thing (e.g. bug) happened, so we avoid waiting for it.
384 if (err != -EIO) {
385 int err2 = filemap_fdatawait(mapping);
386 if (!err)
387 err = err2;
390 return err;
392 EXPORT_SYMBOL(filemap_write_and_wait);
395 * filemap_write_and_wait_range - write out & wait on a file range
396 * @mapping: the address_space for the pages
397 * @lstart: offset in bytes where the range starts
398 * @lend: offset in bytes where the range ends (inclusive)
400 * Write out and wait upon file offsets lstart->lend, inclusive.
402 * Note that `lend' is inclusive (describes the last byte to be written) so
403 * that this function can be used to write to the very end-of-file (end = -1).
405 int filemap_write_and_wait_range(struct address_space *mapping,
406 loff_t lstart, loff_t lend)
408 int err = 0;
410 if (mapping->nrpages) {
411 err = __filemap_fdatawrite_range(mapping, lstart, lend,
412 WB_SYNC_ALL);
413 /* See comment of filemap_write_and_wait() */
414 if (err != -EIO) {
415 int err2 = wait_on_page_writeback_range(mapping,
416 lstart >> PAGE_CACHE_SHIFT,
417 lend >> PAGE_CACHE_SHIFT);
418 if (!err)
419 err = err2;
422 return err;
426 * add_to_page_cache - add newly allocated pagecache pages
427 * @page: page to add
428 * @mapping: the page's address_space
429 * @offset: page index
430 * @gfp_mask: page allocation mode
432 * This function is used to add newly allocated pagecache pages;
433 * the page is new, so we can just run SetPageLocked() against it.
434 * The other page state flags were set by rmqueue().
436 * This function does not add the page to the LRU. The caller must do that.
438 int add_to_page_cache(struct page *page, struct address_space *mapping,
439 pgoff_t offset, gfp_t gfp_mask)
441 int error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
443 if (error == 0) {
444 write_lock_irq(&mapping->tree_lock);
445 error = radix_tree_insert(&mapping->page_tree, offset, page);
446 if (!error) {
447 page_cache_get(page);
448 SetPageLocked(page);
449 page->mapping = mapping;
450 page->index = offset;
451 mapping->nrpages++;
452 __inc_zone_page_state(page, NR_FILE_PAGES);
454 write_unlock_irq(&mapping->tree_lock);
455 radix_tree_preload_end();
457 return error;
459 EXPORT_SYMBOL(add_to_page_cache);
461 int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
462 pgoff_t offset, gfp_t gfp_mask)
464 int ret = add_to_page_cache(page, mapping, offset, gfp_mask);
465 if (ret == 0)
466 lru_cache_add(page);
467 return ret;
470 #ifdef CONFIG_NUMA
471 struct page *__page_cache_alloc(gfp_t gfp)
473 if (cpuset_do_page_mem_spread()) {
474 int n = cpuset_mem_spread_node();
475 return alloc_pages_node(n, gfp, 0);
477 return alloc_pages(gfp, 0);
479 EXPORT_SYMBOL(__page_cache_alloc);
480 #endif
482 static int __sleep_on_page_lock(void *word)
484 io_schedule();
485 return 0;
489 * In order to wait for pages to become available there must be
490 * waitqueues associated with pages. By using a hash table of
491 * waitqueues where the bucket discipline is to maintain all
492 * waiters on the same queue and wake all when any of the pages
493 * become available, and for the woken contexts to check to be
494 * sure the appropriate page became available, this saves space
495 * at a cost of "thundering herd" phenomena during rare hash
496 * collisions.
498 static wait_queue_head_t *page_waitqueue(struct page *page)
500 const struct zone *zone = page_zone(page);
502 return &zone->wait_table[hash_ptr(page, zone->wait_table_bits)];
505 static inline void wake_up_page(struct page *page, int bit)
507 __wake_up_bit(page_waitqueue(page), &page->flags, bit);
510 void fastcall wait_on_page_bit(struct page *page, int bit_nr)
512 DEFINE_WAIT_BIT(wait, &page->flags, bit_nr);
514 if (test_bit(bit_nr, &page->flags))
515 __wait_on_bit(page_waitqueue(page), &wait, sync_page,
516 TASK_UNINTERRUPTIBLE);
518 EXPORT_SYMBOL(wait_on_page_bit);
521 * unlock_page - unlock a locked page
522 * @page: the page
524 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
525 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
526 * mechananism between PageLocked pages and PageWriteback pages is shared.
527 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
529 * The first mb is necessary to safely close the critical section opened by the
530 * TestSetPageLocked(), the second mb is necessary to enforce ordering between
531 * the clear_bit and the read of the waitqueue (to avoid SMP races with a
532 * parallel wait_on_page_locked()).
534 void fastcall unlock_page(struct page *page)
536 smp_mb__before_clear_bit();
537 if (!TestClearPageLocked(page))
538 BUG();
539 smp_mb__after_clear_bit();
540 wake_up_page(page, PG_locked);
542 EXPORT_SYMBOL(unlock_page);
545 * end_page_writeback - end writeback against a page
546 * @page: the page
548 void end_page_writeback(struct page *page)
550 if (!TestClearPageReclaim(page) || rotate_reclaimable_page(page)) {
551 if (!test_clear_page_writeback(page))
552 BUG();
554 smp_mb__after_clear_bit();
555 wake_up_page(page, PG_writeback);
557 EXPORT_SYMBOL(end_page_writeback);
560 * __lock_page - get a lock on the page, assuming we need to sleep to get it
561 * @page: the page to lock
563 * Ugly. Running sync_page() in state TASK_UNINTERRUPTIBLE is scary. If some
564 * random driver's requestfn sets TASK_RUNNING, we could busywait. However
565 * chances are that on the second loop, the block layer's plug list is empty,
566 * so sync_page() will then return in state TASK_UNINTERRUPTIBLE.
568 void fastcall __lock_page(struct page *page)
570 DEFINE_WAIT_BIT(wait, &page->flags, PG_locked);
572 __wait_on_bit_lock(page_waitqueue(page), &wait, sync_page,
573 TASK_UNINTERRUPTIBLE);
575 EXPORT_SYMBOL(__lock_page);
578 * Variant of lock_page that does not require the caller to hold a reference
579 * on the page's mapping.
581 void fastcall __lock_page_nosync(struct page *page)
583 DEFINE_WAIT_BIT(wait, &page->flags, PG_locked);
584 __wait_on_bit_lock(page_waitqueue(page), &wait, __sleep_on_page_lock,
585 TASK_UNINTERRUPTIBLE);
589 * find_get_page - find and get a page reference
590 * @mapping: the address_space to search
591 * @offset: the page index
593 * Is there a pagecache struct page at the given (mapping, offset) tuple?
594 * If yes, increment its refcount and return it; if no, return NULL.
596 struct page * find_get_page(struct address_space *mapping, unsigned long offset)
598 struct page *page;
600 read_lock_irq(&mapping->tree_lock);
601 page = radix_tree_lookup(&mapping->page_tree, offset);
602 if (page)
603 page_cache_get(page);
604 read_unlock_irq(&mapping->tree_lock);
605 return page;
607 EXPORT_SYMBOL(find_get_page);
610 * find_lock_page - locate, pin and lock a pagecache page
611 * @mapping: the address_space to search
612 * @offset: the page index
614 * Locates the desired pagecache page, locks it, increments its reference
615 * count and returns its address.
617 * Returns zero if the page was not present. find_lock_page() may sleep.
619 struct page *find_lock_page(struct address_space *mapping,
620 unsigned long offset)
622 struct page *page;
624 read_lock_irq(&mapping->tree_lock);
625 repeat:
626 page = radix_tree_lookup(&mapping->page_tree, offset);
627 if (page) {
628 page_cache_get(page);
629 if (TestSetPageLocked(page)) {
630 read_unlock_irq(&mapping->tree_lock);
631 __lock_page(page);
632 read_lock_irq(&mapping->tree_lock);
634 /* Has the page been truncated while we slept? */
635 if (unlikely(page->mapping != mapping ||
636 page->index != offset)) {
637 unlock_page(page);
638 page_cache_release(page);
639 goto repeat;
643 read_unlock_irq(&mapping->tree_lock);
644 return page;
646 EXPORT_SYMBOL(find_lock_page);
649 * find_or_create_page - locate or add a pagecache page
650 * @mapping: the page's address_space
651 * @index: the page's index into the mapping
652 * @gfp_mask: page allocation mode
654 * Locates a page in the pagecache. If the page is not present, a new page
655 * is allocated using @gfp_mask and is added to the pagecache and to the VM's
656 * LRU list. The returned page is locked and has its reference count
657 * incremented.
659 * find_or_create_page() may sleep, even if @gfp_flags specifies an atomic
660 * allocation!
662 * find_or_create_page() returns the desired page's address, or zero on
663 * memory exhaustion.
665 struct page *find_or_create_page(struct address_space *mapping,
666 unsigned long index, gfp_t gfp_mask)
668 struct page *page, *cached_page = NULL;
669 int err;
670 repeat:
671 page = find_lock_page(mapping, index);
672 if (!page) {
673 if (!cached_page) {
674 cached_page =
675 __page_cache_alloc(gfp_mask);
676 if (!cached_page)
677 return NULL;
679 err = add_to_page_cache_lru(cached_page, mapping,
680 index, gfp_mask);
681 if (!err) {
682 page = cached_page;
683 cached_page = NULL;
684 } else if (err == -EEXIST)
685 goto repeat;
687 if (cached_page)
688 page_cache_release(cached_page);
689 return page;
691 EXPORT_SYMBOL(find_or_create_page);
694 * find_get_pages - gang pagecache lookup
695 * @mapping: The address_space to search
696 * @start: The starting page index
697 * @nr_pages: The maximum number of pages
698 * @pages: Where the resulting pages are placed
700 * find_get_pages() will search for and return a group of up to
701 * @nr_pages pages in the mapping. The pages are placed at @pages.
702 * find_get_pages() takes a reference against the returned pages.
704 * The search returns a group of mapping-contiguous pages with ascending
705 * indexes. There may be holes in the indices due to not-present pages.
707 * find_get_pages() returns the number of pages which were found.
709 unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
710 unsigned int nr_pages, struct page **pages)
712 unsigned int i;
713 unsigned int ret;
715 read_lock_irq(&mapping->tree_lock);
716 ret = radix_tree_gang_lookup(&mapping->page_tree,
717 (void **)pages, start, nr_pages);
718 for (i = 0; i < ret; i++)
719 page_cache_get(pages[i]);
720 read_unlock_irq(&mapping->tree_lock);
721 return ret;
725 * find_get_pages_contig - gang contiguous pagecache lookup
726 * @mapping: The address_space to search
727 * @index: The starting page index
728 * @nr_pages: The maximum number of pages
729 * @pages: Where the resulting pages are placed
731 * find_get_pages_contig() works exactly like find_get_pages(), except
732 * that the returned number of pages are guaranteed to be contiguous.
734 * find_get_pages_contig() returns the number of pages which were found.
736 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
737 unsigned int nr_pages, struct page **pages)
739 unsigned int i;
740 unsigned int ret;
742 read_lock_irq(&mapping->tree_lock);
743 ret = radix_tree_gang_lookup(&mapping->page_tree,
744 (void **)pages, index, nr_pages);
745 for (i = 0; i < ret; i++) {
746 if (pages[i]->mapping == NULL || pages[i]->index != index)
747 break;
749 page_cache_get(pages[i]);
750 index++;
752 read_unlock_irq(&mapping->tree_lock);
753 return i;
755 EXPORT_SYMBOL(find_get_pages_contig);
758 * find_get_pages_tag - find and return pages that match @tag
759 * @mapping: the address_space to search
760 * @index: the starting page index
761 * @tag: the tag index
762 * @nr_pages: the maximum number of pages
763 * @pages: where the resulting pages are placed
765 * Like find_get_pages, except we only return pages which are tagged with
766 * @tag. We update @index to index the next page for the traversal.
768 unsigned find_get_pages_tag(struct address_space *mapping, pgoff_t *index,
769 int tag, unsigned int nr_pages, struct page **pages)
771 unsigned int i;
772 unsigned int ret;
774 read_lock_irq(&mapping->tree_lock);
775 ret = radix_tree_gang_lookup_tag(&mapping->page_tree,
776 (void **)pages, *index, nr_pages, tag);
777 for (i = 0; i < ret; i++)
778 page_cache_get(pages[i]);
779 if (ret)
780 *index = pages[ret - 1]->index + 1;
781 read_unlock_irq(&mapping->tree_lock);
782 return ret;
784 EXPORT_SYMBOL(find_get_pages_tag);
787 * grab_cache_page_nowait - returns locked page at given index in given cache
788 * @mapping: target address_space
789 * @index: the page index
791 * Same as grab_cache_page(), but do not wait if the page is unavailable.
792 * This is intended for speculative data generators, where the data can
793 * be regenerated if the page couldn't be grabbed. This routine should
794 * be safe to call while holding the lock for another page.
796 * Clear __GFP_FS when allocating the page to avoid recursion into the fs
797 * and deadlock against the caller's locked page.
799 struct page *
800 grab_cache_page_nowait(struct address_space *mapping, unsigned long index)
802 struct page *page = find_get_page(mapping, index);
804 if (page) {
805 if (!TestSetPageLocked(page))
806 return page;
807 page_cache_release(page);
808 return NULL;
810 page = __page_cache_alloc(mapping_gfp_mask(mapping) & ~__GFP_FS);
811 if (page && add_to_page_cache_lru(page, mapping, index, GFP_KERNEL)) {
812 page_cache_release(page);
813 page = NULL;
815 return page;
817 EXPORT_SYMBOL(grab_cache_page_nowait);
820 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
821 * a _large_ part of the i/o request. Imagine the worst scenario:
823 * ---R__________________________________________B__________
824 * ^ reading here ^ bad block(assume 4k)
826 * read(R) => miss => readahead(R...B) => media error => frustrating retries
827 * => failing the whole request => read(R) => read(R+1) =>
828 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
829 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
830 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
832 * It is going insane. Fix it by quickly scaling down the readahead size.
834 static void shrink_readahead_size_eio(struct file *filp,
835 struct file_ra_state *ra)
837 if (!ra->ra_pages)
838 return;
840 ra->ra_pages /= 4;
844 * do_generic_mapping_read - generic file read routine
845 * @mapping: address_space to be read
846 * @_ra: file's readahead state
847 * @filp: the file to read
848 * @ppos: current file position
849 * @desc: read_descriptor
850 * @actor: read method
852 * This is a generic file read routine, and uses the
853 * mapping->a_ops->readpage() function for the actual low-level stuff.
855 * This is really ugly. But the goto's actually try to clarify some
856 * of the logic when it comes to error handling etc.
858 * Note the struct file* is only passed for the use of readpage.
859 * It may be NULL.
861 void do_generic_mapping_read(struct address_space *mapping,
862 struct file_ra_state *_ra,
863 struct file *filp,
864 loff_t *ppos,
865 read_descriptor_t *desc,
866 read_actor_t actor)
868 struct inode *inode = mapping->host;
869 unsigned long index;
870 unsigned long offset;
871 unsigned long last_index;
872 unsigned long next_index;
873 unsigned long prev_index;
874 unsigned int prev_offset;
875 struct page *cached_page;
876 int error;
877 struct file_ra_state ra = *_ra;
879 cached_page = NULL;
880 index = *ppos >> PAGE_CACHE_SHIFT;
881 next_index = index;
882 prev_index = ra.prev_index;
883 prev_offset = ra.prev_offset;
884 last_index = (*ppos + desc->count + PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT;
885 offset = *ppos & ~PAGE_CACHE_MASK;
887 for (;;) {
888 struct page *page;
889 unsigned long end_index;
890 loff_t isize;
891 unsigned long nr, ret;
893 cond_resched();
894 find_page:
895 page = find_get_page(mapping, index);
896 if (!page) {
897 page_cache_sync_readahead(mapping,
898 &ra, filp,
899 index, last_index - index);
900 page = find_get_page(mapping, index);
901 if (unlikely(page == NULL))
902 goto no_cached_page;
904 if (PageReadahead(page)) {
905 page_cache_async_readahead(mapping,
906 &ra, filp, page,
907 index, last_index - index);
909 if (!PageUptodate(page))
910 goto page_not_up_to_date;
911 page_ok:
913 * i_size must be checked after we know the page is Uptodate.
915 * Checking i_size after the check allows us to calculate
916 * the correct value for "nr", which means the zero-filled
917 * part of the page is not copied back to userspace (unless
918 * another truncate extends the file - this is desired though).
921 isize = i_size_read(inode);
922 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
923 if (unlikely(!isize || index > end_index)) {
924 page_cache_release(page);
925 goto out;
928 /* nr is the maximum number of bytes to copy from this page */
929 nr = PAGE_CACHE_SIZE;
930 if (index == end_index) {
931 nr = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
932 if (nr <= offset) {
933 page_cache_release(page);
934 goto out;
937 nr = nr - offset;
939 /* If users can be writing to this page using arbitrary
940 * virtual addresses, take care about potential aliasing
941 * before reading the page on the kernel side.
943 if (mapping_writably_mapped(mapping))
944 flush_dcache_page(page);
947 * When a sequential read accesses a page several times,
948 * only mark it as accessed the first time.
950 if (prev_index != index || offset != prev_offset)
951 mark_page_accessed(page);
952 prev_index = index;
955 * Ok, we have the page, and it's up-to-date, so
956 * now we can copy it to user space...
958 * The actor routine returns how many bytes were actually used..
959 * NOTE! This may not be the same as how much of a user buffer
960 * we filled up (we may be padding etc), so we can only update
961 * "pos" here (the actor routine has to update the user buffer
962 * pointers and the remaining count).
964 ret = actor(desc, page, offset, nr);
965 offset += ret;
966 index += offset >> PAGE_CACHE_SHIFT;
967 offset &= ~PAGE_CACHE_MASK;
968 prev_offset = offset;
969 ra.prev_offset = offset;
971 page_cache_release(page);
972 if (ret == nr && desc->count)
973 continue;
974 goto out;
976 page_not_up_to_date:
977 /* Get exclusive access to the page ... */
978 lock_page(page);
980 /* Did it get truncated before we got the lock? */
981 if (!page->mapping) {
982 unlock_page(page);
983 page_cache_release(page);
984 continue;
987 /* Did somebody else fill it already? */
988 if (PageUptodate(page)) {
989 unlock_page(page);
990 goto page_ok;
993 readpage:
994 /* Start the actual read. The read will unlock the page. */
995 error = mapping->a_ops->readpage(filp, page);
997 if (unlikely(error)) {
998 if (error == AOP_TRUNCATED_PAGE) {
999 page_cache_release(page);
1000 goto find_page;
1002 goto readpage_error;
1005 if (!PageUptodate(page)) {
1006 lock_page(page);
1007 if (!PageUptodate(page)) {
1008 if (page->mapping == NULL) {
1010 * invalidate_inode_pages got it
1012 unlock_page(page);
1013 page_cache_release(page);
1014 goto find_page;
1016 unlock_page(page);
1017 error = -EIO;
1018 shrink_readahead_size_eio(filp, &ra);
1019 goto readpage_error;
1021 unlock_page(page);
1024 goto page_ok;
1026 readpage_error:
1027 /* UHHUH! A synchronous read error occurred. Report it */
1028 desc->error = error;
1029 page_cache_release(page);
1030 goto out;
1032 no_cached_page:
1034 * Ok, it wasn't cached, so we need to create a new
1035 * page..
1037 if (!cached_page) {
1038 cached_page = page_cache_alloc_cold(mapping);
1039 if (!cached_page) {
1040 desc->error = -ENOMEM;
1041 goto out;
1044 error = add_to_page_cache_lru(cached_page, mapping,
1045 index, GFP_KERNEL);
1046 if (error) {
1047 if (error == -EEXIST)
1048 goto find_page;
1049 desc->error = error;
1050 goto out;
1052 page = cached_page;
1053 cached_page = NULL;
1054 goto readpage;
1057 out:
1058 *_ra = ra;
1059 _ra->prev_index = prev_index;
1061 *ppos = ((loff_t) index << PAGE_CACHE_SHIFT) + offset;
1062 if (cached_page)
1063 page_cache_release(cached_page);
1064 if (filp)
1065 file_accessed(filp);
1067 EXPORT_SYMBOL(do_generic_mapping_read);
1069 int file_read_actor(read_descriptor_t *desc, struct page *page,
1070 unsigned long offset, unsigned long size)
1072 char *kaddr;
1073 unsigned long left, count = desc->count;
1075 if (size > count)
1076 size = count;
1079 * Faults on the destination of a read are common, so do it before
1080 * taking the kmap.
1082 if (!fault_in_pages_writeable(desc->arg.buf, size)) {
1083 kaddr = kmap_atomic(page, KM_USER0);
1084 left = __copy_to_user_inatomic(desc->arg.buf,
1085 kaddr + offset, size);
1086 kunmap_atomic(kaddr, KM_USER0);
1087 if (left == 0)
1088 goto success;
1091 /* Do it the slow way */
1092 kaddr = kmap(page);
1093 left = __copy_to_user(desc->arg.buf, kaddr + offset, size);
1094 kunmap(page);
1096 if (left) {
1097 size -= left;
1098 desc->error = -EFAULT;
1100 success:
1101 desc->count = count - size;
1102 desc->written += size;
1103 desc->arg.buf += size;
1104 return size;
1108 * Performs necessary checks before doing a write
1109 * @iov: io vector request
1110 * @nr_segs: number of segments in the iovec
1111 * @count: number of bytes to write
1112 * @access_flags: type of access: %VERIFY_READ or %VERIFY_WRITE
1114 * Adjust number of segments and amount of bytes to write (nr_segs should be
1115 * properly initialized first). Returns appropriate error code that caller
1116 * should return or zero in case that write should be allowed.
1118 int generic_segment_checks(const struct iovec *iov,
1119 unsigned long *nr_segs, size_t *count, int access_flags)
1121 unsigned long seg;
1122 size_t cnt = 0;
1123 for (seg = 0; seg < *nr_segs; seg++) {
1124 const struct iovec *iv = &iov[seg];
1127 * If any segment has a negative length, or the cumulative
1128 * length ever wraps negative then return -EINVAL.
1130 cnt += iv->iov_len;
1131 if (unlikely((ssize_t)(cnt|iv->iov_len) < 0))
1132 return -EINVAL;
1133 if (access_ok(access_flags, iv->iov_base, iv->iov_len))
1134 continue;
1135 if (seg == 0)
1136 return -EFAULT;
1137 *nr_segs = seg;
1138 cnt -= iv->iov_len; /* This segment is no good */
1139 break;
1141 *count = cnt;
1142 return 0;
1144 EXPORT_SYMBOL(generic_segment_checks);
1147 * generic_file_aio_read - generic filesystem read routine
1148 * @iocb: kernel I/O control block
1149 * @iov: io vector request
1150 * @nr_segs: number of segments in the iovec
1151 * @pos: current file position
1153 * This is the "read()" routine for all filesystems
1154 * that can use the page cache directly.
1156 ssize_t
1157 generic_file_aio_read(struct kiocb *iocb, const struct iovec *iov,
1158 unsigned long nr_segs, loff_t pos)
1160 struct file *filp = iocb->ki_filp;
1161 ssize_t retval;
1162 unsigned long seg;
1163 size_t count;
1164 loff_t *ppos = &iocb->ki_pos;
1166 count = 0;
1167 retval = generic_segment_checks(iov, &nr_segs, &count, VERIFY_WRITE);
1168 if (retval)
1169 return retval;
1171 /* coalesce the iovecs and go direct-to-BIO for O_DIRECT */
1172 if (filp->f_flags & O_DIRECT) {
1173 loff_t size;
1174 struct address_space *mapping;
1175 struct inode *inode;
1177 mapping = filp->f_mapping;
1178 inode = mapping->host;
1179 retval = 0;
1180 if (!count)
1181 goto out; /* skip atime */
1182 size = i_size_read(inode);
1183 if (pos < size) {
1184 retval = generic_file_direct_IO(READ, iocb,
1185 iov, pos, nr_segs);
1186 if (retval > 0)
1187 *ppos = pos + retval;
1189 if (likely(retval != 0)) {
1190 file_accessed(filp);
1191 goto out;
1195 retval = 0;
1196 if (count) {
1197 for (seg = 0; seg < nr_segs; seg++) {
1198 read_descriptor_t desc;
1200 desc.written = 0;
1201 desc.arg.buf = iov[seg].iov_base;
1202 desc.count = iov[seg].iov_len;
1203 if (desc.count == 0)
1204 continue;
1205 desc.error = 0;
1206 do_generic_file_read(filp,ppos,&desc,file_read_actor);
1207 retval += desc.written;
1208 if (desc.error) {
1209 retval = retval ?: desc.error;
1210 break;
1212 if (desc.count > 0)
1213 break;
1216 out:
1217 return retval;
1219 EXPORT_SYMBOL(generic_file_aio_read);
1221 static ssize_t
1222 do_readahead(struct address_space *mapping, struct file *filp,
1223 unsigned long index, unsigned long nr)
1225 if (!mapping || !mapping->a_ops || !mapping->a_ops->readpage)
1226 return -EINVAL;
1228 force_page_cache_readahead(mapping, filp, index,
1229 max_sane_readahead(nr));
1230 return 0;
1233 asmlinkage ssize_t sys_readahead(int fd, loff_t offset, size_t count)
1235 ssize_t ret;
1236 struct file *file;
1238 ret = -EBADF;
1239 file = fget(fd);
1240 if (file) {
1241 if (file->f_mode & FMODE_READ) {
1242 struct address_space *mapping = file->f_mapping;
1243 unsigned long start = offset >> PAGE_CACHE_SHIFT;
1244 unsigned long end = (offset + count - 1) >> PAGE_CACHE_SHIFT;
1245 unsigned long len = end - start + 1;
1246 ret = do_readahead(mapping, file, start, len);
1248 fput(file);
1250 return ret;
1253 #ifdef CONFIG_MMU
1254 static int FASTCALL(page_cache_read(struct file * file, unsigned long offset));
1256 * page_cache_read - adds requested page to the page cache if not already there
1257 * @file: file to read
1258 * @offset: page index
1260 * This adds the requested page to the page cache if it isn't already there,
1261 * and schedules an I/O to read in its contents from disk.
1263 static int fastcall page_cache_read(struct file * file, unsigned long offset)
1265 struct address_space *mapping = file->f_mapping;
1266 struct page *page;
1267 int ret;
1269 do {
1270 page = page_cache_alloc_cold(mapping);
1271 if (!page)
1272 return -ENOMEM;
1274 ret = add_to_page_cache_lru(page, mapping, offset, GFP_KERNEL);
1275 if (ret == 0)
1276 ret = mapping->a_ops->readpage(file, page);
1277 else if (ret == -EEXIST)
1278 ret = 0; /* losing race to add is OK */
1280 page_cache_release(page);
1282 } while (ret == AOP_TRUNCATED_PAGE);
1284 return ret;
1287 #define MMAP_LOTSAMISS (100)
1290 * filemap_fault - read in file data for page fault handling
1291 * @vma: vma in which the fault was taken
1292 * @vmf: struct vm_fault containing details of the fault
1294 * filemap_fault() is invoked via the vma operations vector for a
1295 * mapped memory region to read in file data during a page fault.
1297 * The goto's are kind of ugly, but this streamlines the normal case of having
1298 * it in the page cache, and handles the special cases reasonably without
1299 * having a lot of duplicated code.
1301 int filemap_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
1303 int error;
1304 struct file *file = vma->vm_file;
1305 struct address_space *mapping = file->f_mapping;
1306 struct file_ra_state *ra = &file->f_ra;
1307 struct inode *inode = mapping->host;
1308 struct page *page;
1309 unsigned long size;
1310 int did_readaround = 0;
1311 int ret = 0;
1313 size = (i_size_read(inode) + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
1314 if (vmf->pgoff >= size)
1315 return VM_FAULT_SIGBUS;
1317 /* If we don't want any read-ahead, don't bother */
1318 if (VM_RandomReadHint(vma))
1319 goto no_cached_page;
1322 * Do we have something in the page cache already?
1324 retry_find:
1325 page = find_lock_page(mapping, vmf->pgoff);
1327 * For sequential accesses, we use the generic readahead logic.
1329 if (VM_SequentialReadHint(vma)) {
1330 if (!page) {
1331 page_cache_sync_readahead(mapping, ra, file,
1332 vmf->pgoff, 1);
1333 page = find_lock_page(mapping, vmf->pgoff);
1334 if (!page)
1335 goto no_cached_page;
1337 if (PageReadahead(page)) {
1338 page_cache_async_readahead(mapping, ra, file, page,
1339 vmf->pgoff, 1);
1343 if (!page) {
1344 unsigned long ra_pages;
1346 ra->mmap_miss++;
1349 * Do we miss much more than hit in this file? If so,
1350 * stop bothering with read-ahead. It will only hurt.
1352 if (ra->mmap_miss > ra->mmap_hit + MMAP_LOTSAMISS)
1353 goto no_cached_page;
1356 * To keep the pgmajfault counter straight, we need to
1357 * check did_readaround, as this is an inner loop.
1359 if (!did_readaround) {
1360 ret = VM_FAULT_MAJOR;
1361 count_vm_event(PGMAJFAULT);
1363 did_readaround = 1;
1364 ra_pages = max_sane_readahead(file->f_ra.ra_pages);
1365 if (ra_pages) {
1366 pgoff_t start = 0;
1368 if (vmf->pgoff > ra_pages / 2)
1369 start = vmf->pgoff - ra_pages / 2;
1370 do_page_cache_readahead(mapping, file, start, ra_pages);
1372 page = find_lock_page(mapping, vmf->pgoff);
1373 if (!page)
1374 goto no_cached_page;
1377 if (!did_readaround)
1378 ra->mmap_hit++;
1381 * We have a locked page in the page cache, now we need to check
1382 * that it's up-to-date. If not, it is going to be due to an error.
1384 if (unlikely(!PageUptodate(page)))
1385 goto page_not_uptodate;
1387 /* Must recheck i_size under page lock */
1388 size = (i_size_read(inode) + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
1389 if (unlikely(vmf->pgoff >= size)) {
1390 unlock_page(page);
1391 page_cache_release(page);
1392 return VM_FAULT_SIGBUS;
1396 * Found the page and have a reference on it.
1398 mark_page_accessed(page);
1399 ra->prev_index = page->index;
1400 vmf->page = page;
1401 return ret | VM_FAULT_LOCKED;
1403 no_cached_page:
1405 * We're only likely to ever get here if MADV_RANDOM is in
1406 * effect.
1408 error = page_cache_read(file, vmf->pgoff);
1411 * The page we want has now been added to the page cache.
1412 * In the unlikely event that someone removed it in the
1413 * meantime, we'll just come back here and read it again.
1415 if (error >= 0)
1416 goto retry_find;
1419 * An error return from page_cache_read can result if the
1420 * system is low on memory, or a problem occurs while trying
1421 * to schedule I/O.
1423 if (error == -ENOMEM)
1424 return VM_FAULT_OOM;
1425 return VM_FAULT_SIGBUS;
1427 page_not_uptodate:
1428 /* IO error path */
1429 if (!did_readaround) {
1430 ret = VM_FAULT_MAJOR;
1431 count_vm_event(PGMAJFAULT);
1435 * Umm, take care of errors if the page isn't up-to-date.
1436 * Try to re-read it _once_. We do this synchronously,
1437 * because there really aren't any performance issues here
1438 * and we need to check for errors.
1440 ClearPageError(page);
1441 error = mapping->a_ops->readpage(file, page);
1442 page_cache_release(page);
1444 if (!error || error == AOP_TRUNCATED_PAGE)
1445 goto retry_find;
1447 /* Things didn't work out. Return zero to tell the mm layer so. */
1448 shrink_readahead_size_eio(file, ra);
1449 return VM_FAULT_SIGBUS;
1451 EXPORT_SYMBOL(filemap_fault);
1453 struct vm_operations_struct generic_file_vm_ops = {
1454 .fault = filemap_fault,
1457 /* This is used for a general mmap of a disk file */
1459 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
1461 struct address_space *mapping = file->f_mapping;
1463 if (!mapping->a_ops->readpage)
1464 return -ENOEXEC;
1465 file_accessed(file);
1466 vma->vm_ops = &generic_file_vm_ops;
1467 vma->vm_flags |= VM_CAN_NONLINEAR;
1468 return 0;
1472 * This is for filesystems which do not implement ->writepage.
1474 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
1476 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
1477 return -EINVAL;
1478 return generic_file_mmap(file, vma);
1480 #else
1481 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
1483 return -ENOSYS;
1485 int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
1487 return -ENOSYS;
1489 #endif /* CONFIG_MMU */
1491 EXPORT_SYMBOL(generic_file_mmap);
1492 EXPORT_SYMBOL(generic_file_readonly_mmap);
1494 static struct page *__read_cache_page(struct address_space *mapping,
1495 unsigned long index,
1496 int (*filler)(void *,struct page*),
1497 void *data)
1499 struct page *page, *cached_page = NULL;
1500 int err;
1501 repeat:
1502 page = find_get_page(mapping, index);
1503 if (!page) {
1504 if (!cached_page) {
1505 cached_page = page_cache_alloc_cold(mapping);
1506 if (!cached_page)
1507 return ERR_PTR(-ENOMEM);
1509 err = add_to_page_cache_lru(cached_page, mapping,
1510 index, GFP_KERNEL);
1511 if (err == -EEXIST)
1512 goto repeat;
1513 if (err < 0) {
1514 /* Presumably ENOMEM for radix tree node */
1515 page_cache_release(cached_page);
1516 return ERR_PTR(err);
1518 page = cached_page;
1519 cached_page = NULL;
1520 err = filler(data, page);
1521 if (err < 0) {
1522 page_cache_release(page);
1523 page = ERR_PTR(err);
1526 if (cached_page)
1527 page_cache_release(cached_page);
1528 return page;
1532 * Same as read_cache_page, but don't wait for page to become unlocked
1533 * after submitting it to the filler.
1535 struct page *read_cache_page_async(struct address_space *mapping,
1536 unsigned long index,
1537 int (*filler)(void *,struct page*),
1538 void *data)
1540 struct page *page;
1541 int err;
1543 retry:
1544 page = __read_cache_page(mapping, index, filler, data);
1545 if (IS_ERR(page))
1546 return page;
1547 if (PageUptodate(page))
1548 goto out;
1550 lock_page(page);
1551 if (!page->mapping) {
1552 unlock_page(page);
1553 page_cache_release(page);
1554 goto retry;
1556 if (PageUptodate(page)) {
1557 unlock_page(page);
1558 goto out;
1560 err = filler(data, page);
1561 if (err < 0) {
1562 page_cache_release(page);
1563 return ERR_PTR(err);
1565 out:
1566 mark_page_accessed(page);
1567 return page;
1569 EXPORT_SYMBOL(read_cache_page_async);
1572 * read_cache_page - read into page cache, fill it if needed
1573 * @mapping: the page's address_space
1574 * @index: the page index
1575 * @filler: function to perform the read
1576 * @data: destination for read data
1578 * Read into the page cache. If a page already exists, and PageUptodate() is
1579 * not set, try to fill the page then wait for it to become unlocked.
1581 * If the page does not get brought uptodate, return -EIO.
1583 struct page *read_cache_page(struct address_space *mapping,
1584 unsigned long index,
1585 int (*filler)(void *,struct page*),
1586 void *data)
1588 struct page *page;
1590 page = read_cache_page_async(mapping, index, filler, data);
1591 if (IS_ERR(page))
1592 goto out;
1593 wait_on_page_locked(page);
1594 if (!PageUptodate(page)) {
1595 page_cache_release(page);
1596 page = ERR_PTR(-EIO);
1598 out:
1599 return page;
1601 EXPORT_SYMBOL(read_cache_page);
1604 * If the page was newly created, increment its refcount and add it to the
1605 * caller's lru-buffering pagevec. This function is specifically for
1606 * generic_file_write().
1608 static inline struct page *
1609 __grab_cache_page(struct address_space *mapping, unsigned long index,
1610 struct page **cached_page, struct pagevec *lru_pvec)
1612 int err;
1613 struct page *page;
1614 repeat:
1615 page = find_lock_page(mapping, index);
1616 if (!page) {
1617 if (!*cached_page) {
1618 *cached_page = page_cache_alloc(mapping);
1619 if (!*cached_page)
1620 return NULL;
1622 err = add_to_page_cache(*cached_page, mapping,
1623 index, GFP_KERNEL);
1624 if (err == -EEXIST)
1625 goto repeat;
1626 if (err == 0) {
1627 page = *cached_page;
1628 page_cache_get(page);
1629 if (!pagevec_add(lru_pvec, page))
1630 __pagevec_lru_add(lru_pvec);
1631 *cached_page = NULL;
1634 return page;
1638 * The logic we want is
1640 * if suid or (sgid and xgrp)
1641 * remove privs
1643 int should_remove_suid(struct dentry *dentry)
1645 mode_t mode = dentry->d_inode->i_mode;
1646 int kill = 0;
1648 /* suid always must be killed */
1649 if (unlikely(mode & S_ISUID))
1650 kill = ATTR_KILL_SUID;
1653 * sgid without any exec bits is just a mandatory locking mark; leave
1654 * it alone. If some exec bits are set, it's a real sgid; kill it.
1656 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1657 kill |= ATTR_KILL_SGID;
1659 if (unlikely(kill && !capable(CAP_FSETID)))
1660 return kill;
1662 return 0;
1664 EXPORT_SYMBOL(should_remove_suid);
1666 int __remove_suid(struct dentry *dentry, int kill)
1668 struct iattr newattrs;
1670 newattrs.ia_valid = ATTR_FORCE | kill;
1671 return notify_change(dentry, &newattrs);
1674 int remove_suid(struct dentry *dentry)
1676 int kill = should_remove_suid(dentry);
1678 if (unlikely(kill))
1679 return __remove_suid(dentry, kill);
1681 return 0;
1683 EXPORT_SYMBOL(remove_suid);
1685 size_t
1686 __filemap_copy_from_user_iovec_inatomic(char *vaddr,
1687 const struct iovec *iov, size_t base, size_t bytes)
1689 size_t copied = 0, left = 0;
1691 while (bytes) {
1692 char __user *buf = iov->iov_base + base;
1693 int copy = min(bytes, iov->iov_len - base);
1695 base = 0;
1696 left = __copy_from_user_inatomic_nocache(vaddr, buf, copy);
1697 copied += copy;
1698 bytes -= copy;
1699 vaddr += copy;
1700 iov++;
1702 if (unlikely(left))
1703 break;
1705 return copied - left;
1709 * Performs necessary checks before doing a write
1711 * Can adjust writing position or amount of bytes to write.
1712 * Returns appropriate error code that caller should return or
1713 * zero in case that write should be allowed.
1715 inline int generic_write_checks(struct file *file, loff_t *pos, size_t *count, int isblk)
1717 struct inode *inode = file->f_mapping->host;
1718 unsigned long limit = current->signal->rlim[RLIMIT_FSIZE].rlim_cur;
1720 if (unlikely(*pos < 0))
1721 return -EINVAL;
1723 if (!isblk) {
1724 /* FIXME: this is for backwards compatibility with 2.4 */
1725 if (file->f_flags & O_APPEND)
1726 *pos = i_size_read(inode);
1728 if (limit != RLIM_INFINITY) {
1729 if (*pos >= limit) {
1730 send_sig(SIGXFSZ, current, 0);
1731 return -EFBIG;
1733 if (*count > limit - (typeof(limit))*pos) {
1734 *count = limit - (typeof(limit))*pos;
1740 * LFS rule
1742 if (unlikely(*pos + *count > MAX_NON_LFS &&
1743 !(file->f_flags & O_LARGEFILE))) {
1744 if (*pos >= MAX_NON_LFS) {
1745 return -EFBIG;
1747 if (*count > MAX_NON_LFS - (unsigned long)*pos) {
1748 *count = MAX_NON_LFS - (unsigned long)*pos;
1753 * Are we about to exceed the fs block limit ?
1755 * If we have written data it becomes a short write. If we have
1756 * exceeded without writing data we send a signal and return EFBIG.
1757 * Linus frestrict idea will clean these up nicely..
1759 if (likely(!isblk)) {
1760 if (unlikely(*pos >= inode->i_sb->s_maxbytes)) {
1761 if (*count || *pos > inode->i_sb->s_maxbytes) {
1762 return -EFBIG;
1764 /* zero-length writes at ->s_maxbytes are OK */
1767 if (unlikely(*pos + *count > inode->i_sb->s_maxbytes))
1768 *count = inode->i_sb->s_maxbytes - *pos;
1769 } else {
1770 #ifdef CONFIG_BLOCK
1771 loff_t isize;
1772 if (bdev_read_only(I_BDEV(inode)))
1773 return -EPERM;
1774 isize = i_size_read(inode);
1775 if (*pos >= isize) {
1776 if (*count || *pos > isize)
1777 return -ENOSPC;
1780 if (*pos + *count > isize)
1781 *count = isize - *pos;
1782 #else
1783 return -EPERM;
1784 #endif
1786 return 0;
1788 EXPORT_SYMBOL(generic_write_checks);
1790 ssize_t
1791 generic_file_direct_write(struct kiocb *iocb, const struct iovec *iov,
1792 unsigned long *nr_segs, loff_t pos, loff_t *ppos,
1793 size_t count, size_t ocount)
1795 struct file *file = iocb->ki_filp;
1796 struct address_space *mapping = file->f_mapping;
1797 struct inode *inode = mapping->host;
1798 ssize_t written;
1800 if (count != ocount)
1801 *nr_segs = iov_shorten((struct iovec *)iov, *nr_segs, count);
1803 written = generic_file_direct_IO(WRITE, iocb, iov, pos, *nr_segs);
1804 if (written > 0) {
1805 loff_t end = pos + written;
1806 if (end > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
1807 i_size_write(inode, end);
1808 mark_inode_dirty(inode);
1810 *ppos = end;
1814 * Sync the fs metadata but not the minor inode changes and
1815 * of course not the data as we did direct DMA for the IO.
1816 * i_mutex is held, which protects generic_osync_inode() from
1817 * livelocking. AIO O_DIRECT ops attempt to sync metadata here.
1819 if ((written >= 0 || written == -EIOCBQUEUED) &&
1820 ((file->f_flags & O_SYNC) || IS_SYNC(inode))) {
1821 int err = generic_osync_inode(inode, mapping, OSYNC_METADATA);
1822 if (err < 0)
1823 written = err;
1825 return written;
1827 EXPORT_SYMBOL(generic_file_direct_write);
1829 ssize_t
1830 generic_file_buffered_write(struct kiocb *iocb, const struct iovec *iov,
1831 unsigned long nr_segs, loff_t pos, loff_t *ppos,
1832 size_t count, ssize_t written)
1834 struct file *file = iocb->ki_filp;
1835 struct address_space * mapping = file->f_mapping;
1836 const struct address_space_operations *a_ops = mapping->a_ops;
1837 struct inode *inode = mapping->host;
1838 long status = 0;
1839 struct page *page;
1840 struct page *cached_page = NULL;
1841 size_t bytes;
1842 struct pagevec lru_pvec;
1843 const struct iovec *cur_iov = iov; /* current iovec */
1844 size_t iov_base = 0; /* offset in the current iovec */
1845 char __user *buf;
1847 pagevec_init(&lru_pvec, 0);
1850 * handle partial DIO write. Adjust cur_iov if needed.
1852 if (likely(nr_segs == 1))
1853 buf = iov->iov_base + written;
1854 else {
1855 filemap_set_next_iovec(&cur_iov, &iov_base, written);
1856 buf = cur_iov->iov_base + iov_base;
1859 do {
1860 unsigned long index;
1861 unsigned long offset;
1862 size_t copied;
1864 offset = (pos & (PAGE_CACHE_SIZE -1)); /* Within page */
1865 index = pos >> PAGE_CACHE_SHIFT;
1866 bytes = PAGE_CACHE_SIZE - offset;
1868 /* Limit the size of the copy to the caller's write size */
1869 bytes = min(bytes, count);
1871 /* We only need to worry about prefaulting when writes are from
1872 * user-space. NFSd uses vfs_writev with several non-aligned
1873 * segments in the vector, and limiting to one segment a time is
1874 * a noticeable performance for re-write
1876 if (!segment_eq(get_fs(), KERNEL_DS)) {
1878 * Limit the size of the copy to that of the current
1879 * segment, because fault_in_pages_readable() doesn't
1880 * know how to walk segments.
1882 bytes = min(bytes, cur_iov->iov_len - iov_base);
1885 * Bring in the user page that we will copy from
1886 * _first_. Otherwise there's a nasty deadlock on
1887 * copying from the same page as we're writing to,
1888 * without it being marked up-to-date.
1890 fault_in_pages_readable(buf, bytes);
1892 page = __grab_cache_page(mapping,index,&cached_page,&lru_pvec);
1893 if (!page) {
1894 status = -ENOMEM;
1895 break;
1898 if (unlikely(bytes == 0)) {
1899 status = 0;
1900 copied = 0;
1901 goto zero_length_segment;
1904 status = a_ops->prepare_write(file, page, offset, offset+bytes);
1905 if (unlikely(status)) {
1906 loff_t isize = i_size_read(inode);
1908 if (status != AOP_TRUNCATED_PAGE)
1909 unlock_page(page);
1910 page_cache_release(page);
1911 if (status == AOP_TRUNCATED_PAGE)
1912 continue;
1914 * prepare_write() may have instantiated a few blocks
1915 * outside i_size. Trim these off again.
1917 if (pos + bytes > isize)
1918 vmtruncate(inode, isize);
1919 break;
1921 if (likely(nr_segs == 1))
1922 copied = filemap_copy_from_user(page, offset,
1923 buf, bytes);
1924 else
1925 copied = filemap_copy_from_user_iovec(page, offset,
1926 cur_iov, iov_base, bytes);
1927 flush_dcache_page(page);
1928 status = a_ops->commit_write(file, page, offset, offset+bytes);
1929 if (status == AOP_TRUNCATED_PAGE) {
1930 page_cache_release(page);
1931 continue;
1933 zero_length_segment:
1934 if (likely(copied >= 0)) {
1935 if (!status)
1936 status = copied;
1938 if (status >= 0) {
1939 written += status;
1940 count -= status;
1941 pos += status;
1942 buf += status;
1943 if (unlikely(nr_segs > 1)) {
1944 filemap_set_next_iovec(&cur_iov,
1945 &iov_base, status);
1946 if (count)
1947 buf = cur_iov->iov_base +
1948 iov_base;
1949 } else {
1950 iov_base += status;
1954 if (unlikely(copied != bytes))
1955 if (status >= 0)
1956 status = -EFAULT;
1957 unlock_page(page);
1958 mark_page_accessed(page);
1959 page_cache_release(page);
1960 if (status < 0)
1961 break;
1962 balance_dirty_pages_ratelimited(mapping);
1963 cond_resched();
1964 } while (count);
1965 *ppos = pos;
1967 if (cached_page)
1968 page_cache_release(cached_page);
1971 * For now, when the user asks for O_SYNC, we'll actually give O_DSYNC
1973 if (likely(status >= 0)) {
1974 if (unlikely((file->f_flags & O_SYNC) || IS_SYNC(inode))) {
1975 if (!a_ops->writepage || !is_sync_kiocb(iocb))
1976 status = generic_osync_inode(inode, mapping,
1977 OSYNC_METADATA|OSYNC_DATA);
1982 * If we get here for O_DIRECT writes then we must have fallen through
1983 * to buffered writes (block instantiation inside i_size). So we sync
1984 * the file data here, to try to honour O_DIRECT expectations.
1986 if (unlikely(file->f_flags & O_DIRECT) && written)
1987 status = filemap_write_and_wait(mapping);
1989 pagevec_lru_add(&lru_pvec);
1990 return written ? written : status;
1992 EXPORT_SYMBOL(generic_file_buffered_write);
1994 static ssize_t
1995 __generic_file_aio_write_nolock(struct kiocb *iocb, const struct iovec *iov,
1996 unsigned long nr_segs, loff_t *ppos)
1998 struct file *file = iocb->ki_filp;
1999 struct address_space * mapping = file->f_mapping;
2000 size_t ocount; /* original count */
2001 size_t count; /* after file limit checks */
2002 struct inode *inode = mapping->host;
2003 loff_t pos;
2004 ssize_t written;
2005 ssize_t err;
2007 ocount = 0;
2008 err = generic_segment_checks(iov, &nr_segs, &ocount, VERIFY_READ);
2009 if (err)
2010 return err;
2012 count = ocount;
2013 pos = *ppos;
2015 vfs_check_frozen(inode->i_sb, SB_FREEZE_WRITE);
2017 /* We can write back this queue in page reclaim */
2018 current->backing_dev_info = mapping->backing_dev_info;
2019 written = 0;
2021 err = generic_write_checks(file, &pos, &count, S_ISBLK(inode->i_mode));
2022 if (err)
2023 goto out;
2025 if (count == 0)
2026 goto out;
2028 err = remove_suid(file->f_path.dentry);
2029 if (err)
2030 goto out;
2032 file_update_time(file);
2034 /* coalesce the iovecs and go direct-to-BIO for O_DIRECT */
2035 if (unlikely(file->f_flags & O_DIRECT)) {
2036 loff_t endbyte;
2037 ssize_t written_buffered;
2039 written = generic_file_direct_write(iocb, iov, &nr_segs, pos,
2040 ppos, count, ocount);
2041 if (written < 0 || written == count)
2042 goto out;
2044 * direct-io write to a hole: fall through to buffered I/O
2045 * for completing the rest of the request.
2047 pos += written;
2048 count -= written;
2049 written_buffered = generic_file_buffered_write(iocb, iov,
2050 nr_segs, pos, ppos, count,
2051 written);
2053 * If generic_file_buffered_write() retuned a synchronous error
2054 * then we want to return the number of bytes which were
2055 * direct-written, or the error code if that was zero. Note
2056 * that this differs from normal direct-io semantics, which
2057 * will return -EFOO even if some bytes were written.
2059 if (written_buffered < 0) {
2060 err = written_buffered;
2061 goto out;
2065 * We need to ensure that the page cache pages are written to
2066 * disk and invalidated to preserve the expected O_DIRECT
2067 * semantics.
2069 endbyte = pos + written_buffered - written - 1;
2070 err = do_sync_mapping_range(file->f_mapping, pos, endbyte,
2071 SYNC_FILE_RANGE_WAIT_BEFORE|
2072 SYNC_FILE_RANGE_WRITE|
2073 SYNC_FILE_RANGE_WAIT_AFTER);
2074 if (err == 0) {
2075 written = written_buffered;
2076 invalidate_mapping_pages(mapping,
2077 pos >> PAGE_CACHE_SHIFT,
2078 endbyte >> PAGE_CACHE_SHIFT);
2079 } else {
2081 * We don't know how much we wrote, so just return
2082 * the number of bytes which were direct-written
2085 } else {
2086 written = generic_file_buffered_write(iocb, iov, nr_segs,
2087 pos, ppos, count, written);
2089 out:
2090 current->backing_dev_info = NULL;
2091 return written ? written : err;
2094 ssize_t generic_file_aio_write_nolock(struct kiocb *iocb,
2095 const struct iovec *iov, unsigned long nr_segs, loff_t pos)
2097 struct file *file = iocb->ki_filp;
2098 struct address_space *mapping = file->f_mapping;
2099 struct inode *inode = mapping->host;
2100 ssize_t ret;
2102 BUG_ON(iocb->ki_pos != pos);
2104 ret = __generic_file_aio_write_nolock(iocb, iov, nr_segs,
2105 &iocb->ki_pos);
2107 if (ret > 0 && ((file->f_flags & O_SYNC) || IS_SYNC(inode))) {
2108 ssize_t err;
2110 err = sync_page_range_nolock(inode, mapping, pos, ret);
2111 if (err < 0)
2112 ret = err;
2114 return ret;
2116 EXPORT_SYMBOL(generic_file_aio_write_nolock);
2118 ssize_t generic_file_aio_write(struct kiocb *iocb, const struct iovec *iov,
2119 unsigned long nr_segs, loff_t pos)
2121 struct file *file = iocb->ki_filp;
2122 struct address_space *mapping = file->f_mapping;
2123 struct inode *inode = mapping->host;
2124 ssize_t ret;
2126 BUG_ON(iocb->ki_pos != pos);
2128 mutex_lock(&inode->i_mutex);
2129 ret = __generic_file_aio_write_nolock(iocb, iov, nr_segs,
2130 &iocb->ki_pos);
2131 mutex_unlock(&inode->i_mutex);
2133 if (ret > 0 && ((file->f_flags & O_SYNC) || IS_SYNC(inode))) {
2134 ssize_t err;
2136 err = sync_page_range(inode, mapping, pos, ret);
2137 if (err < 0)
2138 ret = err;
2140 return ret;
2142 EXPORT_SYMBOL(generic_file_aio_write);
2145 * Called under i_mutex for writes to S_ISREG files. Returns -EIO if something
2146 * went wrong during pagecache shootdown.
2148 static ssize_t
2149 generic_file_direct_IO(int rw, struct kiocb *iocb, const struct iovec *iov,
2150 loff_t offset, unsigned long nr_segs)
2152 struct file *file = iocb->ki_filp;
2153 struct address_space *mapping = file->f_mapping;
2154 ssize_t retval;
2155 size_t write_len;
2156 pgoff_t end = 0; /* silence gcc */
2159 * If it's a write, unmap all mmappings of the file up-front. This
2160 * will cause any pte dirty bits to be propagated into the pageframes
2161 * for the subsequent filemap_write_and_wait().
2163 if (rw == WRITE) {
2164 write_len = iov_length(iov, nr_segs);
2165 end = (offset + write_len - 1) >> PAGE_CACHE_SHIFT;
2166 if (mapping_mapped(mapping))
2167 unmap_mapping_range(mapping, offset, write_len, 0);
2170 retval = filemap_write_and_wait(mapping);
2171 if (retval)
2172 goto out;
2175 * After a write we want buffered reads to be sure to go to disk to get
2176 * the new data. We invalidate clean cached page from the region we're
2177 * about to write. We do this *before* the write so that we can return
2178 * -EIO without clobbering -EIOCBQUEUED from ->direct_IO().
2180 if (rw == WRITE && mapping->nrpages) {
2181 retval = invalidate_inode_pages2_range(mapping,
2182 offset >> PAGE_CACHE_SHIFT, end);
2183 if (retval)
2184 goto out;
2187 retval = mapping->a_ops->direct_IO(rw, iocb, iov, offset, nr_segs);
2188 if (retval)
2189 goto out;
2192 * Finally, try again to invalidate clean pages which might have been
2193 * faulted in by get_user_pages() if the source of the write was an
2194 * mmap()ed region of the file we're writing. That's a pretty crazy
2195 * thing to do, so we don't support it 100%. If this invalidation
2196 * fails and we have -EIOCBQUEUED we ignore the failure.
2198 if (rw == WRITE && mapping->nrpages) {
2199 int err = invalidate_inode_pages2_range(mapping,
2200 offset >> PAGE_CACHE_SHIFT, end);
2201 if (err && retval >= 0)
2202 retval = err;
2204 out:
2205 return retval;
2209 * try_to_release_page() - release old fs-specific metadata on a page
2211 * @page: the page which the kernel is trying to free
2212 * @gfp_mask: memory allocation flags (and I/O mode)
2214 * The address_space is to try to release any data against the page
2215 * (presumably at page->private). If the release was successful, return `1'.
2216 * Otherwise return zero.
2218 * The @gfp_mask argument specifies whether I/O may be performed to release
2219 * this page (__GFP_IO), and whether the call may block (__GFP_WAIT).
2221 * NOTE: @gfp_mask may go away, and this function may become non-blocking.
2223 int try_to_release_page(struct page *page, gfp_t gfp_mask)
2225 struct address_space * const mapping = page->mapping;
2227 BUG_ON(!PageLocked(page));
2228 if (PageWriteback(page))
2229 return 0;
2231 if (mapping && mapping->a_ops->releasepage)
2232 return mapping->a_ops->releasepage(page, gfp_mask);
2233 return try_to_free_buffers(page);
2236 EXPORT_SYMBOL(try_to_release_page);