[mirror_ubuntu-bionic-kernel.git] / arch / x86 / include / asm / pgtable_types.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _ASM_X86_PGTABLE_DEFS_H
#define _ASM_X86_PGTABLE_DEFS_H

#include <linux/const.h>
#include <linux/mem_encrypt.h>

#include <asm/page_types.h>

#define FIRST_USER_ADDRESS	0UL

#define _PAGE_BIT_PRESENT	0	/* is present */
#define _PAGE_BIT_RW		1	/* writeable */
#define _PAGE_BIT_USER		2	/* userspace addressable */
#define _PAGE_BIT_PWT		3	/* page write through */
#define _PAGE_BIT_PCD		4	/* page cache disabled */
#define _PAGE_BIT_ACCESSED	5	/* was accessed (raised by CPU) */
#define _PAGE_BIT_DIRTY		6	/* was written to (raised by CPU) */
#define _PAGE_BIT_PSE		7	/* 4 MB (or 2MB) page */
#define _PAGE_BIT_PAT		7	/* on 4KB pages */
#define _PAGE_BIT_GLOBAL	8	/* Global TLB entry PPro+ */
#define _PAGE_BIT_SOFTW1	9	/* available for programmer */
#define _PAGE_BIT_SOFTW2	10	/* " */
#define _PAGE_BIT_SOFTW3	11	/* " */
#define _PAGE_BIT_PAT_LARGE	12	/* On 2MB or 1GB pages */
#define _PAGE_BIT_SOFTW4	58	/* available for programmer */
#define _PAGE_BIT_PKEY_BIT0	59	/* Protection Keys, bit 1/4 */
#define _PAGE_BIT_PKEY_BIT1	60	/* Protection Keys, bit 2/4 */
#define _PAGE_BIT_PKEY_BIT2	61	/* Protection Keys, bit 3/4 */
#define _PAGE_BIT_PKEY_BIT3	62	/* Protection Keys, bit 4/4 */
#define _PAGE_BIT_NX		63	/* No execute: only valid after cpuid check */

#define _PAGE_BIT_SPECIAL	_PAGE_BIT_SOFTW1
#define _PAGE_BIT_CPA_TEST	_PAGE_BIT_SOFTW1
#define _PAGE_BIT_HIDDEN	_PAGE_BIT_SOFTW3 /* hidden by kmemcheck */
#define _PAGE_BIT_SOFT_DIRTY	_PAGE_BIT_SOFTW3 /* software dirty tracking */
#define _PAGE_BIT_DEVMAP	_PAGE_BIT_SOFTW4

/* If _PAGE_BIT_PRESENT is clear, we use these: */
/* - if the user mapped it with PROT_NONE; pte_present gives true */
#define _PAGE_BIT_PROTNONE	_PAGE_BIT_GLOBAL

#define _PAGE_PRESENT	(_AT(pteval_t, 1) << _PAGE_BIT_PRESENT)
#define _PAGE_RW	(_AT(pteval_t, 1) << _PAGE_BIT_RW)
#define _PAGE_USER	(_AT(pteval_t, 1) << _PAGE_BIT_USER)
#define _PAGE_PWT	(_AT(pteval_t, 1) << _PAGE_BIT_PWT)
#define _PAGE_PCD	(_AT(pteval_t, 1) << _PAGE_BIT_PCD)
#define _PAGE_ACCESSED	(_AT(pteval_t, 1) << _PAGE_BIT_ACCESSED)
#define _PAGE_DIRTY	(_AT(pteval_t, 1) << _PAGE_BIT_DIRTY)
#define _PAGE_PSE	(_AT(pteval_t, 1) << _PAGE_BIT_PSE)
#define _PAGE_GLOBAL	(_AT(pteval_t, 1) << _PAGE_BIT_GLOBAL)
#define _PAGE_SOFTW1	(_AT(pteval_t, 1) << _PAGE_BIT_SOFTW1)
#define _PAGE_SOFTW2	(_AT(pteval_t, 1) << _PAGE_BIT_SOFTW2)
#define _PAGE_PAT	(_AT(pteval_t, 1) << _PAGE_BIT_PAT)
#define _PAGE_PAT_LARGE (_AT(pteval_t, 1) << _PAGE_BIT_PAT_LARGE)
#define _PAGE_SPECIAL	(_AT(pteval_t, 1) << _PAGE_BIT_SPECIAL)
#define _PAGE_CPA_TEST	(_AT(pteval_t, 1) << _PAGE_BIT_CPA_TEST)
#ifdef CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS
#define _PAGE_PKEY_BIT0	(_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT0)
#define _PAGE_PKEY_BIT1	(_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT1)
#define _PAGE_PKEY_BIT2	(_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT2)
#define _PAGE_PKEY_BIT3	(_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT3)
#else
#define _PAGE_PKEY_BIT0	(_AT(pteval_t, 0))
#define _PAGE_PKEY_BIT1	(_AT(pteval_t, 0))
#define _PAGE_PKEY_BIT2	(_AT(pteval_t, 0))
#define _PAGE_PKEY_BIT3	(_AT(pteval_t, 0))
#endif
#define __HAVE_ARCH_PTE_SPECIAL

#define _PAGE_PKEY_MASK (_PAGE_PKEY_BIT0 | \
			 _PAGE_PKEY_BIT1 | \
			 _PAGE_PKEY_BIT2 | \
			 _PAGE_PKEY_BIT3)

#if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
#define _PAGE_KNL_ERRATUM_MASK (_PAGE_DIRTY | _PAGE_ACCESSED)
#else
#define _PAGE_KNL_ERRATUM_MASK 0
#endif

#ifdef CONFIG_KMEMCHECK
#define _PAGE_HIDDEN	(_AT(pteval_t, 1) << _PAGE_BIT_HIDDEN)
#else
#define _PAGE_HIDDEN	(_AT(pteval_t, 0))
#endif

/*
 * The same hidden bit is used by kmemcheck, but since kmemcheck
 * works on kernel pages while soft-dirty engine on user space,
 * they do not conflict with each other.
 */

#ifdef CONFIG_MEM_SOFT_DIRTY
#define _PAGE_SOFT_DIRTY	(_AT(pteval_t, 1) << _PAGE_BIT_SOFT_DIRTY)
#else
#define _PAGE_SOFT_DIRTY	(_AT(pteval_t, 0))
#endif

/*
 * Tracking soft dirty bit when a page goes to a swap is tricky.
 * We need a bit which can be stored in pte _and_ not conflict
 * with swap entry format. On x86 bits 1-4 are *not* involved
 * into swap entry computation, but bit 7 is used for thp migration,
 * so we borrow bit 1 for soft dirty tracking.
 *
 * Please note that this bit must be treated as swap dirty page
 * mark if and only if the PTE/PMD has present bit clear!
 */
#ifdef CONFIG_MEM_SOFT_DIRTY
#define _PAGE_SWP_SOFT_DIRTY	_PAGE_RW
#else
#define _PAGE_SWP_SOFT_DIRTY	(_AT(pteval_t, 0))
#endif

