path: root/mm/damon/ops-common.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Common Code for Data Access Monitoring
 */

#include <linux/hugetlb.h>
#include <linux/migrate.h>
#include <linux/mmu_notifier.h>
#include <linux/page_idle.h>
#include <linux/pagemap.h>
#include <linux/rmap.h>
#include <linux/swap.h>
#include <linux/leafops.h>

#include "../internal.h"
#include "ops-common.h"

static bool damon_folio_acceptable(struct folio *folio, bool monitor)
{
	return folio_test_lru(folio) ||
		(monitor && folio_test_hugetlb(folio));
}

/*
 * Get an online page for a pfn if it's in the LRU list, or a hugetlb folio if
 * @monitor is set.  Otherwise, returns NULL.
 *
 * The body of this function is stolen from the 'page_idle_get_folio()'.  We
 * steal rather than reuse it because the code is quite simple.
 */
static struct folio *__damon_get_folio(unsigned long pfn, bool monitor)
{
	struct page *page = pfn_to_online_page(pfn);
	struct folio *folio;

	if (!page)
		return NULL;

	folio = page_folio(page);
	if (!folio_try_get(folio))
		return NULL;
	if (unlikely(page_folio(page) != folio) ||
			!damon_folio_acceptable(folio, monitor)) {
		folio_put(folio);
		folio = NULL;
	}
	return folio;
}

struct folio *damon_get_folio(unsigned long pfn)
{
	return __damon_get_folio(pfn, false);
}

struct folio *damon_get_monitor_folio(unsigned long pfn)
{
	return __damon_get_folio(pfn, true);
}

void damon_ptep_mkold(pte_t *pte, struct vm_area_struct *vma, unsigned long addr)
{
	pte_t pteval = ptep_get(pte);
	struct folio *folio;
	bool young = false;
	unsigned long pfn;

	if (likely(pte_present(pteval)))
		pfn = pte_pfn(pteval);
	else
		pfn = softleaf_to_pfn(softleaf_from_pte(pteval));

	folio = damon_get_folio(pfn);
	if (!folio)
		return;

	/*
	 * PFN swap PTEs, such as device-exclusive ones, that actually map pages
	 * are "old" from a CPU perspective. The MMU notifier takes care of any
	 * device aspects.
	 */
	if (likely(pte_present(pteval)))
		/*
		 * Arch implementation of ptep_test_and_clear_young() may
		 * require aligned @addr
		 */
		young |= ptep_test_and_clear_young(vma, PAGE_ALIGN_DOWN(addr),
				pte);
	young |= mmu_notifier_clear_young(vma->vm_mm, addr, addr + PAGE_SIZE);
	if (young)
		folio_set_young(folio);

	folio_set_idle(folio);
	folio_put(folio);
}

void damon_pmdp_mkold(pmd_t *pmd, struct vm_area_struct *vma, unsigned long addr)
{
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
	pmd_t pmdval = pmdp_get(pmd);
	struct folio *folio;
	bool young = false;
	unsigned long pfn;

	if (likely(pmd_present(pmdval)))
		pfn = pmd_pfn(pmdval);
	else
		pfn = softleaf_to_pfn(softleaf_from_pmd(pmdval));

	folio = damon_get_folio(pfn);
	if (!folio)
		return;

	if (likely(pmd_present(pmdval)))
		young |= pmdp_test_and_clear_young(vma, addr, pmd);
	young |= mmu_notifier_clear_young(vma->vm_mm, addr, addr + HPAGE_PMD_SIZE);
	if (young)
		folio_set_young(folio);

	folio_set_idle(folio);
	folio_put(folio);
#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
}

#ifdef CONFIG_HUGETLB_PAGE
static bool damon_hugetlb_ptep_mkold(pte_t *pte, struct mm_struct *mm,
		struct vm_area_struct *vma, unsigned long addr, pte_t *entry)
{
	unsigned long psize = huge_page_size(hstate_vma(vma));

	if (!pte_young(*entry))
		return false;
	*entry = huge_ptep_get_and_clear(mm, addr, pte, psize);
	*entry = pte_mkold(*entry);
	set_huge_pte_at(mm, addr, pte, *entry, psize);
	return true;
}

void damon_hugetlb_mkold(pte_t *pte, struct mm_struct *mm,
		struct vm_area_struct *vma, unsigned long addr)
{
	bool referenced = false;
	pte_t entry = huge_ptep_get(mm, addr, pte);
	struct folio *folio;

