pmap.h revision 1.19
1/* $NetBSD: pmap.h,v 1.19 1998/05/19 02:04:28 thorpej Exp $ */
2
3/*-
4 * Copyright (c) 1998 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) 1987 Carnegie-Mellon University
42 * Copyright (c) 1991, 1993
43 *	The Regents of the University of California.  All rights reserved.
44 *
45 * This code is derived from software contributed to Berkeley by
46 * the Systems Programming Group of the University of Utah Computer
47 * Science Department.
48 *
49 * Redistribution and use in source and binary forms, with or without
50 * modification, are permitted provided that the following conditions
51 * are met:
52 * 1. Redistributions of source code must retain the above copyright
53 *    notice, this list of conditions and the following disclaimer.
54 * 2. Redistributions in binary form must reproduce the above copyright
55 *    notice, this list of conditions and the following disclaimer in the
56 *    documentation and/or other materials provided with the distribution.
57 * 3. All advertising materials mentioning features or use of this software
58 *    must display the following acknowledgement:
59 *	This product includes software developed by the University of
60 *	California, Berkeley and its contributors.
61 * 4. Neither the name of the University nor the names of its contributors
62 *    may be used to endorse or promote products derived from this software
63 *    without specific prior written permission.
64 *
65 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
66 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
67 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
68 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
69 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
70 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
71 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
72 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
73 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
74 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
75 * SUCH DAMAGE.
76 *
77 *	@(#)pmap.h	8.1 (Berkeley) 6/10/93
78 */
79
80#ifndef	_PMAP_MACHINE_
81#define	_PMAP_MACHINE_
82
83#include <sys/queue.h>
84#include <machine/pte.h>
85
86/*
87 * Machine-dependent virtual memory state.
88 *
89 * If we ever support processor numbers higher than 63, we'll have to
90 * rethink the CPU mask.
91 *
92 * XXX When we support multiple processors, pm_asn and pm_asngen need
93 * XXX to be per-processor.
94 */
95struct pmap {
96	LIST_ENTRY(pmap)	pm_list;	/* list of all pmaps */
97	pt_entry_t		*pm_lev1map;	/* level 1 map */
98	int			pm_count;	/* pmap reference count */
99	simple_lock_data_t	pm_lock;	/* lock on pmap */
100	struct pmap_statistics	pm_stats;	/* pmap statistics */
101	long			pm_nlev2;	/* level 2 pt page count */
102	long			pm_nlev3;	/* level 3 pt page count */
103	unsigned int		pm_asn;		/* address space number */
104	unsigned long		pm_asngen;	/* ASN generation number */
105	unsigned long		pm_cpus;	/* mask of CPUs using pmap */
106};
107
108typedef struct pmap	*pmap_t;
109
110#define	PMAP_ASN_RESERVED	0	/* reserved for Lev1map users */
111
112extern struct pmap	kernel_pmap_store;
113
114#define pmap_kernel()	(&kernel_pmap_store)
115
116/*
117 * For each vm_page_t, there is a list of all currently valid virtual
118 * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
119 */
120typedef struct pv_entry {
121	LIST_ENTRY(pv_entry) pv_list;	/* pv_entry list */
122	struct pmap	*pv_pmap;	/* pmap where mapping lies */
123	vm_offset_t	pv_va;		/* virtual address for mapping */
124} *pv_entry_t;
125
126/*
127 * The head of the list of pv_entry_t's, also contains page attributes.
128 */
129struct pv_head {
130	LIST_HEAD(, pv_entry) pvh_list;		/* pv_entry list */
131	int pvh_attrs;				/* page attributes */
132	int pvh_usage;				/* page usage */
133	int pvh_refcnt;				/* special use ref count */
134};
135
136/* pvh_attrs */
137#define	PGA_MODIFIED		0x01		/* modified */
138#define	PGA_REFERENCED		0x02		/* referenced */
139
140/* pvh_usage */
141#define	PGU_NORMAL		0		/* free or normal use */
142#define	PGU_PVENT		1		/* PV entries */
143#define	PGU_L1PT		2		/* level 1 page table */
144#define	PGU_L2PT		3		/* level 2 page table */
145#define	PGU_L3PT		4		/* level 3 page table */
146
147#define	PGU_ISPTPAGE(pgu)	((pgu) >= PGU_L1PT)
148
149struct pv_page_info {
150	TAILQ_ENTRY(pv_page) pgi_list;
151	LIST_HEAD(, pv_entry) pgi_freelist;
152	int pgi_nfree;
153};
154
155struct pv_page {
156	struct pv_page_info pvp_pgi;
157	struct pv_entry pvp_pv[1];		/* variable length */
158};
159
160#ifdef _KERNEL
161
162#ifndef _LKM
163#include "opt_new_scc_driver.h"
164#include "opt_dec_3000_300.h"			/* XXX */
165#include "opt_dec_3000_500.h"			/* XXX */
166#include "opt_dec_kn8ae.h"			/* XXX */
167#include "opt_dec_kn300.h"			/* XXX */
168
169#if defined(NEW_SCC_DRIVER)
170#if defined(DEC_KN8AE) || defined(DEC_KN300)
171#define	_PMAP_MAY_USE_PROM_CONSOLE
172#endif
173#else /* ! NEW_SCC_DRIVER */
174#if defined(DEC_3000_300)		\
175 || defined(DEC_3000_500)		\
176 || defined(DEC_KN300)			\
177 || defined(DEC_KN8AE) 				/* XXX */
178#define _PMAP_MAY_USE_PROM_CONSOLE		/* XXX */
179#endif						/* XXX */
180#endif /* NEW_SCC_DRIVER */
181#endif /* _LKM */
182
183#define	pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
184#define	pmap_wired_count(pmap)		((pmap)->pm_stats.wired_count)
185
186extern	pt_entry_t *VPT;		/* Virtual Page Table */
187
188#define	PMAP_STEAL_MEMORY		/* enable pmap_steal_memory() */
189
190vm_offset_t vtophys __P((vm_offset_t));
191
192/* Machine-specific functions. */
193void	pmap_bootstrap __P((vm_offset_t ptaddr, u_int maxasn));
194void	pmap_emulate_reference __P((struct proc *p, vm_offset_t v,
195		int user, int write));
196#ifdef _PMAP_MAY_USE_PROM_CONSOLE
197int	pmap_uses_prom_console __P((void));
198#endif
199
200#define	pmap_pte_pa(pte)	(PG_PFNUM(*(pte)) << PGSHIFT)
201#define	pmap_pte_prot(pte)	(*(pte) & PG_PROT)
202#define	pmap_pte_w(pte)		(*(pte) & PG_WIRED)
203#define	pmap_pte_v(pte)		(*(pte) & PG_V)
204#define	pmap_pte_pv(pte)	(*(pte) & PG_PVLIST)
205#define	pmap_pte_asm(pte)	(*(pte) & PG_ASM)
206
207#define	pmap_pte_set_w(pte, v)						\
208do {									\
209	if (v)								\
210		*(pte) |= PG_WIRED;					\
211	else								\
212		*(pte) &= ~PG_WIRED;					\
213} while (0)
214
215#define	pmap_pte_w_chg(pte, nw)	((nw) ^ pmap_pte_w(pte))
216
217#define	pmap_pte_set_prot(pte, np)					\
218do {									\
219	*(pte) &= ~PG_PROT;						\
220	*(pte) |= (np);							\
221} while (0)
222
223#define	pmap_pte_prot_chg(pte, np) ((np) ^ pmap_pte_prot(pte))
224
225static __inline pt_entry_t *pmap_l2pte __P((pmap_t, vm_offset_t, pt_entry_t *));
226static __inline pt_entry_t *pmap_l3pte __P((pmap_t, vm_offset_t, pt_entry_t *));
227
228#define	pmap_l1pte(pmap, v)						\
229	(&(pmap)->pm_lev1map[l1pte_index((vm_offset_t)(v))])
230
231static __inline pt_entry_t *
232pmap_l2pte(pmap, v, l1pte)
233	pmap_t pmap;
234	vm_offset_t v;
235	pt_entry_t *l1pte;
236{
237	pt_entry_t *lev2map;
238
239	if (l1pte == NULL) {
240		l1pte = pmap_l1pte(pmap, v);
241		if (pmap_pte_v(l1pte) == 0)
242			return (NULL);
243	}
244
245	lev2map = (pt_entry_t *)ALPHA_PHYS_TO_K0SEG(pmap_pte_pa(l1pte));
246	return (&lev2map[l2pte_index(v)]);
247}
248
249static __inline pt_entry_t *
250pmap_l3pte(pmap, v, l2pte)
251	pmap_t pmap;
252	vm_offset_t v;
253	pt_entry_t *l2pte;
254{
255	pt_entry_t *l1pte, *lev2map, *lev3map;
256
257	if (l2pte == NULL) {
258		l1pte = pmap_l1pte(pmap, v);
259		if (pmap_pte_v(l1pte) == 0)
260			return (NULL);
261
262		lev2map = (pt_entry_t *)ALPHA_PHYS_TO_K0SEG(pmap_pte_pa(l1pte));
263		l2pte = &lev2map[l2pte_index(v)];
264		if (pmap_pte_v(l2pte) == 0)
265			return (NULL);
266	}
267
268	lev3map = (pt_entry_t *)ALPHA_PHYS_TO_K0SEG(pmap_pte_pa(l2pte));
269	return (&lev3map[l3pte_index(v)]);
270}
271
272#endif /* _KERNEL */
273
274#endif /* _PMAP_MACHINE_ */
275