[mirror_ubuntu-hirsute-kernel.git] / mm / page_vma_mapped.c

// SPDX-License-Identifier: GPL-2.0
#include <linux/mm.h>
#include <linux/rmap.h>
#include <linux/hugetlb.h>
#include <linux/swap.h>
#include <linux/swapops.h>

#include "internal.h"

static inline bool not_found(struct page_vma_mapped_walk *pvmw)
{
	page_vma_mapped_walk_done(pvmw);
	return false;
}

static bool map_pte(struct page_vma_mapped_walk *pvmw)
{
	pvmw->pte = pte_offset_map(pvmw->pmd, pvmw->address);
	if (!(pvmw->flags & PVMW_SYNC)) {
		if (pvmw->flags & PVMW_MIGRATION) {
			if (!is_swap_pte(*pvmw->pte))
				return false;
		} else {
			/*
			 * We get here when we are trying to unmap a private
			 * device page from the process address space. Such
			 * page is not CPU accessible and thus is mapped as
			 * a special swap entry, nonetheless it still does
			 * count as a valid regular mapping for the page (and
			 * is accounted as such in page maps count).
			 *
			 * So handle this special case as if it was a normal
			 * page mapping ie lock CPU page table and returns
			 * true.
			 *
			 * For more details on device private memory see HMM
			 * (include/linux/hmm.h or mm/hmm.c).
			 */
			if (is_swap_pte(*pvmw->pte)) {
				swp_entry_t entry;

				/* Handle un-addressable ZONE_DEVICE memory */
				entry = pte_to_swp_entry(*pvmw->pte);
				if (!is_device_private_entry(entry))
					return false;
			} else if (!pte_present(*pvmw->pte))
				return false;
		}
	}
	pvmw->ptl = pte_lockptr(pvmw->vma->vm_mm, pvmw->pmd);
	spin_lock(pvmw->ptl);
	return true;
}

static inline bool pfn_is_match(struct page *page, unsigned long pfn)
{
	unsigned long page_pfn = page_to_pfn(page);

	/* normal page and hugetlbfs page */
	if (!PageTransCompound(page) || PageHuge(page))
		return page_pfn == pfn;

	/* THP can be referenced by any subpage */
	return pfn >= page_pfn && pfn - page_pfn < thp_nr_pages(page);
}

/**
 * check_pte - check if @pvmw->page is mapped at the @pvmw->pte
 * @pvmw: page_vma_mapped_walk struct, includes a pair pte and page for checking
 *
 * page_vma_mapped_walk() found a place where @pvmw->page is *potentially*
 * mapped. check_pte() has to validate this.
 *
 * pvmw->pte may point to empty PTE, swap PTE or PTE pointing to
 * arbitrary page.
 *
 * If PVMW_MIGRATION flag is set, returns true if @pvmw->pte contains migration
 * entry that points to @pvmw->page or any subpage in case of THP.
 *
 * If PVMW_MIGRATION flag is not set, returns true if pvmw->pte points to
 * pvmw->page or any subpage in case of THP.
 *
 * Otherwise, return false.
 *
 */
static bool check_pte(struct page_vma_mapped_walk *pvmw)
{
	unsigned long pfn;

	if (pvmw->flags & PVMW_MIGRATION) {
		swp_entry_t entry;
		if (!is_swap_pte(*pvmw->pte))
			return false;
		entry = pte_to_swp_entry(*pvmw->pte);

		if (!is_migration_entry(entry))
			return false;

		pfn = migration_entry_to_pfn(entry);
	} else if (is_swap_pte(*pvmw->pte)) {
		swp_entry_t entry;

		/* Handle un-addressable ZONE_DEVICE memory */
		entry = pte_to_swp_entry(*pvmw->pte);
		if (!is_device_private_entry(entry))
			return false;

		pfn = device_private_entry_to_pfn(entry);
	} else {
		if (!pte_present(*pvmw->pte))
			return false;

		pfn = pte_pfn(*pvmw->pte);
	}

	return pfn_is_match(pvmw->page, pfn);
}

