KPTI: Rename to PAGE_TABLE_ISOLATION
[pandora-kernel.git] / arch / x86 / include / asm / pgtable_types.h
1 #ifndef _ASM_X86_PGTABLE_DEFS_H
2 #define _ASM_X86_PGTABLE_DEFS_H
3
4 #include <linux/const.h>
5 #include <asm/page_types.h>
6
7 #define FIRST_USER_ADDRESS      0
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+ */
19 #define _PAGE_BIT_UNUSED1       9       /* available for programmer */
20 #define _PAGE_BIT_IOMAP         10      /* flag used to indicate IO mapping */
21 #define _PAGE_BIT_HIDDEN        11      /* hidden by kmemcheck */
22 #define _PAGE_BIT_PAT_LARGE     12      /* On 2MB or 1GB pages */
23 #define _PAGE_BIT_SPECIAL       _PAGE_BIT_UNUSED1
24 #define _PAGE_BIT_CPA_TEST      _PAGE_BIT_UNUSED1
25 #define _PAGE_BIT_SPLITTING     _PAGE_BIT_UNUSED1 /* only valid on a PSE pmd */
26 #define _PAGE_BIT_NX           63       /* No execute: only valid after cpuid check */
27
28 /* If _PAGE_BIT_PRESENT is clear, we use these: */
29 /* - if the user mapped it with PROT_NONE; pte_present gives true */
30 #define _PAGE_BIT_PROTNONE      _PAGE_BIT_GLOBAL
31 /* - set: nonlinear file mapping, saved PTE; unset:swap */
32 #define _PAGE_BIT_FILE          _PAGE_BIT_DIRTY
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)
43 #define _PAGE_UNUSED1   (_AT(pteval_t, 1) << _PAGE_BIT_UNUSED1)
44 #define _PAGE_IOMAP     (_AT(pteval_t, 1) << _PAGE_BIT_IOMAP)
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)
49 #define _PAGE_SPLITTING (_AT(pteval_t, 1) << _PAGE_BIT_SPLITTING)
50 #define __HAVE_ARCH_PTE_SPECIAL
51
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
58 #if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
59 #define _PAGE_NX        (_AT(pteval_t, 1) << _PAGE_BIT_NX)
60 #else
61 #define _PAGE_NX        (_AT(pteval_t, 0))
62 #endif
63
64 #define _PAGE_FILE      (_AT(pteval_t, 1) << _PAGE_BIT_FILE)
65 #define _PAGE_PROTNONE  (_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)
66
67 #define _PAGE_TABLE     (_PAGE_PRESENT | _PAGE_RW | _PAGE_USER |        \
68                          _PAGE_ACCESSED | _PAGE_DIRTY)
69 #define _KERNPG_TABLE   (_PAGE_PRESENT | _PAGE_RW | _PAGE_ACCESSED |    \
70                          _PAGE_DIRTY)
71
72 /* Set of bits not changed in pte_modify */
73 #define _PAGE_CHG_MASK  (PTE_PFN_MASK | _PAGE_PCD | _PAGE_PWT |         \
74                          _PAGE_SPECIAL | _PAGE_ACCESSED | _PAGE_DIRTY)
75 #define _HPAGE_CHG_MASK (_PAGE_CHG_MASK | _PAGE_PSE)
76
77 /* The ASID is the lower 12 bits of CR3 */
78 #define X86_CR3_PCID_ASID_MASK  (_AC((1<<12)-1,UL))
79
80 /* Mask for all the PCID-related bits in CR3: */
81 #define X86_CR3_PCID_MASK       (X86_CR3_PCID_NOFLUSH | X86_CR3_PCID_ASID_MASK)
82 #define X86_CR3_PCID_ASID_KERN  (_AC(0x0,UL))
83
84 #if defined(CONFIG_PAGE_TABLE_ISOLATION) && defined(CONFIG_X86_64)
85 /* Let X86_CR3_PCID_ASID_USER be usable for the X86_CR3_PCID_NOFLUSH bit */
86 #define X86_CR3_PCID_ASID_USER  (_AC(0x80,UL))
87
88 #define X86_CR3_PCID_KERN_FLUSH         (X86_CR3_PCID_ASID_KERN)
89 #define X86_CR3_PCID_USER_FLUSH         (X86_CR3_PCID_ASID_USER)
90 #define X86_CR3_PCID_KERN_NOFLUSH       (X86_CR3_PCID_NOFLUSH | X86_CR3_PCID_ASID_KERN)
91 #define X86_CR3_PCID_USER_NOFLUSH       (X86_CR3_PCID_NOFLUSH | X86_CR3_PCID_ASID_USER)
92 #else
93 #define X86_CR3_PCID_ASID_USER  (_AC(0x0,UL))
94 /*
95  * PCIDs are unsupported on 32-bit and none of these bits can be
96  * set in CR3:
97  */
98 #define X86_CR3_PCID_KERN_FLUSH         (0)
99 #define X86_CR3_PCID_USER_FLUSH         (0)
100 #define X86_CR3_PCID_KERN_NOFLUSH       (0)
101 #define X86_CR3_PCID_USER_NOFLUSH       (0)
102 #endif
103
104 #define _PAGE_CACHE_MASK        (_PAGE_PCD | _PAGE_PWT)
105 #define _PAGE_CACHE_WB          (0)
106 #define _PAGE_CACHE_WC          (_PAGE_PWT)
107 #define _PAGE_CACHE_UC_MINUS    (_PAGE_PCD)
108 #define _PAGE_CACHE_UC          (_PAGE_PCD | _PAGE_PWT)
109
110 #define PAGE_NONE       __pgprot(_PAGE_PROTNONE | _PAGE_ACCESSED)
111 #define PAGE_SHARED     __pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | \
112                                  _PAGE_ACCESSED | _PAGE_NX)
113
114 #define PAGE_SHARED_EXEC        __pgprot(_PAGE_PRESENT | _PAGE_RW |     \
115                                          _PAGE_USER | _PAGE_ACCESSED)
116 #define PAGE_COPY_NOEXEC        __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
117                                          _PAGE_ACCESSED | _PAGE_NX)
118 #define PAGE_COPY_EXEC          __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
119                                          _PAGE_ACCESSED)
120 #define PAGE_COPY               PAGE_COPY_NOEXEC
121 #define PAGE_READONLY           __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
122                                          _PAGE_ACCESSED | _PAGE_NX)
123 #define PAGE_READONLY_EXEC      __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
124                                          _PAGE_ACCESSED)
125
126 #define __PAGE_KERNEL_EXEC                                              \
127         (_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED | _PAGE_GLOBAL)
128 #define __PAGE_KERNEL           (__PAGE_KERNEL_EXEC | _PAGE_NX)
129
130 #define __PAGE_KERNEL_RO                (__PAGE_KERNEL & ~_PAGE_RW)
131 #define __PAGE_KERNEL_RX                (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
132 #define __PAGE_KERNEL_EXEC_NOCACHE      (__PAGE_KERNEL_EXEC | _PAGE_PCD | _PAGE_PWT)
133 #define __PAGE_KERNEL_WC                (__PAGE_KERNEL | _PAGE_CACHE_WC)
134 #define __PAGE_KERNEL_NOCACHE           (__PAGE_KERNEL | _PAGE_PCD | _PAGE_PWT)
135 #define __PAGE_KERNEL_UC_MINUS          (__PAGE_KERNEL | _PAGE_PCD)
136 #define __PAGE_KERNEL_VSYSCALL          (__PAGE_KERNEL_RX | _PAGE_USER)
137 #define __PAGE_KERNEL_VVAR              (__PAGE_KERNEL_RO | _PAGE_USER)
138 #define __PAGE_KERNEL_VVAR_NOCACHE      (__PAGE_KERNEL_VVAR | _PAGE_PCD | _PAGE_PWT)
139 #define __PAGE_KERNEL_LARGE             (__PAGE_KERNEL | _PAGE_PSE)
140 #define __PAGE_KERNEL_LARGE_NOCACHE     (__PAGE_KERNEL | _PAGE_CACHE_UC | _PAGE_PSE)
141 #define __PAGE_KERNEL_LARGE_EXEC        (__PAGE_KERNEL_EXEC | _PAGE_PSE)
142
143 #define __PAGE_KERNEL_IO                (__PAGE_KERNEL | _PAGE_IOMAP)
144 #define __PAGE_KERNEL_IO_NOCACHE        (__PAGE_KERNEL_NOCACHE | _PAGE_IOMAP)
145 #define __PAGE_KERNEL_IO_UC_MINUS       (__PAGE_KERNEL_UC_MINUS | _PAGE_IOMAP)
146 #define __PAGE_KERNEL_IO_WC             (__PAGE_KERNEL_WC | _PAGE_IOMAP)
147
148 #define PAGE_KERNEL                     __pgprot(__PAGE_KERNEL)
149 #define PAGE_KERNEL_RO                  __pgprot(__PAGE_KERNEL_RO)
150 #define PAGE_KERNEL_EXEC                __pgprot(__PAGE_KERNEL_EXEC)
151 #define PAGE_KERNEL_RX                  __pgprot(__PAGE_KERNEL_RX)
152 #define PAGE_KERNEL_WC                  __pgprot(__PAGE_KERNEL_WC)
153 #define PAGE_KERNEL_NOCACHE             __pgprot(__PAGE_KERNEL_NOCACHE)
154 #define PAGE_KERNEL_UC_MINUS            __pgprot(__PAGE_KERNEL_UC_MINUS)
155 #define PAGE_KERNEL_EXEC_NOCACHE        __pgprot(__PAGE_KERNEL_EXEC_NOCACHE)
156 #define PAGE_KERNEL_LARGE               __pgprot(__PAGE_KERNEL_LARGE)
157 #define PAGE_KERNEL_LARGE_NOCACHE       __pgprot(__PAGE_KERNEL_LARGE_NOCACHE)
158 #define PAGE_KERNEL_LARGE_EXEC          __pgprot(__PAGE_KERNEL_LARGE_EXEC)
159 #define PAGE_KERNEL_VSYSCALL            __pgprot(__PAGE_KERNEL_VSYSCALL)
160 #define PAGE_KERNEL_VVAR                __pgprot(__PAGE_KERNEL_VVAR)
161 #define PAGE_KERNEL_VVAR_NOCACHE        __pgprot(__PAGE_KERNEL_VVAR_NOCACHE)
162
163 #define PAGE_KERNEL_IO                  __pgprot(__PAGE_KERNEL_IO)
164 #define PAGE_KERNEL_IO_NOCACHE          __pgprot(__PAGE_KERNEL_IO_NOCACHE)
165 #define PAGE_KERNEL_IO_UC_MINUS         __pgprot(__PAGE_KERNEL_IO_UC_MINUS)
166 #define PAGE_KERNEL_IO_WC               __pgprot(__PAGE_KERNEL_IO_WC)
167
168 /*         xwr */
169 #define __P000  PAGE_NONE
170 #define __P001  PAGE_READONLY
171 #define __P010  PAGE_COPY
172 #define __P011  PAGE_COPY
173 #define __P100  PAGE_READONLY_EXEC
174 #define __P101  PAGE_READONLY_EXEC
175 #define __P110  PAGE_COPY_EXEC
176 #define __P111  PAGE_COPY_EXEC
177
178 #define __S000  PAGE_NONE
179 #define __S001  PAGE_READONLY
180 #define __S010  PAGE_SHARED
181 #define __S011  PAGE_SHARED
182 #define __S100  PAGE_READONLY_EXEC
183 #define __S101  PAGE_READONLY_EXEC
184 #define __S110  PAGE_SHARED_EXEC
185 #define __S111  PAGE_SHARED_EXEC
186
187 /*
188  * early identity mapping  pte attrib macros.
189  */
190 #ifdef CONFIG_X86_64
191 #define __PAGE_KERNEL_IDENT_LARGE_EXEC  __PAGE_KERNEL_LARGE_EXEC
192 #else
193 /*
194  * For PDE_IDENT_ATTR include USER bit. As the PDE and PTE protection
195  * bits are combined, this will alow user to access the high address mapped
196  * VDSO in the presence of CONFIG_COMPAT_VDSO
197  */
198 #define PTE_IDENT_ATTR   0x003          /* PRESENT+RW */
199 #define PDE_IDENT_ATTR   0x067          /* PRESENT+RW+USER+DIRTY+ACCESSED */
200 #define PGD_IDENT_ATTR   0x001          /* PRESENT (no other attributes) */
201 #endif
202
203 #ifdef CONFIG_X86_32
204 # include "pgtable_32_types.h"
205 #else
206 # include "pgtable_64_types.h"
207 #endif
208
209 #ifndef __ASSEMBLY__
210
211 #include <linux/types.h>
212
213 /* PTE_PFN_MASK extracts the PFN from a (pte|pmd|pud|pgd)val_t */
214 #define PTE_PFN_MASK            ((pteval_t)PHYSICAL_PAGE_MASK)
215
216 /* PTE_FLAGS_MASK extracts the flags from a (pte|pmd|pud|pgd)val_t */
217 #define PTE_FLAGS_MASK          (~PTE_PFN_MASK)
218
219 typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;
220
221 typedef struct { pgdval_t pgd; } pgd_t;
222
223 static inline pgd_t native_make_pgd(pgdval_t val)
224 {
225         return (pgd_t) { val };
226 }
227
228 static inline pgdval_t native_pgd_val(pgd_t pgd)
229 {
230         return pgd.pgd;
231 }
232
233 static inline pgdval_t pgd_flags(pgd_t pgd)
234 {
235         return native_pgd_val(pgd) & PTE_FLAGS_MASK;
236 }
237
238 #if PAGETABLE_LEVELS > 3
239 typedef struct { pudval_t pud; } pud_t;
240
241 static inline pud_t native_make_pud(pmdval_t val)
242 {
243         return (pud_t) { val };
244 }
245
246 static inline pudval_t native_pud_val(pud_t pud)
247 {
248         return pud.pud;
249 }
250 #else
251 #include <asm-generic/pgtable-nopud.h>
252
253 static inline pudval_t native_pud_val(pud_t pud)
254 {
255         return native_pgd_val(pud.pgd);
256 }
257 #endif
258
259 #if PAGETABLE_LEVELS > 2
260 typedef struct { pmdval_t pmd; } pmd_t;
261
262 static inline pmd_t native_make_pmd(pmdval_t val)
263 {
264         return (pmd_t) { val };
265 }
266
267 static inline pmdval_t native_pmd_val(pmd_t pmd)
268 {
269         return pmd.pmd;
270 }
271 #else
272 #include <asm-generic/pgtable-nopmd.h>
273
274 static inline pmdval_t native_pmd_val(pmd_t pmd)
275 {
276         return native_pgd_val(pmd.pud.pgd);
277 }
278 #endif
279
280 static inline pudval_t pud_flags(pud_t pud)
281 {
282         return native_pud_val(pud) & PTE_FLAGS_MASK;
283 }
284
285 static inline pmdval_t pmd_flags(pmd_t pmd)
286 {
287         return native_pmd_val(pmd) & PTE_FLAGS_MASK;
288 }
289
290 static inline pte_t native_make_pte(pteval_t val)
291 {
292         return (pte_t) { .pte = val };
293 }
294
295 static inline pteval_t native_pte_val(pte_t pte)
296 {
297         return pte.pte;
298 }
299
300 static inline pteval_t pte_flags(pte_t pte)
301 {
302         return native_pte_val(pte) & PTE_FLAGS_MASK;
303 }
304
305 #define pgprot_val(x)   ((x).pgprot)
306 #define __pgprot(x)     ((pgprot_t) { (x) } )
307
308
309 typedef struct page *pgtable_t;
310
311 extern pteval_t __supported_pte_mask;
312 extern void set_nx(void);
313 extern int nx_enabled;
314
315 #define pgprot_writecombine     pgprot_writecombine
316 extern pgprot_t pgprot_writecombine(pgprot_t prot);
317
318 /* Indicate that x86 has its own track and untrack pfn vma functions */
319 #define __HAVE_PFNMAP_TRACKING
320
321 #define __HAVE_PHYS_MEM_ACCESS_PROT
322 struct file;
323 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
324                               unsigned long size, pgprot_t vma_prot);
325 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
326                               unsigned long size, pgprot_t *vma_prot);
327
328 /* Install a pte for a particular vaddr in kernel space. */
329 void set_pte_vaddr(unsigned long vaddr, pte_t pte);
330
331 extern void native_pagetable_reserve(u64 start, u64 end);
332 #ifdef CONFIG_X86_32
333 extern void native_pagetable_setup_start(pgd_t *base);
334 extern void native_pagetable_setup_done(pgd_t *base);
335 #else
336 #define native_pagetable_setup_start x86_init_pgd_noop
337 #define native_pagetable_setup_done  x86_init_pgd_noop
338 #endif
339
340 struct seq_file;
341 extern void arch_report_meminfo(struct seq_file *m);
342
343 enum {
344         PG_LEVEL_NONE,
345         PG_LEVEL_4K,
346         PG_LEVEL_2M,
347         PG_LEVEL_1G,
348         PG_LEVEL_NUM
349 };
350
351 #ifdef CONFIG_PROC_FS
352 extern void update_page_count(int level, unsigned long pages);
353 #else
354 static inline void update_page_count(int level, unsigned long pages) { }
355 #endif
356
357 /*
358  * Helper function that returns the kernel pagetable entry controlling
359  * the virtual address 'address'. NULL means no pagetable entry present.
360  * NOTE: the return type is pte_t but if the pmd is PSE then we return it
361  * as a pte too.
362  */
363 extern pte_t *lookup_address(unsigned long address, unsigned int *level);
364
365 #endif  /* !__ASSEMBLY__ */
366
367 #endif /* _ASM_X86_PGTABLE_DEFS_H */