1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2011 NetApp, Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 * 28 * $FreeBSD$ 29 */ 30 31 #ifndef _VMX_H_ 32 #define _VMX_H_ 33 34 #include "vmcs.h" 35 36 struct pmap; 37 38 struct vmxctx { 39 register_t guest_rdi; /* Guest state */ 40 register_t guest_rsi; 41 register_t guest_rdx; 42 register_t guest_rcx; 43 register_t guest_r8; 44 register_t guest_r9; 45 register_t guest_rax; 46 register_t guest_rbx; 47 register_t guest_rbp; 48 register_t guest_r10; 49 register_t guest_r11; 50 register_t guest_r12; 51 register_t guest_r13; 52 register_t guest_r14; 53 register_t guest_r15; 54 register_t guest_cr2; 55 56 register_t host_r15; /* Host state */ 57 register_t host_r14; 58 register_t host_r13; 59 register_t host_r12; 60 register_t host_rbp; 61 register_t host_rsp; 62 register_t host_rbx; 63 /* 64 * XXX todo debug registers and fpu state 65 */ 66 67 int inst_fail_status; 68 69 /* 70 * The pmap needs to be deactivated in vmx_enter_guest() 71 * so keep a copy of the 'pmap' in each vmxctx. 72 */ 73 struct pmap *pmap; 74 }; 75 76 struct vmxcap { 77 int set; 78 uint32_t proc_ctls; 79 uint32_t proc_ctls2; 80 }; 81 82 struct vmxstate { 83 uint64_t nextrip; /* next instruction to be executed by guest */ 84 int lastcpu; /* host cpu that this 'vcpu' last ran on */ 85 uint16_t vpid; 86 }; 87 88 struct apic_page { 89 uint32_t reg[PAGE_SIZE / 4]; 90 }; 91 CTASSERT(sizeof(struct apic_page) == PAGE_SIZE); 92 93 /* Posted Interrupt Descriptor (described in section 29.6 of the Intel SDM) */ 94 struct pir_desc { 95 uint64_t pir[4]; 96 uint64_t pending; 97 uint64_t unused[3]; 98 } __aligned(64); 99 CTASSERT(sizeof(struct pir_desc) == 64); 100 101 /* Index into the 'guest_msrs[]' array */ 102 enum { 103 IDX_MSR_LSTAR, 104 IDX_MSR_CSTAR, 105 IDX_MSR_STAR, 106 IDX_MSR_SF_MASK, 107 IDX_MSR_KGSBASE, 108 IDX_MSR_PAT, 109 GUEST_MSR_NUM /* must be the last enumeration */ 110 }; 111 112 /* virtual machine softc */ 113 struct vmx { 114 struct vmcs vmcs[VM_MAXCPU]; /* one vmcs per virtual cpu */ 115 struct apic_page apic_page[VM_MAXCPU]; /* one apic page per vcpu */ 116 char msr_bitmap[PAGE_SIZE]; 117 struct pir_desc pir_desc[VM_MAXCPU]; 118 uint64_t guest_msrs[VM_MAXCPU][GUEST_MSR_NUM]; 119 struct vmxctx ctx[VM_MAXCPU]; 120 struct vmxcap cap[VM_MAXCPU]; 121 struct vmxstate state[VM_MAXCPU]; 122 uint64_t eptp; 123 struct vm *vm; 124 long eptgen[MAXCPU]; /* cached pmap->pm_eptgen */ 125 }; 126 CTASSERT((offsetof(struct vmx, vmcs) & PAGE_MASK) == 0); 127 CTASSERT((offsetof(struct vmx, msr_bitmap) & PAGE_MASK) == 0); 128 CTASSERT((offsetof(struct vmx, pir_desc[0]) & 63) == 0); 129 130 #define VMX_GUEST_VMEXIT 0 131 #define VMX_VMRESUME_ERROR 1 132 #define VMX_VMLAUNCH_ERROR 2 133 #define VMX_INVEPT_ERROR 3 134 int vmx_enter_guest(struct vmxctx *ctx, struct vmx *vmx, int launched); 135 void vmx_call_isr(uintptr_t entry); 136 137 u_long vmx_fix_cr0(u_long cr0); 138 u_long vmx_fix_cr4(u_long cr4); 139 140 int vmx_set_tsc_offset(struct vmx *vmx, int vcpu, uint64_t offset); 141 142 extern char vmx_exit_guest[]; 143 144 #endif 145