vmm.h revision 241489
1/*- 2 * Copyright (c) 2011 NetApp, Inc. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD: vmm.h 482 2011-05-09 21:22:43Z grehan $ 27 */ 28 29#ifndef _VMM_H_ 30#define _VMM_H_ 31 32#ifdef _KERNEL 33 34#define VM_MAX_NAMELEN 32 35 36struct vm; 37struct vm_memory_segment; 38struct seg_desc; 39struct vm_exit; 40struct vm_run; 41struct vlapic; 42 43enum x2apic_state; 44 45typedef int (*vmm_init_func_t)(void); 46typedef int (*vmm_cleanup_func_t)(void); 47typedef void * (*vmi_init_func_t)(struct vm *vm); /* instance specific apis */ 48typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip); 49typedef void (*vmi_cleanup_func_t)(void *vmi); 50typedef int (*vmi_mmap_set_func_t)(void *vmi, vm_paddr_t gpa, 51 vm_paddr_t hpa, size_t length, 52 vm_memattr_t attr, int prot, 53 boolean_t superpages_ok); 54typedef vm_paddr_t (*vmi_mmap_get_func_t)(void *vmi, vm_paddr_t gpa); 55typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 56 uint64_t *retval); 57typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 58 uint64_t val); 59typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 60 struct seg_desc *desc); 61typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 62 struct seg_desc *desc); 63typedef int (*vmi_inject_event_t)(void *vmi, int vcpu, 64 int type, int vector, 65 uint32_t code, int code_valid); 66typedef int (*vmi_inject_nmi_t)(void *vmi, int vcpu); 67typedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval); 68typedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val); 69 70struct vmm_ops { 71 vmm_init_func_t init; /* module wide initialization */ 72 vmm_cleanup_func_t cleanup; 73 74 vmi_init_func_t vminit; /* vm-specific initialization */ 75 vmi_run_func_t vmrun; 76 vmi_cleanup_func_t vmcleanup; 77 vmi_mmap_set_func_t vmmmap_set; 78 vmi_mmap_get_func_t vmmmap_get; 79 vmi_get_register_t vmgetreg; 80 vmi_set_register_t vmsetreg; 81 vmi_get_desc_t vmgetdesc; 82 vmi_set_desc_t vmsetdesc; 83 vmi_inject_event_t vminject; 84 vmi_inject_nmi_t vmnmi; 85 vmi_get_cap_t vmgetcap; 86 vmi_set_cap_t vmsetcap; 87}; 88 89extern struct vmm_ops vmm_ops_intel; 90extern struct vmm_ops vmm_ops_amd; 91 92struct vm *vm_create(const char *name); 93void vm_destroy(struct vm *vm); 94const char *vm_name(struct vm *vm); 95int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len); 96int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 97int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 98vm_paddr_t vm_gpa2hpa(struct vm *vm, vm_paddr_t gpa, size_t size); 99int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase, 100 struct vm_memory_segment *seg); 101int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 102int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 103int vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 104 struct seg_desc *ret_desc); 105int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 106 struct seg_desc *desc); 107int vm_get_pinning(struct vm *vm, int vcpu, int *cpuid); 108int vm_set_pinning(struct vm *vm, int vcpu, int cpuid); 109int vm_run(struct vm *vm, struct vm_run *vmrun); 110int vm_inject_event(struct vm *vm, int vcpu, int type, 111 int vector, uint32_t error_code, int error_code_valid); 112int vm_inject_nmi(struct vm *vm, int vcpu); 113uint64_t *vm_guest_msrs(struct vm *vm, int cpu); 114struct vlapic *vm_lapic(struct vm *vm, int cpu); 115int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 116int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 117int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 118int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 119void vm_activate_cpu(struct vm *vm, int vcpu); 120cpuset_t vm_active_cpus(struct vm *vm); 121struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 122 123/* 124 * Return 1 if device indicated by bus/slot/func is supposed to be a 125 * pci passthrough device. 126 * 127 * Return 0 otherwise. 128 */ 129int vmm_is_pptdev(int bus, int slot, int func); 130 131void *vm_iommu_domain(struct vm *vm); 132 133enum vcpu_state { 134 VCPU_IDLE, 135 VCPU_RUNNING, 136 VCPU_CANNOT_RUN, 137}; 138 139int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state); 140enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu); 141 142static int __inline 143vcpu_is_running(struct vm *vm, int vcpu) 144{ 145 return (vcpu_get_state(vm, vcpu) == VCPU_RUNNING); 146} 147 148void *vcpu_stats(struct vm *vm, int vcpu); 149void vm_interrupt_hostcpu(struct vm *vm, int vcpu); 150 151#endif /* KERNEL */ 152 153#define VM_MAXCPU 8 /* maximum virtual cpus */ 154 155/* 156 * Identifiers for events that can be injected into the VM 157 */ 158enum vm_event_type { 159 VM_EVENT_NONE, 160 VM_HW_INTR, 161 VM_NMI, 162 VM_HW_EXCEPTION, 163 VM_SW_INTR, 164 VM_PRIV_SW_EXCEPTION, 165 VM_SW_EXCEPTION, 166 VM_EVENT_MAX 167}; 168 169/* 170 * Identifiers for architecturally defined registers. 171 */ 172enum vm_reg_name { 173 VM_REG_GUEST_RAX, 174 VM_REG_GUEST_RBX, 175 VM_REG_GUEST_RCX, 176 VM_REG_GUEST_RDX, 177 VM_REG_GUEST_RSI, 178 VM_REG_GUEST_RDI, 179 VM_REG_GUEST_RBP, 180 VM_REG_GUEST_R8, 181 VM_REG_GUEST_R9, 182 VM_REG_GUEST_R10, 183 VM_REG_GUEST_R11, 184 VM_REG_GUEST_R12, 185 VM_REG_GUEST_R13, 186 VM_REG_GUEST_R14, 187 VM_REG_GUEST_R15, 188 VM_REG_GUEST_CR0, 189 VM_REG_GUEST_CR3, 190 VM_REG_GUEST_CR4, 191 VM_REG_GUEST_DR7, 192 VM_REG_GUEST_RSP, 193 VM_REG_GUEST_RIP, 194 VM_REG_GUEST_RFLAGS, 195 VM_REG_GUEST_ES, 196 VM_REG_GUEST_CS, 197 VM_REG_GUEST_SS, 198 VM_REG_GUEST_DS, 199 VM_REG_GUEST_FS, 200 VM_REG_GUEST_GS, 201 VM_REG_GUEST_LDTR, 202 VM_REG_GUEST_TR, 203 VM_REG_GUEST_IDTR, 204 VM_REG_GUEST_GDTR, 205 VM_REG_GUEST_EFER, 206 VM_REG_LAST 207}; 208 209/* 210 * Identifiers for optional vmm capabilities 211 */ 212enum vm_cap_type { 213 VM_CAP_HALT_EXIT, 214 VM_CAP_MTRAP_EXIT, 215 VM_CAP_PAUSE_EXIT, 216 VM_CAP_UNRESTRICTED_GUEST, 217 VM_CAP_MAX 218}; 219 220enum x2apic_state { 221 X2APIC_ENABLED, 222 X2APIC_AVAILABLE, 223 X2APIC_DISABLED, 224 X2APIC_STATE_LAST 225}; 226 227/* 228 * The 'access' field has the format specified in Table 21-2 of the Intel 229 * Architecture Manual vol 3b. 230 * 231 * XXX The contents of the 'access' field are architecturally defined except 232 * bit 16 - Segment Unusable. 233 */ 234struct seg_desc { 235 uint64_t base; 236 uint32_t limit; 237 uint32_t access; 238}; 239 240enum vm_exitcode { 241 VM_EXITCODE_INOUT, 242 VM_EXITCODE_VMX, 243 VM_EXITCODE_BOGUS, 244 VM_EXITCODE_RDMSR, 245 VM_EXITCODE_WRMSR, 246 VM_EXITCODE_HLT, 247 VM_EXITCODE_MTRAP, 248 VM_EXITCODE_PAUSE, 249 VM_EXITCODE_PAGING, 250 VM_EXITCODE_SPINUP_AP, 251 VM_EXITCODE_MAX 252}; 253 254struct vm_exit { 255 enum vm_exitcode exitcode; 256 int inst_length; /* 0 means unknown */ 257 uint64_t rip; 258 union { 259 struct { 260 uint16_t bytes:3; /* 1 or 2 or 4 */ 261 uint16_t in:1; /* out is 0, in is 1 */ 262 uint16_t string:1; 263 uint16_t rep:1; 264 uint16_t port; 265 uint32_t eax; /* valid for out */ 266 } inout; 267 struct { 268 uint64_t cr3; 269 } paging; 270 /* 271 * VMX specific payload. Used when there is no "better" 272 * exitcode to represent the VM-exit. 273 */ 274 struct { 275 int error; /* vmx inst error */ 276 uint32_t exit_reason; 277 uint64_t exit_qualification; 278 } vmx; 279 struct { 280 uint32_t code; /* ecx value */ 281 uint64_t wval; 282 } msr; 283 struct { 284 int vcpu; 285 uint64_t rip; 286 } spinup_ap; 287 } u; 288}; 289 290#endif /* _VMM_H_ */ 291