1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3 * linux/mm/filemap.c
4 *
5 * Copyright (C) 1994-1999 Linus Torvalds
6 */
7
8 /*
9 * This file handles the generic file mmap semantics used by
10 * most "normal" filesystems (but you don't /have/ to use this:
11 * the NFS filesystem used to do this differently, for example)
12 */
13 #include <linux/export.h>
14 #include <linux/compiler.h>
15 #include <linux/dax.h>
16 #include <linux/fs.h>
17 #include <linux/sched/signal.h>
18 #include <linux/uaccess.h>
19 #include <linux/capability.h>
20 #include <linux/kernel_stat.h>
21 #include <linux/gfp.h>
22 #include <linux/mm.h>
23 #include <linux/swap.h>
24 #include <linux/mman.h>
25 #include <linux/pagemap.h>
26 #include <linux/file.h>
27 #include <linux/uio.h>
28 #include <linux/error-injection.h>
29 #include <linux/hash.h>
30 #include <linux/writeback.h>
31 #include <linux/backing-dev.h>
32 #include <linux/pagevec.h>
33 #include <linux/blkdev.h>
34 #include <linux/security.h>
35 #include <linux/cpuset.h>
36 #include <linux/hugetlb.h>
37 #include <linux/memcontrol.h>
38 #include <linux/cleancache.h>
39 #include <linux/shmem_fs.h>
40 #include <linux/rmap.h>
41 #include <linux/delayacct.h>
42 #include <linux/psi.h>
43 #include <linux/ramfs.h>
44 #include <linux/page_idle.h>
45 #include <asm/pgalloc.h>
46 #include <asm/tlbflush.h>
47 #include "internal.h"
48
49 #define CREATE_TRACE_POINTS
50 #include <trace/events/filemap.h>
51
52 #undef CREATE_TRACE_POINTS
53 #include <trace/hooks/mm.h>
54
55 /*
56 * FIXME: remove all knowledge of the buffer layer from the core VM
57 */
58 #include <linux/buffer_head.h> /* for try_to_free_buffers */
59
60 #include <asm/mman.h>
61
62 /*
63 * Shared mappings implemented 30.11.1994. It's not fully working yet,
64 * though.
65 *
66 * Shared mappings now work. 15.8.1995 Bruno.
67 *
68 * finished 'unifying' the page and buffer cache and SMP-threaded the
69 * page-cache, 21.05.1999, Ingo Molnar <mingo@redhat.com>
70 *
71 * SMP-threaded pagemap-LRU 1999, Andrea Arcangeli <andrea@suse.de>
72 */
73
74 /*
75 * Lock ordering:
76 *
77 * ->i_mmap_rwsem (truncate_pagecache)
78 * ->private_lock (__free_pte->__set_page_dirty_buffers)
79 * ->swap_lock (exclusive_swap_page, others)
80 * ->i_pages lock
81 *
82 * ->i_mutex
83 * ->i_mmap_rwsem (truncate->unmap_mapping_range)
84 *
85 * ->mmap_lock
86 * ->i_mmap_rwsem
87 * ->page_table_lock or pte_lock (various, mainly in memory.c)
88 * ->i_pages lock (arch-dependent flush_dcache_mmap_lock)
89 *
90 * ->mmap_lock
91 * ->lock_page (access_process_vm)
92 *
93 * ->i_mutex (generic_perform_write)
94 * ->mmap_lock (fault_in_pages_readable->do_page_fault)
95 *
96 * bdi->wb.list_lock
97 * sb_lock (fs/fs-writeback.c)
98 * ->i_pages lock (__sync_single_inode)
99 *
100 * ->i_mmap_rwsem
101 * ->anon_vma.lock (vma_adjust)
102 *
103 * ->anon_vma.lock
104 * ->page_table_lock or pte_lock (anon_vma_prepare and various)
105 *
106 * ->page_table_lock or pte_lock
107 * ->swap_lock (try_to_unmap_one)
108 * ->private_lock (try_to_unmap_one)
109 * ->i_pages lock (try_to_unmap_one)
110 * ->pgdat->lru_lock (follow_page->mark_page_accessed)
111 * ->pgdat->lru_lock (check_pte_range->isolate_lru_page)
112 * ->private_lock (page_remove_rmap->set_page_dirty)
113 * ->i_pages lock (page_remove_rmap->set_page_dirty)
114 * bdi.wb->list_lock (page_remove_rmap->set_page_dirty)
115 * ->inode->i_lock (page_remove_rmap->set_page_dirty)
116 * ->memcg->move_lock (page_remove_rmap->lock_page_memcg)
117 * bdi.wb->list_lock (zap_pte_range->set_page_dirty)
118 * ->inode->i_lock (zap_pte_range->set_page_dirty)
119 * ->private_lock (zap_pte_range->__set_page_dirty_buffers)
120 *
121 * ->i_mmap_rwsem
122 * ->tasklist_lock (memory_failure, collect_procs_ao)
123 */
124
page_cache_delete(struct address_space * mapping,struct page * page,void * shadow)125 static void page_cache_delete(struct address_space *mapping,
126 struct page *page, void *shadow)
127 {
128 XA_STATE(xas, &mapping->i_pages, page->index);
129 unsigned int nr = 1;
130
131 mapping_set_update(&xas, mapping);
132
133 /* hugetlb pages are represented by a single entry in the xarray */
134 if (!PageHuge(page)) {
135 xas_set_order(&xas, page->index, compound_order(page));
136 nr = compound_nr(page);
137 }
138
139 VM_BUG_ON_PAGE(!PageLocked(page), page);
140 VM_BUG_ON_PAGE(PageTail(page), page);
141 VM_BUG_ON_PAGE(nr != 1 && shadow, page);
142
143 xas_store(&xas, shadow);
144 xas_init_marks(&xas);
145
146 page->mapping = NULL;
147 /* Leave page->index set: truncation lookup relies upon it */
148
149 if (shadow) {
150 mapping->nrexceptional += nr;
151 /*
152 * Make sure the nrexceptional update is committed before
153 * the nrpages update so that final truncate racing
154 * with reclaim does not see both counters 0 at the
155 * same time and miss a shadow entry.
156 */
157 smp_wmb();
158 }
159 mapping->nrpages -= nr;
160 }
161
unaccount_page_cache_page(struct address_space * mapping,struct page * page)162 static void unaccount_page_cache_page(struct address_space *mapping,
163 struct page *page)
164 {
165 int nr;
166
167 /*
168 * if we're uptodate, flush out into the cleancache, otherwise
169 * invalidate any existing cleancache entries. We can't leave
170 * stale data around in the cleancache once our page is gone
171 */
172 if (PageUptodate(page) && PageMappedToDisk(page))
173 cleancache_put_page(page);
174 else
175 cleancache_invalidate_page(mapping, page);
176
177 VM_BUG_ON_PAGE(PageTail(page), page);
178 VM_BUG_ON_PAGE(page_mapped(page), page);
179 if (!IS_ENABLED(CONFIG_DEBUG_VM) && unlikely(page_mapped(page))) {
180 int mapcount;
181
182 pr_alert("BUG: Bad page cache in process %s pfn:%05lx\n",
183 current->comm, page_to_pfn(page));
184 dump_page(page, "still mapped when deleted");
185 dump_stack();
186 add_taint(TAINT_BAD_PAGE, LOCKDEP_NOW_UNRELIABLE);
187
188 mapcount = page_mapcount(page);
189 if (mapping_exiting(mapping) &&
190 page_count(page) >= mapcount + 2) {
191 /*
192 * All vmas have already been torn down, so it's
193 * a good bet that actually the page is unmapped,
194 * and we'd prefer not to leak it: if we're wrong,
195 * some other bad page check should catch it later.
196 */
197 page_mapcount_reset(page);
198 page_ref_sub(page, mapcount);
199 }
200 }
201
202 /* hugetlb pages do not participate in page cache accounting. */
203 if (PageHuge(page))
204 return;
205
206 nr = thp_nr_pages(page);
207
208 __mod_lruvec_page_state(page, NR_FILE_PAGES, -nr);
209 if (PageSwapBacked(page)) {
210 __mod_lruvec_page_state(page, NR_SHMEM, -nr);
211 if (PageTransHuge(page))
212 __dec_node_page_state(page, NR_SHMEM_THPS);
213 } else if (PageTransHuge(page)) {
214 __dec_node_page_state(page, NR_FILE_THPS);
215 filemap_nr_thps_dec(mapping);
216 }
217
218 /*
219 * At this point page must be either written or cleaned by
220 * truncate. Dirty page here signals a bug and loss of
221 * unwritten data.
222 *
223 * This fixes dirty accounting after removing the page entirely
224 * but leaves PageDirty set: it has no effect for truncated
225 * page and anyway will be cleared before returning page into
226 * buddy allocator.
227 */
228 if (WARN_ON_ONCE(PageDirty(page)))
229 account_page_cleaned(page, mapping, inode_to_wb(mapping->host));
230 }
231
232 /*
233 * Delete a page from the page cache and free it. Caller has to make
234 * sure the page is locked and that nobody else uses it - or that usage
235 * is safe. The caller must hold the i_pages lock.
236 */
__delete_from_page_cache(struct page * page,void * shadow)237 void __delete_from_page_cache(struct page *page, void *shadow)
238 {
239 struct address_space *mapping = page->mapping;
240
241 trace_mm_filemap_delete_from_page_cache(page);
242
243 unaccount_page_cache_page(mapping, page);
244 page_cache_delete(mapping, page, shadow);
245 }
246
page_cache_free_page(struct address_space * mapping,struct page * page)247 static void page_cache_free_page(struct address_space *mapping,
248 struct page *page)
249 {
250 void (*freepage)(struct page *);
251
252 freepage = mapping->a_ops->freepage;
253 if (freepage)
254 freepage(page);
255
256 if (PageTransHuge(page) && !PageHuge(page)) {
257 page_ref_sub(page, thp_nr_pages(page));
258 VM_BUG_ON_PAGE(page_count(page) <= 0, page);
259 } else {
260 put_page(page);
261 }
262 }
263
264 /**
265 * delete_from_page_cache - delete page from page cache
266 * @page: the page which the kernel is trying to remove from page cache
267 *
268 * This must be called only on pages that have been verified to be in the page
269 * cache and locked. It will never put the page into the free list, the caller
270 * has a reference on the page.
271 */
delete_from_page_cache(struct page * page)272 void delete_from_page_cache(struct page *page)
273 {
274 struct address_space *mapping = page_mapping(page);
275 unsigned long flags;
276
277 BUG_ON(!PageLocked(page));
278 xa_lock_irqsave(&mapping->i_pages, flags);
279 __delete_from_page_cache(page, NULL);
280 xa_unlock_irqrestore(&mapping->i_pages, flags);
281
282 page_cache_free_page(mapping, page);
283 }
284 EXPORT_SYMBOL(delete_from_page_cache);
285
286 /*
287 * page_cache_delete_batch - delete several pages from page cache
288 * @mapping: the mapping to which pages belong
289 * @pvec: pagevec with pages to delete
290 *
291 * The function walks over mapping->i_pages and removes pages passed in @pvec
292 * from the mapping. The function expects @pvec to be sorted by page index
293 * and is optimised for it to be dense.
294 * It tolerates holes in @pvec (mapping entries at those indices are not
295 * modified). The function expects only THP head pages to be present in the
296 * @pvec.
297 *
298 * The function expects the i_pages lock to be held.
299 */
page_cache_delete_batch(struct address_space * mapping,struct pagevec * pvec)300 static void page_cache_delete_batch(struct address_space *mapping,
301 struct pagevec *pvec)
302 {
303 XA_STATE(xas, &mapping->i_pages, pvec->pages[0]->index);
304 int total_pages = 0;
305 int i = 0;
306 struct page *page;
307
308 mapping_set_update(&xas, mapping);
309 xas_for_each(&xas, page, ULONG_MAX) {
310 if (i >= pagevec_count(pvec))
311 break;
312
313 /* A swap/dax/shadow entry got inserted? Skip it. */
314 if (xa_is_value(page))
315 continue;
316 /*
317 * A page got inserted in our range? Skip it. We have our
318 * pages locked so they are protected from being removed.
319 * If we see a page whose index is higher than ours, it
320 * means our page has been removed, which shouldn't be
321 * possible because we're holding the PageLock.
322 */
323 if (page != pvec->pages[i]) {
324 VM_BUG_ON_PAGE(page->index > pvec->pages[i]->index,
325 page);
326 continue;
327 }
328
329 WARN_ON_ONCE(!PageLocked(page));
330
331 if (page->index == xas.xa_index)
332 page->mapping = NULL;
333 /* Leave page->index set: truncation lookup relies on it */
334
335 /*
336 * Move to the next page in the vector if this is a regular
337 * page or the index is of the last sub-page of this compound
338 * page.
339 */
340 if (page->index + compound_nr(page) - 1 == xas.xa_index)
341 i++;
342 xas_store(&xas, NULL);
343 total_pages++;
344 }
345 mapping->nrpages -= total_pages;
346 }
347
delete_from_page_cache_batch(struct address_space * mapping,struct pagevec * pvec)348 void delete_from_page_cache_batch(struct address_space *mapping,
349 struct pagevec *pvec)
350 {
351 int i;
352 unsigned long flags;
353
354 if (!pagevec_count(pvec))
355 return;
356
357 xa_lock_irqsave(&mapping->i_pages, flags);
358 for (i = 0; i < pagevec_count(pvec); i++) {
359 trace_mm_filemap_delete_from_page_cache(pvec->pages[i]);
360
361 unaccount_page_cache_page(mapping, pvec->pages[i]);
362 }
363 page_cache_delete_batch(mapping, pvec);
364 xa_unlock_irqrestore(&mapping->i_pages, flags);
365
366 for (i = 0; i < pagevec_count(pvec); i++)
367 page_cache_free_page(mapping, pvec->pages[i]);
368 }
369
filemap_check_errors(struct address_space * mapping)370 int filemap_check_errors(struct address_space *mapping)
371 {
372 int ret = 0;
373 /* Check for outstanding write errors */
374 if (test_bit(AS_ENOSPC, &mapping->flags) &&
375 test_and_clear_bit(AS_ENOSPC, &mapping->flags))
376 ret = -ENOSPC;
377 if (test_bit(AS_EIO, &mapping->flags) &&
378 test_and_clear_bit(AS_EIO, &mapping->flags))
379 ret = -EIO;
380 return ret;
381 }
382 EXPORT_SYMBOL(filemap_check_errors);
383
filemap_check_and_keep_errors(struct address_space * mapping)384 static int filemap_check_and_keep_errors(struct address_space *mapping)
385 {
386 /* Check for outstanding write errors */
387 if (test_bit(AS_EIO, &mapping->flags))
388 return -EIO;
389 if (test_bit(AS_ENOSPC, &mapping->flags))
390 return -ENOSPC;
391 return 0;
392 }
393
394 /**
395 * __filemap_fdatawrite_range - start writeback on mapping dirty pages in range
396 * @mapping: address space structure to write
397 * @start: offset in bytes where the range starts
398 * @end: offset in bytes where the range ends (inclusive)
399 * @sync_mode: enable synchronous operation
400 *
401 * Start writeback against all of a mapping's dirty pages that lie
402 * within the byte offsets <start, end> inclusive.
403 *
404 * If sync_mode is WB_SYNC_ALL then this is a "data integrity" operation, as
405 * opposed to a regular memory cleansing writeback. The difference between
406 * these two operations is that if a dirty page/buffer is encountered, it must
407 * be waited upon, and not just skipped over.
408 *
409 * Return: %0 on success, negative error code otherwise.
410 */
__filemap_fdatawrite_range(struct address_space * mapping,loff_t start,loff_t end,int sync_mode)411 int __filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
412 loff_t end, int sync_mode)
413 {
414 int ret;
415 struct writeback_control wbc = {
416 .sync_mode = sync_mode,
417 .nr_to_write = LONG_MAX,
418 .range_start = start,
419 .range_end = end,
420 };
421
422 if (!mapping_can_writeback(mapping) ||
423 !mapping_tagged(mapping, PAGECACHE_TAG_DIRTY))
424 return 0;
425
426 wbc_attach_fdatawrite_inode(&wbc, mapping->host);
427 ret = do_writepages(mapping, &wbc);
428 wbc_detach_inode(&wbc);
429 return ret;
430 }
431
__filemap_fdatawrite(struct address_space * mapping,int sync_mode)432 static inline int __filemap_fdatawrite(struct address_space *mapping,
433 int sync_mode)
434 {
435 return __filemap_fdatawrite_range(mapping, 0, LLONG_MAX, sync_mode);
436 }
437
filemap_fdatawrite(struct address_space * mapping)438 int filemap_fdatawrite(struct address_space *mapping)
439 {
440 return __filemap_fdatawrite(mapping, WB_SYNC_ALL);
441 }
442 EXPORT_SYMBOL(filemap_fdatawrite);
443
filemap_fdatawrite_range(struct address_space * mapping,loff_t start,loff_t end)444 int filemap_fdatawrite_range(struct address_space *mapping, loff_t start,
445 loff_t end)
446 {
447 return __filemap_fdatawrite_range(mapping, start, end, WB_SYNC_ALL);
448 }
449 EXPORT_SYMBOL(filemap_fdatawrite_range);
450
451 /**
452 * filemap_flush - mostly a non-blocking flush
453 * @mapping: target address_space
454 *
455 * This is a mostly non-blocking flush. Not suitable for data-integrity
456 * purposes - I/O may not be started against all dirty pages.
457 *
458 * Return: %0 on success, negative error code otherwise.
459 */
filemap_flush(struct address_space * mapping)460 int filemap_flush(struct address_space *mapping)
461 {
462 return __filemap_fdatawrite(mapping, WB_SYNC_NONE);
463 }
464 EXPORT_SYMBOL(filemap_flush);
465
466 /**
467 * filemap_range_has_page - check if a page exists in range.
468 * @mapping: address space within which to check
469 * @start_byte: offset in bytes where the range starts
470 * @end_byte: offset in bytes where the range ends (inclusive)
471 *
472 * Find at least one page in the range supplied, usually used to check if
473 * direct writing in this range will trigger a writeback.
474 *
475 * Return: %true if at least one page exists in the specified range,
476 * %false otherwise.
477 */
filemap_range_has_page(struct address_space * mapping,loff_t start_byte,loff_t end_byte)478 bool filemap_range_has_page(struct address_space *mapping,
479 loff_t start_byte, loff_t end_byte)
480 {
481 struct page *page;
482 XA_STATE(xas, &mapping->i_pages, start_byte >> PAGE_SHIFT);
483 pgoff_t max = end_byte >> PAGE_SHIFT;
484
485 if (end_byte < start_byte)
486 return false;
487
488 rcu_read_lock();
489 for (;;) {
490 page = xas_find(&xas, max);
491 if (xas_retry(&xas, page))
492 continue;
493 /* Shadow entries don't count */
494 if (xa_is_value(page))
495 continue;
496 /*
497 * We don't need to try to pin this page; we're about to
498 * release the RCU lock anyway. It is enough to know that
499 * there was a page here recently.
500 */
501 break;
502 }
503 rcu_read_unlock();
504
505 return page != NULL;
506 }
507 EXPORT_SYMBOL(filemap_range_has_page);
508
__filemap_fdatawait_range(struct address_space * mapping,loff_t start_byte,loff_t end_byte)509 static void __filemap_fdatawait_range(struct address_space *mapping,
510 loff_t start_byte, loff_t end_byte)
511 {
512 pgoff_t index = start_byte >> PAGE_SHIFT;
513 pgoff_t end = end_byte >> PAGE_SHIFT;
514 struct pagevec pvec;
515 int nr_pages;
516
517 if (end_byte < start_byte)
518 return;
519
520 pagevec_init(&pvec);
521 while (index <= end) {
522 unsigned i;
523
524 nr_pages = pagevec_lookup_range_tag(&pvec, mapping, &index,
525 end, PAGECACHE_TAG_WRITEBACK);
526 if (!nr_pages)
527 break;
528
529 for (i = 0; i < nr_pages; i++) {
530 struct page *page = pvec.pages[i];
531
532 wait_on_page_writeback(page);
533 ClearPageError(page);
534 }
535 pagevec_release(&pvec);
536 cond_resched();
537 }
538 }
539
540 /**
541 * filemap_fdatawait_range - wait for writeback to complete
542 * @mapping: address space structure to wait for
543 * @start_byte: offset in bytes where the range starts
544 * @end_byte: offset in bytes where the range ends (inclusive)
545 *
546 * Walk the list of under-writeback pages of the given address space
547 * in the given range and wait for all of them. Check error status of
548 * the address space and return it.
549 *
550 * Since the error status of the address space is cleared by this function,
551 * callers are responsible for checking the return value and handling and/or
552 * reporting the error.
553 *
554 * Return: error status of the address space.
555 */
filemap_fdatawait_range(struct address_space * mapping,loff_t start_byte,loff_t end_byte)556 int filemap_fdatawait_range(struct address_space *mapping, loff_t start_byte,
557 loff_t end_byte)
558 {
559 __filemap_fdatawait_range(mapping, start_byte, end_byte);
560 return filemap_check_errors(mapping);
561 }
562 EXPORT_SYMBOL(filemap_fdatawait_range);
563
564 /**
565 * filemap_fdatawait_range_keep_errors - wait for writeback to complete
566 * @mapping: address space structure to wait for
567 * @start_byte: offset in bytes where the range starts
568 * @end_byte: offset in bytes where the range ends (inclusive)
569 *
570 * Walk the list of under-writeback pages of the given address space in the
571 * given range and wait for all of them. Unlike filemap_fdatawait_range(),
572 * this function does not clear error status of the address space.
573 *
574 * Use this function if callers don't handle errors themselves. Expected
575 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
576 * fsfreeze(8)
577 */
filemap_fdatawait_range_keep_errors(struct address_space * mapping,loff_t start_byte,loff_t end_byte)578 int filemap_fdatawait_range_keep_errors(struct address_space *mapping,
579 loff_t start_byte, loff_t end_byte)
580 {
581 __filemap_fdatawait_range(mapping, start_byte, end_byte);
582 return filemap_check_and_keep_errors(mapping);
583 }
584 EXPORT_SYMBOL(filemap_fdatawait_range_keep_errors);
585
586 /**
587 * file_fdatawait_range - wait for writeback to complete
588 * @file: file pointing to address space structure to wait for
589 * @start_byte: offset in bytes where the range starts
590 * @end_byte: offset in bytes where the range ends (inclusive)
591 *
592 * Walk the list of under-writeback pages of the address space that file
593 * refers to, in the given range and wait for all of them. Check error
594 * status of the address space vs. the file->f_wb_err cursor and return it.
595 *
596 * Since the error status of the file is advanced by this function,
597 * callers are responsible for checking the return value and handling and/or
598 * reporting the error.
599 *
600 * Return: error status of the address space vs. the file->f_wb_err cursor.
601 */
file_fdatawait_range(struct file * file,loff_t start_byte,loff_t end_byte)602 int file_fdatawait_range(struct file *file, loff_t start_byte, loff_t end_byte)
603 {
604 struct address_space *mapping = file->f_mapping;
605
606 __filemap_fdatawait_range(mapping, start_byte, end_byte);
607 return file_check_and_advance_wb_err(file);
608 }
609 EXPORT_SYMBOL(file_fdatawait_range);
610
611 /**
612 * filemap_fdatawait_keep_errors - wait for writeback without clearing errors
613 * @mapping: address space structure to wait for
614 *
615 * Walk the list of under-writeback pages of the given address space
616 * and wait for all of them. Unlike filemap_fdatawait(), this function
617 * does not clear error status of the address space.
618 *
619 * Use this function if callers don't handle errors themselves. Expected
620 * call sites are system-wide / filesystem-wide data flushers: e.g. sync(2),
621 * fsfreeze(8)
622 *
623 * Return: error status of the address space.
624 */
filemap_fdatawait_keep_errors(struct address_space * mapping)625 int filemap_fdatawait_keep_errors(struct address_space *mapping)
626 {
627 __filemap_fdatawait_range(mapping, 0, LLONG_MAX);
628 return filemap_check_and_keep_errors(mapping);
629 }
630 EXPORT_SYMBOL(filemap_fdatawait_keep_errors);
631
632 /* Returns true if writeback might be needed or already in progress. */
mapping_needs_writeback(struct address_space * mapping)633 static bool mapping_needs_writeback(struct address_space *mapping)
634 {
635 if (dax_mapping(mapping))
636 return mapping->nrexceptional;
637
638 return mapping->nrpages;
639 }
640
641 /**
642 * filemap_write_and_wait_range - write out & wait on a file range
643 * @mapping: the address_space for the pages
644 * @lstart: offset in bytes where the range starts
645 * @lend: offset in bytes where the range ends (inclusive)
646 *
647 * Write out and wait upon file offsets lstart->lend, inclusive.
648 *
649 * Note that @lend is inclusive (describes the last byte to be written) so
650 * that this function can be used to write to the very end-of-file (end = -1).
651 *
652 * Return: error status of the address space.
653 */
filemap_write_and_wait_range(struct address_space * mapping,loff_t lstart,loff_t lend)654 int filemap_write_and_wait_range(struct address_space *mapping,
655 loff_t lstart, loff_t lend)
656 {
657 int err = 0;
658
659 if (mapping_needs_writeback(mapping)) {
660 err = __filemap_fdatawrite_range(mapping, lstart, lend,
661 WB_SYNC_ALL);
662 /*
663 * Even if the above returned error, the pages may be
664 * written partially (e.g. -ENOSPC), so we wait for it.
665 * But the -EIO is special case, it may indicate the worst
666 * thing (e.g. bug) happened, so we avoid waiting for it.
667 */
668 if (err != -EIO) {
669 int err2 = filemap_fdatawait_range(mapping,
670 lstart, lend);
671 if (!err)
672 err = err2;
673 } else {
674 /* Clear any previously stored errors */
675 filemap_check_errors(mapping);
676 }
677 } else {
678 err = filemap_check_errors(mapping);
679 }
680 return err;
681 }
682 EXPORT_SYMBOL(filemap_write_and_wait_range);
683
__filemap_set_wb_err(struct address_space * mapping,int err)684 void __filemap_set_wb_err(struct address_space *mapping, int err)
685 {
686 errseq_t eseq = errseq_set(&mapping->wb_err, err);
687
688 trace_filemap_set_wb_err(mapping, eseq);
689 }
690 EXPORT_SYMBOL(__filemap_set_wb_err);
691
692 /**
693 * file_check_and_advance_wb_err - report wb error (if any) that was previously
694 * and advance wb_err to current one
695 * @file: struct file on which the error is being reported
696 *
697 * When userland calls fsync (or something like nfsd does the equivalent), we
698 * want to report any writeback errors that occurred since the last fsync (or
699 * since the file was opened if there haven't been any).
700 *
701 * Grab the wb_err from the mapping. If it matches what we have in the file,
702 * then just quickly return 0. The file is all caught up.
703 *
704 * If it doesn't match, then take the mapping value, set the "seen" flag in
705 * it and try to swap it into place. If it works, or another task beat us
706 * to it with the new value, then update the f_wb_err and return the error
707 * portion. The error at this point must be reported via proper channels
708 * (a'la fsync, or NFS COMMIT operation, etc.).
709 *
710 * While we handle mapping->wb_err with atomic operations, the f_wb_err
711 * value is protected by the f_lock since we must ensure that it reflects
712 * the latest value swapped in for this file descriptor.
713 *
714 * Return: %0 on success, negative error code otherwise.
715 */
file_check_and_advance_wb_err(struct file * file)716 int file_check_and_advance_wb_err(struct file *file)
717 {
718 int err = 0;
719 errseq_t old = READ_ONCE(file->f_wb_err);
720 struct address_space *mapping = file->f_mapping;
721
722 /* Locklessly handle the common case where nothing has changed */
723 if (errseq_check(&mapping->wb_err, old)) {
724 /* Something changed, must use slow path */
725 spin_lock(&file->f_lock);
726 old = file->f_wb_err;
727 err = errseq_check_and_advance(&mapping->wb_err,
728 &file->f_wb_err);
729 trace_file_check_and_advance_wb_err(file, old);
730 spin_unlock(&file->f_lock);
731 }
732
733 /*
734 * We're mostly using this function as a drop in replacement for
735 * filemap_check_errors. Clear AS_EIO/AS_ENOSPC to emulate the effect
736 * that the legacy code would have had on these flags.
737 */
738 clear_bit(AS_EIO, &mapping->flags);
739 clear_bit(AS_ENOSPC, &mapping->flags);
740 return err;
741 }
742 EXPORT_SYMBOL(file_check_and_advance_wb_err);
743
744 /**
745 * file_write_and_wait_range - write out & wait on a file range
746 * @file: file pointing to address_space with pages
747 * @lstart: offset in bytes where the range starts
748 * @lend: offset in bytes where the range ends (inclusive)
749 *
750 * Write out and wait upon file offsets lstart->lend, inclusive.
751 *
752 * Note that @lend is inclusive (describes the last byte to be written) so
753 * that this function can be used to write to the very end-of-file (end = -1).
754 *
755 * After writing out and waiting on the data, we check and advance the
756 * f_wb_err cursor to the latest value, and return any errors detected there.
757 *
758 * Return: %0 on success, negative error code otherwise.
759 */
file_write_and_wait_range(struct file * file,loff_t lstart,loff_t lend)760 int file_write_and_wait_range(struct file *file, loff_t lstart, loff_t lend)
761 {
762 int err = 0, err2;
763 struct address_space *mapping = file->f_mapping;
764
765 if (mapping_needs_writeback(mapping)) {
766 err = __filemap_fdatawrite_range(mapping, lstart, lend,
767 WB_SYNC_ALL);
768 /* See comment of filemap_write_and_wait() */
769 if (err != -EIO)
770 __filemap_fdatawait_range(mapping, lstart, lend);
771 }
772 err2 = file_check_and_advance_wb_err(file);
773 if (!err)
774 err = err2;
775 return err;
776 }
777 EXPORT_SYMBOL(file_write_and_wait_range);
778
779 /**
780 * replace_page_cache_page - replace a pagecache page with a new one
781 * @old: page to be replaced
782 * @new: page to replace with
783 * @gfp_mask: allocation mode
784 *
785 * This function replaces a page in the pagecache with a new one. On
786 * success it acquires the pagecache reference for the new page and
787 * drops it for the old page. Both the old and new pages must be
788 * locked. This function does not add the new page to the LRU, the
789 * caller must do that.
790 *
791 * The remove + add is atomic. This function cannot fail.
792 *
793 * Return: %0
794 */
replace_page_cache_page(struct page * old,struct page * new,gfp_t gfp_mask)795 int replace_page_cache_page(struct page *old, struct page *new, gfp_t gfp_mask)
796 {
797 struct address_space *mapping = old->mapping;
798 void (*freepage)(struct page *) = mapping->a_ops->freepage;
799 pgoff_t offset = old->index;
800 XA_STATE(xas, &mapping->i_pages, offset);
801 unsigned long flags;
802
803 VM_BUG_ON_PAGE(!PageLocked(old), old);
804 VM_BUG_ON_PAGE(!PageLocked(new), new);
805 VM_BUG_ON_PAGE(new->mapping, new);
806
807 get_page(new);
808 new->mapping = mapping;
809 new->index = offset;
810
811 mem_cgroup_migrate(old, new);
812
813 xas_lock_irqsave(&xas, flags);
814 xas_store(&xas, new);
815
816 old->mapping = NULL;
817 /* hugetlb pages do not participate in page cache accounting. */
818 if (!PageHuge(old))
819 __dec_lruvec_page_state(old, NR_FILE_PAGES);
820 if (!PageHuge(new))
821 __inc_lruvec_page_state(new, NR_FILE_PAGES);
822 if (PageSwapBacked(old))
823 __dec_lruvec_page_state(old, NR_SHMEM);
824 if (PageSwapBacked(new))
825 __inc_lruvec_page_state(new, NR_SHMEM);
826 xas_unlock_irqrestore(&xas, flags);
827 if (freepage)
828 freepage(old);
829 put_page(old);
830
831 return 0;
832 }
833 EXPORT_SYMBOL_GPL(replace_page_cache_page);
834
__add_to_page_cache_locked(struct page * page,struct address_space * mapping,pgoff_t offset,gfp_t gfp,void ** shadowp)835 noinline int __add_to_page_cache_locked(struct page *page,
836 struct address_space *mapping,
837 pgoff_t offset, gfp_t gfp,
838 void **shadowp)
839 {
840 XA_STATE(xas, &mapping->i_pages, offset);
841 int huge = PageHuge(page);
842 int error;
843 bool charged = false;
844
845 VM_BUG_ON_PAGE(!PageLocked(page), page);
846 VM_BUG_ON_PAGE(PageSwapBacked(page), page);
847 mapping_set_update(&xas, mapping);
848
849 get_page(page);
850 page->mapping = mapping;
851 page->index = offset;
852
853 if (!huge) {
854 error = mem_cgroup_charge(page, current->mm, gfp);
855 if (error)
856 goto error;
857 charged = true;
858 }
859
860 gfp &= GFP_RECLAIM_MASK;
861
862 do {
863 unsigned int order = xa_get_order(xas.xa, xas.xa_index);
864 void *entry, *old = NULL;
865
866 if (order > thp_order(page))
867 xas_split_alloc(&xas, xa_load(xas.xa, xas.xa_index),
868 order, gfp);
869 xas_lock_irq(&xas);
870 xas_for_each_conflict(&xas, entry) {
871 old = entry;
872 if (!xa_is_value(entry)) {
873 xas_set_err(&xas, -EEXIST);
874 goto unlock;
875 }
876 }
877
878 if (old) {
879 if (shadowp)
880 *shadowp = old;
881 /* entry may have been split before we acquired lock */
882 order = xa_get_order(xas.xa, xas.xa_index);
883 if (order > thp_order(page)) {
884 xas_split(&xas, old, order);
885 xas_reset(&xas);
886 }
887 }
888
889 xas_store(&xas, page);
890 if (xas_error(&xas))
891 goto unlock;
892
893 if (old)
894 mapping->nrexceptional--;
895 mapping->nrpages++;
896
897 /* hugetlb pages do not participate in page cache accounting */
898 if (!huge)
899 __inc_lruvec_page_state(page, NR_FILE_PAGES);
900 unlock:
901 xas_unlock_irq(&xas);
902 } while (xas_nomem(&xas, gfp));
903
904 if (xas_error(&xas)) {
905 error = xas_error(&xas);
906 if (charged)
907 mem_cgroup_uncharge(page);
908 goto error;
909 }
910
911 trace_mm_filemap_add_to_page_cache(page);
912 return 0;
913 error:
914 page->mapping = NULL;
915 /* Leave page->index set: truncation relies upon it */
916 put_page(page);
917 return error;
918 }
919 ALLOW_ERROR_INJECTION(__add_to_page_cache_locked, ERRNO);
920
921 /**
922 * add_to_page_cache_locked - add a locked page to the pagecache
923 * @page: page to add
924 * @mapping: the page's address_space
925 * @offset: page index
926 * @gfp_mask: page allocation mode
927 *
928 * This function is used to add a page to the pagecache. It must be locked.
929 * This function does not add the page to the LRU. The caller must do that.
930 *
931 * Return: %0 on success, negative error code otherwise.
932 */
add_to_page_cache_locked(struct page * page,struct address_space * mapping,pgoff_t offset,gfp_t gfp_mask)933 int add_to_page_cache_locked(struct page *page, struct address_space *mapping,
934 pgoff_t offset, gfp_t gfp_mask)
935 {
936 return __add_to_page_cache_locked(page, mapping, offset,
937 gfp_mask, NULL);
938 }
939 EXPORT_SYMBOL(add_to_page_cache_locked);
940
add_to_page_cache_lru(struct page * page,struct address_space * mapping,pgoff_t offset,gfp_t gfp_mask)941 int add_to_page_cache_lru(struct page *page, struct address_space *mapping,
942 pgoff_t offset, gfp_t gfp_mask)
943 {
944 void *shadow = NULL;
945 int ret;
946
947 __SetPageLocked(page);
948 ret = __add_to_page_cache_locked(page, mapping, offset,
949 gfp_mask, &shadow);
950 if (unlikely(ret))
951 __ClearPageLocked(page);
952 else {
953 /*
954 * The page might have been evicted from cache only
955 * recently, in which case it should be activated like
956 * any other repeatedly accessed page.
957 * The exception is pages getting rewritten; evicting other
958 * data from the working set, only to cache data that will
959 * get overwritten with something else, is a waste of memory.
960 */
961 WARN_ON_ONCE(PageActive(page));
962 if (!(gfp_mask & __GFP_WRITE) && shadow)
963 workingset_refault(page, shadow);
964 lru_cache_add(page);
965 }
966 return ret;
967 }
968 EXPORT_SYMBOL_GPL(add_to_page_cache_lru);
969
970 #ifdef CONFIG_NUMA
__page_cache_alloc(gfp_t gfp)971 struct page *__page_cache_alloc(gfp_t gfp)
972 {
973 int n;
974 struct page *page;
975
976 if (cpuset_do_page_mem_spread()) {
977 unsigned int cpuset_mems_cookie;
978 do {
979 cpuset_mems_cookie = read_mems_allowed_begin();
980 n = cpuset_mem_spread_node();
981 page = __alloc_pages_node(n, gfp, 0);
982 } while (!page && read_mems_allowed_retry(cpuset_mems_cookie));
983
984 return page;
985 }
986 return alloc_pages(gfp, 0);
987 }
988 EXPORT_SYMBOL(__page_cache_alloc);
989 #endif
990
991 /*
992 * In order to wait for pages to become available there must be
993 * waitqueues associated with pages. By using a hash table of
994 * waitqueues where the bucket discipline is to maintain all
995 * waiters on the same queue and wake all when any of the pages
996 * become available, and for the woken contexts to check to be
997 * sure the appropriate page became available, this saves space
998 * at a cost of "thundering herd" phenomena during rare hash
999 * collisions.
1000 */
1001 #define PAGE_WAIT_TABLE_BITS 8
1002 #define PAGE_WAIT_TABLE_SIZE (1 << PAGE_WAIT_TABLE_BITS)
1003 static wait_queue_head_t page_wait_table[PAGE_WAIT_TABLE_SIZE] __cacheline_aligned;
1004
page_waitqueue(struct page * page)1005 static wait_queue_head_t *page_waitqueue(struct page *page)
1006 {
1007 return &page_wait_table[hash_ptr(page, PAGE_WAIT_TABLE_BITS)];
1008 }
1009
pagecache_init(void)1010 void __init pagecache_init(void)
1011 {
1012 int i;
1013
1014 for (i = 0; i < PAGE_WAIT_TABLE_SIZE; i++)
1015 init_waitqueue_head(&page_wait_table[i]);
1016
1017 page_writeback_init();
1018 }
1019
1020 /*
1021 * The page wait code treats the "wait->flags" somewhat unusually, because
1022 * we have multiple different kinds of waits, not just the usual "exclusive"
1023 * one.
1024 *
1025 * We have:
1026 *
1027 * (a) no special bits set:
1028 *
1029 * We're just waiting for the bit to be released, and when a waker
1030 * calls the wakeup function, we set WQ_FLAG_WOKEN and wake it up,
1031 * and remove it from the wait queue.
1032 *
1033 * Simple and straightforward.
1034 *
1035 * (b) WQ_FLAG_EXCLUSIVE:
1036 *
1037 * The waiter is waiting to get the lock, and only one waiter should
1038 * be woken up to avoid any thundering herd behavior. We'll set the
1039 * WQ_FLAG_WOKEN bit, wake it up, and remove it from the wait queue.
1040 *
1041 * This is the traditional exclusive wait.
1042 *
1043 * (c) WQ_FLAG_EXCLUSIVE | WQ_FLAG_CUSTOM:
1044 *
1045 * The waiter is waiting to get the bit, and additionally wants the
1046 * lock to be transferred to it for fair lock behavior. If the lock
1047 * cannot be taken, we stop walking the wait queue without waking
1048 * the waiter.
1049 *
1050 * This is the "fair lock handoff" case, and in addition to setting
1051 * WQ_FLAG_WOKEN, we set WQ_FLAG_DONE to let the waiter easily see
1052 * that it now has the lock.
1053 */
wake_page_function(wait_queue_entry_t * wait,unsigned mode,int sync,void * arg)1054 static int wake_page_function(wait_queue_entry_t *wait, unsigned mode, int sync, void *arg)
1055 {
1056 unsigned int flags;
1057 struct wait_page_key *key = arg;
1058 struct wait_page_queue *wait_page
1059 = container_of(wait, struct wait_page_queue, wait);
1060
1061 if (!wake_page_match(wait_page, key))
1062 return 0;
1063
1064 /*
1065 * If it's a lock handoff wait, we get the bit for it, and
1066 * stop walking (and do not wake it up) if we can't.
1067 */
1068 flags = wait->flags;
1069 if (flags & WQ_FLAG_EXCLUSIVE) {
1070 if (test_bit(key->bit_nr, &key->page->flags))
1071 return -1;
1072 if (flags & WQ_FLAG_CUSTOM) {
1073 if (test_and_set_bit(key->bit_nr, &key->page->flags))
1074 return -1;
1075 flags |= WQ_FLAG_DONE;
1076 }
1077 }
1078
1079 /*
1080 * We are holding the wait-queue lock, but the waiter that
1081 * is waiting for this will be checking the flags without
1082 * any locking.
1083 *
1084 * So update the flags atomically, and wake up the waiter
1085 * afterwards to avoid any races. This store-release pairs
1086 * with the load-acquire in wait_on_page_bit_common().
1087 */
1088 smp_store_release(&wait->flags, flags | WQ_FLAG_WOKEN);
1089 wake_up_state(wait->private, mode);
1090
1091 /*
1092 * Ok, we have successfully done what we're waiting for,
1093 * and we can unconditionally remove the wait entry.
1094 *
1095 * Note that this pairs with the "finish_wait()" in the
1096 * waiter, and has to be the absolute last thing we do.
1097 * After this list_del_init(&wait->entry) the wait entry
1098 * might be de-allocated and the process might even have
1099 * exited.
1100 */
1101 list_del_init_careful(&wait->entry);
1102 return (flags & WQ_FLAG_EXCLUSIVE) != 0;
1103 }
1104
wake_up_page_bit(struct page * page,int bit_nr)1105 static void wake_up_page_bit(struct page *page, int bit_nr)
1106 {
1107 wait_queue_head_t *q = page_waitqueue(page);
1108 struct wait_page_key key;
1109 unsigned long flags;
1110 wait_queue_entry_t bookmark;
1111
1112 key.page = page;
1113 key.bit_nr = bit_nr;
1114 key.page_match = 0;
1115
1116 bookmark.flags = 0;
1117 bookmark.private = NULL;
1118 bookmark.func = NULL;
1119 INIT_LIST_HEAD(&bookmark.entry);
1120
1121 spin_lock_irqsave(&q->lock, flags);
1122 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1123
1124 while (bookmark.flags & WQ_FLAG_BOOKMARK) {
1125 /*
1126 * Take a breather from holding the lock,
1127 * allow pages that finish wake up asynchronously
1128 * to acquire the lock and remove themselves
1129 * from wait queue
1130 */
1131 spin_unlock_irqrestore(&q->lock, flags);
1132 cpu_relax();
1133 spin_lock_irqsave(&q->lock, flags);
1134 __wake_up_locked_key_bookmark(q, TASK_NORMAL, &key, &bookmark);
1135 }
1136
1137 /*
1138 * It is possible for other pages to have collided on the waitqueue
1139 * hash, so in that case check for a page match. That prevents a long-
1140 * term waiter
1141 *
1142 * It is still possible to miss a case here, when we woke page waiters
1143 * and removed them from the waitqueue, but there are still other
1144 * page waiters.
1145 */
1146 if (!waitqueue_active(q) || !key.page_match) {
1147 ClearPageWaiters(page);
1148 /*
1149 * It's possible to miss clearing Waiters here, when we woke
1150 * our page waiters, but the hashed waitqueue has waiters for
1151 * other pages on it.
1152 *
1153 * That's okay, it's a rare case. The next waker will clear it.
1154 */
1155 }
1156 spin_unlock_irqrestore(&q->lock, flags);
1157 }
1158
wake_up_page(struct page * page,int bit)1159 static void wake_up_page(struct page *page, int bit)
1160 {
1161 if (!PageWaiters(page))
1162 return;
1163 wake_up_page_bit(page, bit);
1164 }
1165
1166 /*
1167 * A choice of three behaviors for wait_on_page_bit_common():
1168 */
1169 enum behavior {
1170 EXCLUSIVE, /* Hold ref to page and take the bit when woken, like
1171 * __lock_page() waiting on then setting PG_locked.
1172 */
1173 SHARED, /* Hold ref to page and check the bit when woken, like
1174 * wait_on_page_writeback() waiting on PG_writeback.
1175 */
1176 DROP, /* Drop ref to page before wait, no check when woken,
1177 * like put_and_wait_on_page_locked() on PG_locked.
1178 */
1179 };
1180
1181 /*
1182 * Attempt to check (or get) the page bit, and mark us done
1183 * if successful.
1184 */
trylock_page_bit_common(struct page * page,int bit_nr,struct wait_queue_entry * wait)1185 static inline bool trylock_page_bit_common(struct page *page, int bit_nr,
1186 struct wait_queue_entry *wait)
1187 {
1188 if (wait->flags & WQ_FLAG_EXCLUSIVE) {
1189 if (test_and_set_bit(bit_nr, &page->flags))
1190 return false;
1191 } else if (test_bit(bit_nr, &page->flags))
1192 return false;
1193
1194 wait->flags |= WQ_FLAG_WOKEN | WQ_FLAG_DONE;
1195 return true;
1196 }
1197
1198 /* How many times do we accept lock stealing from under a waiter? */
1199 int sysctl_page_lock_unfairness = 5;
1200
wait_on_page_bit_common(wait_queue_head_t * q,struct page * page,int bit_nr,int state,enum behavior behavior)1201 static inline __sched int wait_on_page_bit_common(wait_queue_head_t *q,
1202 struct page *page, int bit_nr, int state, enum behavior behavior)
1203 {
1204 int unfairness = sysctl_page_lock_unfairness;
1205 struct wait_page_queue wait_page;
1206 wait_queue_entry_t *wait = &wait_page.wait;
1207 bool thrashing = false;
1208 bool delayacct = false;
1209 unsigned long pflags;
1210
1211 if (bit_nr == PG_locked &&
1212 !PageUptodate(page) && PageWorkingset(page)) {
1213 if (!PageSwapBacked(page)) {
1214 delayacct_thrashing_start();
1215 delayacct = true;
1216 }
1217 psi_memstall_enter(&pflags);
1218 thrashing = true;
1219 }
1220
1221 init_wait(wait);
1222 wait->func = wake_page_function;
1223 wait_page.page = page;
1224 wait_page.bit_nr = bit_nr;
1225
1226 repeat:
1227 wait->flags = 0;
1228 if (behavior == EXCLUSIVE) {
1229 wait->flags = WQ_FLAG_EXCLUSIVE;
1230 if (--unfairness < 0)
1231 wait->flags |= WQ_FLAG_CUSTOM;
1232 }
1233
1234 /*
1235 * Do one last check whether we can get the
1236 * page bit synchronously.
1237 *
1238 * Do the SetPageWaiters() marking before that
1239 * to let any waker we _just_ missed know they
1240 * need to wake us up (otherwise they'll never
1241 * even go to the slow case that looks at the
1242 * page queue), and add ourselves to the wait
1243 * queue if we need to sleep.
1244 *
1245 * This part needs to be done under the queue
1246 * lock to avoid races.
1247 */
1248 spin_lock_irq(&q->lock);
1249 SetPageWaiters(page);
1250 if (!trylock_page_bit_common(page, bit_nr, wait))
1251 __add_wait_queue_entry_tail(q, wait);
1252 spin_unlock_irq(&q->lock);
1253
1254 /*
1255 * From now on, all the logic will be based on
1256 * the WQ_FLAG_WOKEN and WQ_FLAG_DONE flag, to
1257 * see whether the page bit testing has already
1258 * been done by the wake function.
1259 *
1260 * We can drop our reference to the page.
1261 */
1262 if (behavior == DROP)
1263 put_page(page);
1264
1265 /*
1266 * Note that until the "finish_wait()", or until
1267 * we see the WQ_FLAG_WOKEN flag, we need to
1268 * be very careful with the 'wait->flags', because
1269 * we may race with a waker that sets them.
1270 */
1271 for (;;) {
1272 unsigned int flags;
1273
1274 set_current_state(state);
1275
1276 /* Loop until we've been woken or interrupted */
1277 flags = smp_load_acquire(&wait->flags);
1278 if (!(flags & WQ_FLAG_WOKEN)) {
1279 if (signal_pending_state(state, current))
1280 break;
1281
1282 io_schedule();
1283 continue;
1284 }
1285
1286 /* If we were non-exclusive, we're done */
1287 if (behavior != EXCLUSIVE)
1288 break;
1289
1290 /* If the waker got the lock for us, we're done */
1291 if (flags & WQ_FLAG_DONE)
1292 break;
1293
1294 /*
1295 * Otherwise, if we're getting the lock, we need to
1296 * try to get it ourselves.
1297 *
1298 * And if that fails, we'll have to retry this all.
1299 */
1300 if (unlikely(test_and_set_bit(bit_nr, &page->flags)))
1301 goto repeat;
1302
1303 wait->flags |= WQ_FLAG_DONE;
1304 break;
1305 }
1306
1307 /*
1308 * If a signal happened, this 'finish_wait()' may remove the last
1309 * waiter from the wait-queues, but the PageWaiters bit will remain
1310 * set. That's ok. The next wakeup will take care of it, and trying
1311 * to do it here would be difficult and prone to races.
1312 */
1313 finish_wait(q, wait);
1314
1315 if (thrashing) {
1316 if (delayacct)
1317 delayacct_thrashing_end();
1318 psi_memstall_leave(&pflags);
1319 }
1320
1321 /*
1322 * NOTE! The wait->flags weren't stable until we've done the
1323 * 'finish_wait()', and we could have exited the loop above due
1324 * to a signal, and had a wakeup event happen after the signal
1325 * test but before the 'finish_wait()'.
1326 *
1327 * So only after the finish_wait() can we reliably determine
1328 * if we got woken up or not, so we can now figure out the final
1329 * return value based on that state without races.
1330 *
1331 * Also note that WQ_FLAG_WOKEN is sufficient for a non-exclusive
1332 * waiter, but an exclusive one requires WQ_FLAG_DONE.
1333 */
1334 if (behavior == EXCLUSIVE)
1335 return wait->flags & WQ_FLAG_DONE ? 0 : -EINTR;
1336
1337 return wait->flags & WQ_FLAG_WOKEN ? 0 : -EINTR;
1338 }
1339
wait_on_page_bit(struct page * page,int bit_nr)1340 __sched void wait_on_page_bit(struct page *page, int bit_nr)
1341 {
1342 wait_queue_head_t *q = page_waitqueue(page);
1343 wait_on_page_bit_common(q, page, bit_nr, TASK_UNINTERRUPTIBLE, SHARED);
1344 }
1345 EXPORT_SYMBOL(wait_on_page_bit);
1346
wait_on_page_bit_killable(struct page * page,int bit_nr)1347 __sched int wait_on_page_bit_killable(struct page *page, int bit_nr)
1348 {
1349 wait_queue_head_t *q = page_waitqueue(page);
1350 return wait_on_page_bit_common(q, page, bit_nr, TASK_KILLABLE, SHARED);
1351 }
1352 EXPORT_SYMBOL(wait_on_page_bit_killable);
1353
__wait_on_page_locked_async(struct page * page,struct wait_page_queue * wait,bool set)1354 static int __wait_on_page_locked_async(struct page *page,
1355 struct wait_page_queue *wait, bool set)
1356 {
1357 struct wait_queue_head *q = page_waitqueue(page);
1358 int ret = 0;
1359
1360 wait->page = page;
1361 wait->bit_nr = PG_locked;
1362
1363 spin_lock_irq(&q->lock);
1364 __add_wait_queue_entry_tail(q, &wait->wait);
1365 SetPageWaiters(page);
1366 if (set)
1367 ret = !trylock_page(page);
1368 else
1369 ret = PageLocked(page);
1370 /*
1371 * If we were succesful now, we know we're still on the
1372 * waitqueue as we're still under the lock. This means it's
1373 * safe to remove and return success, we know the callback
1374 * isn't going to trigger.
1375 */
1376 if (!ret)
1377 __remove_wait_queue(q, &wait->wait);
1378 else
1379 ret = -EIOCBQUEUED;
1380 spin_unlock_irq(&q->lock);
1381 return ret;
1382 }
1383
wait_on_page_locked_async(struct page * page,struct wait_page_queue * wait)1384 static int wait_on_page_locked_async(struct page *page,
1385 struct wait_page_queue *wait)
1386 {
1387 if (!PageLocked(page))
1388 return 0;
1389 return __wait_on_page_locked_async(compound_head(page), wait, false);
1390 }
1391
1392 /**
1393 * put_and_wait_on_page_locked - Drop a reference and wait for it to be unlocked
1394 * @page: The page to wait for.
1395 *
1396 * The caller should hold a reference on @page. They expect the page to
1397 * become unlocked relatively soon, but do not wish to hold up migration
1398 * (for example) by holding the reference while waiting for the page to
1399 * come unlocked. After this function returns, the caller should not
1400 * dereference @page.
1401 */
put_and_wait_on_page_locked(struct page * page)1402 void put_and_wait_on_page_locked(struct page *page)
1403 {
1404 wait_queue_head_t *q;
1405
1406 page = compound_head(page);
1407 q = page_waitqueue(page);
1408 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE, DROP);
1409 }
1410
1411 /**
1412 * add_page_wait_queue - Add an arbitrary waiter to a page's wait queue
1413 * @page: Page defining the wait queue of interest
1414 * @waiter: Waiter to add to the queue
1415 *
1416 * Add an arbitrary @waiter to the wait queue for the nominated @page.
1417 */
add_page_wait_queue(struct page * page,wait_queue_entry_t * waiter)1418 void add_page_wait_queue(struct page *page, wait_queue_entry_t *waiter)
1419 {
1420 wait_queue_head_t *q = page_waitqueue(page);
1421 unsigned long flags;
1422
1423 spin_lock_irqsave(&q->lock, flags);
1424 __add_wait_queue_entry_tail(q, waiter);
1425 SetPageWaiters(page);
1426 spin_unlock_irqrestore(&q->lock, flags);
1427 }
1428 EXPORT_SYMBOL_GPL(add_page_wait_queue);
1429
1430 #ifndef clear_bit_unlock_is_negative_byte
1431
1432 /*
1433 * PG_waiters is the high bit in the same byte as PG_lock.
1434 *
1435 * On x86 (and on many other architectures), we can clear PG_lock and
1436 * test the sign bit at the same time. But if the architecture does
1437 * not support that special operation, we just do this all by hand
1438 * instead.
1439 *
1440 * The read of PG_waiters has to be after (or concurrently with) PG_locked
1441 * being cleared, but a memory barrier should be unnecessary since it is
1442 * in the same byte as PG_locked.
1443 */
clear_bit_unlock_is_negative_byte(long nr,volatile void * mem)1444 static inline bool clear_bit_unlock_is_negative_byte(long nr, volatile void *mem)
1445 {
1446 clear_bit_unlock(nr, mem);
1447 /* smp_mb__after_atomic(); */
1448 return test_bit(PG_waiters, mem);
1449 }
1450
1451 #endif
1452
1453 /**
1454 * unlock_page - unlock a locked page
1455 * @page: the page
1456 *
1457 * Unlocks the page and wakes up sleepers in wait_on_page_locked().
1458 * Also wakes sleepers in wait_on_page_writeback() because the wakeup
1459 * mechanism between PageLocked pages and PageWriteback pages is shared.
1460 * But that's OK - sleepers in wait_on_page_writeback() just go back to sleep.
1461 *
1462 * Note that this depends on PG_waiters being the sign bit in the byte
1463 * that contains PG_locked - thus the BUILD_BUG_ON(). That allows us to
1464 * clear the PG_locked bit and test PG_waiters at the same time fairly
1465 * portably (architectures that do LL/SC can test any bit, while x86 can
1466 * test the sign bit).
1467 */
unlock_page(struct page * page)1468 void unlock_page(struct page *page)
1469 {
1470 BUILD_BUG_ON(PG_waiters != 7);
1471 page = compound_head(page);
1472 VM_BUG_ON_PAGE(!PageLocked(page), page);
1473 if (clear_bit_unlock_is_negative_byte(PG_locked, &page->flags))
1474 wake_up_page_bit(page, PG_locked);
1475 }
1476 EXPORT_SYMBOL(unlock_page);
1477
1478 /**
1479 * end_page_writeback - end writeback against a page
1480 * @page: the page
1481 */
end_page_writeback(struct page * page)1482 void end_page_writeback(struct page *page)
1483 {
1484 /*
1485 * TestClearPageReclaim could be used here but it is an atomic
1486 * operation and overkill in this particular case. Failing to
1487 * shuffle a page marked for immediate reclaim is too mild to
1488 * justify taking an atomic operation penalty at the end of
1489 * ever page writeback.
1490 */
1491 if (PageReclaim(page)) {
1492 ClearPageReclaim(page);
1493 rotate_reclaimable_page(page);
1494 }
1495
1496 /*
1497 * Writeback does not hold a page reference of its own, relying
1498 * on truncation to wait for the clearing of PG_writeback.
1499 * But here we must make sure that the page is not freed and
1500 * reused before the wake_up_page().
1501 */
1502 get_page(page);
1503 if (!test_clear_page_writeback(page))
1504 BUG();
1505
1506 smp_mb__after_atomic();
1507 wake_up_page(page, PG_writeback);
1508 put_page(page);
1509 }
1510 EXPORT_SYMBOL(end_page_writeback);
1511
1512 /*
1513 * After completing I/O on a page, call this routine to update the page
1514 * flags appropriately
1515 */
page_endio(struct page * page,bool is_write,int err)1516 void page_endio(struct page *page, bool is_write, int err)
1517 {
1518 if (!is_write) {
1519 if (!err) {
1520 SetPageUptodate(page);
1521 } else {
1522 ClearPageUptodate(page);
1523 SetPageError(page);
1524 }
1525 unlock_page(page);
1526 } else {
1527 if (err) {
1528 struct address_space *mapping;
1529
1530 SetPageError(page);
1531 mapping = page_mapping(page);
1532 if (mapping)
1533 mapping_set_error(mapping, err);
1534 }
1535 end_page_writeback(page);
1536 }
1537 }
1538 EXPORT_SYMBOL_GPL(page_endio);
1539
1540 /**
1541 * __lock_page - get a lock on the page, assuming we need to sleep to get it
1542 * @__page: the page to lock
1543 */
__lock_page(struct page * __page)1544 __sched void __lock_page(struct page *__page)
1545 {
1546 struct page *page = compound_head(__page);
1547 wait_queue_head_t *q = page_waitqueue(page);
1548 wait_on_page_bit_common(q, page, PG_locked, TASK_UNINTERRUPTIBLE,
1549 EXCLUSIVE);
1550 }
1551 EXPORT_SYMBOL(__lock_page);
1552
__lock_page_killable(struct page * __page)1553 __sched int __lock_page_killable(struct page *__page)
1554 {
1555 struct page *page = compound_head(__page);
1556 wait_queue_head_t *q = page_waitqueue(page);
1557 return wait_on_page_bit_common(q, page, PG_locked, TASK_KILLABLE,
1558 EXCLUSIVE);
1559 }
1560 EXPORT_SYMBOL_GPL(__lock_page_killable);
1561
__lock_page_async(struct page * page,struct wait_page_queue * wait)1562 __sched int __lock_page_async(struct page *page, struct wait_page_queue *wait)
1563 {
1564 return __wait_on_page_locked_async(page, wait, true);
1565 }
1566
1567 /*
1568 * Return values:
1569 * 1 - page is locked; mmap_lock is still held.
1570 * 0 - page is not locked.
1571 * mmap_lock has been released (mmap_read_unlock(), unless flags had both
1572 * FAULT_FLAG_ALLOW_RETRY and FAULT_FLAG_RETRY_NOWAIT set, in
1573 * which case mmap_lock is still held.
1574 *
1575 * If neither ALLOW_RETRY nor KILLABLE are set, will always return 1
1576 * with the page locked and the mmap_lock unperturbed.
1577 */
__lock_page_or_retry(struct page * page,struct mm_struct * mm,unsigned int flags)1578 __sched int __lock_page_or_retry(struct page *page, struct mm_struct *mm,
1579 unsigned int flags)
1580 {
1581 if (fault_flag_allow_retry_first(flags)) {
1582 /*
1583 * CAUTION! In this case, mmap_lock is not released
1584 * even though return 0.
1585 */
1586 if (flags & FAULT_FLAG_RETRY_NOWAIT)
1587 return 0;
1588
1589 mmap_read_unlock(mm);
1590 if (flags & FAULT_FLAG_KILLABLE)
1591 wait_on_page_locked_killable(page);
1592 else
1593 wait_on_page_locked(page);
1594 return 0;
1595 } else {
1596 if (flags & FAULT_FLAG_KILLABLE) {
1597 int ret;
1598
1599 ret = __lock_page_killable(page);
1600 if (ret) {
1601 mmap_read_unlock(mm);
1602 return 0;
1603 }
1604 } else
1605 __lock_page(page);
1606 return 1;
1607 }
1608 }
1609
1610 /**
1611 * page_cache_next_miss() - Find the next gap in the page cache.
1612 * @mapping: Mapping.
1613 * @index: Index.
1614 * @max_scan: Maximum range to search.
1615 *
1616 * Search the range [index, min(index + max_scan - 1, ULONG_MAX)] for the
1617 * gap with the lowest index.
1618 *
1619 * This function may be called under the rcu_read_lock. However, this will
1620 * not atomically search a snapshot of the cache at a single point in time.
1621 * For example, if a gap is created at index 5, then subsequently a gap is
1622 * created at index 10, page_cache_next_miss covering both indices may
1623 * return 10 if called under the rcu_read_lock.
1624 *
1625 * Return: The index of the gap if found, otherwise an index outside the
1626 * range specified (in which case 'return - index >= max_scan' will be true).
1627 * In the rare case of index wrap-around, 0 will be returned.
1628 */
page_cache_next_miss(struct address_space * mapping,pgoff_t index,unsigned long max_scan)1629 pgoff_t page_cache_next_miss(struct address_space *mapping,
1630 pgoff_t index, unsigned long max_scan)
1631 {
1632 XA_STATE(xas, &mapping->i_pages, index);
1633
1634 while (max_scan--) {
1635 void *entry = xas_next(&xas);
1636 if (!entry || xa_is_value(entry))
1637 break;
1638 if (xas.xa_index == 0)
1639 break;
1640 }
1641
1642 return xas.xa_index;
1643 }
1644 EXPORT_SYMBOL(page_cache_next_miss);
1645
1646 /**
1647 * page_cache_prev_miss() - Find the previous gap in the page cache.
1648 * @mapping: Mapping.
1649 * @index: Index.
1650 * @max_scan: Maximum range to search.
1651 *
1652 * Search the range [max(index - max_scan + 1, 0), index] for the
1653 * gap with the highest index.
1654 *
1655 * This function may be called under the rcu_read_lock. However, this will
1656 * not atomically search a snapshot of the cache at a single point in time.
1657 * For example, if a gap is created at index 10, then subsequently a gap is
1658 * created at index 5, page_cache_prev_miss() covering both indices may
1659 * return 5 if called under the rcu_read_lock.
1660 *
1661 * Return: The index of the gap if found, otherwise an index outside the
1662 * range specified (in which case 'index - return >= max_scan' will be true).
1663 * In the rare case of wrap-around, ULONG_MAX will be returned.
1664 */
page_cache_prev_miss(struct address_space * mapping,pgoff_t index,unsigned long max_scan)1665 pgoff_t page_cache_prev_miss(struct address_space *mapping,
1666 pgoff_t index, unsigned long max_scan)
1667 {
1668 XA_STATE(xas, &mapping->i_pages, index);
1669
1670 while (max_scan--) {
1671 void *entry = xas_prev(&xas);
1672 if (!entry || xa_is_value(entry))
1673 break;
1674 if (xas.xa_index == ULONG_MAX)
1675 break;
1676 }
1677
1678 return xas.xa_index;
1679 }
1680 EXPORT_SYMBOL(page_cache_prev_miss);
1681
1682 /**
1683 * find_get_entry - find and get a page cache entry
1684 * @mapping: the address_space to search
1685 * @index: The page cache index.
1686 *
1687 * Looks up the page cache slot at @mapping & @offset. If there is a
1688 * page cache page, the head page is returned with an increased refcount.
1689 *
1690 * If the slot holds a shadow entry of a previously evicted page, or a
1691 * swap entry from shmem/tmpfs, it is returned.
1692 *
1693 * Return: The head page or shadow entry, %NULL if nothing is found.
1694 */
find_get_entry(struct address_space * mapping,pgoff_t index)1695 struct page *find_get_entry(struct address_space *mapping, pgoff_t index)
1696 {
1697 XA_STATE(xas, &mapping->i_pages, index);
1698 struct page *page;
1699
1700 rcu_read_lock();
1701 repeat:
1702 xas_reset(&xas);
1703 page = xas_load(&xas);
1704 if (xas_retry(&xas, page))
1705 goto repeat;
1706 /*
1707 * A shadow entry of a recently evicted page, or a swap entry from
1708 * shmem/tmpfs. Return it without attempting to raise page count.
1709 */
1710 if (!page || xa_is_value(page))
1711 goto out;
1712
1713 if (!page_cache_get_speculative(page))
1714 goto repeat;
1715
1716 /*
1717 * Has the page moved or been split?
1718 * This is part of the lockless pagecache protocol. See
1719 * include/linux/pagemap.h for details.
1720 */
1721 if (unlikely(page != xas_reload(&xas))) {
1722 put_page(page);
1723 goto repeat;
1724 }
1725 out:
1726 rcu_read_unlock();
1727
1728 return page;
1729 }
1730
1731 /**
1732 * find_lock_entry - Locate and lock a page cache entry.
1733 * @mapping: The address_space to search.
1734 * @index: The page cache index.
1735 *
1736 * Looks up the page at @mapping & @index. If there is a page in the
1737 * cache, the head page is returned locked and with an increased refcount.
1738 *
1739 * If the slot holds a shadow entry of a previously evicted page, or a
1740 * swap entry from shmem/tmpfs, it is returned.
1741 *
1742 * Context: May sleep.
1743 * Return: The head page or shadow entry, %NULL if nothing is found.
1744 */
find_lock_entry(struct address_space * mapping,pgoff_t index)1745 struct page *find_lock_entry(struct address_space *mapping, pgoff_t index)
1746 {
1747 struct page *page;
1748
1749 repeat:
1750 page = find_get_entry(mapping, index);
1751 if (page && !xa_is_value(page)) {
1752 lock_page(page);
1753 /* Has the page been truncated? */
1754 if (unlikely(page->mapping != mapping)) {
1755 unlock_page(page);
1756 put_page(page);
1757 goto repeat;
1758 }
1759 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
1760 }
1761 return page;
1762 }
1763
1764 /**
1765 * pagecache_get_page - Find and get a reference to a page.
1766 * @mapping: The address_space to search.
1767 * @index: The page index.
1768 * @fgp_flags: %FGP flags modify how the page is returned.
1769 * @gfp_mask: Memory allocation flags to use if %FGP_CREAT is specified.
1770 *
1771 * Looks up the page cache entry at @mapping & @index.
1772 *
1773 * @fgp_flags can be zero or more of these flags:
1774 *
1775 * * %FGP_ACCESSED - The page will be marked accessed.
1776 * * %FGP_LOCK - The page is returned locked.
1777 * * %FGP_HEAD - If the page is present and a THP, return the head page
1778 * rather than the exact page specified by the index.
1779 * * %FGP_CREAT - If no page is present then a new page is allocated using
1780 * @gfp_mask and added to the page cache and the VM's LRU list.
1781 * The page is returned locked and with an increased refcount.
1782 * * %FGP_FOR_MMAP - The caller wants to do its own locking dance if the
1783 * page is already in cache. If the page was allocated, unlock it before
1784 * returning so the caller can do the same dance.
1785 * * %FGP_WRITE - The page will be written
1786 * * %FGP_NOFS - __GFP_FS will get cleared in gfp mask
1787 * * %FGP_NOWAIT - Don't get blocked by page lock
1788 *
1789 * If %FGP_LOCK or %FGP_CREAT are specified then the function may sleep even
1790 * if the %GFP flags specified for %FGP_CREAT are atomic.
1791 *
1792 * If there is a page cache page, it is returned with an increased refcount.
1793 *
1794 * Return: The found page or %NULL otherwise.
1795 */
pagecache_get_page(struct address_space * mapping,pgoff_t index,int fgp_flags,gfp_t gfp_mask)1796 struct page *pagecache_get_page(struct address_space *mapping, pgoff_t index,
1797 int fgp_flags, gfp_t gfp_mask)
1798 {
1799 struct page *page;
1800
1801 repeat:
1802 page = find_get_entry(mapping, index);
1803 if (xa_is_value(page))
1804 page = NULL;
1805
1806 trace_android_vh_pagecache_get_page(mapping, index, fgp_flags,
1807 gfp_mask, page);
1808 if (!page)
1809 goto no_page;
1810
1811 if (fgp_flags & FGP_LOCK) {
1812 if (fgp_flags & FGP_NOWAIT) {
1813 if (!trylock_page(page)) {
1814 put_page(page);
1815 return NULL;
1816 }
1817 } else {
1818 lock_page(page);
1819 }
1820
1821 /* Has the page been truncated? */
1822 if (unlikely(page->mapping != mapping)) {
1823 unlock_page(page);
1824 put_page(page);
1825 goto repeat;
1826 }
1827 VM_BUG_ON_PAGE(!thp_contains(page, index), page);
1828 }
1829
1830 if (fgp_flags & FGP_ACCESSED)
1831 mark_page_accessed(page);
1832 else if (fgp_flags & FGP_WRITE) {
1833 /* Clear idle flag for buffer write */
1834 if (page_is_idle(page))
1835 clear_page_idle(page);
1836 }
1837 if (!(fgp_flags & FGP_HEAD))
1838 page = find_subpage(page, index);
1839
1840 no_page:
1841 if (!page && (fgp_flags & FGP_CREAT)) {
1842 int err;
1843 if ((fgp_flags & FGP_WRITE) && mapping_can_writeback(mapping))
1844 gfp_mask |= __GFP_WRITE;
1845 if (fgp_flags & FGP_NOFS)
1846 gfp_mask &= ~__GFP_FS;
1847
1848 page = __page_cache_alloc(gfp_mask);
1849 if (!page)
1850 return NULL;
1851
1852 if (WARN_ON_ONCE(!(fgp_flags & (FGP_LOCK | FGP_FOR_MMAP))))
1853 fgp_flags |= FGP_LOCK;
1854
1855 /* Init accessed so avoid atomic mark_page_accessed later */
1856 if (fgp_flags & FGP_ACCESSED)
1857 __SetPageReferenced(page);
1858
1859 err = add_to_page_cache_lru(page, mapping, index, gfp_mask);
1860 if (unlikely(err)) {
1861 put_page(page);
1862 page = NULL;
1863 if (err == -EEXIST)
1864 goto repeat;
1865 }
1866
1867 /*
1868 * add_to_page_cache_lru locks the page, and for mmap we expect
1869 * an unlocked page.
1870 */
1871 if (page && (fgp_flags & FGP_FOR_MMAP))
1872 unlock_page(page);
1873 }
1874
1875 return page;
1876 }
1877 EXPORT_SYMBOL(pagecache_get_page);
1878
1879 /**
1880 * find_get_entries - gang pagecache lookup
1881 * @mapping: The address_space to search
1882 * @start: The starting page cache index
1883 * @nr_entries: The maximum number of entries
1884 * @entries: Where the resulting entries are placed
1885 * @indices: The cache indices corresponding to the entries in @entries
1886 *
1887 * find_get_entries() will search for and return a group of up to
1888 * @nr_entries entries in the mapping. The entries are placed at
1889 * @entries. find_get_entries() takes a reference against any actual
1890 * pages it returns.
1891 *
1892 * The search returns a group of mapping-contiguous page cache entries
1893 * with ascending indexes. There may be holes in the indices due to
1894 * not-present pages.
1895 *
1896 * Any shadow entries of evicted pages, or swap entries from
1897 * shmem/tmpfs, are included in the returned array.
1898 *
1899 * If it finds a Transparent Huge Page, head or tail, find_get_entries()
1900 * stops at that page: the caller is likely to have a better way to handle
1901 * the compound page as a whole, and then skip its extent, than repeatedly
1902 * calling find_get_entries() to return all its tails.
1903 *
1904 * Return: the number of pages and shadow entries which were found.
1905 */
find_get_entries(struct address_space * mapping,pgoff_t start,unsigned int nr_entries,struct page ** entries,pgoff_t * indices)1906 unsigned find_get_entries(struct address_space *mapping,
1907 pgoff_t start, unsigned int nr_entries,
1908 struct page **entries, pgoff_t *indices)
1909 {
1910 XA_STATE(xas, &mapping->i_pages, start);
1911 struct page *page;
1912 unsigned int ret = 0;
1913
1914 if (!nr_entries)
1915 return 0;
1916
1917 rcu_read_lock();
1918 xas_for_each(&xas, page, ULONG_MAX) {
1919 if (xas_retry(&xas, page))
1920 continue;
1921 /*
1922 * A shadow entry of a recently evicted page, a swap
1923 * entry from shmem/tmpfs or a DAX entry. Return it
1924 * without attempting to raise page count.
1925 */
1926 if (xa_is_value(page))
1927 goto export;
1928
1929 if (!page_cache_get_speculative(page))
1930 goto retry;
1931
1932 /* Has the page moved or been split? */
1933 if (unlikely(page != xas_reload(&xas)))
1934 goto put_page;
1935
1936 /*
1937 * Terminate early on finding a THP, to allow the caller to
1938 * handle it all at once; but continue if this is hugetlbfs.
1939 */
1940 if (PageTransHuge(page) && !PageHuge(page)) {
1941 page = find_subpage(page, xas.xa_index);
1942 nr_entries = ret + 1;
1943 }
1944 export:
1945 indices[ret] = xas.xa_index;
1946 entries[ret] = page;
1947 if (++ret == nr_entries)
1948 break;
1949 continue;
1950 put_page:
1951 put_page(page);
1952 retry:
1953 xas_reset(&xas);
1954 }
1955 rcu_read_unlock();
1956 return ret;
1957 }
1958
1959 /**
1960 * find_get_pages_range - gang pagecache lookup
1961 * @mapping: The address_space to search
1962 * @start: The starting page index
1963 * @end: The final page index (inclusive)
1964 * @nr_pages: The maximum number of pages
1965 * @pages: Where the resulting pages are placed
1966 *
1967 * find_get_pages_range() will search for and return a group of up to @nr_pages
1968 * pages in the mapping starting at index @start and up to index @end
1969 * (inclusive). The pages are placed at @pages. find_get_pages_range() takes
1970 * a reference against the returned pages.
1971 *
1972 * The search returns a group of mapping-contiguous pages with ascending
1973 * indexes. There may be holes in the indices due to not-present pages.
1974 * We also update @start to index the next page for the traversal.
1975 *
1976 * Return: the number of pages which were found. If this number is
1977 * smaller than @nr_pages, the end of specified range has been
1978 * reached.
1979 */
find_get_pages_range(struct address_space * mapping,pgoff_t * start,pgoff_t end,unsigned int nr_pages,struct page ** pages)1980 unsigned find_get_pages_range(struct address_space *mapping, pgoff_t *start,
1981 pgoff_t end, unsigned int nr_pages,
1982 struct page **pages)
1983 {
1984 XA_STATE(xas, &mapping->i_pages, *start);
1985 struct page *page;
1986 unsigned ret = 0;
1987
1988 if (unlikely(!nr_pages))
1989 return 0;
1990
1991 rcu_read_lock();
1992 xas_for_each(&xas, page, end) {
1993 if (xas_retry(&xas, page))
1994 continue;
1995 /* Skip over shadow, swap and DAX entries */
1996 if (xa_is_value(page))
1997 continue;
1998
1999 if (!page_cache_get_speculative(page))
2000 goto retry;
2001
2002 /* Has the page moved or been split? */
2003 if (unlikely(page != xas_reload(&xas)))
2004 goto put_page;
2005
2006 pages[ret] = find_subpage(page, xas.xa_index);
2007 if (++ret == nr_pages) {
2008 *start = xas.xa_index + 1;
2009 goto out;
2010 }
2011 continue;
2012 put_page:
2013 put_page(page);
2014 retry:
2015 xas_reset(&xas);
2016 }
2017
2018 /*
2019 * We come here when there is no page beyond @end. We take care to not
2020 * overflow the index @start as it confuses some of the callers. This
2021 * breaks the iteration when there is a page at index -1 but that is
2022 * already broken anyway.
2023 */
2024 if (end == (pgoff_t)-1)
2025 *start = (pgoff_t)-1;
2026 else
2027 *start = end + 1;
2028 out:
2029 rcu_read_unlock();
2030
2031 return ret;
2032 }
2033
2034 /**
2035 * find_get_pages_contig - gang contiguous pagecache lookup
2036 * @mapping: The address_space to search
2037 * @index: The starting page index
2038 * @nr_pages: The maximum number of pages
2039 * @pages: Where the resulting pages are placed
2040 *
2041 * find_get_pages_contig() works exactly like find_get_pages(), except
2042 * that the returned number of pages are guaranteed to be contiguous.
2043 *
2044 * Return: the number of pages which were found.
2045 */
find_get_pages_contig(struct address_space * mapping,pgoff_t index,unsigned int nr_pages,struct page ** pages)2046 unsigned find_get_pages_contig(struct address_space *mapping, pgoff_t index,
2047 unsigned int nr_pages, struct page **pages)
2048 {
2049 XA_STATE(xas, &mapping->i_pages, index);
2050 struct page *page;
2051 unsigned int ret = 0;
2052
2053 if (unlikely(!nr_pages))
2054 return 0;
2055
2056 rcu_read_lock();
2057 for (page = xas_load(&xas); page; page = xas_next(&xas)) {
2058 if (xas_retry(&xas, page))
2059 continue;
2060 /*
2061 * If the entry has been swapped out, we can stop looking.
2062 * No current caller is looking for DAX entries.
2063 */
2064 if (xa_is_value(page))
2065 break;
2066
2067 if (!page_cache_get_speculative(page))
2068 goto retry;
2069
2070 /* Has the page moved or been split? */
2071 if (unlikely(page != xas_reload(&xas)))
2072 goto put_page;
2073
2074 pages[ret] = find_subpage(page, xas.xa_index);
2075 if (++ret == nr_pages)
2076 break;
2077 continue;
2078 put_page:
2079 put_page(page);
2080 retry:
2081 xas_reset(&xas);
2082 }
2083 rcu_read_unlock();
2084 return ret;
2085 }
2086 EXPORT_SYMBOL(find_get_pages_contig);
2087
2088 /**
2089 * find_get_pages_range_tag - find and return pages in given range matching @tag
2090 * @mapping: the address_space to search
2091 * @index: the starting page index
2092 * @end: The final page index (inclusive)
2093 * @tag: the tag index
2094 * @nr_pages: the maximum number of pages
2095 * @pages: where the resulting pages are placed
2096 *
2097 * Like find_get_pages, except we only return pages which are tagged with
2098 * @tag. We update @index to index the next page for the traversal.
2099 *
2100 * Return: the number of pages which were found.
2101 */
find_get_pages_range_tag(struct address_space * mapping,pgoff_t * index,pgoff_t end,xa_mark_t tag,unsigned int nr_pages,struct page ** pages)2102 unsigned find_get_pages_range_tag(struct address_space *mapping, pgoff_t *index,
2103 pgoff_t end, xa_mark_t tag, unsigned int nr_pages,
2104 struct page **pages)
2105 {
2106 XA_STATE(xas, &mapping->i_pages, *index);
2107 struct page *page;
2108 unsigned ret = 0;
2109
2110 if (unlikely(!nr_pages))
2111 return 0;
2112
2113 rcu_read_lock();
2114 xas_for_each_marked(&xas, page, end, tag) {
2115 if (xas_retry(&xas, page))
2116 continue;
2117 /*
2118 * Shadow entries should never be tagged, but this iteration
2119 * is lockless so there is a window for page reclaim to evict
2120 * a page we saw tagged. Skip over it.
2121 */
2122 if (xa_is_value(page))
2123 continue;
2124
2125 if (!page_cache_get_speculative(page))
2126 goto retry;
2127
2128 /* Has the page moved or been split? */
2129 if (unlikely(page != xas_reload(&xas)))
2130 goto put_page;
2131
2132 pages[ret] = find_subpage(page, xas.xa_index);
2133 if (++ret == nr_pages) {
2134 *index = xas.xa_index + 1;
2135 goto out;
2136 }
2137 continue;
2138 put_page:
2139 put_page(page);
2140 retry:
2141 xas_reset(&xas);
2142 }
2143
2144 /*
2145 * We come here when we got to @end. We take care to not overflow the
2146 * index @index as it confuses some of the callers. This breaks the
2147 * iteration when there is a page at index -1 but that is already
2148 * broken anyway.
2149 */
2150 if (end == (pgoff_t)-1)
2151 *index = (pgoff_t)-1;
2152 else
2153 *index = end + 1;
2154 out:
2155 rcu_read_unlock();
2156
2157 return ret;
2158 }
2159 EXPORT_SYMBOL(find_get_pages_range_tag);
2160
2161 /*
2162 * CD/DVDs are error prone. When a medium error occurs, the driver may fail
2163 * a _large_ part of the i/o request. Imagine the worst scenario:
2164 *
2165 * ---R__________________________________________B__________
2166 * ^ reading here ^ bad block(assume 4k)
2167 *
2168 * read(R) => miss => readahead(R...B) => media error => frustrating retries
2169 * => failing the whole request => read(R) => read(R+1) =>
2170 * readahead(R+1...B+1) => bang => read(R+2) => read(R+3) =>
2171 * readahead(R+3...B+2) => bang => read(R+3) => read(R+4) =>
2172 * readahead(R+4...B+3) => bang => read(R+4) => read(R+5) => ......
2173 *
2174 * It is going insane. Fix it by quickly scaling down the readahead size.
2175 */
shrink_readahead_size_eio(struct file_ra_state * ra)2176 static void shrink_readahead_size_eio(struct file_ra_state *ra)
2177 {
2178 ra->ra_pages /= 4;
2179 }
2180
2181 /**
2182 * generic_file_buffered_read - generic file read routine
2183 * @iocb: the iocb to read
2184 * @iter: data destination
2185 * @written: already copied
2186 *
2187 * This is a generic file read routine, and uses the
2188 * mapping->a_ops->readpage() function for the actual low-level stuff.
2189 *
2190 * This is really ugly. But the goto's actually try to clarify some
2191 * of the logic when it comes to error handling etc.
2192 *
2193 * Return:
2194 * * total number of bytes copied, including those the were already @written
2195 * * negative error code if nothing was copied
2196 */
generic_file_buffered_read(struct kiocb * iocb,struct iov_iter * iter,ssize_t written)2197 ssize_t generic_file_buffered_read(struct kiocb *iocb,
2198 struct iov_iter *iter, ssize_t written)
2199 {
2200 struct file *filp = iocb->ki_filp;
2201 struct address_space *mapping = filp->f_mapping;
2202 struct inode *inode = mapping->host;
2203 struct file_ra_state *ra = &filp->f_ra;
2204 loff_t *ppos = &iocb->ki_pos;
2205 pgoff_t index;
2206 pgoff_t last_index;
2207 pgoff_t prev_index;
2208 unsigned long offset; /* offset into pagecache page */
2209 unsigned int prev_offset;
2210 int error = 0;
2211
2212 if (unlikely(*ppos >= inode->i_sb->s_maxbytes))
2213 return 0;
2214 iov_iter_truncate(iter, inode->i_sb->s_maxbytes);
2215
2216 index = *ppos >> PAGE_SHIFT;
2217 prev_index = ra->prev_pos >> PAGE_SHIFT;
2218 prev_offset = ra->prev_pos & (PAGE_SIZE-1);
2219 last_index = (*ppos + iter->count + PAGE_SIZE-1) >> PAGE_SHIFT;
2220 offset = *ppos & ~PAGE_MASK;
2221
2222 /*
2223 * If we've already successfully copied some data, then we
2224 * can no longer safely return -EIOCBQUEUED. Hence mark
2225 * an async read NOWAIT at that point.
2226 */
2227 if (written && (iocb->ki_flags & IOCB_WAITQ))
2228 iocb->ki_flags |= IOCB_NOWAIT;
2229
2230 for (;;) {
2231 struct page *page;
2232 pgoff_t end_index;
2233 loff_t isize;
2234 unsigned long nr, ret;
2235
2236 cond_resched();
2237 find_page:
2238 if (fatal_signal_pending(current)) {
2239 error = -EINTR;
2240 goto out;
2241 }
2242
2243 page = find_get_page(mapping, index);
2244 if (!page) {
2245 if (iocb->ki_flags & IOCB_NOIO)
2246 goto would_block;
2247 page_cache_sync_readahead(mapping,
2248 ra, filp,
2249 index, last_index - index);
2250 page = find_get_page(mapping, index);
2251 if (unlikely(page == NULL))
2252 goto no_cached_page;
2253 }
2254 if (PageReadahead(page)) {
2255 if (iocb->ki_flags & IOCB_NOIO) {
2256 put_page(page);
2257 goto out;
2258 }
2259 page_cache_async_readahead(mapping,
2260 ra, filp, page,
2261 index, last_index - index);
2262 }
2263 if (!PageUptodate(page)) {
2264 /*
2265 * See comment in do_read_cache_page on why
2266 * wait_on_page_locked is used to avoid unnecessarily
2267 * serialisations and why it's safe.
2268 */
2269 if (iocb->ki_flags & IOCB_WAITQ) {
2270 if (written) {
2271 put_page(page);
2272 goto out;
2273 }
2274 error = wait_on_page_locked_async(page,
2275 iocb->ki_waitq);
2276 } else {
2277 if (iocb->ki_flags & IOCB_NOWAIT) {
2278 put_page(page);
2279 goto would_block;
2280 }
2281 error = wait_on_page_locked_killable(page);
2282 }
2283 if (unlikely(error))
2284 goto readpage_error;
2285 if (PageUptodate(page))
2286 goto page_ok;
2287
2288 if (inode->i_blkbits == PAGE_SHIFT ||
2289 !mapping->a_ops->is_partially_uptodate)
2290 goto page_not_up_to_date;
2291 /* pipes can't handle partially uptodate pages */
2292 if (unlikely(iov_iter_is_pipe(iter)))
2293 goto page_not_up_to_date;
2294 if (!trylock_page(page))
2295 goto page_not_up_to_date;
2296 /* Did it get truncated before we got the lock? */
2297 if (!page->mapping)
2298 goto page_not_up_to_date_locked;
2299 if (!mapping->a_ops->is_partially_uptodate(page,
2300 offset, iter->count))
2301 goto page_not_up_to_date_locked;
2302 unlock_page(page);
2303 }
2304 page_ok:
2305 /*
2306 * i_size must be checked after we know the page is Uptodate.
2307 *
2308 * Checking i_size after the check allows us to calculate
2309 * the correct value for "nr", which means the zero-filled
2310 * part of the page is not copied back to userspace (unless
2311 * another truncate extends the file - this is desired though).
2312 */
2313
2314 isize = i_size_read(inode);
2315 end_index = (isize - 1) >> PAGE_SHIFT;
2316 if (unlikely(!isize || index > end_index)) {
2317 put_page(page);
2318 goto out;
2319 }
2320
2321 /* nr is the maximum number of bytes to copy from this page */
2322 nr = PAGE_SIZE;
2323 if (index == end_index) {
2324 nr = ((isize - 1) & ~PAGE_MASK) + 1;
2325 if (nr <= offset) {
2326 put_page(page);
2327 goto out;
2328 }
2329 }
2330 nr = nr - offset;
2331
2332 /* If users can be writing to this page using arbitrary
2333 * virtual addresses, take care about potential aliasing
2334 * before reading the page on the kernel side.
2335 */
2336 if (mapping_writably_mapped(mapping))
2337 flush_dcache_page(page);
2338
2339 /*
2340 * When a sequential read accesses a page several times,
2341 * only mark it as accessed the first time.
2342 */
2343 if (prev_index != index || offset != prev_offset)
2344 mark_page_accessed(page);
2345 prev_index = index;
2346
2347 /*
2348 * Ok, we have the page, and it's up-to-date, so
2349 * now we can copy it to user space...
2350 */
2351
2352 ret = copy_page_to_iter(page, offset, nr, iter);
2353 offset += ret;
2354 index += offset >> PAGE_SHIFT;
2355 offset &= ~PAGE_MASK;
2356 prev_offset = offset;
2357
2358 put_page(page);
2359 written += ret;
2360 if (!iov_iter_count(iter))
2361 goto out;
2362 if (ret < nr) {
2363 error = -EFAULT;
2364 goto out;
2365 }
2366 continue;
2367
2368 page_not_up_to_date:
2369 /* Get exclusive access to the page ... */
2370 if (iocb->ki_flags & IOCB_WAITQ) {
2371 if (written) {
2372 put_page(page);
2373 goto out;
2374 }
2375 error = lock_page_async(page, iocb->ki_waitq);
2376 } else {
2377 error = lock_page_killable(page);
2378 }
2379 if (unlikely(error))
2380 goto readpage_error;
2381
2382 page_not_up_to_date_locked:
2383 /* Did it get truncated before we got the lock? */
2384 if (!page->mapping) {
2385 unlock_page(page);
2386 put_page(page);
2387 continue;
2388 }
2389
2390 /* Did somebody else fill it already? */
2391 if (PageUptodate(page)) {
2392 unlock_page(page);
2393 goto page_ok;
2394 }
2395
2396 readpage:
2397 if (iocb->ki_flags & (IOCB_NOIO | IOCB_NOWAIT)) {
2398 unlock_page(page);
2399 put_page(page);
2400 goto would_block;
2401 }
2402 /*
2403 * A previous I/O error may have been due to temporary
2404 * failures, eg. multipath errors.
2405 * PG_error will be set again if readpage fails.
2406 */
2407 ClearPageError(page);
2408 /* Start the actual read. The read will unlock the page. */
2409 error = mapping->a_ops->readpage(filp, page);
2410
2411 if (unlikely(error)) {
2412 if (error == AOP_TRUNCATED_PAGE) {
2413 put_page(page);
2414 error = 0;
2415 goto find_page;
2416 }
2417 goto readpage_error;
2418 }
2419
2420 if (!PageUptodate(page)) {
2421 if (iocb->ki_flags & IOCB_WAITQ) {
2422 if (written) {
2423 put_page(page);
2424 goto out;
2425 }
2426 error = lock_page_async(page, iocb->ki_waitq);
2427 } else {
2428 error = lock_page_killable(page);
2429 }
2430
2431 if (unlikely(error))
2432 goto readpage_error;
2433 if (!PageUptodate(page)) {
2434 if (page->mapping == NULL) {
2435 /*
2436 * invalidate_mapping_pages got it
2437 */
2438 unlock_page(page);
2439 put_page(page);
2440 goto find_page;
2441 }
2442 unlock_page(page);
2443 shrink_readahead_size_eio(ra);
2444 error = -EIO;
2445 goto readpage_error;
2446 }
2447 unlock_page(page);
2448 }
2449
2450 goto page_ok;
2451
2452 readpage_error:
2453 /* UHHUH! A synchronous read error occurred. Report it */
2454 put_page(page);
2455 goto out;
2456
2457 no_cached_page:
2458 /*
2459 * Ok, it wasn't cached, so we need to create a new
2460 * page..
2461 */
2462 page = page_cache_alloc(mapping);
2463 if (!page) {
2464 error = -ENOMEM;
2465 goto out;
2466 }
2467 error = add_to_page_cache_lru(page, mapping, index,
2468 mapping_gfp_constraint(mapping, GFP_KERNEL));
2469 if (error) {
2470 put_page(page);
2471 if (error == -EEXIST) {
2472 error = 0;
2473 goto find_page;
2474 }
2475 goto out;
2476 }
2477 goto readpage;
2478 }
2479
2480 would_block:
2481 error = -EAGAIN;
2482 out:
2483 ra->prev_pos = prev_index;
2484 ra->prev_pos <<= PAGE_SHIFT;
2485 ra->prev_pos |= prev_offset;
2486
2487 *ppos = ((loff_t)index << PAGE_SHIFT) + offset;
2488 file_accessed(filp);
2489 return written ? written : error;
2490 }
2491 EXPORT_SYMBOL_GPL(generic_file_buffered_read);
2492
2493 /**
2494 * generic_file_read_iter - generic filesystem read routine
2495 * @iocb: kernel I/O control block
2496 * @iter: destination for the data read
2497 *
2498 * This is the "read_iter()" routine for all filesystems
2499 * that can use the page cache directly.
2500 *
2501 * The IOCB_NOWAIT flag in iocb->ki_flags indicates that -EAGAIN shall
2502 * be returned when no data can be read without waiting for I/O requests
2503 * to complete; it doesn't prevent readahead.
2504 *
2505 * The IOCB_NOIO flag in iocb->ki_flags indicates that no new I/O
2506 * requests shall be made for the read or for readahead. When no data
2507 * can be read, -EAGAIN shall be returned. When readahead would be
2508 * triggered, a partial, possibly empty read shall be returned.
2509 *
2510 * Return:
2511 * * number of bytes copied, even for partial reads
2512 * * negative error code (or 0 if IOCB_NOIO) if nothing was read
2513 */
2514 ssize_t
generic_file_read_iter(struct kiocb * iocb,struct iov_iter * iter)2515 generic_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
2516 {
2517 size_t count = iov_iter_count(iter);
2518 ssize_t retval = 0;
2519
2520 if (!count)
2521 goto out; /* skip atime */
2522
2523 if (iocb->ki_flags & IOCB_DIRECT) {
2524 struct file *file = iocb->ki_filp;
2525 struct address_space *mapping = file->f_mapping;
2526 struct inode *inode = mapping->host;
2527 loff_t size;
2528
2529 size = i_size_read(inode);
2530 if (iocb->ki_flags & IOCB_NOWAIT) {
2531 if (filemap_range_has_page(mapping, iocb->ki_pos,
2532 iocb->ki_pos + count - 1))
2533 return -EAGAIN;
2534 } else {
2535 retval = filemap_write_and_wait_range(mapping,
2536 iocb->ki_pos,
2537 iocb->ki_pos + count - 1);
2538 if (retval < 0)
2539 goto out;
2540 }
2541
2542 file_accessed(file);
2543
2544 retval = mapping->a_ops->direct_IO(iocb, iter);
2545 if (retval >= 0) {
2546 iocb->ki_pos += retval;
2547 count -= retval;
2548 }
2549 iov_iter_revert(iter, count - iov_iter_count(iter));
2550
2551 /*
2552 * Btrfs can have a short DIO read if we encounter
2553 * compressed extents, so if there was an error, or if
2554 * we've already read everything we wanted to, or if
2555 * there was a short read because we hit EOF, go ahead
2556 * and return. Otherwise fallthrough to buffered io for
2557 * the rest of the read. Buffered reads will not work for
2558 * DAX files, so don't bother trying.
2559 */
2560 if (retval < 0 || !count || iocb->ki_pos >= size ||
2561 IS_DAX(inode))
2562 goto out;
2563 }
2564
2565 retval = generic_file_buffered_read(iocb, iter, retval);
2566 out:
2567 return retval;
2568 }
2569 EXPORT_SYMBOL(generic_file_read_iter);
2570
2571 #ifdef CONFIG_MMU
2572 #define MMAP_LOTSAMISS (100)
2573 /*
2574 * lock_page_maybe_drop_mmap - lock the page, possibly dropping the mmap_lock
2575 * @vmf - the vm_fault for this fault.
2576 * @page - the page to lock.
2577 * @fpin - the pointer to the file we may pin (or is already pinned).
2578 *
2579 * This works similar to lock_page_or_retry in that it can drop the mmap_lock.
2580 * It differs in that it actually returns the page locked if it returns 1 and 0
2581 * if it couldn't lock the page. If we did have to drop the mmap_lock then fpin
2582 * will point to the pinned file and needs to be fput()'ed at a later point.
2583 */
lock_page_maybe_drop_mmap(struct vm_fault * vmf,struct page * page,struct file ** fpin)2584 static int lock_page_maybe_drop_mmap(struct vm_fault *vmf, struct page *page,
2585 struct file **fpin)
2586 {
2587 if (trylock_page(page))
2588 return 1;
2589
2590 /*
2591 * NOTE! This will make us return with VM_FAULT_RETRY, but with
2592 * the mmap_lock still held. That's how FAULT_FLAG_RETRY_NOWAIT
2593 * is supposed to work. We have way too many special cases..
2594 */
2595 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
2596 return 0;
2597
2598 *fpin = maybe_unlock_mmap_for_io(vmf, *fpin);
2599 if (vmf->flags & FAULT_FLAG_KILLABLE) {
2600 if (__lock_page_killable(page)) {
2601 /*
2602 * We didn't have the right flags to drop the mmap_lock,
2603 * but all fault_handlers only check for fatal signals
2604 * if we return VM_FAULT_RETRY, so we need to drop the
2605 * mmap_lock here and return 0 if we don't have a fpin.
2606 */
2607 if (*fpin == NULL)
2608 mmap_read_unlock(vmf->vma->vm_mm);
2609 return 0;
2610 }
2611 } else
2612 __lock_page(page);
2613 return 1;
2614 }
2615
2616
2617 /*
2618 * Synchronous readahead happens when we don't even find a page in the page
2619 * cache at all. We don't want to perform IO under the mmap sem, so if we have
2620 * to drop the mmap sem we return the file that was pinned in order for us to do
2621 * that. If we didn't pin a file then we return NULL. The file that is
2622 * returned needs to be fput()'ed when we're done with it.
2623 */
do_sync_mmap_readahead(struct vm_fault * vmf)2624 static struct file *do_sync_mmap_readahead(struct vm_fault *vmf)
2625 {
2626 struct file *file = vmf->vma->vm_file;
2627 struct file_ra_state *ra = &file->f_ra;
2628 struct address_space *mapping = file->f_mapping;
2629 DEFINE_READAHEAD(ractl, file, mapping, vmf->pgoff);
2630 struct file *fpin = NULL;
2631 unsigned int mmap_miss;
2632
2633 /* If we don't want any read-ahead, don't bother */
2634 if (vmf->vma->vm_flags & VM_RAND_READ)
2635 return fpin;
2636 if (!ra->ra_pages)
2637 return fpin;
2638
2639 if (vmf->vma->vm_flags & VM_SEQ_READ) {
2640 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2641 page_cache_sync_ra(&ractl, ra, ra->ra_pages);
2642 return fpin;
2643 }
2644
2645 /* Avoid banging the cache line if not needed */
2646 mmap_miss = READ_ONCE(ra->mmap_miss);
2647 if (mmap_miss < MMAP_LOTSAMISS * 10)
2648 WRITE_ONCE(ra->mmap_miss, ++mmap_miss);
2649
2650 /*
2651 * Do we miss much more than hit in this file? If so,
2652 * stop bothering with read-ahead. It will only hurt.
2653 */
2654 if (mmap_miss > MMAP_LOTSAMISS)
2655 return fpin;
2656
2657 /*
2658 * mmap read-around
2659 */
2660 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2661 ra->start = max_t(long, 0, vmf->pgoff - ra->ra_pages / 2);
2662 ra->size = ra->ra_pages;
2663 ra->async_size = ra->ra_pages / 4;
2664 ractl._index = ra->start;
2665 do_page_cache_ra(&ractl, ra->size, ra->async_size);
2666 return fpin;
2667 }
2668
2669 /*
2670 * Asynchronous readahead happens when we find the page and PG_readahead,
2671 * so we want to possibly extend the readahead further. We return the file that
2672 * was pinned if we have to drop the mmap_lock in order to do IO.
2673 */
do_async_mmap_readahead(struct vm_fault * vmf,struct page * page)2674 static struct file *do_async_mmap_readahead(struct vm_fault *vmf,
2675 struct page *page)
2676 {
2677 struct file *file = vmf->vma->vm_file;
2678 struct file_ra_state *ra = &file->f_ra;
2679 struct address_space *mapping = file->f_mapping;
2680 struct file *fpin = NULL;
2681 unsigned int mmap_miss;
2682 pgoff_t offset = vmf->pgoff;
2683
2684 /* If we don't want any read-ahead, don't bother */
2685 if (vmf->vma->vm_flags & VM_RAND_READ || !ra->ra_pages)
2686 return fpin;
2687 mmap_miss = READ_ONCE(ra->mmap_miss);
2688 if (mmap_miss)
2689 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
2690 if (PageReadahead(page)) {
2691 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2692 page_cache_async_readahead(mapping, ra, file,
2693 page, offset, ra->ra_pages);
2694 }
2695 return fpin;
2696 }
2697
2698 /**
2699 * filemap_fault - read in file data for page fault handling
2700 * @vmf: struct vm_fault containing details of the fault
2701 *
2702 * filemap_fault() is invoked via the vma operations vector for a
2703 * mapped memory region to read in file data during a page fault.
2704 *
2705 * The goto's are kind of ugly, but this streamlines the normal case of having
2706 * it in the page cache, and handles the special cases reasonably without
2707 * having a lot of duplicated code.
2708 *
2709 * If FAULT_FLAG_SPECULATIVE is set, this function runs with elevated vma
2710 * refcount and with mmap lock not held.
2711 * Otherwise, vma->vm_mm->mmap_lock must be held on entry.
2712 *
2713 * If our return value has VM_FAULT_RETRY set, it's because the mmap_lock
2714 * may be dropped before doing I/O or by lock_page_maybe_drop_mmap().
2715 *
2716 * If our return value does not have VM_FAULT_RETRY set, the mmap_lock
2717 * has not been released.
2718 *
2719 * We never return with VM_FAULT_RETRY and a bit from VM_FAULT_ERROR set.
2720 *
2721 * Return: bitwise-OR of %VM_FAULT_ codes.
2722 */
filemap_fault(struct vm_fault * vmf)2723 vm_fault_t filemap_fault(struct vm_fault *vmf)
2724 {
2725 int error;
2726 struct file *file = vmf->vma->vm_file;
2727 struct file *fpin = NULL;
2728 struct address_space *mapping = file->f_mapping;
2729 struct file_ra_state *ra = &file->f_ra;
2730 struct inode *inode = mapping->host;
2731 pgoff_t offset = vmf->pgoff;
2732 pgoff_t max_off;
2733 struct page *page = NULL;
2734 vm_fault_t ret = 0;
2735 bool retry = false;
2736
2737 if (vmf->flags & FAULT_FLAG_SPECULATIVE) {
2738 page = find_get_page(mapping, offset);
2739 if (unlikely(!page) || unlikely(PageReadahead(page)))
2740 return VM_FAULT_RETRY;
2741
2742 if (!trylock_page(page))
2743 return VM_FAULT_RETRY;
2744
2745 if (unlikely(compound_head(page)->mapping != mapping))
2746 goto page_unlock;
2747 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
2748 if (unlikely(!PageUptodate(page)))
2749 goto page_unlock;
2750
2751 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2752 if (unlikely(offset >= max_off))
2753 goto page_unlock;
2754
2755 /*
2756 * Update readahead mmap_miss statistic.
2757 *
2758 * Note that we are not sure if finish_fault() will
2759 * manage to complete the transaction. If it fails,
2760 * we'll come back to filemap_fault() non-speculative
2761 * case which will update mmap_miss a second time.
2762 * This is not ideal, we would prefer to guarantee the
2763 * update will happen exactly once.
2764 */
2765 if (!(vmf->vma->vm_flags & VM_RAND_READ) && ra->ra_pages) {
2766 unsigned int mmap_miss = READ_ONCE(ra->mmap_miss);
2767 if (mmap_miss)
2768 WRITE_ONCE(ra->mmap_miss, --mmap_miss);
2769 }
2770
2771 vmf->page = page;
2772 return VM_FAULT_LOCKED;
2773 page_unlock:
2774 unlock_page(page);
2775 return VM_FAULT_RETRY;
2776 }
2777
2778 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2779 if (unlikely(offset >= max_off))
2780 return VM_FAULT_SIGBUS;
2781
2782 trace_android_vh_filemap_fault_get_page(vmf, &page, &retry);
2783 if (unlikely(retry))
2784 goto out_retry;
2785 if (unlikely(page))
2786 goto page_ok;
2787
2788 /*
2789 * Do we have something in the page cache already?
2790 */
2791 page = find_get_page(mapping, offset);
2792 if (likely(page) && !(vmf->flags & FAULT_FLAG_TRIED)) {
2793 /*
2794 * We found the page, so try async readahead before
2795 * waiting for the lock.
2796 */
2797 fpin = do_async_mmap_readahead(vmf, page);
2798 } else if (!page) {
2799 /* No page in the page cache at all */
2800 count_vm_event(PGMAJFAULT);
2801 count_memcg_event_mm(vmf->vma->vm_mm, PGMAJFAULT);
2802 ret = VM_FAULT_MAJOR;
2803 fpin = do_sync_mmap_readahead(vmf);
2804 retry_find:
2805 page = pagecache_get_page(mapping, offset,
2806 FGP_CREAT|FGP_FOR_MMAP,
2807 vmf->gfp_mask);
2808 if (!page) {
2809 if (fpin)
2810 goto out_retry;
2811 return VM_FAULT_OOM;
2812 }
2813 }
2814
2815 if (!lock_page_maybe_drop_mmap(vmf, page, &fpin))
2816 goto out_retry;
2817
2818 /* Did it get truncated? */
2819 if (unlikely(compound_head(page)->mapping != mapping)) {
2820 unlock_page(page);
2821 put_page(page);
2822 goto retry_find;
2823 }
2824 VM_BUG_ON_PAGE(page_to_pgoff(page) != offset, page);
2825
2826 /*
2827 * We have a locked page in the page cache, now we need to check
2828 * that it's up-to-date. If not, it is going to be due to an error.
2829 */
2830 if (unlikely(!PageUptodate(page)))
2831 goto page_not_uptodate;
2832
2833 /*
2834 * We've made it this far and we had to drop our mmap_lock, now is the
2835 * time to return to the upper layer and have it re-find the vma and
2836 * redo the fault.
2837 */
2838 if (fpin) {
2839 unlock_page(page);
2840 goto out_retry;
2841 }
2842
2843 page_ok:
2844 /*
2845 * Found the page and have a reference on it.
2846 * We must recheck i_size under page lock.
2847 */
2848 max_off = DIV_ROUND_UP(i_size_read(inode), PAGE_SIZE);
2849 if (unlikely(offset >= max_off)) {
2850 unlock_page(page);
2851 put_page(page);
2852 return VM_FAULT_SIGBUS;
2853 }
2854
2855 vmf->page = page;
2856 return ret | VM_FAULT_LOCKED;
2857
2858 page_not_uptodate:
2859 /*
2860 * Umm, take care of errors if the page isn't up-to-date.
2861 * Try to re-read it _once_. We do this synchronously,
2862 * because there really aren't any performance issues here
2863 * and we need to check for errors.
2864 */
2865 ClearPageError(page);
2866 fpin = maybe_unlock_mmap_for_io(vmf, fpin);
2867 error = mapping->a_ops->readpage(file, page);
2868 if (!error) {
2869 wait_on_page_locked(page);
2870 if (!PageUptodate(page))
2871 error = -EIO;
2872 }
2873 if (fpin)
2874 goto out_retry;
2875 put_page(page);
2876
2877 if (!error || error == AOP_TRUNCATED_PAGE)
2878 goto retry_find;
2879
2880 shrink_readahead_size_eio(ra);
2881 return VM_FAULT_SIGBUS;
2882
2883 out_retry:
2884 /*
2885 * We dropped the mmap_lock, we need to return to the fault handler to
2886 * re-find the vma and come back and find our hopefully still populated
2887 * page.
2888 */
2889 if (page) {
2890 trace_android_vh_filemap_fault_cache_page(vmf, page);
2891 put_page(page);
2892 }
2893 if (fpin)
2894 fput(fpin);
2895 return ret | VM_FAULT_RETRY;
2896 }
2897 EXPORT_SYMBOL(filemap_fault);
2898
filemap_map_pmd(struct vm_fault * vmf,struct page * page)2899 static bool filemap_map_pmd(struct vm_fault *vmf, struct page *page)
2900 {
2901 struct mm_struct *mm = vmf->vma->vm_mm;
2902
2903 /* Huge page is mapped? No need to proceed. */
2904 if (pmd_trans_huge(*vmf->pmd)) {
2905 unlock_page(page);
2906 put_page(page);
2907 return true;
2908 }
2909
2910 if (pmd_none(*vmf->pmd) && PageTransHuge(page)) {
2911 vm_fault_t ret = do_set_pmd(vmf, page);
2912 if (!ret) {
2913 /* The page is mapped successfully, reference consumed. */
2914 unlock_page(page);
2915 return true;
2916 }
2917 }
2918
2919 if (pmd_none(*vmf->pmd)) {
2920 vmf->ptl = pmd_lock(mm, vmf->pmd);
2921 if (likely(pmd_none(*vmf->pmd))) {
2922 mm_inc_nr_ptes(mm);
2923 pmd_populate(mm, vmf->pmd, vmf->prealloc_pte);
2924 vmf->prealloc_pte = NULL;
2925 }
2926 spin_unlock(vmf->ptl);
2927 }
2928
2929 /* See comment in handle_pte_fault() */
2930 if (pmd_devmap_trans_unstable(vmf->pmd)) {
2931 unlock_page(page);
2932 put_page(page);
2933 return true;
2934 }
2935
2936 return false;
2937 }
2938
next_uptodate_page(struct page * page,struct address_space * mapping,struct xa_state * xas,pgoff_t end_pgoff)2939 static struct page *next_uptodate_page(struct page *page,
2940 struct address_space *mapping,
2941 struct xa_state *xas, pgoff_t end_pgoff)
2942 {
2943 unsigned long max_idx;
2944
2945 do {
2946 if (!page)
2947 return NULL;
2948 if (xas_retry(xas, page))
2949 continue;
2950 if (xa_is_value(page))
2951 continue;
2952 if (PageLocked(page))
2953 continue;
2954 if (!page_cache_get_speculative(page))
2955 continue;
2956 /* Has the page moved or been split? */
2957 if (unlikely(page != xas_reload(xas)))
2958 goto skip;
2959 if (!PageUptodate(page) || PageReadahead(page))
2960 goto skip;
2961 if (PageHWPoison(page))
2962 goto skip;
2963 if (!trylock_page(page))
2964 goto skip;
2965 if (page->mapping != mapping)
2966 goto unlock;
2967 if (!PageUptodate(page))
2968 goto unlock;
2969 max_idx = DIV_ROUND_UP(i_size_read(mapping->host), PAGE_SIZE);
2970 if (xas->xa_index >= max_idx)
2971 goto unlock;
2972 return page;
2973 unlock:
2974 unlock_page(page);
2975 skip:
2976 put_page(page);
2977 } while ((page = xas_next_entry(xas, end_pgoff)) != NULL);
2978
2979 return NULL;
2980 }
2981
first_map_page(struct address_space * mapping,struct xa_state * xas,pgoff_t end_pgoff)2982 static inline struct page *first_map_page(struct address_space *mapping,
2983 struct xa_state *xas,
2984 pgoff_t end_pgoff)
2985 {
2986 return next_uptodate_page(xas_find(xas, end_pgoff),
2987 mapping, xas, end_pgoff);
2988 }
2989
next_map_page(struct address_space * mapping,struct xa_state * xas,pgoff_t end_pgoff)2990 static inline struct page *next_map_page(struct address_space *mapping,
2991 struct xa_state *xas,
2992 pgoff_t end_pgoff)
2993 {
2994 return next_uptodate_page(xas_next_entry(xas, end_pgoff),
2995 mapping, xas, end_pgoff);
2996 }
2997
2998 #ifdef CONFIG_SPECULATIVE_PAGE_FAULT
filemap_allow_speculation(void)2999 bool filemap_allow_speculation(void)
3000 {
3001 return true;
3002 }
3003 EXPORT_SYMBOL_GPL(filemap_allow_speculation);
3004 #endif
3005
filemap_map_pages(struct vm_fault * vmf,pgoff_t start_pgoff,pgoff_t end_pgoff)3006 vm_fault_t filemap_map_pages(struct vm_fault *vmf,
3007 pgoff_t start_pgoff, pgoff_t end_pgoff)
3008 {
3009 struct vm_area_struct *vma = vmf->vma;
3010 struct file *file = vma->vm_file;
3011 struct address_space *mapping = file->f_mapping;
3012 pgoff_t last_pgoff = start_pgoff;
3013 unsigned long addr;
3014 XA_STATE(xas, &mapping->i_pages, start_pgoff);
3015 struct page *head, *page;
3016 unsigned int mmap_miss = READ_ONCE(file->f_ra.mmap_miss);
3017 vm_fault_t ret = (vmf->flags & FAULT_FLAG_SPECULATIVE) ?
3018 VM_FAULT_RETRY : 0;
3019
3020 rcu_read_lock();
3021 head = first_map_page(mapping, &xas, end_pgoff);
3022 if (!head)
3023 goto out;
3024
3025 if (!(vmf->flags & FAULT_FLAG_SPECULATIVE) &&
3026 filemap_map_pmd(vmf, head)) {
3027 ret = VM_FAULT_NOPAGE;
3028 goto out;
3029 }
3030
3031 addr = vma->vm_start + ((start_pgoff - vma->vm_pgoff) << PAGE_SHIFT);
3032 if (!pte_map_lock_addr(vmf, addr)) {
3033 unlock_page(head);
3034 put_page(head);
3035 goto out;
3036 }
3037
3038 do {
3039 page = find_subpage(head, xas.xa_index);
3040 if (PageHWPoison(page))
3041 goto unlock;
3042
3043 if (mmap_miss > 0)
3044 mmap_miss--;
3045
3046 addr += (xas.xa_index - last_pgoff) << PAGE_SHIFT;
3047 vmf->pte += xas.xa_index - last_pgoff;
3048 last_pgoff = xas.xa_index;
3049
3050 if (!pte_none(*vmf->pte))
3051 goto unlock;
3052
3053 /* We're about to handle the fault */
3054 if (vmf->address == addr)
3055 ret = VM_FAULT_NOPAGE;
3056
3057 do_set_pte(vmf, page, addr);
3058 /* no need to invalidate: a not-present page won't be cached */
3059 update_mmu_cache(vma, addr, vmf->pte);
3060 unlock_page(head);
3061 continue;
3062 unlock:
3063 unlock_page(head);
3064 put_page(head);
3065 } while ((head = next_map_page(mapping, &xas, end_pgoff)) != NULL);
3066 pte_unmap_unlock(vmf->pte, vmf->ptl);
3067 out:
3068 rcu_read_unlock();
3069 WRITE_ONCE(file->f_ra.mmap_miss, mmap_miss);
3070 return ret;
3071 }
3072 EXPORT_SYMBOL(filemap_map_pages);
3073
filemap_page_mkwrite(struct vm_fault * vmf)3074 vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
3075 {
3076 struct page *page = vmf->page;
3077 struct inode *inode = file_inode(vmf->vma->vm_file);
3078 vm_fault_t ret = VM_FAULT_LOCKED;
3079
3080 sb_start_pagefault(inode->i_sb);
3081 file_update_time(vmf->vma->vm_file);
3082 lock_page(page);
3083 if (page->mapping != inode->i_mapping) {
3084 unlock_page(page);
3085 ret = VM_FAULT_NOPAGE;
3086 goto out;
3087 }
3088 /*
3089 * We mark the page dirty already here so that when freeze is in
3090 * progress, we are guaranteed that writeback during freezing will
3091 * see the dirty page and writeprotect it again.
3092 */
3093 set_page_dirty(page);
3094 wait_for_stable_page(page);
3095 out:
3096 sb_end_pagefault(inode->i_sb);
3097 return ret;
3098 }
3099
3100 const struct vm_operations_struct generic_file_vm_ops = {
3101 .fault = filemap_fault,
3102 .map_pages = filemap_map_pages,
3103 .page_mkwrite = filemap_page_mkwrite,
3104 #ifdef CONFIG_SPECULATIVE_PAGE_FAULT
3105 .allow_speculation = filemap_allow_speculation,
3106 #endif
3107 };
3108
3109 /* This is used for a general mmap of a disk file */
3110
generic_file_mmap(struct file * file,struct vm_area_struct * vma)3111 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3112 {
3113 struct address_space *mapping = file->f_mapping;
3114
3115 if (!mapping->a_ops->readpage)
3116 return -ENOEXEC;
3117 file_accessed(file);
3118 vma->vm_ops = &generic_file_vm_ops;
3119 return 0;
3120 }
3121
3122 /*
3123 * This is for filesystems which do not implement ->writepage.
3124 */
generic_file_readonly_mmap(struct file * file,struct vm_area_struct * vma)3125 int generic_file_readonly_mmap(struct file *file, struct vm_area_struct *vma)
3126 {
3127 if ((vma->vm_flags & VM_SHARED) && (vma->vm_flags & VM_MAYWRITE))
3128 return -EINVAL;
3129 return generic_file_mmap(file, vma);
3130 }
3131 #else
filemap_page_mkwrite(struct vm_fault * vmf)3132 vm_fault_t filemap_page_mkwrite(struct vm_fault *vmf)
3133 {
3134 return VM_FAULT_SIGBUS;
3135 }
generic_file_mmap(struct file * file,struct vm_area_struct * vma)3136 int generic_file_mmap(struct file * file, struct vm_area_struct * vma)
3137 {
3138 return -ENOSYS;
3139 }
generic_file_readonly_mmap(struct file * file,struct vm_area_struct * vma)3140 int generic_file_readonly_mmap(struct file * file, struct vm_area_struct * vma)
3141 {
3142 return -ENOSYS;
3143 }
3144 #endif /* CONFIG_MMU */
3145
3146 EXPORT_SYMBOL(filemap_page_mkwrite);
3147 EXPORT_SYMBOL(generic_file_mmap);
3148 EXPORT_SYMBOL(generic_file_readonly_mmap);
3149
wait_on_page_read(struct page * page)3150 static struct page *wait_on_page_read(struct page *page)
3151 {
3152 if (!IS_ERR(page)) {
3153 wait_on_page_locked(page);
3154 if (!PageUptodate(page)) {
3155 put_page(page);
3156 page = ERR_PTR(-EIO);
3157 }
3158 }
3159 return page;
3160 }
3161
do_read_cache_page(struct address_space * mapping,pgoff_t index,int (* filler)(void *,struct page *),void * data,gfp_t gfp)3162 static struct page *do_read_cache_page(struct address_space *mapping,
3163 pgoff_t index,
3164 int (*filler)(void *, struct page *),
3165 void *data,
3166 gfp_t gfp)
3167 {
3168 struct page *page;
3169 int err;
3170 repeat:
3171 page = find_get_page(mapping, index);
3172 if (!page) {
3173 page = __page_cache_alloc(gfp);
3174 if (!page)
3175 return ERR_PTR(-ENOMEM);
3176 err = add_to_page_cache_lru(page, mapping, index, gfp);
3177 if (unlikely(err)) {
3178 put_page(page);
3179 if (err == -EEXIST)
3180 goto repeat;
3181 /* Presumably ENOMEM for xarray node */
3182 return ERR_PTR(err);
3183 }
3184
3185 filler:
3186 if (filler)
3187 err = filler(data, page);
3188 else
3189 err = mapping->a_ops->readpage(data, page);
3190
3191 if (err < 0) {
3192 put_page(page);
3193 return ERR_PTR(err);
3194 }
3195
3196 page = wait_on_page_read(page);
3197 if (IS_ERR(page))
3198 return page;
3199 goto out;
3200 }
3201 if (PageUptodate(page))
3202 goto out;
3203
3204 /*
3205 * Page is not up to date and may be locked due to one of the following
3206 * case a: Page is being filled and the page lock is held
3207 * case b: Read/write error clearing the page uptodate status
3208 * case c: Truncation in progress (page locked)
3209 * case d: Reclaim in progress
3210 *
3211 * Case a, the page will be up to date when the page is unlocked.
3212 * There is no need to serialise on the page lock here as the page
3213 * is pinned so the lock gives no additional protection. Even if the
3214 * page is truncated, the data is still valid if PageUptodate as
3215 * it's a race vs truncate race.
3216 * Case b, the page will not be up to date
3217 * Case c, the page may be truncated but in itself, the data may still
3218 * be valid after IO completes as it's a read vs truncate race. The
3219 * operation must restart if the page is not uptodate on unlock but
3220 * otherwise serialising on page lock to stabilise the mapping gives
3221 * no additional guarantees to the caller as the page lock is
3222 * released before return.
3223 * Case d, similar to truncation. If reclaim holds the page lock, it
3224 * will be a race with remove_mapping that determines if the mapping
3225 * is valid on unlock but otherwise the data is valid and there is
3226 * no need to serialise with page lock.
3227 *
3228 * As the page lock gives no additional guarantee, we optimistically
3229 * wait on the page to be unlocked and check if it's up to date and
3230 * use the page if it is. Otherwise, the page lock is required to
3231 * distinguish between the different cases. The motivation is that we
3232 * avoid spurious serialisations and wakeups when multiple processes
3233 * wait on the same page for IO to complete.
3234 */
3235 wait_on_page_locked(page);
3236 if (PageUptodate(page))
3237 goto out;
3238
3239 /* Distinguish between all the cases under the safety of the lock */
3240 lock_page(page);
3241
3242 /* Case c or d, restart the operation */
3243 if (!page->mapping) {
3244 unlock_page(page);
3245 put_page(page);
3246 goto repeat;
3247 }
3248
3249 /* Someone else locked and filled the page in a very small window */
3250 if (PageUptodate(page)) {
3251 unlock_page(page);
3252 goto out;
3253 }
3254
3255 /*
3256 * A previous I/O error may have been due to temporary
3257 * failures.
3258 * Clear page error before actual read, PG_error will be
3259 * set again if read page fails.
3260 */
3261 ClearPageError(page);
3262 goto filler;
3263
3264 out:
3265 mark_page_accessed(page);
3266 return page;
3267 }
3268
3269 /**
3270 * read_cache_page - read into page cache, fill it if needed
3271 * @mapping: the page's address_space
3272 * @index: the page index
3273 * @filler: function to perform the read
3274 * @data: first arg to filler(data, page) function, often left as NULL
3275 *
3276 * Read into the page cache. If a page already exists, and PageUptodate() is
3277 * not set, try to fill the page and wait for it to become unlocked.
3278 *
3279 * If the page does not get brought uptodate, return -EIO.
3280 *
3281 * Return: up to date page on success, ERR_PTR() on failure.
3282 */
read_cache_page(struct address_space * mapping,pgoff_t index,int (* filler)(void *,struct page *),void * data)3283 struct page *read_cache_page(struct address_space *mapping,
3284 pgoff_t index,
3285 int (*filler)(void *, struct page *),
3286 void *data)
3287 {
3288 return do_read_cache_page(mapping, index, filler, data,
3289 mapping_gfp_mask(mapping));
3290 }
3291 EXPORT_SYMBOL(read_cache_page);
3292
3293 /**
3294 * read_cache_page_gfp - read into page cache, using specified page allocation flags.
3295 * @mapping: the page's address_space
3296 * @index: the page index
3297 * @gfp: the page allocator flags to use if allocating
3298 *
3299 * This is the same as "read_mapping_page(mapping, index, NULL)", but with
3300 * any new page allocations done using the specified allocation flags.
3301 *
3302 * If the page does not get brought uptodate, return -EIO.
3303 *
3304 * Return: up to date page on success, ERR_PTR() on failure.
3305 */
read_cache_page_gfp(struct address_space * mapping,pgoff_t index,gfp_t gfp)3306 struct page *read_cache_page_gfp(struct address_space *mapping,
3307 pgoff_t index,
3308 gfp_t gfp)
3309 {
3310 return do_read_cache_page(mapping, index, NULL, NULL, gfp);
3311 }
3312 EXPORT_SYMBOL(read_cache_page_gfp);
3313
pagecache_write_begin(struct file * file,struct address_space * mapping,loff_t pos,unsigned len,unsigned flags,struct page ** pagep,void ** fsdata)3314 int pagecache_write_begin(struct file *file, struct address_space *mapping,
3315 loff_t pos, unsigned len, unsigned flags,
3316 struct page **pagep, void **fsdata)
3317 {
3318 const struct address_space_operations *aops = mapping->a_ops;
3319
3320 return aops->write_begin(file, mapping, pos, len, flags,
3321 pagep, fsdata);
3322 }
3323 EXPORT_SYMBOL(pagecache_write_begin);
3324
pagecache_write_end(struct file * file,struct address_space * mapping,loff_t pos,unsigned len,unsigned copied,struct page * page,void * fsdata)3325 int pagecache_write_end(struct file *file, struct address_space *mapping,
3326 loff_t pos, unsigned len, unsigned copied,
3327 struct page *page, void *fsdata)
3328 {
3329 const struct address_space_operations *aops = mapping->a_ops;
3330
3331 return aops->write_end(file, mapping, pos, len, copied, page, fsdata);
3332 }
3333 EXPORT_SYMBOL(pagecache_write_end);
3334
3335 /*
3336 * Warn about a page cache invalidation failure during a direct I/O write.
3337 */
dio_warn_stale_pagecache(struct file * filp)3338 void dio_warn_stale_pagecache(struct file *filp)
3339 {
3340 static DEFINE_RATELIMIT_STATE(_rs, 86400 * HZ, DEFAULT_RATELIMIT_BURST);
3341 char pathname[128];
3342 struct inode *inode = file_inode(filp);
3343 char *path;
3344
3345 errseq_set(&inode->i_mapping->wb_err, -EIO);
3346 if (__ratelimit(&_rs)) {
3347 path = file_path(filp, pathname, sizeof(pathname));
3348 if (IS_ERR(path))
3349 path = "(unknown)";
3350 pr_crit("Page cache invalidation failure on direct I/O. Possible data corruption due to collision with buffered I/O!\n");
3351 pr_crit("File: %s PID: %d Comm: %.20s\n", path, current->pid,
3352 current->comm);
3353 }
3354 }
3355
3356 ssize_t
generic_file_direct_write(struct kiocb * iocb,struct iov_iter * from)3357 generic_file_direct_write(struct kiocb *iocb, struct iov_iter *from)
3358 {
3359 struct file *file = iocb->ki_filp;
3360 struct address_space *mapping = file->f_mapping;
3361 struct inode *inode = mapping->host;
3362 loff_t pos = iocb->ki_pos;
3363 ssize_t written;
3364 size_t write_len;
3365 pgoff_t end;
3366
3367 write_len = iov_iter_count(from);
3368 end = (pos + write_len - 1) >> PAGE_SHIFT;
3369
3370 if (iocb->ki_flags & IOCB_NOWAIT) {
3371 /* If there are pages to writeback, return */
3372 if (filemap_range_has_page(inode->i_mapping, pos,
3373 pos + write_len - 1))
3374 return -EAGAIN;
3375 } else {
3376 written = filemap_write_and_wait_range(mapping, pos,
3377 pos + write_len - 1);
3378 if (written)
3379 goto out;
3380 }
3381
3382 /*
3383 * After a write we want buffered reads to be sure to go to disk to get
3384 * the new data. We invalidate clean cached page from the region we're
3385 * about to write. We do this *before* the write so that we can return
3386 * without clobbering -EIOCBQUEUED from ->direct_IO().
3387 */
3388 written = invalidate_inode_pages2_range(mapping,
3389 pos >> PAGE_SHIFT, end);
3390 /*
3391 * If a page can not be invalidated, return 0 to fall back
3392 * to buffered write.
3393 */
3394 if (written) {
3395 if (written == -EBUSY)
3396 return 0;
3397 goto out;
3398 }
3399
3400 written = mapping->a_ops->direct_IO(iocb, from);
3401
3402 /*
3403 * Finally, try again to invalidate clean pages which might have been
3404 * cached by non-direct readahead, or faulted in by get_user_pages()
3405 * if the source of the write was an mmap'ed region of the file
3406 * we're writing. Either one is a pretty crazy thing to do,
3407 * so we don't support it 100%. If this invalidation
3408 * fails, tough, the write still worked...
3409 *
3410 * Most of the time we do not need this since dio_complete() will do
3411 * the invalidation for us. However there are some file systems that
3412 * do not end up with dio_complete() being called, so let's not break
3413 * them by removing it completely.
3414 *
3415 * Noticeable example is a blkdev_direct_IO().
3416 *
3417 * Skip invalidation for async writes or if mapping has no pages.
3418 */
3419 if (written > 0 && mapping->nrpages &&
3420 invalidate_inode_pages2_range(mapping, pos >> PAGE_SHIFT, end))
3421 dio_warn_stale_pagecache(file);
3422
3423 if (written > 0) {
3424 pos += written;
3425 write_len -= written;
3426 if (pos > i_size_read(inode) && !S_ISBLK(inode->i_mode)) {
3427 i_size_write(inode, pos);
3428 mark_inode_dirty(inode);
3429 }
3430 iocb->ki_pos = pos;
3431 }
3432 iov_iter_revert(from, write_len - iov_iter_count(from));
3433 out:
3434 return written;
3435 }
3436 EXPORT_SYMBOL(generic_file_direct_write);
3437
3438 /*
3439 * Find or create a page at the given pagecache position. Return the locked
3440 * page. This function is specifically for buffered writes.
3441 */
grab_cache_page_write_begin(struct address_space * mapping,pgoff_t index,unsigned flags)3442 struct page *grab_cache_page_write_begin(struct address_space *mapping,
3443 pgoff_t index, unsigned flags)
3444 {
3445 struct page *page;
3446 int fgp_flags = FGP_LOCK|FGP_WRITE|FGP_CREAT;
3447
3448 if (flags & AOP_FLAG_NOFS)
3449 fgp_flags |= FGP_NOFS;
3450
3451 page = pagecache_get_page(mapping, index, fgp_flags,
3452 mapping_gfp_mask(mapping));
3453 if (page)
3454 wait_for_stable_page(page);
3455
3456 return page;
3457 }
3458 EXPORT_SYMBOL(grab_cache_page_write_begin);
3459
generic_perform_write(struct file * file,struct iov_iter * i,loff_t pos)3460 ssize_t generic_perform_write(struct file *file,
3461 struct iov_iter *i, loff_t pos)
3462 {
3463 struct address_space *mapping = file->f_mapping;
3464 const struct address_space_operations *a_ops = mapping->a_ops;
3465 long status = 0;
3466 ssize_t written = 0;
3467 unsigned int flags = 0;
3468
3469 do {
3470 struct page *page;
3471 unsigned long offset; /* Offset into pagecache page */
3472 unsigned long bytes; /* Bytes to write to page */
3473 size_t copied; /* Bytes copied from user */
3474 void *fsdata = NULL;
3475
3476 offset = (pos & (PAGE_SIZE - 1));
3477 bytes = min_t(unsigned long, PAGE_SIZE - offset,
3478 iov_iter_count(i));
3479
3480 again:
3481 /*
3482 * Bring in the user page that we will copy from _first_.
3483 * Otherwise there's a nasty deadlock on copying from the
3484 * same page as we're writing to, without it being marked
3485 * up-to-date.
3486 *
3487 * Not only is this an optimisation, but it is also required
3488 * to check that the address is actually valid, when atomic
3489 * usercopies are used, below.
3490 */
3491 if (unlikely(iov_iter_fault_in_readable(i, bytes))) {
3492 status = -EFAULT;
3493 break;
3494 }
3495
3496 if (fatal_signal_pending(current)) {
3497 status = -EINTR;
3498 break;
3499 }
3500
3501 status = a_ops->write_begin(file, mapping, pos, bytes, flags,
3502 &page, &fsdata);
3503 if (unlikely(status < 0))
3504 break;
3505
3506 if (mapping_writably_mapped(mapping))
3507 flush_dcache_page(page);
3508
3509 copied = iov_iter_copy_from_user_atomic(page, i, offset, bytes);
3510 flush_dcache_page(page);
3511
3512 status = a_ops->write_end(file, mapping, pos, bytes, copied,
3513 page, fsdata);
3514 if (unlikely(status < 0))
3515 break;
3516 copied = status;
3517
3518 cond_resched();
3519
3520 iov_iter_advance(i, copied);
3521 if (unlikely(copied == 0)) {
3522 /*
3523 * If we were unable to copy any data at all, we must
3524 * fall back to a single segment length write.
3525 *
3526 * If we didn't fallback here, we could livelock
3527 * because not all segments in the iov can be copied at
3528 * once without a pagefault.
3529 */
3530 bytes = min_t(unsigned long, PAGE_SIZE - offset,
3531 iov_iter_single_seg_count(i));
3532 goto again;
3533 }
3534 pos += copied;
3535 written += copied;
3536
3537 balance_dirty_pages_ratelimited(mapping);
3538 } while (iov_iter_count(i));
3539
3540 return written ? written : status;
3541 }
3542 EXPORT_SYMBOL(generic_perform_write);
3543
3544 /**
3545 * __generic_file_write_iter - write data to a file
3546 * @iocb: IO state structure (file, offset, etc.)
3547 * @from: iov_iter with data to write
3548 *
3549 * This function does all the work needed for actually writing data to a
3550 * file. It does all basic checks, removes SUID from the file, updates
3551 * modification times and calls proper subroutines depending on whether we
3552 * do direct IO or a standard buffered write.
3553 *
3554 * It expects i_mutex to be grabbed unless we work on a block device or similar
3555 * object which does not need locking at all.
3556 *
3557 * This function does *not* take care of syncing data in case of O_SYNC write.
3558 * A caller has to handle it. This is mainly due to the fact that we want to
3559 * avoid syncing under i_mutex.
3560 *
3561 * Return:
3562 * * number of bytes written, even for truncated writes
3563 * * negative error code if no data has been written at all
3564 */
__generic_file_write_iter(struct kiocb * iocb,struct iov_iter * from)3565 ssize_t __generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3566 {
3567 struct file *file = iocb->ki_filp;
3568 struct address_space * mapping = file->f_mapping;
3569 struct inode *inode = mapping->host;
3570 ssize_t written = 0;
3571 ssize_t err;
3572 ssize_t status;
3573
3574 /* We can write back this queue in page reclaim */
3575 current->backing_dev_info = inode_to_bdi(inode);
3576 err = file_remove_privs(file);
3577 if (err)
3578 goto out;
3579
3580 err = file_update_time(file);
3581 if (err)
3582 goto out;
3583
3584 if (iocb->ki_flags & IOCB_DIRECT) {
3585 loff_t pos, endbyte;
3586
3587 written = generic_file_direct_write(iocb, from);
3588 /*
3589 * If the write stopped short of completing, fall back to
3590 * buffered writes. Some filesystems do this for writes to
3591 * holes, for example. For DAX files, a buffered write will
3592 * not succeed (even if it did, DAX does not handle dirty
3593 * page-cache pages correctly).
3594 */
3595 if (written < 0 || !iov_iter_count(from) || IS_DAX(inode))
3596 goto out;
3597
3598 status = generic_perform_write(file, from, pos = iocb->ki_pos);
3599 /*
3600 * If generic_perform_write() returned a synchronous error
3601 * then we want to return the number of bytes which were
3602 * direct-written, or the error code if that was zero. Note
3603 * that this differs from normal direct-io semantics, which
3604 * will return -EFOO even if some bytes were written.
3605 */
3606 if (unlikely(status < 0)) {
3607 err = status;
3608 goto out;
3609 }
3610 /*
3611 * We need to ensure that the page cache pages are written to
3612 * disk and invalidated to preserve the expected O_DIRECT
3613 * semantics.
3614 */
3615 endbyte = pos + status - 1;
3616 err = filemap_write_and_wait_range(mapping, pos, endbyte);
3617 if (err == 0) {
3618 iocb->ki_pos = endbyte + 1;
3619 written += status;
3620 invalidate_mapping_pages(mapping,
3621 pos >> PAGE_SHIFT,
3622 endbyte >> PAGE_SHIFT);
3623 } else {
3624 /*
3625 * We don't know how much we wrote, so just return
3626 * the number of bytes which were direct-written
3627 */
3628 }
3629 } else {
3630 written = generic_perform_write(file, from, iocb->ki_pos);
3631 if (likely(written > 0))
3632 iocb->ki_pos += written;
3633 }
3634 out:
3635 current->backing_dev_info = NULL;
3636 return written ? written : err;
3637 }
3638 EXPORT_SYMBOL(__generic_file_write_iter);
3639
3640 /**
3641 * generic_file_write_iter - write data to a file
3642 * @iocb: IO state structure
3643 * @from: iov_iter with data to write
3644 *
3645 * This is a wrapper around __generic_file_write_iter() to be used by most
3646 * filesystems. It takes care of syncing the file in case of O_SYNC file
3647 * and acquires i_mutex as needed.
3648 * Return:
3649 * * negative error code if no data has been written at all of
3650 * vfs_fsync_range() failed for a synchronous write
3651 * * number of bytes written, even for truncated writes
3652 */
generic_file_write_iter(struct kiocb * iocb,struct iov_iter * from)3653 ssize_t generic_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
3654 {
3655 struct file *file = iocb->ki_filp;
3656 struct inode *inode = file->f_mapping->host;
3657 ssize_t ret;
3658
3659 inode_lock(inode);
3660 ret = generic_write_checks(iocb, from);
3661 if (ret > 0)
3662 ret = __generic_file_write_iter(iocb, from);
3663 inode_unlock(inode);
3664
3665 if (ret > 0)
3666 ret = generic_write_sync(iocb, ret);
3667 return ret;
3668 }
3669 EXPORT_SYMBOL(generic_file_write_iter);
3670
3671 /**
3672 * try_to_release_page() - release old fs-specific metadata on a page
3673 *
3674 * @page: the page which the kernel is trying to free
3675 * @gfp_mask: memory allocation flags (and I/O mode)
3676 *
3677 * The address_space is to try to release any data against the page
3678 * (presumably at page->private).
3679 *
3680 * This may also be called if PG_fscache is set on a page, indicating that the
3681 * page is known to the local caching routines.
3682 *
3683 * The @gfp_mask argument specifies whether I/O may be performed to release
3684 * this page (__GFP_IO), and whether the call may block (__GFP_RECLAIM & __GFP_FS).
3685 *
3686 * Return: %1 if the release was successful, otherwise return zero.
3687 */
try_to_release_page(struct page * page,gfp_t gfp_mask)3688 int try_to_release_page(struct page *page, gfp_t gfp_mask)
3689 {
3690 struct address_space * const mapping = page->mapping;
3691
3692 BUG_ON(!PageLocked(page));
3693 if (PageWriteback(page))
3694 return 0;
3695
3696 if (mapping && mapping->a_ops->releasepage)
3697 return mapping->a_ops->releasepage(page, gfp_mask);
3698 return try_to_free_buffers(page);
3699 }
3700
3701 EXPORT_SYMBOL(try_to_release_page);
3702