1366f6083SPeter Grehan /*- 2366f6083SPeter Grehan * Copyright (c) 2011 NetApp, Inc. 3366f6083SPeter Grehan * All rights reserved. 4366f6083SPeter Grehan * 5366f6083SPeter Grehan * Redistribution and use in source and binary forms, with or without 6366f6083SPeter Grehan * modification, are permitted provided that the following conditions 7366f6083SPeter Grehan * are met: 8366f6083SPeter Grehan * 1. Redistributions of source code must retain the above copyright 9366f6083SPeter Grehan * notice, this list of conditions and the following disclaimer. 10366f6083SPeter Grehan * 2. Redistributions in binary form must reproduce the above copyright 11366f6083SPeter Grehan * notice, this list of conditions and the following disclaimer in the 12366f6083SPeter Grehan * documentation and/or other materials provided with the distribution. 13366f6083SPeter Grehan * 14366f6083SPeter Grehan * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 15366f6083SPeter Grehan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16366f6083SPeter Grehan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17366f6083SPeter Grehan * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 18366f6083SPeter Grehan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19366f6083SPeter Grehan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20366f6083SPeter Grehan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21366f6083SPeter Grehan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22366f6083SPeter Grehan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23366f6083SPeter Grehan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24366f6083SPeter Grehan * SUCH DAMAGE. 25366f6083SPeter Grehan * 26912a3e67SNeel Natu * $FreeBSD$ 27366f6083SPeter Grehan */ 28366f6083SPeter Grehan 29366f6083SPeter Grehan #ifndef _VMM_H_ 30366f6083SPeter Grehan #define _VMM_H_ 31366f6083SPeter Grehan 32366f6083SPeter Grehan #ifdef _KERNEL 33366f6083SPeter Grehan 34366f6083SPeter Grehan #define VM_MAX_NAMELEN 32 35366f6083SPeter Grehan 36366f6083SPeter Grehan struct vm; 37366f6083SPeter Grehan struct vm_memory_segment; 38366f6083SPeter Grehan struct seg_desc; 39366f6083SPeter Grehan struct vm_exit; 40366f6083SPeter Grehan struct vm_run; 41366f6083SPeter Grehan struct vlapic; 42318224bbSNeel Natu struct vmspace; 43318224bbSNeel Natu struct vm_object; 44318224bbSNeel Natu struct pmap; 45366f6083SPeter Grehan 46e9027382SNeel Natu enum x2apic_state; 47e9027382SNeel Natu 48366f6083SPeter Grehan typedef int (*vmm_init_func_t)(void); 49366f6083SPeter Grehan typedef int (*vmm_cleanup_func_t)(void); 50318224bbSNeel Natu typedef void * (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap); 51318224bbSNeel Natu typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip, 52318224bbSNeel Natu struct pmap *pmap); 53366f6083SPeter Grehan typedef void (*vmi_cleanup_func_t)(void *vmi); 54366f6083SPeter Grehan typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 55366f6083SPeter Grehan uint64_t *retval); 56366f6083SPeter Grehan typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 57366f6083SPeter Grehan uint64_t val); 58366f6083SPeter Grehan typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 59366f6083SPeter Grehan struct seg_desc *desc); 60366f6083SPeter Grehan typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 61366f6083SPeter Grehan struct seg_desc *desc); 62366f6083SPeter Grehan typedef int (*vmi_inject_event_t)(void *vmi, int vcpu, 63366f6083SPeter Grehan int type, int vector, 64366f6083SPeter Grehan uint32_t code, int code_valid); 65366f6083SPeter Grehan typedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval); 66366f6083SPeter Grehan typedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val); 67318224bbSNeel Natu typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max); 68318224bbSNeel Natu typedef void (*vmi_vmspace_free)(struct vmspace *vmspace); 69366f6083SPeter Grehan 70366f6083SPeter Grehan struct vmm_ops { 71366f6083SPeter Grehan vmm_init_func_t init; /* module wide initialization */ 72366f6083SPeter Grehan vmm_cleanup_func_t cleanup; 73366f6083SPeter Grehan 74366f6083SPeter Grehan vmi_init_func_t vminit; /* vm-specific initialization */ 75366f6083SPeter Grehan vmi_run_func_t vmrun; 76366f6083SPeter Grehan vmi_cleanup_func_t vmcleanup; 77366f6083SPeter Grehan vmi_get_register_t vmgetreg; 78366f6083SPeter Grehan vmi_set_register_t vmsetreg; 79366f6083SPeter Grehan vmi_get_desc_t vmgetdesc; 80366f6083SPeter Grehan vmi_set_desc_t vmsetdesc; 81366f6083SPeter Grehan vmi_inject_event_t vminject; 82366f6083SPeter Grehan vmi_get_cap_t vmgetcap; 83366f6083SPeter Grehan vmi_set_cap_t vmsetcap; 84318224bbSNeel Natu vmi_vmspace_alloc vmspace_alloc; 85318224bbSNeel Natu vmi_vmspace_free vmspace_free; 86366f6083SPeter Grehan }; 87366f6083SPeter Grehan 88366f6083SPeter Grehan extern struct vmm_ops vmm_ops_intel; 89366f6083SPeter Grehan extern struct vmm_ops vmm_ops_amd; 90366f6083SPeter Grehan 91d5408b1dSNeel Natu int vm_create(const char *name, struct vm **retvm); 92366f6083SPeter Grehan void vm_destroy(struct vm *vm); 93366f6083SPeter Grehan const char *vm_name(struct vm *vm); 94341f19c9SNeel Natu int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len); 95366f6083SPeter Grehan int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 96366f6083SPeter Grehan int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 97318224bbSNeel Natu void *vm_gpa_hold(struct vm *, vm_paddr_t gpa, size_t len, int prot, 98318224bbSNeel Natu void **cookie); 99318224bbSNeel Natu void vm_gpa_release(void *cookie); 100366f6083SPeter Grehan int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase, 101366f6083SPeter Grehan struct vm_memory_segment *seg); 102318224bbSNeel Natu int vm_get_memobj(struct vm *vm, vm_paddr_t gpa, size_t len, 103318224bbSNeel Natu vm_offset_t *offset, struct vm_object **object); 104318224bbSNeel Natu boolean_t vm_mem_allocated(struct vm *vm, vm_paddr_t gpa); 105366f6083SPeter Grehan int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 106366f6083SPeter Grehan int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 107366f6083SPeter Grehan int vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 108366f6083SPeter Grehan struct seg_desc *ret_desc); 109366f6083SPeter Grehan int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 110366f6083SPeter Grehan struct seg_desc *desc); 111366f6083SPeter Grehan int vm_run(struct vm *vm, struct vm_run *vmrun); 112366f6083SPeter Grehan int vm_inject_event(struct vm *vm, int vcpu, int type, 113366f6083SPeter Grehan int vector, uint32_t error_code, int error_code_valid); 114366f6083SPeter Grehan int vm_inject_nmi(struct vm *vm, int vcpu); 115f352ff0cSNeel Natu int vm_nmi_pending(struct vm *vm, int vcpuid); 116f352ff0cSNeel Natu void vm_nmi_clear(struct vm *vm, int vcpuid); 117366f6083SPeter Grehan uint64_t *vm_guest_msrs(struct vm *vm, int cpu); 118366f6083SPeter Grehan struct vlapic *vm_lapic(struct vm *vm, int cpu); 119366f6083SPeter Grehan int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 120366f6083SPeter Grehan int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 121e9027382SNeel Natu int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 122e9027382SNeel Natu int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 123366f6083SPeter Grehan void vm_activate_cpu(struct vm *vm, int vcpu); 124a5615c90SPeter Grehan cpuset_t vm_active_cpus(struct vm *vm); 12598ed632cSNeel Natu struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 126366f6083SPeter Grehan 127366f6083SPeter Grehan /* 128366f6083SPeter Grehan * Return 1 if device indicated by bus/slot/func is supposed to be a 129366f6083SPeter Grehan * pci passthrough device. 130366f6083SPeter Grehan * 131366f6083SPeter Grehan * Return 0 otherwise. 132366f6083SPeter Grehan */ 133366f6083SPeter Grehan int vmm_is_pptdev(int bus, int slot, int func); 134366f6083SPeter Grehan 135366f6083SPeter Grehan void *vm_iommu_domain(struct vm *vm); 136366f6083SPeter Grehan 13775dd3366SNeel Natu enum vcpu_state { 13875dd3366SNeel Natu VCPU_IDLE, 139318224bbSNeel Natu VCPU_FROZEN, 14075dd3366SNeel Natu VCPU_RUNNING, 141318224bbSNeel Natu VCPU_SLEEPING, 14275dd3366SNeel Natu }; 143366f6083SPeter Grehan 14475dd3366SNeel Natu int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state); 145d3c11f40SPeter Grehan enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu); 146366f6083SPeter Grehan 147366f6083SPeter Grehan static int __inline 148d3c11f40SPeter Grehan vcpu_is_running(struct vm *vm, int vcpu, int *hostcpu) 149366f6083SPeter Grehan { 150d3c11f40SPeter Grehan return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING); 151366f6083SPeter Grehan } 152366f6083SPeter Grehan 15375dd3366SNeel Natu void *vcpu_stats(struct vm *vm, int vcpu); 15475dd3366SNeel Natu void vm_interrupt_hostcpu(struct vm *vm, int vcpu); 155318224bbSNeel Natu struct vmspace *vm_get_vmspace(struct vm *vm); 156318224bbSNeel Natu int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func); 157318224bbSNeel Natu int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func); 158366f6083SPeter Grehan #endif /* KERNEL */ 159366f6083SPeter Grehan 160ba9b7bf7SNeel Natu #include <machine/vmm_instruction_emul.h> 161ba9b7bf7SNeel Natu 1628d39ed16SPeter Grehan #define VM_MAXCPU 16 /* maximum virtual cpus */ 163366f6083SPeter Grehan 164366f6083SPeter Grehan /* 165366f6083SPeter Grehan * Identifiers for events that can be injected into the VM 166366f6083SPeter Grehan */ 167366f6083SPeter Grehan enum vm_event_type { 168366f6083SPeter Grehan VM_EVENT_NONE, 169366f6083SPeter Grehan VM_HW_INTR, 170366f6083SPeter Grehan VM_NMI, 171366f6083SPeter Grehan VM_HW_EXCEPTION, 172366f6083SPeter Grehan VM_SW_INTR, 173366f6083SPeter Grehan VM_PRIV_SW_EXCEPTION, 174366f6083SPeter Grehan VM_SW_EXCEPTION, 175366f6083SPeter Grehan VM_EVENT_MAX 176366f6083SPeter Grehan }; 177366f6083SPeter Grehan 178366f6083SPeter Grehan /* 179366f6083SPeter Grehan * Identifiers for architecturally defined registers. 180366f6083SPeter Grehan */ 181366f6083SPeter Grehan enum vm_reg_name { 182366f6083SPeter Grehan VM_REG_GUEST_RAX, 183366f6083SPeter Grehan VM_REG_GUEST_RBX, 184366f6083SPeter Grehan VM_REG_GUEST_RCX, 185366f6083SPeter Grehan VM_REG_GUEST_RDX, 186366f6083SPeter Grehan VM_REG_GUEST_RSI, 187366f6083SPeter Grehan VM_REG_GUEST_RDI, 188366f6083SPeter Grehan VM_REG_GUEST_RBP, 189366f6083SPeter Grehan VM_REG_GUEST_R8, 190366f6083SPeter Grehan VM_REG_GUEST_R9, 191366f6083SPeter Grehan VM_REG_GUEST_R10, 192366f6083SPeter Grehan VM_REG_GUEST_R11, 193366f6083SPeter Grehan VM_REG_GUEST_R12, 194366f6083SPeter Grehan VM_REG_GUEST_R13, 195366f6083SPeter Grehan VM_REG_GUEST_R14, 196366f6083SPeter Grehan VM_REG_GUEST_R15, 197366f6083SPeter Grehan VM_REG_GUEST_CR0, 198366f6083SPeter Grehan VM_REG_GUEST_CR3, 199366f6083SPeter Grehan VM_REG_GUEST_CR4, 200366f6083SPeter Grehan VM_REG_GUEST_DR7, 201366f6083SPeter Grehan VM_REG_GUEST_RSP, 202366f6083SPeter Grehan VM_REG_GUEST_RIP, 203366f6083SPeter Grehan VM_REG_GUEST_RFLAGS, 204366f6083SPeter Grehan VM_REG_GUEST_ES, 205366f6083SPeter Grehan VM_REG_GUEST_CS, 206366f6083SPeter Grehan VM_REG_GUEST_SS, 207366f6083SPeter Grehan VM_REG_GUEST_DS, 208366f6083SPeter Grehan VM_REG_GUEST_FS, 209366f6083SPeter Grehan VM_REG_GUEST_GS, 210366f6083SPeter Grehan VM_REG_GUEST_LDTR, 211366f6083SPeter Grehan VM_REG_GUEST_TR, 212366f6083SPeter Grehan VM_REG_GUEST_IDTR, 213366f6083SPeter Grehan VM_REG_GUEST_GDTR, 214366f6083SPeter Grehan VM_REG_GUEST_EFER, 215366f6083SPeter Grehan VM_REG_LAST 216366f6083SPeter Grehan }; 217366f6083SPeter Grehan 218366f6083SPeter Grehan /* 219366f6083SPeter Grehan * Identifiers for optional vmm capabilities 220366f6083SPeter Grehan */ 221366f6083SPeter Grehan enum vm_cap_type { 222366f6083SPeter Grehan VM_CAP_HALT_EXIT, 223366f6083SPeter Grehan VM_CAP_MTRAP_EXIT, 224366f6083SPeter Grehan VM_CAP_PAUSE_EXIT, 225366f6083SPeter Grehan VM_CAP_UNRESTRICTED_GUEST, 22649cc03daSNeel Natu VM_CAP_ENABLE_INVPCID, 227366f6083SPeter Grehan VM_CAP_MAX 228366f6083SPeter Grehan }; 229366f6083SPeter Grehan 230e9027382SNeel Natu enum x2apic_state { 231e9027382SNeel Natu X2APIC_ENABLED, 232e9027382SNeel Natu X2APIC_AVAILABLE, 233e9027382SNeel Natu X2APIC_DISABLED, 234e9027382SNeel Natu X2APIC_STATE_LAST 235e9027382SNeel Natu }; 236e9027382SNeel Natu 237366f6083SPeter Grehan /* 238366f6083SPeter Grehan * The 'access' field has the format specified in Table 21-2 of the Intel 239366f6083SPeter Grehan * Architecture Manual vol 3b. 240366f6083SPeter Grehan * 241366f6083SPeter Grehan * XXX The contents of the 'access' field are architecturally defined except 242366f6083SPeter Grehan * bit 16 - Segment Unusable. 243366f6083SPeter Grehan */ 244366f6083SPeter Grehan struct seg_desc { 245366f6083SPeter Grehan uint64_t base; 246366f6083SPeter Grehan uint32_t limit; 247366f6083SPeter Grehan uint32_t access; 248366f6083SPeter Grehan }; 249366f6083SPeter Grehan 250366f6083SPeter Grehan enum vm_exitcode { 251366f6083SPeter Grehan VM_EXITCODE_INOUT, 252366f6083SPeter Grehan VM_EXITCODE_VMX, 253366f6083SPeter Grehan VM_EXITCODE_BOGUS, 254366f6083SPeter Grehan VM_EXITCODE_RDMSR, 255366f6083SPeter Grehan VM_EXITCODE_WRMSR, 256366f6083SPeter Grehan VM_EXITCODE_HLT, 257366f6083SPeter Grehan VM_EXITCODE_MTRAP, 258366f6083SPeter Grehan VM_EXITCODE_PAUSE, 259cd942e0fSPeter Grehan VM_EXITCODE_PAGING, 260318224bbSNeel Natu VM_EXITCODE_INST_EMUL, 261edf89256SNeel Natu VM_EXITCODE_SPINUP_AP, 262cd942e0fSPeter Grehan VM_EXITCODE_MAX 263366f6083SPeter Grehan }; 264366f6083SPeter Grehan 265366f6083SPeter Grehan struct vm_exit { 266366f6083SPeter Grehan enum vm_exitcode exitcode; 267366f6083SPeter Grehan int inst_length; /* 0 means unknown */ 268366f6083SPeter Grehan uint64_t rip; 269366f6083SPeter Grehan union { 270366f6083SPeter Grehan struct { 271366f6083SPeter Grehan uint16_t bytes:3; /* 1 or 2 or 4 */ 272366f6083SPeter Grehan uint16_t in:1; /* out is 0, in is 1 */ 273366f6083SPeter Grehan uint16_t string:1; 274366f6083SPeter Grehan uint16_t rep:1; 275366f6083SPeter Grehan uint16_t port; 276366f6083SPeter Grehan uint32_t eax; /* valid for out */ 277366f6083SPeter Grehan } inout; 278cd942e0fSPeter Grehan struct { 27913ec9371SPeter Grehan uint64_t gpa; 280318224bbSNeel Natu int fault_type; 281318224bbSNeel Natu int protection; 282cd942e0fSPeter Grehan } paging; 283318224bbSNeel Natu struct { 284318224bbSNeel Natu uint64_t gpa; 285318224bbSNeel Natu uint64_t gla; 286318224bbSNeel Natu uint64_t cr3; 287318224bbSNeel Natu struct vie vie; 288318224bbSNeel Natu } inst_emul; 289366f6083SPeter Grehan /* 290366f6083SPeter Grehan * VMX specific payload. Used when there is no "better" 291366f6083SPeter Grehan * exitcode to represent the VM-exit. 292366f6083SPeter Grehan */ 293366f6083SPeter Grehan struct { 294366f6083SPeter Grehan int error; /* vmx inst error */ 295366f6083SPeter Grehan uint32_t exit_reason; 296366f6083SPeter Grehan uint64_t exit_qualification; 297366f6083SPeter Grehan } vmx; 298366f6083SPeter Grehan struct { 299366f6083SPeter Grehan uint32_t code; /* ecx value */ 300366f6083SPeter Grehan uint64_t wval; 301366f6083SPeter Grehan } msr; 302edf89256SNeel Natu struct { 303edf89256SNeel Natu int vcpu; 304edf89256SNeel Natu uint64_t rip; 305edf89256SNeel Natu } spinup_ap; 306366f6083SPeter Grehan } u; 307366f6083SPeter Grehan }; 308366f6083SPeter Grehan 309366f6083SPeter Grehan #endif /* _VMM_H_ */ 310