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 * 26912a3e67SNeel Natu * $FreeBSD$ 27366f6083SPeter Grehan */ 28366f6083SPeter Grehan 29366f6083SPeter Grehan #ifndef _VMM_H_ 30366f6083SPeter Grehan #define _VMM_H_ 31366f6083SPeter Grehan 32f0fdcfe2SNeel Natu enum vm_suspend_how { 33f0fdcfe2SNeel Natu VM_SUSPEND_NONE, 34f0fdcfe2SNeel Natu VM_SUSPEND_RESET, 35f0fdcfe2SNeel Natu VM_SUSPEND_POWEROFF, 36e50ce2aaSNeel Natu VM_SUSPEND_HALT, 37f0fdcfe2SNeel Natu VM_SUSPEND_LAST 38f0fdcfe2SNeel Natu }; 39f0fdcfe2SNeel Natu 40366f6083SPeter Grehan #ifdef _KERNEL 41366f6083SPeter Grehan 42366f6083SPeter Grehan #define VM_MAX_NAMELEN 32 43366f6083SPeter Grehan 44366f6083SPeter Grehan struct vm; 45dc506506SNeel Natu struct vm_exception; 46366f6083SPeter Grehan struct vm_memory_segment; 47366f6083SPeter Grehan struct seg_desc; 48366f6083SPeter Grehan struct vm_exit; 49366f6083SPeter Grehan struct vm_run; 5008e3ff32SNeel Natu struct vhpet; 51565bbb86SNeel Natu struct vioapic; 52366f6083SPeter Grehan struct vlapic; 53318224bbSNeel Natu struct vmspace; 54318224bbSNeel Natu struct vm_object; 55318224bbSNeel Natu struct pmap; 56366f6083SPeter Grehan 57d17b5104SNeel Natu enum vm_reg_name; 58e9027382SNeel Natu enum x2apic_state; 59e9027382SNeel Natu 60add611fdSNeel Natu typedef int (*vmm_init_func_t)(int ipinum); 61366f6083SPeter Grehan typedef int (*vmm_cleanup_func_t)(void); 6263e62d39SJohn Baldwin typedef void (*vmm_resume_func_t)(void); 63318224bbSNeel Natu typedef void * (*vmi_init_func_t)(struct vm *vm, struct pmap *pmap); 64318224bbSNeel Natu typedef int (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip, 65b15a09c0SNeel Natu struct pmap *pmap, void *rendezvous_cookie, 66b15a09c0SNeel Natu void *suspend_cookie); 67366f6083SPeter Grehan typedef void (*vmi_cleanup_func_t)(void *vmi); 68366f6083SPeter Grehan typedef int (*vmi_get_register_t)(void *vmi, int vcpu, int num, 69366f6083SPeter Grehan uint64_t *retval); 70366f6083SPeter Grehan typedef int (*vmi_set_register_t)(void *vmi, int vcpu, int num, 71366f6083SPeter Grehan uint64_t val); 72366f6083SPeter Grehan typedef int (*vmi_get_desc_t)(void *vmi, int vcpu, int num, 73366f6083SPeter Grehan struct seg_desc *desc); 74366f6083SPeter Grehan typedef int (*vmi_set_desc_t)(void *vmi, int vcpu, int num, 75366f6083SPeter Grehan struct seg_desc *desc); 76366f6083SPeter Grehan typedef int (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval); 77366f6083SPeter Grehan typedef int (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val); 78318224bbSNeel Natu typedef struct vmspace * (*vmi_vmspace_alloc)(vm_offset_t min, vm_offset_t max); 79318224bbSNeel Natu typedef void (*vmi_vmspace_free)(struct vmspace *vmspace); 80de5ea6b6SNeel Natu typedef struct vlapic * (*vmi_vlapic_init)(void *vmi, int vcpu); 81de5ea6b6SNeel Natu typedef void (*vmi_vlapic_cleanup)(void *vmi, struct vlapic *vlapic); 82366f6083SPeter Grehan 83366f6083SPeter Grehan struct vmm_ops { 84366f6083SPeter Grehan vmm_init_func_t init; /* module wide initialization */ 85366f6083SPeter Grehan vmm_cleanup_func_t cleanup; 8663e62d39SJohn Baldwin vmm_resume_func_t resume; 87366f6083SPeter Grehan 88366f6083SPeter Grehan vmi_init_func_t vminit; /* vm-specific initialization */ 89366f6083SPeter Grehan vmi_run_func_t vmrun; 90366f6083SPeter Grehan vmi_cleanup_func_t vmcleanup; 91366f6083SPeter Grehan vmi_get_register_t vmgetreg; 92366f6083SPeter Grehan vmi_set_register_t vmsetreg; 93366f6083SPeter Grehan vmi_get_desc_t vmgetdesc; 94366f6083SPeter Grehan vmi_set_desc_t vmsetdesc; 95366f6083SPeter Grehan vmi_get_cap_t vmgetcap; 96366f6083SPeter Grehan vmi_set_cap_t vmsetcap; 97318224bbSNeel Natu vmi_vmspace_alloc vmspace_alloc; 98318224bbSNeel Natu vmi_vmspace_free vmspace_free; 99de5ea6b6SNeel Natu vmi_vlapic_init vlapic_init; 100de5ea6b6SNeel Natu vmi_vlapic_cleanup vlapic_cleanup; 101366f6083SPeter Grehan }; 102366f6083SPeter Grehan 103366f6083SPeter Grehan extern struct vmm_ops vmm_ops_intel; 104366f6083SPeter Grehan extern struct vmm_ops vmm_ops_amd; 105366f6083SPeter Grehan 106d5408b1dSNeel Natu int vm_create(const char *name, struct vm **retvm); 107366f6083SPeter Grehan void vm_destroy(struct vm *vm); 1085fcf252fSNeel Natu int vm_reinit(struct vm *vm); 109366f6083SPeter Grehan const char *vm_name(struct vm *vm); 110341f19c9SNeel Natu int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len); 111366f6083SPeter Grehan int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa); 112366f6083SPeter Grehan int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len); 113318224bbSNeel Natu void *vm_gpa_hold(struct vm *, vm_paddr_t gpa, size_t len, int prot, 114318224bbSNeel Natu void **cookie); 115318224bbSNeel Natu void vm_gpa_release(void *cookie); 116366f6083SPeter Grehan int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase, 117366f6083SPeter Grehan struct vm_memory_segment *seg); 118318224bbSNeel Natu int vm_get_memobj(struct vm *vm, vm_paddr_t gpa, size_t len, 119318224bbSNeel Natu vm_offset_t *offset, struct vm_object **object); 120318224bbSNeel Natu boolean_t vm_mem_allocated(struct vm *vm, vm_paddr_t gpa); 121366f6083SPeter Grehan int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval); 122366f6083SPeter Grehan int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val); 123366f6083SPeter Grehan int vm_get_seg_desc(struct vm *vm, int vcpu, int reg, 124366f6083SPeter Grehan struct seg_desc *ret_desc); 125366f6083SPeter Grehan int vm_set_seg_desc(struct vm *vm, int vcpu, int reg, 126366f6083SPeter Grehan struct seg_desc *desc); 127366f6083SPeter Grehan int vm_run(struct vm *vm, struct vm_run *vmrun); 128f0fdcfe2SNeel Natu int vm_suspend(struct vm *vm, enum vm_suspend_how how); 129366f6083SPeter Grehan int vm_inject_nmi(struct vm *vm, int vcpu); 130f352ff0cSNeel Natu int vm_nmi_pending(struct vm *vm, int vcpuid); 131f352ff0cSNeel Natu void vm_nmi_clear(struct vm *vm, int vcpuid); 1320775fbb4STycho Nightingale int vm_inject_extint(struct vm *vm, int vcpu); 1330775fbb4STycho Nightingale int vm_extint_pending(struct vm *vm, int vcpuid); 1340775fbb4STycho Nightingale void vm_extint_clear(struct vm *vm, int vcpuid); 135366f6083SPeter Grehan uint64_t *vm_guest_msrs(struct vm *vm, int cpu); 136366f6083SPeter Grehan struct vlapic *vm_lapic(struct vm *vm, int cpu); 137565bbb86SNeel Natu struct vioapic *vm_ioapic(struct vm *vm); 13808e3ff32SNeel Natu struct vhpet *vm_hpet(struct vm *vm); 139366f6083SPeter Grehan int vm_get_capability(struct vm *vm, int vcpu, int type, int *val); 140366f6083SPeter Grehan int vm_set_capability(struct vm *vm, int vcpu, int type, int val); 141e9027382SNeel Natu int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state); 142e9027382SNeel Natu int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state); 143565bbb86SNeel Natu int vm_apicid2vcpuid(struct vm *vm, int apicid); 14495ebc360SNeel Natu int vm_activate_cpu(struct vm *vm, int vcpu); 145a5615c90SPeter Grehan cpuset_t vm_active_cpus(struct vm *vm); 14695ebc360SNeel Natu cpuset_t vm_suspended_cpus(struct vm *vm); 14798ed632cSNeel Natu struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid); 148f0fdcfe2SNeel Natu void vm_exit_suspended(struct vm *vm, int vcpuid, uint64_t rip); 149366f6083SPeter Grehan 150366f6083SPeter Grehan /* 1515b8a8cd1SNeel Natu * Rendezvous all vcpus specified in 'dest' and execute 'func(arg)'. 1525b8a8cd1SNeel Natu * The rendezvous 'func(arg)' is not allowed to do anything that will 1535b8a8cd1SNeel Natu * cause the thread to be put to sleep. 1545b8a8cd1SNeel Natu * 1555b8a8cd1SNeel Natu * If the rendezvous is being initiated from a vcpu context then the 1565b8a8cd1SNeel Natu * 'vcpuid' must refer to that vcpu, otherwise it should be set to -1. 1575b8a8cd1SNeel Natu * 1585b8a8cd1SNeel Natu * The caller cannot hold any locks when initiating the rendezvous. 1595b8a8cd1SNeel Natu * 1605b8a8cd1SNeel Natu * The implementation of this API may cause vcpus other than those specified 1615b8a8cd1SNeel Natu * by 'dest' to be stalled. The caller should not rely on any vcpus making 1625b8a8cd1SNeel Natu * forward progress when the rendezvous is in progress. 1635b8a8cd1SNeel Natu */ 1645b8a8cd1SNeel Natu typedef void (*vm_rendezvous_func_t)(struct vm *vm, int vcpuid, void *arg); 1655b8a8cd1SNeel Natu void vm_smp_rendezvous(struct vm *vm, int vcpuid, cpuset_t dest, 1665b8a8cd1SNeel Natu vm_rendezvous_func_t func, void *arg); 1675b8a8cd1SNeel Natu 1685b8a8cd1SNeel Natu static __inline int 1695b8a8cd1SNeel Natu vcpu_rendezvous_pending(void *rendezvous_cookie) 1705b8a8cd1SNeel Natu { 1715b8a8cd1SNeel Natu 1725b8a8cd1SNeel Natu return (*(uintptr_t *)rendezvous_cookie != 0); 1735b8a8cd1SNeel Natu } 1745b8a8cd1SNeel Natu 175b15a09c0SNeel Natu static __inline int 176b15a09c0SNeel Natu vcpu_suspended(void *suspend_cookie) 177b15a09c0SNeel Natu { 178b15a09c0SNeel Natu 179b15a09c0SNeel Natu return (*(int *)suspend_cookie); 180b15a09c0SNeel Natu } 181b15a09c0SNeel Natu 1825b8a8cd1SNeel Natu /* 183366f6083SPeter Grehan * Return 1 if device indicated by bus/slot/func is supposed to be a 184366f6083SPeter Grehan * pci passthrough device. 185366f6083SPeter Grehan * 186366f6083SPeter Grehan * Return 0 otherwise. 187366f6083SPeter Grehan */ 188366f6083SPeter Grehan int vmm_is_pptdev(int bus, int slot, int func); 189366f6083SPeter Grehan 190366f6083SPeter Grehan void *vm_iommu_domain(struct vm *vm); 191366f6083SPeter Grehan 19275dd3366SNeel Natu enum vcpu_state { 19375dd3366SNeel Natu VCPU_IDLE, 194318224bbSNeel Natu VCPU_FROZEN, 19575dd3366SNeel Natu VCPU_RUNNING, 196318224bbSNeel Natu VCPU_SLEEPING, 19775dd3366SNeel Natu }; 198366f6083SPeter Grehan 199f80330a8SNeel Natu int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state, 200f80330a8SNeel Natu bool from_idle); 201d3c11f40SPeter Grehan enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu); 202366f6083SPeter Grehan 203366f6083SPeter Grehan static int __inline 204d3c11f40SPeter Grehan vcpu_is_running(struct vm *vm, int vcpu, int *hostcpu) 205366f6083SPeter Grehan { 206d3c11f40SPeter Grehan return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING); 207366f6083SPeter Grehan } 208366f6083SPeter Grehan 20975dd3366SNeel Natu void *vcpu_stats(struct vm *vm, int vcpu); 210de5ea6b6SNeel Natu void vcpu_notify_event(struct vm *vm, int vcpuid, bool lapic_intr); 211318224bbSNeel Natu struct vmspace *vm_get_vmspace(struct vm *vm); 212318224bbSNeel Natu int vm_assign_pptdev(struct vm *vm, int bus, int slot, int func); 213318224bbSNeel Natu int vm_unassign_pptdev(struct vm *vm, int bus, int slot, int func); 214762fd208STycho Nightingale struct vatpic *vm_atpic(struct vm *vm); 215e883c9bbSTycho Nightingale struct vatpit *vm_atpit(struct vm *vm); 216dc506506SNeel Natu 217dc506506SNeel Natu /* 218dc506506SNeel Natu * Inject exception 'vme' into the guest vcpu. This function returns 0 on 219dc506506SNeel Natu * success and non-zero on failure. 220dc506506SNeel Natu * 221dc506506SNeel Natu * Wrapper functions like 'vm_inject_gp()' should be preferred to calling 222dc506506SNeel Natu * this function directly because they enforce the trap-like or fault-like 223dc506506SNeel Natu * behavior of an exception. 224dc506506SNeel Natu * 225dc506506SNeel Natu * This function should only be called in the context of the thread that is 226dc506506SNeel Natu * executing this vcpu. 227dc506506SNeel Natu */ 228dc506506SNeel Natu int vm_inject_exception(struct vm *vm, int vcpuid, struct vm_exception *vme); 229dc506506SNeel Natu 230dc506506SNeel Natu /* 231dc506506SNeel Natu * Returns 0 if there is no exception pending for this vcpu. Returns 1 if an 232dc506506SNeel Natu * exception is pending and also updates 'vme'. The pending exception is 233dc506506SNeel Natu * cleared when this function returns. 234dc506506SNeel Natu * 235dc506506SNeel Natu * This function should only be called in the context of the thread that is 236dc506506SNeel Natu * executing this vcpu. 237dc506506SNeel Natu */ 238dc506506SNeel Natu int vm_exception_pending(struct vm *vm, int vcpuid, struct vm_exception *vme); 239dc506506SNeel Natu 240dc506506SNeel Natu void vm_inject_gp(struct vm *vm, int vcpuid); /* general protection fault */ 241dc506506SNeel Natu void vm_inject_ud(struct vm *vm, int vcpuid); /* undefined instruction fault */ 24237a723a5SNeel Natu void vm_inject_pf(struct vm *vm, int vcpuid, int error_code, uint64_t cr2); 243dc506506SNeel Natu 244d17b5104SNeel Natu enum vm_reg_name vm_segment_name(int seg_encoding); 245d17b5104SNeel Natu 246366f6083SPeter Grehan #endif /* KERNEL */ 247366f6083SPeter Grehan 2488d39ed16SPeter Grehan #define VM_MAXCPU 16 /* maximum virtual cpus */ 249366f6083SPeter Grehan 250366f6083SPeter Grehan /* 251366f6083SPeter Grehan * Identifiers for architecturally defined registers. 252366f6083SPeter Grehan */ 253366f6083SPeter Grehan enum vm_reg_name { 254366f6083SPeter Grehan VM_REG_GUEST_RAX, 255366f6083SPeter Grehan VM_REG_GUEST_RBX, 256366f6083SPeter Grehan VM_REG_GUEST_RCX, 257366f6083SPeter Grehan VM_REG_GUEST_RDX, 258366f6083SPeter Grehan VM_REG_GUEST_RSI, 259366f6083SPeter Grehan VM_REG_GUEST_RDI, 260366f6083SPeter Grehan VM_REG_GUEST_RBP, 261366f6083SPeter Grehan VM_REG_GUEST_R8, 262366f6083SPeter Grehan VM_REG_GUEST_R9, 263366f6083SPeter Grehan VM_REG_GUEST_R10, 264366f6083SPeter Grehan VM_REG_GUEST_R11, 265366f6083SPeter Grehan VM_REG_GUEST_R12, 266366f6083SPeter Grehan VM_REG_GUEST_R13, 267366f6083SPeter Grehan VM_REG_GUEST_R14, 268366f6083SPeter Grehan VM_REG_GUEST_R15, 269366f6083SPeter Grehan VM_REG_GUEST_CR0, 270366f6083SPeter Grehan VM_REG_GUEST_CR3, 271366f6083SPeter Grehan VM_REG_GUEST_CR4, 272366f6083SPeter Grehan VM_REG_GUEST_DR7, 273366f6083SPeter Grehan VM_REG_GUEST_RSP, 274366f6083SPeter Grehan VM_REG_GUEST_RIP, 275366f6083SPeter Grehan VM_REG_GUEST_RFLAGS, 276366f6083SPeter Grehan VM_REG_GUEST_ES, 277366f6083SPeter Grehan VM_REG_GUEST_CS, 278366f6083SPeter Grehan VM_REG_GUEST_SS, 279366f6083SPeter Grehan VM_REG_GUEST_DS, 280366f6083SPeter Grehan VM_REG_GUEST_FS, 281366f6083SPeter Grehan VM_REG_GUEST_GS, 282366f6083SPeter Grehan VM_REG_GUEST_LDTR, 283366f6083SPeter Grehan VM_REG_GUEST_TR, 284366f6083SPeter Grehan VM_REG_GUEST_IDTR, 285366f6083SPeter Grehan VM_REG_GUEST_GDTR, 286366f6083SPeter Grehan VM_REG_GUEST_EFER, 28737a723a5SNeel Natu VM_REG_GUEST_CR2, 288366f6083SPeter Grehan VM_REG_LAST 289366f6083SPeter Grehan }; 290366f6083SPeter Grehan 291366f6083SPeter Grehan /* 292366f6083SPeter Grehan * Identifiers for optional vmm capabilities 293366f6083SPeter Grehan */ 294366f6083SPeter Grehan enum vm_cap_type { 295366f6083SPeter Grehan VM_CAP_HALT_EXIT, 296366f6083SPeter Grehan VM_CAP_MTRAP_EXIT, 297366f6083SPeter Grehan VM_CAP_PAUSE_EXIT, 298366f6083SPeter Grehan VM_CAP_UNRESTRICTED_GUEST, 29949cc03daSNeel Natu VM_CAP_ENABLE_INVPCID, 300366f6083SPeter Grehan VM_CAP_MAX 301366f6083SPeter Grehan }; 302366f6083SPeter Grehan 303e9027382SNeel Natu enum x2apic_state { 304e9027382SNeel Natu X2APIC_DISABLED, 30552e5c8a2SNeel Natu X2APIC_ENABLED, 306e9027382SNeel Natu X2APIC_STATE_LAST 307e9027382SNeel Natu }; 308e9027382SNeel Natu 309b3e9732aSJohn Baldwin enum vm_intr_trigger { 310b3e9732aSJohn Baldwin EDGE_TRIGGER, 311b3e9732aSJohn Baldwin LEVEL_TRIGGER 312b3e9732aSJohn Baldwin }; 313b3e9732aSJohn Baldwin 314366f6083SPeter Grehan /* 315366f6083SPeter Grehan * The 'access' field has the format specified in Table 21-2 of the Intel 316366f6083SPeter Grehan * Architecture Manual vol 3b. 317366f6083SPeter Grehan * 318366f6083SPeter Grehan * XXX The contents of the 'access' field are architecturally defined except 319366f6083SPeter Grehan * bit 16 - Segment Unusable. 320366f6083SPeter Grehan */ 321366f6083SPeter Grehan struct seg_desc { 322366f6083SPeter Grehan uint64_t base; 323366f6083SPeter Grehan uint32_t limit; 324366f6083SPeter Grehan uint32_t access; 325366f6083SPeter Grehan }; 32665ffa035SNeel Natu #define SEG_DESC_TYPE(desc) ((desc)->access & 0x001f) 32765ffa035SNeel Natu #define SEG_DESC_PRESENT(desc) ((desc)->access & 0x0080) 32865ffa035SNeel Natu #define SEG_DESC_DEF32(desc) ((desc)->access & 0x4000) 32965ffa035SNeel Natu #define SEG_DESC_GRANULARITY(desc) ((desc)->access & 0x8000) 33065ffa035SNeel Natu #define SEG_DESC_UNUSABLE(desc) ((desc)->access & 0x10000) 331366f6083SPeter Grehan 332e813a873SNeel Natu enum vm_cpu_mode { 333e813a873SNeel Natu CPU_MODE_COMPATIBILITY, /* IA-32E mode (CS.L = 0) */ 334e813a873SNeel Natu CPU_MODE_64BIT, /* IA-32E mode (CS.L = 1) */ 335e813a873SNeel Natu }; 336e813a873SNeel Natu 337e813a873SNeel Natu enum vm_paging_mode { 338e813a873SNeel Natu PAGING_MODE_FLAT, 339e813a873SNeel Natu PAGING_MODE_32, 340e813a873SNeel Natu PAGING_MODE_PAE, 341e813a873SNeel Natu PAGING_MODE_64, 342e813a873SNeel Natu }; 343e813a873SNeel Natu 344e813a873SNeel Natu struct vm_guest_paging { 345e813a873SNeel Natu uint64_t cr3; 346e813a873SNeel Natu int cpl; 347e813a873SNeel Natu enum vm_cpu_mode cpu_mode; 348e813a873SNeel Natu enum vm_paging_mode paging_mode; 349e813a873SNeel Natu }; 350e813a873SNeel Natu 351e813a873SNeel Natu /* 352e813a873SNeel Natu * The data structures 'vie' and 'vie_op' are meant to be opaque to the 353e813a873SNeel Natu * consumers of instruction decoding. The only reason why their contents 354e813a873SNeel Natu * need to be exposed is because they are part of the 'vm_exit' structure. 355e813a873SNeel Natu */ 356e813a873SNeel Natu struct vie_op { 357e813a873SNeel Natu uint8_t op_byte; /* actual opcode byte */ 358e813a873SNeel Natu uint8_t op_type; /* type of operation (e.g. MOV) */ 359e813a873SNeel Natu uint16_t op_flags; 360e813a873SNeel Natu }; 361e813a873SNeel Natu 362e813a873SNeel Natu #define VIE_INST_SIZE 15 363e813a873SNeel Natu struct vie { 364e813a873SNeel Natu uint8_t inst[VIE_INST_SIZE]; /* instruction bytes */ 365e813a873SNeel Natu uint8_t num_valid; /* size of the instruction */ 366e813a873SNeel Natu uint8_t num_processed; 367e813a873SNeel Natu 368e813a873SNeel Natu uint8_t rex_w:1, /* REX prefix */ 369e813a873SNeel Natu rex_r:1, 370e813a873SNeel Natu rex_x:1, 371e813a873SNeel Natu rex_b:1, 372e813a873SNeel Natu rex_present:1; 373e813a873SNeel Natu 374e813a873SNeel Natu uint8_t mod:2, /* ModRM byte */ 375e813a873SNeel Natu reg:4, 376e813a873SNeel Natu rm:4; 377e813a873SNeel Natu 378e813a873SNeel Natu uint8_t ss:2, /* SIB byte */ 379e813a873SNeel Natu index:4, 380e813a873SNeel Natu base:4; 381e813a873SNeel Natu 382e813a873SNeel Natu uint8_t disp_bytes; 383e813a873SNeel Natu uint8_t imm_bytes; 384e813a873SNeel Natu 385e813a873SNeel Natu uint8_t scale; 386e813a873SNeel Natu int base_register; /* VM_REG_GUEST_xyz */ 387e813a873SNeel Natu int index_register; /* VM_REG_GUEST_xyz */ 388e813a873SNeel Natu 389e813a873SNeel Natu int64_t displacement; /* optional addr displacement */ 390e813a873SNeel Natu int64_t immediate; /* optional immediate operand */ 391e813a873SNeel Natu 392e813a873SNeel Natu uint8_t decoded; /* set to 1 if successfully decoded */ 393e813a873SNeel Natu 394e813a873SNeel Natu struct vie_op op; /* opcode description */ 395e813a873SNeel Natu }; 396e813a873SNeel Natu 397366f6083SPeter Grehan enum vm_exitcode { 398366f6083SPeter Grehan VM_EXITCODE_INOUT, 399366f6083SPeter Grehan VM_EXITCODE_VMX, 400366f6083SPeter Grehan VM_EXITCODE_BOGUS, 401366f6083SPeter Grehan VM_EXITCODE_RDMSR, 402366f6083SPeter Grehan VM_EXITCODE_WRMSR, 403366f6083SPeter Grehan VM_EXITCODE_HLT, 404366f6083SPeter Grehan VM_EXITCODE_MTRAP, 405366f6083SPeter Grehan VM_EXITCODE_PAUSE, 406cd942e0fSPeter Grehan VM_EXITCODE_PAGING, 407318224bbSNeel Natu VM_EXITCODE_INST_EMUL, 408edf89256SNeel Natu VM_EXITCODE_SPINUP_AP, 409c6a0cc2eSNeel Natu VM_EXITCODE_DEPRECATED1, /* used to be SPINDOWN_CPU */ 4105b8a8cd1SNeel Natu VM_EXITCODE_RENDEZVOUS, 41130b94db8SNeel Natu VM_EXITCODE_IOAPIC_EOI, 412b15a09c0SNeel Natu VM_EXITCODE_SUSPENDED, 413d17b5104SNeel Natu VM_EXITCODE_INOUT_STR, 414cd942e0fSPeter Grehan VM_EXITCODE_MAX 415366f6083SPeter Grehan }; 416366f6083SPeter Grehan 417d17b5104SNeel Natu struct vm_inout { 418d17b5104SNeel Natu uint16_t bytes:3; /* 1 or 2 or 4 */ 419d17b5104SNeel Natu uint16_t in:1; 420d17b5104SNeel Natu uint16_t string:1; 421d17b5104SNeel Natu uint16_t rep:1; 422d17b5104SNeel Natu uint16_t port; 423d17b5104SNeel Natu uint32_t eax; /* valid for out */ 424d17b5104SNeel Natu }; 425d17b5104SNeel Natu 426d17b5104SNeel Natu struct vm_inout_str { 427d17b5104SNeel Natu struct vm_inout inout; /* must be the first element */ 428e813a873SNeel Natu struct vm_guest_paging paging; 429d17b5104SNeel Natu uint64_t rflags; 430d17b5104SNeel Natu uint64_t cr0; 431d17b5104SNeel Natu uint64_t index; 432d17b5104SNeel Natu uint64_t count; /* rep=1 (%rcx), rep=0 (1) */ 433d17b5104SNeel Natu int addrsize; 434d17b5104SNeel Natu enum vm_reg_name seg_name; 435d17b5104SNeel Natu struct seg_desc seg_desc; 436d17b5104SNeel Natu }; 437d17b5104SNeel Natu 438366f6083SPeter Grehan struct vm_exit { 439366f6083SPeter Grehan enum vm_exitcode exitcode; 440366f6083SPeter Grehan int inst_length; /* 0 means unknown */ 441366f6083SPeter Grehan uint64_t rip; 442366f6083SPeter Grehan union { 443d17b5104SNeel Natu struct vm_inout inout; 444d17b5104SNeel Natu struct vm_inout_str inout_str; 445cd942e0fSPeter Grehan struct { 44613ec9371SPeter Grehan uint64_t gpa; 447318224bbSNeel Natu int fault_type; 448cd942e0fSPeter Grehan } paging; 449318224bbSNeel Natu struct { 450318224bbSNeel Natu uint64_t gpa; 451318224bbSNeel Natu uint64_t gla; 452e813a873SNeel Natu struct vm_guest_paging paging; 453318224bbSNeel Natu struct vie vie; 454318224bbSNeel Natu } inst_emul; 455366f6083SPeter Grehan /* 456366f6083SPeter Grehan * VMX specific payload. Used when there is no "better" 457366f6083SPeter Grehan * exitcode to represent the VM-exit. 458366f6083SPeter Grehan */ 459366f6083SPeter Grehan struct { 4600492757cSNeel Natu int status; /* vmx inst status */ 4610492757cSNeel Natu /* 4620492757cSNeel Natu * 'exit_reason' and 'exit_qualification' are valid 4630492757cSNeel Natu * only if 'status' is zero. 4640492757cSNeel Natu */ 465366f6083SPeter Grehan uint32_t exit_reason; 466366f6083SPeter Grehan uint64_t exit_qualification; 4670492757cSNeel Natu /* 4680492757cSNeel Natu * 'inst_error' and 'inst_type' are valid 4690492757cSNeel Natu * only if 'status' is non-zero. 4700492757cSNeel Natu */ 4710492757cSNeel Natu int inst_type; 4720492757cSNeel Natu int inst_error; 473366f6083SPeter Grehan } vmx; 474366f6083SPeter Grehan struct { 475366f6083SPeter Grehan uint32_t code; /* ecx value */ 476366f6083SPeter Grehan uint64_t wval; 477366f6083SPeter Grehan } msr; 478edf89256SNeel Natu struct { 479edf89256SNeel Natu int vcpu; 480edf89256SNeel Natu uint64_t rip; 481edf89256SNeel Natu } spinup_ap; 4821c052192SNeel Natu struct { 4831c052192SNeel Natu uint64_t rflags; 4841c052192SNeel Natu } hlt; 48530b94db8SNeel Natu struct { 48630b94db8SNeel Natu int vector; 48730b94db8SNeel Natu } ioapic_eoi; 488f0fdcfe2SNeel Natu struct { 489f0fdcfe2SNeel Natu enum vm_suspend_how how; 490f0fdcfe2SNeel Natu } suspended; 491366f6083SPeter Grehan } u; 492366f6083SPeter Grehan }; 493366f6083SPeter Grehan 494366f6083SPeter Grehan #endif /* _VMM_H_ */ 495