	folio = damon_get_monitor_folio(pte_pfn(entry));
	if (!folio)
		return;

	referenced = damon_hugetlb_ptep_mkold(pte, mm, vma, addr, &entry);
	if (mmu_notifier_clear_young(mm, addr,
				     addr + huge_page_size(hstate_vma(vma))))
		referenced = true;

	if (referenced)
		folio_set_young(folio);

	folio_set_idle(folio);
	folio_put(folio);
}
#endif	/* CONFIG_HUGETLB_PAGE */

#define DAMON_MAX_SUBSCORE	(100)
#define DAMON_MAX_AGE_IN_LOG	(32)

int damon_hot_score(struct damon_ctx *c, struct damon_region *r,
			struct damos *s)
{
	int freq_subscore;
	u64 age_in_sec;
	int age_in_log, age_subscore;
	unsigned int freq_weight = s->quota.weight_nr_accesses;
	unsigned int age_weight = s->quota.weight_age;
	int hotness;

	freq_subscore = mult_frac(damon_nr_accesses_mvsum(r, c),
			DAMON_MAX_SUBSCORE,
			damon_nr_samples_per_aggr(&c->attrs));

	age_in_sec = div_u64((u64)r->age * c->attrs.aggr_interval,
			     USEC_PER_SEC);
	if (age_in_sec)
		age_in_log = min_t(int, ilog2(age_in_sec) + 1,
				DAMON_MAX_AGE_IN_LOG);
	else
		age_in_log = 0;


	/* If frequency is 0, higher age means it's colder */
	if (freq_subscore == 0)
		age_in_log *= -1;

	/*
	 * Now age_in_log is in [-DAMON_MAX_AGE_IN_LOG, DAMON_MAX_AGE_IN_LOG].
	 * Scale it to be in [0, 100] and set it as age subscore.
	 */
	age_in_log += DAMON_MAX_AGE_IN_LOG;
	age_subscore = age_in_log * DAMON_MAX_SUBSCORE /
		DAMON_MAX_AGE_IN_LOG / 2;

	hotness = (freq_weight * freq_subscore + age_weight * age_subscore);
	if (freq_weight + age_weight)
		hotness /= freq_weight + age_weight;
	/*
	 * Transform it to fit in [0, DAMOS_MAX_SCORE]
	 */
	hotness = hotness * DAMOS_MAX_SCORE / DAMON_MAX_SUBSCORE;
	hotness = max(min(hotness, DAMOS_MAX_SCORE), 0);

	return hotness;
}

int damon_cold_score(struct damon_ctx *c, struct damon_region *r,
			struct damos *s)
{
	int hotness = damon_hot_score(c, r, s);

	/* Return coldness of the region */
	return DAMOS_MAX_SCORE - hotness;
}

static bool damon_folio_mkold_one(struct folio *folio,
		struct vm_area_struct *vma, unsigned long addr, void *arg)
{
	DEFINE_FOLIO_VMA_WALK(pvmw, folio, vma, addr, 0);

	while (page_vma_mapped_walk(&pvmw)) {
		addr = pvmw.address;
		if (pvmw.pte) {
			if (folio_test_hugetlb(folio))
				damon_hugetlb_mkold(pvmw.pte, vma->vm_mm, vma,
						addr);
			else
				damon_ptep_mkold(pvmw.pte, vma, addr);
		} else {
			damon_pmdp_mkold(pvmw.pmd, vma, addr);
		}
	}
	return true;
}

void damon_folio_mkold(struct folio *folio)
{
	struct rmap_walk_control rwc = {
		.rmap_one = damon_folio_mkold_one,
		.anon_lock = folio_lock_anon_vma_read,
	};

	if (!folio_mapped(folio) || !folio_raw_mapping(folio)) {
		folio_set_idle(folio);
		return;
	}

	if (!folio_trylock(folio))
		return;

	rmap_walk(folio, &rwc);
	folio_unlock(folio);

}

#ifdef CONFIG_HUGETLB_PAGE
static bool damon_hugetlb_young(pte_t *pte, struct vm_area_struct *vma,
		unsigned long addr, struct folio *folio)
{
	pte_t entry = huge_ptep_get(vma->vm_mm, addr, pte);

	return (pte_present(entry) && pte_young(entry)) ||
		!folio_test_idle(folio) ||
		mmu_notifier_test_young(vma->vm_mm, addr);
}
#else
static bool damon_hugetlb_young(pte_t *pte, struct vm_area_struct *vma,
		unsigned long addr, struct folio *folio)
{
	return false;
}
#endif	/* CONFIG_HUGETLB_PAGE */

