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

#ifndef _ASM_X86_PGTABLE_DEFS_H
#define _ASM_X86_PGTABLE_DEFS_H

#include <linux/const.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_SPECIAL	_PAGE_BIT_SOFTW1
#define _PAGE_BIT_CPA_TEST	_PAGE_BIT_SOFTW1
#define _PAGE_BIT_SPLITTING	_PAGE_BIT_SOFTW2 /* only valid on a PSE pmd */
#define _PAGE_BIT_HIDDEN	_PAGE_BIT_SOFTW3 /* hidden by kmemcheck */
#define _PAGE_BIT_SOFT_DIRTY	_PAGE_BIT_SOFTW3 /* software dirty tracking */
#define _PAGE_BIT_NX           63       /* No execute: only valid after cpuid check */

/* 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)
#define _PAGE_SPLITTING	(_AT(pteval_t, 1) << _PAGE_BIT_SPLITTING)
#define __HAVE_ARCH_PTE_SPECIAL

#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 6 and 7 are *not* involved
 * into swap entry computation, but bit 6 is used for nonlinear
 * file mapping, so we borrow bit 7 for soft dirty tracking.
 *
 * Please note that this bit must be treated as swap dirty page
 * mark if and only if the PTE has present bit clear!
 */
#ifdef CONFIG_MEM_SOFT_DIRTY
#define _PAGE_SWP_SOFT_DIRTY	_PAGE_PSE
#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)
#else
#define _PAGE_NX	(_AT(pteval_t, 0))
#endif

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

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

/* Set of bits not changed in pte_modify */
#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_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_IO		(__PAGE_KERNEL)
#define __PAGE_KERNEL_IO_NOCACHE	(__PAGE_KERNEL_NOCACHE)

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

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

/*         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>

/* PTE_PFN_MASK extracts the PFN from a (pte|pmd|pud|pgd)val_t */
#define PTE_PFN_MASK		((pteval_t)PHYSICAL_PAGE_MASK)

/* PTE_FLAGS_MASK extracts the flags from a (pte|pmd|pud|pgd)val_t */
#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 > 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.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.pgd);
}
#endif

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

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

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)
{
	pgprot_t new;
	unsigned long val;

	val = pgprot_val(pgprot);
	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)
{
	pgprot_t new;
	unsigned long val;

	val = pgprot_val(pgprot);
	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);
int phys_mem_access_prot_allowed(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_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);
void kernel_unmap_pages_in_pgd(pgd_t *root, unsigned long address,
			       unsigned numpages);
#endif	/* !__ASSEMBLY__ */

#endif /* _ASM_X86_PGTABLE_DEFS_H */
Commit	Line	Data
8d19c99f JF	1	#ifndef _ASM_X86_PGTABLE_DEFS_H
	2	#define _ASM_X86_PGTABLE_DEFS_H
	3
	4	#include <linux/const.h>
e43623b4	5	#include <asm/page_types.h>
8d19c99f	6
d016bf7e	7	#define FIRST_USER_ADDRESS 0UL
8d19c99f JF	8
	9	#define _PAGE_BIT_PRESENT 0 /* is present */
	10	#define _PAGE_BIT_RW 1 /* writeable */
	11	#define _PAGE_BIT_USER 2 /* userspace addressable */
	12	#define _PAGE_BIT_PWT 3 /* page write through */
	13	#define _PAGE_BIT_PCD 4 /* page cache disabled */
	14	#define _PAGE_BIT_ACCESSED 5 /* was accessed (raised by CPU) */
	15	#define _PAGE_BIT_DIRTY 6 /* was written to (raised by CPU) */
	16	#define _PAGE_BIT_PSE 7 /* 4 MB (or 2MB) page */
	17	#define _PAGE_BIT_PAT 7 /* on 4KB pages */
	18	#define _PAGE_BIT_GLOBAL 8 /* Global TLB entry PPro+ */
c46a7c81 MG	19	#define _PAGE_BIT_SOFTW1 9 /* available for programmer */
	20	#define _PAGE_BIT_SOFTW2 10 /* " */
	21	#define _PAGE_BIT_SOFTW3 11 /* " */
8d19c99f	22	#define _PAGE_BIT_PAT_LARGE 12 /* On 2MB or 1GB pages */
c46a7c81 MG	23	#define _PAGE_BIT_SPECIAL _PAGE_BIT_SOFTW1
	24	#define _PAGE_BIT_CPA_TEST _PAGE_BIT_SOFTW1
	25	#define _PAGE_BIT_SPLITTING _PAGE_BIT_SOFTW2 /* only valid on a PSE pmd */
