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