1366f6083SPeter Grehan /*- 2c49761ddSPedro F. Giffuni * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3c49761ddSPedro F. Giffuni * 4366f6083SPeter Grehan * Copyright (c) 2011 NetApp, Inc. 5366f6083SPeter Grehan * All rights reserved. 6366f6083SPeter Grehan * 7366f6083SPeter Grehan * Redistribution and use in source and binary forms, with or without 8366f6083SPeter Grehan * modification, are permitted provided that the following conditions 9366f6083SPeter Grehan * are met: 10366f6083SPeter Grehan * 1. Redistributions of source code must retain the above copyright 11366f6083SPeter Grehan * notice, this list of conditions and the following disclaimer. 12366f6083SPeter Grehan * 2. Redistributions in binary form must reproduce the above copyright 13366f6083SPeter Grehan * notice, this list of conditions and the following disclaimer in the 14366f6083SPeter Grehan * documentation and/or other materials provided with the distribution. 15366f6083SPeter Grehan * 16366f6083SPeter Grehan * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 17366f6083SPeter Grehan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18366f6083SPeter Grehan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19366f6083SPeter Grehan * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 20366f6083SPeter Grehan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21366f6083SPeter Grehan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22366f6083SPeter Grehan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23366f6083SPeter Grehan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24366f6083SPeter Grehan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25366f6083SPeter Grehan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26366f6083SPeter Grehan * SUCH DAMAGE. 27366f6083SPeter Grehan * 28912a3e67SNeel Natu * $FreeBSD$ 29366f6083SPeter Grehan */ 30366f6083SPeter Grehan 31366f6083SPeter Grehan #ifndef _VMM_H_ 32366f6083SPeter Grehan #define _VMM_H_ 33366f6083SPeter Grehan 346ac73777STycho Nightingale #include <sys/sdt.h> 35d37f2adbSNeel Natu #include <x86/segments.h> 36d37f2adbSNeel Natu 37483d953aSJohn Baldwin struct vm_snapshot_meta; 38483d953aSJohn Baldwin 396ac73777STycho Nightingale #ifdef _KERNEL 406ac73777STycho Nightingale SDT_PROVIDER_DECLARE(vmm); 416ac73777STycho Nightingale #endif 426ac73777STycho Nightingale 43f0fdcfe2SNeel Natu enum vm_suspend_how { 44f0fdcfe2SNeel Natu VM_SUSPEND_NONE, 45f0fdcfe2SNeel Natu VM_SUSPEND_RESET, 46f0fdcfe2SNeel Natu VM_SUSPEND_POWEROFF, 47e50ce2aaSNeel Natu VM_SUSPEND_HALT, 48091d4532SNeel Natu VM_SUSPEND_TRIPLEFAULT, 49f0fdcfe2SNeel Natu VM_SUSPEND_LAST 50f0fdcfe2SNeel Natu }; 51f0fdcfe2SNeel Natu 525ebc578bSTycho Nightingale /* 535ebc578bSTycho Nightingale * Identifiers for architecturally defined registers. 545ebc578bSTycho Nightingale */ 555ebc578bSTycho Nightingale enum vm_reg_name { 565ebc578bSTycho Nightingale VM_REG_GUEST_RAX, 575ebc578bSTycho Nightingale VM_REG_GUEST_RBX, 585ebc578bSTycho Nightingale VM_REG_GUEST_RCX, 595ebc578bSTycho Nightingale VM_REG_GUEST_RDX, 605ebc578bSTycho Nightingale VM_REG_GUEST_RSI, 615ebc578bSTycho Nightingale VM_REG_GUEST_RDI, 625ebc578bSTycho Nightingale VM_REG_GUEST_RBP, 635ebc578bSTycho Nightingale VM_REG_GUEST_R8, 645ebc578bSTycho Nightingale VM_REG_GUEST_R9, 655ebc578bSTycho Nightingale VM_REG_GUEST_R10, 665ebc578bSTycho Nightingale VM_REG_GUEST_R11, 675ebc578bSTycho Nightingale VM_REG_GUEST_R12, 685ebc578bSTycho Nightingale VM_REG_GUEST_R13, 695ebc578bSTycho Nightingale VM_REG_GUEST_R14, 705ebc578bSTycho Nightingale VM_REG_GUEST_R15, 715ebc578bSTycho Nightingale VM_REG_GUEST_CR0, 725ebc578bSTycho Nightingale VM_REG_GUEST_CR3, 735ebc578bSTycho Nightingale VM_REG_GUEST_CR4, 745ebc578bSTycho Nightingale VM_REG_GUEST_DR7, 755ebc578bSTycho Nightingale VM_REG_GUEST_RSP, 765ebc578bSTycho Nightingale VM_REG_GUEST_RIP, 775ebc578bSTycho Nightingale VM_REG_GUEST_RFLAGS, 785ebc578bSTycho Nightingale VM_REG_GUEST_ES, 795ebc578bSTycho Nightingale VM_REG_GUEST_CS, 805ebc578bSTycho Nightingale VM_REG_GUEST_SS, 815ebc578bSTycho Nightingale VM_REG_GUEST_DS, 825ebc578bSTycho Nightingale VM_REG_GUEST_FS, 835ebc578bSTycho Nightingale VM_REG_GUEST_GS, 845ebc578bSTycho Nightingale VM_REG_GUEST_LDTR, 855ebc578bSTycho Nightingale VM_REG_GUEST_TR, 865ebc578bSTycho Nightingale VM_REG_GUEST_IDTR, 875ebc578bSTycho Nightingale VM_REG_GUEST_GDTR, 885ebc578bSTycho Nightingale VM_REG_GUEST_EFER, 895ebc578bSTycho Nightingale VM_REG_GUEST_CR2, 903d5444c8SNeel Natu VM_REG_GUEST_PDPTE0, 913d5444c8SNeel Natu VM_REG_GUEST_PDPTE1, 923d5444c8SNeel Natu VM_REG_GUEST_PDPTE2, 933d5444c8SNeel Natu VM_REG_GUEST_PDPTE3, 94d1819632SNeel Natu VM_REG_GUEST_INTR_SHADOW, 9565eefbe4SJohn Baldwin VM_REG_GUEST_DR0, 9665eefbe4SJohn Baldwin VM_REG_GUEST_DR1, 9765eefbe4SJohn Baldwin VM_REG_GUEST_DR2, 9865eefbe4SJohn Baldwin VM_REG_GUEST_DR3, 9965eefbe4SJohn Baldwin VM_REG_GUEST_DR6, 100cbd03a9dSJohn Baldwin VM_REG_GUEST_ENTRY_INST_LENGTH, 1015ebc578bSTycho Nightingale VM_REG_LAST 1025ebc578bSTycho Nightingale }; 1035ebc578bSTycho Nightingale 1045ebc578bSTycho Nightingale enum x2apic_state { 1055ebc578bSTycho Nightingale X2APIC_DISABLED, 1065ebc578bSTycho Nightingale X2APIC_ENABLED, 1075ebc578bSTycho Nightingale X2APIC_STATE_LAST 1085ebc578bSTycho Nightingale }; 1095ebc578bSTycho Nightingale 110091d4532SNeel Natu #define VM_INTINFO_VECTOR(info) ((info) & 0xff) 111091d4532SNeel Natu #define VM_INTINFO_DEL_ERRCODE 0x800 112091d4532SNeel Natu #define VM_INTINFO_RSVD 0x7ffff000 113091d4532SNeel Natu #define VM_INTINFO_VALID 0x80000000 114091d4532SNeel Natu #define VM_INTINFO_TYPE 0x700 115091d4532SNeel Natu #define VM_INTINFO_HWINTR (0 << 8) 116091d4532SNeel Natu #define VM_INTINFO_NMI (2 << 8) 117091d4532SNeel Natu #define VM_INTINFO_HWEXCEPTION (3 << 8) 118091d4532SNeel Natu #define VM_INTINFO_SWINTR (4 << 8) 119091d4532SNeel Natu 120422a8a4dSScott Long /* 121422a8a4dSScott Long * The VM name has to fit into the pathname length constraints of devfs, 122422a8a4dSScott Long * governed primarily by SPECNAMELEN. The length is the total number of 123422a8a4dSScott Long * characters in the full path, relative to the mount point and not 124422a8a4dSScott Long * including any leading '/' characters. 125422a8a4dSScott Long * A prefix and a suffix are added to the name specified by the user. 126422a8a4dSScott Long * The prefix is usually "vmm/" or "vmm.io/", but can be a few characters 127422a8a4dSScott Long * longer for future use. 128422a8a4dSScott Long * The suffix is a string that identifies a bootrom image or some similar 129422a8a4dSScott Long * image that is attached to the VM. A separator character gets added to 130422a8a4dSScott Long * the suffix automatically when generating the full path, so it must be 131422a8a4dSScott Long * accounted for, reducing the effective length by 1. 132422a8a4dSScott Long * The effective length of a VM name is 229 bytes for FreeBSD 13 and 37 133422a8a4dSScott Long * bytes for FreeBSD 12. A minimum length is set for safety and supports 134422a8a4dSScott Long * a SPECNAMELEN as small as 32 on old systems. 135422a8a4dSScott Long */ 136422a8a4dSScott Long #define VM_MAX_PREFIXLEN 10 137422a8a4dSScott Long #define VM_MAX_SUFFIXLEN 15 138422a8a4dSScott Long #define VM_MIN_NAMELEN 6 139422a8a4dSScott Long #define VM_MAX_NAMELEN \ 140422a8a4dSScott Long (SPECNAMELEN - VM_MAX_PREFIXLEN - VM_MAX_SUFFIXLEN - 1) 141366f6083SPeter Grehan 142422a8a4dSScott Long #ifdef _KERNEL 143422a8a4dSScott Long CTASSERT(VM_MAX_NAMELEN >= VM_MIN_NAMELEN); 144366f6083SPeter Grehan 145366f6083SPeter Grehan struct vm; 146dc506506SNeel Natu struct vm_exception; 147366f6083SPeter Grehan struct seg_desc; 148366f6083SPeter Grehan struct vm_exit; 149366f6083SPeter Grehan struct vm_run; 15008e3ff32SNeel Natu struct vhpet; 151565bbb86SNeel Natu struct vioapic; 152366f6083SPeter Grehan struct vlapic; 153318224bbSNeel Natu struct vmspace; 154318224bbSNeel Natu struct vm_object; 155d665d229SNeel Natu struct vm_guest_paging; 156318224bbSNeel Natu struct pmap; 157483d953aSJohn Baldwin enum snapshot_req; 158366f6083SPeter Grehan 159248e6799SNeel Natu struct vm_eventinfo { 160248e6799SNeel Natu void *rptr; /* rendezvous cookie */ 161248e6799SNeel Natu int *sptr; /* suspend cookie */ 162248e6799SNeel Natu int *iptr; /* reqidle cookie */ 163248e6799SNeel Natu }; 164248e6799SNeel Natu 165add611fdSNeel Natu typedef int (*vmm_init_func_t)(int ipinum); 166366f6083SPeter Grehan typedef int (*vmm_cleanup_func_t)(void); 16763e62d39SJohn Baldwin typedef void (*vmm_resume_func_t)(void); 168318224bbSNeel Natu typedef void * (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap); 169318224bbSNeel Natu typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip, 170248e6799SNeel Natu struct pmap *pmap, struct vm_eventinfo *info); 171366f6083SPeter Grehan typedef void (*vmi_cleanup_func_t)(void *vmi); 172366f6083SPeter Grehan typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 173366f6083SPeter Grehan uint64_t *retval); 174366f6083SPeter Grehan typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 175366f6083SPeter Grehan uint64_t val); 176366f6083SPeter Grehan typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 177366f6083SPeter Grehan struct seg_desc *desc); 178366f6083SPeter Grehan typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 179366f6083SPeter Grehan struct seg_desc *desc); 180366f6083SPeter Grehan typedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval); 181366f6083SPeter Grehan typedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val); 182318224bbSNeel Natu typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max); 183318224bbSNeel Natu typedef void (*vmi_vmspace_free)(struct vmspace *vmspace); 184de5ea6b6SNeel Natu typedef struct vlapic * (*vmi_vlapic_init)(void *vmi, int vcpu); 185de5ea6b6SNeel Natu typedef void (*vmi_vlapic_cleanup)(void *vmi, struct vlapic *vlapic); 186483d953aSJohn Baldwin typedef int (*vmi_snapshot_t)(void *vmi, struct vm_snapshot_meta *meta); 187483d953aSJohn Baldwin typedef int (*vmi_snapshot_vmcx_t)(void *vmi, struct vm_snapshot_meta *meta, 188483d953aSJohn Baldwin int vcpu); 189483d953aSJohn Baldwin typedef int (*vmi_restore_tsc_t)(void *vmi, int vcpuid, uint64_t now); 190366f6083SPeter Grehan 191366f6083SPeter Grehan struct vmm_ops { 19215add60dSPeter Grehan vmm_init_func_t modinit; /* module wide initialization */ 19315add60dSPeter Grehan vmm_cleanup_func_t modcleanup; 19415add60dSPeter Grehan vmm_resume_func_t modresume; 195366f6083SPeter Grehan 19615add60dSPeter Grehan vmi_init_func_t init; /* vm-specific initialization */ 19715add60dSPeter Grehan vmi_run_func_t run; 19815add60dSPeter Grehan vmi_cleanup_func_t cleanup; 19915add60dSPeter Grehan vmi_get_register_t getreg; 20015add60dSPeter Grehan vmi_set_register_t setreg; 20115add60dSPeter Grehan vmi_get_desc_t getdesc; 20215add60dSPeter Grehan vmi_set_desc_t setdesc; 20315add60dSPeter Grehan vmi_get_cap_t getcap; 20415add60dSPeter Grehan vmi_set_cap_t setcap; 205318224bbSNeel Natu vmi_vmspace_alloc vmspace_alloc; 206318224bbSNeel Natu vmi_vmspace_free vmspace_free; 207de5ea6b6SNeel Natu vmi_vlapic_init vlapic_init; 208de5ea6b6SNeel Natu vmi_vlapic_cleanup vlapic_cleanup; 209483d953aSJohn Baldwin 210483d953aSJohn Baldwin /* checkpoint operations */ 21115add60dSPeter Grehan vmi_snapshot_t snapshot; 212483d953aSJohn Baldwin vmi_snapshot_vmcx_t vmcx_snapshot; 21315add60dSPeter Grehan vmi_restore_tsc_t restore_tsc; 214366f6083SPeter Grehan }; 215366f6083SPeter Grehan 21615add60dSPeter Grehan extern const struct vmm_ops vmm_ops_intel; 21715add60dSPeter Grehan extern const struct vmm_ops vmm_ops_amd; 218366f6083SPeter Grehan 219d5408b1dSNeel Natu int vm_create(const char *name, struct vm **retvm); 220366f6083SPeter Grehan void vm_destroy(struct vm *vm); 2215fcf252fSNeel Natu int vm_reinit(struct vm *vm); 222366f6083SPeter Grehan const char *vm_name(struct vm *vm); 223a488c9c9SRodney W. Grimes uint16_t vm_get_maxcpus(struct vm *vm); 22401d822d3SRodney W. Grimes void vm_get_topology(struct vm *vm, uint16_t *sockets, uint16_t *cores, 22501d822d3SRodney W. Grimes uint16_t *threads, uint16_t *maxcpus); 22601d822d3SRodney W. Grimes int vm_set_topology(struct vm *vm, uint16_t sockets, uint16_t cores, 22701d822d3SRodney W. Grimes uint16_t threads, uint16_t maxcpus); 2289b1aa8d6SNeel Natu 2299b1aa8d6SNeel Natu /* 2309b1aa8d6SNeel Natu * APIs that modify the guest memory map require all vcpus to be frozen. 2319b1aa8d6SNeel Natu */ 2329b1aa8d6SNeel Natu int vm_mmap_memseg(struct vm *vm, vm_paddr_t gpa, int segid, vm_ooffset_t off, 2339b1aa8d6SNeel Natu size_t len, int prot, int flags); 234f8a6ec2dSD Scott Phillips int vm_munmap_memseg(struct vm *vm, vm_paddr_t gpa, size_t len); 2359b1aa8d6SNeel Natu int vm_alloc_memseg(struct vm *vm, int ident, size_t len, bool sysmem); 2369b1aa8d6SNeel Natu void vm_free_memseg(struct vm *vm, int ident); 237366f6083SPeter Grehan int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 238366f6083SPeter Grehan int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 2399b1aa8d6SNeel Natu int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func); 2409b1aa8d6SNeel Natu int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func); 2419b1aa8d6SNeel Natu 2429b1aa8d6SNeel Natu /* 2439b1aa8d6SNeel Natu * APIs that inspect the guest memory map require only a *single* vcpu to 2449b1aa8d6SNeel Natu * be frozen. This acts like a read lock on the guest memory map since any 2459b1aa8d6SNeel Natu * modification requires *all* vcpus to be frozen. 2469b1aa8d6SNeel Natu */ 2479b1aa8d6SNeel Natu int vm_mmap_getnext(struct vm *vm, vm_paddr_t *gpa, int *segid, 2489b1aa8d6SNeel Natu vm_ooffset_t *segoff, size_t *len, int *prot, int *flags); 2499b1aa8d6SNeel Natu int vm_get_memseg(struct vm *vm, int ident, size_t *len, bool *sysmem, 2509b1aa8d6SNeel Natu struct vm_object **objptr); 251147d12a7SAntoine Brodin vm_paddr_t vmm_sysmem_maxaddr(struct vm *vm); 2529b1aa8d6SNeel Natu void *vm_gpa_hold(struct vm *, int vcpuid, vm_paddr_t gpa, size_t len, 2539b1aa8d6SNeel Natu int prot, void **cookie); 254318224bbSNeel Natu void vm_gpa_release(void *cookie); 2559b1aa8d6SNeel Natu bool vm_mem_allocated(struct vm *vm, int vcpuid, vm_paddr_t gpa); 2569b1aa8d6SNeel Natu 257366f6083SPeter Grehan int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 258366f6083SPeter Grehan int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 259366f6083SPeter Grehan int vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 260366f6083SPeter Grehan struct seg_desc *ret_desc); 261366f6083SPeter Grehan int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 262366f6083SPeter Grehan struct seg_desc *desc); 263366f6083SPeter Grehan int vm_run(struct vm *vm, struct vm_run *vmrun); 264f0fdcfe2SNeel Natu int vm_suspend(struct vm *vm, enum vm_suspend_how how); 265366f6083SPeter Grehan int vm_inject_nmi(struct vm *vm, int vcpu); 266f352ff0cSNeel Natu int vm_nmi_pending(struct vm *vm, int vcpuid); 267f352ff0cSNeel Natu void vm_nmi_clear(struct vm *vm, int vcpuid); 2680775fbb4STycho Nightingale int vm_inject_extint(struct vm *vm, int vcpu); 2690775fbb4STycho Nightingale int vm_extint_pending(struct vm *vm, int vcpuid); 2700775fbb4STycho Nightingale void vm_extint_clear(struct vm *vm, int vcpuid); 271366f6083SPeter Grehan struct vlapic *vm_lapic(struct vm *vm, int cpu); 272565bbb86SNeel Natu struct vioapic *vm_ioapic(struct vm *vm); 27308e3ff32SNeel Natu struct vhpet *vm_hpet(struct vm *vm); 274366f6083SPeter Grehan int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 275366f6083SPeter Grehan int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 276e9027382SNeel Natu int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 277e9027382SNeel Natu int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 278565bbb86SNeel Natu int vm_apicid2vcpuid(struct vm *vm, int apicid); 27995ebc360SNeel Natu int vm_activate_cpu(struct vm *vm, int vcpu); 280fc276d92SJohn Baldwin int vm_suspend_cpu(struct vm *vm, int vcpu); 281fc276d92SJohn Baldwin int vm_resume_cpu(struct vm *vm, int vcpu); 28298ed632cSNeel Natu struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 283f0fdcfe2SNeel Natu void vm_exit_suspended(struct vm *vm, int vcpuid, uint64_t rip); 284fc276d92SJohn Baldwin void vm_exit_debug(struct vm *vm, int vcpuid, uint64_t rip); 28540487465SNeel Natu void vm_exit_rendezvous(struct vm *vm, int vcpuid, uint64_t rip); 28640487465SNeel Natu void vm_exit_astpending(struct vm *vm, int vcpuid, uint64_t rip); 287248e6799SNeel Natu void vm_exit_reqidle(struct vm *vm, int vcpuid, uint64_t rip); 288483d953aSJohn Baldwin int vm_snapshot_req(struct vm *vm, struct vm_snapshot_meta *meta); 289483d953aSJohn Baldwin int vm_restore_time(struct vm *vm); 290483d953aSJohn Baldwin 2918325ce5cSNeel Natu #ifdef _SYS__CPUSET_H_ 292366f6083SPeter Grehan /* 2935b8a8cd1SNeel Natu * Rendezvous all vcpus specified in 'dest' and execute 'func(arg)'. 2945b8a8cd1SNeel Natu * The rendezvous 'func(arg)' is not allowed to do anything that will 2955b8a8cd1SNeel Natu * cause the thread to be put to sleep. 2965b8a8cd1SNeel Natu * 2975b8a8cd1SNeel Natu * If the rendezvous is being initiated from a vcpu context then the 2985b8a8cd1SNeel Natu * 'vcpuid' must refer to that vcpu, otherwise it should be set to -1. 2995b8a8cd1SNeel Natu * 3005b8a8cd1SNeel Natu * The caller cannot hold any locks when initiating the rendezvous. 3015b8a8cd1SNeel Natu * 3025b8a8cd1SNeel Natu * The implementation of this API may cause vcpus other than those specified 3035b8a8cd1SNeel Natu * by 'dest' to be stalled. The caller should not rely on any vcpus making 3045b8a8cd1SNeel Natu * forward progress when the rendezvous is in progress. 3055b8a8cd1SNeel Natu */ 3065b8a8cd1SNeel Natu typedef void (*vm_rendezvous_func_t)(struct vm *vm, int vcpuid, void *arg); 307b837daddSKonstantin Belousov int vm_smp_rendezvous(struct vm *vm, int vcpuid, cpuset_t dest, 3085b8a8cd1SNeel Natu vm_rendezvous_func_t func, void *arg); 3098325ce5cSNeel Natu cpuset_t vm_active_cpus(struct vm *vm); 310fc276d92SJohn Baldwin cpuset_t vm_debug_cpus(struct vm *vm); 3118325ce5cSNeel Natu cpuset_t vm_suspended_cpus(struct vm *vm); 3128325ce5cSNeel Natu #endif /* _SYS__CPUSET_H_ */ 3135b8a8cd1SNeel Natu 3145b8a8cd1SNeel Natu static __inline int 315248e6799SNeel Natu vcpu_rendezvous_pending(struct vm_eventinfo *info) 3165b8a8cd1SNeel Natu { 3175b8a8cd1SNeel Natu 318248e6799SNeel Natu return (*((uintptr_t *)(info->rptr)) != 0); 3195b8a8cd1SNeel Natu } 3205b8a8cd1SNeel Natu 321b15a09c0SNeel Natu static __inline int 322248e6799SNeel Natu vcpu_suspended(struct vm_eventinfo *info) 323b15a09c0SNeel Natu { 324b15a09c0SNeel Natu 325248e6799SNeel Natu return (*info->sptr); 326248e6799SNeel Natu } 327248e6799SNeel Natu 328248e6799SNeel Natu static __inline int 329248e6799SNeel Natu vcpu_reqidle(struct vm_eventinfo *info) 330248e6799SNeel Natu { 331248e6799SNeel Natu 332248e6799SNeel Natu return (*info->iptr); 333b15a09c0SNeel Natu } 334b15a09c0SNeel Natu 335fc276d92SJohn Baldwin int vcpu_debugged(struct vm *vm, int vcpuid); 336fc276d92SJohn Baldwin 3375b8a8cd1SNeel Natu /* 338490d56c5SEd Maste * Return true if device indicated by bus/slot/func is supposed to be a 339366f6083SPeter Grehan * pci passthrough device. 340366f6083SPeter Grehan * 341490d56c5SEd Maste * Return false otherwise. 342366f6083SPeter Grehan */ 343490d56c5SEd Maste bool vmm_is_pptdev(int bus, int slot, int func); 344366f6083SPeter Grehan 345366f6083SPeter Grehan void *vm_iommu_domain(struct vm *vm); 346366f6083SPeter Grehan 34775dd3366SNeel Natu enum vcpu_state { 34875dd3366SNeel Natu VCPU_IDLE, 349318224bbSNeel Natu VCPU_FROZEN, 35075dd3366SNeel Natu VCPU_RUNNING, 351318224bbSNeel Natu VCPU_SLEEPING, 35275dd3366SNeel Natu }; 353366f6083SPeter Grehan 354f80330a8SNeel Natu int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state, 355f80330a8SNeel Natu bool from_idle); 356d3c11f40SPeter Grehan enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu); 357366f6083SPeter Grehan 358366f6083SPeter Grehan static int __inline 359d3c11f40SPeter Grehan vcpu_is_running(struct vm *vm, int vcpu, int *hostcpu) 360366f6083SPeter Grehan { 361d3c11f40SPeter Grehan return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING); 362366f6083SPeter Grehan } 363366f6083SPeter Grehan 364f008d157SNeel Natu #ifdef _SYS_PROC_H_ 365f008d157SNeel Natu static int __inline 366f008d157SNeel Natu vcpu_should_yield(struct vm *vm, int vcpu) 367f008d157SNeel Natu { 368ede04033SNeel Natu 369ede04033SNeel Natu if (curthread->td_flags & (TDF_ASTPENDING | TDF_NEEDRESCHED)) 370ede04033SNeel Natu return (1); 371ede04033SNeel Natu else if (curthread->td_owepreempt) 372ede04033SNeel Natu return (1); 373ede04033SNeel Natu else 374ede04033SNeel Natu return (0); 375f008d157SNeel Natu } 376f008d157SNeel Natu #endif 377f008d157SNeel Natu 37875dd3366SNeel Natu void *vcpu_stats(struct vm *vm, int vcpu); 379de5ea6b6SNeel Natu void vcpu_notify_event(struct vm *vm, int vcpuid, bool lapic_intr); 380318224bbSNeel Natu struct vmspace *vm_get_vmspace(struct vm *vm); 381762fd208STycho Nightingale struct vatpic *vm_atpic(struct vm *vm); 382e883c9bbSTycho Nightingale struct vatpit *vm_atpit(struct vm *vm); 383160ef77aSNeel Natu struct vpmtmr *vm_pmtmr(struct vm *vm); 3840dafa5cdSNeel Natu struct vrtc *vm_rtc(struct vm *vm); 385dc506506SNeel Natu 386dc506506SNeel Natu /* 387c9c75df4SNeel Natu * Inject exception 'vector' into the guest vcpu. This function returns 0 on 388dc506506SNeel Natu * success and non-zero on failure. 389dc506506SNeel Natu * 390dc506506SNeel Natu * Wrapper functions like 'vm_inject_gp()' should be preferred to calling 391dc506506SNeel Natu * this function directly because they enforce the trap-like or fault-like 392dc506506SNeel Natu * behavior of an exception. 393dc506506SNeel Natu * 394dc506506SNeel Natu * This function should only be called in the context of the thread that is 395dc506506SNeel Natu * executing this vcpu. 396dc506506SNeel Natu */ 397c9c75df4SNeel Natu int vm_inject_exception(struct vm *vm, int vcpuid, int vector, int err_valid, 398c9c75df4SNeel Natu uint32_t errcode, int restart_instruction); 399dc506506SNeel Natu 400dc506506SNeel Natu /* 401091d4532SNeel Natu * This function is called after a VM-exit that occurred during exception or 402091d4532SNeel Natu * interrupt delivery through the IDT. The format of 'intinfo' is described 403091d4532SNeel Natu * in Figure 15-1, "EXITINTINFO for All Intercepts", APM, Vol 2. 404dc506506SNeel Natu * 405091d4532SNeel Natu * If a VM-exit handler completes the event delivery successfully then it 406091d4532SNeel Natu * should call vm_exit_intinfo() to extinguish the pending event. For e.g., 407091d4532SNeel Natu * if the task switch emulation is triggered via a task gate then it should 408091d4532SNeel Natu * call this function with 'intinfo=0' to indicate that the external event 409091d4532SNeel Natu * is not pending anymore. 410091d4532SNeel Natu * 411091d4532SNeel Natu * Return value is 0 on success and non-zero on failure. 412dc506506SNeel Natu */ 413091d4532SNeel Natu int vm_exit_intinfo(struct vm *vm, int vcpuid, uint64_t intinfo); 414091d4532SNeel Natu 415091d4532SNeel Natu /* 416091d4532SNeel Natu * This function is called before every VM-entry to retrieve a pending 417091d4532SNeel Natu * event that should be injected into the guest. This function combines 418091d4532SNeel Natu * nested events into a double or triple fault. 419091d4532SNeel Natu * 420091d4532SNeel Natu * Returns 0 if there are no events that need to be injected into the guest 421091d4532SNeel Natu * and non-zero otherwise. 422091d4532SNeel Natu */ 423091d4532SNeel Natu int vm_entry_intinfo(struct vm *vm, int vcpuid, uint64_t *info); 424091d4532SNeel Natu 425091d4532SNeel Natu int vm_get_intinfo(struct vm *vm, int vcpuid, uint64_t *info1, uint64_t *info2); 426dc506506SNeel Natu 427483d953aSJohn Baldwin /* 428483d953aSJohn Baldwin * Function used to keep track of the guest's TSC offset. The 429483d953aSJohn Baldwin * offset is used by the virutalization extensions to provide a consistent 430483d953aSJohn Baldwin * value for the Time Stamp Counter to the guest. 431483d953aSJohn Baldwin * 432483d953aSJohn Baldwin * Return value is 0 on success and non-zero on failure. 433483d953aSJohn Baldwin */ 434483d953aSJohn Baldwin int vm_set_tsc_offset(struct vm *vm, int vcpu_id, uint64_t offset); 435483d953aSJohn Baldwin 436d17b5104SNeel Natu enum vm_reg_name vm_segment_name(int seg_encoding); 437d17b5104SNeel Natu 438d665d229SNeel Natu struct vm_copyinfo { 439d665d229SNeel Natu uint64_t gpa; 440d665d229SNeel Natu size_t len; 441d665d229SNeel Natu void *hva; 442d665d229SNeel Natu void *cookie; 443d665d229SNeel Natu }; 444d665d229SNeel Natu 445d665d229SNeel Natu /* 446d665d229SNeel Natu * Set up 'copyinfo[]' to copy to/from guest linear address space starting 447d665d229SNeel Natu * at 'gla' and 'len' bytes long. The 'prot' should be set to PROT_READ for 448d665d229SNeel Natu * a copyin or PROT_WRITE for a copyout. 449d665d229SNeel Natu * 450edafb5a3SPedro F. Giffuni * retval is_fault Interpretation 4519c4d5478SNeel Natu * 0 0 Success 4529c4d5478SNeel Natu * 0 1 An exception was injected into the guest 4539c4d5478SNeel Natu * EFAULT N/A Unrecoverable error 454d665d229SNeel Natu * 455d665d229SNeel Natu * The 'copyinfo[]' can be passed to 'vm_copyin()' or 'vm_copyout()' only if 456d665d229SNeel Natu * the return value is 0. The 'copyinfo[]' resources should be freed by calling 457d665d229SNeel Natu * 'vm_copy_teardown()' after the copy is done. 458d665d229SNeel Natu */ 459d665d229SNeel Natu int vm_copy_setup(struct vm *vm, int vcpuid, struct vm_guest_paging *paging, 460d665d229SNeel Natu uint64_t gla, size_t len, int prot, struct vm_copyinfo *copyinfo, 4619c4d5478SNeel Natu int num_copyinfo, int *is_fault); 462d665d229SNeel Natu void vm_copy_teardown(struct vm *vm, int vcpuid, struct vm_copyinfo *copyinfo, 463d665d229SNeel Natu int num_copyinfo); 464d665d229SNeel Natu void vm_copyin(struct vm *vm, int vcpuid, struct vm_copyinfo *copyinfo, 465d665d229SNeel Natu void *kaddr, size_t len); 466d665d229SNeel Natu void vm_copyout(struct vm *vm, int vcpuid, const void *kaddr, 467d665d229SNeel Natu struct vm_copyinfo *copyinfo, size_t len); 468b0538143SNeel Natu 469b0538143SNeel Natu int vcpu_trace_exceptions(struct vm *vm, int vcpuid); 470366f6083SPeter Grehan #endif /* KERNEL */ 471366f6083SPeter Grehan 472f1d450ddSJohn Baldwin #ifdef _KERNEL 4738d39ed16SPeter Grehan #define VM_MAXCPU 16 /* maximum virtual cpus */ 474f1d450ddSJohn Baldwin #endif 475366f6083SPeter Grehan 476366f6083SPeter Grehan /* 477366f6083SPeter Grehan * Identifiers for optional vmm capabilities 478366f6083SPeter Grehan */ 479366f6083SPeter Grehan enum vm_cap_type { 480366f6083SPeter Grehan VM_CAP_HALT_EXIT, 481366f6083SPeter Grehan VM_CAP_MTRAP_EXIT, 482366f6083SPeter Grehan VM_CAP_PAUSE_EXIT, 483366f6083SPeter Grehan VM_CAP_UNRESTRICTED_GUEST, 48449cc03daSNeel Natu VM_CAP_ENABLE_INVPCID, 485cbd03a9dSJohn Baldwin VM_CAP_BPT_EXIT, 486f5f5f1e7SPeter Grehan VM_CAP_RDPID, 487f5f5f1e7SPeter Grehan VM_CAP_RDTSCP, 488366f6083SPeter Grehan VM_CAP_MAX 489366f6083SPeter Grehan }; 490366f6083SPeter Grehan 491b3e9732aSJohn Baldwin enum vm_intr_trigger { 492b3e9732aSJohn Baldwin EDGE_TRIGGER, 493b3e9732aSJohn Baldwin LEVEL_TRIGGER 494b3e9732aSJohn Baldwin }; 495b3e9732aSJohn Baldwin 496366f6083SPeter Grehan /* 497366f6083SPeter Grehan * The 'access' field has the format specified in Table 21-2 of the Intel 498366f6083SPeter Grehan * Architecture Manual vol 3b. 499366f6083SPeter Grehan * 500366f6083SPeter Grehan * XXX The contents of the 'access' field are architecturally defined except 501366f6083SPeter Grehan * bit 16 - Segment Unusable. 502366f6083SPeter Grehan */ 503366f6083SPeter Grehan struct seg_desc { 504366f6083SPeter Grehan uint64_t base; 505366f6083SPeter Grehan uint32_t limit; 506366f6083SPeter Grehan uint32_t access; 507366f6083SPeter Grehan }; 508f7a9f178SNeel Natu #define SEG_DESC_TYPE(access) ((access) & 0x001f) 5093d5444c8SNeel Natu #define SEG_DESC_DPL(access) (((access) >> 5) & 0x3) 510f7a9f178SNeel Natu #define SEG_DESC_PRESENT(access) (((access) & 0x0080) ? 1 : 0) 511f7a9f178SNeel Natu #define SEG_DESC_DEF32(access) (((access) & 0x4000) ? 1 : 0) 512f7a9f178SNeel Natu #define SEG_DESC_GRANULARITY(access) (((access) & 0x8000) ? 1 : 0) 513f7a9f178SNeel Natu #define SEG_DESC_UNUSABLE(access) (((access) & 0x10000) ? 1 : 0) 514366f6083SPeter Grehan 515e813a873SNeel Natu enum vm_cpu_mode { 516b301b9e2SNeel Natu CPU_MODE_REAL, 517b301b9e2SNeel Natu CPU_MODE_PROTECTED, 518e813a873SNeel Natu CPU_MODE_COMPATIBILITY, /* IA-32E mode (CS.L = 0) */ 519e813a873SNeel Natu CPU_MODE_64BIT, /* IA-32E mode (CS.L = 1) */ 520e813a873SNeel Natu }; 521e813a873SNeel Natu 522e813a873SNeel Natu enum vm_paging_mode { 523e813a873SNeel Natu PAGING_MODE_FLAT, 524e813a873SNeel Natu PAGING_MODE_32, 525e813a873SNeel Natu PAGING_MODE_PAE, 526e813a873SNeel Natu PAGING_MODE_64, 527f3eb12e4SKonstantin Belousov PAGING_MODE_64_LA57, 528e813a873SNeel Natu }; 529e813a873SNeel Natu 530e813a873SNeel Natu struct vm_guest_paging { 531e813a873SNeel Natu uint64_t cr3; 532e813a873SNeel Natu int cpl; 533e813a873SNeel Natu enum vm_cpu_mode cpu_mode; 534e813a873SNeel Natu enum vm_paging_mode paging_mode; 535e813a873SNeel Natu }; 536e813a873SNeel Natu 537e813a873SNeel Natu /* 538e813a873SNeel Natu * The data structures 'vie' and 'vie_op' are meant to be opaque to the 539e813a873SNeel Natu * consumers of instruction decoding. The only reason why their contents 540e813a873SNeel Natu * need to be exposed is because they are part of the 'vm_exit' structure. 541e813a873SNeel Natu */ 542e813a873SNeel Natu struct vie_op { 543e813a873SNeel Natu uint8_t op_byte; /* actual opcode byte */ 544e813a873SNeel Natu uint8_t op_type; /* type of operation (e.g. MOV) */ 545e813a873SNeel Natu uint16_t op_flags; 546e813a873SNeel Natu }; 547497cb925SConrad Meyer _Static_assert(sizeof(struct vie_op) == 4, "ABI"); 548497cb925SConrad Meyer _Static_assert(_Alignof(struct vie_op) == 2, "ABI"); 549e813a873SNeel Natu 550e813a873SNeel Natu #define VIE_INST_SIZE 15 551e813a873SNeel Natu struct vie { 552e813a873SNeel Natu uint8_t inst[VIE_INST_SIZE]; /* instruction bytes */ 553e813a873SNeel Natu uint8_t num_valid; /* size of the instruction */ 5544daa95f8SConrad Meyer 5554daa95f8SConrad Meyer /* The following fields are all zeroed upon restart. */ 5564daa95f8SConrad Meyer #define vie_startzero num_processed 557e813a873SNeel Natu uint8_t num_processed; 558e813a873SNeel Natu 559f7a9f178SNeel Natu uint8_t addrsize:4, opsize:4; /* address and operand sizes */ 560e813a873SNeel Natu uint8_t rex_w:1, /* REX prefix */ 561e813a873SNeel Natu rex_r:1, 562e813a873SNeel Natu rex_x:1, 563e813a873SNeel Natu rex_b:1, 564f7a9f178SNeel Natu rex_present:1, 56575346353SNeel Natu repz_present:1, /* REP/REPE/REPZ prefix */ 56675346353SNeel Natu repnz_present:1, /* REPNE/REPNZ prefix */ 567f7a9f178SNeel Natu opsize_override:1, /* Operand size override */ 56875346353SNeel Natu addrsize_override:1, /* Address size override */ 56975346353SNeel Natu segment_override:1; /* Segment override */ 570e813a873SNeel Natu 571e813a873SNeel Natu uint8_t mod:2, /* ModRM byte */ 572e813a873SNeel Natu reg:4, 573e813a873SNeel Natu rm:4; 574e813a873SNeel Natu 575e813a873SNeel Natu uint8_t ss:2, /* SIB byte */ 576cfdea69dSConrad Meyer vex_present:1, /* VEX prefixed */ 577cfdea69dSConrad Meyer vex_l:1, /* L bit */ 578497cb925SConrad Meyer index:4, /* SIB byte */ 579497cb925SConrad Meyer base:4; /* SIB byte */ 580e813a873SNeel Natu 581e813a873SNeel Natu uint8_t disp_bytes; 582e813a873SNeel Natu uint8_t imm_bytes; 583e813a873SNeel Natu 584e813a873SNeel Natu uint8_t scale; 585497cb925SConrad Meyer 586cfdea69dSConrad Meyer uint8_t vex_reg:4, /* vvvv: first source register specifier */ 587cfdea69dSConrad Meyer vex_pp:2, /* pp */ 588cfdea69dSConrad Meyer _sparebits:2; 589cfdea69dSConrad Meyer 590cfdea69dSConrad Meyer uint8_t _sparebytes[2]; 591497cb925SConrad Meyer 592e813a873SNeel Natu int base_register; /* VM_REG_GUEST_xyz */ 593e813a873SNeel Natu int index_register; /* VM_REG_GUEST_xyz */ 59475346353SNeel Natu int segment_register; /* VM_REG_GUEST_xyz */ 595e813a873SNeel Natu 596e813a873SNeel Natu int64_t displacement; /* optional addr displacement */ 597e813a873SNeel Natu int64_t immediate; /* optional immediate operand */ 598e813a873SNeel Natu 599e813a873SNeel Natu uint8_t decoded; /* set to 1 if successfully decoded */ 600e813a873SNeel Natu 601497cb925SConrad Meyer uint8_t _sparebyte; 602497cb925SConrad Meyer 603e813a873SNeel Natu struct vie_op op; /* opcode description */ 604e813a873SNeel Natu }; 605497cb925SConrad Meyer _Static_assert(sizeof(struct vie) == 64, "ABI"); 606497cb925SConrad Meyer _Static_assert(__offsetof(struct vie, disp_bytes) == 22, "ABI"); 607497cb925SConrad Meyer _Static_assert(__offsetof(struct vie, scale) == 24, "ABI"); 608497cb925SConrad Meyer _Static_assert(__offsetof(struct vie, base_register) == 28, "ABI"); 609e813a873SNeel Natu 610366f6083SPeter Grehan enum vm_exitcode { 611366f6083SPeter Grehan VM_EXITCODE_INOUT, 612366f6083SPeter Grehan VM_EXITCODE_VMX, 613366f6083SPeter Grehan VM_EXITCODE_BOGUS, 614366f6083SPeter Grehan VM_EXITCODE_RDMSR, 615366f6083SPeter Grehan VM_EXITCODE_WRMSR, 616366f6083SPeter Grehan VM_EXITCODE_HLT, 617366f6083SPeter Grehan VM_EXITCODE_MTRAP, 618366f6083SPeter Grehan VM_EXITCODE_PAUSE, 619cd942e0fSPeter Grehan VM_EXITCODE_PAGING, 620318224bbSNeel Natu VM_EXITCODE_INST_EMUL, 621edf89256SNeel Natu VM_EXITCODE_SPINUP_AP, 622c6a0cc2eSNeel Natu VM_EXITCODE_DEPRECATED1, /* used to be SPINDOWN_CPU */ 6235b8a8cd1SNeel Natu VM_EXITCODE_RENDEZVOUS, 62430b94db8SNeel Natu VM_EXITCODE_IOAPIC_EOI, 625b15a09c0SNeel Natu VM_EXITCODE_SUSPENDED, 626d17b5104SNeel Natu VM_EXITCODE_INOUT_STR, 6273d5444c8SNeel Natu VM_EXITCODE_TASK_SWITCH, 62865145c7fSNeel Natu VM_EXITCODE_MONITOR, 62965145c7fSNeel Natu VM_EXITCODE_MWAIT, 630bbadcde4SNeel Natu VM_EXITCODE_SVM, 631248e6799SNeel Natu VM_EXITCODE_REQIDLE, 632fc276d92SJohn Baldwin VM_EXITCODE_DEBUG, 63327d26457SAndrew Turner VM_EXITCODE_VMINSN, 634cbd03a9dSJohn Baldwin VM_EXITCODE_BPT, 635cd942e0fSPeter Grehan VM_EXITCODE_MAX 636366f6083SPeter Grehan }; 637366f6083SPeter Grehan 638d17b5104SNeel Natu struct vm_inout { 639d17b5104SNeel Natu uint16_t bytes:3; /* 1 or 2 or 4 */ 640d17b5104SNeel Natu uint16_t in:1; 641d17b5104SNeel Natu uint16_t string:1; 642d17b5104SNeel Natu uint16_t rep:1; 643d17b5104SNeel Natu uint16_t port; 644d17b5104SNeel Natu uint32_t eax; /* valid for out */ 645d17b5104SNeel Natu }; 646d17b5104SNeel Natu 647d17b5104SNeel Natu struct vm_inout_str { 648d17b5104SNeel Natu struct vm_inout inout; /* must be the first element */ 649e813a873SNeel Natu struct vm_guest_paging paging; 650d17b5104SNeel Natu uint64_t rflags; 651d17b5104SNeel Natu uint64_t cr0; 652d17b5104SNeel Natu uint64_t index; 653d17b5104SNeel Natu uint64_t count; /* rep=1 (%rcx), rep=0 (1) */ 654d17b5104SNeel Natu int addrsize; 655d17b5104SNeel Natu enum vm_reg_name seg_name; 656d17b5104SNeel Natu struct seg_desc seg_desc; 657d17b5104SNeel Natu }; 658d17b5104SNeel Natu 6593d5444c8SNeel Natu enum task_switch_reason { 6603d5444c8SNeel Natu TSR_CALL, 6613d5444c8SNeel Natu TSR_IRET, 6623d5444c8SNeel Natu TSR_JMP, 6633d5444c8SNeel Natu TSR_IDT_GATE, /* task gate in IDT */ 6643d5444c8SNeel Natu }; 6653d5444c8SNeel Natu 6663d5444c8SNeel Natu struct vm_task_switch { 6673d5444c8SNeel Natu uint16_t tsssel; /* new TSS selector */ 6683d5444c8SNeel Natu int ext; /* task switch due to external event */ 6693d5444c8SNeel Natu uint32_t errcode; 6703d5444c8SNeel Natu int errcode_valid; /* push 'errcode' on the new stack */ 6713d5444c8SNeel Natu enum task_switch_reason reason; 6723d5444c8SNeel Natu struct vm_guest_paging paging; 6733d5444c8SNeel Natu }; 6743d5444c8SNeel Natu 675366f6083SPeter Grehan struct vm_exit { 676366f6083SPeter Grehan enum vm_exitcode exitcode; 677366f6083SPeter Grehan int inst_length; /* 0 means unknown */ 678366f6083SPeter Grehan uint64_t rip; 679366f6083SPeter Grehan union { 680d17b5104SNeel Natu struct vm_inout inout; 681d17b5104SNeel Natu struct vm_inout_str inout_str; 682cd942e0fSPeter Grehan struct { 68313ec9371SPeter Grehan uint64_t gpa; 684318224bbSNeel Natu int fault_type; 685cd942e0fSPeter Grehan } paging; 686318224bbSNeel Natu struct { 687318224bbSNeel Natu uint64_t gpa; 688318224bbSNeel Natu uint64_t gla; 689e4f605eeSTycho Nightingale uint64_t cs_base; 690f7a9f178SNeel Natu int cs_d; /* CS.D */ 691e813a873SNeel Natu struct vm_guest_paging paging; 692318224bbSNeel Natu struct vie vie; 693318224bbSNeel Natu } inst_emul; 694366f6083SPeter Grehan /* 695366f6083SPeter Grehan * VMX specific payload. Used when there is no "better" 696366f6083SPeter Grehan * exitcode to represent the VM-exit. 697366f6083SPeter Grehan */ 698366f6083SPeter Grehan struct { 6990492757cSNeel Natu int status; /* vmx inst status */ 7000492757cSNeel Natu /* 7010492757cSNeel Natu * 'exit_reason' and 'exit_qualification' are valid 7020492757cSNeel Natu * only if 'status' is zero. 7030492757cSNeel Natu */ 704366f6083SPeter Grehan uint32_t exit_reason; 705366f6083SPeter Grehan uint64_t exit_qualification; 7060492757cSNeel Natu /* 7070492757cSNeel Natu * 'inst_error' and 'inst_type' are valid 7080492757cSNeel Natu * only if 'status' is non-zero. 7090492757cSNeel Natu */ 7100492757cSNeel Natu int inst_type; 7110492757cSNeel Natu int inst_error; 712366f6083SPeter Grehan } vmx; 713bbadcde4SNeel Natu /* 714bbadcde4SNeel Natu * SVM specific payload. 715bbadcde4SNeel Natu */ 716bbadcde4SNeel Natu struct { 717bbadcde4SNeel Natu uint64_t exitcode; 718bbadcde4SNeel Natu uint64_t exitinfo1; 719bbadcde4SNeel Natu uint64_t exitinfo2; 720bbadcde4SNeel Natu } svm; 721366f6083SPeter Grehan struct { 722cbd03a9dSJohn Baldwin int inst_length; 723cbd03a9dSJohn Baldwin } bpt; 724cbd03a9dSJohn Baldwin struct { 725366f6083SPeter Grehan uint32_t code; /* ecx value */ 726366f6083SPeter Grehan uint64_t wval; 727366f6083SPeter Grehan } msr; 728edf89256SNeel Natu struct { 729edf89256SNeel Natu int vcpu; 730edf89256SNeel Natu uint64_t rip; 731edf89256SNeel Natu } spinup_ap; 7321c052192SNeel Natu struct { 7331c052192SNeel Natu uint64_t rflags; 734490768e2STycho Nightingale uint64_t intr_status; 7351c052192SNeel Natu } hlt; 73630b94db8SNeel Natu struct { 73730b94db8SNeel Natu int vector; 73830b94db8SNeel Natu } ioapic_eoi; 739f0fdcfe2SNeel Natu struct { 740f0fdcfe2SNeel Natu enum vm_suspend_how how; 741f0fdcfe2SNeel Natu } suspended; 7423d5444c8SNeel Natu struct vm_task_switch task_switch; 743366f6083SPeter Grehan } u; 744366f6083SPeter Grehan }; 745366f6083SPeter Grehan 746d37f2adbSNeel Natu /* APIs to inject faults into the guest */ 747d37f2adbSNeel Natu void vm_inject_fault(void *vm, int vcpuid, int vector, int errcode_valid, 748d37f2adbSNeel Natu int errcode); 749d37f2adbSNeel Natu 7507f21538bSPeter Grehan static __inline void 751d37f2adbSNeel Natu vm_inject_ud(void *vm, int vcpuid) 752d37f2adbSNeel Natu { 753d37f2adbSNeel Natu vm_inject_fault(vm, vcpuid, IDT_UD, 0, 0); 754d37f2adbSNeel Natu } 755d37f2adbSNeel Natu 7567f21538bSPeter Grehan static __inline void 757d37f2adbSNeel Natu vm_inject_gp(void *vm, int vcpuid) 758d37f2adbSNeel Natu { 759d37f2adbSNeel Natu vm_inject_fault(vm, vcpuid, IDT_GP, 1, 0); 760d37f2adbSNeel Natu } 761d37f2adbSNeel Natu 7627f21538bSPeter Grehan static __inline void 763d37f2adbSNeel Natu vm_inject_ac(void *vm, int vcpuid, int errcode) 764d37f2adbSNeel Natu { 765d37f2adbSNeel Natu vm_inject_fault(vm, vcpuid, IDT_AC, 1, errcode); 766d37f2adbSNeel Natu } 767d37f2adbSNeel Natu 7687f21538bSPeter Grehan static __inline void 769d37f2adbSNeel Natu vm_inject_ss(void *vm, int vcpuid, int errcode) 770d37f2adbSNeel Natu { 771d37f2adbSNeel Natu vm_inject_fault(vm, vcpuid, IDT_SS, 1, errcode); 772d37f2adbSNeel Natu } 773d37f2adbSNeel Natu 774d37f2adbSNeel Natu void vm_inject_pf(void *vm, int vcpuid, int error_code, uint64_t cr2); 775d37f2adbSNeel Natu 776c9c75df4SNeel Natu int vm_restart_instruction(void *vm, int vcpuid); 777c9c75df4SNeel Natu 778366f6083SPeter Grehan #endif /* _VMM_H_ */ 779