sys/amd64/include/vmm.h

   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$
  27  */
  28
  29 #ifndef _VMM_H_
  30 #define _VMM_H_
  31
  32 #ifdef _KERNEL
  33
  34 #define VM_MAX_NAMELEN  32
  35
  36 struct vm;
  37 struct vm_memory_segment;
  38 struct seg_desc;
  39 struct vm_exit;
  40 struct vm_run;
  41 struct vlapic;
  42
  43 enum x2apic_state;
  44
  45 typedef int     (*vmm_init_func_t)(void);
  46 typedef int     (*vmm_cleanup_func_t)(void);
  47 typedef void *  (*vmi_init_func_t)(struct vm *vm); /* instance specific apis */
  48 typedef int     (*vmi_run_func_t)(void *vmi, int vcpu, register_t rip);
  49 typedef void    (*vmi_cleanup_func_t)(void *vmi);
  50 typedef 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);
  54 typedef vm_paddr_t (*vmi_mmap_get_func_t)(void *vmi, vm_paddr_t gpa);
  55 typedef int     (*vmi_get_register_t)(void *vmi, int vcpu, int num,
  56                                       uint64_t *retval);
  57 typedef int     (*vmi_set_register_t)(void *vmi, int vcpu, int num,
  58                                       uint64_t val);
  59 typedef int     (*vmi_get_desc_t)(void *vmi, int vcpu, int num,
  60                                   struct seg_desc *desc);
  61 typedef int     (*vmi_set_desc_t)(void *vmi, int vcpu, int num,
  62                                   struct seg_desc *desc);
  63 typedef int     (*vmi_inject_event_t)(void *vmi, int vcpu,
  64                                       int type, int vector,
  65                                       uint32_t code, int code_valid);
  66 typedef int     (*vmi_get_cap_t)(void *vmi, int vcpu, int num, int *retval);
  67 typedef int     (*vmi_set_cap_t)(void *vmi, int vcpu, int num, int val);
  68
  69 struct vmm_ops {
  70         vmm_init_func_t         init;           /* module wide initialization */
  71         vmm_cleanup_func_t      cleanup;
  72
  73         vmi_init_func_t         vminit;         /* vm-specific initialization */
  74         vmi_run_func_t          vmrun;
  75         vmi_cleanup_func_t      vmcleanup;
  76         vmi_mmap_set_func_t     vmmmap_set;
  77         vmi_mmap_get_func_t     vmmmap_get;
  78         vmi_get_register_t      vmgetreg;
  79         vmi_set_register_t      vmsetreg;
  80         vmi_get_desc_t          vmgetdesc;
  81         vmi_set_desc_t          vmsetdesc;
  82         vmi_inject_event_t      vminject;
  83         vmi_get_cap_t           vmgetcap;
  84         vmi_set_cap_t           vmsetcap;
  85 };
  86
  87 extern struct vmm_ops vmm_ops_intel;
  88 extern struct vmm_ops vmm_ops_amd;
  89
  90 int vm_create(const char *name, struct vm **retvm);
  91 void vm_destroy(struct vm *vm);
  92 const char *vm_name(struct vm *vm);
  93 int vm_malloc(struct vm *vm, vm_paddr_t gpa, size_t len);
  94 int vm_map_mmio(struct vm *vm, vm_paddr_t gpa, size_t len, vm_paddr_t hpa);
  95 int vm_unmap_mmio(struct vm *vm, vm_paddr_t gpa, size_t len);
  96 vm_paddr_t vm_gpa2hpa(struct vm *vm, vm_paddr_t gpa, size_t size);
  97 int vm_gpabase2memseg(struct vm *vm, vm_paddr_t gpabase,
  98               struct vm_memory_segment *seg);
  99 int vm_get_register(struct vm *vm, int vcpu, int reg, uint64_t *retval);
 100 int vm_set_register(struct vm *vm, int vcpu, int reg, uint64_t val);
 101 int vm_get_seg_desc(struct vm *vm, int vcpu, int reg,
 102                     struct seg_desc *ret_desc);
 103 int vm_set_seg_desc(struct vm *vm, int vcpu, int reg,
 104                     struct seg_desc *desc);
 105 int vm_run(struct vm *vm, struct vm_run *vmrun);
 106 int vm_inject_event(struct vm *vm, int vcpu, int type,
 107                     int vector, uint32_t error_code, int error_code_valid);
 108 int vm_inject_nmi(struct vm *vm, int vcpu);
 109 int vm_nmi_pending(struct vm *vm, int vcpuid);
 110 void vm_nmi_clear(struct vm *vm, int vcpuid);
 111 uint64_t *vm_guest_msrs(struct vm *vm, int cpu);
 112 struct vlapic *vm_lapic(struct vm *vm, int cpu);
 113 int vm_get_capability(struct vm *vm, int vcpu, int type, int *val);
 114 int vm_set_capability(struct vm *vm, int vcpu, int type, int val);
 115 int vm_get_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state *state);
 116 int vm_set_x2apic_state(struct vm *vm, int vcpu, enum x2apic_state state);
 117 void vm_activate_cpu(struct vm *vm, int vcpu);
 118 cpuset_t vm_active_cpus(struct vm *vm);
 119 struct vm_exit *vm_exitinfo(struct vm *vm, int vcpuid);
 120
 121 /*
 122  * Return 1 if device indicated by bus/slot/func is supposed to be a
 123  * pci passthrough device.
 124  *
 125  * Return 0 otherwise.
 126  */
 127 int vmm_is_pptdev(int bus, int slot, int func);
 128
 129 void *vm_iommu_domain(struct vm *vm);
 130
 131 enum vcpu_state {
 132         VCPU_IDLE,
 133         VCPU_RUNNING,
 134         VCPU_CANNOT_RUN,
 135 };
 136
 137 int vcpu_set_state(struct vm *vm, int vcpu, enum vcpu_state state);
 138 enum vcpu_state vcpu_get_state(struct vm *vm, int vcpu, int *hostcpu);
 139
 140 static int __inline
 141 vcpu_is_running(struct vm *vm, int vcpu, int *hostcpu)
 142 {
 143         return (vcpu_get_state(vm, vcpu, hostcpu) == VCPU_RUNNING);
 144 }
 145
 146 void *vcpu_stats(struct vm *vm, int vcpu);
 147 void vm_interrupt_hostcpu(struct vm *vm, int vcpu);
 148
 149 #endif  /* KERNEL */
 150
 151 #include <machine/vmm_instruction_emul.h>
 152
 153 #define VM_MAXCPU       8                       /* maximum virtual cpus */
 154
 155 /*
 156  * Identifiers for events that can be injected into the VM
 157  */
 158 enum 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  */
 172 enum 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  */
 212 enum 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
 220 enum 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  */
 234 struct seg_desc {
 235         uint64_t        base;
 236         uint32_t        limit;
 237         uint32_t        access;
 238 };
 239
 240 enum 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
 254 struct 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        gpa;
 269                         struct vie      vie;
 270                 } paging;
 271                 /*
 272                  * VMX specific payload. Used when there is no "better"
 273                  * exitcode to represent the VM-exit.
 274                  */
 275                 struct {
 276                         int             error;          /* vmx inst error */
 277                         uint32_t        exit_reason;
 278                         uint64_t        exit_qualification;
 279                 } vmx;
 280                 struct {
 281                         uint32_t        code;           /* ecx value */
 282                         uint64_t        wval;
 283                 } msr;
 284                 struct {
 285                         int             vcpu;
 286                         uint64_t        rip;
 287                 } spinup_ap;
 288         } u;
 289 };
 290
 291 #endif  /* _VMM_H_ */