#if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
#define _PAGE_NX	(_AT(pteval_t, 1) << _PAGE_BIT_NX)
#define _PAGE_DEVMAP	(_AT(u64, 1) << _PAGE_BIT_DEVMAP)
#define __HAVE_ARCH_PTE_DEVMAP
#else
#define _PAGE_NX	(_AT(pteval_t, 0))
#define _PAGE_DEVMAP	(_AT(pteval_t, 0))
#endif

#define _PAGE_PROTNONE	(_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)

#define _PAGE_TABLE_NOENC	(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER |\
				 _PAGE_ACCESSED | _PAGE_DIRTY)
#define _KERNPG_TABLE_NOENC	(_PAGE_PRESENT | _PAGE_RW |		\
				 _PAGE_ACCESSED | _PAGE_DIRTY)

/*
 * Set of bits not changed in pte_modify.  The pte's
 * protection key is treated like _PAGE_RW, for
 * instance, and is *not* included in this mask since
 * pte_modify() does modify it.
 */
#define _PAGE_CHG_MASK	(PTE_PFN_MASK | _PAGE_PCD | _PAGE_PWT |		\
			 _PAGE_SPECIAL | _PAGE_ACCESSED | _PAGE_DIRTY |	\
			 _PAGE_SOFT_DIRTY)
#define _HPAGE_CHG_MASK (_PAGE_CHG_MASK | _PAGE_PSE)

/*
 * The cache modes defined here are used to translate between pure SW usage
 * and the HW defined cache mode bits and/or PAT entries.
 *
 * The resulting bits for PWT, PCD and PAT should be chosen in a way
 * to have the WB mode at index 0 (all bits clear). This is the default
 * right now and likely would break too much if changed.
 */
#ifndef __ASSEMBLY__
enum page_cache_mode {
	_PAGE_CACHE_MODE_WB = 0,
	_PAGE_CACHE_MODE_WC = 1,
	_PAGE_CACHE_MODE_UC_MINUS = 2,
	_PAGE_CACHE_MODE_UC = 3,
	_PAGE_CACHE_MODE_WT = 4,
	_PAGE_CACHE_MODE_WP = 5,
	_PAGE_CACHE_MODE_NUM = 8
};
#endif

#define _PAGE_CACHE_MASK	(_PAGE_PAT | _PAGE_PCD | _PAGE_PWT)
#define _PAGE_NOCACHE		(cachemode2protval(_PAGE_CACHE_MODE_UC))
#define _PAGE_CACHE_WP		(cachemode2protval(_PAGE_CACHE_MODE_WP))

#define PAGE_NONE	__pgprot(_PAGE_PROTNONE | _PAGE_ACCESSED)
#define PAGE_SHARED	__pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | \
				 _PAGE_ACCESSED | _PAGE_NX)

#define PAGE_SHARED_EXEC	__pgprot(_PAGE_PRESENT | _PAGE_RW |	\
					 _PAGE_USER | _PAGE_ACCESSED)
#define PAGE_COPY_NOEXEC	__pgprot(_PAGE_PRESENT | _PAGE_USER |	\
					 _PAGE_ACCESSED | _PAGE_NX)
#define PAGE_COPY_EXEC		__pgprot(_PAGE_PRESENT | _PAGE_USER |	\
					 _PAGE_ACCESSED)
#define PAGE_COPY		PAGE_COPY_NOEXEC
#define PAGE_READONLY		__pgprot(_PAGE_PRESENT | _PAGE_USER |	\
					 _PAGE_ACCESSED | _PAGE_NX)
#define PAGE_READONLY_EXEC	__pgprot(_PAGE_PRESENT | _PAGE_USER |	\
					 _PAGE_ACCESSED)

#define __PAGE_KERNEL_EXEC						\
	(_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED | _PAGE_GLOBAL)
#define __PAGE_KERNEL		(__PAGE_KERNEL_EXEC | _PAGE_NX)

#define __PAGE_KERNEL_RO		(__PAGE_KERNEL & ~_PAGE_RW)
#define __PAGE_KERNEL_RX		(__PAGE_KERNEL_EXEC & ~_PAGE_RW)
#define __PAGE_KERNEL_NOCACHE		(__PAGE_KERNEL | _PAGE_NOCACHE)
#define __PAGE_KERNEL_VSYSCALL		(__PAGE_KERNEL_RX | _PAGE_USER)
#define __PAGE_KERNEL_VVAR		(__PAGE_KERNEL_RO | _PAGE_USER)
#define __PAGE_KERNEL_LARGE		(__PAGE_KERNEL | _PAGE_PSE)
#define __PAGE_KERNEL_LARGE_EXEC	(__PAGE_KERNEL_EXEC | _PAGE_PSE)
#define __PAGE_KERNEL_WP		(__PAGE_KERNEL | _PAGE_CACHE_WP)

#define __PAGE_KERNEL_IO		(__PAGE_KERNEL)
#define __PAGE_KERNEL_IO_NOCACHE	(__PAGE_KERNEL_NOCACHE)

#ifndef __ASSEMBLY__

#define _PAGE_ENC	(_AT(pteval_t, sme_me_mask))

#define _KERNPG_TABLE	(_PAGE_PRESENT | _PAGE_RW | _PAGE_ACCESSED |	\
			 _PAGE_DIRTY | _PAGE_ENC)
#define _PAGE_TABLE	(_KERNPG_TABLE | _PAGE_USER)

#define __PAGE_KERNEL_ENC	(__PAGE_KERNEL | _PAGE_ENC)
#define __PAGE_KERNEL_ENC_WP	(__PAGE_KERNEL_WP | _PAGE_ENC)

#define __PAGE_KERNEL_NOENC	(__PAGE_KERNEL)
#define __PAGE_KERNEL_NOENC_WP	(__PAGE_KERNEL_WP)

#define PAGE_KERNEL		__pgprot(__PAGE_KERNEL | _PAGE_ENC)
#define PAGE_KERNEL_NOENC	__pgprot(__PAGE_KERNEL)
#define PAGE_KERNEL_RO		__pgprot(__PAGE_KERNEL_RO | _PAGE_ENC)
#define PAGE_KERNEL_EXEC	__pgprot(__PAGE_KERNEL_EXEC | _PAGE_ENC)
#define PAGE_KERNEL_EXEC_NOENC	__pgprot(__PAGE_KERNEL_EXEC)
#define PAGE_KERNEL_RX		__pgprot(__PAGE_KERNEL_RX | _PAGE_ENC)
#define PAGE_KERNEL_NOCACHE	__pgprot(__PAGE_KERNEL_NOCACHE | _PAGE_ENC)
#define PAGE_KERNEL_LARGE	__pgprot(__PAGE_KERNEL_LARGE | _PAGE_ENC)
#define PAGE_KERNEL_LARGE_EXEC	__pgprot(__PAGE_KERNEL_LARGE_EXEC | _PAGE_ENC)
#define PAGE_KERNEL_VSYSCALL	__pgprot(__PAGE_KERNEL_VSYSCALL | _PAGE_ENC)
#define PAGE_KERNEL_VVAR	__pgprot(__PAGE_KERNEL_VVAR | _PAGE_ENC)

