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