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