sys/amd64/vmm/intel/vmx.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 _VMX_H_
  30 #define _VMX_H_
  31
  32 #include "vmcs.h"
  33
  34 struct pmap;
  35
  36 struct vmxctx {
  37         register_t      guest_rdi;              /* Guest state */
  38         register_t      guest_rsi;
  39         register_t      guest_rdx;
  40         register_t      guest_rcx;
  41         register_t      guest_r8;
  42         register_t      guest_r9;
  43         register_t      guest_rax;
  44         register_t      guest_rbx;
  45         register_t      guest_rbp;
  46         register_t      guest_r10;
  47         register_t      guest_r11;
  48         register_t      guest_r12;
  49         register_t      guest_r13;
  50         register_t      guest_r14;
  51         register_t      guest_r15;
  52         register_t      guest_cr2;
  53
  54         register_t      host_r15;               /* Host state */
  55         register_t      host_r14;
  56         register_t      host_r13;
  57         register_t      host_r12;
  58         register_t      host_rbp;
  59         register_t      host_rsp;
  60         register_t      host_rbx;
  61         /*
  62          * XXX todo debug registers and fpu state
  63          */
  64
  65         int             inst_fail_status;
  66
  67         /*
  68          * The pmap needs to be deactivated in vmx_enter_guest()
  69          * so keep a copy of the 'pmap' in each vmxctx.
  70          */
  71         struct pmap     *pmap;
  72 };
  73
  74 struct vmxcap {
  75         int     set;
  76         uint32_t proc_ctls;
  77         uint32_t proc_ctls2;
  78 };
  79
  80 struct vmxstate {
  81         uint64_t nextrip;       /* next instruction to be executed by guest */
  82         int     lastcpu;        /* host cpu that this 'vcpu' last ran on */
  83         uint16_t vpid;
  84 };
  85
  86 struct apic_page {
  87         uint32_t reg[PAGE_SIZE / 4];
  88 };
  89 CTASSERT(sizeof(struct apic_page) == PAGE_SIZE);
  90
  91 /* Posted Interrupt Descriptor (described in section 29.6 of the Intel SDM) */
  92 struct pir_desc {
  93         uint64_t        pir[4];
  94         uint64_t        pending;
  95         uint64_t        unused[3];
  96 } __aligned(64);
  97 CTASSERT(sizeof(struct pir_desc) == 64);
  98
  99 /* Index into the 'guest_msrs[]' array */
 100 enum {
 101         IDX_MSR_LSTAR,
 102         IDX_MSR_CSTAR,
 103         IDX_MSR_STAR,
 104         IDX_MSR_SF_MASK,
 105         IDX_MSR_KGSBASE,
 106         IDX_MSR_PAT,
 107         GUEST_MSR_NUM           /* must be the last enumeration */
 108 };
 109
 110 /* virtual machine softc */
 111 struct vmx {
 112         struct vmcs     vmcs[VM_MAXCPU];        /* one vmcs per virtual cpu */
 113         struct apic_page apic_page[VM_MAXCPU];  /* one apic page per vcpu */
 114         char            msr_bitmap[PAGE_SIZE];
 115         struct pir_desc pir_desc[VM_MAXCPU];
 116         uint64_t        guest_msrs[VM_MAXCPU][GUEST_MSR_NUM];
 117         struct vmxctx   ctx[VM_MAXCPU];
 118         struct vmxcap   cap[VM_MAXCPU];
 119         struct vmxstate state[VM_MAXCPU];
 120         uint64_t        eptp;
 121         struct vm       *vm;
 122         long            eptgen[MAXCPU];         /* cached pmap->pm_eptgen */
 123 };
 124 CTASSERT((offsetof(struct vmx, vmcs) & PAGE_MASK) == 0);
 125 CTASSERT((offsetof(struct vmx, msr_bitmap) & PAGE_MASK) == 0);
 126 CTASSERT((offsetof(struct vmx, pir_desc[0]) & 63) == 0);
 127
 128 #define VMX_GUEST_VMEXIT        0
 129 #define VMX_VMRESUME_ERROR      1
 130 #define VMX_VMLAUNCH_ERROR      2
 131 #define VMX_INVEPT_ERROR        3
 132 int     vmx_enter_guest(struct vmxctx *ctx, struct vmx *vmx, int launched);
 133 void    vmx_call_isr(uintptr_t entry);
 134
 135 u_long  vmx_fix_cr0(u_long cr0);
 136 u_long  vmx_fix_cr4(u_long cr4);
 137
 138 int     vmx_set_tsc_offset(struct vmx *vmx, int vcpu, uint64_t offset);
 139
 140 extern char     vmx_exit_guest[];
 141
 142 #endif