GNU Linux-libre 4.14.303-gnu1
[releases.git] / mm / rmap.c
1 /*
2  * mm/rmap.c - physical to virtual reverse mappings
3  *
4  * Copyright 2001, Rik van Riel <riel@conectiva.com.br>
5  * Released under the General Public License (GPL).
6  *
7  * Simple, low overhead reverse mapping scheme.
8  * Please try to keep this thing as modular as possible.
9  *
10  * Provides methods for unmapping each kind of mapped page:
11  * the anon methods track anonymous pages, and
12  * the file methods track pages belonging to an inode.
13  *
14  * Original design by Rik van Riel <riel@conectiva.com.br> 2001
15  * File methods by Dave McCracken <dmccr@us.ibm.com> 2003, 2004
16  * Anonymous methods by Andrea Arcangeli <andrea@suse.de> 2004
17  * Contributions by Hugh Dickins 2003, 2004
18  */
19
20 /*
21  * Lock ordering in mm:
22  *
23  * inode->i_mutex       (while writing or truncating, not reading or faulting)
24  *   mm->mmap_sem
25  *     page->flags PG_locked (lock_page)
26  *       hugetlbfs_i_mmap_rwsem_key (in huge_pmd_share)
27  *         mapping->i_mmap_rwsem
28  *           anon_vma->rwsem
29  *             mm->page_table_lock or pte_lock
30  *               zone_lru_lock (in mark_page_accessed, isolate_lru_page)
31  *               swap_lock (in swap_duplicate, swap_info_get)
32  *                 mmlist_lock (in mmput, drain_mmlist and others)
33  *                 mapping->private_lock (in __set_page_dirty_buffers)
34  *                   mem_cgroup_{begin,end}_page_stat (memcg->move_lock)
35  *                     mapping->tree_lock (widely used)
36  *                 inode->i_lock (in set_page_dirty's __mark_inode_dirty)
37  *                 bdi.wb->list_lock (in set_page_dirty's __mark_inode_dirty)
38  *                   sb_lock (within inode_lock in fs/fs-writeback.c)
39  *                   mapping->tree_lock (widely used, in set_page_dirty,
40  *                             in arch-dependent flush_dcache_mmap_lock,
41  *                             within bdi.wb->list_lock in __sync_single_inode)
42  *
43  * anon_vma->rwsem,mapping->i_mutex      (memory_failure, collect_procs_anon)
44  *   ->tasklist_lock
45  *     pte map lock
46  */
47
48 #include <linux/mm.h>
49 #include <linux/sched/mm.h>
50 #include <linux/sched/task.h>
51 #include <linux/pagemap.h>
52 #include <linux/swap.h>
53 #include <linux/swapops.h>
54 #include <linux/slab.h>
55 #include <linux/init.h>
56 #include <linux/ksm.h>
57 #include <linux/rmap.h>
58 #include <linux/rcupdate.h>
59 #include <linux/export.h>
60 #include <linux/memcontrol.h>
61 #include <linux/mmu_notifier.h>
62 #include <linux/migrate.h>
63 #include <linux/hugetlb.h>
64 #include <linux/backing-dev.h>
65 #include <linux/page_idle.h>
66 #include <linux/memremap.h>
67 #include <linux/userfaultfd_k.h>
68
69 #include <asm/tlbflush.h>
70
71 #include <trace/events/tlb.h>
72
73 #include "internal.h"
74
75 static struct kmem_cache *anon_vma_cachep;
76 static struct kmem_cache *anon_vma_chain_cachep;
77
78 static inline struct anon_vma *anon_vma_alloc(void)
79 {
80         struct anon_vma *anon_vma;
81
82         anon_vma = kmem_cache_alloc(anon_vma_cachep, GFP_KERNEL);
83         if (anon_vma) {
84                 atomic_set(&anon_vma->refcount, 1);
85                 anon_vma->num_children = 0;
86                 anon_vma->num_active_vmas = 0;
87                 anon_vma->parent = anon_vma;
88                 /*
89                  * Initialise the anon_vma root to point to itself. If called
90                  * from fork, the root will be reset to the parents anon_vma.
91                  */
92                 anon_vma->root = anon_vma;
93         }
94
95         return anon_vma;
96 }
97
98 static inline void anon_vma_free(struct anon_vma *anon_vma)
99 {
100         VM_BUG_ON(atomic_read(&anon_vma->refcount));
101
102         /*
103          * Synchronize against page_lock_anon_vma_read() such that
104          * we can safely hold the lock without the anon_vma getting
105          * freed.
106          *
107          * Relies on the full mb implied by the atomic_dec_and_test() from
108          * put_anon_vma() against the acquire barrier implied by
109          * down_read_trylock() from page_lock_anon_vma_read(). This orders:
110          *
111          * page_lock_anon_vma_read()    VS      put_anon_vma()
112          *   down_read_trylock()                  atomic_dec_and_test()
113          *   LOCK                                 MB
114          *   atomic_read()                        rwsem_is_locked()
115          *
116          * LOCK should suffice since the actual taking of the lock must
117          * happen _before_ what follows.
118          */
119         might_sleep();
120         if (rwsem_is_locked(&anon_vma->root->rwsem)) {
121                 anon_vma_lock_write(anon_vma);
122                 anon_vma_unlock_write(anon_vma);
123         }
124
125         kmem_cache_free(anon_vma_cachep, anon_vma);
126 }
127
128 static inline struct anon_vma_chain *anon_vma_chain_alloc(gfp_t gfp)
129 {
130         return kmem_cache_alloc(anon_vma_chain_cachep, gfp);
131 }
132
133 static void anon_vma_chain_free(struct anon_vma_chain *anon_vma_chain)
134 {
135         kmem_cache_free(anon_vma_chain_cachep, anon_vma_chain);
136 }
137
138 static void anon_vma_chain_link(struct vm_area_struct *vma,
139                                 struct anon_vma_chain *avc,
140                                 struct anon_vma *anon_vma)
141 {
142         avc->vma = vma;
143         avc->anon_vma = anon_vma;
144         list_add(&avc->same_vma, &vma->anon_vma_chain);
145         anon_vma_interval_tree_insert(avc, &anon_vma->rb_root);
146 }
147
148 /**
149  * __anon_vma_prepare - attach an anon_vma to a memory region
150  * @vma: the memory region in question
151  *
152  * This makes sure the memory mapping described by 'vma' has
153  * an 'anon_vma' attached to it, so that we can associate the
154  * anonymous pages mapped into it with that anon_vma.
155  *
156  * The common case will be that we already have one, which
157  * is handled inline by anon_vma_prepare(). But if
158  * not we either need to find an adjacent mapping that we
159  * can re-use the anon_vma from (very common when the only
160  * reason for splitting a vma has been mprotect()), or we
161  * allocate a new one.
162  *
163  * Anon-vma allocations are very subtle, because we may have
164  * optimistically looked up an anon_vma in page_lock_anon_vma_read()
165  * and that may actually touch the spinlock even in the newly
166  * allocated vma (it depends on RCU to make sure that the
167  * anon_vma isn't actually destroyed).
168  *
169  * As a result, we need to do proper anon_vma locking even
170  * for the new allocation. At the same time, we do not want
171  * to do any locking for the common case of already having
172  * an anon_vma.
173  *
174  * This must be called with the mmap_sem held for reading.
175  */
176 int __anon_vma_prepare(struct vm_area_struct *vma)
177 {
178         struct mm_struct *mm = vma->vm_mm;
179         struct anon_vma *anon_vma, *allocated;
180         struct anon_vma_chain *avc;
181
182         might_sleep();
183
184         avc = anon_vma_chain_alloc(GFP_KERNEL);
185         if (!avc)
186                 goto out_enomem;
187
188         anon_vma = find_mergeable_anon_vma(vma);
189         allocated = NULL;
190         if (!anon_vma) {
191                 anon_vma = anon_vma_alloc();
192                 if (unlikely(!anon_vma))
193                         goto out_enomem_free_avc;
194                 anon_vma->num_children++; /* self-parent link for new root */
195                 allocated = anon_vma;
196         }
197
198         anon_vma_lock_write(anon_vma);
199         /* page_table_lock to protect against threads */
200         spin_lock(&mm->page_table_lock);
201         if (likely(!vma->anon_vma)) {
202                 vma->anon_vma = anon_vma;
203                 anon_vma_chain_link(vma, avc, anon_vma);
204                 anon_vma->num_active_vmas++;
205                 allocated = NULL;
206                 avc = NULL;
207         }
208         spin_unlock(&mm->page_table_lock);
209         anon_vma_unlock_write(anon_vma);
210
211         if (unlikely(allocated))
212                 put_anon_vma(allocated);
213         if (unlikely(avc))
214                 anon_vma_chain_free(avc);
215
216         return 0;
217
218  out_enomem_free_avc:
219         anon_vma_chain_free(avc);
220  out_enomem:
221         return -ENOMEM;
222 }
223
224 /*
225  * This is a useful helper function for locking the anon_vma root as
226  * we traverse the vma->anon_vma_chain, looping over anon_vma's that
227  * have the same vma.
228  *
229  * Such anon_vma's should have the same root, so you'd expect to see
230  * just a single mutex_lock for the whole traversal.
231  */
232 static inline struct anon_vma *lock_anon_vma_root(struct anon_vma *root, struct anon_vma *anon_vma)
233 {
234         struct anon_vma *new_root = anon_vma->root;
235         if (new_root != root) {
236                 if (WARN_ON_ONCE(root))
237                         up_write(&root->rwsem);
238                 root = new_root;
239                 down_write(&root->rwsem);
240         }
241         return root;
242 }
243
244 static inline void unlock_anon_vma_root(struct anon_vma *root)
245 {
246         if (root)
247                 up_write(&root->rwsem);
248 }
249
250 /*
251  * Attach the anon_vmas from src to dst.
252  * Returns 0 on success, -ENOMEM on failure.
253  *
254  * If dst->anon_vma is NULL this function tries to find and reuse existing
255  * anon_vma which has no vmas and only one child anon_vma. This prevents
256  * degradation of anon_vma hierarchy to endless linear chain in case of
257  * constantly forking task. On the other hand, an anon_vma with more than one
258  * child isn't reused even if there was no alive vma, thus rmap walker has a
259  * good chance of avoiding scanning the whole hierarchy when it searches where
260  * page is mapped.
261  */
262 int anon_vma_clone(struct vm_area_struct *dst, struct vm_area_struct *src)
263 {
264         struct anon_vma_chain *avc, *pavc;
265         struct anon_vma *root = NULL;
266
267         list_for_each_entry_reverse(pavc, &src->anon_vma_chain, same_vma) {
268                 struct anon_vma *anon_vma;
269
270                 avc = anon_vma_chain_alloc(GFP_NOWAIT | __GFP_NOWARN);
271                 if (unlikely(!avc)) {
272                         unlock_anon_vma_root(root);
273                         root = NULL;
274                         avc = anon_vma_chain_alloc(GFP_KERNEL);
275                         if (!avc)
276                                 goto enomem_failure;
277                 }
278                 anon_vma = pavc->anon_vma;
279                 root = lock_anon_vma_root(root, anon_vma);
280                 anon_vma_chain_link(dst, avc, anon_vma);
281
282                 /*
283                  * Reuse existing anon_vma if it has no vma and only one
284                  * anon_vma child.
285                  *
286                  * Root anon_vma is never reused:
287                  * it has self-parent reference and at least one child.
288                  */
289                 if (!dst->anon_vma &&
290                     anon_vma->num_children < 2 &&
291                     anon_vma->num_active_vmas == 0)
292                         dst->anon_vma = anon_vma;
293         }
294         if (dst->anon_vma)
295                 dst->anon_vma->num_active_vmas++;
296         unlock_anon_vma_root(root);
297         return 0;
298
299  enomem_failure:
300         /*
301          * dst->anon_vma is dropped here otherwise its degree can be incorrectly
302          * decremented in unlink_anon_vmas().
303          * We can safely do this because callers of anon_vma_clone() don't care
304          * about dst->anon_vma if anon_vma_clone() failed.
305          */
306         dst->anon_vma = NULL;
307         unlink_anon_vmas(dst);
308         return -ENOMEM;
309 }
310
311 /*
312  * Attach vma to its own anon_vma, as well as to the anon_vmas that
313  * the corresponding VMA in the parent process is attached to.
314  * Returns 0 on success, non-zero on failure.
315  */
316 int anon_vma_fork(struct vm_area_struct *vma, struct vm_area_struct *pvma)
317 {
318         struct anon_vma_chain *avc;
319         struct anon_vma *anon_vma;
320         int error;
321
322         /* Don't bother if the parent process has no anon_vma here. */
323         if (!pvma->anon_vma)
324                 return 0;
325
326         /* Drop inherited anon_vma, we'll reuse existing or allocate new. */
327         vma->anon_vma = NULL;
328
329         /*
330          * First, attach the new VMA to the parent VMA's anon_vmas,
331          * so rmap can find non-COWed pages in child processes.
332          */
333         error = anon_vma_clone(vma, pvma);
334         if (error)
335                 return error;
336
337         /* An existing anon_vma has been reused, all done then. */
338         if (vma->anon_vma)
339                 return 0;
340
341         /* Then add our own anon_vma. */
342         anon_vma = anon_vma_alloc();
343         if (!anon_vma)
344                 goto out_error;
345         anon_vma->num_active_vmas++;
346         avc = anon_vma_chain_alloc(GFP_KERNEL);
347         if (!avc)
348                 goto out_error_free_anon_vma;
349
350         /*
351          * The root anon_vma's spinlock is the lock actually used when we
352          * lock any of the anon_vmas in this anon_vma tree.
353          */
354         anon_vma->root = pvma->anon_vma->root;
355         anon_vma->parent = pvma->anon_vma;
356         /*
357          * With refcounts, an anon_vma can stay around longer than the
358          * process it belongs to. The root anon_vma needs to be pinned until
359          * this anon_vma is freed, because the lock lives in the root.
360          */
361         get_anon_vma(anon_vma->root);
362         /* Mark this anon_vma as the one where our new (COWed) pages go. */
363         vma->anon_vma = anon_vma;
364         anon_vma_lock_write(anon_vma);
365         anon_vma_chain_link(vma, avc, anon_vma);
366         anon_vma->parent->num_children++;
367         anon_vma_unlock_write(anon_vma);
368
369         return 0;
370
371  out_error_free_anon_vma:
372         put_anon_vma(anon_vma);
373  out_error:
374         unlink_anon_vmas(vma);
375         return -ENOMEM;
376 }
377
378 void unlink_anon_vmas(struct vm_area_struct *vma)
379 {
380         struct anon_vma_chain *avc, *next;
381         struct anon_vma *root = NULL;
382
383         /*
384          * Unlink each anon_vma chained to the VMA.  This list is ordered
385          * from newest to oldest, ensuring the root anon_vma gets freed last.
386          */
387         list_for_each_entry_safe(avc, next, &vma->anon_vma_chain, same_vma) {
388                 struct anon_vma *anon_vma = avc->anon_vma;
389
390                 root = lock_anon_vma_root(root, anon_vma);
391                 anon_vma_interval_tree_remove(avc, &anon_vma->rb_root);
392
393                 /*
394                  * Leave empty anon_vmas on the list - we'll need
395                  * to free them outside the lock.
396                  */
397                 if (RB_EMPTY_ROOT(&anon_vma->rb_root.rb_root)) {
398                         anon_vma->parent->num_children--;
399                         continue;
400                 }
401
402                 list_del(&avc->same_vma);
403                 anon_vma_chain_free(avc);
404         }
405         if (vma->anon_vma)
406                 vma->anon_vma->num_active_vmas--;
407         unlock_anon_vma_root(root);
408
409         /*
410          * Iterate the list once more, it now only contains empty and unlinked
411          * anon_vmas, destroy them. Could not do before due to __put_anon_vma()
412          * needing to write-acquire the anon_vma->root->rwsem.
413          */
414         list_for_each_entry_safe(avc, next, &vma->anon_vma_chain, same_vma) {
415                 struct anon_vma *anon_vma = avc->anon_vma;
416
417                 VM_WARN_ON(anon_vma->num_children);
418                 VM_WARN_ON(anon_vma->num_active_vmas);
419                 put_anon_vma(anon_vma);
420
421                 list_del(&avc->same_vma);
422                 anon_vma_chain_free(avc);
423         }
424 }
425
426 static void anon_vma_ctor(void *data)
427 {
428         struct anon_vma *anon_vma = data;
429
430         init_rwsem(&anon_vma->rwsem);
431         atomic_set(&anon_vma->refcount, 0);
432         anon_vma->rb_root = RB_ROOT_CACHED;
433 }
434
435 void __init anon_vma_init(void)
436 {
437         anon_vma_cachep = kmem_cache_create("anon_vma", sizeof(struct anon_vma),
438                         0, SLAB_TYPESAFE_BY_RCU|SLAB_PANIC|SLAB_ACCOUNT,
439                         anon_vma_ctor);
440         anon_vma_chain_cachep = KMEM_CACHE(anon_vma_chain,
441                         SLAB_PANIC|SLAB_ACCOUNT);
442 }
443
444 /*
445  * Getting a lock on a stable anon_vma from a page off the LRU is tricky!
446  *
447  * Since there is no serialization what so ever against page_remove_rmap()
448  * the best this function can do is return a locked anon_vma that might
449  * have been relevant to this page.
450  *
451  * The page might have been remapped to a different anon_vma or the anon_vma
452  * returned may already be freed (and even reused).
453  *
454  * In case it was remapped to a different anon_vma, the new anon_vma will be a
455  * child of the old anon_vma, and the anon_vma lifetime rules will therefore
456  * ensure that any anon_vma obtained from the page will still be valid for as
457  * long as we observe page_mapped() [ hence all those page_mapped() tests ].
458  *
459  * All users of this function must be very careful when walking the anon_vma
460  * chain and verify that the page in question is indeed mapped in it
461  * [ something equivalent to page_mapped_in_vma() ].
462  *
463  * Since anon_vma's slab is DESTROY_BY_RCU and we know from page_remove_rmap()
464  * that the anon_vma pointer from page->mapping is valid if there is a
465  * mapcount, we can dereference the anon_vma after observing those.
466  */
467 struct anon_vma *page_get_anon_vma(struct page *page)
468 {
469         struct anon_vma *anon_vma = NULL;
470         unsigned long anon_mapping;
471
472         rcu_read_lock();
473         anon_mapping = (unsigned long)READ_ONCE(page->mapping);
474         if ((anon_mapping & PAGE_MAPPING_FLAGS) != PAGE_MAPPING_ANON)
475                 goto out;
476         if (!page_mapped(page))
477                 goto out;
478
479         anon_vma = (struct anon_vma *) (anon_mapping - PAGE_MAPPING_ANON);
480         if (!atomic_inc_not_zero(&anon_vma->refcount)) {
481                 anon_vma = NULL;
482                 goto out;
483         }
484
485         /*
486          * If this page is still mapped, then its anon_vma cannot have been
487          * freed.  But if it has been unmapped, we have no security against the
488          * anon_vma structure being freed and reused (for another anon_vma:
489          * SLAB_TYPESAFE_BY_RCU guarantees that - so the atomic_inc_not_zero()
490          * above cannot corrupt).
491          */
492         if (!page_mapped(page)) {
493                 rcu_read_unlock();
494                 put_anon_vma(anon_vma);
495                 return NULL;
496         }
497 out:
498         rcu_read_unlock();
499
500         return anon_vma;
501 }
502
503 /*
504  * Similar to page_get_anon_vma() except it locks the anon_vma.
505  *
506  * Its a little more complex as it tries to keep the fast path to a single
507  * atomic op -- the trylock. If we fail the trylock, we fall back to getting a
508  * reference like with page_get_anon_vma() and then block on the mutex.
509  */
510 struct anon_vma *page_lock_anon_vma_read(struct page *page)
511 {
512         struct anon_vma *anon_vma = NULL;
513         struct anon_vma *root_anon_vma;
514         unsigned long anon_mapping;
515
516         rcu_read_lock();
517         anon_mapping = (unsigned long)READ_ONCE(page->mapping);
518         if ((anon_mapping & PAGE_MAPPING_FLAGS) != PAGE_MAPPING_ANON)
519                 goto out;
520         if (!page_mapped(page))
521                 goto out;
522
523         anon_vma = (struct anon_vma *) (anon_mapping - PAGE_MAPPING_ANON);
524         root_anon_vma = READ_ONCE(anon_vma->root);
525         if (down_read_trylock(&root_anon_vma->rwsem)) {
526                 /*
527                  * If the page is still mapped, then this anon_vma is still
528                  * its anon_vma, and holding the mutex ensures that it will
529                  * not go away, see anon_vma_free().
530                  */
531                 if (!page_mapped(page)) {
532                         up_read(&root_anon_vma->rwsem);
533                         anon_vma = NULL;
534                 }
535                 goto out;
536         }
537
538         /* trylock failed, we got to sleep */
539         if (!atomic_inc_not_zero(&anon_vma->refcount)) {
540                 anon_vma = NULL;
541                 goto out;
542         }
543
544         if (!page_mapped(page)) {
545                 rcu_read_unlock();
546                 put_anon_vma(anon_vma);
547                 return NULL;
548         }
549
550         /* we pinned the anon_vma, its safe to sleep */
551         rcu_read_unlock();
552         anon_vma_lock_read(anon_vma);
553
554         if (atomic_dec_and_test(&anon_vma->refcount)) {
555                 /*
556                  * Oops, we held the last refcount, release the lock
557                  * and bail -- can't simply use put_anon_vma() because
558                  * we'll deadlock on the anon_vma_lock_write() recursion.
559                  */
560                 anon_vma_unlock_read(anon_vma);
561                 __put_anon_vma(anon_vma);
562                 anon_vma = NULL;
563         }
564
565         return anon_vma;
566
567 out:
568         rcu_read_unlock();
569         return anon_vma;
570 }
571
572 void page_unlock_anon_vma_read(struct anon_vma *anon_vma)
573 {
574         anon_vma_unlock_read(anon_vma);
575 }
576
577 #ifdef CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH
578 /*
579  * Flush TLB entries for recently unmapped pages from remote CPUs. It is
580  * important if a PTE was dirty when it was unmapped that it's flushed
581  * before any IO is initiated on the page to prevent lost writes. Similarly,
582  * it must be flushed before freeing to prevent data leakage.
583  */
584 void try_to_unmap_flush(void)
585 {
586         struct tlbflush_unmap_batch *tlb_ubc = &current->tlb_ubc;
587
588         if (!tlb_ubc->flush_required)
589                 return;
590
591         arch_tlbbatch_flush(&tlb_ubc->arch);
592         tlb_ubc->flush_required = false;
593         tlb_ubc->writable = false;
594 }
595
596 /* Flush iff there are potentially writable TLB entries that can race with IO */
597 void try_to_unmap_flush_dirty(void)
598 {
599         struct tlbflush_unmap_batch *tlb_ubc = &current->tlb_ubc;
600
601         if (tlb_ubc->writable)
602                 try_to_unmap_flush();
603 }
604
605 static void set_tlb_ubc_flush_pending(struct mm_struct *mm, bool writable)
606 {
607         struct tlbflush_unmap_batch *tlb_ubc = &current->tlb_ubc;
608
609         arch_tlbbatch_add_mm(&tlb_ubc->arch, mm);
610         tlb_ubc->flush_required = true;
611
612         /*
613          * Ensure compiler does not re-order the setting of tlb_flush_batched
614          * before the PTE is cleared.
615          */
616         barrier();
617         mm->tlb_flush_batched = true;
618
619         /*
620          * If the PTE was dirty then it's best to assume it's writable. The
621          * caller must use try_to_unmap_flush_dirty() or try_to_unmap_flush()
622          * before the page is queued for IO.
623          */
624         if (writable)
625                 tlb_ubc->writable = true;
626 }
627
628 /*
629  * Returns true if the TLB flush should be deferred to the end of a batch of
630  * unmap operations to reduce IPIs.
631  */
632 static bool should_defer_flush(struct mm_struct *mm, enum ttu_flags flags)
633 {
634         bool should_defer = false;
635
636         if (!(flags & TTU_BATCH_FLUSH))
637                 return false;
638
639         /* If remote CPUs need to be flushed then defer batch the flush */
640         if (cpumask_any_but(mm_cpumask(mm), get_cpu()) < nr_cpu_ids)
641                 should_defer = true;
642         put_cpu();
643
644         return should_defer;
645 }
646
647 /*
648  * Reclaim unmaps pages under the PTL but do not flush the TLB prior to
649  * releasing the PTL if TLB flushes are batched. It's possible for a parallel
650  * operation such as mprotect or munmap to race between reclaim unmapping
651  * the page and flushing the page. If this race occurs, it potentially allows
652  * access to data via a stale TLB entry. Tracking all mm's that have TLB
653  * batching in flight would be expensive during reclaim so instead track
654  * whether TLB batching occurred in the past and if so then do a flush here
655  * if required. This will cost one additional flush per reclaim cycle paid
656  * by the first operation at risk such as mprotect and mumap.
657  *
658  * This must be called under the PTL so that an access to tlb_flush_batched
659  * that is potentially a "reclaim vs mprotect/munmap/etc" race will synchronise
660  * via the PTL.
661  */
662 void flush_tlb_batched_pending(struct mm_struct *mm)
663 {
664         if (mm->tlb_flush_batched) {
665                 flush_tlb_mm(mm);
666
667                 /*
668                  * Do not allow the compiler to re-order the clearing of
669                  * tlb_flush_batched before the tlb is flushed.
670                  */
671                 barrier();
672                 mm->tlb_flush_batched = false;
673         }
674 }
675 #else
676 static void set_tlb_ubc_flush_pending(struct mm_struct *mm, bool writable)
677 {
678 }
679
680 static bool should_defer_flush(struct mm_struct *mm, enum ttu_flags flags)
681 {
682         return false;
683 }
684 #endif /* CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH */
685
686 /*
687  * At what user virtual address is page expected in vma?
688  * Caller should check the page is actually part of the vma.
689  */
690 unsigned long page_address_in_vma(struct page *page, struct vm_area_struct *vma)
691 {
692         if (PageAnon(page)) {
693                 struct anon_vma *page__anon_vma = page_anon_vma(page);
694                 /*
695                  * Note: swapoff's unuse_vma() is more efficient with this
696                  * check, and needs it to match anon_vma when KSM is active.
697                  */
698                 if (!vma->anon_vma || !page__anon_vma ||
699                     vma->anon_vma->root != page__anon_vma->root)
700                         return -EFAULT;
701         } else if (!vma->vm_file) {
702                 return -EFAULT;
703         } else if (vma->vm_file->f_mapping != compound_head(page)->mapping) {
704                 return -EFAULT;
705         }
706
707         return vma_address(page, vma);
708 }
709
710 pmd_t *mm_find_pmd(struct mm_struct *mm, unsigned long address)
711 {
712         pgd_t *pgd;
713         p4d_t *p4d;
714         pud_t *pud;
715         pmd_t *pmd = NULL;
716         pmd_t pmde;
717
718         pgd = pgd_offset(mm, address);
719         if (!pgd_present(*pgd))
720                 goto out;
721
722         p4d = p4d_offset(pgd, address);
723         if (!p4d_present(*p4d))
724                 goto out;
725
726         pud = pud_offset(p4d, address);
727         if (!pud_present(*pud))
728                 goto out;
729
730         pmd = pmd_offset(pud, address);
731         /*
732          * Some THP functions use the sequence pmdp_huge_clear_flush(), set_pmd_at()
733          * without holding anon_vma lock for write.  So when looking for a
734          * genuine pmde (in which to find pte), test present and !THP together.
735          */
736         pmde = *pmd;
737         barrier();
738         if (!pmd_present(pmde) || pmd_trans_huge(pmde))
739                 pmd = NULL;
740 out:
741         return pmd;
742 }
743
744 struct page_referenced_arg {
745         int mapcount;
746         int referenced;
747         unsigned long vm_flags;
748         struct mem_cgroup *memcg;
749 };
750 /*
751  * arg: page_referenced_arg will be passed
752  */
753 static bool page_referenced_one(struct page *page, struct vm_area_struct *vma,
754                         unsigned long address, void *arg)
755 {
756         struct page_referenced_arg *pra = arg;
757         struct page_vma_mapped_walk pvmw = {
758                 .page = page,
759                 .vma = vma,
760                 .address = address,
761         };
762         int referenced = 0;
763
764         while (page_vma_mapped_walk(&pvmw)) {
765                 address = pvmw.address;
766
767                 if (vma->vm_flags & VM_LOCKED) {
768                         page_vma_mapped_walk_done(&pvmw);
769                         pra->vm_flags |= VM_LOCKED;
770                         return false; /* To break the loop */
771                 }
772
773                 if (pvmw.pte) {
774                         if (ptep_clear_flush_young_notify(vma, address,
775                                                 pvmw.pte)) {
776                                 /*
777                                  * Don't treat a reference through
778                                  * a sequentially read mapping as such.
779                                  * If the page has been used in another mapping,
780                                  * we will catch it; if this other mapping is
781                                  * already gone, the unmap path will have set
782                                  * PG_referenced or activated the page.
783                                  */
784                                 if (likely(!(vma->vm_flags & VM_SEQ_READ)))
785                                         referenced++;
786                         }
787                 } else if (IS_ENABLED(CONFIG_TRANSPARENT_HUGEPAGE)) {
788                         if (pmdp_clear_flush_young_notify(vma, address,
789                                                 pvmw.pmd))
790                                 referenced++;
791                 } else {
792                         /* unexpected pmd-mapped page? */
793                         WARN_ON_ONCE(1);
794                 }
795
796                 pra->mapcount--;
797         }
798
799         if (referenced)
800                 clear_page_idle(page);
801         if (test_and_clear_page_young(page))
802                 referenced++;
803
804         if (referenced) {
805                 pra->referenced++;
806                 pra->vm_flags |= vma->vm_flags;
807         }
808
809         if (!pra->mapcount)
810                 return false; /* To break the loop */
811
812         return true;
813 }
814
815 static bool invalid_page_referenced_vma(struct vm_area_struct *vma, void *arg)
816 {
817         struct page_referenced_arg *pra = arg;
818         struct mem_cgroup *memcg = pra->memcg;
819
820         if (!mm_match_cgroup(vma->vm_mm, memcg))
821                 return true;
822
823         return false;
824 }
825
826 /**
827  * page_referenced - test if the page was referenced
828  * @page: the page to test
829  * @is_locked: caller holds lock on the page
830  * @memcg: target memory cgroup
831  * @vm_flags: collect encountered vma->vm_flags who actually referenced the page
832  *
833  * Quick test_and_clear_referenced for all mappings to a page,
834  * returns the number of ptes which referenced the page.
835  */
836 int page_referenced(struct page *page,
837                     int is_locked,
838                     struct mem_cgroup *memcg,
839                     unsigned long *vm_flags)
840 {
841         int we_locked = 0;
842         struct page_referenced_arg pra = {
843                 .mapcount = total_mapcount(page),
844                 .memcg = memcg,
845         };
846         struct rmap_walk_control rwc = {
847                 .rmap_one = page_referenced_one,
848                 .arg = (void *)&pra,
849                 .anon_lock = page_lock_anon_vma_read,
850         };
851
852         *vm_flags = 0;
853         if (!page_mapped(page))
854                 return 0;
855
856         if (!page_rmapping(page))
857                 return 0;
858
859         if (!is_locked && (!PageAnon(page) || PageKsm(page))) {
860                 we_locked = trylock_page(page);
861                 if (!we_locked)
862                         return 1;
863         }
864
865         /*
866          * If we are reclaiming on behalf of a cgroup, skip
867          * counting on behalf of references from different
868          * cgroups
869          */
870         if (memcg) {
871                 rwc.invalid_vma = invalid_page_referenced_vma;
872         }
873
874         rmap_walk(page, &rwc);
875         *vm_flags = pra.vm_flags;
876
877         if (we_locked)
878                 unlock_page(page);
879
880         return pra.referenced;
881 }
882
883 static bool page_mkclean_one(struct page *page, struct vm_area_struct *vma,
884                             unsigned long address, void *arg)
885 {
886         struct page_vma_mapped_walk pvmw = {
887                 .page = page,
888                 .vma = vma,
889                 .address = address,
890                 .flags = PVMW_SYNC,
891         };
892         unsigned long start = address, end;
893         int *cleaned = arg;
894
895         /*
896          * We have to assume the worse case ie pmd for invalidation. Note that
897          * the page can not be free from this function.
898          */
899         end = vma_address_end(page, vma);
900         mmu_notifier_invalidate_range_start(vma->vm_mm, start, end);
901
902         while (page_vma_mapped_walk(&pvmw)) {
903                 unsigned long cstart, cend;
904                 int ret = 0;
905
906                 cstart = address = pvmw.address;
907                 if (pvmw.pte) {
908                         pte_t entry;
909                         pte_t *pte = pvmw.pte;
910
911                         if (!pte_dirty(*pte) && !pte_write(*pte))
912                                 continue;
913
914                         flush_cache_page(vma, address, pte_pfn(*pte));
915                         entry = ptep_clear_flush(vma, address, pte);
916                         entry = pte_wrprotect(entry);
917                         entry = pte_mkclean(entry);
918                         set_pte_at(vma->vm_mm, address, pte, entry);
919                         cend = cstart + PAGE_SIZE;
920                         ret = 1;
921                 } else {
922 #ifdef CONFIG_TRANSPARENT_HUGE_PAGECACHE
923                         pmd_t *pmd = pvmw.pmd;
924                         pmd_t entry;
925
926                         if (!pmd_dirty(*pmd) && !pmd_write(*pmd))
927                                 continue;
928
929                         flush_cache_page(vma, address, page_to_pfn(page));
930                         entry = pmdp_huge_clear_flush(vma, address, pmd);
931                         entry = pmd_wrprotect(entry);
932                         entry = pmd_mkclean(entry);
933                         set_pmd_at(vma->vm_mm, address, pmd, entry);
934                         cstart &= PMD_MASK;
935                         cend = cstart + PMD_SIZE;
936                         ret = 1;
937 #else
938                         /* unexpected pmd-mapped page? */
939                         WARN_ON_ONCE(1);
940 #endif
941                 }
942
943                 if (ret) {
944                         mmu_notifier_invalidate_range(vma->vm_mm, cstart, cend);
945                         (*cleaned)++;
946                 }
947         }
948
949         mmu_notifier_invalidate_range_end(vma->vm_mm, start, end);
950
951         return true;
952 }
953
954 static bool invalid_mkclean_vma(struct vm_area_struct *vma, void *arg)
955 {
956         if (vma->vm_flags & VM_SHARED)
957                 return false;
958
959         return true;
960 }
961
962 int page_mkclean(struct page *page)
963 {
964         int cleaned = 0;
965         struct address_space *mapping;
966         struct rmap_walk_control rwc = {
967                 .arg = (void *)&cleaned,
968                 .rmap_one = page_mkclean_one,
969                 .invalid_vma = invalid_mkclean_vma,
970         };
971
972         BUG_ON(!PageLocked(page));
973
974         if (!page_mapped(page))
975                 return 0;
976
977         mapping = page_mapping(page);
978         if (!mapping)
979                 return 0;
980
981         rmap_walk(page, &rwc);
982
983         return cleaned;
984 }
985 EXPORT_SYMBOL_GPL(page_mkclean);
986
987 /**
988  * page_move_anon_rmap - move a page to our anon_vma
989  * @page:       the page to move to our anon_vma
990  * @vma:        the vma the page belongs to
991  *
992  * When a page belongs exclusively to one process after a COW event,
993  * that page can be moved into the anon_vma that belongs to just that
994  * process, so the rmap code will not search the parent or sibling
995  * processes.
996  */
997 void page_move_anon_rmap(struct page *page, struct vm_area_struct *vma)
998 {
999         struct anon_vma *anon_vma = vma->anon_vma;
1000
1001         page = compound_head(page);
1002
1003         VM_BUG_ON_PAGE(!PageLocked(page), page);
1004         VM_BUG_ON_VMA(!anon_vma, vma);
1005
1006         anon_vma = (void *) anon_vma + PAGE_MAPPING_ANON;
1007         /*
1008          * Ensure that anon_vma and the PAGE_MAPPING_ANON bit are written
1009          * simultaneously, so a concurrent reader (eg page_referenced()'s
1010          * PageAnon()) will not see one without the other.
1011          */
1012         WRITE_ONCE(page->mapping, (struct address_space *) anon_vma);
1013 }
1014
1015 /**
1016  * __page_set_anon_rmap - set up new anonymous rmap
1017  * @page:       Page to add to rmap     
1018  * @vma:        VM area to add page to.
1019  * @address:    User virtual address of the mapping     
1020  * @exclusive:  the page is exclusively owned by the current process
1021  */
1022 static void __page_set_anon_rmap(struct page *page,
1023         struct vm_area_struct *vma, unsigned long address, int exclusive)
1024 {
1025         struct anon_vma *anon_vma = vma->anon_vma;
1026
1027         BUG_ON(!anon_vma);
1028
1029         if (PageAnon(page))
1030                 return;
1031
1032         /*
1033          * If the page isn't exclusively mapped into this vma,
1034          * we must use the _oldest_ possible anon_vma for the
1035          * page mapping!
1036          */
1037         if (!exclusive)
1038                 anon_vma = anon_vma->root;
1039
1040         anon_vma = (void *) anon_vma + PAGE_MAPPING_ANON;
1041         page->mapping = (struct address_space *) anon_vma;
1042         page->index = linear_page_index(vma, address);
1043 }
1044
1045 /**
1046  * __page_check_anon_rmap - sanity check anonymous rmap addition
1047  * @page:       the page to add the mapping to
1048  * @vma:        the vm area in which the mapping is added
1049  * @address:    the user virtual address mapped
1050  */
1051 static void __page_check_anon_rmap(struct page *page,
1052         struct vm_area_struct *vma, unsigned long address)
1053 {
1054 #ifdef CONFIG_DEBUG_VM
1055         /*
1056          * The page's anon-rmap details (mapping and index) are guaranteed to
1057          * be set up correctly at this point.
1058          *
1059          * We have exclusion against page_add_anon_rmap because the caller
1060          * always holds the page locked, except if called from page_dup_rmap,
1061          * in which case the page is already known to be setup.
1062          *
1063          * We have exclusion against page_add_new_anon_rmap because those pages
1064          * are initially only visible via the pagetables, and the pte is locked
1065          * over the call to page_add_new_anon_rmap.
1066          */
1067         BUG_ON(page_anon_vma(page)->root != vma->anon_vma->root);
1068         BUG_ON(page_to_pgoff(page) != linear_page_index(vma, address));
1069 #endif
1070 }
1071
1072 /**
1073  * page_add_anon_rmap - add pte mapping to an anonymous page
1074  * @page:       the page to add the mapping to
1075  * @vma:        the vm area in which the mapping is added
1076  * @address:    the user virtual address mapped
1077  * @compound:   charge the page as compound or small page
1078  *
1079  * The caller needs to hold the pte lock, and the page must be locked in
1080  * the anon_vma case: to serialize mapping,index checking after setting,
1081  * and to ensure that PageAnon is not being upgraded racily to PageKsm
1082  * (but PageKsm is never downgraded to PageAnon).
1083  */
1084 void page_add_anon_rmap(struct page *page,
1085         struct vm_area_struct *vma, unsigned long address, bool compound)
1086 {
1087         do_page_add_anon_rmap(page, vma, address, compound ? RMAP_COMPOUND : 0);
1088 }
1089
1090 /*
1091  * Special version of the above for do_swap_page, which often runs
1092  * into pages that are exclusively owned by the current process.
1093  * Everybody else should continue to use page_add_anon_rmap above.
1094  */
1095 void do_page_add_anon_rmap(struct page *page,
1096         struct vm_area_struct *vma, unsigned long address, int flags)
1097 {
1098         bool compound = flags & RMAP_COMPOUND;
1099         bool first;
1100
1101         if (compound) {
1102                 atomic_t *mapcount;
1103                 VM_BUG_ON_PAGE(!PageLocked(page), page);
1104                 VM_BUG_ON_PAGE(!PageTransHuge(page), page);
1105                 mapcount = compound_mapcount_ptr(page);
1106                 first = atomic_inc_and_test(mapcount);
1107         } else {
1108                 first = atomic_inc_and_test(&page->_mapcount);
1109         }
1110
1111         if (first) {
1112                 int nr = compound ? hpage_nr_pages(page) : 1;
1113                 /*
1114                  * We use the irq-unsafe __{inc|mod}_zone_page_stat because
1115                  * these counters are not modified in interrupt context, and
1116                  * pte lock(a spinlock) is held, which implies preemption
1117                  * disabled.
1118                  */
1119                 if (compound)
1120                         __inc_node_page_state(page, NR_ANON_THPS);
1121                 __mod_node_page_state(page_pgdat(page), NR_ANON_MAPPED, nr);
1122         }
1123         if (unlikely(PageKsm(page)))
1124                 return;
1125
1126         VM_BUG_ON_PAGE(!PageLocked(page), page);
1127
1128         /* address might be in next vma when migration races vma_adjust */
1129         if (first)
1130                 __page_set_anon_rmap(page, vma, address,
1131                                 flags & RMAP_EXCLUSIVE);
1132         else
1133                 __page_check_anon_rmap(page, vma, address);
1134 }
1135
1136 /**
1137  * page_add_new_anon_rmap - add pte mapping to a new anonymous page
1138  * @page:       the page to add the mapping to
1139  * @vma:        the vm area in which the mapping is added
1140  * @address:    the user virtual address mapped
1141  * @compound:   charge the page as compound or small page
1142  *
1143  * Same as page_add_anon_rmap but must only be called on *new* pages.
1144  * This means the inc-and-test can be bypassed.
1145  * Page does not have to be locked.
1146  */
1147 void page_add_new_anon_rmap(struct page *page,
1148         struct vm_area_struct *vma, unsigned long address, bool compound)
1149 {
1150         int nr = compound ? hpage_nr_pages(page) : 1;
1151
1152         VM_BUG_ON_VMA(address < vma->vm_start || address >= vma->vm_end, vma);
1153         __SetPageSwapBacked(page);
1154         if (compound) {
1155                 VM_BUG_ON_PAGE(!PageTransHuge(page), page);
1156                 /* increment count (starts at -1) */
1157                 atomic_set(compound_mapcount_ptr(page), 0);
1158                 __inc_node_page_state(page, NR_ANON_THPS);
1159         } else {
1160                 /* Anon THP always mapped first with PMD */
1161                 VM_BUG_ON_PAGE(PageTransCompound(page), page);
1162                 /* increment count (starts at -1) */
1163                 atomic_set(&page->_mapcount, 0);
1164         }
1165         __mod_node_page_state(page_pgdat(page), NR_ANON_MAPPED, nr);
1166         __page_set_anon_rmap(page, vma, address, 1);
1167 }
1168
1169 /**
1170  * page_add_file_rmap - add pte mapping to a file page
1171  * @page: the page to add the mapping to
1172  *
1173  * The caller needs to hold the pte lock.
1174  */
1175 void page_add_file_rmap(struct page *page, bool compound)
1176 {
1177         int i, nr = 1;
1178
1179         VM_BUG_ON_PAGE(compound && !PageTransHuge(page), page);
1180         lock_page_memcg(page);
1181         if (compound && PageTransHuge(page)) {
1182                 for (i = 0, nr = 0; i < HPAGE_PMD_NR; i++) {
1183                         if (atomic_inc_and_test(&page[i]._mapcount))
1184                                 nr++;
1185                 }
1186                 if (!atomic_inc_and_test(compound_mapcount_ptr(page)))
1187                         goto out;
1188                 VM_BUG_ON_PAGE(!PageSwapBacked(page), page);
1189                 __inc_node_page_state(page, NR_SHMEM_PMDMAPPED);
1190         } else {
1191                 if (PageTransCompound(page) && page_mapping(page)) {
1192                         VM_WARN_ON_ONCE(!PageLocked(page));
1193
1194                         SetPageDoubleMap(compound_head(page));
1195                         if (PageMlocked(page))
1196                                 clear_page_mlock(compound_head(page));
1197                 }
1198                 if (!atomic_inc_and_test(&page->_mapcount))
1199                         goto out;
1200         }
1201         __mod_lruvec_page_state(page, NR_FILE_MAPPED, nr);
1202 out:
1203         unlock_page_memcg(page);
1204 }
1205
1206 static void page_remove_file_rmap(struct page *page, bool compound)
1207 {
1208         int i, nr = 1;
1209
1210         VM_BUG_ON_PAGE(compound && !PageHead(page), page);
1211         lock_page_memcg(page);
1212
1213         /* Hugepages are not counted in NR_FILE_MAPPED for now. */
1214         if (unlikely(PageHuge(page))) {
1215                 /* hugetlb pages are always mapped with pmds */
1216                 atomic_dec(compound_mapcount_ptr(page));
1217                 goto out;
1218         }
1219
1220         /* page still mapped by someone else? */
1221         if (compound && PageTransHuge(page)) {
1222                 for (i = 0, nr = 0; i < HPAGE_PMD_NR; i++) {
1223                         if (atomic_add_negative(-1, &page[i]._mapcount))
1224                                 nr++;
1225                 }
1226                 if (!atomic_add_negative(-1, compound_mapcount_ptr(page)))
1227                         goto out;
1228                 VM_BUG_ON_PAGE(!PageSwapBacked(page), page);
1229                 __dec_node_page_state(page, NR_SHMEM_PMDMAPPED);
1230         } else {
1231                 if (!atomic_add_negative(-1, &page->_mapcount))
1232                         goto out;
1233         }
1234
1235         /*
1236          * We use the irq-unsafe __{inc|mod}_lruvec_page_state because
1237          * these counters are not modified in interrupt context, and
1238          * pte lock(a spinlock) is held, which implies preemption disabled.
1239          */
1240         __mod_lruvec_page_state(page, NR_FILE_MAPPED, -nr);
1241
1242         if (unlikely(PageMlocked(page)))
1243                 clear_page_mlock(page);
1244 out:
1245         unlock_page_memcg(page);
1246 }
1247
1248 static void page_remove_anon_compound_rmap(struct page *page)
1249 {
1250         int i, nr;
1251
1252         if (!atomic_add_negative(-1, compound_mapcount_ptr(page)))
1253                 return;
1254
1255         /* Hugepages are not counted in NR_ANON_PAGES for now. */
1256         if (unlikely(PageHuge(page)))
1257                 return;
1258
1259         if (!IS_ENABLED(CONFIG_TRANSPARENT_HUGEPAGE))
1260                 return;
1261
1262         __dec_node_page_state(page, NR_ANON_THPS);
1263
1264         if (TestClearPageDoubleMap(page)) {
1265                 /*
1266                  * Subpages can be mapped with PTEs too. Check how many of
1267                  * themi are still mapped.
1268                  */
1269                 for (i = 0, nr = 0; i < HPAGE_PMD_NR; i++) {
1270                         if (atomic_add_negative(-1, &page[i]._mapcount))
1271                                 nr++;
1272                 }
1273         } else {
1274                 nr = HPAGE_PMD_NR;
1275         }
1276
1277         if (unlikely(PageMlocked(page)))
1278                 clear_page_mlock(page);
1279
1280         if (nr) {
1281                 __mod_node_page_state(page_pgdat(page), NR_ANON_MAPPED, -nr);
1282                 deferred_split_huge_page(page);
1283         }
1284 }
1285
1286 /**
1287  * page_remove_rmap - take down pte mapping from a page
1288  * @page:       page to remove mapping from
1289  * @compound:   uncharge the page as compound or small page
1290  *
1291  * The caller needs to hold the pte lock.
1292  */
1293 void page_remove_rmap(struct page *page, bool compound)
1294 {
1295         if (!PageAnon(page))
1296                 return page_remove_file_rmap(page, compound);
1297
1298         if (compound)
1299                 return page_remove_anon_compound_rmap(page);
1300
1301         /* page still mapped by someone else? */
1302         if (!atomic_add_negative(-1, &page->_mapcount))
1303                 return;
1304
1305         /*
1306          * We use the irq-unsafe __{inc|mod}_zone_page_stat because
1307          * these counters are not modified in interrupt context, and
1308          * pte lock(a spinlock) is held, which implies preemption disabled.
1309          */
1310         __dec_node_page_state(page, NR_ANON_MAPPED);
1311
1312         if (unlikely(PageMlocked(page)))
1313                 clear_page_mlock(page);
1314
1315         if (PageTransCompound(page))
1316                 deferred_split_huge_page(compound_head(page));
1317
1318         /*
1319          * It would be tidy to reset the PageAnon mapping here,
1320          * but that might overwrite a racing page_add_anon_rmap
1321          * which increments mapcount after us but sets mapping
1322          * before us: so leave the reset to free_hot_cold_page,
1323          * and remember that it's only reliable while mapped.
1324          * Leaving it set also helps swapoff to reinstate ptes
1325          * faster for those pages still in swapcache.
1326          */
1327 }
1328
1329 /*
1330  * @arg: enum ttu_flags will be passed to this argument
1331  */
1332 static bool try_to_unmap_one(struct page *page, struct vm_area_struct *vma,
1333                      unsigned long address, void *arg)
1334 {
1335         struct mm_struct *mm = vma->vm_mm;
1336         struct page_vma_mapped_walk pvmw = {
1337                 .page = page,
1338                 .vma = vma,
1339                 .address = address,
1340         };
1341         pte_t pteval;
1342         struct page *subpage;
1343         bool ret = true;
1344         unsigned long start = address, end;
1345         enum ttu_flags flags = (enum ttu_flags)arg;
1346
1347         /*
1348          * When racing against e.g. zap_pte_range() on another cpu,
1349          * in between its ptep_get_and_clear_full() and page_remove_rmap(),
1350          * try_to_unmap() may return false when it is about to become true,
1351          * if page table locking is skipped: use TTU_SYNC to wait for that.
1352          */
1353         if (flags & TTU_SYNC)
1354                 pvmw.flags = PVMW_SYNC;
1355
1356         /* munlock has nothing to gain from examining un-locked vmas */
1357         if ((flags & TTU_MUNLOCK) && !(vma->vm_flags & VM_LOCKED))
1358                 return true;
1359
1360         if (IS_ENABLED(CONFIG_MIGRATION) && (flags & TTU_MIGRATION) &&
1361             is_zone_device_page(page) && !is_device_private_page(page))
1362                 return true;
1363
1364         if (flags & TTU_SPLIT_HUGE_PMD) {
1365                 split_huge_pmd_address(vma, address,
1366                                 flags & TTU_SPLIT_FREEZE, page);
1367         }
1368
1369         /*
1370          * For THP, we have to assume the worse case ie pmd for invalidation.
1371          * For hugetlb, it could be much worse if we need to do pud
1372          * invalidation in the case of pmd sharing.
1373          *
1374          * Note that the page can not be free in this function as call of
1375          * try_to_unmap() must hold a reference on the page.
1376          */
1377         end = PageKsm(page) ?
1378                         address + PAGE_SIZE : vma_address_end(page, vma);
1379         if (PageHuge(page)) {
1380                 /*
1381                  * If sharing is possible, start and end will be adjusted
1382                  * accordingly.
1383                  */
1384                 adjust_range_if_pmd_sharing_possible(vma, &start, &end);
1385         }
1386         mmu_notifier_invalidate_range_start(vma->vm_mm, start, end);
1387
1388         while (page_vma_mapped_walk(&pvmw)) {
1389 #ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
1390                 /* PMD-mapped THP migration entry */
1391                 if (!pvmw.pte && (flags & TTU_MIGRATION)) {
1392                         VM_BUG_ON_PAGE(PageHuge(page) || !PageTransCompound(page), page);
1393
1394                         if (!PageAnon(page))
1395                                 continue;
1396
1397                         set_pmd_migration_entry(&pvmw, page);
1398                         continue;
1399                 }
1400 #endif
1401
1402                 /*
1403                  * If the page is mlock()d, we cannot swap it out.
1404                  * If it's recently referenced (perhaps page_referenced
1405                  * skipped over this mm) then we should reactivate it.
1406                  */
1407                 if (!(flags & TTU_IGNORE_MLOCK)) {
1408                         if (vma->vm_flags & VM_LOCKED) {
1409                                 /* PTE-mapped THP are never mlocked */
1410                                 if (!PageTransCompound(page)) {
1411                                         /*
1412                                          * Holding pte lock, we do *not* need
1413                                          * mmap_sem here
1414                                          */
1415                                         mlock_vma_page(page);
1416                                 }
1417                                 ret = false;
1418                                 page_vma_mapped_walk_done(&pvmw);
1419                                 break;
1420                         }
1421                         if (flags & TTU_MUNLOCK)
1422                                 continue;
1423                 }
1424
1425                 /* Unexpected PMD-mapped THP? */
1426                 VM_BUG_ON_PAGE(!pvmw.pte, page);
1427
1428                 subpage = page - page_to_pfn(page) + pte_pfn(*pvmw.pte);
1429                 address = pvmw.address;
1430
1431                 if (PageHuge(page)) {
1432                         if (huge_pmd_unshare(mm, &address, pvmw.pte)) {
1433                                 /*
1434                                  * huge_pmd_unshare unmapped an entire PMD
1435                                  * page.  There is no way of knowing exactly
1436                                  * which PMDs may be cached for this mm, so
1437                                  * we must flush them all.  start/end were
1438                                  * already adjusted above to cover this range.
1439                                  */
1440                                 flush_cache_range(vma, start, end);
1441                                 flush_tlb_range(vma, start, end);
1442                                 mmu_notifier_invalidate_range(mm, start, end);
1443
1444                                 /*
1445                                  * The ref count of the PMD page was dropped
1446                                  * which is part of the way map counting
1447                                  * is done for shared PMDs.  Return 'true'
1448                                  * here.  When there is no other sharing,
1449                                  * huge_pmd_unshare returns false and we will
1450                                  * unmap the actual page and drop map count
1451                                  * to zero.
1452                                  */
1453                                 page_vma_mapped_walk_done(&pvmw);
1454                                 break;
1455                         }
1456                 }
1457
1458                 if (IS_ENABLED(CONFIG_MIGRATION) &&
1459                     (flags & TTU_MIGRATION) &&
1460                     is_zone_device_page(page)) {
1461                         swp_entry_t entry;
1462                         pte_t swp_pte;
1463
1464                         pteval = ptep_get_and_clear(mm, pvmw.address, pvmw.pte);
1465
1466                         /*
1467                          * Store the pfn of the page in a special migration
1468                          * pte. do_swap_page() will wait until the migration
1469                          * pte is removed and then restart fault handling.
1470                          */
1471                         entry = make_migration_entry(page, 0);
1472                         swp_pte = swp_entry_to_pte(entry);
1473                         if (pte_soft_dirty(pteval))
1474                                 swp_pte = pte_swp_mksoft_dirty(swp_pte);
1475                         set_pte_at(mm, pvmw.address, pvmw.pte, swp_pte);
1476                         goto discard;
1477                 }
1478
1479                 if (!(flags & TTU_IGNORE_ACCESS)) {
1480                         if (ptep_clear_flush_young_notify(vma, address,
1481                                                 pvmw.pte)) {
1482                                 ret = false;
1483                                 page_vma_mapped_walk_done(&pvmw);
1484                                 break;
1485                         }
1486                 }
1487
1488                 /* Nuke the page table entry. */
1489                 flush_cache_page(vma, address, pte_pfn(*pvmw.pte));
1490                 if (should_defer_flush(mm, flags)) {
1491                         /*
1492                          * We clear the PTE but do not flush so potentially
1493                          * a remote CPU could still be writing to the page.
1494                          * If the entry was previously clean then the
1495                          * architecture must guarantee that a clear->dirty
1496                          * transition on a cached TLB entry is written through
1497                          * and traps if the PTE is unmapped.
1498                          */
1499                         pteval = ptep_get_and_clear(mm, address, pvmw.pte);
1500
1501                         set_tlb_ubc_flush_pending(mm, pte_dirty(pteval));
1502                 } else {
1503                         pteval = ptep_clear_flush(vma, address, pvmw.pte);
1504                 }
1505
1506                 /* Move the dirty bit to the page. Now the pte is gone. */
1507                 if (pte_dirty(pteval))
1508                         set_page_dirty(page);
1509
1510                 /* Update high watermark before we lower rss */
1511                 update_hiwater_rss(mm);
1512
1513                 if (PageHWPoison(page) && !(flags & TTU_IGNORE_HWPOISON)) {
1514                         pteval = swp_entry_to_pte(make_hwpoison_entry(subpage));
1515                         if (PageHuge(page)) {
1516                                 int nr = 1 << compound_order(page);
1517                                 hugetlb_count_sub(nr, mm);
1518                                 set_huge_swap_pte_at(mm, address,
1519                                                      pvmw.pte, pteval,
1520                                                      vma_mmu_pagesize(vma));
1521                         } else {
1522                                 dec_mm_counter(mm, mm_counter(page));
1523                                 set_pte_at(mm, address, pvmw.pte, pteval);
1524                         }
1525
1526                 } else if (pte_unused(pteval) && !userfaultfd_armed(vma)) {
1527                         /*
1528                          * The guest indicated that the page content is of no
1529                          * interest anymore. Simply discard the pte, vmscan
1530                          * will take care of the rest.
1531                          * A future reference will then fault in a new zero
1532                          * page. When userfaultfd is active, we must not drop
1533                          * this page though, as its main user (postcopy
1534                          * migration) will not expect userfaults on already
1535                          * copied pages.
1536                          */
1537                         dec_mm_counter(mm, mm_counter(page));
1538                 } else if (IS_ENABLED(CONFIG_MIGRATION) &&
1539                                 (flags & (TTU_MIGRATION|TTU_SPLIT_FREEZE))) {
1540                         swp_entry_t entry;
1541                         pte_t swp_pte;
1542                         /*
1543                          * Store the pfn of the page in a special migration
1544                          * pte. do_swap_page() will wait until the migration
1545                          * pte is removed and then restart fault handling.
1546                          */
1547                         entry = make_migration_entry(subpage,
1548                                         pte_write(pteval));
1549                         swp_pte = swp_entry_to_pte(entry);
1550                         if (pte_soft_dirty(pteval))
1551                                 swp_pte = pte_swp_mksoft_dirty(swp_pte);
1552                         set_pte_at(mm, address, pvmw.pte, swp_pte);
1553                 } else if (PageAnon(page)) {
1554                         swp_entry_t entry = { .val = page_private(subpage) };
1555                         pte_t swp_pte;
1556                         /*
1557                          * Store the swap location in the pte.
1558                          * See handle_pte_fault() ...
1559                          */
1560                         if (unlikely(PageSwapBacked(page) != PageSwapCache(page))) {
1561                                 WARN_ON_ONCE(1);
1562                                 ret = false;
1563                                 /* We have to invalidate as we cleared the pte */
1564                                 page_vma_mapped_walk_done(&pvmw);
1565                                 break;
1566                         }
1567
1568                         /* MADV_FREE page check */
1569                         if (!PageSwapBacked(page)) {
1570                                 int ref_count, map_count;
1571
1572                                 /*
1573                                  * Synchronize with gup_pte_range():
1574                                  * - clear PTE; barrier; read refcount
1575                                  * - inc refcount; barrier; read PTE
1576                                  */
1577                                 smp_mb();
1578
1579                                 ref_count = page_ref_count(page);
1580                                 map_count = page_mapcount(page);
1581
1582                                 /*
1583                                  * Order reads for page refcount and dirty flag
1584                                  * (see comments in __remove_mapping()).
1585                                  */
1586                                 smp_rmb();
1587
1588                                 /*
1589                                  * The only page refs must be one from isolation
1590                                  * plus the rmap(s) (dropped by discard:).
1591                                  */
1592                                 if (ref_count == 1 + map_count &&
1593                                     !PageDirty(page)) {
1594                                         dec_mm_counter(mm, MM_ANONPAGES);
1595                                         goto discard;
1596                                 }
1597
1598                                 /*
1599                                  * If the page was redirtied, it cannot be
1600                                  * discarded. Remap the page to page table.
1601                                  */
1602                                 set_pte_at(mm, address, pvmw.pte, pteval);
1603                                 SetPageSwapBacked(page);
1604                                 ret = false;
1605                                 page_vma_mapped_walk_done(&pvmw);
1606                                 break;
1607                         }
1608
1609                         if (swap_duplicate(entry) < 0) {
1610                                 set_pte_at(mm, address, pvmw.pte, pteval);
1611                                 ret = false;
1612                                 page_vma_mapped_walk_done(&pvmw);
1613                                 break;
1614                         }
1615                         if (list_empty(&mm->mmlist)) {
1616                                 spin_lock(&mmlist_lock);
1617                                 if (list_empty(&mm->mmlist))
1618                                         list_add(&mm->mmlist, &init_mm.mmlist);
1619                                 spin_unlock(&mmlist_lock);
1620                         }
1621                         dec_mm_counter(mm, MM_ANONPAGES);
1622                         inc_mm_counter(mm, MM_SWAPENTS);
1623                         swp_pte = swp_entry_to_pte(entry);
1624                         if (pte_soft_dirty(pteval))
1625                                 swp_pte = pte_swp_mksoft_dirty(swp_pte);
1626                         set_pte_at(mm, address, pvmw.pte, swp_pte);
1627                 } else
1628                         dec_mm_counter(mm, mm_counter_file(page));
1629 discard:
1630                 page_remove_rmap(subpage, PageHuge(page));
1631                 put_page(page);
1632                 mmu_notifier_invalidate_range(mm, address,
1633                                               address + PAGE_SIZE);
1634         }
1635
1636         mmu_notifier_invalidate_range_end(vma->vm_mm, start, end);
1637
1638         return ret;
1639 }
1640
1641 bool is_vma_temporary_stack(struct vm_area_struct *vma)
1642 {
1643         int maybe_stack = vma->vm_flags & (VM_GROWSDOWN | VM_GROWSUP);
1644
1645         if (!maybe_stack)
1646                 return false;
1647
1648         if ((vma->vm_flags & VM_STACK_INCOMPLETE_SETUP) ==
1649                                                 VM_STACK_INCOMPLETE_SETUP)
1650                 return true;
1651
1652         return false;
1653 }
1654
1655 static bool invalid_migration_vma(struct vm_area_struct *vma, void *arg)
1656 {
1657         return is_vma_temporary_stack(vma);
1658 }
1659
1660 static int page_not_mapped(struct page *page)
1661 {
1662         return !page_mapped(page);
1663 }
1664
1665 /**
1666  * try_to_unmap - try to remove all page table mappings to a page
1667  * @page: the page to get unmapped
1668  * @flags: action and flags
1669  *
1670  * Tries to remove all the page table entries which are mapping this
1671  * page, used in the pageout path.  Caller must hold the page lock.
1672  *
1673  * If unmap is successful, return true. Otherwise, false.
1674  */
1675 bool try_to_unmap(struct page *page, enum ttu_flags flags)
1676 {
1677         struct rmap_walk_control rwc = {
1678                 .rmap_one = try_to_unmap_one,
1679                 .arg = (void *)flags,
1680                 .done = page_not_mapped,
1681                 .anon_lock = page_lock_anon_vma_read,
1682         };
1683
1684         /*
1685          * During exec, a temporary VMA is setup and later moved.
1686          * The VMA is moved under the anon_vma lock but not the
1687          * page tables leading to a race where migration cannot
1688          * find the migration ptes. Rather than increasing the
1689          * locking requirements of exec(), migration skips
1690          * temporary VMAs until after exec() completes.
1691          */
1692         if ((flags & (TTU_MIGRATION|TTU_SPLIT_FREEZE))
1693             && !PageKsm(page) && PageAnon(page))
1694                 rwc.invalid_vma = invalid_migration_vma;
1695
1696         if (flags & TTU_RMAP_LOCKED)
1697                 rmap_walk_locked(page, &rwc);
1698         else
1699                 rmap_walk(page, &rwc);
1700
1701         /*
1702          * When racing against e.g. zap_pte_range() on another cpu,
1703          * in between its ptep_get_and_clear_full() and page_remove_rmap(),
1704          * try_to_unmap() may return false when it is about to become true,
1705          * if page table locking is skipped: use TTU_SYNC to wait for that.
1706          */
1707         return !page_mapcount(page);
1708 }
1709
1710 /**
1711  * try_to_munlock - try to munlock a page
1712  * @page: the page to be munlocked
1713  *
1714  * Called from munlock code.  Checks all of the VMAs mapping the page
1715  * to make sure nobody else has this page mlocked. The page will be
1716  * returned with PG_mlocked cleared if no other vmas have it mlocked.
1717  */
1718
1719 void try_to_munlock(struct page *page)
1720 {
1721         struct rmap_walk_control rwc = {
1722                 .rmap_one = try_to_unmap_one,
1723                 .arg = (void *)TTU_MUNLOCK,
1724                 .done = page_not_mapped,
1725                 .anon_lock = page_lock_anon_vma_read,
1726
1727         };
1728
1729         VM_BUG_ON_PAGE(!PageLocked(page) || PageLRU(page), page);
1730         VM_BUG_ON_PAGE(PageCompound(page) && PageDoubleMap(page), page);
1731
1732         rmap_walk(page, &rwc);
1733 }
1734
1735 void __put_anon_vma(struct anon_vma *anon_vma)
1736 {
1737         struct anon_vma *root = anon_vma->root;
1738
1739         anon_vma_free(anon_vma);
1740         if (root != anon_vma && atomic_dec_and_test(&root->refcount))
1741                 anon_vma_free(root);
1742 }
1743
1744 static struct anon_vma *rmap_walk_anon_lock(struct page *page,
1745                                         struct rmap_walk_control *rwc)
1746 {
1747         struct anon_vma *anon_vma;
1748
1749         if (rwc->anon_lock)
1750                 return rwc->anon_lock(page);
1751
1752         /*
1753          * Note: remove_migration_ptes() cannot use page_lock_anon_vma_read()
1754          * because that depends on page_mapped(); but not all its usages
1755          * are holding mmap_sem. Users without mmap_sem are required to
1756          * take a reference count to prevent the anon_vma disappearing
1757          */
1758         anon_vma = page_anon_vma(page);
1759         if (!anon_vma)
1760                 return NULL;
1761
1762         anon_vma_lock_read(anon_vma);
1763         return anon_vma;
1764 }
1765
1766 /*
1767  * rmap_walk_anon - do something to anonymous page using the object-based
1768  * rmap method
1769  * @page: the page to be handled
1770  * @rwc: control variable according to each walk type
1771  *
1772  * Find all the mappings of a page using the mapping pointer and the vma chains
1773  * contained in the anon_vma struct it points to.
1774  *
1775  * When called from try_to_munlock(), the mmap_sem of the mm containing the vma
1776  * where the page was found will be held for write.  So, we won't recheck
1777  * vm_flags for that VMA.  That should be OK, because that vma shouldn't be
1778  * LOCKED.
1779  */
1780 static void rmap_walk_anon(struct page *page, struct rmap_walk_control *rwc,
1781                 bool locked)
1782 {
1783         struct anon_vma *anon_vma;
1784         pgoff_t pgoff_start, pgoff_end;
1785         struct anon_vma_chain *avc;
1786
1787         if (locked) {
1788                 anon_vma = page_anon_vma(page);
1789                 /* anon_vma disappear under us? */
1790                 VM_BUG_ON_PAGE(!anon_vma, page);
1791         } else {
1792                 anon_vma = rmap_walk_anon_lock(page, rwc);
1793         }
1794         if (!anon_vma)
1795                 return;
1796
1797         pgoff_start = page_to_pgoff(page);
1798         pgoff_end = pgoff_start + hpage_nr_pages(page) - 1;
1799         anon_vma_interval_tree_foreach(avc, &anon_vma->rb_root,
1800                         pgoff_start, pgoff_end) {
1801                 struct vm_area_struct *vma = avc->vma;
1802                 unsigned long address = vma_address(page, vma);
1803
1804                 VM_BUG_ON_VMA(address == -EFAULT, vma);
1805                 cond_resched();
1806
1807                 if (rwc->invalid_vma && rwc->invalid_vma(vma, rwc->arg))
1808                         continue;
1809
1810                 if (!rwc->rmap_one(page, vma, address, rwc->arg))
1811                         break;
1812                 if (rwc->done && rwc->done(page))
1813                         break;
1814         }
1815
1816         if (!locked)
1817                 anon_vma_unlock_read(anon_vma);
1818 }
1819
1820 /*
1821  * rmap_walk_file - do something to file page using the object-based rmap method
1822  * @page: the page to be handled
1823  * @rwc: control variable according to each walk type
1824  *
1825  * Find all the mappings of a page using the mapping pointer and the vma chains
1826  * contained in the address_space struct it points to.
1827  *
1828  * When called from try_to_munlock(), the mmap_sem of the mm containing the vma
1829  * where the page was found will be held for write.  So, we won't recheck
1830  * vm_flags for that VMA.  That should be OK, because that vma shouldn't be
1831  * LOCKED.
1832  */
1833 static void rmap_walk_file(struct page *page, struct rmap_walk_control *rwc,
1834                 bool locked)
1835 {
1836         struct address_space *mapping = page_mapping(page);
1837         pgoff_t pgoff_start, pgoff_end;
1838         struct vm_area_struct *vma;
1839
1840         /*
1841          * The page lock not only makes sure that page->mapping cannot
1842          * suddenly be NULLified by truncation, it makes sure that the
1843          * structure at mapping cannot be freed and reused yet,
1844          * so we can safely take mapping->i_mmap_rwsem.
1845          */
1846         VM_BUG_ON_PAGE(!PageLocked(page), page);
1847
1848         if (!mapping)
1849                 return;
1850
1851         pgoff_start = page_to_pgoff(page);
1852         pgoff_end = pgoff_start + hpage_nr_pages(page) - 1;
1853         if (!locked)
1854                 i_mmap_lock_read(mapping);
1855         vma_interval_tree_foreach(vma, &mapping->i_mmap,
1856                         pgoff_start, pgoff_end) {
1857                 unsigned long address = vma_address(page, vma);
1858
1859                 VM_BUG_ON_VMA(address == -EFAULT, vma);
1860                 cond_resched();
1861
1862                 if (rwc->invalid_vma && rwc->invalid_vma(vma, rwc->arg))
1863                         continue;
1864
1865                 if (!rwc->rmap_one(page, vma, address, rwc->arg))
1866                         goto done;
1867                 if (rwc->done && rwc->done(page))
1868                         goto done;
1869         }
1870
1871 done:
1872         if (!locked)
1873                 i_mmap_unlock_read(mapping);
1874 }
1875
1876 void rmap_walk(struct page *page, struct rmap_walk_control *rwc)
1877 {
1878         if (unlikely(PageKsm(page)))
1879                 rmap_walk_ksm(page, rwc);
1880         else if (PageAnon(page))
1881                 rmap_walk_anon(page, rwc, false);
1882         else
1883                 rmap_walk_file(page, rwc, false);
1884 }
1885
1886 /* Like rmap_walk, but caller holds relevant rmap lock */
1887 void rmap_walk_locked(struct page *page, struct rmap_walk_control *rwc)
1888 {
1889         /* no ksm support for now */
1890         VM_BUG_ON_PAGE(PageKsm(page), page);
1891         if (PageAnon(page))
1892                 rmap_walk_anon(page, rwc, true);
1893         else
1894                 rmap_walk_file(page, rwc, true);
1895 }
1896
1897 #ifdef CONFIG_HUGETLB_PAGE
1898 /*
1899  * The following three functions are for anonymous (private mapped) hugepages.
1900  * Unlike common anonymous pages, anonymous hugepages have no accounting code
1901  * and no lru code, because we handle hugepages differently from common pages.
1902  */
1903 static void __hugepage_set_anon_rmap(struct page *page,
1904         struct vm_area_struct *vma, unsigned long address, int exclusive)
1905 {
1906         struct anon_vma *anon_vma = vma->anon_vma;
1907
1908         BUG_ON(!anon_vma);
1909
1910         if (PageAnon(page))
1911                 return;
1912         if (!exclusive)
1913                 anon_vma = anon_vma->root;
1914
1915         anon_vma = (void *) anon_vma + PAGE_MAPPING_ANON;
1916         page->mapping = (struct address_space *) anon_vma;
1917         page->index = linear_page_index(vma, address);
1918 }
1919
1920 void hugepage_add_anon_rmap(struct page *page,
1921                             struct vm_area_struct *vma, unsigned long address)
1922 {
1923         struct anon_vma *anon_vma = vma->anon_vma;
1924         int first;
1925
1926         BUG_ON(!PageLocked(page));
1927         BUG_ON(!anon_vma);
1928         /* address might be in next vma when migration races vma_adjust */
1929         first = atomic_inc_and_test(compound_mapcount_ptr(page));
1930         if (first)
1931                 __hugepage_set_anon_rmap(page, vma, address, 0);
1932 }
1933
1934 void hugepage_add_new_anon_rmap(struct page *page,
1935                         struct vm_area_struct *vma, unsigned long address)
1936 {
1937         BUG_ON(address < vma->vm_start || address >= vma->vm_end);
1938         atomic_set(compound_mapcount_ptr(page), 0);
1939         __hugepage_set_anon_rmap(page, vma, address, 1);
1940 }
1941 #endif /* CONFIG_HUGETLB_PAGE */