c46a7c81 MG	26	#define _PAGE_BIT_HIDDEN _PAGE_BIT_SOFTW3 /* hidden by kmemcheck */
c46a7c81 MG	27	#define _PAGE_BIT_SOFT_DIRTY _PAGE_BIT_SOFTW3 /* software dirty tracking */
8d19c99f JF	28	#define _PAGE_BIT_NX 63 /* No execute: only valid after cpuid check */
	29
	30	/* If _PAGE_BIT_PRESENT is clear, we use these: */
	31	/* - if the user mapped it with PROT_NONE; pte_present gives true */
	32	#define _PAGE_BIT_PROTNONE _PAGE_BIT_GLOBAL
8d19c99f JF	33
	34	#define _PAGE_PRESENT (_AT(pteval_t, 1) << _PAGE_BIT_PRESENT)
	35	#define _PAGE_RW (_AT(pteval_t, 1) << _PAGE_BIT_RW)
	36	#define _PAGE_USER (_AT(pteval_t, 1) << _PAGE_BIT_USER)
	37	#define _PAGE_PWT (_AT(pteval_t, 1) << _PAGE_BIT_PWT)
	38	#define _PAGE_PCD (_AT(pteval_t, 1) << _PAGE_BIT_PCD)
	39	#define _PAGE_ACCESSED (_AT(pteval_t, 1) << _PAGE_BIT_ACCESSED)
	40	#define _PAGE_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_DIRTY)
	41	#define _PAGE_PSE (_AT(pteval_t, 1) << _PAGE_BIT_PSE)
	42	#define _PAGE_GLOBAL (_AT(pteval_t, 1) << _PAGE_BIT_GLOBAL)
c46a7c81	43	#define _PAGE_SOFTW1 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW1)
f955371c	44	#define _PAGE_SOFTW2 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW2)
8d19c99f JF	45	#define _PAGE_PAT (_AT(pteval_t, 1) << _PAGE_BIT_PAT)
	46	#define _PAGE_PAT_LARGE (_AT(pteval_t, 1) << _PAGE_BIT_PAT_LARGE)
	47	#define _PAGE_SPECIAL (_AT(pteval_t, 1) << _PAGE_BIT_SPECIAL)
	48	#define _PAGE_CPA_TEST (_AT(pteval_t, 1) << _PAGE_BIT_CPA_TEST)
5f6e8da7	49	#define _PAGE_SPLITTING (_AT(pteval_t, 1) << _PAGE_BIT_SPLITTING)
8d19c99f JF	50	#define __HAVE_ARCH_PTE_SPECIAL
8d19c99f JF	51
9d31c506 JF	52	#ifdef CONFIG_KMEMCHECK
	53	#define _PAGE_HIDDEN (_AT(pteval_t, 1) << _PAGE_BIT_HIDDEN)
	54	#else
	55	#define _PAGE_HIDDEN (_AT(pteval_t, 0))
	56	#endif
	57
0f8975ec PE	58	/*
	59	* The same hidden bit is used by kmemcheck, but since kmemcheck
	60	* works on kernel pages while soft-dirty engine on user space,
	61	* they do not conflict with each other.
	62	*/
	63
	64	#ifdef CONFIG_MEM_SOFT_DIRTY
41bb3476	65	#define _PAGE_SOFT_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_SOFT_DIRTY)
0f8975ec PE	66	#else
	67	#define _PAGE_SOFT_DIRTY (_AT(pteval_t, 0))
	68	#endif
	69
179ef71c CG	70	/*
	71	* Tracking soft dirty bit when a page goes to a swap is tricky.
	72	* We need a bit which can be stored in pte _and_ not conflict
	73	* with swap entry format. On x86 bits 6 and 7 are not involved
	74	* into swap entry computation, but bit 6 is used for nonlinear
	75	* file mapping, so we borrow bit 7 for soft dirty tracking.
fa0f281c CG	76	*
	77	* Please note that this bit must be treated as swap dirty page
	78	* mark if and only if the PTE has present bit clear!
179ef71c CG	79	*/
	80	#ifdef CONFIG_MEM_SOFT_DIRTY
	81	#define _PAGE_SWP_SOFT_DIRTY _PAGE_PSE
	82	#else
	83	#define _PAGE_SWP_SOFT_DIRTY (_AT(pteval_t, 0))
	84	#endif
	85
