include/asm-generic/pgtable.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _ASM_GENERIC_PGTABLE_H
   3 #define _ASM_GENERIC_PGTABLE_H
   4
   5 #include <linux/pfn.h>
   6
   7 #ifndef __ASSEMBLY__
   8 #ifdef CONFIG_MMU
   9
  10 #include <linux/mm_types.h>
  11 #include <linux/bug.h>
  12 #include <linux/errno.h>
  13
  14 #if 5 - defined(__PAGETABLE_P4D_FOLDED) - defined(__PAGETABLE_PUD_FOLDED) - \
  15         defined(__PAGETABLE_PMD_FOLDED) != CONFIG_PGTABLE_LEVELS
  16 #error CONFIG_PGTABLE_LEVELS is not consistent with __PAGETABLE_{P4D,PUD,PMD}_FOLDED
  17 #endif
  18
  19 /*
  20  * On almost all architectures and configurations, 0 can be used as the
  21  * upper ceiling to free_pgtables(): on many architectures it has the same
  22  * effect as using TASK_SIZE.  However, there is one configuration which
  23  * must impose a more careful limit, to avoid freeing kernel pgtables.
  24  */
  25 #ifndef USER_PGTABLES_CEILING
  26 #define USER_PGTABLES_CEILING   0UL
  27 #endif
  28
  29 #ifndef __HAVE_ARCH_PTEP_SET_ACCESS_FLAGS
  30 extern int ptep_set_access_flags(struct vm_area_struct *vma,
  31                                  unsigned long address, pte_t *ptep,
  32                                  pte_t entry, int dirty);
  33 #endif
  34
  35 #ifndef __HAVE_ARCH_PMDP_SET_ACCESS_FLAGS
  36 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
  37 extern int pmdp_set_access_flags(struct vm_area_struct *vma,
  38                                  unsigned long address, pmd_t *pmdp,
  39                                  pmd_t entry, int dirty);
  40 extern int pudp_set_access_flags(struct vm_area_struct *vma,
  41                                  unsigned long address, pud_t *pudp,
  42                                  pud_t entry, int dirty);
  43 #else
  44 static inline int pmdp_set_access_flags(struct vm_area_struct *vma,
  45                                         unsigned long address, pmd_t *pmdp,
  46                                         pmd_t entry, int dirty)
  47 {
  48         BUILD_BUG();
  49         return 0;
  50 }
  51 static inline int pudp_set_access_flags(struct vm_area_struct *vma,
  52                                         unsigned long address, pud_t *pudp,
  53                                         pud_t entry, int dirty)
  54 {
  55         BUILD_BUG();
  56         return 0;
  57 }
  58 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
  59 #endif
  60
  61 #ifndef __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
  62 static inline int ptep_test_and_clear_young(struct vm_area_struct *vma,
  63                                             unsigned long address,
  64                                             pte_t *ptep)
  65 {
  66         pte_t pte = *ptep;
  67         int r = 1;
  68         if (!pte_young(pte))
  69                 r = 0;
  70         else
  71                 set_pte_at(vma->vm_mm, address, ptep, pte_mkold(pte));
  72         return r;
  73 }
  74 #endif
  75
  76 #ifndef __HAVE_ARCH_PMDP_TEST_AND_CLEAR_YOUNG
  77 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
  78 static inline int pmdp_test_and_clear_young(struct vm_area_struct *vma,
  79                                             unsigned long address,
  80                                             pmd_t *pmdp)
  81 {
  82         pmd_t pmd = *pmdp;
  83         int r = 1;
  84         if (!pmd_young(pmd))
  85                 r = 0;
  86         else
  87                 set_pmd_at(vma->vm_mm, address, pmdp, pmd_mkold(pmd));
  88         return r;
  89 }
  90 #else
  91 static inline int pmdp_test_and_clear_young(struct vm_area_struct *vma,
  92                                             unsigned long address,
  93                                             pmd_t *pmdp)
  94 {
  95         BUILD_BUG();
  96         return 0;
  97 }
  98 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
  99 #endif
 100
 101 #ifndef __HAVE_ARCH_PTEP_CLEAR_YOUNG_FLUSH
 102 int ptep_clear_flush_young(struct vm_area_struct *vma,
 103                            unsigned long address, pte_t *ptep);
 104 #endif
 105
 106 #ifndef __HAVE_ARCH_PMDP_CLEAR_YOUNG_FLUSH
 107 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 108 extern int pmdp_clear_flush_young(struct vm_area_struct *vma,
 109                                   unsigned long address, pmd_t *pmdp);
 110 #else
 111 /*
 112  * Despite relevant to THP only, this API is called from generic rmap code
 113  * under PageTransHuge(), hence needs a dummy implementation for !THP
 114  */
 115 static inline int pmdp_clear_flush_young(struct vm_area_struct *vma,
 116                                          unsigned long address, pmd_t *pmdp)
 117 {
 118         BUILD_BUG();
 119         return 0;
 120 }
 121 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 122 #endif
 123
 124 #ifndef __HAVE_ARCH_PTEP_GET_AND_CLEAR
 125 static inline pte_t ptep_get_and_clear(struct mm_struct *mm,
 126                                        unsigned long address,
 127                                        pte_t *ptep)
 128 {
 129         pte_t pte = *ptep;
 130         pte_clear(mm, address, ptep);
 131         return pte;
 132 }
 133 #endif
 134
 135 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 136 #ifndef __HAVE_ARCH_PMDP_HUGE_GET_AND_CLEAR
 137 static inline pmd_t pmdp_huge_get_and_clear(struct mm_struct *mm,
 138                                             unsigned long address,
 139                                             pmd_t *pmdp)
 140 {
 141         pmd_t pmd = *pmdp;
 142         pmd_clear(pmdp);
 143         return pmd;
 144 }
 145 #endif /* __HAVE_ARCH_PMDP_HUGE_GET_AND_CLEAR */
 146 #ifndef __HAVE_ARCH_PUDP_HUGE_GET_AND_CLEAR
 147 static inline pud_t pudp_huge_get_and_clear(struct mm_struct *mm,
 148                                             unsigned long address,
 149                                             pud_t *pudp)
 150 {
 151         pud_t pud = *pudp;
 152
 153         pud_clear(pudp);
 154         return pud;
 155 }
 156 #endif /* __HAVE_ARCH_PUDP_HUGE_GET_AND_CLEAR */
 157 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 158
 159 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 160 #ifndef __HAVE_ARCH_PMDP_HUGE_GET_AND_CLEAR_FULL
 161 static inline pmd_t pmdp_huge_get_and_clear_full(struct mm_struct *mm,
 162                                             unsigned long address, pmd_t *pmdp,
 163                                             int full)
 164 {
 165         return pmdp_huge_get_and_clear(mm, address, pmdp);
 166 }
 167 #endif
 168
 169 #ifndef __HAVE_ARCH_PUDP_HUGE_GET_AND_CLEAR_FULL
 170 static inline pud_t pudp_huge_get_and_clear_full(struct mm_struct *mm,
 171                                             unsigned long address, pud_t *pudp,
 172                                             int full)
 173 {
 174         return pudp_huge_get_and_clear(mm, address, pudp);
 175 }
 176 #endif
 177 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 178
 179 #ifndef __HAVE_ARCH_PTEP_GET_AND_CLEAR_FULL
 180 static inline pte_t ptep_get_and_clear_full(struct mm_struct *mm,
 181                                             unsigned long address, pte_t *ptep,
 182                                             int full)
 183 {
 184         pte_t pte;
 185         pte = ptep_get_and_clear(mm, address, ptep);
 186         return pte;
 187 }
 188 #endif
 189
 190 /*
 191  * Some architectures may be able to avoid expensive synchronization
 192  * primitives when modifications are made to PTE's which are already
 193  * not present, or in the process of an address space destruction.
 194  */
 195 #ifndef __HAVE_ARCH_PTE_CLEAR_NOT_PRESENT_FULL
 196 static inline void pte_clear_not_present_full(struct mm_struct *mm,
 197                                               unsigned long address,
 198                                               pte_t *ptep,
 199                                               int full)
 200 {
 201         pte_clear(mm, address, ptep);
 202 }
 203 #endif
 204
 205 #ifndef __HAVE_ARCH_PTEP_CLEAR_FLUSH
 206 extern pte_t ptep_clear_flush(struct vm_area_struct *vma,
 207                               unsigned long address,
 208                               pte_t *ptep);
 209 #endif
 210
 211 #ifndef __HAVE_ARCH_PMDP_HUGE_CLEAR_FLUSH
 212 extern pmd_t pmdp_huge_clear_flush(struct vm_area_struct *vma,
 213                               unsigned long address,
 214                               pmd_t *pmdp);
 215 extern pud_t pudp_huge_clear_flush(struct vm_area_struct *vma,
 216                               unsigned long address,
 217                               pud_t *pudp);
 218 #endif
 219
 220 #ifndef __HAVE_ARCH_PTEP_SET_WRPROTECT
 221 struct mm_struct;
 222 static inline void ptep_set_wrprotect(struct mm_struct *mm, unsigned long address, pte_t *ptep)
 223 {
 224         pte_t old_pte = *ptep;
 225         set_pte_at(mm, address, ptep, pte_wrprotect(old_pte));
 226 }
 227 #endif
 228
 229 #ifndef pte_savedwrite
 230 #define pte_savedwrite pte_write
 231 #endif
 232
 233 #ifndef pte_mk_savedwrite
 234 #define pte_mk_savedwrite pte_mkwrite
 235 #endif
 236
 237 #ifndef pte_clear_savedwrite
 238 #define pte_clear_savedwrite pte_wrprotect
 239 #endif
 240
 241 #ifndef pmd_savedwrite
 242 #define pmd_savedwrite pmd_write
 243 #endif
 244
 245 #ifndef pmd_mk_savedwrite
 246 #define pmd_mk_savedwrite pmd_mkwrite
 247 #endif
 248
 249 #ifndef pmd_clear_savedwrite
 250 #define pmd_clear_savedwrite pmd_wrprotect
 251 #endif
 252
 253 #ifndef __HAVE_ARCH_PMDP_SET_WRPROTECT
 254 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 255 static inline void pmdp_set_wrprotect(struct mm_struct *mm,
 256                                       unsigned long address, pmd_t *pmdp)
 257 {
 258         pmd_t old_pmd = *pmdp;
 259         set_pmd_at(mm, address, pmdp, pmd_wrprotect(old_pmd));
 260 }
 261 #else
 262 static inline void pmdp_set_wrprotect(struct mm_struct *mm,
 263                                       unsigned long address, pmd_t *pmdp)
 264 {
 265         BUILD_BUG();
 266 }
 267 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 268 #endif
 269 #ifndef __HAVE_ARCH_PUDP_SET_WRPROTECT
 270 #ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
 271 static inline void pudp_set_wrprotect(struct mm_struct *mm,
 272                                       unsigned long address, pud_t *pudp)
 273 {
 274         pud_t old_pud = *pudp;
 275
 276         set_pud_at(mm, address, pudp, pud_wrprotect(old_pud));
 277 }
 278 #else
 279 static inline void pudp_set_wrprotect(struct mm_struct *mm,
 280                                       unsigned long address, pud_t *pudp)
 281 {
 282         BUILD_BUG();
 283 }
 284 #endif /* CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD */
 285 #endif
 286
 287 #ifndef pmdp_collapse_flush
 288 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 289 extern pmd_t pmdp_collapse_flush(struct vm_area_struct *vma,
 290                                  unsigned long address, pmd_t *pmdp);
 291 #else
 292 static inline pmd_t pmdp_collapse_flush(struct vm_area_struct *vma,
 293                                         unsigned long address,
 294                                         pmd_t *pmdp)
 295 {
 296         BUILD_BUG();
 297         return *pmdp;
 298 }
 299 #define pmdp_collapse_flush pmdp_collapse_flush
 300 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 301 #endif
 302
 303 #ifndef __HAVE_ARCH_PGTABLE_DEPOSIT
 304 extern void pgtable_trans_huge_deposit(struct mm_struct *mm, pmd_t *pmdp,
 305                                        pgtable_t pgtable);
 306 #endif
 307
 308 #ifndef __HAVE_ARCH_PGTABLE_WITHDRAW
 309 extern pgtable_t pgtable_trans_huge_withdraw(struct mm_struct *mm, pmd_t *pmdp);
 310 #endif
 311
 312 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 313 /*
 314  * This is an implementation of pmdp_establish() that is only suitable for an
 315  * architecture that doesn't have hardware dirty/accessed bits. In this case we
 316  * can't race with CPU which sets these bits and non-atomic aproach is fine.
 317  */
 318 static inline pmd_t generic_pmdp_establish(struct vm_area_struct *vma,
 319                 unsigned long address, pmd_t *pmdp, pmd_t pmd)
 320 {
 321         pmd_t old_pmd = *pmdp;
 322         set_pmd_at(vma->vm_mm, address, pmdp, pmd);
 323         return old_pmd;
 324 }
 325 #endif
 326
 327 #ifndef __HAVE_ARCH_PMDP_INVALIDATE
 328 extern pmd_t pmdp_invalidate(struct vm_area_struct *vma, unsigned long address,
 329                             pmd_t *pmdp);
 330 #endif
 331
 332 #ifndef __HAVE_ARCH_PTE_SAME
 333 static inline int pte_same(pte_t pte_a, pte_t pte_b)
 334 {
 335         return pte_val(pte_a) == pte_val(pte_b);
 336 }
 337 #endif
 338
 339 #ifndef __HAVE_ARCH_PTE_UNUSED
 340 /*
 341  * Some architectures provide facilities to virtualization guests
 342  * so that they can flag allocated pages as unused. This allows the
 343  * host to transparently reclaim unused pages. This function returns
 344  * whether the pte's page is unused.
 345  */
 346 static inline int pte_unused(pte_t pte)
 347 {
 348         return 0;
 349 }
 350 #endif
 351
 352 #ifndef pte_access_permitted
 353 #define pte_access_permitted(pte, write) \
 354         (pte_present(pte) && (!(write) || pte_write(pte)))
 355 #endif
 356
 357 #ifndef pmd_access_permitted
 358 #define pmd_access_permitted(pmd, write) \
 359         (pmd_present(pmd) && (!(write) || pmd_write(pmd)))
 360 #endif
 361
 362 #ifndef pud_access_permitted
 363 #define pud_access_permitted(pud, write) \
 364         (pud_present(pud) && (!(write) || pud_write(pud)))
 365 #endif
 366
 367 #ifndef p4d_access_permitted
 368 #define p4d_access_permitted(p4d, write) \
 369         (p4d_present(p4d) && (!(write) || p4d_write(p4d)))
 370 #endif
 371
 372 #ifndef pgd_access_permitted
 373 #define pgd_access_permitted(pgd, write) \
 374         (pgd_present(pgd) && (!(write) || pgd_write(pgd)))
 375 #endif
 376
 377 #ifndef __HAVE_ARCH_PMD_SAME
 378 static inline int pmd_same(pmd_t pmd_a, pmd_t pmd_b)
 379 {
 380         return pmd_val(pmd_a) == pmd_val(pmd_b);
 381 }
 382
 383 static inline int pud_same(pud_t pud_a, pud_t pud_b)
 384 {
 385         return pud_val(pud_a) == pud_val(pud_b);
 386 }
 387 #endif
 388
 389 #ifndef __HAVE_ARCH_DO_SWAP_PAGE
 390 /*
 391  * Some architectures support metadata associated with a page. When a
 392  * page is being swapped out, this metadata must be saved so it can be
 393  * restored when the page is swapped back in. SPARC M7 and newer
 394  * processors support an ADI (Application Data Integrity) tag for the
 395  * page as metadata for the page. arch_do_swap_page() can restore this
 396  * metadata when a page is swapped back in.
 397  */
 398 static inline void arch_do_swap_page(struct mm_struct *mm,
 399                                      struct vm_area_struct *vma,
 400                                      unsigned long addr,
 401                                      pte_t pte, pte_t oldpte)
 402 {
 403
 404 }
 405 #endif
 406
 407 #ifndef __HAVE_ARCH_UNMAP_ONE
 408 /*
 409  * Some architectures support metadata associated with a page. When a
 410  * page is being swapped out, this metadata must be saved so it can be
 411  * restored when the page is swapped back in. SPARC M7 and newer
 412  * processors support an ADI (Application Data Integrity) tag for the
 413  * page as metadata for the page. arch_unmap_one() can save this
 414  * metadata on a swap-out of a page.
 415  */
 416 static inline int arch_unmap_one(struct mm_struct *mm,
 417                                   struct vm_area_struct *vma,
 418                                   unsigned long addr,
 419                                   pte_t orig_pte)
 420 {
 421         return 0;
 422 }
 423 #endif
 424
 425 #ifndef __HAVE_ARCH_PGD_OFFSET_GATE
 426 #define pgd_offset_gate(mm, addr)       pgd_offset(mm, addr)
 427 #endif
 428
 429 #ifndef __HAVE_ARCH_MOVE_PTE
 430 #define move_pte(pte, prot, old_addr, new_addr) (pte)
 431 #endif
 432
 433 #ifndef pte_accessible
 434 # define pte_accessible(mm, pte)        ((void)(pte), 1)
 435 #endif
 436
 437 #ifndef flush_tlb_fix_spurious_fault
 438 #define flush_tlb_fix_spurious_fault(vma, address) flush_tlb_page(vma, address)
 439 #endif
 440
 441 #ifndef pgprot_noncached
 442 #define pgprot_noncached(prot)  (prot)
 443 #endif
 444
 445 #ifndef pgprot_writecombine
 446 #define pgprot_writecombine pgprot_noncached
 447 #endif
 448
 449 #ifndef pgprot_writethrough
 450 #define pgprot_writethrough pgprot_noncached
 451 #endif
 452
 453 #ifndef pgprot_device
 454 #define pgprot_device pgprot_noncached
 455 #endif
 456
 457 #ifndef pgprot_modify
 458 #define pgprot_modify pgprot_modify
 459 static inline pgprot_t pgprot_modify(pgprot_t oldprot, pgprot_t newprot)
 460 {
 461         if (pgprot_val(oldprot) == pgprot_val(pgprot_noncached(oldprot)))
 462                 newprot = pgprot_noncached(newprot);
 463         if (pgprot_val(oldprot) == pgprot_val(pgprot_writecombine(oldprot)))
 464                 newprot = pgprot_writecombine(newprot);
 465         if (pgprot_val(oldprot) == pgprot_val(pgprot_device(oldprot)))
 466                 newprot = pgprot_device(newprot);
 467         return newprot;
 468 }
 469 #endif
 470
 471 /*
 472  * When walking page tables, get the address of the next boundary,
 473  * or the end address of the range if that comes earlier.  Although no
 474  * vma end wraps to 0, rounded up __boundary may wrap to 0 throughout.
 475  */
 476
 477 #define pgd_addr_end(addr, end)                                         \
 478 ({      unsigned long __boundary = ((addr) + PGDIR_SIZE) & PGDIR_MASK;  \
 479         (__boundary - 1 < (end) - 1)? __boundary: (end);                \
 480 })
 481
 482 #ifndef p4d_addr_end
 483 #define p4d_addr_end(addr, end)                                         \
 484 ({      unsigned long __boundary = ((addr) + P4D_SIZE) & P4D_MASK;      \
 485         (__boundary - 1 < (end) - 1)? __boundary: (end);                \
 486 })
 487 #endif
 488
 489 #ifndef pud_addr_end
 490 #define pud_addr_end(addr, end)                                         \
 491 ({      unsigned long __boundary = ((addr) + PUD_SIZE) & PUD_MASK;      \
 492         (__boundary - 1 < (end) - 1)? __boundary: (end);                \
 493 })
 494 #endif
 495
 496 #ifndef pmd_addr_end
 497 #define pmd_addr_end(addr, end)                                         \
 498 ({      unsigned long __boundary = ((addr) + PMD_SIZE) & PMD_MASK;      \
 499         (__boundary - 1 < (end) - 1)? __boundary: (end);                \
 500 })
 501 #endif
 502
 503 /*
 504  * When walking page tables, we usually want to skip any p?d_none entries;
 505  * and any p?d_bad entries - reporting the error before resetting to none.
 506  * Do the tests inline, but report and clear the bad entry in mm/memory.c.
 507  */
 508 void pgd_clear_bad(pgd_t *);
 509 void p4d_clear_bad(p4d_t *);
 510 void pud_clear_bad(pud_t *);
 511 void pmd_clear_bad(pmd_t *);
 512
 513 static inline int pgd_none_or_clear_bad(pgd_t *pgd)
 514 {
 515         if (pgd_none(*pgd))
 516                 return 1;
 517         if (unlikely(pgd_bad(*pgd))) {
 518                 pgd_clear_bad(pgd);
 519                 return 1;
 520         }
 521         return 0;
 522 }
 523
 524 static inline int p4d_none_or_clear_bad(p4d_t *p4d)
 525 {
 526         if (p4d_none(*p4d))
 527                 return 1;
 528         if (unlikely(p4d_bad(*p4d))) {
 529                 p4d_clear_bad(p4d);
 530                 return 1;
 531         }
 532         return 0;
 533 }
 534
 535 static inline int pud_none_or_clear_bad(pud_t *pud)
 536 {
 537         if (pud_none(*pud))
 538                 return 1;
 539         if (unlikely(pud_bad(*pud))) {
 540                 pud_clear_bad(pud);
 541                 return 1;
 542         }
 543         return 0;
 544 }
 545
 546 static inline int pmd_none_or_clear_bad(pmd_t *pmd)
 547 {
 548         if (pmd_none(*pmd))
 549                 return 1;
 550         if (unlikely(pmd_bad(*pmd))) {
 551                 pmd_clear_bad(pmd);
 552                 return 1;
 553         }
 554         return 0;
 555 }
 556
 557 static inline pte_t __ptep_modify_prot_start(struct mm_struct *mm,
 558                                              unsigned long addr,
 559                                              pte_t *ptep)
 560 {
 561         /*
 562          * Get the current pte state, but zero it out to make it
 563          * non-present, preventing the hardware from asynchronously
 564          * updating it.
 565          */
 566         return ptep_get_and_clear(mm, addr, ptep);
 567 }
 568
 569 static inline void __ptep_modify_prot_commit(struct mm_struct *mm,
 570                                              unsigned long addr,
 571                                              pte_t *ptep, pte_t pte)
 572 {
 573         /*
 574          * The pte is non-present, so there's no hardware state to
 575          * preserve.
 576          */
 577         set_pte_at(mm, addr, ptep, pte);
 578 }
 579
 580 #ifndef __HAVE_ARCH_PTEP_MODIFY_PROT_TRANSACTION
 581 /*
 582  * Start a pte protection read-modify-write transaction, which
 583  * protects against asynchronous hardware modifications to the pte.
 584  * The intention is not to prevent the hardware from making pte
 585  * updates, but to prevent any updates it may make from being lost.
 586  *
 587  * This does not protect against other software modifications of the
 588  * pte; the appropriate pte lock must be held over the transation.
 589  *
 590  * Note that this interface is intended to be batchable, meaning that
 591  * ptep_modify_prot_commit may not actually update the pte, but merely
 592  * queue the update to be done at some later time.  The update must be
 593  * actually committed before the pte lock is released, however.
 594  */
 595 static inline pte_t ptep_modify_prot_start(struct mm_struct *mm,
 596                                            unsigned long addr,
 597                                            pte_t *ptep)
 598 {
 599         return __ptep_modify_prot_start(mm, addr, ptep);
 600 }
 601
 602 /*
 603  * Commit an update to a pte, leaving any hardware-controlled bits in
 604  * the PTE unmodified.
 605  */
 606 static inline void ptep_modify_prot_commit(struct mm_struct *mm,
 607                                            unsigned long addr,
 608                                            pte_t *ptep, pte_t pte)
 609 {
 610         __ptep_modify_prot_commit(mm, addr, ptep, pte);
 611 }
 612 #endif /* __HAVE_ARCH_PTEP_MODIFY_PROT_TRANSACTION */
 613 #endif /* CONFIG_MMU */
 614
 615 /*
 616  * No-op macros that just return the current protection value. Defined here
 617  * because these macros can be used used even if CONFIG_MMU is not defined.
 618  */
 619 #ifndef pgprot_encrypted
 620 #define pgprot_encrypted(prot)  (prot)
 621 #endif
 622
 623 #ifndef pgprot_decrypted
 624 #define pgprot_decrypted(prot)  (prot)
 625 #endif
 626
 627 /*
 628  * A facility to provide lazy MMU batching.  This allows PTE updates and
 629  * page invalidations to be delayed until a call to leave lazy MMU mode
 630  * is issued.  Some architectures may benefit from doing this, and it is
 631  * beneficial for both shadow and direct mode hypervisors, which may batch
 632  * the PTE updates which happen during this window.  Note that using this
 633  * interface requires that read hazards be removed from the code.  A read
 634  * hazard could result in the direct mode hypervisor case, since the actual
 635  * write to the page tables may not yet have taken place, so reads though
 636  * a raw PTE pointer after it has been modified are not guaranteed to be
 637  * up to date.  This mode can only be entered and left under the protection of
 638  * the page table locks for all page tables which may be modified.  In the UP
 639  * case, this is required so that preemption is disabled, and in the SMP case,
 640  * it must synchronize the delayed page table writes properly on other CPUs.
 641  */
 642 #ifndef __HAVE_ARCH_ENTER_LAZY_MMU_MODE
 643 #define arch_enter_lazy_mmu_mode()      do {} while (0)
 644 #define arch_leave_lazy_mmu_mode()      do {} while (0)
 645 #define arch_flush_lazy_mmu_mode()      do {} while (0)
 646 #endif
 647
 648 /*
 649  * A facility to provide batching of the reload of page tables and
 650  * other process state with the actual context switch code for
 651  * paravirtualized guests.  By convention, only one of the batched
 652  * update (lazy) modes (CPU, MMU) should be active at any given time,
 653  * entry should never be nested, and entry and exits should always be
 654  * paired.  This is for sanity of maintaining and reasoning about the
 655  * kernel code.  In this case, the exit (end of the context switch) is
 656  * in architecture-specific code, and so doesn't need a generic
 657  * definition.
 658  */
 659 #ifndef __HAVE_ARCH_START_CONTEXT_SWITCH
 660 #define arch_start_context_switch(prev) do {} while (0)
 661 #endif
 662
 663 #ifdef CONFIG_HAVE_ARCH_SOFT_DIRTY
 664 #ifndef CONFIG_ARCH_ENABLE_THP_MIGRATION
 665 static inline pmd_t pmd_swp_mksoft_dirty(pmd_t pmd)
 666 {
 667         return pmd;
 668 }
 669
 670 static inline int pmd_swp_soft_dirty(pmd_t pmd)
 671 {
 672         return 0;
 673 }
 674
 675 static inline pmd_t pmd_swp_clear_soft_dirty(pmd_t pmd)
 676 {
 677         return pmd;
 678 }
 679 #endif
 680 #else /* !CONFIG_HAVE_ARCH_SOFT_DIRTY */
 681 static inline int pte_soft_dirty(pte_t pte)
 682 {
 683         return 0;
 684 }
 685
 686 static inline int pmd_soft_dirty(pmd_t pmd)
 687 {
 688         return 0;
 689 }
 690
 691 static inline pte_t pte_mksoft_dirty(pte_t pte)
 692 {
 693         return pte;
 694 }
 695
 696 static inline pmd_t pmd_mksoft_dirty(pmd_t pmd)
 697 {
 698         return pmd;
 699 }
 700
 701 static inline pte_t pte_clear_soft_dirty(pte_t pte)
 702 {
 703         return pte;
 704 }
 705
 706 static inline pmd_t pmd_clear_soft_dirty(pmd_t pmd)
 707 {
 708         return pmd;
 709 }
 710
 711 static inline pte_t pte_swp_mksoft_dirty(pte_t pte)
 712 {
 713         return pte;
 714 }
 715
 716 static inline int pte_swp_soft_dirty(pte_t pte)
 717 {
 718         return 0;
 719 }
 720
 721 static inline pte_t pte_swp_clear_soft_dirty(pte_t pte)
 722 {
 723         return pte;
 724 }
 725
 726 static inline pmd_t pmd_swp_mksoft_dirty(pmd_t pmd)
 727 {
 728         return pmd;
 729 }
 730
 731 static inline int pmd_swp_soft_dirty(pmd_t pmd)
 732 {
 733         return 0;
 734 }
 735
 736 static inline pmd_t pmd_swp_clear_soft_dirty(pmd_t pmd)
 737 {
 738         return pmd;
 739 }
 740 #endif
 741
 742 #ifndef __HAVE_PFNMAP_TRACKING
 743 /*
 744  * Interfaces that can be used by architecture code to keep track of
 745  * memory type of pfn mappings specified by the remap_pfn_range,
 746  * vmf_insert_pfn.
 747  */
 748
 749 /*
 750  * track_pfn_remap is called when a _new_ pfn mapping is being established
 751  * by remap_pfn_range() for physical range indicated by pfn and size.
 752  */
 753 static inline int track_pfn_remap(struct vm_area_struct *vma, pgprot_t *prot,
 754                                   unsigned long pfn, unsigned long addr,
 755                                   unsigned long size)
 756 {
 757         return 0;
 758 }
 759
 760 /*
 761  * track_pfn_insert is called when a _new_ single pfn is established
 762  * by vmf_insert_pfn().
 763  */
 764 static inline void track_pfn_insert(struct vm_area_struct *vma, pgprot_t *prot,
 765                                     pfn_t pfn)
 766 {
 767 }
 768
 769 /*
 770  * track_pfn_copy is called when vma that is covering the pfnmap gets
 771  * copied through copy_page_range().
 772  */
 773 static inline int track_pfn_copy(struct vm_area_struct *vma)
 774 {
 775         return 0;
 776 }
 777
 778 /*
 779  * untrack_pfn is called while unmapping a pfnmap for a region.
 780  * untrack can be called for a specific region indicated by pfn and size or
 781  * can be for the entire vma (in which case pfn, size are zero).
 782  */
 783 static inline void untrack_pfn(struct vm_area_struct *vma,
 784                                unsigned long pfn, unsigned long size)
 785 {
 786 }
 787
 788 /*
 789  * untrack_pfn_moved is called while mremapping a pfnmap for a new region.
 790  */
 791 static inline void untrack_pfn_moved(struct vm_area_struct *vma)
 792 {
 793 }
 794 #else
 795 extern int track_pfn_remap(struct vm_area_struct *vma, pgprot_t *prot,
 796                            unsigned long pfn, unsigned long addr,
 797                            unsigned long size);
 798 extern void track_pfn_insert(struct vm_area_struct *vma, pgprot_t *prot,
 799                              pfn_t pfn);
 800 extern int track_pfn_copy(struct vm_area_struct *vma);
 801 extern void untrack_pfn(struct vm_area_struct *vma, unsigned long pfn,
 802                         unsigned long size);
 803 extern void untrack_pfn_moved(struct vm_area_struct *vma);
 804 #endif
 805
 806 #ifdef __HAVE_COLOR_ZERO_PAGE
 807 static inline int is_zero_pfn(unsigned long pfn)
 808 {
 809         extern unsigned long zero_pfn;
 810         unsigned long offset_from_zero_pfn = pfn - zero_pfn;
 811         return offset_from_zero_pfn <= (zero_page_mask >> PAGE_SHIFT);
 812 }
 813
 814 #define my_zero_pfn(addr)       page_to_pfn(ZERO_PAGE(addr))
 815
 816 #else
 817 static inline int is_zero_pfn(unsigned long pfn)
 818 {
 819         extern unsigned long zero_pfn;
 820         return pfn == zero_pfn;
 821 }
 822
 823 static inline unsigned long my_zero_pfn(unsigned long addr)
 824 {
 825         extern unsigned long zero_pfn;
 826         return zero_pfn;
 827 }
 828 #endif
 829
 830 #ifdef CONFIG_MMU
 831
 832 #ifndef CONFIG_TRANSPARENT_HUGEPAGE
 833 static inline int pmd_trans_huge(pmd_t pmd)
 834 {
 835         return 0;
 836 }
 837 #ifndef pmd_write
 838 static inline int pmd_write(pmd_t pmd)
 839 {
 840         BUG();
 841         return 0;
 842 }
 843 #endif /* pmd_write */
 844 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
 845
 846 #ifndef pud_write
 847 static inline int pud_write(pud_t pud)
 848 {
 849         BUG();
 850         return 0;
 851 }
 852 #endif /* pud_write */
 853
 854 #if !defined(CONFIG_TRANSPARENT_HUGEPAGE) || \
 855         (defined(CONFIG_TRANSPARENT_HUGEPAGE) && \
 856          !defined(CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD))
 857 static inline int pud_trans_huge(pud_t pud)
 858 {
 859         return 0;
 860 }
 861 #endif
 862
 863 #ifndef pmd_read_atomic
 864 static inline pmd_t pmd_read_atomic(pmd_t *pmdp)
 865 {
 866         /*
 867          * Depend on compiler for an atomic pmd read. NOTE: this is
 868          * only going to work, if the pmdval_t isn't larger than
 869          * an unsigned long.
 870          */
 871         return *pmdp;
 872 }
 873 #endif
 874
 875 #ifndef arch_needs_pgtable_deposit
 876 #define arch_needs_pgtable_deposit() (false)
 877 #endif
 878 /*
 879  * This function is meant to be used by sites walking pagetables with
 880  * the mmap_sem hold in read mode to protect against MADV_DONTNEED and
 881  * transhuge page faults. MADV_DONTNEED can convert a transhuge pmd
 882  * into a null pmd and the transhuge page fault can convert a null pmd
 883  * into an hugepmd or into a regular pmd (if the hugepage allocation
 884  * fails). While holding the mmap_sem in read mode the pmd becomes
 885  * stable and stops changing under us only if it's not null and not a
 886  * transhuge pmd. When those races occurs and this function makes a
 887  * difference vs the standard pmd_none_or_clear_bad, the result is
 888  * undefined so behaving like if the pmd was none is safe (because it
 889  * can return none anyway). The compiler level barrier() is critically
 890  * important to compute the two checks atomically on the same pmdval.
 891  *
 892  * For 32bit kernels with a 64bit large pmd_t this automatically takes
 893  * care of reading the pmd atomically to avoid SMP race conditions
 894  * against pmd_populate() when the mmap_sem is hold for reading by the
 895  * caller (a special atomic read not done by "gcc" as in the generic
 896  * version above, is also needed when THP is disabled because the page
 897  * fault can populate the pmd from under us).
 898  */
 899 static inline int pmd_none_or_trans_huge_or_clear_bad(pmd_t *pmd)
 900 {
 901         pmd_t pmdval = pmd_read_atomic(pmd);
 902         /*
 903          * The barrier will stabilize the pmdval in a register or on
 904          * the stack so that it will stop changing under the code.
 905          *
 906          * When CONFIG_TRANSPARENT_HUGEPAGE=y on x86 32bit PAE,
 907          * pmd_read_atomic is allowed to return a not atomic pmdval
 908          * (for example pointing to an hugepage that has never been
 909          * mapped in the pmd). The below checks will only care about
 910          * the low part of the pmd with 32bit PAE x86 anyway, with the
 911          * exception of pmd_none(). So the important thing is that if
 912          * the low part of the pmd is found null, the high part will
 913          * be also null or the pmd_none() check below would be
 914          * confused.
 915          */
 916 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 917         barrier();
 918 #endif
 919         /*
 920          * !pmd_present() checks for pmd migration entries
 921          *
 922          * The complete check uses is_pmd_migration_entry() in linux/swapops.h
 923          * But using that requires moving current function and pmd_trans_unstable()
 924          * to linux/swapops.h to resovle dependency, which is too much code move.
 925          *
 926          * !pmd_present() is equivalent to is_pmd_migration_entry() currently,
 927          * because !pmd_present() pages can only be under migration not swapped
 928          * out.
 929          *
 930          * pmd_none() is preseved for future condition checks on pmd migration
 931          * entries and not confusing with this function name, although it is
 932          * redundant with !pmd_present().
 933          */
 934         if (pmd_none(pmdval) || pmd_trans_huge(pmdval) ||
 935                 (IS_ENABLED(CONFIG_ARCH_ENABLE_THP_MIGRATION) && !pmd_present(pmdval)))
 936                 return 1;
 937         if (unlikely(pmd_bad(pmdval))) {
 938                 pmd_clear_bad(pmd);
 939                 return 1;
 940         }
 941         return 0;
 942 }
 943
 944 /*
 945  * This is a noop if Transparent Hugepage Support is not built into
 946  * the kernel. Otherwise it is equivalent to
 947  * pmd_none_or_trans_huge_or_clear_bad(), and shall only be called in
 948  * places that already verified the pmd is not none and they want to
 949  * walk ptes while holding the mmap sem in read mode (write mode don't
 950  * need this). If THP is not enabled, the pmd can't go away under the
 951  * code even if MADV_DONTNEED runs, but if THP is enabled we need to
 952  * run a pmd_trans_unstable before walking the ptes after
 953  * split_huge_page_pmd returns (because it may have run when the pmd
 954  * become null, but then a page fault can map in a THP and not a
 955  * regular page).
 956  */
 957 static inline int pmd_trans_unstable(pmd_t *pmd)
 958 {
 959 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 960         return pmd_none_or_trans_huge_or_clear_bad(pmd);
 961 #else
 962         return 0;
 963 #endif
 964 }
 965
 966 #ifndef CONFIG_NUMA_BALANCING
 967 /*
 968  * Technically a PTE can be PROTNONE even when not doing NUMA balancing but
 969  * the only case the kernel cares is for NUMA balancing and is only ever set
 970  * when the VMA is accessible. For PROT_NONE VMAs, the PTEs are not marked
 971  * _PAGE_PROTNONE so by by default, implement the helper as "always no". It
 972  * is the responsibility of the caller to distinguish between PROT_NONE
 973  * protections and NUMA hinting fault protections.
 974  */
 975 static inline int pte_protnone(pte_t pte)
 976 {
 977         return 0;
 978 }
 979
 980 static inline int pmd_protnone(pmd_t pmd)
 981 {
 982         return 0;
 983 }
 984 #endif /* CONFIG_NUMA_BALANCING */
 985
 986 #endif /* CONFIG_MMU */
 987
 988 #ifdef CONFIG_HAVE_ARCH_HUGE_VMAP
 989
 990 #ifndef __PAGETABLE_P4D_FOLDED
 991 int p4d_set_huge(p4d_t *p4d, phys_addr_t addr, pgprot_t prot);
 992 int p4d_clear_huge(p4d_t *p4d);
 993 #else
 994 static inline int p4d_set_huge(p4d_t *p4d, phys_addr_t addr, pgprot_t prot)
 995 {
 996         return 0;
 997 }
 998 static inline int p4d_clear_huge(p4d_t *p4d)
 999 {
1000         return 0;
1001 }
1002 #endif /* !__PAGETABLE_P4D_FOLDED */
1003
1004 int pud_set_huge(pud_t *pud, phys_addr_t addr, pgprot_t prot);
1005 int pmd_set_huge(pmd_t *pmd, phys_addr_t addr, pgprot_t prot);
1006 int pud_clear_huge(pud_t *pud);
1007 int pmd_clear_huge(pmd_t *pmd);
1008 int pud_free_pmd_page(pud_t *pud, unsigned long addr);
1009 int pmd_free_pte_page(pmd_t *pmd, unsigned long addr);
1010 #else   /* !CONFIG_HAVE_ARCH_HUGE_VMAP */
1011 static inline int p4d_set_huge(p4d_t *p4d, phys_addr_t addr, pgprot_t prot)
1012 {
1013         return 0;
1014 }
1015 static inline int pud_set_huge(pud_t *pud, phys_addr_t addr, pgprot_t prot)
1016 {
1017         return 0;
1018 }
1019 static inline int pmd_set_huge(pmd_t *pmd, phys_addr_t addr, pgprot_t prot)
1020 {
1021         return 0;
1022 }
1023 static inline int p4d_clear_huge(p4d_t *p4d)
1024 {
1025         return 0;
1026 }
1027 static inline int pud_clear_huge(pud_t *pud)
1028 {
1029         return 0;
1030 }
1031 static inline int pmd_clear_huge(pmd_t *pmd)
1032 {
1033         return 0;
1034 }
1035 static inline int pud_free_pmd_page(pud_t *pud, unsigned long addr)
1036 {
1037         return 0;
1038 }
1039 static inline int pmd_free_pte_page(pmd_t *pmd, unsigned long addr)
1040 {
1041         return 0;
1042 }
1043 #endif  /* CONFIG_HAVE_ARCH_HUGE_VMAP */
1044
1045 #ifndef __HAVE_ARCH_FLUSH_PMD_TLB_RANGE
1046 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1047 /*
1048  * ARCHes with special requirements for evicting THP backing TLB entries can
1049  * implement this. Otherwise also, it can help optimize normal TLB flush in
1050  * THP regime. stock flush_tlb_range() typically has optimization to nuke the
1051  * entire TLB TLB if flush span is greater than a threshold, which will
1052  * likely be true for a single huge page. Thus a single thp flush will
1053  * invalidate the entire TLB which is not desitable.
1054  * e.g. see arch/arc: flush_pmd_tlb_range
1055  */
1056 #define flush_pmd_tlb_range(vma, addr, end)     flush_tlb_range(vma, addr, end)
1057 #define flush_pud_tlb_range(vma, addr, end)     flush_tlb_range(vma, addr, end)
1058 #else
1059 #define flush_pmd_tlb_range(vma, addr, end)     BUILD_BUG()
1060 #define flush_pud_tlb_range(vma, addr, end)     BUILD_BUG()
1061 #endif
1062 #endif
1063
1064 struct file;
1065 int phys_mem_access_prot_allowed(struct file *file, unsigned long pfn,
1066                         unsigned long size, pgprot_t *vma_prot);
1067
1068 #ifndef CONFIG_X86_ESPFIX64
1069 static inline void init_espfix_bsp(void) { }
1070 #endif
1071
1072 #ifndef __HAVE_ARCH_PFN_MODIFY_ALLOWED
1073 static inline bool pfn_modify_allowed(unsigned long pfn, pgprot_t prot)
1074 {
1075         return true;
1076 }
1077
1078 static inline bool arch_has_pfn_modify_check(void)
1079 {
1080         return false;
1081 }
1082 #endif /* !_HAVE_ARCH_PFN_MODIFY_ALLOWED */
1083
1084 /*
1085  * Architecture PAGE_KERNEL_* fallbacks
1086  *
1087  * Some architectures don't define certain PAGE_KERNEL_* flags. This is either
1088  * because they really don't support them, or the port needs to be updated to
1089  * reflect the required functionality. Below are a set of relatively safe
1090  * fallbacks, as best effort, which we can count on in lieu of the architectures
1091  * not defining them on their own yet.
1092  */
1093
1094 #ifndef PAGE_KERNEL_RO
1095 # define PAGE_KERNEL_RO PAGE_KERNEL
1096 #endif
1097
1098 #ifndef PAGE_KERNEL_EXEC
1099 # define PAGE_KERNEL_EXEC PAGE_KERNEL
1100 #endif
1101
1102 #endif /* !__ASSEMBLY__ */
1103
1104 #ifndef io_remap_pfn_range
1105 #define io_remap_pfn_range remap_pfn_range
1106 #endif
1107
1108 #ifndef has_transparent_hugepage
1109 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1110 #define has_transparent_hugepage() 1
1111 #else
1112 #define has_transparent_hugepage() 0
1113 #endif
1114 #endif
1115
1116 /*
1117  * On some architectures it depends on the mm if the p4d/pud or pmd
1118  * layer of the page table hierarchy is folded or not.
1119  */
1120 #ifndef mm_p4d_folded
1121 #define mm_p4d_folded(mm)       __is_defined(__PAGETABLE_P4D_FOLDED)
1122 #endif
1123
1124 #ifndef mm_pud_folded
1125 #define mm_pud_folded(mm)       __is_defined(__PAGETABLE_PUD_FOLDED)
1126 #endif
1127
1128 #ifndef mm_pmd_folded
1129 #define mm_pmd_folded(mm)       __is_defined(__PAGETABLE_PMD_FOLDED)
1130 #endif
1131
1132 #endif /* _ASM_GENERIC_PGTABLE_H */