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 340bda8d3eSCorvin Köhne #include <sys/cpuset.h> 356ac73777STycho Nightingale #include <sys/sdt.h> 36d37f2adbSNeel Natu #include <x86/segments.h> 37d37f2adbSNeel Natu 38483d953aSJohn Baldwin struct vm_snapshot_meta; 39483d953aSJohn Baldwin 406ac73777STycho Nightingale #ifdef _KERNEL 416ac73777STycho Nightingale SDT_PROVIDER_DECLARE(vmm); 426ac73777STycho Nightingale #endif 436ac73777STycho Nightingale 44f0fdcfe2SNeel Natu enum vm_suspend_how { 45f0fdcfe2SNeel Natu VM_SUSPEND_NONE, 46f0fdcfe2SNeel Natu VM_SUSPEND_RESET, 47f0fdcfe2SNeel Natu VM_SUSPEND_POWEROFF, 48e50ce2aaSNeel Natu VM_SUSPEND_HALT, 49091d4532SNeel Natu VM_SUSPEND_TRIPLEFAULT, 50f0fdcfe2SNeel Natu VM_SUSPEND_LAST 51f0fdcfe2SNeel Natu }; 52f0fdcfe2SNeel Natu 535ebc578bSTycho Nightingale /* 545ebc578bSTycho Nightingale * Identifiers for architecturally defined registers. 555ebc578bSTycho Nightingale */ 565ebc578bSTycho Nightingale enum vm_reg_name { 575ebc578bSTycho Nightingale VM_REG_GUEST_RAX, 585ebc578bSTycho Nightingale VM_REG_GUEST_RBX, 595ebc578bSTycho Nightingale VM_REG_GUEST_RCX, 605ebc578bSTycho Nightingale VM_REG_GUEST_RDX, 615ebc578bSTycho Nightingale VM_REG_GUEST_RSI, 625ebc578bSTycho Nightingale VM_REG_GUEST_RDI, 635ebc578bSTycho Nightingale VM_REG_GUEST_RBP, 645ebc578bSTycho Nightingale VM_REG_GUEST_R8, 655ebc578bSTycho Nightingale VM_REG_GUEST_R9, 665ebc578bSTycho Nightingale VM_REG_GUEST_R10, 675ebc578bSTycho Nightingale VM_REG_GUEST_R11, 685ebc578bSTycho Nightingale VM_REG_GUEST_R12, 695ebc578bSTycho Nightingale VM_REG_GUEST_R13, 705ebc578bSTycho Nightingale VM_REG_GUEST_R14, 715ebc578bSTycho Nightingale VM_REG_GUEST_R15, 725ebc578bSTycho Nightingale VM_REG_GUEST_CR0, 735ebc578bSTycho Nightingale VM_REG_GUEST_CR3, 745ebc578bSTycho Nightingale VM_REG_GUEST_CR4, 755ebc578bSTycho Nightingale VM_REG_GUEST_DR7, 765ebc578bSTycho Nightingale VM_REG_GUEST_RSP, 775ebc578bSTycho Nightingale VM_REG_GUEST_RIP, 785ebc578bSTycho Nightingale VM_REG_GUEST_RFLAGS, 795ebc578bSTycho Nightingale VM_REG_GUEST_ES, 805ebc578bSTycho Nightingale VM_REG_GUEST_CS, 815ebc578bSTycho Nightingale VM_REG_GUEST_SS, 825ebc578bSTycho Nightingale VM_REG_GUEST_DS, 835ebc578bSTycho Nightingale VM_REG_GUEST_FS, 845ebc578bSTycho Nightingale VM_REG_GUEST_GS, 855ebc578bSTycho Nightingale VM_REG_GUEST_LDTR, 865ebc578bSTycho Nightingale VM_REG_GUEST_TR, 875ebc578bSTycho Nightingale VM_REG_GUEST_IDTR, 885ebc578bSTycho Nightingale VM_REG_GUEST_GDTR, 895ebc578bSTycho Nightingale VM_REG_GUEST_EFER, 905ebc578bSTycho Nightingale VM_REG_GUEST_CR2, 913d5444c8SNeel Natu VM_REG_GUEST_PDPTE0, 923d5444c8SNeel Natu VM_REG_GUEST_PDPTE1, 933d5444c8SNeel Natu VM_REG_GUEST_PDPTE2, 943d5444c8SNeel Natu VM_REG_GUEST_PDPTE3, 95d1819632SNeel Natu VM_REG_GUEST_INTR_SHADOW, 9665eefbe4SJohn Baldwin VM_REG_GUEST_DR0, 9765eefbe4SJohn Baldwin VM_REG_GUEST_DR1, 9865eefbe4SJohn Baldwin VM_REG_GUEST_DR2, 9965eefbe4SJohn Baldwin VM_REG_GUEST_DR3, 10065eefbe4SJohn Baldwin VM_REG_GUEST_DR6, 101cbd03a9dSJohn Baldwin VM_REG_GUEST_ENTRY_INST_LENGTH, 1025ebc578bSTycho Nightingale VM_REG_LAST 1035ebc578bSTycho Nightingale }; 1045ebc578bSTycho Nightingale 1055ebc578bSTycho Nightingale enum x2apic_state { 1065ebc578bSTycho Nightingale X2APIC_DISABLED, 1075ebc578bSTycho Nightingale X2APIC_ENABLED, 1085ebc578bSTycho Nightingale X2APIC_STATE_LAST 1095ebc578bSTycho Nightingale }; 1105ebc578bSTycho Nightingale 111091d4532SNeel Natu #define VM_INTINFO_VECTOR(info) ((info) & 0xff) 112091d4532SNeel Natu #define VM_INTINFO_DEL_ERRCODE 0x800 113091d4532SNeel Natu #define VM_INTINFO_RSVD 0x7ffff000 114091d4532SNeel Natu #define VM_INTINFO_VALID 0x80000000 115091d4532SNeel Natu #define VM_INTINFO_TYPE 0x700 116091d4532SNeel Natu #define VM_INTINFO_HWINTR (0 << 8) 117091d4532SNeel Natu #define VM_INTINFO_NMI (2 << 8) 118091d4532SNeel Natu #define VM_INTINFO_HWEXCEPTION (3 << 8) 119091d4532SNeel Natu #define VM_INTINFO_SWINTR (4 << 8) 120091d4532SNeel Natu 121422a8a4dSScott Long /* 122422a8a4dSScott Long * The VM name has to fit into the pathname length constraints of devfs, 123422a8a4dSScott Long * governed primarily by SPECNAMELEN. The length is the total number of 124422a8a4dSScott Long * characters in the full path, relative to the mount point and not 125422a8a4dSScott Long * including any leading '/' characters. 126422a8a4dSScott Long * A prefix and a suffix are added to the name specified by the user. 127422a8a4dSScott Long * The prefix is usually "vmm/" or "vmm.io/", but can be a few characters 128422a8a4dSScott Long * longer for future use. 129422a8a4dSScott Long * The suffix is a string that identifies a bootrom image or some similar 130422a8a4dSScott Long * image that is attached to the VM. A separator character gets added to 131422a8a4dSScott Long * the suffix automatically when generating the full path, so it must be 132422a8a4dSScott Long * accounted for, reducing the effective length by 1. 133422a8a4dSScott Long * The effective length of a VM name is 229 bytes for FreeBSD 13 and 37 134422a8a4dSScott Long * bytes for FreeBSD 12. A minimum length is set for safety and supports 135422a8a4dSScott Long * a SPECNAMELEN as small as 32 on old systems. 136422a8a4dSScott Long */ 137422a8a4dSScott Long #define VM_MAX_PREFIXLEN 10 138422a8a4dSScott Long #define VM_MAX_SUFFIXLEN 15 139422a8a4dSScott Long #define VM_MIN_NAMELEN 6 140422a8a4dSScott Long #define VM_MAX_NAMELEN \ 141422a8a4dSScott Long (SPECNAMELEN - VM_MAX_PREFIXLEN - VM_MAX_SUFFIXLEN - 1) 142366f6083SPeter Grehan 143422a8a4dSScott Long #ifdef _KERNEL 144422a8a4dSScott Long CTASSERT(VM_MAX_NAMELEN >= VM_MIN_NAMELEN); 145366f6083SPeter Grehan 146950af9ffSJohn Baldwin struct vcpu; 147366f6083SPeter Grehan struct vm; 148dc506506SNeel Natu struct vm_exception; 149366f6083SPeter Grehan struct seg_desc; 150366f6083SPeter Grehan struct vm_exit; 151366f6083SPeter Grehan struct vm_run; 15208e3ff32SNeel Natu struct vhpet; 153565bbb86SNeel Natu struct vioapic; 154366f6083SPeter Grehan struct vlapic; 155318224bbSNeel Natu struct vmspace; 156318224bbSNeel Natu struct vm_object; 157d665d229SNeel Natu struct vm_guest_paging; 158318224bbSNeel Natu struct pmap; 159483d953aSJohn Baldwin enum snapshot_req; 160366f6083SPeter Grehan 161248e6799SNeel Natu struct vm_eventinfo { 162248e6799SNeel Natu void *rptr; /* rendezvous cookie */ 163248e6799SNeel Natu int *sptr; /* suspend cookie */ 164248e6799SNeel Natu int *iptr; /* reqidle cookie */ 165248e6799SNeel Natu }; 166248e6799SNeel Natu 167add611fdSNeel Natu typedef int (*vmm_init_func_t)(int ipinum); 168366f6083SPeter Grehan typedef int (*vmm_cleanup_func_t)(void); 16963e62d39SJohn Baldwin typedef void (*vmm_resume_func_t)(void); 170318224bbSNeel Natu typedef void * (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap); 171869c8d19SJohn Baldwin typedef int (*vmi_run_func_t)(void *vcpui, register_t rip, 172248e6799SNeel Natu struct pmap *pmap, struct vm_eventinfo *info); 173366f6083SPeter Grehan typedef void (*vmi_cleanup_func_t)(void *vmi); 174950af9ffSJohn Baldwin typedef void * (*vmi_vcpu_init_func_t)(void *vmi, struct vcpu *vcpu, 175950af9ffSJohn Baldwin int vcpu_id); 176869c8d19SJohn Baldwin typedef void (*vmi_vcpu_cleanup_func_t)(void *vcpui); 177869c8d19SJohn Baldwin typedef int (*vmi_get_register_t)(void *vcpui, int num, uint64_t *retval); 178869c8d19SJohn Baldwin typedef int (*vmi_set_register_t)(void *vcpui, int num, uint64_t val); 179869c8d19SJohn Baldwin typedef int (*vmi_get_desc_t)(void *vcpui, int num, struct seg_desc *desc); 180869c8d19SJohn Baldwin typedef int (*vmi_set_desc_t)(void *vcpui, int num, struct seg_desc *desc); 181869c8d19SJohn Baldwin typedef int (*vmi_get_cap_t)(void *vcpui, int num, int *retval); 182869c8d19SJohn Baldwin typedef int (*vmi_set_cap_t)(void *vcpui, int num, int val); 183318224bbSNeel Natu typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max); 184318224bbSNeel Natu typedef void (*vmi_vmspace_free)(struct vmspace *vmspace); 185869c8d19SJohn Baldwin typedef struct vlapic * (*vmi_vlapic_init)(void *vcpui); 186869c8d19SJohn Baldwin typedef void (*vmi_vlapic_cleanup)(struct vlapic *vlapic); 187483d953aSJohn Baldwin typedef int (*vmi_snapshot_t)(void *vmi, struct vm_snapshot_meta *meta); 188869c8d19SJohn Baldwin typedef int (*vmi_snapshot_vcpu_t)(void *vcpui, struct vm_snapshot_meta *meta); 189869c8d19SJohn Baldwin typedef int (*vmi_restore_tsc_t)(void *vcpui, 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; 1991aa51504SJohn Baldwin vmi_vcpu_init_func_t vcpu_init; 2001aa51504SJohn Baldwin vmi_vcpu_cleanup_func_t vcpu_cleanup; 20115add60dSPeter Grehan vmi_get_register_t getreg; 20215add60dSPeter Grehan vmi_set_register_t setreg; 20315add60dSPeter Grehan vmi_get_desc_t getdesc; 20415add60dSPeter Grehan vmi_set_desc_t setdesc; 20515add60dSPeter Grehan vmi_get_cap_t getcap; 20615add60dSPeter Grehan vmi_set_cap_t setcap; 207318224bbSNeel Natu vmi_vmspace_alloc vmspace_alloc; 208318224bbSNeel Natu vmi_vmspace_free vmspace_free; 209de5ea6b6SNeel Natu vmi_vlapic_init vlapic_init; 210de5ea6b6SNeel Natu vmi_vlapic_cleanup vlapic_cleanup; 211483d953aSJohn Baldwin 212483d953aSJohn Baldwin /* checkpoint operations */ 21315add60dSPeter Grehan vmi_snapshot_t snapshot; 21439ec056eSJohn Baldwin vmi_snapshot_vcpu_t vcpu_snapshot; 21515add60dSPeter Grehan vmi_restore_tsc_t restore_tsc; 216366f6083SPeter Grehan }; 217366f6083SPeter Grehan 21815add60dSPeter Grehan extern const struct vmm_ops vmm_ops_intel; 21915add60dSPeter Grehan extern const struct vmm_ops vmm_ops_amd; 220366f6083SPeter Grehan 221d5408b1dSNeel Natu int vm_create(const char *name, struct vm **retvm); 222366f6083SPeter Grehan void vm_destroy(struct vm *vm); 2235fcf252fSNeel Natu int vm_reinit(struct vm *vm); 224366f6083SPeter Grehan const char *vm_name(struct vm *vm); 225a488c9c9SRodney W. Grimes uint16_t vm_get_maxcpus(struct vm *vm); 22601d822d3SRodney W. Grimes void vm_get_topology(struct vm *vm, uint16_t *sockets, uint16_t *cores, 22701d822d3SRodney W. Grimes uint16_t *threads, uint16_t *maxcpus); 22801d822d3SRodney W. Grimes int vm_set_topology(struct vm *vm, uint16_t sockets, uint16_t cores, 22901d822d3SRodney W. Grimes uint16_t threads, uint16_t maxcpus); 2309b1aa8d6SNeel Natu 2319b1aa8d6SNeel Natu /* 2329b1aa8d6SNeel Natu * APIs that modify the guest memory map require all vcpus to be frozen. 2339b1aa8d6SNeel Natu */ 2349b1aa8d6SNeel Natu int vm_mmap_memseg(struct vm *vm, vm_paddr_t gpa, int segid, vm_ooffset_t off, 2359b1aa8d6SNeel Natu size_t len, int prot, int flags); 236f8a6ec2dSD Scott Phillips int vm_munmap_memseg(struct vm *vm, vm_paddr_t gpa, size_t len); 2379b1aa8d6SNeel Natu int vm_alloc_memseg(struct vm *vm, int ident, size_t len, bool sysmem); 2389b1aa8d6SNeel Natu void vm_free_memseg(struct vm *vm, int ident); 239366f6083SPeter Grehan int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 240366f6083SPeter Grehan int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 2419b1aa8d6SNeel Natu int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func); 2429b1aa8d6SNeel Natu int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func); 2439b1aa8d6SNeel Natu 2449b1aa8d6SNeel Natu /* 2459b1aa8d6SNeel Natu * APIs that inspect the guest memory map require only a *single* vcpu to 2469b1aa8d6SNeel Natu * be frozen. This acts like a read lock on the guest memory map since any 2479b1aa8d6SNeel Natu * modification requires *all* vcpus to be frozen. 2489b1aa8d6SNeel Natu */ 2499b1aa8d6SNeel Natu int vm_mmap_getnext(struct vm *vm, vm_paddr_t *gpa, int *segid, 2509b1aa8d6SNeel Natu vm_ooffset_t *segoff, size_t *len, int *prot, int *flags); 2519b1aa8d6SNeel Natu int vm_get_memseg(struct vm *vm, int ident, size_t *len, bool *sysmem, 2529b1aa8d6SNeel Natu struct vm_object **objptr); 253147d12a7SAntoine Brodin vm_paddr_t vmm_sysmem_maxaddr(struct vm *vm); 254d3956e46SJohn Baldwin void *vm_gpa_hold(struct vcpu *vcpu, vm_paddr_t gpa, size_t len, 255d3956e46SJohn Baldwin int prot, void **cookie); 256d3956e46SJohn Baldwin void *vm_gpa_hold_global(struct vm *vm, vm_paddr_t gpa, size_t len, 2579b1aa8d6SNeel Natu int prot, void **cookie); 25828b561adSJohn Baldwin void *vm_gpa_hold_global(struct vm *vm, vm_paddr_t gpa, size_t len, 25928b561adSJohn Baldwin int prot, void **cookie); 260318224bbSNeel Natu void vm_gpa_release(void *cookie); 26180cb5d84SJohn Baldwin bool vm_mem_allocated(struct vcpu *vcpu, vm_paddr_t gpa); 2629b1aa8d6SNeel Natu 263d3956e46SJohn Baldwin int vm_get_register(struct vcpu *vcpu, int reg, uint64_t *retval); 264d3956e46SJohn Baldwin int vm_set_register(struct vcpu *vcpu, int reg, uint64_t val); 265d3956e46SJohn Baldwin int vm_get_seg_desc(struct vcpu *vcpu, int reg, 266366f6083SPeter Grehan struct seg_desc *ret_desc); 267366f6083SPeter Grehan int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 268366f6083SPeter Grehan struct seg_desc *desc); 269366f6083SPeter Grehan int vm_run(struct vm *vm, struct vm_run *vmrun); 270f0fdcfe2SNeel Natu int vm_suspend(struct vm *vm, enum vm_suspend_how how); 271366f6083SPeter Grehan int vm_inject_nmi(struct vm *vm, int vcpu); 27280cb5d84SJohn Baldwin int vm_nmi_pending(struct vcpu *vcpu); 27380cb5d84SJohn Baldwin void vm_nmi_clear(struct vcpu *vcpu); 2740775fbb4STycho Nightingale int vm_inject_extint(struct vm *vm, int vcpu); 27580cb5d84SJohn Baldwin int vm_extint_pending(struct vcpu *vcpu); 27680cb5d84SJohn Baldwin void vm_extint_clear(struct vcpu *vcpu); 277950af9ffSJohn Baldwin int vcpu_vcpuid(struct vcpu *vcpu); 278950af9ffSJohn Baldwin struct vm *vcpu_vm(struct vcpu *vcpu); 279950af9ffSJohn Baldwin struct vcpu *vm_vcpu(struct vm *vm, int cpu); 280d3956e46SJohn Baldwin struct vlapic *vm_lapic(struct vcpu *vcpu); 281565bbb86SNeel Natu struct vioapic *vm_ioapic(struct vm *vm); 28208e3ff32SNeel Natu struct vhpet *vm_hpet(struct vm *vm); 283366f6083SPeter Grehan int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 284366f6083SPeter Grehan int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 285e9027382SNeel Natu int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 286e9027382SNeel Natu int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 287565bbb86SNeel Natu int vm_apicid2vcpuid(struct vm *vm, int apicid); 28895ebc360SNeel Natu int vm_activate_cpu(struct vm *vm, int vcpu); 289fc276d92SJohn Baldwin int vm_suspend_cpu(struct vm *vm, int vcpu); 290fc276d92SJohn Baldwin int vm_resume_cpu(struct vm *vm, int vcpu); 291d3956e46SJohn Baldwin int vm_restart_instruction(struct vcpu *vcpu); 29280cb5d84SJohn Baldwin struct vm_exit *vm_exitinfo(struct vcpu *vcpu); 29380cb5d84SJohn Baldwin void vm_exit_suspended(struct vcpu *vcpu, uint64_t rip); 29480cb5d84SJohn Baldwin void vm_exit_debug(struct vcpu *vcpu, uint64_t rip); 29580cb5d84SJohn Baldwin void vm_exit_rendezvous(struct vcpu *vcpu, uint64_t rip); 29680cb5d84SJohn Baldwin void vm_exit_astpending(struct vcpu *vcpu, uint64_t rip); 29780cb5d84SJohn Baldwin void vm_exit_reqidle(struct vcpu *vcpu, uint64_t rip); 298483d953aSJohn Baldwin int vm_snapshot_req(struct vm *vm, struct vm_snapshot_meta *meta); 299483d953aSJohn Baldwin int vm_restore_time(struct vm *vm); 300483d953aSJohn Baldwin 3018325ce5cSNeel Natu #ifdef _SYS__CPUSET_H_ 302366f6083SPeter Grehan /* 3035b8a8cd1SNeel Natu * Rendezvous all vcpus specified in 'dest' and execute 'func(arg)'. 3045b8a8cd1SNeel Natu * The rendezvous 'func(arg)' is not allowed to do anything that will 3055b8a8cd1SNeel Natu * cause the thread to be put to sleep. 3065b8a8cd1SNeel Natu * 3075b8a8cd1SNeel Natu * If the rendezvous is being initiated from a vcpu context then the 3085b8a8cd1SNeel Natu * 'vcpuid' must refer to that vcpu, otherwise it should be set to -1. 3095b8a8cd1SNeel Natu * 3105b8a8cd1SNeel Natu * The caller cannot hold any locks when initiating the rendezvous. 3115b8a8cd1SNeel Natu * 3125b8a8cd1SNeel Natu * The implementation of this API may cause vcpus other than those specified 3135b8a8cd1SNeel Natu * by 'dest' to be stalled. The caller should not rely on any vcpus making 3145b8a8cd1SNeel Natu * forward progress when the rendezvous is in progress. 3155b8a8cd1SNeel Natu */ 316d8be3d52SJohn Baldwin typedef void (*vm_rendezvous_func_t)(struct vcpu *vcpu, void *arg); 317d8be3d52SJohn Baldwin int vm_smp_rendezvous(struct vcpu *vcpu, cpuset_t dest, 3185b8a8cd1SNeel Natu vm_rendezvous_func_t func, void *arg); 3198325ce5cSNeel Natu cpuset_t vm_active_cpus(struct vm *vm); 320fc276d92SJohn Baldwin cpuset_t vm_debug_cpus(struct vm *vm); 3218325ce5cSNeel Natu cpuset_t vm_suspended_cpus(struct vm *vm); 3228325ce5cSNeel Natu #endif /* _SYS__CPUSET_H_ */ 3235b8a8cd1SNeel Natu 3245b8a8cd1SNeel Natu static __inline int 325248e6799SNeel Natu vcpu_rendezvous_pending(struct vm_eventinfo *info) 3265b8a8cd1SNeel Natu { 3275b8a8cd1SNeel Natu 328248e6799SNeel Natu return (*((uintptr_t *)(info->rptr)) != 0); 3295b8a8cd1SNeel Natu } 3305b8a8cd1SNeel Natu 331b15a09c0SNeel Natu static __inline int 332248e6799SNeel Natu vcpu_suspended(struct vm_eventinfo *info) 333b15a09c0SNeel Natu { 334b15a09c0SNeel Natu 335248e6799SNeel Natu return (*info->sptr); 336248e6799SNeel Natu } 337248e6799SNeel Natu 338248e6799SNeel Natu static __inline int 339248e6799SNeel Natu vcpu_reqidle(struct vm_eventinfo *info) 340248e6799SNeel Natu { 341248e6799SNeel Natu 342248e6799SNeel Natu return (*info->iptr); 343b15a09c0SNeel Natu } 344b15a09c0SNeel Natu 34580cb5d84SJohn Baldwin int vcpu_debugged(struct vcpu *vcpu); 346fc276d92SJohn Baldwin 3475b8a8cd1SNeel Natu /* 348490d56c5SEd Maste * Return true if device indicated by bus/slot/func is supposed to be a 349366f6083SPeter Grehan * pci passthrough device. 350366f6083SPeter Grehan * 351490d56c5SEd Maste * Return false otherwise. 352366f6083SPeter Grehan */ 353490d56c5SEd Maste bool vmm_is_pptdev(int bus, int slot, int func); 354366f6083SPeter Grehan 355366f6083SPeter Grehan void *vm_iommu_domain(struct vm *vm); 356366f6083SPeter Grehan 35775dd3366SNeel Natu enum vcpu_state { 35875dd3366SNeel Natu VCPU_IDLE, 359318224bbSNeel Natu VCPU_FROZEN, 36075dd3366SNeel Natu VCPU_RUNNING, 361318224bbSNeel Natu VCPU_SLEEPING, 36275dd3366SNeel Natu }; 363366f6083SPeter Grehan 364f80330a8SNeel Natu int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state, 365f80330a8SNeel Natu bool from_idle); 366d3956e46SJohn Baldwin enum vcpu_state vcpu_get_state(struct vcpu *vcpu, int *hostcpu); 367366f6083SPeter Grehan 368366f6083SPeter Grehan static int __inline 36980cb5d84SJohn Baldwin vcpu_is_running(struct vcpu *vcpu, int *hostcpu) 370366f6083SPeter Grehan { 37180cb5d84SJohn Baldwin return (vcpu_get_state(vcpu, hostcpu) == VCPU_RUNNING); 372366f6083SPeter Grehan } 373366f6083SPeter Grehan 374f008d157SNeel Natu #ifdef _SYS_PROC_H_ 375f008d157SNeel Natu static int __inline 37680cb5d84SJohn Baldwin vcpu_should_yield(struct vcpu *vcpu) 377f008d157SNeel Natu { 378c6d31b83SKonstantin Belousov struct thread *td; 379ede04033SNeel Natu 380c6d31b83SKonstantin Belousov td = curthread; 381c6d31b83SKonstantin Belousov return (td->td_ast != 0 || td->td_owepreempt != 0); 382f008d157SNeel Natu } 383f008d157SNeel Natu #endif 384f008d157SNeel Natu 3853dc3d32aSJohn Baldwin void *vcpu_stats(struct vcpu *vcpu); 386de5ea6b6SNeel Natu void vcpu_notify_event(struct vm *vm, int vcpuid, bool lapic_intr); 387318224bbSNeel Natu struct vmspace *vm_get_vmspace(struct vm *vm); 388762fd208STycho Nightingale struct vatpic *vm_atpic(struct vm *vm); 389e883c9bbSTycho Nightingale struct vatpit *vm_atpit(struct vm *vm); 390160ef77aSNeel Natu struct vpmtmr *vm_pmtmr(struct vm *vm); 3910dafa5cdSNeel Natu struct vrtc *vm_rtc(struct vm *vm); 392dc506506SNeel Natu 393dc506506SNeel Natu /* 394c9c75df4SNeel Natu * Inject exception 'vector' into the guest vcpu. This function returns 0 on 395dc506506SNeel Natu * success and non-zero on failure. 396dc506506SNeel Natu * 397dc506506SNeel Natu * Wrapper functions like 'vm_inject_gp()' should be preferred to calling 398dc506506SNeel Natu * this function directly because they enforce the trap-like or fault-like 399dc506506SNeel Natu * behavior of an exception. 400dc506506SNeel Natu * 401dc506506SNeel Natu * This function should only be called in the context of the thread that is 402dc506506SNeel Natu * executing this vcpu. 403dc506506SNeel Natu */ 404d3956e46SJohn Baldwin int vm_inject_exception(struct vcpu *vcpu, int vector, int err_valid, 405c9c75df4SNeel Natu uint32_t errcode, int restart_instruction); 406dc506506SNeel Natu 407dc506506SNeel Natu /* 408091d4532SNeel Natu * This function is called after a VM-exit that occurred during exception or 409091d4532SNeel Natu * interrupt delivery through the IDT. The format of 'intinfo' is described 410091d4532SNeel Natu * in Figure 15-1, "EXITINTINFO for All Intercepts", APM, Vol 2. 411dc506506SNeel Natu * 412091d4532SNeel Natu * If a VM-exit handler completes the event delivery successfully then it 413091d4532SNeel Natu * should call vm_exit_intinfo() to extinguish the pending event. For e.g., 414091d4532SNeel Natu * if the task switch emulation is triggered via a task gate then it should 415091d4532SNeel Natu * call this function with 'intinfo=0' to indicate that the external event 416091d4532SNeel Natu * is not pending anymore. 417091d4532SNeel Natu * 418091d4532SNeel Natu * Return value is 0 on success and non-zero on failure. 419dc506506SNeel Natu */ 42080cb5d84SJohn Baldwin int vm_exit_intinfo(struct vcpu *vcpu, uint64_t intinfo); 421091d4532SNeel Natu 422091d4532SNeel Natu /* 423091d4532SNeel Natu * This function is called before every VM-entry to retrieve a pending 424091d4532SNeel Natu * event that should be injected into the guest. This function combines 425091d4532SNeel Natu * nested events into a double or triple fault. 426091d4532SNeel Natu * 427091d4532SNeel Natu * Returns 0 if there are no events that need to be injected into the guest 428091d4532SNeel Natu * and non-zero otherwise. 429091d4532SNeel Natu */ 43080cb5d84SJohn Baldwin int vm_entry_intinfo(struct vcpu *vcpu, uint64_t *info); 431091d4532SNeel Natu 432091d4532SNeel Natu int vm_get_intinfo(struct vm *vm, int vcpuid, uint64_t *info1, uint64_t *info2); 433dc506506SNeel Natu 434483d953aSJohn Baldwin /* 435483d953aSJohn Baldwin * Function used to keep track of the guest's TSC offset. The 436483d953aSJohn Baldwin * offset is used by the virutalization extensions to provide a consistent 437483d953aSJohn Baldwin * value for the Time Stamp Counter to the guest. 438483d953aSJohn Baldwin */ 43980cb5d84SJohn Baldwin void vm_set_tsc_offset(struct vcpu *vcpu, uint64_t offset); 440483d953aSJohn Baldwin 441d17b5104SNeel Natu enum vm_reg_name vm_segment_name(int seg_encoding); 442d17b5104SNeel Natu 443d665d229SNeel Natu struct vm_copyinfo { 444d665d229SNeel Natu uint64_t gpa; 445d665d229SNeel Natu size_t len; 446d665d229SNeel Natu void *hva; 447d665d229SNeel Natu void *cookie; 448d665d229SNeel Natu }; 449d665d229SNeel Natu 450d665d229SNeel Natu /* 451d665d229SNeel Natu * Set up 'copyinfo[]' to copy to/from guest linear address space starting 452d665d229SNeel Natu * at 'gla' and 'len' bytes long. The 'prot' should be set to PROT_READ for 453d665d229SNeel Natu * a copyin or PROT_WRITE for a copyout. 454d665d229SNeel Natu * 455edafb5a3SPedro F. Giffuni * retval is_fault Interpretation 4569c4d5478SNeel Natu * 0 0 Success 4579c4d5478SNeel Natu * 0 1 An exception was injected into the guest 4589c4d5478SNeel Natu * EFAULT N/A Unrecoverable error 459d665d229SNeel Natu * 460d665d229SNeel Natu * The 'copyinfo[]' can be passed to 'vm_copyin()' or 'vm_copyout()' only if 461d665d229SNeel Natu * the return value is 0. The 'copyinfo[]' resources should be freed by calling 462d665d229SNeel Natu * 'vm_copy_teardown()' after the copy is done. 463d665d229SNeel Natu */ 464d3956e46SJohn Baldwin int vm_copy_setup(struct vcpu *vcpu, struct vm_guest_paging *paging, 465d665d229SNeel Natu uint64_t gla, size_t len, int prot, struct vm_copyinfo *copyinfo, 4669c4d5478SNeel Natu int num_copyinfo, int *is_fault); 4672b4fe856SJohn Baldwin void vm_copy_teardown(struct vm_copyinfo *copyinfo, int num_copyinfo); 4682b4fe856SJohn Baldwin void vm_copyin(struct vm_copyinfo *copyinfo, void *kaddr, size_t len); 4692b4fe856SJohn Baldwin void vm_copyout(const void *kaddr, struct vm_copyinfo *copyinfo, size_t len); 470b0538143SNeel Natu 47180cb5d84SJohn Baldwin int vcpu_trace_exceptions(struct vcpu *vcpu); 47280cb5d84SJohn Baldwin int vcpu_trap_wbinvd(struct vcpu *vcpu); 473366f6083SPeter Grehan #endif /* KERNEL */ 474366f6083SPeter Grehan 475f1d450ddSJohn Baldwin #ifdef _KERNEL 4768d39ed16SPeter Grehan #define VM_MAXCPU 16 /* maximum virtual cpus */ 477f1d450ddSJohn Baldwin #endif 478366f6083SPeter Grehan 479366f6083SPeter Grehan /* 480366f6083SPeter Grehan * Identifiers for optional vmm capabilities 481366f6083SPeter Grehan */ 482366f6083SPeter Grehan enum vm_cap_type { 483366f6083SPeter Grehan VM_CAP_HALT_EXIT, 484366f6083SPeter Grehan VM_CAP_MTRAP_EXIT, 485366f6083SPeter Grehan VM_CAP_PAUSE_EXIT, 486366f6083SPeter Grehan VM_CAP_UNRESTRICTED_GUEST, 48749cc03daSNeel Natu VM_CAP_ENABLE_INVPCID, 488cbd03a9dSJohn Baldwin VM_CAP_BPT_EXIT, 489f5f5f1e7SPeter Grehan VM_CAP_RDPID, 490f5f5f1e7SPeter Grehan VM_CAP_RDTSCP, 4910bda8d3eSCorvin Köhne VM_CAP_IPI_EXIT, 492366f6083SPeter Grehan VM_CAP_MAX 493366f6083SPeter Grehan }; 494366f6083SPeter Grehan 495b3e9732aSJohn Baldwin enum vm_intr_trigger { 496b3e9732aSJohn Baldwin EDGE_TRIGGER, 497b3e9732aSJohn Baldwin LEVEL_TRIGGER 498b3e9732aSJohn Baldwin }; 499b3e9732aSJohn Baldwin 500366f6083SPeter Grehan /* 501366f6083SPeter Grehan * The 'access' field has the format specified in Table 21-2 of the Intel 502366f6083SPeter Grehan * Architecture Manual vol 3b. 503366f6083SPeter Grehan * 504366f6083SPeter Grehan * XXX The contents of the 'access' field are architecturally defined except 505366f6083SPeter Grehan * bit 16 - Segment Unusable. 506366f6083SPeter Grehan */ 507366f6083SPeter Grehan struct seg_desc { 508366f6083SPeter Grehan uint64_t base; 509366f6083SPeter Grehan uint32_t limit; 510366f6083SPeter Grehan uint32_t access; 511366f6083SPeter Grehan }; 512f7a9f178SNeel Natu #define SEG_DESC_TYPE(access) ((access) & 0x001f) 5133d5444c8SNeel Natu #define SEG_DESC_DPL(access) (((access) >> 5) & 0x3) 514f7a9f178SNeel Natu #define SEG_DESC_PRESENT(access) (((access) & 0x0080) ? 1 : 0) 515f7a9f178SNeel Natu #define SEG_DESC_DEF32(access) (((access) & 0x4000) ? 1 : 0) 516f7a9f178SNeel Natu #define SEG_DESC_GRANULARITY(access) (((access) & 0x8000) ? 1 : 0) 517f7a9f178SNeel Natu #define SEG_DESC_UNUSABLE(access) (((access) & 0x10000) ? 1 : 0) 518366f6083SPeter Grehan 519e813a873SNeel Natu enum vm_cpu_mode { 520b301b9e2SNeel Natu CPU_MODE_REAL, 521b301b9e2SNeel Natu CPU_MODE_PROTECTED, 522e813a873SNeel Natu CPU_MODE_COMPATIBILITY, /* IA-32E mode (CS.L = 0) */ 523e813a873SNeel Natu CPU_MODE_64BIT, /* IA-32E mode (CS.L = 1) */ 524e813a873SNeel Natu }; 525e813a873SNeel Natu 526e813a873SNeel Natu enum vm_paging_mode { 527e813a873SNeel Natu PAGING_MODE_FLAT, 528e813a873SNeel Natu PAGING_MODE_32, 529e813a873SNeel Natu PAGING_MODE_PAE, 530e813a873SNeel Natu PAGING_MODE_64, 531f3eb12e4SKonstantin Belousov PAGING_MODE_64_LA57, 532e813a873SNeel Natu }; 533e813a873SNeel Natu 534e813a873SNeel Natu struct vm_guest_paging { 535e813a873SNeel Natu uint64_t cr3; 536e813a873SNeel Natu int cpl; 537e813a873SNeel Natu enum vm_cpu_mode cpu_mode; 538e813a873SNeel Natu enum vm_paging_mode paging_mode; 539e813a873SNeel Natu }; 540e813a873SNeel Natu 541e813a873SNeel Natu /* 542e813a873SNeel Natu * The data structures 'vie' and 'vie_op' are meant to be opaque to the 543e813a873SNeel Natu * consumers of instruction decoding. The only reason why their contents 544e813a873SNeel Natu * need to be exposed is because they are part of the 'vm_exit' structure. 545e813a873SNeel Natu */ 546e813a873SNeel Natu struct vie_op { 547e813a873SNeel Natu uint8_t op_byte; /* actual opcode byte */ 548e813a873SNeel Natu uint8_t op_type; /* type of operation (e.g. MOV) */ 549e813a873SNeel Natu uint16_t op_flags; 550e813a873SNeel Natu }; 551497cb925SConrad Meyer _Static_assert(sizeof(struct vie_op) == 4, "ABI"); 552497cb925SConrad Meyer _Static_assert(_Alignof(struct vie_op) == 2, "ABI"); 553e813a873SNeel Natu 554e813a873SNeel Natu #define VIE_INST_SIZE 15 555e813a873SNeel Natu struct vie { 556e813a873SNeel Natu uint8_t inst[VIE_INST_SIZE]; /* instruction bytes */ 557e813a873SNeel Natu uint8_t num_valid; /* size of the instruction */ 5584daa95f8SConrad Meyer 5594daa95f8SConrad Meyer /* The following fields are all zeroed upon restart. */ 5604daa95f8SConrad Meyer #define vie_startzero num_processed 561e813a873SNeel Natu uint8_t num_processed; 562e813a873SNeel Natu 563f7a9f178SNeel Natu uint8_t addrsize:4, opsize:4; /* address and operand sizes */ 564e813a873SNeel Natu uint8_t rex_w:1, /* REX prefix */ 565e813a873SNeel Natu rex_r:1, 566e813a873SNeel Natu rex_x:1, 567e813a873SNeel Natu rex_b:1, 568f7a9f178SNeel Natu rex_present:1, 56975346353SNeel Natu repz_present:1, /* REP/REPE/REPZ prefix */ 57075346353SNeel Natu repnz_present:1, /* REPNE/REPNZ prefix */ 571f7a9f178SNeel Natu opsize_override:1, /* Operand size override */ 57275346353SNeel Natu addrsize_override:1, /* Address size override */ 57375346353SNeel Natu segment_override:1; /* Segment override */ 574e813a873SNeel Natu 575e813a873SNeel Natu uint8_t mod:2, /* ModRM byte */ 576e813a873SNeel Natu reg:4, 577e813a873SNeel Natu rm:4; 578e813a873SNeel Natu 579e813a873SNeel Natu uint8_t ss:2, /* SIB byte */ 580cfdea69dSConrad Meyer vex_present:1, /* VEX prefixed */ 581cfdea69dSConrad Meyer vex_l:1, /* L bit */ 582497cb925SConrad Meyer index:4, /* SIB byte */ 583497cb925SConrad Meyer base:4; /* SIB byte */ 584e813a873SNeel Natu 585e813a873SNeel Natu uint8_t disp_bytes; 586e813a873SNeel Natu uint8_t imm_bytes; 587e813a873SNeel Natu 588e813a873SNeel Natu uint8_t scale; 589497cb925SConrad Meyer 590cfdea69dSConrad Meyer uint8_t vex_reg:4, /* vvvv: first source register specifier */ 591cfdea69dSConrad Meyer vex_pp:2, /* pp */ 592cfdea69dSConrad Meyer _sparebits:2; 593cfdea69dSConrad Meyer 594cfdea69dSConrad Meyer uint8_t _sparebytes[2]; 595497cb925SConrad Meyer 596e813a873SNeel Natu int base_register; /* VM_REG_GUEST_xyz */ 597e813a873SNeel Natu int index_register; /* VM_REG_GUEST_xyz */ 59875346353SNeel Natu int segment_register; /* VM_REG_GUEST_xyz */ 599e813a873SNeel Natu 600e813a873SNeel Natu int64_t displacement; /* optional addr displacement */ 601e813a873SNeel Natu int64_t immediate; /* optional immediate operand */ 602e813a873SNeel Natu 603e813a873SNeel Natu uint8_t decoded; /* set to 1 if successfully decoded */ 604e813a873SNeel Natu 605497cb925SConrad Meyer uint8_t _sparebyte; 606497cb925SConrad Meyer 607e813a873SNeel Natu struct vie_op op; /* opcode description */ 608e813a873SNeel Natu }; 609497cb925SConrad Meyer _Static_assert(sizeof(struct vie) == 64, "ABI"); 610497cb925SConrad Meyer _Static_assert(__offsetof(struct vie, disp_bytes) == 22, "ABI"); 611497cb925SConrad Meyer _Static_assert(__offsetof(struct vie, scale) == 24, "ABI"); 612497cb925SConrad Meyer _Static_assert(__offsetof(struct vie, base_register) == 28, "ABI"); 613e813a873SNeel Natu 614366f6083SPeter Grehan enum vm_exitcode { 615366f6083SPeter Grehan VM_EXITCODE_INOUT, 616366f6083SPeter Grehan VM_EXITCODE_VMX, 617366f6083SPeter Grehan VM_EXITCODE_BOGUS, 618366f6083SPeter Grehan VM_EXITCODE_RDMSR, 619366f6083SPeter Grehan VM_EXITCODE_WRMSR, 620366f6083SPeter Grehan VM_EXITCODE_HLT, 621366f6083SPeter Grehan VM_EXITCODE_MTRAP, 622366f6083SPeter Grehan VM_EXITCODE_PAUSE, 623cd942e0fSPeter Grehan VM_EXITCODE_PAGING, 624318224bbSNeel Natu VM_EXITCODE_INST_EMUL, 625edf89256SNeel Natu VM_EXITCODE_SPINUP_AP, 626c6a0cc2eSNeel Natu VM_EXITCODE_DEPRECATED1, /* used to be SPINDOWN_CPU */ 6275b8a8cd1SNeel Natu VM_EXITCODE_RENDEZVOUS, 62830b94db8SNeel Natu VM_EXITCODE_IOAPIC_EOI, 629b15a09c0SNeel Natu VM_EXITCODE_SUSPENDED, 630d17b5104SNeel Natu VM_EXITCODE_INOUT_STR, 6313d5444c8SNeel Natu VM_EXITCODE_TASK_SWITCH, 63265145c7fSNeel Natu VM_EXITCODE_MONITOR, 63365145c7fSNeel Natu VM_EXITCODE_MWAIT, 634bbadcde4SNeel Natu VM_EXITCODE_SVM, 635248e6799SNeel Natu VM_EXITCODE_REQIDLE, 636fc276d92SJohn Baldwin VM_EXITCODE_DEBUG, 63727d26457SAndrew Turner VM_EXITCODE_VMINSN, 638cbd03a9dSJohn Baldwin VM_EXITCODE_BPT, 6390bda8d3eSCorvin Köhne VM_EXITCODE_IPI, 640cd942e0fSPeter Grehan VM_EXITCODE_MAX 641366f6083SPeter Grehan }; 642366f6083SPeter Grehan 643d17b5104SNeel Natu struct vm_inout { 644d17b5104SNeel Natu uint16_t bytes:3; /* 1 or 2 or 4 */ 645d17b5104SNeel Natu uint16_t in:1; 646d17b5104SNeel Natu uint16_t string:1; 647d17b5104SNeel Natu uint16_t rep:1; 648d17b5104SNeel Natu uint16_t port; 649d17b5104SNeel Natu uint32_t eax; /* valid for out */ 650d17b5104SNeel Natu }; 651d17b5104SNeel Natu 652d17b5104SNeel Natu struct vm_inout_str { 653d17b5104SNeel Natu struct vm_inout inout; /* must be the first element */ 654e813a873SNeel Natu struct vm_guest_paging paging; 655d17b5104SNeel Natu uint64_t rflags; 656d17b5104SNeel Natu uint64_t cr0; 657d17b5104SNeel Natu uint64_t index; 658d17b5104SNeel Natu uint64_t count; /* rep=1 (%rcx), rep=0 (1) */ 659d17b5104SNeel Natu int addrsize; 660d17b5104SNeel Natu enum vm_reg_name seg_name; 661d17b5104SNeel Natu struct seg_desc seg_desc; 662d17b5104SNeel Natu }; 663d17b5104SNeel Natu 6643d5444c8SNeel Natu enum task_switch_reason { 6653d5444c8SNeel Natu TSR_CALL, 6663d5444c8SNeel Natu TSR_IRET, 6673d5444c8SNeel Natu TSR_JMP, 6683d5444c8SNeel Natu TSR_IDT_GATE, /* task gate in IDT */ 6693d5444c8SNeel Natu }; 6703d5444c8SNeel Natu 6713d5444c8SNeel Natu struct vm_task_switch { 6723d5444c8SNeel Natu uint16_t tsssel; /* new TSS selector */ 6733d5444c8SNeel Natu int ext; /* task switch due to external event */ 6743d5444c8SNeel Natu uint32_t errcode; 6753d5444c8SNeel Natu int errcode_valid; /* push 'errcode' on the new stack */ 6763d5444c8SNeel Natu enum task_switch_reason reason; 6773d5444c8SNeel Natu struct vm_guest_paging paging; 6783d5444c8SNeel Natu }; 6793d5444c8SNeel Natu 680366f6083SPeter Grehan struct vm_exit { 681366f6083SPeter Grehan enum vm_exitcode exitcode; 682366f6083SPeter Grehan int inst_length; /* 0 means unknown */ 683366f6083SPeter Grehan uint64_t rip; 684366f6083SPeter Grehan union { 685d17b5104SNeel Natu struct vm_inout inout; 686d17b5104SNeel Natu struct vm_inout_str inout_str; 687cd942e0fSPeter Grehan struct { 68813ec9371SPeter Grehan uint64_t gpa; 689318224bbSNeel Natu int fault_type; 690cd942e0fSPeter Grehan } paging; 691318224bbSNeel Natu struct { 692318224bbSNeel Natu uint64_t gpa; 693318224bbSNeel Natu uint64_t gla; 694e4f605eeSTycho Nightingale uint64_t cs_base; 695f7a9f178SNeel Natu int cs_d; /* CS.D */ 696e813a873SNeel Natu struct vm_guest_paging paging; 697318224bbSNeel Natu struct vie vie; 698318224bbSNeel Natu } inst_emul; 699366f6083SPeter Grehan /* 700366f6083SPeter Grehan * VMX specific payload. Used when there is no "better" 701366f6083SPeter Grehan * exitcode to represent the VM-exit. 702366f6083SPeter Grehan */ 703366f6083SPeter Grehan struct { 7040492757cSNeel Natu int status; /* vmx inst status */ 7050492757cSNeel Natu /* 7060492757cSNeel Natu * 'exit_reason' and 'exit_qualification' are valid 7070492757cSNeel Natu * only if 'status' is zero. 7080492757cSNeel Natu */ 709366f6083SPeter Grehan uint32_t exit_reason; 710366f6083SPeter Grehan uint64_t exit_qualification; 7110492757cSNeel Natu /* 7120492757cSNeel Natu * 'inst_error' and 'inst_type' are valid 7130492757cSNeel Natu * only if 'status' is non-zero. 7140492757cSNeel Natu */ 7150492757cSNeel Natu int inst_type; 7160492757cSNeel Natu int inst_error; 717366f6083SPeter Grehan } vmx; 718bbadcde4SNeel Natu /* 719bbadcde4SNeel Natu * SVM specific payload. 720bbadcde4SNeel Natu */ 721bbadcde4SNeel Natu struct { 722bbadcde4SNeel Natu uint64_t exitcode; 723bbadcde4SNeel Natu uint64_t exitinfo1; 724bbadcde4SNeel Natu uint64_t exitinfo2; 725bbadcde4SNeel Natu } svm; 726366f6083SPeter Grehan struct { 727cbd03a9dSJohn Baldwin int inst_length; 728cbd03a9dSJohn Baldwin } bpt; 729cbd03a9dSJohn Baldwin struct { 730366f6083SPeter Grehan uint32_t code; /* ecx value */ 731366f6083SPeter Grehan uint64_t wval; 732366f6083SPeter Grehan } msr; 733edf89256SNeel Natu struct { 734edf89256SNeel Natu int vcpu; 735edf89256SNeel Natu uint64_t rip; 736edf89256SNeel Natu } spinup_ap; 7371c052192SNeel Natu struct { 7381c052192SNeel Natu uint64_t rflags; 739490768e2STycho Nightingale uint64_t intr_status; 7401c052192SNeel Natu } hlt; 74130b94db8SNeel Natu struct { 74230b94db8SNeel Natu int vector; 74330b94db8SNeel Natu } ioapic_eoi; 744f0fdcfe2SNeel Natu struct { 745f0fdcfe2SNeel Natu enum vm_suspend_how how; 746f0fdcfe2SNeel Natu } suspended; 7470bda8d3eSCorvin Köhne struct { 7480bda8d3eSCorvin Köhne uint32_t mode; 7490bda8d3eSCorvin Köhne uint8_t vector; 7500bda8d3eSCorvin Köhne cpuset_t dmask; 7510bda8d3eSCorvin Köhne } ipi; 7523d5444c8SNeel Natu struct vm_task_switch task_switch; 753366f6083SPeter Grehan } u; 754366f6083SPeter Grehan }; 755366f6083SPeter Grehan 756d37f2adbSNeel Natu /* APIs to inject faults into the guest */ 757d3956e46SJohn Baldwin #ifdef _KERNEL 758d3956e46SJohn Baldwin void vm_inject_fault(struct vcpu *vcpu, int vector, int errcode_valid, 759d3956e46SJohn Baldwin int errcode); 760d3956e46SJohn Baldwin 761d3956e46SJohn Baldwin static __inline void 762d3956e46SJohn Baldwin vm_inject_ud(struct vcpu *vcpu) 763d3956e46SJohn Baldwin { 764d3956e46SJohn Baldwin vm_inject_fault(vcpu, IDT_UD, 0, 0); 765d3956e46SJohn Baldwin } 766d3956e46SJohn Baldwin 767d3956e46SJohn Baldwin static __inline void 768d3956e46SJohn Baldwin vm_inject_gp(struct vcpu *vcpu) 769d3956e46SJohn Baldwin { 770d3956e46SJohn Baldwin vm_inject_fault(vcpu, IDT_GP, 1, 0); 771d3956e46SJohn Baldwin } 772d3956e46SJohn Baldwin 773d3956e46SJohn Baldwin static __inline void 774d3956e46SJohn Baldwin vm_inject_ac(struct vcpu *vcpu, int errcode) 775d3956e46SJohn Baldwin { 776d3956e46SJohn Baldwin vm_inject_fault(vcpu, IDT_AC, 1, errcode); 777d3956e46SJohn Baldwin } 778d3956e46SJohn Baldwin 779d3956e46SJohn Baldwin static __inline void 780d3956e46SJohn Baldwin vm_inject_ss(struct vcpu *vcpu, int errcode) 781d3956e46SJohn Baldwin { 782d3956e46SJohn Baldwin vm_inject_fault(vcpu, IDT_SS, 1, errcode); 783d3956e46SJohn Baldwin } 784d3956e46SJohn Baldwin 785d3956e46SJohn Baldwin void vm_inject_pf(struct vcpu *vcpu, int error_code, uint64_t cr2); 786d3956e46SJohn Baldwin #else 787d37f2adbSNeel Natu void vm_inject_fault(void *vm, int vcpuid, int vector, int errcode_valid, 788d37f2adbSNeel Natu int errcode); 789d37f2adbSNeel Natu 7907f21538bSPeter Grehan static __inline void 79180cb5d84SJohn Baldwin vm_inject_ud(struct vcpu *vcpu) 792d37f2adbSNeel Natu { 79380cb5d84SJohn Baldwin vm_inject_fault(vcpu, IDT_UD, 0, 0); 794d37f2adbSNeel Natu } 795d37f2adbSNeel Natu 7967f21538bSPeter Grehan static __inline void 79780cb5d84SJohn Baldwin vm_inject_gp(struct vcpu *vcpu) 798d37f2adbSNeel Natu { 79980cb5d84SJohn Baldwin vm_inject_fault(vcpu, IDT_GP, 1, 0); 800d37f2adbSNeel Natu } 801d37f2adbSNeel Natu 8027f21538bSPeter Grehan static __inline void 80380cb5d84SJohn Baldwin vm_inject_ac(struct vcpu *vcpu, int errcode) 804d37f2adbSNeel Natu { 80580cb5d84SJohn Baldwin vm_inject_fault(vcpu, IDT_AC, 1, errcode); 806d37f2adbSNeel Natu } 807d37f2adbSNeel Natu 8087f21538bSPeter Grehan static __inline void 80980cb5d84SJohn Baldwin vm_inject_ss(struct vcpu *vcpu, int errcode) 810d37f2adbSNeel Natu { 81180cb5d84SJohn Baldwin vm_inject_fault(vcpu, IDT_SS, 1, errcode); 812d37f2adbSNeel Natu } 813d37f2adbSNeel Natu 814d37f2adbSNeel Natu void vm_inject_pf(void *vm, int vcpuid, int error_code, uint64_t cr2); 815d3956e46SJohn Baldwin #endif 816c9c75df4SNeel Natu 817366f6083SPeter Grehan #endif /* _VMM_H_ */ 818