8469067e63c4c482bb6ad6fab13887b1f6a20967
[dragonfly.git] / sys / platform / pc64 / include / pmap.h
1 /*
2  * Copyright (c) 1991 Regents of the University of California.
3  * Copyright (c) 2003 Peter Wemm.
4  * Copyright (c) 2008 The DragonFly Project.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * the Systems Programming Group of the University of Utah Computer
9  * Science Department and William Jolitz of UUNET Technologies Inc.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *      This product includes software developed by the University of
22  *      California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  * Derived from hp300 version by Mike Hibler, this version by William
40  * Jolitz uses a recursive map [a pde points to the page directory] to
41  * map the page tables using the pagetables themselves. This is done to
42  * reduce the impact on kernel virtual memory for lots of sparse address
43  * space, and to reduce the cost of memory to each process.
44  *
45  * from: hp300: @(#)pmap.h      7.2 (Berkeley) 12/16/90
46  * from: @(#)pmap.h     7.4 (Berkeley) 5/12/91
47  * $FreeBSD: src/sys/i386/include/pmap.h,v 1.65.2.3 2001/10/03 07:15:37 peter Exp $
48  * $DragonFly: src/sys/platform/pc64/include/pmap.h,v 1.1 2008/08/29 17:07:17 dillon Exp $
49  */
50
51 #ifndef _MACHINE_PMAP_H_
52 #define _MACHINE_PMAP_H_
53
54 #include <cpu/pmap.h>
55
56 /*
57  * Size of Kernel address space.  This is the number of page table pages
58  * (2MB each) to use for the kernel.  256 pages == 512 Megabyte.
59  * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
60  */
61 #ifndef KVA_PAGES
62 #define KVA_PAGES       256
63 #endif
64
65 /*
66  * Pte related macros.  This is complicated by having to deal with
67  * the sign extension of the 48th bit.
68  */
69 #define KVADDR(l4, l3, l2, l1) ( \
70         ((unsigned long)-1 << 47) | \
71         ((unsigned long)(l4) << PML4SHIFT) | \
72         ((unsigned long)(l3) << PDPSHIFT) | \
73         ((unsigned long)(l2) << PDRSHIFT) | \
74         ((unsigned long)(l1) << PAGE_SHIFT))
75
76 #define UVADDR(l4, l3, l2, l1) ( \
77         ((unsigned long)(l4) << PML4SHIFT) | \
78         ((unsigned long)(l3) << PDPSHIFT) | \
79         ((unsigned long)(l2) << PDRSHIFT) | \
80         ((unsigned long)(l1) << PAGE_SHIFT))
81
82 /*
83  * NOTE: We no longer hardwire NKPT, it is calculated in create_pagetables()
84  */
85 #define NKPML4E         1               /* number of kernel PML4 slots */
86 /* NKPDPE defined in vmparam.h */
87
88 #define NUPML4E         (NPML4EPG/2)    /* number of userland PML4 pages */
89 #define NUPDPE          (NUPML4E*NPDPEPG)/* number of userland PDP pages */
90 #define NUPDE           (NUPDPE*NPDEPG) /* number of userland PD entries */
91
92 #define NDMPML4E        1               /* number of dmap PML4 slots */
93
94 /*
95  * The *PML4I values control the layout of virtual memory.  Each PML4
96  * entry represents 512G.
97  */
98 #define PML4PML4I       (NPML4EPG/2)    /* Index of recursive pml4 mapping */
99
100 #define KPML4I          (NPML4EPG-1)    /* Top 512GB for KVM */
101 #define DMPML4I         (KPML4I-1)      /* Next 512GB down for direct map */
102
103 /*
104  * The location of KERNBASE in the last PD of the kernel's KVM (KPML4I)
105  * space.  Each PD represents 1GB.  The kernel must be placed here
106  * for the compile/link options to work properly so absolute 32-bit
107  * addressing can be used to access stuff.
108  */
109 #define KPDPI           (NPDPEPG-2)     /* kernbase at -2GB */
110
111 /*
112  * per-CPU data assume ~64K x SMP_MAXCPU, say up to 256 cpus
113  * in the future or 16MB of space.  Each PD represents 2MB so
114  * use NPDEPG-8 to place the per-CPU data.
115  */
116 #define MPPML4I         KPML4I
117 #define MPPDPI          KPDPI
118 #define MPPTDI          (NPDEPG-8)
119
120 /*
121  * XXX doesn't really belong here I guess...
122  */
123 #define ISA_HOLE_START    0xa0000
124 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
125
126 #ifndef LOCORE
127
128 #ifndef _SYS_TYPES_H_
129 #include <sys/types.h>
130 #endif
131 #ifndef _SYS_QUEUE_H_
132 #include <sys/queue.h>
133 #endif
134 #ifndef _SYS_SPINLOCK_H_
135 #include <sys/spinlock.h>
136 #endif
137 #ifndef _SYS_THREAD_H_
138 #include <sys/thread.h>
139 #endif
140 #ifndef _MACHINE_TYPES_H_
141 #include <machine/types.h>
142 #endif
143 #ifndef _MACHINE_PARAM_H_
144 #include <machine/param.h>
145 #endif
146
147 /*
148  * Address of current and alternate address space page table maps
149  * and directories.
150  */
151 #ifdef _KERNEL
152 #define addr_PTmap      (KVADDR(PML4PML4I, 0, 0, 0))
153 #define addr_PDmap      (KVADDR(PML4PML4I, PML4PML4I, 0, 0))
154 #define addr_PDPmap     (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, 0))
155 #define addr_PML4map    (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, PML4PML4I))
156 #define addr_PML4pml4e  (addr_PML4map + (PML4PML4I * sizeof(pml4_entry_t)))
157 #define PTmap           ((pt_entry_t *)(addr_PTmap))
158 #define PDmap           ((pd_entry_t *)(addr_PDmap))
159 #define PDPmap          ((pd_entry_t *)(addr_PDPmap))
160 #define PML4map         ((pd_entry_t *)(addr_PML4map))
161 #define PML4pml4e       ((pd_entry_t *)(addr_PML4pml4e))
162
163 extern u_int64_t KPML4phys;     /* physical address of kernel level 4 */
164 #endif
165
166 #ifdef _KERNEL
167
168 /*
169  * XXX
170  */
171 #define vtophys(va)     pmap_kextract(((vm_offset_t)(va)))
172 #define vtophys_pte(va) ((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
173
174 #endif
175
176 #define pte_load_clear(pte)     atomic_readandclear_long(pte)
177
178 static __inline void
179 pte_store(pt_entry_t *ptep, pt_entry_t pte)
180 {
181         *ptep = pte;
182 }
183
184 #define pde_store(pdep, pde)    pte_store((pdep), (pde))
185
186 /*
187  * Pmap stuff
188  */
189 struct pv_entry;
190 struct vm_page;
191 struct vm_object;
192 struct vmspace;
193
194 struct md_page {
195         int pv_list_count;
196         int pv_generation;
197         TAILQ_HEAD(,pv_entry)   pv_list;
198 };
199
200 /*
201  * Each machine dependent implementation is expected to
202  * keep certain statistics.  They may do this anyway they
203  * so choose, but are expected to return the statistics
204  * in the following structure.
205  *
206  * NOTE: We try to match the size of the pc32 pmap with the vkernel pmap
207  * so the same utilities (like 'ps') can be used on both.
208  */
209 struct pmap_statistics {
210         long resident_count;    /* # of pages mapped (total) */
211         long wired_count;       /* # of pages wired */
212 };
213 typedef struct pmap_statistics *pmap_statistics_t;
214
215 struct pmap {
216         pml4_entry_t            *pm_pml4;       /* KVA of level 4 page table */
217         struct vm_page          *pm_pdirm;      /* VM page for pg directory */
218         struct vm_object        *pm_pteobj;     /* Container for pte's */
219         TAILQ_ENTRY(pmap)       pm_pmnode;      /* list of pmaps */
220         TAILQ_HEAD(,pv_entry)   pm_pvlist;      /* list of mappings in pmap */
221         TAILQ_HEAD(,pv_entry)   pm_pvlist_free; /* free mappings */
222         int                     pm_count;       /* reference count */
223         cpumask_t               pm_active;      /* active on cpus */
224         int                     pm_filler02;    /* (filler sync w/vkernel) */
225         struct pmap_statistics  pm_stats;       /* pmap statistics */
226         struct  vm_page         *pm_ptphint;    /* pmap ptp hint */
227         int                     pm_generation;  /* detect pvlist deletions */
228         int                     pm_hold;
229         struct spinlock         pm_spin;
230         struct lwkt_token       pm_token;
231 };
232
233 #define CPUMASK_LOCK            CPUMASK(SMP_MAXCPU)
234 #define CPUMASK_BIT             SMP_MAXCPU      /* for 1LLU << SMP_MAXCPU */
235
236 #define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
237
238 typedef struct pmap     *pmap_t;
239
240 #ifdef _KERNEL
241 extern struct pmap      kernel_pmap;
242 #endif
243
244 /*
245  * For each vm_page_t, there is a list of all currently valid virtual
246  * mappings of that page.  An entry is a pv_entry_t, the list is pv_table.
247  */
248 typedef struct pv_entry {
249         pmap_t          pv_pmap;        /* pmap where mapping lies */
250         vm_offset_t     pv_va;          /* virtual address for mapping */
251         TAILQ_ENTRY(pv_entry)   pv_list;
252         TAILQ_ENTRY(pv_entry)   pv_plist;
253         struct vm_page  *pv_ptem;       /* VM page for pte */
254         u_int           pv_hold;        /* hold on destruction count */
255 } *pv_entry_t;
256
257 #ifdef  _KERNEL
258
259 #define NPPROVMTRR              8
260 #define PPRO_VMTRRphysBase0     0x200
261 #define PPRO_VMTRRphysMask0     0x201
262 struct ppro_vmtrr {
263         u_int64_t base, mask;
264 };
265 extern struct ppro_vmtrr PPro_vmtrr[NPPROVMTRR];
266
267 extern caddr_t  CADDR1;
268 extern pt_entry_t *CMAP1;
269 extern vm_paddr_t dump_avail[];
270 extern vm_paddr_t avail_end;
271 extern vm_paddr_t avail_start;
272 extern vm_offset_t clean_eva;
273 extern vm_offset_t clean_sva;
274 extern char *ptvmmap;           /* poor name! */
275
276 void    pmap_release(struct pmap *pmap);
277 void    pmap_interlock_wait (struct vmspace *);
278 void    pmap_bootstrap (vm_paddr_t *);
279 void    *pmap_mapdev (vm_paddr_t, vm_size_t);
280 void    *pmap_mapdev_uncacheable(vm_paddr_t, vm_size_t);
281 void    pmap_unmapdev (vm_offset_t, vm_size_t);
282 struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
283 #ifdef SMP
284 void    pmap_set_opt (void);
285 #endif
286 vm_paddr_t pmap_kextract(vm_offset_t);
287
288 #endif /* _KERNEL */
289
290 #endif /* !LOCORE */
291
292 #endif /* !_MACHINE_PMAP_H_ */