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  * $DragonFly: src/sys/platform/vkernel/include/pmap.h,v 1.4 2007/07/01 02:51:44 dillon Exp $
47  */
48 
49 #ifndef _MACHINE_PMAP_H_
50 #define	_MACHINE_PMAP_H_
51 
52 #include <cpu/pmap.h>
53 
54 /*
55  * Pte related macros
56  */
57 #define KVADDR(l4, l3, l2, l1) ( \
58 	((unsigned long)-1 << 47) | \
59 	((unsigned long)(l4) << PML4SHIFT) | \
60 	((unsigned long)(l3) << PDPSHIFT) | \
61 	((unsigned long)(l2) << PDRSHIFT) | \
62 	((unsigned long)(l1) << PAGE_SHIFT))
63 
64 #define UVADDR(l4, l3, l2, l1) ( \
65 	((unsigned long)(l4) << PML4SHIFT) | \
66 	((unsigned long)(l3) << PDPSHIFT) | \
67 	((unsigned long)(l2) << PDRSHIFT) | \
68 	((unsigned long)(l1) << PAGE_SHIFT))
69 
70 /*
71  * Initial number of kernel page tables.  NKPT is now calculated in the
72  * pmap code.
73  *
74  * Give NKPDPE a generous value, allowing the kernel to map up to 128G.
75  */
76 #define NKPML4E		1		/* number of kernel PML4 slots */
77 #define NKPDPE		128		/* number of kernel PDP slots */
78 
79 #define	NUPML4E		(NPML4EPG/2)	/* number of userland PML4 pages */
80 #define	NUPDPE		(NUPML4E*NPDPEPG)/* number of userland PDP pages */
81 #define	NUPDE		(NUPDPE*NPDEPG)	/* number of userland PD entries */
82 
83 #define	NDMPML4E	1		/* number of dmap PML4 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_VKERNEL_H_
100 #include <sys/vkernel.h>
101 #endif
102 #ifndef _MACHINE_TYPES_H_
103 #include <machine/types.h>
104 #endif
105 #ifndef _MACHINE_PARAM_H_
106 #include <machine/param.h>
107 #endif
108 
109 #ifdef _KERNEL
110 
111 vm_paddr_t pmap_kextract(vm_offset_t);
112 
113 /*
114  * XXX
115  */
116 #define	vtophys(va)	pmap_kextract(((vm_offset_t)(va)))
117 #define	vtophys_pte(va)	((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
118 
119 #endif
120 
121 #define	pte_load_clear(pte)	atomic_readandclear_long(pte)
122 
123 /*
124  * Pmap stuff
125  */
126 struct pv_entry;
127 struct vm_page;
128 struct vm_object;
129 
130 struct md_page {
131 	int pv_list_count;
132 	TAILQ_HEAD(,pv_entry)	pv_list;
133 };
134 
135 /*
136  * Each machine dependent implementation is expected to
137  * keep certain statistics.  They may do this anyway they
138  * so choose, but are expected to return the statistics
139  * in the following structure.
140  */
141 struct pmap_statistics {
142 	long resident_count;    /* # of pages mapped (total) */
143 	long wired_count;       /* # of pages wired */
144 };
145 typedef struct pmap_statistics *pmap_statistics_t;
146 
147 struct pmap {
148 	pml4_entry_t		*pm_pml4;	/* KVA of level 4 page table */
149 	struct vm_page		*pm_pdirm;	/* VM page for pg directory */
150 	vpte_t			pm_pdirpte;	/* pte mapping phys page */
151 	struct vm_object	*pm_pteobj;	/* Container for pte's */
152 	TAILQ_ENTRY(pmap)	pm_pmnode;	/* list of pmaps */
153 	TAILQ_HEAD(,pv_entry)	pm_pvlist;	/* list of mappings in pmap */
154 	int			pm_count;	/* reference count */
155 	cpumask_t		pm_active;	/* active on cpus */
156 	vm_pindex_t		pm_pdindex;	/* page dir page in obj */
157 	struct pmap_statistics	pm_stats;	/* pmap statistics */
158 	struct	vm_page		*pm_ptphint;	/* pmap ptp hint */
159 	int			pm_generation;	/* detect pvlist deletions */
160 };
161 
162 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
163 
164 typedef struct pmap	*pmap_t;
165 
166 #ifdef _KERNEL
167 extern struct pmap	kernel_pmap;
168 #endif
169 
170 /*
171  * For each vm_page_t, there is a list of all currently valid virtual
172  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
173  */
174 typedef struct pv_entry {
175 	pmap_t		pv_pmap;	/* pmap where mapping lies */
176 	vm_offset_t	pv_va;		/* virtual address for mapping */
177 	TAILQ_ENTRY(pv_entry)	pv_list;
178 	TAILQ_ENTRY(pv_entry)	pv_plist;
179 	struct vm_page	*pv_ptem;	/* VM page for pte */
180 } *pv_entry_t;
181 
182 #ifdef	_KERNEL
183 
184 extern caddr_t	CADDR1;
185 extern pt_entry_t *CMAP1;
186 extern char *ptvmmap;		/* poor name! */
187 extern vm_offset_t clean_sva;
188 extern vm_offset_t clean_eva;
189 
190 void	pmap_bootstrap(vm_paddr_t *, int64_t);
191 void	*pmap_mapdev (vm_paddr_t, vm_size_t);
192 void	pmap_unmapdev (vm_offset_t, vm_size_t);
193 struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
194 
195 #endif /* _KERNEL */
196 
197 #endif /* !LOCORE */
198 
199 #endif /* !_MACHINE_PMAP_H_ */
200