vmm.h revision 258579
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: head/sys/amd64/include/vmm.h 258579 2013-11-25 19:04:51Z neel $ 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 vhpet; 42struct vioapic; 43struct vlapic; 44struct vmspace; 45struct vm_object; 46struct pmap; 47 48enum x2apic_state; 49 50typedef int (*vmm_init_func_t)(void); 51typedef int (*vmm_cleanup_func_t)(void); 52typedef void * (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap); 53typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip, 54 struct pmap *pmap); 55typedef void (*vmi_cleanup_func_t)(void *vmi); 56typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 57 uint64_t *retval); 58typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 59 uint64_t val); 60typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 61 struct seg_desc *desc); 62typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 63 struct seg_desc *desc); 64typedef int (*vmi_inject_event_t)(void *vmi, int vcpu, 65 int type, int vector, 66 uint32_t code, int code_valid); 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); 69typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max); 70typedef void (*vmi_vmspace_free)(struct vmspace *vmspace); 71 72struct vmm_ops { 73 vmm_init_func_t init; /* module wide initialization */ 74 vmm_cleanup_func_t cleanup; 75 76 vmi_init_func_t vminit; /* vm-specific initialization */ 77 vmi_run_func_t vmrun; 78 vmi_cleanup_func_t vmcleanup; 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_get_cap_t vmgetcap; 85 vmi_set_cap_t vmsetcap; 86 vmi_vmspace_alloc vmspace_alloc; 87 vmi_vmspace_free vmspace_free; 88}; 89 90extern struct vmm_ops vmm_ops_intel; 91extern struct vmm_ops vmm_ops_amd; 92 93int vm_create(const char *name, struct vm **retvm); 94void vm_destroy(struct vm *vm); 95const char *vm_name(struct vm *vm); 96int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len); 97int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 98int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 99void *vm_gpa_hold(struct vm *, vm_paddr_t gpa, size_t len, int prot, 100 void **cookie); 101void vm_gpa_release(void *cookie); 102int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase, 103 struct vm_memory_segment *seg); 104int vm_get_memobj(struct vm *vm, vm_paddr_t gpa, size_t len, 105 vm_offset_t *offset, struct vm_object **object); 106boolean_t vm_mem_allocated(struct vm *vm, vm_paddr_t gpa); 107int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 108int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 109int vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 110 struct seg_desc *ret_desc); 111int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 112 struct seg_desc *desc); 113int vm_run(struct vm *vm, struct vm_run *vmrun); 114int vm_inject_event(struct vm *vm, int vcpu, int type, 115 int vector, uint32_t error_code, int error_code_valid); 116int vm_inject_nmi(struct vm *vm, int vcpu); 117int vm_nmi_pending(struct vm *vm, int vcpuid); 118void vm_nmi_clear(struct vm *vm, int vcpuid); 119uint64_t *vm_guest_msrs(struct vm *vm, int cpu); 120struct vlapic *vm_lapic(struct vm *vm, int cpu); 121struct vioapic *vm_ioapic(struct vm *vm); 122struct vhpet *vm_hpet(struct vm *vm); 123int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 124int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 125int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 126int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 127int vm_apicid2vcpuid(struct vm *vm, int apicid); 128void vm_activate_cpu(struct vm *vm, int vcpu); 129cpuset_t vm_active_cpus(struct vm *vm); 130struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 131 132/* 133 * Return 1 if device indicated by bus/slot/func is supposed to be a 134 * pci passthrough device. 135 * 136 * Return 0 otherwise. 137 */ 138int vmm_is_pptdev(int bus, int slot, int func); 139 140void *vm_iommu_domain(struct vm *vm); 141 142enum vcpu_state { 143 VCPU_IDLE, 144 VCPU_FROZEN, 145 VCPU_RUNNING, 146 VCPU_SLEEPING, 147}; 148 149int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state); 150enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu); 151 152static int __inline 153vcpu_is_running(struct vm *vm, int vcpu, int *hostcpu) 154{ 155 return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING); 156} 157 158void *vcpu_stats(struct vm *vm, int vcpu); 159void vm_interrupt_hostcpu(struct vm *vm, int vcpu); 160struct vmspace *vm_get_vmspace(struct vm *vm); 161int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func); 162int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func); 163#endif /* KERNEL */ 164 165#include <machine/vmm_instruction_emul.h> 166 167#define VM_MAXCPU 16 /* maximum virtual cpus */ 168 169/* 170 * Identifiers for events that can be injected into the VM 171 */ 172enum vm_event_type { 173 VM_EVENT_NONE, 174 VM_HW_INTR, 175 VM_NMI, 176 VM_HW_EXCEPTION, 177 VM_SW_INTR, 178 VM_PRIV_SW_EXCEPTION, 179 VM_SW_EXCEPTION, 180 VM_EVENT_MAX 181}; 182 183/* 184 * Identifiers for architecturally defined registers. 185 */ 186enum vm_reg_name { 187 VM_REG_GUEST_RAX, 188 VM_REG_GUEST_RBX, 189 VM_REG_GUEST_RCX, 190 VM_REG_GUEST_RDX, 191 VM_REG_GUEST_RSI, 192 VM_REG_GUEST_RDI, 193 VM_REG_GUEST_RBP, 194 VM_REG_GUEST_R8, 195 VM_REG_GUEST_R9, 196 VM_REG_GUEST_R10, 197 VM_REG_GUEST_R11, 198 VM_REG_GUEST_R12, 199 VM_REG_GUEST_R13, 200 VM_REG_GUEST_R14, 201 VM_REG_GUEST_R15, 202 VM_REG_GUEST_CR0, 203 VM_REG_GUEST_CR3, 204 VM_REG_GUEST_CR4, 205 VM_REG_GUEST_DR7, 206 VM_REG_GUEST_RSP, 207 VM_REG_GUEST_RIP, 208 VM_REG_GUEST_RFLAGS, 209 VM_REG_GUEST_ES, 210 VM_REG_GUEST_CS, 211 VM_REG_GUEST_SS, 212 VM_REG_GUEST_DS, 213 VM_REG_GUEST_FS, 214 VM_REG_GUEST_GS, 215 VM_REG_GUEST_LDTR, 216 VM_REG_GUEST_TR, 217 VM_REG_GUEST_IDTR, 218 VM_REG_GUEST_GDTR, 219 VM_REG_GUEST_EFER, 220 VM_REG_LAST 221}; 222 223/* 224 * Identifiers for optional vmm capabilities 225 */ 226enum vm_cap_type { 227 VM_CAP_HALT_EXIT, 228 VM_CAP_MTRAP_EXIT, 229 VM_CAP_PAUSE_EXIT, 230 VM_CAP_UNRESTRICTED_GUEST, 231 VM_CAP_ENABLE_INVPCID, 232 VM_CAP_MAX 233}; 234 235enum x2apic_state { 236 X2APIC_ENABLED, 237 X2APIC_AVAILABLE, 238 X2APIC_DISABLED, 239 X2APIC_STATE_LAST 240}; 241 242/* 243 * The 'access' field has the format specified in Table 21-2 of the Intel 244 * Architecture Manual vol 3b. 245 * 246 * XXX The contents of the 'access' field are architecturally defined except 247 * bit 16 - Segment Unusable. 248 */ 249struct seg_desc { 250 uint64_t base; 251 uint32_t limit; 252 uint32_t access; 253}; 254 255enum vm_exitcode { 256 VM_EXITCODE_INOUT, 257 VM_EXITCODE_VMX, 258 VM_EXITCODE_BOGUS, 259 VM_EXITCODE_RDMSR, 260 VM_EXITCODE_WRMSR, 261 VM_EXITCODE_HLT, 262 VM_EXITCODE_MTRAP, 263 VM_EXITCODE_PAUSE, 264 VM_EXITCODE_PAGING, 265 VM_EXITCODE_INST_EMUL, 266 VM_EXITCODE_SPINUP_AP, 267 VM_EXITCODE_MAX 268}; 269 270struct vm_exit { 271 enum vm_exitcode exitcode; 272 int inst_length; /* 0 means unknown */ 273 uint64_t rip; 274 union { 275 struct { 276 uint16_t bytes:3; /* 1 or 2 or 4 */ 277 uint16_t in:1; /* out is 0, in is 1 */ 278 uint16_t string:1; 279 uint16_t rep:1; 280 uint16_t port; 281 uint32_t eax; /* valid for out */ 282 } inout; 283 struct { 284 uint64_t gpa; 285 int fault_type; 286 int protection; 287 } paging; 288 struct { 289 uint64_t gpa; 290 uint64_t gla; 291 uint64_t cr3; 292 struct vie vie; 293 } inst_emul; 294 /* 295 * VMX specific payload. Used when there is no "better" 296 * exitcode to represent the VM-exit. 297 */ 298 struct { 299 int error; /* vmx inst error */ 300 uint32_t exit_reason; 301 uint64_t exit_qualification; 302 } vmx; 303 struct { 304 uint32_t code; /* ecx value */ 305 uint64_t wval; 306 } msr; 307 struct { 308 int vcpu; 309 uint64_t rip; 310 } spinup_ap; 311 } u; 312}; 313 314#endif /* _VMM_H_ */ 315