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: src/sys/i386/include/pmap.h,v 1.65.2.3 2001/10/03 07:15:37 peter Exp $
46  */
47 
48 #ifndef _MACHINE_PMAP_H_
49 #define	_MACHINE_PMAP_H_
50 
51 #include <cpu/pmap.h>
52 
53 /*
54  * Pte related macros
55  */
56 #define KVADDR(l4, l3, l2, l1) ( \
57 	((unsigned long)-1 << 47) | \
58 	((unsigned long)(l4) << PML4SHIFT) | \
59 	((unsigned long)(l3) << PDPSHIFT) | \
60 	((unsigned long)(l2) << PDRSHIFT) | \
61 	((unsigned long)(l1) << PAGE_SHIFT))
62 
63 #define UVADDR(l4, l3, l2, l1) ( \
64 	((unsigned long)(l4) << PML4SHIFT) | \
65 	((unsigned long)(l3) << PDPSHIFT) | \
66 	((unsigned long)(l2) << PDRSHIFT) | \
67 	((unsigned long)(l1) << PAGE_SHIFT))
68 
69 /*
70  * Initial number of kernel page tables.  NKPT is now calculated in the
71  * pmap code.
72  *
73  * Give NKPDPE a generous value, allowing the kernel to map up to 128G.
74  */
75 #define NKPML4E		1		/* number of kernel PML4 slots */
76 #define NKPDPE		128		/* number of kernel PDP slots */
77 
78 #define	NUPML4E		(NPML4EPG/2)	/* number of userland PML4 pages */
79 #define	NUPDPE		(NUPML4E*NPDPEPG)/* number of userland PDP pages */
80 #define	NUPDE		(NUPDPE*NPDEPG)	/* number of userland PD entries */
81 
82 #define	NDMPML4E	1		/* number of dmap PML4 slots */
83 #define	NDMPDPE		NPTEPG		/* number of dmap PDPE slots */
84 
85 /*
86  * The *PML4I values control the layout of virtual memory
87  */
88 #define	PML4PML4I	(NPML4EPG/2)	/* Index of recursive pml4 mapping */
89 
90 
91 #ifndef LOCORE
92 
93 #ifndef _SYS_TYPES_H_
94 #include <sys/types.h>
95 #endif
96 #ifndef _SYS_QUEUE_H_
97 #include <sys/queue.h>
98 #endif
99 #ifndef _SYS_SPINLOCK_H_
100 #include <sys/spinlock.h>
101 #endif
102 #ifndef _SYS_THREAD_H_
103 #include <sys/thread.h>
104 #endif
105 #ifndef _SYS_VKERNEL_H_
106 #include <sys/vkernel.h>
107 #endif
108 #ifndef _MACHINE_TYPES_H_
109 #include <machine/types.h>
110 #endif
111 #ifndef _MACHINE_PARAM_H_
112 #include <machine/param.h>
113 #endif
114 
115 #ifdef _KERNEL
116 
117 vm_paddr_t pmap_kextract(vm_offset_t);
118 
119 /*
120  * XXX
121  */
122 #define	vtophys(va)	pmap_kextract(((vm_offset_t)(va)))
123 #define	vtophys_pte(va)	((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
124 
125 #endif
126 
127 #define	pte_load_clear(pte)	atomic_readandclear_long(pte)
128 
129 /*
130  * Pmap stuff
131  */
132 struct pv_entry;
133 struct vm_page;
134 struct vm_object;
135 
136 struct md_page {
137 	int pv_list_count;
138 	TAILQ_HEAD(,pv_entry)	pv_list;
139 };
140 
141 struct md_object {
142 };
143 
144 /*
145  * Each machine dependent implementation is expected to
146  * keep certain statistics.  They may do this anyway they
147  * so choose, but are expected to return the statistics
148  * in the following structure.
149  */
150 struct pmap_statistics {
151 	long resident_count;    /* # of pages mapped (total) */
152 	long wired_count;       /* # of pages wired */
153 };
154 typedef struct pmap_statistics *pmap_statistics_t;
155 
156 struct pmap {
157 	pml4_entry_t		*pm_pml4;	/* KVA of level 4 page table */
158 	struct vm_page		*pm_pdirm;	/* VM page for pg directory */
159 	vpte_t			pm_pdirpte;	/* pte mapping phys page */
160 	struct vm_object	*pm_pteobj;	/* Container for pte's */
161 	TAILQ_ENTRY(pmap)	pm_pmnode;	/* list of pmaps */
162 	TAILQ_HEAD(,pv_entry)	pm_pvlist;	/* list of mappings in pmap */
163 	TAILQ_HEAD(,pv_entry)	pm_pvlist_free;	/* free mappings */
164 	int			pm_count;	/* reference count */
165 	cpulock_t		pm_active_lock; /* interlock */
166 	cpumask_t		pm_active;	/* active on cpus */
167 	vm_pindex_t		pm_pdindex;	/* page dir page in obj */
168 	struct pmap_statistics	pm_stats;	/* pmap statistics */
169 	struct	vm_page		*pm_ptphint;	/* pmap ptp hint */
170 	int			pm_generation;	/* detect pvlist deletions */
171 	struct spinlock		pm_spin;
172 	struct lwkt_token	pm_token;
173 };
174 
175 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
176 
177 typedef struct pmap	*pmap_t;
178 
179 #ifdef _KERNEL
180 extern struct pmap	kernel_pmap;
181 #endif
182 
183 /*
184  * For each vm_page_t, there is a list of all currently valid virtual
185  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
186  */
187 typedef struct pv_entry {
188 	pmap_t		pv_pmap;	/* pmap where mapping lies */
189 	vm_offset_t	pv_va;		/* virtual address for mapping */
190 	TAILQ_ENTRY(pv_entry)	pv_list;
191 	TAILQ_ENTRY(pv_entry)	pv_plist;
192 	struct vm_page	*pv_ptem;	/* VM page for pte */
193 } *pv_entry_t;
194 
195 #ifdef	_KERNEL
196 
197 extern caddr_t	CADDR1;
198 extern pt_entry_t *CMAP1;
199 extern char *ptvmmap;		/* poor name! */
200 extern vm_offset_t clean_sva;
201 extern vm_offset_t clean_eva;
202 
203 #ifndef __VM_PAGE_T_DEFINED__
204 #define __VM_PAGE_T_DEFINED__
205 typedef struct vm_page *vm_page_t;
206 #endif
207 #ifndef __VM_MEMATTR_T_DEFINED__
208 #define __VM_MEMATTR_T_DEFINED__
209 typedef char vm_memattr_t;
210 #endif
211 
212 void	pmap_bootstrap(vm_paddr_t *, int64_t);
213 void	*pmap_mapdev (vm_paddr_t, vm_size_t);
214 void	pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
215 void	pmap_unmapdev (vm_offset_t, vm_size_t);
216 void	pmap_release(struct pmap *pmap);
217 void	pmap_interlock_wait (struct vmspace *);
218 
219 struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
220 
221 static __inline int
222 pmap_emulate_ad_bits(pmap_t pmap) {
223 	return 0;
224 }
225 
226 #endif /* _KERNEL */
227 
228 #endif /* !LOCORE */
229 
230 #endif /* !_MACHINE_PMAP_H_ */
231