[linux-block.git] / include / linux / pfn_t.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_PFN_T_H_
#define _LINUX_PFN_T_H_
#include <linux/mm.h>

/*
 * PFN_FLAGS_MASK - mask of all the possible valid pfn_t flags
 * PFN_SG_CHAIN - pfn is a pointer to the next scatterlist entry
 * PFN_SG_LAST - pfn references a page and is the last scatterlist entry
 * PFN_DEV - pfn is not covered by system memmap by default
 * PFN_MAP - pfn has a dynamic page mapping established by a device driver
 * PFN_SPECIAL - for CONFIG_FS_DAX_LIMITED builds to allow XIP, but not
 *		 get_user_pages
 */
#define PFN_FLAGS_MASK (((u64) (~PAGE_MASK)) << (BITS_PER_LONG_LONG - PAGE_SHIFT))
#define PFN_SG_CHAIN (1ULL << (BITS_PER_LONG_LONG - 1))
#define PFN_SG_LAST (1ULL << (BITS_PER_LONG_LONG - 2))
#define PFN_DEV (1ULL << (BITS_PER_LONG_LONG - 3))
#define PFN_MAP (1ULL << (BITS_PER_LONG_LONG - 4))
#define PFN_SPECIAL (1ULL << (BITS_PER_LONG_LONG - 5))

#define PFN_FLAGS_TRACE \
	{ PFN_SPECIAL,	"SPECIAL" }, \
	{ PFN_SG_CHAIN,	"SG_CHAIN" }, \
	{ PFN_SG_LAST,	"SG_LAST" }, \
	{ PFN_DEV,	"DEV" }, \
	{ PFN_MAP,	"MAP" }

static inline pfn_t __pfn_to_pfn_t(unsigned long pfn, u64 flags)
{
	pfn_t pfn_t = { .val = pfn | (flags & PFN_FLAGS_MASK), };

	return pfn_t;
}

/* a default pfn to pfn_t conversion assumes that @pfn is pfn_valid() */
static inline pfn_t pfn_to_pfn_t(unsigned long pfn)
{
	return __pfn_to_pfn_t(pfn, 0);
}

static inline pfn_t phys_to_pfn_t(phys_addr_t addr, u64 flags)
{
	return __pfn_to_pfn_t(addr >> PAGE_SHIFT, flags);
}

static inline bool pfn_t_has_page(pfn_t pfn)
{
	return (pfn.val & PFN_MAP) == PFN_MAP || (pfn.val & PFN_DEV) == 0;
}

static inline unsigned long pfn_t_to_pfn(pfn_t pfn)
{
	return pfn.val & ~PFN_FLAGS_MASK;
}

static inline struct page *pfn_t_to_page(pfn_t pfn)
{
	if (pfn_t_has_page(pfn))
		return pfn_to_page(pfn_t_to_pfn(pfn));
	return NULL;
}

static inline phys_addr_t pfn_t_to_phys(pfn_t pfn)
{
	return PFN_PHYS(pfn_t_to_pfn(pfn));
}

static inline void *pfn_t_to_virt(pfn_t pfn)
{
	if (pfn_t_has_page(pfn))
		return __va(pfn_t_to_phys(pfn));
	return NULL;
}

static inline pfn_t page_to_pfn_t(struct page *page)
{
	return pfn_to_pfn_t(page_to_pfn(page));
}

static inline int pfn_t_valid(pfn_t pfn)
{
	return pfn_valid(pfn_t_to_pfn(pfn));
}

#ifdef CONFIG_MMU
static inline pte_t pfn_t_pte(pfn_t pfn, pgprot_t pgprot)
{
	return pfn_pte(pfn_t_to_pfn(pfn), pgprot);
}
#endif

#ifdef CONFIG_TRANSPARENT_HUGEPAGE
static inline pmd_t pfn_t_pmd(pfn_t pfn, pgprot_t pgprot)
{
	return pfn_pmd(pfn_t_to_pfn(pfn), pgprot);
}

