xref: /netbsd-src/sys/arch/vax/include/pmap.h (revision c2f76ff004a2cb67efe5b12d97bd3ef7fe89e18d)
1 /*	$NetBSD: pmap.h,v 1.79 2010/11/14 13:33:23 uebayasi Exp $	   */
2 
3 /*
4  * Copyright (c) 1991 Regents of the University of California.
5  * All rights reserved.
6  *
7  * Changed for the VAX port. /IC
8  *
9  * This code is derived from software contributed to Berkeley by
10  * the Systems Programming Group of the University of Utah Computer
11  * Science Department.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)pmap.h	7.6 (Berkeley) 5/10/91
38  */
39 
40 /*
41  * Copyright (c) 1987 Carnegie-Mellon University
42  *
43  * Changed for the VAX port. /IC
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	7.6 (Berkeley) 5/10/91
78  */
79 
80 
81 #ifndef PMAP_H
82 #define PMAP_H
83 
84 #include <sys/simplelock.h>
85 
86 #include <uvm/uvm_page.h>
87 
88 #include <machine/pte.h>
89 #include <machine/mtpr.h>
90 #include <machine/pcb.h>
91 
92 /*
93  * Some constants to make life easier.
94  */
95 #define LTOHPS		(PGSHIFT - VAX_PGSHIFT)
96 #define LTOHPN		(1 << LTOHPS)
97 
98 /*
99  * Pmap structure
100  *  pm_stack holds lowest allocated memory for the process stack.
101  */
102 
103 struct pmap {
104 	struct pte	*pm_p1ap;	/* Base of alloced p1 pte space */
105 	int		 pm_count;	/* reference count */
106 	struct pcb	*pm_pcbs;	/* PCBs using this pmap */
107 	struct pte	*pm_p0br;	/* page 0 base register */
108 	long		 pm_p0lr;	/* page 0 length register */
109 	struct pte	*pm_p1br;	/* page 1 base register */
110 	long		 pm_p1lr;	/* page 1 length register */
111 	struct simplelock pm_lock;	/* Lock entry in MP environment */
112 	struct pmap_statistics	 pm_stats;	/* Some statistics */
113 };
114 
115 /*
116  * For each struct vm_page, there is a list of all currently valid virtual
117  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
118  */
119 
120 struct pv_entry {
121 	struct pv_entry *pv_next;	/* next pv_entry */
122 	vaddr_t		 pv_vaddr;	/* address for this physical page */
123 	struct pmap	*pv_pmap;	/* pmap this entry belongs to */
124 	int		 pv_attr;	/* write/modified bits */
125 };
126 
127 extern	struct  pv_entry *pv_table;
128 
129 /* Mapping macros used when allocating SPT */
130 #define MAPVIRT(ptr, count)				\
131 	ptr = virtual_avail;		\
132 	virtual_avail += (count) * VAX_NBPG;
133 
134 #define MAPPHYS(ptr, count, perm)			\
135 	ptr = avail_start + KERNBASE;	\
136 	avail_start += (count) * VAX_NBPG;
137 
138 
139 /*
140  * Real nice (fast) routines to get the virtual address of a physical page
141  * (and vice versa).
142  */
143 #define	PMAP_VTOPHYS(va)	((va) & ~KERNBASE)
144 #define PMAP_MAP_POOLPAGE(pa)	((pa) | KERNBASE)
145 #define PMAP_UNMAP_POOLPAGE(va) ((va) & ~KERNBASE)
146 
147 #define PMAP_STEAL_MEMORY
148 
149 /*
150  * This is the by far most used pmap routine. Make it inline.
151  */
152 __inline static bool
153 pmap_extract(pmap_t pmap, vaddr_t va, paddr_t *pap)
154 {
155 	int	*pte, sva;
156 
157 	if (va & KERNBASE) {
158 		paddr_t pa;
159 
160 		pa = kvtophys(va); /* Is 0 if not mapped */
161 		if (pap)
162 			*pap = pa;
163 		if (pa)
164 			return (true);
165 		return (false);
166 	}
167 
168 	sva = PG_PFNUM(va);
169 	if (va < 0x40000000) {
170 		if (sva >= (pmap->pm_p0lr & ~AST_MASK))
171 			goto fail;
172 		pte = (int *)pmap->pm_p0br;
173 	} else {
174 		if (sva < pmap->pm_p1lr)
175 			goto fail;
176 		pte = (int *)pmap->pm_p1br;
177 	}
178 	/*
179 	 * Since the PTE tables are sparsely allocated, make sure the page
180 	 * table page actually exists before deferencing the pte itself.
181 	 */
182 	if (kvtopte(&pte[sva])->pg_v && (pte[sva] & PG_FRAME)) {
183 		if (pap)
184 			*pap = (pte[sva] & PG_FRAME) << VAX_PGSHIFT;
185 		return (true);
186 	}
187   fail:
188 	if (pap)
189 		*pap = 0;
190 	return (false);
191 }
192 
193 bool pmap_clear_modify_long(struct pv_entry *);
194 bool pmap_clear_reference_long(struct pv_entry *);
195 bool pmap_is_modified_long(struct pv_entry *);
196 void pmap_page_protect_long(struct pv_entry *, vm_prot_t);
197 void pmap_protect_long(pmap_t, vaddr_t, vaddr_t, vm_prot_t);
198 
199 __inline static bool
200 pmap_is_referenced(struct vm_page *pg)
201 {
202 	struct pv_entry *pv = pv_table + (VM_PAGE_TO_PHYS(pg) >> PGSHIFT);
203 	bool rv = (pv->pv_attr & PG_V) != 0;
204 
205 	return rv;
206 }
207 
208 __inline static bool
209 pmap_clear_reference(struct vm_page *pg)
210 {
211 	struct pv_entry *pv = pv_table + (VM_PAGE_TO_PHYS(pg) >> PGSHIFT);
212 	bool rv = (pv->pv_attr & PG_V) != 0;
213 
214 	pv->pv_attr &= ~PG_V;
215 	if (pv->pv_pmap != NULL || pv->pv_next != NULL)
216 		rv |= pmap_clear_reference_long(pv);
217 	return rv;
218 }
219 
220 __inline static bool
221 pmap_clear_modify(struct vm_page *pg)
222 {
223 	struct  pv_entry *pv = pv_table + (VM_PAGE_TO_PHYS(pg) >> PGSHIFT);
224 	bool rv = (pv->pv_attr & PG_M) != 0;
225 
226 	pv->pv_attr &= ~PG_M;
227 	if (pv->pv_pmap != NULL || pv->pv_next != NULL)
228 		rv |= pmap_clear_modify_long(pv);
229 	return rv;
230 }
231 
232 __inline static bool
233 pmap_is_modified(struct vm_page *pg)
234 {
235 	struct pv_entry *pv = pv_table + (VM_PAGE_TO_PHYS(pg) >> PGSHIFT);
236 	if (pv->pv_attr & PG_M)
237 		return 1;
238 	else
239 		return pmap_is_modified_long(pv);
240 }
241 
242 __inline static void
243 pmap_page_protect(struct vm_page *pg, vm_prot_t prot)
244 {
245 	struct  pv_entry *pv = pv_table + (VM_PAGE_TO_PHYS(pg) >> PGSHIFT);
246 
247 	if (pv->pv_pmap != NULL || pv->pv_next != NULL)
248 		pmap_page_protect_long(pv, prot);
249 }
250 
251 __inline static void
252 pmap_protect(pmap_t pmap, vaddr_t start, vaddr_t end, vm_prot_t prot)
253 {
254 	if (pmap->pm_p0lr != 0 || pmap->pm_p1lr != 0x200000 ||
255 	    (start & KERNBASE) != 0)
256 		pmap_protect_long(pmap, start, end, prot);
257 }
258 
259 static __inline void
260 pmap_remove_all(struct pmap *pmap)
261 {
262 	/* Nothing. */
263 }
264 
265 /* Routines that are best to define as macros */
266 #define pmap_phys_address(phys)		((u_int)(phys) << PGSHIFT)
267 #define pmap_copy(a,b,c,d,e)		/* Dont do anything */
268 #define pmap_update(pmap)		/* nothing (yet) */
269 #define pmap_remove(pmap, start, slut)	pmap_protect(pmap, start, slut, 0)
270 #define pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
271 #define pmap_wired_count(pmap)		((pmap)->pm_stats.wired_count)
272 #define pmap_reference(pmap)		(pmap)->pm_count++
273 
274 /* These can be done as efficient inline macros */
275 #define pmap_copy_page(src, dst)			\
276 	__asm("addl3 $0x80000000,%0,%%r0;"		\
277 		"addl3 $0x80000000,%1,%%r1;"		\
278 		"movc3 $4096,(%%r0),(%%r1)"		\
279 	    :: "r"(src), "r"(dst)			\
280 	    : "r0","r1","r2","r3","r4","r5");
281 
282 #define pmap_zero_page(phys)				\
283 	__asm("addl3 $0x80000000,%0,%%r0;"		\
284 		"movc5 $0,(%%r0),$0,$4096,(%%r0)"	\
285 	    :: "r"(phys)				\
286 	    : "r0","r1","r2","r3","r4","r5");
287 
288 /* Prototypes */
289 void	pmap_bootstrap(void);
290 vaddr_t pmap_map(vaddr_t, vaddr_t, vaddr_t, int);
291 
292 #if 0
293 #define	__HAVE_VM_PAGE_MD
294 
295 struct vm_page_md {
296 	unsigned int md_attrs;
297 };
298 
299 #define	VM_MDPAGE_INIT(pg)	((pg)->mdpage.md_attrs = 0)
300 #endif
301 
302 #endif /* PMAP_H */
303