2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1991 Regents of the University of California.
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.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * Derived from hp300 version by Mike Hibler, this version by William
36 * Jolitz uses a recursive map [a pde points to the page directory] to
37 * map the page tables using the pagetables themselves. This is done to
38 * reduce the impact on kernel virtual memory for lots of sparse address
39 * space, and to reduce the cost of memory to each process.
41 * from: hp300: @(#)pmap.h 7.2 (Berkeley) 12/16/90
42 * from: @(#)pmap.h 7.4 (Berkeley) 5/12/91
46 #ifndef _MACHINE_PMAP_H_
47 #define _MACHINE_PMAP_H_
50 * Page-directory and page-table entries follow this format, with a few
51 * of the fields not present here and there, depending on a lot of things.
53 /* ---- Intel Nomenclature ---- */
54 #define PG_V 0x001 /* P Valid */
55 #define PG_RW 0x002 /* R/W Read/Write */
56 #define PG_U 0x004 /* U/S User/Supervisor */
57 #define PG_NC_PWT 0x008 /* PWT Write through */
58 #define PG_NC_PCD 0x010 /* PCD Cache disable */
59 #define PG_A 0x020 /* A Accessed */
60 #define PG_M 0x040 /* D Dirty */
61 #define PG_PS 0x080 /* PS Page size (0=4k,1=4M) */
62 #define PG_PTE_PAT 0x080 /* PAT PAT index */
63 #define PG_G 0x100 /* G Global */
64 #define PG_AVAIL1 0x200 /* / Available for system */
65 #define PG_AVAIL2 0x400 /* < programmers use */
66 #define PG_AVAIL3 0x800 /* \ */
67 #define PG_PDE_PAT 0x1000 /* PAT PAT index */
68 #define PG_NX (1ull<<63) /* No-execute */
70 /* Our various interpretations of the above */
71 #define PG_W PG_AVAIL1 /* "Wired" pseudoflag */
72 #define PG_MANAGED PG_AVAIL2
73 #define PG_PROMOTED PG_AVAIL3 /* PDE only */
75 #define PG_PROT (PG_RW|PG_U) /* all protection bits . */
76 #define PG_N (PG_NC_PWT|PG_NC_PCD) /* Non-cacheable */
78 /* Page level cache control fields used to determine the PAT type */
79 #define PG_PDE_CACHE (PG_PDE_PAT | PG_NC_PWT | PG_NC_PCD)
80 #define PG_PTE_CACHE (PG_PTE_PAT | PG_NC_PWT | PG_NC_PCD)
83 * Promotion to a 2 or 4MB (PDE) page mapping requires that the corresponding
84 * 4KB (PTE) page mappings have identical settings for the following fields:
86 #define PG_PTE_PROMOTE (PG_MANAGED | PG_W | PG_G | PG_PTE_PAT | \
87 PG_M | PG_A | PG_NC_PCD | PG_NC_PWT | PG_U | PG_RW | PG_V)
90 * Page Protection Exception bits
93 #define PGEX_P 0x01 /* Protection violation vs. not present */
94 #define PGEX_W 0x02 /* during a Write cycle */
95 #define PGEX_U 0x04 /* access from User mode (UPL) */
96 #define PGEX_RSV 0x08 /* reserved PTE field is non-zero */
97 #define PGEX_I 0x10 /* during an instruction fetch */
102 #define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
105 #define NKPDE (KVA_PAGES) /* number of page tables/pde's */
108 #define PDRSHIFT_PAE 21 /* LOG2(NBPDR) */
109 #define PG_FRAME_PAE (0x000ffffffffff000ull)
110 #define PG_PS_FRAME_PAE (0x000fffffffe00000ull)
112 #define PDRSHIFT_NOPAE 22
113 #define PG_FRAME_NOPAE (~PAGE_MASK)
114 #define PG_PS_FRAME_NOPAE (0xffc00000)
117 * The *PTDI values control the layout of virtual memory
119 #define KPTDI 0 /* start of kernel virtual pde's */
120 /* ptd entry that points to ptd */
121 #define PTDPTDI (NPDEPTD - NTRPPTD - NPGPTD)
122 #define TRPTDI (NPDEPTD - NTRPPTD) /* u/k trampoline ptd */
125 * XXX doesn't really belong here I guess...
127 #define ISA_HOLE_START 0xa0000
128 #define ISA_HOLE_LENGTH (0x100000-ISA_HOLE_START)
132 #include <sys/queue.h>
133 #include <sys/_cpuset.h>
134 #include <sys/_lock.h>
135 #include <sys/_mutex.h>
137 #include <vm/_vm_radix.h>
140 * Address of current address space page table maps and directories.
145 * Translate a virtual address to its physical address.
147 * This macro may be used before pmap_bootstrap() is called.
149 #define vtophys(va) pmap_kextract((vm_offset_t)(va))
151 #define pte_clear(ptep) pte_store(ptep, 0)
153 #define pde_store(pdep, pde) pte_store(pdep, pde)
164 TAILQ_HEAD(,pv_entry) pv_list;
169 cpuset_t pm_active; /* active on cpus */
171 struct pmap_statistics pm_stats; /* pmap statistics */
172 uint32_t *pm_pdir_nopae; /* KVA of page directory */
173 uint64_t *pm_pdir_pae;
174 TAILQ_HEAD(,pv_chunk) pm_pvchunk; /* list of mappings in pmap */
175 LIST_ENTRY(pmap) pm_list; /* List of all pmaps */
176 uint64_t *pm_pdpt_pae;
177 struct vm_radix pm_root; /* spare page table pages */
178 vm_page_t pm_ptdpg[4]; /* PAE NPGPTD */
181 typedef struct pmap *pmap_t;
184 extern struct pmap kernel_pmap_store;
185 #define kernel_pmap (&kernel_pmap_store)
187 #define PMAP_LOCK(pmap) mtx_lock(&(pmap)->pm_mtx)
188 #define PMAP_LOCK_ASSERT(pmap, type) \
189 mtx_assert(&(pmap)->pm_mtx, (type))
190 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
191 #define PMAP_LOCK_INIT(pmap) mtx_init(&(pmap)->pm_mtx, "pmap", \
192 NULL, MTX_DEF | MTX_DUPOK)
193 #define PMAP_LOCKED(pmap) mtx_owned(&(pmap)->pm_mtx)
194 #define PMAP_MTX(pmap) (&(pmap)->pm_mtx)
195 #define PMAP_TRYLOCK(pmap) mtx_trylock(&(pmap)->pm_mtx)
196 #define PMAP_UNLOCK(pmap) mtx_unlock(&(pmap)->pm_mtx)
200 * For each vm_page_t, there is a list of all currently valid virtual
201 * mappings of that page. An entry is a pv_entry_t, the list is pv_list.
203 typedef struct pv_entry {
204 vm_offset_t pv_va; /* virtual address for mapping */
205 TAILQ_ENTRY(pv_entry) pv_next;
209 * pv_entries are allocated in chunks per-process. This avoids the
210 * need to track per-pmap assignments.
216 TAILQ_ENTRY(pv_chunk) pc_list;
217 uint32_t pc_map[_NPCM]; /* bitmap; 1 = free */
218 TAILQ_ENTRY(pv_chunk) pc_lru;
219 struct pv_entry pc_pventry[_NPCPV];
224 extern char *ptvmmap; /* poor name! */
225 extern vm_offset_t virtual_avail;
226 extern vm_offset_t virtual_end;
228 #define pmap_page_get_memattr(m) ((vm_memattr_t)(m)->md.pat_mode)
229 #define pmap_page_is_write_mapped(m) (((m)->a.flags & PGA_WRITEABLE) != 0)
230 #define pmap_unmapbios(va, sz) pmap_unmapdev((va), (sz))
233 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
242 * Only the following functions or macros may be used before pmap_bootstrap()
243 * is called: pmap_kenter(), pmap_kextract(), pmap_kremove(), vtophys(), and
246 void pmap_activate_boot(pmap_t pmap);
247 void pmap_basemem_setup(u_int basemem);
248 void *pmap_bios16_enter(void);
249 void pmap_bios16_leave(void *handle);
250 void pmap_bootstrap(vm_paddr_t);
251 int pmap_cache_bits(pmap_t, int mode, boolean_t is_pde);
252 int pmap_change_attr(vm_offset_t, vm_size_t, int);
253 caddr_t pmap_cmap3(vm_paddr_t pa, u_int pte_bits);
254 void pmap_cp_slow0_map(vm_offset_t kaddr, int plen, vm_page_t *ma);
255 void pmap_flush_page(vm_page_t m);
256 u_int pmap_get_kcr3(void);
257 u_int pmap_get_cr3(pmap_t);
258 vm_offset_t pmap_get_map_low(void);
259 vm_offset_t pmap_get_vm_maxuser_address(void);
260 void pmap_init_pat(void);
261 void pmap_kenter(vm_offset_t va, vm_paddr_t pa);
262 void *pmap_kenter_temporary(vm_paddr_t pa, int i);
263 vm_paddr_t pmap_kextract(vm_offset_t va);
264 void pmap_kremove(vm_offset_t);
265 void pmap_ksetrw(vm_offset_t va);
266 void *pmap_mapbios(vm_paddr_t, vm_size_t);
267 void *pmap_mapdev(vm_paddr_t, vm_size_t);
268 void *pmap_mapdev_attr(vm_paddr_t, vm_size_t, int);
269 boolean_t pmap_page_is_mapped(vm_page_t m);
270 void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
271 vm_paddr_t pmap_pg_frame(vm_paddr_t pa);
272 bool pmap_ps_enabled(pmap_t pmap);
273 void pmap_remap_lower(bool);
274 void pmap_remap_lowptdi(bool);
275 void pmap_set_nx(void);
276 void pmap_sf_buf_map(struct sf_buf *sf);
277 void pmap_unmapdev(vm_offset_t, vm_size_t);
278 void pmap_invalidate_page(pmap_t, vm_offset_t);
279 void pmap_invalidate_range(pmap_t, vm_offset_t, vm_offset_t);
280 void pmap_invalidate_all(pmap_t);
281 void pmap_invalidate_cache(void);
282 void pmap_invalidate_cache_pages(vm_page_t *pages, int count);
283 void pmap_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva);
284 void pmap_force_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva);
285 void *pmap_trm_alloc(size_t size, int flags);
286 void pmap_trm_free(void *addr, size_t size);
288 void invltlb_glob(void);
293 extern int i386_pmap_VM_NFREEORDER;
294 extern int i386_pmap_VM_LEVEL_0_ORDER;
295 extern int i386_pmap_PDRSHIFT;
301 #endif /* !_MACHINE_PMAP_H_ */