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 * 26366f6083SPeter Grehan * $FreeBSD: vmm.h 482 2011-05-09 21:22:43Z grehan $ 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; 42366f6083SPeter Grehan 43e9027382SNeel Natu enum x2apic_state; 44e9027382SNeel Natu 45366f6083SPeter Grehan typedef int (*vmm_init_func_t)(void); 46366f6083SPeter Grehan typedef int (*vmm_cleanup_func_t)(void); 47366f6083SPeter Grehan typedef void * (*vmi_init_func_t)(struct vm *vm); /* instance specific apis */ 4898ed632cSNeel Natu typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip); 49366f6083SPeter Grehan typedef void (*vmi_cleanup_func_t)(void *vmi); 50bda273f2SNeel Natu typedef int (*vmi_mmap_set_func_t)(void *vmi, vm_paddr_t gpa, 51bda273f2SNeel Natu vm_paddr_t hpa, size_t length, 52bda273f2SNeel Natu vm_memattr_t attr, int prot, 53bda273f2SNeel Natu boolean_t superpages_ok); 54bda273f2SNeel Natu typedef vm_paddr_t (*vmi_mmap_get_func_t)(void *vmi, vm_paddr_t gpa); 55366f6083SPeter Grehan typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 56366f6083SPeter Grehan uint64_t *retval); 57366f6083SPeter Grehan typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 58366f6083SPeter Grehan uint64_t val); 59366f6083SPeter Grehan typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 60366f6083SPeter Grehan struct seg_desc *desc); 61366f6083SPeter Grehan typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 62366f6083SPeter Grehan struct seg_desc *desc); 63366f6083SPeter Grehan typedef int (*vmi_inject_event_t)(void *vmi, int vcpu, 64366f6083SPeter Grehan int type, int vector, 65366f6083SPeter Grehan uint32_t code, int code_valid); 66366f6083SPeter Grehan typedef int (*vmi_inject_nmi_t)(void *vmi, int vcpu); 67366f6083SPeter Grehan typedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval); 68366f6083SPeter Grehan typedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val); 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; 77bda273f2SNeel Natu vmi_mmap_set_func_t vmmmap_set; 78bda273f2SNeel Natu vmi_mmap_get_func_t vmmmap_get; 79366f6083SPeter Grehan vmi_get_register_t vmgetreg; 80366f6083SPeter Grehan vmi_set_register_t vmsetreg; 81366f6083SPeter Grehan vmi_get_desc_t vmgetdesc; 82366f6083SPeter Grehan vmi_set_desc_t vmsetdesc; 83366f6083SPeter Grehan vmi_inject_event_t vminject; 84366f6083SPeter Grehan vmi_inject_nmi_t vmnmi; 85366f6083SPeter Grehan vmi_get_cap_t vmgetcap; 86366f6083SPeter Grehan vmi_set_cap_t vmsetcap; 87366f6083SPeter Grehan }; 88366f6083SPeter Grehan 89366f6083SPeter Grehan extern struct vmm_ops vmm_ops_intel; 90366f6083SPeter Grehan extern struct vmm_ops vmm_ops_amd; 91366f6083SPeter Grehan 92366f6083SPeter Grehan struct vm *vm_create(const char *name); 93366f6083SPeter Grehan void vm_destroy(struct vm *vm); 94366f6083SPeter Grehan const char *vm_name(struct vm *vm); 95341f19c9SNeel Natu int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len); 96366f6083SPeter Grehan int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 97366f6083SPeter Grehan int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 98366f6083SPeter Grehan vm_paddr_t vm_gpa2hpa(struct vm *vm, vm_paddr_t gpa, size_t size); 99366f6083SPeter Grehan int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase, 100366f6083SPeter Grehan struct vm_memory_segment *seg); 101366f6083SPeter Grehan int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 102366f6083SPeter Grehan int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 103366f6083SPeter Grehan int vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 104366f6083SPeter Grehan struct seg_desc *ret_desc); 105366f6083SPeter Grehan int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 106366f6083SPeter Grehan struct seg_desc *desc); 107366f6083SPeter Grehan int vm_get_pinning(struct vm *vm, int vcpu, int *cpuid); 108366f6083SPeter Grehan int vm_set_pinning(struct vm *vm, int vcpu, int cpuid); 109366f6083SPeter Grehan int vm_run(struct vm *vm, struct vm_run *vmrun); 110366f6083SPeter Grehan int vm_inject_event(struct vm *vm, int vcpu, int type, 111366f6083SPeter Grehan int vector, uint32_t error_code, int error_code_valid); 112366f6083SPeter Grehan int vm_inject_nmi(struct vm *vm, int vcpu); 113366f6083SPeter Grehan uint64_t *vm_guest_msrs(struct vm *vm, int cpu); 114366f6083SPeter Grehan struct vlapic *vm_lapic(struct vm *vm, int cpu); 115366f6083SPeter Grehan int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 116366f6083SPeter Grehan int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 117e9027382SNeel Natu int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 118e9027382SNeel Natu int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 119366f6083SPeter Grehan void vm_activate_cpu(struct vm *vm, int vcpu); 120a5615c90SPeter Grehan cpuset_t vm_active_cpus(struct vm *vm); 12198ed632cSNeel Natu struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 122366f6083SPeter Grehan 123366f6083SPeter Grehan /* 124366f6083SPeter Grehan * Return 1 if device indicated by bus/slot/func is supposed to be a 125366f6083SPeter Grehan * pci passthrough device. 126366f6083SPeter Grehan * 127366f6083SPeter Grehan * Return 0 otherwise. 128366f6083SPeter Grehan */ 129366f6083SPeter Grehan int vmm_is_pptdev(int bus, int slot, int func); 130366f6083SPeter Grehan 131366f6083SPeter Grehan void *vm_iommu_domain(struct vm *vm); 132366f6083SPeter Grehan 13375dd3366SNeel Natu enum vcpu_state { 13475dd3366SNeel Natu VCPU_IDLE, 13575dd3366SNeel Natu VCPU_RUNNING, 13675dd3366SNeel Natu VCPU_CANNOT_RUN, 13775dd3366SNeel Natu }; 138366f6083SPeter Grehan 13975dd3366SNeel Natu int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state); 14075dd3366SNeel Natu enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu); 141366f6083SPeter Grehan 142366f6083SPeter Grehan static int __inline 14375dd3366SNeel Natu vcpu_is_running(struct vm *vm, int vcpu) 144366f6083SPeter Grehan { 14575dd3366SNeel Natu return (vcpu_get_state(vm, vcpu) == VCPU_RUNNING); 146366f6083SPeter Grehan } 147366f6083SPeter Grehan 14875dd3366SNeel Natu void *vcpu_stats(struct vm *vm, int vcpu); 14975dd3366SNeel Natu void vm_interrupt_hostcpu(struct vm *vm, int vcpu); 15075dd3366SNeel Natu 151366f6083SPeter Grehan #endif /* KERNEL */ 152366f6083SPeter Grehan 153366f6083SPeter Grehan #define VM_MAXCPU 8 /* maximum virtual cpus */ 154366f6083SPeter Grehan 155366f6083SPeter Grehan /* 156366f6083SPeter Grehan * Identifiers for events that can be injected into the VM 157366f6083SPeter Grehan */ 158366f6083SPeter Grehan enum vm_event_type { 159366f6083SPeter Grehan VM_EVENT_NONE, 160366f6083SPeter Grehan VM_HW_INTR, 161366f6083SPeter Grehan VM_NMI, 162366f6083SPeter Grehan VM_HW_EXCEPTION, 163366f6083SPeter Grehan VM_SW_INTR, 164366f6083SPeter Grehan VM_PRIV_SW_EXCEPTION, 165366f6083SPeter Grehan VM_SW_EXCEPTION, 166366f6083SPeter Grehan VM_EVENT_MAX 167366f6083SPeter Grehan }; 168366f6083SPeter Grehan 169366f6083SPeter Grehan /* 170366f6083SPeter Grehan * Identifiers for architecturally defined registers. 171366f6083SPeter Grehan */ 172366f6083SPeter Grehan enum vm_reg_name { 173366f6083SPeter Grehan VM_REG_GUEST_RAX, 174366f6083SPeter Grehan VM_REG_GUEST_RBX, 175366f6083SPeter Grehan VM_REG_GUEST_RCX, 176366f6083SPeter Grehan VM_REG_GUEST_RDX, 177366f6083SPeter Grehan VM_REG_GUEST_RSI, 178366f6083SPeter Grehan VM_REG_GUEST_RDI, 179366f6083SPeter Grehan VM_REG_GUEST_RBP, 180366f6083SPeter Grehan VM_REG_GUEST_R8, 181366f6083SPeter Grehan VM_REG_GUEST_R9, 182366f6083SPeter Grehan VM_REG_GUEST_R10, 183366f6083SPeter Grehan VM_REG_GUEST_R11, 184366f6083SPeter Grehan VM_REG_GUEST_R12, 185366f6083SPeter Grehan VM_REG_GUEST_R13, 186366f6083SPeter Grehan VM_REG_GUEST_R14, 187366f6083SPeter Grehan VM_REG_GUEST_R15, 188366f6083SPeter Grehan VM_REG_GUEST_CR0, 189366f6083SPeter Grehan VM_REG_GUEST_CR3, 190366f6083SPeter Grehan VM_REG_GUEST_CR4, 191366f6083SPeter Grehan VM_REG_GUEST_DR7, 192366f6083SPeter Grehan VM_REG_GUEST_RSP, 193366f6083SPeter Grehan VM_REG_GUEST_RIP, 194366f6083SPeter Grehan VM_REG_GUEST_RFLAGS, 195366f6083SPeter Grehan VM_REG_GUEST_ES, 196366f6083SPeter Grehan VM_REG_GUEST_CS, 197366f6083SPeter Grehan VM_REG_GUEST_SS, 198366f6083SPeter Grehan VM_REG_GUEST_DS, 199366f6083SPeter Grehan VM_REG_GUEST_FS, 200366f6083SPeter Grehan VM_REG_GUEST_GS, 201366f6083SPeter Grehan VM_REG_GUEST_LDTR, 202366f6083SPeter Grehan VM_REG_GUEST_TR, 203366f6083SPeter Grehan VM_REG_GUEST_IDTR, 204366f6083SPeter Grehan VM_REG_GUEST_GDTR, 205366f6083SPeter Grehan VM_REG_GUEST_EFER, 206366f6083SPeter Grehan VM_REG_LAST 207366f6083SPeter Grehan }; 208366f6083SPeter Grehan 209366f6083SPeter Grehan /* 210366f6083SPeter Grehan * Identifiers for optional vmm capabilities 211366f6083SPeter Grehan */ 212366f6083SPeter Grehan enum vm_cap_type { 213366f6083SPeter Grehan VM_CAP_HALT_EXIT, 214366f6083SPeter Grehan VM_CAP_MTRAP_EXIT, 215366f6083SPeter Grehan VM_CAP_PAUSE_EXIT, 216366f6083SPeter Grehan VM_CAP_UNRESTRICTED_GUEST, 217366f6083SPeter Grehan VM_CAP_MAX 218366f6083SPeter Grehan }; 219366f6083SPeter Grehan 220e9027382SNeel Natu enum x2apic_state { 221e9027382SNeel Natu X2APIC_ENABLED, 222e9027382SNeel Natu X2APIC_AVAILABLE, 223e9027382SNeel Natu X2APIC_DISABLED, 224e9027382SNeel Natu X2APIC_STATE_LAST 225e9027382SNeel Natu }; 226e9027382SNeel Natu 227366f6083SPeter Grehan /* 228366f6083SPeter Grehan * The 'access' field has the format specified in Table 21-2 of the Intel 229366f6083SPeter Grehan * Architecture Manual vol 3b. 230366f6083SPeter Grehan * 231366f6083SPeter Grehan * XXX The contents of the 'access' field are architecturally defined except 232366f6083SPeter Grehan * bit 16 - Segment Unusable. 233366f6083SPeter Grehan */ 234366f6083SPeter Grehan struct seg_desc { 235366f6083SPeter Grehan uint64_t base; 236366f6083SPeter Grehan uint32_t limit; 237366f6083SPeter Grehan uint32_t access; 238366f6083SPeter Grehan }; 239366f6083SPeter Grehan 240366f6083SPeter Grehan enum vm_exitcode { 241366f6083SPeter Grehan VM_EXITCODE_INOUT, 242366f6083SPeter Grehan VM_EXITCODE_VMX, 243366f6083SPeter Grehan VM_EXITCODE_BOGUS, 244366f6083SPeter Grehan VM_EXITCODE_RDMSR, 245366f6083SPeter Grehan VM_EXITCODE_WRMSR, 246366f6083SPeter Grehan VM_EXITCODE_HLT, 247366f6083SPeter Grehan VM_EXITCODE_MTRAP, 248366f6083SPeter Grehan VM_EXITCODE_PAUSE, 249cd942e0fSPeter Grehan VM_EXITCODE_PAGING, 250edf89256SNeel Natu VM_EXITCODE_SPINUP_AP, 251cd942e0fSPeter Grehan VM_EXITCODE_MAX 252366f6083SPeter Grehan }; 253366f6083SPeter Grehan 254366f6083SPeter Grehan struct vm_exit { 255366f6083SPeter Grehan enum vm_exitcode exitcode; 256366f6083SPeter Grehan int inst_length; /* 0 means unknown */ 257366f6083SPeter Grehan uint64_t rip; 258366f6083SPeter Grehan union { 259366f6083SPeter Grehan struct { 260366f6083SPeter Grehan uint16_t bytes:3; /* 1 or 2 or 4 */ 261366f6083SPeter Grehan uint16_t in:1; /* out is 0, in is 1 */ 262366f6083SPeter Grehan uint16_t string:1; 263366f6083SPeter Grehan uint16_t rep:1; 264366f6083SPeter Grehan uint16_t port; 265366f6083SPeter Grehan uint32_t eax; /* valid for out */ 266366f6083SPeter Grehan } inout; 267cd942e0fSPeter Grehan struct { 268cd942e0fSPeter Grehan uint64_t cr3; 269cd942e0fSPeter Grehan } paging; 270366f6083SPeter Grehan /* 271366f6083SPeter Grehan * VMX specific payload. Used when there is no "better" 272366f6083SPeter Grehan * exitcode to represent the VM-exit. 273366f6083SPeter Grehan */ 274366f6083SPeter Grehan struct { 275366f6083SPeter Grehan int error; /* vmx inst error */ 276366f6083SPeter Grehan uint32_t exit_reason; 277366f6083SPeter Grehan uint64_t exit_qualification; 278366f6083SPeter Grehan } vmx; 279366f6083SPeter Grehan struct { 280366f6083SPeter Grehan uint32_t code; /* ecx value */ 281366f6083SPeter Grehan uint64_t wval; 282366f6083SPeter Grehan } msr; 283edf89256SNeel Natu struct { 284edf89256SNeel Natu int vcpu; 285edf89256SNeel Natu uint64_t rip; 286edf89256SNeel Natu } spinup_ap; 287366f6083SPeter Grehan } u; 288366f6083SPeter Grehan }; 289366f6083SPeter Grehan 290366f6083SPeter Grehan #endif /* _VMM_H_ */ 291