#define PAGE_KERNEL_IO		__pgprot(__PAGE_KERNEL_IO)
#define PAGE_KERNEL_IO_NOCACHE	__pgprot(__PAGE_KERNEL_IO_NOCACHE)

#endif	/* __ASSEMBLY__ */

/*         xwr */
#define __P000	PAGE_NONE
#define __P001	PAGE_READONLY
#define __P010	PAGE_COPY
#define __P011	PAGE_COPY
#define __P100	PAGE_READONLY_EXEC
#define __P101	PAGE_READONLY_EXEC
#define __P110	PAGE_COPY_EXEC
#define __P111	PAGE_COPY_EXEC

#define __S000	PAGE_NONE
#define __S001	PAGE_READONLY
#define __S010	PAGE_SHARED
#define __S011	PAGE_SHARED
#define __S100	PAGE_READONLY_EXEC
#define __S101	PAGE_READONLY_EXEC
#define __S110	PAGE_SHARED_EXEC
#define __S111	PAGE_SHARED_EXEC

/*
 * early identity mapping  pte attrib macros.
 */
#ifdef CONFIG_X86_64
#define __PAGE_KERNEL_IDENT_LARGE_EXEC	__PAGE_KERNEL_LARGE_EXEC
#else
#define PTE_IDENT_ATTR	 0x003		/* PRESENT+RW */
#define PDE_IDENT_ATTR	 0x063		/* PRESENT+RW+DIRTY+ACCESSED */
#define PGD_IDENT_ATTR	 0x001		/* PRESENT (no other attributes) */
#endif

#ifdef CONFIG_X86_32
# include <asm/pgtable_32_types.h>
#else
# include <asm/pgtable_64_types.h>
#endif

#ifndef __ASSEMBLY__

#include <linux/types.h>

/* Extracts the PFN from a (pte|pmd|pud|pgd)val_t of a 4KB page */
#define PTE_PFN_MASK		((pteval_t)PHYSICAL_PAGE_MASK)

/*
 *  Extracts the flags from a (pte|pmd|pud|pgd)val_t
 *  This includes the protection key value.
 */
#define PTE_FLAGS_MASK		(~PTE_PFN_MASK)

typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;

typedef struct { pgdval_t pgd; } pgd_t;

static inline pgd_t native_make_pgd(pgdval_t val)
{
	return (pgd_t) { val };
}

static inline pgdval_t native_pgd_val(pgd_t pgd)
{
	return pgd.pgd;
}

static inline pgdval_t pgd_flags(pgd_t pgd)
{
	return native_pgd_val(pgd) & PTE_FLAGS_MASK;
}

#if CONFIG_PGTABLE_LEVELS > 4
typedef struct { p4dval_t p4d; } p4d_t;

static inline p4d_t native_make_p4d(pudval_t val)
{
	return (p4d_t) { val };
}

static inline p4dval_t native_p4d_val(p4d_t p4d)
{
	return p4d.p4d;
}
#else
#include <asm-generic/pgtable-nop4d.h>

static inline p4d_t native_make_p4d(pudval_t val)
{
	return (p4d_t) { .pgd = native_make_pgd((pgdval_t)val) };
}

static inline p4dval_t native_p4d_val(p4d_t p4d)
{
	return native_pgd_val(p4d.pgd);
}
#endif

#if CONFIG_PGTABLE_LEVELS > 3
typedef struct { pudval_t pud; } pud_t;

static inline pud_t native_make_pud(pmdval_t val)
{
	return (pud_t) { val };
}

static inline pudval_t native_pud_val(pud_t pud)
{
	return pud.pud;
}
#else
#include <asm-generic/pgtable-nopud.h>

static inline pudval_t native_pud_val(pud_t pud)
{
	return native_pgd_val(pud.p4d.pgd);
}
#endif

#if CONFIG_PGTABLE_LEVELS > 2
typedef struct { pmdval_t pmd; } pmd_t;

static inline pmd_t native_make_pmd(pmdval_t val)
{
	return (pmd_t) { val };
}

static inline pmdval_t native_pmd_val(pmd_t pmd)
{
	return pmd.pmd;
}
#else
#include <asm-generic/pgtable-nopmd.h>

static inline pmdval_t native_pmd_val(pmd_t pmd)
{
	return native_pgd_val(pmd.pud.p4d.pgd);
}
#endif

static inline p4dval_t p4d_pfn_mask(p4d_t p4d)
{
	/* No 512 GiB huge pages yet */
	return PTE_PFN_MASK;
}

static inline p4dval_t p4d_flags_mask(p4d_t p4d)
{
	return ~p4d_pfn_mask(p4d);
}

static inline p4dval_t p4d_flags(p4d_t p4d)
{
	return native_p4d_val(p4d) & p4d_flags_mask(p4d);
}

static inline pudval_t pud_pfn_mask(pud_t pud)
{
	if (native_pud_val(pud) & _PAGE_PSE)
		return PHYSICAL_PUD_PAGE_MASK;
	else
		return PTE_PFN_MASK;
}

static inline pudval_t pud_flags_mask(pud_t pud)
{
	return ~pud_pfn_mask(pud);
}

static inline pudval_t pud_flags(pud_t pud)
{
	return native_pud_val(pud) & pud_flags_mask(pud);
}

static inline pmdval_t pmd_pfn_mask(pmd_t pmd)
{
	if (native_pmd_val(pmd) & _PAGE_PSE)
		return PHYSICAL_PMD_PAGE_MASK;
	else
		return PTE_PFN_MASK;
}

static inline pmdval_t pmd_flags_mask(pmd_t pmd)
{
	return ~pmd_pfn_mask(pmd);
}

static inline pmdval_t pmd_flags(pmd_t pmd)
{
	return native_pmd_val(pmd) & pmd_flags_mask(pmd);
}

static inline pte_t native_make_pte(pteval_t val)
{
	return (pte_t) { .pte = val };
}

static inline pteval_t native_pte_val(pte_t pte)
{
	return pte.pte;
}

static inline pteval_t pte_flags(pte_t pte)
{
	return native_pte_val(pte) & PTE_FLAGS_MASK;
}

#define pgprot_val(x)	((x).pgprot)
#define __pgprot(x)	((pgprot_t) { (x) } )

extern uint16_t __cachemode2pte_tbl[_PAGE_CACHE_MODE_NUM];
extern uint8_t __pte2cachemode_tbl[8];

#define __pte2cm_idx(cb)				\
	((((cb) >> (_PAGE_BIT_PAT - 2)) & 4) |		\
	 (((cb) >> (_PAGE_BIT_PCD - 1)) & 2) |		\
	 (((cb) >> _PAGE_BIT_PWT) & 1))