#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
static inline pud_t pfn_t_pud(pfn_t pfn, pgprot_t pgprot)
{
	return pfn_pud(pfn_t_to_pfn(pfn), pgprot);
}
#endif
#endif

#ifdef __HAVE_ARCH_PTE_DEVMAP
static inline bool pfn_t_devmap(pfn_t pfn)
{
	const u64 flags = PFN_DEV|PFN_MAP;

	return (pfn.val & flags) == flags;
}
#else
static inline bool pfn_t_devmap(pfn_t pfn)
{
	return false;
}
pte_t pte_mkdevmap(pte_t pte);
pmd_t pmd_mkdevmap(pmd_t pmd);
#if defined(CONFIG_TRANSPARENT_HUGEPAGE) && \
	defined(CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD)
pud_t pud_mkdevmap(pud_t pud);
#endif
#endif /* __HAVE_ARCH_PTE_DEVMAP */

#ifdef CONFIG_ARCH_HAS_PTE_SPECIAL
static inline bool pfn_t_special(pfn_t pfn)
{
	return (pfn.val & PFN_SPECIAL) == PFN_SPECIAL;
}
#else
static inline bool pfn_t_special(pfn_t pfn)
{
	return false;
}
#endif /* CONFIG_ARCH_HAS_PTE_SPECIAL */
#endif /* _LINUX_PFN_T_H_ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
34c0fd54 DW	2	#ifndef _LINUX_PFN_T_H_
	3	#define _LINUX_PFN_T_H_
	4	#include <linux/mm.h>
	5
	6	/*
	7	* PFN_FLAGS_MASK - mask of all the possible valid pfn_t flags
	8	* PFN_SG_CHAIN - pfn is a pointer to the next scatterlist entry
	9	* PFN_SG_LAST - pfn references a page and is the last scatterlist entry
	10	* PFN_DEV - pfn is not covered by system memmap by default
	11	* PFN_MAP - pfn has a dynamic page mapping established by a device driver
cc4b8c79 YS	12	* PFN_SPECIAL - for CONFIG_FS_DAX_LIMITED builds to allow XIP, but not
cc4b8c79 YS	13	* get_user_pages
34c0fd54	14	*/
4d54954a	15	#define PFN_FLAGS_MASK (((u64) (~PAGE_MASK)) << (BITS_PER_LONG_LONG - PAGE_SHIFT))
db78c222 DW	16	#define PFN_SG_CHAIN (1ULL << (BITS_PER_LONG_LONG - 1))
	17	#define PFN_SG_LAST (1ULL << (BITS_PER_LONG_LONG - 2))
	18	#define PFN_DEV (1ULL << (BITS_PER_LONG_LONG - 3))
	19	#define PFN_MAP (1ULL << (BITS_PER_LONG_LONG - 4))
785a3fab	20	#define PFN_SPECIAL (1ULL << (BITS_PER_LONG_LONG - 5))
db78c222	21
27a7ffac	22	#define PFN_FLAGS_TRACE \
785a3fab	23	{ PFN_SPECIAL, "SPECIAL" }, \
27a7ffac RZ	24	{ PFN_SG_CHAIN, "SG_CHAIN" }, \
	25	{ PFN_SG_LAST, "SG_LAST" }, \
	26	{ PFN_DEV, "DEV" }, \
	27	{ PFN_MAP, "MAP" }
	28
db78c222	29	static inline pfn_t __pfn_to_pfn_t(unsigned long pfn, u64 flags)
34c0fd54 DW	30	{
	31	pfn_t pfn_t = { .val = pfn \| (flags & PFN_FLAGS_MASK), };
	32
	33	return pfn_t;
	34	}
	35
	36	/* a default pfn to pfn_t conversion assumes that @pfn is pfn_valid() */
	37	static inline pfn_t pfn_to_pfn_t(unsigned long pfn)
	38	{
	39	return __pfn_to_pfn_t(pfn, 0);
	40	}
	41
f295e53b DW	42	static inline pfn_t phys_to_pfn_t(phys_addr_t addr, u64 flags)
	43	{
	44	return __pfn_to_pfn_t(addr >> PAGE_SHIFT, flags);
	45	}
