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