kernel: Make SMP support default (and non-optional).
[dragonfly.git] / sys / platform / pc64 / include / pmap.h
CommitLineData
c8fe38ae
MD
1/*
2 * Copyright (c) 1991 Regents of the University of California.
48ffc236 3 * Copyright (c) 2003 Peter Wemm.
c8fe38ae
MD
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 $
c8fe38ae
MD
48 */
49
50#ifndef _MACHINE_PMAP_H_
51#define _MACHINE_PMAP_H_
52
53#include <cpu/pmap.h>
54
55/*
56 * Size of Kernel address space. This is the number of page table pages
90244566 57 * (2GB each) to use for the kernel. 256 pages == 512 Gigabytes.
c8fe38ae
MD
58 * This **MUST** be a multiple of 4 (eg: 252, 256, 260, etc).
59 */
60#ifndef KVA_PAGES
61#define KVA_PAGES 256
62#endif
63
64/*
48ffc236
JG
65 * Pte related macros. This is complicated by having to deal with
66 * the sign extension of the 48th bit.
c8fe38ae 67 */
48ffc236
JG
68#define KVADDR(l4, l3, l2, l1) ( \
69 ((unsigned long)-1 << 47) | \
70 ((unsigned long)(l4) << PML4SHIFT) | \
71 ((unsigned long)(l3) << PDPSHIFT) | \
72 ((unsigned long)(l2) << PDRSHIFT) | \
73 ((unsigned long)(l1) << PAGE_SHIFT))
74
75#define UVADDR(l4, l3, l2, l1) ( \
76 ((unsigned long)(l4) << PML4SHIFT) | \
77 ((unsigned long)(l3) << PDPSHIFT) | \
78 ((unsigned long)(l2) << PDRSHIFT) | \
79 ((unsigned long)(l1) << PAGE_SHIFT))
80
791c6551 81/*
ad54aa11 82 * NOTE: We no longer hardwire NKPT, it is calculated in create_pagetables()
791c6551 83 */
48ffc236 84#define NKPML4E 1 /* number of kernel PML4 slots */
791c6551 85/* NKPDPE defined in vmparam.h */
48ffc236 86
701c977e
MD
87/*
88 * NUPDPs 512 (256 user) number of PDPs in user page table
89 * NUPDs 512 * 512 number of PDs in user page table
90 * NUPTs 512 * 512 * 512 number of PTs in user page table
91 * NUPTEs 512 * 512 * 512 * 512 number of PTEs in user page table
92 *
93 * NUPDP_USER number of PDPs reserved for userland
94 * NUPTE_USER number of PTEs reserved for userland (big number)
95 */
96#define NUPDP_USER (NPML4EPG/2)
97#define NUPDP_TOTAL (NPML4EPG)
98#define NUPD_TOTAL (NPDPEPG * NUPDP_TOTAL)
99#define NUPT_TOTAL (NPDEPG * NUPD_TOTAL)
100#define NUPTE_TOTAL ((vm_pindex_t)NPTEPG * NUPT_TOTAL)
101#define NUPTE_USER ((vm_pindex_t)NPTEPG * NPDEPG * NPDPEPG * NUPDP_USER)
48ffc236 102
33fb3ba1
MD
103/*
104 * Number of 512G dmap PML4 slots (max ~254 or so but don't go over 64,
105 * which gives us 32TB of ram). Because we cache free, empty pmaps the
106 * initialization overhead is minimal.
107 *
108 * It should be possible to bump this up to 255 (but not 256), which would
109 * be able to address a maximum of ~127TB of physical ram.
110 */
111#define NDMPML4E 64
48ffc236 112
c8fe38ae 113/*
da23a592
MD
114 * The *PML4I values control the layout of virtual memory. Each PML4
115 * entry represents 512G.
c8fe38ae 116 */
48ffc236
JG
117#define PML4PML4I (NPML4EPG/2) /* Index of recursive pml4 mapping */
118
119#define KPML4I (NPML4EPG-1) /* Top 512GB for KVM */
33fb3ba1 120#define DMPML4I (KPML4I-NDMPML4E) /* Next 512GBxN down for dmap */
c8fe38ae 121
da23a592
MD
122/*
123 * The location of KERNBASE in the last PD of the kernel's KVM (KPML4I)
124 * space. Each PD represents 1GB. The kernel must be placed here
125 * for the compile/link options to work properly so absolute 32-bit
126 * addressing can be used to access stuff.
127 */
48ffc236
JG
128#define KPDPI (NPDPEPG-2) /* kernbase at -2GB */
129
da23a592
MD
130/*
131 * per-CPU data assume ~64K x SMP_MAXCPU, say up to 256 cpus
132 * in the future or 16MB of space. Each PD represents 2MB so
133 * use NPDEPG-8 to place the per-CPU data.
134 */
48ffc236
JG
135#define MPPML4I KPML4I
136#define MPPDPI KPDPI
da23a592 137#define MPPTDI (NPDEPG-8)
c8fe38ae
MD
138
139/*
140 * XXX doesn't really belong here I guess...
141 */
142#define ISA_HOLE_START 0xa0000
143#define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
144
145#ifndef LOCORE
146
147#ifndef _SYS_TYPES_H_
148#include <sys/types.h>
149#endif
150#ifndef _SYS_QUEUE_H_
151#include <sys/queue.h>
152#endif
701c977e
MD
153#ifndef _SYS_TREE_H_
154#include <sys/tree.h>
155#endif
b12defdc
MD
156#ifndef _SYS_SPINLOCK_H_
157#include <sys/spinlock.h>
158#endif
159#ifndef _SYS_THREAD_H_
160#include <sys/thread.h>
161#endif
c8fe38ae
MD
162#ifndef _MACHINE_TYPES_H_
163#include <machine/types.h>
164#endif
165#ifndef _MACHINE_PARAM_H_
166#include <machine/param.h>
167#endif
168
169/*
170 * Address of current and alternate address space page table maps
171 * and directories.
172 */
173#ifdef _KERNEL
48ffc236
JG
174#define addr_PTmap (KVADDR(PML4PML4I, 0, 0, 0))
175#define addr_PDmap (KVADDR(PML4PML4I, PML4PML4I, 0, 0))
176#define addr_PDPmap (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, 0))
177#define addr_PML4map (KVADDR(PML4PML4I, PML4PML4I, PML4PML4I, PML4PML4I))
178#define addr_PML4pml4e (addr_PML4map + (PML4PML4I * sizeof(pml4_entry_t)))
179#define PTmap ((pt_entry_t *)(addr_PTmap))
180#define PDmap ((pd_entry_t *)(addr_PDmap))
181#define PDPmap ((pd_entry_t *)(addr_PDPmap))
182#define PML4map ((pd_entry_t *)(addr_PML4map))
183#define PML4pml4e ((pd_entry_t *)(addr_PML4pml4e))
184
185extern u_int64_t KPML4phys; /* physical address of kernel level 4 */
c8fe38ae
MD
186#endif
187
188#ifdef _KERNEL
c8fe38ae
MD
189
190/*
191 * XXX
192 */
193#define vtophys(va) pmap_kextract(((vm_offset_t)(va)))
194#define vtophys_pte(va) ((pt_entry_t)pmap_kextract(((vm_offset_t)(va))))
195
196#endif
197
198#define pte_load_clear(pte) atomic_readandclear_long(pte)
199
48ffc236
JG
200static __inline void
201pte_store(pt_entry_t *ptep, pt_entry_t pte)
202{
48ffc236
JG
203 *ptep = pte;
204}
205
206#define pde_store(pdep, pde) pte_store((pdep), (pde))
207
c8fe38ae
MD
208/*
209 * Pmap stuff
210 */
921c891e 211struct pmap;
c8fe38ae
MD
212struct pv_entry;
213struct vm_page;
214struct vm_object;
c2fb025d 215struct vmspace;
c8fe38ae 216
921c891e
MD
217/*
218 * vm_page structures embed a list of related pv_entry's
219 */
c8fe38ae 220struct md_page {
c8fe38ae
MD
221 TAILQ_HEAD(,pv_entry) pv_list;
222};
223
921c891e
MD
224/*
225 * vm_object's representing large mappings can contain embedded pmaps
226 * to organize sharing at higher page table levels for PROT_READ and
227 * PROT_READ|PROT_WRITE maps.
228 */
229struct md_object {
230 struct pmap *pmap_rw;
231 struct pmap *pmap_ro;
232};
233
c8fe38ae
MD
234/*
235 * Each machine dependent implementation is expected to
236 * keep certain statistics. They may do this anyway they
237 * so choose, but are expected to return the statistics
238 * in the following structure.
239 *
240 * NOTE: We try to match the size of the pc32 pmap with the vkernel pmap
241 * so the same utilities (like 'ps') can be used on both.
242 */
243struct pmap_statistics {
244 long resident_count; /* # of pages mapped (total) */
245 long wired_count; /* # of pages wired */
246};
247typedef struct pmap_statistics *pmap_statistics_t;
248
701c977e
MD
249struct pv_entry_rb_tree;
250RB_PROTOTYPE2(pv_entry_rb_tree, pv_entry, pv_entry,
251 pv_entry_compare, vm_pindex_t);
252
c8fe38ae 253struct pmap {
48ffc236 254 pml4_entry_t *pm_pml4; /* KVA of level 4 page table */
701c977e 255 struct pv_entry *pm_pmlpv; /* PV entry for pml4 */
c8fe38ae 256 TAILQ_ENTRY(pmap) pm_pmnode; /* list of pmaps */
701c977e 257 RB_HEAD(pv_entry_rb_tree, pv_entry) pm_pvroot;
c8fe38ae
MD
258 int pm_count; /* reference count */
259 cpumask_t pm_active; /* active on cpus */
921c891e 260 int pm_flags;
c8fe38ae 261 struct pmap_statistics pm_stats; /* pmap statistics */
701c977e 262 struct pv_entry *pm_pvhint; /* pv_entry lookup hint */
c8fe38ae 263 int pm_generation; /* detect pvlist deletions */
b12defdc
MD
264 struct spinlock pm_spin;
265 struct lwkt_token pm_token;
c8fe38ae
MD
266};
267
da23a592
MD
268#define CPUMASK_LOCK CPUMASK(SMP_MAXCPU)
269#define CPUMASK_BIT SMP_MAXCPU /* for 1LLU << SMP_MAXCPU */
c2fb025d 270
921c891e
MD
271#define PMAP_FLAG_SIMPLE 0x00000001
272
c8fe38ae
MD
273#define pmap_resident_count(pmap) (pmap)->pm_stats.resident_count
274
275typedef struct pmap *pmap_t;
276
277#ifdef _KERNEL
278extern struct pmap kernel_pmap;
279#endif
280
281/*
282 * For each vm_page_t, there is a list of all currently valid virtual
283 * mappings of that page. An entry is a pv_entry_t, the list is pv_table.
284 */
285typedef struct pv_entry {
286 pmap_t pv_pmap; /* pmap where mapping lies */
701c977e 287 vm_pindex_t pv_pindex; /* PTE, PT, PD, PDP, or PML4 */
c8fe38ae 288 TAILQ_ENTRY(pv_entry) pv_list;
701c977e
MD
289 RB_ENTRY(pv_entry) pv_entry;
290 struct vm_page *pv_m; /* page being mapped */
291 u_int pv_hold; /* interlock action */
921c891e 292 u_int pv_flags;
701c977e
MD
293#ifdef PMAP_DEBUG
294 const char *pv_func;
295 int pv_line;
296#endif
c8fe38ae
MD
297} *pv_entry_t;
298
921c891e
MD
299#define PV_HOLD_LOCKED 0x80000000U
300#define PV_HOLD_WAITING 0x40000000U
301#define PV_HOLD_DELETED 0x20000000U
302#define PV_HOLD_MASK 0x1FFFFFFFU
303
304#define PV_FLAG_VMOBJECT 0x00000001U /* shared pt in VM obj */
701c977e 305
c8fe38ae
MD
306#ifdef _KERNEL
307
308#define NPPROVMTRR 8
309#define PPRO_VMTRRphysBase0 0x200
310#define PPRO_VMTRRphysMask0 0x201
311struct ppro_vmtrr {
312 u_int64_t base, mask;
313};
314extern struct ppro_vmtrr PPro_vmtrr[NPPROVMTRR];
315
316extern caddr_t CADDR1;
317extern pt_entry_t *CMAP1;
b24cd69c 318extern vm_paddr_t dump_avail[];
c8fe38ae
MD
319extern vm_paddr_t avail_end;
320extern vm_paddr_t avail_start;
321extern vm_offset_t clean_eva;
322extern vm_offset_t clean_sva;
323extern char *ptvmmap; /* poor name! */
324
b12defdc 325void pmap_release(struct pmap *pmap);
c2fb025d
MD
326void pmap_interlock_wait (struct vmspace *);
327void pmap_bootstrap (vm_paddr_t *);
c8fe38ae 328void *pmap_mapdev (vm_paddr_t, vm_size_t);
057877ac 329void *pmap_mapdev_uncacheable(vm_paddr_t, vm_size_t);
c8fe38ae 330void pmap_unmapdev (vm_offset_t, vm_size_t);
c8fe38ae 331struct vm_page *pmap_use_pt (pmap_t, vm_offset_t);
c8fe38ae 332void pmap_set_opt (void);
48ffc236 333vm_paddr_t pmap_kextract(vm_offset_t);
c8fe38ae
MD
334
335#endif /* _KERNEL */
336
337#endif /* !LOCORE */
338
339#endif /* !_MACHINE_PMAP_H_ */