2 * Copyright (c) 1991 Regents of the University of California.
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.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 #ifndef _MACHINE_PMAP_H_
39 #define _MACHINE_PMAP_H_
41 #include <machine/pte.h>
45 #include <sys/queue.h>
46 #include <sys/_lock.h>
47 #include <sys/_mutex.h>
48 #include <sys/_pv_entry.h>
50 #include <vm/_vm_radix.h>
54 #define vtophys(va) pmap_kextract((vm_offset_t)(va))
58 #define pmap_page_get_memattr(m) ((m)->md.pv_memattr)
59 #define pmap_page_is_write_mapped(m) (((m)->a.flags & PGA_WRITEABLE) != 0)
60 void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma);
67 TAILQ_HEAD(,pv_entry) pv_list;
69 vm_memattr_t pv_memattr;
73 * This structure is used to hold a virtual<->physical address
74 * association and is used mostly by bootstrap code
77 SLIST_ENTRY(pv_addr) pv_list;
90 struct pmap_statistics pm_stats; /* pmap statistics */
92 vm_paddr_t pm_l0_paddr;
94 TAILQ_HEAD(,pv_chunk) pm_pvchunk; /* list of mappings in pmap */
95 struct vm_radix pm_root; /* spare page table pages */
96 long pm_cookie; /* encodes the pmap's ASID */
97 struct asid_set *pm_asid_set; /* The ASID/VMID set to use */
98 enum pmap_stage pm_stage;
100 uint64_t pm_reserved[4];
102 typedef struct pmap *pmap_t;
107 extern struct pmap kernel_pmap_store;
108 #define kernel_pmap (&kernel_pmap_store)
109 #define pmap_kernel() kernel_pmap
111 #define PMAP_ASSERT_LOCKED(pmap) \
112 mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
113 #define PMAP_LOCK(pmap) mtx_lock(&(pmap)->pm_mtx)
114 #define PMAP_LOCK_ASSERT(pmap, type) \
115 mtx_assert(&(pmap)->pm_mtx, (type))
116 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
117 #define PMAP_LOCK_INIT(pmap) mtx_init(&(pmap)->pm_mtx, "pmap", \
118 NULL, MTX_DEF | MTX_DUPOK)
119 #define PMAP_OWNED(pmap) mtx_owned(&(pmap)->pm_mtx)
120 #define PMAP_MTX(pmap) (&(pmap)->pm_mtx)
121 #define PMAP_TRYLOCK(pmap) mtx_trylock(&(pmap)->pm_mtx)
122 #define PMAP_UNLOCK(pmap) mtx_unlock(&(pmap)->pm_mtx)
124 #define ASID_RESERVED_FOR_PID_0 0
125 #define ASID_RESERVED_FOR_EFI 1
126 #define ASID_FIRST_AVAILABLE (ASID_RESERVED_FOR_EFI + 1)
127 #define ASID_TO_OPERAND(asid) ({ \
128 KASSERT((asid) != -1, ("invalid ASID")); \
129 (uint64_t)(asid) << TTBR_ASID_SHIFT; \
132 #define PMAP_WANT_ACTIVE_CPUS_NAIVE
134 extern vm_offset_t virtual_avail;
135 extern vm_offset_t virtual_end;
138 * Macros to test if a mapping is mappable with an L1 Section mapping
139 * or an L2 Large Page mapping.
141 #define L1_MAPPABLE_P(va, pa, size) \
142 ((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE)
144 #define pmap_vm_page_alloc_check(m)
146 void pmap_activate_vm(pmap_t);
147 void pmap_bootstrap(vm_size_t);
148 int pmap_change_attr(vm_offset_t va, vm_size_t size, int mode);
149 int pmap_change_prot(vm_offset_t va, vm_size_t size, vm_prot_t prot);
150 void pmap_kenter(vm_offset_t sva, vm_size_t size, vm_paddr_t pa, int mode);
151 void pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t);
152 bool pmap_klookup(vm_offset_t va, vm_paddr_t *pa);
153 vm_paddr_t pmap_kextract(vm_offset_t va);
154 void pmap_kremove(vm_offset_t);
155 void pmap_kremove_device(vm_offset_t, vm_size_t);
156 void *pmap_mapdev_attr(vm_paddr_t pa, vm_size_t size, vm_memattr_t ma);
157 bool pmap_page_is_mapped(vm_page_t m);
158 int pmap_pinit_stage(pmap_t, enum pmap_stage, int);
159 bool pmap_ps_enabled(pmap_t pmap);
160 uint64_t pmap_to_ttbr0(pmap_t pmap);
161 void pmap_disable_promotion(vm_offset_t sva, vm_size_t size);
162 void pmap_map_delete(pmap_t, vm_offset_t, vm_offset_t);
164 void *pmap_mapdev(vm_paddr_t, vm_size_t);
165 void *pmap_mapbios(vm_paddr_t, vm_size_t);
166 void pmap_unmapdev(void *, vm_size_t);
167 void pmap_unmapbios(void *, vm_size_t);
169 bool pmap_map_io_transient(vm_page_t *, vm_offset_t *, int, bool);
170 void pmap_unmap_io_transient(vm_page_t *, vm_offset_t *, int, bool);
172 bool pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **,
173 pd_entry_t **, pt_entry_t **);
175 int pmap_fault(pmap_t, uint64_t, uint64_t);
177 struct pcb *pmap_switch(struct thread *);
179 extern void (*pmap_clean_stage2_tlbi)(void);
180 extern void (*pmap_invalidate_vpipt_icache)(void);
181 extern void (*pmap_stage2_invalidate_range)(uint64_t, vm_offset_t, vm_offset_t,
183 extern void (*pmap_stage2_invalidate_all)(uint64_t);
186 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused)
192 #if defined(KASAN) || defined(KMSAN)
193 struct arm64_bootparams;
195 void pmap_bootstrap_san(void);
196 void pmap_san_enter(vm_offset_t);
197 void pmap_san_bootstrap(struct arm64_bootparams *);
204 #endif /* !_MACHINE_PMAP_H_ */
206 #endif /* !__arm__ */