x86/mm/pkeys: Add arch-specific VMA protection bits
[cascardo/linux.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      0UL
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_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 */
29
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
35
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
39
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)
60 #else
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))
65 #endif
66 #define __HAVE_ARCH_PTE_SPECIAL
67
68 #ifdef CONFIG_KMEMCHECK
69 #define _PAGE_HIDDEN    (_AT(pteval_t, 1) << _PAGE_BIT_HIDDEN)
70 #else
71 #define _PAGE_HIDDEN    (_AT(pteval_t, 0))
72 #endif
73
74 /*
75  * The same hidden bit is used by kmemcheck, but since kmemcheck
76  * works on kernel pages while soft-dirty engine on user space,
77  * they do not conflict with each other.
78  */
79
80 #ifdef CONFIG_MEM_SOFT_DIRTY
81 #define _PAGE_SOFT_DIRTY        (_AT(pteval_t, 1) << _PAGE_BIT_SOFT_DIRTY)
82 #else
83 #define _PAGE_SOFT_DIRTY        (_AT(pteval_t, 0))
84 #endif
85
86 /*
87  * Tracking soft dirty bit when a page goes to a swap is tricky.
88  * We need a bit which can be stored in pte _and_ not conflict
89  * with swap entry format. On x86 bits 6 and 7 are *not* involved
90  * into swap entry computation, but bit 6 is used for nonlinear
91  * file mapping, so we borrow bit 7 for soft dirty tracking.
92  *
93  * Please note that this bit must be treated as swap dirty page
94  * mark if and only if the PTE has present bit clear!
95  */
96 #ifdef CONFIG_MEM_SOFT_DIRTY
97 #define _PAGE_SWP_SOFT_DIRTY    _PAGE_PSE
98 #else
99 #define _PAGE_SWP_SOFT_DIRTY    (_AT(pteval_t, 0))
100 #endif
101
102 #if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
103 #define _PAGE_NX        (_AT(pteval_t, 1) << _PAGE_BIT_NX)
104 #define _PAGE_DEVMAP    (_AT(u64, 1) << _PAGE_BIT_DEVMAP)
105 #define __HAVE_ARCH_PTE_DEVMAP
106 #else
107 #define _PAGE_NX        (_AT(pteval_t, 0))
108 #define _PAGE_DEVMAP    (_AT(pteval_t, 0))
109 #endif
110
111 #define _PAGE_PROTNONE  (_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)
112
113 #define _PAGE_TABLE     (_PAGE_PRESENT | _PAGE_RW | _PAGE_USER |        \
114                          _PAGE_ACCESSED | _PAGE_DIRTY)
115 #define _KERNPG_TABLE   (_PAGE_PRESENT | _PAGE_RW | _PAGE_ACCESSED |    \
116                          _PAGE_DIRTY)
117
118 /*
119  * Set of bits not changed in pte_modify.  The pte's
120  * protection key is treated like _PAGE_RW, for
121  * instance, and is *not* included in this mask since
122  * pte_modify() does modify it.
123  */
124 #define _PAGE_CHG_MASK  (PTE_PFN_MASK | _PAGE_PCD | _PAGE_PWT |         \
125                          _PAGE_SPECIAL | _PAGE_ACCESSED | _PAGE_DIRTY | \
126                          _PAGE_SOFT_DIRTY)
127 #define _HPAGE_CHG_MASK (_PAGE_CHG_MASK | _PAGE_PSE)
128
129 /*
130  * The cache modes defined here are used to translate between pure SW usage
131  * and the HW defined cache mode bits and/or PAT entries.
132  *
133  * The resulting bits for PWT, PCD and PAT should be chosen in a way
134  * to have the WB mode at index 0 (all bits clear). This is the default
135  * right now and likely would break too much if changed.
136  */
137 #ifndef __ASSEMBLY__
138 enum page_cache_mode {
139         _PAGE_CACHE_MODE_WB = 0,
140         _PAGE_CACHE_MODE_WC = 1,
141         _PAGE_CACHE_MODE_UC_MINUS = 2,
142         _PAGE_CACHE_MODE_UC = 3,
143         _PAGE_CACHE_MODE_WT = 4,
144         _PAGE_CACHE_MODE_WP = 5,
145         _PAGE_CACHE_MODE_NUM = 8
146 };
147 #endif
148
149 #define _PAGE_CACHE_MASK        (_PAGE_PAT | _PAGE_PCD | _PAGE_PWT)
150 #define _PAGE_NOCACHE           (cachemode2protval(_PAGE_CACHE_MODE_UC))
151
152 #define PAGE_NONE       __pgprot(_PAGE_PROTNONE | _PAGE_ACCESSED)
153 #define PAGE_SHARED     __pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | \
154                                  _PAGE_ACCESSED | _PAGE_NX)
155
156 #define PAGE_SHARED_EXEC        __pgprot(_PAGE_PRESENT | _PAGE_RW |     \
157                                          _PAGE_USER | _PAGE_ACCESSED)
158 #define PAGE_COPY_NOEXEC        __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
159                                          _PAGE_ACCESSED | _PAGE_NX)
160 #define PAGE_COPY_EXEC          __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
161                                          _PAGE_ACCESSED)
162 #define PAGE_COPY               PAGE_COPY_NOEXEC
163 #define PAGE_READONLY           __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
164                                          _PAGE_ACCESSED | _PAGE_NX)
165 #define PAGE_READONLY_EXEC      __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
166                                          _PAGE_ACCESSED)
167
168 #define __PAGE_KERNEL_EXEC                                              \
169         (_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED | _PAGE_GLOBAL)
170 #define __PAGE_KERNEL           (__PAGE_KERNEL_EXEC | _PAGE_NX)
171
172 #define __PAGE_KERNEL_RO                (__PAGE_KERNEL & ~_PAGE_RW)
173 #define __PAGE_KERNEL_RX                (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
174 #define __PAGE_KERNEL_NOCACHE           (__PAGE_KERNEL | _PAGE_NOCACHE)
175 #define __PAGE_KERNEL_VSYSCALL          (__PAGE_KERNEL_RX | _PAGE_USER)
176 #define __PAGE_KERNEL_VVAR              (__PAGE_KERNEL_RO | _PAGE_USER)
177 #define __PAGE_KERNEL_LARGE             (__PAGE_KERNEL | _PAGE_PSE)
178 #define __PAGE_KERNEL_LARGE_EXEC        (__PAGE_KERNEL_EXEC | _PAGE_PSE)
179
180 #define __PAGE_KERNEL_IO                (__PAGE_KERNEL)
181 #define __PAGE_KERNEL_IO_NOCACHE        (__PAGE_KERNEL_NOCACHE)
182
183 #define PAGE_KERNEL                     __pgprot(__PAGE_KERNEL)
184 #define PAGE_KERNEL_RO                  __pgprot(__PAGE_KERNEL_RO)
185 #define PAGE_KERNEL_EXEC                __pgprot(__PAGE_KERNEL_EXEC)
186 #define PAGE_KERNEL_RX                  __pgprot(__PAGE_KERNEL_RX)
187 #define PAGE_KERNEL_NOCACHE             __pgprot(__PAGE_KERNEL_NOCACHE)
188 #define PAGE_KERNEL_LARGE               __pgprot(__PAGE_KERNEL_LARGE)
189 #define PAGE_KERNEL_LARGE_EXEC          __pgprot(__PAGE_KERNEL_LARGE_EXEC)
190 #define PAGE_KERNEL_VSYSCALL            __pgprot(__PAGE_KERNEL_VSYSCALL)
191 #define PAGE_KERNEL_VVAR                __pgprot(__PAGE_KERNEL_VVAR)
192
193 #define PAGE_KERNEL_IO                  __pgprot(__PAGE_KERNEL_IO)
194 #define PAGE_KERNEL_IO_NOCACHE          __pgprot(__PAGE_KERNEL_IO_NOCACHE)
195
196 /*         xwr */
197 #define __P000  PAGE_NONE
198 #define __P001  PAGE_READONLY
199 #define __P010  PAGE_COPY
200 #define __P011  PAGE_COPY
201 #define __P100  PAGE_READONLY_EXEC
202 #define __P101  PAGE_READONLY_EXEC
203 #define __P110  PAGE_COPY_EXEC
204 #define __P111  PAGE_COPY_EXEC
205
206 #define __S000  PAGE_NONE
207 #define __S001  PAGE_READONLY
208 #define __S010  PAGE_SHARED
209 #define __S011  PAGE_SHARED
210 #define __S100  PAGE_READONLY_EXEC
211 #define __S101  PAGE_READONLY_EXEC
212 #define __S110  PAGE_SHARED_EXEC
213 #define __S111  PAGE_SHARED_EXEC
214
215 /*
216  * early identity mapping  pte attrib macros.
217  */
218 #ifdef CONFIG_X86_64
219 #define __PAGE_KERNEL_IDENT_LARGE_EXEC  __PAGE_KERNEL_LARGE_EXEC
220 #else
221 #define PTE_IDENT_ATTR   0x003          /* PRESENT+RW */
222 #define PDE_IDENT_ATTR   0x063          /* PRESENT+RW+DIRTY+ACCESSED */
223 #define PGD_IDENT_ATTR   0x001          /* PRESENT (no other attributes) */
224 #endif
225
226 #ifdef CONFIG_X86_32
227 # include <asm/pgtable_32_types.h>
228 #else
229 # include <asm/pgtable_64_types.h>
230 #endif
231
232 #ifndef __ASSEMBLY__
233
234 #include <linux/types.h>
235
236 /* Extracts the PFN from a (pte|pmd|pud|pgd)val_t of a 4KB page */
237 #define PTE_PFN_MASK            ((pteval_t)PHYSICAL_PAGE_MASK)
238
239 /*
240  *  Extracts the flags from a (pte|pmd|pud|pgd)val_t
241  *  This includes the protection key value.
242  */
243 #define PTE_FLAGS_MASK          (~PTE_PFN_MASK)
244
245 typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;
246
247 typedef struct { pgdval_t pgd; } pgd_t;
248
249 static inline pgd_t native_make_pgd(pgdval_t val)
250 {
251         return (pgd_t) { val };
252 }
253
254 static inline pgdval_t native_pgd_val(pgd_t pgd)
255 {
256         return pgd.pgd;
257 }
258
259 static inline pgdval_t pgd_flags(pgd_t pgd)
260 {
261         return native_pgd_val(pgd) & PTE_FLAGS_MASK;
262 }
263
264 #if CONFIG_PGTABLE_LEVELS > 3
265 typedef struct { pudval_t pud; } pud_t;
266
267 static inline pud_t native_make_pud(pmdval_t val)
268 {
269         return (pud_t) { val };
270 }
271
272 static inline pudval_t native_pud_val(pud_t pud)
273 {
274         return pud.pud;
275 }
276 #else
277 #include <asm-generic/pgtable-nopud.h>
278
279 static inline pudval_t native_pud_val(pud_t pud)
280 {
281         return native_pgd_val(pud.pgd);
282 }
283 #endif
284
285 #if CONFIG_PGTABLE_LEVELS > 2
286 typedef struct { pmdval_t pmd; } pmd_t;
287
288 static inline pmd_t native_make_pmd(pmdval_t val)
289 {
290         return (pmd_t) { val };
291 }
292
293 static inline pmdval_t native_pmd_val(pmd_t pmd)
294 {
295         return pmd.pmd;
296 }
297 #else
298 #include <asm-generic/pgtable-nopmd.h>
299
300 static inline pmdval_t native_pmd_val(pmd_t pmd)
301 {
302         return native_pgd_val(pmd.pud.pgd);
303 }
304 #endif
305
306 static inline pudval_t pud_pfn_mask(pud_t pud)
307 {
308         if (native_pud_val(pud) & _PAGE_PSE)
309                 return PHYSICAL_PUD_PAGE_MASK;
310         else
311                 return PTE_PFN_MASK;
312 }
313
314 static inline pudval_t pud_flags_mask(pud_t pud)
315 {
316         return ~pud_pfn_mask(pud);
317 }
318
319 static inline pudval_t pud_flags(pud_t pud)
320 {
321         return native_pud_val(pud) & pud_flags_mask(pud);
322 }
323
324 static inline pmdval_t pmd_pfn_mask(pmd_t pmd)
325 {
326         if (native_pmd_val(pmd) & _PAGE_PSE)
327                 return PHYSICAL_PMD_PAGE_MASK;
328         else
329                 return PTE_PFN_MASK;
330 }
331
332 static inline pmdval_t pmd_flags_mask(pmd_t pmd)
333 {
334         return ~pmd_pfn_mask(pmd);
335 }
336
337 static inline pmdval_t pmd_flags(pmd_t pmd)
338 {
339         return native_pmd_val(pmd) & pmd_flags_mask(pmd);
340 }
341
342 static inline pte_t native_make_pte(pteval_t val)
343 {
344         return (pte_t) { .pte = val };
345 }
346
347 static inline pteval_t native_pte_val(pte_t pte)
348 {
349         return pte.pte;
350 }
351
352 static inline pteval_t pte_flags(pte_t pte)
353 {
354         return native_pte_val(pte) & PTE_FLAGS_MASK;
355 }
356
357 #define pgprot_val(x)   ((x).pgprot)
358 #define __pgprot(x)     ((pgprot_t) { (x) } )
359
360 extern uint16_t __cachemode2pte_tbl[_PAGE_CACHE_MODE_NUM];
361 extern uint8_t __pte2cachemode_tbl[8];
362
363 #define __pte2cm_idx(cb)                                \
364         ((((cb) >> (_PAGE_BIT_PAT - 2)) & 4) |          \
365          (((cb) >> (_PAGE_BIT_PCD - 1)) & 2) |          \
366          (((cb) >> _PAGE_BIT_PWT) & 1))
367 #define __cm_idx2pte(i)                                 \
368         ((((i) & 4) << (_PAGE_BIT_PAT - 2)) |           \
369          (((i) & 2) << (_PAGE_BIT_PCD - 1)) |           \
370          (((i) & 1) << _PAGE_BIT_PWT))
371
372 static inline unsigned long cachemode2protval(enum page_cache_mode pcm)
373 {
374         if (likely(pcm == 0))
375                 return 0;
376         return __cachemode2pte_tbl[pcm];
377 }
378 static inline pgprot_t cachemode2pgprot(enum page_cache_mode pcm)
379 {
380         return __pgprot(cachemode2protval(pcm));
381 }
382 static inline enum page_cache_mode pgprot2cachemode(pgprot_t pgprot)
383 {
384         unsigned long masked;
385
386         masked = pgprot_val(pgprot) & _PAGE_CACHE_MASK;
387         if (likely(masked == 0))
388                 return 0;
389         return __pte2cachemode_tbl[__pte2cm_idx(masked)];
390 }
391 static inline pgprot_t pgprot_4k_2_large(pgprot_t pgprot)
392 {
393         pgprotval_t val = pgprot_val(pgprot);
394         pgprot_t new;
395
396         pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
397                 ((val & _PAGE_PAT) << (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
398         return new;
399 }
400 static inline pgprot_t pgprot_large_2_4k(pgprot_t pgprot)
401 {
402         pgprotval_t val = pgprot_val(pgprot);
403         pgprot_t new;
404
405         pgprot_val(new) = (val & ~(_PAGE_PAT | _PAGE_PAT_LARGE)) |
406                           ((val & _PAGE_PAT_LARGE) >>
407                            (_PAGE_BIT_PAT_LARGE - _PAGE_BIT_PAT));
408         return new;
409 }
410
411
412 typedef struct page *pgtable_t;
413
414 extern pteval_t __supported_pte_mask;
415 extern void set_nx(void);
416 extern int nx_enabled;
417
418 #define pgprot_writecombine     pgprot_writecombine
419 extern pgprot_t pgprot_writecombine(pgprot_t prot);
420
421 #define pgprot_writethrough     pgprot_writethrough
422 extern pgprot_t pgprot_writethrough(pgprot_t prot);
423
424 /* Indicate that x86 has its own track and untrack pfn vma functions */
425 #define __HAVE_PFNMAP_TRACKING
426
427 #define __HAVE_PHYS_MEM_ACCESS_PROT
428 struct file;
429 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
430                               unsigned long size, pgprot_t vma_prot);
431 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
432                               unsigned long size, pgprot_t *vma_prot);
433
434 /* Install a pte for a particular vaddr in kernel space. */
435 void set_pte_vaddr(unsigned long vaddr, pte_t pte);
436
437 #ifdef CONFIG_X86_32
438 extern void native_pagetable_init(void);
439 #else
440 #define native_pagetable_init        paging_init
441 #endif
442
443 struct seq_file;
444 extern void arch_report_meminfo(struct seq_file *m);
445
446 enum pg_level {
447         PG_LEVEL_NONE,
448         PG_LEVEL_4K,
449         PG_LEVEL_2M,
450         PG_LEVEL_1G,
451         PG_LEVEL_NUM
452 };
453
454 #ifdef CONFIG_PROC_FS
455 extern void update_page_count(int level, unsigned long pages);
456 #else
457 static inline void update_page_count(int level, unsigned long pages) { }
458 #endif
459
460 /*
461  * Helper function that returns the kernel pagetable entry controlling
462  * the virtual address 'address'. NULL means no pagetable entry present.
463  * NOTE: the return type is pte_t but if the pmd is PSE then we return it
464  * as a pte too.
465  */
466 extern pte_t *lookup_address(unsigned long address, unsigned int *level);
467 extern pte_t *lookup_address_in_pgd(pgd_t *pgd, unsigned long address,
468                                     unsigned int *level);
469 extern pmd_t *lookup_pmd_address(unsigned long address);
470 extern phys_addr_t slow_virt_to_phys(void *__address);
471 extern int kernel_map_pages_in_pgd(pgd_t *pgd, u64 pfn, unsigned long address,
472                                    unsigned numpages, unsigned long page_flags);
473 void kernel_unmap_pages_in_pgd(pgd_t *root, unsigned long address,
474                                unsigned numpages);
475 #endif  /* !__ASSEMBLY__ */
476
477 #endif /* _ASM_X86_PGTABLE_DEFS_H */