1 #ifndef _ASM_X86_PGTABLE_DEFS_H
2 #define _ASM_X86_PGTABLE_DEFS_H
4 #include <linux/const.h>
5 #include <asm/page_types.h>
7 #define FIRST_USER_ADDRESS 0UL
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+ */
19 #define _PAGE_BIT_SOFTW1 9 /* available for programmer */
20 #define _PAGE_BIT_SOFTW2 10 /* " */
21 #define _PAGE_BIT_SOFTW3 11 /* " */
22 #define _PAGE_BIT_PAT_LARGE 12 /* On 2MB or 1GB pages */
23 #define _PAGE_BIT_SOFTW4 58 /* available for programmer */
24 #define _PAGE_BIT_PKEY_BIT0 59 /* Protection Keys, bit 1/4 */
25 #define _PAGE_BIT_PKEY_BIT1 60 /* Protection Keys, bit 2/4 */
26 #define _PAGE_BIT_PKEY_BIT2 61 /* Protection Keys, bit 3/4 */
27 #define _PAGE_BIT_PKEY_BIT3 62 /* Protection Keys, bit 4/4 */
28 #define _PAGE_BIT_NX 63 /* No execute: only valid after cpuid check */
30 #define _PAGE_BIT_SPECIAL _PAGE_BIT_SOFTW1
31 #define _PAGE_BIT_CPA_TEST _PAGE_BIT_SOFTW1
32 #define _PAGE_BIT_HIDDEN _PAGE_BIT_SOFTW3 /* hidden by kmemcheck */
33 #define _PAGE_BIT_SOFT_DIRTY _PAGE_BIT_SOFTW3 /* software dirty tracking */
34 #define _PAGE_BIT_DEVMAP _PAGE_BIT_SOFTW4
36 /* If _PAGE_BIT_PRESENT is clear, we use these: */
37 /* - if the user mapped it with PROT_NONE; pte_present gives true */
38 #define _PAGE_BIT_PROTNONE _PAGE_BIT_GLOBAL
40 #define _PAGE_PRESENT (_AT(pteval_t, 1) << _PAGE_BIT_PRESENT)
41 #define _PAGE_RW (_AT(pteval_t, 1) << _PAGE_BIT_RW)
42 #define _PAGE_USER (_AT(pteval_t, 1) << _PAGE_BIT_USER)
43 #define _PAGE_PWT (_AT(pteval_t, 1) << _PAGE_BIT_PWT)
44 #define _PAGE_PCD (_AT(pteval_t, 1) << _PAGE_BIT_PCD)
45 #define _PAGE_ACCESSED (_AT(pteval_t, 1) << _PAGE_BIT_ACCESSED)
46 #define _PAGE_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_DIRTY)
47 #define _PAGE_PSE (_AT(pteval_t, 1) << _PAGE_BIT_PSE)
48 #define _PAGE_GLOBAL (_AT(pteval_t, 1) << _PAGE_BIT_GLOBAL)
49 #define _PAGE_SOFTW1 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW1)
50 #define _PAGE_SOFTW2 (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW2)
51 #define _PAGE_PAT (_AT(pteval_t, 1) << _PAGE_BIT_PAT)
52 #define _PAGE_PAT_LARGE (_AT(pteval_t, 1) << _PAGE_BIT_PAT_LARGE)
53 #define _PAGE_SPECIAL (_AT(pteval_t, 1) << _PAGE_BIT_SPECIAL)
54 #define _PAGE_CPA_TEST (_AT(pteval_t, 1) << _PAGE_BIT_CPA_TEST)
55 #ifdef CONFIG_X86_INTEL_MEMORY_PROTECTION_KEYS
56 #define _PAGE_PKEY_BIT0 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT0)
57 #define _PAGE_PKEY_BIT1 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT1)
58 #define _PAGE_PKEY_BIT2 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT2)
59 #define _PAGE_PKEY_BIT3 (_AT(pteval_t, 1) << _PAGE_BIT_PKEY_BIT3)
61 #define _PAGE_PKEY_BIT0 (_AT(pteval_t, 0))
62 #define _PAGE_PKEY_BIT1 (_AT(pteval_t, 0))
63 #define _PAGE_PKEY_BIT2 (_AT(pteval_t, 0))
64 #define _PAGE_PKEY_BIT3 (_AT(pteval_t, 0))
66 #define __HAVE_ARCH_PTE_SPECIAL
68 #define _PAGE_PKEY_MASK (_PAGE_PKEY_BIT0 | \
73 #ifdef CONFIG_KMEMCHECK
74 #define _PAGE_HIDDEN (_AT(pteval_t, 1) << _PAGE_BIT_HIDDEN)
76 #define _PAGE_HIDDEN (_AT(pteval_t, 0))
80 * The same hidden bit is used by kmemcheck, but since kmemcheck
81 * works on kernel pages while soft-dirty engine on user space,
82 * they do not conflict with each other.
85 #ifdef CONFIG_MEM_SOFT_DIRTY
86 #define _PAGE_SOFT_DIRTY (_AT(pteval_t, 1) << _PAGE_BIT_SOFT_DIRTY)
88 #define _PAGE_SOFT_DIRTY (_AT(pteval_t, 0))
92 * Tracking soft dirty bit when a page goes to a swap is tricky.
93 * We need a bit which can be stored in pte _and_ not conflict
94 * with swap entry format. On x86 bits 6 and 7 are *not* involved
95 * into swap entry computation, but bit 6 is used for nonlinear
96 * file mapping, so we borrow bit 7 for soft dirty tracking.
98 * Please note that this bit must be treated as swap dirty page
99 * mark if and only if the PTE has present bit clear!
101 #ifdef CONFIG_MEM_SOFT_DIRTY
102 #define _PAGE_SWP_SOFT_DIRTY _PAGE_PSE
104 #define _PAGE_SWP_SOFT_DIRTY (_AT(pteval_t, 0))
107 #if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
108 #define _PAGE_NX (_AT(pteval_t, 1) << _PAGE_BIT_NX)
109 #define _PAGE_DEVMAP (_AT(u64, 1) << _PAGE_BIT_DEVMAP)
110 #define __HAVE_ARCH_PTE_DEVMAP
112 #define _PAGE_NX (_AT(pteval_t, 0))
113 #define _PAGE_DEVMAP (_AT(pteval_t, 0))
116 #define _PAGE_PROTNONE (_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)
118 #define _PAGE_TABLE (_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | \
119 _PAGE_ACCESSED | _PAGE_DIRTY)
120 #define _KERNPG_TABLE (_PAGE_PRESENT | _PAGE_RW | _PAGE_ACCESSED | \
124 * Set of bits not changed in pte_modify. The pte's
125 * protection key is treated like _PAGE_RW, for
126 * instance, and is *not* included in this mask since
127 * pte_modify() does modify it.
129 #define _PAGE_CHG_MASK (PTE_PFN_MASK | _PAGE_PCD | _PAGE_PWT | \
130 _PAGE_SPECIAL | _PAGE_ACCESSED | _PAGE_DIRTY | \
132 #define _HPAGE_CHG_MASK (_PAGE_CHG_MASK | _PAGE_PSE)
135 * The cache modes defined here are used to translate between pure SW usage
136 * and the HW defined cache mode bits and/or PAT entries.
138 * The resulting bits for PWT, PCD and PAT should be chosen in a way
139 * to have the WB mode at index 0 (all bits clear). This is the default
140 * right now and likely would break too much if changed.
143 enum page_cache_mode {
144 _PAGE_CACHE_MODE_WB = 0,
145 _PAGE_CACHE_MODE_WC = 1,
146 _PAGE_CACHE_MODE_UC_MINUS = 2,
147 _PAGE_CACHE_MODE_UC = 3,
148 _PAGE_CACHE_MODE_WT = 4,
149 _PAGE_CACHE_MODE_WP = 5,
150 _PAGE_CACHE_MODE_NUM = 8
154 #define _PAGE_CACHE_MASK (_PAGE_PAT | _PAGE_PCD | _PAGE_PWT)
155 #define _PAGE_NOCACHE (cachemode2protval(_PAGE_CACHE_MODE_UC))
157 #define PAGE_NONE __pgprot(_PAGE_PROTNONE | _PAGE_ACCESSED)
158 #define PAGE_SHARED __pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | \
159 _PAGE_ACCESSED | _PAGE_NX)
161 #define PAGE_SHARED_EXEC __pgprot(_PAGE_PRESENT | _PAGE_RW | \
162 _PAGE_USER | _PAGE_ACCESSED)
163 #define PAGE_COPY_NOEXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | \
164 _PAGE_ACCESSED | _PAGE_NX)
165 #define PAGE_COPY_EXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | \
167 #define PAGE_COPY PAGE_COPY_NOEXEC
168 #define PAGE_READONLY __pgprot(_PAGE_PRESENT | _PAGE_USER | \
169 _PAGE_ACCESSED | _PAGE_NX)
170 #define PAGE_READONLY_EXEC __pgprot(_PAGE_PRESENT | _PAGE_USER | \
173 #define __PAGE_KERNEL_EXEC \
174 (_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED | _PAGE_GLOBAL)
175 #define __PAGE_KERNEL (__PAGE_KERNEL_EXEC | _PAGE_NX)
177 #define __PAGE_KERNEL_RO (__PAGE_KERNEL & ~_PAGE_RW)
178 #define __PAGE_KERNEL_RX (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
179 #define __PAGE_KERNEL_NOCACHE (__PAGE_KERNEL | _PAGE_NOCACHE)
180 #define __PAGE_KERNEL_VSYSCALL (__PAGE_KERNEL_RX | _PAGE_USER)
181 #define __PAGE_KERNEL_VVAR (__PAGE_KERNEL_RO | _PAGE_USER)
182 #define __PAGE_KERNEL_LARGE (__PAGE_KERNEL | _PAGE_PSE)
183 #define __PAGE_KERNEL_LARGE_EXEC (__PAGE_KERNEL_EXEC | _PAGE_PSE)
185 #define __PAGE_KERNEL_IO (__PAGE_KERNEL)
186 #define __PAGE_KERNEL_IO_NOCACHE (__PAGE_KERNEL_NOCACHE)
188 #define PAGE_KERNEL __pgprot(__PAGE_KERNEL)
189 #define PAGE_KERNEL_RO __pgprot(__PAGE_KERNEL_RO)
190 #define PAGE_KERNEL_EXEC __pgprot(__PAGE_KERNEL_EXEC)
191 #define PAGE_KERNEL_RX __pgprot(__PAGE_KERNEL_RX)
192 #define PAGE_KERNEL_NOCACHE __pgprot(__PAGE_KERNEL_NOCACHE)
193 #define PAGE_KERNEL_LARGE __pgprot(__PAGE_KERNEL_LARGE)
194 #define PAGE_KERNEL_LARGE_EXEC __pgprot(__PAGE_KERNEL_LARGE_EXEC)
195 #define PAGE_KERNEL_VSYSCALL __pgprot(__PAGE_KERNEL_VSYSCALL)
196 #define PAGE_KERNEL_VVAR __pgprot(__PAGE_KERNEL_VVAR)
198 #define PAGE_KERNEL_IO __pgprot(__PAGE_KERNEL_IO)
199 #define PAGE_KERNEL_IO_NOCACHE __pgprot(__PAGE_KERNEL_IO_NOCACHE)
202 #define __P000 PAGE_NONE
203 #define __P001 PAGE_READONLY
204 #define __P010 PAGE_COPY
205 #define __P011 PAGE_COPY
206 #define __P100 PAGE_READONLY_EXEC
207 #define __P101 PAGE_READONLY_EXEC
208 #define __P110 PAGE_COPY_EXEC
209 #define __P111 PAGE_COPY_EXEC
211 #define __S000 PAGE_NONE
212 #define __S001 PAGE_READONLY
213 #define __S010 PAGE_SHARED
214 #define __S011 PAGE_SHARED
215 #define __S100 PAGE_READONLY_EXEC
216 #define __S101 PAGE_READONLY_EXEC
217 #define __S110 PAGE_SHARED_EXEC
218 #define __S111 PAGE_SHARED_EXEC
221 * early identity mapping pte attrib macros.
224 #define __PAGE_KERNEL_IDENT_LARGE_EXEC __PAGE_KERNEL_LARGE_EXEC
226 #define PTE_IDENT_ATTR 0x003 /* PRESENT+RW */
227 #define PDE_IDENT_ATTR 0x063 /* PRESENT+RW+DIRTY+ACCESSED */
228 #define PGD_IDENT_ATTR 0x001 /* PRESENT (no other attributes) */
232 # include <asm/pgtable_32_types.h>
234 # include <asm/pgtable_64_types.h>
239 #include <linux/types.h>
241 /* Extracts the PFN from a (pte|pmd|pud|pgd)val_t of a 4KB page */
242 #define PTE_PFN_MASK ((pteval_t)PHYSICAL_PAGE_MASK)
245 * Extracts the flags from a (pte|pmd|pud|pgd)val_t
246 * This includes the protection key value.
248 #define PTE_FLAGS_MASK (~PTE_PFN_MASK)
250 typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;
252 typedef struct { pgdval_t pgd; } pgd_t;
254 static inline pgd_t native_make_pgd(pgdval_t val)
256 return (pgd_t) { val };
259 static inline pgdval_t native_pgd_val(pgd_t pgd)
264 static inline pgdval_t pgd_flags(pgd_t pgd)
266 return native_pgd_val(pgd) & PTE_FLAGS_MASK;
269 #if CONFIG_PGTABLE_LEVELS > 3
270 typedef struct { pudval_t pud; } pud_t;
272 static inline pud_t native_make_pud(pmdval_t val)
274 return (pud_t) { val };
277 static inline pudval_t native_pud_val(pud_t pud)
282 #include <asm-generic/pgtable-nopud.h>
284 static inline pudval_t native_pud_val(pud_t pud)
286 return native_pgd_val(pud.pgd);
290 #if CONFIG_PGTABLE_LEVELS > 2
291 typedef struct { pmdval_t pmd; } pmd_t;
293 static inline pmd_t native_make_pmd(pmdval_t val)
295 return (pmd_t) { val };
298 static inline pmdval_t native_pmd_val(pmd_t pmd)
303 #include <asm-generic/pgtable-nopmd.h>
305 static inline pmdval_t native_pmd_val(pmd_t pmd)
307 return native_pgd_val(pmd.pud.pgd);
311 static inline pudval_t pud_pfn_mask(pud_t pud)
313 if (native_pud_val(pud) & _PAGE_PSE)
314 return PHYSICAL_PUD_PAGE_MASK;
319 static inline pudval_t pud_flags_mask(pud_t pud)
321 return ~pud_pfn_mask(pud);
324 static inline pudval_t pud_flags(pud_t pud)
326 return native_pud_val(pud) & pud_flags_mask(pud);
329 static inline pmdval_t pmd_pfn_mask(pmd_t pmd)
331 if (native_pmd_val(pmd) & _PAGE_PSE)
332 return PHYSICAL_PMD_PAGE_MASK;
337 static inline pmdval_t pmd_flags_mask(pmd_t pmd)
339 return ~pmd_pfn_mask(pmd);
342 static inline pmdval_t pmd_flags(pmd_t pmd)
344 return native_pmd_val(pmd) & pmd_flags_mask(pmd);
347 static inline pte_t native_make_pte(pteval_t val)
349 return (pte_t) { .pte = val };
352 static inline pteval_t native_pte_val(pte_t pte)
357 static inline pteval_t pte_flags(pte_t pte)
359 return native_pte_val(pte) & PTE_FLAGS_MASK;
362 #define pgprot_val(x) ((x).pgprot)
363 #define __pgprot(x) ((pgprot_t) { (x) } )
365 extern uint16_t __cachemode2pte_tbl[_PAGE_CACHE_MODE_NUM];
366 extern uint8_t __pte2cachemode_tbl[8];
368 #define __pte2cm_idx(cb) \
369 ((((cb) >> (_PAGE_BIT_PAT - 2)) & 4) | \
370 (((cb) >> (_PAGE_BIT_PCD - 1)) & 2) | \
371 (((cb) >> _PAGE_BIT_PWT) & 1))
372 #define __cm_idx2pte(i) \
373 ((((i) & 4) << (_PAGE_BIT_PAT - 2)) | \
374 (((i) & 2) << (_PAGE_BIT_PCD - 1)) | \
375 (((i) & 1) << _PAGE_BIT_PWT))
377 static inline unsigned long cachemode2protval(enum page_cache_mode pcm)
379 if (likely(pcm == 0))
381 return __cachemode2pte_tbl[pcm];
383 static inline pgprot_t cachemode2pgprot(enum page_cache_mode pcm)
385 return __pgprot(cachemode2protval(pcm));
387 static inline enum page_cache_mode pgprot2cachemode(pgprot_t pgprot)
389 unsigned long masked;
391 masked = pgprot_val(pgprot) & _PAGE_CACHE_MASK;
392 if (likely(masked == 0))
394 return __pte2cachemode_tbl[__pte2cm_idx(masked)];
396 static inline pgprot_t pgprot_4k_2_large(pgprot_t pgprot)
398 pgprotval_t val = pgprot_val(pgprot);
401 pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
402 ((val & _PAGE_PAT) << (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
405 static inline pgprot_t pgprot_large_2_4k(pgprot_t pgprot)
407 pgprotval_t val = pgprot_val(pgprot);
410 pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
411 ((val & _PAGE_PAT_LARGE) >>
412 (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
417 typedef struct page *pgtable_t;
419 extern pteval_t __supported_pte_mask;
420 extern void set_nx(void);
421 extern int nx_enabled;
423 #define pgprot_writecombine pgprot_writecombine
424 extern pgprot_t pgprot_writecombine(pgprot_t prot);
426 #define pgprot_writethrough pgprot_writethrough
427 extern pgprot_t pgprot_writethrough(pgprot_t prot);
429 /* Indicate that x86 has its own track and untrack pfn vma functions */
430 #define __HAVE_PFNMAP_TRACKING
432 #define __HAVE_PHYS_MEM_ACCESS_PROT
434 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
435 unsigned long size, pgprot_t vma_prot);
436 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
437 unsigned long size, pgprot_t *vma_prot);
439 /* Install a pte for a particular vaddr in kernel space. */
440 void set_pte_vaddr(unsigned long vaddr, pte_t pte);
443 extern void native_pagetable_init(void);
445 #define native_pagetable_init paging_init
449 extern void arch_report_meminfo(struct seq_file *m);
459 #ifdef CONFIG_PROC_FS
460 extern void update_page_count(int level, unsigned long pages);
462 static inline void update_page_count(int level, unsigned long pages) { }
466 * Helper function that returns the kernel pagetable entry controlling
467 * the virtual address 'address'. NULL means no pagetable entry present.
468 * NOTE: the return type is pte_t but if the pmd is PSE then we return it
471 extern pte_t *lookup_address(unsigned long address, unsigned int *level);
472 extern pte_t *lookup_address_in_pgd(pgd_t *pgd, unsigned long address,
473 unsigned int *level);
474 extern pmd_t *lookup_pmd_address(unsigned long address);
475 extern phys_addr_t slow_virt_to_phys(void *__address);
476 extern int kernel_map_pages_in_pgd(pgd_t *pgd, u64 pfn, unsigned long address,
477 unsigned numpages, unsigned long page_flags);
478 void kernel_unmap_pages_in_pgd(pgd_t *root, unsigned long address,
480 #endif /* !__ASSEMBLY__ */
482 #endif /* _ASM_X86_PGTABLE_DEFS_H */