8d19c99f JF	86	#if defined(CONFIG_X86_64) \|\| defined(CONFIG_X86_PAE)
	87	#define _PAGE_NX (_AT(pteval_t, 1) << _PAGE_BIT_NX)
	88	#else
	89	#define _PAGE_NX (_AT(pteval_t, 0))
	90	#endif
	91
8d19c99f JF	92	#define _PAGE_PROTNONE (_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)
	93
	94	#define _PAGE_TABLE (_PAGE_PRESENT \| _PAGE_RW \| _PAGE_USER \| \
	95	_PAGE_ACCESSED \| _PAGE_DIRTY)
	96	#define _KERNPG_TABLE (_PAGE_PRESENT \| _PAGE_RW \| _PAGE_ACCESSED \| \
	97	_PAGE_DIRTY)
	98
	99	/* Set of bits not changed in pte_modify */
	100	#define _PAGE_CHG_MASK (PTE_PFN_MASK \| _PAGE_PCD \| _PAGE_PWT \| \
24f91eba	101	_PAGE_SPECIAL \| _PAGE_ACCESSED \| _PAGE_DIRTY \| \
21d9ee3e MG	102	_PAGE_SOFT_DIRTY)
21d9ee3e MG	103	#define _HPAGE_CHG_MASK (_PAGE_CHG_MASK \| _PAGE_PSE)
8d19c99f	104
281d4078 JG	105	/*
	106	* The cache modes defined here are used to translate between pure SW usage
	107	* and the HW defined cache mode bits and/or PAT entries.
	108	*
	109	* The resulting bits for PWT, PCD and PAT should be chosen in a way
	110	* to have the WB mode at index 0 (all bits clear). This is the default
	111	* right now and likely would break too much if changed.
	112	*/
	113	#ifndef __ASSEMBLY__
	114	enum page_cache_mode {
	115	_PAGE_CACHE_MODE_WB = 0,
	116	_PAGE_CACHE_MODE_WC = 1,
	117	_PAGE_CACHE_MODE_UC_MINUS = 2,
	118	_PAGE_CACHE_MODE_UC = 3,
	119	_PAGE_CACHE_MODE_WT = 4,
	120	_PAGE_CACHE_MODE_WP = 5,
	121	_PAGE_CACHE_MODE_NUM = 8
	122	};
	123	#endif
	124
	125	#define _PAGE_CACHE_MASK (_PAGE_PAT \| _PAGE_PCD \| _PAGE_PWT)
	126	#define _PAGE_NOCACHE (cachemode2protval(_PAGE_CACHE_MODE_UC))
	127
8d19c99f JF	128	#define PAGE_NONE __pgprot(_PAGE_PROTNONE \| _PAGE_ACCESSED)
	129	#define PAGE_SHARED __pgprot(_PAGE_PRESENT \| _PAGE_RW \| _PAGE_USER \| \
	130	_PAGE_ACCESSED \| _PAGE_NX)
	131
	132	#define PAGE_SHARED_EXEC __pgprot(_PAGE_PRESENT \| _PAGE_RW \| \
	133	_PAGE_USER \| _PAGE_ACCESSED)
	134	#define PAGE_COPY_NOEXEC __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	135	_PAGE_ACCESSED \| _PAGE_NX)
	136	#define PAGE_COPY_EXEC __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	137	_PAGE_ACCESSED)
	138	#define PAGE_COPY PAGE_COPY_NOEXEC
	139	#define PAGE_READONLY __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	140	_PAGE_ACCESSED \| _PAGE_NX)
	141	#define PAGE_READONLY_EXEC __pgprot(_PAGE_PRESENT \| _PAGE_USER \| \
	142	_PAGE_ACCESSED)
	143
	144	#define __PAGE_KERNEL_EXEC \
	145	(_PAGE_PRESENT \| _PAGE_RW \| _PAGE_DIRTY \| _PAGE_ACCESSED \| _PAGE_GLOBAL)
	146	#define __PAGE_KERNEL (__PAGE_KERNEL_EXEC \| _PAGE_NX)
	147
	148	#define __PAGE_KERNEL_RO (__PAGE_KERNEL & ~_PAGE_RW)
	149	#define __PAGE_KERNEL_RX (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
