xref: /freebsd/sys/amd64/include/pmap.h (revision 7ab9b220d934cea20d147fbaabf4a241a0aa5b0a)
1 /*
2  * Copyright (c) 1991 Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * the Systems Programming Group of the University of Utah Computer
7  * Science Department and William Jolitz of UUNET Technologies Inc.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. 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  * Derived from hp300 version by Mike Hibler, this version by William
38  * Jolitz uses a recursive map [a pde points to the page directory] to
39  * map the page tables using the pagetables themselves. This is done to
40  * reduce the impact on kernel virtual memory for lots of sparse address
41  * space, and to reduce the cost of memory to each process.
42  *
43  *	from: hp300: @(#)pmap.h	7.2 (Berkeley) 12/16/90
44  *	from: @(#)pmap.h	7.4 (Berkeley) 5/12/91
45  * $FreeBSD$
46  */
47 
48 #ifndef _MACHINE_PMAP_H_
49 #define	_MACHINE_PMAP_H_
50 
51 /*
52  * Page-directory and page-table entires follow this format, with a few
53  * of the fields not present here and there, depending on a lot of things.
54  */
55 				/* ---- Intel Nomenclature ---- */
56 #define	PG_V		0x001	/* P	Valid			*/
57 #define PG_RW		0x002	/* R/W	Read/Write		*/
58 #define PG_U		0x004	/* U/S  User/Supervisor		*/
59 #define	PG_NC_PWT	0x008	/* PWT	Write through		*/
60 #define	PG_NC_PCD	0x010	/* PCD	Cache disable		*/
61 #define PG_A		0x020	/* A	Accessed		*/
62 #define	PG_M		0x040	/* D	Dirty			*/
63 #define	PG_PS		0x080	/* PS	Page size (0=4k,1=4M)	*/
64 #define	PG_G		0x100	/* G	Global			*/
65 #define	PG_AVAIL1	0x200	/*    /	Available for system	*/
66 #define	PG_AVAIL2	0x400	/*   <	programmers use		*/
67 #define	PG_AVAIL3	0x800	/*    \				*/
68 
69 
70 /* Our various interpretations of the above */
71 #define PG_W		PG_AVAIL1	/* "Wired" pseudoflag */
72 #define	PG_MANAGED	PG_AVAIL2
73 #define	PG_FRAME	(~((vm_paddr_t)PAGE_MASK))
74 #define	PG_PROT		(PG_RW|PG_U)	/* all protection bits . */
75 #define PG_N		(PG_NC_PWT|PG_NC_PCD)	/* Non-cacheable */
76 
77 /*
78  * Page Protection Exception bits
79  */
80 
81 #define PGEX_P		0x01	/* Protection violation vs. not present */
82 #define PGEX_W		0x02	/* during a Write cycle */
83 #define PGEX_U		0x04	/* access from User mode (UPL) */
84 
85 /*
86  * Size of Kernel address space.  This is the number of page table pages
87  * (4MB each) to use for the kernel.  256 pages == 1 Gigabyte.
88  * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
89  */
90 #ifndef KVA_PAGES
91 #ifdef PAE
92 #define KVA_PAGES	512
93 #else
94 #define KVA_PAGES	256
95 #endif
96 #endif
97 
98 /*
99  * Pte related macros
100  */
101 #define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
102 
103 #ifndef NKPT
104 #ifdef PAE
105 #define	NKPT		120	/* actual number of kernel page tables */
106 #else
107 #define	NKPT		30	/* actual number of kernel page tables */
108 #endif
109 #endif
110 #ifndef NKPDE
111 #ifdef SMP
112 #define NKPDE	(KVA_PAGES - (NPGPTD + 1)) /* number of page tables/pde's */
113 #else
114 #define NKPDE	(KVA_PAGES - NPGPTD)	/* number of page tables/pde's */
115 #endif
116 #endif
117 
118 /*
119  * The *PTDI values control the layout of virtual memory
120  *
121  * XXX This works for now, but I am not real happy with it, I'll fix it
122  * right after I fix locore.s and the magic 28K hole
123  *
124  * SMP_PRIVPAGES: The per-cpu address space is 0xff80000 -> 0xffbfffff
125  */
126 #define	APTDPTDI	(NPDEPTD-NPGPTD) /* alt ptd entry that points to APTD */
127 #ifdef SMP
128 #define MPPTDI		(APTDPTDI-1)	/* per cpu ptd entry */
129 #define	KPTDI		(MPPTDI-NKPDE)	/* start of kernel virtual pde's */
130 #else
131 #define	KPTDI		(APTDPTDI-NKPDE)/* start of kernel virtual pde's */
132 #endif	/* SMP */
133 #define	PTDPTDI		(KPTDI-NPGPTD)	/* ptd entry that points to ptd! */
134 
135 /*
136  * XXX doesn't really belong here I guess...
137  */
138 #define ISA_HOLE_START    0xa0000
139 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
140 
141 #ifndef LOCORE
142 
143 #include <sys/queue.h>
144 
145 #ifdef PAE
146 
147 typedef uint64_t pdpt_entry_t;
148 typedef uint64_t pd_entry_t;
149 typedef uint64_t pt_entry_t;
150 
151 #define	PTESHIFT	(3)
152 #define	PDESHIFT	(3)
153 
154 #else
155 
156 typedef uint32_t pd_entry_t;
157 typedef uint32_t pt_entry_t;
158 
159 #define	PTESHIFT	(2)
160 #define	PDESHIFT	(2)
161 
162 #endif
163 
164 /*
165  * Address of current and alternate address space page table maps
166  * and directories.
167  */
168 #ifdef _KERNEL
169 extern pt_entry_t PTmap[], APTmap[];
170 extern pd_entry_t PTD[], APTD[];
171 extern pd_entry_t PTDpde[], APTDpde[];
172 
173 #ifdef PAE
174 extern pdpt_entry_t *IdlePDPT;
175 #endif
176 extern pd_entry_t *IdlePTD;	/* physical address of "Idle" state directory */
177 #endif
178 
179 #ifdef _KERNEL
180 /*
181  * virtual address to page table entry and
182  * to physical address. Likewise for alternate address space.
183  * Note: these work recursively, thus vtopte of a pte will give
184  * the corresponding pde that in turn maps it.
185  */
186 #define	vtopte(va)	(PTmap + i386_btop(va))
187 #define	avtopte(va)	(APTmap + i386_btop(va))
188 
189 /*
190  *	Routine:	pmap_kextract
191  *	Function:
192  *		Extract the physical page address associated
193  *		kernel virtual address.
194  */
195 static __inline vm_paddr_t
196 pmap_kextract(vm_offset_t va)
197 {
198 	vm_paddr_t pa;
199 
200 	if ((pa = (vm_offset_t) PTD[va >> PDRSHIFT]) & PG_PS) {
201 		pa = (pa & ~(NBPDR - 1)) | (va & (NBPDR - 1));
202 	} else {
203 		pa = *vtopte(va);
204 		pa = (pa & PG_FRAME) | (va & PAGE_MASK);
205 	}
206 	return pa;
207 }
208 
209 #define	vtophys(va)	pmap_kextract(((vm_offset_t) (va)))
210 
211 #ifdef PAE
212 
213 static __inline pt_entry_t
214 pte_load_clear(pt_entry_t *pte)
215 {
216 	pt_entry_t r;
217 
218 	r = *pte;
219 	__asm __volatile(
220 	    "1:\n"
221 	    "\tcmpxchg8b %1\n"
222 	    "\tjnz 1b"
223 	    : "+A" (r)
224 	    : "m" (*pte), "b" (0), "c" (0));
225 	return (r);
226 }
227 
228 #else
229 
230 #define	pte_load_clear(pte)	atomic_readandclear_int(pte)
231 
232 #endif
233 
234 #endif
235 
236 /*
237  * Pmap stuff
238  */
239 struct	pv_entry;
240 
241 struct md_page {
242 	int pv_list_count;
243 	TAILQ_HEAD(,pv_entry)	pv_list;
244 };
245 
246 struct pmap {
247 	pd_entry_t		*pm_pdir;	/* KVA of page directory */
248 	vm_object_t		pm_pteobj;	/* Container for pte's */
249 	TAILQ_HEAD(,pv_entry)	pm_pvlist;	/* list of mappings in pmap */
250 	int			pm_active;	/* active on cpus */
251 	struct pmap_statistics	pm_stats;	/* pmap statistics */
252 	LIST_ENTRY(pmap) 	pm_list;	/* List of all pmaps */
253 #ifdef PAE
254 	pdpt_entry_t		*pm_pdpt;	/* KVA of page director pointer
255 						   table */
256 #endif
257 };
258 
259 #define	pmap_page_is_mapped(m)	(!TAILQ_EMPTY(&(m)->md.pv_list))
260 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
261 
262 typedef struct pmap	*pmap_t;
263 
264 #ifdef _KERNEL
265 extern struct pmap	kernel_pmap_store;
266 #define kernel_pmap	(&kernel_pmap_store)
267 #endif
268 
269 /*
270  * For each vm_page_t, there is a list of all currently valid virtual
271  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
272  */
273 typedef struct pv_entry {
274 	pmap_t		pv_pmap;	/* pmap where mapping lies */
275 	vm_offset_t	pv_va;		/* virtual address for mapping */
276 	TAILQ_ENTRY(pv_entry)	pv_list;
277 	TAILQ_ENTRY(pv_entry)	pv_plist;
278 	vm_page_t	pv_ptem;	/* VM page for pte */
279 } *pv_entry_t;
280 
281 #ifdef	_KERNEL
282 
283 #define NPPROVMTRR		8
284 #define PPRO_VMTRRphysBase0	0x200
285 #define PPRO_VMTRRphysMask0	0x201
286 struct ppro_vmtrr {
287 	u_int64_t base, mask;
288 };
289 extern struct ppro_vmtrr PPro_vmtrr[NPPROVMTRR];
290 
291 extern caddr_t	CADDR1;
292 extern pt_entry_t *CMAP1;
293 extern vm_paddr_t avail_end;
294 extern vm_paddr_t avail_start;
295 extern vm_offset_t clean_eva;
296 extern vm_offset_t clean_sva;
297 extern vm_paddr_t phys_avail[];
298 extern char *ptvmmap;		/* poor name! */
299 extern vm_offset_t virtual_avail;
300 extern vm_offset_t virtual_end;
301 
302 void	pmap_bootstrap(vm_paddr_t, vm_paddr_t);
303 void	pmap_kenter(vm_offset_t va, vm_paddr_t pa);
304 void	pmap_kremove(vm_offset_t);
305 void	*pmap_mapdev(vm_paddr_t, vm_size_t);
306 void	pmap_unmapdev(vm_offset_t, vm_size_t);
307 pt_entry_t *pmap_pte_quick(pmap_t, vm_offset_t) __pure2;
308 void	pmap_set_opt(void);
309 void	pmap_invalidate_page(pmap_t, vm_offset_t);
310 void	pmap_invalidate_range(pmap_t, vm_offset_t, vm_offset_t);
311 void	pmap_invalidate_all(pmap_t);
312 
313 #endif /* _KERNEL */
314 
315 #endif /* !LOCORE */
316 
317 #endif /* !_MACHINE_PMAP_H_ */
318