Merge from vendor branch LIBARCHIVE:
[dragonfly.git] / sys / platform / pc32 / include / pmap.h
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/pc32/include/pmap.h,v 1.7 2007/06/08 00:57:04 dillon Exp $
47  */
48
49 #ifndef _MACHINE_PMAP_H_
50 #define _MACHINE_PMAP_H_
51
52 #include <cpu/pmap.h>
53
54 /*
55  * Size of Kernel address space.  This is the number of page table pages
56  * (4MB each) to use for the kernel.  256 pages == 1 Gigabyte.
57  * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
58  */
59 #ifndef KVA_PAGES
60 #define KVA_PAGES       256
61 #endif
62
63 /*
64  * Pte related macros
65  */
66 #define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
67
68 #ifndef NKPT
69 #define NKPT            30      /* actual number of kernel page tables */
70 #endif
71 #ifndef NKPDE
72 #define NKPDE   (KVA_PAGES - 2) /* addressable number of page tables/pde's */
73 #endif
74 #if NKPDE > KVA_PAGES - 2
75 #error "Maximum NKPDE is KVA_PAGES - 2"
76 #endif
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  * SMP_PRIVPAGES: The per-cpu address space is 0xff80000 -> 0xffbfffff
85  */
86 #define APTDPTDI        (NPDEPG-1)      /* alt ptd entry that points to APTD */
87 #define MPPTDI          (APTDPTDI-1)    /* per cpu ptd entry */
88 #define KPTDI           (MPPTDI-NKPDE)  /* start of kernel virtual pde's */
89 #define PTDPTDI         (KPTDI-1)       /* ptd entry that points to ptd! */
90 #define UMAXPTDI        (PTDPTDI-1)     /* ptd entry for user space end */
91 #define UMAXPTEOFF      (NPTEPG)        /* pte entry for user space end */
92
93 /*
94  * XXX doesn't really belong here I guess...
95  */
96 #define ISA_HOLE_START    0xa0000
97 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
98
99 #ifndef LOCORE
100
101 #ifndef _SYS_TYPES_H_
102 #include <sys/types.h>
103 #endif
104 #ifndef _SYS_QUEUE_H_
105 #include <sys/queue.h>
106 #endif
107 #ifndef _MACHINE_TYPES_H_
108 #include <machine/types.h>
109 #endif
110 #ifndef _MACHINE_PARAM_H_
111 #include <machine/param.h>
112 #endif
113
114 /*
115  * Address of current and alternate address space page table maps
116  * and directories.
117  */
118 #ifdef _KERNEL
119 extern pt_entry_t PTmap[], APTmap[], Upte;
120 extern pd_entry_t PTD[], APTD[], PTDpde, APTDpde, Upde;
121
122 extern pd_entry_t IdlePTD;      /* physical address of "Idle" state directory */
123 #endif
124
125 #ifdef _KERNEL
126 /*
127  * virtual address to page table entry and
128  * to physical address. Likewise for alternate address space.
129  * Note: these work recursively, thus vtopte of a pte will give
130  * the corresponding pde that in turn maps it.
131  */
132 #define vtopte(va)      (PTmap + i386_btop(va))
133
134 #define avtopte(va)     (APTmap + i386_btop(va))
135
136 /*
137  *      Routine:        pmap_kextract
138  *      Function:
139  *              Extract the physical page address associated
140  *              kernel virtual address.
141  */
142 static __inline vm_paddr_t
143 pmap_kextract(vm_offset_t va)
144 {
145         vm_paddr_t pa;
146
147         if ((pa = (vm_offset_t) PTD[va >> PDRSHIFT]) & PG_PS) {
148                 pa = (pa & ~(NBPDR - 1)) | (va & (NBPDR - 1));
149         } else {
150                 pa = *(vm_offset_t *)vtopte(va);
151                 pa = (pa & PG_FRAME) | (va & PAGE_MASK);
152         }
153         return pa;
154 }
155
156 /*
157  * XXX
158  */
159 #define vtophys(va)     pmap_kextract(((vm_offset_t)(va)))
160 #define vtophys_pte(va) ((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
161
162 #endif
163
164 /*
165  * Pmap stuff
166  */
167 struct pv_entry;
168 struct vm_page;
169 struct vm_object;
170
171 struct md_page {
172         int pv_list_count;
173         TAILQ_HEAD(,pv_entry)   pv_list;
174 };
175
176 /*
177  * Each machine dependent implementation is expected to
178  * keep certain statistics.  They may do this anyway they
179  * so choose, but are expected to return the statistics
180  * in the following structure.
181  *
182  * NOTE: We try to match the size of the pc32 pmap with the vkernel pmap
183  * so the same utilities (like 'ps') can be used on both.
184  */
185 struct pmap_statistics {
186         long resident_count;    /* # of pages mapped (total) */
187         long wired_count;       /* # of pages wired */
188 };
189 typedef struct pmap_statistics *pmap_statistics_t;
190
191 struct pmap {
192         pd_entry_t              *pm_pdir;       /* KVA of page directory */
193         struct vm_page          *pm_pdirm;      /* VM page for pg directory */
194         struct vm_object        *pm_pteobj;     /* Container for pte's */
195         TAILQ_ENTRY(pmap)       pm_pmnode;      /* list of pmaps */
196         TAILQ_HEAD(,pv_entry)   pm_pvlist;      /* list of mappings in pmap */
197         int                     pm_count;       /* reference count */
198         cpumask_t               pm_active;      /* active on cpus */
199         int                     pm_filler02;    /* (filler sync w/vkernel) */
200         struct pmap_statistics  pm_stats;       /* pmap statistics */
201         struct  vm_page         *pm_ptphint;    /* pmap ptp hint */
202         int                     pm_generation;  /* detect pvlist deletions */
203 };
204
205 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
206
207 typedef struct pmap     *pmap_t;
208
209 #ifdef _KERNEL
210 extern struct pmap      kernel_pmap;
211 #endif
212
213 /*
214  * For each vm_page_t, there is a list of all currently valid virtual
215  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
216  */
217 typedef struct pv_entry {
218         pmap_t          pv_pmap;        /* pmap where mapping lies */
219         vm_offset_t     pv_va;          /* virtual address for mapping */
220         TAILQ_ENTRY(pv_entry)   pv_list;
221         TAILQ_ENTRY(pv_entry)   pv_plist;
222         struct vm_page  *pv_ptem;       /* VM page for pte */
223 } *pv_entry_t;
224
225 #ifdef  _KERNEL
226
227 #define NPPROVMTRR              8
228 #define PPRO_VMTRRphysBase0     0x200
229 #define PPRO_VMTRRphysMask0     0x201
230 struct ppro_vmtrr {
231         u_int64_t base, mask;
232 };
233 extern struct ppro_vmtrr PPro_vmtrr[NPPROVMTRR];
234
235 extern caddr_t  CADDR1;
236 extern pt_entry_t *CMAP1;
237 extern vm_paddr_t avail_end;
238 extern vm_paddr_t avail_start;
239 extern vm_offset_t clean_eva;
240 extern vm_offset_t clean_sva;
241 extern char *ptvmmap;           /* poor name! */
242
243 void    pmap_bootstrap ( vm_paddr_t, vm_paddr_t);
244 void    *pmap_mapdev (vm_paddr_t, vm_size_t);
245 void    pmap_unmapdev (vm_offset_t, vm_size_t);
246 unsigned *pmap_pte (pmap_t, vm_offset_t) __pure2;
247 struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
248 #ifdef SMP
249 void    pmap_set_opt (void);
250 #endif
251
252 #endif /* _KERNEL */
253
254 #endif /* !LOCORE */
255
256 #endif /* !_MACHINE_PMAP_H_ */