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