2 * mm/rmap.c - physical to virtual reverse mappings
5 * Released under the General Public License (GPL).
7 * Simple, low overhead reverse mapping scheme.
8 * Please try to keep this thing as modular as possible.
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.
17 * Contributions by Hugh Dickins 2003, 2004
21 * Lock ordering in mm:
23 * inode->i_rwsem (while writing or truncating, not reading or faulting)
25 * mapping->invalidate_lock (in filemap_fault)
26 * page->flags PG_locked (lock_page) * (see hugetlbfs below)
27 * hugetlbfs_i_mmap_rwsem_key (in huge_pmd_share)
28 * mapping->i_mmap_rwsem
29 * hugetlb_fault_mutex (hugetlbfs specific page fault mutex)
31 * mm->page_table_lock or pte_lock
32 * swap_lock (in swap_duplicate, swap_info_get)
33 * mmlist_lock (in mmput, drain_mmlist and others)
34 * mapping->private_lock (in __set_page_dirty_buffers)
35 * lock_page_memcg move_lock (in __set_page_dirty_buffers)
36 * i_pages lock (widely used)
37 * lruvec->lru_lock (in folio_lruvec_lock_irq)
38 * inode->i_lock (in set_page_dirty's __mark_inode_dirty)
39 * bdi.wb->list_lock (in set_page_dirty's __mark_inode_dirty)
40 * sb_lock (within inode_lock in fs/fs-writeback.c)
41 * i_pages lock (widely used, in set_page_dirty,
42 * in arch-dependent flush_dcache_mmap_lock,
43 * within bdi.wb->list_lock in __sync_single_inode)
45 * anon_vma->rwsem,mapping->i_mmap_rwsem (memory_failure, collect_procs_anon)
49 * * hugetlbfs PageHuge() pages take locks in this order:
50 * mapping->i_mmap_rwsem
51 * hugetlb_fault_mutex (hugetlbfs specific page fault mutex)
52 * page->flags PG_locked (lock_page)
56 #include <linux/sched/mm.h>
57 #include <linux/sched/task.h>
58 #include <linux/pagemap.h>
59 #include <linux/swap.h>
60 #include <linux/swapops.h>
61 #include <linux/slab.h>
62 #include <linux/init.h>
63 #include <linux/ksm.h>
64 #include <linux/rmap.h>
65 #include <linux/rcupdate.h>
66 #include <linux/export.h>
67 #include <linux/memcontrol.h>
68 #include <linux/mmu_notifier.h>
69 #include <linux/migrate.h>
70 #include <linux/hugetlb.h>
71 #include <linux/huge_mm.h>
72 #include <linux/backing-dev.h>
73 #include <linux/page_idle.h>
74 #include <linux/memremap.h>
75 #include <linux/userfaultfd_k.h>
77 #include <asm/tlbflush.h>
79 #include <trace/events/tlb.h>
83 static struct kmem_cache *anon_vma_cachep;
84 static struct kmem_cache *anon_vma_chain_cachep;
86 static inline struct anon_vma *anon_vma_alloc(void)
88 struct anon_vma *anon_vma;
90 anon_vma = kmem_cache_alloc(anon_vma_cachep, GFP_KERNEL);
92 atomic_set(&anon_vma->refcount, 1);
93 anon_vma->degree = 1; /* Reference for first vma */
94 anon_vma->parent = anon_vma;
96 * Initialise the anon_vma root to point to itself. If called
97 * from fork, the root will be reset to the parents anon_vma.
99 anon_vma->root = anon_vma;
105 static inline void anon_vma_free(struct anon_vma *anon_vma)
107 VM_BUG_ON(atomic_read(&anon_vma->refcount));
110 * Synchronize against page_lock_anon_vma_read() such that
111 * we can safely hold the lock without the anon_vma getting
114 * Relies on the full mb implied by the atomic_dec_and_test() from
115 * put_anon_vma() against the acquire barrier implied by
116 * down_read_trylock() from page_lock_anon_vma_read(). This orders:
118 * page_lock_anon_vma_read() VS put_anon_vma()
119 * down_read_trylock() atomic_dec_and_test()
121 * atomic_read() rwsem_is_locked()
123 * LOCK should suffice since the actual taking of the lock must
124 * happen _before_ what follows.
127 if (rwsem_is_locked(&anon_vma->root->rwsem)) {
128 anon_vma_lock_write(anon_vma);
129 anon_vma_unlock_write(anon_vma);
132 kmem_cache_free(anon_vma_cachep, anon_vma);
135 static inline struct anon_vma_chain *anon_vma_chain_alloc(gfp_t gfp)
137 return kmem_cache_alloc(anon_vma_chain_cachep, gfp);
140 static void anon_vma_chain_free(struct anon_vma_chain *anon_vma_chain)
142 kmem_cache_free(anon_vma_chain_cachep, anon_vma_chain);
145 static void anon_vma_chain_link(struct vm_area_struct *vma,
146 struct anon_vma_chain *avc,
147 struct anon_vma *anon_vma)
150 avc->anon_vma = anon_vma;
151 list_add(&avc->same_vma, &vma->anon_vma_chain);
152 anon_vma_interval_tree_insert(avc, &anon_vma->rb_root);
156 * __anon_vma_prepare - attach an anon_vma to a memory region
157 * @vma: the memory region in question
159 * This makes sure the memory mapping described by 'vma' has
160 * an 'anon_vma' attached to it, so that we can associate the
161 * anonymous pages mapped into it with that anon_vma.
163 * The common case will be that we already have one, which
164 * is handled inline by anon_vma_prepare(). But if
165 * not we either need to find an adjacent mapping that we
166 * can re-use the anon_vma from (very common when the only
167 * reason for splitting a vma has been mprotect()), or we
168 * allocate a new one.
170 * Anon-vma allocations are very subtle, because we may have
171 * optimistically looked up an anon_vma in page_lock_anon_vma_read()
172 * and that may actually touch the rwsem even in the newly
173 * allocated vma (it depends on RCU to make sure that the
174 * anon_vma isn't actually destroyed).
176 * As a result, we need to do proper anon_vma locking even
177 * for the new allocation. At the same time, we do not want
178 * to do any locking for the common case of already having
181 * This must be called with the mmap_lock held for reading.
183 int __anon_vma_prepare(struct vm_area_struct *vma)
185 struct mm_struct *mm = vma->vm_mm;
186 struct anon_vma *anon_vma, *allocated;
187 struct anon_vma_chain *avc;
191 avc = anon_vma_chain_alloc(GFP_KERNEL);
195 anon_vma = find_mergeable_anon_vma(vma);
198 anon_vma = anon_vma_alloc();
199 if (unlikely(!anon_vma))
200 goto out_enomem_free_avc;
201 allocated = anon_vma;
204 anon_vma_lock_write(anon_vma);
205 /* page_table_lock to protect against threads */
206 spin_lock(&mm->page_table_lock);
207 if (likely(!vma->anon_vma)) {
208 vma->anon_vma = anon_vma;
209 anon_vma_chain_link(vma, avc, anon_vma);
210 /* vma reference or self-parent link for new root */
215 spin_unlock(&mm->page_table_lock);
216 anon_vma_unlock_write(anon_vma);
218 if (unlikely(allocated))
219 put_anon_vma(allocated);
221 anon_vma_chain_free(avc);
226 anon_vma_chain_free(avc);
232 * This is a useful helper function for locking the anon_vma root as
233 * we traverse the vma->anon_vma_chain, looping over anon_vma's that
236 * Such anon_vma's should have the same root, so you'd expect to see
237 * just a single mutex_lock for the whole traversal.
239 static inline struct anon_vma *lock_anon_vma_root(struct anon_vma *root, struct anon_vma *anon_vma)
241 struct anon_vma *new_root = anon_vma->root;
242 if (new_root != root) {
243 if (WARN_ON_ONCE(root))
244 up_write(&root->rwsem);
246 down_write(&root->rwsem);
251 static inline void unlock_anon_vma_root(struct anon_vma *root)
254 up_write(&root->rwsem);
258 * Attach the anon_vmas from src to dst.
259 * Returns 0 on success, -ENOMEM on failure.
261 * anon_vma_clone() is called by __vma_adjust(), __split_vma(), copy_vma() and
262 * anon_vma_fork(). The first three want an exact copy of src, while the last
263 * one, anon_vma_fork(), may try to reuse an existing anon_vma to prevent
264 * endless growth of anon_vma. Since dst->anon_vma is set to NULL before call,
265 * we can identify this case by checking (!dst->anon_vma && src->anon_vma).
267 * If (!dst->anon_vma && src->anon_vma) is true, this function tries to find
268 * and reuse existing anon_vma which has no vmas and only one child anon_vma.
269 * This prevents degradation of anon_vma hierarchy to endless linear chain in
270 * case of constantly forking task. On the other hand, an anon_vma with more
271 * than one child isn't reused even if there was no alive vma, thus rmap
272 * walker has a good chance of avoiding scanning the whole hierarchy when it
273 * searches where page is mapped.
275 int anon_vma_clone(struct vm_area_struct *dst, struct vm_area_struct *src)
277 struct anon_vma_chain *avc, *pavc;
278 struct anon_vma *root = NULL;
280 list_for_each_entry_reverse(pavc, &src->anon_vma_chain, same_vma) {
281 struct anon_vma *anon_vma;
283 avc = anon_vma_chain_alloc(GFP_NOWAIT | __GFP_NOWARN);
284 if (unlikely(!avc)) {
285 unlock_anon_vma_root(root);
287 avc = anon_vma_chain_alloc(GFP_KERNEL);
291 anon_vma = pavc->anon_vma;
292 root = lock_anon_vma_root(root, anon_vma);
293 anon_vma_chain_link(dst, avc, anon_vma);
296 * Reuse existing anon_vma if its degree lower than two,
297 * that means it has no vma and only one anon_vma child.
299 * Do not chose parent anon_vma, otherwise first child
300 * will always reuse it. Root anon_vma is never reused:
301 * it has self-parent reference and at least one child.
303 if (!dst->anon_vma && src->anon_vma &&
304 anon_vma != src->anon_vma && anon_vma->degree < 2)
305 dst->anon_vma = anon_vma;
308 dst->anon_vma->degree++;
309 unlock_anon_vma_root(root);
314 * dst->anon_vma is dropped here otherwise its degree can be incorrectly
315 * decremented in unlink_anon_vmas().
316 * We can safely do this because callers of anon_vma_clone() don't care
317 * about dst->anon_vma if anon_vma_clone() failed.
319 dst->anon_vma = NULL;
320 unlink_anon_vmas(dst);
325 * Attach vma to its own anon_vma, as well as to the anon_vmas that
326 * the corresponding VMA in the parent process is attached to.
327 * Returns 0 on success, non-zero on failure.
329 int anon_vma_fork(struct vm_area_struct *vma, struct vm_area_struct *pvma)
331 struct anon_vma_chain *avc;
332 struct anon_vma *anon_vma;
335 /* Don't bother if the parent process has no anon_vma here. */
339 /* Drop inherited anon_vma, we'll reuse existing or allocate new. */
340 vma->anon_vma = NULL;
343 * First, attach the new VMA to the parent VMA's anon_vmas,
344 * so rmap can find non-COWed pages in child processes.
346 error = anon_vma_clone(vma, pvma);
350 /* An existing anon_vma has been reused, all done then. */
354 /* Then add our own anon_vma. */
355 anon_vma = anon_vma_alloc();
358 avc = anon_vma_chain_alloc(GFP_KERNEL);
360 goto out_error_free_anon_vma;
363 * The root anon_vma's rwsem is the lock actually used when we
364 * lock any of the anon_vmas in this anon_vma tree.
366 anon_vma->root = pvma->anon_vma->root;
367 anon_vma->parent = pvma->anon_vma;
369 * With refcounts, an anon_vma can stay around longer than the
370 * process it belongs to. The root anon_vma needs to be pinned until
371 * this anon_vma is freed, because the lock lives in the root.
373 get_anon_vma(anon_vma->root);
374 /* Mark this anon_vma as the one where our new (COWed) pages go. */
375 vma->anon_vma = anon_vma;
376 anon_vma_lock_write(anon_vma);
377 anon_vma_chain_link(vma, avc, anon_vma);
378 anon_vma->parent->degree++;
379 anon_vma_unlock_write(anon_vma);
383 out_error_free_anon_vma:
384 put_anon_vma(anon_vma);
386 unlink_anon_vmas(vma);
390 void unlink_anon_vmas(struct vm_area_struct *vma)
392 struct anon_vma_chain *avc, *next;
393 struct anon_vma *root = NULL;
396 * Unlink each anon_vma chained to the VMA. This list is ordered
397 * from newest to oldest, ensuring the root anon_vma gets freed last.
399 list_for_each_entry_safe(avc, next, &vma->anon_vma_chain, same_vma) {
400 struct anon_vma *anon_vma = avc->anon_vma;
402 root = lock_anon_vma_root(root, anon_vma);
403 anon_vma_interval_tree_remove(avc, &anon_vma->rb_root);
406 * Leave empty anon_vmas on the list - we'll need
407 * to free them outside the lock.
409 if (RB_EMPTY_ROOT(&anon_vma->rb_root.rb_root)) {
410 anon_vma->parent->degree--;
414 list_del(&avc->same_vma);
415 anon_vma_chain_free(avc);
418 vma->anon_vma->degree--;
421 * vma would still be needed after unlink, and anon_vma will be prepared
424 vma->anon_vma = NULL;
426 unlock_anon_vma_root(root);
429 * Iterate the list once more, it now only contains empty and unlinked
430 * anon_vmas, destroy them. Could not do before due to __put_anon_vma()
431 * needing to write-acquire the anon_vma->root->rwsem.
433 list_for_each_entry_safe(avc, next, &vma->anon_vma_chain, same_vma) {
434 struct anon_vma *anon_vma = avc->anon_vma;
436 VM_WARN_ON(anon_vma->degree);
437 put_anon_vma(anon_vma);
439 list_del(&avc->same_vma);
440 anon_vma_chain_free(avc);
444 static void anon_vma_ctor(void *data)
446 struct anon_vma *anon_vma = data;
448 init_rwsem(&anon_vma->rwsem);
449 atomic_set(&anon_vma->refcount, 0);
450 anon_vma->rb_root = RB_ROOT_CACHED;
453 void __init anon_vma_init(void)
455 anon_vma_cachep = kmem_cache_create("anon_vma", sizeof(struct anon_vma),
456 0, SLAB_TYPESAFE_BY_RCU|SLAB_PANIC|SLAB_ACCOUNT,
458 anon_vma_chain_cachep = KMEM_CACHE(anon_vma_chain,
459 SLAB_PANIC|SLAB_ACCOUNT);
463 * Getting a lock on a stable anon_vma from a page off the LRU is tricky!
465 * Since there is no serialization what so ever against page_remove_rmap()
466 * the best this function can do is return a refcount increased anon_vma
467 * that might have been relevant to this page.
469 * The page might have been remapped to a different anon_vma or the anon_vma
470 * returned may already be freed (and even reused).
472 * In case it was remapped to a different anon_vma, the new anon_vma will be a
473 * child of the old anon_vma, and the anon_vma lifetime rules will therefore
474 * ensure that any anon_vma obtained from the page will still be valid for as
475 * long as we observe page_mapped() [ hence all those page_mapped() tests ].
477 * All users of this function must be very careful when walking the anon_vma
478 * chain and verify that the page in question is indeed mapped in it
479 * [ something equivalent to page_mapped_in_vma() ].
481 * Since anon_vma's slab is SLAB_TYPESAFE_BY_RCU and we know from
482 * page_remove_rmap() that the anon_vma pointer from page->mapping is valid
483 * if there is a mapcount, we can dereference the anon_vma after observing
486 struct anon_vma *page_get_anon_vma(struct page *page)
488 struct anon_vma *anon_vma = NULL;
489 unsigned long anon_mapping;
492 anon_mapping = (unsigned long)READ_ONCE(page->mapping);
493 if ((anon_mapping & PAGE_MAPPING_FLAGS) != PAGE_MAPPING_ANON)
495 if (!page_mapped(page))
498 anon_vma = (struct anon_vma *) (anon_mapping - PAGE_MAPPING_ANON);
499 if (!atomic_inc_not_zero(&anon_vma->refcount)) {
505 * If this page is still mapped, then its anon_vma cannot have been
506 * freed. But if it has been unmapped, we have no security against the
507 * anon_vma structure being freed and reused (for another anon_vma:
508 * SLAB_TYPESAFE_BY_RCU guarantees that - so the atomic_inc_not_zero()
509 * above cannot corrupt).
511 if (!page_mapped(page)) {
513 put_anon_vma(anon_vma);
523 * Similar to page_get_anon_vma() except it locks the anon_vma.
525 * Its a little more complex as it tries to keep the fast path to a single
526 * atomic op -- the trylock. If we fail the trylock, we fall back to getting a
527 * reference like with page_get_anon_vma() and then block on the mutex.
529 struct anon_vma *page_lock_anon_vma_read(struct page *page)
531 struct anon_vma *anon_vma = NULL;
532 struct anon_vma *root_anon_vma;
533 unsigned long anon_mapping;
536 anon_mapping = (unsigned long)READ_ONCE(page->mapping);
537 if ((anon_mapping & PAGE_MAPPING_FLAGS) != PAGE_MAPPING_ANON)
539 if (!page_mapped(page))
542 anon_vma = (struct anon_vma *) (anon_mapping - PAGE_MAPPING_ANON);
543 root_anon_vma = READ_ONCE(anon_vma->root);
544 if (down_read_trylock(&root_anon_vma->rwsem)) {
546 * If the page is still mapped, then this anon_vma is still
547 * its anon_vma, and holding the mutex ensures that it will
548 * not go away, see anon_vma_free().
550 if (!page_mapped(page)) {
551 up_read(&root_anon_vma->rwsem);
557 /* trylock failed, we got to sleep */
558 if (!atomic_inc_not_zero(&anon_vma->refcount)) {
563 if (!page_mapped(page)) {
565 put_anon_vma(anon_vma);
569 /* we pinned the anon_vma, its safe to sleep */
571 anon_vma_lock_read(anon_vma);
573 if (atomic_dec_and_test(&anon_vma->refcount)) {
575 * Oops, we held the last refcount, release the lock
576 * and bail -- can't simply use put_anon_vma() because
577 * we'll deadlock on the anon_vma_lock_write() recursion.
579 anon_vma_unlock_read(anon_vma);
580 __put_anon_vma(anon_vma);
591 void page_unlock_anon_vma_read(struct anon_vma *anon_vma)
593 anon_vma_unlock_read(anon_vma);
596 #ifdef CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH
598 * Flush TLB entries for recently unmapped pages from remote CPUs. It is
599 * important if a PTE was dirty when it was unmapped that it's flushed
600 * before any IO is initiated on the page to prevent lost writes. Similarly,
601 * it must be flushed before freeing to prevent data leakage.
603 void try_to_unmap_flush(void)
605 struct tlbflush_unmap_batch *tlb_ubc = ¤t->tlb_ubc;
607 if (!tlb_ubc->flush_required)
610 arch_tlbbatch_flush(&tlb_ubc->arch);
611 tlb_ubc->flush_required = false;
612 tlb_ubc->writable = false;
615 /* Flush iff there are potentially writable TLB entries that can race with IO */
616 void try_to_unmap_flush_dirty(void)
618 struct tlbflush_unmap_batch *tlb_ubc = ¤t->tlb_ubc;
620 if (tlb_ubc->writable)
621 try_to_unmap_flush();
625 * Bits 0-14 of mm->tlb_flush_batched record pending generations.
626 * Bits 16-30 of mm->tlb_flush_batched bit record flushed generations.
628 #define TLB_FLUSH_BATCH_FLUSHED_SHIFT 16
629 #define TLB_FLUSH_BATCH_PENDING_MASK \
630 ((1 << (TLB_FLUSH_BATCH_FLUSHED_SHIFT - 1)) - 1)
631 #define TLB_FLUSH_BATCH_PENDING_LARGE \
632 (TLB_FLUSH_BATCH_PENDING_MASK / 2)
634 static void set_tlb_ubc_flush_pending(struct mm_struct *mm, bool writable)
636 struct tlbflush_unmap_batch *tlb_ubc = ¤t->tlb_ubc;
639 arch_tlbbatch_add_mm(&tlb_ubc->arch, mm);
640 tlb_ubc->flush_required = true;
643 * Ensure compiler does not re-order the setting of tlb_flush_batched
644 * before the PTE is cleared.
647 batch = atomic_read(&mm->tlb_flush_batched);
649 if ((batch & TLB_FLUSH_BATCH_PENDING_MASK) > TLB_FLUSH_BATCH_PENDING_LARGE) {
651 * Prevent `pending' from catching up with `flushed' because of
652 * overflow. Reset `pending' and `flushed' to be 1 and 0 if
653 * `pending' becomes large.
655 nbatch = atomic_cmpxchg(&mm->tlb_flush_batched, batch, 1);
656 if (nbatch != batch) {
661 atomic_inc(&mm->tlb_flush_batched);
665 * If the PTE was dirty then it's best to assume it's writable. The
666 * caller must use try_to_unmap_flush_dirty() or try_to_unmap_flush()
667 * before the page is queued for IO.
670 tlb_ubc->writable = true;
674 * Returns true if the TLB flush should be deferred to the end of a batch of
675 * unmap operations to reduce IPIs.
677 static bool should_defer_flush(struct mm_struct *mm, enum ttu_flags flags)
679 bool should_defer = false;
681 if (!(flags & TTU_BATCH_FLUSH))
684 /* If remote CPUs need to be flushed then defer batch the flush */
685 if (cpumask_any_but(mm_cpumask(mm), get_cpu()) < nr_cpu_ids)
693 * Reclaim unmaps pages under the PTL but do not flush the TLB prior to
694 * releasing the PTL if TLB flushes are batched. It's possible for a parallel
695 * operation such as mprotect or munmap to race between reclaim unmapping
696 * the page and flushing the page. If this race occurs, it potentially allows
697 * access to data via a stale TLB entry. Tracking all mm's that have TLB
698 * batching in flight would be expensive during reclaim so instead track
699 * whether TLB batching occurred in the past and if so then do a flush here
700 * if required. This will cost one additional flush per reclaim cycle paid
701 * by the first operation at risk such as mprotect and mumap.
703 * This must be called under the PTL so that an access to tlb_flush_batched
704 * that is potentially a "reclaim vs mprotect/munmap/etc" race will synchronise
707 void flush_tlb_batched_pending(struct mm_struct *mm)
709 int batch = atomic_read(&mm->tlb_flush_batched);
710 int pending = batch & TLB_FLUSH_BATCH_PENDING_MASK;
711 int flushed = batch >> TLB_FLUSH_BATCH_FLUSHED_SHIFT;
713 if (pending != flushed) {
716 * If the new TLB flushing is pending during flushing, leave
717 * mm->tlb_flush_batched as is, to avoid losing flushing.
719 atomic_cmpxchg(&mm->tlb_flush_batched, batch,
720 pending | (pending << TLB_FLUSH_BATCH_FLUSHED_SHIFT));
724 static void set_tlb_ubc_flush_pending(struct mm_struct *mm, bool writable)
728 static bool should_defer_flush(struct mm_struct *mm, enum ttu_flags flags)
732 #endif /* CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH */
735 * At what user virtual address is page expected in vma?
736 * Caller should check the page is actually part of the vma.
738 unsigned long page_address_in_vma(struct page *page, struct vm_area_struct *vma)
740 if (PageAnon(page)) {
741 struct anon_vma *page__anon_vma = page_anon_vma(page);
743 * Note: swapoff's unuse_vma() is more efficient with this
744 * check, and needs it to match anon_vma when KSM is active.
746 if (!vma->anon_vma || !page__anon_vma ||
747 vma->anon_vma->root != page__anon_vma->root)
749 } else if (!vma->vm_file) {
751 } else if (vma->vm_file->f_mapping != compound_head(page)->mapping) {
755 return vma_address(page, vma);
758 pmd_t *mm_find_pmd(struct mm_struct *mm, unsigned long address)
766 pgd = pgd_offset(mm, address);
767 if (!pgd_present(*pgd))
770 p4d = p4d_offset(pgd, address);
771 if (!p4d_present(*p4d))
774 pud = pud_offset(p4d, address);
775 if (!pud_present(*pud))
778 pmd = pmd_offset(pud, address);
780 * Some THP functions use the sequence pmdp_huge_clear_flush(), set_pmd_at()
781 * without holding anon_vma lock for write. So when looking for a
782 * genuine pmde (in which to find pte), test present and !THP together.
786 if (!pmd_present(pmde) || pmd_trans_huge(pmde))
792 struct page_referenced_arg {
795 unsigned long vm_flags;
796 struct mem_cgroup *memcg;
799 * arg: page_referenced_arg will be passed
801 static bool page_referenced_one(struct page *page, struct vm_area_struct *vma,
802 unsigned long address, void *arg)
804 struct page_referenced_arg *pra = arg;
805 DEFINE_PAGE_VMA_WALK(pvmw, page, vma, address, 0);
808 while (page_vma_mapped_walk(&pvmw)) {
809 address = pvmw.address;
811 if ((vma->vm_flags & VM_LOCKED) &&
812 (!PageTransCompound(page) || !pvmw.pte)) {
813 /* Restore the mlock which got missed */
814 mlock_vma_page(page, vma, !pvmw.pte);
815 page_vma_mapped_walk_done(&pvmw);
816 pra->vm_flags |= VM_LOCKED;
817 return false; /* To break the loop */
821 if (ptep_clear_flush_young_notify(vma, address,
824 * Don't treat a reference through
825 * a sequentially read mapping as such.
826 * If the page has been used in another mapping,
827 * we will catch it; if this other mapping is
828 * already gone, the unmap path will have set
829 * PG_referenced or activated the page.
831 if (likely(!(vma->vm_flags & VM_SEQ_READ)))
834 } else if (IS_ENABLED(CONFIG_TRANSPARENT_HUGEPAGE)) {
835 if (pmdp_clear_flush_young_notify(vma, address,
839 /* unexpected pmd-mapped page? */
847 clear_page_idle(page);
848 if (test_and_clear_page_young(page))
853 pra->vm_flags |= vma->vm_flags & ~VM_LOCKED;
857 return false; /* To break the loop */
862 static bool invalid_page_referenced_vma(struct vm_area_struct *vma, void *arg)
864 struct page_referenced_arg *pra = arg;
865 struct mem_cgroup *memcg = pra->memcg;
867 if (!mm_match_cgroup(vma->vm_mm, memcg))
874 * page_referenced - test if the page was referenced
875 * @page: the page to test
876 * @is_locked: caller holds lock on the page
877 * @memcg: target memory cgroup
878 * @vm_flags: collect encountered vma->vm_flags who actually referenced the page
880 * Quick test_and_clear_referenced for all mappings to a page,
881 * returns the number of ptes which referenced the page.
883 int page_referenced(struct page *page,
885 struct mem_cgroup *memcg,
886 unsigned long *vm_flags)
889 struct page_referenced_arg pra = {
890 .mapcount = total_mapcount(page),
893 struct rmap_walk_control rwc = {
894 .rmap_one = page_referenced_one,
896 .anon_lock = page_lock_anon_vma_read,
903 if (!page_rmapping(page))
906 if (!is_locked && (!PageAnon(page) || PageKsm(page))) {
907 we_locked = trylock_page(page);
913 * If we are reclaiming on behalf of a cgroup, skip
914 * counting on behalf of references from different
918 rwc.invalid_vma = invalid_page_referenced_vma;
921 rmap_walk(page, &rwc);
922 *vm_flags = pra.vm_flags;
927 return pra.referenced;
930 static bool page_mkclean_one(struct page *page, struct vm_area_struct *vma,
931 unsigned long address, void *arg)
933 DEFINE_PAGE_VMA_WALK(pvmw, page, vma, address, PVMW_SYNC);
934 struct mmu_notifier_range range;
938 * We have to assume the worse case ie pmd for invalidation. Note that
939 * the page can not be free from this function.
941 mmu_notifier_range_init(&range, MMU_NOTIFY_PROTECTION_PAGE,
942 0, vma, vma->vm_mm, address,
943 vma_address_end(&pvmw));
944 mmu_notifier_invalidate_range_start(&range);
946 while (page_vma_mapped_walk(&pvmw)) {
949 address = pvmw.address;
952 pte_t *pte = pvmw.pte;
954 if (!pte_dirty(*pte) && !pte_write(*pte))
957 flush_cache_page(vma, address, pte_pfn(*pte));
958 entry = ptep_clear_flush(vma, address, pte);
959 entry = pte_wrprotect(entry);
960 entry = pte_mkclean(entry);
961 set_pte_at(vma->vm_mm, address, pte, entry);
964 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
965 pmd_t *pmd = pvmw.pmd;
968 if (!pmd_dirty(*pmd) && !pmd_write(*pmd))
971 flush_cache_page(vma, address, page_to_pfn(page));
972 entry = pmdp_invalidate(vma, address, pmd);
973 entry = pmd_wrprotect(entry);
974 entry = pmd_mkclean(entry);
975 set_pmd_at(vma->vm_mm, address, pmd, entry);
978 /* unexpected pmd-mapped page? */
984 * No need to call mmu_notifier_invalidate_range() as we are
985 * downgrading page table protection not changing it to point
988 * See Documentation/vm/mmu_notifier.rst
994 mmu_notifier_invalidate_range_end(&range);
999 static bool invalid_mkclean_vma(struct vm_area_struct *vma, void *arg)
1001 if (vma->vm_flags & VM_SHARED)
1007 int folio_mkclean(struct folio *folio)
1010 struct address_space *mapping;
1011 struct rmap_walk_control rwc = {
1012 .arg = (void *)&cleaned,
1013 .rmap_one = page_mkclean_one,
1014 .invalid_vma = invalid_mkclean_vma,
1017 BUG_ON(!folio_test_locked(folio));
1019 if (!folio_mapped(folio))
1022 mapping = folio_mapping(folio);
1026 rmap_walk(&folio->page, &rwc);
1030 EXPORT_SYMBOL_GPL(folio_mkclean);
1033 * page_move_anon_rmap - move a page to our anon_vma
1034 * @page: the page to move to our anon_vma
1035 * @vma: the vma the page belongs to
1037 * When a page belongs exclusively to one process after a COW event,
1038 * that page can be moved into the anon_vma that belongs to just that
1039 * process, so the rmap code will not search the parent or sibling
1042 void page_move_anon_rmap(struct page *page, struct vm_area_struct *vma)
1044 struct anon_vma *anon_vma = vma->anon_vma;
1046 page = compound_head(page);
1048 VM_BUG_ON_PAGE(!PageLocked(page), page);
1049 VM_BUG_ON_VMA(!anon_vma, vma);
1051 anon_vma = (void *) anon_vma + PAGE_MAPPING_ANON;
1053 * Ensure that anon_vma and the PAGE_MAPPING_ANON bit are written
1054 * simultaneously, so a concurrent reader (eg page_referenced()'s
1055 * PageAnon()) will not see one without the other.
1057 WRITE_ONCE(page->mapping, (struct address_space *) anon_vma);
1061 * __page_set_anon_rmap - set up new anonymous rmap
1062 * @page: Page or Hugepage to add to rmap
1063 * @vma: VM area to add page to.
1064 * @address: User virtual address of the mapping
1065 * @exclusive: the page is exclusively owned by the current process
1067 static void __page_set_anon_rmap(struct page *page,
1068 struct vm_area_struct *vma, unsigned long address, int exclusive)
1070 struct anon_vma *anon_vma = vma->anon_vma;
1078 * If the page isn't exclusively mapped into this vma,
1079 * we must use the _oldest_ possible anon_vma for the
1083 anon_vma = anon_vma->root;
1086 * page_idle does a lockless/optimistic rmap scan on page->mapping.
1087 * Make sure the compiler doesn't split the stores of anon_vma and
1088 * the PAGE_MAPPING_ANON type identifier, otherwise the rmap code
1089 * could mistake the mapping for a struct address_space and crash.
1091 anon_vma = (void *) anon_vma + PAGE_MAPPING_ANON;
1092 WRITE_ONCE(page->mapping, (struct address_space *) anon_vma);
1093 page->index = linear_page_index(vma, address);
1097 * __page_check_anon_rmap - sanity check anonymous rmap addition
1098 * @page: the page to add the mapping to
1099 * @vma: the vm area in which the mapping is added
1100 * @address: the user virtual address mapped
1102 static void __page_check_anon_rmap(struct page *page,
1103 struct vm_area_struct *vma, unsigned long address)
1106 * The page's anon-rmap details (mapping and index) are guaranteed to
1107 * be set up correctly at this point.
1109 * We have exclusion against page_add_anon_rmap because the caller
1110 * always holds the page locked.
1112 * We have exclusion against page_add_new_anon_rmap because those pages
1113 * are initially only visible via the pagetables, and the pte is locked
1114 * over the call to page_add_new_anon_rmap.
1116 VM_BUG_ON_PAGE(page_anon_vma(page)->root != vma->anon_vma->root, page);
1117 VM_BUG_ON_PAGE(page_to_pgoff(page) != linear_page_index(vma, address),
1122 * page_add_anon_rmap - add pte mapping to an anonymous page
1123 * @page: the page to add the mapping to
1124 * @vma: the vm area in which the mapping is added
1125 * @address: the user virtual address mapped
1126 * @compound: charge the page as compound or small page
1128 * The caller needs to hold the pte lock, and the page must be locked in
1129 * the anon_vma case: to serialize mapping,index checking after setting,
1130 * and to ensure that PageAnon is not being upgraded racily to PageKsm
1131 * (but PageKsm is never downgraded to PageAnon).
1133 void page_add_anon_rmap(struct page *page,
1134 struct vm_area_struct *vma, unsigned long address, bool compound)
1136 do_page_add_anon_rmap(page, vma, address, compound ? RMAP_COMPOUND : 0);
1140 * Special version of the above for do_swap_page, which often runs
1141 * into pages that are exclusively owned by the current process.
1142 * Everybody else should continue to use page_add_anon_rmap above.
1144 void do_page_add_anon_rmap(struct page *page,
1145 struct vm_area_struct *vma, unsigned long address, int flags)
1147 bool compound = flags & RMAP_COMPOUND;
1150 if (unlikely(PageKsm(page)))
1151 lock_page_memcg(page);
1153 VM_BUG_ON_PAGE(!PageLocked(page), page);
1157 VM_BUG_ON_PAGE(!PageLocked(page), page);
1158 VM_BUG_ON_PAGE(!PageTransHuge(page), page);
1159 mapcount = compound_mapcount_ptr(page);
1160 first = atomic_inc_and_test(mapcount);
1162 first = atomic_inc_and_test(&page->_mapcount);
1166 int nr = compound ? thp_nr_pages(page) : 1;
1168 * We use the irq-unsafe __{inc|mod}_zone_page_stat because
1169 * these counters are not modified in interrupt context, and
1170 * pte lock(a spinlock) is held, which implies preemption
1174 __mod_lruvec_page_state(page, NR_ANON_THPS, nr);
1175 __mod_lruvec_page_state(page, NR_ANON_MAPPED, nr);
1178 if (unlikely(PageKsm(page)))
1179 unlock_page_memcg(page);
1181 /* address might be in next vma when migration races vma_adjust */
1183 __page_set_anon_rmap(page, vma, address,
1184 flags & RMAP_EXCLUSIVE);
1186 __page_check_anon_rmap(page, vma, address);
1188 mlock_vma_page(page, vma, compound);
1192 * page_add_new_anon_rmap - add pte mapping to a new anonymous page
1193 * @page: the page to add the mapping to
1194 * @vma: the vm area in which the mapping is added
1195 * @address: the user virtual address mapped
1196 * @compound: charge the page as compound or small page
1198 * Same as page_add_anon_rmap but must only be called on *new* pages.
1199 * This means the inc-and-test can be bypassed.
1200 * Page does not have to be locked.
1202 void page_add_new_anon_rmap(struct page *page,
1203 struct vm_area_struct *vma, unsigned long address, bool compound)
1205 int nr = compound ? thp_nr_pages(page) : 1;
1207 VM_BUG_ON_VMA(address < vma->vm_start || address >= vma->vm_end, vma);
1208 __SetPageSwapBacked(page);
1210 VM_BUG_ON_PAGE(!PageTransHuge(page), page);
1211 /* increment count (starts at -1) */
1212 atomic_set(compound_mapcount_ptr(page), 0);
1213 atomic_set(compound_pincount_ptr(page), 0);
1215 __mod_lruvec_page_state(page, NR_ANON_THPS, nr);
1217 /* Anon THP always mapped first with PMD */
1218 VM_BUG_ON_PAGE(PageTransCompound(page), page);
1219 /* increment count (starts at -1) */
1220 atomic_set(&page->_mapcount, 0);
1222 __mod_lruvec_page_state(page, NR_ANON_MAPPED, nr);
1223 __page_set_anon_rmap(page, vma, address, 1);
1227 * page_add_file_rmap - add pte mapping to a file page
1228 * @page: the page to add the mapping to
1229 * @vma: the vm area in which the mapping is added
1230 * @compound: charge the page as compound or small page
1232 * The caller needs to hold the pte lock.
1234 void page_add_file_rmap(struct page *page,
1235 struct vm_area_struct *vma, bool compound)
1239 VM_BUG_ON_PAGE(compound && !PageTransHuge(page), page);
1240 lock_page_memcg(page);
1241 if (compound && PageTransHuge(page)) {
1242 int nr_pages = thp_nr_pages(page);
1244 for (i = 0, nr = 0; i < nr_pages; i++) {
1245 if (atomic_inc_and_test(&page[i]._mapcount))
1248 if (!atomic_inc_and_test(compound_mapcount_ptr(page)))
1250 if (PageSwapBacked(page))
1251 __mod_lruvec_page_state(page, NR_SHMEM_PMDMAPPED,
1254 __mod_lruvec_page_state(page, NR_FILE_PMDMAPPED,
1257 if (PageTransCompound(page) && page_mapping(page)) {
1258 VM_WARN_ON_ONCE(!PageLocked(page));
1259 SetPageDoubleMap(compound_head(page));
1261 if (!atomic_inc_and_test(&page->_mapcount))
1264 __mod_lruvec_page_state(page, NR_FILE_MAPPED, nr);
1266 unlock_page_memcg(page);
1268 mlock_vma_page(page, vma, compound);
1271 static void page_remove_file_rmap(struct page *page, bool compound)
1275 VM_BUG_ON_PAGE(compound && !PageHead(page), page);
1277 /* Hugepages are not counted in NR_FILE_MAPPED for now. */
1278 if (unlikely(PageHuge(page))) {
1279 /* hugetlb pages are always mapped with pmds */
1280 atomic_dec(compound_mapcount_ptr(page));
1284 /* page still mapped by someone else? */
1285 if (compound && PageTransHuge(page)) {
1286 int nr_pages = thp_nr_pages(page);
1288 for (i = 0, nr = 0; i < nr_pages; i++) {
1289 if (atomic_add_negative(-1, &page[i]._mapcount))
1292 if (!atomic_add_negative(-1, compound_mapcount_ptr(page)))
1294 if (PageSwapBacked(page))
1295 __mod_lruvec_page_state(page, NR_SHMEM_PMDMAPPED,
1298 __mod_lruvec_page_state(page, NR_FILE_PMDMAPPED,
1301 if (!atomic_add_negative(-1, &page->_mapcount))
1306 * We use the irq-unsafe __{inc|mod}_lruvec_page_state because
1307 * these counters are not modified in interrupt context, and
1308 * pte lock(a spinlock) is held, which implies preemption disabled.
1310 __mod_lruvec_page_state(page, NR_FILE_MAPPED, -nr);
1313 static void page_remove_anon_compound_rmap(struct page *page)
1317 if (!atomic_add_negative(-1, compound_mapcount_ptr(page)))
1320 /* Hugepages are not counted in NR_ANON_PAGES for now. */
1321 if (unlikely(PageHuge(page)))
1324 if (!IS_ENABLED(CONFIG_TRANSPARENT_HUGEPAGE))
1327 __mod_lruvec_page_state(page, NR_ANON_THPS, -thp_nr_pages(page));
1329 if (TestClearPageDoubleMap(page)) {
1331 * Subpages can be mapped with PTEs too. Check how many of
1332 * them are still mapped.
1334 for (i = 0, nr = 0; i < thp_nr_pages(page); i++) {
1335 if (atomic_add_negative(-1, &page[i]._mapcount))
1340 * Queue the page for deferred split if at least one small
1341 * page of the compound page is unmapped, but at least one
1342 * small page is still mapped.
1344 if (nr && nr < thp_nr_pages(page))
1345 deferred_split_huge_page(page);
1347 nr = thp_nr_pages(page);
1351 __mod_lruvec_page_state(page, NR_ANON_MAPPED, -nr);
1355 * page_remove_rmap - take down pte mapping from a page
1356 * @page: page to remove mapping from
1357 * @vma: the vm area from which the mapping is removed
1358 * @compound: uncharge the page as compound or small page
1360 * The caller needs to hold the pte lock.
1362 void page_remove_rmap(struct page *page,
1363 struct vm_area_struct *vma, bool compound)
1365 lock_page_memcg(page);
1367 if (!PageAnon(page)) {
1368 page_remove_file_rmap(page, compound);
1373 page_remove_anon_compound_rmap(page);
1377 /* page still mapped by someone else? */
1378 if (!atomic_add_negative(-1, &page->_mapcount))
1382 * We use the irq-unsafe __{inc|mod}_zone_page_stat because
1383 * these counters are not modified in interrupt context, and
1384 * pte lock(a spinlock) is held, which implies preemption disabled.
1386 __dec_lruvec_page_state(page, NR_ANON_MAPPED);
1388 if (PageTransCompound(page))
1389 deferred_split_huge_page(compound_head(page));
1392 * It would be tidy to reset the PageAnon mapping here,
1393 * but that might overwrite a racing page_add_anon_rmap
1394 * which increments mapcount after us but sets mapping
1395 * before us: so leave the reset to free_unref_page,
1396 * and remember that it's only reliable while mapped.
1397 * Leaving it set also helps swapoff to reinstate ptes
1398 * faster for those pages still in swapcache.
1401 unlock_page_memcg(page);
1403 munlock_vma_page(page, vma, compound);
1407 * @arg: enum ttu_flags will be passed to this argument
1409 static bool try_to_unmap_one(struct page *page, struct vm_area_struct *vma,
1410 unsigned long address, void *arg)
1412 struct mm_struct *mm = vma->vm_mm;
1413 DEFINE_PAGE_VMA_WALK(pvmw, page, vma, address, 0);
1415 struct page *subpage;
1417 struct mmu_notifier_range range;
1418 enum ttu_flags flags = (enum ttu_flags)(long)arg;
1421 * When racing against e.g. zap_pte_range() on another cpu,
1422 * in between its ptep_get_and_clear_full() and page_remove_rmap(),
1423 * try_to_unmap() may return before page_mapped() has become false,
1424 * if page table locking is skipped: use TTU_SYNC to wait for that.
1426 if (flags & TTU_SYNC)
1427 pvmw.flags = PVMW_SYNC;
1429 if (flags & TTU_SPLIT_HUGE_PMD)
1430 split_huge_pmd_address(vma, address, false, page);
1433 * For THP, we have to assume the worse case ie pmd for invalidation.
1434 * For hugetlb, it could be much worse if we need to do pud
1435 * invalidation in the case of pmd sharing.
1437 * Note that the page can not be free in this function as call of
1438 * try_to_unmap() must hold a reference on the page.
1440 range.end = vma_address_end(&pvmw);
1441 mmu_notifier_range_init(&range, MMU_NOTIFY_CLEAR, 0, vma, vma->vm_mm,
1442 address, range.end);
1443 if (PageHuge(page)) {
1445 * If sharing is possible, start and end will be adjusted
1448 adjust_range_if_pmd_sharing_possible(vma, &range.start,
1451 mmu_notifier_invalidate_range_start(&range);
1453 while (page_vma_mapped_walk(&pvmw)) {
1454 /* Unexpected PMD-mapped THP? */
1455 VM_BUG_ON_PAGE(!pvmw.pte, page);
1458 * If the page is in an mlock()d vma, we must not swap it out.
1460 if (!(flags & TTU_IGNORE_MLOCK) &&
1461 (vma->vm_flags & VM_LOCKED)) {
1462 /* Restore the mlock which got missed */
1463 mlock_vma_page(page, vma, false);
1464 page_vma_mapped_walk_done(&pvmw);
1469 subpage = page - page_to_pfn(page) + pte_pfn(*pvmw.pte);
1470 address = pvmw.address;
1472 if (PageHuge(page) && !PageAnon(page)) {
1474 * To call huge_pmd_unshare, i_mmap_rwsem must be
1475 * held in write mode. Caller needs to explicitly
1476 * do this outside rmap routines.
1478 VM_BUG_ON(!(flags & TTU_RMAP_LOCKED));
1479 if (huge_pmd_unshare(mm, vma, &address, pvmw.pte)) {
1481 * huge_pmd_unshare unmapped an entire PMD
1482 * page. There is no way of knowing exactly
1483 * which PMDs may be cached for this mm, so
1484 * we must flush them all. start/end were
1485 * already adjusted above to cover this range.
1487 flush_cache_range(vma, range.start, range.end);
1488 flush_tlb_range(vma, range.start, range.end);
1489 mmu_notifier_invalidate_range(mm, range.start,
1493 * The ref count of the PMD page was dropped
1494 * which is part of the way map counting
1495 * is done for shared PMDs. Return 'true'
1496 * here. When there is no other sharing,
1497 * huge_pmd_unshare returns false and we will
1498 * unmap the actual page and drop map count
1501 page_vma_mapped_walk_done(&pvmw);
1506 /* Nuke the page table entry. */
1507 flush_cache_page(vma, address, pte_pfn(*pvmw.pte));
1508 if (should_defer_flush(mm, flags)) {
1510 * We clear the PTE but do not flush so potentially
1511 * a remote CPU could still be writing to the page.
1512 * If the entry was previously clean then the
1513 * architecture must guarantee that a clear->dirty
1514 * transition on a cached TLB entry is written through
1515 * and traps if the PTE is unmapped.
1517 pteval = ptep_get_and_clear(mm, address, pvmw.pte);
1519 set_tlb_ubc_flush_pending(mm, pte_dirty(pteval));
1521 pteval = ptep_clear_flush(vma, address, pvmw.pte);
1524 /* Move the dirty bit to the page. Now the pte is gone. */
1525 if (pte_dirty(pteval))
1526 set_page_dirty(page);
1528 /* Update high watermark before we lower rss */
1529 update_hiwater_rss(mm);
1531 if (PageHWPoison(page) && !(flags & TTU_IGNORE_HWPOISON)) {
1532 pteval = swp_entry_to_pte(make_hwpoison_entry(subpage));
1533 if (PageHuge(page)) {
1534 hugetlb_count_sub(compound_nr(page), mm);
1535 set_huge_swap_pte_at(mm, address,
1537 vma_mmu_pagesize(vma));
1539 dec_mm_counter(mm, mm_counter(page));
1540 set_pte_at(mm, address, pvmw.pte, pteval);
1543 } else if (pte_unused(pteval) && !userfaultfd_armed(vma)) {
1545 * The guest indicated that the page content is of no
1546 * interest anymore. Simply discard the pte, vmscan
1547 * will take care of the rest.
1548 * A future reference will then fault in a new zero
1549 * page. When userfaultfd is active, we must not drop
1550 * this page though, as its main user (postcopy
1551 * migration) will not expect userfaults on already
1554 dec_mm_counter(mm, mm_counter(page));
1555 /* We have to invalidate as we cleared the pte */
1556 mmu_notifier_invalidate_range(mm, address,
1557 address + PAGE_SIZE);
1558 } else if (PageAnon(page)) {
1559 swp_entry_t entry = { .val = page_private(subpage) };
1562 * Store the swap location in the pte.
1563 * See handle_pte_fault() ...
1565 if (unlikely(PageSwapBacked(page) != PageSwapCache(page))) {
1568 /* We have to invalidate as we cleared the pte */
1569 mmu_notifier_invalidate_range(mm, address,
1570 address + PAGE_SIZE);
1571 page_vma_mapped_walk_done(&pvmw);
1575 /* MADV_FREE page check */
1576 if (!PageSwapBacked(page)) {
1577 if (!PageDirty(page)) {
1578 /* Invalidate as we cleared the pte */
1579 mmu_notifier_invalidate_range(mm,
1580 address, address + PAGE_SIZE);
1581 dec_mm_counter(mm, MM_ANONPAGES);
1586 * If the page was redirtied, it cannot be
1587 * discarded. Remap the page to page table.
1589 set_pte_at(mm, address, pvmw.pte, pteval);
1590 SetPageSwapBacked(page);
1592 page_vma_mapped_walk_done(&pvmw);
1596 if (swap_duplicate(entry) < 0) {
1597 set_pte_at(mm, address, pvmw.pte, pteval);
1599 page_vma_mapped_walk_done(&pvmw);
1602 if (arch_unmap_one(mm, vma, address, pteval) < 0) {
1603 set_pte_at(mm, address, pvmw.pte, pteval);
1605 page_vma_mapped_walk_done(&pvmw);
1608 if (list_empty(&mm->mmlist)) {
1609 spin_lock(&mmlist_lock);
1610 if (list_empty(&mm->mmlist))
1611 list_add(&mm->mmlist, &init_mm.mmlist);
1612 spin_unlock(&mmlist_lock);
1614 dec_mm_counter(mm, MM_ANONPAGES);
1615 inc_mm_counter(mm, MM_SWAPENTS);
1616 swp_pte = swp_entry_to_pte(entry);
1617 if (pte_soft_dirty(pteval))
1618 swp_pte = pte_swp_mksoft_dirty(swp_pte);
1619 if (pte_uffd_wp(pteval))
1620 swp_pte = pte_swp_mkuffd_wp(swp_pte);
1621 set_pte_at(mm, address, pvmw.pte, swp_pte);
1622 /* Invalidate as we cleared the pte */
1623 mmu_notifier_invalidate_range(mm, address,
1624 address + PAGE_SIZE);
1627 * This is a locked file-backed page, thus it cannot
1628 * be removed from the page cache and replaced by a new
1629 * page before mmu_notifier_invalidate_range_end, so no
1630 * concurrent thread might update its page table to
1631 * point at new page while a device still is using this
1634 * See Documentation/vm/mmu_notifier.rst
1636 dec_mm_counter(mm, mm_counter_file(page));
1640 * No need to call mmu_notifier_invalidate_range() it has be
1641 * done above for all cases requiring it to happen under page
1642 * table lock before mmu_notifier_invalidate_range_end()
1644 * See Documentation/vm/mmu_notifier.rst
1646 page_remove_rmap(subpage, vma, PageHuge(page));
1647 if (vma->vm_flags & VM_LOCKED)
1648 mlock_page_drain(smp_processor_id());
1652 mmu_notifier_invalidate_range_end(&range);
1657 static bool invalid_migration_vma(struct vm_area_struct *vma, void *arg)
1659 return vma_is_temporary_stack(vma);
1662 static int page_not_mapped(struct page *page)
1664 return !page_mapped(page);
1668 * try_to_unmap - try to remove all page table mappings to a page
1669 * @page: the page to get unmapped
1670 * @flags: action and flags
1672 * Tries to remove all the page table entries which are mapping this
1673 * page, used in the pageout path. Caller must hold the page lock.
1675 * It is the caller's responsibility to check if the page is still
1676 * mapped when needed (use TTU_SYNC to prevent accounting races).
1678 void try_to_unmap(struct page *page, enum ttu_flags flags)
1680 struct rmap_walk_control rwc = {
1681 .rmap_one = try_to_unmap_one,
1682 .arg = (void *)flags,
1683 .done = page_not_mapped,
1684 .anon_lock = page_lock_anon_vma_read,
1687 if (flags & TTU_RMAP_LOCKED)
1688 rmap_walk_locked(page, &rwc);
1690 rmap_walk(page, &rwc);
1694 * @arg: enum ttu_flags will be passed to this argument.
1696 * If TTU_SPLIT_HUGE_PMD is specified any PMD mappings will be split into PTEs
1697 * containing migration entries.
1699 static bool try_to_migrate_one(struct page *page, struct vm_area_struct *vma,
1700 unsigned long address, void *arg)
1702 struct mm_struct *mm = vma->vm_mm;
1703 DEFINE_PAGE_VMA_WALK(pvmw, page, vma, address, 0);
1705 struct page *subpage;
1707 struct mmu_notifier_range range;
1708 enum ttu_flags flags = (enum ttu_flags)(long)arg;
1711 * When racing against e.g. zap_pte_range() on another cpu,
1712 * in between its ptep_get_and_clear_full() and page_remove_rmap(),
1713 * try_to_migrate() may return before page_mapped() has become false,
1714 * if page table locking is skipped: use TTU_SYNC to wait for that.
1716 if (flags & TTU_SYNC)
1717 pvmw.flags = PVMW_SYNC;
1720 * unmap_page() in mm/huge_memory.c is the only user of migration with
1721 * TTU_SPLIT_HUGE_PMD and it wants to freeze.
1723 if (flags & TTU_SPLIT_HUGE_PMD)
1724 split_huge_pmd_address(vma, address, true, page);
1727 * For THP, we have to assume the worse case ie pmd for invalidation.
1728 * For hugetlb, it could be much worse if we need to do pud
1729 * invalidation in the case of pmd sharing.
1731 * Note that the page can not be free in this function as call of
1732 * try_to_unmap() must hold a reference on the page.
1734 range.end = vma_address_end(&pvmw);
1735 mmu_notifier_range_init(&range, MMU_NOTIFY_CLEAR, 0, vma, vma->vm_mm,
1736 address, range.end);
1737 if (PageHuge(page)) {
1739 * If sharing is possible, start and end will be adjusted
1742 adjust_range_if_pmd_sharing_possible(vma, &range.start,
1745 mmu_notifier_invalidate_range_start(&range);
1747 while (page_vma_mapped_walk(&pvmw)) {
1748 #ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
1749 /* PMD-mapped THP migration entry */
1751 VM_BUG_ON_PAGE(PageHuge(page) ||
1752 !PageTransCompound(page), page);
1754 set_pmd_migration_entry(&pvmw, page);
1759 /* Unexpected PMD-mapped THP? */
1760 VM_BUG_ON_PAGE(!pvmw.pte, page);
1762 subpage = page - page_to_pfn(page) + pte_pfn(*pvmw.pte);
1763 address = pvmw.address;
1765 if (PageHuge(page) && !PageAnon(page)) {
1767 * To call huge_pmd_unshare, i_mmap_rwsem must be
1768 * held in write mode. Caller needs to explicitly
1769 * do this outside rmap routines.
1771 VM_BUG_ON(!(flags & TTU_RMAP_LOCKED));
1772 if (huge_pmd_unshare(mm, vma, &address, pvmw.pte)) {
1774 * huge_pmd_unshare unmapped an entire PMD
1775 * page. There is no way of knowing exactly
1776 * which PMDs may be cached for this mm, so
1777 * we must flush them all. start/end were
1778 * already adjusted above to cover this range.
1780 flush_cache_range(vma, range.start, range.end);
1781 flush_tlb_range(vma, range.start, range.end);
1782 mmu_notifier_invalidate_range(mm, range.start,
1786 * The ref count of the PMD page was dropped
1787 * which is part of the way map counting
1788 * is done for shared PMDs. Return 'true'
1789 * here. When there is no other sharing,
1790 * huge_pmd_unshare returns false and we will
1791 * unmap the actual page and drop map count
1794 page_vma_mapped_walk_done(&pvmw);
1799 /* Nuke the page table entry. */
1800 flush_cache_page(vma, address, pte_pfn(*pvmw.pte));
1801 pteval = ptep_clear_flush(vma, address, pvmw.pte);
1803 /* Move the dirty bit to the page. Now the pte is gone. */
1804 if (pte_dirty(pteval))
1805 set_page_dirty(page);
1807 /* Update high watermark before we lower rss */
1808 update_hiwater_rss(mm);
1810 if (is_zone_device_page(page)) {
1811 unsigned long pfn = page_to_pfn(page);
1816 * Store the pfn of the page in a special migration
1817 * pte. do_swap_page() will wait until the migration
1818 * pte is removed and then restart fault handling.
1820 entry = pte_to_swp_entry(pteval);
1821 if (is_writable_device_private_entry(entry))
1822 entry = make_writable_migration_entry(pfn);
1824 entry = make_readable_migration_entry(pfn);
1825 swp_pte = swp_entry_to_pte(entry);
1828 * pteval maps a zone device page and is therefore
1831 if (pte_swp_soft_dirty(pteval))
1832 swp_pte = pte_swp_mksoft_dirty(swp_pte);
1833 if (pte_swp_uffd_wp(pteval))
1834 swp_pte = pte_swp_mkuffd_wp(swp_pte);
1835 set_pte_at(mm, pvmw.address, pvmw.pte, swp_pte);
1837 * No need to invalidate here it will synchronize on
1838 * against the special swap migration pte.
1840 * The assignment to subpage above was computed from a
1841 * swap PTE which results in an invalid pointer.
1842 * Since only PAGE_SIZE pages can currently be
1843 * migrated, just set it to page. This will need to be
1844 * changed when hugepage migrations to device private
1845 * memory are supported.
1848 } else if (PageHWPoison(page)) {
1849 pteval = swp_entry_to_pte(make_hwpoison_entry(subpage));
1850 if (PageHuge(page)) {
1851 hugetlb_count_sub(compound_nr(page), mm);
1852 set_huge_swap_pte_at(mm, address,
1854 vma_mmu_pagesize(vma));
1856 dec_mm_counter(mm, mm_counter(page));
1857 set_pte_at(mm, address, pvmw.pte, pteval);
1860 } else if (pte_unused(pteval) && !userfaultfd_armed(vma)) {
1862 * The guest indicated that the page content is of no
1863 * interest anymore. Simply discard the pte, vmscan
1864 * will take care of the rest.
1865 * A future reference will then fault in a new zero
1866 * page. When userfaultfd is active, we must not drop
1867 * this page though, as its main user (postcopy
1868 * migration) will not expect userfaults on already
1871 dec_mm_counter(mm, mm_counter(page));
1872 /* We have to invalidate as we cleared the pte */
1873 mmu_notifier_invalidate_range(mm, address,
1874 address + PAGE_SIZE);
1879 if (arch_unmap_one(mm, vma, address, pteval) < 0) {
1880 set_pte_at(mm, address, pvmw.pte, pteval);
1882 page_vma_mapped_walk_done(&pvmw);
1887 * Store the pfn of the page in a special migration
1888 * pte. do_swap_page() will wait until the migration
1889 * pte is removed and then restart fault handling.
1891 if (pte_write(pteval))
1892 entry = make_writable_migration_entry(
1893 page_to_pfn(subpage));
1895 entry = make_readable_migration_entry(
1896 page_to_pfn(subpage));
1898 swp_pte = swp_entry_to_pte(entry);
1899 if (pte_soft_dirty(pteval))
1900 swp_pte = pte_swp_mksoft_dirty(swp_pte);
1901 if (pte_uffd_wp(pteval))
1902 swp_pte = pte_swp_mkuffd_wp(swp_pte);
1903 set_pte_at(mm, address, pvmw.pte, swp_pte);
1905 * No need to invalidate here it will synchronize on
1906 * against the special swap migration pte.
1911 * No need to call mmu_notifier_invalidate_range() it has be
1912 * done above for all cases requiring it to happen under page
1913 * table lock before mmu_notifier_invalidate_range_end()
1915 * See Documentation/vm/mmu_notifier.rst
1917 page_remove_rmap(subpage, vma, PageHuge(page));
1918 if (vma->vm_flags & VM_LOCKED)
1919 mlock_page_drain(smp_processor_id());
1923 mmu_notifier_invalidate_range_end(&range);
1929 * try_to_migrate - try to replace all page table mappings with swap entries
1930 * @page: the page to replace page table entries for
1931 * @flags: action and flags
1933 * Tries to remove all the page table entries which are mapping this page and
1934 * replace them with special swap entries. Caller must hold the page lock.
1936 void try_to_migrate(struct page *page, enum ttu_flags flags)
1938 struct rmap_walk_control rwc = {
1939 .rmap_one = try_to_migrate_one,
1940 .arg = (void *)flags,
1941 .done = page_not_mapped,
1942 .anon_lock = page_lock_anon_vma_read,
1946 * Migration always ignores mlock and only supports TTU_RMAP_LOCKED and
1947 * TTU_SPLIT_HUGE_PMD and TTU_SYNC flags.
1949 if (WARN_ON_ONCE(flags & ~(TTU_RMAP_LOCKED | TTU_SPLIT_HUGE_PMD |
1953 if (is_zone_device_page(page) && !is_device_private_page(page))
1957 * During exec, a temporary VMA is setup and later moved.
1958 * The VMA is moved under the anon_vma lock but not the
1959 * page tables leading to a race where migration cannot
1960 * find the migration ptes. Rather than increasing the
1961 * locking requirements of exec(), migration skips
1962 * temporary VMAs until after exec() completes.
1964 if (!PageKsm(page) && PageAnon(page))
1965 rwc.invalid_vma = invalid_migration_vma;
1967 if (flags & TTU_RMAP_LOCKED)
1968 rmap_walk_locked(page, &rwc);
1970 rmap_walk(page, &rwc);
1973 #ifdef CONFIG_DEVICE_PRIVATE
1974 struct make_exclusive_args {
1975 struct mm_struct *mm;
1976 unsigned long address;
1981 static bool page_make_device_exclusive_one(struct page *page,
1982 struct vm_area_struct *vma, unsigned long address, void *priv)
1984 struct mm_struct *mm = vma->vm_mm;
1985 DEFINE_PAGE_VMA_WALK(pvmw, page, vma, address, 0);
1986 struct make_exclusive_args *args = priv;
1988 struct page *subpage;
1990 struct mmu_notifier_range range;
1994 mmu_notifier_range_init_owner(&range, MMU_NOTIFY_EXCLUSIVE, 0, vma,
1995 vma->vm_mm, address, min(vma->vm_end,
1996 address + page_size(page)), args->owner);
1997 mmu_notifier_invalidate_range_start(&range);
1999 while (page_vma_mapped_walk(&pvmw)) {
2000 /* Unexpected PMD-mapped THP? */
2001 VM_BUG_ON_PAGE(!pvmw.pte, page);
2003 if (!pte_present(*pvmw.pte)) {
2005 page_vma_mapped_walk_done(&pvmw);
2009 subpage = page - page_to_pfn(page) + pte_pfn(*pvmw.pte);
2010 address = pvmw.address;
2012 /* Nuke the page table entry. */
2013 flush_cache_page(vma, address, pte_pfn(*pvmw.pte));
2014 pteval = ptep_clear_flush(vma, address, pvmw.pte);
2016 /* Move the dirty bit to the page. Now the pte is gone. */
2017 if (pte_dirty(pteval))
2018 set_page_dirty(page);
2021 * Check that our target page is still mapped at the expected
2024 if (args->mm == mm && args->address == address &&
2029 * Store the pfn of the page in a special migration
2030 * pte. do_swap_page() will wait until the migration
2031 * pte is removed and then restart fault handling.
2033 if (pte_write(pteval))
2034 entry = make_writable_device_exclusive_entry(
2035 page_to_pfn(subpage));
2037 entry = make_readable_device_exclusive_entry(
2038 page_to_pfn(subpage));
2039 swp_pte = swp_entry_to_pte(entry);
2040 if (pte_soft_dirty(pteval))
2041 swp_pte = pte_swp_mksoft_dirty(swp_pte);
2042 if (pte_uffd_wp(pteval))
2043 swp_pte = pte_swp_mkuffd_wp(swp_pte);
2045 set_pte_at(mm, address, pvmw.pte, swp_pte);
2048 * There is a reference on the page for the swap entry which has
2049 * been removed, so shouldn't take another.
2051 page_remove_rmap(subpage, vma, false);
2054 mmu_notifier_invalidate_range_end(&range);
2060 * page_make_device_exclusive - mark the page exclusively owned by a device
2061 * @page: the page to replace page table entries for
2062 * @mm: the mm_struct where the page is expected to be mapped
2063 * @address: address where the page is expected to be mapped
2064 * @owner: passed to MMU_NOTIFY_EXCLUSIVE range notifier callbacks
2066 * Tries to remove all the page table entries which are mapping this page and
2067 * replace them with special device exclusive swap entries to grant a device
2068 * exclusive access to the page. Caller must hold the page lock.
2070 * Returns false if the page is still mapped, or if it could not be unmapped
2071 * from the expected address. Otherwise returns true (success).
2073 static bool page_make_device_exclusive(struct page *page, struct mm_struct *mm,
2074 unsigned long address, void *owner)
2076 struct make_exclusive_args args = {
2082 struct rmap_walk_control rwc = {
2083 .rmap_one = page_make_device_exclusive_one,
2084 .done = page_not_mapped,
2085 .anon_lock = page_lock_anon_vma_read,
2090 * Restrict to anonymous pages for now to avoid potential writeback
2091 * issues. Also tail pages shouldn't be passed to rmap_walk so skip
2094 if (!PageAnon(page) || PageTail(page))
2097 rmap_walk(page, &rwc);
2099 return args.valid && !page_mapcount(page);
2103 * make_device_exclusive_range() - Mark a range for exclusive use by a device
2104 * @mm: mm_struct of assoicated target process
2105 * @start: start of the region to mark for exclusive device access
2106 * @end: end address of region
2107 * @pages: returns the pages which were successfully marked for exclusive access
2108 * @owner: passed to MMU_NOTIFY_EXCLUSIVE range notifier to allow filtering
2110 * Returns: number of pages found in the range by GUP. A page is marked for
2111 * exclusive access only if the page pointer is non-NULL.
2113 * This function finds ptes mapping page(s) to the given address range, locks
2114 * them and replaces mappings with special swap entries preventing userspace CPU
2115 * access. On fault these entries are replaced with the original mapping after
2116 * calling MMU notifiers.
2118 * A driver using this to program access from a device must use a mmu notifier
2119 * critical section to hold a device specific lock during programming. Once
2120 * programming is complete it should drop the page lock and reference after
2121 * which point CPU access to the page will revoke the exclusive access.
2123 int make_device_exclusive_range(struct mm_struct *mm, unsigned long start,
2124 unsigned long end, struct page **pages,
2127 long npages = (end - start) >> PAGE_SHIFT;
2130 npages = get_user_pages_remote(mm, start, npages,
2131 FOLL_GET | FOLL_WRITE | FOLL_SPLIT_PMD,
2136 for (i = 0; i < npages; i++, start += PAGE_SIZE) {
2137 if (!trylock_page(pages[i])) {
2143 if (!page_make_device_exclusive(pages[i], mm, start, owner)) {
2144 unlock_page(pages[i]);
2152 EXPORT_SYMBOL_GPL(make_device_exclusive_range);
2155 void __put_anon_vma(struct anon_vma *anon_vma)
2157 struct anon_vma *root = anon_vma->root;
2159 anon_vma_free(anon_vma);
2160 if (root != anon_vma && atomic_dec_and_test(&root->refcount))
2161 anon_vma_free(root);
2164 static struct anon_vma *rmap_walk_anon_lock(struct page *page,
2165 struct rmap_walk_control *rwc)
2167 struct anon_vma *anon_vma;
2170 return rwc->anon_lock(page);
2173 * Note: remove_migration_ptes() cannot use page_lock_anon_vma_read()
2174 * because that depends on page_mapped(); but not all its usages
2175 * are holding mmap_lock. Users without mmap_lock are required to
2176 * take a reference count to prevent the anon_vma disappearing
2178 anon_vma = page_anon_vma(page);
2182 anon_vma_lock_read(anon_vma);
2187 * rmap_walk_anon - do something to anonymous page using the object-based
2189 * @page: the page to be handled
2190 * @rwc: control variable according to each walk type
2192 * Find all the mappings of a page using the mapping pointer and the vma chains
2193 * contained in the anon_vma struct it points to.
2195 static void rmap_walk_anon(struct page *page, struct rmap_walk_control *rwc,
2198 struct anon_vma *anon_vma;
2199 pgoff_t pgoff_start, pgoff_end;
2200 struct anon_vma_chain *avc;
2203 anon_vma = page_anon_vma(page);
2204 /* anon_vma disappear under us? */
2205 VM_BUG_ON_PAGE(!anon_vma, page);
2207 anon_vma = rmap_walk_anon_lock(page, rwc);
2212 pgoff_start = page_to_pgoff(page);
2213 pgoff_end = pgoff_start + thp_nr_pages(page) - 1;
2214 anon_vma_interval_tree_foreach(avc, &anon_vma->rb_root,
2215 pgoff_start, pgoff_end) {
2216 struct vm_area_struct *vma = avc->vma;
2217 unsigned long address = vma_address(page, vma);
2219 VM_BUG_ON_VMA(address == -EFAULT, vma);
2222 if (rwc->invalid_vma && rwc->invalid_vma(vma, rwc->arg))
2225 if (!rwc->rmap_one(page, vma, address, rwc->arg))
2227 if (rwc->done && rwc->done(page))
2232 anon_vma_unlock_read(anon_vma);
2236 * rmap_walk_file - do something to file page using the object-based rmap method
2237 * @page: the page to be handled
2238 * @rwc: control variable according to each walk type
2240 * Find all the mappings of a page using the mapping pointer and the vma chains
2241 * contained in the address_space struct it points to.
2243 static void rmap_walk_file(struct page *page, struct rmap_walk_control *rwc,
2246 struct address_space *mapping = page_mapping(page);
2247 pgoff_t pgoff_start, pgoff_end;
2248 struct vm_area_struct *vma;
2251 * The page lock not only makes sure that page->mapping cannot
2252 * suddenly be NULLified by truncation, it makes sure that the
2253 * structure at mapping cannot be freed and reused yet,
2254 * so we can safely take mapping->i_mmap_rwsem.
2256 VM_BUG_ON_PAGE(!PageLocked(page), page);
2261 pgoff_start = page_to_pgoff(page);
2262 pgoff_end = pgoff_start + thp_nr_pages(page) - 1;
2264 i_mmap_lock_read(mapping);
2265 vma_interval_tree_foreach(vma, &mapping->i_mmap,
2266 pgoff_start, pgoff_end) {
2267 unsigned long address = vma_address(page, vma);
2269 VM_BUG_ON_VMA(address == -EFAULT, vma);
2272 if (rwc->invalid_vma && rwc->invalid_vma(vma, rwc->arg))
2275 if (!rwc->rmap_one(page, vma, address, rwc->arg))
2277 if (rwc->done && rwc->done(page))
2283 i_mmap_unlock_read(mapping);
2286 void rmap_walk(struct page *page, struct rmap_walk_control *rwc)
2288 if (unlikely(PageKsm(page)))
2289 rmap_walk_ksm(page, rwc);
2290 else if (PageAnon(page))
2291 rmap_walk_anon(page, rwc, false);
2293 rmap_walk_file(page, rwc, false);
2296 /* Like rmap_walk, but caller holds relevant rmap lock */
2297 void rmap_walk_locked(struct page *page, struct rmap_walk_control *rwc)
2299 /* no ksm support for now */
2300 VM_BUG_ON_PAGE(PageKsm(page), page);
2302 rmap_walk_anon(page, rwc, true);
2304 rmap_walk_file(page, rwc, true);
2307 #ifdef CONFIG_HUGETLB_PAGE
2309 * The following two functions are for anonymous (private mapped) hugepages.
2310 * Unlike common anonymous pages, anonymous hugepages have no accounting code
2311 * and no lru code, because we handle hugepages differently from common pages.
2313 void hugepage_add_anon_rmap(struct page *page,
2314 struct vm_area_struct *vma, unsigned long address)
2316 struct anon_vma *anon_vma = vma->anon_vma;
2319 BUG_ON(!PageLocked(page));
2321 /* address might be in next vma when migration races vma_adjust */
2322 first = atomic_inc_and_test(compound_mapcount_ptr(page));
2324 __page_set_anon_rmap(page, vma, address, 0);
2327 void hugepage_add_new_anon_rmap(struct page *page,
2328 struct vm_area_struct *vma, unsigned long address)
2330 BUG_ON(address < vma->vm_start || address >= vma->vm_end);
2331 atomic_set(compound_mapcount_ptr(page), 0);
2332 atomic_set(compound_pincount_ptr(page), 0);
2334 __page_set_anon_rmap(page, vma, address, 1);
2336 #endif /* CONFIG_HUGETLB_PAGE */