pmap.h revision 1.17 1 /* $NetBSD: pmap.h,v 1.17 2018/11/01 20:34:50 maxv 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_GROWKERNEL
50 #define PMAP_STEAL_MEMORY
51
52 #define __HAVE_VM_PAGE_MD
53
54 #ifndef KASAN
55 #define PMAP_MAP_POOLPAGE(pa) AARCH64_PA_TO_KVA(pa)
56 #define PMAP_UNMAP_POOLPAGE(va) AARCH64_KVA_TO_PA(va)
57 #endif
58
59 struct pmap {
60 kmutex_t pm_lock;
61 struct pool *pm_pvpool;
62 pd_entry_t *pm_l0table; /* L0 table: 512G*512 */
63 paddr_t pm_l0table_pa;
64
65 SLIST_HEAD(, vm_page) pm_vmlist; /* for L[0123] tables */
66
67 struct pmap_statistics pm_stats;
68 unsigned int pm_refcnt;
69 int pm_asid;
70 bool pm_activated;
71 };
72
73 struct pv_entry;
74 struct vm_page_md {
75 kmutex_t mdpg_pvlock;
76 SLIST_ENTRY(vm_page) mdpg_vmlist; /* L[0-3] table vm_page list */
77 TAILQ_HEAD(, pv_entry) mdpg_pvhead;
78
79 /* VM_PROT_READ means referenced, VM_PROT_WRITE means modified */
80 uint32_t mdpg_flags;
81 };
82
83 /* each mdpg_pvlock will be initialized in pmap_init() */
84 #define VM_MDPAGE_INIT(pg) \
85 do { \
86 TAILQ_INIT(&(pg)->mdpage.mdpg_pvhead); \
87 (pg)->mdpage.mdpg_flags = 0; \
88 } while (/*CONSTCOND*/ 0)
89
90
91 /* saved permission bit for referenced/modified emulation */
92 #define LX_BLKPAG_OS_READ LX_BLKPAG_OS_0
93 #define LX_BLKPAG_OS_WRITE LX_BLKPAG_OS_1
94 #define LX_BLKPAG_OS_WIRED LX_BLKPAG_OS_2
95 #define LX_BLKPAG_OS_BOOT LX_BLKPAG_OS_3
96 #define LX_BLKPAG_OS_RWMASK (LX_BLKPAG_OS_WRITE|LX_BLKPAG_OS_READ)
97
98 /* memory attributes are configured MAIR_EL1 in locore */
99 #define LX_BLKPAG_ATTR_NORMAL_WB __SHIFTIN(0, LX_BLKPAG_ATTR_INDX)
100 #define LX_BLKPAG_ATTR_NORMAL_NC __SHIFTIN(1, LX_BLKPAG_ATTR_INDX)
101 #define LX_BLKPAG_ATTR_NORMAL_WT __SHIFTIN(2, LX_BLKPAG_ATTR_INDX)
102 #define LX_BLKPAG_ATTR_DEVICE_MEM __SHIFTIN(3, LX_BLKPAG_ATTR_INDX)
103 #define LX_BLKPAG_ATTR_MASK LX_BLKPAG_ATTR_INDX
104
105 #define lxpde_pa(pde) ((paddr_t)((pde) & LX_TBL_PA))
106 #define l0pde_pa(pde) lxpde_pa(pde)
107 #define l0pde_index(v) (((vaddr_t)(v) & L0_ADDR_BITS) >> L0_SHIFT)
108 #define l0pde_valid(pde) (((pde) & LX_VALID) == LX_VALID)
109 /* l0pte always contains table entries */
110
111 #define l1pde_pa(pde) lxpde_pa(pde)
112 #define l1pde_index(v) (((vaddr_t)(v) & L1_ADDR_BITS) >> L1_SHIFT)
113 #define l1pde_valid(pde) (((pde) & LX_VALID) == LX_VALID)
114 #define l1pde_is_block(pde) (((pde) & LX_TYPE) == LX_TYPE_BLK)
115 #define l1pde_is_table(pde) (((pde) & LX_TYPE) == LX_TYPE_TBL)
116
117 #define l2pde_pa(pde) lxpde_pa(pde)
118 #define l2pde_index(v) (((vaddr_t)(v) & L2_ADDR_BITS) >> L2_SHIFT)
119 #define l2pde_valid(pde) (((pde) & LX_VALID) == LX_VALID)
120 #define l2pde_is_block(pde) (((pde) & LX_TYPE) == LX_TYPE_BLK)
121 #define l2pde_is_table(pde) (((pde) & LX_TYPE) == LX_TYPE_TBL)
122
123 #define l3pte_pa(pde) lxpde_pa(pde)
124 #define l3pte_executable(pde,user) \
125 (((pde) & ((user) ? LX_BLKPAG_UXN : LX_BLKPAG_PXN)) == 0)
126 #define l3pte_readable(pde) ((pde) & LX_BLKPAG_AF)
127 #define l3pte_writable(pde) \
128 (((pde) & (LX_BLKPAG_AF|LX_BLKPAG_AP)) == (LX_BLKPAG_AF|LX_BLKPAG_AP_RW))
129 #define l3pte_index(v) (((vaddr_t)(v) & L3_ADDR_BITS) >> L3_SHIFT)
130 #define l3pte_valid(pde) (((pde) & LX_VALID) == LX_VALID)
131 #define l3pte_is_page(pde) (((pde) & LX_TYPE) == L3_TYPE_PAG)
132 /* l3pte contains always page entries */
133
134 void pmap_bootstrap(vaddr_t, vaddr_t);
135 bool pmap_fault_fixup(struct pmap *, vaddr_t, vm_prot_t, bool user);
136
137 /* for ddb */
138 void pmap_db_pteinfo(vaddr_t, void (*)(const char *, ...) __printflike(1, 2));
139 pt_entry_t *kvtopte(vaddr_t);
140 pt_entry_t pmap_kvattr(vaddr_t, vm_prot_t);
141
142 /* locore.S */
143 pd_entry_t *bootpage_alloc(void);
144
145 /* pmap_locore.c */
146 int pmapboot_enter(vaddr_t, paddr_t, psize_t, psize_t,
147 pt_entry_t, uint64_t, pd_entry_t *(*)(void),
148 void (*pr)(const char *, ...) __printflike(1, 2));
149 #define PMAPBOOT_ENTER_NOBLOCK 0x00000001
150 #define PMAPBOOT_ENTER_NOOVERWRITE 0x00000002
151 int pmapboot_protect(vaddr_t, vaddr_t, vm_prot_t);
152 void pmap_db_pte_print(pt_entry_t, int,
153 void (*pr)(const char *, ...) __printflike(1, 2));
154
155 /* Hooks for the pool allocator */
156 paddr_t vtophys(vaddr_t);
157 #define VTOPHYS_FAILED ((paddr_t)-1L) /* POOL_PADDR_INVALID */
158 #define POOL_VTOPHYS(va) vtophys((vaddr_t) (va))
159
160
161 /* devmap */
162 struct pmap_devmap {
163 vaddr_t pd_va; /* virtual address */
164 paddr_t pd_pa; /* physical address */
165 psize_t pd_size; /* size of region */
166 vm_prot_t pd_prot; /* protection code */
167 u_int pd_flags; /* flags for pmap_kenter_pa() */
168 };
169
170 void pmap_devmap_register(const struct pmap_devmap *);
171 void pmap_devmap_bootstrap(vaddr_t, const struct pmap_devmap *);
172 const struct pmap_devmap *pmap_devmap_find_pa(paddr_t, psize_t);
173 const struct pmap_devmap *pmap_devmap_find_va(vaddr_t, vsize_t);
174 vaddr_t pmap_devmap_phystov(paddr_t);
175 paddr_t pmap_devmap_vtophys(paddr_t);
176
177 pd_entry_t *pmap_alloc_pdp(struct pmap *, paddr_t *);
178
179 #define L1_TRUNC_BLOCK(x) ((x) & L1_FRAME)
180 #define L1_ROUND_BLOCK(x) L1_TRUNC_BLOCK((x) + L1_SIZE - 1)
181 #define L2_TRUNC_BLOCK(x) ((x) & L2_FRAME)
182 #define L2_ROUND_BLOCK(x) L2_TRUNC_BLOCK((x) + L2_SIZE - 1)
183
184 /* devmap use L2 blocks. (2Mbyte) */
185 #define DEVMAP_TRUNC_ADDR(x) L2_TRUNC_BLOCK((x))
186 #define DEVMAP_ROUND_SIZE(x) L2_ROUND_BLOCK((x))
187
188 #define DEVMAP_ENTRY(va, pa, sz) \
189 { \
190 .pd_va = DEVMAP_TRUNC_ADDR(va), \
191 .pd_pa = DEVMAP_TRUNC_ADDR(pa), \
192 .pd_size = DEVMAP_ROUND_SIZE(sz), \
193 .pd_prot = VM_PROT_READ|VM_PROT_WRITE, \
194 .pd_flags = PMAP_NOCACHE \
195 }
196 #define DEVMAP_ENTRY_END { 0 }
197
198 /* mmap cookie and flags */
199 #define AARCH64_MMAP_FLAG_SHIFT (64 - PGSHIFT)
200 #define AARCH64_MMAP_FLAG_MASK 0xf
201 #define AARCH64_MMAP_WRITEBACK 0UL
202 #define AARCH64_MMAP_NOCACHE 1UL
203 #define AARCH64_MMAP_WRITECOMBINE 2UL
204 #define AARCH64_MMAP_DEVICE 3UL
205
206 #define ARM_MMAP_MASK __BITS(63, AARCH64_MMAP_FLAG_SHIFT)
207 #define ARM_MMAP_WRITECOMBINE __SHIFTIN(AARCH64_MMAP_WRITECOMBINE, ARM_MMAP_MASK)
208 #define ARM_MMAP_WRITEBACK __SHIFTIN(AARCH64_MMAP_WRITEBACK, ARM_MMAP_MASK)
209 #define ARM_MMAP_NOCACHE __SHIFTIN(AARCH64_MMAP_NOCACHE, ARM_MMAP_MASK)
210 #define ARM_MMAP_DEVICE __SHIFTIN(AARCH64_MMAP_DEVICE, ARM_MMAP_MASK)
211
212 #define PMAP_PTE 0x10000000 /* kenter_pa */
213 #define PMAP_DEV 0x20000000 /* kenter_pa */
214
215 static inline u_int
216 aarch64_mmap_flags(paddr_t mdpgno)
217 {
218 u_int nflag, pflag;
219
220 /*
221 * aarch64 arch has 4 memory attribute:
222 *
223 * WriteBack - write back cache
224 * WriteThru - wite through cache
225 * NoCache - no cache
226 * Device(nGnRnE) - no Gathering, no Reordering, no Early write ack
227 *
228 * but pmap has PMAP_{NOCACHE,WRITE_COMBINE,WRITE_BACK} flags.
229 */
230
231 nflag = (mdpgno >> AARCH64_MMAP_FLAG_SHIFT) & AARCH64_MMAP_FLAG_MASK;
232 switch (nflag) {
233 case AARCH64_MMAP_DEVICE:
234 pflag = PMAP_DEV;
235 break;
236 case AARCH64_MMAP_WRITECOMBINE:
237 pflag = PMAP_WRITE_COMBINE;
238 break;
239 case AARCH64_MMAP_WRITEBACK:
240 pflag = PMAP_WRITE_BACK;
241 break;
242 case AARCH64_MMAP_NOCACHE:
243 default:
244 pflag = PMAP_NOCACHE;
245 break;
246 }
247 return pflag;
248 }
249
250
251 #define pmap_phys_address(pa) aarch64_ptob((pa))
252 #define pmap_mmap_flags(ppn) aarch64_mmap_flags((ppn))
253
254 #define pmap_update(pmap) ((void)0)
255 #define pmap_copy(dp,sp,d,l,s) ((void)0)
256 #define pmap_wired_count(pmap) ((pmap)->pm_stats.wired_count)
257 #define pmap_resident_count(pmap) ((pmap)->pm_stats.resident_count)
258
259 bool pmap_extract_coherency(pmap_t, vaddr_t, paddr_t *, bool *);
260 void pmap_icache_sync_range(pmap_t, vaddr_t, vaddr_t);
261
262 #define PMAP_MAPSIZE1 L2_SIZE
263
264 #endif /* _KERNEL */
265
266 #elif defined(__arm__)
267
268 #include <arm/pmap.h>
269
270 #endif /* __arm__/__aarch64__ */
271
272 #endif /* !_AARCH64_PMAP_ */
273