34c0fd54 DW	46
	47	static inline bool pfn_t_has_page(pfn_t pfn)
	48	{
	49	return (pfn.val & PFN_MAP) == PFN_MAP \|\| (pfn.val & PFN_DEV) == 0;
	50	}
	51
	52	static inline unsigned long pfn_t_to_pfn(pfn_t pfn)
	53	{
	54	return pfn.val & ~PFN_FLAGS_MASK;
	55	}
	56
	57	static inline struct page *pfn_t_to_page(pfn_t pfn)
	58	{
	59	if (pfn_t_has_page(pfn))
	60	return pfn_to_page(pfn_t_to_pfn(pfn));
	61	return NULL;
	62	}
	63
76e9f0ee	64	static inline phys_addr_t pfn_t_to_phys(pfn_t pfn)
34c0fd54 DW	65	{
	66	return PFN_PHYS(pfn_t_to_pfn(pfn));
	67	}
	68
	69	static inline void *pfn_t_to_virt(pfn_t pfn)
	70	{
	71	if (pfn_t_has_page(pfn))
	72	return __va(pfn_t_to_phys(pfn));
	73	return NULL;
	74	}
	75
	76	static inline pfn_t page_to_pfn_t(struct page *page)
	77	{
	78	return pfn_to_pfn_t(page_to_pfn(page));
	79	}
01c8f1c4 DW	80
	81	static inline int pfn_t_valid(pfn_t pfn)
	82	{
	83	return pfn_valid(pfn_t_to_pfn(pfn));
	84	}
	85
	86	#ifdef CONFIG_MMU
	87	static inline pte_t pfn_t_pte(pfn_t pfn, pgprot_t pgprot)
	88	{
	89	return pfn_pte(pfn_t_to_pfn(pfn), pgprot);
	90	}
	91	#endif
	92
f25748e3 DW	93	#ifdef CONFIG_TRANSPARENT_HUGEPAGE
	94	static inline pmd_t pfn_t_pmd(pfn_t pfn, pgprot_t pgprot)
	95	{
	96	return pfn_pmd(pfn_t_to_pfn(pfn), pgprot);
	97	}
a00cc7d9 MW	98
	99	#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
	100	static inline pud_t pfn_t_pud(pfn_t pfn, pgprot_t pgprot)
	101	{
	102	return pfn_pud(pfn_t_to_pfn(pfn), pgprot);
	103	}
	104	#endif
f25748e3 DW	105	#endif
f25748e3 DW	106
01c8f1c4 DW	107	#ifdef __HAVE_ARCH_PTE_DEVMAP
	108	static inline bool pfn_t_devmap(pfn_t pfn)
	109	{
db78c222	110	const u64 flags = PFN_DEV\|PFN_MAP;
01c8f1c4 DW	111
	112	return (pfn.val & flags) == flags;
	113	}
	114	#else
	115	static inline bool pfn_t_devmap(pfn_t pfn)
	116	{
	117	return false;
	118	}
	119	pte_t pte_mkdevmap(pte_t pte);
f25748e3	120	pmd_t pmd_mkdevmap(pmd_t pmd);
a00cc7d9 MW	121	#if defined(CONFIG_TRANSPARENT_HUGEPAGE) && \
	122	defined(CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD)
	123	pud_t pud_mkdevmap(pud_t pud);
01c8f1c4	124	#endif
a00cc7d9 MW	125	#endif /* __HAVE_ARCH_PTE_DEVMAP */
a00cc7d9 MW	126
3010a5ea	127	#ifdef CONFIG_ARCH_HAS_PTE_SPECIAL
785a3fab DW	128	static inline bool pfn_t_special(pfn_t pfn)
	129	{
	130	return (pfn.val & PFN_SPECIAL) == PFN_SPECIAL;
	131	}
	132	#else
	133	static inline bool pfn_t_special(pfn_t pfn)
	134	{
	135	return false;
	136	}
3010a5ea	137	#endif /* CONFIG_ARCH_HAS_PTE_SPECIAL */
34c0fd54	138	#endif /* _LINUX_PFN_T_H_ */