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 register_t guest_dr0; 56 register_t guest_dr1; 57 register_t guest_dr2; 58 register_t guest_dr3; 59 register_t guest_dr6; 60 61 register_t host_r15; /* Host state */ 62 register_t host_r14; 63 register_t host_r13; 64 register_t host_r12; 65 register_t host_rbp; 66 register_t host_rsp; 67 register_t host_rbx; 68 register_t host_dr0; 69 register_t host_dr1; 70 register_t host_dr2; 71 register_t host_dr3; 72 register_t host_dr6; 73 register_t host_dr7; 74 uint64_t host_debugctl; 75 int host_tf; 76 77 int inst_fail_status; 78 79 /* 80 * The pmap needs to be deactivated in vmx_enter_guest() 81 * so keep a copy of the 'pmap' in each vmxctx. 82 */ 83 struct pmap *pmap; 84}; 85 86 struct vmxcap { 87 int set; 88 uint32_t proc_ctls; 89 uint32_t proc_ctls2; 90 uint32_t exc_bitmap; 91}; 92 93 struct vmxstate { 94 uint64_t nextrip; /* next instruction to be executed by guest */ 95 int lastcpu; /* host cpu that this 'vcpu' last ran on */ 96 uint16_t vpid; 97}; 98 99 struct apic_page { 100 uint32_t reg[PAGE_SIZE / 4]; 101}; 102 CTASSERT(sizeof(struct apic_page) == PAGE_SIZE); 103 104 /* Posted Interrupt Descriptor (described in section 29.6 of the Intel SDM) */ 105 struct pir_desc { 106 uint64_t pir[4]; 107 uint64_t pending; 108 uint64_t unused[3]; 109} __aligned(64); 110 CTASSERT(sizeof(struct pir_desc) == 64); 111 112 /* Index into the 'guest_msrs[]' array */ 113 enum { 114 IDX_MSR_LSTAR, 115 IDX_MSR_CSTAR, 116 IDX_MSR_STAR, 117 IDX_MSR_SF_MASK, 118 IDX_MSR_KGSBASE, 119 IDX_MSR_PAT, 120 IDX_MSR_TSC_AUX, 121 GUEST_MSR_NUM /* must be the last enumeration */ 122}; 123 124 /* virtual machine softc */ 125 struct vmx { 126 struct vmcs vmcs[VM_MAXCPU]; /* one vmcs per virtual cpu */ 127 struct apic_page apic_page[VM_MAXCPU]; /* one apic page per vcpu */ 128 char msr_bitmap[PAGE_SIZE]; 129 struct pir_desc pir_desc[VM_MAXCPU]; 130 uint64_t guest_msrs[VM_MAXCPU][GUEST_MSR_NUM]; 131 struct vmxctx ctx[VM_MAXCPU]; 132 struct vmxcap cap[VM_MAXCPU]; 133 struct vmxstate state[VM_MAXCPU]; 134 uint64_t eptp; 135 struct vm *vm; 136 long eptgen[MAXCPU]; /* cached pmap->pm_eptgen */ 137}; 138 CTASSERT((offsetof(struct vmx, vmcs) & PAGE_MASK) == 0); 139 CTASSERT((offsetof(struct vmx, msr_bitmap) & PAGE_MASK) == 0); 140 CTASSERT((offsetof(struct vmx, pir_desc[0]) & 63) == 0); 141 142#define VMX_GUEST_VMEXIT 0 143#define VMX_VMRESUME_ERROR 1 144#define VMX_VMLAUNCH_ERROR 2 145 int vmx_enter_guest(struct vmxctx *ctx, struct vmx *vmx, int launched); 146 void vmx_call_isr(uintptr_t entry); 147 148 u_long vmx_fix_cr0(u_long cr0); 149 u_long vmx_fix_cr4(u_long cr4); 150 151 int vmx_set_tsc_offset(struct vmx *vmx, int vcpu, uint64_t offset); 152 153 extern char vmx_exit_guest[]; 154 extern char vmx_exit_guest_flush_rsb[]; 155 156 static inline bool 157 vmx_have_msr_tsc_aux(struct vmx *vmx) 158{ 159 int rdpid_rdtscp_bits = ((1 << VM_CAP_RDPID) | (1 << VM_CAP_RDTSCP)); 160 161 /* 162 * Since the values of these bits are uniform across all vCPUs 163 * (see discussion in vmx_modinit() and initialization of these bits 164 * in vmx_init()), just always use vCPU-zero's capability set and 165 * remove the need to require a vcpuid argument. 166 */ 167 return ((vmx->cap[0].set & rdpid_rdtscp_bits) != 0); 168} 169 170#endif 171