1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2011 NetApp, Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #ifndef _VMM_H_ 30 #define _VMM_H_ 31 32 #include <sys/cpuset.h> 33 #include <sys/sdt.h> 34 #include <x86/segments.h> 35 36 struct vcpu; 37 struct vm_snapshot_meta; 38 39 #ifdef _KERNEL 40 SDT_PROVIDER_DECLARE(vmm); 41 #endif 42 43 enum vm_suspend_how { 44 VM_SUSPEND_NONE, 45 VM_SUSPEND_RESET, 46 VM_SUSPEND_POWEROFF, 47 VM_SUSPEND_HALT, 48 VM_SUSPEND_TRIPLEFAULT, 49 VM_SUSPEND_LAST 50 }; 51 52 /* 53 * Identifiers for architecturally defined registers. 54 */ 55 enum vm_reg_name { 56 VM_REG_GUEST_RAX, 57 VM_REG_GUEST_RBX, 58 VM_REG_GUEST_RCX, 59 VM_REG_GUEST_RDX, 60 VM_REG_GUEST_RSI, 61 VM_REG_GUEST_RDI, 62 VM_REG_GUEST_RBP, 63 VM_REG_GUEST_R8, 64 VM_REG_GUEST_R9, 65 VM_REG_GUEST_R10, 66 VM_REG_GUEST_R11, 67 VM_REG_GUEST_R12, 68 VM_REG_GUEST_R13, 69 VM_REG_GUEST_R14, 70 VM_REG_GUEST_R15, 71 VM_REG_GUEST_CR0, 72 VM_REG_GUEST_CR3, 73 VM_REG_GUEST_CR4, 74 VM_REG_GUEST_DR7, 75 VM_REG_GUEST_RSP, 76 VM_REG_GUEST_RIP, 77 VM_REG_GUEST_RFLAGS, 78 VM_REG_GUEST_ES, 79 VM_REG_GUEST_CS, 80 VM_REG_GUEST_SS, 81 VM_REG_GUEST_DS, 82 VM_REG_GUEST_FS, 83 VM_REG_GUEST_GS, 84 VM_REG_GUEST_LDTR, 85 VM_REG_GUEST_TR, 86 VM_REG_GUEST_IDTR, 87 VM_REG_GUEST_GDTR, 88 VM_REG_GUEST_EFER, 89 VM_REG_GUEST_CR2, 90 VM_REG_GUEST_PDPTE0, 91 VM_REG_GUEST_PDPTE1, 92 VM_REG_GUEST_PDPTE2, 93 VM_REG_GUEST_PDPTE3, 94 VM_REG_GUEST_INTR_SHADOW, 95 VM_REG_GUEST_DR0, 96 VM_REG_GUEST_DR1, 97 VM_REG_GUEST_DR2, 98 VM_REG_GUEST_DR3, 99 VM_REG_GUEST_DR6, 100 VM_REG_GUEST_ENTRY_INST_LENGTH, 101 VM_REG_LAST 102 }; 103 104 enum x2apic_state { 105 X2APIC_DISABLED, 106 X2APIC_ENABLED, 107 X2APIC_STATE_LAST 108 }; 109 110 #define VM_INTINFO_VECTOR(info) ((info) & 0xff) 111 #define VM_INTINFO_DEL_ERRCODE 0x800 112 #define VM_INTINFO_RSVD 0x7ffff000 113 #define VM_INTINFO_VALID 0x80000000 114 #define VM_INTINFO_TYPE 0x700 115 #define VM_INTINFO_HWINTR (0 << 8) 116 #define VM_INTINFO_NMI (2 << 8) 117 #define VM_INTINFO_HWEXCEPTION (3 << 8) 118 #define VM_INTINFO_SWINTR (4 << 8) 119 120 /* 121 * The VM name has to fit into the pathname length constraints of devfs, 122 * governed primarily by SPECNAMELEN. The length is the total number of 123 * characters in the full path, relative to the mount point and not 124 * including any leading '/' characters. 125 * A prefix and a suffix are added to the name specified by the user. 126 * The prefix is usually "vmm/" or "vmm.io/", but can be a few characters 127 * longer for future use. 128 * The suffix is a string that identifies a bootrom image or some similar 129 * image that is attached to the VM. A separator character gets added to 130 * the suffix automatically when generating the full path, so it must be 131 * accounted for, reducing the effective length by 1. 132 * The effective length of a VM name is 229 bytes for FreeBSD 13 and 37 133 * bytes for FreeBSD 12. A minimum length is set for safety and supports 134 * a SPECNAMELEN as small as 32 on old systems. 135 */ 136 #define VM_MAX_PREFIXLEN 10 137 #define VM_MAX_SUFFIXLEN 15 138 #define VM_MIN_NAMELEN 6 139 #define VM_MAX_NAMELEN \ 140 (SPECNAMELEN - VM_MAX_PREFIXLEN - VM_MAX_SUFFIXLEN - 1) 141 142 #ifdef _KERNEL 143 CTASSERT(VM_MAX_NAMELEN >= VM_MIN_NAMELEN); 144 145 struct vm; 146 struct vm_exception; 147 struct seg_desc; 148 struct vm_exit; 149 struct vm_run; 150 struct vhpet; 151 struct vioapic; 152 struct vlapic; 153 struct vmspace; 154 struct vm_object; 155 struct vm_guest_paging; 156 struct pmap; 157 enum snapshot_req; 158 159 struct vm_eventinfo { 160 cpuset_t *rptr; /* rendezvous cookie */ 161 int *sptr; /* suspend cookie */ 162 int *iptr; /* reqidle cookie */ 163 }; 164 165 typedef int (*vmm_init_func_t)(int ipinum); 166 typedef int (*vmm_cleanup_func_t)(void); 167 typedef void (*vmm_resume_func_t)(void); 168 typedef void * (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap); 169 typedef int (*vmi_run_func_t)(void *vcpui, register_t rip, 170 struct pmap *pmap, struct vm_eventinfo *info); 171 typedef void (*vmi_cleanup_func_t)(void *vmi); 172 typedef void * (*vmi_vcpu_init_func_t)(void *vmi, struct vcpu *vcpu, 173 int vcpu_id); 174 typedef void (*vmi_vcpu_cleanup_func_t)(void *vcpui); 175 typedef int (*vmi_get_register_t)(void *vcpui, int num, uint64_t *retval); 176 typedef int (*vmi_set_register_t)(void *vcpui, int num, uint64_t val); 177 typedef int (*vmi_get_desc_t)(void *vcpui, int num, struct seg_desc *desc); 178 typedef int (*vmi_set_desc_t)(void *vcpui, int num, struct seg_desc *desc); 179 typedef int (*vmi_get_cap_t)(void *vcpui, int num, int *retval); 180 typedef int (*vmi_set_cap_t)(void *vcpui, int num, int val); 181 typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max); 182 typedef void (*vmi_vmspace_free)(struct vmspace *vmspace); 183 typedef struct vlapic * (*vmi_vlapic_init)(void *vcpui); 184 typedef void (*vmi_vlapic_cleanup)(struct vlapic *vlapic); 185 typedef int (*vmi_snapshot_vcpu_t)(void *vcpui, struct vm_snapshot_meta *meta); 186 typedef int (*vmi_restore_tsc_t)(void *vcpui, uint64_t now); 187 188 struct vmm_ops { 189 vmm_init_func_t modinit; /* module wide initialization */ 190 vmm_cleanup_func_t modcleanup; 191 vmm_resume_func_t modresume; 192 193 vmi_init_func_t init; /* vm-specific initialization */ 194 vmi_run_func_t run; 195 vmi_cleanup_func_t cleanup; 196 vmi_vcpu_init_func_t vcpu_init; 197 vmi_vcpu_cleanup_func_t vcpu_cleanup; 198 vmi_get_register_t getreg; 199 vmi_set_register_t setreg; 200 vmi_get_desc_t getdesc; 201 vmi_set_desc_t setdesc; 202 vmi_get_cap_t getcap; 203 vmi_set_cap_t setcap; 204 vmi_vmspace_alloc vmspace_alloc; 205 vmi_vmspace_free vmspace_free; 206 vmi_vlapic_init vlapic_init; 207 vmi_vlapic_cleanup vlapic_cleanup; 208 209 /* checkpoint operations */ 210 vmi_snapshot_vcpu_t vcpu_snapshot; 211 vmi_restore_tsc_t restore_tsc; 212 }; 213 214 extern const struct vmm_ops vmm_ops_intel; 215 extern const struct vmm_ops vmm_ops_amd; 216 217 extern u_int vm_maxcpu; /* maximum virtual cpus */ 218 219 int vm_create(const char *name, struct vm **retvm); 220 struct vcpu *vm_alloc_vcpu(struct vm *vm, int vcpuid); 221 void vm_disable_vcpu_creation(struct vm *vm); 222 void vm_slock_vcpus(struct vm *vm); 223 void vm_unlock_vcpus(struct vm *vm); 224 void vm_destroy(struct vm *vm); 225 int vm_reinit(struct vm *vm); 226 const char *vm_name(struct vm *vm); 227 uint16_t vm_get_maxcpus(struct vm *vm); 228 void vm_get_topology(struct vm *vm, uint16_t *sockets, uint16_t *cores, 229 uint16_t *threads, uint16_t *maxcpus); 230 int vm_set_topology(struct vm *vm, uint16_t sockets, uint16_t cores, 231 uint16_t threads, uint16_t maxcpus); 232 233 /* 234 * APIs that modify the guest memory map require all vcpus to be frozen. 235 */ 236 void vm_slock_memsegs(struct vm *vm); 237 void vm_xlock_memsegs(struct vm *vm); 238 void vm_unlock_memsegs(struct vm *vm); 239 int vm_mmap_memseg(struct vm *vm, vm_paddr_t gpa, int segid, vm_ooffset_t off, 240 size_t len, int prot, int flags); 241 int vm_munmap_memseg(struct vm *vm, vm_paddr_t gpa, size_t len); 242 int vm_alloc_memseg(struct vm *vm, int ident, size_t len, bool sysmem); 243 void vm_free_memseg(struct vm *vm, int ident); 244 int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 245 int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 246 int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func); 247 int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func); 248 249 /* 250 * APIs that inspect the guest memory map require only a *single* vcpu to 251 * be frozen. This acts like a read lock on the guest memory map since any 252 * modification requires *all* vcpus to be frozen. 253 */ 254 int vm_mmap_getnext(struct vm *vm, vm_paddr_t *gpa, int *segid, 255 vm_ooffset_t *segoff, size_t *len, int *prot, int *flags); 256 int vm_get_memseg(struct vm *vm, int ident, size_t *len, bool *sysmem, 257 struct vm_object **objptr); 258 vm_paddr_t vmm_sysmem_maxaddr(struct vm *vm); 259 void *vm_gpa_hold(struct vcpu *vcpu, vm_paddr_t gpa, size_t len, 260 int prot, void **cookie); 261 void *vm_gpa_hold_global(struct vm *vm, vm_paddr_t gpa, size_t len, 262 int prot, void **cookie); 263 void *vm_gpa_hold_global(struct vm *vm, vm_paddr_t gpa, size_t len, 264 int prot, void **cookie); 265 void vm_gpa_release(void *cookie); 266 bool vm_mem_allocated(struct vcpu *vcpu, vm_paddr_t gpa); 267 268 int vm_get_register(struct vcpu *vcpu, int reg, uint64_t *retval); 269 int vm_set_register(struct vcpu *vcpu, int reg, uint64_t val); 270 int vm_get_seg_desc(struct vcpu *vcpu, int reg, 271 struct seg_desc *ret_desc); 272 int vm_set_seg_desc(struct vcpu *vcpu, int reg, 273 struct seg_desc *desc); 274 int vm_run(struct vcpu *vcpu); 275 int vm_suspend(struct vm *vm, enum vm_suspend_how how); 276 int vm_inject_nmi(struct vcpu *vcpu); 277 int vm_nmi_pending(struct vcpu *vcpu); 278 void vm_nmi_clear(struct vcpu *vcpu); 279 int vm_inject_extint(struct vcpu *vcpu); 280 int vm_extint_pending(struct vcpu *vcpu); 281 void vm_extint_clear(struct vcpu *vcpu); 282 int vcpu_vcpuid(struct vcpu *vcpu); 283 struct vm *vcpu_vm(struct vcpu *vcpu); 284 struct vcpu *vm_vcpu(struct vm *vm, int cpu); 285 struct vlapic *vm_lapic(struct vcpu *vcpu); 286 struct vioapic *vm_ioapic(struct vm *vm); 287 struct vhpet *vm_hpet(struct vm *vm); 288 int vm_get_capability(struct vcpu *vcpu, int type, int *val); 289 int vm_set_capability(struct vcpu *vcpu, int type, int val); 290 int vm_get_x2apic_state(struct vcpu *vcpu, enum x2apic_state *state); 291 int vm_set_x2apic_state(struct vcpu *vcpu, enum x2apic_state state); 292 int vm_apicid2vcpuid(struct vm *vm, int apicid); 293 int vm_activate_cpu(struct vcpu *vcpu); 294 int vm_suspend_cpu(struct vm *vm, struct vcpu *vcpu); 295 int vm_resume_cpu(struct vm *vm, struct vcpu *vcpu); 296 int vm_restart_instruction(struct vcpu *vcpu); 297 struct vm_exit *vm_exitinfo(struct vcpu *vcpu); 298 cpuset_t *vm_exitinfo_cpuset(struct vcpu *vcpu); 299 void vm_exit_suspended(struct vcpu *vcpu, uint64_t rip); 300 void vm_exit_debug(struct vcpu *vcpu, uint64_t rip); 301 void vm_exit_rendezvous(struct vcpu *vcpu, uint64_t rip); 302 void vm_exit_astpending(struct vcpu *vcpu, uint64_t rip); 303 void vm_exit_reqidle(struct vcpu *vcpu, uint64_t rip); 304 int vm_snapshot_req(struct vm *vm, struct vm_snapshot_meta *meta); 305 int vm_restore_time(struct vm *vm); 306 307 #ifdef _SYS__CPUSET_H_ 308 /* 309 * Rendezvous all vcpus specified in 'dest' and execute 'func(arg)'. 310 * The rendezvous 'func(arg)' is not allowed to do anything that will 311 * cause the thread to be put to sleep. 312 * 313 * The caller cannot hold any locks when initiating the rendezvous. 314 * 315 * The implementation of this API may cause vcpus other than those specified 316 * by 'dest' to be stalled. The caller should not rely on any vcpus making 317 * forward progress when the rendezvous is in progress. 318 */ 319 typedef void (*vm_rendezvous_func_t)(struct vcpu *vcpu, void *arg); 320 int vm_smp_rendezvous(struct vcpu *vcpu, cpuset_t dest, 321 vm_rendezvous_func_t func, void *arg); 322 323 cpuset_t vm_active_cpus(struct vm *vm); 324 cpuset_t vm_debug_cpus(struct vm *vm); 325 cpuset_t vm_suspended_cpus(struct vm *vm); 326 cpuset_t vm_start_cpus(struct vm *vm, const cpuset_t *tostart); 327 void vm_await_start(struct vm *vm, const cpuset_t *waiting); 328 #endif /* _SYS__CPUSET_H_ */ 329 330 static __inline int 331 vcpu_rendezvous_pending(struct vcpu *vcpu, struct vm_eventinfo *info) 332 { 333 /* 334 * This check isn't done with atomic operations or under a lock because 335 * there's no need to. If the vcpuid bit is set, the vcpu is part of a 336 * rendezvous and the bit won't be cleared until the vcpu enters the 337 * rendezvous. On rendezvous exit, the cpuset is cleared and the vcpu 338 * will see an empty cpuset. So, the races are harmless. 339 */ 340 return (CPU_ISSET(vcpu_vcpuid(vcpu), info->rptr)); 341 } 342 343 static __inline int 344 vcpu_suspended(struct vm_eventinfo *info) 345 { 346 347 return (*info->sptr); 348 } 349 350 static __inline int 351 vcpu_reqidle(struct vm_eventinfo *info) 352 { 353 354 return (*info->iptr); 355 } 356 357 int vcpu_debugged(struct vcpu *vcpu); 358 359 /* 360 * Return true if device indicated by bus/slot/func is supposed to be a 361 * pci passthrough device. 362 * 363 * Return false otherwise. 364 */ 365 bool vmm_is_pptdev(int bus, int slot, int func); 366 367 void *vm_iommu_domain(struct vm *vm); 368 369 enum vcpu_state { 370 VCPU_IDLE, 371 VCPU_FROZEN, 372 VCPU_RUNNING, 373 VCPU_SLEEPING, 374 }; 375 376 int vcpu_set_state(struct vcpu *vcpu, enum vcpu_state state, bool from_idle); 377 enum vcpu_state vcpu_get_state(struct vcpu *vcpu, int *hostcpu); 378 379 static int __inline 380 vcpu_is_running(struct vcpu *vcpu, int *hostcpu) 381 { 382 return (vcpu_get_state(vcpu, hostcpu) == VCPU_RUNNING); 383 } 384 385 #ifdef _SYS_PROC_H_ 386 static int __inline 387 vcpu_should_yield(struct vcpu *vcpu) 388 { 389 struct thread *td; 390 391 td = curthread; 392 return (td->td_ast != 0 || td->td_owepreempt != 0); 393 } 394 #endif 395 396 void *vcpu_stats(struct vcpu *vcpu); 397 void vcpu_notify_event(struct vcpu *vcpu, bool lapic_intr); 398 struct vmspace *vm_get_vmspace(struct vm *vm); 399 struct vatpic *vm_atpic(struct vm *vm); 400 struct vatpit *vm_atpit(struct vm *vm); 401 struct vpmtmr *vm_pmtmr(struct vm *vm); 402 struct vrtc *vm_rtc(struct vm *vm); 403 404 /* 405 * Inject exception 'vector' into the guest vcpu. This function returns 0 on 406 * success and non-zero on failure. 407 * 408 * Wrapper functions like 'vm_inject_gp()' should be preferred to calling 409 * this function directly because they enforce the trap-like or fault-like 410 * behavior of an exception. 411 * 412 * This function should only be called in the context of the thread that is 413 * executing this vcpu. 414 */ 415 int vm_inject_exception(struct vcpu *vcpu, int vector, int err_valid, 416 uint32_t errcode, int restart_instruction); 417 418 /* 419 * This function is called after a VM-exit that occurred during exception or 420 * interrupt delivery through the IDT. The format of 'intinfo' is described 421 * in Figure 15-1, "EXITINTINFO for All Intercepts", APM, Vol 2. 422 * 423 * If a VM-exit handler completes the event delivery successfully then it 424 * should call vm_exit_intinfo() to extinguish the pending event. For e.g., 425 * if the task switch emulation is triggered via a task gate then it should 426 * call this function with 'intinfo=0' to indicate that the external event 427 * is not pending anymore. 428 * 429 * Return value is 0 on success and non-zero on failure. 430 */ 431 int vm_exit_intinfo(struct vcpu *vcpu, uint64_t intinfo); 432 433 /* 434 * This function is called before every VM-entry to retrieve a pending 435 * event that should be injected into the guest. This function combines 436 * nested events into a double or triple fault. 437 * 438 * Returns 0 if there are no events that need to be injected into the guest 439 * and non-zero otherwise. 440 */ 441 int vm_entry_intinfo(struct vcpu *vcpu, uint64_t *info); 442 443 int vm_get_intinfo(struct vcpu *vcpu, uint64_t *info1, uint64_t *info2); 444 445 /* 446 * Function used to keep track of the guest's TSC offset. The 447 * offset is used by the virutalization extensions to provide a consistent 448 * value for the Time Stamp Counter to the guest. 449 */ 450 void vm_set_tsc_offset(struct vcpu *vcpu, uint64_t offset); 451 452 enum vm_reg_name vm_segment_name(int seg_encoding); 453 454 struct vm_copyinfo { 455 uint64_t gpa; 456 size_t len; 457 void *hva; 458 void *cookie; 459 }; 460 461 /* 462 * Set up 'copyinfo[]' to copy to/from guest linear address space starting 463 * at 'gla' and 'len' bytes long. The 'prot' should be set to PROT_READ for 464 * a copyin or PROT_WRITE for a copyout. 465 * 466 * retval is_fault Interpretation 467 * 0 0 Success 468 * 0 1 An exception was injected into the guest 469 * EFAULT N/A Unrecoverable error 470 * 471 * The 'copyinfo[]' can be passed to 'vm_copyin()' or 'vm_copyout()' only if 472 * the return value is 0. The 'copyinfo[]' resources should be freed by calling 473 * 'vm_copy_teardown()' after the copy is done. 474 */ 475 int vm_copy_setup(struct vcpu *vcpu, struct vm_guest_paging *paging, 476 uint64_t gla, size_t len, int prot, struct vm_copyinfo *copyinfo, 477 int num_copyinfo, int *is_fault); 478 void vm_copy_teardown(struct vm_copyinfo *copyinfo, int num_copyinfo); 479 void vm_copyin(struct vm_copyinfo *copyinfo, void *kaddr, size_t len); 480 void vm_copyout(const void *kaddr, struct vm_copyinfo *copyinfo, size_t len); 481 482 int vcpu_trace_exceptions(struct vcpu *vcpu); 483 int vcpu_trap_wbinvd(struct vcpu *vcpu); 484 #endif /* KERNEL */ 485 486 /* 487 * Identifiers for optional vmm capabilities 488 */ 489 enum vm_cap_type { 490 VM_CAP_HALT_EXIT, 491 VM_CAP_MTRAP_EXIT, 492 VM_CAP_PAUSE_EXIT, 493 VM_CAP_UNRESTRICTED_GUEST, 494 VM_CAP_ENABLE_INVPCID, 495 VM_CAP_BPT_EXIT, 496 VM_CAP_RDPID, 497 VM_CAP_RDTSCP, 498 VM_CAP_IPI_EXIT, 499 VM_CAP_MASK_HWINTR, 500 VM_CAP_RFLAGS_TF, 501 VM_CAP_MAX 502 }; 503 504 enum vm_intr_trigger { 505 EDGE_TRIGGER, 506 LEVEL_TRIGGER 507 }; 508 509 /* 510 * The 'access' field has the format specified in Table 21-2 of the Intel 511 * Architecture Manual vol 3b. 512 * 513 * XXX The contents of the 'access' field are architecturally defined except 514 * bit 16 - Segment Unusable. 515 */ 516 struct seg_desc { 517 uint64_t base; 518 uint32_t limit; 519 uint32_t access; 520 }; 521 #define SEG_DESC_TYPE(access) ((access) & 0x001f) 522 #define SEG_DESC_DPL(access) (((access) >> 5) & 0x3) 523 #define SEG_DESC_PRESENT(access) (((access) & 0x0080) ? 1 : 0) 524 #define SEG_DESC_DEF32(access) (((access) & 0x4000) ? 1 : 0) 525 #define SEG_DESC_GRANULARITY(access) (((access) & 0x8000) ? 1 : 0) 526 #define SEG_DESC_UNUSABLE(access) (((access) & 0x10000) ? 1 : 0) 527 528 enum vm_cpu_mode { 529 CPU_MODE_REAL, 530 CPU_MODE_PROTECTED, 531 CPU_MODE_COMPATIBILITY, /* IA-32E mode (CS.L = 0) */ 532 CPU_MODE_64BIT, /* IA-32E mode (CS.L = 1) */ 533 }; 534 535 enum vm_paging_mode { 536 PAGING_MODE_FLAT, 537 PAGING_MODE_32, 538 PAGING_MODE_PAE, 539 PAGING_MODE_64, 540 PAGING_MODE_64_LA57, 541 }; 542 543 struct vm_guest_paging { 544 uint64_t cr3; 545 int cpl; 546 enum vm_cpu_mode cpu_mode; 547 enum vm_paging_mode paging_mode; 548 }; 549 550 /* 551 * The data structures 'vie' and 'vie_op' are meant to be opaque to the 552 * consumers of instruction decoding. The only reason why their contents 553 * need to be exposed is because they are part of the 'vm_exit' structure. 554 */ 555 struct vie_op { 556 uint8_t op_byte; /* actual opcode byte */ 557 uint8_t op_type; /* type of operation (e.g. MOV) */ 558 uint16_t op_flags; 559 }; 560 _Static_assert(sizeof(struct vie_op) == 4, "ABI"); 561 _Static_assert(_Alignof(struct vie_op) == 2, "ABI"); 562 563 #define VIE_INST_SIZE 15 564 struct vie { 565 uint8_t inst[VIE_INST_SIZE]; /* instruction bytes */ 566 uint8_t num_valid; /* size of the instruction */ 567 568 /* The following fields are all zeroed upon restart. */ 569 #define vie_startzero num_processed 570 uint8_t num_processed; 571 572 uint8_t addrsize:4, opsize:4; /* address and operand sizes */ 573 uint8_t rex_w:1, /* REX prefix */ 574 rex_r:1, 575 rex_x:1, 576 rex_b:1, 577 rex_present:1, 578 repz_present:1, /* REP/REPE/REPZ prefix */ 579 repnz_present:1, /* REPNE/REPNZ prefix */ 580 opsize_override:1, /* Operand size override */ 581 addrsize_override:1, /* Address size override */ 582 segment_override:1; /* Segment override */ 583 584 uint8_t mod:2, /* ModRM byte */ 585 reg:4, 586 rm:4; 587 588 uint8_t ss:2, /* SIB byte */ 589 vex_present:1, /* VEX prefixed */ 590 vex_l:1, /* L bit */ 591 index:4, /* SIB byte */ 592 base:4; /* SIB byte */ 593 594 uint8_t disp_bytes; 595 uint8_t imm_bytes; 596 597 uint8_t scale; 598 599 uint8_t vex_reg:4, /* vvvv: first source register specifier */ 600 vex_pp:2, /* pp */ 601 _sparebits:2; 602 603 uint8_t _sparebytes[2]; 604 605 int base_register; /* VM_REG_GUEST_xyz */ 606 int index_register; /* VM_REG_GUEST_xyz */ 607 int segment_register; /* VM_REG_GUEST_xyz */ 608 609 int64_t displacement; /* optional addr displacement */ 610 int64_t immediate; /* optional immediate operand */ 611 612 uint8_t decoded; /* set to 1 if successfully decoded */ 613 614 uint8_t _sparebyte; 615 616 struct vie_op op; /* opcode description */ 617 }; 618 _Static_assert(sizeof(struct vie) == 64, "ABI"); 619 _Static_assert(__offsetof(struct vie, disp_bytes) == 22, "ABI"); 620 _Static_assert(__offsetof(struct vie, scale) == 24, "ABI"); 621 _Static_assert(__offsetof(struct vie, base_register) == 28, "ABI"); 622 623 enum vm_exitcode { 624 VM_EXITCODE_INOUT, 625 VM_EXITCODE_VMX, 626 VM_EXITCODE_BOGUS, 627 VM_EXITCODE_RDMSR, 628 VM_EXITCODE_WRMSR, 629 VM_EXITCODE_HLT, 630 VM_EXITCODE_MTRAP, 631 VM_EXITCODE_PAUSE, 632 VM_EXITCODE_PAGING, 633 VM_EXITCODE_INST_EMUL, 634 VM_EXITCODE_SPINUP_AP, 635 VM_EXITCODE_DEPRECATED1, /* used to be SPINDOWN_CPU */ 636 VM_EXITCODE_RENDEZVOUS, 637 VM_EXITCODE_IOAPIC_EOI, 638 VM_EXITCODE_SUSPENDED, 639 VM_EXITCODE_INOUT_STR, 640 VM_EXITCODE_TASK_SWITCH, 641 VM_EXITCODE_MONITOR, 642 VM_EXITCODE_MWAIT, 643 VM_EXITCODE_SVM, 644 VM_EXITCODE_REQIDLE, 645 VM_EXITCODE_DEBUG, 646 VM_EXITCODE_VMINSN, 647 VM_EXITCODE_BPT, 648 VM_EXITCODE_IPI, 649 VM_EXITCODE_DB, 650 VM_EXITCODE_MAX 651 }; 652 653 struct vm_inout { 654 uint16_t bytes:3; /* 1 or 2 or 4 */ 655 uint16_t in:1; 656 uint16_t string:1; 657 uint16_t rep:1; 658 uint16_t port; 659 uint32_t eax; /* valid for out */ 660 }; 661 662 struct vm_inout_str { 663 struct vm_inout inout; /* must be the first element */ 664 struct vm_guest_paging paging; 665 uint64_t rflags; 666 uint64_t cr0; 667 uint64_t index; 668 uint64_t count; /* rep=1 (%rcx), rep=0 (1) */ 669 int addrsize; 670 enum vm_reg_name seg_name; 671 struct seg_desc seg_desc; 672 }; 673 674 enum task_switch_reason { 675 TSR_CALL, 676 TSR_IRET, 677 TSR_JMP, 678 TSR_IDT_GATE, /* task gate in IDT */ 679 }; 680 681 struct vm_task_switch { 682 uint16_t tsssel; /* new TSS selector */ 683 int ext; /* task switch due to external event */ 684 uint32_t errcode; 685 int errcode_valid; /* push 'errcode' on the new stack */ 686 enum task_switch_reason reason; 687 struct vm_guest_paging paging; 688 }; 689 690 struct vm_exit { 691 enum vm_exitcode exitcode; 692 int inst_length; /* 0 means unknown */ 693 uint64_t rip; 694 union { 695 struct vm_inout inout; 696 struct vm_inout_str inout_str; 697 struct { 698 uint64_t gpa; 699 int fault_type; 700 } paging; 701 struct { 702 uint64_t gpa; 703 uint64_t gla; 704 uint64_t cs_base; 705 int cs_d; /* CS.D */ 706 struct vm_guest_paging paging; 707 struct vie vie; 708 } inst_emul; 709 /* 710 * VMX specific payload. Used when there is no "better" 711 * exitcode to represent the VM-exit. 712 */ 713 struct { 714 int status; /* vmx inst status */ 715 /* 716 * 'exit_reason' and 'exit_qualification' are valid 717 * only if 'status' is zero. 718 */ 719 uint32_t exit_reason; 720 uint64_t exit_qualification; 721 /* 722 * 'inst_error' and 'inst_type' are valid 723 * only if 'status' is non-zero. 724 */ 725 int inst_type; 726 int inst_error; 727 } vmx; 728 /* 729 * SVM specific payload. 730 */ 731 struct { 732 uint64_t exitcode; 733 uint64_t exitinfo1; 734 uint64_t exitinfo2; 735 } svm; 736 struct { 737 int inst_length; 738 } bpt; 739 struct { 740 int trace_trap; 741 int pushf_intercept; 742 int tf_shadow_val; 743 struct vm_guest_paging paging; 744 } dbg; 745 struct { 746 uint32_t code; /* ecx value */ 747 uint64_t wval; 748 } msr; 749 struct { 750 int vcpu; 751 uint64_t rip; 752 } spinup_ap; 753 struct { 754 uint64_t rflags; 755 uint64_t intr_status; 756 } hlt; 757 struct { 758 int vector; 759 } ioapic_eoi; 760 struct { 761 enum vm_suspend_how how; 762 } suspended; 763 struct { 764 /* 765 * The destination vCPU mask is saved in vcpu->cpuset 766 * and is copied out to userspace separately to avoid 767 * ABI concerns. 768 */ 769 uint32_t mode; 770 uint8_t vector; 771 } ipi; 772 struct vm_task_switch task_switch; 773 } u; 774 }; 775 776 /* APIs to inject faults into the guest */ 777 void vm_inject_fault(struct vcpu *vcpu, int vector, int errcode_valid, 778 int errcode); 779 780 static __inline void 781 vm_inject_ud(struct vcpu *vcpu) 782 { 783 vm_inject_fault(vcpu, IDT_UD, 0, 0); 784 } 785 786 static __inline void 787 vm_inject_gp(struct vcpu *vcpu) 788 { 789 vm_inject_fault(vcpu, IDT_GP, 1, 0); 790 } 791 792 static __inline void 793 vm_inject_ac(struct vcpu *vcpu, int errcode) 794 { 795 vm_inject_fault(vcpu, IDT_AC, 1, errcode); 796 } 797 798 static __inline void 799 vm_inject_ss(struct vcpu *vcpu, int errcode) 800 { 801 vm_inject_fault(vcpu, IDT_SS, 1, errcode); 802 } 803 804 void vm_inject_pf(struct vcpu *vcpu, int error_code, uint64_t cr2); 805 806 #endif /* _VMM_H_ */ 807