/**
 * page_vma_mapped_walk - check if @pvmw->page is mapped in @pvmw->vma at
 * @pvmw->address
 * @pvmw: pointer to struct page_vma_mapped_walk. page, vma, address and flags
 * must be set. pmd, pte and ptl must be NULL.
 *
 * Returns true if the page is mapped in the vma. @pvmw->pmd and @pvmw->pte point
 * to relevant page table entries. @pvmw->ptl is locked. @pvmw->address is
 * adjusted if needed (for PTE-mapped THPs).
 *
 * If @pvmw->pmd is set but @pvmw->pte is not, you have found PMD-mapped page
 * (usually THP). For PTE-mapped THP, you should run page_vma_mapped_walk() in
 * a loop to find all PTEs that map the THP.
 *
 * For HugeTLB pages, @pvmw->pte is set to the relevant page table entry
 * regardless of which page table level the page is mapped at. @pvmw->pmd is
 * NULL.
 *
 * Retruns false if there are no more page table entries for the page in
 * the vma. @pvmw->ptl is unlocked and @pvmw->pte is unmapped.
 *
 * If you need to stop the walk before page_vma_mapped_walk() returned false,
 * use page_vma_mapped_walk_done(). It will do the housekeeping.
 */
bool page_vma_mapped_walk(struct page_vma_mapped_walk *pvmw)
{
	struct mm_struct *mm = pvmw->vma->vm_mm;
	struct page *page = pvmw->page;
	pgd_t *pgd;
	p4d_t *p4d;
	pud_t *pud;
	pmd_t pmde;

	/* The only possible pmd mapping has been handled on last iteration */
	if (pvmw->pmd && !pvmw->pte)
		return not_found(pvmw);

	if (pvmw->pte)
		goto next_pte;

	if (unlikely(PageHuge(pvmw->page))) {
		/* when pud is not present, pte will be NULL */
		pvmw->pte = huge_pte_offset(mm, pvmw->address, page_size(page));
		if (!pvmw->pte)
			return false;

		pvmw->ptl = huge_pte_lockptr(page_hstate(page), mm, pvmw->pte);
		spin_lock(pvmw->ptl);
		if (!check_pte(pvmw))
			return not_found(pvmw);
		return true;
	}
restart:
	pgd = pgd_offset(mm, pvmw->address);
	if (!pgd_present(*pgd))
		return false;
	p4d = p4d_offset(pgd, pvmw->address);
	if (!p4d_present(*p4d))
		return false;
	pud = pud_offset(p4d, pvmw->address);
	if (!pud_present(*pud))
		return false;
	pvmw->pmd = pmd_offset(pud, pvmw->address);
	/*
	 * Make sure the pmd value isn't cached in a register by the
	 * compiler and used as a stale value after we've observed a
	 * subsequent update.
	 */
	pmde = READ_ONCE(*pvmw->pmd);
	if (pmd_trans_huge(pmde) || is_pmd_migration_entry(pmde)) {
		pvmw->ptl = pmd_lock(mm, pvmw->pmd);
		if (likely(pmd_trans_huge(*pvmw->pmd))) {
			if (pvmw->flags & PVMW_MIGRATION)
				return not_found(pvmw);
			if (pmd_page(*pvmw->pmd) != page)
				return not_found(pvmw);
			return true;
		} else if (!pmd_present(*pvmw->pmd)) {
			if (thp_migration_supported()) {
				if (!(pvmw->flags & PVMW_MIGRATION))
					return not_found(pvmw);
				if (is_migration_entry(pmd_to_swp_entry(*pvmw->pmd))) {
					swp_entry_t entry = pmd_to_swp_entry(*pvmw->pmd);

					if (migration_entry_to_page(entry) != page)
						return not_found(pvmw);
					return true;
				}
			}
			return not_found(pvmw);
		} else {
			/* THP pmd was split under us: handle on pte level */
			spin_unlock(pvmw->ptl);
			pvmw->ptl = NULL;
		}
	} else if (!pmd_present(pmde)) {
		return false;
	}
	if (!map_pte(pvmw))
		goto next_pte;
	while (1) {
		if (check_pte(pvmw))
			return true;
next_pte:
		/* Seek to next pte only makes sense for THP */
		if (!PageTransHuge(pvmw->page) || PageHuge(pvmw->page))
			return not_found(pvmw);
		do {
			pvmw->address += PAGE_SIZE;
			if (pvmw->address >= pvmw->vma->vm_end ||
			    pvmw->address >=
					__vma_address(pvmw->page, pvmw->vma) +
					thp_size(pvmw->page))
				return not_found(pvmw);
			/* Did we cross page table boundary? */
			if (pvmw->address % PMD_SIZE == 0) {
				pte_unmap(pvmw->pte);
				if (pvmw->ptl) {
					spin_unlock(pvmw->ptl);
					pvmw->ptl = NULL;
				}
				goto restart;
			} else {
				pvmw->pte++;
			}
		} while (pte_none(*pvmw->pte));

		if (!pvmw->ptl) {
			pvmw->ptl = pte_lockptr(mm, pvmw->pmd);
			spin_lock(pvmw->ptl);
		}
	}
}

