1 /*- 2 * Copyright (c) 1991 Regents of the University of California. 3 * All rights reserved. 4 * 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. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 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. 20 * 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 31 * SUCH DAMAGE. 32 */ 33 34 #ifdef __arm__ 35 #include <arm/pmap.h> 36 #else /* !__arm__ */ 37 38 #ifndef _MACHINE_PMAP_H_ 39 #define _MACHINE_PMAP_H_ 40 41 #include <machine/pte.h> 42 43 #ifndef LOCORE 44 45 #include <sys/queue.h> 46 #include <sys/systm.h> 47 #include <sys/_lock.h> 48 #include <sys/_mutex.h> 49 #include <sys/_pv_entry.h> 50 51 #include <vm/_vm_radix.h> 52 53 #ifdef _KERNEL 54 55 #define vtophys(va) pmap_kextract((vm_offset_t)(va)) 56 57 #endif 58 59 #define pmap_page_get_memattr(m) ((m)->md.pv_memattr) 60 #define pmap_page_is_write_mapped(m) (((m)->a.flags & PGA_WRITEABLE) != 0) 61 void pmap_page_set_memattr(vm_page_t m, vm_memattr_t ma); 62 63 /* 64 * Pmap stuff 65 */ 66 67 struct rangeset; 68 69 struct md_page { 70 TAILQ_HEAD(,pv_entry) pv_list; 71 int pv_gen; 72 vm_memattr_t pv_memattr; 73 uint8_t pv_reserve[3]; 74 }; 75 76 enum pmap_stage { 77 PM_INVALID, 78 PM_STAGE1, 79 PM_STAGE2, 80 }; 81 82 struct pmap { 83 struct mtx pm_mtx; 84 struct pmap_statistics pm_stats; /* pmap statistics */ 85 uint64_t pm_ttbr; 86 vm_paddr_t pm_l0_paddr; 87 pd_entry_t *pm_l0; 88 TAILQ_HEAD(,pv_chunk) pm_pvchunk; /* list of mappings in pmap */ 89 struct vm_radix pm_root; /* spare page table pages */ 90 long pm_cookie; /* encodes the pmap's ASID */ 91 struct asid_set *pm_asid_set; /* The ASID/VMID set to use */ 92 enum pmap_stage pm_stage; 93 int pm_levels; 94 struct rangeset *pm_bti; 95 uint64_t pm_reserved[3]; 96 }; 97 typedef struct pmap *pmap_t; 98 99 struct thread; 100 101 #ifdef _KERNEL 102 extern struct pmap kernel_pmap_store; 103 #define kernel_pmap (&kernel_pmap_store) 104 #define pmap_kernel() kernel_pmap 105 106 extern bool pmap_lpa_enabled; 107 108 #define PMAP_ASSERT_LOCKED(pmap) \ 109 mtx_assert(&(pmap)->pm_mtx, MA_OWNED) 110 #define PMAP_LOCK(pmap) mtx_lock(&(pmap)->pm_mtx) 111 #define PMAP_LOCK_ASSERT(pmap, type) \ 112 mtx_assert(&(pmap)->pm_mtx, (type)) 113 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx) 114 #define PMAP_LOCK_INIT(pmap) mtx_init(&(pmap)->pm_mtx, "pmap", \ 115 NULL, MTX_DEF | MTX_DUPOK) 116 #define PMAP_OWNED(pmap) mtx_owned(&(pmap)->pm_mtx) 117 #define PMAP_MTX(pmap) (&(pmap)->pm_mtx) 118 #define PMAP_TRYLOCK(pmap) mtx_trylock(&(pmap)->pm_mtx) 119 #define PMAP_UNLOCK(pmap) mtx_unlock(&(pmap)->pm_mtx) 120 121 #define ASID_RESERVED_FOR_PID_0 0 122 #define ASID_RESERVED_FOR_EFI 1 123 #define ASID_FIRST_AVAILABLE (ASID_RESERVED_FOR_EFI + 1) 124 #define ASID_TO_OPERAND(asid) ({ \ 125 KASSERT((asid) != -1, ("invalid ASID")); \ 126 (uint64_t)(asid) << TTBR_ASID_SHIFT; \ 127 }) 128 129 #define PMAP_WANT_ACTIVE_CPUS_NAIVE 130 131 extern vm_offset_t virtual_avail; 132 extern vm_offset_t virtual_end; 133 134 extern pt_entry_t pmap_sh_attr; 135 136 extern __read_mostly uint64_t prot_ns_shared_pa; 137 138 /* 139 * Macros to test if a mapping is mappable with an L1 Section mapping 140 * or an L2 Large Page mapping. 141 */ 142 #define L1_MAPPABLE_P(va, pa, size) \ 143 ((((va) | (pa)) & L1_OFFSET) == 0 && (size) >= L1_SIZE) 144 145 #define pmap_vm_page_alloc_check(m) 146 147 void pmap_activate_vm(pmap_t); 148 void pmap_bootstrap_dmap(vm_size_t); 149 void pmap_bootstrap(void); 150 int pmap_change_attr(void *va, vm_size_t size, int mode); 151 int pmap_change_prot(void *va, vm_size_t size, vm_prot_t prot); 152 void pmap_kenter(vm_offset_t sva, vm_size_t size, vm_paddr_t pa, int mode); 153 void pmap_kenter_device(vm_offset_t, vm_size_t, vm_paddr_t); 154 bool pmap_klookup(vm_offset_t va, vm_paddr_t *pa); 155 vm_paddr_t pmap_kextract(vm_offset_t va); 156 void pmap_kremove(vm_offset_t); 157 void pmap_kremove_device(vm_offset_t, vm_size_t); 158 void *pmap_mapdev_attr(vm_paddr_t pa, vm_size_t size, vm_memattr_t ma); 159 bool pmap_page_is_mapped(vm_page_t m); 160 int pmap_pinit_stage(pmap_t, enum pmap_stage, int); 161 bool pmap_ps_enabled(pmap_t pmap); 162 bool pmap_vs_enabled(void); 163 uint64_t pmap_to_ttbr0(pmap_t pmap); 164 void pmap_disable_promotion(vm_offset_t sva, vm_size_t size); 165 void pmap_map_delete(pmap_t, vm_offset_t, vm_offset_t); 166 167 void *pmap_mapdev(vm_paddr_t, vm_size_t); 168 void *pmap_mapbios(vm_paddr_t, vm_size_t); 169 void pmap_unmapdev(void *, vm_size_t); 170 void pmap_unmapbios(void *, vm_size_t); 171 172 bool pmap_map_io_transient(vm_page_t *, void **, int, bool); 173 void pmap_unmap_io_transient(vm_page_t *, void **, int, bool); 174 175 bool pmap_get_tables(pmap_t, vm_offset_t, pd_entry_t **, pd_entry_t **, 176 pd_entry_t **, pt_entry_t **); 177 178 int pmap_fault(pmap_t, uint64_t, uint64_t); 179 180 struct pcb *pmap_switch(struct thread *); 181 182 void pmap_s1_invalidate_all_kernel(void); 183 184 extern void (*pmap_clean_stage2_tlbi)(void); 185 extern void (*pmap_stage2_invalidate_range)(uint64_t, vm_offset_t, vm_offset_t, 186 bool); 187 extern void (*pmap_stage2_invalidate_all)(uint64_t); 188 189 int pmap_vmspace_copy(pmap_t, pmap_t); 190 191 int pmap_bti_set(pmap_t, vm_offset_t, vm_offset_t); 192 int pmap_bti_clear(pmap_t, vm_offset_t, vm_offset_t); 193 194 #if defined(KASAN) || defined(KMSAN) 195 struct arm64_bootparams; 196 197 void pmap_bootstrap_san(void); 198 void pmap_san_enter(vm_offset_t); 199 #endif 200 201 #endif /* _KERNEL */ 202 203 #endif /* !LOCORE */ 204 205 #endif /* !_MACHINE_PMAP_H_ */ 206 207 #endif /* !__arm__ */ 208