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