xref: /freebsd/sys/i386/include/pmap.h (revision eb6d21b4ca6d668cf89afd99eef7baeafa712197)
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  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * Derived from hp300 version by Mike Hibler, this version by William
34  * Jolitz uses a recursive map [a pde points to the page directory] to
35  * map the page tables using the pagetables themselves. This is done to
36  * reduce the impact on kernel virtual memory for lots of sparse address
37  * space, and to reduce the cost of memory to each process.
38  *
39  *	from: hp300: @(#)pmap.h	7.2 (Berkeley) 12/16/90
40  *	from: @(#)pmap.h	7.4 (Berkeley) 5/12/91
41  * $FreeBSD$
42  */
43 
44 #ifndef _MACHINE_PMAP_H_
45 #define	_MACHINE_PMAP_H_
46 
47 /*
48  * Page-directory and page-table entries follow this format, with a few
49  * of the fields not present here and there, depending on a lot of things.
50  */
51 				/* ---- Intel Nomenclature ---- */
52 #define	PG_V		0x001	/* P	Valid			*/
53 #define PG_RW		0x002	/* R/W	Read/Write		*/
54 #define PG_U		0x004	/* U/S  User/Supervisor		*/
55 #define	PG_NC_PWT	0x008	/* PWT	Write through		*/
56 #define	PG_NC_PCD	0x010	/* PCD	Cache disable		*/
57 #define PG_A		0x020	/* A	Accessed		*/
58 #define	PG_M		0x040	/* D	Dirty			*/
59 #define	PG_PS		0x080	/* PS	Page size (0=4k,1=4M)	*/
60 #define	PG_PTE_PAT	0x080	/* PAT	PAT index		*/
61 #define	PG_G		0x100	/* G	Global			*/
62 #define	PG_AVAIL1	0x200	/*    /	Available for system	*/
63 #define	PG_AVAIL2	0x400	/*   <	programmers use		*/
64 #define	PG_AVAIL3	0x800	/*    \				*/
65 #define	PG_PDE_PAT	0x1000	/* PAT	PAT index		*/
66 #ifdef PAE
67 #define	PG_NX		(1ull<<63) /* No-execute */
68 #endif
69 
70 
71 /* Our various interpretations of the above */
72 #define PG_W		PG_AVAIL1	/* "Wired" pseudoflag */
73 #define	PG_MANAGED	PG_AVAIL2
74 #ifdef PAE
75 #define	PG_FRAME	(0x000ffffffffff000ull)
76 #define	PG_PS_FRAME	(0x000fffffffe00000ull)
77 #else
78 #define	PG_FRAME	(~PAGE_MASK)
79 #define	PG_PS_FRAME	(0xffc00000)
80 #endif
81 #define	PG_PROT		(PG_RW|PG_U)	/* all protection bits . */
82 #define PG_N		(PG_NC_PWT|PG_NC_PCD)	/* Non-cacheable */
83 
84 /* Page level cache control fields used to determine the PAT type */
85 #define PG_PDE_CACHE	(PG_PDE_PAT | PG_NC_PWT | PG_NC_PCD)
86 #define PG_PTE_CACHE	(PG_PTE_PAT | PG_NC_PWT | PG_NC_PCD)
87 
88 /*
89  * Promotion to a 2 or 4MB (PDE) page mapping requires that the corresponding
90  * 4KB (PTE) page mappings have identical settings for the following fields:
91  */
92 #define PG_PTE_PROMOTE	(PG_MANAGED | PG_W | PG_G | PG_PTE_PAT | \
93 	    PG_M | PG_A | PG_NC_PCD | PG_NC_PWT | PG_U | PG_RW | PG_V)
94 
95 /*
96  * Page Protection Exception bits
97  */
98 
99 #define PGEX_P		0x01	/* Protection violation vs. not present */
100 #define PGEX_W		0x02	/* during a Write cycle */
101 #define PGEX_U		0x04	/* access from User mode (UPL) */
102 #define PGEX_RSV	0x08	/* reserved PTE field is non-zero */
103 #define PGEX_I		0x10	/* during an instruction fetch */
104 
105 /*
106  * Size of Kernel address space.  This is the number of page table pages
107  * (4MB each) to use for the kernel.  256 pages == 1 Gigabyte.
108  * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
109  * For PAE, the page table page unit size is 2MB.  This means that 512 pages
110  * is 1 Gigabyte.  Double everything.  It must be a multiple of 8 for PAE.
111  */
112 #ifndef KVA_PAGES
113 #ifdef PAE
114 #define KVA_PAGES	512
115 #else
116 #define KVA_PAGES	256
117 #endif
118 #endif
119 
120 /*
121  * Pte related macros
122  */
123 #define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
124 
125 /* Initial number of kernel page tables. */
126 #ifndef NKPT
127 #ifdef PAE
128 /* 152 page tables needed to map 16G (76B "struct vm_page", 2M page tables). */
129 #define	NKPT		240
130 #else
131 /* 18 page tables needed to map 4G (72B "struct vm_page", 4M page tables). */
132 #define	NKPT		30
133 #endif
134 #endif
135 
136 #ifndef NKPDE
137 #define NKPDE	(KVA_PAGES)	/* number of page tables/pde's */
138 #endif
139 
140 /*
141  * The *PTDI values control the layout of virtual memory
142  *
143  * XXX This works for now, but I am not real happy with it, I'll fix it
144  * right after I fix locore.s and the magic 28K hole
145  */
146 #define	KPTDI		(NPDEPTD-NKPDE)	/* start of kernel virtual pde's */
147 #define	PTDPTDI		(KPTDI-NPGPTD)	/* ptd entry that points to ptd! */
148 
149 /*
150  * XXX doesn't really belong here I guess...
151  */
152 #define ISA_HOLE_START    0xa0000
153 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
154 
155 #ifndef LOCORE
156 
157 #include <sys/queue.h>
158 #include <sys/_lock.h>
159 #include <sys/_mutex.h>
160 
161 #ifdef PAE
162 
163 typedef uint64_t pdpt_entry_t;
164 typedef uint64_t pd_entry_t;
165 typedef uint64_t pt_entry_t;
166 
167 #define	PTESHIFT	(3)
168 #define	PDESHIFT	(3)
169 
170 #else
171 
172 typedef uint32_t pd_entry_t;
173 typedef uint32_t pt_entry_t;
174 
175 #define	PTESHIFT	(2)
176 #define	PDESHIFT	(2)
177 
178 #endif
179 
180 /*
181  * Address of current address space page table maps and directories.
182  */
183 #ifdef _KERNEL
184 extern pt_entry_t PTmap[];
185 extern pd_entry_t PTD[];
186 extern pd_entry_t PTDpde[];
187 
188 #ifdef PAE
189 extern pdpt_entry_t *IdlePDPT;
190 #endif
191 extern pd_entry_t *IdlePTD;	/* physical address of "Idle" state directory */
192 
193 /*
194  * virtual address to page table entry and
195  * to physical address.
196  * Note: these work recursively, thus vtopte of a pte will give
197  * the corresponding pde that in turn maps it.
198  */
199 #define	vtopte(va)	(PTmap + i386_btop(va))
200 #define	vtophys(va)	pmap_kextract((vm_offset_t)(va))
201 
202 #ifdef XEN
203 #include <sys/param.h>
204 #include <machine/xen/xen-os.h>
205 #include <machine/xen/xenvar.h>
206 #include <machine/xen/xenpmap.h>
207 
208 extern pt_entry_t pg_nx;
209 
210 #define PG_KERNEL  (PG_V | PG_A | PG_RW | PG_M)
211 
212 #define MACH_TO_VM_PAGE(ma) PHYS_TO_VM_PAGE(xpmap_mtop((ma)))
213 #define VM_PAGE_TO_MACH(m) xpmap_ptom(VM_PAGE_TO_PHYS((m)))
214 
215 static __inline vm_paddr_t
216 pmap_kextract_ma(vm_offset_t va)
217 {
218         vm_paddr_t ma;
219         if ((ma = PTD[va >> PDRSHIFT]) & PG_PS) {
220                 ma = (ma & ~(NBPDR - 1)) | (va & (NBPDR - 1));
221         } else {
222                 ma = (*vtopte(va) & PG_FRAME) | (va & PAGE_MASK);
223         }
224         return ma;
225 }
226 
227 static __inline vm_paddr_t
228 pmap_kextract(vm_offset_t va)
229 {
230         return xpmap_mtop(pmap_kextract_ma(va));
231 }
232 #define vtomach(va)     pmap_kextract_ma(((vm_offset_t) (va)))
233 
234 vm_paddr_t pmap_extract_ma(struct pmap *pmap, vm_offset_t va);
235 
236 void    pmap_kenter_ma(vm_offset_t va, vm_paddr_t pa);
237 void    pmap_map_readonly(struct pmap *pmap, vm_offset_t va, int len);
238 void    pmap_map_readwrite(struct pmap *pmap, vm_offset_t va, int len);
239 
240 static __inline pt_entry_t
241 pte_load_store(pt_entry_t *ptep, pt_entry_t v)
242 {
243 	pt_entry_t r;
244 
245 	v = xpmap_ptom(v);
246 	r = *ptep;
247 	PT_SET_VA(ptep, v, TRUE);
248 	return (r);
249 }
250 
251 static __inline pt_entry_t
252 pte_load_store_ma(pt_entry_t *ptep, pt_entry_t v)
253 {
254 	pt_entry_t r;
255 
256 	r = *ptep;
257 	PT_SET_VA_MA(ptep, v, TRUE);
258 	return (r);
259 }
260 
261 #define	pte_load_clear(ptep)	pte_load_store((ptep), (pt_entry_t)0ULL)
262 
263 #define	pte_store(ptep, pte)	pte_load_store((ptep), (pt_entry_t)pte)
264 #define	pte_store_ma(ptep, pte)	pte_load_store_ma((ptep), (pt_entry_t)pte)
265 #define	pde_store_ma(ptep, pte)	pte_load_store_ma((ptep), (pt_entry_t)pte)
266 
267 #elif !defined(XEN)
268 /*
269  *	Routine:	pmap_kextract
270  *	Function:
271  *		Extract the physical page address associated
272  *		kernel virtual address.
273  */
274 static __inline vm_paddr_t
275 pmap_kextract(vm_offset_t va)
276 {
277 	vm_paddr_t pa;
278 
279 	if ((pa = PTD[va >> PDRSHIFT]) & PG_PS) {
280 		pa = (pa & PG_PS_FRAME) | (va & PDRMASK);
281 	} else {
282 		pa = *vtopte(va);
283 		pa = (pa & PG_FRAME) | (va & PAGE_MASK);
284 	}
285 	return pa;
286 }
287 
288 #define PT_UPDATES_FLUSH()
289 #endif
290 
291 #if defined(PAE) && !defined(XEN)
292 
293 #define	pde_cmpset(pdep, old, new) \
294 				atomic_cmpset_64((pdep), (old), (new))
295 
296 static __inline pt_entry_t
297 pte_load(pt_entry_t *ptep)
298 {
299 	pt_entry_t r;
300 
301 	__asm __volatile(
302 	    "lock; cmpxchg8b %1"
303 	    : "=A" (r)
304 	    : "m" (*ptep), "a" (0), "d" (0), "b" (0), "c" (0));
305 	return (r);
306 }
307 
308 static __inline pt_entry_t
309 pte_load_store(pt_entry_t *ptep, pt_entry_t v)
310 {
311 	pt_entry_t r;
312 
313 	r = *ptep;
314 	__asm __volatile(
315 	    "1:\n"
316 	    "\tlock; cmpxchg8b %1\n"
317 	    "\tjnz 1b"
318 	    : "+A" (r)
319 	    : "m" (*ptep), "b" ((uint32_t)v), "c" ((uint32_t)(v >> 32)));
320 	return (r);
321 }
322 
323 /* XXXRU move to atomic.h? */
324 static __inline int
325 atomic_cmpset_64(volatile uint64_t *dst, uint64_t exp, uint64_t src)
326 {
327 	int64_t res = exp;
328 
329 	__asm __volatile (
330 	"	lock ;			"
331 	"	cmpxchg8b %2 ;		"
332 	"	setz	%%al ;		"
333 	"	movzbl	%%al,%0 ;	"
334 	"# atomic_cmpset_64"
335 	: "+A" (res),			/* 0 (result) */
336 	  "=m" (*dst)			/* 1 */
337 	: "m" (*dst),			/* 2 */
338 	  "b" ((uint32_t)src),
339 	  "c" ((uint32_t)(src >> 32)));
340 
341 	return (res);
342 }
343 
344 #define	pte_load_clear(ptep)	pte_load_store((ptep), (pt_entry_t)0ULL)
345 
346 #define	pte_store(ptep, pte)	pte_load_store((ptep), (pt_entry_t)pte)
347 
348 extern pt_entry_t pg_nx;
349 
350 #elif !defined(PAE) && !defined (XEN)
351 
352 #define	pde_cmpset(pdep, old, new) \
353 				atomic_cmpset_int((pdep), (old), (new))
354 
355 static __inline pt_entry_t
356 pte_load(pt_entry_t *ptep)
357 {
358 	pt_entry_t r;
359 
360 	r = *ptep;
361 	return (r);
362 }
363 
364 static __inline pt_entry_t
365 pte_load_store(pt_entry_t *ptep, pt_entry_t pte)
366 {
367 	__asm volatile("xchgl %0, %1" : "+m" (*ptep), "+r" (pte));
368 	return (pte);
369 }
370 
371 #define	pte_load_clear(pte)	atomic_readandclear_int(pte)
372 
373 static __inline void
374 pte_store(pt_entry_t *ptep, pt_entry_t pte)
375 {
376 
377 	*ptep = pte;
378 }
379 
380 #endif /* PAE */
381 
382 #define	pte_clear(ptep)		pte_store((ptep), (pt_entry_t)0ULL)
383 
384 #define	pde_store(pdep, pde)	pte_store((pdep), (pde))
385 
386 #endif /* _KERNEL */
387 
388 /*
389  * Pmap stuff
390  */
391 struct	pv_entry;
392 struct	pv_chunk;
393 
394 struct md_page {
395 	TAILQ_HEAD(,pv_entry)	pv_list;
396 	int			pat_mode;
397 };
398 
399 struct pmap {
400 	struct mtx		pm_mtx;
401 	pd_entry_t		*pm_pdir;	/* KVA of page directory */
402 	TAILQ_HEAD(,pv_chunk)	pm_pvchunk;	/* list of mappings in pmap */
403 	u_int			pm_active;	/* active on cpus */
404 	struct pmap_statistics	pm_stats;	/* pmap statistics */
405 	LIST_ENTRY(pmap) 	pm_list;	/* List of all pmaps */
406 #ifdef PAE
407 	pdpt_entry_t		*pm_pdpt;	/* KVA of page director pointer
408 						   table */
409 #endif
410 	vm_page_t		pm_root;	/* spare page table pages */
411 };
412 
413 typedef struct pmap	*pmap_t;
414 
415 #ifdef _KERNEL
416 extern struct pmap	kernel_pmap_store;
417 #define kernel_pmap	(&kernel_pmap_store)
418 
419 #define	PMAP_LOCK(pmap)		mtx_lock(&(pmap)->pm_mtx)
420 #define	PMAP_LOCK_ASSERT(pmap, type) \
421 				mtx_assert(&(pmap)->pm_mtx, (type))
422 #define	PMAP_LOCK_DESTROY(pmap)	mtx_destroy(&(pmap)->pm_mtx)
423 #define	PMAP_LOCK_INIT(pmap)	mtx_init(&(pmap)->pm_mtx, "pmap", \
424 				    NULL, MTX_DEF | MTX_DUPOK)
425 #define	PMAP_LOCKED(pmap)	mtx_owned(&(pmap)->pm_mtx)
426 #define	PMAP_MTX(pmap)		(&(pmap)->pm_mtx)
427 #define	PMAP_TRYLOCK(pmap)	mtx_trylock(&(pmap)->pm_mtx)
428 #define	PMAP_UNLOCK(pmap)	mtx_unlock(&(pmap)->pm_mtx)
429 #endif
430 
431 /*
432  * For each vm_page_t, there is a list of all currently valid virtual
433  * mappings of that page.  An entry is a pv_entry_t, the list is pv_list.
434  */
435 typedef struct pv_entry {
436 	vm_offset_t	pv_va;		/* virtual address for mapping */
437 	TAILQ_ENTRY(pv_entry)	pv_list;
438 } *pv_entry_t;
439 
440 /*
441  * pv_entries are allocated in chunks per-process.  This avoids the
442  * need to track per-pmap assignments.
443  */
444 #define	_NPCM	11
445 #define	_NPCPV	336
446 struct pv_chunk {
447 	pmap_t			pc_pmap;
448 	TAILQ_ENTRY(pv_chunk)	pc_list;
449 	uint32_t		pc_map[_NPCM];	/* bitmap; 1 = free */
450 	uint32_t		pc_spare[2];
451 	struct pv_entry		pc_pventry[_NPCPV];
452 };
453 
454 #ifdef	_KERNEL
455 
456 extern caddr_t	CADDR1;
457 extern pt_entry_t *CMAP1;
458 extern vm_paddr_t phys_avail[];
459 extern vm_paddr_t dump_avail[];
460 extern int pseflag;
461 extern int pgeflag;
462 extern char *ptvmmap;		/* poor name! */
463 extern vm_offset_t virtual_avail;
464 extern vm_offset_t virtual_end;
465 
466 #define	pmap_page_get_memattr(m)	((vm_memattr_t)(m)->md.pat_mode)
467 #define	pmap_unmapbios(va, sz)	pmap_unmapdev((va), (sz))
468 
469 void	pmap_bootstrap(vm_paddr_t);
470 int	pmap_cache_bits(int mode, boolean_t is_pde);
471 int	pmap_change_attr(vm_offset_t, vm_size_t, int);
472 void	pmap_init_pat(void);
473 void	pmap_kenter(vm_offset_t va, vm_paddr_t pa);
474 void	*pmap_kenter_temporary(vm_paddr_t pa, int i);
475 void	pmap_kremove(vm_offset_t);
476 void	*pmap_mapbios(vm_paddr_t, vm_size_t);
477 void	*pmap_mapdev(vm_paddr_t, vm_size_t);
478 void	*pmap_mapdev_attr(vm_paddr_t, vm_size_t, int);
479 boolean_t pmap_page_is_mapped(vm_page_t m);
480 void	pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
481 void	pmap_unmapdev(vm_offset_t, vm_size_t);
482 pt_entry_t *pmap_pte(pmap_t, vm_offset_t) __pure2;
483 void	pmap_set_pg(void);
484 void	pmap_invalidate_page(pmap_t, vm_offset_t);
485 void	pmap_invalidate_range(pmap_t, vm_offset_t, vm_offset_t);
486 void	pmap_invalidate_all(pmap_t);
487 void	pmap_invalidate_cache(void);
488 void	pmap_invalidate_cache_range(vm_offset_t, vm_offset_t);
489 
490 #endif /* _KERNEL */
491 
492 #endif /* !LOCORE */
493 
494 #endif /* !_MACHINE_PMAP_H_ */
495