pmap.h revision 1.33 1 /* $NetBSD: pmap.h,v 1.33 2020/02/03 13:37:01 ryo Exp $ */
2
3 /*-
4 * Copyright (c) 2014 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Matt Thomas of 3am Software Foundry.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 #ifndef _AARCH64_PMAP_H_
33 #define _AARCH64_PMAP_H_
34
35 #ifdef __aarch64__
36
37 #ifdef _KERNEL
38 #ifdef _KERNEL_OPT
39 #include "opt_kasan.h"
40 #endif
41
42 #include <sys/types.h>
43 #include <sys/pool.h>
44 #include <sys/queue.h>
45 #include <uvm/uvm_pglist.h>
46
47 #include <aarch64/pte.h>
48
49 #define PMAP_NEED_PROCWR
50 #define PMAP_GROWKERNEL
51 #define PMAP_STEAL_MEMORY
52
53 #define __HAVE_VM_PAGE_MD
54 #define __HAVE_PMAP_PV_TRACK 1
55
56 #ifndef KASAN
57 #define PMAP_MAP_POOLPAGE(pa) AARCH64_PA_TO_KVA(pa)
58 #define PMAP_UNMAP_POOLPAGE(va) AARCH64_KVA_TO_PA(va)
59
60 #define PMAP_DIRECT
61 static __inline int
62 pmap_direct_process(paddr_t pa, voff_t pgoff, size_t len,
63 int (*process)(void *, size_t, void *), void *arg)
64 {
65 vaddr_t va = AARCH64_PA_TO_KVA(pa);
66
67 return process((void *)(va + pgoff), len, arg);
68 }
69 #endif
70
71 struct pmap {
72 kmutex_t pm_lock;
73 struct pool *pm_pvpool;
74 pd_entry_t *pm_l0table; /* L0 table: 512G*512 */
75 paddr_t pm_l0table_pa;
76
77 TAILQ_HEAD(, vm_page) pm_vmlist; /* for L[0123] tables */
78
79 struct pmap_statistics pm_stats;
80 unsigned int pm_refcnt;
81 unsigned int pm_idlepdp;
82 int pm_asid;
83 bool pm_activated;
84 };
85
86 struct pv_entry;
87
88 struct pmap_page {
89 kmutex_t pp_pvlock;
90 TAILQ_HEAD(, pv_entry) pp_pvhead;
91
92 /* VM_PROT_READ means referenced, VM_PROT_WRITE means modified */
93 uint32_t pp_flags;
94 #define PMAP_PAGE_FLAGS_PV_TRACKED 0x80000000
95 };
96
97 struct vm_page_md {
98 TAILQ_ENTRY(vm_page) mdpg_vmlist; /* L[0123] table vm_page list */
99 pd_entry_t *mdpg_ptep_parent; /* for page descriptor page only */
100
101 struct pmap_page mdpg_pp;
102 };
103
104 /* each mdpg_pp.pp_pvlock will be initialized in pmap_init() */
105 #define VM_MDPAGE_INIT(pg) \
106 do { \
107 TAILQ_INIT(&(pg)->mdpage.mdpg_pp.pp_pvhead); \
108 (pg)->mdpage.mdpg_pp.pp_flags = 0; \
109 } while (/*CONSTCOND*/ 0)
110
111
112 /* saved permission bit for referenced/modified emulation */
113 #define LX_BLKPAG_OS_READ LX_BLKPAG_OS_0
114 #define LX_BLKPAG_OS_WRITE LX_BLKPAG_OS_1
115 #define LX_BLKPAG_OS_WIRED LX_BLKPAG_OS_2
116 #define LX_BLKPAG_OS_BOOT LX_BLKPAG_OS_3
117 #define LX_BLKPAG_OS_RWMASK (LX_BLKPAG_OS_WRITE|LX_BLKPAG_OS_READ)
118
119 /* memory attributes are configured MAIR_EL1 in locore */
120 #define LX_BLKPAG_ATTR_NORMAL_WB __SHIFTIN(0, LX_BLKPAG_ATTR_INDX)
121 #define LX_BLKPAG_ATTR_NORMAL_NC __SHIFTIN(1, LX_BLKPAG_ATTR_INDX)
122 #define LX_BLKPAG_ATTR_NORMAL_WT __SHIFTIN(2, LX_BLKPAG_ATTR_INDX)
123 #define LX_BLKPAG_ATTR_DEVICE_MEM __SHIFTIN(3, LX_BLKPAG_ATTR_INDX)
124 #define LX_BLKPAG_ATTR_DEVICE_MEM_SO __SHIFTIN(4, LX_BLKPAG_ATTR_INDX)
125 #define LX_BLKPAG_ATTR_MASK LX_BLKPAG_ATTR_INDX
126
127 #define lxpde_pa(pde) ((paddr_t)((pde) & LX_TBL_PA))
128 #define lxpde_valid(pde) (((pde) & LX_VALID) == LX_VALID)
129 #define l0pde_pa(pde) lxpde_pa(pde)
130 #define l0pde_index(v) (((vaddr_t)(v) & L0_ADDR_BITS) >> L0_SHIFT)
131 #define l0pde_valid(pde) lxpde_valid(pde)
132 /* l0pte always contains table entries */
133
134 #define l1pde_pa(pde) lxpde_pa(pde)
135 #define l1pde_index(v) (((vaddr_t)(v) & L1_ADDR_BITS) >> L1_SHIFT)
136 #define l1pde_valid(pde) lxpde_valid(pde)
137 #define l1pde_is_block(pde) (((pde) & LX_TYPE) == LX_TYPE_BLK)
138 #define l1pde_is_table(pde) (((pde) & LX_TYPE) == LX_TYPE_TBL)
139
140 #define l2pde_pa(pde) lxpde_pa(pde)
141 #define l2pde_index(v) (((vaddr_t)(v) & L2_ADDR_BITS) >> L2_SHIFT)
142 #define l2pde_valid(pde) lxpde_valid(pde)
143 #define l2pde_is_block(pde) (((pde) & LX_TYPE) == LX_TYPE_BLK)
144 #define l2pde_is_table(pde) (((pde) & LX_TYPE) == LX_TYPE_TBL)
145
146 #define l3pte_pa(pde) lxpde_pa(pde)
147 #define l3pte_executable(pde,user) \
148 (((pde) & ((user) ? LX_BLKPAG_UXN : LX_BLKPAG_PXN)) == 0)
149 #define l3pte_readable(pde) ((pde) & LX_BLKPAG_AF)
150 #define l3pte_writable(pde) \
151 (((pde) & (LX_BLKPAG_AF|LX_BLKPAG_AP)) == (LX_BLKPAG_AF|LX_BLKPAG_AP_RW))
152 #define l3pte_index(v) (((vaddr_t)(v) & L3_ADDR_BITS) >> L3_SHIFT)
153 #define l3pte_valid(pde) lxpde_valid(pde)
154 #define l3pte_is_page(pde) (((pde) & LX_TYPE) == L3_TYPE_PAG)
155 /* l3pte contains always page entries */
156
157 void pmap_bootstrap(vaddr_t, vaddr_t);
158 bool pmap_fault_fixup(struct pmap *, vaddr_t, vm_prot_t, bool user);
159
160 /* for ddb */
161 void pmap_db_pteinfo(vaddr_t, void (*)(const char *, ...) __printflike(1, 2));
162 void pmap_db_ttbrdump(bool, vaddr_t, void (*)(const char *, ...)
163 __printflike(1, 2));
164 pt_entry_t *kvtopte(vaddr_t);
165 pt_entry_t pmap_kvattr(vaddr_t, vm_prot_t);
166
167 /* locore.S */
168 pd_entry_t *bootpage_alloc(void);
169
170 /* pmap_locore.c */
171 int pmapboot_enter(vaddr_t, paddr_t, psize_t, psize_t,
172 pt_entry_t, uint64_t, pd_entry_t *(*)(void),
173 void (*pr)(const char *, ...) __printflike(1, 2));
174 #define PMAPBOOT_ENTER_NOBLOCK 0x00000001
175 #define PMAPBOOT_ENTER_NOOVERWRITE 0x00000002
176 int pmapboot_protect(vaddr_t, vaddr_t, vm_prot_t);
177 void pmap_db_pte_print(pt_entry_t, int,
178 void (*pr)(const char *, ...) __printflike(1, 2));
179
180 /* Hooks for the pool allocator */
181 paddr_t vtophys(vaddr_t);
182 #define VTOPHYS_FAILED ((paddr_t)-1L) /* POOL_PADDR_INVALID */
183 #define POOL_VTOPHYS(va) vtophys((vaddr_t) (va))
184
185
186 /* devmap */
187 struct pmap_devmap {
188 vaddr_t pd_va; /* virtual address */
189 paddr_t pd_pa; /* physical address */
190 psize_t pd_size; /* size of region */
191 vm_prot_t pd_prot; /* protection code */
192 u_int pd_flags; /* flags for pmap_kenter_pa() */
193 };
194
195 void pmap_devmap_register(const struct pmap_devmap *);
196 void pmap_devmap_bootstrap(vaddr_t, const struct pmap_devmap *);
197 const struct pmap_devmap *pmap_devmap_find_pa(paddr_t, psize_t);
198 const struct pmap_devmap *pmap_devmap_find_va(vaddr_t, vsize_t);
199 vaddr_t pmap_devmap_phystov(paddr_t);
200 paddr_t pmap_devmap_vtophys(paddr_t);
201
202 paddr_t pmap_alloc_pdp(struct pmap *, struct vm_page **, int, bool);
203
204 #define L1_TRUNC_BLOCK(x) ((x) & L1_FRAME)
205 #define L1_ROUND_BLOCK(x) L1_TRUNC_BLOCK((x) + L1_SIZE - 1)
206 #define L2_TRUNC_BLOCK(x) ((x) & L2_FRAME)
207 #define L2_ROUND_BLOCK(x) L2_TRUNC_BLOCK((x) + L2_SIZE - 1)
208 #define L3_TRUNC_BLOCK(x) ((x) & L3_FRAME)
209 #define L3_ROUND_BLOCK(x) L3_TRUNC_BLOCK((x) + L3_SIZE - 1)
210
211 #define DEVMAP_ALIGN(x) L3_TRUNC_BLOCK((x))
212 #define DEVMAP_SIZE(x) L3_ROUND_BLOCK((x))
213
214 #define DEVMAP_ENTRY(va, pa, sz) \
215 { \
216 .pd_va = DEVMAP_ALIGN(va), \
217 .pd_pa = DEVMAP_ALIGN(pa), \
218 .pd_size = DEVMAP_SIZE(sz), \
219 .pd_prot = VM_PROT_READ|VM_PROT_WRITE, \
220 .pd_flags = PMAP_DEV \
221 }
222 #define DEVMAP_ENTRY_END { 0 }
223
224 /* mmap cookie and flags */
225 #define AARCH64_MMAP_FLAG_SHIFT (64 - PGSHIFT)
226 #define AARCH64_MMAP_FLAG_MASK 0xf
227 #define AARCH64_MMAP_WRITEBACK 0UL
228 #define AARCH64_MMAP_NOCACHE 1UL
229 #define AARCH64_MMAP_WRITECOMBINE 2UL
230 #define AARCH64_MMAP_DEVICE 3UL
231
232 #define ARM_MMAP_MASK __BITS(63, AARCH64_MMAP_FLAG_SHIFT)
233 #define ARM_MMAP_WRITECOMBINE __SHIFTIN(AARCH64_MMAP_WRITECOMBINE, ARM_MMAP_MASK)
234 #define ARM_MMAP_WRITEBACK __SHIFTIN(AARCH64_MMAP_WRITEBACK, ARM_MMAP_MASK)
235 #define ARM_MMAP_NOCACHE __SHIFTIN(AARCH64_MMAP_NOCACHE, ARM_MMAP_MASK)
236 #define ARM_MMAP_DEVICE __SHIFTIN(AARCH64_MMAP_DEVICE, ARM_MMAP_MASK)
237
238 #define PMAP_PTE 0x10000000 /* kenter_pa */
239 #define PMAP_DEV 0x20000000 /* kenter_pa */
240 #define PMAP_DEV_SO 0x40000000 /* kenter_pa */
241 #define PMAP_DEV_MASK (PMAP_DEV | PMAP_DEV_SO)
242
243 static inline u_int
244 aarch64_mmap_flags(paddr_t mdpgno)
245 {
246 u_int nflag, pflag;
247
248 /*
249 * aarch64 arch has 5 memory attribute:
250 *
251 * WriteBack - write back cache
252 * WriteThru - write through cache
253 * NoCache - no cache
254 * Device(nGnRE) - no Gathering, no Reordering, Early write ack
255 * Device(nGnRnE) - no Gathering, no Reordering, no Early write ack
256 *
257 * but pmap has PMAP_{NOCACHE,WRITE_COMBINE,WRITE_BACK} flags.
258 */
259
260 nflag = (mdpgno >> AARCH64_MMAP_FLAG_SHIFT) & AARCH64_MMAP_FLAG_MASK;
261 switch (nflag) {
262 case AARCH64_MMAP_DEVICE:
263 pflag = PMAP_DEV;
264 break;
265 case AARCH64_MMAP_WRITECOMBINE:
266 pflag = PMAP_WRITE_COMBINE;
267 break;
268 case AARCH64_MMAP_WRITEBACK:
269 pflag = PMAP_WRITE_BACK;
270 break;
271 case AARCH64_MMAP_NOCACHE:
272 default:
273 pflag = PMAP_NOCACHE;
274 break;
275 }
276 return pflag;
277 }
278
279
280 #define pmap_phys_address(pa) aarch64_ptob((pa))
281 #define pmap_mmap_flags(ppn) aarch64_mmap_flags((ppn))
282
283 #define pmap_update(pmap) ((void)0)
284 #define pmap_copy(dp,sp,d,l,s) ((void)0)
285 #define pmap_wired_count(pmap) ((pmap)->pm_stats.wired_count)
286 #define pmap_resident_count(pmap) ((pmap)->pm_stats.resident_count)
287
288 void pmap_procwr(struct proc *, vaddr_t, int);
289 bool pmap_extract_coherency(pmap_t, vaddr_t, paddr_t *, bool *);
290 void pmap_icache_sync_range(pmap_t, vaddr_t, vaddr_t);
291
292 void pmap_pv_init(void);
293 void pmap_pv_track(paddr_t, psize_t);
294 void pmap_pv_untrack(paddr_t, psize_t);
295 void pmap_pv_protect(paddr_t, vm_prot_t);
296
297 #define PMAP_MAPSIZE1 L2_SIZE
298
299 #endif /* _KERNEL */
300
301 #elif defined(__arm__)
302
303 #include <arm/pmap.h>
304
305 #endif /* __arm__/__aarch64__ */
306
307 #endif /* !_AARCH64_PMAP_ */
308