#define __cm_idx2pte(i)					\
	((((i) & 4) << (_PAGE_BIT_PAT - 2)) |		\
	 (((i) & 2) << (_PAGE_BIT_PCD - 1)) |		\
	 (((i) & 1) << _PAGE_BIT_PWT))

static inline unsigned long cachemode2protval(enum page_cache_mode pcm)
{
	if (likely(pcm == 0))
		return 0;
	return __cachemode2pte_tbl[pcm];
}
static inline pgprot_t cachemode2pgprot(enum page_cache_mode pcm)
{
	return __pgprot(cachemode2protval(pcm));
}
static inline enum page_cache_mode pgprot2cachemode(pgprot_t pgprot)
{
	unsigned long masked;

	masked = pgprot_val(pgprot) & _PAGE_CACHE_MASK;
	if (likely(masked == 0))
		return 0;
	return __pte2cachemode_tbl[__pte2cm_idx(masked)];
}
static inline pgprot_t pgprot_4k_2_large(pgprot_t pgprot)
{
	pgprotval_t val = pgprot_val(pgprot);
	pgprot_t new;

	pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
		((val & _PAGE_PAT) << (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
	return new;
}
static inline pgprot_t pgprot_large_2_4k(pgprot_t pgprot)
{
	pgprotval_t val = pgprot_val(pgprot);
	pgprot_t new;

	pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
			  ((val & _PAGE_PAT_LARGE) >>
			   (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
	return new;
}


typedef struct page *pgtable_t;

extern pteval_t __supported_pte_mask;
extern void set_nx(void);
extern int nx_enabled;

#define pgprot_writecombine	pgprot_writecombine
extern pgprot_t pgprot_writecombine(pgprot_t prot);

#define pgprot_writethrough	pgprot_writethrough
extern pgprot_t pgprot_writethrough(pgprot_t prot);

/* Indicate that x86 has its own track and untrack pfn vma functions */
#define __HAVE_PFNMAP_TRACKING

#define __HAVE_PHYS_MEM_ACCESS_PROT
struct file;
pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
                              unsigned long size, pgprot_t vma_prot);

/* Install a pte for a particular vaddr in kernel space. */
void set_pte_vaddr(unsigned long vaddr, pte_t pte);

#ifdef CONFIG_X86_32
extern void native_pagetable_init(void);
#else
#define native_pagetable_init        paging_init
#endif

struct seq_file;
extern void arch_report_meminfo(struct seq_file *m);

enum pg_level {
	PG_LEVEL_NONE,
	PG_LEVEL_4K,
	PG_LEVEL_2M,
	PG_LEVEL_1G,
	PG_LEVEL_512G,
	PG_LEVEL_NUM
};

#ifdef CONFIG_PROC_FS
extern void update_page_count(int level, unsigned long pages);
#else
static inline void update_page_count(int level, unsigned long pages) { }
#endif

/*
 * Helper function that returns the kernel pagetable entry controlling
 * the virtual address 'address'. NULL means no pagetable entry present.
 * NOTE: the return type is pte_t but if the pmd is PSE then we return it
 * as a pte too.
 */
extern pte_t *lookup_address(unsigned long address, unsigned int *level);
extern pte_t *lookup_address_in_pgd(pgd_t *pgd, unsigned long address,
				    unsigned int *level);
extern pmd_t *lookup_pmd_address(unsigned long address);
extern phys_addr_t slow_virt_to_phys(void *__address);
extern int kernel_map_pages_in_pgd(pgd_t *pgd, u64 pfn, unsigned long address,
				   unsigned numpages, unsigned long page_flags);
#endif	/* !__ASSEMBLY__ */

#endif /* _ASM_X86_PGTABLE_DEFS_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
8d19c99f JF	2	#ifndef _ASM_X86_PGTABLE_DEFS_H
	3	#define _ASM_X86_PGTABLE_DEFS_H
	4
	5	#include <linux/const.h>
21729f81 TL	6	#include <linux/mem_encrypt.h>
21729f81 TL	7
e43623b4	8	#include <asm/page_types.h>
8d19c99f	9
d016bf7e	10	#define FIRST_USER_ADDRESS 0UL
8d19c99f JF	11
	12	#define _PAGE_BIT_PRESENT 0 /* is present */
	13	#define _PAGE_BIT_RW 1 /* writeable */
	14	#define _PAGE_BIT_USER 2 /* userspace addressable */
	15	#define _PAGE_BIT_PWT 3 /* page write through */
	16	#define _PAGE_BIT_PCD 4 /* page cache disabled */
	17	#define _PAGE_BIT_ACCESSED 5 /* was accessed (raised by CPU) */
	18	#define _PAGE_BIT_DIRTY 6 /* was written to (raised by CPU) */
	19	#define _PAGE_BIT_PSE 7 /* 4 MB (or 2MB) page */
	20	#define _PAGE_BIT_PAT 7 /* on 4KB pages */
	21	#define _PAGE_BIT_GLOBAL 8 /* Global TLB entry PPro+ */
c46a7c81 MG	22	#define _PAGE_BIT_SOFTW1 9 /* available for programmer */
	23	#define _PAGE_BIT_SOFTW2 10 /* " */
	24	#define _PAGE_BIT_SOFTW3 11 /* " */
8d19c99f	25	#define _PAGE_BIT_PAT_LARGE 12 /* On 2MB or 1GB pages */
5c1d90f5 DH	26	#define _PAGE_BIT_SOFTW4 58 /* available for programmer */
	27	#define _PAGE_BIT_PKEY_BIT0 59 /* Protection Keys, bit 1/4 */
	28	#define _PAGE_BIT_PKEY_BIT1 60 /* Protection Keys, bit 2/4 */
	29	#define _PAGE_BIT_PKEY_BIT2 61 /* Protection Keys, bit 3/4 */
	30	#define _PAGE_BIT_PKEY_BIT3 62 /* Protection Keys, bit 4/4 */
	31	#define _PAGE_BIT_NX 63 /* No execute: only valid after cpuid check */
	32
c46a7c81 MG	33	#define _PAGE_BIT_SPECIAL _PAGE_BIT_SOFTW1
c46a7c81 MG	34	#define _PAGE_BIT_CPA_TEST _PAGE_BIT_SOFTW1
c46a7c81 MG	35	#define _PAGE_BIT_HIDDEN _PAGE_BIT_SOFTW3 /* hidden by kmemcheck */
c46a7c81 MG	36	#define _PAGE_BIT_SOFT_DIRTY _PAGE_BIT_SOFTW3 /* software dirty tracking */
5c1d90f5	37	#define _PAGE_BIT_DEVMAP _PAGE_BIT_SOFTW4
8d19c99f JF	38
	39	/* If _PAGE_BIT_PRESENT is clear, we use these: */
	40	/* - if the user mapped it with PROT_NONE; pte_present gives true */
	41	#define _PAGE_BIT_PROTNONE _PAGE_BIT_GLOBAL
8d19c99f JF	42
	43	#define _PAGE_PRESENT (_AT(pteval_t, 1) << _PAGE_BIT_PRESENT)
	44	#define _PAGE_RW (_AT(pteval_t, 1) << _PAGE_BIT_RW)
	45	#define _PAGE_USER (_AT(pteval_t, 1) << _PAGE_BIT_USER)
	46	#define _PAGE_PWT (_AT(pteval_t, 1) << _PAGE_BIT_PWT)
	47	#define _PAGE_PCD (_AT(pteval_t, 1) << _PAGE_BIT_PCD)
	48	#define _PAGE_ACCESSED (_AT(pteval_t, 1) << _PAGE_BIT_ACCESSED)
	49	#define _PAGE_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_DIRTY)
	50	#define _PAGE_PSE (_AT(pteval_t, 1) << _PAGE_BIT_PSE)
	51	#define _PAGE_GLOBAL (_AT(pteval_t, 1) << _PAGE_BIT_GLOBAL)
c46a7c81	52	#define _PAGE_SOFTW1 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW1)
f955371c	53	#define _PAGE_SOFTW2 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW2)
8d19c99f JF	54	#define _PAGE_PAT (_AT(pteval_t, 1) << _PAGE_BIT_PAT)
	55	#define _PAGE_PAT_LARGE (_AT(pteval_t, 1) << _PAGE_BIT_PAT_LARGE)
	56	#define _PAGE_SPECIAL (_AT(pteval_t, 1) << _PAGE_BIT_SPECIAL)
	57	#define _PAGE_CPA_TEST (_AT(pteval_t, 1) << _PAGE_BIT_CPA_TEST)
5c1d90f5 DH	58	#ifdef CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS
	59	#define _PAGE_PKEY_BIT0 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT0)
	60	#define _PAGE_PKEY_BIT1 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT1)
	61	#define _PAGE_PKEY_BIT2 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT2)
	62	#define _PAGE_PKEY_BIT3 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT3)
	63	#else
	64	#define _PAGE_PKEY_BIT0 (_AT(pteval_t, 0))
	65	#define _PAGE_PKEY_BIT1 (_AT(pteval_t, 0))
	66	#define _PAGE_PKEY_BIT2 (_AT(pteval_t, 0))
	67	#define _PAGE_PKEY_BIT3 (_AT(pteval_t, 0))
	68	#endif
8d19c99f JF	69	#define __HAVE_ARCH_PTE_SPECIAL
8d19c99f JF	70
019132ff DH	71	#define _PAGE_PKEY_MASK (_PAGE_PKEY_BIT0 \| \
	72	_PAGE_PKEY_BIT1 \| \
	73	_PAGE_PKEY_BIT2 \| \
	74	_PAGE_PKEY_BIT3)
	75
97e3c602 DH	76	#if defined(CONFIG_X86_64) \|\| defined(CONFIG_X86_PAE)
	77	#define _PAGE_KNL_ERRATUM_MASK (_PAGE_DIRTY \| _PAGE_ACCESSED)
	78	#else
	79	#define _PAGE_KNL_ERRATUM_MASK 0
	80	#endif
	81
9d31c506 JF	82	#ifdef CONFIG_KMEMCHECK
	83	#define _PAGE_HIDDEN (_AT(pteval_t, 1) << _PAGE_BIT_HIDDEN)
	84	#else
	85	#define _PAGE_HIDDEN (_AT(pteval_t, 0))
	86	#endif
	87
0f8975ec PE	88	/*
	89	* The same hidden bit is used by kmemcheck, but since kmemcheck
	90	* works on kernel pages while soft-dirty engine on user space,
	91	* they do not conflict with each other.
	92	*/
	93
	94	#ifdef CONFIG_MEM_SOFT_DIRTY
41bb3476	95	#define _PAGE_SOFT_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_SOFT_DIRTY)
0f8975ec PE	96	#else
	97	#define _PAGE_SOFT_DIRTY (_AT(pteval_t, 0))
	98	#endif
	99
179ef71c CG	100	/*
	101	* Tracking soft dirty bit when a page goes to a swap is tricky.
	102	* We need a bit which can be stored in pte _and_ not conflict
eee4818b NH	103	* with swap entry format. On x86 bits 1-4 are not involved
	104	* into swap entry computation, but bit 7 is used for thp migration,
	105	* so we borrow bit 1 for soft dirty tracking.
fa0f281c CG	106	*
fa0f281c CG	107	* Please note that this bit must be treated as swap dirty page
eee4818b	108	* mark if and only if the PTE/PMD has present bit clear!
179ef71c CG	109	*/
179ef71c CG	110	#ifdef CONFIG_MEM_SOFT_DIRTY
eee4818b	111	#define _PAGE_SWP_SOFT_DIRTY _PAGE_RW
179ef71c CG	112	#else
	113	#define _PAGE_SWP_SOFT_DIRTY (_AT(pteval_t, 0))
	114	#endif
	115
8d19c99f JF	116	#if defined(CONFIG_X86_64) \|\| defined(CONFIG_X86_PAE)
8d19c99f JF	117	#define _PAGE_NX (_AT(pteval_t, 1) << _PAGE_BIT_NX)
69660fd7 DW	118	#define _PAGE_DEVMAP (_AT(u64, 1) << _PAGE_BIT_DEVMAP)
69660fd7 DW	119	#define __HAVE_ARCH_PTE_DEVMAP
8d19c99f JF	120	#else
8d19c99f JF	121	#define _PAGE_NX (_AT(pteval_t, 0))
69660fd7	122	#define _PAGE_DEVMAP (_AT(pteval_t, 0))
8d19c99f JF	123	#endif
8d19c99f JF	124
8d19c99f JF	125	#define _PAGE_PROTNONE (_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)
8d19c99f JF	126
21729f81 TL	127	#define _PAGE_TABLE_NOENC (_PAGE_PRESENT \| _PAGE_RW \| _PAGE_USER \|\
	128	_PAGE_ACCESSED \| _PAGE_DIRTY)
	129	#define _KERNPG_TABLE_NOENC (_PAGE_PRESENT \| _PAGE_RW \| \
	130	_PAGE_ACCESSED \| _PAGE_DIRTY)
