xref: /openbmc/linux/mm/migrate.c (revision a21d2133)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Memory Migration functionality - linux/mm/migrate.c
4  *
5  * Copyright (C) 2006 Silicon Graphics, Inc., Christoph Lameter
6  *
7  * Page migration was first developed in the context of the memory hotplug
8  * project. The main authors of the migration code are:
9  *
10  * IWAMOTO Toshihiro <iwamoto@valinux.co.jp>
11  * Hirokazu Takahashi <taka@valinux.co.jp>
12  * Dave Hansen <haveblue@us.ibm.com>
13  * Christoph Lameter
14  */
15 
16 #include <linux/migrate.h>
17 #include <linux/export.h>
18 #include <linux/swap.h>
19 #include <linux/swapops.h>
20 #include <linux/pagemap.h>
21 #include <linux/buffer_head.h>
22 #include <linux/mm_inline.h>
23 #include <linux/nsproxy.h>
24 #include <linux/pagevec.h>
25 #include <linux/ksm.h>
26 #include <linux/rmap.h>
27 #include <linux/topology.h>
28 #include <linux/cpu.h>
29 #include <linux/cpuset.h>
30 #include <linux/writeback.h>
31 #include <linux/mempolicy.h>
32 #include <linux/vmalloc.h>
33 #include <linux/security.h>
34 #include <linux/backing-dev.h>
35 #include <linux/compaction.h>
36 #include <linux/syscalls.h>
37 #include <linux/compat.h>
38 #include <linux/hugetlb.h>
39 #include <linux/hugetlb_cgroup.h>
40 #include <linux/gfp.h>
41 #include <linux/pfn_t.h>
42 #include <linux/memremap.h>
43 #include <linux/userfaultfd_k.h>
44 #include <linux/balloon_compaction.h>
45 #include <linux/page_idle.h>
46 #include <linux/page_owner.h>
47 #include <linux/sched/mm.h>
48 #include <linux/ptrace.h>
49 #include <linux/oom.h>
50 #include <linux/memory.h>
51 #include <linux/random.h>
52 #include <linux/sched/sysctl.h>
53 #include <linux/memory-tiers.h>
54 
55 #include <asm/tlbflush.h>
56 
57 #include <trace/events/migrate.h>
58 
59 #include "internal.h"
60 
61 bool isolate_movable_page(struct page *page, isolate_mode_t mode)
62 {
63 	struct folio *folio = folio_get_nontail_page(page);
64 	const struct movable_operations *mops;
65 
66 	/*
67 	 * Avoid burning cycles with pages that are yet under __free_pages(),
68 	 * or just got freed under us.
69 	 *
70 	 * In case we 'win' a race for a movable page being freed under us and
71 	 * raise its refcount preventing __free_pages() from doing its job
72 	 * the put_page() at the end of this block will take care of
73 	 * release this page, thus avoiding a nasty leakage.
74 	 */
75 	if (!folio)
76 		goto out;
77 
78 	if (unlikely(folio_test_slab(folio)))
79 		goto out_putfolio;
80 	/* Pairs with smp_wmb() in slab freeing, e.g. SLUB's __free_slab() */
81 	smp_rmb();
82 	/*
83 	 * Check movable flag before taking the page lock because
84 	 * we use non-atomic bitops on newly allocated page flags so
85 	 * unconditionally grabbing the lock ruins page's owner side.
86 	 */
87 	if (unlikely(!__folio_test_movable(folio)))
88 		goto out_putfolio;
89 	/* Pairs with smp_wmb() in slab allocation, e.g. SLUB's alloc_slab_page() */
90 	smp_rmb();
91 	if (unlikely(folio_test_slab(folio)))
92 		goto out_putfolio;
93 
94 	/*
95 	 * As movable pages are not isolated from LRU lists, concurrent
96 	 * compaction threads can race against page migration functions
97 	 * as well as race against the releasing a page.
98 	 *
99 	 * In order to avoid having an already isolated movable page
100 	 * being (wrongly) re-isolated while it is under migration,
101 	 * or to avoid attempting to isolate pages being released,
102 	 * lets be sure we have the page lock
103 	 * before proceeding with the movable page isolation steps.
104 	 */
105 	if (unlikely(!folio_trylock(folio)))
106 		goto out_putfolio;
107 
108 	if (!folio_test_movable(folio) || folio_test_isolated(folio))
109 		goto out_no_isolated;
110 
111 	mops = folio_movable_ops(folio);
112 	VM_BUG_ON_FOLIO(!mops, folio);
113 
114 	if (!mops->isolate_page(&folio->page, mode))
115 		goto out_no_isolated;
116 
117 	/* Driver shouldn't use PG_isolated bit of page->flags */
118 	WARN_ON_ONCE(folio_test_isolated(folio));
119 	folio_set_isolated(folio);
120 	folio_unlock(folio);
121 
122 	return true;
123 
124 out_no_isolated:
125 	folio_unlock(folio);
126 out_putfolio:
127 	folio_put(folio);
128 out:
129 	return false;
130 }
131 
132 static void putback_movable_folio(struct folio *folio)
133 {
134 	const struct movable_operations *mops = folio_movable_ops(folio);
135 
136 	mops->putback_page(&folio->page);
137 	folio_clear_isolated(folio);
138 }
139 
140 /*
141  * Put previously isolated pages back onto the appropriate lists
142  * from where they were once taken off for compaction/migration.
143  *
144  * This function shall be used whenever the isolated pageset has been
145  * built from lru, balloon, hugetlbfs page. See isolate_migratepages_range()
146  * and isolate_hugetlb().
147  */
148 void putback_movable_pages(struct list_head *l)
149 {
150 	struct folio *folio;
151 	struct folio *folio2;
152 
153 	list_for_each_entry_safe(folio, folio2, l, lru) {
154 		if (unlikely(folio_test_hugetlb(folio))) {
155 			folio_putback_active_hugetlb(folio);
156 			continue;
157 		}
158 		list_del(&folio->lru);
159 		/*
160 		 * We isolated non-lru movable folio so here we can use
161 		 * __PageMovable because LRU folio's mapping cannot have
162 		 * PAGE_MAPPING_MOVABLE.
163 		 */
164 		if (unlikely(__folio_test_movable(folio))) {
165 			VM_BUG_ON_FOLIO(!folio_test_isolated(folio), folio);
166 			folio_lock(folio);
167 			if (folio_test_movable(folio))
168 				putback_movable_folio(folio);
169 			else
170 				folio_clear_isolated(folio);
171 			folio_unlock(folio);
172 			folio_put(folio);
173 		} else {
174 			node_stat_mod_folio(folio, NR_ISOLATED_ANON +
175 					folio_is_file_lru(folio), -folio_nr_pages(folio));
176 			folio_putback_lru(folio);
177 		}
178 	}
179 }
180 
181 /*
182  * Restore a potential migration pte to a working pte entry
183  */
184 static bool remove_migration_pte(struct folio *folio,
185 		struct vm_area_struct *vma, unsigned long addr, void *old)
186 {
187 	DEFINE_FOLIO_VMA_WALK(pvmw, old, vma, addr, PVMW_SYNC | PVMW_MIGRATION);
188 
189 	while (page_vma_mapped_walk(&pvmw)) {
190 		rmap_t rmap_flags = RMAP_NONE;
191 		pte_t pte;
192 		swp_entry_t entry;
193 		struct page *new;
194 		unsigned long idx = 0;
195 
196 		/* pgoff is invalid for ksm pages, but they are never large */
197 		if (folio_test_large(folio) && !folio_test_hugetlb(folio))
198 			idx = linear_page_index(vma, pvmw.address) - pvmw.pgoff;
199 		new = folio_page(folio, idx);
200 
201 #ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
202 		/* PMD-mapped THP migration entry */
203 		if (!pvmw.pte) {
204 			VM_BUG_ON_FOLIO(folio_test_hugetlb(folio) ||
205 					!folio_test_pmd_mappable(folio), folio);
206 			remove_migration_pmd(&pvmw, new);
207 			continue;
208 		}
209 #endif
210 
211 		folio_get(folio);
212 		pte = mk_pte(new, READ_ONCE(vma->vm_page_prot));
213 		if (pte_swp_soft_dirty(*pvmw.pte))
214 			pte = pte_mksoft_dirty(pte);
215 
216 		/*
217 		 * Recheck VMA as permissions can change since migration started
218 		 */
219 		entry = pte_to_swp_entry(*pvmw.pte);
220 		if (!is_migration_entry_young(entry))
221 			pte = pte_mkold(pte);
222 		if (folio_test_dirty(folio) && is_migration_entry_dirty(entry))
223 			pte = pte_mkdirty(pte);
224 		if (is_writable_migration_entry(entry))
225 			pte = maybe_mkwrite(pte, vma);
226 		else if (pte_swp_uffd_wp(*pvmw.pte))
227 			pte = pte_mkuffd_wp(pte);
228 		else
229 			pte = pte_wrprotect(pte);
230 
231 		if (folio_test_anon(folio) && !is_readable_migration_entry(entry))
232 			rmap_flags |= RMAP_EXCLUSIVE;
233 
234 		if (unlikely(is_device_private_page(new))) {
235 			if (pte_write(pte))
236 				entry = make_writable_device_private_entry(
237 							page_to_pfn(new));
238 			else
239 				entry = make_readable_device_private_entry(
240 							page_to_pfn(new));
241 			pte = swp_entry_to_pte(entry);
242 			if (pte_swp_soft_dirty(*pvmw.pte))
243 				pte = pte_swp_mksoft_dirty(pte);
244 			if (pte_swp_uffd_wp(*pvmw.pte))
245 				pte = pte_swp_mkuffd_wp(pte);
246 		}
247 
248 #ifdef CONFIG_HUGETLB_PAGE
249 		if (folio_test_hugetlb(folio)) {
250 			unsigned int shift = huge_page_shift(hstate_vma(vma));
251 
252 			pte = pte_mkhuge(pte);
253 			pte = arch_make_huge_pte(pte, shift, vma->vm_flags);
254 			if (folio_test_anon(folio))
255 				hugepage_add_anon_rmap(new, vma, pvmw.address,
256 						       rmap_flags);
257 			else
258 				page_dup_file_rmap(new, true);
259 			set_huge_pte_at(vma->vm_mm, pvmw.address, pvmw.pte, pte);
260 		} else
261 #endif
262 		{
263 			if (folio_test_anon(folio))
264 				page_add_anon_rmap(new, vma, pvmw.address,
265 						   rmap_flags);
266 			else
267 				page_add_file_rmap(new, vma, false);
268 			set_pte_at(vma->vm_mm, pvmw.address, pvmw.pte, pte);
269 		}
270 		if (vma->vm_flags & VM_LOCKED)
271 			mlock_drain_local();
272 
273 		trace_remove_migration_pte(pvmw.address, pte_val(pte),
274 					   compound_order(new));
275 
276 		/* No need to invalidate - it was non-present before */
277 		update_mmu_cache(vma, pvmw.address, pvmw.pte);
278 	}
279 
280 	return true;
281 }
282 
283 /*
284  * Get rid of all migration entries and replace them by
285  * references to the indicated page.
286  */
287 void remove_migration_ptes(struct folio *src, struct folio *dst, bool locked)
288 {
289 	struct rmap_walk_control rwc = {
290 		.rmap_one = remove_migration_pte,
291 		.arg = src,
292 	};
293 
294 	if (locked)
295 		rmap_walk_locked(dst, &rwc);
296 	else
297 		rmap_walk(dst, &rwc);
298 }
299 
300 /*
301  * Something used the pte of a page under migration. We need to
302  * get to the page and wait until migration is finished.
303  * When we return from this function the fault will be retried.
304  */
305 void __migration_entry_wait(struct mm_struct *mm, pte_t *ptep,
306 				spinlock_t *ptl)
307 {
308 	pte_t pte;
309 	swp_entry_t entry;
310 
311 	spin_lock(ptl);
312 	pte = *ptep;
313 	if (!is_swap_pte(pte))
314 		goto out;
315 
316 	entry = pte_to_swp_entry(pte);
317 	if (!is_migration_entry(entry))
318 		goto out;
319 
320 	migration_entry_wait_on_locked(entry, ptep, ptl);
321 	return;
322 out:
323 	pte_unmap_unlock(ptep, ptl);
324 }
325 
326 void migration_entry_wait(struct mm_struct *mm, pmd_t *pmd,
327 				unsigned long address)
328 {
329 	spinlock_t *ptl = pte_lockptr(mm, pmd);
330 	pte_t *ptep = pte_offset_map(pmd, address);
331 	__migration_entry_wait(mm, ptep, ptl);
332 }
333 
334 #ifdef CONFIG_HUGETLB_PAGE
335 /*
336  * The vma read lock must be held upon entry. Holding that lock prevents either
337  * the pte or the ptl from being freed.
338  *
339  * This function will release the vma lock before returning.
340  */
341 void __migration_entry_wait_huge(struct vm_area_struct *vma,
342 				 pte_t *ptep, spinlock_t *ptl)
343 {
344 	pte_t pte;
345 
346 	hugetlb_vma_assert_locked(vma);
347 	spin_lock(ptl);
348 	pte = huge_ptep_get(ptep);
349 
350 	if (unlikely(!is_hugetlb_entry_migration(pte))) {
351 		spin_unlock(ptl);
352 		hugetlb_vma_unlock_read(vma);
353 	} else {
354 		/*
355 		 * If migration entry existed, safe to release vma lock
356 		 * here because the pgtable page won't be freed without the
357 		 * pgtable lock released.  See comment right above pgtable
358 		 * lock release in migration_entry_wait_on_locked().
359 		 */
360 		hugetlb_vma_unlock_read(vma);
361 		migration_entry_wait_on_locked(pte_to_swp_entry(pte), NULL, ptl);
362 	}
363 }
364 
365 void migration_entry_wait_huge(struct vm_area_struct *vma, pte_t *pte)
366 {
367 	spinlock_t *ptl = huge_pte_lockptr(hstate_vma(vma), vma->vm_mm, pte);
368 
369 	__migration_entry_wait_huge(vma, pte, ptl);
370 }
371 #endif
372 
373 #ifdef CONFIG_ARCH_ENABLE_THP_MIGRATION
374 void pmd_migration_entry_wait(struct mm_struct *mm, pmd_t *pmd)
375 {
376 	spinlock_t *ptl;
377 
378 	ptl = pmd_lock(mm, pmd);
379 	if (!is_pmd_migration_entry(*pmd))
380 		goto unlock;
381 	migration_entry_wait_on_locked(pmd_to_swp_entry(*pmd), NULL, ptl);
382 	return;
383 unlock:
384 	spin_unlock(ptl);
385 }
386 #endif
387 
388 static int folio_expected_refs(struct address_space *mapping,
389 		struct folio *folio)
390 {
391 	int refs = 1;
392 	if (!mapping)
393 		return refs;
394 
395 	refs += folio_nr_pages(folio);
396 	if (folio_test_private(folio))
397 		refs++;
398 
399 	return refs;
400 }
401 
402 /*
403  * Replace the page in the mapping.
404  *
405  * The number of remaining references must be:
406  * 1 for anonymous pages without a mapping
407  * 2 for pages with a mapping
408  * 3 for pages with a mapping and PagePrivate/PagePrivate2 set.
409  */
410 int folio_migrate_mapping(struct address_space *mapping,
411 		struct folio *newfolio, struct folio *folio, int extra_count)
412 {
413 	XA_STATE(xas, &mapping->i_pages, folio_index(folio));
414 	struct zone *oldzone, *newzone;
415 	int dirty;
416 	int expected_count = folio_expected_refs(mapping, folio) + extra_count;
417 	long nr = folio_nr_pages(folio);
418 
419 	if (!mapping) {
420 		/* Anonymous page without mapping */
421 		if (folio_ref_count(folio) != expected_count)
422 			return -EAGAIN;
423 
424 		/* No turning back from here */
425 		newfolio->index = folio->index;
426 		newfolio->mapping = folio->mapping;
427 		if (folio_test_swapbacked(folio))
428 			__folio_set_swapbacked(newfolio);
429 
430 		return MIGRATEPAGE_SUCCESS;
431 	}
432 
433 	oldzone = folio_zone(folio);
434 	newzone = folio_zone(newfolio);
435 
436 	xas_lock_irq(&xas);
437 	if (!folio_ref_freeze(folio, expected_count)) {
438 		xas_unlock_irq(&xas);
439 		return -EAGAIN;
440 	}
441 
442 	/*
443 	 * Now we know that no one else is looking at the folio:
444 	 * no turning back from here.
445 	 */
446 	newfolio->index = folio->index;
447 	newfolio->mapping = folio->mapping;
448 	folio_ref_add(newfolio, nr); /* add cache reference */
449 	if (folio_test_swapbacked(folio)) {
450 		__folio_set_swapbacked(newfolio);
451 		if (folio_test_swapcache(folio)) {
452 			folio_set_swapcache(newfolio);
453 			newfolio->private = folio_get_private(folio);
454 		}
455 	} else {
456 		VM_BUG_ON_FOLIO(folio_test_swapcache(folio), folio);
457 	}
458 
459 	/* Move dirty while page refs frozen and newpage not yet exposed */
460 	dirty = folio_test_dirty(folio);
461 	if (dirty) {
462 		folio_clear_dirty(folio);
463 		folio_set_dirty(newfolio);
464 	}
465 
466 	xas_store(&xas, newfolio);
467 
468 	/*
469 	 * Drop cache reference from old page by unfreezing
470 	 * to one less reference.
471 	 * We know this isn't the last reference.
472 	 */
473 	folio_ref_unfreeze(folio, expected_count - nr);
474 
475 	xas_unlock(&xas);
476 	/* Leave irq disabled to prevent preemption while updating stats */
477 
478 	/*
479 	 * If moved to a different zone then also account
480 	 * the page for that zone. Other VM counters will be
481 	 * taken care of when we establish references to the
482 	 * new page and drop references to the old page.
483 	 *
484 	 * Note that anonymous pages are accounted for
485 	 * via NR_FILE_PAGES and NR_ANON_MAPPED if they
486 	 * are mapped to swap space.
487 	 */
488 	if (newzone != oldzone) {
489 		struct lruvec *old_lruvec, *new_lruvec;
490 		struct mem_cgroup *memcg;
491 
492 		memcg = folio_memcg(folio);
493 		old_lruvec = mem_cgroup_lruvec(memcg, oldzone->zone_pgdat);
494 		new_lruvec = mem_cgroup_lruvec(memcg, newzone->zone_pgdat);
495 
496 		__mod_lruvec_state(old_lruvec, NR_FILE_PAGES, -nr);
497 		__mod_lruvec_state(new_lruvec, NR_FILE_PAGES, nr);
498 		if (folio_test_swapbacked(folio) && !folio_test_swapcache(folio)) {
499 			__mod_lruvec_state(old_lruvec, NR_SHMEM, -nr);
500 			__mod_lruvec_state(new_lruvec, NR_SHMEM, nr);
501 		}
502 #ifdef CONFIG_SWAP
503 		if (folio_test_swapcache(folio)) {
504 			__mod_lruvec_state(old_lruvec, NR_SWAPCACHE, -nr);
505 			__mod_lruvec_state(new_lruvec, NR_SWAPCACHE, nr);
506 		}
507 #endif
508 		if (dirty && mapping_can_writeback(mapping)) {
509 			__mod_lruvec_state(old_lruvec, NR_FILE_DIRTY, -nr);
510 			__mod_zone_page_state(oldzone, NR_ZONE_WRITE_PENDING, -nr);
511 			__mod_lruvec_state(new_lruvec, NR_FILE_DIRTY, nr);
512 			__mod_zone_page_state(newzone, NR_ZONE_WRITE_PENDING, nr);
513 		}
514 	}
515 	local_irq_enable();
516 
517 	return MIGRATEPAGE_SUCCESS;
518 }
519 EXPORT_SYMBOL(folio_migrate_mapping);
520 
521 /*
522  * The expected number of remaining references is the same as that
523  * of folio_migrate_mapping().
524  */
525 int migrate_huge_page_move_mapping(struct address_space *mapping,
526 				   struct folio *dst, struct folio *src)
527 {
528 	XA_STATE(xas, &mapping->i_pages, folio_index(src));
529 	int expected_count;
530 
531 	xas_lock_irq(&xas);
532 	expected_count = 2 + folio_has_private(src);
533 	if (!folio_ref_freeze(src, expected_count)) {
534 		xas_unlock_irq(&xas);
535 		return -EAGAIN;
536 	}
537 
538 	dst->index = src->index;
539 	dst->mapping = src->mapping;
540 
541 	folio_get(dst);
542 
543 	xas_store(&xas, dst);
544 
545 	folio_ref_unfreeze(src, expected_count - 1);
546 
547 	xas_unlock_irq(&xas);
548 
549 	return MIGRATEPAGE_SUCCESS;
550 }
551 
552 /*
553  * Copy the flags and some other ancillary information
554  */
555 void folio_migrate_flags(struct folio *newfolio, struct folio *folio)
556 {
557 	int cpupid;
558 
559 	if (folio_test_error(folio))
560 		folio_set_error(newfolio);
561 	if (folio_test_referenced(folio))
562 		folio_set_referenced(newfolio);
563 	if (folio_test_uptodate(folio))
564 		folio_mark_uptodate(newfolio);
565 	if (folio_test_clear_active(folio)) {
566 		VM_BUG_ON_FOLIO(folio_test_unevictable(folio), folio);
567 		folio_set_active(newfolio);
568 	} else if (folio_test_clear_unevictable(folio))
569 		folio_set_unevictable(newfolio);
570 	if (folio_test_workingset(folio))
571 		folio_set_workingset(newfolio);
572 	if (folio_test_checked(folio))
573 		folio_set_checked(newfolio);
574 	/*
575 	 * PG_anon_exclusive (-> PG_mappedtodisk) is always migrated via
576 	 * migration entries. We can still have PG_anon_exclusive set on an
577 	 * effectively unmapped and unreferenced first sub-pages of an
578 	 * anonymous THP: we can simply copy it here via PG_mappedtodisk.
579 	 */
580 	if (folio_test_mappedtodisk(folio))
581 		folio_set_mappedtodisk(newfolio);
582 
583 	/* Move dirty on pages not done by folio_migrate_mapping() */
584 	if (folio_test_dirty(folio))
585 		folio_set_dirty(newfolio);
586 
587 	if (folio_test_young(folio))
588 		folio_set_young(newfolio);
589 	if (folio_test_idle(folio))
590 		folio_set_idle(newfolio);
591 
592 	/*
593 	 * Copy NUMA information to the new page, to prevent over-eager
594 	 * future migrations of this same page.
595 	 */
596 	cpupid = page_cpupid_xchg_last(&folio->page, -1);
597 	/*
598 	 * For memory tiering mode, when migrate between slow and fast
599 	 * memory node, reset cpupid, because that is used to record
600 	 * page access time in slow memory node.
601 	 */
602 	if (sysctl_numa_balancing_mode & NUMA_BALANCING_MEMORY_TIERING) {
603 		bool f_toptier = node_is_toptier(page_to_nid(&folio->page));
604 		bool t_toptier = node_is_toptier(page_to_nid(&newfolio->page));
605 
606 		if (f_toptier != t_toptier)
607 			cpupid = -1;
608 	}
609 	page_cpupid_xchg_last(&newfolio->page, cpupid);
610 
611 	folio_migrate_ksm(newfolio, folio);
612 	/*
613 	 * Please do not reorder this without considering how mm/ksm.c's
614 	 * get_ksm_page() depends upon ksm_migrate_page() and PageSwapCache().
615 	 */
616 	if (folio_test_swapcache(folio))
617 		folio_clear_swapcache(folio);
618 	folio_clear_private(folio);
619 
620 	/* page->private contains hugetlb specific flags */
621 	if (!folio_test_hugetlb(folio))
622 		folio->private = NULL;
623 
624 	/*
625 	 * If any waiters have accumulated on the new page then
626 	 * wake them up.
627 	 */
628 	if (folio_test_writeback(newfolio))
629 		folio_end_writeback(newfolio);
630 
631 	/*
632 	 * PG_readahead shares the same bit with PG_reclaim.  The above
633 	 * end_page_writeback() may clear PG_readahead mistakenly, so set the
634 	 * bit after that.
635 	 */
636 	if (folio_test_readahead(folio))
637 		folio_set_readahead(newfolio);
638 
639 	folio_copy_owner(newfolio, folio);
640 
641 	if (!folio_test_hugetlb(folio))
642 		mem_cgroup_migrate(folio, newfolio);
643 }
644 EXPORT_SYMBOL(folio_migrate_flags);
645 
646 void folio_migrate_copy(struct folio *newfolio, struct folio *folio)
647 {
648 	folio_copy(newfolio, folio);
649 	folio_migrate_flags(newfolio, folio);
650 }
651 EXPORT_SYMBOL(folio_migrate_copy);
652 
653 /************************************************************
654  *                    Migration functions
655  ***********************************************************/
656 
657 int migrate_folio_extra(struct address_space *mapping, struct folio *dst,
658 		struct folio *src, enum migrate_mode mode, int extra_count)
659 {
660 	int rc;
661 
662 	BUG_ON(folio_test_writeback(src));	/* Writeback must be complete */
663 
664 	rc = folio_migrate_mapping(mapping, dst, src, extra_count);
665 
666 	if (rc != MIGRATEPAGE_SUCCESS)
667 		return rc;
668 
669 	if (mode != MIGRATE_SYNC_NO_COPY)
670 		folio_migrate_copy(dst, src);
671 	else
672 		folio_migrate_flags(dst, src);
673 	return MIGRATEPAGE_SUCCESS;
674 }
675 
676 /**
677  * migrate_folio() - Simple folio migration.
678  * @mapping: The address_space containing the folio.
679  * @dst: The folio to migrate the data to.
680  * @src: The folio containing the current data.
681  * @mode: How to migrate the page.
682  *
683  * Common logic to directly migrate a single LRU folio suitable for
684  * folios that do not use PagePrivate/PagePrivate2.
685  *
686  * Folios are locked upon entry and exit.
687  */
688 int migrate_folio(struct address_space *mapping, struct folio *dst,
689 		struct folio *src, enum migrate_mode mode)
690 {
691 	return migrate_folio_extra(mapping, dst, src, mode, 0);
692 }
693 EXPORT_SYMBOL(migrate_folio);
694 
695 #ifdef CONFIG_BLOCK
696 /* Returns true if all buffers are successfully locked */
697 static bool buffer_migrate_lock_buffers(struct buffer_head *head,
698 							enum migrate_mode mode)
699 {
700 	struct buffer_head *bh = head;
701 
702 	/* Simple case, sync compaction */
703 	if (mode != MIGRATE_ASYNC) {
704 		do {
705 			lock_buffer(bh);
706 			bh = bh->b_this_page;
707 
708 		} while (bh != head);
709 
710 		return true;
711 	}
712 
713 	/* async case, we cannot block on lock_buffer so use trylock_buffer */
714 	do {
715 		if (!trylock_buffer(bh)) {
716 			/*
717 			 * We failed to lock the buffer and cannot stall in
718 			 * async migration. Release the taken locks
719 			 */
720 			struct buffer_head *failed_bh = bh;
721 			bh = head;
722 			while (bh != failed_bh) {
723 				unlock_buffer(bh);
724 				bh = bh->b_this_page;
725 			}
726 			return false;
727 		}
728 
729 		bh = bh->b_this_page;
730 	} while (bh != head);
731 	return true;
732 }
733 
734 static int __buffer_migrate_folio(struct address_space *mapping,
735 		struct folio *dst, struct folio *src, enum migrate_mode mode,
736 		bool check_refs)
737 {
738 	struct buffer_head *bh, *head;
739 	int rc;
740 	int expected_count;
741 
742 	head = folio_buffers(src);
743 	if (!head)
744 		return migrate_folio(mapping, dst, src, mode);
745 
746 	/* Check whether page does not have extra refs before we do more work */
747 	expected_count = folio_expected_refs(mapping, src);
748 	if (folio_ref_count(src) != expected_count)
749 		return -EAGAIN;
750 
751 	if (!buffer_migrate_lock_buffers(head, mode))
752 		return -EAGAIN;
753 
754 	if (check_refs) {
755 		bool busy;
756 		bool invalidated = false;
757 
758 recheck_buffers:
759 		busy = false;
760 		spin_lock(&mapping->private_lock);
761 		bh = head;
762 		do {
763 			if (atomic_read(&bh->b_count)) {
764 				busy = true;
765 				break;
766 			}
767 			bh = bh->b_this_page;
768 		} while (bh != head);
769 		if (busy) {
770 			if (invalidated) {
771 				rc = -EAGAIN;
772 				goto unlock_buffers;
773 			}
774 			spin_unlock(&mapping->private_lock);
775 			invalidate_bh_lrus();
776 			invalidated = true;
777 			goto recheck_buffers;
778 		}
779 	}
780 
781 	rc = folio_migrate_mapping(mapping, dst, src, 0);
782 	if (rc != MIGRATEPAGE_SUCCESS)
783 		goto unlock_buffers;
784 
785 	folio_attach_private(dst, folio_detach_private(src));
786 
787 	bh = head;
788 	do {
789 		set_bh_page(bh, &dst->page, bh_offset(bh));
790 		bh = bh->b_this_page;
791 	} while (bh != head);
792 
793 	if (mode != MIGRATE_SYNC_NO_COPY)
794 		folio_migrate_copy(dst, src);
795 	else
796 		folio_migrate_flags(dst, src);
797 
798 	rc = MIGRATEPAGE_SUCCESS;
799 unlock_buffers:
800 	if (check_refs)
801 		spin_unlock(&mapping->private_lock);
802 	bh = head;
803 	do {
804 		unlock_buffer(bh);
805 		bh = bh->b_this_page;
806 	} while (bh != head);
807 
808 	return rc;
809 }
810 
811 /**
812  * buffer_migrate_folio() - Migration function for folios with buffers.
813  * @mapping: The address space containing @src.
814  * @dst: The folio to migrate to.
815  * @src: The folio to migrate from.
816  * @mode: How to migrate the folio.
817  *
818  * This function can only be used if the underlying filesystem guarantees
819  * that no other references to @src exist. For example attached buffer
820  * heads are accessed only under the folio lock.  If your filesystem cannot
821  * provide this guarantee, buffer_migrate_folio_norefs() may be more
822  * appropriate.
823  *
824  * Return: 0 on success or a negative errno on failure.
825  */
826 int buffer_migrate_folio(struct address_space *mapping,
827 		struct folio *dst, struct folio *src, enum migrate_mode mode)
828 {
829 	return __buffer_migrate_folio(mapping, dst, src, mode, false);
830 }
831 EXPORT_SYMBOL(buffer_migrate_folio);
832 
833 /**
834  * buffer_migrate_folio_norefs() - Migration function for folios with buffers.
835  * @mapping: The address space containing @src.
836  * @dst: The folio to migrate to.
837  * @src: The folio to migrate from.
838  * @mode: How to migrate the folio.
839  *
840  * Like buffer_migrate_folio() except that this variant is more careful
841  * and checks that there are also no buffer head references. This function
842  * is the right one for mappings where buffer heads are directly looked
843  * up and referenced (such as block device mappings).
844  *
845  * Return: 0 on success or a negative errno on failure.
846  */
847 int buffer_migrate_folio_norefs(struct address_space *mapping,
848 		struct folio *dst, struct folio *src, enum migrate_mode mode)
849 {
850 	return __buffer_migrate_folio(mapping, dst, src, mode, true);
851 }
852 EXPORT_SYMBOL_GPL(buffer_migrate_folio_norefs);
853 #endif
854 
855 int filemap_migrate_folio(struct address_space *mapping,
856 		struct folio *dst, struct folio *src, enum migrate_mode mode)
857 {
858 	int ret;
859 
860 	ret = folio_migrate_mapping(mapping, dst, src, 0);
861 	if (ret != MIGRATEPAGE_SUCCESS)
862 		return ret;
863 
864 	if (folio_get_private(src))
865 		folio_attach_private(dst, folio_detach_private(src));
866 
867 	if (mode != MIGRATE_SYNC_NO_COPY)
868 		folio_migrate_copy(dst, src);
869 	else
870 		folio_migrate_flags(dst, src);
871 	return MIGRATEPAGE_SUCCESS;
872 }
873 EXPORT_SYMBOL_GPL(filemap_migrate_folio);
874 
875 /*
876  * Writeback a folio to clean the dirty state
877  */
878 static int writeout(struct address_space *mapping, struct folio *folio)
879 {
880 	struct writeback_control wbc = {
881 		.sync_mode = WB_SYNC_NONE,
882 		.nr_to_write = 1,
883 		.range_start = 0,
884 		.range_end = LLONG_MAX,
885 		.for_reclaim = 1
886 	};
887 	int rc;
888 
889 	if (!mapping->a_ops->writepage)
890 		/* No write method for the address space */
891 		return -EINVAL;
892 
893 	if (!folio_clear_dirty_for_io(folio))
894 		/* Someone else already triggered a write */
895 		return -EAGAIN;
896 
897 	/*
898 	 * A dirty folio may imply that the underlying filesystem has
899 	 * the folio on some queue. So the folio must be clean for
900 	 * migration. Writeout may mean we lose the lock and the
901 	 * folio state is no longer what we checked for earlier.
902 	 * At this point we know that the migration attempt cannot
903 	 * be successful.
904 	 */
905 	remove_migration_ptes(folio, folio, false);
906 
907 	rc = mapping->a_ops->writepage(&folio->page, &wbc);
908 
909 	if (rc != AOP_WRITEPAGE_ACTIVATE)
910 		/* unlocked. Relock */
911 		folio_lock(folio);
912 
913 	return (rc < 0) ? -EIO : -EAGAIN;
914 }
915 
916 /*
917  * Default handling if a filesystem does not provide a migration function.
918  */
919 static int fallback_migrate_folio(struct address_space *mapping,
920 		struct folio *dst, struct folio *src, enum migrate_mode mode)
921 {
922 	if (folio_test_dirty(src)) {
923 		/* Only writeback folios in full synchronous migration */
924 		switch (mode) {
925 		case MIGRATE_SYNC:
926 		case MIGRATE_SYNC_NO_COPY:
927 			break;
928 		default:
929 			return -EBUSY;
930 		}
931 		return writeout(mapping, src);
932 	}
933 
934 	/*
935 	 * Buffers may be managed in a filesystem specific way.
936 	 * We must have no buffers or drop them.
937 	 */
938 	if (folio_test_private(src) &&
939 	    !filemap_release_folio(src, GFP_KERNEL))
940 		return mode == MIGRATE_SYNC ? -EAGAIN : -EBUSY;
941 
942 	return migrate_folio(mapping, dst, src, mode);
943 }
944 
945 /*
946  * Move a page to a newly allocated page
947  * The page is locked and all ptes have been successfully removed.
948  *
949  * The new page will have replaced the old page if this function
950  * is successful.
951  *
952  * Return value:
953  *   < 0 - error code
954  *  MIGRATEPAGE_SUCCESS - success
955  */
956 static int move_to_new_folio(struct folio *dst, struct folio *src,
957 				enum migrate_mode mode)
958 {
959 	int rc = -EAGAIN;
960 	bool is_lru = !__PageMovable(&src->page);
961 
962 	VM_BUG_ON_FOLIO(!folio_test_locked(src), src);
963 	VM_BUG_ON_FOLIO(!folio_test_locked(dst), dst);
964 
965 	if (likely(is_lru)) {
966 		struct address_space *mapping = folio_mapping(src);
967 
968 		if (!mapping)
969 			rc = migrate_folio(mapping, dst, src, mode);
970 		else if (mapping->a_ops->migrate_folio)
971 			/*
972 			 * Most folios have a mapping and most filesystems
973 			 * provide a migrate_folio callback. Anonymous folios
974 			 * are part of swap space which also has its own
975 			 * migrate_folio callback. This is the most common path
976 			 * for page migration.
977 			 */
978 			rc = mapping->a_ops->migrate_folio(mapping, dst, src,
979 								mode);
980 		else
981 			rc = fallback_migrate_folio(mapping, dst, src, mode);
982 	} else {
983 		const struct movable_operations *mops;
984 
985 		/*
986 		 * In case of non-lru page, it could be released after
987 		 * isolation step. In that case, we shouldn't try migration.
988 		 */
989 		VM_BUG_ON_FOLIO(!folio_test_isolated(src), src);
990 		if (!folio_test_movable(src)) {
991 			rc = MIGRATEPAGE_SUCCESS;
992 			folio_clear_isolated(src);
993 			goto out;
994 		}
995 
996 		mops = folio_movable_ops(src);
997 		rc = mops->migrate_page(&dst->page, &src->page, mode);
998 		WARN_ON_ONCE(rc == MIGRATEPAGE_SUCCESS &&
999 				!folio_test_isolated(src));
1000 	}
1001 
1002 	/*
1003 	 * When successful, old pagecache src->mapping must be cleared before
1004 	 * src is freed; but stats require that PageAnon be left as PageAnon.
1005 	 */
1006 	if (rc == MIGRATEPAGE_SUCCESS) {
1007 		if (__PageMovable(&src->page)) {
1008 			VM_BUG_ON_FOLIO(!folio_test_isolated(src), src);
1009 
1010 			/*
1011 			 * We clear PG_movable under page_lock so any compactor
1012 			 * cannot try to migrate this page.
1013 			 */
1014 			folio_clear_isolated(src);
1015 		}
1016 
1017 		/*
1018 		 * Anonymous and movable src->mapping will be cleared by
1019 		 * free_pages_prepare so don't reset it here for keeping
1020 		 * the type to work PageAnon, for example.
1021 		 */
1022 		if (!folio_mapping_flags(src))
1023 			src->mapping = NULL;
1024 
1025 		if (likely(!folio_is_zone_device(dst)))
1026 			flush_dcache_folio(dst);
1027 	}
1028 out:
1029 	return rc;
1030 }
1031 
1032 /*
1033  * To record some information during migration, we use some unused
1034  * fields (mapping and private) of struct folio of the newly allocated
1035  * destination folio.  This is safe because nobody is using them
1036  * except us.
1037  */
1038 union migration_ptr {
1039 	struct anon_vma *anon_vma;
1040 	struct address_space *mapping;
1041 };
1042 static void __migrate_folio_record(struct folio *dst,
1043 				   unsigned long page_was_mapped,
1044 				   struct anon_vma *anon_vma)
1045 {
1046 	union migration_ptr ptr = { .anon_vma = anon_vma };
1047 	dst->mapping = ptr.mapping;
1048 	dst->private = (void *)page_was_mapped;
1049 }
1050 
1051 static void __migrate_folio_extract(struct folio *dst,
1052 				   int *page_was_mappedp,
1053 				   struct anon_vma **anon_vmap)
1054 {
1055 	union migration_ptr ptr = { .mapping = dst->mapping };
1056 	*anon_vmap = ptr.anon_vma;
1057 	*page_was_mappedp = (unsigned long)dst->private;
1058 	dst->mapping = NULL;
1059 	dst->private = NULL;
1060 }
1061 
1062 /* Restore the source folio to the original state upon failure */
1063 static void migrate_folio_undo_src(struct folio *src,
1064 				   int page_was_mapped,
1065 				   struct anon_vma *anon_vma,
1066 				   bool locked,
1067 				   struct list_head *ret)
1068 {
1069 	if (page_was_mapped)
1070 		remove_migration_ptes(src, src, false);
1071 	/* Drop an anon_vma reference if we took one */
1072 	if (anon_vma)
1073 		put_anon_vma(anon_vma);
1074 	if (locked)
1075 		folio_unlock(src);
1076 	if (ret)
1077 		list_move_tail(&src->lru, ret);
1078 }
1079 
1080 /* Restore the destination folio to the original state upon failure */
1081 static void migrate_folio_undo_dst(struct folio *dst,
1082 				   bool locked,
1083 				   free_page_t put_new_page,
1084 				   unsigned long private)
1085 {
1086 	if (locked)
1087 		folio_unlock(dst);
1088 	if (put_new_page)
1089 		put_new_page(&dst->page, private);
1090 	else
1091 		folio_put(dst);
1092 }
1093 
1094 /* Cleanup src folio upon migration success */
1095 static void migrate_folio_done(struct folio *src,
1096 			       enum migrate_reason reason)
1097 {
1098 	/*
1099 	 * Compaction can migrate also non-LRU pages which are
1100 	 * not accounted to NR_ISOLATED_*. They can be recognized
1101 	 * as __PageMovable
1102 	 */
1103 	if (likely(!__folio_test_movable(src)))
1104 		mod_node_page_state(folio_pgdat(src), NR_ISOLATED_ANON +
1105 				    folio_is_file_lru(src), -folio_nr_pages(src));
1106 
1107 	if (reason != MR_MEMORY_FAILURE)
1108 		/* We release the page in page_handle_poison. */
1109 		folio_put(src);
1110 }
1111 
1112 /* Obtain the lock on page, remove all ptes. */
1113 static int migrate_folio_unmap(new_page_t get_new_page, free_page_t put_new_page,
1114 			       unsigned long private, struct folio *src,
1115 			       struct folio **dstp, int force,
1116 			       enum migrate_mode mode, enum migrate_reason reason,
1117 			       struct list_head *ret)
1118 {
1119 	struct folio *dst;
1120 	int rc = -EAGAIN;
1121 	struct page *newpage = NULL;
1122 	int page_was_mapped = 0;
1123 	struct anon_vma *anon_vma = NULL;
1124 	bool is_lru = !__PageMovable(&src->page);
1125 	bool locked = false;
1126 	bool dst_locked = false;
1127 
1128 	if (folio_ref_count(src) == 1) {
1129 		/* Folio was freed from under us. So we are done. */
1130 		folio_clear_active(src);
1131 		folio_clear_unevictable(src);
1132 		/* free_pages_prepare() will clear PG_isolated. */
1133 		list_del(&src->lru);
1134 		migrate_folio_done(src, reason);
1135 		return MIGRATEPAGE_SUCCESS;
1136 	}
1137 
1138 	newpage = get_new_page(&src->page, private);
1139 	if (!newpage)
1140 		return -ENOMEM;
1141 	dst = page_folio(newpage);
1142 	*dstp = dst;
1143 
1144 	dst->private = NULL;
1145 
1146 	if (!folio_trylock(src)) {
1147 		if (!force || mode == MIGRATE_ASYNC)
1148 			goto out;
1149 
1150 		/*
1151 		 * It's not safe for direct compaction to call lock_page.
1152 		 * For example, during page readahead pages are added locked
1153 		 * to the LRU. Later, when the IO completes the pages are
1154 		 * marked uptodate and unlocked. However, the queueing
1155 		 * could be merging multiple pages for one bio (e.g.
1156 		 * mpage_readahead). If an allocation happens for the
1157 		 * second or third page, the process can end up locking
1158 		 * the same page twice and deadlocking. Rather than
1159 		 * trying to be clever about what pages can be locked,
1160 		 * avoid the use of lock_page for direct compaction
1161 		 * altogether.
1162 		 */
1163 		if (current->flags & PF_MEMALLOC)
1164 			goto out;
1165 
1166 		folio_lock(src);
1167 	}
1168 	locked = true;
1169 
1170 	if (folio_test_writeback(src)) {
1171 		/*
1172 		 * Only in the case of a full synchronous migration is it
1173 		 * necessary to wait for PageWriteback. In the async case,
1174 		 * the retry loop is too short and in the sync-light case,
1175 		 * the overhead of stalling is too much
1176 		 */
1177 		switch (mode) {
1178 		case MIGRATE_SYNC:
1179 		case MIGRATE_SYNC_NO_COPY:
1180 			break;
1181 		default:
1182 			rc = -EBUSY;
1183 			goto out;
1184 		}
1185 		if (!force)
1186 			goto out;
1187 		folio_wait_writeback(src);
1188 	}
1189 
1190 	/*
1191 	 * By try_to_migrate(), src->mapcount goes down to 0 here. In this case,
1192 	 * we cannot notice that anon_vma is freed while we migrate a page.
1193 	 * This get_anon_vma() delays freeing anon_vma pointer until the end
1194 	 * of migration. File cache pages are no problem because of page_lock()
1195 	 * File Caches may use write_page() or lock_page() in migration, then,
1196 	 * just care Anon page here.
1197 	 *
1198 	 * Only folio_get_anon_vma() understands the subtleties of
1199 	 * getting a hold on an anon_vma from outside one of its mms.
1200 	 * But if we cannot get anon_vma, then we won't need it anyway,
1201 	 * because that implies that the anon page is no longer mapped
1202 	 * (and cannot be remapped so long as we hold the page lock).
1203 	 */
1204 	if (folio_test_anon(src) && !folio_test_ksm(src))
1205 		anon_vma = folio_get_anon_vma(src);
1206 
1207 	/*
1208 	 * Block others from accessing the new page when we get around to
1209 	 * establishing additional references. We are usually the only one
1210 	 * holding a reference to dst at this point. We used to have a BUG
1211 	 * here if folio_trylock(dst) fails, but would like to allow for
1212 	 * cases where there might be a race with the previous use of dst.
1213 	 * This is much like races on refcount of oldpage: just don't BUG().
1214 	 */
1215 	if (unlikely(!folio_trylock(dst)))
1216 		goto out;
1217 	dst_locked = true;
1218 
1219 	if (unlikely(!is_lru)) {
1220 		__migrate_folio_record(dst, page_was_mapped, anon_vma);
1221 		return MIGRATEPAGE_UNMAP;
1222 	}
1223 
1224 	/*
1225 	 * Corner case handling:
1226 	 * 1. When a new swap-cache page is read into, it is added to the LRU
1227 	 * and treated as swapcache but it has no rmap yet.
1228 	 * Calling try_to_unmap() against a src->mapping==NULL page will
1229 	 * trigger a BUG.  So handle it here.
1230 	 * 2. An orphaned page (see truncate_cleanup_page) might have
1231 	 * fs-private metadata. The page can be picked up due to memory
1232 	 * offlining.  Everywhere else except page reclaim, the page is
1233 	 * invisible to the vm, so the page can not be migrated.  So try to
1234 	 * free the metadata, so the page can be freed.
1235 	 */
1236 	if (!src->mapping) {
1237 		if (folio_test_private(src)) {
1238 			try_to_free_buffers(src);
1239 			goto out;
1240 		}
1241 	} else if (folio_mapped(src)) {
1242 		/* Establish migration ptes */
1243 		VM_BUG_ON_FOLIO(folio_test_anon(src) &&
1244 			       !folio_test_ksm(src) && !anon_vma, src);
1245 		try_to_migrate(src, mode == MIGRATE_ASYNC ? TTU_BATCH_FLUSH : 0);
1246 		page_was_mapped = 1;
1247 	}
1248 
1249 	if (!folio_mapped(src)) {
1250 		__migrate_folio_record(dst, page_was_mapped, anon_vma);
1251 		return MIGRATEPAGE_UNMAP;
1252 	}
1253 
1254 out:
1255 	/*
1256 	 * A folio that has not been unmapped will be restored to
1257 	 * right list unless we want to retry.
1258 	 */
1259 	if (rc == -EAGAIN)
1260 		ret = NULL;
1261 
1262 	migrate_folio_undo_src(src, page_was_mapped, anon_vma, locked, ret);
1263 	migrate_folio_undo_dst(dst, dst_locked, put_new_page, private);
1264 
1265 	return rc;
1266 }
1267 
1268 /* Migrate the folio to the newly allocated folio in dst. */
1269 static int migrate_folio_move(free_page_t put_new_page, unsigned long private,
1270 			      struct folio *src, struct folio *dst,
1271 			      enum migrate_mode mode, enum migrate_reason reason,
1272 			      struct list_head *ret)
1273 {
1274 	int rc;
1275 	int page_was_mapped = 0;
1276 	struct anon_vma *anon_vma = NULL;
1277 	bool is_lru = !__PageMovable(&src->page);
1278 	struct list_head *prev;
1279 
1280 	__migrate_folio_extract(dst, &page_was_mapped, &anon_vma);
1281 	prev = dst->lru.prev;
1282 	list_del(&dst->lru);
1283 
1284 	rc = move_to_new_folio(dst, src, mode);
1285 	if (rc)
1286 		goto out;
1287 
1288 	if (unlikely(!is_lru))
1289 		goto out_unlock_both;
1290 
1291 	/*
1292 	 * When successful, push dst to LRU immediately: so that if it
1293 	 * turns out to be an mlocked page, remove_migration_ptes() will
1294 	 * automatically build up the correct dst->mlock_count for it.
1295 	 *
1296 	 * We would like to do something similar for the old page, when
1297 	 * unsuccessful, and other cases when a page has been temporarily
1298 	 * isolated from the unevictable LRU: but this case is the easiest.
1299 	 */
1300 	folio_add_lru(dst);
1301 	if (page_was_mapped)
1302 		lru_add_drain();
1303 
1304 	if (page_was_mapped)
1305 		remove_migration_ptes(src, dst, false);
1306 
1307 out_unlock_both:
1308 	folio_unlock(dst);
1309 	set_page_owner_migrate_reason(&dst->page, reason);
1310 	/*
1311 	 * If migration is successful, decrease refcount of dst,
1312 	 * which will not free the page because new page owner increased
1313 	 * refcounter.
1314 	 */
1315 	folio_put(dst);
1316 
1317 	/*
1318 	 * A folio that has been migrated has all references removed
1319 	 * and will be freed.
1320 	 */
1321 	list_del(&src->lru);
1322 	/* Drop an anon_vma reference if we took one */
1323 	if (anon_vma)
1324 		put_anon_vma(anon_vma);
1325 	folio_unlock(src);
1326 	migrate_folio_done(src, reason);
1327 
1328 	return rc;
1329 out:
1330 	/*
1331 	 * A folio that has not been migrated will be restored to
1332 	 * right list unless we want to retry.
1333 	 */
1334 	if (rc == -EAGAIN) {
1335 		list_add(&dst->lru, prev);
1336 		__migrate_folio_record(dst, page_was_mapped, anon_vma);
1337 		return rc;
1338 	}
1339 
1340 	migrate_folio_undo_src(src, page_was_mapped, anon_vma, true, ret);
1341 	migrate_folio_undo_dst(dst, true, put_new_page, private);
1342 
1343 	return rc;
1344 }
1345 
1346 /*
1347  * Counterpart of unmap_and_move_page() for hugepage migration.
1348  *
1349  * This function doesn't wait the completion of hugepage I/O
1350  * because there is no race between I/O and migration for hugepage.
1351  * Note that currently hugepage I/O occurs only in direct I/O
1352  * where no lock is held and PG_writeback is irrelevant,
1353  * and writeback status of all subpages are counted in the reference
1354  * count of the head page (i.e. if all subpages of a 2MB hugepage are
1355  * under direct I/O, the reference of the head page is 512 and a bit more.)
1356  * This means that when we try to migrate hugepage whose subpages are
1357  * doing direct I/O, some references remain after try_to_unmap() and
1358  * hugepage migration fails without data corruption.
1359  *
1360  * There is also no race when direct I/O is issued on the page under migration,
1361  * because then pte is replaced with migration swap entry and direct I/O code
1362  * will wait in the page fault for migration to complete.
1363  */
1364 static int unmap_and_move_huge_page(new_page_t get_new_page,
1365 				free_page_t put_new_page, unsigned long private,
1366 				struct page *hpage, int force,
1367 				enum migrate_mode mode, int reason,
1368 				struct list_head *ret)
1369 {
1370 	struct folio *dst, *src = page_folio(hpage);
1371 	int rc = -EAGAIN;
1372 	int page_was_mapped = 0;
1373 	struct page *new_hpage;
1374 	struct anon_vma *anon_vma = NULL;
1375 	struct address_space *mapping = NULL;
1376 
1377 	if (folio_ref_count(src) == 1) {
1378 		/* page was freed from under us. So we are done. */
1379 		folio_putback_active_hugetlb(src);
1380 		return MIGRATEPAGE_SUCCESS;
1381 	}
1382 
1383 	new_hpage = get_new_page(hpage, private);
1384 	if (!new_hpage)
1385 		return -ENOMEM;
1386 	dst = page_folio(new_hpage);
1387 
1388 	if (!folio_trylock(src)) {
1389 		if (!force)
1390 			goto out;
1391 		switch (mode) {
1392 		case MIGRATE_SYNC:
1393 		case MIGRATE_SYNC_NO_COPY:
1394 			break;
1395 		default:
1396 			goto out;
1397 		}
1398 		folio_lock(src);
1399 	}
1400 
1401 	/*
1402 	 * Check for pages which are in the process of being freed.  Without
1403 	 * folio_mapping() set, hugetlbfs specific move page routine will not
1404 	 * be called and we could leak usage counts for subpools.
1405 	 */
1406 	if (hugetlb_folio_subpool(src) && !folio_mapping(src)) {
1407 		rc = -EBUSY;
1408 		goto out_unlock;
1409 	}
1410 
1411 	if (folio_test_anon(src))
1412 		anon_vma = folio_get_anon_vma(src);
1413 
1414 	if (unlikely(!folio_trylock(dst)))
1415 		goto put_anon;
1416 
1417 	if (folio_mapped(src)) {
1418 		enum ttu_flags ttu = 0;
1419 
1420 		if (!folio_test_anon(src)) {
1421 			/*
1422 			 * In shared mappings, try_to_unmap could potentially
1423 			 * call huge_pmd_unshare.  Because of this, take
1424 			 * semaphore in write mode here and set TTU_RMAP_LOCKED
1425 			 * to let lower levels know we have taken the lock.
1426 			 */
1427 			mapping = hugetlb_page_mapping_lock_write(hpage);
1428 			if (unlikely(!mapping))
1429 				goto unlock_put_anon;
1430 
1431 			ttu = TTU_RMAP_LOCKED;
1432 		}
1433 
1434 		try_to_migrate(src, ttu);
1435 		page_was_mapped = 1;
1436 
1437 		if (ttu & TTU_RMAP_LOCKED)
1438 			i_mmap_unlock_write(mapping);
1439 	}
1440 
1441 	if (!folio_mapped(src))
1442 		rc = move_to_new_folio(dst, src, mode);
1443 
1444 	if (page_was_mapped)
1445 		remove_migration_ptes(src,
1446 			rc == MIGRATEPAGE_SUCCESS ? dst : src, false);
1447 
1448 unlock_put_anon:
1449 	folio_unlock(dst);
1450 
1451 put_anon:
1452 	if (anon_vma)
1453 		put_anon_vma(anon_vma);
1454 
1455 	if (rc == MIGRATEPAGE_SUCCESS) {
1456 		move_hugetlb_state(src, dst, reason);
1457 		put_new_page = NULL;
1458 	}
1459 
1460 out_unlock:
1461 	folio_unlock(src);
1462 out:
1463 	if (rc == MIGRATEPAGE_SUCCESS)
1464 		folio_putback_active_hugetlb(src);
1465 	else if (rc != -EAGAIN)
1466 		list_move_tail(&src->lru, ret);
1467 
1468 	/*
1469 	 * If migration was not successful and there's a freeing callback, use
1470 	 * it.  Otherwise, put_page() will drop the reference grabbed during
1471 	 * isolation.
1472 	 */
1473 	if (put_new_page)
1474 		put_new_page(new_hpage, private);
1475 	else
1476 		folio_putback_active_hugetlb(dst);
1477 
1478 	return rc;
1479 }
1480 
1481 static inline int try_split_folio(struct folio *folio, struct list_head *split_folios)
1482 {
1483 	int rc;
1484 
1485 	folio_lock(folio);
1486 	rc = split_folio_to_list(folio, split_folios);
1487 	folio_unlock(folio);
1488 	if (!rc)
1489 		list_move_tail(&folio->lru, split_folios);
1490 
1491 	return rc;
1492 }
1493 
1494 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1495 #define NR_MAX_BATCHED_MIGRATION	HPAGE_PMD_NR
1496 #else
1497 #define NR_MAX_BATCHED_MIGRATION	512
1498 #endif
1499 #define NR_MAX_MIGRATE_PAGES_RETRY	10
1500 
1501 struct migrate_pages_stats {
1502 	int nr_succeeded;	/* Normal and large folios migrated successfully, in
1503 				   units of base pages */
1504 	int nr_failed_pages;	/* Normal and large folios failed to be migrated, in
1505 				   units of base pages.  Untried folios aren't counted */
1506 	int nr_thp_succeeded;	/* THP migrated successfully */
1507 	int nr_thp_failed;	/* THP failed to be migrated */
1508 	int nr_thp_split;	/* THP split before migrating */
1509 };
1510 
1511 /*
1512  * Returns the number of hugetlb folios that were not migrated, or an error code
1513  * after NR_MAX_MIGRATE_PAGES_RETRY attempts or if no hugetlb folios are movable
1514  * any more because the list has become empty or no retryable hugetlb folios
1515  * exist any more. It is caller's responsibility to call putback_movable_pages()
1516  * only if ret != 0.
1517  */
1518 static int migrate_hugetlbs(struct list_head *from, new_page_t get_new_page,
1519 			    free_page_t put_new_page, unsigned long private,
1520 			    enum migrate_mode mode, int reason,
1521 			    struct migrate_pages_stats *stats,
1522 			    struct list_head *ret_folios)
1523 {
1524 	int retry = 1;
1525 	int nr_failed = 0;
1526 	int nr_retry_pages = 0;
1527 	int pass = 0;
1528 	struct folio *folio, *folio2;
1529 	int rc, nr_pages;
1530 
1531 	for (pass = 0; pass < NR_MAX_MIGRATE_PAGES_RETRY && retry; pass++) {
1532 		retry = 0;
1533 		nr_retry_pages = 0;
1534 
1535 		list_for_each_entry_safe(folio, folio2, from, lru) {
1536 			if (!folio_test_hugetlb(folio))
1537 				continue;
1538 
1539 			nr_pages = folio_nr_pages(folio);
1540 
1541 			cond_resched();
1542 
1543 			/*
1544 			 * Migratability of hugepages depends on architectures and
1545 			 * their size.  This check is necessary because some callers
1546 			 * of hugepage migration like soft offline and memory
1547 			 * hotremove don't walk through page tables or check whether
1548 			 * the hugepage is pmd-based or not before kicking migration.
1549 			 */
1550 			if (!hugepage_migration_supported(folio_hstate(folio))) {
1551 				nr_failed++;
1552 				stats->nr_failed_pages += nr_pages;
1553 				list_move_tail(&folio->lru, ret_folios);
1554 				continue;
1555 			}
1556 
1557 			rc = unmap_and_move_huge_page(get_new_page,
1558 						      put_new_page, private,
1559 						      &folio->page, pass > 2, mode,
1560 						      reason, ret_folios);
1561 			/*
1562 			 * The rules are:
1563 			 *	Success: hugetlb folio will be put back
1564 			 *	-EAGAIN: stay on the from list
1565 			 *	-ENOMEM: stay on the from list
1566 			 *	Other errno: put on ret_folios list
1567 			 */
1568 			switch(rc) {
1569 			case -ENOMEM:
1570 				/*
1571 				 * When memory is low, don't bother to try to migrate
1572 				 * other folios, just exit.
1573 				 */
1574 				stats->nr_failed_pages += nr_pages + nr_retry_pages;
1575 				return -ENOMEM;
1576 			case -EAGAIN:
1577 				retry++;
1578 				nr_retry_pages += nr_pages;
1579 				break;
1580 			case MIGRATEPAGE_SUCCESS:
1581 				stats->nr_succeeded += nr_pages;
1582 				break;
1583 			default:
1584 				/*
1585 				 * Permanent failure (-EBUSY, etc.):
1586 				 * unlike -EAGAIN case, the failed folio is
1587 				 * removed from migration folio list and not
1588 				 * retried in the next outer loop.
1589 				 */
1590 				nr_failed++;
1591 				stats->nr_failed_pages += nr_pages;
1592 				break;
1593 			}
1594 		}
1595 	}
1596 	/*
1597 	 * nr_failed is number of hugetlb folios failed to be migrated.  After
1598 	 * NR_MAX_MIGRATE_PAGES_RETRY attempts, give up and count retried hugetlb
1599 	 * folios as failed.
1600 	 */
1601 	nr_failed += retry;
1602 	stats->nr_failed_pages += nr_retry_pages;
1603 
1604 	return nr_failed;
1605 }
1606 
1607 /*
1608  * migrate_pages_batch() first unmaps folios in the from list as many as
1609  * possible, then move the unmapped folios.
1610  *
1611  * We only batch migration if mode == MIGRATE_ASYNC to avoid to wait a
1612  * lock or bit when we have locked more than one folio.  Which may cause
1613  * deadlock (e.g., for loop device).  So, if mode != MIGRATE_ASYNC, the
1614  * length of the from list must be <= 1.
1615  */
1616 static int migrate_pages_batch(struct list_head *from, new_page_t get_new_page,
1617 		free_page_t put_new_page, unsigned long private,
1618 		enum migrate_mode mode, int reason, struct list_head *ret_folios,
1619 		struct list_head *split_folios, struct migrate_pages_stats *stats,
1620 		int nr_pass)
1621 {
1622 	int retry = 1;
1623 	int large_retry = 1;
1624 	int thp_retry = 1;
1625 	int nr_failed = 0;
1626 	int nr_retry_pages = 0;
1627 	int nr_large_failed = 0;
1628 	int pass = 0;
1629 	bool is_large = false;
1630 	bool is_thp = false;
1631 	struct folio *folio, *folio2, *dst = NULL, *dst2;
1632 	int rc, rc_saved = 0, nr_pages;
1633 	LIST_HEAD(unmap_folios);
1634 	LIST_HEAD(dst_folios);
1635 	bool nosplit = (reason == MR_NUMA_MISPLACED);
1636 
1637 	VM_WARN_ON_ONCE(mode != MIGRATE_ASYNC &&
1638 			!list_empty(from) && !list_is_singular(from));
1639 
1640 	for (pass = 0; pass < nr_pass && (retry || large_retry); pass++) {
1641 		retry = 0;
1642 		large_retry = 0;
1643 		thp_retry = 0;
1644 		nr_retry_pages = 0;
1645 
1646 		list_for_each_entry_safe(folio, folio2, from, lru) {
1647 			/*
1648 			 * Large folio statistics is based on the source large
1649 			 * folio. Capture required information that might get
1650 			 * lost during migration.
1651 			 */
1652 			is_large = folio_test_large(folio);
1653 			is_thp = is_large && folio_test_pmd_mappable(folio);
1654 			nr_pages = folio_nr_pages(folio);
1655 
1656 			cond_resched();
1657 
1658 			/*
1659 			 * Large folio migration might be unsupported or
1660 			 * the allocation might be failed so we should retry
1661 			 * on the same folio with the large folio split
1662 			 * to normal folios.
1663 			 *
1664 			 * Split folios are put in split_folios, and
1665 			 * we will migrate them after the rest of the
1666 			 * list is processed.
1667 			 */
1668 			if (!thp_migration_supported() && is_thp) {
1669 				nr_large_failed++;
1670 				stats->nr_thp_failed++;
1671 				if (!try_split_folio(folio, split_folios)) {
1672 					stats->nr_thp_split++;
1673 					continue;
1674 				}
1675 				stats->nr_failed_pages += nr_pages;
1676 				list_move_tail(&folio->lru, ret_folios);
1677 				continue;
1678 			}
1679 
1680 			rc = migrate_folio_unmap(get_new_page, put_new_page, private,
1681 						 folio, &dst, pass > 2, mode,
1682 						 reason, ret_folios);
1683 			/*
1684 			 * The rules are:
1685 			 *	Success: folio will be freed
1686 			 *	Unmap: folio will be put on unmap_folios list,
1687 			 *	       dst folio put on dst_folios list
1688 			 *	-EAGAIN: stay on the from list
1689 			 *	-ENOMEM: stay on the from list
1690 			 *	Other errno: put on ret_folios list
1691 			 */
1692 			switch(rc) {
1693 			case -ENOMEM:
1694 				/*
1695 				 * When memory is low, don't bother to try to migrate
1696 				 * other folios, move unmapped folios, then exit.
1697 				 */
1698 				if (is_large) {
1699 					nr_large_failed++;
1700 					stats->nr_thp_failed += is_thp;
1701 					/* Large folio NUMA faulting doesn't split to retry. */
1702 					if (!nosplit) {
1703 						int ret = try_split_folio(folio, split_folios);
1704 
1705 						if (!ret) {
1706 							stats->nr_thp_split += is_thp;
1707 							break;
1708 						} else if (reason == MR_LONGTERM_PIN &&
1709 							   ret == -EAGAIN) {
1710 							/*
1711 							 * Try again to split large folio to
1712 							 * mitigate the failure of longterm pinning.
1713 							 */
1714 							large_retry++;
1715 							thp_retry += is_thp;
1716 							nr_retry_pages += nr_pages;
1717 							break;
1718 						}
1719 					}
1720 				} else {
1721 					nr_failed++;
1722 				}
1723 
1724 				stats->nr_failed_pages += nr_pages + nr_retry_pages;
1725 				/* nr_failed isn't updated for not used */
1726 				nr_large_failed += large_retry;
1727 				stats->nr_thp_failed += thp_retry;
1728 				rc_saved = rc;
1729 				if (list_empty(&unmap_folios))
1730 					goto out;
1731 				else
1732 					goto move;
1733 			case -EAGAIN:
1734 				if (is_large) {
1735 					large_retry++;
1736 					thp_retry += is_thp;
1737 				} else {
1738 					retry++;
1739 				}
1740 				nr_retry_pages += nr_pages;
1741 				break;
1742 			case MIGRATEPAGE_SUCCESS:
1743 				stats->nr_succeeded += nr_pages;
1744 				stats->nr_thp_succeeded += is_thp;
1745 				break;
1746 			case MIGRATEPAGE_UNMAP:
1747 				list_move_tail(&folio->lru, &unmap_folios);
1748 				list_add_tail(&dst->lru, &dst_folios);
1749 				break;
1750 			default:
1751 				/*
1752 				 * Permanent failure (-EBUSY, etc.):
1753 				 * unlike -EAGAIN case, the failed folio is
1754 				 * removed from migration folio list and not
1755 				 * retried in the next outer loop.
1756 				 */
1757 				if (is_large) {
1758 					nr_large_failed++;
1759 					stats->nr_thp_failed += is_thp;
1760 				} else {
1761 					nr_failed++;
1762 				}
1763 
1764 				stats->nr_failed_pages += nr_pages;
1765 				break;
1766 			}
1767 		}
1768 	}
1769 	nr_failed += retry;
1770 	nr_large_failed += large_retry;
1771 	stats->nr_thp_failed += thp_retry;
1772 	stats->nr_failed_pages += nr_retry_pages;
1773 move:
1774 	/* Flush TLBs for all unmapped folios */
1775 	try_to_unmap_flush();
1776 
1777 	retry = 1;
1778 	for (pass = 0; pass < nr_pass && (retry || large_retry); pass++) {
1779 		retry = 0;
1780 		large_retry = 0;
1781 		thp_retry = 0;
1782 		nr_retry_pages = 0;
1783 
1784 		dst = list_first_entry(&dst_folios, struct folio, lru);
1785 		dst2 = list_next_entry(dst, lru);
1786 		list_for_each_entry_safe(folio, folio2, &unmap_folios, lru) {
1787 			is_large = folio_test_large(folio);
1788 			is_thp = is_large && folio_test_pmd_mappable(folio);
1789 			nr_pages = folio_nr_pages(folio);
1790 
1791 			cond_resched();
1792 
1793 			rc = migrate_folio_move(put_new_page, private,
1794 						folio, dst, mode,
1795 						reason, ret_folios);
1796 			/*
1797 			 * The rules are:
1798 			 *	Success: folio will be freed
1799 			 *	-EAGAIN: stay on the unmap_folios list
1800 			 *	Other errno: put on ret_folios list
1801 			 */
1802 			switch(rc) {
1803 			case -EAGAIN:
1804 				if (is_large) {
1805 					large_retry++;
1806 					thp_retry += is_thp;
1807 				} else {
1808 					retry++;
1809 				}
1810 				nr_retry_pages += nr_pages;
1811 				break;
1812 			case MIGRATEPAGE_SUCCESS:
1813 				stats->nr_succeeded += nr_pages;
1814 				stats->nr_thp_succeeded += is_thp;
1815 				break;
1816 			default:
1817 				if (is_large) {
1818 					nr_large_failed++;
1819 					stats->nr_thp_failed += is_thp;
1820 				} else {
1821 					nr_failed++;
1822 				}
1823 
1824 				stats->nr_failed_pages += nr_pages;
1825 				break;
1826 			}
1827 			dst = dst2;
1828 			dst2 = list_next_entry(dst, lru);
1829 		}
1830 	}
1831 	nr_failed += retry;
1832 	nr_large_failed += large_retry;
1833 	stats->nr_thp_failed += thp_retry;
1834 	stats->nr_failed_pages += nr_retry_pages;
1835 
1836 	if (rc_saved)
1837 		rc = rc_saved;
1838 	else
1839 		rc = nr_failed + nr_large_failed;
1840 out:
1841 	/* Cleanup remaining folios */
1842 	dst = list_first_entry(&dst_folios, struct folio, lru);
1843 	dst2 = list_next_entry(dst, lru);
1844 	list_for_each_entry_safe(folio, folio2, &unmap_folios, lru) {
1845 		int page_was_mapped = 0;
1846 		struct anon_vma *anon_vma = NULL;
1847 
1848 		__migrate_folio_extract(dst, &page_was_mapped, &anon_vma);
1849 		migrate_folio_undo_src(folio, page_was_mapped, anon_vma,
1850 				       true, ret_folios);
1851 		list_del(&dst->lru);
1852 		migrate_folio_undo_dst(dst, true, put_new_page, private);
1853 		dst = dst2;
1854 		dst2 = list_next_entry(dst, lru);
1855 	}
1856 
1857 	return rc;
1858 }
1859 
1860 /*
1861  * migrate_pages - migrate the folios specified in a list, to the free folios
1862  *		   supplied as the target for the page migration
1863  *
1864  * @from:		The list of folios to be migrated.
1865  * @get_new_page:	The function used to allocate free folios to be used
1866  *			as the target of the folio migration.
1867  * @put_new_page:	The function used to free target folios if migration
1868  *			fails, or NULL if no special handling is necessary.
1869  * @private:		Private data to be passed on to get_new_page()
1870  * @mode:		The migration mode that specifies the constraints for
1871  *			folio migration, if any.
1872  * @reason:		The reason for folio migration.
1873  * @ret_succeeded:	Set to the number of folios migrated successfully if
1874  *			the caller passes a non-NULL pointer.
1875  *
1876  * The function returns after NR_MAX_MIGRATE_PAGES_RETRY attempts or if no folios
1877  * are movable any more because the list has become empty or no retryable folios
1878  * exist any more. It is caller's responsibility to call putback_movable_pages()
1879  * only if ret != 0.
1880  *
1881  * Returns the number of {normal folio, large folio, hugetlb} that were not
1882  * migrated, or an error code. The number of large folio splits will be
1883  * considered as the number of non-migrated large folio, no matter how many
1884  * split folios of the large folio are migrated successfully.
1885  */
1886 int migrate_pages(struct list_head *from, new_page_t get_new_page,
1887 		free_page_t put_new_page, unsigned long private,
1888 		enum migrate_mode mode, int reason, unsigned int *ret_succeeded)
1889 {
1890 	int rc, rc_gather;
1891 	int nr_pages, batch;
1892 	struct folio *folio, *folio2;
1893 	LIST_HEAD(folios);
1894 	LIST_HEAD(ret_folios);
1895 	LIST_HEAD(split_folios);
1896 	struct migrate_pages_stats stats;
1897 
1898 	trace_mm_migrate_pages_start(mode, reason);
1899 
1900 	memset(&stats, 0, sizeof(stats));
1901 
1902 	rc_gather = migrate_hugetlbs(from, get_new_page, put_new_page, private,
1903 				     mode, reason, &stats, &ret_folios);
1904 	if (rc_gather < 0)
1905 		goto out;
1906 
1907 	if (mode == MIGRATE_ASYNC)
1908 		batch = NR_MAX_BATCHED_MIGRATION;
1909 	else
1910 		batch = 1;
1911 again:
1912 	nr_pages = 0;
1913 	list_for_each_entry_safe(folio, folio2, from, lru) {
1914 		/* Retried hugetlb folios will be kept in list  */
1915 		if (folio_test_hugetlb(folio)) {
1916 			list_move_tail(&folio->lru, &ret_folios);
1917 			continue;
1918 		}
1919 
1920 		nr_pages += folio_nr_pages(folio);
1921 		if (nr_pages >= batch)
1922 			break;
1923 	}
1924 	if (nr_pages >= batch)
1925 		list_cut_before(&folios, from, &folio2->lru);
1926 	else
1927 		list_splice_init(from, &folios);
1928 	rc = migrate_pages_batch(&folios, get_new_page, put_new_page, private,
1929 				 mode, reason, &ret_folios, &split_folios, &stats,
1930 				 NR_MAX_MIGRATE_PAGES_RETRY);
1931 	list_splice_tail_init(&folios, &ret_folios);
1932 	if (rc < 0) {
1933 		rc_gather = rc;
1934 		list_splice_tail(&split_folios, &ret_folios);
1935 		goto out;
1936 	}
1937 	if (!list_empty(&split_folios)) {
1938 		/*
1939 		 * Failure isn't counted since all split folios of a large folio
1940 		 * is counted as 1 failure already.  And, we only try to migrate
1941 		 * with minimal effort, force MIGRATE_ASYNC mode and retry once.
1942 		 */
1943 		migrate_pages_batch(&split_folios, get_new_page, put_new_page, private,
1944 				    MIGRATE_ASYNC, reason, &ret_folios, NULL, &stats, 1);
1945 		list_splice_tail_init(&split_folios, &ret_folios);
1946 	}
1947 	rc_gather += rc;
1948 	if (!list_empty(from))
1949 		goto again;
1950 out:
1951 	/*
1952 	 * Put the permanent failure folio back to migration list, they
1953 	 * will be put back to the right list by the caller.
1954 	 */
1955 	list_splice(&ret_folios, from);
1956 
1957 	/*
1958 	 * Return 0 in case all split folios of fail-to-migrate large folios
1959 	 * are migrated successfully.
1960 	 */
1961 	if (list_empty(from))
1962 		rc_gather = 0;
1963 
1964 	count_vm_events(PGMIGRATE_SUCCESS, stats.nr_succeeded);
1965 	count_vm_events(PGMIGRATE_FAIL, stats.nr_failed_pages);
1966 	count_vm_events(THP_MIGRATION_SUCCESS, stats.nr_thp_succeeded);
1967 	count_vm_events(THP_MIGRATION_FAIL, stats.nr_thp_failed);
1968 	count_vm_events(THP_MIGRATION_SPLIT, stats.nr_thp_split);
1969 	trace_mm_migrate_pages(stats.nr_succeeded, stats.nr_failed_pages,
1970 			       stats.nr_thp_succeeded, stats.nr_thp_failed,
1971 			       stats.nr_thp_split, mode, reason);
1972 
1973 	if (ret_succeeded)
1974 		*ret_succeeded = stats.nr_succeeded;
1975 
1976 	return rc_gather;
1977 }
1978 
1979 struct page *alloc_migration_target(struct page *page, unsigned long private)
1980 {
1981 	struct folio *folio = page_folio(page);
1982 	struct migration_target_control *mtc;
1983 	gfp_t gfp_mask;
1984 	unsigned int order = 0;
1985 	struct folio *hugetlb_folio = NULL;
1986 	struct folio *new_folio = NULL;
1987 	int nid;
1988 	int zidx;
1989 
1990 	mtc = (struct migration_target_control *)private;
1991 	gfp_mask = mtc->gfp_mask;
1992 	nid = mtc->nid;
1993 	if (nid == NUMA_NO_NODE)
1994 		nid = folio_nid(folio);
1995 
1996 	if (folio_test_hugetlb(folio)) {
1997 		struct hstate *h = folio_hstate(folio);
1998 
1999 		gfp_mask = htlb_modify_alloc_mask(h, gfp_mask);
2000 		hugetlb_folio = alloc_hugetlb_folio_nodemask(h, nid,
2001 						mtc->nmask, gfp_mask);
2002 		return &hugetlb_folio->page;
2003 	}
2004 
2005 	if (folio_test_large(folio)) {
2006 		/*
2007 		 * clear __GFP_RECLAIM to make the migration callback
2008 		 * consistent with regular THP allocations.
2009 		 */
2010 		gfp_mask &= ~__GFP_RECLAIM;
2011 		gfp_mask |= GFP_TRANSHUGE;
2012 		order = folio_order(folio);
2013 	}
2014 	zidx = zone_idx(folio_zone(folio));
2015 	if (is_highmem_idx(zidx) || zidx == ZONE_MOVABLE)
2016 		gfp_mask |= __GFP_HIGHMEM;
2017 
2018 	new_folio = __folio_alloc(gfp_mask, order, nid, mtc->nmask);
2019 
2020 	return &new_folio->page;
2021 }
2022 
2023 #ifdef CONFIG_NUMA
2024 
2025 static int store_status(int __user *status, int start, int value, int nr)
2026 {
2027 	while (nr-- > 0) {
2028 		if (put_user(value, status + start))
2029 			return -EFAULT;
2030 		start++;
2031 	}
2032 
2033 	return 0;
2034 }
2035 
2036 static int do_move_pages_to_node(struct mm_struct *mm,
2037 		struct list_head *pagelist, int node)
2038 {
2039 	int err;
2040 	struct migration_target_control mtc = {
2041 		.nid = node,
2042 		.gfp_mask = GFP_HIGHUSER_MOVABLE | __GFP_THISNODE,
2043 	};
2044 
2045 	err = migrate_pages(pagelist, alloc_migration_target, NULL,
2046 		(unsigned long)&mtc, MIGRATE_SYNC, MR_SYSCALL, NULL);
2047 	if (err)
2048 		putback_movable_pages(pagelist);
2049 	return err;
2050 }
2051 
2052 /*
2053  * Resolves the given address to a struct page, isolates it from the LRU and
2054  * puts it to the given pagelist.
2055  * Returns:
2056  *     errno - if the page cannot be found/isolated
2057  *     0 - when it doesn't have to be migrated because it is already on the
2058  *         target node
2059  *     1 - when it has been queued
2060  */
2061 static int add_page_for_migration(struct mm_struct *mm, unsigned long addr,
2062 		int node, struct list_head *pagelist, bool migrate_all)
2063 {
2064 	struct vm_area_struct *vma;
2065 	struct page *page;
2066 	int err;
2067 	bool isolated;
2068 
2069 	mmap_read_lock(mm);
2070 	err = -EFAULT;
2071 	vma = vma_lookup(mm, addr);
2072 	if (!vma || !vma_migratable(vma))
2073 		goto out;
2074 
2075 	/* FOLL_DUMP to ignore special (like zero) pages */
2076 	page = follow_page(vma, addr, FOLL_GET | FOLL_DUMP);
2077 
2078 	err = PTR_ERR(page);
2079 	if (IS_ERR(page))
2080 		goto out;
2081 
2082 	err = -ENOENT;
2083 	if (!page)
2084 		goto out;
2085 
2086 	if (is_zone_device_page(page))
2087 		goto out_putpage;
2088 
2089 	err = 0;
2090 	if (page_to_nid(page) == node)
2091 		goto out_putpage;
2092 
2093 	err = -EACCES;
2094 	if (page_mapcount(page) > 1 && !migrate_all)
2095 		goto out_putpage;
2096 
2097 	if (PageHuge(page)) {
2098 		if (PageHead(page)) {
2099 			isolated = isolate_hugetlb(page_folio(page), pagelist);
2100 			err = isolated ? 1 : -EBUSY;
2101 		}
2102 	} else {
2103 		struct page *head;
2104 
2105 		head = compound_head(page);
2106 		isolated = isolate_lru_page(head);
2107 		if (!isolated) {
2108 			err = -EBUSY;
2109 			goto out_putpage;
2110 		}
2111 
2112 		err = 1;
2113 		list_add_tail(&head->lru, pagelist);
2114 		mod_node_page_state(page_pgdat(head),
2115 			NR_ISOLATED_ANON + page_is_file_lru(head),
2116 			thp_nr_pages(head));
2117 	}
2118 out_putpage:
2119 	/*
2120 	 * Either remove the duplicate refcount from
2121 	 * isolate_lru_page() or drop the page ref if it was
2122 	 * not isolated.
2123 	 */
2124 	put_page(page);
2125 out:
2126 	mmap_read_unlock(mm);
2127 	return err;
2128 }
2129 
2130 static int move_pages_and_store_status(struct mm_struct *mm, int node,
2131 		struct list_head *pagelist, int __user *status,
2132 		int start, int i, unsigned long nr_pages)
2133 {
2134 	int err;
2135 
2136 	if (list_empty(pagelist))
2137 		return 0;
2138 
2139 	err = do_move_pages_to_node(mm, pagelist, node);
2140 	if (err) {
2141 		/*
2142 		 * Positive err means the number of failed
2143 		 * pages to migrate.  Since we are going to
2144 		 * abort and return the number of non-migrated
2145 		 * pages, so need to include the rest of the
2146 		 * nr_pages that have not been attempted as
2147 		 * well.
2148 		 */
2149 		if (err > 0)
2150 			err += nr_pages - i;
2151 		return err;
2152 	}
2153 	return store_status(status, start, node, i - start);
2154 }
2155 
2156 /*
2157  * Migrate an array of page address onto an array of nodes and fill
2158  * the corresponding array of status.
2159  */
2160 static int do_pages_move(struct mm_struct *mm, nodemask_t task_nodes,
2161 			 unsigned long nr_pages,
2162 			 const void __user * __user *pages,
2163 			 const int __user *nodes,
2164 			 int __user *status, int flags)
2165 {
2166 	int current_node = NUMA_NO_NODE;
2167 	LIST_HEAD(pagelist);
2168 	int start, i;
2169 	int err = 0, err1;
2170 
2171 	lru_cache_disable();
2172 
2173 	for (i = start = 0; i < nr_pages; i++) {
2174 		const void __user *p;
2175 		unsigned long addr;
2176 		int node;
2177 
2178 		err = -EFAULT;
2179 		if (get_user(p, pages + i))
2180 			goto out_flush;
2181 		if (get_user(node, nodes + i))
2182 			goto out_flush;
2183 		addr = (unsigned long)untagged_addr(p);
2184 
2185 		err = -ENODEV;
2186 		if (node < 0 || node >= MAX_NUMNODES)
2187 			goto out_flush;
2188 		if (!node_state(node, N_MEMORY))
2189 			goto out_flush;
2190 
2191 		err = -EACCES;
2192 		if (!node_isset(node, task_nodes))
2193 			goto out_flush;
2194 
2195 		if (current_node == NUMA_NO_NODE) {
2196 			current_node = node;
2197 			start = i;
2198 		} else if (node != current_node) {
2199 			err = move_pages_and_store_status(mm, current_node,
2200 					&pagelist, status, start, i, nr_pages);
2201 			if (err)
2202 				goto out;
2203 			start = i;
2204 			current_node = node;
2205 		}
2206 
2207 		/*
2208 		 * Errors in the page lookup or isolation are not fatal and we simply
2209 		 * report them via status
2210 		 */
2211 		err = add_page_for_migration(mm, addr, current_node,
2212 				&pagelist, flags & MPOL_MF_MOVE_ALL);
2213 
2214 		if (err > 0) {
2215 			/* The page is successfully queued for migration */
2216 			continue;
2217 		}
2218 
2219 		/*
2220 		 * The move_pages() man page does not have an -EEXIST choice, so
2221 		 * use -EFAULT instead.
2222 		 */
2223 		if (err == -EEXIST)
2224 			err = -EFAULT;
2225 
2226 		/*
2227 		 * If the page is already on the target node (!err), store the
2228 		 * node, otherwise, store the err.
2229 		 */
2230 		err = store_status(status, i, err ? : current_node, 1);
2231 		if (err)
2232 			goto out_flush;
2233 
2234 		err = move_pages_and_store_status(mm, current_node, &pagelist,
2235 				status, start, i, nr_pages);
2236 		if (err) {
2237 			/* We have accounted for page i */
2238 			if (err > 0)
2239 				err--;
2240 			goto out;
2241 		}
2242 		current_node = NUMA_NO_NODE;
2243 	}
2244 out_flush:
2245 	/* Make sure we do not overwrite the existing error */
2246 	err1 = move_pages_and_store_status(mm, current_node, &pagelist,
2247 				status, start, i, nr_pages);
2248 	if (err >= 0)
2249 		err = err1;
2250 out:
2251 	lru_cache_enable();
2252 	return err;
2253 }
2254 
2255 /*
2256  * Determine the nodes of an array of pages and store it in an array of status.
2257  */
2258 static void do_pages_stat_array(struct mm_struct *mm, unsigned long nr_pages,
2259 				const void __user **pages, int *status)
2260 {
2261 	unsigned long i;
2262 
2263 	mmap_read_lock(mm);
2264 
2265 	for (i = 0; i < nr_pages; i++) {
2266 		unsigned long addr = (unsigned long)(*pages);
2267 		struct vm_area_struct *vma;
2268 		struct page *page;
2269 		int err = -EFAULT;
2270 
2271 		vma = vma_lookup(mm, addr);
2272 		if (!vma)
2273 			goto set_status;
2274 
2275 		/* FOLL_DUMP to ignore special (like zero) pages */
2276 		page = follow_page(vma, addr, FOLL_GET | FOLL_DUMP);
2277 
2278 		err = PTR_ERR(page);
2279 		if (IS_ERR(page))
2280 			goto set_status;
2281 
2282 		err = -ENOENT;
2283 		if (!page)
2284 			goto set_status;
2285 
2286 		if (!is_zone_device_page(page))
2287 			err = page_to_nid(page);
2288 
2289 		put_page(page);
2290 set_status:
2291 		*status = err;
2292 
2293 		pages++;
2294 		status++;
2295 	}
2296 
2297 	mmap_read_unlock(mm);
2298 }
2299 
2300 static int get_compat_pages_array(const void __user *chunk_pages[],
2301 				  const void __user * __user *pages,
2302 				  unsigned long chunk_nr)
2303 {
2304 	compat_uptr_t __user *pages32 = (compat_uptr_t __user *)pages;
2305 	compat_uptr_t p;
2306 	int i;
2307 
2308 	for (i = 0; i < chunk_nr; i++) {
2309 		if (get_user(p, pages32 + i))
2310 			return -EFAULT;
2311 		chunk_pages[i] = compat_ptr(p);
2312 	}
2313 
2314 	return 0;
2315 }
2316 
2317 /*
2318  * Determine the nodes of a user array of pages and store it in
2319  * a user array of status.
2320  */
2321 static int do_pages_stat(struct mm_struct *mm, unsigned long nr_pages,
2322 			 const void __user * __user *pages,
2323 			 int __user *status)
2324 {
2325 #define DO_PAGES_STAT_CHUNK_NR 16UL
2326 	const void __user *chunk_pages[DO_PAGES_STAT_CHUNK_NR];
2327 	int chunk_status[DO_PAGES_STAT_CHUNK_NR];
2328 
2329 	while (nr_pages) {
2330 		unsigned long chunk_nr = min(nr_pages, DO_PAGES_STAT_CHUNK_NR);
2331 
2332 		if (in_compat_syscall()) {
2333 			if (get_compat_pages_array(chunk_pages, pages,
2334 						   chunk_nr))
2335 				break;
2336 		} else {
2337 			if (copy_from_user(chunk_pages, pages,
2338 				      chunk_nr * sizeof(*chunk_pages)))
2339 				break;
2340 		}
2341 
2342 		do_pages_stat_array(mm, chunk_nr, chunk_pages, chunk_status);
2343 
2344 		if (copy_to_user(status, chunk_status, chunk_nr * sizeof(*status)))
2345 			break;
2346 
2347 		pages += chunk_nr;
2348 		status += chunk_nr;
2349 		nr_pages -= chunk_nr;
2350 	}
2351 	return nr_pages ? -EFAULT : 0;
2352 }
2353 
2354 static struct mm_struct *find_mm_struct(pid_t pid, nodemask_t *mem_nodes)
2355 {
2356 	struct task_struct *task;
2357 	struct mm_struct *mm;
2358 
2359 	/*
2360 	 * There is no need to check if current process has the right to modify
2361 	 * the specified process when they are same.
2362 	 */
2363 	if (!pid) {
2364 		mmget(current->mm);
2365 		*mem_nodes = cpuset_mems_allowed(current);
2366 		return current->mm;
2367 	}
2368 
2369 	/* Find the mm_struct */
2370 	rcu_read_lock();
2371 	task = find_task_by_vpid(pid);
2372 	if (!task) {
2373 		rcu_read_unlock();
2374 		return ERR_PTR(-ESRCH);
2375 	}
2376 	get_task_struct(task);
2377 
2378 	/*
2379 	 * Check if this process has the right to modify the specified
2380 	 * process. Use the regular "ptrace_may_access()" checks.
2381 	 */
2382 	if (!ptrace_may_access(task, PTRACE_MODE_READ_REALCREDS)) {
2383 		rcu_read_unlock();
2384 		mm = ERR_PTR(-EPERM);
2385 		goto out;
2386 	}
2387 	rcu_read_unlock();
2388 
2389 	mm = ERR_PTR(security_task_movememory(task));
2390 	if (IS_ERR(mm))
2391 		goto out;
2392 	*mem_nodes = cpuset_mems_allowed(task);
2393 	mm = get_task_mm(task);
2394 out:
2395 	put_task_struct(task);
2396 	if (!mm)
2397 		mm = ERR_PTR(-EINVAL);
2398 	return mm;
2399 }
2400 
2401 /*
2402  * Move a list of pages in the address space of the currently executing
2403  * process.
2404  */
2405 static int kernel_move_pages(pid_t pid, unsigned long nr_pages,
2406 			     const void __user * __user *pages,
2407 			     const int __user *nodes,
2408 			     int __user *status, int flags)
2409 {
2410 	struct mm_struct *mm;
2411 	int err;
2412 	nodemask_t task_nodes;
2413 
2414 	/* Check flags */
2415 	if (flags & ~(MPOL_MF_MOVE|MPOL_MF_MOVE_ALL))
2416 		return -EINVAL;
2417 
2418 	if ((flags & MPOL_MF_MOVE_ALL) && !capable(CAP_SYS_NICE))
2419 		return -EPERM;
2420 
2421 	mm = find_mm_struct(pid, &task_nodes);
2422 	if (IS_ERR(mm))
2423 		return PTR_ERR(mm);
2424 
2425 	if (nodes)
2426 		err = do_pages_move(mm, task_nodes, nr_pages, pages,
2427 				    nodes, status, flags);
2428 	else
2429 		err = do_pages_stat(mm, nr_pages, pages, status);
2430 
2431 	mmput(mm);
2432 	return err;
2433 }
2434 
2435 SYSCALL_DEFINE6(move_pages, pid_t, pid, unsigned long, nr_pages,
2436 		const void __user * __user *, pages,
2437 		const int __user *, nodes,
2438 		int __user *, status, int, flags)
2439 {
2440 	return kernel_move_pages(pid, nr_pages, pages, nodes, status, flags);
2441 }
2442 
2443 #ifdef CONFIG_NUMA_BALANCING
2444 /*
2445  * Returns true if this is a safe migration target node for misplaced NUMA
2446  * pages. Currently it only checks the watermarks which is crude.
2447  */
2448 static bool migrate_balanced_pgdat(struct pglist_data *pgdat,
2449 				   unsigned long nr_migrate_pages)
2450 {
2451 	int z;
2452 
2453 	for (z = pgdat->nr_zones - 1; z >= 0; z--) {
2454 		struct zone *zone = pgdat->node_zones + z;
2455 
2456 		if (!managed_zone(zone))
2457 			continue;
2458 
2459 		/* Avoid waking kswapd by allocating pages_to_migrate pages. */
2460 		if (!zone_watermark_ok(zone, 0,
2461 				       high_wmark_pages(zone) +
2462 				       nr_migrate_pages,
2463 				       ZONE_MOVABLE, 0))
2464 			continue;
2465 		return true;
2466 	}
2467 	return false;
2468 }
2469 
2470 static struct page *alloc_misplaced_dst_page(struct page *page,
2471 					   unsigned long data)
2472 {
2473 	int nid = (int) data;
2474 	int order = compound_order(page);
2475 	gfp_t gfp = __GFP_THISNODE;
2476 	struct folio *new;
2477 
2478 	if (order > 0)
2479 		gfp |= GFP_TRANSHUGE_LIGHT;
2480 	else {
2481 		gfp |= GFP_HIGHUSER_MOVABLE | __GFP_NOMEMALLOC | __GFP_NORETRY |
2482 			__GFP_NOWARN;
2483 		gfp &= ~__GFP_RECLAIM;
2484 	}
2485 	new = __folio_alloc_node(gfp, order, nid);
2486 
2487 	return &new->page;
2488 }
2489 
2490 static int numamigrate_isolate_page(pg_data_t *pgdat, struct page *page)
2491 {
2492 	int nr_pages = thp_nr_pages(page);
2493 	int order = compound_order(page);
2494 
2495 	VM_BUG_ON_PAGE(order && !PageTransHuge(page), page);
2496 
2497 	/* Do not migrate THP mapped by multiple processes */
2498 	if (PageTransHuge(page) && total_mapcount(page) > 1)
2499 		return 0;
2500 
2501 	/* Avoid migrating to a node that is nearly full */
2502 	if (!migrate_balanced_pgdat(pgdat, nr_pages)) {
2503 		int z;
2504 
2505 		if (!(sysctl_numa_balancing_mode & NUMA_BALANCING_MEMORY_TIERING))
2506 			return 0;
2507 		for (z = pgdat->nr_zones - 1; z >= 0; z--) {
2508 			if (managed_zone(pgdat->node_zones + z))
2509 				break;
2510 		}
2511 		wakeup_kswapd(pgdat->node_zones + z, 0, order, ZONE_MOVABLE);
2512 		return 0;
2513 	}
2514 
2515 	if (!isolate_lru_page(page))
2516 		return 0;
2517 
2518 	mod_node_page_state(page_pgdat(page), NR_ISOLATED_ANON + page_is_file_lru(page),
2519 			    nr_pages);
2520 
2521 	/*
2522 	 * Isolating the page has taken another reference, so the
2523 	 * caller's reference can be safely dropped without the page
2524 	 * disappearing underneath us during migration.
2525 	 */
2526 	put_page(page);
2527 	return 1;
2528 }
2529 
2530 /*
2531  * Attempt to migrate a misplaced page to the specified destination
2532  * node. Caller is expected to have an elevated reference count on
2533  * the page that will be dropped by this function before returning.
2534  */
2535 int migrate_misplaced_page(struct page *page, struct vm_area_struct *vma,
2536 			   int node)
2537 {
2538 	pg_data_t *pgdat = NODE_DATA(node);
2539 	int isolated;
2540 	int nr_remaining;
2541 	unsigned int nr_succeeded;
2542 	LIST_HEAD(migratepages);
2543 	int nr_pages = thp_nr_pages(page);
2544 
2545 	/*
2546 	 * Don't migrate file pages that are mapped in multiple processes
2547 	 * with execute permissions as they are probably shared libraries.
2548 	 */
2549 	if (page_mapcount(page) != 1 && page_is_file_lru(page) &&
2550 	    (vma->vm_flags & VM_EXEC))
2551 		goto out;
2552 
2553 	/*
2554 	 * Also do not migrate dirty pages as not all filesystems can move
2555 	 * dirty pages in MIGRATE_ASYNC mode which is a waste of cycles.
2556 	 */
2557 	if (page_is_file_lru(page) && PageDirty(page))
2558 		goto out;
2559 
2560 	isolated = numamigrate_isolate_page(pgdat, page);
2561 	if (!isolated)
2562 		goto out;
2563 
2564 	list_add(&page->lru, &migratepages);
2565 	nr_remaining = migrate_pages(&migratepages, alloc_misplaced_dst_page,
2566 				     NULL, node, MIGRATE_ASYNC,
2567 				     MR_NUMA_MISPLACED, &nr_succeeded);
2568 	if (nr_remaining) {
2569 		if (!list_empty(&migratepages)) {
2570 			list_del(&page->lru);
2571 			mod_node_page_state(page_pgdat(page), NR_ISOLATED_ANON +
2572 					page_is_file_lru(page), -nr_pages);
2573 			putback_lru_page(page);
2574 		}
2575 		isolated = 0;
2576 	}
2577 	if (nr_succeeded) {
2578 		count_vm_numa_events(NUMA_PAGE_MIGRATE, nr_succeeded);
2579 		if (!node_is_toptier(page_to_nid(page)) && node_is_toptier(node))
2580 			mod_node_page_state(pgdat, PGPROMOTE_SUCCESS,
2581 					    nr_succeeded);
2582 	}
2583 	BUG_ON(!list_empty(&migratepages));
2584 	return isolated;
2585 
2586 out:
2587 	put_page(page);
2588 	return 0;
2589 }
2590 #endif /* CONFIG_NUMA_BALANCING */
2591 #endif /* CONFIG_NUMA */
2592