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_IOMAP         _PAGE_BIT_SOFTW2 /* flag used to indicate IO mapping */
  27 #define _PAGE_BIT_HIDDEN        _PAGE_BIT_SOFTW3 /* hidden by kmemcheck */
  28 #define _PAGE_BIT_SOFT_DIRTY    _PAGE_BIT_SOFTW3 /* software dirty tracking */
  29 #define _PAGE_BIT_NX           63       /* No execute: only valid after cpuid check */
  30
  31 /*
  32  * Swap offsets on configurations that allow automatic NUMA balancing use the
  33  * bits after _PAGE_BIT_GLOBAL. To uniquely distinguish NUMA hinting PTEs from
  34  * swap entries, we use the first bit after _PAGE_BIT_GLOBAL and shrink the
  35  * maximum possible swap space from 16TB to 8TB.
  36  */
  37 #define _PAGE_BIT_NUMA          (_PAGE_BIT_GLOBAL+1)
  38
  39 /* If _PAGE_BIT_PRESENT is clear, we use these: */
  40 /* - if the user mapped it with PROT_NONE; pte_present gives true */
  41 #define _PAGE_BIT_PROTNONE      _PAGE_BIT_GLOBAL
  42 /* - set: nonlinear file mapping, saved PTE; unset:swap */
  43 #define _PAGE_BIT_FILE          _PAGE_BIT_DIRTY
  44
  45 #define _PAGE_PRESENT   (_AT(pteval_t, 1) << _PAGE_BIT_PRESENT)
  46 #define _PAGE_RW        (_AT(pteval_t, 1) << _PAGE_BIT_RW)
  47 #define _PAGE_USER      (_AT(pteval_t, 1) << _PAGE_BIT_USER)
  48 #define _PAGE_PWT       (_AT(pteval_t, 1) << _PAGE_BIT_PWT)
  49 #define _PAGE_PCD       (_AT(pteval_t, 1) << _PAGE_BIT_PCD)
  50 #define _PAGE_ACCESSED  (_AT(pteval_t, 1) << _PAGE_BIT_ACCESSED)
  51 #define _PAGE_DIRTY     (_AT(pteval_t, 1) << _PAGE_BIT_DIRTY)
  52 #define _PAGE_PSE       (_AT(pteval_t, 1) << _PAGE_BIT_PSE)
  53 #define _PAGE_GLOBAL    (_AT(pteval_t, 1) << _PAGE_BIT_GLOBAL)
  54 #define _PAGE_SOFTW1    (_AT(pteval_t, 1) << _PAGE_BIT_SOFTW1)
  55 #define _PAGE_IOMAP     (_AT(pteval_t, 1) << _PAGE_BIT_IOMAP)
  56 #define _PAGE_PAT       (_AT(pteval_t, 1) << _PAGE_BIT_PAT)
  57 #define _PAGE_PAT_LARGE (_AT(pteval_t, 1) << _PAGE_BIT_PAT_LARGE)
  58 #define _PAGE_SPECIAL   (_AT(pteval_t, 1) << _PAGE_BIT_SPECIAL)
  59 #define _PAGE_CPA_TEST  (_AT(pteval_t, 1) << _PAGE_BIT_CPA_TEST)
  60 #define _PAGE_SPLITTING (_AT(pteval_t, 1) << _PAGE_BIT_SPLITTING)
  61 #define __HAVE_ARCH_PTE_SPECIAL
  62
  63 #ifdef CONFIG_KMEMCHECK
  64 #define _PAGE_HIDDEN    (_AT(pteval_t, 1) << _PAGE_BIT_HIDDEN)
  65 #else
  66 #define _PAGE_HIDDEN    (_AT(pteval_t, 0))
  67 #endif
  68
  69 /*
  70  * The same hidden bit is used by kmemcheck, but since kmemcheck
  71  * works on kernel pages while soft-dirty engine on user space,
  72  * they do not conflict with each other.
  73  */
  74
  75 #ifdef CONFIG_MEM_SOFT_DIRTY
  76 #define _PAGE_SOFT_DIRTY        (_AT(pteval_t, 1) << _PAGE_BIT_SOFT_DIRTY)
  77 #else
  78 #define _PAGE_SOFT_DIRTY        (_AT(pteval_t, 0))
  79 #endif
  80
  81 /*
  82  * _PAGE_NUMA distinguishes between a numa hinting minor fault and a page
  83  * that is not present. The hinting fault gathers numa placement statistics
  84  * (see pte_numa()). The bit is always zero when the PTE is not present.
  85  *
  86  * The bit picked must be always zero when the pmd is present and not
  87  * present, so that we don't lose information when we set it while
  88  * atomically clearing the present bit.
  89  */
  90 #ifdef CONFIG_NUMA_BALANCING
  91 #define _PAGE_NUMA      (_AT(pteval_t, 1) << _PAGE_BIT_NUMA)
  92 #else
  93 #define _PAGE_NUMA      (_AT(pteval_t, 0))
  94 #endif
  95
  96 /*
  97  * Tracking soft dirty bit when a page goes to a swap is tricky.
  98  * We need a bit which can be stored in pte _and_ not conflict
  99  * with swap entry format. On x86 bits 6 and 7 are *not* involved
 100  * into swap entry computation, but bit 6 is used for nonlinear
 101  * file mapping, so we borrow bit 7 for soft dirty tracking.
 102  *
 103  * Please note that this bit must be treated as swap dirty page
 104  * mark if and only if the PTE has present bit clear!
 105  */
 106 #ifdef CONFIG_MEM_SOFT_DIRTY
 107 #define _PAGE_SWP_SOFT_DIRTY    _PAGE_PSE
 108 #else
 109 #define _PAGE_SWP_SOFT_DIRTY    (_AT(pteval_t, 0))
 110 #endif
 111
 112 #if defined(CONFIG_X86_64) || defined(CONFIG_X86_PAE)
 113 #define _PAGE_NX        (_AT(pteval_t, 1) << _PAGE_BIT_NX)
 114 #else
 115 #define _PAGE_NX        (_AT(pteval_t, 0))
 116 #endif
 117
 118 #define _PAGE_FILE      (_AT(pteval_t, 1) << _PAGE_BIT_FILE)
 119 #define _PAGE_PROTNONE  (_AT(pteval_t, 1) << _PAGE_BIT_PROTNONE)
 120
 121 #define _PAGE_TABLE     (_PAGE_PRESENT | _PAGE_RW | _PAGE_USER |        \
 122                          _PAGE_ACCESSED | _PAGE_DIRTY)
 123 #define _KERNPG_TABLE   (_PAGE_PRESENT | _PAGE_RW | _PAGE_ACCESSED |    \
 124                          _PAGE_DIRTY)
 125
 126 /* Set of bits not changed in pte_modify */
 127 #define _PAGE_CHG_MASK  (PTE_PFN_MASK | _PAGE_PCD | _PAGE_PWT |         \
 128                          _PAGE_SPECIAL | _PAGE_ACCESSED | _PAGE_DIRTY | \
 129                          _PAGE_SOFT_DIRTY | _PAGE_NUMA)
 130 #define _HPAGE_CHG_MASK (_PAGE_CHG_MASK | _PAGE_PSE | _PAGE_NUMA)
 131
 132 #define _PAGE_CACHE_MASK        (_PAGE_PCD | _PAGE_PWT)
 133 #define _PAGE_CACHE_WB          (0)
 134 #define _PAGE_CACHE_WC          (_PAGE_PWT)
 135 #define _PAGE_CACHE_UC_MINUS    (_PAGE_PCD)
 136 #define _PAGE_CACHE_UC          (_PAGE_PCD | _PAGE_PWT)
 137
 138 #define PAGE_NONE       __pgprot(_PAGE_PROTNONE | _PAGE_ACCESSED)
 139 #define PAGE_SHARED     __pgprot(_PAGE_PRESENT | _PAGE_RW | _PAGE_USER | \
 140                                  _PAGE_ACCESSED | _PAGE_NX)
 141
 142 #define PAGE_SHARED_EXEC        __pgprot(_PAGE_PRESENT | _PAGE_RW |     \
 143                                          _PAGE_USER | _PAGE_ACCESSED)
 144 #define PAGE_COPY_NOEXEC        __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
 145                                          _PAGE_ACCESSED | _PAGE_NX)
 146 #define PAGE_COPY_EXEC          __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
 147                                          _PAGE_ACCESSED)
 148 #define PAGE_COPY               PAGE_COPY_NOEXEC
 149 #define PAGE_READONLY           __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
 150                                          _PAGE_ACCESSED | _PAGE_NX)
 151 #define PAGE_READONLY_EXEC      __pgprot(_PAGE_PRESENT | _PAGE_USER |   \
 152                                          _PAGE_ACCESSED)
 153
 154 #define __PAGE_KERNEL_EXEC                                              \
 155         (_PAGE_PRESENT | _PAGE_RW | _PAGE_DIRTY | _PAGE_ACCESSED | _PAGE_GLOBAL)
 156 #define __PAGE_KERNEL           (__PAGE_KERNEL_EXEC | _PAGE_NX)
 157
 158 #define __PAGE_KERNEL_RO                (__PAGE_KERNEL & ~_PAGE_RW)
 159 #define __PAGE_KERNEL_RX                (__PAGE_KERNEL_EXEC & ~_PAGE_RW)
 160 #define __PAGE_KERNEL_EXEC_NOCACHE      (__PAGE_KERNEL_EXEC | _PAGE_PCD | _PAGE_PWT)
 161 #define __PAGE_KERNEL_WC                (__PAGE_KERNEL | _PAGE_CACHE_WC)
 162 #define __PAGE_KERNEL_NOCACHE           (__PAGE_KERNEL | _PAGE_PCD | _PAGE_PWT)
 163 #define __PAGE_KERNEL_UC_MINUS          (__PAGE_KERNEL | _PAGE_PCD)
 164 #define __PAGE_KERNEL_VSYSCALL          (__PAGE_KERNEL_RX | _PAGE_USER)
 165 #define __PAGE_KERNEL_VVAR              (__PAGE_KERNEL_RO | _PAGE_USER)
 166 #define __PAGE_KERNEL_VVAR_NOCACHE      (__PAGE_KERNEL_VVAR | _PAGE_PCD | _PAGE_PWT)
 167 #define __PAGE_KERNEL_LARGE             (__PAGE_KERNEL | _PAGE_PSE)
 168 #define __PAGE_KERNEL_LARGE_NOCACHE     (__PAGE_KERNEL | _PAGE_CACHE_UC | _PAGE_PSE)
 169 #define __PAGE_KERNEL_LARGE_EXEC        (__PAGE_KERNEL_EXEC | _PAGE_PSE)
 170
 171 #define __PAGE_KERNEL_IO                (__PAGE_KERNEL | _PAGE_IOMAP)
 172 #define __PAGE_KERNEL_IO_NOCACHE        (__PAGE_KERNEL_NOCACHE | _PAGE_IOMAP)
 173 #define __PAGE_KERNEL_IO_UC_MINUS       (__PAGE_KERNEL_UC_MINUS | _PAGE_IOMAP)
 174 #define __PAGE_KERNEL_IO_WC             (__PAGE_KERNEL_WC | _PAGE_IOMAP)
 175
 176 #define PAGE_KERNEL                     __pgprot(__PAGE_KERNEL)
 177 #define PAGE_KERNEL_RO                  __pgprot(__PAGE_KERNEL_RO)
 178 #define PAGE_KERNEL_EXEC                __pgprot(__PAGE_KERNEL_EXEC)
 179 #define PAGE_KERNEL_RX                  __pgprot(__PAGE_KERNEL_RX)
 180 #define PAGE_KERNEL_WC                  __pgprot(__PAGE_KERNEL_WC)
 181 #define PAGE_KERNEL_NOCACHE             __pgprot(__PAGE_KERNEL_NOCACHE)
 182 #define PAGE_KERNEL_UC_MINUS            __pgprot(__PAGE_KERNEL_UC_MINUS)
 183 #define PAGE_KERNEL_EXEC_NOCACHE        __pgprot(__PAGE_KERNEL_EXEC_NOCACHE)
 184 #define PAGE_KERNEL_LARGE               __pgprot(__PAGE_KERNEL_LARGE)
 185 #define PAGE_KERNEL_LARGE_NOCACHE       __pgprot(__PAGE_KERNEL_LARGE_NOCACHE)
 186 #define PAGE_KERNEL_LARGE_EXEC          __pgprot(__PAGE_KERNEL_LARGE_EXEC)
 187 #define PAGE_KERNEL_VSYSCALL            __pgprot(__PAGE_KERNEL_VSYSCALL)
 188 #define PAGE_KERNEL_VVAR                __pgprot(__PAGE_KERNEL_VVAR)
 189 #define PAGE_KERNEL_VVAR_NOCACHE        __pgprot(__PAGE_KERNEL_VVAR_NOCACHE)
 190
 191 #define PAGE_KERNEL_IO                  __pgprot(__PAGE_KERNEL_IO)
 192 #define PAGE_KERNEL_IO_NOCACHE          __pgprot(__PAGE_KERNEL_IO_NOCACHE)
 193 #define PAGE_KERNEL_IO_UC_MINUS         __pgprot(__PAGE_KERNEL_IO_UC_MINUS)
 194 #define PAGE_KERNEL_IO_WC               __pgprot(__PAGE_KERNEL_IO_WC)
 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 /* PTE_PFN_MASK extracts the PFN from a (pte|pmd|pud|pgd)val_t */
 237 #define PTE_PFN_MASK            ((pteval_t)PHYSICAL_PAGE_MASK)
 238
 239 /* PTE_FLAGS_MASK extracts the flags from a (pte|pmd|pud|pgd)val_t */
 240 #define PTE_FLAGS_MASK          (~PTE_PFN_MASK)
 241
 242 typedef struct pgprot { pgprotval_t pgprot; } pgprot_t;
 243
 244 typedef struct { pgdval_t pgd; } pgd_t;
 245
 246 static inline pgd_t native_make_pgd(pgdval_t val)
 247 {
 248         return (pgd_t) { val };
 249 }
 250
 251 static inline pgdval_t native_pgd_val(pgd_t pgd)
 252 {
 253         return pgd.pgd;
 254 }
 255
 256 static inline pgdval_t pgd_flags(pgd_t pgd)
 257 {
 258         return native_pgd_val(pgd) & PTE_FLAGS_MASK;
 259 }
 260
 261 #if PAGETABLE_LEVELS > 3
 262 typedef struct { pudval_t pud; } pud_t;
 263
 264 static inline pud_t native_make_pud(pmdval_t val)
 265 {
 266         return (pud_t) { val };
 267 }
 268
 269 static inline pudval_t native_pud_val(pud_t pud)
 270 {
 271         return pud.pud;
 272 }
 273 #else
 274 #include <asm-generic/pgtable-nopud.h>
 275
 276 static inline pudval_t native_pud_val(pud_t pud)
 277 {
 278         return native_pgd_val(pud.pgd);
 279 }
 280 #endif
 281
 282 #if PAGETABLE_LEVELS > 2
 283 typedef struct { pmdval_t pmd; } pmd_t;
 284
 285 static inline pmd_t native_make_pmd(pmdval_t val)
 286 {
 287         return (pmd_t) { val };
 288 }
 289
 290 static inline pmdval_t native_pmd_val(pmd_t pmd)
 291 {
 292         return pmd.pmd;
 293 }
 294 #else
 295 #include <asm-generic/pgtable-nopmd.h>
 296
 297 static inline pmdval_t native_pmd_val(pmd_t pmd)
 298 {
 299         return native_pgd_val(pmd.pud.pgd);
 300 }
 301 #endif
 302
 303 static inline pudval_t pud_flags(pud_t pud)
 304 {
 305         return native_pud_val(pud) & PTE_FLAGS_MASK;
 306 }
 307
 308 static inline pmdval_t pmd_flags(pmd_t pmd)
 309 {
 310         return native_pmd_val(pmd) & PTE_FLAGS_MASK;
 311 }
 312
 313 static inline pte_t native_make_pte(pteval_t val)
 314 {
 315         return (pte_t) { .pte = val };
 316 }
 317
 318 static inline pteval_t native_pte_val(pte_t pte)
 319 {
 320         return pte.pte;
 321 }
 322
 323 static inline pteval_t pte_flags(pte_t pte)
 324 {
 325         return native_pte_val(pte) & PTE_FLAGS_MASK;
 326 }
 327
 328 #ifdef CONFIG_NUMA_BALANCING
 329 /* Set of bits that distinguishes present, prot_none and numa ptes */
 330 #define _PAGE_NUMA_MASK (_PAGE_NUMA|_PAGE_PROTNONE|_PAGE_PRESENT)
 331 static inline pteval_t ptenuma_flags(pte_t pte)
 332 {
 333         return pte_flags(pte) & _PAGE_NUMA_MASK;
 334 }
 335
 336 static inline pmdval_t pmdnuma_flags(pmd_t pmd)
 337 {
 338         return pmd_flags(pmd) & _PAGE_NUMA_MASK;
 339 }
 340 #endif /* CONFIG_NUMA_BALANCING */
 341
 342 #define pgprot_val(x)   ((x).pgprot)
 343 #define __pgprot(x)     ((pgprot_t) { (x) } )
 344
 345
 346 typedef struct page *pgtable_t;
 347
 348 extern pteval_t __supported_pte_mask;
 349 extern void set_nx(void);
 350 extern int nx_enabled;
 351
 352 #define pgprot_writecombine     pgprot_writecombine
 353 extern pgprot_t pgprot_writecombine(pgprot_t prot);
 354
 355 /* Indicate that x86 has its own track and untrack pfn vma functions */
 356 #define __HAVE_PFNMAP_TRACKING
 357
 358 #define __HAVE_PHYS_MEM_ACCESS_PROT
 359 struct file;
 360 pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
 361                               unsigned long size, pgprot_t vma_prot);
 362 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
 363                               unsigned long size, pgprot_t *vma_prot);
 364
 365 /* Install a pte for a particular vaddr in kernel space. */
 366 void set_pte_vaddr(unsigned long vaddr, pte_t pte);
 367
 368 #ifdef CONFIG_X86_32
 369 extern void native_pagetable_init(void);
 370 #else
 371 #define native_pagetable_init        paging_init
 372 #endif
 373
 374 struct seq_file;
 375 extern void arch_report_meminfo(struct seq_file *m);
 376
 377 enum pg_level {
 378         PG_LEVEL_NONE,
 379         PG_LEVEL_4K,
 380         PG_LEVEL_2M,
 381         PG_LEVEL_1G,
 382         PG_LEVEL_NUM
 383 };
 384
 385 #ifdef CONFIG_PROC_FS
 386 extern void update_page_count(int level, unsigned long pages);
 387 #else
 388 static inline void update_page_count(int level, unsigned long pages) { }
 389 #endif
 390
 391 /*
 392  * Helper function that returns the kernel pagetable entry controlling
 393  * the virtual address 'address'. NULL means no pagetable entry present.
 394  * NOTE: the return type is pte_t but if the pmd is PSE then we return it
 395  * as a pte too.
 396  */
 397 extern pte_t *lookup_address(unsigned long address, unsigned int *level);
 398 extern pte_t *lookup_address_in_pgd(pgd_t *pgd, unsigned long address,
 399                                     unsigned int *level);
 400 extern phys_addr_t slow_virt_to_phys(void *__address);
 401 extern int kernel_map_pages_in_pgd(pgd_t *pgd, u64 pfn, unsigned long address,
 402                                    unsigned numpages, unsigned long page_flags);
 403 void kernel_unmap_pages_in_pgd(pgd_t *root, unsigned long address,
 404                                unsigned numpages);
 405 #endif  /* !__ASSEMBLY__ */
 406
 407 #endif /* _ASM_X86_PGTABLE_DEFS_H */