vmm.h revision 249396
1221828Sgrehan/*- 2221828Sgrehan * Copyright (c) 2011 NetApp, Inc. 3221828Sgrehan * All rights reserved. 4221828Sgrehan * 5221828Sgrehan * Redistribution and use in source and binary forms, with or without 6221828Sgrehan * modification, are permitted provided that the following conditions 7221828Sgrehan * are met: 8221828Sgrehan * 1. Redistributions of source code must retain the above copyright 9221828Sgrehan * notice, this list of conditions and the following disclaimer. 10221828Sgrehan * 2. Redistributions in binary form must reproduce the above copyright 11221828Sgrehan * notice, this list of conditions and the following disclaimer in the 12221828Sgrehan * documentation and/or other materials provided with the distribution. 13221828Sgrehan * 14221828Sgrehan * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 15221828Sgrehan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16221828Sgrehan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17221828Sgrehan * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 18221828Sgrehan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19221828Sgrehan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20221828Sgrehan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21221828Sgrehan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22221828Sgrehan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23221828Sgrehan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24221828Sgrehan * SUCH DAMAGE. 25221828Sgrehan * 26245678Sneel * $FreeBSD: head/sys/amd64/include/vmm.h 249396 2013-04-12 01:16:52Z neel $ 27221828Sgrehan */ 28221828Sgrehan 29221828Sgrehan#ifndef _VMM_H_ 30221828Sgrehan#define _VMM_H_ 31221828Sgrehan 32221828Sgrehan#ifdef _KERNEL 33221828Sgrehan 34221828Sgrehan#define VM_MAX_NAMELEN 32 35221828Sgrehan 36221828Sgrehanstruct vm; 37221828Sgrehanstruct vm_memory_segment; 38221828Sgrehanstruct seg_desc; 39221828Sgrehanstruct vm_exit; 40221828Sgrehanstruct vm_run; 41221828Sgrehanstruct vlapic; 42221828Sgrehan 43240922Sneelenum x2apic_state; 44240922Sneel 45221828Sgrehantypedef int (*vmm_init_func_t)(void); 46221828Sgrehantypedef int (*vmm_cleanup_func_t)(void); 47221828Sgrehantypedef void * (*vmi_init_func_t)(struct vm *vm); /* instance specific apis */ 48240894Sneeltypedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip); 49221828Sgrehantypedef void (*vmi_cleanup_func_t)(void *vmi); 50241147Sneeltypedef int (*vmi_mmap_set_func_t)(void *vmi, vm_paddr_t gpa, 51241147Sneel vm_paddr_t hpa, size_t length, 52241147Sneel vm_memattr_t attr, int prot, 53241147Sneel boolean_t superpages_ok); 54241147Sneeltypedef vm_paddr_t (*vmi_mmap_get_func_t)(void *vmi, vm_paddr_t gpa); 55221828Sgrehantypedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 56221828Sgrehan uint64_t *retval); 57221828Sgrehantypedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 58221828Sgrehan uint64_t val); 59221828Sgrehantypedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 60221828Sgrehan struct seg_desc *desc); 61221828Sgrehantypedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 62221828Sgrehan struct seg_desc *desc); 63221828Sgrehantypedef int (*vmi_inject_event_t)(void *vmi, int vcpu, 64221828Sgrehan int type, int vector, 65221828Sgrehan uint32_t code, int code_valid); 66221828Sgrehantypedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval); 67221828Sgrehantypedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val); 68221828Sgrehan 69221828Sgrehanstruct vmm_ops { 70221828Sgrehan vmm_init_func_t init; /* module wide initialization */ 71221828Sgrehan vmm_cleanup_func_t cleanup; 72221828Sgrehan 73221828Sgrehan vmi_init_func_t vminit; /* vm-specific initialization */ 74221828Sgrehan vmi_run_func_t vmrun; 75221828Sgrehan vmi_cleanup_func_t vmcleanup; 76241147Sneel vmi_mmap_set_func_t vmmmap_set; 77241147Sneel vmi_mmap_get_func_t vmmmap_get; 78221828Sgrehan vmi_get_register_t vmgetreg; 79221828Sgrehan vmi_set_register_t vmsetreg; 80221828Sgrehan vmi_get_desc_t vmgetdesc; 81221828Sgrehan vmi_set_desc_t vmsetdesc; 82221828Sgrehan vmi_inject_event_t vminject; 83221828Sgrehan vmi_get_cap_t vmgetcap; 84221828Sgrehan vmi_set_cap_t vmsetcap; 85221828Sgrehan}; 86221828Sgrehan 87221828Sgrehanextern struct vmm_ops vmm_ops_intel; 88221828Sgrehanextern struct vmm_ops vmm_ops_amd; 89221828Sgrehan 90249396Sneelint vm_create(const char *name, struct vm **retvm); 91221828Sgrehanvoid vm_destroy(struct vm *vm); 92221828Sgrehanconst char *vm_name(struct vm *vm); 93241041Sneelint vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len); 94221828Sgrehanint vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 95221828Sgrehanint vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 96221828Sgrehanvm_paddr_t vm_gpa2hpa(struct vm *vm, vm_paddr_t gpa, size_t size); 97221828Sgrehanint vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase, 98221828Sgrehan struct vm_memory_segment *seg); 99221828Sgrehanint vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 100221828Sgrehanint vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 101221828Sgrehanint vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 102221828Sgrehan struct seg_desc *ret_desc); 103221828Sgrehanint vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 104221828Sgrehan struct seg_desc *desc); 105221828Sgrehanint vm_run(struct vm *vm, struct vm_run *vmrun); 106221828Sgrehanint vm_inject_event(struct vm *vm, int vcpu, int type, 107221828Sgrehan int vector, uint32_t error_code, int error_code_valid); 108221828Sgrehanint vm_inject_nmi(struct vm *vm, int vcpu); 109241982Sneelint vm_nmi_pending(struct vm *vm, int vcpuid); 110241982Sneelvoid vm_nmi_clear(struct vm *vm, int vcpuid); 111221828Sgrehanuint64_t *vm_guest_msrs(struct vm *vm, int cpu); 112221828Sgrehanstruct vlapic *vm_lapic(struct vm *vm, int cpu); 113221828Sgrehanint vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 114221828Sgrehanint vm_set_capability(struct vm *vm, int vcpu, int type, int val); 115240922Sneelint vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 116240922Sneelint vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 117221828Sgrehanvoid vm_activate_cpu(struct vm *vm, int vcpu); 118223621Sgrehancpuset_t vm_active_cpus(struct vm *vm); 119240894Sneelstruct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 120221828Sgrehan 121221828Sgrehan/* 122221828Sgrehan * Return 1 if device indicated by bus/slot/func is supposed to be a 123221828Sgrehan * pci passthrough device. 124221828Sgrehan * 125221828Sgrehan * Return 0 otherwise. 126221828Sgrehan */ 127221828Sgrehanint vmm_is_pptdev(int bus, int slot, int func); 128221828Sgrehan 129221828Sgrehanvoid *vm_iommu_domain(struct vm *vm); 130221828Sgrehan 131241489Sneelenum vcpu_state { 132241489Sneel VCPU_IDLE, 133241489Sneel VCPU_RUNNING, 134241489Sneel VCPU_CANNOT_RUN, 135241489Sneel}; 136221828Sgrehan 137241489Sneelint vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state); 138241489Sneelenum vcpu_state vcpu_get_state(struct vm *vm, int vcpu); 139221828Sgrehan 140221828Sgrehanstatic int __inline 141241489Sneelvcpu_is_running(struct vm *vm, int vcpu) 142221828Sgrehan{ 143241489Sneel return (vcpu_get_state(vm, vcpu) == VCPU_RUNNING); 144221828Sgrehan} 145221828Sgrehan 146241489Sneelvoid *vcpu_stats(struct vm *vm, int vcpu); 147241489Sneelvoid vm_interrupt_hostcpu(struct vm *vm, int vcpu); 148241489Sneel 149221828Sgrehan#endif /* KERNEL */ 150221828Sgrehan 151243640Sneel#include <machine/vmm_instruction_emul.h> 152243640Sneel 153221828Sgrehan#define VM_MAXCPU 8 /* maximum virtual cpus */ 154221828Sgrehan 155221828Sgrehan/* 156221828Sgrehan * Identifiers for events that can be injected into the VM 157221828Sgrehan */ 158221828Sgrehanenum vm_event_type { 159221828Sgrehan VM_EVENT_NONE, 160221828Sgrehan VM_HW_INTR, 161221828Sgrehan VM_NMI, 162221828Sgrehan VM_HW_EXCEPTION, 163221828Sgrehan VM_SW_INTR, 164221828Sgrehan VM_PRIV_SW_EXCEPTION, 165221828Sgrehan VM_SW_EXCEPTION, 166221828Sgrehan VM_EVENT_MAX 167221828Sgrehan}; 168221828Sgrehan 169221828Sgrehan/* 170221828Sgrehan * Identifiers for architecturally defined registers. 171221828Sgrehan */ 172221828Sgrehanenum vm_reg_name { 173221828Sgrehan VM_REG_GUEST_RAX, 174221828Sgrehan VM_REG_GUEST_RBX, 175221828Sgrehan VM_REG_GUEST_RCX, 176221828Sgrehan VM_REG_GUEST_RDX, 177221828Sgrehan VM_REG_GUEST_RSI, 178221828Sgrehan VM_REG_GUEST_RDI, 179221828Sgrehan VM_REG_GUEST_RBP, 180221828Sgrehan VM_REG_GUEST_R8, 181221828Sgrehan VM_REG_GUEST_R9, 182221828Sgrehan VM_REG_GUEST_R10, 183221828Sgrehan VM_REG_GUEST_R11, 184221828Sgrehan VM_REG_GUEST_R12, 185221828Sgrehan VM_REG_GUEST_R13, 186221828Sgrehan VM_REG_GUEST_R14, 187221828Sgrehan VM_REG_GUEST_R15, 188221828Sgrehan VM_REG_GUEST_CR0, 189221828Sgrehan VM_REG_GUEST_CR3, 190221828Sgrehan VM_REG_GUEST_CR4, 191221828Sgrehan VM_REG_GUEST_DR7, 192221828Sgrehan VM_REG_GUEST_RSP, 193221828Sgrehan VM_REG_GUEST_RIP, 194221828Sgrehan VM_REG_GUEST_RFLAGS, 195221828Sgrehan VM_REG_GUEST_ES, 196221828Sgrehan VM_REG_GUEST_CS, 197221828Sgrehan VM_REG_GUEST_SS, 198221828Sgrehan VM_REG_GUEST_DS, 199221828Sgrehan VM_REG_GUEST_FS, 200221828Sgrehan VM_REG_GUEST_GS, 201221828Sgrehan VM_REG_GUEST_LDTR, 202221828Sgrehan VM_REG_GUEST_TR, 203221828Sgrehan VM_REG_GUEST_IDTR, 204221828Sgrehan VM_REG_GUEST_GDTR, 205221828Sgrehan VM_REG_GUEST_EFER, 206221828Sgrehan VM_REG_LAST 207221828Sgrehan}; 208221828Sgrehan 209221828Sgrehan/* 210221828Sgrehan * Identifiers for optional vmm capabilities 211221828Sgrehan */ 212221828Sgrehanenum vm_cap_type { 213221828Sgrehan VM_CAP_HALT_EXIT, 214221828Sgrehan VM_CAP_MTRAP_EXIT, 215221828Sgrehan VM_CAP_PAUSE_EXIT, 216221828Sgrehan VM_CAP_UNRESTRICTED_GUEST, 217221828Sgrehan VM_CAP_MAX 218221828Sgrehan}; 219221828Sgrehan 220240922Sneelenum x2apic_state { 221240922Sneel X2APIC_ENABLED, 222240922Sneel X2APIC_AVAILABLE, 223240922Sneel X2APIC_DISABLED, 224240922Sneel X2APIC_STATE_LAST 225240922Sneel}; 226240922Sneel 227221828Sgrehan/* 228221828Sgrehan * The 'access' field has the format specified in Table 21-2 of the Intel 229221828Sgrehan * Architecture Manual vol 3b. 230221828Sgrehan * 231221828Sgrehan * XXX The contents of the 'access' field are architecturally defined except 232221828Sgrehan * bit 16 - Segment Unusable. 233221828Sgrehan */ 234221828Sgrehanstruct seg_desc { 235221828Sgrehan uint64_t base; 236221828Sgrehan uint32_t limit; 237221828Sgrehan uint32_t access; 238221828Sgrehan}; 239221828Sgrehan 240221828Sgrehanenum vm_exitcode { 241221828Sgrehan VM_EXITCODE_INOUT, 242221828Sgrehan VM_EXITCODE_VMX, 243221828Sgrehan VM_EXITCODE_BOGUS, 244221828Sgrehan VM_EXITCODE_RDMSR, 245221828Sgrehan VM_EXITCODE_WRMSR, 246221828Sgrehan VM_EXITCODE_HLT, 247221828Sgrehan VM_EXITCODE_MTRAP, 248221828Sgrehan VM_EXITCODE_PAUSE, 249234761Sgrehan VM_EXITCODE_PAGING, 250240912Sneel VM_EXITCODE_SPINUP_AP, 251234761Sgrehan VM_EXITCODE_MAX 252221828Sgrehan}; 253221828Sgrehan 254221828Sgrehanstruct vm_exit { 255221828Sgrehan enum vm_exitcode exitcode; 256221828Sgrehan int inst_length; /* 0 means unknown */ 257221828Sgrehan uint64_t rip; 258221828Sgrehan union { 259221828Sgrehan struct { 260221828Sgrehan uint16_t bytes:3; /* 1 or 2 or 4 */ 261221828Sgrehan uint16_t in:1; /* out is 0, in is 1 */ 262221828Sgrehan uint16_t string:1; 263221828Sgrehan uint16_t rep:1; 264221828Sgrehan uint16_t port; 265221828Sgrehan uint32_t eax; /* valid for out */ 266221828Sgrehan } inout; 267234761Sgrehan struct { 268241497Sgrehan uint64_t gpa; 269243640Sneel struct vie vie; 270234761Sgrehan } paging; 271221828Sgrehan /* 272221828Sgrehan * VMX specific payload. Used when there is no "better" 273221828Sgrehan * exitcode to represent the VM-exit. 274221828Sgrehan */ 275221828Sgrehan struct { 276221828Sgrehan int error; /* vmx inst error */ 277221828Sgrehan uint32_t exit_reason; 278221828Sgrehan uint64_t exit_qualification; 279221828Sgrehan } vmx; 280221828Sgrehan struct { 281221828Sgrehan uint32_t code; /* ecx value */ 282221828Sgrehan uint64_t wval; 283221828Sgrehan } msr; 284240912Sneel struct { 285240912Sneel int vcpu; 286240912Sneel uint64_t rip; 287240912Sneel } spinup_ap; 288221828Sgrehan } u; 289221828Sgrehan}; 290221828Sgrehan 291221828Sgrehan#endif /* _VMM_H_ */ 292