xref: /netbsd-src/sys/arch/alpha/include/pmap.h (revision a8c74629f602faa0ccf8a463757d7baf858bbf3a)
1 /* $NetBSD: pmap.h,v 1.84 2020/09/03 02:09:09 thorpej Exp $ */
2 
3 /*-
4  * Copyright (c) 1998, 1999, 2000, 2001, 2007 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9  * NASA Ames Research Center and by Chris G. Demetriou.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * Copyright (c) 1991, 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * This code is derived from software contributed to Berkeley by
38  * the Systems Programming Group of the University of Utah Computer
39  * Science Department.
40  *
41  * Redistribution and use in source and binary forms, with or without
42  * modification, are permitted provided that the following conditions
43  * are met:
44  * 1. Redistributions of source code must retain the above copyright
45  *    notice, this list of conditions and the following disclaimer.
46  * 2. Redistributions in binary form must reproduce the above copyright
47  *    notice, this list of conditions and the following disclaimer in the
48  *    documentation and/or other materials provided with the distribution.
49  * 3. Neither the name of the University nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  *	@(#)pmap.h	8.1 (Berkeley) 6/10/93
66  */
67 
68 /*
69  * Copyright (c) 1987 Carnegie-Mellon University
70  *
71  * This code is derived from software contributed to Berkeley by
72  * the Systems Programming Group of the University of Utah Computer
73  * Science Department.
74  *
75  * Redistribution and use in source and binary forms, with or without
76  * modification, are permitted provided that the following conditions
77  * are met:
78  * 1. Redistributions of source code must retain the above copyright
79  *    notice, this list of conditions and the following disclaimer.
80  * 2. Redistributions in binary form must reproduce the above copyright
81  *    notice, this list of conditions and the following disclaimer in the
82  *    documentation and/or other materials provided with the distribution.
83  * 3. All advertising materials mentioning features or use of this software
84  *    must display the following acknowledgement:
85  *	This product includes software developed by the University of
86  *	California, Berkeley and its contributors.
87  * 4. Neither the name of the University nor the names of its contributors
88  *    may be used to endorse or promote products derived from this software
89  *    without specific prior written permission.
90  *
91  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
92  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
94  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
95  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
96  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
97  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
98  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
99  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
100  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
101  * SUCH DAMAGE.
102  *
103  *	@(#)pmap.h	8.1 (Berkeley) 6/10/93
104  */
105 
106 #ifndef	_PMAP_MACHINE_
107 #define	_PMAP_MACHINE_
108 
109 #if defined(_KERNEL_OPT)
110 #include "opt_multiprocessor.h"
111 #endif
112 
113 #include <sys/mutex.h>
114 #include <sys/queue.h>
115 
116 #include <machine/pte.h>
117 
118 /*
119  * Machine-dependent virtual memory state.
120  *
121  * If we ever support processor numbers higher than 63, we'll have to
122  * rethink the CPU mask.
123  *
124  * Note pm_asn and pm_asngen are arrays allocated in pmap_create().
125  * Their size is based on the PCS count from the HWRPB, and indexed
126  * by processor ID (from `whami').  This is all padded to COHERENCY_UNIT
127  * to avoid false sharing.
128  *
129  * The kernel pmap is a special case; since the kernel uses only ASM
130  * mappings and uses a reserved ASN to keep the TLB clean, we don't
131  * allocate any ASN info for the kernel pmap at all.
132  * arrays which hold enough for ALPHA_MAXPROCS.
133  */
134 struct pmap_asn_info {
135 	unsigned int		pma_asn;	/* address space number */
136 	unsigned int		pma_pad0;
137 	unsigned long		pma_asngen;	/* ASN generation number */
138 	unsigned long		pma_padN[(COHERENCY_UNIT / 8) - 2];
139 };
140 
141 struct pmap {	/* pmaps are aligned to COHERENCY_UNIT boundaries */
142 		/* pmaps are locked by hashed mutexes */
143 	pt_entry_t		*pm_lev1map;	/* [ 0] level 1 map */
144 	unsigned long		pm_cpus;	/* [ 8] CPUs using pmap */
145 	unsigned long		pm_needisync;	/* [16] CPUs needing isync */
146 	struct pmap_statistics	pm_stats;	/* [32] statistics */
147 	long			pm_count;	/* [40] reference count */
148 	TAILQ_ENTRY(pmap)	pm_list;	/* [48] list of all pmaps */
149 	/* -- COHERENCY_UNIT boundary -- */
150 	struct pmap_asn_info	pm_asni[];	/* [64] ASN information */
151 			/*	variable length		*/
152 };
153 
154 #define	PMAP_SIZEOF(x)							\
155 	(ALIGN(offsetof(struct pmap, pm_asni[(x)])))
156 
157 #define	PMAP_ASN_KERNEL		0	/* kernel-reserved ASN */
158 #define	PMAP_ASN_FIRST_USER	1	/* first user ASN */
159 #define	PMAP_ASNGEN_INVALID	0	/* reserved (invalid) ASN generation */
160 #define	PMAP_ASNGEN_INITIAL	1	/* first valid generatation */
161 
162 /*
163  * For each struct vm_page, there is a list of all currently valid virtual
164  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
165  */
166 typedef struct pv_entry {
167 	struct pv_entry	*pv_next;	/* next pv_entry on list */
168 	struct pmap	*pv_pmap;	/* pmap where mapping lies */
169 	vaddr_t		pv_va;		/* virtual address for mapping */
170 	pt_entry_t	*pv_pte;	/* PTE that maps the VA */
171 } *pv_entry_t;
172 
173 /* pvh_attrs */
174 #define	PGA_MODIFIED		0x01		/* modified */
175 #define	PGA_REFERENCED		0x02		/* referenced */
176 
177 /* pvh_usage */
178 #define	PGU_NORMAL		0		/* free or normal use */
179 #define	PGU_PVENT		1		/* PV entries */
180 #define	PGU_L1PT		2		/* level 1 page table */
181 #define	PGU_L2PT		3		/* level 2 page table */
182 #define	PGU_L3PT		4		/* level 3 page table */
183 
184 #ifdef _KERNEL
185 
186 #include <sys/atomic.h>
187 
188 struct cpu_info;
189 struct trapframe;
190 
191 void	pmap_init_cpu(struct cpu_info *);
192 #if defined(MULTIPROCESSOR)
193 void	pmap_tlb_shootdown_ipi(struct cpu_info *, struct trapframe *);
194 #endif /* MULTIPROCESSOR */
195 
196 #define	pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
197 #define	pmap_wired_count(pmap)		((pmap)->pm_stats.wired_count)
198 
199 #define	pmap_copy(dp, sp, da, l, sa)	/* nothing */
200 #define	pmap_update(pmap)		/* nothing (yet) */
201 
202 static __inline bool
203 pmap_remove_all(struct pmap *pmap)
204 {
205 	/* Nothing. */
206 	return false;
207 }
208 
209 #define	pmap_is_referenced(pg)						\
210 	(((pg)->mdpage.pvh_attrs & PGA_REFERENCED) != 0)
211 #define	pmap_is_modified(pg)						\
212 	(((pg)->mdpage.pvh_attrs & PGA_MODIFIED) != 0)
213 
214 #define	PMAP_STEAL_MEMORY		/* enable pmap_steal_memory() */
215 #define	PMAP_GROWKERNEL			/* enable pmap_growkernel() */
216 
217 #define	PMAP_DIRECT
218 #define	PMAP_DIRECT_MAP(pa)		ALPHA_PHYS_TO_K0SEG((pa))
219 #define	PMAP_DIRECT_UNMAP(va)		ALPHA_K0SEG_TO_PHYS((va))
220 
221 static __inline int
222 pmap_direct_process(paddr_t pa, voff_t pgoff, size_t len,
223     int (*process)(void *, size_t, void *), void *arg)
224 {
225 	vaddr_t va = PMAP_DIRECT_MAP(pa);
226 
227 	return process((void *)(va + pgoff), len, arg);
228 }
229 
230 /*
231  * Alternate mapping hooks for pool pages.  Avoids thrashing the TLB.
232  */
233 #define	PMAP_MAP_POOLPAGE(pa)		PMAP_DIRECT_MAP(pa)
234 #define	PMAP_UNMAP_POOLPAGE(va)		PMAP_DIRECT_UNMAP(va)
235 
236 /*
237  * Other hooks for the pool allocator.
238  */
239 #define	POOL_VTOPHYS(va)		ALPHA_K0SEG_TO_PHYS((vaddr_t) (va))
240 
241 bool	pmap_pageidlezero(paddr_t);
242 #define	PMAP_PAGEIDLEZERO(pa)	pmap_pageidlezero((pa))
243 
244 paddr_t vtophys(vaddr_t);
245 
246 /* Machine-specific functions. */
247 void	pmap_bootstrap(paddr_t, u_int, u_long);
248 int	pmap_emulate_reference(struct lwp *, vaddr_t, int, int);
249 
250 #define	pmap_pte_pa(pte)	(PG_PFNUM(*(pte)) << PGSHIFT)
251 #define	pmap_pte_prot(pte)	(*(pte) & PG_PROT)
252 #define	pmap_pte_w(pte)		(*(pte) & PG_WIRED)
253 #define	pmap_pte_v(pte)		(*(pte) & PG_V)
254 #define	pmap_pte_pv(pte)	(*(pte) & PG_PVLIST)
255 #define	pmap_pte_asm(pte)	(*(pte) & PG_ASM)
256 #define	pmap_pte_exec(pte)	(*(pte) & PG_EXEC)
257 
258 #define	pmap_pte_set_w(pte, v)						\
259 do {									\
260 	if (v)								\
261 		*(pte) |= PG_WIRED;					\
262 	else								\
263 		*(pte) &= ~PG_WIRED;					\
264 } while (0)
265 
266 #define	pmap_pte_w_chg(pte, nw)	((nw) ^ pmap_pte_w(pte))
267 
268 #define	pmap_pte_set_prot(pte, np)					\
269 do {									\
270 	*(pte) &= ~PG_PROT;						\
271 	*(pte) |= (np);							\
272 } while (0)
273 
274 #define	pmap_pte_prot_chg(pte, np) ((np) ^ pmap_pte_prot(pte))
275 
276 static __inline pt_entry_t *pmap_l2pte(pmap_t, vaddr_t, pt_entry_t *);
277 static __inline pt_entry_t *pmap_l3pte(pmap_t, vaddr_t, pt_entry_t *);
278 
279 #define	pmap_l1pte(pmap, v)						\
280 	(&(pmap)->pm_lev1map[l1pte_index((vaddr_t)(v))])
281 
282 static __inline pt_entry_t *
283 pmap_l2pte(pmap_t pmap, vaddr_t v, pt_entry_t *l1pte)
284 {
285 	pt_entry_t *lev2map;
286 
287 	if (l1pte == NULL) {
288 		l1pte = pmap_l1pte(pmap, v);
289 		if (pmap_pte_v(l1pte) == 0)
290 			return (NULL);
291 	}
292 
293 	lev2map = (pt_entry_t *)ALPHA_PHYS_TO_K0SEG(pmap_pte_pa(l1pte));
294 	return (&lev2map[l2pte_index(v)]);
295 }
296 
297 static __inline pt_entry_t *
298 pmap_l3pte(pmap_t pmap, vaddr_t v, pt_entry_t *l2pte)
299 {
300 	pt_entry_t *l1pte, *lev2map, *lev3map;
301 
302 	if (l2pte == NULL) {
303 		l1pte = pmap_l1pte(pmap, v);
304 		if (pmap_pte_v(l1pte) == 0)
305 			return (NULL);
306 
307 		lev2map = (pt_entry_t *)ALPHA_PHYS_TO_K0SEG(pmap_pte_pa(l1pte));
308 		l2pte = &lev2map[l2pte_index(v)];
309 		if (pmap_pte_v(l2pte) == 0)
310 			return (NULL);
311 	}
312 
313 	lev3map = (pt_entry_t *)ALPHA_PHYS_TO_K0SEG(pmap_pte_pa(l2pte));
314 	return (&lev3map[l3pte_index(v)]);
315 }
316 
317 /*
318  * Macro for processing deferred I-stream synchronization.
319  *
320  * The pmap module may defer syncing the user I-stream until the
321  * return to userspace, since the IMB PALcode op can be quite
322  * expensive.  Since user instructions won't be executed until
323  * the return to userspace, this can be deferred until userret().
324  */
325 #define	PMAP_USERRET(pmap)						\
326 do {									\
327 	u_long cpu_mask = (1UL << cpu_number());			\
328 									\
329 	if ((pmap)->pm_needisync & cpu_mask) {				\
330 		atomic_and_ulong(&(pmap)->pm_needisync,	~cpu_mask);	\
331 		alpha_pal_imb();					\
332 	}								\
333 } while (0)
334 
335 /*
336  * pmap-specific data store in the vm_page structure.
337  */
338 #define	__HAVE_VM_PAGE_MD
339 struct vm_page_md {
340 	struct pv_entry *pvh_list;		/* pv_entry list */
341 	int pvh_attrs;				/* page attributes */
342 	unsigned pvh_refcnt;
343 };
344 
345 #define	VM_MDPAGE_INIT(pg)						\
346 do {									\
347 	(pg)->mdpage.pvh_list = NULL;					\
348 	(pg)->mdpage.pvh_refcnt = 0;					\
349 } while (/*CONSTCOND*/0)
350 
351 #endif /* _KERNEL */
352 
353 #endif /* _PMAP_MACHINE_ */
354