arch/arm64/include/asm/pgtable.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2012 ARM Ltd.
   4  */
   5 #ifndef __ASM_PGTABLE_H
   6 #define __ASM_PGTABLE_H
   7
   8 #include <asm/bug.h>
   9 #include <asm/proc-fns.h>
  10
  11 #include <asm/memory.h>
  12 #include <asm/pgtable-hwdef.h>
  13 #include <asm/pgtable-prot.h>
  14 #include <asm/tlbflush.h>
  15
  16 /*
  17  * VMALLOC range.
  18  *
  19  * VMALLOC_START: beginning of the kernel vmalloc space
  20  * VMALLOC_END: extends to the available space below vmmemmap, PCI I/O space
  21  *      and fixed mappings
  22  */
  23 #define VMALLOC_START           (MODULES_END)
  24 #define VMALLOC_END             (PAGE_OFFSET - PUD_SIZE - VMEMMAP_SIZE - SZ_64K)
  25
  26 #define vmemmap                 ((struct page *)VMEMMAP_START - (memstart_addr >> PAGE_SHIFT))
  27
  28 #define FIRST_USER_ADDRESS      0UL
  29
  30 #ifndef __ASSEMBLY__
  31
  32 #include <asm/cmpxchg.h>
  33 #include <asm/fixmap.h>
  34 #include <linux/mmdebug.h>
  35 #include <linux/mm_types.h>
  36 #include <linux/sched.h>
  37
  38 extern void __pte_error(const char *file, int line, unsigned long val);
  39 extern void __pmd_error(const char *file, int line, unsigned long val);
  40 extern void __pud_error(const char *file, int line, unsigned long val);
  41 extern void __pgd_error(const char *file, int line, unsigned long val);
  42
  43 /*
  44  * ZERO_PAGE is a global shared page that is always zero: used
  45  * for zero-mapped memory areas etc..
  46  */
  47 extern unsigned long empty_zero_page[PAGE_SIZE / sizeof(unsigned long)];
  48 #define ZERO_PAGE(vaddr)        phys_to_page(__pa_symbol(empty_zero_page))
  49
  50 #define pte_ERROR(pte)          __pte_error(__FILE__, __LINE__, pte_val(pte))
  51
  52 /*
  53  * Macros to convert between a physical address and its placement in a
  54  * page table entry, taking care of 52-bit addresses.
  55  */
  56 #ifdef CONFIG_ARM64_PA_BITS_52
  57 #define __pte_to_phys(pte)      \
  58         ((pte_val(pte) & PTE_ADDR_LOW) | ((pte_val(pte) & PTE_ADDR_HIGH) << 36))
  59 #define __phys_to_pte_val(phys) (((phys) | ((phys) >> 36)) & PTE_ADDR_MASK)
  60 #else
  61 #define __pte_to_phys(pte)      (pte_val(pte) & PTE_ADDR_MASK)
  62 #define __phys_to_pte_val(phys) (phys)
  63 #endif
  64
  65 #define pte_pfn(pte)            (__pte_to_phys(pte) >> PAGE_SHIFT)
  66 #define pfn_pte(pfn,prot)       \
  67         __pte(__phys_to_pte_val((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot))
  68
  69 #define pte_none(pte)           (!pte_val(pte))
  70 #define pte_clear(mm,addr,ptep) set_pte(ptep, __pte(0))
  71 #define pte_page(pte)           (pfn_to_page(pte_pfn(pte)))
  72
  73 /*
  74  * The following only work if pte_present(). Undefined behaviour otherwise.
  75  */
  76 #define pte_present(pte)        (!!(pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)))
  77 #define pte_young(pte)          (!!(pte_val(pte) & PTE_AF))
  78 #define pte_special(pte)        (!!(pte_val(pte) & PTE_SPECIAL))
  79 #define pte_write(pte)          (!!(pte_val(pte) & PTE_WRITE))
  80 #define pte_user_exec(pte)      (!(pte_val(pte) & PTE_UXN))
  81 #define pte_cont(pte)           (!!(pte_val(pte) & PTE_CONT))
  82 #define pte_devmap(pte)         (!!(pte_val(pte) & PTE_DEVMAP))
  83
  84 #define pte_cont_addr_end(addr, end)                                            \
  85 ({      unsigned long __boundary = ((addr) + CONT_PTE_SIZE) & CONT_PTE_MASK;    \
  86         (__boundary - 1 < (end) - 1) ? __boundary : (end);                      \
  87 })
  88
  89 #define pmd_cont_addr_end(addr, end)                                            \
  90 ({      unsigned long __boundary = ((addr) + CONT_PMD_SIZE) & CONT_PMD_MASK;    \
  91         (__boundary - 1 < (end) - 1) ? __boundary : (end);                      \
  92 })
  93
  94 #define pte_hw_dirty(pte)       (pte_write(pte) && !(pte_val(pte) & PTE_RDONLY))
  95 #define pte_sw_dirty(pte)       (!!(pte_val(pte) & PTE_DIRTY))
  96 #define pte_dirty(pte)          (pte_sw_dirty(pte) || pte_hw_dirty(pte))
  97
  98 #define pte_valid(pte)          (!!(pte_val(pte) & PTE_VALID))
  99 /*
 100  * Execute-only user mappings do not have the PTE_USER bit set. All valid
 101  * kernel mappings have the PTE_UXN bit set.
 102  */
 103 #define pte_valid_not_user(pte) \
 104         ((pte_val(pte) & (PTE_VALID | PTE_USER | PTE_UXN)) == (PTE_VALID | PTE_UXN))
 105 #define pte_valid_young(pte) \
 106         ((pte_val(pte) & (PTE_VALID | PTE_AF)) == (PTE_VALID | PTE_AF))
 107 #define pte_valid_user(pte) \
 108         ((pte_val(pte) & (PTE_VALID | PTE_USER)) == (PTE_VALID | PTE_USER))
 109
 110 /*
 111  * Could the pte be present in the TLB? We must check mm_tlb_flush_pending
 112  * so that we don't erroneously return false for pages that have been
 113  * remapped as PROT_NONE but are yet to be flushed from the TLB.
 114  */
 115 #define pte_accessible(mm, pte) \
 116         (mm_tlb_flush_pending(mm) ? pte_present(pte) : pte_valid_young(pte))
 117
 118 /*
 119  * p??_access_permitted() is true for valid user mappings (subject to the
 120  * write permission check) other than user execute-only which do not have the
 121  * PTE_USER bit set. PROT_NONE mappings do not have the PTE_VALID bit set.
 122  */
 123 #define pte_access_permitted(pte, write) \
 124         (pte_valid_user(pte) && (!(write) || pte_write(pte)))
 125 #define pmd_access_permitted(pmd, write) \
 126         (pte_access_permitted(pmd_pte(pmd), (write)))
 127 #define pud_access_permitted(pud, write) \
 128         (pte_access_permitted(pud_pte(pud), (write)))
 129
 130 static inline pte_t clear_pte_bit(pte_t pte, pgprot_t prot)
 131 {
 132         pte_val(pte) &= ~pgprot_val(prot);
 133         return pte;
 134 }
 135
 136 static inline pte_t set_pte_bit(pte_t pte, pgprot_t prot)
 137 {
 138         pte_val(pte) |= pgprot_val(prot);
 139         return pte;
 140 }
 141
 142 static inline pte_t pte_wrprotect(pte_t pte)
 143 {
 144         pte = clear_pte_bit(pte, __pgprot(PTE_WRITE));
 145         pte = set_pte_bit(pte, __pgprot(PTE_RDONLY));
 146         return pte;
 147 }
 148
 149 static inline pte_t pte_mkwrite(pte_t pte)
 150 {
 151         pte = set_pte_bit(pte, __pgprot(PTE_WRITE));
 152         pte = clear_pte_bit(pte, __pgprot(PTE_RDONLY));
 153         return pte;
 154 }
 155
 156 static inline pte_t pte_mkclean(pte_t pte)
 157 {
 158         pte = clear_pte_bit(pte, __pgprot(PTE_DIRTY));
 159         pte = set_pte_bit(pte, __pgprot(PTE_RDONLY));
 160
 161         return pte;
 162 }
 163
 164 static inline pte_t pte_mkdirty(pte_t pte)
 165 {
 166         pte = set_pte_bit(pte, __pgprot(PTE_DIRTY));
 167
 168         if (pte_write(pte))
 169                 pte = clear_pte_bit(pte, __pgprot(PTE_RDONLY));
 170
 171         return pte;
 172 }
 173
 174 static inline pte_t pte_mkold(pte_t pte)
 175 {
 176         return clear_pte_bit(pte, __pgprot(PTE_AF));
 177 }
 178
 179 static inline pte_t pte_mkyoung(pte_t pte)
 180 {
 181         return set_pte_bit(pte, __pgprot(PTE_AF));
 182 }
 183
 184 static inline pte_t pte_mkspecial(pte_t pte)
 185 {
 186         return set_pte_bit(pte, __pgprot(PTE_SPECIAL));
 187 }
 188
 189 static inline pte_t pte_mkcont(pte_t pte)
 190 {
 191         pte = set_pte_bit(pte, __pgprot(PTE_CONT));
 192         return set_pte_bit(pte, __pgprot(PTE_TYPE_PAGE));
 193 }
 194
 195 static inline pte_t pte_mknoncont(pte_t pte)
 196 {
 197         return clear_pte_bit(pte, __pgprot(PTE_CONT));
 198 }
 199
 200 static inline pte_t pte_mkpresent(pte_t pte)
 201 {
 202         return set_pte_bit(pte, __pgprot(PTE_VALID));
 203 }
 204
 205 static inline pmd_t pmd_mkcont(pmd_t pmd)
 206 {
 207         return __pmd(pmd_val(pmd) | PMD_SECT_CONT);
 208 }
 209
 210 static inline pte_t pte_mkdevmap(pte_t pte)
 211 {
 212         return set_pte_bit(pte, __pgprot(PTE_DEVMAP | PTE_SPECIAL));
 213 }
 214
 215 static inline void set_pte(pte_t *ptep, pte_t pte)
 216 {
 217         WRITE_ONCE(*ptep, pte);
 218
 219         /*
 220          * Only if the new pte is valid and kernel, otherwise TLB maintenance
 221          * or update_mmu_cache() have the necessary barriers.
 222          */
 223         if (pte_valid_not_user(pte)) {
 224                 dsb(ishst);
 225                 isb();
 226         }
 227 }
 228
 229 extern void __sync_icache_dcache(pte_t pteval);
 230
 231 /*
 232  * PTE bits configuration in the presence of hardware Dirty Bit Management
 233  * (PTE_WRITE == PTE_DBM):
 234  *
 235  * Dirty  Writable | PTE_RDONLY  PTE_WRITE  PTE_DIRTY (sw)
 236  *   0      0      |   1           0          0
 237  *   0      1      |   1           1          0
 238  *   1      0      |   1           0          1
 239  *   1      1      |   0           1          x
 240  *
 241  * When hardware DBM is not present, the sofware PTE_DIRTY bit is updated via
 242  * the page fault mechanism. Checking the dirty status of a pte becomes:
 243  *
 244  *   PTE_DIRTY || (PTE_WRITE && !PTE_RDONLY)
 245  */
 246
 247 static inline void __check_racy_pte_update(struct mm_struct *mm, pte_t *ptep,
 248                                            pte_t pte)
 249 {
 250         pte_t old_pte;
 251
 252         if (!IS_ENABLED(CONFIG_DEBUG_VM))
 253                 return;
 254
 255         old_pte = READ_ONCE(*ptep);
 256
 257         if (!pte_valid(old_pte) || !pte_valid(pte))
 258                 return;
 259         if (mm != current->active_mm && atomic_read(&mm->mm_users) <= 1)
 260                 return;
 261
 262         /*
 263          * Check for potential race with hardware updates of the pte
 264          * (ptep_set_access_flags safely changes valid ptes without going
 265          * through an invalid entry).
 266          */
 267         VM_WARN_ONCE(!pte_young(pte),
 268                      "%s: racy access flag clearing: 0x%016llx -> 0x%016llx",
 269                      __func__, pte_val(old_pte), pte_val(pte));
 270         VM_WARN_ONCE(pte_write(old_pte) && !pte_dirty(pte),
 271                      "%s: racy dirty state clearing: 0x%016llx -> 0x%016llx",
 272                      __func__, pte_val(old_pte), pte_val(pte));
 273 }
 274
 275 static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
 276                               pte_t *ptep, pte_t pte)
 277 {
 278         if (pte_present(pte) && pte_user_exec(pte) && !pte_special(pte))
 279                 __sync_icache_dcache(pte);
 280
 281         __check_racy_pte_update(mm, ptep, pte);
 282
 283         set_pte(ptep, pte);
 284 }
 285
 286 /*
 287  * Huge pte definitions.
 288  */
 289 #define pte_mkhuge(pte)         (__pte(pte_val(pte) & ~PTE_TABLE_BIT))
 290
 291 /*
 292  * Hugetlb definitions.
 293  */
 294 #define HUGE_MAX_HSTATE         4
 295 #define HPAGE_SHIFT             PMD_SHIFT
 296 #define HPAGE_SIZE              (_AC(1, UL) << HPAGE_SHIFT)
 297 #define HPAGE_MASK              (~(HPAGE_SIZE - 1))
 298 #define HUGETLB_PAGE_ORDER      (HPAGE_SHIFT - PAGE_SHIFT)
 299
 300 static inline pte_t pgd_pte(pgd_t pgd)
 301 {
 302         return __pte(pgd_val(pgd));
 303 }
 304
 305 static inline pte_t pud_pte(pud_t pud)
 306 {
 307         return __pte(pud_val(pud));
 308 }
 309
 310 static inline pud_t pte_pud(pte_t pte)
 311 {
 312         return __pud(pte_val(pte));
 313 }
 314
 315 static inline pmd_t pud_pmd(pud_t pud)
 316 {
 317         return __pmd(pud_val(pud));
 318 }
 319
 320 static inline pte_t pmd_pte(pmd_t pmd)
 321 {
 322         return __pte(pmd_val(pmd));
 323 }
 324
 325 static inline pmd_t pte_pmd(pte_t pte)
 326 {
 327         return __pmd(pte_val(pte));
 328 }
 329
 330 static inline pgprot_t mk_pud_sect_prot(pgprot_t prot)
 331 {
 332         return __pgprot((pgprot_val(prot) & ~PUD_TABLE_BIT) | PUD_TYPE_SECT);
 333 }
 334
 335 static inline pgprot_t mk_pmd_sect_prot(pgprot_t prot)
 336 {
 337         return __pgprot((pgprot_val(prot) & ~PMD_TABLE_BIT) | PMD_TYPE_SECT);
 338 }
 339
 340 #ifdef CONFIG_NUMA_BALANCING
 341 /*
 342  * See the comment in include/asm-generic/pgtable.h
 343  */
 344 static inline int pte_protnone(pte_t pte)
 345 {
 346         return (pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)) == PTE_PROT_NONE;
 347 }
 348
 349 static inline int pmd_protnone(pmd_t pmd)
 350 {
 351         return pte_protnone(pmd_pte(pmd));
 352 }
 353 #endif
 354
 355 /*
 356  * THP definitions.
 357  */
 358
 359 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 360 #define pmd_trans_huge(pmd)     (pmd_val(pmd) && !(pmd_val(pmd) & PMD_TABLE_BIT))
 361 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 362
 363 #define pmd_present(pmd)        pte_present(pmd_pte(pmd))
 364 #define pmd_dirty(pmd)          pte_dirty(pmd_pte(pmd))
 365 #define pmd_young(pmd)          pte_young(pmd_pte(pmd))
 366 #define pmd_valid(pmd)          pte_valid(pmd_pte(pmd))
 367 #define pmd_wrprotect(pmd)      pte_pmd(pte_wrprotect(pmd_pte(pmd)))
 368 #define pmd_mkold(pmd)          pte_pmd(pte_mkold(pmd_pte(pmd)))
 369 #define pmd_mkwrite(pmd)        pte_pmd(pte_mkwrite(pmd_pte(pmd)))
 370 #define pmd_mkclean(pmd)        pte_pmd(pte_mkclean(pmd_pte(pmd)))
 371 #define pmd_mkdirty(pmd)        pte_pmd(pte_mkdirty(pmd_pte(pmd)))
 372 #define pmd_mkyoung(pmd)        pte_pmd(pte_mkyoung(pmd_pte(pmd)))
 373 #define pmd_mknotpresent(pmd)   (__pmd(pmd_val(pmd) & ~PMD_SECT_VALID))
 374
 375 #define pmd_thp_or_huge(pmd)    (pmd_huge(pmd) || pmd_trans_huge(pmd))
 376
 377 #define pmd_write(pmd)          pte_write(pmd_pte(pmd))
 378
 379 #define pmd_mkhuge(pmd)         (__pmd(pmd_val(pmd) & ~PMD_TABLE_BIT))
 380
 381 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 382 #define pmd_devmap(pmd)         pte_devmap(pmd_pte(pmd))
 383 #endif
 384 static inline pmd_t pmd_mkdevmap(pmd_t pmd)
 385 {
 386         return pte_pmd(set_pte_bit(pmd_pte(pmd), __pgprot(PTE_DEVMAP)));
 387 }
 388
 389 #define __pmd_to_phys(pmd)      __pte_to_phys(pmd_pte(pmd))
 390 #define __phys_to_pmd_val(phys) __phys_to_pte_val(phys)
 391 #define pmd_pfn(pmd)            ((__pmd_to_phys(pmd) & PMD_MASK) >> PAGE_SHIFT)
 392 #define pfn_pmd(pfn,prot)       __pmd(__phys_to_pmd_val((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot))
 393 #define mk_pmd(page,prot)       pfn_pmd(page_to_pfn(page),prot)
 394
 395 #define pud_young(pud)          pte_young(pud_pte(pud))
 396 #define pud_mkyoung(pud)        pte_pud(pte_mkyoung(pud_pte(pud)))
 397 #define pud_write(pud)          pte_write(pud_pte(pud))
 398
 399 #define pud_mkhuge(pud)         (__pud(pud_val(pud) & ~PUD_TABLE_BIT))
 400
 401 #define __pud_to_phys(pud)      __pte_to_phys(pud_pte(pud))
 402 #define __phys_to_pud_val(phys) __phys_to_pte_val(phys)
 403 #define pud_pfn(pud)            ((__pud_to_phys(pud) & PUD_MASK) >> PAGE_SHIFT)
 404 #define pfn_pud(pfn,prot)       __pud(__phys_to_pud_val((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot))
 405
 406 #define set_pmd_at(mm, addr, pmdp, pmd) set_pte_at(mm, addr, (pte_t *)pmdp, pmd_pte(pmd))
 407
 408 #define __pgd_to_phys(pgd)      __pte_to_phys(pgd_pte(pgd))
 409 #define __phys_to_pgd_val(phys) __phys_to_pte_val(phys)
 410
 411 #define __pgprot_modify(prot,mask,bits) \
 412         __pgprot((pgprot_val(prot) & ~(mask)) | (bits))
 413
 414 /*
 415  * Mark the prot value as uncacheable and unbufferable.
 416  */
 417 #define pgprot_noncached(prot) \
 418         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRnE) | PTE_PXN | PTE_UXN)
 419 #define pgprot_writecombine(prot) \
 420         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_NORMAL_NC) | PTE_PXN | PTE_UXN)
 421 #define pgprot_device(prot) \
 422         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRE) | PTE_PXN | PTE_UXN)
 423 #define __HAVE_PHYS_MEM_ACCESS_PROT
 424 struct file;
 425 extern pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
 426                                      unsigned long size, pgprot_t vma_prot);
 427
 428 #define pmd_none(pmd)           (!pmd_val(pmd))
 429
 430 #define pmd_bad(pmd)            (!(pmd_val(pmd) & PMD_TABLE_BIT))
 431
 432 #define pmd_table(pmd)          ((pmd_val(pmd) & PMD_TYPE_MASK) == \
 433                                  PMD_TYPE_TABLE)
 434 #define pmd_sect(pmd)           ((pmd_val(pmd) & PMD_TYPE_MASK) == \
 435                                  PMD_TYPE_SECT)
 436
 437 #if defined(CONFIG_ARM64_64K_PAGES) || CONFIG_PGTABLE_LEVELS < 3
 438 static inline bool pud_sect(pud_t pud) { return false; }
 439 static inline bool pud_table(pud_t pud) { return true; }
 440 #else
 441 #define pud_sect(pud)           ((pud_val(pud) & PUD_TYPE_MASK) == \
 442                                  PUD_TYPE_SECT)
 443 #define pud_table(pud)          ((pud_val(pud) & PUD_TYPE_MASK) == \
 444                                  PUD_TYPE_TABLE)
 445 #endif
 446
 447 extern pgd_t init_pg_dir[PTRS_PER_PGD];
 448 extern pgd_t init_pg_end[];
 449 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
 450 extern pgd_t idmap_pg_dir[PTRS_PER_PGD];
 451 extern pgd_t tramp_pg_dir[PTRS_PER_PGD];
 452
 453 extern void set_swapper_pgd(pgd_t *pgdp, pgd_t pgd);
 454
 455 static inline bool in_swapper_pgdir(void *addr)
 456 {
 457         return ((unsigned long)addr & PAGE_MASK) ==
 458                 ((unsigned long)swapper_pg_dir & PAGE_MASK);
 459 }
 460
 461 static inline void set_pmd(pmd_t *pmdp, pmd_t pmd)
 462 {
 463 #ifdef __PAGETABLE_PMD_FOLDED
 464         if (in_swapper_pgdir(pmdp)) {
 465                 set_swapper_pgd((pgd_t *)pmdp, __pgd(pmd_val(pmd)));
 466                 return;
 467         }
 468 #endif /* __PAGETABLE_PMD_FOLDED */
 469
 470         WRITE_ONCE(*pmdp, pmd);
 471
 472         if (pmd_valid(pmd)) {
 473                 dsb(ishst);
 474                 isb();
 475         }
 476 }
 477
 478 static inline void pmd_clear(pmd_t *pmdp)
 479 {
 480         set_pmd(pmdp, __pmd(0));
 481 }
 482
 483 static inline phys_addr_t pmd_page_paddr(pmd_t pmd)
 484 {
 485         return __pmd_to_phys(pmd);
 486 }
 487
 488 static inline void pte_unmap(pte_t *pte) { }
 489
 490 /* Find an entry in the third-level page table. */
 491 #define pte_index(addr)         (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
 492
 493 #define pte_offset_phys(dir,addr)       (pmd_page_paddr(READ_ONCE(*(dir))) + pte_index(addr) * sizeof(pte_t))
 494 #define pte_offset_kernel(dir,addr)     ((pte_t *)__va(pte_offset_phys((dir), (addr))))
 495
 496 #define pte_offset_map(dir,addr)        pte_offset_kernel((dir), (addr))
 497
 498 #define pte_set_fixmap(addr)            ((pte_t *)set_fixmap_offset(FIX_PTE, addr))
 499 #define pte_set_fixmap_offset(pmd, addr)        pte_set_fixmap(pte_offset_phys(pmd, addr))
 500 #define pte_clear_fixmap()              clear_fixmap(FIX_PTE)
 501
 502 #define pmd_page(pmd)           pfn_to_page(__phys_to_pfn(__pmd_to_phys(pmd)))
 503
 504 /* use ONLY for statically allocated translation tables */
 505 #define pte_offset_kimg(dir,addr)       ((pte_t *)__phys_to_kimg(pte_offset_phys((dir), (addr))))
 506
 507 /*
 508  * Conversion functions: convert a page and protection to a page entry,
 509  * and a page entry and page directory to the page they refer to.
 510  */
 511 #define mk_pte(page,prot)       pfn_pte(page_to_pfn(page),prot)
 512
 513 #if CONFIG_PGTABLE_LEVELS > 2
 514
 515 #define pmd_ERROR(pmd)          __pmd_error(__FILE__, __LINE__, pmd_val(pmd))
 516
 517 #define pud_none(pud)           (!pud_val(pud))
 518 #define pud_bad(pud)            (!(pud_val(pud) & PUD_TABLE_BIT))
 519 #define pud_present(pud)        pte_present(pud_pte(pud))
 520 #define pud_valid(pud)          pte_valid(pud_pte(pud))
 521
 522 static inline void set_pud(pud_t *pudp, pud_t pud)
 523 {
 524 #ifdef __PAGETABLE_PUD_FOLDED
 525         if (in_swapper_pgdir(pudp)) {
 526                 set_swapper_pgd((pgd_t *)pudp, __pgd(pud_val(pud)));
 527                 return;
 528         }
 529 #endif /* __PAGETABLE_PUD_FOLDED */
 530
 531         WRITE_ONCE(*pudp, pud);
 532
 533         if (pud_valid(pud)) {
 534                 dsb(ishst);
 535                 isb();
 536         }
 537 }
 538
 539 static inline void pud_clear(pud_t *pudp)
 540 {
 541         set_pud(pudp, __pud(0));
 542 }
 543
 544 static inline phys_addr_t pud_page_paddr(pud_t pud)
 545 {
 546         return __pud_to_phys(pud);
 547 }
 548
 549 /* Find an entry in the second-level page table. */
 550 #define pmd_index(addr)         (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1))
 551
 552 #define pmd_offset_phys(dir, addr)      (pud_page_paddr(READ_ONCE(*(dir))) + pmd_index(addr) * sizeof(pmd_t))
 553 #define pmd_offset(dir, addr)           ((pmd_t *)__va(pmd_offset_phys((dir), (addr))))
 554
 555 #define pmd_set_fixmap(addr)            ((pmd_t *)set_fixmap_offset(FIX_PMD, addr))
 556 #define pmd_set_fixmap_offset(pud, addr)        pmd_set_fixmap(pmd_offset_phys(pud, addr))
 557 #define pmd_clear_fixmap()              clear_fixmap(FIX_PMD)
 558
 559 #define pud_page(pud)           pfn_to_page(__phys_to_pfn(__pud_to_phys(pud)))
 560
 561 /* use ONLY for statically allocated translation tables */
 562 #define pmd_offset_kimg(dir,addr)       ((pmd_t *)__phys_to_kimg(pmd_offset_phys((dir), (addr))))
 563
 564 #else
 565
 566 #define pud_page_paddr(pud)     ({ BUILD_BUG(); 0; })
 567
 568 /* Match pmd_offset folding in <asm/generic/pgtable-nopmd.h> */
 569 #define pmd_set_fixmap(addr)            NULL
 570 #define pmd_set_fixmap_offset(pudp, addr)       ((pmd_t *)pudp)
 571 #define pmd_clear_fixmap()
 572
 573 #define pmd_offset_kimg(dir,addr)       ((pmd_t *)dir)
 574
 575 #endif  /* CONFIG_PGTABLE_LEVELS > 2 */
 576
 577 #if CONFIG_PGTABLE_LEVELS > 3
 578
 579 #define pud_ERROR(pud)          __pud_error(__FILE__, __LINE__, pud_val(pud))
 580
 581 #define pgd_none(pgd)           (!pgd_val(pgd))
 582 #define pgd_bad(pgd)            (!(pgd_val(pgd) & 2))
 583 #define pgd_present(pgd)        (pgd_val(pgd))
 584
 585 static inline void set_pgd(pgd_t *pgdp, pgd_t pgd)
 586 {
 587         if (in_swapper_pgdir(pgdp)) {
 588                 set_swapper_pgd(pgdp, pgd);
 589                 return;
 590         }
 591
 592         WRITE_ONCE(*pgdp, pgd);
 593         dsb(ishst);
 594 }
 595
 596 static inline void pgd_clear(pgd_t *pgdp)
 597 {
 598         set_pgd(pgdp, __pgd(0));
 599 }
 600
 601 static inline phys_addr_t pgd_page_paddr(pgd_t pgd)
 602 {
 603         return __pgd_to_phys(pgd);
 604 }
 605
 606 /* Find an entry in the frst-level page table. */
 607 #define pud_index(addr)         (((addr) >> PUD_SHIFT) & (PTRS_PER_PUD - 1))
 608
 609 #define pud_offset_phys(dir, addr)      (pgd_page_paddr(READ_ONCE(*(dir))) + pud_index(addr) * sizeof(pud_t))
 610 #define pud_offset(dir, addr)           ((pud_t *)__va(pud_offset_phys((dir), (addr))))
 611
 612 #define pud_set_fixmap(addr)            ((pud_t *)set_fixmap_offset(FIX_PUD, addr))
 613 #define pud_set_fixmap_offset(pgd, addr)        pud_set_fixmap(pud_offset_phys(pgd, addr))
 614 #define pud_clear_fixmap()              clear_fixmap(FIX_PUD)
 615
 616 #define pgd_page(pgd)           pfn_to_page(__phys_to_pfn(__pgd_to_phys(pgd)))
 617
 618 /* use ONLY for statically allocated translation tables */
 619 #define pud_offset_kimg(dir,addr)       ((pud_t *)__phys_to_kimg(pud_offset_phys((dir), (addr))))
 620
 621 #else
 622
 623 #define pgd_page_paddr(pgd)     ({ BUILD_BUG(); 0;})
 624
 625 /* Match pud_offset folding in <asm/generic/pgtable-nopud.h> */
 626 #define pud_set_fixmap(addr)            NULL
 627 #define pud_set_fixmap_offset(pgdp, addr)       ((pud_t *)pgdp)
 628 #define pud_clear_fixmap()
 629
 630 #define pud_offset_kimg(dir,addr)       ((pud_t *)dir)
 631
 632 #endif  /* CONFIG_PGTABLE_LEVELS > 3 */
 633
 634 #define pgd_ERROR(pgd)          __pgd_error(__FILE__, __LINE__, pgd_val(pgd))
 635
 636 /* to find an entry in a page-table-directory */
 637 #define pgd_index(addr)         (((addr) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
 638
 639 #define pgd_offset_raw(pgd, addr)       ((pgd) + pgd_index(addr))
 640
 641 #define pgd_offset(mm, addr)    (pgd_offset_raw((mm)->pgd, (addr)))
 642
 643 /* to find an entry in a kernel page-table-directory */
 644 #define pgd_offset_k(addr)      pgd_offset(&init_mm, addr)
 645
 646 #define pgd_set_fixmap(addr)    ((pgd_t *)set_fixmap_offset(FIX_PGD, addr))
 647 #define pgd_clear_fixmap()      clear_fixmap(FIX_PGD)
 648
 649 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
 650 {
 651         const pteval_t mask = PTE_USER | PTE_PXN | PTE_UXN | PTE_RDONLY |
 652                               PTE_PROT_NONE | PTE_VALID | PTE_WRITE;
 653         /* preserve the hardware dirty information */
 654         if (pte_hw_dirty(pte))
 655                 pte = pte_mkdirty(pte);
 656         pte_val(pte) = (pte_val(pte) & ~mask) | (pgprot_val(newprot) & mask);
 657         return pte;
 658 }
 659
 660 static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
 661 {
 662         return pte_pmd(pte_modify(pmd_pte(pmd), newprot));
 663 }
 664
 665 #define __HAVE_ARCH_PTEP_SET_ACCESS_FLAGS
 666 extern int ptep_set_access_flags(struct vm_area_struct *vma,
 667                                  unsigned long address, pte_t *ptep,
 668                                  pte_t entry, int dirty);
 669
 670 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 671 #define __HAVE_ARCH_PMDP_SET_ACCESS_FLAGS
 672 static inline int pmdp_set_access_flags(struct vm_area_struct *vma,
 673                                         unsigned long address, pmd_t *pmdp,
 674                                         pmd_t entry, int dirty)
 675 {
 676         return ptep_set_access_flags(vma, address, (pte_t *)pmdp, pmd_pte(entry), dirty);
 677 }
 678
 679 static inline int pud_devmap(pud_t pud)
 680 {
 681         return 0;
 682 }
 683
 684 static inline int pgd_devmap(pgd_t pgd)
 685 {
 686         return 0;
 687 }
 688 #endif
 689
 690 /*
 691  * Atomic pte/pmd modifications.
 692  */
 693 #define __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
 694 static inline int __ptep_test_and_clear_young(pte_t *ptep)
 695 {
 696         pte_t old_pte, pte;
 697
 698         pte = READ_ONCE(*ptep);
 699         do {
 700                 old_pte = pte;
 701                 pte = pte_mkold(pte);
 702                 pte_val(pte) = cmpxchg_relaxed(&pte_val(*ptep),
 703                                                pte_val(old_pte), pte_val(pte));
 704         } while (pte_val(pte) != pte_val(old_pte));
 705
 706         return pte_young(pte);
 707 }
 708
 709 static inline int ptep_test_and_clear_young(struct vm_area_struct *vma,
 710                                             unsigned long address,
 711                                             pte_t *ptep)
 712 {
 713         return __ptep_test_and_clear_young(ptep);
 714 }
 715
 716 #define __HAVE_ARCH_PTEP_CLEAR_YOUNG_FLUSH
 717 static inline int ptep_clear_flush_young(struct vm_area_struct *vma,
 718                                          unsigned long address, pte_t *ptep)
 719 {
 720         int young = ptep_test_and_clear_young(vma, address, ptep);
 721
 722         if (young) {
 723                 /*
 724                  * We can elide the trailing DSB here since the worst that can
 725                  * happen is that a CPU continues to use the young entry in its
 726                  * TLB and we mistakenly reclaim the associated page. The
 727                  * window for such an event is bounded by the next
 728                  * context-switch, which provides a DSB to complete the TLB
 729                  * invalidation.
 730                  */
 731                 flush_tlb_page_nosync(vma, address);
 732         }
 733
 734         return young;
 735 }
 736
 737 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 738 #define __HAVE_ARCH_PMDP_TEST_AND_CLEAR_YOUNG
 739 static inline int pmdp_test_and_clear_young(struct vm_area_struct *vma,
 740                                             unsigned long address,
 741                                             pmd_t *pmdp)
 742 {
 743         return ptep_test_and_clear_young(vma, address, (pte_t *)pmdp);
 744 }
 745 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 746
 747 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR
 748 static inline pte_t ptep_get_and_clear(struct mm_struct *mm,
 749                                        unsigned long address, pte_t *ptep)
 750 {
 751         return __pte(xchg_relaxed(&pte_val(*ptep), 0));
 752 }
 753
 754 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 755 #define __HAVE_ARCH_PMDP_HUGE_GET_AND_CLEAR
 756 static inline pmd_t pmdp_huge_get_and_clear(struct mm_struct *mm,
 757                                             unsigned long address, pmd_t *pmdp)
 758 {
 759         return pte_pmd(ptep_get_and_clear(mm, address, (pte_t *)pmdp));
 760 }
 761 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 762
 763 /*
 764  * ptep_set_wrprotect - mark read-only while trasferring potential hardware
 765  * dirty status (PTE_DBM && !PTE_RDONLY) to the software PTE_DIRTY bit.
 766  */
 767 #define __HAVE_ARCH_PTEP_SET_WRPROTECT
 768 static inline void ptep_set_wrprotect(struct mm_struct *mm, unsigned long address, pte_t *ptep)
 769 {
 770         pte_t old_pte, pte;
 771
 772         pte = READ_ONCE(*ptep);
 773         do {
 774                 old_pte = pte;
 775                 /*
 776                  * If hardware-dirty (PTE_WRITE/DBM bit set and PTE_RDONLY
 777                  * clear), set the PTE_DIRTY bit.
 778                  */
 779                 if (pte_hw_dirty(pte))
 780                         pte = pte_mkdirty(pte);
 781                 pte = pte_wrprotect(pte);
 782                 pte_val(pte) = cmpxchg_relaxed(&pte_val(*ptep),
 783                                                pte_val(old_pte), pte_val(pte));
 784         } while (pte_val(pte) != pte_val(old_pte));
 785 }
 786
 787 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 788 #define __HAVE_ARCH_PMDP_SET_WRPROTECT
 789 static inline void pmdp_set_wrprotect(struct mm_struct *mm,
 790                                       unsigned long address, pmd_t *pmdp)
 791 {
 792         ptep_set_wrprotect(mm, address, (pte_t *)pmdp);
 793 }
 794
 795 #define pmdp_establish pmdp_establish
 796 static inline pmd_t pmdp_establish(struct vm_area_struct *vma,
 797                 unsigned long address, pmd_t *pmdp, pmd_t pmd)
 798 {
 799         return __pmd(xchg_relaxed(&pmd_val(*pmdp), pmd_val(pmd)));
 800 }
 801 #endif
 802
 803 /*
 804  * Encode and decode a swap entry:
 805  *      bits 0-1:       present (must be zero)
 806  *      bits 2-7:       swap type
 807  *      bits 8-57:      swap offset
 808  *      bit  58:        PTE_PROT_NONE (must be zero)
 809  */
 810 #define __SWP_TYPE_SHIFT        2
 811 #define __SWP_TYPE_BITS         6
 812 #define __SWP_OFFSET_BITS       50
 813 #define __SWP_TYPE_MASK         ((1 << __SWP_TYPE_BITS) - 1)
 814 #define __SWP_OFFSET_SHIFT      (__SWP_TYPE_BITS + __SWP_TYPE_SHIFT)
 815 #define __SWP_OFFSET_MASK       ((1UL << __SWP_OFFSET_BITS) - 1)
 816
 817 #define __swp_type(x)           (((x).val >> __SWP_TYPE_SHIFT) & __SWP_TYPE_MASK)
 818 #define __swp_offset(x)         (((x).val >> __SWP_OFFSET_SHIFT) & __SWP_OFFSET_MASK)
 819 #define __swp_entry(type,offset) ((swp_entry_t) { ((type) << __SWP_TYPE_SHIFT) | ((offset) << __SWP_OFFSET_SHIFT) })
 820
 821 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
 822 #define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
 823
 824 /*
 825  * Ensure that there are not more swap files than can be encoded in the kernel
 826  * PTEs.
 827  */
 828 #define MAX_SWAPFILES_CHECK() BUILD_BUG_ON(MAX_SWAPFILES_SHIFT > __SWP_TYPE_BITS)
 829
 830 extern int kern_addr_valid(unsigned long addr);
 831
 832 #include <asm-generic/pgtable.h>
 833
 834 static inline void pgtable_cache_init(void) { }
 835
 836 /*
 837  * On AArch64, the cache coherency is handled via the set_pte_at() function.
 838  */
 839 static inline void update_mmu_cache(struct vm_area_struct *vma,
 840                                     unsigned long addr, pte_t *ptep)
 841 {
 842         /*
 843          * We don't do anything here, so there's a very small chance of
 844          * us retaking a user fault which we just fixed up. The alternative
 845          * is doing a dsb(ishst), but that penalises the fastpath.
 846          */
 847 }
 848
 849 #define update_mmu_cache_pmd(vma, address, pmd) do { } while (0)
 850
 851 #define kc_vaddr_to_offset(v)   ((v) & ~VA_START)
 852 #define kc_offset_to_vaddr(o)   ((o) | VA_START)
 853
 854 #ifdef CONFIG_ARM64_PA_BITS_52
 855 #define phys_to_ttbr(addr)      (((addr) | ((addr) >> 46)) & TTBR_BADDR_MASK_52)
 856 #else
 857 #define phys_to_ttbr(addr)      (addr)
 858 #endif
 859
 860 #endif /* !__ASSEMBLY__ */
 861
 862 #endif /* __ASM_PGTABLE_H */