87ad0b71	150	#define __PAGE_KERNEL_NOCACHE (__PAGE_KERNEL \| _PAGE_NOCACHE)
8d19c99f	151	#define __PAGE_KERNEL_VSYSCALL (__PAGE_KERNEL_RX \| _PAGE_USER)
9fd67b4e	152	#define __PAGE_KERNEL_VVAR (__PAGE_KERNEL_RO \| _PAGE_USER)
8d19c99f	153	#define __PAGE_KERNEL_LARGE (__PAGE_KERNEL \| _PAGE_PSE)
8d19c99f JF	154	#define __PAGE_KERNEL_LARGE_EXEC (__PAGE_KERNEL_EXEC \| _PAGE_PSE)
8d19c99f JF	155
f955371c DV	156	#define __PAGE_KERNEL_IO (__PAGE_KERNEL)
f955371c DV	157	#define __PAGE_KERNEL_IO_NOCACHE (__PAGE_KERNEL_NOCACHE)
8d19c99f JF	158
	159	#define PAGE_KERNEL __pgprot(__PAGE_KERNEL)
	160	#define PAGE_KERNEL_RO __pgprot(__PAGE_KERNEL_RO)
	161	#define PAGE_KERNEL_EXEC __pgprot(__PAGE_KERNEL_EXEC)
	162	#define PAGE_KERNEL_RX __pgprot(__PAGE_KERNEL_RX)
8d19c99f	163	#define PAGE_KERNEL_NOCACHE __pgprot(__PAGE_KERNEL_NOCACHE)
8d19c99f	164	#define PAGE_KERNEL_LARGE __pgprot(__PAGE_KERNEL_LARGE)
8d19c99f JF	165	#define PAGE_KERNEL_LARGE_EXEC __pgprot(__PAGE_KERNEL_LARGE_EXEC)
8d19c99f JF	166	#define PAGE_KERNEL_VSYSCALL __pgprot(__PAGE_KERNEL_VSYSCALL)
9fd67b4e	167	#define PAGE_KERNEL_VVAR __pgprot(__PAGE_KERNEL_VVAR)
8d19c99f JF	168
	169	#define PAGE_KERNEL_IO __pgprot(__PAGE_KERNEL_IO)
	170	#define PAGE_KERNEL_IO_NOCACHE __pgprot(__PAGE_KERNEL_IO_NOCACHE)
8d19c99f JF	171
	172	/* xwr */
	173	#define __P000 PAGE_NONE
	174	#define __P001 PAGE_READONLY
	175	#define __P010 PAGE_COPY
	176	#define __P011 PAGE_COPY
	177	#define __P100 PAGE_READONLY_EXEC
	178	#define __P101 PAGE_READONLY_EXEC
	179	#define __P110 PAGE_COPY_EXEC
	180	#define __P111 PAGE_COPY_EXEC
	181
	182	#define __S000 PAGE_NONE
	183	#define __S001 PAGE_READONLY
	184	#define __S010 PAGE_SHARED
	185	#define __S011 PAGE_SHARED
	186	#define __S100 PAGE_READONLY_EXEC
	187	#define __S101 PAGE_READONLY_EXEC
	188	#define __S110 PAGE_SHARED_EXEC
	189	#define __S111 PAGE_SHARED_EXEC
	190
	191	/*
	192	* early identity mapping pte attrib macros.
	193	*/
	194	#ifdef CONFIG_X86_64
	195	#define __PAGE_KERNEL_IDENT_LARGE_EXEC __PAGE_KERNEL_LARGE_EXEC
	196	#else
8d19c99f	197	#define PTE_IDENT_ATTR 0x003 /* PRESENT+RW */
7dda0387	198	#define PDE_IDENT_ATTR 0x063 /* PRESENT+RW+DIRTY+ACCESSED */
8d19c99f JF	199	#define PGD_IDENT_ATTR 0x001 /* PRESENT (no other attributes) */
	200	#endif
	201
54321d94	202	#ifdef CONFIG_X86_32
a1ce3928	203	# include <asm/pgtable_32_types.h>
54321d94	204	#else
a1ce3928	205	# include <asm/pgtable_64_types.h>
54321d94 JF	206	#endif
54321d94 JF	207
8d19c99f JF	208	#ifndef __ASSEMBLY__
8d19c99f JF	209
54321d94 JF	210	#include <linux/types.h>
54321d94 JF	211
9b3651cb JF	212	/* PTE_PFN_MASK extracts the PFN from a (pte\|pmd\|pud\|pgd)val_t */
	213	#define PTE_PFN_MASK ((pteval_t)PHYSICAL_PAGE_MASK)
	214
	215	/* PTE_FLAGS_MASK extracts the flags from a (pte\|pmd\|pud\|pgd)val_t */
	216	#define PTE_FLAGS_MASK (~PTE_PFN_MASK)
	217
