1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _ASM_X86_PGTABLE_DEFS_H
3 #define _ASM_X86_PGTABLE_DEFS_H
5 #include <linux/const.h>
6 #include <linux/mem_encrypt.h>
8 #include <asm/page_types.h>
10 #define FIRST_USER_ADDRESS 0UL
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+ */
22 #define _PAGE_BIT_SOFTW1 9 /* available for programmer */
23 #define _PAGE_BIT_SOFTW2 10 /* " */
24 #define _PAGE_BIT_SOFTW3 11 /* " */
25 #define _PAGE_BIT_PAT_LARGE 12 /* On 2MB or 1GB pages */
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 */
33 #define _PAGE_BIT_SPECIAL _PAGE_BIT_SOFTW1
34 #define _PAGE_BIT_CPA_TEST _PAGE_BIT_SOFTW1
35 #define _PAGE_BIT_SOFT_DIRTY _PAGE_BIT_SOFTW3 /* software dirty tracking */
36 #define _PAGE_BIT_DEVMAP _PAGE_BIT_SOFTW4
38 /* If _PAGE_BIT_PRESENT is clear, we use these: */
39 /* - if the user mapped it with PROT_NONE; pte_present gives true */
40 #define _PAGE_BIT_PROTNONE _PAGE_BIT_GLOBAL
42 #define _PAGE_PRESENT (_AT(pteval_t, 1) << _PAGE_BIT_PRESENT)
43 #define _PAGE_RW (_AT(pteval_t, 1) << _PAGE_BIT_RW)
44 #define _PAGE_USER (_AT(pteval_t, 1) << _PAGE_BIT_USER)
45 #define _PAGE_PWT (_AT(pteval_t, 1) << _PAGE_BIT_PWT)
46 #define _PAGE_PCD (_AT(pteval_t, 1) << _PAGE_BIT_PCD)
47 #define _PAGE_ACCESSED (_AT(pteval_t, 1) << _PAGE_BIT_ACCESSED)
48 #define _PAGE_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_DIRTY)
49 #define _PAGE_PSE (_AT(pteval_t, 1) << _PAGE_BIT_PSE)
50 #define _PAGE_GLOBAL (_AT(pteval_t, 1) << _PAGE_BIT_GLOBAL)
51 #define _PAGE_SOFTW1 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW1)
52 #define _PAGE_SOFTW2 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW2)
53 #define _PAGE_PAT (_AT(pteval_t, 1) << _PAGE_BIT_PAT)
54 #define _PAGE_PAT_LARGE (_AT(pteval_t, 1) << _PAGE_BIT_PAT_LARGE)
55 #define _PAGE_SPECIAL (_AT(pteval_t, 1) << _PAGE_BIT_SPECIAL)
56 #define _PAGE_CPA_TEST (_AT(pteval_t, 1) << _PAGE_BIT_CPA_TEST)
57 #ifdef CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS
58 #define _PAGE_PKEY_BIT0 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT0)
59 #define _PAGE_PKEY_BIT1 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT1)
60 #define _PAGE_PKEY_BIT2 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT2)
61 #define _PAGE_PKEY_BIT3 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT3)
63 #define _PAGE_PKEY_BIT0 (_AT(pteval_t, 0))
64 #define _PAGE_PKEY_BIT1 (_AT(pteval_t, 0))
65 #define _PAGE_PKEY_BIT2 (_AT(pteval_t, 0))
66 #define _PAGE_PKEY_BIT3 (_AT(pteval_t, 0))
68 #define __HAVE_ARCH_PTE_SPECIAL
70 #define _PAGE_PKEY_MASK (_PAGE_PKEY_BIT0 | \
75 #if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
76 #define _PAGE_KNL_ERRATUM_MASK (_PAGE_DIRTY | _PAGE_ACCESSED)
78 #define _PAGE_KNL_ERRATUM_MASK 0
81 #ifdef CONFIG_MEM_SOFT_DIRTY
82 #define _PAGE_SOFT_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_SOFT_DIRTY)
84 #define _PAGE_SOFT_DIRTY (_AT(pteval_t, 0))
88 * Tracking soft dirty bit when a page goes to a swap is tricky.
89 * We need a bit which can be stored in pte _and_ not conflict
90 * with swap entry format. On x86 bits 1-4 are *not* involved
91 * into swap entry computation, but bit 7 is used for thp migration,
92 * so we borrow bit 1 for soft dirty tracking.
94 * Please note that this bit must be treated as swap dirty page
95 * mark if and only if the PTE/PMD has present bit clear!
97 #ifdef CONFIG_MEM_SOFT_DIRTY
98 #define _PAGE_SWP_SOFT_DIRTY _PAGE_RW
100 #define _PAGE_SWP_SOFT_DIRTY (_AT(pteval_t, 0))
103 #if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
104 #define _PAGE_NX (_AT(pteval_t, 1) << _PAGE_BIT_NX)
105 #define _PAGE_DEVMAP (_AT(u64, 1) << _PAGE_BIT_DEVMAP)
106 #define __HAVE_ARCH_PTE_DEVMAP
108 #define _PAGE_NX (_AT(pteval_t, 0))
109 #define _PAGE_DEVMAP (_AT(pteval_t, 0))
112 #define _PAGE_PROTNONE (_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)
114 #define _PAGE_TABLE_NOENC (_PAGE_PRESENT | _PAGE_RW | _PAGE_USER |\
115 _PAGE_ACCESSED | _PAGE_DIRTY)
116 #define _KERNPG_TABLE_NOENC (_PAGE_PRESENT | _PAGE_RW | \
117 _PAGE_ACCESSED | _PAGE_DIRTY)
120 * Set of bits not changed in pte_modify. The pte's
121 * protection key is treated like _PAGE_RW, for
122 * instance, and is *not* included in this mask since
123 * pte_modify() does modify it.
125 #define _PAGE_CHG_MASK (PTE_PFN_MASK | _PAGE_PCD | _PAGE_PWT | \
126 _PAGE_SPECIAL | _PAGE_ACCESSED | _PAGE_DIRTY | \
128 #define _HPAGE_CHG_MASK (_PAGE_CHG_MASK | _PAGE_PSE)
131 * The cache modes defined here are used to translate between pure SW usage
132 * and the HW defined cache mode bits and/or PAT entries.
134 * The resulting bits for PWT, PCD and PAT should be chosen in a way
135 * to have the WB mode at index 0 (all bits clear). This is the default
136 * right now and likely would break too much if changed.
139 enum page_cache_mode {
140 _PAGE_CACHE_MODE_WB = 0,
141 _PAGE_CACHE_MODE_WC = 1,
142 _PAGE_CACHE_MODE_UC_MINUS = 2,
143 _PAGE_CACHE_MODE_UC = 3,
144 _PAGE_CACHE_MODE_WT = 4,
145 _PAGE_CACHE_MODE_WP = 5,
146 _PAGE_CACHE_MODE_NUM = 8
150 #define _PAGE_CACHE_MASK (_PAGE_PAT | _PAGE_PCD | _PAGE_PWT)
151 #define _PAGE_NOCACHE (cachemode2protval(_PAGE_CACHE_MODE_UC))
152 #define _PAGE_CACHE_WP (cachemode2protval(_PAGE_CACHE_MODE_WP))
154 #define PAGE_NONE __pgprot(_PAGE_PROTNONE | _PAGE_ACCESSED)
155 #define PAGE_SHARED __pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | \
156 _PAGE_ACCESSED | _PAGE_NX)
158 #define PAGE_SHARED_EXEC __pgprot(_PAGE_PRESENT | _PAGE_RW | \
159 _PAGE_USER | _PAGE_ACCESSED)
160 #define PAGE_COPY_NOEXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | \
161 _PAGE_ACCESSED | _PAGE_NX)
162 #define PAGE_COPY_EXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | \
164 #define PAGE_COPY PAGE_COPY_NOEXEC
165 #define PAGE_READONLY __pgprot(_PAGE_PRESENT | _PAGE_USER | \
166 _PAGE_ACCESSED | _PAGE_NX)
167 #define PAGE_READONLY_EXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | \
170 #define __PAGE_KERNEL_EXEC \
171 (_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED | _PAGE_GLOBAL)
172 #define __PAGE_KERNEL (__PAGE_KERNEL_EXEC | _PAGE_NX)
174 #define __PAGE_KERNEL_RO (__PAGE_KERNEL & ~_PAGE_RW)
175 #define __PAGE_KERNEL_RX (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
176 #define __PAGE_KERNEL_NOCACHE (__PAGE_KERNEL | _PAGE_NOCACHE)
177 #define __PAGE_KERNEL_VSYSCALL (__PAGE_KERNEL_RX | _PAGE_USER)
178 #define __PAGE_KERNEL_VVAR (__PAGE_KERNEL_RO | _PAGE_USER)
179 #define __PAGE_KERNEL_LARGE (__PAGE_KERNEL | _PAGE_PSE)
180 #define __PAGE_KERNEL_LARGE_EXEC (__PAGE_KERNEL_EXEC | _PAGE_PSE)
181 #define __PAGE_KERNEL_WP (__PAGE_KERNEL | _PAGE_CACHE_WP)
183 #define __PAGE_KERNEL_IO (__PAGE_KERNEL)
184 #define __PAGE_KERNEL_IO_NOCACHE (__PAGE_KERNEL_NOCACHE)
188 #define _PAGE_ENC (_AT(pteval_t, sme_me_mask))
190 #define _KERNPG_TABLE (_PAGE_PRESENT | _PAGE_RW | _PAGE_ACCESSED | \
191 _PAGE_DIRTY | _PAGE_ENC)
192 #define _PAGE_TABLE (_KERNPG_TABLE | _PAGE_USER)
194 #define __PAGE_KERNEL_ENC (__PAGE_KERNEL | _PAGE_ENC)
195 #define __PAGE_KERNEL_ENC_WP (__PAGE_KERNEL_WP | _PAGE_ENC)
197 #define __PAGE_KERNEL_NOENC (__PAGE_KERNEL)
198 #define __PAGE_KERNEL_NOENC_WP (__PAGE_KERNEL_WP)
200 #define PAGE_KERNEL __pgprot(__PAGE_KERNEL | _PAGE_ENC)
201 #define PAGE_KERNEL_NOENC __pgprot(__PAGE_KERNEL)
202 #define PAGE_KERNEL_RO __pgprot(__PAGE_KERNEL_RO | _PAGE_ENC)
203 #define PAGE_KERNEL_EXEC __pgprot(__PAGE_KERNEL_EXEC | _PAGE_ENC)
204 #define PAGE_KERNEL_EXEC_NOENC __pgprot(__PAGE_KERNEL_EXEC)
205 #define PAGE_KERNEL_RX __pgprot(__PAGE_KERNEL_RX | _PAGE_ENC)
206 #define PAGE_KERNEL_NOCACHE __pgprot(__PAGE_KERNEL_NOCACHE | _PAGE_ENC)
207 #define PAGE_KERNEL_LARGE __pgprot(__PAGE_KERNEL_LARGE | _PAGE_ENC)
208 #define PAGE_KERNEL_LARGE_EXEC __pgprot(__PAGE_KERNEL_LARGE_EXEC | _PAGE_ENC)
209 #define PAGE_KERNEL_VSYSCALL __pgprot(__PAGE_KERNEL_VSYSCALL | _PAGE_ENC)
210 #define PAGE_KERNEL_VVAR __pgprot(__PAGE_KERNEL_VVAR | _PAGE_ENC)
212 #define PAGE_KERNEL_IO __pgprot(__PAGE_KERNEL_IO)
213 #define PAGE_KERNEL_IO_NOCACHE __pgprot(__PAGE_KERNEL_IO_NOCACHE)
215 #endif /* __ASSEMBLY__ */
218 #define __P000 PAGE_NONE
219 #define __P001 PAGE_READONLY
220 #define __P010 PAGE_COPY
221 #define __P011 PAGE_COPY
222 #define __P100 PAGE_READONLY_EXEC
223 #define __P101 PAGE_READONLY_EXEC
224 #define __P110 PAGE_COPY_EXEC
225 #define __P111 PAGE_COPY_EXEC
227 #define __S000 PAGE_NONE
228 #define __S001 PAGE_READONLY
229 #define __S010 PAGE_SHARED
230 #define __S011 PAGE_SHARED
231 #define __S100 PAGE_READONLY_EXEC
232 #define __S101 PAGE_READONLY_EXEC
233 #define __S110 PAGE_SHARED_EXEC
234 #define __S111 PAGE_SHARED_EXEC
237 * early identity mapping pte attrib macros.
240 #define __PAGE_KERNEL_IDENT_LARGE_EXEC __PAGE_KERNEL_LARGE_EXEC
242 #define PTE_IDENT_ATTR 0x003 /* PRESENT+RW */
243 #define PDE_IDENT_ATTR 0x063 /* PRESENT+RW+DIRTY+ACCESSED */
244 #define PGD_IDENT_ATTR 0x001 /* PRESENT (no other attributes) */
248 # include <asm/pgtable_32_types.h>
250 # include <asm/pgtable_64_types.h>
255 #include <linux/types.h>
257 /* Extracts the PFN from a (pte|pmd|pud|pgd)val_t of a 4KB page */
258 #define PTE_PFN_MASK ((pteval_t)PHYSICAL_PAGE_MASK)
261 * Extracts the flags from a (pte|pmd|pud|pgd)val_t
262 * This includes the protection key value.
264 #define PTE_FLAGS_MASK (~PTE_PFN_MASK)
266 typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;
268 typedef struct { pgdval_t pgd; } pgd_t;
270 static inline pgd_t native_make_pgd(pgdval_t val)
272 return (pgd_t) { val };
275 static inline pgdval_t native_pgd_val(pgd_t pgd)
280 static inline pgdval_t pgd_flags(pgd_t pgd)
282 return native_pgd_val(pgd) & PTE_FLAGS_MASK;
285 #if CONFIG_PGTABLE_LEVELS > 4
286 typedef struct { p4dval_t p4d; } p4d_t;
288 static inline p4d_t native_make_p4d(pudval_t val)
290 return (p4d_t) { val };
293 static inline p4dval_t native_p4d_val(p4d_t p4d)
298 #include <asm-generic/pgtable-nop4d.h>
300 static inline p4d_t native_make_p4d(pudval_t val)
302 return (p4d_t) { .pgd = native_make_pgd((pgdval_t)val) };
305 static inline p4dval_t native_p4d_val(p4d_t p4d)
307 return native_pgd_val(p4d.pgd);
311 #if CONFIG_PGTABLE_LEVELS > 3
312 typedef struct { pudval_t pud; } pud_t;
314 static inline pud_t native_make_pud(pmdval_t val)
316 return (pud_t) { val };
319 static inline pudval_t native_pud_val(pud_t pud)
324 #include <asm-generic/pgtable-nopud.h>
326 static inline pudval_t native_pud_val(pud_t pud)
328 return native_pgd_val(pud.p4d.pgd);
332 #if CONFIG_PGTABLE_LEVELS > 2
333 typedef struct { pmdval_t pmd; } pmd_t;
335 static inline pmd_t native_make_pmd(pmdval_t val)
337 return (pmd_t) { val };
340 static inline pmdval_t native_pmd_val(pmd_t pmd)
345 #include <asm-generic/pgtable-nopmd.h>
347 static inline pmdval_t native_pmd_val(pmd_t pmd)
349 return native_pgd_val(pmd.pud.p4d.pgd);
353 static inline p4dval_t p4d_pfn_mask(p4d_t p4d)
355 /* No 512 GiB huge pages yet */
359 static inline p4dval_t p4d_flags_mask(p4d_t p4d)
361 return ~p4d_pfn_mask(p4d);
364 static inline p4dval_t p4d_flags(p4d_t p4d)
366 return native_p4d_val(p4d) & p4d_flags_mask(p4d);
369 static inline pudval_t pud_pfn_mask(pud_t pud)
371 if (native_pud_val(pud) & _PAGE_PSE)
372 return PHYSICAL_PUD_PAGE_MASK;
377 static inline pudval_t pud_flags_mask(pud_t pud)
379 return ~pud_pfn_mask(pud);
382 static inline pudval_t pud_flags(pud_t pud)
384 return native_pud_val(pud) & pud_flags_mask(pud);
387 static inline pmdval_t pmd_pfn_mask(pmd_t pmd)
389 if (native_pmd_val(pmd) & _PAGE_PSE)
390 return PHYSICAL_PMD_PAGE_MASK;
395 static inline pmdval_t pmd_flags_mask(pmd_t pmd)
397 return ~pmd_pfn_mask(pmd);
400 static inline pmdval_t pmd_flags(pmd_t pmd)
402 return native_pmd_val(pmd) & pmd_flags_mask(pmd);
405 static inline pte_t native_make_pte(pteval_t val)
407 return (pte_t) { .pte = val };
410 static inline pteval_t native_pte_val(pte_t pte)
415 static inline pteval_t pte_flags(pte_t pte)
417 return native_pte_val(pte) & PTE_FLAGS_MASK;
420 #define pgprot_val(x) ((x).pgprot)
421 #define __pgprot(x) ((pgprot_t) { (x) } )
423 extern uint16_t __cachemode2pte_tbl[_PAGE_CACHE_MODE_NUM];
424 extern uint8_t __pte2cachemode_tbl[8];
426 #define __pte2cm_idx(cb) \
427 ((((cb) >> (_PAGE_BIT_PAT - 2)) & 4) | \
428 (((cb) >> (_PAGE_BIT_PCD - 1)) & 2) | \
429 (((cb) >> _PAGE_BIT_PWT) & 1))
430 #define __cm_idx2pte(i) \
431 ((((i) & 4) << (_PAGE_BIT_PAT - 2)) | \
432 (((i) & 2) << (_PAGE_BIT_PCD - 1)) | \
433 (((i) & 1) << _PAGE_BIT_PWT))
435 static inline unsigned long cachemode2protval(enum page_cache_mode pcm)
437 if (likely(pcm == 0))
439 return __cachemode2pte_tbl[pcm];
441 static inline pgprot_t cachemode2pgprot(enum page_cache_mode pcm)
443 return __pgprot(cachemode2protval(pcm));
445 static inline enum page_cache_mode pgprot2cachemode(pgprot_t pgprot)
447 unsigned long masked;
449 masked = pgprot_val(pgprot) & _PAGE_CACHE_MASK;
450 if (likely(masked == 0))
452 return __pte2cachemode_tbl[__pte2cm_idx(masked)];
454 static inline pgprot_t pgprot_4k_2_large(pgprot_t pgprot)
456 pgprotval_t val = pgprot_val(pgprot);
459 pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
460 ((val & _PAGE_PAT) << (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
463 static inline pgprot_t pgprot_large_2_4k(pgprot_t pgprot)
465 pgprotval_t val = pgprot_val(pgprot);
468 pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
469 ((val & _PAGE_PAT_LARGE) >>
470 (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
475 typedef struct page *pgtable_t;
477 extern pteval_t __supported_pte_mask;
478 extern void set_nx(void);
479 extern int nx_enabled;
481 #define pgprot_writecombine pgprot_writecombine
482 extern pgprot_t pgprot_writecombine(pgprot_t prot);
484 #define pgprot_writethrough pgprot_writethrough
485 extern pgprot_t pgprot_writethrough(pgprot_t prot);
487 /* Indicate that x86 has its own track and untrack pfn vma functions */
488 #define __HAVE_PFNMAP_TRACKING
490 #define __HAVE_PHYS_MEM_ACCESS_PROT
492 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
493 unsigned long size, pgprot_t vma_prot);
495 /* Install a pte for a particular vaddr in kernel space. */
496 void set_pte_vaddr(unsigned long vaddr, pte_t pte);
499 extern void native_pagetable_init(void);
501 #define native_pagetable_init paging_init
505 extern void arch_report_meminfo(struct seq_file *m);
516 #ifdef CONFIG_PROC_FS
517 extern void update_page_count(int level, unsigned long pages);
519 static inline void update_page_count(int level, unsigned long pages) { }
523 * Helper function that returns the kernel pagetable entry controlling
524 * the virtual address 'address'. NULL means no pagetable entry present.
525 * NOTE: the return type is pte_t but if the pmd is PSE then we return it
528 extern pte_t *lookup_address(unsigned long address, unsigned int *level);
529 extern pte_t *lookup_address_in_pgd(pgd_t *pgd, unsigned long address,
530 unsigned int *level);
531 extern pmd_t *lookup_pmd_address(unsigned long address);
532 extern phys_addr_t slow_virt_to_phys(void *__address);
533 extern int kernel_map_pages_in_pgd(pgd_t *pgd, u64 pfn, unsigned long address,
534 unsigned numpages, unsigned long page_flags);
535 #endif /* !__ASSEMBLY__ */
537 #endif /* _ASM_X86_PGTABLE_DEFS_H */