1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1991 Regents of the University of California.
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. 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.
22 *
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
33 * SUCH DAMAGE.
34 *
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.
40 */
41
42#ifndef _MACHINE_PMAP_H_
43#define _MACHINE_PMAP_H_
44
45/*
46 * Page-directory and page-table entries follow this format, with a few
47 * of the fields not present here and there, depending on a lot of things.
48 */
49 /* ---- Intel Nomenclature ---- */
50#define PG_V 0x001 /* P Valid */
51#define PG_RW 0x002 /* R/W Read/Write */
52#define PG_U 0x004 /* U/S User/Supervisor */
53#define PG_NC_PWT 0x008 /* PWT Write through */
54#define PG_NC_PCD 0x010 /* PCD Cache disable */
55#define PG_A 0x020 /* A Accessed */
56#define PG_M 0x040 /* D Dirty */
57#define PG_PS 0x080 /* PS Page size (0=4k,1=4M) */
58#define PG_PTE_PAT 0x080 /* PAT PAT index */
59#define PG_G 0x100 /* G Global */
60#define PG_AVAIL1 0x200 /* / Available for system */
61#define PG_AVAIL2 0x400 /* < programmers use */
62#define PG_AVAIL3 0x800 /* \ */
63#define PG_PDE_PAT 0x1000 /* PAT PAT index */
64#define PG_NX (1ull<<63) /* No-execute */
65
66/* Our various interpretations of the above */
67#define PG_W PG_AVAIL1 /* "Wired" pseudoflag */
68#define PG_MANAGED PG_AVAIL2
69#define PG_PROMOTED PG_AVAIL3 /* PDE only */
70
71#define PG_PROT (PG_RW|PG_U) /* all protection bits . */
72#define PG_N (PG_NC_PWT|PG_NC_PCD) /* Non-cacheable */
73
74/* Page level cache control fields used to determine the PAT type */
75#define PG_PDE_CACHE (PG_PDE_PAT | PG_NC_PWT | PG_NC_PCD)
76#define PG_PTE_CACHE (PG_PTE_PAT | PG_NC_PWT | PG_NC_PCD)
77
78/*
79 * Promotion to a 2 or 4MB (PDE) page mapping requires that the corresponding
80 * 4KB (PTE) page mappings have identical settings for the following fields:
81 */
82#define PG_PTE_PROMOTE (PG_MANAGED | PG_W | PG_G | PG_PTE_PAT | \
83 PG_M | PG_NC_PCD | PG_NC_PWT | PG_U | PG_RW | PG_V)
84
85/*
86 * Page Protection Exception bits
87 */
88
89#define PGEX_P 0x01 /* Protection violation vs. not present */
90#define PGEX_W 0x02 /* during a Write cycle */
91#define PGEX_U 0x04 /* access from User mode (UPL) */
92#define PGEX_RSV 0x08 /* reserved PTE field is non-zero */
93#define PGEX_I 0x10 /* during an instruction fetch */
94
95/*
96 * Pte related macros
97 */
98#define VADDR(pdi, pti) ((vm_offset_t)(((pdi)<<PDRSHIFT)|((pti)<<PAGE_SHIFT)))
99
100#ifndef NKPDE
101#define NKPDE (KVA_PAGES) /* number of page tables/pde's */
102#endif
103
104#define PDRSHIFT_PAE 21 /* LOG2(NBPDR) */
105#define PG_FRAME_PAE (0x000ffffffffff000ull)
106#define PG_PS_FRAME_PAE (0x000fffffffe00000ull)
107
108#define PDRSHIFT_NOPAE 22
109#define PG_FRAME_NOPAE (~PAGE_MASK)
110#define PG_PS_FRAME_NOPAE (0xffc00000)
111
112/*
113 * The *PTDI values control the layout of virtual memory
114 */
115#define KPTDI 0 /* start of kernel virtual pde's */
116/* ptd entry that points to ptd */
117#define PTDPTDI (NPDEPTD - NTRPPTD - NPGPTD)
118#define TRPTDI (NPDEPTD - NTRPPTD) /* u/k trampoline ptd */
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#include <sys/queue.h>
129#include <sys/_cpuset.h>
130#include <sys/_lock.h>
131#include <sys/_mutex.h>
132#include <sys/_pv_entry.h>
133
134#include <vm/_vm_radix.h>
135
136/*
137 * Address of current address space page table maps and directories.
138 */
139#ifdef _KERNEL
140
141/*
142 * Translate a virtual address to its physical address.
143 *
144 * This macro may be used before pmap_bootstrap() is called.
145 */
146#define vtophys(va) pmap_kextract((vm_offset_t)(va))
147
148#define pte_clear(ptep) pte_store(ptep, 0)
149
150#define pde_store(pdep, pde) pte_store(pdep, pde)
151
152#endif /* _KERNEL */
153
154/*
155 * Pmap stuff
156 */
157struct md_page {
158 TAILQ_HEAD(,pv_entry) pv_list;
159 int pat_mode;
160};
161
162struct pmap {
163 cpuset_t pm_active; /* active on cpus */
164 struct mtx pm_mtx;
165 struct pmap_statistics pm_stats; /* pmap statistics */
166 uint32_t *pm_pdir_nopae; /* KVA of page directory */
167 uint64_t *pm_pdir_pae;
168 TAILQ_HEAD(,pv_chunk) pm_pvchunk; /* list of mappings in pmap */
169 LIST_ENTRY(pmap) pm_list; /* List of all pmaps */
170 uint64_t *pm_pdpt_pae;
171 struct vm_radix pm_root; /* spare page table pages */
172 vm_page_t pm_ptdpg[4]; /* PAE NPGPTD */
173};
174
175typedef struct pmap *pmap_t;
176
177#ifdef _KERNEL
178extern struct pmap kernel_pmap_store;
179#define kernel_pmap (&kernel_pmap_store)
180
181#define PMAP_LOCK(pmap) mtx_lock(&(pmap)->pm_mtx)
182#define PMAP_LOCK_ASSERT(pmap, type) \
183 mtx_assert(&(pmap)->pm_mtx, (type))
184#define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
185#define PMAP_LOCK_INIT(pmap) mtx_init(&(pmap)->pm_mtx, "pmap", \
186 NULL, MTX_DEF | MTX_DUPOK)
187#define PMAP_LOCKED(pmap) mtx_owned(&(pmap)->pm_mtx)
188#define PMAP_MTX(pmap) (&(pmap)->pm_mtx)
189#define PMAP_TRYLOCK(pmap) mtx_trylock(&(pmap)->pm_mtx)
190#define PMAP_UNLOCK(pmap) mtx_unlock(&(pmap)->pm_mtx)
191
192extern char *ptvmmap; /* poor name! */
193extern vm_offset_t virtual_avail;
194extern vm_offset_t virtual_end;
195
196#define pmap_page_get_memattr(m) ((vm_memattr_t)(m)->md.pat_mode)
197#define pmap_page_is_write_mapped(m) (((m)->a.flags & PGA_WRITEABLE) != 0)
198#define pmap_unmapbios(va, sz) pmap_unmapdev((va), (sz))
199
200static inline int
201pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
202{
203
204 return (0);
205}
206
207struct sf_buf;
208
209#define pmap_vm_page_alloc_check(m)
210
211/*
212 * Only the following functions or macros may be used before pmap_bootstrap()
213 * is called: pmap_kenter(), pmap_kextract(), pmap_kremove(), vtophys(), and
214 * vtopte().
215 */
216void pmap_activate_boot(pmap_t pmap);
217void pmap_basemem_setup(u_int basemem);
218void *pmap_bios16_enter(void);
219void pmap_bios16_leave(void *handle);
220void pmap_bootstrap(vm_paddr_t);
221int pmap_cache_bits(pmap_t, int mode, bool is_pde);
222int pmap_change_attr(vm_offset_t, vm_size_t, int);
223caddr_t pmap_cmap3(vm_paddr_t pa, u_int pte_bits);
224void pmap_cp_slow0_map(vm_offset_t kaddr, int plen, vm_page_t *ma);
225void pmap_flush_page(vm_page_t m);
226u_int pmap_get_kcr3(void);
227u_int pmap_get_cr3(pmap_t);
228vm_offset_t pmap_get_map_low(void);
229vm_offset_t pmap_get_vm_maxuser_address(void);
230void pmap_init_pat(void);
231void pmap_kenter(vm_offset_t va, vm_paddr_t pa);
232void *pmap_kenter_temporary(vm_paddr_t pa, int i);
233vm_paddr_t pmap_kextract(vm_offset_t va);
234void pmap_kremove(vm_offset_t);
235void pmap_ksetrw(vm_offset_t va);
236void *pmap_mapbios(vm_paddr_t, vm_size_t);
237void *pmap_mapdev(vm_paddr_t, vm_size_t);
238void *pmap_mapdev_attr(vm_paddr_t, vm_size_t, int);
239bool pmap_page_is_mapped(vm_page_t m);
240void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
241vm_paddr_t pmap_pg_frame(vm_paddr_t pa);
242bool pmap_ps_enabled(pmap_t pmap);
243void pmap_remap_lower(bool);
244void pmap_remap_lowptdi(bool);
245void pmap_set_nx(void);
246void pmap_sf_buf_map(struct sf_buf *sf);
247void pmap_unmapdev(void *, vm_size_t);
248void pmap_invalidate_page(pmap_t, vm_offset_t);
249void pmap_invalidate_range(pmap_t, vm_offset_t, vm_offset_t);
250void pmap_invalidate_all(pmap_t);
251void pmap_invalidate_cache(void);
252void pmap_invalidate_cache_pages(vm_page_t *pages, int count);
253void pmap_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva);
254void pmap_force_invalidate_cache_range(vm_offset_t sva, vm_offset_t eva);
255void *pmap_trm_alloc(size_t size, int flags);
256void pmap_trm_free(void *addr, size_t size);
257#define pmap_map_delete(pmap, sva, eva) pmap_remove(pmap, sva, eva)
258
259void invltlb_glob(void);
260
261struct thread;
262
263extern int pae_mode;
264extern int i386_pmap_VM_NFREEORDER;
265extern int i386_pmap_VM_LEVEL_0_ORDER;
266extern int i386_pmap_PDRSHIFT;
267
268#endif /* _KERNEL */
269
270#endif /* !LOCORE */
271
272#endif /* !_MACHINE_PMAP_H_ */