xref: /netbsd-src/sys/arch/amd64/include/pmap.h (revision e6c7e151de239c49d2e38720a061ed9d1fa99309)
1 /*	$NetBSD: pmap.h,v 1.65 2020/03/17 18:17:07 ad Exp $	*/
2 
3 /*
4  * Copyright (c) 1997 Charles D. Cranor and Washington University.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 /*
29  * Copyright (c) 2001 Wasabi Systems, Inc.
30  * All rights reserved.
31  *
32  * Written by Frank van der Linden for Wasabi Systems, Inc.
33  *
34  * Redistribution and use in source and binary forms, with or without
35  * modification, are permitted provided that the following conditions
36  * are met:
37  * 1. Redistributions of source code must retain the above copyright
38  *    notice, this list of conditions and the following disclaimer.
39  * 2. Redistributions in binary form must reproduce the above copyright
40  *    notice, this list of conditions and the following disclaimer in the
41  *    documentation and/or other materials provided with the distribution.
42  * 3. All advertising materials mentioning features or use of this software
43  *    must display the following acknowledgement:
44  *      This product includes software developed for the NetBSD Project by
45  *      Wasabi Systems, Inc.
46  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
47  *    or promote products derived from this software without specific prior
48  *    written permission.
49  *
50  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
52  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
53  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
54  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
55  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
56  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
57  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
58  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
59  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
60  * POSSIBILITY OF SUCH DAMAGE.
61  */
62 
63 #ifndef	_AMD64_PMAP_H_
64 #define	_AMD64_PMAP_H_
65 
66 #ifdef __x86_64__
67 
68 #if defined(_KERNEL_OPT)
69 #include "opt_xen.h"
70 #include "opt_kasan.h"
71 #include "opt_kmsan.h"
72 #include "opt_kubsan.h"
73 #endif
74 
75 #include <sys/atomic.h>
76 
77 #include <machine/pte.h>
78 #include <machine/segments.h>
79 #ifdef _KERNEL
80 #include <machine/cpufunc.h>
81 #endif
82 
83 #include <uvm/uvm_object.h>
84 #ifdef XENPV
85 #include <xen/xenfunc.h>
86 #include <xen/xenpmap.h>
87 #endif
88 
89 /*
90  * Mask to get rid of the sign-extended part of addresses.
91  */
92 #define VA_SIGN_MASK		0xffff000000000000
93 #define VA_SIGN_NEG(va)		((va) | VA_SIGN_MASK)
94 /* XXXfvdl this one's not right. */
95 #define VA_SIGN_POS(va)		((va) & ~VA_SIGN_MASK)
96 
97 #ifdef KASAN
98 #define L4_SLOT_KASAN		256
99 #define NL4_SLOT_KASAN		32
100 #endif
101 
102 #ifdef KMSAN
103 #define L4_SLOT_KMSAN		256
104 #define NL4_SLOT_KMSAN		4
105 #endif
106 
107 #define NL4_SLOT_DIRECT		32
108 
109 #ifndef XENPV
110 #define L4_SLOT_PTE		slotspace.area[SLAREA_PTE].sslot
111 #else
112 #define L4_SLOT_PTE		509
113 #endif
114 #define L4_SLOT_KERN		slotspace.area[SLAREA_MAIN].sslot
115 #define L4_SLOT_KERNBASE	511 /* pl4_i(KERNBASE) */
116 
117 #define PDIR_SLOT_USERLIM	255
118 #define PDIR_SLOT_KERN	L4_SLOT_KERN
119 #define PDIR_SLOT_PTE	L4_SLOT_PTE
120 
121 /*
122  * The following defines give the virtual addresses of various MMU
123  * data structures:
124  * PTE_BASE: the base VA of the linear PTE mappings
125  * PDP_BASE: the base VA of the recursive mapping of the PTD
126  */
127 
128 #ifndef XENPV
129 extern pt_entry_t *pte_base;
130 #define PTE_BASE	pte_base
131 #else
132 #define PTE_BASE	((pt_entry_t *)VA_SIGN_NEG((L4_SLOT_PTE * NBPD_L4)))
133 #endif
134 
135 #define L1_BASE	PTE_BASE
136 #define L2_BASE	((pd_entry_t *)((char *)L1_BASE + L4_SLOT_PTE * NBPD_L3))
137 #define L3_BASE	((pd_entry_t *)((char *)L2_BASE + L4_SLOT_PTE * NBPD_L2))
138 #define L4_BASE	((pd_entry_t *)((char *)L3_BASE + L4_SLOT_PTE * NBPD_L1))
139 
140 #define PDP_BASE	L4_BASE
141 
142 #if defined(KMSAN)
143 #define NKL4_MAX_ENTRIES	(unsigned long)1	/* 512GB only */
144 #else
145 #define NKL4_MAX_ENTRIES	(unsigned long)64
146 #endif
147 #define NKL3_MAX_ENTRIES	(unsigned long)(NKL4_MAX_ENTRIES * 512)
148 #define NKL2_MAX_ENTRIES	(unsigned long)(NKL3_MAX_ENTRIES * 512)
149 #define NKL1_MAX_ENTRIES	(unsigned long)(NKL2_MAX_ENTRIES * 512)
150 
151 #define NKL4_KIMG_ENTRIES	1
152 #define NKL3_KIMG_ENTRIES	1
153 #if defined(KUBSAN) || defined(KMSAN)
154 #define NKL2_KIMG_ENTRIES	64	/* really big kernel */
155 #else
156 #define NKL2_KIMG_ENTRIES	48
157 #endif
158 
159 /*
160  * Since kva space is below the kernel in its entirety, we start off
161  * with zero entries on each level.
162  */
163 #define NKL4_START_ENTRIES	0
164 #define NKL3_START_ENTRIES	0
165 #define NKL2_START_ENTRIES	0
166 #define NKL1_START_ENTRIES	0
167 
168 #define PTP_MASK_INITIALIZER	{ L1_MASK, L2_MASK, L3_MASK, L4_MASK }
169 #define PTP_FRAME_INITIALIZER	{ L1_FRAME, L2_FRAME, L3_FRAME, L4_FRAME }
170 #define PTP_SHIFT_INITIALIZER	{ L1_SHIFT, L2_SHIFT, L3_SHIFT, L4_SHIFT }
171 #define NKPTP_INITIALIZER	{ NKL1_START_ENTRIES, NKL2_START_ENTRIES, \
172 				  NKL3_START_ENTRIES, NKL4_START_ENTRIES }
173 #define NKPTPMAX_INITIALIZER	{ NKL1_MAX_ENTRIES, NKL2_MAX_ENTRIES, \
174 				  NKL3_MAX_ENTRIES, NKL4_MAX_ENTRIES }
175 #define NBPD_INITIALIZER	{ NBPD_L1, NBPD_L2, NBPD_L3, NBPD_L4 }
176 #define PDES_INITIALIZER	{ L2_BASE, L3_BASE, L4_BASE }
177 
178 #define PTP_LEVELS	4
179 
180 /*
181  * PTE_AVL usage: we make use of the ignored bits of the PTE
182  */
183 #define PTE_WIRED	PTE_AVL1	/* Wired Mapping */
184 #define PTE_PVLIST	PTE_AVL2	/* Mapping has entry on pvlist */
185 #define PTE_X		0		/* Dummy */
186 
187 /* XXX To be deleted. */
188 #define PG_W		PTE_WIRED
189 #define PG_PVLIST	PTE_PVLIST
190 #define PG_X		PTE_X
191 
192 void svs_pmap_sync(struct pmap *, int);
193 void svs_ldt_sync(struct pmap *);
194 void svs_lwp_switch(struct lwp *, struct lwp *);
195 void svs_pdir_switch(struct pmap *);
196 void svs_init(void);
197 extern bool svs_enabled;
198 extern bool svs_pcid;
199 
200 #include <x86/pmap.h>
201 
202 #ifndef XENPV
203 #define pmap_pa2pte(a)			(a)
204 #define pmap_pte2pa(a)			((a) & PTE_FRAME)
205 #define pmap_pte_set(p, n)		\
206     (void)atomic_swap_ulong((volatile unsigned long *)p, n)
207 #define pmap_pte_cas(p, o, n)		atomic_cas_64((p), (o), (n))
208 #define pmap_pte_testset(p, n)		\
209     atomic_swap_ulong((volatile unsigned long *)p, n)
210 #define pmap_pte_setbits(p, b)		\
211     atomic_or_ulong((volatile unsigned long *)p, b)
212 #define pmap_pte_clearbits(p, b)	\
213     atomic_and_ulong((volatile unsigned long *)p, ~(b))
214 #define pmap_pte_flush()		/* nothing */
215 #else
216 extern kmutex_t pte_lock;
217 
218 static __inline pt_entry_t
219 pmap_pa2pte(paddr_t pa)
220 {
221 	return (pt_entry_t)xpmap_ptom_masked(pa);
222 }
223 
224 static __inline paddr_t
225 pmap_pte2pa(pt_entry_t pte)
226 {
227 	return xpmap_mtop_masked(pte & PTE_FRAME);
228 }
229 
230 static __inline void
231 pmap_pte_set(pt_entry_t *pte, pt_entry_t npte)
232 {
233 	int s = splvm();
234 	xpq_queue_pte_update(xpmap_ptetomach(pte), npte);
235 	splx(s);
236 }
237 
238 static __inline pt_entry_t
239 pmap_pte_cas(volatile pt_entry_t *ptep, pt_entry_t o, pt_entry_t n)
240 {
241 	pt_entry_t opte;
242 
243 	mutex_enter(&pte_lock);
244 	opte = *ptep;
245 	if (opte == o) {
246 		xpq_queue_pte_update(xpmap_ptetomach(__UNVOLATILE(ptep)), n);
247 		xpq_flush_queue();
248 	}
249 
250 	mutex_exit(&pte_lock);
251 	return opte;
252 }
253 
254 static __inline pt_entry_t
255 pmap_pte_testset(volatile pt_entry_t *pte, pt_entry_t npte)
256 {
257 	pt_entry_t opte;
258 
259 	mutex_enter(&pte_lock);
260 	opte = *pte;
261 	xpq_queue_pte_update(xpmap_ptetomach(__UNVOLATILE(pte)), npte);
262 	xpq_flush_queue();
263 	mutex_exit(&pte_lock);
264 	return opte;
265 }
266 
267 static __inline void
268 pmap_pte_setbits(volatile pt_entry_t *pte, pt_entry_t bits)
269 {
270 	mutex_enter(&pte_lock);
271 	xpq_queue_pte_update(xpmap_ptetomach(__UNVOLATILE(pte)), (*pte) | bits);
272 	xpq_flush_queue();
273 	mutex_exit(&pte_lock);
274 }
275 
276 static __inline void
277 pmap_pte_clearbits(volatile pt_entry_t *pte, pt_entry_t bits)
278 {
279 	mutex_enter(&pte_lock);
280 	xpq_queue_pte_update(xpmap_ptetomach(__UNVOLATILE(pte)),
281 	    (*pte) & ~bits);
282 	xpq_flush_queue();
283 	mutex_exit(&pte_lock);
284 }
285 
286 static __inline void
287 pmap_pte_flush(void)
288 {
289 	int s = splvm();
290 	xpq_flush_queue();
291 	splx(s);
292 }
293 #endif
294 
295 #ifdef __HAVE_DIRECT_MAP
296 #define PMAP_DIRECT
297 
298 static __inline int
299 pmap_direct_process(paddr_t pa, voff_t pgoff, size_t len,
300     int (*process)(void *, size_t, void *), void *arg)
301 {
302 	vaddr_t va = PMAP_DIRECT_MAP(pa);
303 
304 	return process((void *)(va + pgoff), len, arg);
305 }
306 
307 #endif /* __HAVE_DIRECT_MAP */
308 
309 void pmap_changeprot_local(vaddr_t, vm_prot_t);
310 
311 #include <x86/pmap_pv.h>
312 
313 #define	__HAVE_VM_PAGE_MD
314 #define	VM_MDPAGE_INIT(pg) \
315 	memset(&(pg)->mdpage, 0, sizeof((pg)->mdpage)); \
316 	PMAP_PAGE_INIT(&(pg)->mdpage.mp_pp)
317 
318 struct vm_page_md {
319 	struct pmap_page mp_pp;
320 };
321 
322 #else	/*	!__x86_64__	*/
323 
324 #include <i386/pmap.h>
325 
326 #endif	/*	__x86_64__	*/
327 
328 #endif	/* _AMD64_PMAP_H_ */
329