static bool damon_pte_young(pte_t *pte, struct vm_area_struct *vma,
		unsigned long addr, struct folio *folio)
{
	pte_t entry = ptep_get(pte);

	/*
	 * PFN swap PTEs, such as device-exclusive ones, that actually map
	 * pages are "old" from a CPU perspective. The MMU notifier takes care
	 * of any device aspects.
	 */
	return (pte_present(entry) && pte_young(entry)) ||
		!folio_test_idle(folio) ||
		mmu_notifier_test_young(vma->vm_mm, addr);
}

static bool damon_folio_young_one(struct folio *folio,
		struct vm_area_struct *vma, unsigned long addr, void *arg)
{
	bool *accessed = arg;
	DEFINE_FOLIO_VMA_WALK(pvmw, folio, vma, addr, 0);

	*accessed = false;
	while (page_vma_mapped_walk(&pvmw)) {
		addr = pvmw.address;
		if (pvmw.pte) {
			if (folio_test_hugetlb(folio))
				*accessed = damon_hugetlb_young(pvmw.pte, vma,
						addr, folio);
			else
				*accessed = damon_pte_young(pvmw.pte, vma,
						addr, folio);
		} else {
#ifdef CONFIG_TRANSPARENT_HUGEPAGE
			pmd_t pmd = pmdp_get(pvmw.pmd);

			*accessed = (pmd_present(pmd) && pmd_young(pmd)) ||
				!folio_test_idle(folio) ||
				mmu_notifier_test_young(vma->vm_mm, addr);
#else
			WARN_ON_ONCE(1);
#endif	/* CONFIG_TRANSPARENT_HUGEPAGE */
		}
		if (*accessed) {
			page_vma_mapped_walk_done(&pvmw);
			break;
		}
	}

	/* If accessed, stop walking */
	return *accessed == false;
}

bool damon_folio_young(struct folio *folio)
{
	bool accessed = false;
	struct rmap_walk_control rwc = {
		.arg = &accessed,
		.rmap_one = damon_folio_young_one,
		.anon_lock = folio_lock_anon_vma_read,
	};

	if (!folio_mapped(folio) || !folio_raw_mapping(folio)) {
		if (folio_test_idle(folio))
			return false;
		else
			return true;
	}

	if (!folio_trylock(folio))
		return false;

	rmap_walk(folio, &rwc);
	folio_unlock(folio);

	return accessed;
}

bool damos_folio_filter_match(struct damos_filter *filter, struct folio *folio)
{
	bool matched = false;
	struct mem_cgroup *memcg;
	size_t folio_sz;

	switch (filter->type) {
	case DAMOS_FILTER_TYPE_ANON:
		matched = folio_test_anon(folio);
		break;
	case DAMOS_FILTER_TYPE_ACTIVE:
		matched = folio_test_active(folio);
		break;
	case DAMOS_FILTER_TYPE_MEMCG:
		rcu_read_lock();
		memcg = folio_memcg_check(folio);
		if (!memcg)
			matched = false;
		else
			matched = filter->memcg_id == mem_cgroup_id(memcg);
		rcu_read_unlock();
		break;
	case DAMOS_FILTER_TYPE_YOUNG:
		matched = damon_folio_young(folio);
		if (matched)
			damon_folio_mkold(folio);
		break;
	case DAMOS_FILTER_TYPE_HUGEPAGE_SIZE:
		folio_sz = folio_size(folio);
		matched = filter->sz_range.min <= folio_sz &&
			  folio_sz <= filter->sz_range.max;
		break;
	case DAMOS_FILTER_TYPE_UNMAPPED:
		matched = !folio_mapped(folio) || !folio_raw_mapping(folio);
		break;
	default:
		break;
	}

	return matched == filter->matching;
}

static unsigned int __damon_migrate_folio_list(
		struct list_head *migrate_folios, struct pglist_data *pgdat,
		int target_nid)
{
	unsigned int nr_succeeded = 0;
	struct migration_target_control mtc = {
		/*
		 * Allocate from 'node', or fail quickly and quietly.
		 * When this happens, 'page' will likely just be discarded
		 * instead of migrated.
		 */
		.gfp_mask = (GFP_HIGHUSER_MOVABLE & ~__GFP_RECLAIM) |
			__GFP_NOMEMALLOC | GFP_NOWAIT | __GFP_THISNODE,
		.nid = target_nid,
	};

	if (pgdat->node_id == target_nid || target_nid == NUMA_NO_NODE)
		return 0;

	if (list_empty(migrate_folios))
		return 0;

	/* Migration ignores all cpuset and mempolicy settings */
	migrate_pages(migrate_folios, alloc_migration_target, NULL,
		      (unsigned long)&mtc, MIGRATE_ASYNC, MR_DAMON,
		      &nr_succeeded);

	return nr_succeeded;
}

