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