54321d94 JF	218	typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;
	219
	220	typedef struct { pgdval_t pgd; } pgd_t;
	221
	222	static inline pgd_t native_make_pgd(pgdval_t val)
	223	{
	224	return (pgd_t) { val };
	225	}
	226
	227	static inline pgdval_t native_pgd_val(pgd_t pgd)
	228	{
	229	return pgd.pgd;
	230	}
	231
	232	static inline pgdval_t pgd_flags(pgd_t pgd)
	233	{
	234	return native_pgd_val(pgd) & PTE_FLAGS_MASK;
	235	}
	236
98233368	237	#if CONFIG_PGTABLE_LEVELS > 3
54321d94 JF	238	typedef struct { pudval_t pud; } pud_t;
	239
	240	static inline pud_t native_make_pud(pmdval_t val)
	241	{
	242	return (pud_t) { val };
	243	}
	244
	245	static inline pudval_t native_pud_val(pud_t pud)
	246	{
	247	return pud.pud;
	248	}
	249	#else
	250	#include <asm-generic/pgtable-nopud.h>
	251
	252	static inline pudval_t native_pud_val(pud_t pud)
	253	{
	254	return native_pgd_val(pud.pgd);
	255	}
	256	#endif
	257
98233368	258	#if CONFIG_PGTABLE_LEVELS > 2
54321d94 JF	259	typedef struct { pmdval_t pmd; } pmd_t;
	260
	261	static inline pmd_t native_make_pmd(pmdval_t val)
	262	{
	263	return (pmd_t) { val };
	264	}
	265
	266	static inline pmdval_t native_pmd_val(pmd_t pmd)
	267	{
	268	return pmd.pmd;
	269	}
	270	#else
	271	#include <asm-generic/pgtable-nopmd.h>
	272
	273	static inline pmdval_t native_pmd_val(pmd_t pmd)
	274	{
	275	return native_pgd_val(pmd.pud.pgd);
	276	}
	277	#endif
	278
	279	static inline pudval_t pud_flags(pud_t pud)
	280	{
	281	return native_pud_val(pud) & PTE_FLAGS_MASK;
	282	}
	283
	284	static inline pmdval_t pmd_flags(pmd_t pmd)
	285	{
	286	return native_pmd_val(pmd) & PTE_FLAGS_MASK;
	287	}
	288
	289	static inline pte_t native_make_pte(pteval_t val)
	290	{
	291	return (pte_t) { .pte = val };
	292	}
	293
	294	static inline pteval_t native_pte_val(pte_t pte)
	295	{
	296	return pte.pte;
	297	}
	298
	299	static inline pteval_t pte_flags(pte_t pte)
	300	{
	301	return native_pte_val(pte) & PTE_FLAGS_MASK;
	302	}
	303
	304	#define pgprot_val(x) ((x).pgprot)
	305	#define __pgprot(x) ((pgprot_t) { (x) } )
	306
281d4078 JG	307	extern uint16_t __cachemode2pte_tbl[_PAGE_CACHE_MODE_NUM];
	308	extern uint8_t __pte2cachemode_tbl[8];
	309
	310	#define __pte2cm_idx(cb) \
	311	((((cb) >> (_PAGE_BIT_PAT - 2)) & 4) \| \
	312	(((cb) >> (_PAGE_BIT_PCD - 1)) & 2) \| \
	313	(((cb) >> _PAGE_BIT_PWT) & 1))
bd809af1 JG	314	#define __cm_idx2pte(i) \
	315	((((i) & 4) << (_PAGE_BIT_PAT - 2)) \| \
	316	(((i) & 2) << (_PAGE_BIT_PCD - 1)) \| \
	317	(((i) & 1) << _PAGE_BIT_PWT))