8d19c99f	131
8f62c883 DH	132	/*
	133	* Set of bits not changed in pte_modify. The pte's
	134	* protection key is treated like _PAGE_RW, for
	135	* instance, and is not included in this mask since
	136	* pte_modify() does modify it.
	137	*/
8d19c99f	138	#define _PAGE_CHG_MASK (PTE_PFN_MASK \| _PAGE_PCD \| _PAGE_PWT \| \
24f91eba	139	_PAGE_SPECIAL \| _PAGE_ACCESSED \| _PAGE_DIRTY \| \
21d9ee3e MG	140	_PAGE_SOFT_DIRTY)
21d9ee3e MG	141	#define _HPAGE_CHG_MASK (_PAGE_CHG_MASK \| _PAGE_PSE)
8d19c99f	142
281d4078 JG	143	/*
	144	* The cache modes defined here are used to translate between pure SW usage
	145	* and the HW defined cache mode bits and/or PAT entries.
	146	*
	147	* The resulting bits for PWT, PCD and PAT should be chosen in a way
	148	* to have the WB mode at index 0 (all bits clear). This is the default
	149	* right now and likely would break too much if changed.
	150	*/
	151	#ifndef __ASSEMBLY__
	152	enum page_cache_mode {
	153	_PAGE_CACHE_MODE_WB = 0,
	154	_PAGE_CACHE_MODE_WC = 1,
	155	_PAGE_CACHE_MODE_UC_MINUS = 2,
	156	_PAGE_CACHE_MODE_UC = 3,
	157	_PAGE_CACHE_MODE_WT = 4,
	158	_PAGE_CACHE_MODE_WP = 5,
	159	_PAGE_CACHE_MODE_NUM = 8
	160	};
	161	#endif
	162
	163	#define _PAGE_CACHE_MASK (_PAGE_PAT \| _PAGE_PCD \| _PAGE_PWT)
	164	#define _PAGE_NOCACHE (cachemode2protval(_PAGE_CACHE_MODE_UC))
