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