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