f88a68fa	165	#define _PAGE_CACHE_WP (cachemode2protval(_PAGE_CACHE_MODE_WP))
281d4078	166
8d19c99f JF	167	#define PAGE_NONE __pgprot(_PAGE_PROTNONE \| _PAGE_ACCESSED)
	168	#define PAGE_SHARED __pgprot(_PAGE_PRESENT \| _PAGE_RW \| _PAGE_USER \| \
	169	_PAGE_ACCESSED \| _PAGE_NX)
	170
	171	#define PAGE_SHARED_EXEC __pgprot(_PAGE_PRESENT \| _PAGE_RW \| \
	172	_PAGE_USER \| _PAGE_ACCESSED)
	173	#define PAGE_COPY_NOEXEC __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	174	_PAGE_ACCESSED \| _PAGE_NX)
	175	#define PAGE_COPY_EXEC __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	176	_PAGE_ACCESSED)
	177	#define PAGE_COPY PAGE_COPY_NOEXEC
	178	#define PAGE_READONLY __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	179	_PAGE_ACCESSED \| _PAGE_NX)
	180	#define PAGE_READONLY_EXEC __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	181	_PAGE_ACCESSED)
	182
	183	#define __PAGE_KERNEL_EXEC \
	184	(_PAGE_PRESENT \| _PAGE_RW \| _PAGE_DIRTY \| _PAGE_ACCESSED \| _PAGE_GLOBAL)
	185	#define __PAGE_KERNEL (__PAGE_KERNEL_EXEC \| _PAGE_NX)
	186
	187	#define __PAGE_KERNEL_RO (__PAGE_KERNEL & ~_PAGE_RW)
	188	#define __PAGE_KERNEL_RX (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
87ad0b71	189	#define __PAGE_KERNEL_NOCACHE (__PAGE_KERNEL \| _PAGE_NOCACHE)
8d19c99f	190	#define __PAGE_KERNEL_VSYSCALL (__PAGE_KERNEL_RX \| _PAGE_USER)
9fd67b4e	191	#define __PAGE_KERNEL_VVAR (__PAGE_KERNEL_RO \| _PAGE_USER)
8d19c99f	192	#define __PAGE_KERNEL_LARGE (__PAGE_KERNEL \| _PAGE_PSE)
8d19c99f	193	#define __PAGE_KERNEL_LARGE_EXEC (__PAGE_KERNEL_EXEC \| _PAGE_PSE)
f88a68fa	194	#define __PAGE_KERNEL_WP (__PAGE_KERNEL \| _PAGE_CACHE_WP)
8d19c99f	195
f955371c DV	196	#define __PAGE_KERNEL_IO (__PAGE_KERNEL)
f955371c DV	197	#define __PAGE_KERNEL_IO_NOCACHE (__PAGE_KERNEL_NOCACHE)
8d19c99f	198
21729f81 TL	199	#ifndef __ASSEMBLY__
	200
	201	#define _PAGE_ENC (_AT(pteval_t, sme_me_mask))
	202
21729f81 TL	203	#define _KERNPG_TABLE (_PAGE_PRESENT \| _PAGE_RW \| _PAGE_ACCESSED \| \
21729f81 TL	204	_PAGE_DIRTY \| _PAGE_ENC)
c7da092a	205	#define _PAGE_TABLE (_KERNPG_TABLE \| _PAGE_USER)
21729f81	206
f88a68fa TL	207	#define __PAGE_KERNEL_ENC (__PAGE_KERNEL \| _PAGE_ENC)
	208	#define __PAGE_KERNEL_ENC_WP (__PAGE_KERNEL_WP \| _PAGE_ENC)
	209
	210	#define __PAGE_KERNEL_NOENC (__PAGE_KERNEL)
	211	#define __PAGE_KERNEL_NOENC_WP (__PAGE_KERNEL_WP)
	212
21729f81	213	#define PAGE_KERNEL __pgprot(__PAGE_KERNEL \| _PAGE_ENC)
57bd1905	214	#define PAGE_KERNEL_NOENC __pgprot(__PAGE_KERNEL)
21729f81 TL	215	#define PAGE_KERNEL_RO __pgprot(__PAGE_KERNEL_RO \| _PAGE_ENC)
21729f81 TL	216	#define PAGE_KERNEL_EXEC __pgprot(__PAGE_KERNEL_EXEC \| _PAGE_ENC)
bba4ed01	217	#define PAGE_KERNEL_EXEC_NOENC __pgprot(__PAGE_KERNEL_EXEC)
21729f81 TL	218	#define PAGE_KERNEL_RX __pgprot(__PAGE_KERNEL_RX \| _PAGE_ENC)
	219	#define PAGE_KERNEL_NOCACHE __pgprot(__PAGE_KERNEL_NOCACHE \| _PAGE_ENC)
	220	#define PAGE_KERNEL_LARGE __pgprot(__PAGE_KERNEL_LARGE \| _PAGE_ENC)
	221	#define PAGE_KERNEL_LARGE_EXEC __pgprot(__PAGE_KERNEL_LARGE_EXEC \| _PAGE_ENC)
	222	#define PAGE_KERNEL_VSYSCALL __pgprot(__PAGE_KERNEL_VSYSCALL \| _PAGE_ENC)
	223	#define PAGE_KERNEL_VVAR __pgprot(__PAGE_KERNEL_VVAR \| _PAGE_ENC)
	224
	225	#define PAGE_KERNEL_IO __pgprot(__PAGE_KERNEL_IO)
	226	#define PAGE_KERNEL_IO_NOCACHE __pgprot(__PAGE_KERNEL_IO_NOCACHE)
	227
	228	#endif /* __ASSEMBLY__ */
