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_LAST 53 }; 54 55 /* 56 * Identifiers for architecturally defined registers. 57 */ 58 enum vm_reg_name { 59 VM_REG_GUEST_ZERO = 0, 60 VM_REG_GUEST_RA, 61 VM_REG_GUEST_SP, 62 VM_REG_GUEST_GP, 63 VM_REG_GUEST_TP, 64 VM_REG_GUEST_T0, 65 VM_REG_GUEST_T1, 66 VM_REG_GUEST_T2, 67 VM_REG_GUEST_S0, 68 VM_REG_GUEST_S1, 69 VM_REG_GUEST_A0, 70 VM_REG_GUEST_A1, 71 VM_REG_GUEST_A2, 72 VM_REG_GUEST_A3, 73 VM_REG_GUEST_A4, 74 VM_REG_GUEST_A5, 75 VM_REG_GUEST_A6, 76 VM_REG_GUEST_A7, 77 VM_REG_GUEST_S2, 78 VM_REG_GUEST_S3, 79 VM_REG_GUEST_S4, 80 VM_REG_GUEST_S5, 81 VM_REG_GUEST_S6, 82 VM_REG_GUEST_S7, 83 VM_REG_GUEST_S8, 84 VM_REG_GUEST_S9, 85 VM_REG_GUEST_S10, 86 VM_REG_GUEST_S11, 87 VM_REG_GUEST_T3, 88 VM_REG_GUEST_T4, 89 VM_REG_GUEST_T5, 90 VM_REG_GUEST_T6, 91 VM_REG_GUEST_SEPC, 92 VM_REG_LAST 93 }; 94 95 #define VM_INTINFO_VECTOR(info) ((info) & 0xff) 96 #define VM_INTINFO_DEL_ERRCODE 0x800 97 #define VM_INTINFO_RSVD 0x7ffff000 98 #define VM_INTINFO_VALID 0x80000000 99 #define VM_INTINFO_TYPE 0x700 100 #define VM_INTINFO_HWINTR (0 << 8) 101 #define VM_INTINFO_NMI (2 << 8) 102 #define VM_INTINFO_HWEXCEPTION (3 << 8) 103 #define VM_INTINFO_SWINTR (4 << 8) 104 105 #define VM_MAX_NAMELEN 32 106 #define VM_MAX_SUFFIXLEN 15 107 108 #ifdef _KERNEL 109 110 struct vm; 111 struct vm_exception; 112 struct vm_exit; 113 struct vm_run; 114 struct vm_object; 115 struct vm_guest_paging; 116 struct vm_aplic_descr; 117 struct pmap; 118 119 struct vm_eventinfo { 120 void *rptr; /* rendezvous cookie */ 121 int *sptr; /* suspend cookie */ 122 int *iptr; /* reqidle cookie */ 123 }; 124 125 int vm_create(const char *name, struct vm **retvm); 126 struct vcpu *vm_alloc_vcpu(struct vm *vm, int vcpuid); 127 void vm_disable_vcpu_creation(struct vm *vm); 128 void vm_slock_vcpus(struct vm *vm); 129 void vm_unlock_vcpus(struct vm *vm); 130 void vm_destroy(struct vm *vm); 131 int vm_reinit(struct vm *vm); 132 const char *vm_name(struct vm *vm); 133 134 uint16_t vm_get_maxcpus(struct vm *vm); 135 void vm_get_topology(struct vm *vm, uint16_t *sockets, uint16_t *cores, 136 uint16_t *threads, uint16_t *maxcpus); 137 int vm_set_topology(struct vm *vm, uint16_t sockets, uint16_t cores, 138 uint16_t threads, uint16_t maxcpus); 139 int vm_get_register(struct vcpu *vcpu, int reg, uint64_t *retval); 140 int vm_set_register(struct vcpu *vcpu, int reg, uint64_t val); 141 int vm_run(struct vcpu *vcpu); 142 int vm_suspend(struct vm *vm, enum vm_suspend_how how); 143 void* vm_get_cookie(struct vm *vm); 144 int vcpu_vcpuid(struct vcpu *vcpu); 145 void *vcpu_get_cookie(struct vcpu *vcpu); 146 struct vm *vcpu_vm(struct vcpu *vcpu); 147 struct vcpu *vm_vcpu(struct vm *vm, int cpu); 148 int vm_get_capability(struct vcpu *vcpu, int type, int *val); 149 int vm_set_capability(struct vcpu *vcpu, int type, int val); 150 int vm_activate_cpu(struct vcpu *vcpu); 151 int vm_suspend_cpu(struct vm *vm, struct vcpu *vcpu); 152 int vm_resume_cpu(struct vm *vm, struct vcpu *vcpu); 153 int vm_inject_exception(struct vcpu *vcpu, uint64_t scause); 154 int vm_attach_aplic(struct vm *vm, struct vm_aplic_descr *descr); 155 int vm_assert_irq(struct vm *vm, uint32_t irq); 156 int vm_deassert_irq(struct vm *vm, uint32_t irq); 157 int vm_raise_msi(struct vm *vm, uint64_t msg, uint64_t addr, int bus, int slot, 158 int func); 159 struct vm_exit *vm_exitinfo(struct vcpu *vcpu); 160 void vm_exit_suspended(struct vcpu *vcpu, uint64_t pc); 161 void vm_exit_debug(struct vcpu *vcpu, uint64_t pc); 162 void vm_exit_rendezvous(struct vcpu *vcpu, uint64_t pc); 163 void vm_exit_astpending(struct vcpu *vcpu, uint64_t pc); 164 165 cpuset_t vm_active_cpus(struct vm *vm); 166 cpuset_t vm_debug_cpus(struct vm *vm); 167 cpuset_t vm_suspended_cpus(struct vm *vm); 168 169 static __inline int 170 vcpu_rendezvous_pending(struct vm_eventinfo *info) 171 { 172 173 return (*((uintptr_t *)(info->rptr)) != 0); 174 } 175 176 static __inline int 177 vcpu_suspended(struct vm_eventinfo *info) 178 { 179 180 return (*info->sptr); 181 } 182 183 int vcpu_debugged(struct vcpu *vcpu); 184 185 enum vcpu_state { 186 VCPU_IDLE, 187 VCPU_FROZEN, 188 VCPU_RUNNING, 189 VCPU_SLEEPING, 190 }; 191 192 int vcpu_set_state(struct vcpu *vcpu, enum vcpu_state state, bool from_idle); 193 enum vcpu_state vcpu_get_state(struct vcpu *vcpu, int *hostcpu); 194 195 static int __inline 196 vcpu_is_running(struct vcpu *vcpu, int *hostcpu) 197 { 198 return (vcpu_get_state(vcpu, hostcpu) == VCPU_RUNNING); 199 } 200 201 #ifdef _SYS_PROC_H_ 202 static int __inline 203 vcpu_should_yield(struct vcpu *vcpu) 204 { 205 struct thread *td; 206 207 td = curthread; 208 return (td->td_ast != 0 || td->td_owepreempt != 0); 209 } 210 #endif 211 212 void *vcpu_stats(struct vcpu *vcpu); 213 void vcpu_notify_event(struct vcpu *vcpu); 214 struct vmspace *vm_vmspace(struct vm *vm); 215 struct vm_mem *vm_mem(struct vm *vm); 216 217 enum vm_reg_name vm_segment_name(int seg_encoding); 218 219 #endif /* _KERNEL */ 220 221 #define VM_DIR_READ 0 222 #define VM_DIR_WRITE 1 223 224 #define VM_GP_M_MASK 0x1f 225 #define VM_GP_MMU_ENABLED (1 << 5) 226 227 struct vm_guest_paging { 228 int flags; 229 int padding; 230 }; 231 232 struct vie { 233 uint8_t access_size:4, sign_extend:1, dir:1, unused:2; 234 enum vm_reg_name reg; 235 }; 236 237 struct vre { 238 uint32_t inst_syndrome; 239 uint8_t dir:1, unused:7; 240 enum vm_reg_name reg; 241 }; 242 243 /* 244 * Identifiers for optional vmm capabilities 245 */ 246 enum vm_cap_type { 247 VM_CAP_UNRESTRICTED_GUEST, 248 VM_CAP_SSTC, 249 VM_CAP_MAX 250 }; 251 252 enum vm_exitcode { 253 VM_EXITCODE_BOGUS, 254 VM_EXITCODE_ECALL, 255 VM_EXITCODE_HYP, 256 VM_EXITCODE_PAGING, 257 VM_EXITCODE_SUSPENDED, 258 VM_EXITCODE_DEBUG, 259 VM_EXITCODE_INST_EMUL, 260 VM_EXITCODE_WFI, 261 VM_EXITCODE_MAX 262 }; 263 264 struct vm_exit { 265 uint64_t scause; 266 uint64_t sepc; 267 uint64_t stval; 268 uint64_t htval; 269 uint64_t htinst; 270 enum vm_exitcode exitcode; 271 int inst_length; 272 uint64_t pc; 273 union { 274 struct { 275 uint64_t gpa; 276 } paging; 277 278 struct { 279 uint64_t gpa; 280 struct vm_guest_paging paging; 281 struct vie vie; 282 } inst_emul; 283 284 struct { 285 uint64_t args[8]; 286 } ecall; 287 288 struct { 289 enum vm_suspend_how how; 290 } suspended; 291 292 struct { 293 uint64_t scause; 294 } hyp; 295 } u; 296 }; 297 298 #endif /* _VMM_H_ */ 299