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