1 /* 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2015 Mihai Carabas <mihai.carabas@gmail.com> 5 * Copyright (c) 2024 Ruslan Bukin <br@bsdpad.com> 6 * 7 * This software was developed by the University of Cambridge Computer 8 * Laboratory (Department of Computer Science and Technology) under Innovate 9 * UK project 105694, "Digital Security by Design (DSbD) Technology Platform 10 * Prototype". 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions and the following disclaimer. 17 * 2. Redistributions in binary form must reproduce the above copyright 18 * notice, this list of conditions and the following disclaimer in the 19 * documentation and/or other materials provided with the distribution. 20 * 21 * THIS SOFTWARE IS PROVIDED BY AUTHOR 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 AUTHOR 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 #ifndef _VMM_H_ 35 #define _VMM_H_ 36 37 #include <sys/param.h> 38 #include <sys/cpuset.h> 39 #include <vm/vm.h> 40 #include <vm/pmap.h> 41 42 #include "pte.h" 43 #include "pmap.h" 44 45 struct vcpu; 46 47 enum vm_suspend_how { 48 VM_SUSPEND_NONE, 49 VM_SUSPEND_RESET, 50 VM_SUSPEND_POWEROFF, 51 VM_SUSPEND_HALT, 52 VM_SUSPEND_DESTROY, 53 VM_SUSPEND_LAST 54 }; 55 56 /* 57 * Identifiers for architecturally defined registers. 58 */ 59 enum vm_reg_name { 60 VM_REG_GUEST_ZERO = 0, 61 VM_REG_GUEST_RA, 62 VM_REG_GUEST_SP, 63 VM_REG_GUEST_GP, 64 VM_REG_GUEST_TP, 65 VM_REG_GUEST_T0, 66 VM_REG_GUEST_T1, 67 VM_REG_GUEST_T2, 68 VM_REG_GUEST_S0, 69 VM_REG_GUEST_S1, 70 VM_REG_GUEST_A0, 71 VM_REG_GUEST_A1, 72 VM_REG_GUEST_A2, 73 VM_REG_GUEST_A3, 74 VM_REG_GUEST_A4, 75 VM_REG_GUEST_A5, 76 VM_REG_GUEST_A6, 77 VM_REG_GUEST_A7, 78 VM_REG_GUEST_S2, 79 VM_REG_GUEST_S3, 80 VM_REG_GUEST_S4, 81 VM_REG_GUEST_S5, 82 VM_REG_GUEST_S6, 83 VM_REG_GUEST_S7, 84 VM_REG_GUEST_S8, 85 VM_REG_GUEST_S9, 86 VM_REG_GUEST_S10, 87 VM_REG_GUEST_S11, 88 VM_REG_GUEST_T3, 89 VM_REG_GUEST_T4, 90 VM_REG_GUEST_T5, 91 VM_REG_GUEST_T6, 92 VM_REG_GUEST_SEPC, 93 VM_REG_LAST 94 }; 95 96 #define VM_INTINFO_VECTOR(info) ((info) & 0xff) 97 #define VM_INTINFO_DEL_ERRCODE 0x800 98 #define VM_INTINFO_RSVD 0x7ffff000 99 #define VM_INTINFO_VALID 0x80000000 100 #define VM_INTINFO_TYPE 0x700 101 #define VM_INTINFO_HWINTR (0 << 8) 102 #define VM_INTINFO_NMI (2 << 8) 103 #define VM_INTINFO_HWEXCEPTION (3 << 8) 104 #define VM_INTINFO_SWINTR (4 << 8) 105 106 #ifdef _KERNEL 107 #include <machine/vmm_instruction_emul.h> 108 109 #define VMM_VCPU_MD_FIELDS \ 110 struct vm_exit exitinfo; \ 111 uint64_t nextpc; /* (x) next instruction to execute */ \ 112 struct fpreg *guestfpu /* (a,i) guest fpu state */ 113 114 #define VMM_VM_MD_FIELDS \ 115 struct vmm_mmio_region mmio_region[VM_MAX_MMIO_REGIONS] 116 117 struct vm; 118 struct vm_eventinfo; 119 struct vm_exception; 120 struct vm_exit; 121 struct vm_run; 122 struct vm_object; 123 struct vm_guest_paging; 124 struct vm_aplic_descr; 125 struct pmap; 126 127 struct vmm_mmio_region { 128 uint64_t start; 129 uint64_t end; 130 mem_region_read_t read; 131 mem_region_write_t write; 132 }; 133 #define VM_MAX_MMIO_REGIONS 4 134 135 #define DECLARE_VMMOPS_FUNC(ret_type, opname, args) \ 136 ret_type vmmops_##opname args 137 138 DECLARE_VMMOPS_FUNC(int, modinit, (void)); 139 DECLARE_VMMOPS_FUNC(int, modcleanup, (void)); 140 DECLARE_VMMOPS_FUNC(void *, init, (struct vm *vm, struct pmap *pmap)); 141 DECLARE_VMMOPS_FUNC(int, gla2gpa, (void *vcpui, struct vm_guest_paging *paging, 142 uint64_t gla, int prot, uint64_t *gpa, int *is_fault)); 143 DECLARE_VMMOPS_FUNC(int, run, (void *vcpui, register_t pc, struct pmap *pmap, 144 struct vm_eventinfo *info)); 145 DECLARE_VMMOPS_FUNC(void, cleanup, (void *vmi)); 146 DECLARE_VMMOPS_FUNC(void *, vcpu_init, (void *vmi, struct vcpu *vcpu, 147 int vcpu_id)); 148 DECLARE_VMMOPS_FUNC(void, vcpu_cleanup, (void *vcpui)); 149 DECLARE_VMMOPS_FUNC(int, exception, (void *vcpui, uint64_t scause)); 150 DECLARE_VMMOPS_FUNC(int, getreg, (void *vcpui, int num, uint64_t *retval)); 151 DECLARE_VMMOPS_FUNC(int, setreg, (void *vcpui, int num, uint64_t val)); 152 DECLARE_VMMOPS_FUNC(int, getcap, (void *vcpui, int num, int *retval)); 153 DECLARE_VMMOPS_FUNC(int, setcap, (void *vcpui, int num, int val)); 154 DECLARE_VMMOPS_FUNC(struct vmspace *, vmspace_alloc, (vm_offset_t min, 155 vm_offset_t max)); 156 DECLARE_VMMOPS_FUNC(void, vmspace_free, (struct vmspace *vmspace)); 157 158 int vm_get_register(struct vcpu *vcpu, int reg, uint64_t *retval); 159 int vm_set_register(struct vcpu *vcpu, int reg, uint64_t val); 160 int vm_run(struct vcpu *vcpu); 161 void *vm_get_cookie(struct vm *vm); 162 void *vcpu_get_cookie(struct vcpu *vcpu); 163 int vm_get_capability(struct vcpu *vcpu, int type, int *val); 164 int vm_set_capability(struct vcpu *vcpu, int type, int val); 165 int vm_inject_exception(struct vcpu *vcpu, uint64_t scause); 166 int vm_attach_aplic(struct vm *vm, struct vm_aplic_descr *descr); 167 int vm_assert_irq(struct vm *vm, uint32_t irq); 168 int vm_deassert_irq(struct vm *vm, uint32_t irq); 169 int vm_raise_msi(struct vm *vm, uint64_t msg, uint64_t addr, int bus, int slot, 170 int func); 171 struct vm_exit *vm_exitinfo(struct vcpu *vcpu); 172 void vm_exit_suspended(struct vcpu *vcpu, uint64_t pc); 173 void vm_exit_debug(struct vcpu *vcpu, uint64_t pc); 174 void vm_exit_astpending(struct vcpu *vcpu, uint64_t pc); 175 #endif /* _KERNEL */ 176 177 #define VM_DIR_READ 0 178 #define VM_DIR_WRITE 1 179 180 #define VM_GP_M_MASK 0x1f 181 #define VM_GP_MMU_ENABLED (1 << 5) 182 183 struct vm_guest_paging { 184 int flags; 185 int padding; 186 }; 187 188 struct vie { 189 uint8_t access_size:4, sign_extend:1, dir:1, unused:2; 190 enum vm_reg_name reg; 191 }; 192 193 struct vre { 194 uint32_t inst_syndrome; 195 uint8_t dir:1, unused:7; 196 enum vm_reg_name reg; 197 }; 198 199 /* 200 * Identifiers for optional vmm capabilities 201 */ 202 enum vm_cap_type { 203 VM_CAP_UNRESTRICTED_GUEST, 204 VM_CAP_SSTC, 205 VM_CAP_MAX 206 }; 207 208 enum vm_exitcode { 209 VM_EXITCODE_BOGUS, 210 VM_EXITCODE_ECALL, 211 VM_EXITCODE_HYP, 212 VM_EXITCODE_PAGING, 213 VM_EXITCODE_SUSPENDED, 214 VM_EXITCODE_DEBUG, 215 VM_EXITCODE_INST_EMUL, 216 VM_EXITCODE_WFI, 217 VM_EXITCODE_MAX 218 }; 219 220 struct vm_exit { 221 uint64_t scause; 222 uint64_t sepc; 223 uint64_t stval; 224 uint64_t htval; 225 uint64_t htinst; 226 enum vm_exitcode exitcode; 227 int inst_length; 228 uint64_t pc; 229 union { 230 struct { 231 uint64_t gpa; 232 } paging; 233 234 struct { 235 uint64_t gpa; 236 struct vm_guest_paging paging; 237 struct vie vie; 238 } inst_emul; 239 240 struct { 241 uint64_t args[8]; 242 } ecall; 243 244 struct { 245 enum vm_suspend_how how; 246 } suspended; 247 248 struct { 249 uint64_t scause; 250 } hyp; 251 } u; 252 }; 253 254 #endif /* _VMM_H_ */ 255