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