8d19c99f JF	229
	230	/* xwr */
	231	#define __P000 PAGE_NONE
	232	#define __P001 PAGE_READONLY
	233	#define __P010 PAGE_COPY
	234	#define __P011 PAGE_COPY
	235	#define __P100 PAGE_READONLY_EXEC
	236	#define __P101 PAGE_READONLY_EXEC
	237	#define __P110 PAGE_COPY_EXEC
	238	#define __P111 PAGE_COPY_EXEC
	239
	240	#define __S000 PAGE_NONE
	241	#define __S001 PAGE_READONLY
	242	#define __S010 PAGE_SHARED
	243	#define __S011 PAGE_SHARED
	244	#define __S100 PAGE_READONLY_EXEC
	245	#define __S101 PAGE_READONLY_EXEC
	246	#define __S110 PAGE_SHARED_EXEC
	247	#define __S111 PAGE_SHARED_EXEC
	248
	249	/*
	250	* early identity mapping pte attrib macros.
	251	*/
	252	#ifdef CONFIG_X86_64
	253	#define __PAGE_KERNEL_IDENT_LARGE_EXEC __PAGE_KERNEL_LARGE_EXEC
	254	#else
8d19c99f	255	#define PTE_IDENT_ATTR 0x003 /* PRESENT+RW */
7dda0387	256	#define PDE_IDENT_ATTR 0x063 /* PRESENT+RW+DIRTY+ACCESSED */
8d19c99f JF	257	#define PGD_IDENT_ATTR 0x001 /* PRESENT (no other attributes) */
	258	#endif
	259
54321d94	260	#ifdef CONFIG_X86_32
a1ce3928	261	# include <asm/pgtable_32_types.h>
54321d94	262	#else
a1ce3928	263	# include <asm/pgtable_64_types.h>
54321d94 JF	264	#endif
54321d94 JF	265
8d19c99f JF	266	#ifndef __ASSEMBLY__
8d19c99f JF	267
54321d94 JF	268	#include <linux/types.h>
54321d94 JF	269
4be4c1fb	270	/* Extracts the PFN from a (pte\|pmd\|pud\|pgd)val_t of a 4KB page */
9b3651cb JF	271	#define PTE_PFN_MASK ((pteval_t)PHYSICAL_PAGE_MASK)
9b3651cb JF	272
8f62c883 DH	273	/*
	274	* Extracts the flags from a (pte\|pmd\|pud\|pgd)val_t
	275	* This includes the protection key value.
	276	*/
9b3651cb JF	277	#define PTE_FLAGS_MASK (~PTE_PFN_MASK)
9b3651cb JF	278
54321d94 JF	279	typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;
	280
	281	typedef struct { pgdval_t pgd; } pgd_t;
	282
	283	static inline pgd_t native_make_pgd(pgdval_t val)
	284	{
	285	return (pgd_t) { val };
	286	}
	287
	288	static inline pgdval_t native_pgd_val(pgd_t pgd)
	289	{
	290	return pgd.pgd;
	291	}
	292
	293	static inline pgdval_t pgd_flags(pgd_t pgd)
	294	{
	295	return native_pgd_val(pgd) & PTE_FLAGS_MASK;
	296	}
	297
fe1e8c3e	298	#if CONFIG_PGTABLE_LEVELS > 4
b8504058	299	typedef struct { p4dval_t p4d; } p4d_t;
fe1e8c3e	300
b8504058 KS	301	static inline p4d_t native_make_p4d(pudval_t val)
	302	{
	303	return (p4d_t) { val };
	304	}
fe1e8c3e	305
b8504058 KS	306	static inline p4dval_t native_p4d_val(p4d_t p4d)
	307	{
	308	return p4d.p4d;
	309	}
fe1e8c3e	310	#else
f2a6a705	311	#include <asm-generic/pgtable-nop4d.h>
9849a569	312
db516997 TL	313	static inline p4d_t native_make_p4d(pudval_t val)
	314	{
	315	return (p4d_t) { .pgd = native_make_pgd((pgdval_t)val) };
	316	}
	317
fe1e8c3e KS	318	static inline p4dval_t native_p4d_val(p4d_t p4d)
fe1e8c3e KS	319	{
f2a6a705	320	return native_pgd_val(p4d.pgd);
fe1e8c3e KS	321	}
	322	#endif
	323
	324	#if CONFIG_PGTABLE_LEVELS > 3
54321d94 JF	325	typedef struct { pudval_t pud; } pud_t;
	326
	327	static inline pud_t native_make_pud(pmdval_t val)
	328	{
	329	return (pud_t) { val };
	330	}
	331
	332	static inline pudval_t native_pud_val(pud_t pud)
	333	{
	334	return pud.pud;
	335	}
	336	#else
	337	#include <asm-generic/pgtable-nopud.h>
	338
	339	static inline pudval_t native_pud_val(pud_t pud)
	340	{
f2a6a705	341	return native_pgd_val(pud.p4d.pgd);
54321d94 JF	342	}
	343	#endif
	344
98233368	345	#if CONFIG_PGTABLE_LEVELS > 2
54321d94 JF	346	typedef struct { pmdval_t pmd; } pmd_t;
	347
	348	static inline pmd_t native_make_pmd(pmdval_t val)
	349	{
	350	return (pmd_t) { val };
	351	}
	352
	353	static inline pmdval_t native_pmd_val(pmd_t pmd)
	354	{
	355	return pmd.pmd;
	356	}
	357	#else
	358	#include <asm-generic/pgtable-nopmd.h>
	359
	360	static inline pmdval_t native_pmd_val(pmd_t pmd)
	361	{
f2a6a705	362	return native_pgd_val(pmd.pud.p4d.pgd);
54321d94 JF	363	}
	364	#endif
	365
fe1e8c3e KS	366	static inline p4dval_t p4d_pfn_mask(p4d_t p4d)
	367	{
	368	/* No 512 GiB huge pages yet */
	369	return PTE_PFN_MASK;
	370	}
	371
	372	static inline p4dval_t p4d_flags_mask(p4d_t p4d)
	373	{
	374	return ~p4d_pfn_mask(p4d);
	375	}
	376
	377	static inline p4dval_t p4d_flags(p4d_t p4d)
	378	{
	379	return native_p4d_val(p4d) & p4d_flags_mask(p4d);
	380	}
	381
