Merge tag 'docs-4.16' of git://git.lwn.net/linux
[sfrench/cifs-2.6.git] / arch / arm64 / include / asm / pgtable.h
1 /*
2  * Copyright (C) 2012 ARM Ltd.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16 #ifndef __ASM_PGTABLE_H
17 #define __ASM_PGTABLE_H
18
19 #include <asm/bug.h>
20 #include <asm/proc-fns.h>
21
22 #include <asm/memory.h>
23 #include <asm/pgtable-hwdef.h>
24 #include <asm/pgtable-prot.h>
25
26 /*
27  * VMALLOC range.
28  *
29  * VMALLOC_START: beginning of the kernel vmalloc space
30  * VMALLOC_END: extends to the available space below vmmemmap, PCI I/O space
31  *      and fixed mappings
32  */
33 #define VMALLOC_START           (MODULES_END)
34 #define VMALLOC_END             (PAGE_OFFSET - PUD_SIZE - VMEMMAP_SIZE - SZ_64K)
35
36 #define vmemmap                 ((struct page *)VMEMMAP_START - (memstart_addr >> PAGE_SHIFT))
37
38 #define FIRST_USER_ADDRESS      0UL
39
40 #ifndef __ASSEMBLY__
41
42 #include <asm/cmpxchg.h>
43 #include <asm/fixmap.h>
44 #include <linux/mmdebug.h>
45 #include <linux/mm_types.h>
46 #include <linux/sched.h>
47
48 extern void __pte_error(const char *file, int line, unsigned long val);
49 extern void __pmd_error(const char *file, int line, unsigned long val);
50 extern void __pud_error(const char *file, int line, unsigned long val);
51 extern void __pgd_error(const char *file, int line, unsigned long val);
52
53 /*
54  * ZERO_PAGE is a global shared page that is always zero: used
55  * for zero-mapped memory areas etc..
56  */
57 extern unsigned long empty_zero_page[PAGE_SIZE / sizeof(unsigned long)];
58 #define ZERO_PAGE(vaddr)        phys_to_page(__pa_symbol(empty_zero_page))
59
60 #define pte_ERROR(pte)          __pte_error(__FILE__, __LINE__, pte_val(pte))
61
62 /*
63  * Macros to convert between a physical address and its placement in a
64  * page table entry, taking care of 52-bit addresses.
65  */
66 #ifdef CONFIG_ARM64_PA_BITS_52
67 #define __pte_to_phys(pte)      \
68         ((pte_val(pte) & PTE_ADDR_LOW) | ((pte_val(pte) & PTE_ADDR_HIGH) << 36))
69 #define __phys_to_pte_val(phys) (((phys) | ((phys) >> 36)) & PTE_ADDR_MASK)
70 #else
71 #define __pte_to_phys(pte)      (pte_val(pte) & PTE_ADDR_MASK)
72 #define __phys_to_pte_val(phys) (phys)
73 #endif
74
75 #define pte_pfn(pte)            (__pte_to_phys(pte) >> PAGE_SHIFT)
76 #define pfn_pte(pfn,prot)       \
77         __pte(__phys_to_pte_val((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot))
78
79 #define pte_none(pte)           (!pte_val(pte))
80 #define pte_clear(mm,addr,ptep) set_pte(ptep, __pte(0))
81 #define pte_page(pte)           (pfn_to_page(pte_pfn(pte)))
82
83 /*
84  * The following only work if pte_present(). Undefined behaviour otherwise.
85  */
86 #define pte_present(pte)        (!!(pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)))
87 #define pte_young(pte)          (!!(pte_val(pte) & PTE_AF))
88 #define pte_special(pte)        (!!(pte_val(pte) & PTE_SPECIAL))
89 #define pte_write(pte)          (!!(pte_val(pte) & PTE_WRITE))
90 #define pte_user_exec(pte)      (!(pte_val(pte) & PTE_UXN))
91 #define pte_cont(pte)           (!!(pte_val(pte) & PTE_CONT))
92
93 #define pte_cont_addr_end(addr, end)                                            \
94 ({      unsigned long __boundary = ((addr) + CONT_PTE_SIZE) & CONT_PTE_MASK;    \
95         (__boundary - 1 < (end) - 1) ? __boundary : (end);                      \
96 })
97
98 #define pmd_cont_addr_end(addr, end)                                            \
99 ({      unsigned long __boundary = ((addr) + CONT_PMD_SIZE) & CONT_PMD_MASK;    \
100         (__boundary - 1 < (end) - 1) ? __boundary : (end);                      \
101 })
102
103 #define pte_hw_dirty(pte)       (pte_write(pte) && !(pte_val(pte) & PTE_RDONLY))
104 #define pte_sw_dirty(pte)       (!!(pte_val(pte) & PTE_DIRTY))
105 #define pte_dirty(pte)          (pte_sw_dirty(pte) || pte_hw_dirty(pte))
106
107 #define pte_valid(pte)          (!!(pte_val(pte) & PTE_VALID))
108 /*
109  * Execute-only user mappings do not have the PTE_USER bit set. All valid
110  * kernel mappings have the PTE_UXN bit set.
111  */
112 #define pte_valid_not_user(pte) \
113         ((pte_val(pte) & (PTE_VALID | PTE_USER | PTE_UXN)) == (PTE_VALID | PTE_UXN))
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) other than user execute-only which do not have the
130  * PTE_USER bit set. PROT_NONE mappings do not have the PTE_VALID bit 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 void set_pte(pte_t *ptep, pte_t pte)
220 {
221         *ptep = pte;
222
223         /*
224          * Only if the new pte is valid and kernel, otherwise TLB maintenance
225          * or update_mmu_cache() have the necessary barriers.
226          */
227         if (pte_valid_not_user(pte)) {
228                 dsb(ishst);
229                 isb();
230         }
231 }
232
233 extern void __sync_icache_dcache(pte_t pteval, unsigned long addr);
234
235 /*
236  * PTE bits configuration in the presence of hardware Dirty Bit Management
237  * (PTE_WRITE == PTE_DBM):
238  *
239  * Dirty  Writable | PTE_RDONLY  PTE_WRITE  PTE_DIRTY (sw)
240  *   0      0      |   1           0          0
241  *   0      1      |   1           1          0
242  *   1      0      |   1           0          1
243  *   1      1      |   0           1          x
244  *
245  * When hardware DBM is not present, the sofware PTE_DIRTY bit is updated via
246  * the page fault mechanism. Checking the dirty status of a pte becomes:
247  *
248  *   PTE_DIRTY || (PTE_WRITE && !PTE_RDONLY)
249  */
250 static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
251                               pte_t *ptep, pte_t pte)
252 {
253         if (pte_present(pte) && pte_user_exec(pte) && !pte_special(pte))
254                 __sync_icache_dcache(pte, addr);
255
256         /*
257          * If the existing pte is valid, check for potential race with
258          * hardware updates of the pte (ptep_set_access_flags safely changes
259          * valid ptes without going through an invalid entry).
260          */
261         if (IS_ENABLED(CONFIG_DEBUG_VM) && pte_valid(*ptep) && pte_valid(pte) &&
262            (mm == current->active_mm || atomic_read(&mm->mm_users) > 1)) {
263                 VM_WARN_ONCE(!pte_young(pte),
264                              "%s: racy access flag clearing: 0x%016llx -> 0x%016llx",
265                              __func__, pte_val(*ptep), pte_val(pte));
266                 VM_WARN_ONCE(pte_write(*ptep) && !pte_dirty(pte),
267                              "%s: racy dirty state clearing: 0x%016llx -> 0x%016llx",
268                              __func__, pte_val(*ptep), pte_val(pte));
269         }
270
271         set_pte(ptep, pte);
272 }
273
274 #define __HAVE_ARCH_PTE_SAME
275 static inline int pte_same(pte_t pte_a, pte_t pte_b)
276 {
277         pteval_t lhs, rhs;
278
279         lhs = pte_val(pte_a);
280         rhs = pte_val(pte_b);
281
282         if (pte_present(pte_a))
283                 lhs &= ~PTE_RDONLY;
284
285         if (pte_present(pte_b))
286                 rhs &= ~PTE_RDONLY;
287
288         return (lhs == rhs);
289 }
290
291 /*
292  * Huge pte definitions.
293  */
294 #define pte_huge(pte)           (!(pte_val(pte) & PTE_TABLE_BIT))
295 #define pte_mkhuge(pte)         (__pte(pte_val(pte) & ~PTE_TABLE_BIT))
296
297 /*
298  * Hugetlb definitions.
299  */
300 #define HUGE_MAX_HSTATE         4
301 #define HPAGE_SHIFT             PMD_SHIFT
302 #define HPAGE_SIZE              (_AC(1, UL) << HPAGE_SHIFT)
303 #define HPAGE_MASK              (~(HPAGE_SIZE - 1))
304 #define HUGETLB_PAGE_ORDER      (HPAGE_SHIFT - PAGE_SHIFT)
305
306 #define __HAVE_ARCH_PTE_SPECIAL
307
308 static inline pte_t pgd_pte(pgd_t pgd)
309 {
310         return __pte(pgd_val(pgd));
311 }
312
313 static inline pte_t pud_pte(pud_t pud)
314 {
315         return __pte(pud_val(pud));
316 }
317
318 static inline pmd_t pud_pmd(pud_t pud)
319 {
320         return __pmd(pud_val(pud));
321 }
322
323 static inline pte_t pmd_pte(pmd_t pmd)
324 {
325         return __pte(pmd_val(pmd));
326 }
327
328 static inline pmd_t pte_pmd(pte_t pte)
329 {
330         return __pmd(pte_val(pte));
331 }
332
333 static inline pgprot_t mk_sect_prot(pgprot_t prot)
334 {
335         return __pgprot(pgprot_val(prot) & ~PTE_TABLE_BIT);
336 }
337
338 #ifdef CONFIG_NUMA_BALANCING
339 /*
340  * See the comment in include/asm-generic/pgtable.h
341  */
342 static inline int pte_protnone(pte_t pte)
343 {
344         return (pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)) == PTE_PROT_NONE;
345 }
346
347 static inline int pmd_protnone(pmd_t pmd)
348 {
349         return pte_protnone(pmd_pte(pmd));
350 }
351 #endif
352
353 /*
354  * THP definitions.
355  */
356
357 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
358 #define pmd_trans_huge(pmd)     (pmd_val(pmd) && !(pmd_val(pmd) & PMD_TABLE_BIT))
359 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
360
361 #define pmd_present(pmd)        pte_present(pmd_pte(pmd))
362 #define pmd_dirty(pmd)          pte_dirty(pmd_pte(pmd))
363 #define pmd_young(pmd)          pte_young(pmd_pte(pmd))
364 #define pmd_wrprotect(pmd)      pte_pmd(pte_wrprotect(pmd_pte(pmd)))
365 #define pmd_mkold(pmd)          pte_pmd(pte_mkold(pmd_pte(pmd)))
366 #define pmd_mkwrite(pmd)        pte_pmd(pte_mkwrite(pmd_pte(pmd)))
367 #define pmd_mkclean(pmd)        pte_pmd(pte_mkclean(pmd_pte(pmd)))
368 #define pmd_mkdirty(pmd)        pte_pmd(pte_mkdirty(pmd_pte(pmd)))
369 #define pmd_mkyoung(pmd)        pte_pmd(pte_mkyoung(pmd_pte(pmd)))
370 #define pmd_mknotpresent(pmd)   (__pmd(pmd_val(pmd) & ~PMD_SECT_VALID))
371
372 #define pmd_thp_or_huge(pmd)    (pmd_huge(pmd) || pmd_trans_huge(pmd))
373
374 #define pmd_write(pmd)          pte_write(pmd_pte(pmd))
375
376 #define pmd_mkhuge(pmd)         (__pmd(pmd_val(pmd) & ~PMD_TABLE_BIT))
377
378 #define __pmd_to_phys(pmd)      __pte_to_phys(pmd_pte(pmd))
379 #define __phys_to_pmd_val(phys) __phys_to_pte_val(phys)
380 #define pmd_pfn(pmd)            ((__pmd_to_phys(pmd) & PMD_MASK) >> PAGE_SHIFT)
381 #define pfn_pmd(pfn,prot)       __pmd(__phys_to_pmd_val((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot))
382 #define mk_pmd(page,prot)       pfn_pmd(page_to_pfn(page),prot)
383
384 #define pud_write(pud)          pte_write(pud_pte(pud))
385
386 #define __pud_to_phys(pud)      __pte_to_phys(pud_pte(pud))
387 #define __phys_to_pud_val(phys) __phys_to_pte_val(phys)
388 #define pud_pfn(pud)            ((__pud_to_phys(pud) & PUD_MASK) >> PAGE_SHIFT)
389 #define pfn_pud(pfn,prot)       __pud(__phys_to_pud_val((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot))
390
391 #define set_pmd_at(mm, addr, pmdp, pmd) set_pte_at(mm, addr, (pte_t *)pmdp, pmd_pte(pmd))
392
393 #define __pgd_to_phys(pgd)      __pte_to_phys(pgd_pte(pgd))
394 #define __phys_to_pgd_val(phys) __phys_to_pte_val(phys)
395
396 #define __pgprot_modify(prot,mask,bits) \
397         __pgprot((pgprot_val(prot) & ~(mask)) | (bits))
398
399 /*
400  * Mark the prot value as uncacheable and unbufferable.
401  */
402 #define pgprot_noncached(prot) \
403         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRnE) | PTE_PXN | PTE_UXN)
404 #define pgprot_writecombine(prot) \
405         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_NORMAL_NC) | PTE_PXN | PTE_UXN)
406 #define pgprot_device(prot) \
407         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRE) | PTE_PXN | PTE_UXN)
408 #define __HAVE_PHYS_MEM_ACCESS_PROT
409 struct file;
410 extern pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
411                                      unsigned long size, pgprot_t vma_prot);
412
413 #define pmd_none(pmd)           (!pmd_val(pmd))
414
415 #define pmd_bad(pmd)            (!(pmd_val(pmd) & PMD_TABLE_BIT))
416
417 #define pmd_table(pmd)          ((pmd_val(pmd) & PMD_TYPE_MASK) == \
418                                  PMD_TYPE_TABLE)
419 #define pmd_sect(pmd)           ((pmd_val(pmd) & PMD_TYPE_MASK) == \
420                                  PMD_TYPE_SECT)
421
422 #if defined(CONFIG_ARM64_64K_PAGES) || CONFIG_PGTABLE_LEVELS < 3
423 #define pud_sect(pud)           (0)
424 #define pud_table(pud)          (1)
425 #else
426 #define pud_sect(pud)           ((pud_val(pud) & PUD_TYPE_MASK) == \
427                                  PUD_TYPE_SECT)
428 #define pud_table(pud)          ((pud_val(pud) & PUD_TYPE_MASK) == \
429                                  PUD_TYPE_TABLE)
430 #endif
431
432 static inline void set_pmd(pmd_t *pmdp, pmd_t pmd)
433 {
434         *pmdp = pmd;
435         dsb(ishst);
436         isb();
437 }
438
439 static inline void pmd_clear(pmd_t *pmdp)
440 {
441         set_pmd(pmdp, __pmd(0));
442 }
443
444 static inline phys_addr_t pmd_page_paddr(pmd_t pmd)
445 {
446         return __pmd_to_phys(pmd);
447 }
448
449 /* Find an entry in the third-level page table. */
450 #define pte_index(addr)         (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
451
452 #define pte_offset_phys(dir,addr)       (pmd_page_paddr(READ_ONCE(*(dir))) + pte_index(addr) * sizeof(pte_t))
453 #define pte_offset_kernel(dir,addr)     ((pte_t *)__va(pte_offset_phys((dir), (addr))))
454
455 #define pte_offset_map(dir,addr)        pte_offset_kernel((dir), (addr))
456 #define pte_offset_map_nested(dir,addr) pte_offset_kernel((dir), (addr))
457 #define pte_unmap(pte)                  do { } while (0)
458 #define pte_unmap_nested(pte)           do { } while (0)
459
460 #define pte_set_fixmap(addr)            ((pte_t *)set_fixmap_offset(FIX_PTE, addr))
461 #define pte_set_fixmap_offset(pmd, addr)        pte_set_fixmap(pte_offset_phys(pmd, addr))
462 #define pte_clear_fixmap()              clear_fixmap(FIX_PTE)
463
464 #define pmd_page(pmd)           pfn_to_page(__phys_to_pfn(__pmd_to_phys(pmd)))
465
466 /* use ONLY for statically allocated translation tables */
467 #define pte_offset_kimg(dir,addr)       ((pte_t *)__phys_to_kimg(pte_offset_phys((dir), (addr))))
468
469 /*
470  * Conversion functions: convert a page and protection to a page entry,
471  * and a page entry and page directory to the page they refer to.
472  */
473 #define mk_pte(page,prot)       pfn_pte(page_to_pfn(page),prot)
474
475 #if CONFIG_PGTABLE_LEVELS > 2
476
477 #define pmd_ERROR(pmd)          __pmd_error(__FILE__, __LINE__, pmd_val(pmd))
478
479 #define pud_none(pud)           (!pud_val(pud))
480 #define pud_bad(pud)            (!(pud_val(pud) & PUD_TABLE_BIT))
481 #define pud_present(pud)        pte_present(pud_pte(pud))
482
483 static inline void set_pud(pud_t *pudp, pud_t pud)
484 {
485         *pudp = pud;
486         dsb(ishst);
487         isb();
488 }
489
490 static inline void pud_clear(pud_t *pudp)
491 {
492         set_pud(pudp, __pud(0));
493 }
494
495 static inline phys_addr_t pud_page_paddr(pud_t pud)
496 {
497         return __pud_to_phys(pud);
498 }
499
500 /* Find an entry in the second-level page table. */
501 #define pmd_index(addr)         (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1))
502
503 #define pmd_offset_phys(dir, addr)      (pud_page_paddr(*(dir)) + pmd_index(addr) * sizeof(pmd_t))
504 #define pmd_offset(dir, addr)           ((pmd_t *)__va(pmd_offset_phys((dir), (addr))))
505
506 #define pmd_set_fixmap(addr)            ((pmd_t *)set_fixmap_offset(FIX_PMD, addr))
507 #define pmd_set_fixmap_offset(pud, addr)        pmd_set_fixmap(pmd_offset_phys(pud, addr))
508 #define pmd_clear_fixmap()              clear_fixmap(FIX_PMD)
509
510 #define pud_page(pud)           pfn_to_page(__phys_to_pfn(__pud_to_phys(pud)))
511
512 /* use ONLY for statically allocated translation tables */
513 #define pmd_offset_kimg(dir,addr)       ((pmd_t *)__phys_to_kimg(pmd_offset_phys((dir), (addr))))
514
515 #else
516
517 #define pud_page_paddr(pud)     ({ BUILD_BUG(); 0; })
518
519 /* Match pmd_offset folding in <asm/generic/pgtable-nopmd.h> */
520 #define pmd_set_fixmap(addr)            NULL
521 #define pmd_set_fixmap_offset(pudp, addr)       ((pmd_t *)pudp)
522 #define pmd_clear_fixmap()
523
524 #define pmd_offset_kimg(dir,addr)       ((pmd_t *)dir)
525
526 #endif  /* CONFIG_PGTABLE_LEVELS > 2 */
527
528 #if CONFIG_PGTABLE_LEVELS > 3
529
530 #define pud_ERROR(pud)          __pud_error(__FILE__, __LINE__, pud_val(pud))
531
532 #define pgd_none(pgd)           (!pgd_val(pgd))
533 #define pgd_bad(pgd)            (!(pgd_val(pgd) & 2))
534 #define pgd_present(pgd)        (pgd_val(pgd))
535
536 static inline void set_pgd(pgd_t *pgdp, pgd_t pgd)
537 {
538         *pgdp = pgd;
539         dsb(ishst);
540 }
541
542 static inline void pgd_clear(pgd_t *pgdp)
543 {
544         set_pgd(pgdp, __pgd(0));
545 }
546
547 static inline phys_addr_t pgd_page_paddr(pgd_t pgd)
548 {
549         return __pgd_to_phys(pgd);
550 }
551
552 /* Find an entry in the frst-level page table. */
553 #define pud_index(addr)         (((addr) >> PUD_SHIFT) & (PTRS_PER_PUD - 1))
554
555 #define pud_offset_phys(dir, addr)      (pgd_page_paddr(*(dir)) + pud_index(addr) * sizeof(pud_t))
556 #define pud_offset(dir, addr)           ((pud_t *)__va(pud_offset_phys((dir), (addr))))
557
558 #define pud_set_fixmap(addr)            ((pud_t *)set_fixmap_offset(FIX_PUD, addr))
559 #define pud_set_fixmap_offset(pgd, addr)        pud_set_fixmap(pud_offset_phys(pgd, addr))
560 #define pud_clear_fixmap()              clear_fixmap(FIX_PUD)
561
562 #define pgd_page(pgd)           pfn_to_page(__phys_to_pfn(__pgd_to_phys(pgd)))
563
564 /* use ONLY for statically allocated translation tables */
565 #define pud_offset_kimg(dir,addr)       ((pud_t *)__phys_to_kimg(pud_offset_phys((dir), (addr))))
566
567 #else
568
569 #define pgd_page_paddr(pgd)     ({ BUILD_BUG(); 0;})
570
571 /* Match pud_offset folding in <asm/generic/pgtable-nopud.h> */
572 #define pud_set_fixmap(addr)            NULL
573 #define pud_set_fixmap_offset(pgdp, addr)       ((pud_t *)pgdp)
574 #define pud_clear_fixmap()
575
576 #define pud_offset_kimg(dir,addr)       ((pud_t *)dir)
577
578 #endif  /* CONFIG_PGTABLE_LEVELS > 3 */
579
580 #define pgd_ERROR(pgd)          __pgd_error(__FILE__, __LINE__, pgd_val(pgd))
581
582 /* to find an entry in a page-table-directory */
583 #define pgd_index(addr)         (((addr) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
584
585 #define pgd_offset_raw(pgd, addr)       ((pgd) + pgd_index(addr))
586
587 #define pgd_offset(mm, addr)    (pgd_offset_raw((mm)->pgd, (addr)))
588
589 /* to find an entry in a kernel page-table-directory */
590 #define pgd_offset_k(addr)      pgd_offset(&init_mm, addr)
591
592 #define pgd_set_fixmap(addr)    ((pgd_t *)set_fixmap_offset(FIX_PGD, addr))
593 #define pgd_clear_fixmap()      clear_fixmap(FIX_PGD)
594
595 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
596 {
597         const pteval_t mask = PTE_USER | PTE_PXN | PTE_UXN | PTE_RDONLY |
598                               PTE_PROT_NONE | PTE_VALID | PTE_WRITE;
599         /* preserve the hardware dirty information */
600         if (pte_hw_dirty(pte))
601                 pte = pte_mkdirty(pte);
602         pte_val(pte) = (pte_val(pte) & ~mask) | (pgprot_val(newprot) & mask);
603         return pte;
604 }
605
606 static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
607 {
608         return pte_pmd(pte_modify(pmd_pte(pmd), newprot));
609 }
610
611 #define __HAVE_ARCH_PTEP_SET_ACCESS_FLAGS
612 extern int ptep_set_access_flags(struct vm_area_struct *vma,
613                                  unsigned long address, pte_t *ptep,
614                                  pte_t entry, int dirty);
615
616 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
617 #define __HAVE_ARCH_PMDP_SET_ACCESS_FLAGS
618 static inline int pmdp_set_access_flags(struct vm_area_struct *vma,
619                                         unsigned long address, pmd_t *pmdp,
620                                         pmd_t entry, int dirty)
621 {
622         return ptep_set_access_flags(vma, address, (pte_t *)pmdp, pmd_pte(entry), dirty);
623 }
624 #endif
625
626 /*
627  * Atomic pte/pmd modifications.
628  */
629 #define __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
630 static inline int __ptep_test_and_clear_young(pte_t *ptep)
631 {
632         pte_t old_pte, pte;
633
634         pte = READ_ONCE(*ptep);
635         do {
636                 old_pte = pte;
637                 pte = pte_mkold(pte);
638                 pte_val(pte) = cmpxchg_relaxed(&pte_val(*ptep),
639                                                pte_val(old_pte), pte_val(pte));
640         } while (pte_val(pte) != pte_val(old_pte));
641
642         return pte_young(pte);
643 }
644
645 static inline int ptep_test_and_clear_young(struct vm_area_struct *vma,
646                                             unsigned long address,
647                                             pte_t *ptep)
648 {
649         return __ptep_test_and_clear_young(ptep);
650 }
651
652 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
653 #define __HAVE_ARCH_PMDP_TEST_AND_CLEAR_YOUNG
654 static inline int pmdp_test_and_clear_young(struct vm_area_struct *vma,
655                                             unsigned long address,
656                                             pmd_t *pmdp)
657 {
658         return ptep_test_and_clear_young(vma, address, (pte_t *)pmdp);
659 }
660 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
661
662 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR
663 static inline pte_t ptep_get_and_clear(struct mm_struct *mm,
664                                        unsigned long address, pte_t *ptep)
665 {
666         return __pte(xchg_relaxed(&pte_val(*ptep), 0));
667 }
668
669 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
670 #define __HAVE_ARCH_PMDP_HUGE_GET_AND_CLEAR
671 static inline pmd_t pmdp_huge_get_and_clear(struct mm_struct *mm,
672                                             unsigned long address, pmd_t *pmdp)
673 {
674         return pte_pmd(ptep_get_and_clear(mm, address, (pte_t *)pmdp));
675 }
676 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
677
678 /*
679  * ptep_set_wrprotect - mark read-only while trasferring potential hardware
680  * dirty status (PTE_DBM && !PTE_RDONLY) to the software PTE_DIRTY bit.
681  */
682 #define __HAVE_ARCH_PTEP_SET_WRPROTECT
683 static inline void ptep_set_wrprotect(struct mm_struct *mm, unsigned long address, pte_t *ptep)
684 {
685         pte_t old_pte, pte;
686
687         pte = READ_ONCE(*ptep);
688         do {
689                 old_pte = pte;
690                 /*
691                  * If hardware-dirty (PTE_WRITE/DBM bit set and PTE_RDONLY
692                  * clear), set the PTE_DIRTY bit.
693                  */
694                 if (pte_hw_dirty(pte))
695                         pte = pte_mkdirty(pte);
696                 pte = pte_wrprotect(pte);
697                 pte_val(pte) = cmpxchg_relaxed(&pte_val(*ptep),
698                                                pte_val(old_pte), pte_val(pte));
699         } while (pte_val(pte) != pte_val(old_pte));
700 }
701
702 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
703 #define __HAVE_ARCH_PMDP_SET_WRPROTECT
704 static inline void pmdp_set_wrprotect(struct mm_struct *mm,
705                                       unsigned long address, pmd_t *pmdp)
706 {
707         ptep_set_wrprotect(mm, address, (pte_t *)pmdp);
708 }
709
710 #define pmdp_establish pmdp_establish
711 static inline pmd_t pmdp_establish(struct vm_area_struct *vma,
712                 unsigned long address, pmd_t *pmdp, pmd_t pmd)
713 {
714         return __pmd(xchg_relaxed(&pmd_val(*pmdp), pmd_val(pmd)));
715 }
716 #endif
717
718 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
719 extern pgd_t swapper_pg_end[];
720 extern pgd_t idmap_pg_dir[PTRS_PER_PGD];
721 extern pgd_t tramp_pg_dir[PTRS_PER_PGD];
722
723 /*
724  * Encode and decode a swap entry:
725  *      bits 0-1:       present (must be zero)
726  *      bits 2-7:       swap type
727  *      bits 8-57:      swap offset
728  *      bit  58:        PTE_PROT_NONE (must be zero)
729  */
730 #define __SWP_TYPE_SHIFT        2
731 #define __SWP_TYPE_BITS         6
732 #define __SWP_OFFSET_BITS       50
733 #define __SWP_TYPE_MASK         ((1 << __SWP_TYPE_BITS) - 1)
734 #define __SWP_OFFSET_SHIFT      (__SWP_TYPE_BITS + __SWP_TYPE_SHIFT)
735 #define __SWP_OFFSET_MASK       ((1UL << __SWP_OFFSET_BITS) - 1)
736
737 #define __swp_type(x)           (((x).val >> __SWP_TYPE_SHIFT) & __SWP_TYPE_MASK)
738 #define __swp_offset(x)         (((x).val >> __SWP_OFFSET_SHIFT) & __SWP_OFFSET_MASK)
739 #define __swp_entry(type,offset) ((swp_entry_t) { ((type) << __SWP_TYPE_SHIFT) | ((offset) << __SWP_OFFSET_SHIFT) })
740
741 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
742 #define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
743
744 /*
745  * Ensure that there are not more swap files than can be encoded in the kernel
746  * PTEs.
747  */
748 #define MAX_SWAPFILES_CHECK() BUILD_BUG_ON(MAX_SWAPFILES_SHIFT > __SWP_TYPE_BITS)
749
750 extern int kern_addr_valid(unsigned long addr);
751
752 #include <asm-generic/pgtable.h>
753
754 void pgd_cache_init(void);
755 #define pgtable_cache_init      pgd_cache_init
756
757 /*
758  * On AArch64, the cache coherency is handled via the set_pte_at() function.
759  */
760 static inline void update_mmu_cache(struct vm_area_struct *vma,
761                                     unsigned long addr, pte_t *ptep)
762 {
763         /*
764          * We don't do anything here, so there's a very small chance of
765          * us retaking a user fault which we just fixed up. The alternative
766          * is doing a dsb(ishst), but that penalises the fastpath.
767          */
768 }
769
770 #define update_mmu_cache_pmd(vma, address, pmd) do { } while (0)
771
772 #define kc_vaddr_to_offset(v)   ((v) & ~VA_START)
773 #define kc_offset_to_vaddr(o)   ((o) | VA_START)
774
775 #ifdef CONFIG_ARM64_PA_BITS_52
776 #define phys_to_ttbr(addr)      (((addr) | ((addr) >> 46)) & TTBR_BADDR_MASK_52)
777 #else
778 #define phys_to_ttbr(addr)      (addr)
779 #endif
780
781 #endif /* !__ASSEMBLY__ */
782
783 #endif /* __ASM_PGTABLE_H */