/**
 * page_mapped_in_vma - check whether a page is really mapped in a VMA
 * @page: the page to test
 * @vma: the VMA to test
 *
 * Returns 1 if the page is mapped into the page tables of the VMA, 0
 * if the page is not mapped into the page tables of this VMA.  Only
 * valid for normal file or anonymous VMAs.
 */
int page_mapped_in_vma(struct page *page, struct vm_area_struct *vma)
{
	struct page_vma_mapped_walk pvmw = {
		.page = page,
		.vma = vma,
		.flags = PVMW_SYNC,
	};
	unsigned long start, end;

	start = __vma_address(page, vma);
	end = start + thp_size(page) - PAGE_SIZE;

	if (unlikely(end < vma->vm_start || start >= vma->vm_end))
		return 0;
	pvmw.address = max(start, vma->vm_start);
	if (!page_vma_mapped_walk(&pvmw))
		return 0;
	page_vma_mapped_walk_done(&pvmw);
	return 1;
}
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
ace71a19 KS	2	#include <linux/mm.h>
	3	#include <linux/rmap.h>
	4	#include <linux/hugetlb.h>
	5	#include <linux/swap.h>
	6	#include <linux/swapops.h>
	7
	8	#include "internal.h"
	9
ace71a19 KS	10	static inline bool not_found(struct page_vma_mapped_walk *pvmw)
	11	{
	12	page_vma_mapped_walk_done(pvmw);
	13	return false;
	14	}
	15
	16	static bool map_pte(struct page_vma_mapped_walk *pvmw)
	17	{
	18	pvmw->pte = pte_offset_map(pvmw->pmd, pvmw->address);
	19	if (!(pvmw->flags & PVMW_SYNC)) {
	20	if (pvmw->flags & PVMW_MIGRATION) {
	21	if (!is_swap_pte(*pvmw->pte))
	22	return false;
	23	} else {
aab8d052 RC	24	/*
	25	* We get here when we are trying to unmap a private
	26	* device page from the process address space. Such
	27	* page is not CPU accessible and thus is mapped as
	28	* a special swap entry, nonetheless it still does
	29	* count as a valid regular mapping for the page (and
	30	* is accounted as such in page maps count).
	31	*
	32	* So handle this special case as if it was a normal
	33	* page mapping ie lock CPU page table and returns
	34	* true.
	35	*
	36	* For more details on device private memory see HMM
	37	* (include/linux/hmm.h or mm/hmm.c).
	38	*/
	39	if (is_swap_pte(*pvmw->pte)) {
	40	swp_entry_t entry;
	41
	42	/* Handle un-addressable ZONE_DEVICE memory */
	43	entry = pte_to_swp_entry(*pvmw->pte);
	44	if (!is_device_private_entry(entry))
	45	return false;
	46	} else if (!pte_present(*pvmw->pte))
ace71a19 KS	47	return false;
	48	}
	49	}
	50	pvmw->ptl = pte_lockptr(pvmw->vma->vm_mm, pvmw->pmd);
	51	spin_lock(pvmw->ptl);
	52	return true;
	53	}
	54
5b8d6e37	55	static inline bool pfn_is_match(struct page *page, unsigned long pfn)
7222708e	56	{
5b8d6e37 LX	57	unsigned long page_pfn = page_to_pfn(page);
	58
	59	/* normal page and hugetlbfs page */
	60	if (!PageTransCompound(page) \|\| PageHuge(page))
	61	return page_pfn == pfn;
7222708e KS	62
7222708e KS	63	/* THP can be referenced by any subpage */
6c357848	64	return pfn >= page_pfn && pfn - page_pfn < thp_nr_pages(page);
7222708e KS	65	}
7222708e KS	66
0d665e7b KS	67	/**
0d665e7b KS	68	* check_pte - check if @pvmw->page is mapped at the @pvmw->pte
777f303c	69	* @pvmw: page_vma_mapped_walk struct, includes a pair pte and page for checking
0d665e7b KS	70	*
	71	* page_vma_mapped_walk() found a place where @pvmw->page is potentially
	72	* mapped. check_pte() has to validate this.
	73	*
777f303c AS	74	* pvmw->pte may point to empty PTE, swap PTE or PTE pointing to
777f303c AS	75	* arbitrary page.
0d665e7b KS	76	*
	77	* If PVMW_MIGRATION flag is set, returns true if @pvmw->pte contains migration
	78	* entry that points to @pvmw->page or any subpage in case of THP.
	79	*
777f303c AS	80	* If PVMW_MIGRATION flag is not set, returns true if pvmw->pte points to
777f303c AS	81	* pvmw->page or any subpage in case of THP.
0d665e7b KS	82	*
	83	* Otherwise, return false.
	84	*
	85	*/