4be4c1fb TK	382	static inline pudval_t pud_pfn_mask(pud_t pud)
	383	{
	384	if (native_pud_val(pud) & _PAGE_PSE)
70f15287	385	return PHYSICAL_PUD_PAGE_MASK;
4be4c1fb TK	386	else
	387	return PTE_PFN_MASK;
	388	}
	389
	390	static inline pudval_t pud_flags_mask(pud_t pud)
	391	{
70f15287	392	return ~pud_pfn_mask(pud);
4be4c1fb TK	393	}
4be4c1fb TK	394
54321d94 JF	395	static inline pudval_t pud_flags(pud_t pud)
54321d94 JF	396	{
f70abb0f	397	return native_pud_val(pud) & pud_flags_mask(pud);
54321d94 JF	398	}
54321d94 JF	399
4be4c1fb TK	400	static inline pmdval_t pmd_pfn_mask(pmd_t pmd)
	401	{
	402	if (native_pmd_val(pmd) & _PAGE_PSE)
70f15287	403	return PHYSICAL_PMD_PAGE_MASK;
4be4c1fb TK	404	else
	405	return PTE_PFN_MASK;
	406	}
	407
	408	static inline pmdval_t pmd_flags_mask(pmd_t pmd)
	409	{
70f15287	410	return ~pmd_pfn_mask(pmd);
4be4c1fb TK	411	}
4be4c1fb TK	412
54321d94 JF	413	static inline pmdval_t pmd_flags(pmd_t pmd)
54321d94 JF	414	{
f70abb0f	415	return native_pmd_val(pmd) & pmd_flags_mask(pmd);
54321d94 JF	416	}
	417
	418	static inline pte_t native_make_pte(pteval_t val)
	419	{
	420	return (pte_t) { .pte = val };
	421	}
	422
	423	static inline pteval_t native_pte_val(pte_t pte)
	424	{
	425	return pte.pte;
	426	}
	427
	428	static inline pteval_t pte_flags(pte_t pte)
	429	{
	430	return native_pte_val(pte) & PTE_FLAGS_MASK;
	431	}
	432
	433	#define pgprot_val(x) ((x).pgprot)
	434	#define __pgprot(x) ((pgprot_t) { (x) } )
	435
281d4078 JG	436	extern uint16_t __cachemode2pte_tbl[_PAGE_CACHE_MODE_NUM];
	437	extern uint8_t __pte2cachemode_tbl[8];
	438
	439	#define __pte2cm_idx(cb) \
	440	((((cb) >> (_PAGE_BIT_PAT - 2)) & 4) \| \
	441	(((cb) >> (_PAGE_BIT_PCD - 1)) & 2) \| \
	442	(((cb) >> _PAGE_BIT_PWT) & 1))
bd809af1 JG	443	#define __cm_idx2pte(i) \
	444	((((i) & 4) << (_PAGE_BIT_PAT - 2)) \| \
	445	(((i) & 2) << (_PAGE_BIT_PCD - 1)) \| \
	446	(((i) & 1) << _PAGE_BIT_PWT))
281d4078 JG	447
	448	static inline unsigned long cachemode2protval(enum page_cache_mode pcm)
	449	{
	450	if (likely(pcm == 0))
	451	return 0;
	452	return __cachemode2pte_tbl[pcm];
	453	}
	454	static inline pgprot_t cachemode2pgprot(enum page_cache_mode pcm)
	455	{
	456	return __pgprot(cachemode2protval(pcm));
	457	}
	458	static inline enum page_cache_mode pgprot2cachemode(pgprot_t pgprot)
	459	{
	460	unsigned long masked;
	461
	462	masked = pgprot_val(pgprot) & _PAGE_CACHE_MASK;
	463	if (likely(masked == 0))
	464	return 0;
	465	return __pte2cachemode_tbl[__pte2cm_idx(masked)];
	466	}
	467	static inline pgprot_t pgprot_4k_2_large(pgprot_t pgprot)
	468	{
3625c2c2	469	pgprotval_t val = pgprot_val(pgprot);
281d4078	470	pgprot_t new;
281d4078	471
281d4078 JG	472	pgprot_val(new) = (val & ~(_PAGE_PAT \| _PAGE_PAT_LARGE)) \|
	473	((val & _PAGE_PAT) << (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
	474	return new;
	475	}
	476	static inline pgprot_t pgprot_large_2_4k(pgprot_t pgprot)
	477	{
3625c2c2	478	pgprotval_t val = pgprot_val(pgprot);
281d4078	479	pgprot_t new;
281d4078	480
281d4078 JG	481	pgprot_val(new) = (val & ~(_PAGE_PAT \| _PAGE_PAT_LARGE)) \|
	482	((val & _PAGE_PAT_LARGE) >>
	483	(_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
	484	return new;
	485	}
	486
54321d94 JF	487
	488	typedef struct page *pgtable_t;
	489
8d19c99f	490	extern pteval_t __supported_pte_mask;
c44c9ec0	491	extern void set_nx(void);
54321d94	492	extern int nx_enabled;
8d19c99f JF	493
	494	#define pgprot_writecombine pgprot_writecombine
	495	extern pgprot_t pgprot_writecombine(pgprot_t prot);
	496
d1b4bfbf TK	497	#define pgprot_writethrough pgprot_writethrough
	498	extern pgprot_t pgprot_writethrough(pgprot_t prot);
	499
8d19c99f JF	500	/* Indicate that x86 has its own track and untrack pfn vma functions */
	501	#define __HAVE_PFNMAP_TRACKING
	502
	503	#define __HAVE_PHYS_MEM_ACCESS_PROT
	504	struct file;
	505	pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
	506	unsigned long size, pgprot_t vma_prot);
8d19c99f JF	507
	508	/* Install a pte for a particular vaddr in kernel space. */
	509	void set_pte_vaddr(unsigned long vaddr, pte_t pte);
	510
	511	#ifdef CONFIG_X86_32
7737b215	512	extern void native_pagetable_init(void);
8d19c99f	513	#else
843b8ed2	514	#define native_pagetable_init paging_init
8d19c99f JF	515	#endif
	516
	517	struct seq_file;
	518	extern void arch_report_meminfo(struct seq_file *m);
	519
4cbeb51b	520	enum pg_level {
8d19c99f JF	521	PG_LEVEL_NONE,
	522	PG_LEVEL_4K,
	523	PG_LEVEL_2M,
	524	PG_LEVEL_1G,
fe1e8c3e	525	PG_LEVEL_512G,
8d19c99f JF	526	PG_LEVEL_NUM
	527	};
	528
	529	#ifdef CONFIG_PROC_FS
	530	extern void update_page_count(int level, unsigned long pages);
	531	#else
	532	static inline void update_page_count(int level, unsigned long pages) { }
	533	#endif
	534
	535	/*
	536	* Helper function that returns the kernel pagetable entry controlling
	537	* the virtual address 'address'. NULL means no pagetable entry present.
	538	* NOTE: the return type is pte_t but if the pmd is PSE then we return it
	539	* as a pte too.
	540	*/
	541	extern pte_t lookup_address(unsigned long address, unsigned int level);
426e34cc MF	542	extern pte_t lookup_address_in_pgd(pgd_t pgd, unsigned long address,
426e34cc MF	543	unsigned int *level);
792230c3	544	extern pmd_t *lookup_pmd_address(unsigned long address);
d7656534	545	extern phys_addr_t slow_virt_to_phys(void *__address);
d2f7cbe7 BP	546	extern int kernel_map_pages_in_pgd(pgd_t *pgd, u64 pfn, unsigned long address,
d2f7cbe7 BP	547	unsigned numpages, unsigned long page_flags);
8d19c99f JF	548	#endif /* !__ASSEMBLY__ */
	549
	550	#endif /* _ASM_X86_PGTABLE_DEFS_H */