blob: a29318147365831ce12d8e86dd41e1644b2f8628 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/mm/filemap.c
3 *
4 * Copyright (C) 1994-1999 Linus Torvalds
5 */
6
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)
11 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070013#include <linux/compiler.h>
14#include <linux/fs.h>
Hiro Yoshiokac22ce142006-06-23 02:04:16 -070015#include <linux/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#include <linux/aio.h>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080017#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/kernel_stat.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090019#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#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>
Linus Torvalds53253382007-10-18 14:47:32 -070028#include <linux/backing-dev.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029#include <linux/pagevec.h>
30#include <linux/blkdev.h>
31#include <linux/security.h>
32#include <linux/syscalls.h>
Paul Jackson44110fe2006-03-24 03:16:04 -080033#include <linux/cpuset.h>
Nick Piggin2f718ff2007-10-16 01:24:59 -070034#include <linux/hardirq.h> /* for BUG_ON(!in_atomic()) only */
Balbir Singh8a9f3cc2008-02-07 00:13:53 -080035#include <linux/memcontrol.h>
Rik van Riel4f98a2f2008-10-18 20:26:32 -070036#include <linux/mm_inline.h> /* for page_is_file_cache() */
Nick Piggin0f8053a2006-03-22 00:08:33 -080037#include "internal.h"
38
Linus Torvalds1da177e2005-04-16 15:20:36 -070039/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 * FIXME: remove all knowledge of the buffer layer from the core VM
41 */
Jan Kara148f9482009-08-17 19:52:36 +020042#include <linux/buffer_head.h> /* for try_to_free_buffers */
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <asm/mman.h>
45
46/*
47 * Shared mappings implemented 30.11.1994. It's not fully working yet,
48 * though.
49 *
50 * Shared mappings now work. 15.8.1995 Bruno.
51 *
52 * finished 'unifying' the page and buffer cache and SMP-threaded the
53 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
54 *
55 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
56 */
57
58/*
59 * Lock ordering:
60 *
npiggin@suse.de25d9e2d2009-08-21 02:35:05 +100061 * ->i_mmap_lock (truncate_pagecache)
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 * ->private_lock (__free_pte->__set_page_dirty_buffers)
Hugh Dickins5d337b92005-09-03 15:54:41 -070063 * ->swap_lock (exclusive_swap_page, others)
64 * ->mapping->tree_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080066 * ->i_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * ->i_mmap_lock (truncate->unmap_mapping_range)
68 *
69 * ->mmap_sem
70 * ->i_mmap_lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070071 * ->page_table_lock or pte_lock (various, mainly in memory.c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * ->mapping->tree_lock (arch-dependent flush_dcache_mmap_lock)
73 *
74 * ->mmap_sem
75 * ->lock_page (access_process_vm)
76 *
Nick Piggin82591e62006-10-19 23:29:10 -070077 * ->i_mutex (generic_file_buffered_write)
78 * ->mmap_sem (fault_in_pages_readable->do_page_fault)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079 *
Jes Sorensen1b1dcc12006-01-09 15:59:24 -080080 * ->i_mutex
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 * ->i_alloc_sem (various)
82 *
83 * ->inode_lock
84 * ->sb_lock (fs/fs-writeback.c)
85 * ->mapping->tree_lock (__sync_single_inode)
86 *
87 * ->i_mmap_lock
88 * ->anon_vma.lock (vma_adjust)
89 *
90 * ->anon_vma.lock
Hugh Dickinsb8072f02005-10-29 18:16:41 -070091 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 *
Hugh Dickinsb8072f02005-10-29 18:16:41 -070093 * ->page_table_lock or pte_lock
Hugh Dickins5d337b92005-09-03 15:54:41 -070094 * ->swap_lock (try_to_unmap_one)
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 * ->private_lock (try_to_unmap_one)
96 * ->tree_lock (try_to_unmap_one)
97 * ->zone.lru_lock (follow_page->mark_page_accessed)
Nick Piggin053837f2006-01-18 17:42:27 -080098 * ->zone.lru_lock (check_pte_range->isolate_lru_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 * ->private_lock (page_remove_rmap->set_page_dirty)
100 * ->tree_lock (page_remove_rmap->set_page_dirty)
101 * ->inode_lock (page_remove_rmap->set_page_dirty)
102 * ->inode_lock (zap_pte_range->set_page_dirty)
103 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
104 *
Andi Kleen6a460792009-09-16 11:50:15 +0200105 * (code doesn't rely on that order, so you could switch it around)
106 * ->tasklist_lock (memory_failure, collect_procs_ao)
107 * ->i_mmap_lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108 */
109
110/*
Minchan Kime64a7822011-03-22 16:32:44 -0700111 * Delete a page from the page cache and free it. Caller has to make
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 * sure the page is locked and that nobody else uses it - or that usage
Nick Piggin19fd6232008-07-25 19:45:32 -0700113 * is safe. The caller must hold the mapping's tree_lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 */
Minchan Kime64a7822011-03-22 16:32:44 -0700115void __delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116{
117 struct address_space *mapping = page->mapping;
118
119 radix_tree_delete(&mapping->page_tree, page->index);
120 page->mapping = NULL;
121 mapping->nrpages--;
Christoph Lameter347ce432006-06-30 01:55:35 -0700122 __dec_zone_page_state(page, NR_FILE_PAGES);
KOSAKI Motohiro4b021082009-09-21 17:01:33 -0700123 if (PageSwapBacked(page))
124 __dec_zone_page_state(page, NR_SHMEM);
Nick Piggin45426812007-07-15 23:38:12 -0700125 BUG_ON(page_mapped(page));
Linus Torvalds3a692792007-12-19 14:05:13 -0800126
127 /*
128 * Some filesystems seem to re-dirty the page even after
129 * the VM has canceled the dirty bit (eg ext3 journaling).
130 *
131 * Fix it up by doing a final dirty accounting check after
132 * having removed the page entirely.
133 */
134 if (PageDirty(page) && mapping_cap_account_dirty(mapping)) {
135 dec_zone_page_state(page, NR_FILE_DIRTY);
136 dec_bdi_stat(mapping->backing_dev_info, BDI_RECLAIMABLE);
137 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138}
139
Minchan Kim702cfbf2011-03-22 16:32:43 -0700140/**
141 * delete_from_page_cache - delete page from page cache
142 * @page: the page which the kernel is trying to remove from page cache
143 *
144 * This must be called only on pages that have been verified to be in the page
145 * cache and locked. It will never put the page into the free list, the caller
146 * has a reference on the page.
147 */
148void delete_from_page_cache(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149{
150 struct address_space *mapping = page->mapping;
Linus Torvalds6072d132010-12-01 13:35:19 -0500151 void (*freepage)(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152
Matt Mackallcd7619d2005-05-01 08:59:01 -0700153 BUG_ON(!PageLocked(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Linus Torvalds6072d132010-12-01 13:35:19 -0500155 freepage = mapping->a_ops->freepage;
Nick Piggin19fd6232008-07-25 19:45:32 -0700156 spin_lock_irq(&mapping->tree_lock);
Minchan Kime64a7822011-03-22 16:32:44 -0700157 __delete_from_page_cache(page);
Nick Piggin19fd6232008-07-25 19:45:32 -0700158 spin_unlock_irq(&mapping->tree_lock);
Daisuke Nishimurae767e052009-05-28 14:34:28 -0700159 mem_cgroup_uncharge_cache_page(page);
Linus Torvalds6072d132010-12-01 13:35:19 -0500160
161 if (freepage)
162 freepage(page);
Minchan Kim97cecb52011-03-22 16:30:53 -0700163 page_cache_release(page);
164}
165EXPORT_SYMBOL(delete_from_page_cache);
166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167static int sync_page(void *word)
168{
169 struct address_space *mapping;
170 struct page *page;
171
Andi Kleen07808b72005-11-05 17:25:53 +0100172 page = container_of((unsigned long *)word, struct page, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174 /*
William Lee Irwin IIIdd1d5af2005-05-01 08:58:38 -0700175 * page_mapping() is being called without PG_locked held.
176 * Some knowledge of the state and use of the page is used to
177 * reduce the requirements down to a memory barrier.
178 * The danger here is of a stale page_mapping() return value
179 * indicating a struct address_space different from the one it's
180 * associated with when it is associated with one.
181 * After smp_mb(), it's either the correct page_mapping() for
182 * the page, or an old page_mapping() and the page's own
183 * page_mapping() has gone NULL.
184 * The ->sync_page() address_space operation must tolerate
185 * page_mapping() going NULL. By an amazing coincidence,
186 * this comes about because none of the users of the page
187 * in the ->sync_page() methods make essential use of the
188 * page_mapping(), merely passing the page down to the backing
189 * device's unplug functions when it's non-NULL, which in turn
Hugh Dickins4c21e2f2005-10-29 18:16:40 -0700190 * ignore it for all cases but swap, where only page_private(page) is
William Lee Irwin IIIdd1d5af2005-05-01 08:58:38 -0700191 * of interest. When page_mapping() does go NULL, the entire
192 * call stack gracefully ignores the page and returns.
193 * -- wli
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 */
195 smp_mb();
196 mapping = page_mapping(page);
197 if (mapping && mapping->a_ops && mapping->a_ops->sync_page)
198 mapping->a_ops->sync_page(page);
199 io_schedule();
200 return 0;
201}
202
Matthew Wilcox2687a352007-12-06 11:18:49 -0500203static int sync_page_killable(void *word)
204{
205 sync_page(word);
206 return fatal_signal_pending(current) ? -EINTR : 0;
207}
208
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700210 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
Martin Waitz67be2dd2005-05-01 08:59:26 -0700211 * @mapping: address space structure to write
212 * @start: offset in bytes where the range starts
Andrew Morton469eb4d2006-03-24 03:17:45 -0800213 * @end: offset in bytes where the range ends (inclusive)
Martin Waitz67be2dd2005-05-01 08:59:26 -0700214 * @sync_mode: enable synchronous operation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700216 * Start writeback against all of a mapping's dirty pages that lie
217 * within the byte offsets <start, end> inclusive.
218 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
Randy Dunlap485bb992006-06-23 02:03:49 -0700220 * opposed to a regular memory cleansing writeback. The difference between
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 * these two operations is that if a dirty page/buffer is encountered, it must
222 * be waited upon, and not just skipped over.
223 */
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800224int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
225 loff_t end, int sync_mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226{
227 int ret;
228 struct writeback_control wbc = {
229 .sync_mode = sync_mode,
Nick Piggin05fe4782009-01-06 14:39:08 -0800230 .nr_to_write = LONG_MAX,
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700231 .range_start = start,
232 .range_end = end,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 };
234
235 if (!mapping_cap_writeback_dirty(mapping))
236 return 0;
237
238 ret = do_writepages(mapping, &wbc);
239 return ret;
240}
241
242static inline int __filemap_fdatawrite(struct address_space *mapping,
243 int sync_mode)
244{
OGAWA Hirofumi111ebb62006-06-23 02:03:26 -0700245 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246}
247
248int filemap_fdatawrite(struct address_space *mapping)
249{
250 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
251}
252EXPORT_SYMBOL(filemap_fdatawrite);
253
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400254int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
Andrew Mortonebcf28e2006-03-24 03:18:04 -0800255 loff_t end)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256{
257 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
258}
Jan Karaf4c0a0f2008-07-11 19:27:31 -0400259EXPORT_SYMBOL(filemap_fdatawrite_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
Randy Dunlap485bb992006-06-23 02:03:49 -0700261/**
262 * filemap_flush - mostly a non-blocking flush
263 * @mapping: target address_space
264 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 * This is a mostly non-blocking flush. Not suitable for data-integrity
266 * purposes - I/O may not be started against all dirty pages.
267 */
268int filemap_flush(struct address_space *mapping)
269{
270 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
271}
272EXPORT_SYMBOL(filemap_flush);
273
Randy Dunlap485bb992006-06-23 02:03:49 -0700274/**
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200275 * filemap_fdatawait_range - wait for writeback to complete
276 * @mapping: address space structure to wait for
277 * @start_byte: offset in bytes where the range starts
278 * @end_byte: offset in bytes where the range ends (inclusive)
Randy Dunlap485bb992006-06-23 02:03:49 -0700279 *
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200280 * Walk the list of under-writeback pages of the given address space
281 * in the given range and wait for all of them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 */
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200283int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
284 loff_t end_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200286 pgoff_t index = start_byte >> PAGE_CACHE_SHIFT;
287 pgoff_t end = end_byte >> PAGE_CACHE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 struct pagevec pvec;
289 int nr_pages;
290 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200292 if (end_byte < start_byte)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 return 0;
294
295 pagevec_init(&pvec, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 while ((index <= end) &&
297 (nr_pages = pagevec_lookup_tag(&pvec, mapping, &index,
298 PAGECACHE_TAG_WRITEBACK,
299 min(end - index, (pgoff_t)PAGEVEC_SIZE-1) + 1)) != 0) {
300 unsigned i;
301
302 for (i = 0; i < nr_pages; i++) {
303 struct page *page = pvec.pages[i];
304
305 /* until radix tree lookup accepts end_index */
306 if (page->index > end)
307 continue;
308
309 wait_on_page_writeback(page);
Rik van Riel212260a2011-01-13 15:46:06 -0800310 if (TestClearPageError(page))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 ret = -EIO;
312 }
313 pagevec_release(&pvec);
314 cond_resched();
315 }
316
317 /* Check for outstanding write errors */
318 if (test_and_clear_bit(AS_ENOSPC, &mapping->flags))
319 ret = -ENOSPC;
320 if (test_and_clear_bit(AS_EIO, &mapping->flags))
321 ret = -EIO;
322
323 return ret;
324}
Jan Karad3bccb6f2009-08-17 19:30:27 +0200325EXPORT_SYMBOL(filemap_fdatawait_range);
326
327/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700328 * filemap_fdatawait - wait for all under-writeback pages to complete
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 * @mapping: address space structure to wait for
Randy Dunlap485bb992006-06-23 02:03:49 -0700330 *
331 * Walk the list of under-writeback pages of the given address space
332 * and wait for all of them.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 */
334int filemap_fdatawait(struct address_space *mapping)
335{
336 loff_t i_size = i_size_read(mapping->host);
337
338 if (i_size == 0)
339 return 0;
340
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200341 return filemap_fdatawait_range(mapping, 0, i_size - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342}
343EXPORT_SYMBOL(filemap_fdatawait);
344
345int filemap_write_and_wait(struct address_space *mapping)
346{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800347 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 if (mapping->nrpages) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800350 err = filemap_fdatawrite(mapping);
351 /*
352 * Even if the above returned error, the pages may be
353 * written partially (e.g. -ENOSPC), so we wait for it.
354 * But the -EIO is special case, it may indicate the worst
355 * thing (e.g. bug) happened, so we avoid waiting for it.
356 */
357 if (err != -EIO) {
358 int err2 = filemap_fdatawait(mapping);
359 if (!err)
360 err = err2;
361 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800363 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364}
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800365EXPORT_SYMBOL(filemap_write_and_wait);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Randy Dunlap485bb992006-06-23 02:03:49 -0700367/**
368 * filemap_write_and_wait_range - write out & wait on a file range
369 * @mapping: the address_space for the pages
370 * @lstart: offset in bytes where the range starts
371 * @lend: offset in bytes where the range ends (inclusive)
372 *
Andrew Morton469eb4d2006-03-24 03:17:45 -0800373 * Write out and wait upon file offsets lstart->lend, inclusive.
374 *
375 * Note that `lend' is inclusive (describes the last byte to be written) so
376 * that this function can be used to write to the very end-of-file (end = -1).
377 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378int filemap_write_and_wait_range(struct address_space *mapping,
379 loff_t lstart, loff_t lend)
380{
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800381 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382
383 if (mapping->nrpages) {
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800384 err = __filemap_fdatawrite_range(mapping, lstart, lend,
385 WB_SYNC_ALL);
386 /* See comment of filemap_write_and_wait() */
387 if (err != -EIO) {
Christoph Hellwig94004ed2009-09-30 22:16:33 +0200388 int err2 = filemap_fdatawait_range(mapping,
389 lstart, lend);
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800390 if (!err)
391 err = err2;
392 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 }
OGAWA Hirofumi28fd1292006-01-08 01:02:14 -0800394 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395}
Chris Masonf6995582009-04-15 13:22:37 -0400396EXPORT_SYMBOL(filemap_write_and_wait_range);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
Randy Dunlap485bb992006-06-23 02:03:49 -0700398/**
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700399 * replace_page_cache_page - replace a pagecache page with a new one
400 * @old: page to be replaced
401 * @new: page to replace with
402 * @gfp_mask: allocation mode
403 *
404 * This function replaces a page in the pagecache with a new one. On
405 * success it acquires the pagecache reference for the new page and
406 * drops it for the old page. Both the old and new pages must be
407 * locked. This function does not add the new page to the LRU, the
408 * caller must do that.
409 *
410 * The remove + add is atomic. The only way this function can fail is
411 * memory allocation failure.
412 */
413int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
414{
415 int error;
416 struct mem_cgroup *memcg = NULL;
417
418 VM_BUG_ON(!PageLocked(old));
419 VM_BUG_ON(!PageLocked(new));
420 VM_BUG_ON(new->mapping);
421
422 /*
423 * This is not page migration, but prepare_migration and
424 * end_migration does enough work for charge replacement.
425 *
426 * In the longer term we probably want a specialized function
427 * for moving the charge from old to new in a more efficient
428 * manner.
429 */
430 error = mem_cgroup_prepare_migration(old, new, &memcg, gfp_mask);
431 if (error)
432 return error;
433
434 error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
435 if (!error) {
436 struct address_space *mapping = old->mapping;
437 void (*freepage)(struct page *);
438
439 pgoff_t offset = old->index;
440 freepage = mapping->a_ops->freepage;
441
442 page_cache_get(new);
443 new->mapping = mapping;
444 new->index = offset;
445
446 spin_lock_irq(&mapping->tree_lock);
Minchan Kime64a7822011-03-22 16:32:44 -0700447 __delete_from_page_cache(old);
Miklos Szeredief6a3c62011-03-22 16:30:52 -0700448 error = radix_tree_insert(&mapping->page_tree, offset, new);
449 BUG_ON(error);
450 mapping->nrpages++;
451 __inc_zone_page_state(new, NR_FILE_PAGES);
452 if (PageSwapBacked(new))
453 __inc_zone_page_state(new, NR_SHMEM);
454 spin_unlock_irq(&mapping->tree_lock);
455 radix_tree_preload_end();
456 if (freepage)
457 freepage(old);
458 page_cache_release(old);
459 mem_cgroup_end_migration(memcg, old, new, true);
460 } else {
461 mem_cgroup_end_migration(memcg, old, new, false);
462 }
463
464 return error;
465}
466EXPORT_SYMBOL_GPL(replace_page_cache_page);
467
468/**
Nick Piggine2867812008-07-25 19:45:30 -0700469 * add_to_page_cache_locked - add a locked page to the pagecache
Randy Dunlap485bb992006-06-23 02:03:49 -0700470 * @page: page to add
471 * @mapping: the page's address_space
472 * @offset: page index
473 * @gfp_mask: page allocation mode
474 *
Nick Piggine2867812008-07-25 19:45:30 -0700475 * This function is used to add a page to the pagecache. It must be locked.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 * This function does not add the page to the LRU. The caller must do that.
477 */
Nick Piggine2867812008-07-25 19:45:30 -0700478int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400479 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480{
Nick Piggine2867812008-07-25 19:45:30 -0700481 int error;
482
483 VM_BUG_ON(!PageLocked(page));
484
485 error = mem_cgroup_cache_charge(page, current->mm,
KAMEZAWA Hiroyuki2c26fdd2009-01-07 18:08:10 -0800486 gfp_mask & GFP_RECLAIM_MASK);
Balbir Singh35c754d2008-02-07 00:14:05 -0800487 if (error)
488 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
Balbir Singh35c754d2008-02-07 00:14:05 -0800490 error = radix_tree_preload(gfp_mask & ~__GFP_HIGHMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 if (error == 0) {
Nick Piggine2867812008-07-25 19:45:30 -0700492 page_cache_get(page);
493 page->mapping = mapping;
494 page->index = offset;
495
Nick Piggin19fd6232008-07-25 19:45:32 -0700496 spin_lock_irq(&mapping->tree_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 error = radix_tree_insert(&mapping->page_tree, offset, page);
Nick Piggine2867812008-07-25 19:45:30 -0700498 if (likely(!error)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 mapping->nrpages++;
Christoph Lameter347ce432006-06-30 01:55:35 -0700500 __inc_zone_page_state(page, NR_FILE_PAGES);
KOSAKI Motohiro4b021082009-09-21 17:01:33 -0700501 if (PageSwapBacked(page))
502 __inc_zone_page_state(page, NR_SHMEM);
Daisuke Nishimurae767e052009-05-28 14:34:28 -0700503 spin_unlock_irq(&mapping->tree_lock);
Nick Piggine2867812008-07-25 19:45:30 -0700504 } else {
505 page->mapping = NULL;
Daisuke Nishimurae767e052009-05-28 14:34:28 -0700506 spin_unlock_irq(&mapping->tree_lock);
KAMEZAWA Hiroyuki69029cd2008-07-25 01:47:14 -0700507 mem_cgroup_uncharge_cache_page(page);
Nick Piggine2867812008-07-25 19:45:30 -0700508 page_cache_release(page);
509 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 radix_tree_preload_end();
Balbir Singh35c754d2008-02-07 00:14:05 -0800511 } else
KAMEZAWA Hiroyuki69029cd2008-07-25 01:47:14 -0700512 mem_cgroup_uncharge_cache_page(page);
Balbir Singh8a9f3cc2008-02-07 00:13:53 -0800513out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 return error;
515}
Nick Piggine2867812008-07-25 19:45:30 -0700516EXPORT_SYMBOL(add_to_page_cache_locked);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
Al Viro6daa0e22005-10-21 03:18:50 -0400519 pgoff_t offset, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520{
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700521 int ret;
522
523 /*
524 * Splice_read and readahead add shmem/tmpfs pages into the page cache
525 * before shmem_readpage has a chance to mark them as SwapBacked: they
KOSAKI Motohiroe9d6c152010-05-24 14:31:48 -0700526 * need to go on the anon lru below, and mem_cgroup_cache_charge
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700527 * (called in add_to_page_cache) needs to know where they're going too.
528 */
529 if (mapping_cap_swap_backed(mapping))
530 SetPageSwapBacked(page);
531
532 ret = add_to_page_cache(page, mapping, offset, gfp_mask);
533 if (ret == 0) {
534 if (page_is_file_cache(page))
535 lru_cache_add_file(page);
536 else
KOSAKI Motohiroe9d6c152010-05-24 14:31:48 -0700537 lru_cache_add_anon(page);
Rik van Riel4f98a2f2008-10-18 20:26:32 -0700538 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 return ret;
540}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300541EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Paul Jackson44110fe2006-03-24 03:16:04 -0800543#ifdef CONFIG_NUMA
Nick Piggin2ae88142006-10-28 10:38:23 -0700544struct page *__page_cache_alloc(gfp_t gfp)
Paul Jackson44110fe2006-03-24 03:16:04 -0800545{
Miao Xiec0ff7452010-05-24 14:32:08 -0700546 int n;
547 struct page *page;
548
Paul Jackson44110fe2006-03-24 03:16:04 -0800549 if (cpuset_do_page_mem_spread()) {
Miao Xiec0ff7452010-05-24 14:32:08 -0700550 get_mems_allowed();
551 n = cpuset_mem_spread_node();
552 page = alloc_pages_exact_node(n, gfp, 0);
553 put_mems_allowed();
554 return page;
Paul Jackson44110fe2006-03-24 03:16:04 -0800555 }
Nick Piggin2ae88142006-10-28 10:38:23 -0700556 return alloc_pages(gfp, 0);
Paul Jackson44110fe2006-03-24 03:16:04 -0800557}
Nick Piggin2ae88142006-10-28 10:38:23 -0700558EXPORT_SYMBOL(__page_cache_alloc);
Paul Jackson44110fe2006-03-24 03:16:04 -0800559#endif
560
Nick Piggindb376482006-09-25 23:31:24 -0700561static int __sleep_on_page_lock(void *word)
562{
563 io_schedule();
564 return 0;
565}
566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567/*
568 * In order to wait for pages to become available there must be
569 * waitqueues associated with pages. By using a hash table of
570 * waitqueues where the bucket discipline is to maintain all
571 * waiters on the same queue and wake all when any of the pages
572 * become available, and for the woken contexts to check to be
573 * sure the appropriate page became available, this saves space
574 * at a cost of "thundering herd" phenomena during rare hash
575 * collisions.
576 */
577static wait_queue_head_t *page_waitqueue(struct page *page)
578{
579 const struct zone *zone = page_zone(page);
580
581 return &zone->wait_table[hash_ptr(page, zone->wait_table_bits)];
582}
583
584static inline void wake_up_page(struct page *page, int bit)
585{
586 __wake_up_bit(page_waitqueue(page), &page->flags, bit);
587}
588
Harvey Harrison920c7a52008-02-04 22:29:26 -0800589void wait_on_page_bit(struct page *page, int bit_nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590{
591 DEFINE_WAIT_BIT(wait, &page->flags, bit_nr);
592
593 if (test_bit(bit_nr, &page->flags))
594 __wait_on_bit(page_waitqueue(page), &wait, sync_page,
595 TASK_UNINTERRUPTIBLE);
596}
597EXPORT_SYMBOL(wait_on_page_bit);
598
599/**
David Howells385e1ca5f2009-04-03 16:42:39 +0100600 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
Randy Dunlap697f6192009-04-13 14:39:54 -0700601 * @page: Page defining the wait queue of interest
602 * @waiter: Waiter to add to the queue
David Howells385e1ca5f2009-04-03 16:42:39 +0100603 *
604 * Add an arbitrary @waiter to the wait queue for the nominated @page.
605 */
606void add_page_wait_queue(struct page *page, wait_queue_t *waiter)
607{
608 wait_queue_head_t *q = page_waitqueue(page);
609 unsigned long flags;
610
611 spin_lock_irqsave(&q->lock, flags);
612 __add_wait_queue(q, waiter);
613 spin_unlock_irqrestore(&q->lock, flags);
614}
615EXPORT_SYMBOL_GPL(add_page_wait_queue);
616
617/**
Randy Dunlap485bb992006-06-23 02:03:49 -0700618 * unlock_page - unlock a locked page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 * @page: the page
620 *
621 * Unlocks the page and wakes up sleepers in ___wait_on_page_locked().
622 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
623 * mechananism between PageLocked pages and PageWriteback pages is shared.
624 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
625 *
Nick Piggin8413ac92008-10-18 20:26:59 -0700626 * The mb is necessary to enforce ordering between the clear_bit and the read
627 * of the waitqueue (to avoid SMP races with a parallel wait_on_page_locked()).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 */
Harvey Harrison920c7a52008-02-04 22:29:26 -0800629void unlock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630{
Nick Piggin8413ac92008-10-18 20:26:59 -0700631 VM_BUG_ON(!PageLocked(page));
632 clear_bit_unlock(PG_locked, &page->flags);
633 smp_mb__after_clear_bit();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 wake_up_page(page, PG_locked);
635}
636EXPORT_SYMBOL(unlock_page);
637
Randy Dunlap485bb992006-06-23 02:03:49 -0700638/**
639 * end_page_writeback - end writeback against a page
640 * @page: the page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 */
642void end_page_writeback(struct page *page)
643{
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700644 if (TestClearPageReclaim(page))
645 rotate_reclaimable_page(page);
646
647 if (!test_clear_page_writeback(page))
648 BUG();
649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 smp_mb__after_clear_bit();
651 wake_up_page(page, PG_writeback);
652}
653EXPORT_SYMBOL(end_page_writeback);
654
Randy Dunlap485bb992006-06-23 02:03:49 -0700655/**
656 * __lock_page - get a lock on the page, assuming we need to sleep to get it
657 * @page: the page to lock
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 *
Randy Dunlap485bb992006-06-23 02:03:49 -0700659 * Ugly. Running sync_page() in state TASK_UNINTERRUPTIBLE is scary. If some
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 * random driver's requestfn sets TASK_RUNNING, we could busywait. However
661 * chances are that on the second loop, the block layer's plug list is empty,
662 * so sync_page() will then return in state TASK_UNINTERRUPTIBLE.
663 */
Harvey Harrison920c7a52008-02-04 22:29:26 -0800664void __lock_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
666 DEFINE_WAIT_BIT(wait, &page->flags, PG_locked);
667
668 __wait_on_bit_lock(page_waitqueue(page), &wait, sync_page,
669 TASK_UNINTERRUPTIBLE);
670}
671EXPORT_SYMBOL(__lock_page);
672
Harvey Harrisonb5606c22008-02-13 15:03:16 -0800673int __lock_page_killable(struct page *page)
Matthew Wilcox2687a352007-12-06 11:18:49 -0500674{
675 DEFINE_WAIT_BIT(wait, &page->flags, PG_locked);
676
677 return __wait_on_bit_lock(page_waitqueue(page), &wait,
678 sync_page_killable, TASK_KILLABLE);
679}
Evgeniy Polyakov18bc0bb2009-02-09 17:02:42 +0300680EXPORT_SYMBOL_GPL(__lock_page_killable);
Matthew Wilcox2687a352007-12-06 11:18:49 -0500681
Randy Dunlap76824862008-03-19 17:00:40 -0700682/**
683 * __lock_page_nosync - get a lock on the page, without calling sync_page()
684 * @page: the page to lock
685 *
Nick Piggindb376482006-09-25 23:31:24 -0700686 * Variant of lock_page that does not require the caller to hold a reference
687 * on the page's mapping.
688 */
Harvey Harrison920c7a52008-02-04 22:29:26 -0800689void __lock_page_nosync(struct page *page)
Nick Piggindb376482006-09-25 23:31:24 -0700690{
691 DEFINE_WAIT_BIT(wait, &page->flags, PG_locked);
692 __wait_on_bit_lock(page_waitqueue(page), &wait, __sleep_on_page_lock,
693 TASK_UNINTERRUPTIBLE);
694}
695
Michel Lespinassed065bd82010-10-26 14:21:57 -0700696int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
697 unsigned int flags)
698{
699 if (!(flags & FAULT_FLAG_ALLOW_RETRY)) {
700 __lock_page(page);
701 return 1;
702 } else {
Gleb Natapov318b2752011-03-22 16:30:51 -0700703 if (!(flags & FAULT_FLAG_RETRY_NOWAIT)) {
704 up_read(&mm->mmap_sem);
705 wait_on_page_locked(page);
706 }
Michel Lespinassed065bd82010-10-26 14:21:57 -0700707 return 0;
708 }
709}
710
Randy Dunlap485bb992006-06-23 02:03:49 -0700711/**
712 * find_get_page - find and get a page reference
713 * @mapping: the address_space to search
714 * @offset: the page index
715 *
Nick Pigginda6052f2006-09-25 23:31:35 -0700716 * Is there a pagecache struct page at the given (mapping, offset) tuple?
717 * If yes, increment its refcount and return it; if no, return NULL.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 */
Nick Piggina60637c2008-07-25 19:45:31 -0700719struct page *find_get_page(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720{
Nick Piggina60637c2008-07-25 19:45:31 -0700721 void **pagep;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 struct page *page;
723
Nick Piggina60637c2008-07-25 19:45:31 -0700724 rcu_read_lock();
725repeat:
726 page = NULL;
727 pagep = radix_tree_lookup_slot(&mapping->page_tree, offset);
728 if (pagep) {
729 page = radix_tree_deref_slot(pagep);
Nick Piggin27d20fd2010-11-11 14:05:19 -0800730 if (unlikely(!page))
731 goto out;
732 if (radix_tree_deref_retry(page))
Nick Piggina60637c2008-07-25 19:45:31 -0700733 goto repeat;
734
735 if (!page_cache_get_speculative(page))
736 goto repeat;
737
738 /*
739 * Has the page moved?
740 * This is part of the lockless pagecache protocol. See
741 * include/linux/pagemap.h for details.
742 */
743 if (unlikely(page != *pagep)) {
744 page_cache_release(page);
745 goto repeat;
746 }
747 }
Nick Piggin27d20fd2010-11-11 14:05:19 -0800748out:
Nick Piggina60637c2008-07-25 19:45:31 -0700749 rcu_read_unlock();
750
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 return page;
752}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753EXPORT_SYMBOL(find_get_page);
754
Randy Dunlap485bb992006-06-23 02:03:49 -0700755/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 * find_lock_page - locate, pin and lock a pagecache page
Martin Waitz67be2dd2005-05-01 08:59:26 -0700757 * @mapping: the address_space to search
758 * @offset: the page index
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 *
760 * Locates the desired pagecache page, locks it, increments its reference
761 * count and returns its address.
762 *
763 * Returns zero if the page was not present. find_lock_page() may sleep.
764 */
Nick Piggina60637c2008-07-25 19:45:31 -0700765struct page *find_lock_page(struct address_space *mapping, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766{
767 struct page *page;
768
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769repeat:
Nick Piggina60637c2008-07-25 19:45:31 -0700770 page = find_get_page(mapping, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 if (page) {
Nick Piggina60637c2008-07-25 19:45:31 -0700772 lock_page(page);
773 /* Has the page been truncated? */
774 if (unlikely(page->mapping != mapping)) {
775 unlock_page(page);
776 page_cache_release(page);
777 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 }
Nick Piggina60637c2008-07-25 19:45:31 -0700779 VM_BUG_ON(page->index != offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 return page;
782}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783EXPORT_SYMBOL(find_lock_page);
784
785/**
786 * find_or_create_page - locate or add a pagecache page
Martin Waitz67be2dd2005-05-01 08:59:26 -0700787 * @mapping: the page's address_space
788 * @index: the page's index into the mapping
789 * @gfp_mask: page allocation mode
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790 *
791 * Locates a page in the pagecache. If the page is not present, a new page
792 * is allocated using @gfp_mask and is added to the pagecache and to the VM's
793 * LRU list. The returned page is locked and has its reference count
794 * incremented.
795 *
796 * find_or_create_page() may sleep, even if @gfp_flags specifies an atomic
797 * allocation!
798 *
799 * find_or_create_page() returns the desired page's address, or zero on
800 * memory exhaustion.
801 */
802struct page *find_or_create_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -0700803 pgoff_t index, gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804{
Nick Piggineb2be182007-10-16 01:24:57 -0700805 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 int err;
807repeat:
808 page = find_lock_page(mapping, index);
809 if (!page) {
Nick Piggineb2be182007-10-16 01:24:57 -0700810 page = __page_cache_alloc(gfp_mask);
811 if (!page)
812 return NULL;
Nick Piggin67d58ac2009-01-06 14:40:28 -0800813 /*
814 * We want a regular kernel memory (not highmem or DMA etc)
815 * allocation for the radix tree nodes, but we need to honour
816 * the context-specific requirements the caller has asked for.
817 * GFP_RECLAIM_MASK collects those requirements.
818 */
819 err = add_to_page_cache_lru(page, mapping, index,
820 (gfp_mask & GFP_RECLAIM_MASK));
Nick Piggineb2be182007-10-16 01:24:57 -0700821 if (unlikely(err)) {
822 page_cache_release(page);
823 page = NULL;
824 if (err == -EEXIST)
825 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 return page;
829}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830EXPORT_SYMBOL(find_or_create_page);
831
832/**
833 * find_get_pages - gang pagecache lookup
834 * @mapping: The address_space to search
835 * @start: The starting page index
836 * @nr_pages: The maximum number of pages
837 * @pages: Where the resulting pages are placed
838 *
839 * find_get_pages() will search for and return a group of up to
840 * @nr_pages pages in the mapping. The pages are placed at @pages.
841 * find_get_pages() takes a reference against the returned pages.
842 *
843 * The search returns a group of mapping-contiguous pages with ascending
844 * indexes. There may be holes in the indices due to not-present pages.
845 *
846 * find_get_pages() returns the number of pages which were found.
847 */
848unsigned find_get_pages(struct address_space *mapping, pgoff_t start,
849 unsigned int nr_pages, struct page **pages)
850{
851 unsigned int i;
852 unsigned int ret;
Nick Piggina60637c2008-07-25 19:45:31 -0700853 unsigned int nr_found;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854
Nick Piggina60637c2008-07-25 19:45:31 -0700855 rcu_read_lock();
856restart:
857 nr_found = radix_tree_gang_lookup_slot(&mapping->page_tree,
858 (void ***)pages, start, nr_pages);
859 ret = 0;
860 for (i = 0; i < nr_found; i++) {
861 struct page *page;
862repeat:
863 page = radix_tree_deref_slot((void **)pages[i]);
864 if (unlikely(!page))
865 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -0700866
867 /*
868 * This can only trigger when the entry at index 0 moves out
869 * of or back to the root: none yet gotten, safe to restart.
870 */
Nick Piggin27d20fd2010-11-11 14:05:19 -0800871 if (radix_tree_deref_retry(page)) {
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -0700872 WARN_ON(start | i);
Nick Piggina60637c2008-07-25 19:45:31 -0700873 goto restart;
Nick Piggin27d20fd2010-11-11 14:05:19 -0800874 }
Nick Piggina60637c2008-07-25 19:45:31 -0700875
876 if (!page_cache_get_speculative(page))
877 goto repeat;
878
879 /* Has the page moved? */
880 if (unlikely(page != *((void **)pages[i]))) {
881 page_cache_release(page);
882 goto repeat;
883 }
884
885 pages[ret] = page;
886 ret++;
887 }
888 rcu_read_unlock();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 return ret;
890}
891
Jens Axboeebf43502006-04-27 08:46:01 +0200892/**
893 * find_get_pages_contig - gang contiguous pagecache lookup
894 * @mapping: The address_space to search
895 * @index: The starting page index
896 * @nr_pages: The maximum number of pages
897 * @pages: Where the resulting pages are placed
898 *
899 * find_get_pages_contig() works exactly like find_get_pages(), except
900 * that the returned number of pages are guaranteed to be contiguous.
901 *
902 * find_get_pages_contig() returns the number of pages which were found.
903 */
904unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
905 unsigned int nr_pages, struct page **pages)
906{
907 unsigned int i;
908 unsigned int ret;
Nick Piggina60637c2008-07-25 19:45:31 -0700909 unsigned int nr_found;
Jens Axboeebf43502006-04-27 08:46:01 +0200910
Nick Piggina60637c2008-07-25 19:45:31 -0700911 rcu_read_lock();
912restart:
913 nr_found = radix_tree_gang_lookup_slot(&mapping->page_tree,
914 (void ***)pages, index, nr_pages);
915 ret = 0;
916 for (i = 0; i < nr_found; i++) {
917 struct page *page;
918repeat:
919 page = radix_tree_deref_slot((void **)pages[i]);
920 if (unlikely(!page))
921 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -0700922
923 /*
924 * This can only trigger when the entry at index 0 moves out
925 * of or back to the root: none yet gotten, safe to restart.
926 */
Nick Piggin27d20fd2010-11-11 14:05:19 -0800927 if (radix_tree_deref_retry(page))
Nick Piggina60637c2008-07-25 19:45:31 -0700928 goto restart;
929
Nick Piggina60637c2008-07-25 19:45:31 -0700930 if (!page_cache_get_speculative(page))
931 goto repeat;
932
933 /* Has the page moved? */
934 if (unlikely(page != *((void **)pages[i]))) {
935 page_cache_release(page);
936 goto repeat;
937 }
938
Nick Piggin9cbb4cb2011-01-13 15:45:51 -0800939 /*
940 * must check mapping and index after taking the ref.
941 * otherwise we can get both false positives and false
942 * negatives, which is just confusing to the caller.
943 */
944 if (page->mapping == NULL || page->index != index) {
945 page_cache_release(page);
946 break;
947 }
948
Nick Piggina60637c2008-07-25 19:45:31 -0700949 pages[ret] = page;
950 ret++;
Jens Axboeebf43502006-04-27 08:46:01 +0200951 index++;
952 }
Nick Piggina60637c2008-07-25 19:45:31 -0700953 rcu_read_unlock();
954 return ret;
Jens Axboeebf43502006-04-27 08:46:01 +0200955}
David Howellsef71c152007-05-09 02:33:44 -0700956EXPORT_SYMBOL(find_get_pages_contig);
Jens Axboeebf43502006-04-27 08:46:01 +0200957
Randy Dunlap485bb992006-06-23 02:03:49 -0700958/**
959 * find_get_pages_tag - find and return pages that match @tag
960 * @mapping: the address_space to search
961 * @index: the starting page index
962 * @tag: the tag index
963 * @nr_pages: the maximum number of pages
964 * @pages: where the resulting pages are placed
965 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700966 * Like find_get_pages, except we only return pages which are tagged with
Randy Dunlap485bb992006-06-23 02:03:49 -0700967 * @tag. We update @index to index the next page for the traversal.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 */
969unsigned find_get_pages_tag(struct address_space *mapping, pgoff_t *index,
970 int tag, unsigned int nr_pages, struct page **pages)
971{
972 unsigned int i;
973 unsigned int ret;
Nick Piggina60637c2008-07-25 19:45:31 -0700974 unsigned int nr_found;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Nick Piggina60637c2008-07-25 19:45:31 -0700976 rcu_read_lock();
977restart:
978 nr_found = radix_tree_gang_lookup_tag_slot(&mapping->page_tree,
979 (void ***)pages, *index, nr_pages, tag);
980 ret = 0;
981 for (i = 0; i < nr_found; i++) {
982 struct page *page;
983repeat:
984 page = radix_tree_deref_slot((void **)pages[i]);
985 if (unlikely(!page))
986 continue;
Hugh Dickins9d8aa4e2011-03-22 16:33:06 -0700987
988 /*
989 * This can only trigger when the entry at index 0 moves out
990 * of or back to the root: none yet gotten, safe to restart.
991 */
Nick Piggin27d20fd2010-11-11 14:05:19 -0800992 if (radix_tree_deref_retry(page))
Nick Piggina60637c2008-07-25 19:45:31 -0700993 goto restart;
994
995 if (!page_cache_get_speculative(page))
996 goto repeat;
997
998 /* Has the page moved? */
999 if (unlikely(page != *((void **)pages[i]))) {
1000 page_cache_release(page);
1001 goto repeat;
1002 }
1003
1004 pages[ret] = page;
1005 ret++;
1006 }
1007 rcu_read_unlock();
1008
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 if (ret)
1010 *index = pages[ret - 1]->index + 1;
Nick Piggina60637c2008-07-25 19:45:31 -07001011
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012 return ret;
1013}
David Howellsef71c152007-05-09 02:33:44 -07001014EXPORT_SYMBOL(find_get_pages_tag);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015
Randy Dunlap485bb992006-06-23 02:03:49 -07001016/**
1017 * grab_cache_page_nowait - returns locked page at given index in given cache
1018 * @mapping: target address_space
1019 * @index: the page index
1020 *
Robert P. J. Day72fd4a32007-02-10 01:45:59 -08001021 * Same as grab_cache_page(), but do not wait if the page is unavailable.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022 * This is intended for speculative data generators, where the data can
1023 * be regenerated if the page couldn't be grabbed. This routine should
1024 * be safe to call while holding the lock for another page.
1025 *
1026 * Clear __GFP_FS when allocating the page to avoid recursion into the fs
1027 * and deadlock against the caller's locked page.
1028 */
1029struct page *
Fengguang Wu57f6b962007-10-16 01:24:37 -07001030grab_cache_page_nowait(struct address_space *mapping, pgoff_t index)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031{
1032 struct page *page = find_get_page(mapping, index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033
1034 if (page) {
Nick Piggin529ae9a2008-08-02 12:01:03 +02001035 if (trylock_page(page))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 return page;
1037 page_cache_release(page);
1038 return NULL;
1039 }
Nick Piggin2ae88142006-10-28 10:38:23 -07001040 page = __page_cache_alloc(mapping_gfp_mask(mapping) & ~__GFP_FS);
Nick Piggin67d58ac2009-01-06 14:40:28 -08001041 if (page && add_to_page_cache_lru(page, mapping, index, GFP_NOFS)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 page_cache_release(page);
1043 page = NULL;
1044 }
1045 return page;
1046}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001047EXPORT_SYMBOL(grab_cache_page_nowait);
1048
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001049/*
1050 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
1051 * a _large_ part of the i/o request. Imagine the worst scenario:
1052 *
1053 * ---R__________________________________________B__________
1054 * ^ reading here ^ bad block(assume 4k)
1055 *
1056 * read(R) => miss => readahead(R...B) => media error => frustrating retries
1057 * => failing the whole request => read(R) => read(R+1) =>
1058 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
1059 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
1060 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
1061 *
1062 * It is going insane. Fix it by quickly scaling down the readahead size.
1063 */
1064static void shrink_readahead_size_eio(struct file *filp,
1065 struct file_ra_state *ra)
1066{
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001067 ra->ra_pages /= 4;
Wu Fengguang76d42bd2006-06-25 05:48:43 -07001068}
1069
Randy Dunlap485bb992006-06-23 02:03:49 -07001070/**
Christoph Hellwig36e78912008-02-08 04:21:24 -08001071 * do_generic_file_read - generic file read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07001072 * @filp: the file to read
1073 * @ppos: current file position
1074 * @desc: read_descriptor
1075 * @actor: read method
1076 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 * This is a generic file read routine, and uses the
Randy Dunlap485bb992006-06-23 02:03:49 -07001078 * mapping->a_ops->readpage() function for the actual low-level stuff.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079 *
1080 * This is really ugly. But the goto's actually try to clarify some
1081 * of the logic when it comes to error handling etc.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 */
Christoph Hellwig36e78912008-02-08 04:21:24 -08001083static void do_generic_file_read(struct file *filp, loff_t *ppos,
1084 read_descriptor_t *desc, read_actor_t actor)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085{
Christoph Hellwig36e78912008-02-08 04:21:24 -08001086 struct address_space *mapping = filp->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 struct inode *inode = mapping->host;
Christoph Hellwig36e78912008-02-08 04:21:24 -08001088 struct file_ra_state *ra = &filp->f_ra;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001089 pgoff_t index;
1090 pgoff_t last_index;
1091 pgoff_t prev_index;
1092 unsigned long offset; /* offset into pagecache page */
Jan Karaec0f1632007-05-06 14:49:25 -07001093 unsigned int prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 int error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 index = *ppos >> PAGE_CACHE_SHIFT;
Fengguang Wu7ff81072007-10-16 01:24:35 -07001097 prev_index = ra->prev_pos >> PAGE_CACHE_SHIFT;
1098 prev_offset = ra->prev_pos & (PAGE_CACHE_SIZE-1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 last_index = (*ppos + desc->count + PAGE_CACHE_SIZE-1) >> PAGE_CACHE_SHIFT;
1100 offset = *ppos & ~PAGE_CACHE_MASK;
1101
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102 for (;;) {
1103 struct page *page;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001104 pgoff_t end_index;
NeilBrowna32ea1e2007-07-17 04:03:04 -07001105 loff_t isize;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001106 unsigned long nr, ret;
1107
Linus Torvalds1da177e2005-04-16 15:20:36 -07001108 cond_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109find_page:
1110 page = find_get_page(mapping, index);
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001111 if (!page) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001112 page_cache_sync_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001113 ra, filp,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001114 index, last_index - index);
1115 page = find_get_page(mapping, index);
1116 if (unlikely(page == NULL))
1117 goto no_cached_page;
1118 }
1119 if (PageReadahead(page)) {
Rusty Russellcf914a72007-07-19 01:48:08 -07001120 page_cache_async_readahead(mapping,
Fengguang Wu7ff81072007-10-16 01:24:35 -07001121 ra, filp, page,
Fengguang Wu3ea89ee2007-07-19 01:48:02 -07001122 index, last_index - index);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 }
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001124 if (!PageUptodate(page)) {
1125 if (inode->i_blkbits == PAGE_CACHE_SHIFT ||
1126 !mapping->a_ops->is_partially_uptodate)
1127 goto page_not_up_to_date;
Nick Piggin529ae9a2008-08-02 12:01:03 +02001128 if (!trylock_page(page))
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001129 goto page_not_up_to_date;
Dave Hansen8d056cb2010-11-11 14:05:15 -08001130 /* Did it get truncated before we got the lock? */
1131 if (!page->mapping)
1132 goto page_not_up_to_date_locked;
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001133 if (!mapping->a_ops->is_partially_uptodate(page,
1134 desc, offset))
1135 goto page_not_up_to_date_locked;
1136 unlock_page(page);
1137 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138page_ok:
NeilBrowna32ea1e2007-07-17 04:03:04 -07001139 /*
1140 * i_size must be checked after we know the page is Uptodate.
1141 *
1142 * Checking i_size after the check allows us to calculate
1143 * the correct value for "nr", which means the zero-filled
1144 * part of the page is not copied back to userspace (unless
1145 * another truncate extends the file - this is desired though).
1146 */
1147
1148 isize = i_size_read(inode);
1149 end_index = (isize - 1) >> PAGE_CACHE_SHIFT;
1150 if (unlikely(!isize || index > end_index)) {
1151 page_cache_release(page);
1152 goto out;
1153 }
1154
1155 /* nr is the maximum number of bytes to copy from this page */
1156 nr = PAGE_CACHE_SIZE;
1157 if (index == end_index) {
1158 nr = ((isize - 1) & ~PAGE_CACHE_MASK) + 1;
1159 if (nr <= offset) {
1160 page_cache_release(page);
1161 goto out;
1162 }
1163 }
1164 nr = nr - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
1166 /* If users can be writing to this page using arbitrary
1167 * virtual addresses, take care about potential aliasing
1168 * before reading the page on the kernel side.
1169 */
1170 if (mapping_writably_mapped(mapping))
1171 flush_dcache_page(page);
1172
1173 /*
Jan Karaec0f1632007-05-06 14:49:25 -07001174 * When a sequential read accesses a page several times,
1175 * only mark it as accessed the first time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176 */
Jan Karaec0f1632007-05-06 14:49:25 -07001177 if (prev_index != index || offset != prev_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178 mark_page_accessed(page);
1179 prev_index = index;
1180
1181 /*
1182 * Ok, we have the page, and it's up-to-date, so
1183 * now we can copy it to user space...
1184 *
1185 * The actor routine returns how many bytes were actually used..
1186 * NOTE! This may not be the same as how much of a user buffer
1187 * we filled up (we may be padding etc), so we can only update
1188 * "pos" here (the actor routine has to update the user buffer
1189 * pointers and the remaining count).
1190 */
1191 ret = actor(desc, page, offset, nr);
1192 offset += ret;
1193 index += offset >> PAGE_CACHE_SHIFT;
1194 offset &= ~PAGE_CACHE_MASK;
Jan Kara6ce745e2007-05-06 14:49:26 -07001195 prev_offset = offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001196
1197 page_cache_release(page);
1198 if (ret == nr && desc->count)
1199 continue;
1200 goto out;
1201
1202page_not_up_to_date:
1203 /* Get exclusive access to the page ... */
Oleg Nesterov85462322008-06-08 21:20:43 +04001204 error = lock_page_killable(page);
1205 if (unlikely(error))
1206 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207
Hisashi Hifumi8ab22b92008-07-28 15:46:36 -07001208page_not_up_to_date_locked:
Nick Pigginda6052f2006-09-25 23:31:35 -07001209 /* Did it get truncated before we got the lock? */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 if (!page->mapping) {
1211 unlock_page(page);
1212 page_cache_release(page);
1213 continue;
1214 }
1215
1216 /* Did somebody else fill it already? */
1217 if (PageUptodate(page)) {
1218 unlock_page(page);
1219 goto page_ok;
1220 }
1221
1222readpage:
Jeff Moyer91803b42010-05-26 11:49:40 -04001223 /*
1224 * A previous I/O error may have been due to temporary
1225 * failures, eg. multipath errors.
1226 * PG_error will be set again if readpage fails.
1227 */
1228 ClearPageError(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 /* Start the actual read. The read will unlock the page. */
1230 error = mapping->a_ops->readpage(filp, page);
1231
Zach Brown994fc28c2005-12-15 14:28:17 -08001232 if (unlikely(error)) {
1233 if (error == AOP_TRUNCATED_PAGE) {
1234 page_cache_release(page);
1235 goto find_page;
1236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 goto readpage_error;
Zach Brown994fc28c2005-12-15 14:28:17 -08001238 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
1240 if (!PageUptodate(page)) {
Oleg Nesterov85462322008-06-08 21:20:43 +04001241 error = lock_page_killable(page);
1242 if (unlikely(error))
1243 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 if (!PageUptodate(page)) {
1245 if (page->mapping == NULL) {
1246 /*
Christoph Hellwig2ecdc822010-01-26 17:27:20 +01001247 * invalidate_mapping_pages got it
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 */
1249 unlock_page(page);
1250 page_cache_release(page);
1251 goto find_page;
1252 }
1253 unlock_page(page);
Fengguang Wu7ff81072007-10-16 01:24:35 -07001254 shrink_readahead_size_eio(filp, ra);
Oleg Nesterov85462322008-06-08 21:20:43 +04001255 error = -EIO;
1256 goto readpage_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001257 }
1258 unlock_page(page);
1259 }
1260
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 goto page_ok;
1262
1263readpage_error:
1264 /* UHHUH! A synchronous read error occurred. Report it */
1265 desc->error = error;
1266 page_cache_release(page);
1267 goto out;
1268
1269no_cached_page:
1270 /*
1271 * Ok, it wasn't cached, so we need to create a new
1272 * page..
1273 */
Nick Piggineb2be182007-10-16 01:24:57 -07001274 page = page_cache_alloc_cold(mapping);
1275 if (!page) {
1276 desc->error = -ENOMEM;
1277 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 }
Nick Piggineb2be182007-10-16 01:24:57 -07001279 error = add_to_page_cache_lru(page, mapping,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 index, GFP_KERNEL);
1281 if (error) {
Nick Piggineb2be182007-10-16 01:24:57 -07001282 page_cache_release(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001283 if (error == -EEXIST)
1284 goto find_page;
1285 desc->error = error;
1286 goto out;
1287 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 goto readpage;
1289 }
1290
1291out:
Fengguang Wu7ff81072007-10-16 01:24:35 -07001292 ra->prev_pos = prev_index;
1293 ra->prev_pos <<= PAGE_CACHE_SHIFT;
1294 ra->prev_pos |= prev_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001295
Fengguang Wuf4e6b492007-10-16 01:24:33 -07001296 *ppos = ((loff_t)index << PAGE_CACHE_SHIFT) + offset;
Krishna Kumar0c6aa262008-10-15 22:01:13 -07001297 file_accessed(filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299
1300int file_read_actor(read_descriptor_t *desc, struct page *page,
1301 unsigned long offset, unsigned long size)
1302{
1303 char *kaddr;
1304 unsigned long left, count = desc->count;
1305
1306 if (size > count)
1307 size = count;
1308
1309 /*
1310 * Faults on the destination of a read are common, so do it before
1311 * taking the kmap.
1312 */
1313 if (!fault_in_pages_writeable(desc->arg.buf, size)) {
1314 kaddr = kmap_atomic(page, KM_USER0);
1315 left = __copy_to_user_inatomic(desc->arg.buf,
1316 kaddr + offset, size);
1317 kunmap_atomic(kaddr, KM_USER0);
1318 if (left == 0)
1319 goto success;
1320 }
1321
1322 /* Do it the slow way */
1323 kaddr = kmap(page);
1324 left = __copy_to_user(desc->arg.buf, kaddr + offset, size);
1325 kunmap(page);
1326
1327 if (left) {
1328 size -= left;
1329 desc->error = -EFAULT;
1330 }
1331success:
1332 desc->count = count - size;
1333 desc->written += size;
1334 desc->arg.buf += size;
1335 return size;
1336}
1337
Dmitriy Monakhov0ceb3312007-05-08 00:23:02 -07001338/*
1339 * Performs necessary checks before doing a write
1340 * @iov: io vector request
1341 * @nr_segs: number of segments in the iovec
1342 * @count: number of bytes to write
1343 * @access_flags: type of access: %VERIFY_READ or %VERIFY_WRITE
1344 *
1345 * Adjust number of segments and amount of bytes to write (nr_segs should be
1346 * properly initialized first). Returns appropriate error code that caller
1347 * should return or zero in case that write should be allowed.
1348 */
1349int generic_segment_checks(const struct iovec *iov,
1350 unsigned long *nr_segs, size_t *count, int access_flags)
1351{
1352 unsigned long seg;
1353 size_t cnt = 0;
1354 for (seg = 0; seg < *nr_segs; seg++) {
1355 const struct iovec *iv = &iov[seg];
1356
1357 /*
1358 * If any segment has a negative length, or the cumulative
1359 * length ever wraps negative then return -EINVAL.
1360 */
1361 cnt += iv->iov_len;
1362 if (unlikely((ssize_t)(cnt|iv->iov_len) < 0))
1363 return -EINVAL;
1364 if (access_ok(access_flags, iv->iov_base, iv->iov_len))
1365 continue;
1366 if (seg == 0)
1367 return -EFAULT;
1368 *nr_segs = seg;
1369 cnt -= iv->iov_len; /* This segment is no good */
1370 break;
1371 }
1372 *count = cnt;
1373 return 0;
1374}
1375EXPORT_SYMBOL(generic_segment_checks);
1376
Randy Dunlap485bb992006-06-23 02:03:49 -07001377/**
Henrik Kretzschmarb2abacf2006-10-04 02:15:22 -07001378 * generic_file_aio_read - generic filesystem read routine
Randy Dunlap485bb992006-06-23 02:03:49 -07001379 * @iocb: kernel I/O control block
1380 * @iov: io vector request
1381 * @nr_segs: number of segments in the iovec
Henrik Kretzschmarb2abacf2006-10-04 02:15:22 -07001382 * @pos: current file position
Randy Dunlap485bb992006-06-23 02:03:49 -07001383 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384 * This is the "read()" routine for all filesystems
1385 * that can use the page cache directly.
1386 */
1387ssize_t
Badari Pulavarty543ade12006-09-30 23:28:48 -07001388generic_file_aio_read(struct kiocb *iocb, const struct iovec *iov,
1389 unsigned long nr_segs, loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390{
1391 struct file *filp = iocb->ki_filp;
1392 ssize_t retval;
Josef Bacik66f998f2010-05-23 11:00:54 -04001393 unsigned long seg = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001394 size_t count;
Badari Pulavarty543ade12006-09-30 23:28:48 -07001395 loff_t *ppos = &iocb->ki_pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
1397 count = 0;
Dmitriy Monakhov0ceb3312007-05-08 00:23:02 -07001398 retval = generic_segment_checks(iov, &nr_segs, &count, VERIFY_WRITE);
1399 if (retval)
1400 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
1402 /* coalesce the iovecs and go direct-to-BIO for O_DIRECT */
1403 if (filp->f_flags & O_DIRECT) {
Badari Pulavarty543ade12006-09-30 23:28:48 -07001404 loff_t size;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 struct address_space *mapping;
1406 struct inode *inode;
1407
1408 mapping = filp->f_mapping;
1409 inode = mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 if (!count)
1411 goto out; /* skip atime */
1412 size = i_size_read(inode);
1413 if (pos < size) {
Nick Piggin48b47c52009-01-06 14:40:22 -08001414 retval = filemap_write_and_wait_range(mapping, pos,
1415 pos + iov_length(iov, nr_segs) - 1);
Christoph Hellwiga969e902008-07-23 21:27:04 -07001416 if (!retval) {
1417 retval = mapping->a_ops->direct_IO(READ, iocb,
1418 iov, pos, nr_segs);
1419 }
Josef Bacik66f998f2010-05-23 11:00:54 -04001420 if (retval > 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 *ppos = pos + retval;
Josef Bacik66f998f2010-05-23 11:00:54 -04001422 count -= retval;
1423 }
1424
1425 /*
1426 * Btrfs can have a short DIO read if we encounter
1427 * compressed extents, so if there was an error, or if
1428 * we've already read everything we wanted to, or if
1429 * there was a short read because we hit EOF, go ahead
1430 * and return. Otherwise fallthrough to buffered io for
1431 * the rest of the read.
1432 */
1433 if (retval < 0 || !count || *ppos >= size) {
Hugh Dickins11fa977e2008-07-23 21:27:34 -07001434 file_accessed(filp);
1435 goto out;
1436 }
Steven Whitehouse0e0bcae2006-09-27 14:45:07 -04001437 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438 }
1439
Josef Bacik66f998f2010-05-23 11:00:54 -04001440 count = retval;
Hugh Dickins11fa977e2008-07-23 21:27:34 -07001441 for (seg = 0; seg < nr_segs; seg++) {
1442 read_descriptor_t desc;
Josef Bacik66f998f2010-05-23 11:00:54 -04001443 loff_t offset = 0;
1444
1445 /*
1446 * If we did a short DIO read we need to skip the section of the
1447 * iov that we've already read data into.
1448 */
1449 if (count) {
1450 if (count > iov[seg].iov_len) {
1451 count -= iov[seg].iov_len;
1452 continue;
1453 }
1454 offset = count;
1455 count = 0;
1456 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457
Hugh Dickins11fa977e2008-07-23 21:27:34 -07001458 desc.written = 0;
Josef Bacik66f998f2010-05-23 11:00:54 -04001459 desc.arg.buf = iov[seg].iov_base + offset;
1460 desc.count = iov[seg].iov_len - offset;
Hugh Dickins11fa977e2008-07-23 21:27:34 -07001461 if (desc.count == 0)
1462 continue;
1463 desc.error = 0;
1464 do_generic_file_read(filp, ppos, &desc, file_read_actor);
1465 retval += desc.written;
1466 if (desc.error) {
1467 retval = retval ?: desc.error;
1468 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469 }
Hugh Dickins11fa977e2008-07-23 21:27:34 -07001470 if (desc.count > 0)
1471 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001472 }
1473out:
1474 return retval;
1475}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001476EXPORT_SYMBOL(generic_file_aio_read);
1477
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478static ssize_t
1479do_readahead(struct address_space *mapping, struct file *filp,
Fengguang Wu57f6b962007-10-16 01:24:37 -07001480 pgoff_t index, unsigned long nr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001481{
1482 if (!mapping || !mapping->a_ops || !mapping->a_ops->readpage)
1483 return -EINVAL;
1484
Wu Fengguangf7e839d2009-06-16 15:31:20 -07001485 force_page_cache_readahead(mapping, filp, index, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486 return 0;
1487}
1488
Heiko Carstens6673e0c2009-01-14 14:14:02 +01001489SYSCALL_DEFINE(readahead)(int fd, loff_t offset, size_t count)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490{
1491 ssize_t ret;
1492 struct file *file;
1493
1494 ret = -EBADF;
1495 file = fget(fd);
1496 if (file) {
1497 if (file->f_mode & FMODE_READ) {
1498 struct address_space *mapping = file->f_mapping;
Fengguang Wu57f6b962007-10-16 01:24:37 -07001499 pgoff_t start = offset >> PAGE_CACHE_SHIFT;
1500 pgoff_t end = (offset + count - 1) >> PAGE_CACHE_SHIFT;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501 unsigned long len = end - start + 1;
1502 ret = do_readahead(mapping, file, start, len);
1503 }
1504 fput(file);
1505 }
1506 return ret;
1507}
Heiko Carstens6673e0c2009-01-14 14:14:02 +01001508#ifdef CONFIG_HAVE_SYSCALL_WRAPPERS
1509asmlinkage long SyS_readahead(long fd, loff_t offset, long count)
1510{
1511 return SYSC_readahead((int) fd, offset, (size_t) count);
1512}
1513SYSCALL_ALIAS(sys_readahead, SyS_readahead);
1514#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07001515
1516#ifdef CONFIG_MMU
Randy Dunlap485bb992006-06-23 02:03:49 -07001517/**
1518 * page_cache_read - adds requested page to the page cache if not already there
1519 * @file: file to read
1520 * @offset: page index
1521 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07001522 * This adds the requested page to the page cache if it isn't already there,
1523 * and schedules an I/O to read in its contents from disk.
1524 */
Harvey Harrison920c7a52008-02-04 22:29:26 -08001525static int page_cache_read(struct file *file, pgoff_t offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526{
1527 struct address_space *mapping = file->f_mapping;
1528 struct page *page;
Zach Brown994fc28c2005-12-15 14:28:17 -08001529 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001530
Zach Brown994fc28c2005-12-15 14:28:17 -08001531 do {
1532 page = page_cache_alloc_cold(mapping);
1533 if (!page)
1534 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535
Zach Brown994fc28c2005-12-15 14:28:17 -08001536 ret = add_to_page_cache_lru(page, mapping, offset, GFP_KERNEL);
1537 if (ret == 0)
1538 ret = mapping->a_ops->readpage(file, page);
1539 else if (ret == -EEXIST)
1540 ret = 0; /* losing race to add is OK */
1541
Linus Torvalds1da177e2005-04-16 15:20:36 -07001542 page_cache_release(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001543
Zach Brown994fc28c2005-12-15 14:28:17 -08001544 } while (ret == AOP_TRUNCATED_PAGE);
1545
1546 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547}
1548
1549#define MMAP_LOTSAMISS (100)
1550
Linus Torvaldsef00e082009-06-16 15:31:25 -07001551/*
1552 * Synchronous readahead happens when we don't even find
1553 * a page in the page cache at all.
1554 */
1555static void do_sync_mmap_readahead(struct vm_area_struct *vma,
1556 struct file_ra_state *ra,
1557 struct file *file,
1558 pgoff_t offset)
1559{
1560 unsigned long ra_pages;
1561 struct address_space *mapping = file->f_mapping;
1562
1563 /* If we don't want any read-ahead, don't bother */
1564 if (VM_RandomReadHint(vma))
1565 return;
1566
Wu Fengguang70ac23c2009-06-16 15:31:28 -07001567 if (VM_SequentialReadHint(vma) ||
1568 offset - 1 == (ra->prev_pos >> PAGE_CACHE_SHIFT)) {
Wu Fengguang7ffc59b2009-06-16 15:31:38 -07001569 page_cache_sync_readahead(mapping, ra, file, offset,
1570 ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07001571 return;
1572 }
1573
1574 if (ra->mmap_miss < INT_MAX)
1575 ra->mmap_miss++;
1576
1577 /*
1578 * Do we miss much more than hit in this file? If so,
1579 * stop bothering with read-ahead. It will only hurt.
1580 */
1581 if (ra->mmap_miss > MMAP_LOTSAMISS)
1582 return;
1583
Wu Fengguangd30a1102009-06-16 15:31:30 -07001584 /*
1585 * mmap read-around
1586 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07001587 ra_pages = max_sane_readahead(ra->ra_pages);
1588 if (ra_pages) {
Wu Fengguangd30a1102009-06-16 15:31:30 -07001589 ra->start = max_t(long, 0, offset - ra_pages/2);
1590 ra->size = ra_pages;
1591 ra->async_size = 0;
1592 ra_submit(ra, mapping, file);
Linus Torvaldsef00e082009-06-16 15:31:25 -07001593 }
1594}
1595
1596/*
1597 * Asynchronous readahead happens when we find the page and PG_readahead,
1598 * so we want to possibly extend the readahead further..
1599 */
1600static void do_async_mmap_readahead(struct vm_area_struct *vma,
1601 struct file_ra_state *ra,
1602 struct file *file,
1603 struct page *page,
1604 pgoff_t offset)
1605{
1606 struct address_space *mapping = file->f_mapping;
1607
1608 /* If we don't want any read-ahead, don't bother */
1609 if (VM_RandomReadHint(vma))
1610 return;
1611 if (ra->mmap_miss > 0)
1612 ra->mmap_miss--;
1613 if (PageReadahead(page))
Wu Fengguang2fad6f52009-06-16 15:31:29 -07001614 page_cache_async_readahead(mapping, ra, file,
1615 page, offset, ra->ra_pages);
Linus Torvaldsef00e082009-06-16 15:31:25 -07001616}
1617
Randy Dunlap485bb992006-06-23 02:03:49 -07001618/**
Nick Piggin54cb8822007-07-19 01:46:59 -07001619 * filemap_fault - read in file data for page fault handling
Nick Piggind0217ac042007-07-19 01:47:03 -07001620 * @vma: vma in which the fault was taken
1621 * @vmf: struct vm_fault containing details of the fault
Randy Dunlap485bb992006-06-23 02:03:49 -07001622 *
Nick Piggin54cb8822007-07-19 01:46:59 -07001623 * filemap_fault() is invoked via the vma operations vector for a
Linus Torvalds1da177e2005-04-16 15:20:36 -07001624 * mapped memory region to read in file data during a page fault.
1625 *
1626 * The goto's are kind of ugly, but this streamlines the normal case of having
1627 * it in the page cache, and handles the special cases reasonably without
1628 * having a lot of duplicated code.
1629 */
Nick Piggind0217ac042007-07-19 01:47:03 -07001630int filemap_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631{
1632 int error;
Nick Piggin54cb8822007-07-19 01:46:59 -07001633 struct file *file = vma->vm_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634 struct address_space *mapping = file->f_mapping;
1635 struct file_ra_state *ra = &file->f_ra;
1636 struct inode *inode = mapping->host;
Linus Torvaldsef00e082009-06-16 15:31:25 -07001637 pgoff_t offset = vmf->pgoff;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 struct page *page;
Jan Kara2004dc82008-02-08 04:20:11 -08001639 pgoff_t size;
Nick Piggin83c54072007-07-19 01:47:05 -07001640 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641
Linus Torvalds1da177e2005-04-16 15:20:36 -07001642 size = (i_size_read(inode) + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Linus Torvaldsef00e082009-06-16 15:31:25 -07001643 if (offset >= size)
Linus Torvalds5307cc12007-10-31 09:19:46 -07001644 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645
Linus Torvalds1da177e2005-04-16 15:20:36 -07001646 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 * Do we have something in the page cache already?
1648 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07001649 page = find_get_page(mapping, offset);
1650 if (likely(page)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 /*
Linus Torvaldsef00e082009-06-16 15:31:25 -07001652 * We found the page, so try async readahead before
1653 * waiting for the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07001655 do_async_mmap_readahead(vma, ra, file, page, offset);
Linus Torvaldsef00e082009-06-16 15:31:25 -07001656 } else {
1657 /* No page in the page cache at all */
1658 do_sync_mmap_readahead(vma, ra, file, offset);
1659 count_vm_event(PGMAJFAULT);
1660 ret = VM_FAULT_MAJOR;
1661retry_find:
Michel Lespinasseb522c942010-10-26 14:21:56 -07001662 page = find_get_page(mapping, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 if (!page)
1664 goto no_cached_page;
1665 }
1666
Michel Lespinassed88c09222010-11-02 13:05:18 -07001667 if (!lock_page_or_retry(page, vma->vm_mm, vmf->flags)) {
1668 page_cache_release(page);
Michel Lespinassed065bd82010-10-26 14:21:57 -07001669 return ret | VM_FAULT_RETRY;
Michel Lespinassed88c09222010-11-02 13:05:18 -07001670 }
Michel Lespinasseb522c942010-10-26 14:21:56 -07001671
1672 /* Did it get truncated? */
1673 if (unlikely(page->mapping != mapping)) {
1674 unlock_page(page);
1675 put_page(page);
1676 goto retry_find;
1677 }
1678 VM_BUG_ON(page->index != offset);
1679
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 /*
Nick Piggind00806b2007-07-19 01:46:57 -07001681 * We have a locked page in the page cache, now we need to check
1682 * that it's up-to-date. If not, it is going to be due to an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 */
Nick Piggind00806b2007-07-19 01:46:57 -07001684 if (unlikely(!PageUptodate(page)))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 goto page_not_uptodate;
1686
Linus Torvaldsef00e082009-06-16 15:31:25 -07001687 /*
1688 * Found the page and have a reference on it.
1689 * We must recheck i_size under page lock.
1690 */
Nick Piggind00806b2007-07-19 01:46:57 -07001691 size = (i_size_read(inode) + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT;
Linus Torvaldsef00e082009-06-16 15:31:25 -07001692 if (unlikely(offset >= size)) {
Nick Piggind00806b2007-07-19 01:46:57 -07001693 unlock_page(page);
Yan Zheng745ad482007-10-08 10:08:37 -07001694 page_cache_release(page);
Linus Torvalds5307cc12007-10-31 09:19:46 -07001695 return VM_FAULT_SIGBUS;
Nick Piggind00806b2007-07-19 01:46:57 -07001696 }
1697
Linus Torvaldsef00e082009-06-16 15:31:25 -07001698 ra->prev_pos = (loff_t)offset << PAGE_CACHE_SHIFT;
Nick Piggind0217ac042007-07-19 01:47:03 -07001699 vmf->page = page;
Nick Piggin83c54072007-07-19 01:47:05 -07001700 return ret | VM_FAULT_LOCKED;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701
Linus Torvalds1da177e2005-04-16 15:20:36 -07001702no_cached_page:
1703 /*
1704 * We're only likely to ever get here if MADV_RANDOM is in
1705 * effect.
1706 */
Linus Torvaldsef00e082009-06-16 15:31:25 -07001707 error = page_cache_read(file, offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
1709 /*
1710 * The page we want has now been added to the page cache.
1711 * In the unlikely event that someone removed it in the
1712 * meantime, we'll just come back here and read it again.
1713 */
1714 if (error >= 0)
1715 goto retry_find;
1716
1717 /*
1718 * An error return from page_cache_read can result if the
1719 * system is low on memory, or a problem occurs while trying
1720 * to schedule I/O.
1721 */
1722 if (error == -ENOMEM)
Nick Piggind0217ac042007-07-19 01:47:03 -07001723 return VM_FAULT_OOM;
1724 return VM_FAULT_SIGBUS;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
1726page_not_uptodate:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001727 /*
1728 * Umm, take care of errors if the page isn't up-to-date.
1729 * Try to re-read it _once_. We do this synchronously,
1730 * because there really aren't any performance issues here
1731 * and we need to check for errors.
1732 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 ClearPageError(page);
Zach Brown994fc28c2005-12-15 14:28:17 -08001734 error = mapping->a_ops->readpage(file, page);
Miklos Szeredi3ef0f722008-05-14 16:05:37 -07001735 if (!error) {
1736 wait_on_page_locked(page);
1737 if (!PageUptodate(page))
1738 error = -EIO;
1739 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 page_cache_release(page);
Nick Piggind00806b2007-07-19 01:46:57 -07001741
1742 if (!error || error == AOP_TRUNCATED_PAGE)
1743 goto retry_find;
1744
1745 /* Things didn't work out. Return zero to tell the mm layer so. */
1746 shrink_readahead_size_eio(file, ra);
Nick Piggind0217ac042007-07-19 01:47:03 -07001747 return VM_FAULT_SIGBUS;
Nick Piggin54cb8822007-07-19 01:46:59 -07001748}
1749EXPORT_SYMBOL(filemap_fault);
1750
Alexey Dobriyanf0f37e2f2009-09-27 22:29:37 +04001751const struct vm_operations_struct generic_file_vm_ops = {
Nick Piggin54cb8822007-07-19 01:46:59 -07001752 .fault = filemap_fault,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753};
1754
1755/* This is used for a general mmap of a disk file */
1756
1757int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
1758{
1759 struct address_space *mapping = file->f_mapping;
1760
1761 if (!mapping->a_ops->readpage)
1762 return -ENOEXEC;
1763 file_accessed(file);
1764 vma->vm_ops = &generic_file_vm_ops;
Nick Piggind0217ac042007-07-19 01:47:03 -07001765 vma->vm_flags |= VM_CAN_NONLINEAR;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001766 return 0;
1767}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001768
1769/*
1770 * This is for filesystems which do not implement ->writepage.
1771 */
1772int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
1773{
1774 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
1775 return -EINVAL;
1776 return generic_file_mmap(file, vma);
1777}
1778#else
1779int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
1780{
1781 return -ENOSYS;
1782}
1783int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
1784{
1785 return -ENOSYS;
1786}
1787#endif /* CONFIG_MMU */
1788
1789EXPORT_SYMBOL(generic_file_mmap);
1790EXPORT_SYMBOL(generic_file_readonly_mmap);
1791
Nick Piggin6fe69002007-05-06 14:49:04 -07001792static struct page *__read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07001793 pgoff_t index,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794 int (*filler)(void *,struct page*),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001795 void *data,
1796 gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797{
Nick Piggineb2be182007-10-16 01:24:57 -07001798 struct page *page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 int err;
1800repeat:
1801 page = find_get_page(mapping, index);
1802 if (!page) {
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001803 page = __page_cache_alloc(gfp | __GFP_COLD);
Nick Piggineb2be182007-10-16 01:24:57 -07001804 if (!page)
1805 return ERR_PTR(-ENOMEM);
1806 err = add_to_page_cache_lru(page, mapping, index, GFP_KERNEL);
1807 if (unlikely(err)) {
1808 page_cache_release(page);
1809 if (err == -EEXIST)
1810 goto repeat;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001811 /* Presumably ENOMEM for radix tree node */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812 return ERR_PTR(err);
1813 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814 err = filler(data, page);
1815 if (err < 0) {
1816 page_cache_release(page);
1817 page = ERR_PTR(err);
1818 }
1819 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001820 return page;
1821}
1822
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001823static struct page *do_read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07001824 pgoff_t index,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825 int (*filler)(void *,struct page*),
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001826 void *data,
1827 gfp_t gfp)
1828
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829{
1830 struct page *page;
1831 int err;
1832
1833retry:
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001834 page = __read_cache_page(mapping, index, filler, data, gfp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001835 if (IS_ERR(page))
David Howellsc855ff32007-05-09 13:42:20 +01001836 return page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001837 if (PageUptodate(page))
1838 goto out;
1839
1840 lock_page(page);
1841 if (!page->mapping) {
1842 unlock_page(page);
1843 page_cache_release(page);
1844 goto retry;
1845 }
1846 if (PageUptodate(page)) {
1847 unlock_page(page);
1848 goto out;
1849 }
1850 err = filler(data, page);
1851 if (err < 0) {
1852 page_cache_release(page);
David Howellsc855ff32007-05-09 13:42:20 +01001853 return ERR_PTR(err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001854 }
David Howellsc855ff32007-05-09 13:42:20 +01001855out:
Nick Piggin6fe69002007-05-06 14:49:04 -07001856 mark_page_accessed(page);
1857 return page;
1858}
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001859
1860/**
1861 * read_cache_page_async - read into page cache, fill it if needed
1862 * @mapping: the page's address_space
1863 * @index: the page index
1864 * @filler: function to perform the read
1865 * @data: destination for read data
1866 *
1867 * Same as read_cache_page, but don't wait for page to become unlocked
1868 * after submitting it to the filler.
1869 *
1870 * Read into the page cache. If a page already exists, and PageUptodate() is
1871 * not set, try to fill the page but don't wait for it to become unlocked.
1872 *
1873 * If the page does not get brought uptodate, return -EIO.
1874 */
1875struct page *read_cache_page_async(struct address_space *mapping,
1876 pgoff_t index,
1877 int (*filler)(void *,struct page*),
1878 void *data)
1879{
1880 return do_read_cache_page(mapping, index, filler, data, mapping_gfp_mask(mapping));
1881}
Nick Piggin6fe69002007-05-06 14:49:04 -07001882EXPORT_SYMBOL(read_cache_page_async);
1883
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001884static struct page *wait_on_page_read(struct page *page)
1885{
1886 if (!IS_ERR(page)) {
1887 wait_on_page_locked(page);
1888 if (!PageUptodate(page)) {
1889 page_cache_release(page);
1890 page = ERR_PTR(-EIO);
1891 }
1892 }
1893 return page;
1894}
1895
1896/**
1897 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
1898 * @mapping: the page's address_space
1899 * @index: the page index
1900 * @gfp: the page allocator flags to use if allocating
1901 *
1902 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
1903 * any new page allocations done using the specified allocation flags. Note
1904 * that the Radix tree operations will still use GFP_KERNEL, so you can't
1905 * expect to do this atomically or anything like that - but you can pass in
1906 * other page requirements.
1907 *
1908 * If the page does not get brought uptodate, return -EIO.
1909 */
1910struct page *read_cache_page_gfp(struct address_space *mapping,
1911 pgoff_t index,
1912 gfp_t gfp)
1913{
1914 filler_t *filler = (filler_t *)mapping->a_ops->readpage;
1915
1916 return wait_on_page_read(do_read_cache_page(mapping, index, filler, NULL, gfp));
1917}
1918EXPORT_SYMBOL(read_cache_page_gfp);
1919
Nick Piggin6fe69002007-05-06 14:49:04 -07001920/**
1921 * read_cache_page - read into page cache, fill it if needed
1922 * @mapping: the page's address_space
1923 * @index: the page index
1924 * @filler: function to perform the read
1925 * @data: destination for read data
1926 *
1927 * Read into the page cache. If a page already exists, and PageUptodate() is
1928 * not set, try to fill the page then wait for it to become unlocked.
1929 *
1930 * If the page does not get brought uptodate, return -EIO.
1931 */
1932struct page *read_cache_page(struct address_space *mapping,
Fengguang Wu57f6b962007-10-16 01:24:37 -07001933 pgoff_t index,
Nick Piggin6fe69002007-05-06 14:49:04 -07001934 int (*filler)(void *,struct page*),
1935 void *data)
1936{
Linus Torvalds0531b2a2010-01-27 09:20:03 -08001937 return wait_on_page_read(read_cache_page_async(mapping, index, filler, data));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939EXPORT_SYMBOL(read_cache_page);
1940
1941/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 * The logic we want is
1943 *
1944 * if suid or (sgid and xgrp)
1945 * remove privs
1946 */
Jens Axboe01de85e2006-10-17 19:50:36 +02001947int should_remove_suid(struct dentry *dentry)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001948{
1949 mode_t mode = dentry->d_inode->i_mode;
1950 int kill = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001951
1952 /* suid always must be killed */
1953 if (unlikely(mode & S_ISUID))
1954 kill = ATTR_KILL_SUID;
1955
1956 /*
1957 * sgid without any exec bits is just a mandatory locking mark; leave
1958 * it alone. If some exec bits are set, it's a real sgid; kill it.
1959 */
1960 if (unlikely((mode & S_ISGID) && (mode & S_IXGRP)))
1961 kill |= ATTR_KILL_SGID;
1962
Dmitri Monakhov7f5ff762008-12-01 14:34:56 -08001963 if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
Jens Axboe01de85e2006-10-17 19:50:36 +02001964 return kill;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
Jens Axboe01de85e2006-10-17 19:50:36 +02001966 return 0;
1967}
Mark Fashehd23a1472006-10-17 17:05:18 -07001968EXPORT_SYMBOL(should_remove_suid);
Jens Axboe01de85e2006-10-17 19:50:36 +02001969
Miklos Szeredi7f3d4ee2008-05-07 09:22:39 +02001970static int __remove_suid(struct dentry *dentry, int kill)
Jens Axboe01de85e2006-10-17 19:50:36 +02001971{
1972 struct iattr newattrs;
1973
1974 newattrs.ia_valid = ATTR_FORCE | kill;
1975 return notify_change(dentry, &newattrs);
1976}
1977
Miklos Szeredi2f1936b2008-06-24 16:50:14 +02001978int file_remove_suid(struct file *file)
Jens Axboe01de85e2006-10-17 19:50:36 +02001979{
Miklos Szeredi2f1936b2008-06-24 16:50:14 +02001980 struct dentry *dentry = file->f_path.dentry;
Serge E. Hallynb5376772007-10-16 23:31:36 -07001981 int killsuid = should_remove_suid(dentry);
1982 int killpriv = security_inode_need_killpriv(dentry);
1983 int error = 0;
Jens Axboe01de85e2006-10-17 19:50:36 +02001984
Serge E. Hallynb5376772007-10-16 23:31:36 -07001985 if (killpriv < 0)
1986 return killpriv;
1987 if (killpriv)
1988 error = security_inode_killpriv(dentry);
1989 if (!error && killsuid)
1990 error = __remove_suid(dentry, killsuid);
Jens Axboe01de85e2006-10-17 19:50:36 +02001991
Serge E. Hallynb5376772007-10-16 23:31:36 -07001992 return error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993}
Miklos Szeredi2f1936b2008-06-24 16:50:14 +02001994EXPORT_SYMBOL(file_remove_suid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001995
Nick Piggin2f718ff2007-10-16 01:24:59 -07001996static size_t __iovec_copy_from_user_inatomic(char *vaddr,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997 const struct iovec *iov, size_t base, size_t bytes)
1998{
Ingo Molnarf1800532009-03-02 11:00:57 +01001999 size_t copied = 0, left = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002000
2001 while (bytes) {
2002 char __user *buf = iov->iov_base + base;
2003 int copy = min(bytes, iov->iov_len - base);
2004
2005 base = 0;
Ingo Molnarf1800532009-03-02 11:00:57 +01002006 left = __copy_from_user_inatomic(vaddr, buf, copy);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 copied += copy;
2008 bytes -= copy;
2009 vaddr += copy;
2010 iov++;
2011
NeilBrown01408c42006-06-25 05:47:58 -07002012 if (unlikely(left))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002013 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002014 }
2015 return copied - left;
2016}
2017
2018/*
Nick Piggin2f718ff2007-10-16 01:24:59 -07002019 * Copy as much as we can into the page and return the number of bytes which
André Goddard Rosaaf901ca2009-11-14 13:09:05 -02002020 * were successfully copied. If a fault is encountered then return the number of
Nick Piggin2f718ff2007-10-16 01:24:59 -07002021 * bytes which were copied.
2022 */
2023size_t iov_iter_copy_from_user_atomic(struct page *page,
2024 struct iov_iter *i, unsigned long offset, size_t bytes)
2025{
2026 char *kaddr;
2027 size_t copied;
2028
2029 BUG_ON(!in_atomic());
2030 kaddr = kmap_atomic(page, KM_USER0);
2031 if (likely(i->nr_segs == 1)) {
2032 int left;
2033 char __user *buf = i->iov->iov_base + i->iov_offset;
Ingo Molnarf1800532009-03-02 11:00:57 +01002034 left = __copy_from_user_inatomic(kaddr + offset, buf, bytes);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002035 copied = bytes - left;
2036 } else {
2037 copied = __iovec_copy_from_user_inatomic(kaddr + offset,
2038 i->iov, i->iov_offset, bytes);
2039 }
2040 kunmap_atomic(kaddr, KM_USER0);
2041
2042 return copied;
2043}
Nick Piggin89e10782007-10-16 01:25:07 -07002044EXPORT_SYMBOL(iov_iter_copy_from_user_atomic);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002045
2046/*
2047 * This has the same sideeffects and return value as
2048 * iov_iter_copy_from_user_atomic().
2049 * The difference is that it attempts to resolve faults.
2050 * Page must not be locked.
2051 */
2052size_t iov_iter_copy_from_user(struct page *page,
2053 struct iov_iter *i, unsigned long offset, size_t bytes)
2054{
2055 char *kaddr;
2056 size_t copied;
2057
2058 kaddr = kmap(page);
2059 if (likely(i->nr_segs == 1)) {
2060 int left;
2061 char __user *buf = i->iov->iov_base + i->iov_offset;
Ingo Molnarf1800532009-03-02 11:00:57 +01002062 left = __copy_from_user(kaddr + offset, buf, bytes);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002063 copied = bytes - left;
2064 } else {
2065 copied = __iovec_copy_from_user_inatomic(kaddr + offset,
2066 i->iov, i->iov_offset, bytes);
2067 }
2068 kunmap(page);
2069 return copied;
2070}
Nick Piggin89e10782007-10-16 01:25:07 -07002071EXPORT_SYMBOL(iov_iter_copy_from_user);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002072
Nick Pigginf7009262008-03-10 11:43:59 -07002073void iov_iter_advance(struct iov_iter *i, size_t bytes)
Nick Piggin2f718ff2007-10-16 01:24:59 -07002074{
Nick Pigginf7009262008-03-10 11:43:59 -07002075 BUG_ON(i->count < bytes);
2076
Nick Piggin2f718ff2007-10-16 01:24:59 -07002077 if (likely(i->nr_segs == 1)) {
2078 i->iov_offset += bytes;
Nick Pigginf7009262008-03-10 11:43:59 -07002079 i->count -= bytes;
Nick Piggin2f718ff2007-10-16 01:24:59 -07002080 } else {
2081 const struct iovec *iov = i->iov;
2082 size_t base = i->iov_offset;
2083
Nick Piggin124d3b72008-02-02 15:01:17 +01002084 /*
2085 * The !iov->iov_len check ensures we skip over unlikely
Nick Pigginf7009262008-03-10 11:43:59 -07002086 * zero-length segments (without overruning the iovec).
Nick Piggin124d3b72008-02-02 15:01:17 +01002087 */
Linus Torvalds94ad3742008-07-30 14:45:12 -07002088 while (bytes || unlikely(i->count && !iov->iov_len)) {
Nick Pigginf7009262008-03-10 11:43:59 -07002089 int copy;
Nick Piggin2f718ff2007-10-16 01:24:59 -07002090
Nick Pigginf7009262008-03-10 11:43:59 -07002091 copy = min(bytes, iov->iov_len - base);
2092 BUG_ON(!i->count || i->count < copy);
2093 i->count -= copy;
Nick Piggin2f718ff2007-10-16 01:24:59 -07002094 bytes -= copy;
2095 base += copy;
2096 if (iov->iov_len == base) {
2097 iov++;
2098 base = 0;
2099 }
2100 }
2101 i->iov = iov;
2102 i->iov_offset = base;
2103 }
2104}
Nick Piggin89e10782007-10-16 01:25:07 -07002105EXPORT_SYMBOL(iov_iter_advance);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002106
Nick Pigginafddba42007-10-16 01:25:01 -07002107/*
2108 * Fault in the first iovec of the given iov_iter, to a maximum length
2109 * of bytes. Returns 0 on success, or non-zero if the memory could not be
2110 * accessed (ie. because it is an invalid address).
2111 *
2112 * writev-intensive code may want this to prefault several iovecs -- that
2113 * would be possible (callers must not rely on the fact that _only_ the
2114 * first iovec will be faulted with the current implementation).
2115 */
2116int iov_iter_fault_in_readable(struct iov_iter *i, size_t bytes)
Nick Piggin2f718ff2007-10-16 01:24:59 -07002117{
Nick Piggin2f718ff2007-10-16 01:24:59 -07002118 char __user *buf = i->iov->iov_base + i->iov_offset;
Nick Pigginafddba42007-10-16 01:25:01 -07002119 bytes = min(bytes, i->iov->iov_len - i->iov_offset);
2120 return fault_in_pages_readable(buf, bytes);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002121}
Nick Piggin89e10782007-10-16 01:25:07 -07002122EXPORT_SYMBOL(iov_iter_fault_in_readable);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002123
2124/*
2125 * Return the count of just the current iov_iter segment.
2126 */
2127size_t iov_iter_single_seg_count(struct iov_iter *i)
2128{
2129 const struct iovec *iov = i->iov;
2130 if (i->nr_segs == 1)
2131 return i->count;
2132 else
2133 return min(i->count, iov->iov_len - i->iov_offset);
2134}
Nick Piggin89e10782007-10-16 01:25:07 -07002135EXPORT_SYMBOL(iov_iter_single_seg_count);
Nick Piggin2f718ff2007-10-16 01:24:59 -07002136
2137/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07002138 * Performs necessary checks before doing a write
2139 *
Randy Dunlap485bb992006-06-23 02:03:49 -07002140 * Can adjust writing position or amount of bytes to write.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002141 * Returns appropriate error code that caller should return or
2142 * zero in case that write should be allowed.
2143 */
2144inline int generic_write_checks(struct file *file, loff_t *pos, size_t *count, int isblk)
2145{
2146 struct inode *inode = file->f_mapping->host;
Jiri Slaby59e99e52010-03-05 13:41:44 -08002147 unsigned long limit = rlimit(RLIMIT_FSIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002148
2149 if (unlikely(*pos < 0))
2150 return -EINVAL;
2151
Linus Torvalds1da177e2005-04-16 15:20:36 -07002152 if (!isblk) {
2153 /* FIXME: this is for backwards compatibility with 2.4 */
2154 if (file->f_flags & O_APPEND)
2155 *pos = i_size_read(inode);
2156
2157 if (limit != RLIM_INFINITY) {
2158 if (*pos >= limit) {
2159 send_sig(SIGXFSZ, current, 0);
2160 return -EFBIG;
2161 }
2162 if (*count > limit - (typeof(limit))*pos) {
2163 *count = limit - (typeof(limit))*pos;
2164 }
2165 }
2166 }
2167
2168 /*
2169 * LFS rule
2170 */
2171 if (unlikely(*pos + *count > MAX_NON_LFS &&
2172 !(file->f_flags & O_LARGEFILE))) {
2173 if (*pos >= MAX_NON_LFS) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002174 return -EFBIG;
2175 }
2176 if (*count > MAX_NON_LFS - (unsigned long)*pos) {
2177 *count = MAX_NON_LFS - (unsigned long)*pos;
2178 }
2179 }
2180
2181 /*
2182 * Are we about to exceed the fs block limit ?
2183 *
2184 * If we have written data it becomes a short write. If we have
2185 * exceeded without writing data we send a signal and return EFBIG.
2186 * Linus frestrict idea will clean these up nicely..
2187 */
2188 if (likely(!isblk)) {
2189 if (unlikely(*pos >= inode->i_sb->s_maxbytes)) {
2190 if (*count || *pos > inode->i_sb->s_maxbytes) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 return -EFBIG;
2192 }
2193 /* zero-length writes at ->s_maxbytes are OK */
2194 }
2195
2196 if (unlikely(*pos + *count > inode->i_sb->s_maxbytes))
2197 *count = inode->i_sb->s_maxbytes - *pos;
2198 } else {
David Howells93614012006-09-30 20:45:40 +02002199#ifdef CONFIG_BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 loff_t isize;
2201 if (bdev_read_only(I_BDEV(inode)))
2202 return -EPERM;
2203 isize = i_size_read(inode);
2204 if (*pos >= isize) {
2205 if (*count || *pos > isize)
2206 return -ENOSPC;
2207 }
2208
2209 if (*pos + *count > isize)
2210 *count = isize - *pos;
David Howells93614012006-09-30 20:45:40 +02002211#else
2212 return -EPERM;
2213#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -07002214 }
2215 return 0;
2216}
2217EXPORT_SYMBOL(generic_write_checks);
2218
Nick Pigginafddba42007-10-16 01:25:01 -07002219int pagecache_write_begin(struct file *file, struct address_space *mapping,
2220 loff_t pos, unsigned len, unsigned flags,
2221 struct page **pagep, void **fsdata)
2222{
2223 const struct address_space_operations *aops = mapping->a_ops;
2224
Nick Piggin4e02ed42008-10-29 14:00:55 -07002225 return aops->write_begin(file, mapping, pos, len, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002226 pagep, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002227}
2228EXPORT_SYMBOL(pagecache_write_begin);
2229
2230int pagecache_write_end(struct file *file, struct address_space *mapping,
2231 loff_t pos, unsigned len, unsigned copied,
2232 struct page *page, void *fsdata)
2233{
2234 const struct address_space_operations *aops = mapping->a_ops;
Nick Pigginafddba42007-10-16 01:25:01 -07002235
Nick Piggin4e02ed42008-10-29 14:00:55 -07002236 mark_page_accessed(page);
2237 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
Nick Pigginafddba42007-10-16 01:25:01 -07002238}
2239EXPORT_SYMBOL(pagecache_write_end);
2240
Linus Torvalds1da177e2005-04-16 15:20:36 -07002241ssize_t
2242generic_file_direct_write(struct kiocb *iocb, const struct iovec *iov,
2243 unsigned long *nr_segs, loff_t pos, loff_t *ppos,
2244 size_t count, size_t ocount)
2245{
2246 struct file *file = iocb->ki_filp;
2247 struct address_space *mapping = file->f_mapping;
2248 struct inode *inode = mapping->host;
2249 ssize_t written;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002250 size_t write_len;
2251 pgoff_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252
2253 if (count != ocount)
2254 *nr_segs = iov_shorten((struct iovec *)iov, *nr_segs, count);
2255
Christoph Hellwiga969e902008-07-23 21:27:04 -07002256 write_len = iov_length(iov, *nr_segs);
2257 end = (pos + write_len - 1) >> PAGE_CACHE_SHIFT;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002258
Nick Piggin48b47c52009-01-06 14:40:22 -08002259 written = filemap_write_and_wait_range(mapping, pos, pos + write_len - 1);
Christoph Hellwiga969e902008-07-23 21:27:04 -07002260 if (written)
2261 goto out;
2262
2263 /*
2264 * After a write we want buffered reads to be sure to go to disk to get
2265 * the new data. We invalidate clean cached page from the region we're
2266 * about to write. We do this *before* the write so that we can return
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002267 * without clobbering -EIOCBQUEUED from ->direct_IO().
Christoph Hellwiga969e902008-07-23 21:27:04 -07002268 */
2269 if (mapping->nrpages) {
2270 written = invalidate_inode_pages2_range(mapping,
2271 pos >> PAGE_CACHE_SHIFT, end);
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002272 /*
2273 * If a page can not be invalidated, return 0 to fall back
2274 * to buffered write.
2275 */
2276 if (written) {
2277 if (written == -EBUSY)
2278 return 0;
Christoph Hellwiga969e902008-07-23 21:27:04 -07002279 goto out;
Hisashi Hifumi6ccfa802008-09-02 14:35:40 -07002280 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002281 }
2282
2283 written = mapping->a_ops->direct_IO(WRITE, iocb, iov, pos, *nr_segs);
2284
2285 /*
2286 * Finally, try again to invalidate clean pages which might have been
2287 * cached by non-direct readahead, or faulted in by get_user_pages()
2288 * if the source of the write was an mmap'ed region of the file
2289 * we're writing. Either one is a pretty crazy thing to do,
2290 * so we don't support it 100%. If this invalidation
2291 * fails, tough, the write still worked...
2292 */
2293 if (mapping->nrpages) {
2294 invalidate_inode_pages2_range(mapping,
2295 pos >> PAGE_CACHE_SHIFT, end);
2296 }
2297
Linus Torvalds1da177e2005-04-16 15:20:36 -07002298 if (written > 0) {
Namhyung Kim01166512010-10-26 14:21:58 -07002299 pos += written;
2300 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
2301 i_size_write(inode, pos);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002302 mark_inode_dirty(inode);
2303 }
Namhyung Kim01166512010-10-26 14:21:58 -07002304 *ppos = pos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002305 }
Christoph Hellwiga969e902008-07-23 21:27:04 -07002306out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002307 return written;
2308}
2309EXPORT_SYMBOL(generic_file_direct_write);
2310
Nick Piggineb2be182007-10-16 01:24:57 -07002311/*
2312 * Find or create a page at the given pagecache position. Return the locked
2313 * page. This function is specifically for buffered writes.
2314 */
Nick Piggin54566b22009-01-04 12:00:53 -08002315struct page *grab_cache_page_write_begin(struct address_space *mapping,
2316 pgoff_t index, unsigned flags)
Nick Piggineb2be182007-10-16 01:24:57 -07002317{
2318 int status;
2319 struct page *page;
Nick Piggin54566b22009-01-04 12:00:53 -08002320 gfp_t gfp_notmask = 0;
2321 if (flags & AOP_FLAG_NOFS)
2322 gfp_notmask = __GFP_FS;
Nick Piggineb2be182007-10-16 01:24:57 -07002323repeat:
2324 page = find_lock_page(mapping, index);
Steven Rostedtc585a262011-01-13 15:46:18 -08002325 if (page)
Nick Piggineb2be182007-10-16 01:24:57 -07002326 return page;
2327
Nick Piggin54566b22009-01-04 12:00:53 -08002328 page = __page_cache_alloc(mapping_gfp_mask(mapping) & ~gfp_notmask);
Nick Piggineb2be182007-10-16 01:24:57 -07002329 if (!page)
2330 return NULL;
Nick Piggin54566b22009-01-04 12:00:53 -08002331 status = add_to_page_cache_lru(page, mapping, index,
2332 GFP_KERNEL & ~gfp_notmask);
Nick Piggineb2be182007-10-16 01:24:57 -07002333 if (unlikely(status)) {
2334 page_cache_release(page);
2335 if (status == -EEXIST)
2336 goto repeat;
2337 return NULL;
2338 }
2339 return page;
2340}
Nick Piggin54566b22009-01-04 12:00:53 -08002341EXPORT_SYMBOL(grab_cache_page_write_begin);
Nick Piggineb2be182007-10-16 01:24:57 -07002342
Nick Pigginafddba42007-10-16 01:25:01 -07002343static ssize_t generic_perform_write(struct file *file,
2344 struct iov_iter *i, loff_t pos)
2345{
2346 struct address_space *mapping = file->f_mapping;
2347 const struct address_space_operations *a_ops = mapping->a_ops;
2348 long status = 0;
2349 ssize_t written = 0;
Nick Piggin674b8922007-10-16 01:25:03 -07002350 unsigned int flags = 0;
2351
2352 /*
2353 * Copies from kernel address space cannot fail (NFSD is a big user).
2354 */
2355 if (segment_eq(get_fs(), KERNEL_DS))
2356 flags |= AOP_FLAG_UNINTERRUPTIBLE;
Nick Pigginafddba42007-10-16 01:25:01 -07002357
2358 do {
2359 struct page *page;
Nick Pigginafddba42007-10-16 01:25:01 -07002360 unsigned long offset; /* Offset into pagecache page */
2361 unsigned long bytes; /* Bytes to write to page */
2362 size_t copied; /* Bytes copied from user */
2363 void *fsdata;
2364
2365 offset = (pos & (PAGE_CACHE_SIZE - 1));
Nick Pigginafddba42007-10-16 01:25:01 -07002366 bytes = min_t(unsigned long, PAGE_CACHE_SIZE - offset,
2367 iov_iter_count(i));
2368
2369again:
2370
2371 /*
2372 * Bring in the user page that we will copy from _first_.
2373 * Otherwise there's a nasty deadlock on copying from the
2374 * same page as we're writing to, without it being marked
2375 * up-to-date.
2376 *
2377 * Not only is this an optimisation, but it is also required
2378 * to check that the address is actually valid, when atomic
2379 * usercopies are used, below.
2380 */
2381 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
2382 status = -EFAULT;
2383 break;
2384 }
2385
Nick Piggin674b8922007-10-16 01:25:03 -07002386 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
Nick Pigginafddba42007-10-16 01:25:01 -07002387 &page, &fsdata);
2388 if (unlikely(status))
2389 break;
2390
anfei zhou931e80e2010-02-02 13:44:02 -08002391 if (mapping_writably_mapped(mapping))
2392 flush_dcache_page(page);
2393
Nick Pigginafddba42007-10-16 01:25:01 -07002394 pagefault_disable();
2395 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
2396 pagefault_enable();
2397 flush_dcache_page(page);
2398
Josef Bacikc8236db2009-07-05 12:08:18 -07002399 mark_page_accessed(page);
Nick Pigginafddba42007-10-16 01:25:01 -07002400 status = a_ops->write_end(file, mapping, pos, bytes, copied,
2401 page, fsdata);
2402 if (unlikely(status < 0))
2403 break;
2404 copied = status;
2405
2406 cond_resched();
2407
Nick Piggin124d3b72008-02-02 15:01:17 +01002408 iov_iter_advance(i, copied);
Nick Pigginafddba42007-10-16 01:25:01 -07002409 if (unlikely(copied == 0)) {
2410 /*
2411 * If we were unable to copy any data at all, we must
2412 * fall back to a single segment length write.
2413 *
2414 * If we didn't fallback here, we could livelock
2415 * because not all segments in the iov can be copied at
2416 * once without a pagefault.
2417 */
2418 bytes = min_t(unsigned long, PAGE_CACHE_SIZE - offset,
2419 iov_iter_single_seg_count(i));
2420 goto again;
2421 }
Nick Pigginafddba42007-10-16 01:25:01 -07002422 pos += copied;
2423 written += copied;
2424
2425 balance_dirty_pages_ratelimited(mapping);
2426
2427 } while (iov_iter_count(i));
2428
2429 return written ? written : status;
2430}
2431
2432ssize_t
2433generic_file_buffered_write(struct kiocb *iocb, const struct iovec *iov,
2434 unsigned long nr_segs, loff_t pos, loff_t *ppos,
2435 size_t count, ssize_t written)
2436{
2437 struct file *file = iocb->ki_filp;
Nick Pigginafddba42007-10-16 01:25:01 -07002438 ssize_t status;
2439 struct iov_iter i;
2440
2441 iov_iter_init(&i, iov, nr_segs, count, written);
Nick Piggin4e02ed42008-10-29 14:00:55 -07002442 status = generic_perform_write(file, &i, pos);
Nick Pigginafddba42007-10-16 01:25:01 -07002443
Linus Torvalds1da177e2005-04-16 15:20:36 -07002444 if (likely(status >= 0)) {
Nick Pigginafddba42007-10-16 01:25:01 -07002445 written += status;
2446 *ppos = pos + status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002447 }
2448
Linus Torvalds1da177e2005-04-16 15:20:36 -07002449 return written ? written : status;
2450}
2451EXPORT_SYMBOL(generic_file_buffered_write);
2452
Jan Karae4dd9de2009-08-17 18:10:06 +02002453/**
2454 * __generic_file_aio_write - write data to a file
2455 * @iocb: IO state structure (file, offset, etc.)
2456 * @iov: vector with data to write
2457 * @nr_segs: number of segments in the vector
2458 * @ppos: position where to write
2459 *
2460 * This function does all the work needed for actually writing data to a
2461 * file. It does all basic checks, removes SUID from the file, updates
2462 * modification times and calls proper subroutines depending on whether we
2463 * do direct IO or a standard buffered write.
2464 *
2465 * It expects i_mutex to be grabbed unless we work on a block device or similar
2466 * object which does not need locking at all.
2467 *
2468 * This function does *not* take care of syncing data in case of O_SYNC write.
2469 * A caller has to handle it. This is mainly due to the fact that we want to
2470 * avoid syncing under i_mutex.
2471 */
2472ssize_t __generic_file_aio_write(struct kiocb *iocb, const struct iovec *iov,
2473 unsigned long nr_segs, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002474{
2475 struct file *file = iocb->ki_filp;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002476 struct address_space * mapping = file->f_mapping;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002477 size_t ocount; /* original count */
2478 size_t count; /* after file limit checks */
2479 struct inode *inode = mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002480 loff_t pos;
2481 ssize_t written;
2482 ssize_t err;
2483
2484 ocount = 0;
Dmitriy Monakhov0ceb3312007-05-08 00:23:02 -07002485 err = generic_segment_checks(iov, &nr_segs, &ocount, VERIFY_READ);
2486 if (err)
2487 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002488
2489 count = ocount;
2490 pos = *ppos;
2491
2492 vfs_check_frozen(inode->i_sb, SB_FREEZE_WRITE);
2493
2494 /* We can write back this queue in page reclaim */
2495 current->backing_dev_info = mapping->backing_dev_info;
2496 written = 0;
2497
2498 err = generic_write_checks(file, &pos, &count, S_ISBLK(inode->i_mode));
2499 if (err)
2500 goto out;
2501
2502 if (count == 0)
2503 goto out;
2504
Miklos Szeredi2f1936b2008-06-24 16:50:14 +02002505 err = file_remove_suid(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002506 if (err)
2507 goto out;
2508
Christoph Hellwig870f4812006-01-09 20:52:01 -08002509 file_update_time(file);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002510
2511 /* coalesce the iovecs and go direct-to-BIO for O_DIRECT */
2512 if (unlikely(file->f_flags & O_DIRECT)) {
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002513 loff_t endbyte;
2514 ssize_t written_buffered;
2515
2516 written = generic_file_direct_write(iocb, iov, &nr_segs, pos,
2517 ppos, count, ocount);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002518 if (written < 0 || written == count)
2519 goto out;
2520 /*
2521 * direct-io write to a hole: fall through to buffered I/O
2522 * for completing the rest of the request.
2523 */
2524 pos += written;
2525 count -= written;
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002526 written_buffered = generic_file_buffered_write(iocb, iov,
2527 nr_segs, pos, ppos, count,
2528 written);
2529 /*
2530 * If generic_file_buffered_write() retuned a synchronous error
2531 * then we want to return the number of bytes which were
2532 * direct-written, or the error code if that was zero. Note
2533 * that this differs from normal direct-io semantics, which
2534 * will return -EFOO even if some bytes were written.
2535 */
2536 if (written_buffered < 0) {
2537 err = written_buffered;
2538 goto out;
2539 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002540
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002541 /*
2542 * We need to ensure that the page cache pages are written to
2543 * disk and invalidated to preserve the expected O_DIRECT
2544 * semantics.
2545 */
2546 endbyte = pos + written_buffered - written - 1;
Christoph Hellwigc05c4ed2009-09-23 15:07:30 +02002547 err = filemap_write_and_wait_range(file->f_mapping, pos, endbyte);
Jeff Moyerfb5527e2006-10-19 23:28:13 -07002548 if (err == 0) {
2549 written = written_buffered;
2550 invalidate_mapping_pages(mapping,
2551 pos >> PAGE_CACHE_SHIFT,
2552 endbyte >> PAGE_CACHE_SHIFT);
2553 } else {
2554 /*
2555 * We don't know how much we wrote, so just return
2556 * the number of bytes which were direct-written
2557 */
2558 }
2559 } else {
2560 written = generic_file_buffered_write(iocb, iov, nr_segs,
2561 pos, ppos, count, written);
2562 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002563out:
2564 current->backing_dev_info = NULL;
2565 return written ? written : err;
2566}
Jan Karae4dd9de2009-08-17 18:10:06 +02002567EXPORT_SYMBOL(__generic_file_aio_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002568
Jan Karae4dd9de2009-08-17 18:10:06 +02002569/**
2570 * generic_file_aio_write - write data to a file
2571 * @iocb: IO state structure
2572 * @iov: vector with data to write
2573 * @nr_segs: number of segments in the vector
2574 * @pos: position in file where to write
2575 *
2576 * This is a wrapper around __generic_file_aio_write() to be used by most
2577 * filesystems. It takes care of syncing the file in case of O_SYNC file
2578 * and acquires i_mutex as needed.
2579 */
Badari Pulavarty027445c2006-09-30 23:28:46 -07002580ssize_t generic_file_aio_write(struct kiocb *iocb, const struct iovec *iov,
2581 unsigned long nr_segs, loff_t pos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002582{
2583 struct file *file = iocb->ki_filp;
Jan Kara148f9482009-08-17 19:52:36 +02002584 struct inode *inode = file->f_mapping->host;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002585 ssize_t ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002586
2587 BUG_ON(iocb->ki_pos != pos);
2588
Jes Sorensen1b1dcc12006-01-09 15:59:24 -08002589 mutex_lock(&inode->i_mutex);
Jan Karae4dd9de2009-08-17 18:10:06 +02002590 ret = __generic_file_aio_write(iocb, iov, nr_segs, &iocb->ki_pos);
Jes Sorensen1b1dcc12006-01-09 15:59:24 -08002591 mutex_unlock(&inode->i_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002592
Jan Kara148f9482009-08-17 19:52:36 +02002593 if (ret > 0 || ret == -EIOCBQUEUED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002594 ssize_t err;
2595
Jan Kara148f9482009-08-17 19:52:36 +02002596 err = generic_write_sync(file, pos, ret);
Jan Karac7b50db2009-08-18 16:18:20 +02002597 if (err < 0 && ret > 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002598 ret = err;
2599 }
2600 return ret;
2601}
2602EXPORT_SYMBOL(generic_file_aio_write);
2603
David Howellscf9a2ae2006-08-29 19:05:54 +01002604/**
2605 * try_to_release_page() - release old fs-specific metadata on a page
2606 *
2607 * @page: the page which the kernel is trying to free
2608 * @gfp_mask: memory allocation flags (and I/O mode)
2609 *
2610 * The address_space is to try to release any data against the page
2611 * (presumably at page->private). If the release was successful, return `1'.
2612 * Otherwise return zero.
2613 *
David Howells266cf652009-04-03 16:42:36 +01002614 * This may also be called if PG_fscache is set on a page, indicating that the
2615 * page is known to the local caching routines.
2616 *
David Howellscf9a2ae2006-08-29 19:05:54 +01002617 * The @gfp_mask argument specifies whether I/O may be performed to release
Mingming Cao3f31fdd2008-07-25 01:46:22 -07002618 * this page (__GFP_IO), and whether the call may block (__GFP_WAIT & __GFP_FS).
David Howellscf9a2ae2006-08-29 19:05:54 +01002619 *
David Howellscf9a2ae2006-08-29 19:05:54 +01002620 */
2621int try_to_release_page(struct page *page, gfp_t gfp_mask)
2622{
2623 struct address_space * const mapping = page->mapping;
2624
2625 BUG_ON(!PageLocked(page));
2626 if (PageWriteback(page))
2627 return 0;
2628
2629 if (mapping && mapping->a_ops->releasepage)
2630 return mapping->a_ops->releasepage(page, gfp_mask);
2631 return try_to_free_buffers(page);
2632}
2633
2634EXPORT_SYMBOL(try_to_release_page);