vmm.h revision 263035
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 263035 2014-03-11 16:56:00Z tychon $ 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_exception; 38struct vm_memory_segment; 39struct seg_desc; 40struct vm_exit; 41struct vm_run; 42struct vhpet; 43struct vioapic; 44struct vlapic; 45struct vmspace; 46struct vm_object; 47struct pmap; 48 49enum x2apic_state; 50 51typedef int (*vmm_init_func_t)(int ipinum); 52typedef int (*vmm_cleanup_func_t)(void); 53typedef void (*vmm_resume_func_t)(void); 54typedef void * (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap); 55typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip, 56 struct pmap *pmap, void *rendezvous_cookie); 57typedef void (*vmi_cleanup_func_t)(void *vmi); 58typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 59 uint64_t *retval); 60typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 61 uint64_t val); 62typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 63 struct seg_desc *desc); 64typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 65 struct seg_desc *desc); 66typedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval); 67typedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val); 68typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max); 69typedef void (*vmi_vmspace_free)(struct vmspace *vmspace); 70typedef struct vlapic * (*vmi_vlapic_init)(void *vmi, int vcpu); 71typedef void (*vmi_vlapic_cleanup)(void *vmi, struct vlapic *vlapic); 72 73struct vmm_ops { 74 vmm_init_func_t init; /* module wide initialization */ 75 vmm_cleanup_func_t cleanup; 76 vmm_resume_func_t resume; 77 78 vmi_init_func_t vminit; /* vm-specific initialization */ 79 vmi_run_func_t vmrun; 80 vmi_cleanup_func_t vmcleanup; 81 vmi_get_register_t vmgetreg; 82 vmi_set_register_t vmsetreg; 83 vmi_get_desc_t vmgetdesc; 84 vmi_set_desc_t vmsetdesc; 85 vmi_get_cap_t vmgetcap; 86 vmi_set_cap_t vmsetcap; 87 vmi_vmspace_alloc vmspace_alloc; 88 vmi_vmspace_free vmspace_free; 89 vmi_vlapic_init vlapic_init; 90 vmi_vlapic_cleanup vlapic_cleanup; 91}; 92 93extern struct vmm_ops vmm_ops_intel; 94extern struct vmm_ops vmm_ops_amd; 95 96int vm_create(const char *name, struct vm **retvm); 97void vm_destroy(struct vm *vm); 98const char *vm_name(struct vm *vm); 99int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len); 100int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 101int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 102void *vm_gpa_hold(struct vm *, vm_paddr_t gpa, size_t len, int prot, 103 void **cookie); 104void vm_gpa_release(void *cookie); 105int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase, 106 struct vm_memory_segment *seg); 107int vm_get_memobj(struct vm *vm, vm_paddr_t gpa, size_t len, 108 vm_offset_t *offset, struct vm_object **object); 109boolean_t vm_mem_allocated(struct vm *vm, vm_paddr_t gpa); 110int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 111int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 112int vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 113 struct seg_desc *ret_desc); 114int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 115 struct seg_desc *desc); 116int vm_run(struct vm *vm, struct vm_run *vmrun); 117int vm_inject_nmi(struct vm *vm, int vcpu); 118int vm_nmi_pending(struct vm *vm, int vcpuid); 119void vm_nmi_clear(struct vm *vm, int vcpuid); 120uint64_t *vm_guest_msrs(struct vm *vm, int cpu); 121struct vlapic *vm_lapic(struct vm *vm, int cpu); 122struct vioapic *vm_ioapic(struct vm *vm); 123struct vhpet *vm_hpet(struct vm *vm); 124int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 125int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 126int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 127int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 128int vm_apicid2vcpuid(struct vm *vm, int apicid); 129void vm_activate_cpu(struct vm *vm, int vcpu); 130cpuset_t vm_active_cpus(struct vm *vm); 131struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 132 133/* 134 * Rendezvous all vcpus specified in 'dest' and execute 'func(arg)'. 135 * The rendezvous 'func(arg)' is not allowed to do anything that will 136 * cause the thread to be put to sleep. 137 * 138 * If the rendezvous is being initiated from a vcpu context then the 139 * 'vcpuid' must refer to that vcpu, otherwise it should be set to -1. 140 * 141 * The caller cannot hold any locks when initiating the rendezvous. 142 * 143 * The implementation of this API may cause vcpus other than those specified 144 * by 'dest' to be stalled. The caller should not rely on any vcpus making 145 * forward progress when the rendezvous is in progress. 146 */ 147typedef void (*vm_rendezvous_func_t)(struct vm *vm, int vcpuid, void *arg); 148void vm_smp_rendezvous(struct vm *vm, int vcpuid, cpuset_t dest, 149 vm_rendezvous_func_t func, void *arg); 150 151static __inline int 152vcpu_rendezvous_pending(void *rendezvous_cookie) 153{ 154 155 return (*(uintptr_t *)rendezvous_cookie != 0); 156} 157 158/* 159 * Return 1 if device indicated by bus/slot/func is supposed to be a 160 * pci passthrough device. 161 * 162 * Return 0 otherwise. 163 */ 164int vmm_is_pptdev(int bus, int slot, int func); 165 166void *vm_iommu_domain(struct vm *vm); 167 168enum vcpu_state { 169 VCPU_IDLE, 170 VCPU_FROZEN, 171 VCPU_RUNNING, 172 VCPU_SLEEPING, 173}; 174 175int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state, 176 bool from_idle); 177enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu); 178 179static int __inline 180vcpu_is_running(struct vm *vm, int vcpu, int *hostcpu) 181{ 182 return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING); 183} 184 185void *vcpu_stats(struct vm *vm, int vcpu); 186void vcpu_notify_event(struct vm *vm, int vcpuid, bool lapic_intr); 187struct vmspace *vm_get_vmspace(struct vm *vm); 188int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func); 189int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func); 190struct vatpic *vm_atpic(struct vm *vm); 191 192/* 193 * Inject exception 'vme' into the guest vcpu. This function returns 0 on 194 * success and non-zero on failure. 195 * 196 * Wrapper functions like 'vm_inject_gp()' should be preferred to calling 197 * this function directly because they enforce the trap-like or fault-like 198 * behavior of an exception. 199 * 200 * This function should only be called in the context of the thread that is 201 * executing this vcpu. 202 */ 203int vm_inject_exception(struct vm *vm, int vcpuid, struct vm_exception *vme); 204 205/* 206 * Returns 0 if there is no exception pending for this vcpu. Returns 1 if an 207 * exception is pending and also updates 'vme'. The pending exception is 208 * cleared when this function returns. 209 * 210 * This function should only be called in the context of the thread that is 211 * executing this vcpu. 212 */ 213int vm_exception_pending(struct vm *vm, int vcpuid, struct vm_exception *vme); 214 215void vm_inject_gp(struct vm *vm, int vcpuid); /* general protection fault */ 216void vm_inject_ud(struct vm *vm, int vcpuid); /* undefined instruction fault */ 217 218#endif /* KERNEL */ 219 220#include <machine/vmm_instruction_emul.h> 221 222#define VM_MAXCPU 16 /* maximum virtual cpus */ 223 224/* 225 * Identifiers for architecturally defined registers. 226 */ 227enum vm_reg_name { 228 VM_REG_GUEST_RAX, 229 VM_REG_GUEST_RBX, 230 VM_REG_GUEST_RCX, 231 VM_REG_GUEST_RDX, 232 VM_REG_GUEST_RSI, 233 VM_REG_GUEST_RDI, 234 VM_REG_GUEST_RBP, 235 VM_REG_GUEST_R8, 236 VM_REG_GUEST_R9, 237 VM_REG_GUEST_R10, 238 VM_REG_GUEST_R11, 239 VM_REG_GUEST_R12, 240 VM_REG_GUEST_R13, 241 VM_REG_GUEST_R14, 242 VM_REG_GUEST_R15, 243 VM_REG_GUEST_CR0, 244 VM_REG_GUEST_CR3, 245 VM_REG_GUEST_CR4, 246 VM_REG_GUEST_DR7, 247 VM_REG_GUEST_RSP, 248 VM_REG_GUEST_RIP, 249 VM_REG_GUEST_RFLAGS, 250 VM_REG_GUEST_ES, 251 VM_REG_GUEST_CS, 252 VM_REG_GUEST_SS, 253 VM_REG_GUEST_DS, 254 VM_REG_GUEST_FS, 255 VM_REG_GUEST_GS, 256 VM_REG_GUEST_LDTR, 257 VM_REG_GUEST_TR, 258 VM_REG_GUEST_IDTR, 259 VM_REG_GUEST_GDTR, 260 VM_REG_GUEST_EFER, 261 VM_REG_LAST 262}; 263 264/* 265 * Identifiers for optional vmm capabilities 266 */ 267enum vm_cap_type { 268 VM_CAP_HALT_EXIT, 269 VM_CAP_MTRAP_EXIT, 270 VM_CAP_PAUSE_EXIT, 271 VM_CAP_UNRESTRICTED_GUEST, 272 VM_CAP_ENABLE_INVPCID, 273 VM_CAP_MAX 274}; 275 276enum x2apic_state { 277 X2APIC_DISABLED, 278 X2APIC_ENABLED, 279 X2APIC_STATE_LAST 280}; 281 282/* 283 * The 'access' field has the format specified in Table 21-2 of the Intel 284 * Architecture Manual vol 3b. 285 * 286 * XXX The contents of the 'access' field are architecturally defined except 287 * bit 16 - Segment Unusable. 288 */ 289struct seg_desc { 290 uint64_t base; 291 uint32_t limit; 292 uint32_t access; 293}; 294 295enum vm_exitcode { 296 VM_EXITCODE_INOUT, 297 VM_EXITCODE_VMX, 298 VM_EXITCODE_BOGUS, 299 VM_EXITCODE_RDMSR, 300 VM_EXITCODE_WRMSR, 301 VM_EXITCODE_HLT, 302 VM_EXITCODE_MTRAP, 303 VM_EXITCODE_PAUSE, 304 VM_EXITCODE_PAGING, 305 VM_EXITCODE_INST_EMUL, 306 VM_EXITCODE_SPINUP_AP, 307 VM_EXITCODE_SPINDOWN_CPU, 308 VM_EXITCODE_RENDEZVOUS, 309 VM_EXITCODE_IOAPIC_EOI, 310 VM_EXITCODE_MAX 311}; 312 313struct vm_exit { 314 enum vm_exitcode exitcode; 315 int inst_length; /* 0 means unknown */ 316 uint64_t rip; 317 union { 318 struct { 319 uint16_t bytes:3; /* 1 or 2 or 4 */ 320 uint16_t in:1; /* out is 0, in is 1 */ 321 uint16_t string:1; 322 uint16_t rep:1; 323 uint16_t port; 324 uint32_t eax; /* valid for out */ 325 } inout; 326 struct { 327 uint64_t gpa; 328 int fault_type; 329 } paging; 330 struct { 331 uint64_t gpa; 332 uint64_t gla; 333 uint64_t cr3; 334 enum vie_cpu_mode cpu_mode; 335 enum vie_paging_mode paging_mode; 336 struct vie vie; 337 } inst_emul; 338 /* 339 * VMX specific payload. Used when there is no "better" 340 * exitcode to represent the VM-exit. 341 */ 342 struct { 343 int status; /* vmx inst status */ 344 /* 345 * 'exit_reason' and 'exit_qualification' are valid 346 * only if 'status' is zero. 347 */ 348 uint32_t exit_reason; 349 uint64_t exit_qualification; 350 /* 351 * 'inst_error' and 'inst_type' are valid 352 * only if 'status' is non-zero. 353 */ 354 int inst_type; 355 int inst_error; 356 } vmx; 357 struct { 358 uint32_t code; /* ecx value */ 359 uint64_t wval; 360 } msr; 361 struct { 362 int vcpu; 363 uint64_t rip; 364 } spinup_ap; 365 struct { 366 uint64_t rflags; 367 } hlt; 368 struct { 369 int vector; 370 } ioapic_eoi; 371 } u; 372}; 373 374#endif /* _VMM_H_ */ 375