ace71a19 KS	86	static bool check_pte(struct page_vma_mapped_walk *pvmw)
ace71a19 KS	87	{
0d665e7b KS	88	unsigned long pfn;
0d665e7b KS	89
ace71a19	90	if (pvmw->flags & PVMW_MIGRATION) {
ace71a19 KS	91	swp_entry_t entry;
	92	if (!is_swap_pte(*pvmw->pte))
	93	return false;
	94	entry = pte_to_swp_entry(*pvmw->pte);
a5430dda	95
ace71a19 KS	96	if (!is_migration_entry(entry))
ace71a19 KS	97	return false;
a5430dda	98
0d665e7b KS	99	pfn = migration_entry_to_pfn(entry);
	100	} else if (is_swap_pte(*pvmw->pte)) {
	101	swp_entry_t entry;
a5430dda	102
0d665e7b KS	103	/* Handle un-addressable ZONE_DEVICE memory */
	104	entry = pte_to_swp_entry(*pvmw->pte);
	105	if (!is_device_private_entry(entry))
ace71a19 KS	106	return false;
ace71a19 KS	107
0d665e7b KS	108	pfn = device_private_entry_to_pfn(entry);
	109	} else {
	110	if (!pte_present(*pvmw->pte))
ace71a19	111	return false;
0d665e7b KS	112
0d665e7b KS	113	pfn = pte_pfn(*pvmw->pte);
ace71a19 KS	114	}
ace71a19 KS	115
5b8d6e37	116	return pfn_is_match(pvmw->page, pfn);
ace71a19 KS	117	}
	118
	119	/**
	120	* page_vma_mapped_walk - check if @pvmw->page is mapped in @pvmw->vma at
	121	* @pvmw->address
	122	* @pvmw: pointer to struct page_vma_mapped_walk. page, vma, address and flags
	123	* must be set. pmd, pte and ptl must be NULL.
	124	*
	125	* Returns true if the page is mapped in the vma. @pvmw->pmd and @pvmw->pte point
	126	* to relevant page table entries. @pvmw->ptl is locked. @pvmw->address is
	127	* adjusted if needed (for PTE-mapped THPs).
	128	*
	129	* If @pvmw->pmd is set but @pvmw->pte is not, you have found PMD-mapped page
	130	* (usually THP). For PTE-mapped THP, you should run page_vma_mapped_walk() in
	131	* a loop to find all PTEs that map the THP.
	132	*
	133	* For HugeTLB pages, @pvmw->pte is set to the relevant page table entry
	134	* regardless of which page table level the page is mapped at. @pvmw->pmd is
	135	* NULL.
	136	*
	137	* Retruns false if there are no more page table entries for the page in
	138	* the vma. @pvmw->ptl is unlocked and @pvmw->pte is unmapped.
	139	*
	140	* If you need to stop the walk before page_vma_mapped_walk() returned false,
	141	* use page_vma_mapped_walk_done(). It will do the housekeeping.
	142	*/
	143	bool page_vma_mapped_walk(struct page_vma_mapped_walk *pvmw)
	144	{
	145	struct mm_struct *mm = pvmw->vma->vm_mm;
	146	struct page *page = pvmw->page;
	147	pgd_t *pgd;
c2febafc	148	p4d_t *p4d;
ace71a19	149	pud_t *pud;
a7b10095	150	pmd_t pmde;
ace71a19 KS	151
	152	/* The only possible pmd mapping has been handled on last iteration */
	153	if (pvmw->pmd && !pvmw->pte)
	154	return not_found(pvmw);
	155
d75450ff	156	if (pvmw->pte)
ace71a19	157	goto next_pte;
ace71a19 KS	158
	159	if (unlikely(PageHuge(pvmw->page))) {
	160	/* when pud is not present, pte will be NULL */
a50b854e	161	pvmw->pte = huge_pte_offset(mm, pvmw->address, page_size(page));
ace71a19 KS	162	if (!pvmw->pte)
	163	return false;
	164
	165	pvmw->ptl = huge_pte_lockptr(page_hstate(page), mm, pvmw->pte);
	166	spin_lock(pvmw->ptl);
	167	if (!check_pte(pvmw))
	168	return not_found(pvmw);
	169	return true;
	170	}
	171	restart:
	172	pgd = pgd_offset(mm, pvmw->address);
	173	if (!pgd_present(*pgd))
	174	return false;
c2febafc KS	175	p4d = p4d_offset(pgd, pvmw->address);
	176	if (!p4d_present(*p4d))
	177	return false;
	178	pud = pud_offset(p4d, pvmw->address);
ace71a19 KS	179	if (!pud_present(*pud))
	180	return false;
	181	pvmw->pmd = pmd_offset(pud, pvmw->address);
a7b10095 WD	182	/*
	183	* Make sure the pmd value isn't cached in a register by the
	184	* compiler and used as a stale value after we've observed a
	185	* subsequent update.
	186	*/
	187	pmde = READ_ONCE(*pvmw->pmd);
	188	if (pmd_trans_huge(pmde) \|\| is_pmd_migration_entry(pmde)) {
ace71a19	189	pvmw->ptl = pmd_lock(mm, pvmw->pmd);
ace71a19 KS	190	if (likely(pmd_trans_huge(*pvmw->pmd))) {
	191	if (pvmw->flags & PVMW_MIGRATION)
	192	return not_found(pvmw);
	193	if (pmd_page(*pvmw->pmd) != page)
	194	return not_found(pvmw);
	195	return true;
616b8371 ZY	196	} else if (!pmd_present(*pvmw->pmd)) {
	197	if (thp_migration_supported()) {
	198	if (!(pvmw->flags & PVMW_MIGRATION))
	199	return not_found(pvmw);
	200	if (is_migration_entry(pmd_to_swp_entry(*pvmw->pmd))) {
	201	swp_entry_t entry = pmd_to_swp_entry(*pvmw->pmd);
	202
	203	if (migration_entry_to_page(entry) != page)
	204	return not_found(pvmw);
	205	return true;
	206	}
af0db981	207	}
616b8371	208	return not_found(pvmw);
ace71a19 KS	209	} else {
	210	/* THP pmd was split under us: handle on pte level */
	211	spin_unlock(pvmw->ptl);
	212	pvmw->ptl = NULL;
	213	}
a7b10095 WD	214	} else if (!pmd_present(pmde)) {
a7b10095 WD	215	return false;
ace71a19 KS	216	}
	217	if (!map_pte(pvmw))
	218	goto next_pte;
	219	while (1) {
	220	if (check_pte(pvmw))
	221	return true;
d75450ff HD	222	next_pte:
	223	/* Seek to next pte only makes sense for THP */
	224	if (!PageTransHuge(pvmw->page) \|\| PageHuge(pvmw->page))
	225	return not_found(pvmw);
	226	do {
ace71a19	227	pvmw->address += PAGE_SIZE;
d75450ff HD	228	if (pvmw->address >= pvmw->vma->vm_end \|\|
d75450ff HD	229	pvmw->address >=
ace71a19	230	__vma_address(pvmw->page, pvmw->vma) +
af3bbc12	231	thp_size(pvmw->page))
ace71a19 KS	232	return not_found(pvmw);
	233	/* Did we cross page table boundary? */
	234	if (pvmw->address % PMD_SIZE == 0) {
	235	pte_unmap(pvmw->pte);
	236	if (pvmw->ptl) {
	237	spin_unlock(pvmw->ptl);
	238	pvmw->ptl = NULL;
	239	}
	240	goto restart;
	241	} else {
	242	pvmw->pte++;
	243	}
	244	} while (pte_none(*pvmw->pte));
	245
	246	if (!pvmw->ptl) {
	247	pvmw->ptl = pte_lockptr(mm, pvmw->pmd);
	248	spin_lock(pvmw->ptl);
	249	}
	250	}
	251	}
6a328a62 KS	252
	253	/**
	254	* page_mapped_in_vma - check whether a page is really mapped in a VMA
	255	* @page: the page to test
	256	* @vma: the VMA to test
	257	*
	258	* Returns 1 if the page is mapped into the page tables of the VMA, 0
	259	* if the page is not mapped into the page tables of this VMA. Only
	260	* valid for normal file or anonymous VMAs.
	261	*/
	262	int page_mapped_in_vma(struct page page, struct vm_area_struct vma)
	263	{
	264	struct page_vma_mapped_walk pvmw = {
	265	.page = page,
	266	.vma = vma,
	267	.flags = PVMW_SYNC,
	268	};
	269	unsigned long start, end;
	270
	271	start = __vma_address(page, vma);
af3bbc12	272	end = start + thp_size(page) - PAGE_SIZE;
6a328a62 KS	273
	274	if (unlikely(end < vma->vm_start \|\| start >= vma->vm_end))
	275	return 0;
	276	pvmw.address = max(start, vma->vm_start);
	277	if (!page_vma_mapped_walk(&pvmw))
	278	return 0;
	279	page_vma_mapped_walk_done(&pvmw);
	280	return 1;
	281	}