arm64: Add support for hardware updates of the access and dirty pte bits
[cascardo/linux.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
25 /*
26  * Software defined PTE bits definition.
27  */
28 #define PTE_VALID               (_AT(pteval_t, 1) << 0)
29 #define PTE_DIRTY               (_AT(pteval_t, 1) << 55)
30 #define PTE_SPECIAL             (_AT(pteval_t, 1) << 56)
31 #ifdef CONFIG_ARM64_HW_AFDBM
32 #define PTE_WRITE               (PTE_DBM)                /* same as DBM */
33 #else
34 #define PTE_WRITE               (_AT(pteval_t, 1) << 57)
35 #endif
36 #define PTE_PROT_NONE           (_AT(pteval_t, 1) << 58) /* only when !PTE_VALID */
37
38 /*
39  * VMALLOC and SPARSEMEM_VMEMMAP ranges.
40  *
41  * VMEMAP_SIZE: allows the whole VA space to be covered by a struct page array
42  *      (rounded up to PUD_SIZE).
43  * VMALLOC_START: beginning of the kernel VA space
44  * VMALLOC_END: extends to the available space below vmmemmap, PCI I/O space,
45  *      fixed mappings and modules
46  */
47 #define VMEMMAP_SIZE            ALIGN((1UL << (VA_BITS - PAGE_SHIFT)) * sizeof(struct page), PUD_SIZE)
48 #define VMALLOC_START           (UL(0xffffffffffffffff) << VA_BITS)
49 #define VMALLOC_END             (PAGE_OFFSET - PUD_SIZE - VMEMMAP_SIZE - SZ_64K)
50
51 #define vmemmap                 ((struct page *)(VMALLOC_END + SZ_64K))
52
53 #define FIRST_USER_ADDRESS      0UL
54
55 #ifndef __ASSEMBLY__
56
57 #include <linux/mmdebug.h>
58
59 extern void __pte_error(const char *file, int line, unsigned long val);
60 extern void __pmd_error(const char *file, int line, unsigned long val);
61 extern void __pud_error(const char *file, int line, unsigned long val);
62 extern void __pgd_error(const char *file, int line, unsigned long val);
63
64 #ifdef CONFIG_SMP
65 #define PROT_DEFAULT            (PTE_TYPE_PAGE | PTE_AF | PTE_SHARED)
66 #define PROT_SECT_DEFAULT       (PMD_TYPE_SECT | PMD_SECT_AF | PMD_SECT_S)
67 #else
68 #define PROT_DEFAULT            (PTE_TYPE_PAGE | PTE_AF)
69 #define PROT_SECT_DEFAULT       (PMD_TYPE_SECT | PMD_SECT_AF)
70 #endif
71
72 #define PROT_DEVICE_nGnRE       (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_DEVICE_nGnRE))
73 #define PROT_NORMAL_NC          (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL_NC))
74 #define PROT_NORMAL             (PROT_DEFAULT | PTE_PXN | PTE_UXN | PTE_ATTRINDX(MT_NORMAL))
75
76 #define PROT_SECT_DEVICE_nGnRE  (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_DEVICE_nGnRE))
77 #define PROT_SECT_NORMAL        (PROT_SECT_DEFAULT | PMD_SECT_PXN | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
78 #define PROT_SECT_NORMAL_EXEC   (PROT_SECT_DEFAULT | PMD_SECT_UXN | PMD_ATTRINDX(MT_NORMAL))
79
80 #define _PAGE_DEFAULT           (PROT_DEFAULT | PTE_ATTRINDX(MT_NORMAL))
81
82 #define PAGE_KERNEL             __pgprot(_PAGE_DEFAULT | PTE_PXN | PTE_UXN | PTE_DIRTY | PTE_WRITE)
83 #define PAGE_KERNEL_EXEC        __pgprot(_PAGE_DEFAULT | PTE_UXN | PTE_DIRTY | PTE_WRITE)
84
85 #define PAGE_HYP                __pgprot(_PAGE_DEFAULT | PTE_HYP)
86 #define PAGE_HYP_DEVICE         __pgprot(PROT_DEVICE_nGnRE | PTE_HYP)
87
88 #define PAGE_S2                 __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_NORMAL) | PTE_S2_RDONLY)
89 #define PAGE_S2_DEVICE          __pgprot(PROT_DEFAULT | PTE_S2_MEMATTR(MT_S2_DEVICE_nGnRE) | PTE_S2_RDONLY | PTE_UXN)
90
91 #define PAGE_NONE               __pgprot(((_PAGE_DEFAULT) & ~PTE_TYPE_MASK) | PTE_PROT_NONE | PTE_PXN | PTE_UXN)
92 #define PAGE_SHARED             __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN | PTE_WRITE)
93 #define PAGE_SHARED_EXEC        __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_WRITE)
94 #define PAGE_COPY               __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
95 #define PAGE_COPY_EXEC          __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
96 #define PAGE_READONLY           __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN | PTE_UXN)
97 #define PAGE_READONLY_EXEC      __pgprot(_PAGE_DEFAULT | PTE_USER | PTE_NG | PTE_PXN)
98
99 #define __P000  PAGE_NONE
100 #define __P001  PAGE_READONLY
101 #define __P010  PAGE_COPY
102 #define __P011  PAGE_COPY
103 #define __P100  PAGE_READONLY_EXEC
104 #define __P101  PAGE_READONLY_EXEC
105 #define __P110  PAGE_COPY_EXEC
106 #define __P111  PAGE_COPY_EXEC
107
108 #define __S000  PAGE_NONE
109 #define __S001  PAGE_READONLY
110 #define __S010  PAGE_SHARED
111 #define __S011  PAGE_SHARED
112 #define __S100  PAGE_READONLY_EXEC
113 #define __S101  PAGE_READONLY_EXEC
114 #define __S110  PAGE_SHARED_EXEC
115 #define __S111  PAGE_SHARED_EXEC
116
117 /*
118  * ZERO_PAGE is a global shared page that is always zero: used
119  * for zero-mapped memory areas etc..
120  */
121 extern struct page *empty_zero_page;
122 #define ZERO_PAGE(vaddr)        (empty_zero_page)
123
124 #define pte_ERROR(pte)          __pte_error(__FILE__, __LINE__, pte_val(pte))
125
126 #define pte_pfn(pte)            ((pte_val(pte) & PHYS_MASK) >> PAGE_SHIFT)
127
128 #define pfn_pte(pfn,prot)       (__pte(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
129
130 #define pte_none(pte)           (!pte_val(pte))
131 #define pte_clear(mm,addr,ptep) set_pte(ptep, __pte(0))
132 #define pte_page(pte)           (pfn_to_page(pte_pfn(pte)))
133
134 /* Find an entry in the third-level page table. */
135 #define pte_index(addr)         (((addr) >> PAGE_SHIFT) & (PTRS_PER_PTE - 1))
136
137 #define pte_offset_kernel(dir,addr)     (pmd_page_vaddr(*(dir)) + pte_index(addr))
138
139 #define pte_offset_map(dir,addr)        pte_offset_kernel((dir), (addr))
140 #define pte_offset_map_nested(dir,addr) pte_offset_kernel((dir), (addr))
141 #define pte_unmap(pte)                  do { } while (0)
142 #define pte_unmap_nested(pte)           do { } while (0)
143
144 /*
145  * The following only work if pte_present(). Undefined behaviour otherwise.
146  */
147 #define pte_present(pte)        (!!(pte_val(pte) & (PTE_VALID | PTE_PROT_NONE)))
148 #define pte_young(pte)          (!!(pte_val(pte) & PTE_AF))
149 #define pte_special(pte)        (!!(pte_val(pte) & PTE_SPECIAL))
150 #define pte_write(pte)          (!!(pte_val(pte) & PTE_WRITE))
151 #define pte_exec(pte)           (!(pte_val(pte) & PTE_UXN))
152
153 #ifdef CONFIG_ARM64_HW_AFDBM
154 #define pte_hw_dirty(pte)       (!(pte_val(pte) & PTE_RDONLY))
155 #else
156 #define pte_hw_dirty(pte)       (0)
157 #endif
158 #define pte_sw_dirty(pte)       (!!(pte_val(pte) & PTE_DIRTY))
159 #define pte_dirty(pte)          (pte_sw_dirty(pte) || pte_hw_dirty(pte))
160
161 #define pte_valid(pte)          (!!(pte_val(pte) && PTE_VALID))
162 #define pte_valid_user(pte) \
163         ((pte_val(pte) & (PTE_VALID | PTE_USER)) == (PTE_VALID | PTE_USER))
164 #define pte_valid_not_user(pte) \
165         ((pte_val(pte) & (PTE_VALID | PTE_USER)) == PTE_VALID)
166
167 static inline pte_t clear_pte_bit(pte_t pte, pgprot_t prot)
168 {
169         pte_val(pte) &= ~pgprot_val(prot);
170         return pte;
171 }
172
173 static inline pte_t set_pte_bit(pte_t pte, pgprot_t prot)
174 {
175         pte_val(pte) |= pgprot_val(prot);
176         return pte;
177 }
178
179 static inline pte_t pte_wrprotect(pte_t pte)
180 {
181         return clear_pte_bit(pte, __pgprot(PTE_WRITE));
182 }
183
184 static inline pte_t pte_mkwrite(pte_t pte)
185 {
186         return set_pte_bit(pte, __pgprot(PTE_WRITE));
187 }
188
189 static inline pte_t pte_mkclean(pte_t pte)
190 {
191         return clear_pte_bit(pte, __pgprot(PTE_DIRTY));
192 }
193
194 static inline pte_t pte_mkdirty(pte_t pte)
195 {
196         return set_pte_bit(pte, __pgprot(PTE_DIRTY));
197 }
198
199 static inline pte_t pte_mkold(pte_t pte)
200 {
201         return clear_pte_bit(pte, __pgprot(PTE_AF));
202 }
203
204 static inline pte_t pte_mkyoung(pte_t pte)
205 {
206         return set_pte_bit(pte, __pgprot(PTE_AF));
207 }
208
209 static inline pte_t pte_mkspecial(pte_t pte)
210 {
211         return set_pte_bit(pte, __pgprot(PTE_SPECIAL));
212 }
213
214 static inline void set_pte(pte_t *ptep, pte_t pte)
215 {
216         *ptep = pte;
217
218         /*
219          * Only if the new pte is valid and kernel, otherwise TLB maintenance
220          * or update_mmu_cache() have the necessary barriers.
221          */
222         if (pte_valid_not_user(pte)) {
223                 dsb(ishst);
224                 isb();
225         }
226 }
227
228 struct mm_struct;
229 struct vm_area_struct;
230
231 extern void __sync_icache_dcache(pte_t pteval, unsigned long addr);
232
233 /*
234  * PTE bits configuration in the presence of hardware Dirty Bit Management
235  * (PTE_WRITE == PTE_DBM):
236  *
237  * Dirty  Writable | PTE_RDONLY  PTE_WRITE  PTE_DIRTY (sw)
238  *   0      0      |   1           0          0
239  *   0      1      |   1           1          0
240  *   1      0      |   1           0          1
241  *   1      1      |   0           1          x
242  *
243  * When hardware DBM is not present, the sofware PTE_DIRTY bit is updated via
244  * the page fault mechanism. Checking the dirty status of a pte becomes:
245  *
246  *   PTE_DIRTY || !PTE_RDONLY
247  */
248 static inline void set_pte_at(struct mm_struct *mm, unsigned long addr,
249                               pte_t *ptep, pte_t pte)
250 {
251         if (pte_valid_user(pte)) {
252                 if (!pte_special(pte) && pte_exec(pte))
253                         __sync_icache_dcache(pte, addr);
254                 if (pte_sw_dirty(pte) && pte_write(pte))
255                         pte_val(pte) &= ~PTE_RDONLY;
256                 else
257                         pte_val(pte) |= PTE_RDONLY;
258         }
259
260         /*
261          * If the existing pte is valid, check for potential race with
262          * hardware updates of the pte (ptep_set_access_flags safely changes
263          * valid ptes without going through an invalid entry).
264          */
265         if (IS_ENABLED(CONFIG_DEBUG_VM) && IS_ENABLED(CONFIG_ARM64_HW_AFDBM) &&
266             pte_valid(*ptep)) {
267                 BUG_ON(!pte_young(pte));
268                 BUG_ON(pte_write(*ptep) && !pte_dirty(pte));
269         }
270
271         set_pte(ptep, pte);
272 }
273
274 /*
275  * Huge pte definitions.
276  */
277 #define pte_huge(pte)           (!(pte_val(pte) & PTE_TABLE_BIT))
278 #define pte_mkhuge(pte)         (__pte(pte_val(pte) & ~PTE_TABLE_BIT))
279
280 /*
281  * Hugetlb definitions.
282  */
283 #define HUGE_MAX_HSTATE         2
284 #define HPAGE_SHIFT             PMD_SHIFT
285 #define HPAGE_SIZE              (_AC(1, UL) << HPAGE_SHIFT)
286 #define HPAGE_MASK              (~(HPAGE_SIZE - 1))
287 #define HUGETLB_PAGE_ORDER      (HPAGE_SHIFT - PAGE_SHIFT)
288
289 #define __HAVE_ARCH_PTE_SPECIAL
290
291 static inline pte_t pud_pte(pud_t pud)
292 {
293         return __pte(pud_val(pud));
294 }
295
296 static inline pmd_t pud_pmd(pud_t pud)
297 {
298         return __pmd(pud_val(pud));
299 }
300
301 static inline pte_t pmd_pte(pmd_t pmd)
302 {
303         return __pte(pmd_val(pmd));
304 }
305
306 static inline pmd_t pte_pmd(pte_t pte)
307 {
308         return __pmd(pte_val(pte));
309 }
310
311 static inline pgprot_t mk_sect_prot(pgprot_t prot)
312 {
313         return __pgprot(pgprot_val(prot) & ~PTE_TABLE_BIT);
314 }
315
316 /*
317  * THP definitions.
318  */
319
320 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
321 #define pmd_trans_huge(pmd)     (pmd_val(pmd) && !(pmd_val(pmd) & PMD_TABLE_BIT))
322 #define pmd_trans_splitting(pmd)        pte_special(pmd_pte(pmd))
323 #ifdef CONFIG_HAVE_RCU_TABLE_FREE
324 #define __HAVE_ARCH_PMDP_SPLITTING_FLUSH
325 struct vm_area_struct;
326 void pmdp_splitting_flush(struct vm_area_struct *vma, unsigned long address,
327                           pmd_t *pmdp);
328 #endif /* CONFIG_HAVE_RCU_TABLE_FREE */
329 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
330
331 #define pmd_dirty(pmd)          pte_dirty(pmd_pte(pmd))
332 #define pmd_young(pmd)          pte_young(pmd_pte(pmd))
333 #define pmd_wrprotect(pmd)      pte_pmd(pte_wrprotect(pmd_pte(pmd)))
334 #define pmd_mksplitting(pmd)    pte_pmd(pte_mkspecial(pmd_pte(pmd)))
335 #define pmd_mkold(pmd)          pte_pmd(pte_mkold(pmd_pte(pmd)))
336 #define pmd_mkwrite(pmd)        pte_pmd(pte_mkwrite(pmd_pte(pmd)))
337 #define pmd_mkdirty(pmd)        pte_pmd(pte_mkdirty(pmd_pte(pmd)))
338 #define pmd_mkyoung(pmd)        pte_pmd(pte_mkyoung(pmd_pte(pmd)))
339 #define pmd_mknotpresent(pmd)   (__pmd(pmd_val(pmd) & ~PMD_TYPE_MASK))
340
341 #define __HAVE_ARCH_PMD_WRITE
342 #define pmd_write(pmd)          pte_write(pmd_pte(pmd))
343
344 #define pmd_mkhuge(pmd)         (__pmd(pmd_val(pmd) & ~PMD_TABLE_BIT))
345
346 #define pmd_pfn(pmd)            (((pmd_val(pmd) & PMD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
347 #define pfn_pmd(pfn,prot)       (__pmd(((phys_addr_t)(pfn) << PAGE_SHIFT) | pgprot_val(prot)))
348 #define mk_pmd(page,prot)       pfn_pmd(page_to_pfn(page),prot)
349
350 #define pud_write(pud)          pte_write(pud_pte(pud))
351 #define pud_pfn(pud)            (((pud_val(pud) & PUD_MASK) & PHYS_MASK) >> PAGE_SHIFT)
352
353 #define set_pmd_at(mm, addr, pmdp, pmd) set_pte_at(mm, addr, (pte_t *)pmdp, pmd_pte(pmd))
354
355 static inline int has_transparent_hugepage(void)
356 {
357         return 1;
358 }
359
360 #define __pgprot_modify(prot,mask,bits) \
361         __pgprot((pgprot_val(prot) & ~(mask)) | (bits))
362
363 /*
364  * Mark the prot value as uncacheable and unbufferable.
365  */
366 #define pgprot_noncached(prot) \
367         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRnE) | PTE_PXN | PTE_UXN)
368 #define pgprot_writecombine(prot) \
369         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_NORMAL_NC) | PTE_PXN | PTE_UXN)
370 #define pgprot_device(prot) \
371         __pgprot_modify(prot, PTE_ATTRINDX_MASK, PTE_ATTRINDX(MT_DEVICE_nGnRE) | PTE_PXN | PTE_UXN)
372 #define __HAVE_PHYS_MEM_ACCESS_PROT
373 struct file;
374 extern pgprot_t phys_mem_access_prot(struct file *file, unsigned long pfn,
375                                      unsigned long size, pgprot_t vma_prot);
376
377 #define pmd_none(pmd)           (!pmd_val(pmd))
378 #define pmd_present(pmd)        (pmd_val(pmd))
379
380 #define pmd_bad(pmd)            (!(pmd_val(pmd) & 2))
381
382 #define pmd_table(pmd)          ((pmd_val(pmd) & PMD_TYPE_MASK) == \
383                                  PMD_TYPE_TABLE)
384 #define pmd_sect(pmd)           ((pmd_val(pmd) & PMD_TYPE_MASK) == \
385                                  PMD_TYPE_SECT)
386
387 #ifdef CONFIG_ARM64_64K_PAGES
388 #define pud_sect(pud)           (0)
389 #define pud_table(pud)          (1)
390 #else
391 #define pud_sect(pud)           ((pud_val(pud) & PUD_TYPE_MASK) == \
392                                  PUD_TYPE_SECT)
393 #define pud_table(pud)          ((pud_val(pud) & PUD_TYPE_MASK) == \
394                                  PUD_TYPE_TABLE)
395 #endif
396
397 static inline void set_pmd(pmd_t *pmdp, pmd_t pmd)
398 {
399         *pmdp = pmd;
400         dsb(ishst);
401         isb();
402 }
403
404 static inline void pmd_clear(pmd_t *pmdp)
405 {
406         set_pmd(pmdp, __pmd(0));
407 }
408
409 static inline pte_t *pmd_page_vaddr(pmd_t pmd)
410 {
411         return __va(pmd_val(pmd) & PHYS_MASK & (s32)PAGE_MASK);
412 }
413
414 #define pmd_page(pmd)           pfn_to_page(__phys_to_pfn(pmd_val(pmd) & PHYS_MASK))
415
416 /*
417  * Conversion functions: convert a page and protection to a page entry,
418  * and a page entry and page directory to the page they refer to.
419  */
420 #define mk_pte(page,prot)       pfn_pte(page_to_pfn(page),prot)
421
422 #if CONFIG_PGTABLE_LEVELS > 2
423
424 #define pmd_ERROR(pmd)          __pmd_error(__FILE__, __LINE__, pmd_val(pmd))
425
426 #define pud_none(pud)           (!pud_val(pud))
427 #define pud_bad(pud)            (!(pud_val(pud) & 2))
428 #define pud_present(pud)        (pud_val(pud))
429
430 static inline void set_pud(pud_t *pudp, pud_t pud)
431 {
432         *pudp = pud;
433         dsb(ishst);
434         isb();
435 }
436
437 static inline void pud_clear(pud_t *pudp)
438 {
439         set_pud(pudp, __pud(0));
440 }
441
442 static inline pmd_t *pud_page_vaddr(pud_t pud)
443 {
444         return __va(pud_val(pud) & PHYS_MASK & (s32)PAGE_MASK);
445 }
446
447 /* Find an entry in the second-level page table. */
448 #define pmd_index(addr)         (((addr) >> PMD_SHIFT) & (PTRS_PER_PMD - 1))
449
450 static inline pmd_t *pmd_offset(pud_t *pud, unsigned long addr)
451 {
452         return (pmd_t *)pud_page_vaddr(*pud) + pmd_index(addr);
453 }
454
455 #define pud_page(pud)           pfn_to_page(__phys_to_pfn(pud_val(pud) & PHYS_MASK))
456
457 #endif  /* CONFIG_PGTABLE_LEVELS > 2 */
458
459 #if CONFIG_PGTABLE_LEVELS > 3
460
461 #define pud_ERROR(pud)          __pud_error(__FILE__, __LINE__, pud_val(pud))
462
463 #define pgd_none(pgd)           (!pgd_val(pgd))
464 #define pgd_bad(pgd)            (!(pgd_val(pgd) & 2))
465 #define pgd_present(pgd)        (pgd_val(pgd))
466
467 static inline void set_pgd(pgd_t *pgdp, pgd_t pgd)
468 {
469         *pgdp = pgd;
470         dsb(ishst);
471 }
472
473 static inline void pgd_clear(pgd_t *pgdp)
474 {
475         set_pgd(pgdp, __pgd(0));
476 }
477
478 static inline pud_t *pgd_page_vaddr(pgd_t pgd)
479 {
480         return __va(pgd_val(pgd) & PHYS_MASK & (s32)PAGE_MASK);
481 }
482
483 /* Find an entry in the frst-level page table. */
484 #define pud_index(addr)         (((addr) >> PUD_SHIFT) & (PTRS_PER_PUD - 1))
485
486 static inline pud_t *pud_offset(pgd_t *pgd, unsigned long addr)
487 {
488         return (pud_t *)pgd_page_vaddr(*pgd) + pud_index(addr);
489 }
490
491 #define pgd_page(pgd)           pfn_to_page(__phys_to_pfn(pgd_val(pgd) & PHYS_MASK))
492
493 #endif  /* CONFIG_PGTABLE_LEVELS > 3 */
494
495 #define pgd_ERROR(pgd)          __pgd_error(__FILE__, __LINE__, pgd_val(pgd))
496
497 /* to find an entry in a page-table-directory */
498 #define pgd_index(addr)         (((addr) >> PGDIR_SHIFT) & (PTRS_PER_PGD - 1))
499
500 #define pgd_offset(mm, addr)    ((mm)->pgd+pgd_index(addr))
501
502 /* to find an entry in a kernel page-table-directory */
503 #define pgd_offset_k(addr)      pgd_offset(&init_mm, addr)
504
505 static inline pte_t pte_modify(pte_t pte, pgprot_t newprot)
506 {
507         const pteval_t mask = PTE_USER | PTE_PXN | PTE_UXN | PTE_RDONLY |
508                               PTE_PROT_NONE | PTE_WRITE | PTE_TYPE_MASK;
509         /* preserve the hardware dirty information */
510         if (pte_hw_dirty(pte))
511                 newprot |= PTE_DIRTY;
512         pte_val(pte) = (pte_val(pte) & ~mask) | (pgprot_val(newprot) & mask);
513         return pte;
514 }
515
516 static inline pmd_t pmd_modify(pmd_t pmd, pgprot_t newprot)
517 {
518         return pte_pmd(pte_modify(pmd_pte(pmd), newprot));
519 }
520
521 #ifdef CONFIG_ARM64_HW_AFDBM
522 /*
523  * Atomic pte/pmd modifications.
524  */
525 #define __HAVE_ARCH_PTEP_TEST_AND_CLEAR_YOUNG
526 static inline int ptep_test_and_clear_young(struct vm_area_struct *vma,
527                                             unsigned long address,
528                                             pte_t *ptep)
529 {
530         pteval_t pteval;
531         unsigned int tmp, res;
532
533         asm volatile("//        ptep_test_and_clear_young\n"
534         "       prfm    pstl1strm, %2\n"
535         "1:     ldxr    %0, %2\n"
536         "       ubfx    %w3, %w0, %5, #1        // extract PTE_AF (young)\n"
537         "       and     %0, %0, %4              // clear PTE_AF\n"
538         "       stxr    %w1, %0, %2\n"
539         "       cbnz    %w1, 1b\n"
540         : "=&r" (pteval), "=&r" (tmp), "+Q" (pte_val(*ptep)), "=&r" (res)
541         : "L" (~PTE_AF), "I" (ilog2(PTE_AF)));
542
543         return res;
544 }
545
546 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
547 #define __HAVE_ARCH_PMDP_TEST_AND_CLEAR_YOUNG
548 static inline int pmdp_test_and_clear_young(struct vm_area_struct *vma,
549                                             unsigned long address,
550                                             pmd_t *pmdp)
551 {
552         return ptep_test_and_clear_young(vma, address, (pte_t *)pmdp);
553 }
554 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
555
556 #define __HAVE_ARCH_PTEP_GET_AND_CLEAR
557 static inline pte_t ptep_get_and_clear(struct mm_struct *mm,
558                                        unsigned long address, pte_t *ptep)
559 {
560         pteval_t old_pteval;
561         unsigned int tmp;
562
563         asm volatile("//        ptep_get_and_clear\n"
564         "       prfm    pstl1strm, %2\n"
565         "1:     ldxr    %0, %2\n"
566         "       stxr    %w1, xzr, %2\n"
567         "       cbnz    %w1, 1b\n"
568         : "=&r" (old_pteval), "=&r" (tmp), "+Q" (pte_val(*ptep)));
569
570         return __pte(old_pteval);
571 }
572
573 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
574 #define __HAVE_ARCH_PMDP_GET_AND_CLEAR
575 static inline pmd_t pmdp_get_and_clear(struct mm_struct *mm,
576                                        unsigned long address, pmd_t *pmdp)
577 {
578         return pte_pmd(ptep_get_and_clear(mm, address, (pte_t *)pmdp));
579 }
580 #endif /* CONFIG_TRANSPARENT_HUGEPAGE */
581
582 /*
583  * ptep_set_wrprotect - mark read-only while trasferring potential hardware
584  * dirty status (PTE_DBM && !PTE_RDONLY) to the software PTE_DIRTY bit.
585  */
586 #define __HAVE_ARCH_PTEP_SET_WRPROTECT
587 static inline void ptep_set_wrprotect(struct mm_struct *mm, unsigned long address, pte_t *ptep)
588 {
589         pteval_t pteval;
590         unsigned long tmp;
591
592         asm volatile("//        ptep_set_wrprotect\n"
593         "       prfm    pstl1strm, %2\n"
594         "1:     ldxr    %0, %2\n"
595         "       tst     %0, %4                  // check for hw dirty (!PTE_RDONLY)\n"
596         "       csel    %1, %3, xzr, eq         // set PTE_DIRTY|PTE_RDONLY if dirty\n"
597         "       orr     %0, %0, %1              // if !dirty, PTE_RDONLY is already set\n"
598         "       and     %0, %0, %5              // clear PTE_WRITE/PTE_DBM\n"
599         "       stxr    %w1, %0, %2\n"
600         "       cbnz    %w1, 1b\n"
601         : "=&r" (pteval), "=&r" (tmp), "+Q" (pte_val(*ptep))
602         : "r" (PTE_DIRTY|PTE_RDONLY), "L" (PTE_RDONLY), "L" (~PTE_WRITE)
603         : "cc");
604 }
605
606 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
607 #define __HAVE_ARCH_PMDP_SET_WRPROTECT
608 static inline void pmdp_set_wrprotect(struct mm_struct *mm,
609                                       unsigned long address, pmd_t *pmdp)
610 {
611         ptep_set_wrprotect(mm, address, (pte_t *)pmdp);
612 }
613 #endif
614 #endif  /* CONFIG_ARM64_HW_AFDBM */
615
616 extern pgd_t swapper_pg_dir[PTRS_PER_PGD];
617 extern pgd_t idmap_pg_dir[PTRS_PER_PGD];
618
619 /*
620  * Encode and decode a swap entry:
621  *      bits 0-1:       present (must be zero)
622  *      bits 2-7:       swap type
623  *      bits 8-57:      swap offset
624  */
625 #define __SWP_TYPE_SHIFT        2
626 #define __SWP_TYPE_BITS         6
627 #define __SWP_OFFSET_BITS       50
628 #define __SWP_TYPE_MASK         ((1 << __SWP_TYPE_BITS) - 1)
629 #define __SWP_OFFSET_SHIFT      (__SWP_TYPE_BITS + __SWP_TYPE_SHIFT)
630 #define __SWP_OFFSET_MASK       ((1UL << __SWP_OFFSET_BITS) - 1)
631
632 #define __swp_type(x)           (((x).val >> __SWP_TYPE_SHIFT) & __SWP_TYPE_MASK)
633 #define __swp_offset(x)         (((x).val >> __SWP_OFFSET_SHIFT) & __SWP_OFFSET_MASK)
634 #define __swp_entry(type,offset) ((swp_entry_t) { ((type) << __SWP_TYPE_SHIFT) | ((offset) << __SWP_OFFSET_SHIFT) })
635
636 #define __pte_to_swp_entry(pte) ((swp_entry_t) { pte_val(pte) })
637 #define __swp_entry_to_pte(swp) ((pte_t) { (swp).val })
638
639 /*
640  * Ensure that there are not more swap files than can be encoded in the kernel
641  * PTEs.
642  */
643 #define MAX_SWAPFILES_CHECK() BUILD_BUG_ON(MAX_SWAPFILES_SHIFT > __SWP_TYPE_BITS)
644
645 extern int kern_addr_valid(unsigned long addr);
646
647 #include <asm-generic/pgtable.h>
648
649 #define pgtable_cache_init() do { } while (0)
650
651 /*
652  * On AArch64, the cache coherency is handled via the set_pte_at() function.
653  */
654 static inline void update_mmu_cache(struct vm_area_struct *vma,
655                                     unsigned long addr, pte_t *ptep)
656 {
657         /*
658          * set_pte() does not have a DSB for user mappings, so make sure that
659          * the page table write is visible.
660          */
661         dsb(ishst);
662 }
663
664 #define update_mmu_cache_pmd(vma, address, pmd) do { } while (0)
665
666 #endif /* !__ASSEMBLY__ */
667
668 #endif /* __ASM_PGTABLE_H */