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