xref: /freebsd/sys/i386/include/pmap.h (revision 05c7a37afb48ddd5ee1bd921a5d46fe59cc70b15)
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  * 	$Id: pmap.h,v 1.34 1996/02/25 03:02:53 dyson Exp $
46  */
47 
48 #ifndef _MACHINE_PMAP_H_
49 #define	_MACHINE_PMAP_H_
50 
51 #include <machine/pte.h>
52 
53 typedef unsigned int *pd_entry_t;
54 typedef unsigned int *pt_entry_t;
55 struct vm_map;
56 
57 /*
58  * NKPDE controls the virtual space of the kernel, what ever is left, minus
59  * the alternate page table area is given to the user (NUPDE)
60  */
61 /*
62  * NKPDE controls the virtual space of the kernel, what ever is left is
63  * given to the user (NUPDE)
64  */
65 #ifndef NKPT
66 #if 0
67 #define	NKPT			26	/* actual number of kernel page tables */
68 #else
69 #define	NKPT			9	/* actual number of kernel page tables */
70 #endif
71 #endif
72 #ifndef NKPDE
73 #define NKPDE			63	/* addressable number of page tables/pde's */
74 #endif
75 
76 #define	NUPDE		(NPTEPG-NKPDE)	/* number of user pde's */
77 
78 /*
79  * The *PTDI values control the layout of virtual memory
80  *
81  * XXX This works for now, but I am not real happy with it, I'll fix it
82  * right after I fix locore.s and the magic 28K hole
83  */
84 #define	APTDPTDI	(NPTEPG-1)	/* alt ptd entry that points to APTD */
85 #define	KPTDI		(APTDPTDI-NKPDE)/* start of kernel virtual pde's */
86 #define	PTDPTDI		(KPTDI-1)	/* ptd entry that points to ptd! */
87 #define	KSTKPTDI	(PTDPTDI-1)	/* ptd entry for u./kernel&user stack */
88 #define KSTKPTEOFF	(NBPG/sizeof(pd_entry_t)-UPAGES) /* pte entry for kernel stack */
89 
90 #define PDESIZE		sizeof(pd_entry_t) /* for assembly files */
91 #define PTESIZE		sizeof(pt_entry_t) /* for assembly files */
92 
93 /*
94  * Address of current and alternate address space page table maps
95  * and directories.
96  */
97 #ifdef KERNEL
98 extern pt_entry_t PTmap[], APTmap[], Upte;
99 extern pd_entry_t PTD[], APTD[], PTDpde, APTDpde, Upde;
100 
101 extern int	IdlePTD;	/* physical address of "Idle" state directory */
102 #endif
103 
104 /*
105  * virtual address to page table entry and
106  * to physical address. Likewise for alternate address space.
107  * Note: these work recursively, thus vtopte of a pte will give
108  * the corresponding pde that in turn maps it.
109  */
110 #define	vtopte(va)	(PTmap + i386_btop(va))
111 #define	kvtopte(va)	vtopte(va)
112 #define	ptetov(pt)	(i386_ptob(pt - PTmap))
113 #define	vtophys(va)	(((int) (*vtopte(va))&PG_FRAME) | ((int)(va) & PGOFSET))
114 #define	ispt(va)	((va) >= UPT_MIN_ADDRESS && (va) <= KPT_MAX_ADDRESS)
115 
116 #define	avtopte(va)	(APTmap + i386_btop(va))
117 #define	ptetoav(pt)	(i386_ptob(pt - APTmap))
118 #define	avtophys(va)	(((int) (*avtopte(va))&PG_FRAME) | ((int)(va) & PGOFSET))
119 
120 #ifdef KERNEL
121 /*
122  *	Routine:	pmap_kextract
123  *	Function:
124  *		Extract the physical page address associated
125  *		kernel virtual address.
126  */
127 static __inline vm_offset_t
128 pmap_kextract(vm_offset_t va)
129 {
130 	vm_offset_t pa = *(int *)vtopte(va);
131 	pa = (pa & PG_FRAME) | (va & ~PG_FRAME);
132 	return pa;
133 }
134 #endif
135 
136 /*
137  * macros to generate page directory/table indices
138  */
139 
140 #define	pdei(va)	(((va)&PD_MASK)>>PD_SHIFT)
141 #define	ptei(va)	(((va)&PT_MASK)>>PG_SHIFT)
142 
143 /*
144  * Pmap stuff
145  */
146 
147 struct pmap {
148 	pd_entry_t		*pm_pdir;	/* KVA of page directory */
149 	short			pm_dref;	/* page directory ref count */
150 	short			pm_count;	/* pmap reference count */
151 	struct pmap_statistics	pm_stats;	/* pmap statistics */
152 	struct	vm_map		*pm_map;	/* map that owns this pmap */
153 };
154 
155 typedef struct pmap	*pmap_t;
156 
157 #ifdef KERNEL
158 extern pmap_t		kernel_pmap;
159 #endif
160 
161 /*
162  * For each vm_page_t, there is a list of all currently valid virtual
163  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
164  */
165 typedef struct pv_entry {
166 	struct pv_entry	*pv_next;	/* next pv_entry */
167 	pmap_t		pv_pmap;	/* pmap where mapping lies */
168 	vm_offset_t	pv_va;		/* virtual address for mapping */
169 	vm_page_t	pv_ptem;	/* VM page for pte */
170 } *pv_entry_t;
171 
172 #define	PV_ENTRY_NULL	((pv_entry_t) 0)
173 
174 #define	PV_CI		0x01	/* all entries must be cache inhibited */
175 #define	PV_PTPAGE	0x02	/* entry maps a page table page */
176 
177 #ifdef	KERNEL
178 
179 extern caddr_t	CADDR1;
180 extern pt_entry_t *CMAP1;
181 extern vm_offset_t avail_end;
182 extern vm_offset_t avail_start;
183 extern vm_offset_t phys_avail[];
184 extern pv_entry_t pv_table;	/* array of entries, one per page */
185 extern vm_offset_t virtual_avail;
186 extern vm_offset_t virtual_end;
187 
188 #define	pa_index(pa)		atop(pa - vm_first_phys)
189 #define	pa_to_pvh(pa)		(&pv_table[pa_index(pa)])
190 
191 #define	pmap_resident_count(pmap)	((pmap)->pm_stats.resident_count)
192 
193 struct pcb;
194 
195 void	pmap_bootstrap __P(( vm_offset_t, vm_offset_t));
196 pmap_t	pmap_kernel __P((void));
197 void	*pmap_mapdev __P((vm_offset_t, vm_size_t));
198 pt_entry_t * __pure pmap_pte __P((pmap_t, vm_offset_t)) __pure2;
199 void	pmap_unuse_pt __P((pmap_t, vm_offset_t, vm_page_t));
200 vm_page_t pmap_use_pt __P((pmap_t, vm_offset_t));
201 
202 #endif /* KERNEL */
203 
204 #endif /* !_MACHINE_PMAP_H_ */
205