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 /* 32 * Copyright 2017 Joyent, Inc. 33 * Copyright 2020 Oxide Computer Company 34 */ 35 36 #ifndef _VMCS_H_ 37 #define _VMCS_H_ 38 39 #ifdef _KERNEL 40 #ifndef _ASM 41 struct vmcs { 42 uint32_t identifier; 43 uint32_t abort_code; 44 char _impl_specific[PAGE_SIZE - sizeof (uint32_t) * 2]; 45 }; 46 CTASSERT(sizeof (struct vmcs) == PAGE_SIZE); 47 48 uint32_t vmcs_field_encoding(int ident); 49 void vmcs_seg_desc_encoding(int seg, uint32_t *base, uint32_t *lim, 50 uint32_t *acc); 51 52 void vmcs_initialize(struct vmcs *vmcs, uintptr_t vmcs_pa); 53 54 void vmcs_load(uintptr_t vmcs_pa); 55 void vmcs_clear(uintptr_t vmcs_pa); 56 57 uint64_t vmcs_read(uint32_t encoding); 58 void vmcs_write(uint32_t encoding, uint64_t val); 59 60 #define vmexit_instruction_length() vmcs_read(VMCS_EXIT_INSTRUCTION_LENGTH) 61 #define vmcs_guest_rip() vmcs_read(VMCS_GUEST_RIP) 62 #define vmcs_instruction_error() vmcs_read(VMCS_INSTRUCTION_ERROR) 63 #define vmcs_exit_reason() (vmcs_read(VMCS_EXIT_REASON) & 0xffff) 64 #define vmcs_exit_qualification() vmcs_read(VMCS_EXIT_QUALIFICATION) 65 #define vmcs_guest_cr3() vmcs_read(VMCS_GUEST_CR3) 66 #define vmcs_gpa() vmcs_read(VMCS_GUEST_PHYSICAL_ADDRESS) 67 #define vmcs_gla() vmcs_read(VMCS_GUEST_LINEAR_ADDRESS) 68 #define vmcs_idt_vectoring_info() vmcs_read(VMCS_IDT_VECTORING_INFO) 69 #define vmcs_idt_vectoring_err() vmcs_read(VMCS_IDT_VECTORING_ERROR) 70 71 #endif /* _ASM */ 72 #endif /* _KERNEL */ 73 74 #define VMCS_INITIAL 0xffffffffffffffff 75 76 /* 77 * VMCS field encodings from Appendix H, Intel Architecture Manual Vol3B. 78 */ 79 #define VMCS_INVALID_ENCODING 0xffffffff 80 81 /* 16-bit control fields */ 82 #define VMCS_VPID 0x00000000 83 #define VMCS_PIR_VECTOR 0x00000002 84 85 /* 16-bit guest-state fields */ 86 #define VMCS_GUEST_ES_SELECTOR 0x00000800 87 #define VMCS_GUEST_CS_SELECTOR 0x00000802 88 #define VMCS_GUEST_SS_SELECTOR 0x00000804 89 #define VMCS_GUEST_DS_SELECTOR 0x00000806 90 #define VMCS_GUEST_FS_SELECTOR 0x00000808 91 #define VMCS_GUEST_GS_SELECTOR 0x0000080A 92 #define VMCS_GUEST_LDTR_SELECTOR 0x0000080C 93 #define VMCS_GUEST_TR_SELECTOR 0x0000080E 94 #define VMCS_GUEST_INTR_STATUS 0x00000810 95 96 /* 16-bit host-state fields */ 97 #define VMCS_HOST_ES_SELECTOR 0x00000C00 98 #define VMCS_HOST_CS_SELECTOR 0x00000C02 99 #define VMCS_HOST_SS_SELECTOR 0x00000C04 100 #define VMCS_HOST_DS_SELECTOR 0x00000C06 101 #define VMCS_HOST_FS_SELECTOR 0x00000C08 102 #define VMCS_HOST_GS_SELECTOR 0x00000C0A 103 #define VMCS_HOST_TR_SELECTOR 0x00000C0C 104 105 /* 64-bit control fields */ 106 #define VMCS_IO_BITMAP_A 0x00002000 107 #define VMCS_IO_BITMAP_B 0x00002002 108 #define VMCS_MSR_BITMAP 0x00002004 109 #define VMCS_EXIT_MSR_STORE 0x00002006 110 #define VMCS_EXIT_MSR_LOAD 0x00002008 111 #define VMCS_ENTRY_MSR_LOAD 0x0000200A 112 #define VMCS_EXECUTIVE_VMCS 0x0000200C 113 #define VMCS_TSC_OFFSET 0x00002010 114 #define VMCS_VIRTUAL_APIC 0x00002012 115 #define VMCS_APIC_ACCESS 0x00002014 116 #define VMCS_PIR_DESC 0x00002016 117 #define VMCS_EPTP 0x0000201A 118 #define VMCS_EOI_EXIT0 0x0000201C 119 #define VMCS_EOI_EXIT1 0x0000201E 120 #define VMCS_EOI_EXIT2 0x00002020 121 #define VMCS_EOI_EXIT3 0x00002022 122 #define VMCS_EOI_EXIT(vector) (VMCS_EOI_EXIT0 + ((vector) / 64) * 2) 123 124 /* 64-bit read-only fields */ 125 #define VMCS_GUEST_PHYSICAL_ADDRESS 0x00002400 126 127 /* 64-bit guest-state fields */ 128 #define VMCS_LINK_POINTER 0x00002800 129 #define VMCS_GUEST_IA32_DEBUGCTL 0x00002802 130 #define VMCS_GUEST_IA32_PAT 0x00002804 131 #define VMCS_GUEST_IA32_EFER 0x00002806 132 #define VMCS_GUEST_IA32_PERF_GLOBAL_CTRL 0x00002808 133 #define VMCS_GUEST_PDPTE0 0x0000280A 134 #define VMCS_GUEST_PDPTE1 0x0000280C 135 #define VMCS_GUEST_PDPTE2 0x0000280E 136 #define VMCS_GUEST_PDPTE3 0x00002810 137 138 /* 64-bit host-state fields */ 139 #define VMCS_HOST_IA32_PAT 0x00002C00 140 #define VMCS_HOST_IA32_EFER 0x00002C02 141 #define VMCS_HOST_IA32_PERF_GLOBAL_CTRL 0x00002C04 142 143 /* 32-bit control fields */ 144 #define VMCS_PIN_BASED_CTLS 0x00004000 145 #define VMCS_PRI_PROC_BASED_CTLS 0x00004002 146 #define VMCS_EXCEPTION_BITMAP 0x00004004 147 #define VMCS_PF_ERROR_MASK 0x00004006 148 #define VMCS_PF_ERROR_MATCH 0x00004008 149 #define VMCS_CR3_TARGET_COUNT 0x0000400A 150 #define VMCS_EXIT_CTLS 0x0000400C 151 #define VMCS_EXIT_MSR_STORE_COUNT 0x0000400E 152 #define VMCS_EXIT_MSR_LOAD_COUNT 0x00004010 153 #define VMCS_ENTRY_CTLS 0x00004012 154 #define VMCS_ENTRY_MSR_LOAD_COUNT 0x00004014 155 #define VMCS_ENTRY_INTR_INFO 0x00004016 156 #define VMCS_ENTRY_EXCEPTION_ERROR 0x00004018 157 #define VMCS_ENTRY_INST_LENGTH 0x0000401A 158 #define VMCS_TPR_THRESHOLD 0x0000401C 159 #define VMCS_SEC_PROC_BASED_CTLS 0x0000401E 160 #define VMCS_PLE_GAP 0x00004020 161 #define VMCS_PLE_WINDOW 0x00004022 162 163 /* 32-bit read-only data fields */ 164 #define VMCS_INSTRUCTION_ERROR 0x00004400 165 #define VMCS_EXIT_REASON 0x00004402 166 #define VMCS_EXIT_INTR_INFO 0x00004404 167 #define VMCS_EXIT_INTR_ERRCODE 0x00004406 168 #define VMCS_IDT_VECTORING_INFO 0x00004408 169 #define VMCS_IDT_VECTORING_ERROR 0x0000440A 170 #define VMCS_EXIT_INSTRUCTION_LENGTH 0x0000440C 171 #define VMCS_EXIT_INSTRUCTION_INFO 0x0000440E 172 173 /* 32-bit guest-state fields */ 174 #define VMCS_GUEST_ES_LIMIT 0x00004800 175 #define VMCS_GUEST_CS_LIMIT 0x00004802 176 #define VMCS_GUEST_SS_LIMIT 0x00004804 177 #define VMCS_GUEST_DS_LIMIT 0x00004806 178 #define VMCS_GUEST_FS_LIMIT 0x00004808 179 #define VMCS_GUEST_GS_LIMIT 0x0000480A 180 #define VMCS_GUEST_LDTR_LIMIT 0x0000480C 181 #define VMCS_GUEST_TR_LIMIT 0x0000480E 182 #define VMCS_GUEST_GDTR_LIMIT 0x00004810 183 #define VMCS_GUEST_IDTR_LIMIT 0x00004812 184 #define VMCS_GUEST_ES_ACCESS_RIGHTS 0x00004814 185 #define VMCS_GUEST_CS_ACCESS_RIGHTS 0x00004816 186 #define VMCS_GUEST_SS_ACCESS_RIGHTS 0x00004818 187 #define VMCS_GUEST_DS_ACCESS_RIGHTS 0x0000481A 188 #define VMCS_GUEST_FS_ACCESS_RIGHTS 0x0000481C 189 #define VMCS_GUEST_GS_ACCESS_RIGHTS 0x0000481E 190 #define VMCS_GUEST_LDTR_ACCESS_RIGHTS 0x00004820 191 #define VMCS_GUEST_TR_ACCESS_RIGHTS 0x00004822 192 #define VMCS_GUEST_INTERRUPTIBILITY 0x00004824 193 #define VMCS_GUEST_ACTIVITY 0x00004826 194 #define VMCS_GUEST_SMBASE 0x00004828 195 #define VMCS_GUEST_IA32_SYSENTER_CS 0x0000482A 196 #define VMCS_PREEMPTION_TIMER_VALUE 0x0000482E 197 198 /* 32-bit host state fields */ 199 #define VMCS_HOST_IA32_SYSENTER_CS 0x00004C00 200 201 /* Natural Width control fields */ 202 #define VMCS_CR0_MASK 0x00006000 203 #define VMCS_CR4_MASK 0x00006002 204 #define VMCS_CR0_SHADOW 0x00006004 205 #define VMCS_CR4_SHADOW 0x00006006 206 #define VMCS_CR3_TARGET0 0x00006008 207 #define VMCS_CR3_TARGET1 0x0000600A 208 #define VMCS_CR3_TARGET2 0x0000600C 209 #define VMCS_CR3_TARGET3 0x0000600E 210 211 /* Natural Width read-only fields */ 212 #define VMCS_EXIT_QUALIFICATION 0x00006400 213 #define VMCS_IO_RCX 0x00006402 214 #define VMCS_IO_RSI 0x00006404 215 #define VMCS_IO_RDI 0x00006406 216 #define VMCS_IO_RIP 0x00006408 217 #define VMCS_GUEST_LINEAR_ADDRESS 0x0000640A 218 219 /* Natural Width guest-state fields */ 220 #define VMCS_GUEST_CR0 0x00006800 221 #define VMCS_GUEST_CR3 0x00006802 222 #define VMCS_GUEST_CR4 0x00006804 223 #define VMCS_GUEST_ES_BASE 0x00006806 224 #define VMCS_GUEST_CS_BASE 0x00006808 225 #define VMCS_GUEST_SS_BASE 0x0000680A 226 #define VMCS_GUEST_DS_BASE 0x0000680C 227 #define VMCS_GUEST_FS_BASE 0x0000680E 228 #define VMCS_GUEST_GS_BASE 0x00006810 229 #define VMCS_GUEST_LDTR_BASE 0x00006812 230 #define VMCS_GUEST_TR_BASE 0x00006814 231 #define VMCS_GUEST_GDTR_BASE 0x00006816 232 #define VMCS_GUEST_IDTR_BASE 0x00006818 233 #define VMCS_GUEST_DR7 0x0000681A 234 #define VMCS_GUEST_RSP 0x0000681C 235 #define VMCS_GUEST_RIP 0x0000681E 236 #define VMCS_GUEST_RFLAGS 0x00006820 237 #define VMCS_GUEST_PENDING_DBG_EXCEPTIONS 0x00006822 238 #define VMCS_GUEST_IA32_SYSENTER_ESP 0x00006824 239 #define VMCS_GUEST_IA32_SYSENTER_EIP 0x00006826 240 241 /* Natural Width host-state fields */ 242 #define VMCS_HOST_CR0 0x00006C00 243 #define VMCS_HOST_CR3 0x00006C02 244 #define VMCS_HOST_CR4 0x00006C04 245 #define VMCS_HOST_FS_BASE 0x00006C06 246 #define VMCS_HOST_GS_BASE 0x00006C08 247 #define VMCS_HOST_TR_BASE 0x00006C0A 248 #define VMCS_HOST_GDTR_BASE 0x00006C0C 249 #define VMCS_HOST_IDTR_BASE 0x00006C0E 250 #define VMCS_HOST_IA32_SYSENTER_ESP 0x00006C10 251 #define VMCS_HOST_IA32_SYSENTER_EIP 0x00006C12 252 #define VMCS_HOST_RSP 0x00006C14 253 #define VMCS_HOST_RIP 0x00006c16 254 255 /* 256 * VM instruction error numbers 257 */ 258 #define VMRESUME_WITH_NON_LAUNCHED_VMCS 5 259 260 /* 261 * VMCS exit reasons 262 */ 263 #define EXIT_REASON_EXCEPTION 0 264 #define EXIT_REASON_EXT_INTR 1 265 #define EXIT_REASON_TRIPLE_FAULT 2 266 #define EXIT_REASON_INIT 3 267 #define EXIT_REASON_SIPI 4 268 #define EXIT_REASON_IO_SMI 5 269 #define EXIT_REASON_SMI 6 270 #define EXIT_REASON_INTR_WINDOW 7 271 #define EXIT_REASON_NMI_WINDOW 8 272 #define EXIT_REASON_TASK_SWITCH 9 273 #define EXIT_REASON_CPUID 10 274 #define EXIT_REASON_GETSEC 11 275 #define EXIT_REASON_HLT 12 276 #define EXIT_REASON_INVD 13 277 #define EXIT_REASON_INVLPG 14 278 #define EXIT_REASON_RDPMC 15 279 #define EXIT_REASON_RDTSC 16 280 #define EXIT_REASON_RSM 17 281 #define EXIT_REASON_VMCALL 18 282 #define EXIT_REASON_VMCLEAR 19 283 #define EXIT_REASON_VMLAUNCH 20 284 #define EXIT_REASON_VMPTRLD 21 285 #define EXIT_REASON_VMPTRST 22 286 #define EXIT_REASON_VMREAD 23 287 #define EXIT_REASON_VMRESUME 24 288 #define EXIT_REASON_VMWRITE 25 289 #define EXIT_REASON_VMXOFF 26 290 #define EXIT_REASON_VMXON 27 291 #define EXIT_REASON_CR_ACCESS 28 292 #define EXIT_REASON_DR_ACCESS 29 293 #define EXIT_REASON_INOUT 30 294 #define EXIT_REASON_RDMSR 31 295 #define EXIT_REASON_WRMSR 32 296 #define EXIT_REASON_INVAL_VMCS 33 297 #define EXIT_REASON_INVAL_MSR 34 298 #define EXIT_REASON_MWAIT 36 299 #define EXIT_REASON_MTF 37 300 #define EXIT_REASON_MONITOR 39 301 #define EXIT_REASON_PAUSE 40 302 #define EXIT_REASON_MCE_DURING_ENTRY 41 303 #define EXIT_REASON_TPR 43 304 #define EXIT_REASON_APIC_ACCESS 44 305 #define EXIT_REASON_VIRTUALIZED_EOI 45 306 #define EXIT_REASON_GDTR_IDTR 46 307 #define EXIT_REASON_LDTR_TR 47 308 #define EXIT_REASON_EPT_FAULT 48 309 #define EXIT_REASON_EPT_MISCONFIG 49 310 #define EXIT_REASON_INVEPT 50 311 #define EXIT_REASON_RDTSCP 51 312 #define EXIT_REASON_VMX_PREEMPT 52 313 #define EXIT_REASON_INVVPID 53 314 #define EXIT_REASON_WBINVD 54 315 #define EXIT_REASON_XSETBV 55 316 #define EXIT_REASON_APIC_WRITE 56 317 #define EXIT_REASON_RDRAND 57 318 #define EXIT_REASON_INVPCID 58 319 #define EXIT_REASON_VMFUNC 59 320 #define EXIT_REASON_ENCLS 60 321 #define EXIT_REASON_RDSEED 61 322 #define EXIT_REASON_PM_LOG_FULL 62 323 #define EXIT_REASON_XSAVES 63 324 #define EXIT_REASON_XRSTORS 64 325 326 /* 327 * NMI unblocking due to IRET. 328 * 329 * Applies to VM-exits due to hardware exception or EPT fault. 330 */ 331 #define EXIT_QUAL_NMIUDTI (1 << 12) 332 /* 333 * VMCS interrupt information fields 334 */ 335 #define VMCS_INTR_VALID (1U << 31) 336 #define VMCS_INTR_T_MASK 0x700 /* Interruption-info type */ 337 #define VMCS_INTR_T_HWINTR (0 << 8) 338 #define VMCS_INTR_T_NMI (2 << 8) 339 #define VMCS_INTR_T_HWEXCEPTION (3 << 8) 340 #define VMCS_INTR_T_SWINTR (4 << 8) 341 #define VMCS_INTR_T_PRIV_SWEXCEPTION (5 << 8) 342 #define VMCS_INTR_T_SWEXCEPTION (6 << 8) 343 #define VMCS_INTR_DEL_ERRCODE (1 << 11) 344 345 /* 346 * VMCS IDT-Vectoring information fields 347 */ 348 #define VMCS_IDT_VEC_VALID (1U << 31) 349 #define VMCS_IDT_VEC_ERRCODE_VALID (1 << 11) 350 351 /* 352 * VMCS Guest interruptibility field 353 */ 354 #define VMCS_INTERRUPTIBILITY_STI_BLOCKING (1 << 0) 355 #define VMCS_INTERRUPTIBILITY_MOVSS_BLOCKING (1 << 1) 356 #define VMCS_INTERRUPTIBILITY_SMI_BLOCKING (1 << 2) 357 #define VMCS_INTERRUPTIBILITY_NMI_BLOCKING (1 << 3) 358 359 /* 360 * Exit qualification for EXIT_REASON_INVAL_VMCS 361 */ 362 #define EXIT_QUAL_NMI_WHILE_STI_BLOCKING 3 363 364 /* 365 * Exit qualification for EPT violation 366 */ 367 #define EPT_VIOLATION_DATA_READ (1UL << 0) 368 #define EPT_VIOLATION_DATA_WRITE (1UL << 1) 369 #define EPT_VIOLATION_INST_FETCH (1UL << 2) 370 #define EPT_VIOLATION_GPA_READABLE (1UL << 3) 371 #define EPT_VIOLATION_GPA_WRITEABLE (1UL << 4) 372 #define EPT_VIOLATION_GPA_EXECUTABLE (1UL << 5) 373 #define EPT_VIOLATION_GLA_VALID (1UL << 7) 374 #define EPT_VIOLATION_XLAT_VALID (1UL << 8) 375 376 /* 377 * Exit qualification for APIC-access VM exit 378 */ 379 #define APIC_ACCESS_OFFSET(qual) ((qual) & 0xFFF) 380 #define APIC_ACCESS_TYPE(qual) (((qual) >> 12) & 0xF) 381 382 /* 383 * Exit qualification for APIC-write VM exit 384 */ 385 #define APIC_WRITE_OFFSET(qual) ((qual) & 0xFFF) 386 387 #endif 388