static void damon_putback_folio_list(struct list_head *folio_list)
{
	struct folio *folio;

	while (!list_empty(folio_list)) {
		folio = lru_to_folio(folio_list);
		list_del(&folio->lru);
		node_stat_sub_folio(folio, NR_ISOLATED_ANON +
				folio_is_file_lru(folio));
		folio_putback_lru(folio);
	}
}

static unsigned int damon_migrate_folio_list(struct list_head *folio_list,
						struct pglist_data *pgdat,
						int target_nid)
{
	unsigned int nr_migrated = 0;
	struct folio *folio;
	LIST_HEAD(ret_folios);
	LIST_HEAD(migrate_folios);

	while (!list_empty(folio_list)) {
		cond_resched();

		folio = lru_to_folio(folio_list);
		list_del(&folio->lru);

		if (!folio_trylock(folio))
			goto keep;

		/* Relocate its contents to another node. */
		list_add(&folio->lru, &migrate_folios);
		folio_unlock(folio);
		continue;
keep:
		list_add(&folio->lru, &ret_folios);
	}
	/* 'folio_list' is always empty here */

	/* Migrate folios selected for migration */
	nr_migrated += __damon_migrate_folio_list(
			&migrate_folios, pgdat, target_nid);
	/*
	 * Folios that could not be migrated are still in @migrate_folios.  Add
	 * those back on @folio_list
	 */
	if (!list_empty(&migrate_folios))
		list_splice_init(&migrate_folios, folio_list);

	try_to_unmap_flush();

	list_splice(&ret_folios, folio_list);

	damon_putback_folio_list(folio_list);

	return nr_migrated;
}

unsigned long damon_migrate_pages(struct list_head *folio_list, int target_nid)
{
	int nid;
	unsigned long nr_migrated = 0;
	LIST_HEAD(node_folio_list);
	unsigned int noreclaim_flag;

	if (list_empty(folio_list))
		return nr_migrated;

	if (target_nid < 0 || target_nid >= MAX_NUMNODES ||
			!node_state(target_nid, N_MEMORY)) {
		damon_putback_folio_list(folio_list);
		return nr_migrated;
	}

	noreclaim_flag = memalloc_noreclaim_save();

	nid = folio_nid(lru_to_folio(folio_list));
	do {
		struct folio *folio = lru_to_folio(folio_list);

		if (nid == folio_nid(folio)) {
			list_move(&folio->lru, &node_folio_list);
			continue;
		}

		nr_migrated += damon_migrate_folio_list(&node_folio_list,
							   NODE_DATA(nid),
							   target_nid);
		nid = folio_nid(lru_to_folio(folio_list));
	} while (!list_empty(folio_list));

	nr_migrated += damon_migrate_folio_list(&node_folio_list,
						   NODE_DATA(nid),
						   target_nid);

	memalloc_noreclaim_restore(noreclaim_flag);

	return nr_migrated;
}

bool damos_ops_has_filter(struct damos *s)
{
	struct damos_filter *f;

	damos_for_each_ops_filter(f, s)
		return true;
	return false;
}

bool damon_ops_filter_match(struct damon_filter *filter, struct folio *folio)
{
	bool matched = false;
	struct mem_cgroup *memcg;
	size_t folio_sz;

	switch (filter->type) {
	case DAMON_FILTER_TYPE_ANON:
		if (!folio) {
			matched = false;
			break;
		}
		matched = folio_test_anon(folio);
		break;
	case DAMON_FILTER_TYPE_MEMCG:
		if (!folio) {
			matched = false;
			break;
		}
		rcu_read_lock();
		memcg = folio_memcg_check(folio);
		if (!memcg)
			matched = false;
		else
			matched = filter->memcg_id == mem_cgroup_id(memcg);
		rcu_read_unlock();
		break;
	case DAMON_FILTER_TYPE_HUGEPAGE_SIZE:
		if (!folio) {
			matched = false;
			break;
		}
		folio_sz = folio_size(folio);
		matched = filter->range_min <= folio_sz &&
			folio_sz <= filter->range_max;
		break;
	default:
		break;
	}
	return matched == filter->matching;
}