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