arch/arm64/include/asm/pgtable.h

   1 /*
   2  * Copyright (C) 2012 ARM Ltd.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16 #ifndef __ASM_PGTABLE_H
  17 #define __ASM_PGTABLE_H
  18
  19 #include <asm/proc-fns.h>
  20
  21 #include <asm/memory.h>
  22 #include <asm/pgtable-hwdef.h>
  23
  24 /*
  25  * Software defined PTE bits definition.
  26  */
  27 #define PTE_VALID               (_AT(pteval_t, 1) << 0)
  28 #define PTE_FILE                (_AT(pteval_t, 1) << 2) /* only when !pte_present() */
  29 #define PTE_DIRTY               (_AT(pteval_t, 1) << 55)
  30 #define PTE_SPECIAL             (_AT(pteval_t, 1) << 56)
  31 #define PTE_WRITE               (_AT(pteval_t, 1) << 57)
  32 #define PTE_PROT_NONE           (_AT(pteval_t, 1) << 58) /* only when !PTE_VALID */
  33
  34 /*
  35  * VMALLOC and SPARSEMEM_VMEMMAP ranges.
  36  */
  37 #define VMALLOC_START           (UL(0xffffffffffffffff) << VA_BITS)
  38 #define VMALLOC_END             (PAGE_OFFSET - UL(0x400000000) - SZ_64K)
  39
  40 #define vmemmap                 ((struct page *)(VMALLOC_END + SZ_64K))
  41
  42 #define FIRST_USER_ADDRESS      0
  43
  44 #ifndef __ASSEMBLY__
  45 extern void __pte_error(const char *file, int line, unsigned long val);
  46 extern void __pmd_error(const char *file, int line, unsigned long val);
  47 extern void __pgd_error(const char *file, int line, unsigned long val);
  48
  49 #define pte_ERROR(pte)          __pte_error(__FILE__, __LINE__, pte_val(pte))
  50 #ifndef CONFIG_ARM64_64K_PAGES
  51 #define pmd_ERROR(pmd)          __pmd_error(__FILE__, __LINE__, pmd_val(pmd))
  52 #endif
  53 #define pgd_ERROR(pgd)          __pgd_error(__FILE__, __LINE__, pgd_val(pgd))
  54
  55 #ifdef CONFIG_SMP
  56 #define PROT_DEFAULT            (PTE_TYPE_PAGE | PTE_AF | PTE_SHARED)
  57 #define PROT_SECT_DEFAULT       (PMD_TYPE_SECT | PMD_SECT_AF | PMD_SECT_S)
  58 #else
  59 #define PROT_DEFAULT            (PTE_TYPE_PAGE | PTE_AF)
  60 #define PROT_SECT_DEFAULT       (PMD_TYPE_SECT | PMD_SECT_AF)
  61 #endif
  62
  63 #define PROT_DEVICE_nGnRE       (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_DEVICE_nGnRE))
  64 #define PROT_NORMAL_NC          (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL_NC))
  65 #define PROT_NORMAL             (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL))
  66
  67 #define PROT_SECT_DEVICE_nGnRE  (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_DEVICE_nGnRE))
  68 #define PROT_SECT_NORMAL        (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
  69 #define PROT_SECT_NORMAL_EXEC   (PROT_SECT_DEFAULT | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
  70
  71 #define _PAGE_DEFAULT           (PROT_DEFAULT | PTE_ATTRINDX(MT_NORMAL))
  72
  73 #define PAGE_KERNEL             __pgprot(_PAGE_DEFAULT | PTE_PXN | PTE_UXN | PTE_DIRTY | PTE_WRITE)
  74 #define PAGE_KERNEL_EXEC        __pgprot(_PAGE_DEFAULT | PTE_UXN | PTE_DIRTY | PTE_WRITE)
  75
  76 #define PAGE_HYP                __pgprot(_PAGE_DEFAULT | PTE_HYP)
  77 #define PAGE_HYP_DEVICE         __pgprot(PROT_DEVICE_nGnRE | PTE_HYP)
  78
  79 #define PAGE_S2                 __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_NORMAL) | PTE_S2_RDONLY)
  80 #define PAGE_S2_DEVICE          __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_DEVICE_nGnRE) | PTE_S2_RDWR | PTE_UXN)
  81
  82 #define PAGE_NONE               __pgprot(((_PAGE_DEFAULT) & ~PTE_TYPE_MASK) | PTE_PROT_NONE | PTE_PXN | PTE_UXN)
  83 #define PAGE_SHARED             __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN | PTE_WRITE)
  84 #define PAGE_SHARED_EXEC        __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_WRITE)
  85 #define PAGE_COPY               __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
  86 #define PAGE_COPY_EXEC          __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
  87 #define PAGE_READONLY           __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
  88 #define PAGE_READONLY_EXEC      __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
  89
  90 #define __P000  PAGE_NONE
  91 #define __P001  PAGE_READONLY
  92 #define __P010  PAGE_COPY
  93 #define __P011  PAGE_COPY
  94 #define __P100  PAGE_READONLY_EXEC
  95 #define __P101  PAGE_READONLY_EXEC
  96 #define __P110  PAGE_COPY_EXEC
  97 #define __P111  PAGE_COPY_EXEC
  98
  99 #define __S000  PAGE_NONE
 100 #define __S001  PAGE_READONLY
 101 #define __S010  PAGE_SHARED
 102 #define __S011  PAGE_SHARED
 103 #define __S100  PAGE_READONLY_EXEC
 104 #define __S101  PAGE_READONLY_EXEC
 105 #define __S110  PAGE_SHARED_EXEC
 106 #define __S111  PAGE_SHARED_EXEC
 107
 108 /*
 109  * ZERO_PAGE is a global shared page that is always zero: used
 110  * for zero-mapped memory areas etc..
 111  */
 112 extern struct page *empty_zero_page;
 113 #define ZERO_PAGE(vaddr)        (empty_zero_page)
 114
 115 #define pte_pfn(pte)            ((pte_val(pte) & PHYS_MASK) >> PAGE_SHIFT)
 116
 117 #define pfn_pte(pfn,prot)       (__pte(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
 118
 119 #define pte_none(pte)           (!pte_val(pte))
 120 #define pte_clear(mm,addr,ptep) set_pte(ptep, __pte(0))
 121 #define pte_page(pte)           (pfn_to_page(pte_pfn(pte)))
 122 #define pte_offset_kernel(dir,addr)     (pmd_page_vaddr(*(dir)) + pte_index(addr))
 123
 124 #define pte_offset_map(dir,addr)        pte_offset_kernel((dir), (addr))
 125 #define pte_offset_map_nested(dir,addr) pte_offset_kernel((dir), (addr))
 126 #define pte_unmap(pte)                  do { } while (0)
 127 #define pte_unmap_nested(pte)           do { } while (0)
 128
 129 /*
 130  * The following only work if pte_present(). Undefined behaviour otherwise.
 131  */
 132 #define pte_present(pte)        (!!(pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)))
 133 #define pte_dirty(pte)          (!!(pte_val(pte) & PTE_DIRTY))
 134 #define pte_young(pte)          (!!(pte_val(pte) & PTE_AF))
 135 #define pte_special(pte)        (!!(pte_val(pte) & PTE_SPECIAL))
 136 #define pte_write(pte)          (!!(pte_val(pte) & PTE_WRITE))
 137 #define pte_exec(pte)           (!(pte_val(pte) & PTE_UXN))
 138
 139 #define pte_valid_user(pte) \
 140         ((pte_val(pte) & (PTE_VALID | PTE_USER)) == (PTE_VALID | PTE_USER))
 141 #define pte_valid_not_user(pte) \
 142         ((pte_val(pte) & (PTE_VALID | PTE_USER)) == PTE_VALID)
 143
 144 static inline pte_t pte_wrprotect(pte_t pte)
 145 {
 146         pte_val(pte) &= ~PTE_WRITE;
 147         return pte;
 148 }
 149
 150 static inline pte_t pte_mkwrite(pte_t pte)
 151 {
 152         pte_val(pte) |= PTE_WRITE;
 153         return pte;
 154 }
 155
 156 static inline pte_t pte_mkclean(pte_t pte)
 157 {
 158         pte_val(pte) &= ~PTE_DIRTY;
 159         return pte;
 160 }
 161
 162 static inline pte_t pte_mkdirty(pte_t pte)
 163 {
 164         pte_val(pte) |= PTE_DIRTY;
 165         return pte;
 166 }
 167
 168 static inline pte_t pte_mkold(pte_t pte)
 169 {
 170         pte_val(pte) &= ~PTE_AF;
 171         return pte;
 172 }
 173
 174 static inline pte_t pte_mkyoung(pte_t pte)
 175 {
 176         pte_val(pte) |= PTE_AF;
 177         return pte;
 178 }
 179
 180 static inline pte_t pte_mkspecial(pte_t pte)
 181 {
 182         pte_val(pte) |= PTE_SPECIAL;
 183         return pte;
 184 }
 185
 186 static inline void set_pte(pte_t *ptep, pte_t pte)
 187 {
 188         *ptep = pte;
 189
 190         /*
 191          * Only if the new pte is valid and kernel, otherwise TLB maintenance
 192          * or update_mmu_cache() have the necessary barriers.
 193          */
 194         if (pte_valid_not_user(pte)) {
 195                 dsb(ishst);
 196                 isb();
 197         }
 198 }
 199
 200 extern void __sync_icache_dcache(pte_t pteval, unsigned long addr);
 201
 202 static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
 203                               pte_t *ptep, pte_t pte)
 204 {
 205         if (pte_valid_user(pte)) {
 206                 if (!pte_special(pte) && pte_exec(pte))
 207                         __sync_icache_dcache(pte, addr);
 208                 if (pte_dirty(pte) && pte_write(pte))
 209                         pte_val(pte) &= ~PTE_RDONLY;
 210                 else
 211                         pte_val(pte) |= PTE_RDONLY;
 212         }
 213
 214         set_pte(ptep, pte);
 215 }
 216
 217 /*
 218  * Huge pte definitions.
 219  */
 220 #define pte_huge(pte)           (!(pte_val(pte) & PTE_TABLE_BIT))
 221 #define pte_mkhuge(pte)         (__pte(pte_val(pte) & ~PTE_TABLE_BIT))
 222
 223 /*
 224  * Hugetlb definitions.
 225  */
 226 #define HUGE_MAX_HSTATE         2
 227 #define HPAGE_SHIFT             PMD_SHIFT
 228 #define HPAGE_SIZE              (_AC(1, UL) << HPAGE_SHIFT)
 229 #define HPAGE_MASK              (~(HPAGE_SIZE - 1))
 230 #define HUGETLB_PAGE_ORDER      (HPAGE_SHIFT - PAGE_SHIFT)
 231
 232 #define __HAVE_ARCH_PTE_SPECIAL
 233
 234 static inline pte_t pmd_pte(pmd_t pmd)
 235 {
 236         return __pte(pmd_val(pmd));
 237 }
 238
 239 static inline pmd_t pte_pmd(pte_t pte)
 240 {
 241         return __pmd(pte_val(pte));
 242 }
 243
 244 /*
 245  * THP definitions.
 246  */
 247
 248 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 249 #define pmd_trans_huge(pmd)     (pmd_val(pmd) && !(pmd_val(pmd) & PMD_TABLE_BIT))
 250 #define pmd_trans_splitting(pmd)        pte_special(pmd_pte(pmd))
 251 #endif
 252
 253 #define pmd_young(pmd)          pte_young(pmd_pte(pmd))
 254 #define pmd_wrprotect(pmd)      pte_pmd(pte_wrprotect(pmd_pte(pmd)))
 255 #define pmd_mksplitting(pmd)    pte_pmd(pte_mkspecial(pmd_pte(pmd)))
 256 #define pmd_mkold(pmd)          pte_pmd(pte_mkold(pmd_pte(pmd)))
 257 #define pmd_mkwrite(pmd)        pte_pmd(pte_mkwrite(pmd_pte(pmd)))
 258 #define pmd_mkdirty(pmd)        pte_pmd(pte_mkdirty(pmd_pte(pmd)))
 259 #define pmd_mkyoung(pmd)        pte_pmd(pte_mkyoung(pmd_pte(pmd)))
 260 #define pmd_mknotpresent(pmd)   (__pmd(pmd_val(pmd) &= ~PMD_TYPE_MASK))
 261
 262 #define __HAVE_ARCH_PMD_WRITE
 263 #define pmd_write(pmd)          pte_write(pmd_pte(pmd))
 264
 265 #define pmd_mkhuge(pmd)         (__pmd(pmd_val(pmd) & ~PMD_TABLE_BIT))
 266
 267 #define pmd_pfn(pmd)            (((pmd_val(pmd) & PMD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
 268 #define pfn_pmd(pfn,prot)       (__pmd(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
 269 #define mk_pmd(page,prot)       pfn_pmd(page_to_pfn(page),prot)
 270
 271 #define pmd_page(pmd)           pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
 272
 273 #define set_pmd_at(mm, addr, pmdp, pmd) set_pte_at(mm, addr, (pte_t *)pmdp, pmd_pte(pmd))
 274
 275 static inline int has_transparent_hugepage(void)
 276 {
 277         return 1;
 278 }
 279
 280 #define __pgprot_modify(prot,mask,bits) \
 281         __pgprot((pgprot_val(prot) & ~(mask)) | (bits))
 282
 283 /*
 284  * Mark the prot value as uncacheable and unbufferable.
 285  */
 286 #define pgprot_noncached(prot) \
 287         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRnE) | PTE_PXN | PTE_UXN)
 288 #define pgprot_writecombine(prot) \
 289         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_NORMAL_NC) | PTE_PXN | PTE_UXN)
 290 #define pgprot_dmacoherent(prot) \
 291         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_NORMAL_NC) | PTE_PXN | PTE_UXN)
 292 #define __HAVE_PHYS_MEM_ACCESS_PROT
 293 struct file;
 294 extern pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
 295                                      unsigned long size, pgprot_t vma_prot);
 296
 297 #define pmd_none(pmd)           (!pmd_val(pmd))
 298 #define pmd_present(pmd)        (pmd_val(pmd))
 299
 300 #define pmd_bad(pmd)            (!(pmd_val(pmd) & 2))
 301
 302 #define pmd_table(pmd)          ((pmd_val(pmd) & PMD_TYPE_MASK) == \
 303                                  PMD_TYPE_TABLE)
 304 #define pmd_sect(pmd)           ((pmd_val(pmd) & PMD_TYPE_MASK) == \
 305                                  PMD_TYPE_SECT)
 306
 307
 308 static inline void set_pmd(pmd_t *pmdp, pmd_t pmd)
 309 {
 310         *pmdp = pmd;
 311         dsb(ishst);
 312         isb();
 313 }
 314
 315 static inline void pmd_clear(pmd_t *pmdp)
 316 {
 317         set_pmd(pmdp, __pmd(0));
 318 }
 319
 320 static inline pte_t *pmd_page_vaddr(pmd_t pmd)
 321 {
 322         return __va(pmd_val(pmd) & PHYS_MASK & (s32)PAGE_MASK);
 323 }
 324
 325 #define pmd_page(pmd)           pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
 326
 327 /*
 328  * Conversion functions: convert a page and protection to a page entry,
 329  * and a page entry and page directory to the page they refer to.
 330  */
 331 #define mk_pte(page,prot)       pfn_pte(page_to_pfn(page),prot)
 332
 333 #ifndef CONFIG_ARM64_64K_PAGES
 334
 335 #define pud_none(pud)           (!pud_val(pud))
 336 #define pud_bad(pud)            (!(pud_val(pud) & 2))
 337 #define pud_present(pud)        (pud_val(pud))
 338
 339 static inline void set_pud(pud_t *pudp, pud_t pud)
 340 {
 341         *pudp = pud;
 342         dsb(ishst);
 343         isb();
 344 }
 345
 346 static inline void pud_clear(pud_t *pudp)
 347 {
 348         set_pud(pudp, __pud(0));
 349 }
 350
 351 static inline pmd_t *pud_page_vaddr(pud_t pud)
 352 {
 353         return __va(pud_val(pud) & PHYS_MASK & (s32)PAGE_MASK);
 354 }
 355
 356 #endif  /* CONFIG_ARM64_64K_PAGES */
 357
 358 /* to find an entry in a page-table-directory */
 359 #define pgd_index(addr)         (((addr) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
 360
 361 #define pgd_offset(mm, addr)    ((mm)->pgd+pgd_index(addr))
 362
 363 /* to find an entry in a kernel page-table-directory */
 364 #define pgd_offset_k(addr)      pgd_offset(&init_mm, addr)
 365
 366 /* Find an entry in the second-level page table.. */
 367 #ifndef CONFIG_ARM64_64K_PAGES
 368 #define pmd_index(addr)         (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1))
 369 static inline pmd_t *pmd_offset(pud_t *pud, unsigned long addr)
 370 {
 371         return (pmd_t *)pud_page_vaddr(*pud) + pmd_index(addr);
 372 }
 373 #endif
 374
 375 /* Find an entry in the third-level page table.. */
 376 #define pte_index(addr)         (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
 377
 378 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
 379 {
 380         const pteval_t mask = PTE_USER | PTE_PXN | PTE_UXN | PTE_RDONLY |
 381                               PTE_PROT_NONE | PTE_VALID | PTE_WRITE;
 382         pte_val(pte) = (pte_val(pte) & ~mask) | (pgprot_val(newprot) & mask);
 383         return pte;
 384 }
 385
 386 static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
 387 {
 388         return pte_pmd(pte_modify(pmd_pte(pmd), newprot));
 389 }
 390
 391 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
 392 extern pgd_t idmap_pg_dir[PTRS_PER_PGD];
 393
 394 /*
 395  * Encode and decode a swap entry:
 396  *      bits 0-1:       present (must be zero)
 397  *      bit  2:         PTE_FILE
 398  *      bits 3-8:       swap type
 399  *      bits 9-57:      swap offset
 400  */
 401 #define __SWP_TYPE_SHIFT        3
 402 #define __SWP_TYPE_BITS         6
 403 #define __SWP_OFFSET_BITS       49
 404 #define __SWP_TYPE_MASK         ((1 << __SWP_TYPE_BITS) - 1)
 405 #define __SWP_OFFSET_SHIFT      (__SWP_TYPE_BITS + __SWP_TYPE_SHIFT)
 406 #define __SWP_OFFSET_MASK       ((1UL << __SWP_OFFSET_BITS) - 1)
 407
 408 #define __swp_type(x)           (((x).val >> __SWP_TYPE_SHIFT) & __SWP_TYPE_MASK)
 409 #define __swp_offset(x)         (((x).val >> __SWP_OFFSET_SHIFT) & __SWP_OFFSET_MASK)
 410 #define __swp_entry(type,offset) ((swp_entry_t) { ((type) << __SWP_TYPE_SHIFT) | ((offset) << __SWP_OFFSET_SHIFT) })
 411
 412 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
 413 #define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
 414
 415 /*
 416  * Ensure that there are not more swap files than can be encoded in the kernel
 417  * PTEs.
 418  */
 419 #define MAX_SWAPFILES_CHECK() BUILD_BUG_ON(MAX_SWAPFILES_SHIFT > __SWP_TYPE_BITS)
 420
 421 /*
 422  * Encode and decode a file entry:
 423  *      bits 0-1:       present (must be zero)
 424  *      bit  2:         PTE_FILE
 425  *      bits 3-57:      file offset / PAGE_SIZE
 426  */
 427 #define pte_file(pte)           (pte_val(pte) & PTE_FILE)
 428 #define pte_to_pgoff(x)         (pte_val(x) >> 3)
 429 #define pgoff_to_pte(x)         __pte(((x) << 3) | PTE_FILE)
 430
 431 #define PTE_FILE_MAX_BITS       55
 432
 433 extern int kern_addr_valid(unsigned long addr);
 434
 435 #include <asm-generic/pgtable.h>
 436
 437 /*
 438  * remap a physical page `pfn' of size `size' with page protection `prot'
 439  * into virtual address `from'
 440  */
 441 #define io_remap_pfn_range(vma,from,pfn,size,prot) \
 442                 remap_pfn_range(vma, from, pfn, size, prot)
 443
 444 #define pgtable_cache_init() do { } while (0)
 445
 446 #endif /* !__ASSEMBLY__ */
 447
 448 #endif /* __ASM_PGTABLE_H */