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