281d4078 JG	318
	319	static inline unsigned long cachemode2protval(enum page_cache_mode pcm)
	320	{
	321	if (likely(pcm == 0))
	322	return 0;
	323	return __cachemode2pte_tbl[pcm];
	324	}
	325	static inline pgprot_t cachemode2pgprot(enum page_cache_mode pcm)
	326	{
	327	return __pgprot(cachemode2protval(pcm));
	328	}
	329	static inline enum page_cache_mode pgprot2cachemode(pgprot_t pgprot)
	330	{
	331	unsigned long masked;
	332
	333	masked = pgprot_val(pgprot) & _PAGE_CACHE_MASK;
	334	if (likely(masked == 0))
	335	return 0;
	336	return __pte2cachemode_tbl[__pte2cm_idx(masked)];
	337	}
	338	static inline pgprot_t pgprot_4k_2_large(pgprot_t pgprot)
	339	{
	340	pgprot_t new;
	341	unsigned long val;
	342
	343	val = pgprot_val(pgprot);
	344	pgprot_val(new) = (val & ~(_PAGE_PAT \| _PAGE_PAT_LARGE)) \|
	345	((val & _PAGE_PAT) << (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
	346	return new;
	347	}
	348	static inline pgprot_t pgprot_large_2_4k(pgprot_t pgprot)
	349	{
	350	pgprot_t new;
	351	unsigned long val;
	352
	353	val = pgprot_val(pgprot);
	354	pgprot_val(new) = (val & ~(_PAGE_PAT \| _PAGE_PAT_LARGE)) \|
	355	((val & _PAGE_PAT_LARGE) >>
	356	(_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
	357	return new;
	358	}
	359
54321d94 JF	360
	361	typedef struct page *pgtable_t;
	362
8d19c99f	363	extern pteval_t __supported_pte_mask;
c44c9ec0	364	extern void set_nx(void);
54321d94	365	extern int nx_enabled;
8d19c99f JF	366
	367	#define pgprot_writecombine pgprot_writecombine
	368	extern pgprot_t pgprot_writecombine(pgprot_t prot);
	369
d1b4bfbf TK	370	#define pgprot_writethrough pgprot_writethrough
	371	extern pgprot_t pgprot_writethrough(pgprot_t prot);
	372
8d19c99f JF	373	/* Indicate that x86 has its own track and untrack pfn vma functions */
	374	#define __HAVE_PFNMAP_TRACKING
	375
	376	#define __HAVE_PHYS_MEM_ACCESS_PROT
	377	struct file;
	378	pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
	379	unsigned long size, pgprot_t vma_prot);
	380	int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
	381	unsigned long size, pgprot_t *vma_prot);
	382
	383	/* Install a pte for a particular vaddr in kernel space. */
	384	void set_pte_vaddr(unsigned long vaddr, pte_t pte);
	385
	386	#ifdef CONFIG_X86_32
7737b215	387	extern void native_pagetable_init(void);
8d19c99f	388	#else
843b8ed2	389	#define native_pagetable_init paging_init
8d19c99f JF	390	#endif
	391
	392	struct seq_file;
	393	extern void arch_report_meminfo(struct seq_file *m);
	394
4cbeb51b	395	enum pg_level {
8d19c99f JF	396	PG_LEVEL_NONE,
	397	PG_LEVEL_4K,
	398	PG_LEVEL_2M,
	399	PG_LEVEL_1G,
	400	PG_LEVEL_NUM
	401	};
	402
	403	#ifdef CONFIG_PROC_FS
	404	extern void update_page_count(int level, unsigned long pages);
	405	#else
	406	static inline void update_page_count(int level, unsigned long pages) { }
	407	#endif
	408
	409	/*
	410	* Helper function that returns the kernel pagetable entry controlling
	411	* the virtual address 'address'. NULL means no pagetable entry present.
	412	* NOTE: the return type is pte_t but if the pmd is PSE then we return it
	413	* as a pte too.
	414	*/
	415	extern pte_t lookup_address(unsigned long address, unsigned int level);
426e34cc MF	416	extern pte_t lookup_address_in_pgd(pgd_t pgd, unsigned long address,
426e34cc MF	417	unsigned int *level);
792230c3	418	extern pmd_t *lookup_pmd_address(unsigned long address);
d7656534	419	extern phys_addr_t slow_virt_to_phys(void *__address);
d2f7cbe7 BP	420	extern int kernel_map_pages_in_pgd(pgd_t *pgd, u64 pfn, unsigned long address,
d2f7cbe7 BP	421	unsigned numpages, unsigned long page_flags);
42a54772 BP	422	void kernel_unmap_pages_in_pgd(pgd_t *root, unsigned long address,
42a54772 BP	423	unsigned numpages);
8d19c99f JF	424	#endif /* !__ASSEMBLY__ */
	425
	426	#endif /* _ASM_X86_PGTABLE_DEFS_H */