VirtualBox

source: vbox/trunk/include/VBox/vmm/hm_vmx.h@ 61570

Last change on this file since 61570 was 61515, checked in by vboxsync, 8 years ago

VMM/HM: Report missing/new VT-x's secondary processor-based VM-execution controls in the release log.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 106.9 KB
Line 
1/** @file
2 * HM - VMX Structures and Definitions. (VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2015 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_vmm_vmx_h
27#define ___VBox_vmm_vmx_h
28
29#include <VBox/types.h>
30#include <VBox/err.h>
31#include <iprt/x86.h>
32#include <iprt/assert.h>
33
34/* In Visual C++ versions prior to 2012, the vmx intrinsics are only available
35 when targeting AMD64. */
36#if RT_INLINE_ASM_USES_INTRIN >= 16 && defined(RT_ARCH_AMD64)
37# include <intrin.h>
38/* We always want them as intrinsics, no functions. */
39# pragma intrinsic(__vmx_on)
40# pragma intrinsic(__vmx_off)
41# pragma intrinsic(__vmx_vmclear)
42# pragma intrinsic(__vmx_vmptrld)
43# pragma intrinsic(__vmx_vmread)
44# pragma intrinsic(__vmx_vmwrite)
45# define VMX_USE_MSC_INTRINSICS 1
46#else
47# define VMX_USE_MSC_INTRINSICS 0
48#endif
49
50
51/** @defgroup grp_hm_vmx VMX Types and Definitions
52 * @ingroup grp_hm
53 * @{
54 */
55
56/** @def HMVMXCPU_GST_SET_UPDATED
57 * Sets a guest-state-updated flag.
58 *
59 * @param pVCpu The cross context virtual CPU structure.
60 * @param fFlag The flag to set.
61 */
62#define HMVMXCPU_GST_SET_UPDATED(pVCpu, fFlag) (ASMAtomicUoOrU32(&(pVCpu)->hm.s.vmx.fUpdatedGuestState, (fFlag)))
63
64/** @def HMVMXCPU_GST_IS_SET
65 * Checks if all the flags in the specified guest-state-updated set is pending.
66 *
67 * @param pVCpu The cross context virtual CPU structure.
68 * @param fFlag The flag to check.
69 */
70#define HMVMXCPU_GST_IS_SET(pVCpu, fFlag) ((ASMAtomicUoReadU32(&(pVCpu)->hm.s.vmx.fUpdatedGuestState) & (fFlag)) == (fFlag))
71
72/** @def HMVMXCPU_GST_IS_UPDATED
73 * Checks if one or more of the flags in the specified guest-state-updated set
74 * is updated.
75 *
76 * @param pVCpu The cross context virtual CPU structure.
77 * @param fFlags The flags to check for.
78 */
79#define HMVMXCPU_GST_IS_UPDATED(pVCpu, fFlags) RT_BOOL(ASMAtomicUoReadU32(&(pVCpu)->hm.s.vmx.fUpdatedGuestState) & (fFlags))
80
81/** @def HMVMXCPU_GST_RESET_TO
82 * Resets the guest-state-updated flags to the specified value.
83 *
84 * @param pVCpu The cross context virtual CPU structure.
85 * @param fFlags The new value.
86 */
87#define HMVMXCPU_GST_RESET_TO(pVCpu, fFlags) (ASMAtomicUoWriteU32(&(pVCpu)->hm.s.vmx.fUpdatedGuestState, (fFlags)))
88
89/** @def HMVMXCPU_GST_VALUE
90 * Returns the current guest-state-updated flags value.
91 *
92 * @param pVCpu The cross context virtual CPU structure.
93 */
94#define HMVMXCPU_GST_VALUE(pVCpu) (ASMAtomicUoReadU32(&(pVCpu)->hm.s.vmx.fUpdatedGuestState))
95
96/** @name Host-state restoration flags.
97 * @note If you change these values don't forget to update the assembly
98 * defines as well!
99 * @{
100 */
101#define VMX_RESTORE_HOST_SEL_DS RT_BIT(0)
102#define VMX_RESTORE_HOST_SEL_ES RT_BIT(1)
103#define VMX_RESTORE_HOST_SEL_FS RT_BIT(2)
104#define VMX_RESTORE_HOST_SEL_GS RT_BIT(3)
105#define VMX_RESTORE_HOST_SEL_TR RT_BIT(4)
106#define VMX_RESTORE_HOST_GDTR RT_BIT(5)
107#define VMX_RESTORE_HOST_IDTR RT_BIT(6)
108#define VMX_RESTORE_HOST_GDT_READ_ONLY RT_BIT(7)
109#define VMX_RESTORE_HOST_REQUIRED RT_BIT(8)
110/** @} */
111
112/**
113 * Host-state restoration structure.
114 * This holds host-state fields that require manual restoration.
115 * Assembly version found in hm_vmx.mac (should be automatically verified).
116 */
117typedef struct VMXRESTOREHOST
118{
119 RTSEL uHostSelDS; /* 0x00 */
120 RTSEL uHostSelES; /* 0x02 */
121 RTSEL uHostSelFS; /* 0x04 */
122 RTSEL uHostSelGS; /* 0x06 */
123 RTSEL uHostSelTR; /* 0x08 */
124 uint8_t abPadding0[4];
125 X86XDTR64 HostGdtr; /**< 0x0e - should be aligned by it's 64-bit member. */
126 uint8_t abPadding1[6];
127 X86XDTR64 HostIdtr; /**< 0x1e - should be aligned by it's 64-bit member. */
128 uint64_t uHostFSBase; /* 0x28 */
129 uint64_t uHostGSBase; /* 0x30 */
130} VMXRESTOREHOST;
131/** Pointer to VMXRESTOREHOST. */
132typedef VMXRESTOREHOST *PVMXRESTOREHOST;
133AssertCompileSize(X86XDTR64, 10);
134AssertCompileMemberOffset(VMXRESTOREHOST, HostGdtr.uAddr, 16);
135AssertCompileMemberOffset(VMXRESTOREHOST, HostIdtr.uAddr, 32);
136AssertCompileMemberOffset(VMXRESTOREHOST, uHostFSBase, 40);
137AssertCompileSize(VMXRESTOREHOST, 56);
138AssertCompileSizeAlignment(VMXRESTOREHOST, 8);
139
140/** @name Host-state MSR lazy-restoration flags.
141 * @{
142 */
143/** The host MSRs have been saved. */
144#define VMX_LAZY_MSRS_SAVED_HOST RT_BIT(0)
145/** The guest MSRs are loaded and in effect. */
146#define VMX_LAZY_MSRS_LOADED_GUEST RT_BIT(1)
147/** @} */
148
149/** @name VMX HM-error codes for VERR_HM_UNSUPPORTED_CPU_FEATURE_COMBO.
150 * UFC = Unsupported Feature Combination.
151 * @{
152 */
153/** Unsupported pin-based VM-execution controls combo. */
154#define VMX_UFC_CTRL_PIN_EXEC 0
155/** Unsupported processor-based VM-execution controls combo. */
156#define VMX_UFC_CTRL_PROC_EXEC 1
157/** Unsupported move debug register VM-exit combo. */
158#define VMX_UFC_CTRL_PROC_MOV_DRX_EXIT 2
159/** Unsupported VM-entry controls combo. */
160#define VMX_UFC_CTRL_ENTRY 3
161/** Unsupported VM-exit controls combo. */
162#define VMX_UFC_CTRL_EXIT 4
163/** MSR storage capacity of the VMCS autoload/store area is not sufficient
164 * for storing host MSRs. */
165#define VMX_UFC_INSUFFICIENT_HOST_MSR_STORAGE 5
166/** MSR storage capacity of the VMCS autoload/store area is not sufficient
167 * for storing guest MSRs. */
168#define VMX_UFC_INSUFFICIENT_GUEST_MSR_STORAGE 6
169/** Invalid VMCS size. */
170#define VMX_UFC_INVALID_VMCS_SIZE 7
171/** Unsupported secondary processor-based VM-execution controls combo. */
172#define VMX_UFC_CTRL_PROC_EXEC2 8
173/** Invalid unrestricted-guest execution controls combo. */
174#define VMX_UFC_INVALID_UX_COMBO 9
175/** EPT flush type not supported. */
176#define VMX_UFC_EPT_FLUSH_TYPE_UNSUPPORTED 10
177/** EPT paging structure memory type is not write-back. */
178#define VMX_UFC_EPT_MEM_TYPE_NOT_WB 11
179/** EPT requires INVEPT instr. support but it's not available. */
180#define VMX_UFC_EPT_INVEPT_UNAVAILABLE 12
181/** EPT requires page-walk length of 4. */
182#define VMX_UFC_EPT_PAGE_WALK_LENGTH_UNSUPPORTED 13
183/** @} */
184
185/** @name VMX HM-error codes for VERR_VMX_INVALID_GUEST_STATE.
186 * IGS = Invalid Guest State.
187 * @{
188 */
189/** An error occurred while checking invalid-guest-state. */
190#define VMX_IGS_ERROR 0
191/** The invalid guest-state checks did not find any reason why. */
192#define VMX_IGS_REASON_NOT_FOUND 1
193/** CR0 fixed1 bits invalid. */
194#define VMX_IGS_CR0_FIXED1 2
195/** CR0 fixed0 bits invalid. */
196#define VMX_IGS_CR0_FIXED0 3
197/** CR0.PE and CR0.PE invalid VT-x/host combination. */
198#define VMX_IGS_CR0_PG_PE_COMBO 4
199/** CR4 fixed1 bits invalid. */
200#define VMX_IGS_CR4_FIXED1 5
201/** CR4 fixed0 bits invalid. */
202#define VMX_IGS_CR4_FIXED0 6
203/** Reserved bits in VMCS' DEBUGCTL MSR field not set to 0 when
204 * VMX_VMCS_CTRL_ENTRY_LOAD_DEBUG is used. */
205#define VMX_IGS_DEBUGCTL_MSR_RESERVED 7
206/** CR0.PG not set for long-mode when not using unrestricted guest. */
207#define VMX_IGS_CR0_PG_LONGMODE 8
208/** CR4.PAE not set for long-mode guest when not using unrestricted guest. */
209#define VMX_IGS_CR4_PAE_LONGMODE 9
210/** CR4.PCIDE set for 32-bit guest. */
211#define VMX_IGS_CR4_PCIDE 10
212/** VMCS' DR7 reserved bits not set to 0. */
213#define VMX_IGS_DR7_RESERVED 11
214/** VMCS' PERF_GLOBAL MSR reserved bits not set to 0. */
215#define VMX_IGS_PERF_GLOBAL_MSR_RESERVED 12
216/** VMCS' EFER MSR reserved bits not set to 0. */
217#define VMX_IGS_EFER_MSR_RESERVED 13
218/** VMCS' EFER MSR.LMA does not match the IA32e mode guest control. */
219#define VMX_IGS_EFER_LMA_GUEST_MODE_MISMATCH 14
220/** VMCS' EFER MSR.LMA does not match EFER.LME of the guest when using paging
221 * without unrestricted guest. */
222#define VMX_IGS_EFER_LMA_LME_MISMATCH 15
223/** CS.Attr.P bit invalid. */
224#define VMX_IGS_CS_ATTR_P_INVALID 16
225/** CS.Attr reserved bits not set to 0. */
226#define VMX_IGS_CS_ATTR_RESERVED 17
227/** CS.Attr.G bit invalid. */
228#define VMX_IGS_CS_ATTR_G_INVALID 18
229/** CS is unusable. */
230#define VMX_IGS_CS_ATTR_UNUSABLE 19
231/** CS and SS DPL unequal. */
232#define VMX_IGS_CS_SS_ATTR_DPL_UNEQUAL 20
233/** CS and SS DPL mismatch. */
234#define VMX_IGS_CS_SS_ATTR_DPL_MISMATCH 21
235/** CS Attr.Type invalid. */
236#define VMX_IGS_CS_ATTR_TYPE_INVALID 22
237/** CS and SS RPL unequal. */
238#define VMX_IGS_SS_CS_RPL_UNEQUAL 23
239/** SS.Attr.DPL and SS RPL unequal. */
240#define VMX_IGS_SS_ATTR_DPL_RPL_UNEQUAL 24
241/** SS.Attr.DPL invalid for segment type. */
242#define VMX_IGS_SS_ATTR_DPL_INVALID 25
243/** SS.Attr.Type invalid. */
244#define VMX_IGS_SS_ATTR_TYPE_INVALID 26
245/** SS.Attr.P bit invalid. */
246#define VMX_IGS_SS_ATTR_P_INVALID 27
247/** SS.Attr reserved bits not set to 0. */
248#define VMX_IGS_SS_ATTR_RESERVED 28
249/** SS.Attr.G bit invalid. */
250#define VMX_IGS_SS_ATTR_G_INVALID 29
251/** DS.Attr.A bit invalid. */
252#define VMX_IGS_DS_ATTR_A_INVALID 30
253/** DS.Attr.P bit invalid. */
254#define VMX_IGS_DS_ATTR_P_INVALID 31
255/** DS.Attr.DPL and DS RPL unequal. */
256#define VMX_IGS_DS_ATTR_DPL_RPL_UNEQUAL 32
257/** DS.Attr reserved bits not set to 0. */
258#define VMX_IGS_DS_ATTR_RESERVED 33
259/** DS.Attr.G bit invalid. */
260#define VMX_IGS_DS_ATTR_G_INVALID 34
261/** DS.Attr.Type invalid. */
262#define VMX_IGS_DS_ATTR_TYPE_INVALID 35
263/** ES.Attr.A bit invalid. */
264#define VMX_IGS_ES_ATTR_A_INVALID 36
265/** ES.Attr.P bit invalid. */
266#define VMX_IGS_ES_ATTR_P_INVALID 37
267/** ES.Attr.DPL and DS RPL unequal. */
268#define VMX_IGS_ES_ATTR_DPL_RPL_UNEQUAL 38
269/** ES.Attr reserved bits not set to 0. */
270#define VMX_IGS_ES_ATTR_RESERVED 39
271/** ES.Attr.G bit invalid. */
272#define VMX_IGS_ES_ATTR_G_INVALID 40
273/** ES.Attr.Type invalid. */
274#define VMX_IGS_ES_ATTR_TYPE_INVALID 41
275/** FS.Attr.A bit invalid. */
276#define VMX_IGS_FS_ATTR_A_INVALID 42
277/** FS.Attr.P bit invalid. */
278#define VMX_IGS_FS_ATTR_P_INVALID 43
279/** FS.Attr.DPL and DS RPL unequal. */
280#define VMX_IGS_FS_ATTR_DPL_RPL_UNEQUAL 44
281/** FS.Attr reserved bits not set to 0. */
282#define VMX_IGS_FS_ATTR_RESERVED 45
283/** FS.Attr.G bit invalid. */
284#define VMX_IGS_FS_ATTR_G_INVALID 46
285/** FS.Attr.Type invalid. */
286#define VMX_IGS_FS_ATTR_TYPE_INVALID 47
287/** GS.Attr.A bit invalid. */
288#define VMX_IGS_GS_ATTR_A_INVALID 48
289/** GS.Attr.P bit invalid. */
290#define VMX_IGS_GS_ATTR_P_INVALID 49
291/** GS.Attr.DPL and DS RPL unequal. */
292#define VMX_IGS_GS_ATTR_DPL_RPL_UNEQUAL 50
293/** GS.Attr reserved bits not set to 0. */
294#define VMX_IGS_GS_ATTR_RESERVED 51
295/** GS.Attr.G bit invalid. */
296#define VMX_IGS_GS_ATTR_G_INVALID 52
297/** GS.Attr.Type invalid. */
298#define VMX_IGS_GS_ATTR_TYPE_INVALID 53
299/** V86 mode CS.Base invalid. */
300#define VMX_IGS_V86_CS_BASE_INVALID 54
301/** V86 mode CS.Limit invalid. */
302#define VMX_IGS_V86_CS_LIMIT_INVALID 55
303/** V86 mode CS.Attr invalid. */
304#define VMX_IGS_V86_CS_ATTR_INVALID 56
305/** V86 mode SS.Base invalid. */
306#define VMX_IGS_V86_SS_BASE_INVALID 57
307/** V86 mode SS.Limit invalid. */
308#define VMX_IGS_V86_SS_LIMIT_INVALID 58
309/** V86 mode SS.Attr invalid. */
310#define VMX_IGS_V86_SS_ATTR_INVALID 59
311/** V86 mode DS.Base invalid. */
312#define VMX_IGS_V86_DS_BASE_INVALID 60
313/** V86 mode DS.Limit invalid. */
314#define VMX_IGS_V86_DS_LIMIT_INVALID 61
315/** V86 mode DS.Attr invalid. */
316#define VMX_IGS_V86_DS_ATTR_INVALID 62
317/** V86 mode ES.Base invalid. */
318#define VMX_IGS_V86_ES_BASE_INVALID 63
319/** V86 mode ES.Limit invalid. */
320#define VMX_IGS_V86_ES_LIMIT_INVALID 64
321/** V86 mode ES.Attr invalid. */
322#define VMX_IGS_V86_ES_ATTR_INVALID 65
323/** V86 mode FS.Base invalid. */
324#define VMX_IGS_V86_FS_BASE_INVALID 66
325/** V86 mode FS.Limit invalid. */
326#define VMX_IGS_V86_FS_LIMIT_INVALID 67
327/** V86 mode FS.Attr invalid. */
328#define VMX_IGS_V86_FS_ATTR_INVALID 68
329/** V86 mode GS.Base invalid. */
330#define VMX_IGS_V86_GS_BASE_INVALID 69
331/** V86 mode GS.Limit invalid. */
332#define VMX_IGS_V86_GS_LIMIT_INVALID 70
333/** V86 mode GS.Attr invalid. */
334#define VMX_IGS_V86_GS_ATTR_INVALID 71
335/** Longmode CS.Base invalid. */
336#define VMX_IGS_LONGMODE_CS_BASE_INVALID 72
337/** Longmode SS.Base invalid. */
338#define VMX_IGS_LONGMODE_SS_BASE_INVALID 73
339/** Longmode DS.Base invalid. */
340#define VMX_IGS_LONGMODE_DS_BASE_INVALID 74
341/** Longmode ES.Base invalid. */
342#define VMX_IGS_LONGMODE_ES_BASE_INVALID 75
343/** SYSENTER ESP is not canonical. */
344#define VMX_IGS_SYSENTER_ESP_NOT_CANONICAL 76
345/** SYSENTER EIP is not canonical. */
346#define VMX_IGS_SYSENTER_EIP_NOT_CANONICAL 77
347/** PAT MSR invalid. */
348#define VMX_IGS_PAT_MSR_INVALID 78
349/** PAT MSR reserved bits not set to 0. */
350#define VMX_IGS_PAT_MSR_RESERVED 79
351/** GDTR.Base is not canonical. */
352#define VMX_IGS_GDTR_BASE_NOT_CANONICAL 80
353/** IDTR.Base is not canonical. */
354#define VMX_IGS_IDTR_BASE_NOT_CANONICAL 81
355/** GDTR.Limit invalid. */
356#define VMX_IGS_GDTR_LIMIT_INVALID 82
357/** IDTR.Limit invalid. */
358#define VMX_IGS_IDTR_LIMIT_INVALID 83
359/** Longmode RIP is invalid. */
360#define VMX_IGS_LONGMODE_RIP_INVALID 84
361/** RFLAGS reserved bits not set to 0. */
362#define VMX_IGS_RFLAGS_RESERVED 85
363/** RFLAGS RA1 reserved bits not set to 1. */
364#define VMX_IGS_RFLAGS_RESERVED1 86
365/** RFLAGS.VM (V86 mode) invalid. */
366#define VMX_IGS_RFLAGS_VM_INVALID 87
367/** RFLAGS.IF invalid. */
368#define VMX_IGS_RFLAGS_IF_INVALID 88
369/** Activity state invalid. */
370#define VMX_IGS_ACTIVITY_STATE_INVALID 89
371/** Activity state HLT invalid when SS.Attr.DPL is not zero. */
372#define VMX_IGS_ACTIVITY_STATE_HLT_INVALID 90
373/** Activity state ACTIVE invalid when block-by-STI or MOV SS. */
374#define VMX_IGS_ACTIVITY_STATE_ACTIVE_INVALID 91
375/** Activity state SIPI WAIT invalid. */
376#define VMX_IGS_ACTIVITY_STATE_SIPI_WAIT_INVALID 92
377/** Interruptibility state reserved bits not set to 0. */
378#define VMX_IGS_INTERRUPTIBILITY_STATE_RESERVED 93
379/** Interruptibility state cannot be block-by-STI -and- MOV SS. */
380#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_MOVSS_INVALID 94
381/** Interruptibility state block-by-STI invalid for EFLAGS. */
382#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_EFL_INVALID 95
383/** Interruptibility state invalid while trying to deliver external
384 * interrupt. */
385#define VMX_IGS_INTERRUPTIBILITY_STATE_EXT_INT_INVALID 96
386/** Interruptibility state block-by-MOVSS invalid while trying to deliver an
387 * NMI. */
388#define VMX_IGS_INTERRUPTIBILITY_STATE_MOVSS_INVALID 97
389/** Interruptibility state block-by-SMI invalid when CPU is not in SMM. */
390#define VMX_IGS_INTERRUPTIBILITY_STATE_SMI_INVALID 98
391/** Interruptibility state block-by-SMI invalid when trying to enter SMM. */
392#define VMX_IGS_INTERRUPTIBILITY_STATE_SMI_SMM_INVALID 99
393/** Interruptibility state block-by-STI (maybe) invalid when trying to
394 * deliver an NMI. */
395#define VMX_IGS_INTERRUPTIBILITY_STATE_STI_INVALID 100
396/** Interruptibility state block-by-NMI invalid when virtual-NMIs control is
397 * active. */
398#define VMX_IGS_INTERRUPTIBILITY_STATE_NMI_INVALID 101
399/** Pending debug exceptions reserved bits not set to 0. */
400#define VMX_IGS_PENDING_DEBUG_RESERVED 102
401/** Longmode pending debug exceptions reserved bits not set to 0. */
402#define VMX_IGS_LONGMODE_PENDING_DEBUG_RESERVED 103
403/** Pending debug exceptions.BS bit is not set when it should be. */
404#define VMX_IGS_PENDING_DEBUG_XCPT_BS_NOT_SET 104
405/** Pending debug exceptions.BS bit is not clear when it should be. */
406#define VMX_IGS_PENDING_DEBUG_XCPT_BS_NOT_CLEAR 105
407/** VMCS link pointer reserved bits not set to 0. */
408#define VMX_IGS_VMCS_LINK_PTR_RESERVED 106
409/** TR cannot index into LDT, TI bit MBZ. */
410#define VMX_IGS_TR_TI_INVALID 107
411/** LDTR cannot index into LDT. TI bit MBZ. */
412#define VMX_IGS_LDTR_TI_INVALID 108
413/** TR.Base is not canonical. */
414#define VMX_IGS_TR_BASE_NOT_CANONICAL 109
415/** FS.Base is not canonical. */
416#define VMX_IGS_FS_BASE_NOT_CANONICAL 110
417/** GS.Base is not canonical. */
418#define VMX_IGS_GS_BASE_NOT_CANONICAL 111
419/** LDTR.Base is not canonical. */
420#define VMX_IGS_LDTR_BASE_NOT_CANONICAL 112
421/** TR is unusable. */
422#define VMX_IGS_TR_ATTR_UNUSABLE 113
423/** TR.Attr.S bit invalid. */
424#define VMX_IGS_TR_ATTR_S_INVALID 114
425/** TR is not present. */
426#define VMX_IGS_TR_ATTR_P_INVALID 115
427/** TR.Attr reserved bits not set to 0. */
428#define VMX_IGS_TR_ATTR_RESERVED 116
429/** TR.Attr.G bit invalid. */
430#define VMX_IGS_TR_ATTR_G_INVALID 117
431/** Longmode TR.Attr.Type invalid. */
432#define VMX_IGS_LONGMODE_TR_ATTR_TYPE_INVALID 118
433/** TR.Attr.Type invalid. */
434#define VMX_IGS_TR_ATTR_TYPE_INVALID 119
435/** CS.Attr.S invalid. */
436#define VMX_IGS_CS_ATTR_S_INVALID 120
437/** CS.Attr.DPL invalid. */
438#define VMX_IGS_CS_ATTR_DPL_INVALID 121
439/** PAE PDPTE reserved bits not set to 0. */
440#define VMX_IGS_PAE_PDPTE_RESERVED 123
441/** @} */
442
443/** @name VMX VMCS-Read cache indices.
444 * @{
445 */
446#define VMX_VMCS_GUEST_ES_BASE_CACHE_IDX 0
447#define VMX_VMCS_GUEST_CS_BASE_CACHE_IDX 1
448#define VMX_VMCS_GUEST_SS_BASE_CACHE_IDX 2
449#define VMX_VMCS_GUEST_DS_BASE_CACHE_IDX 3
450#define VMX_VMCS_GUEST_FS_BASE_CACHE_IDX 4
451#define VMX_VMCS_GUEST_GS_BASE_CACHE_IDX 5
452#define VMX_VMCS_GUEST_LDTR_BASE_CACHE_IDX 6
453#define VMX_VMCS_GUEST_TR_BASE_CACHE_IDX 7
454#define VMX_VMCS_GUEST_GDTR_BASE_CACHE_IDX 8
455#define VMX_VMCS_GUEST_IDTR_BASE_CACHE_IDX 9
456#define VMX_VMCS_GUEST_RSP_CACHE_IDX 10
457#define VMX_VMCS_GUEST_RIP_CACHE_IDX 11
458#define VMX_VMCS_GUEST_SYSENTER_ESP_CACHE_IDX 12
459#define VMX_VMCS_GUEST_SYSENTER_EIP_CACHE_IDX 13
460#define VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX 14
461#define VMX_VMCS_MAX_CACHE_IDX (VMX_VMCS_RO_EXIT_QUALIFICATION_CACHE_IDX + 1)
462#define VMX_VMCS_GUEST_CR3_CACHE_IDX 15
463#define VMX_VMCS_MAX_NESTED_PAGING_CACHE_IDX (VMX_VMCS_GUEST_CR3_CACHE_IDX + 1)
464/** @} */
465
466/** @name VMX EPT paging structures
467 * @{
468 */
469
470/**
471 * Number of page table entries in the EPT. (PDPTE/PDE/PTE)
472 */
473#define EPT_PG_ENTRIES X86_PG_PAE_ENTRIES
474
475/**
476 * EPT Page Directory Pointer Entry. Bit view.
477 * @todo uint64_t isn't safe for bitfields (gcc pedantic warnings, and IIRC,
478 * this did cause trouble with one compiler/version).
479 */
480typedef struct EPTPML4EBITS
481{
482 /** Present bit. */
483 uint64_t u1Present : 1;
484 /** Writable bit. */
485 uint64_t u1Write : 1;
486 /** Executable bit. */
487 uint64_t u1Execute : 1;
488 /** Reserved (must be 0). */
489 uint64_t u5Reserved : 5;
490 /** Available for software. */
491 uint64_t u4Available : 4;
492 /** Physical address of the next level (PD). Restricted by maximum physical address width of the cpu. */
493 uint64_t u40PhysAddr : 40;
494 /** Available for software. */
495 uint64_t u12Available : 12;
496} EPTPML4EBITS;
497AssertCompileSize(EPTPML4EBITS, 8);
498
499/** Bits 12-51 - - EPT - Physical Page number of the next level. */
500#define EPT_PML4E_PG_MASK X86_PML4E_PG_MASK
501/** The page shift to get the PML4 index. */
502#define EPT_PML4_SHIFT X86_PML4_SHIFT
503/** The PML4 index mask (apply to a shifted page address). */
504#define EPT_PML4_MASK X86_PML4_MASK
505
506/**
507 * EPT PML4E.
508 */
509typedef union EPTPML4E
510{
511 /** Normal view. */
512 EPTPML4EBITS n;
513 /** Unsigned integer view. */
514 X86PGPAEUINT u;
515 /** 64 bit unsigned integer view. */
516 uint64_t au64[1];
517 /** 32 bit unsigned integer view. */
518 uint32_t au32[2];
519} EPTPML4E;
520AssertCompileSize(EPTPML4E, 8);
521/** Pointer to a PML4 table entry. */
522typedef EPTPML4E *PEPTPML4E;
523/** Pointer to a const PML4 table entry. */
524typedef const EPTPML4E *PCEPTPML4E;
525
526/**
527 * EPT PML4 Table.
528 */
529typedef struct EPTPML4
530{
531 EPTPML4E a[EPT_PG_ENTRIES];
532} EPTPML4;
533AssertCompileSize(EPTPML4, 0x1000);
534/** Pointer to an EPT PML4 Table. */
535typedef EPTPML4 *PEPTPML4;
536/** Pointer to a const EPT PML4 Table. */
537typedef const EPTPML4 *PCEPTPML4;
538
539/**
540 * EPT Page Directory Pointer Entry. Bit view.
541 */
542typedef struct EPTPDPTEBITS
543{
544 /** Present bit. */
545 uint64_t u1Present : 1;
546 /** Writable bit. */
547 uint64_t u1Write : 1;
548 /** Executable bit. */
549 uint64_t u1Execute : 1;
550 /** Reserved (must be 0). */
551 uint64_t u5Reserved : 5;
552 /** Available for software. */
553 uint64_t u4Available : 4;
554 /** Physical address of the next level (PD). Restricted by maximum physical address width of the cpu. */
555 uint64_t u40PhysAddr : 40;
556 /** Available for software. */
557 uint64_t u12Available : 12;
558} EPTPDPTEBITS;
559AssertCompileSize(EPTPDPTEBITS, 8);
560
561/** Bits 12-51 - - EPT - Physical Page number of the next level. */
562#define EPT_PDPTE_PG_MASK X86_PDPE_PG_MASK
563/** The page shift to get the PDPT index. */
564#define EPT_PDPT_SHIFT X86_PDPT_SHIFT
565/** The PDPT index mask (apply to a shifted page address). */
566#define EPT_PDPT_MASK X86_PDPT_MASK_AMD64
567
568/**
569 * EPT Page Directory Pointer.
570 */
571typedef union EPTPDPTE
572{
573 /** Normal view. */
574 EPTPDPTEBITS n;
575 /** Unsigned integer view. */
576 X86PGPAEUINT u;
577 /** 64 bit unsigned integer view. */
578 uint64_t au64[1];
579 /** 32 bit unsigned integer view. */
580 uint32_t au32[2];
581} EPTPDPTE;
582AssertCompileSize(EPTPDPTE, 8);
583/** Pointer to an EPT Page Directory Pointer Entry. */
584typedef EPTPDPTE *PEPTPDPTE;
585/** Pointer to a const EPT Page Directory Pointer Entry. */
586typedef const EPTPDPTE *PCEPTPDPTE;
587
588/**
589 * EPT Page Directory Pointer Table.
590 */
591typedef struct EPTPDPT
592{
593 EPTPDPTE a[EPT_PG_ENTRIES];
594} EPTPDPT;
595AssertCompileSize(EPTPDPT, 0x1000);
596/** Pointer to an EPT Page Directory Pointer Table. */
597typedef EPTPDPT *PEPTPDPT;
598/** Pointer to a const EPT Page Directory Pointer Table. */
599typedef const EPTPDPT *PCEPTPDPT;
600
601
602/**
603 * EPT Page Directory Table Entry. Bit view.
604 */
605typedef struct EPTPDEBITS
606{
607 /** Present bit. */
608 uint64_t u1Present : 1;
609 /** Writable bit. */
610 uint64_t u1Write : 1;
611 /** Executable bit. */
612 uint64_t u1Execute : 1;
613 /** Reserved (must be 0). */
614 uint64_t u4Reserved : 4;
615 /** Big page (must be 0 here). */
616 uint64_t u1Size : 1;
617 /** Available for software. */
618 uint64_t u4Available : 4;
619 /** Physical address of page table. Restricted by maximum physical address width of the cpu. */
620 uint64_t u40PhysAddr : 40;
621 /** Available for software. */
622 uint64_t u12Available : 12;
623} EPTPDEBITS;
624AssertCompileSize(EPTPDEBITS, 8);
625
626/** Bits 12-51 - - EPT - Physical Page number of the next level. */
627#define EPT_PDE_PG_MASK X86_PDE_PAE_PG_MASK
628/** The page shift to get the PD index. */
629#define EPT_PD_SHIFT X86_PD_PAE_SHIFT
630/** The PD index mask (apply to a shifted page address). */
631#define EPT_PD_MASK X86_PD_PAE_MASK
632
633/**
634 * EPT 2MB Page Directory Table Entry. Bit view.
635 */
636typedef struct EPTPDE2MBITS
637{
638 /** Present bit. */
639 uint64_t u1Present : 1;
640 /** Writable bit. */
641 uint64_t u1Write : 1;
642 /** Executable bit. */
643 uint64_t u1Execute : 1;
644 /** EPT Table Memory Type. MBZ for non-leaf nodes. */
645 uint64_t u3EMT : 3;
646 /** Ignore PAT memory type */
647 uint64_t u1IgnorePAT : 1;
648 /** Big page (must be 1 here). */
649 uint64_t u1Size : 1;
650 /** Available for software. */
651 uint64_t u4Available : 4;
652 /** Reserved (must be 0). */
653 uint64_t u9Reserved : 9;
654 /** Physical address of the 2MB page. Restricted by maximum physical address width of the cpu. */
655 uint64_t u31PhysAddr : 31;
656 /** Available for software. */
657 uint64_t u12Available : 12;
658} EPTPDE2MBITS;
659AssertCompileSize(EPTPDE2MBITS, 8);
660
661/** Bits 21-51 - - EPT - Physical Page number of the next level. */
662#define EPT_PDE2M_PG_MASK X86_PDE2M_PAE_PG_MASK
663
664/**
665 * EPT Page Directory Table Entry.
666 */
667typedef union EPTPDE
668{
669 /** Normal view. */
670 EPTPDEBITS n;
671 /** 2MB view (big). */
672 EPTPDE2MBITS b;
673 /** Unsigned integer view. */
674 X86PGPAEUINT u;
675 /** 64 bit unsigned integer view. */
676 uint64_t au64[1];
677 /** 32 bit unsigned integer view. */
678 uint32_t au32[2];
679} EPTPDE;
680AssertCompileSize(EPTPDE, 8);
681/** Pointer to an EPT Page Directory Table Entry. */
682typedef EPTPDE *PEPTPDE;
683/** Pointer to a const EPT Page Directory Table Entry. */
684typedef const EPTPDE *PCEPTPDE;
685
686/**
687 * EPT Page Directory Table.
688 */
689typedef struct EPTPD
690{
691 EPTPDE a[EPT_PG_ENTRIES];
692} EPTPD;
693AssertCompileSize(EPTPD, 0x1000);
694/** Pointer to an EPT Page Directory Table. */
695typedef EPTPD *PEPTPD;
696/** Pointer to a const EPT Page Directory Table. */
697typedef const EPTPD *PCEPTPD;
698
699
700/**
701 * EPT Page Table Entry. Bit view.
702 */
703typedef struct EPTPTEBITS
704{
705 /** 0 - Present bit.
706 * @remark This is a convenience "misnomer". The bit actually indicates
707 * read access and the CPU will consider an entry with any of the
708 * first three bits set as present. Since all our valid entries
709 * will have this bit set, it can be used as a present indicator
710 * and allow some code sharing. */
711 uint64_t u1Present : 1;
712 /** 1 - Writable bit. */
713 uint64_t u1Write : 1;
714 /** 2 - Executable bit. */
715 uint64_t u1Execute : 1;
716 /** 5:3 - EPT Memory Type. MBZ for non-leaf nodes. */
717 uint64_t u3EMT : 3;
718 /** 6 - Ignore PAT memory type */
719 uint64_t u1IgnorePAT : 1;
720 /** 11:7 - Available for software. */
721 uint64_t u5Available : 5;
722 /** 51:12 - Physical address of page. Restricted by maximum physical
723 * address width of the cpu. */
724 uint64_t u40PhysAddr : 40;
725 /** 63:52 - Available for software. */
726 uint64_t u12Available : 12;
727} EPTPTEBITS;
728AssertCompileSize(EPTPTEBITS, 8);
729
730/** Bits 12-51 - - EPT - Physical Page number of the next level. */
731#define EPT_PTE_PG_MASK X86_PTE_PAE_PG_MASK
732/** The page shift to get the EPT PTE index. */
733#define EPT_PT_SHIFT X86_PT_PAE_SHIFT
734/** The EPT PT index mask (apply to a shifted page address). */
735#define EPT_PT_MASK X86_PT_PAE_MASK
736
737/**
738 * EPT Page Table Entry.
739 */
740typedef union EPTPTE
741{
742 /** Normal view. */
743 EPTPTEBITS n;
744 /** Unsigned integer view. */
745 X86PGPAEUINT u;
746 /** 64 bit unsigned integer view. */
747 uint64_t au64[1];
748 /** 32 bit unsigned integer view. */
749 uint32_t au32[2];
750} EPTPTE;
751AssertCompileSize(EPTPTE, 8);
752/** Pointer to an EPT Page Directory Table Entry. */
753typedef EPTPTE *PEPTPTE;
754/** Pointer to a const EPT Page Directory Table Entry. */
755typedef const EPTPTE *PCEPTPTE;
756
757/**
758 * EPT Page Table.
759 */
760typedef struct EPTPT
761{
762 EPTPTE a[EPT_PG_ENTRIES];
763} EPTPT;
764AssertCompileSize(EPTPT, 0x1000);
765/** Pointer to an extended page table. */
766typedef EPTPT *PEPTPT;
767/** Pointer to a const extended table. */
768typedef const EPTPT *PCEPTPT;
769
770/** @} */
771
772/** VMX VPID flush types.
773 * @note Valid enum members are in accordance to the VT-x spec.
774 */
775typedef enum
776{
777 /** Invalidate a specific page. */
778 VMXFLUSHVPID_INDIV_ADDR = 0,
779 /** Invalidate one context (specific VPID). */
780 VMXFLUSHVPID_SINGLE_CONTEXT = 1,
781 /** Invalidate all contexts (all VPIDs). */
782 VMXFLUSHVPID_ALL_CONTEXTS = 2,
783 /** Invalidate a single VPID context retaining global mappings. */
784 VMXFLUSHVPID_SINGLE_CONTEXT_RETAIN_GLOBALS = 3,
785 /** Unsupported by VirtualBox. */
786 VMXFLUSHVPID_NOT_SUPPORTED = 0xbad0,
787 /** Unsupported by CPU. */
788 VMXFLUSHVPID_NONE = 0xbad1
789} VMXFLUSHVPID;
790AssertCompileSize(VMXFLUSHVPID, 4);
791
792/** VMX EPT flush types.
793 * @note Valid enums values are in accordance to the VT-x spec.
794 */
795typedef enum
796{
797 /** Invalidate one context (specific EPT). */
798 VMXFLUSHEPT_SINGLE_CONTEXT = 1,
799 /* Invalidate all contexts (all EPTs) */
800 VMXFLUSHEPT_ALL_CONTEXTS = 2,
801 /** Unsupported by VirtualBox. */
802 VMXFLUSHEPT_NOT_SUPPORTED = 0xbad0,
803 /** Unsupported by CPU. */
804 VMXFLUSHEPT_NONE = 0xbad1
805} VMXFLUSHEPT;
806AssertCompileSize(VMXFLUSHEPT, 4);
807
808/** VMX Posted Interrupt Descriptor.
809 * In accordance to the VT-x spec.
810 */
811typedef struct VMXPOSTEDINTRDESC
812{
813 uint32_t aVectorBitmap[8];
814 uint32_t fOutstandingNotification : 1;
815 uint32_t uReserved0 : 31;
816 uint8_t au8Reserved0[28];
817} VMXPOSTEDINTRDESC;
818AssertCompileMemberSize(VMXPOSTEDINTRDESC, aVectorBitmap, 32);
819AssertCompileSize(VMXPOSTEDINTRDESC, 64);
820/** Pointer to a posted interrupt descriptor. */
821typedef VMXPOSTEDINTRDESC *PVMXPOSTEDINTRDESC;
822/** Pointer to a const posted interrupt descriptor. */
823typedef const VMXPOSTEDINTRDESC *PCVMXPOSTEDINTRDESC;
824
825/** VMX MSR autoload/store element.
826 * In accordance to the VT-x spec.
827 */
828typedef struct VMXAUTOMSR
829{
830 /** The MSR Id. */
831 uint32_t u32Msr;
832 /** Reserved (MBZ). */
833 uint32_t u32Reserved;
834 /** The MSR value. */
835 uint64_t u64Value;
836} VMXAUTOMSR;
837AssertCompileSize(VMXAUTOMSR, 16);
838/** Pointer to an MSR load/store element. */
839typedef VMXAUTOMSR *PVMXAUTOMSR;
840/** Pointer to a const MSR load/store element. */
841typedef const VMXAUTOMSR *PCVMXAUTOMSR;
842
843/**
844 * VMX-capability qword
845 */
846typedef union
847{
848 struct
849 {
850 /** Bits set here -must- be set in the corresponding VM-execution controls. */
851 uint32_t disallowed0;
852 /** Bits cleared here -must- be cleared in the corresponding VM-execution
853 * controls. */
854 uint32_t allowed1;
855 } n;
856 uint64_t u;
857} VMXCAPABILITY;
858AssertCompileSize(VMXCAPABILITY, 8);
859
860/**
861 * VMX MSRs.
862 */
863typedef struct VMXMSRS
864{
865 uint64_t u64FeatureCtrl;
866 uint64_t u64BasicInfo;
867 VMXCAPABILITY VmxPinCtls;
868 VMXCAPABILITY VmxProcCtls;
869 VMXCAPABILITY VmxProcCtls2;
870 VMXCAPABILITY VmxExit;
871 VMXCAPABILITY VmxEntry;
872 uint64_t u64Misc;
873 uint64_t u64Cr0Fixed0;
874 uint64_t u64Cr0Fixed1;
875 uint64_t u64Cr4Fixed0;
876 uint64_t u64Cr4Fixed1;
877 uint64_t u64VmcsEnum;
878 uint64_t u64Vmfunc;
879 uint64_t u64EptVpidCaps;
880} VMXMSRS;
881AssertCompileSizeAlignment(VMXMSRS, 8);
882/** Pointer to a VMXMSRS struct. */
883typedef VMXMSRS *PVMXMSRS;
884
885/** @name VMX EFLAGS reserved bits.
886 * @{
887 */
888/** And-mask for setting reserved bits to zero */
889#define VMX_EFLAGS_RESERVED_0 (X86_EFL_1 | X86_EFL_LIVE_MASK)
890/** Or-mask for setting reserved bits to 1 */
891#define VMX_EFLAGS_RESERVED_1 X86_EFL_1
892/** @} */
893
894/** @name VMX Basic Exit Reasons.
895 * @{
896 */
897/** -1 Invalid exit code */
898#define VMX_EXIT_INVALID -1
899/** 0 Exception or non-maskable interrupt (NMI). */
900#define VMX_EXIT_XCPT_OR_NMI 0
901/** 1 External interrupt. */
902#define VMX_EXIT_EXT_INT 1
903/** 2 Triple fault. */
904#define VMX_EXIT_TRIPLE_FAULT 2
905/** 3 INIT signal. */
906#define VMX_EXIT_INIT_SIGNAL 3
907/** 4 Start-up IPI (SIPI). */
908#define VMX_EXIT_SIPI 4
909/** 5 I/O system-management interrupt (SMI). */
910#define VMX_EXIT_IO_SMI 5
911/** 6 Other SMI. */
912#define VMX_EXIT_SMI 6
913/** 7 Interrupt window exiting. */
914#define VMX_EXIT_INT_WINDOW 7
915/** 8 NMI window exiting. */
916#define VMX_EXIT_NMI_WINDOW 8
917/** 9 Task switch. */
918#define VMX_EXIT_TASK_SWITCH 9
919/** 10 Guest software attempted to execute CPUID. */
920#define VMX_EXIT_CPUID 10
921/** 11 Guest software attempted to execute GETSEC. */
922#define VMX_EXIT_GETSEC 11
923/** 12 Guest software attempted to execute HLT. */
924#define VMX_EXIT_HLT 12
925/** 13 Guest software attempted to execute INVD. */
926#define VMX_EXIT_INVD 13
927/** 14 Guest software attempted to execute INVLPG. */
928#define VMX_EXIT_INVLPG 14
929/** 15 Guest software attempted to execute RDPMC. */
930#define VMX_EXIT_RDPMC 15
931/** 16 Guest software attempted to execute RDTSC. */
932#define VMX_EXIT_RDTSC 16
933/** 17 Guest software attempted to execute RSM in SMM. */
934#define VMX_EXIT_RSM 17
935/** 18 Guest software executed VMCALL. */
936#define VMX_EXIT_VMCALL 18
937/** 19 Guest software executed VMCLEAR. */
938#define VMX_EXIT_VMCLEAR 19
939/** 20 Guest software executed VMLAUNCH. */
940#define VMX_EXIT_VMLAUNCH 20
941/** 21 Guest software executed VMPTRLD. */
942#define VMX_EXIT_VMPTRLD 21
943/** 22 Guest software executed VMPTRST. */
944#define VMX_EXIT_VMPTRST 22
945/** 23 Guest software executed VMREAD. */
946#define VMX_EXIT_VMREAD 23
947/** 24 Guest software executed VMRESUME. */
948#define VMX_EXIT_VMRESUME 24
949/** 25 Guest software executed VMWRITE. */
950#define VMX_EXIT_VMWRITE 25
951/** 26 Guest software executed VMXOFF. */
952#define VMX_EXIT_VMXOFF 26
953/** 27 Guest software executed VMXON. */
954#define VMX_EXIT_VMXON 27
955/** 28 Control-register accesses. */
956#define VMX_EXIT_MOV_CRX 28
957/** 29 Debug-register accesses. */
958#define VMX_EXIT_MOV_DRX 29
959/** 30 I/O instruction. */
960#define VMX_EXIT_IO_INSTR 30
961/** 31 RDMSR. Guest software attempted to execute RDMSR. */
962#define VMX_EXIT_RDMSR 31
963/** 32 WRMSR. Guest software attempted to execute WRMSR. */
964#define VMX_EXIT_WRMSR 32
965/** 33 VM-entry failure due to invalid guest state. */
966#define VMX_EXIT_ERR_INVALID_GUEST_STATE 33
967/** 34 VM-entry failure due to MSR loading. */
968#define VMX_EXIT_ERR_MSR_LOAD 34
969/** 36 Guest software executed MWAIT. */
970#define VMX_EXIT_MWAIT 36
971/** 37 VM-exit due to monitor trap flag. */
972#define VMX_EXIT_MTF 37
973/** 39 Guest software attempted to execute MONITOR. */
974#define VMX_EXIT_MONITOR 39
975/** 40 Guest software attempted to execute PAUSE. */
976#define VMX_EXIT_PAUSE 40
977/** 41 VM-entry failure due to machine-check. */
978#define VMX_EXIT_ERR_MACHINE_CHECK 41
979/** 43 TPR below threshold. Guest software executed MOV to CR8. */
980#define VMX_EXIT_TPR_BELOW_THRESHOLD 43
981/** 44 APIC access. Guest software attempted to access memory at a physical address on the APIC-access page. */
982#define VMX_EXIT_APIC_ACCESS 44
983/** 45 Virtualized EOI. EOI virtualization was performed for a virtual interrupt
984whose vector indexed a bit set in the EOI-exit bitmap. */
985#define VMX_EXIT_VIRTUALIZED_EOI 45
986/** 46 Access to GDTR or IDTR. Guest software attempted to execute LGDT, LIDT, SGDT, or SIDT. */
987#define VMX_EXIT_XDTR_ACCESS 46
988/** 47 Access to LDTR or TR. Guest software attempted to execute LLDT, LTR, SLDT, or STR. */
989#define VMX_EXIT_TR_ACCESS 47
990/** 48 EPT violation. An attempt to access memory with a guest-physical address was disallowed by the configuration of the EPT paging structures. */
991#define VMX_EXIT_EPT_VIOLATION 48
992/** 49 EPT misconfiguration. An attempt to access memory with a guest-physical address encountered a misconfigured EPT paging-structure entry. */
993#define VMX_EXIT_EPT_MISCONFIG 49
994/** 50 INVEPT. Guest software attempted to execute INVEPT. */
995#define VMX_EXIT_INVEPT 50
996/** 51 RDTSCP. Guest software attempted to execute RDTSCP. */
997#define VMX_EXIT_RDTSCP 51
998/** 52 VMX-preemption timer expired. The preemption timer counted down to zero. */
999#define VMX_EXIT_PREEMPT_TIMER 52
1000/** 53 INVVPID. Guest software attempted to execute INVVPID. */
1001#define VMX_EXIT_INVVPID 53
1002/** 54 WBINVD. Guest software attempted to execute WBINVD. */
1003#define VMX_EXIT_WBINVD 54
1004/** 55 XSETBV. Guest software attempted to execute XSETBV. */
1005#define VMX_EXIT_XSETBV 55
1006/** 56 APIC write. Guest completed write to virtual-APIC. */
1007#define VMX_EXIT_APIC_WRITE 56
1008/** 57 RDRAND. Guest software attempted to execute RDRAND. */
1009#define VMX_EXIT_RDRAND 57
1010/** 58 INVPCID. Guest software attempted to execute INVPCID. */
1011#define VMX_EXIT_INVPCID 58
1012/** 59 VMFUNC. Guest software attempted to execute VMFUNC. */
1013#define VMX_EXIT_VMFUNC 59
1014/** 60 ENCLS. Guest software attempted to execute ENCLS. */
1015#define VMX_EXIT_ENCLS 60
1016/** 61 - RDSEED - Guest software attempted to executed RDSEED and exiting was
1017 * enabled. */
1018#define VMX_EXIT_RDSEED 61
1019/** 62 - Page-modification log full. */
1020#define VMX_EXIT_PML_FULL 62
1021/** 63 - XSAVES - Guest software attempted to executed XSAVES and exiting was
1022 * enabled (XSAVES/XRSTORS was enabled too, of course). */
1023#define VMX_EXIT_XSAVES 63
1024/** 63 - XRSTORS - Guest software attempted to executed XRSTORS and exiting
1025 * was enabled (XSAVES/XRSTORS was enabled too, of course). */
1026#define VMX_EXIT_XRSTORS 64
1027/** The maximum exit value (inclusive). */
1028#define VMX_EXIT_MAX (VMX_EXIT_XRSTORS)
1029/** @} */
1030
1031
1032/** @name VM Instruction Errors
1033 * @{
1034 */
1035/** VMCALL executed in VMX root operation. */
1036#define VMX_ERROR_VMCALL 1
1037/** VMCLEAR with invalid physical address. */
1038#define VMX_ERROR_VMCLEAR_INVALID_PHYS_ADDR 2
1039/** VMCLEAR with VMXON pointer. */
1040#define VMX_ERROR_VMCLEAR_INVALID_VMXON_PTR 3
1041/** VMLAUNCH with non-clear VMCS. */
1042#define VMX_ERROR_VMLAUCH_NON_CLEAR_VMCS 4
1043/** VMRESUME with non-launched VMCS. */
1044#define VMX_ERROR_VMRESUME_NON_LAUNCHED_VMCS 5
1045/** VMRESUME with a corrupted VMCS (indicates corruption of the current VMCS). */
1046#define VMX_ERROR_VMRESUME_CORRUPTED_VMCS 6
1047/** VM-entry with invalid control field(s). */
1048#define VMX_ERROR_VMENTRY_INVALID_CONTROL_FIELDS 7
1049/** VM-entry with invalid host-state field(s). */
1050#define VMX_ERROR_VMENTRY_INVALID_HOST_STATE 8
1051/** VMPTRLD with invalid physical address. */
1052#define VMX_ERROR_VMPTRLD_INVALID_PHYS_ADDR 9
1053/** VMPTRLD with VMXON pointer. */
1054#define VMX_ERROR_VMPTRLD_VMXON_PTR 10
1055/** VMPTRLD with incorrect VMCS revision identifier. */
1056#define VMX_ERROR_VMPTRLD_WRONG_VMCS_REVISION 11
1057/** VMREAD/VMWRITE from/to unsupported VMCS component. */
1058#define VMX_ERROR_VMREAD_INVALID_COMPONENT 12
1059#define VMX_ERROR_VMWRITE_INVALID_COMPONENT VMX_ERROR_VMREAD_INVALID_COMPONENT
1060/** VMWRITE to read-only VMCS component. */
1061#define VMX_ERROR_VMWRITE_READONLY_COMPONENT 13
1062/** VMXON executed in VMX root operation. */
1063#define VMX_ERROR_VMXON_IN_VMX_ROOT_OP 15
1064/** VM-entry with invalid executive-VMCS pointer. */
1065#define VMX_ERROR_VMENTRY_INVALID_VMCS_EXEC_PTR 16
1066/** VM-entry with non-launched executive VMCS. */
1067#define VMX_ERROR_VMENTRY_NON_LAUNCHED_EXEC_VMCS 17
1068/** VM-entry with executive-VMCS pointer not VMXON pointer. */
1069#define VMX_ERROR_VMENTRY_EXEC_VMCS_PTR 18
1070/** VMCALL with non-clear VMCS. */
1071#define VMX_ERROR_VMCALL_NON_CLEAR_VMCS 19
1072/** VMCALL with invalid VM-exit control fields. */
1073#define VMX_ERROR_VMCALL_INVALID_VMEXIT_FIELDS 20
1074/** VMCALL with incorrect MSEG revision identifier. */
1075#define VMX_ERROR_VMCALL_INVALID_MSEG_REVISION 22
1076/** VMXOFF under dual-monitor treatment of SMIs and SMM. */
1077#define VMX_ERROR_VMXOFF_DUAL_MONITOR 23
1078/** VMCALL with invalid SMM-monitor features. */
1079#define VMX_ERROR_VMCALL_INVALID_SMM_MONITOR 24
1080/** VM-entry with invalid VM-execution control fields in executive VMCS. */
1081#define VMX_ERROR_VMENTRY_INVALID_VM_EXEC_CTRL 25
1082/** VM-entry with events blocked by MOV SS. */
1083#define VMX_ERROR_VMENTRY_MOV_SS 26
1084/** Invalid operand to INVEPT/INVVPID. */
1085#define VMX_ERROR_INVEPTVPID_INVALID_OPERAND 28
1086/** @} */
1087
1088
1089/** @name VMX MSRs - Basic VMX information.
1090 * @{
1091 */
1092/** VMCS revision identifier used by the processor. */
1093#define MSR_IA32_VMX_BASIC_INFO_VMCS_ID(a) ((a) & 0x7FFFFFFF)
1094/** Size of the VMCS. */
1095#define MSR_IA32_VMX_BASIC_INFO_VMCS_SIZE(a) (((a) >> 32) & 0x1FFF)
1096/** Width of physical address used for the VMCS.
1097 * 0 -> limited to the available amount of physical ram
1098 * 1 -> within the first 4 GB
1099 */
1100#define MSR_IA32_VMX_BASIC_INFO_VMCS_PHYS_WIDTH(a) (((a) >> 48) & 1)
1101/** Whether the processor supports the dual-monitor treatment of system-management interrupts and system-management code. (always 1) */
1102#define MSR_IA32_VMX_BASIC_INFO_VMCS_DUAL_MON(a) (((a) >> 49) & 1)
1103/** Memory type that must be used for the VMCS. */
1104#define MSR_IA32_VMX_BASIC_INFO_VMCS_MEM_TYPE(a) (((a) >> 50) & 0xF)
1105/** Whether the processor provides additional information for exits due to INS/OUTS. */
1106#define MSR_IA32_VMX_BASIC_INFO_VMCS_INS_OUTS(a) RT_BOOL((a) & RT_BIT_64(54))
1107/** @} */
1108
1109
1110/** @name VMX MSRs - Misc VMX info.
1111 * @{
1112 */
1113/** Relationship between the preemption timer and tsc; count down every time bit x of the tsc changes. */
1114#define MSR_IA32_VMX_MISC_PREEMPT_TSC_BIT(a) ((a) & 0x1f)
1115/** Whether VM-exit stores EFER.LMA into the "IA32e mode guest" field. */
1116#define MSR_IA32_VMX_MISC_STORE_EFERLMA_VMEXIT(a) (((a) >> 5) & 1)
1117/** Activity states supported by the implementation. */
1118#define MSR_IA32_VMX_MISC_ACTIVITY_STATES(a) (((a) >> 6) & 0x7)
1119/** Number of CR3 target values supported by the processor. (0-256) */
1120#define MSR_IA32_VMX_MISC_CR3_TARGET(a) (((a) >> 16) & 0x1FF)
1121/** Maximum number of MSRs in the VMCS. (N+1)*512. */
1122#define MSR_IA32_VMX_MISC_MAX_MSR(a) (((((a) >> 25) & 0x7) + 1) * 512)
1123/** Whether RDMSR can be used to read IA32_SMBASE_MSR in SMM. */
1124#define MSR_IA32_VMX_MISC_RDMSR_SMBASE_MSR_SMM(a) (((a) >> 15) & 1)
1125/** Whether bit 2 of IA32_SMM_MONITOR_CTL can be set to 1. */
1126#define MSR_IA32_VMX_MISC_SMM_MONITOR_CTL_B2(a) (((a) >> 28) & 1)
1127/** Whether VMWRITE can be used to write VM-exit information fields. */
1128#define MSR_IA32_VMX_MISC_VMWRITE_VMEXIT_INFO(a) (((a) >> 29) & 1)
1129/** MSEG revision identifier used by the processor. */
1130#define MSR_IA32_VMX_MISC_MSEG_ID(a) ((a) >> 32)
1131/** @} */
1132
1133
1134/** @name VMX MSRs - VMCS enumeration field info
1135 * @{
1136 */
1137/** Highest field index. */
1138#define MSR_IA32_VMX_VMCS_ENUM_HIGHEST_INDEX(a) (((a) >> 1) & 0x1FF)
1139/** @} */
1140
1141
1142/** @name MSR_IA32_VMX_EPT_VPID_CAPS; EPT capabilities MSR
1143 * @{
1144 */
1145#define MSR_IA32_VMX_EPT_VPID_CAP_RWX_X_ONLY RT_BIT_64(0)
1146#define MSR_IA32_VMX_EPT_VPID_CAP_PAGE_WALK_LENGTH_4 RT_BIT_64(6)
1147#define MSR_IA32_VMX_EPT_VPID_CAP_EMT_UC RT_BIT_64(8)
1148#define MSR_IA32_VMX_EPT_VPID_CAP_EMT_WB RT_BIT_64(14)
1149#define MSR_IA32_VMX_EPT_VPID_CAP_PDE_2M RT_BIT_64(16)
1150#define MSR_IA32_VMX_EPT_VPID_CAP_PDPTE_1G RT_BIT_64(17)
1151#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT RT_BIT_64(20)
1152#define MSR_IA32_VMX_EPT_VPID_CAP_EPT_ACCESS_DIRTY RT_BIT_64(21)
1153#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT_SINGLE_CONTEXT RT_BIT_64(25)
1154#define MSR_IA32_VMX_EPT_VPID_CAP_INVEPT_ALL_CONTEXTS RT_BIT_64(26)
1155#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID RT_BIT_64(32)
1156#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_INDIV_ADDR RT_BIT_64(40)
1157#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_SINGLE_CONTEXT RT_BIT_64(41)
1158#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_ALL_CONTEXTS RT_BIT_64(42)
1159#define MSR_IA32_VMX_EPT_VPID_CAP_INVVPID_SINGLE_CONTEXT_RETAIN_GLOBALS RT_BIT_64(43)
1160/** @} */
1161
1162/** @name Extended Page Table Pointer (EPTP)
1163 * @{
1164 */
1165/** Uncachable EPT paging structure memory type. */
1166#define VMX_EPT_MEMTYPE_UC 0
1167/** Write-back EPT paging structure memory type. */
1168#define VMX_EPT_MEMTYPE_WB 6
1169/** Shift value to get the EPT page walk length (bits 5-3) */
1170#define VMX_EPT_PAGE_WALK_LENGTH_SHIFT 3
1171/** Mask value to get the EPT page walk length (bits 5-3) */
1172#define VMX_EPT_PAGE_WALK_LENGTH_MASK 7
1173/** Default EPT page-walk length (1 less than the actual EPT page-walk
1174 * length) */
1175#define VMX_EPT_PAGE_WALK_LENGTH_DEFAULT 3
1176/** @} */
1177
1178
1179/** @name VMCS field encoding - 16 bits guest fields
1180 * @{
1181 */
1182#define VMX_VMCS16_VPID 0x000
1183#define VMX_VMCS16_POSTED_INTR_NOTIFY_VECTOR 0x002
1184#define VMX_VMCS16_EPTP_INDEX 0x004
1185#define VMX_VMCS16_GUEST_ES_SEL 0x800
1186#define VMX_VMCS16_GUEST_CS_SEL 0x802
1187#define VMX_VMCS16_GUEST_SS_SEL 0x804
1188#define VMX_VMCS16_GUEST_DS_SEL 0x806
1189#define VMX_VMCS16_GUEST_FS_SEL 0x808
1190#define VMX_VMCS16_GUEST_GS_SEL 0x80A
1191#define VMX_VMCS16_GUEST_LDTR_SEL 0x80C
1192#define VMX_VMCS16_GUEST_TR_SEL 0x80E
1193#define VMX_VMCS16_GUEST_INTR_STATUS 0x810
1194/** @} */
1195
1196/** @name VMCS field encoding - 16 bits host fields
1197 * @{
1198 */
1199#define VMX_VMCS16_HOST_ES_SEL 0xC00
1200#define VMX_VMCS16_HOST_CS_SEL 0xC02
1201#define VMX_VMCS16_HOST_SS_SEL 0xC04
1202#define VMX_VMCS16_HOST_DS_SEL 0xC06
1203#define VMX_VMCS16_HOST_FS_SEL 0xC08
1204#define VMX_VMCS16_HOST_GS_SEL 0xC0A
1205#define VMX_VMCS16_HOST_TR_SEL 0xC0C
1206/** @} */
1207
1208/** @name VMCS field encoding - 64 bits host fields
1209 * @{
1210 */
1211#define VMX_VMCS64_HOST_PAT_FULL 0x2C00
1212#define VMX_VMCS64_HOST_PAT_HIGH 0x2C01
1213#define VMX_VMCS64_HOST_EFER_FULL 0x2C02
1214#define VMX_VMCS64_HOST_EFER_HIGH 0x2C03
1215#define VMX_VMCS64_HOST_PERF_GLOBAL_CTRL_FULL 0x2C04 /**< MSR IA32_PERF_GLOBAL_CTRL */
1216#define VMX_VMCS64_HOST_PERF_GLOBAL_CTRL_HIGH 0x2C05 /**< MSR IA32_PERF_GLOBAL_CTRL */
1217/** @} */
1218
1219
1220/** @name VMCS field encoding - 64 Bits control fields
1221 * @{
1222 */
1223#define VMX_VMCS64_CTRL_IO_BITMAP_A_FULL 0x2000
1224#define VMX_VMCS64_CTRL_IO_BITMAP_A_HIGH 0x2001
1225#define VMX_VMCS64_CTRL_IO_BITMAP_B_FULL 0x2002
1226#define VMX_VMCS64_CTRL_IO_BITMAP_B_HIGH 0x2003
1227
1228/* Optional */
1229#define VMX_VMCS64_CTRL_MSR_BITMAP_FULL 0x2004
1230#define VMX_VMCS64_CTRL_MSR_BITMAP_HIGH 0x2005
1231
1232#define VMX_VMCS64_CTRL_EXIT_MSR_STORE_FULL 0x2006
1233#define VMX_VMCS64_CTRL_EXIT_MSR_STORE_HIGH 0x2007
1234#define VMX_VMCS64_CTRL_EXIT_MSR_LOAD_FULL 0x2008
1235#define VMX_VMCS64_CTRL_EXIT_MSR_LOAD_HIGH 0x2009
1236
1237#define VMX_VMCS64_CTRL_ENTRY_MSR_LOAD_FULL 0x200A
1238#define VMX_VMCS64_CTRL_ENTRY_MSR_LOAD_HIGH 0x200B
1239
1240#define VMX_VMCS64_CTRL_EXEC_VMCS_PTR_FULL 0x200C
1241#define VMX_VMCS64_CTRL_EXEC_VMCS_PTR_HIGH 0x200D
1242
1243#define VMX_VMCS64_CTRL_TSC_OFFSET_FULL 0x2010
1244#define VMX_VMCS64_CTRL_TSC_OFFSET_HIGH 0x2011
1245
1246/** Optional (VMX_VMCS_CTRL_PROC_EXEC_USE_TPR_SHADOW) */
1247#define VMX_VMCS64_CTRL_VAPIC_PAGEADDR_FULL 0x2012
1248#define VMX_VMCS64_CTRL_VAPIC_PAGEADDR_HIGH 0x2013
1249
1250/** Optional (VMX_VMCS_CTRL_PROC_EXEC2_VIRT_APIC) */
1251#define VMX_VMCS64_CTRL_APIC_ACCESSADDR_FULL 0x2014
1252#define VMX_VMCS64_CTRL_APIC_ACCESSADDR_HIGH 0x2015
1253
1254/** Optional (VMX_VMCS_CTRL_PROC_EXEC2_VMFUNC) */
1255#define VMX_VMCS64_CTRL_POSTED_INTR_DESC_FULL 0x2016
1256#define VMX_VMCS64_CTRL_POSTED_INTR_DESC_HIGH 0x2017
1257
1258/** Optional (VMX_VMCS_CTRL_PROC_EXEC2_VMFUNC) */
1259#define VMX_VMCS64_CTRL_VMFUNC_CTRLS_FULL 0x2018
1260#define VMX_VMCS64_CTRL_VMFUNC_CTRLS_HIGH 0x2019
1261
1262/** Extended page table pointer. */
1263#define VMX_VMCS64_CTRL_EPTP_FULL 0x201A
1264#define VMX_VMCS64_CTRL_EPTP_HIGH 0x201B
1265
1266/** EOI-exit bitmap 0. */
1267#define VMX_VMCS64_CTRL_EOI_BITMAP_0_FULL 0x201C
1268#define VMX_VMCS64_CTRL_EOI_BITMAP_0_HIGH 0x201D
1269
1270/** EOI-exit bitmap 1. */
1271#define VMX_VMCS64_CTRL_EOI_BITMAP_1_FULL 0x201E
1272#define VMX_VMCS64_CTRL_EOI_BITMAP_1_HIGH 0x201F
1273
1274/** EOI-exit bitmap 2. */
1275#define VMX_VMCS64_CTRL_EOI_BITMAP_2_FULL 0x2020
1276#define VMX_VMCS64_CTRL_EOI_BITMAP_2_HIGH 0x2021
1277
1278/** EOI-exit bitmap 3. */
1279#define VMX_VMCS64_CTRL_EOI_BITMAP_3_FULL 0x2022
1280#define VMX_VMCS64_CTRL_EOI_BITMAP_3_HIGH 0x2023
1281
1282/** Extended page table pointer lists. */
1283#define VMX_VMCS64_CTRL_EPTP_LIST_FULL 0x2024
1284#define VMX_VMCS64_CTRL_EPTP_LIST_HIGH 0x2025
1285
1286/** VM-read bitmap. */
1287#define VMX_VMCS64_CTRL_VMREAD_BITMAP_FULL 0x2026
1288#define VMX_VMCS64_CTRL_VMREAD_BITMAP_HIGH 0x2027
1289
1290/** VM-write bitmap. */
1291#define VMX_VMCS64_CTRL_VMWRITE_BITMAP_FULL 0x2028
1292#define VMX_VMCS64_CTRL_VMWRITE_BITMAP_HIGH 0x2029
1293
1294/** Virtualization-exception information address. */
1295#define VMX_VMCS64_CTRL_VIRTXCPT_INFO_ADDR_FULL 0x202A
1296#define VMX_VMCS64_CTRL_VIRTXCPT_INFO_ADDR_HIGH 0x202B
1297
1298/** XSS-exiting bitmap. */
1299#define VMX_VMCS64_CTRL_XSS_EXITING_BITMAP_FULL 0x202C
1300#define VMX_VMCS64_CTRL_XSS_EXITING_BITMAP_HIGH 0x202D
1301
1302/** TSC multiplier. */
1303#define VMX_VMCS64_CTRL_TSC_MULTIPLIER_FULL 0x2032
1304#define VMX_VMCS64_CTRL_TSC_MULTIPLIER_HIGH 0x2033
1305
1306/** VM-exit guest physical address. */
1307#define VMX_VMCS64_EXIT_GUEST_PHYS_ADDR_FULL 0x2400
1308#define VMX_VMCS64_EXIT_GUEST_PHYS_ADDR_HIGH 0x2401
1309/** @} */
1310
1311
1312/** @name VMCS field encoding - 64 Bits guest fields
1313 * @{
1314 */
1315#define VMX_VMCS64_GUEST_VMCS_LINK_PTR_FULL 0x2800
1316#define VMX_VMCS64_GUEST_VMCS_LINK_PTR_HIGH 0x2801
1317#define VMX_VMCS64_GUEST_DEBUGCTL_FULL 0x2802 /**< MSR IA32_DEBUGCTL */
1318#define VMX_VMCS64_GUEST_DEBUGCTL_HIGH 0x2803 /**< MSR IA32_DEBUGCTL */
1319#define VMX_VMCS64_GUEST_PAT_FULL 0x2804
1320#define VMX_VMCS64_GUEST_PAT_HIGH 0x2805
1321#define VMX_VMCS64_GUEST_EFER_FULL 0x2806
1322#define VMX_VMCS64_GUEST_EFER_HIGH 0x2807
1323#define VMX_VMCS64_GUEST_PERF_GLOBAL_CTRL_FULL 0x2808 /**< MSR IA32_PERF_GLOBAL_CTRL */
1324#define VMX_VMCS64_GUEST_PERF_GLOBAL_CTRL_HIGH 0x2809 /**< MSR IA32_PERF_GLOBAL_CTRL */
1325#define VMX_VMCS64_GUEST_PDPTE0_FULL 0x280A
1326#define VMX_VMCS64_GUEST_PDPTE0_HIGH 0x280B
1327#define VMX_VMCS64_GUEST_PDPTE1_FULL 0x280C
1328#define VMX_VMCS64_GUEST_PDPTE1_HIGH 0x280D
1329#define VMX_VMCS64_GUEST_PDPTE2_FULL 0x280E
1330#define VMX_VMCS64_GUEST_PDPTE2_HIGH 0x280F
1331#define VMX_VMCS64_GUEST_PDPTE3_FULL 0x2810
1332#define VMX_VMCS64_GUEST_PDPTE3_HIGH 0x2811
1333/** @} */
1334
1335
1336/** @name VMCS field encoding - 32 Bits control fields
1337 * @{
1338 */
1339#define VMX_VMCS32_CTRL_PIN_EXEC 0x4000
1340#define VMX_VMCS32_CTRL_PROC_EXEC 0x4002
1341#define VMX_VMCS32_CTRL_EXCEPTION_BITMAP 0x4004
1342#define VMX_VMCS32_CTRL_PAGEFAULT_ERROR_MASK 0x4006
1343#define VMX_VMCS32_CTRL_PAGEFAULT_ERROR_MATCH 0x4008
1344#define VMX_VMCS32_CTRL_CR3_TARGET_COUNT 0x400A
1345#define VMX_VMCS32_CTRL_EXIT 0x400C
1346#define VMX_VMCS32_CTRL_EXIT_MSR_STORE_COUNT 0x400E
1347#define VMX_VMCS32_CTRL_EXIT_MSR_LOAD_COUNT 0x4010
1348#define VMX_VMCS32_CTRL_ENTRY 0x4012
1349#define VMX_VMCS32_CTRL_ENTRY_MSR_LOAD_COUNT 0x4014
1350#define VMX_VMCS32_CTRL_ENTRY_INTERRUPTION_INFO 0x4016
1351#define VMX_VMCS32_CTRL_ENTRY_EXCEPTION_ERRCODE 0x4018
1352#define VMX_VMCS32_CTRL_ENTRY_INSTR_LENGTH 0x401A
1353#define VMX_VMCS32_CTRL_TPR_THRESHOLD 0x401C
1354#define VMX_VMCS32_CTRL_PROC_EXEC2 0x401E
1355#define VMX_VMCS32_CTRL_PLE_GAP 0x4020
1356#define VMX_VMCS32_CTRL_PLE_WINDOW 0x4022
1357/** @} */
1358
1359
1360/** @name VMX_VMCS_CTRL_PIN_EXEC
1361 * @{
1362 */
1363/** External interrupts cause VM-exits if set; otherwise dispatched through the guest's IDT. */
1364#define VMX_VMCS_CTRL_PIN_EXEC_EXT_INT_EXIT RT_BIT(0)
1365/** Non-maskable interrupts cause VM-exits if set; otherwise dispatched through the guest's IDT. */
1366#define VMX_VMCS_CTRL_PIN_EXEC_NMI_EXIT RT_BIT(3)
1367/** Virtual NMIs. */
1368#define VMX_VMCS_CTRL_PIN_EXEC_VIRTUAL_NMI RT_BIT(5)
1369/** Activate VMX preemption timer. */
1370#define VMX_VMCS_CTRL_PIN_EXEC_PREEMPT_TIMER RT_BIT(6)
1371/** Process interrupts with the posted-interrupt notification vector. */
1372#define VMX_VMCS_CTRL_PIN_EXEC_POSTED_INTR RT_BIT(7)
1373/* All other bits are reserved and must be set according to MSR IA32_VMX_PROCBASED_CTLS. */
1374/** @} */
1375
1376/** @name VMX_VMCS_CTRL_PROC_EXEC
1377 * @{
1378 */
1379/** VM-exit as soon as RFLAGS.IF=1 and no blocking is active. */
1380#define VMX_VMCS_CTRL_PROC_EXEC_INT_WINDOW_EXIT RT_BIT(2)
1381/** Use timestamp counter offset. */
1382#define VMX_VMCS_CTRL_PROC_EXEC_USE_TSC_OFFSETTING RT_BIT(3)
1383/** VM-exit when executing the HLT instruction. */
1384#define VMX_VMCS_CTRL_PROC_EXEC_HLT_EXIT RT_BIT(7)
1385/** VM-exit when executing the INVLPG instruction. */
1386#define VMX_VMCS_CTRL_PROC_EXEC_INVLPG_EXIT RT_BIT(9)
1387/** VM-exit when executing the MWAIT instruction. */
1388#define VMX_VMCS_CTRL_PROC_EXEC_MWAIT_EXIT RT_BIT(10)
1389/** VM-exit when executing the RDPMC instruction. */
1390#define VMX_VMCS_CTRL_PROC_EXEC_RDPMC_EXIT RT_BIT(11)
1391/** VM-exit when executing the RDTSC/RDTSCP instruction. */
1392#define VMX_VMCS_CTRL_PROC_EXEC_RDTSC_EXIT RT_BIT(12)
1393/** VM-exit when executing the MOV to CR3 instruction. (forced to 1 on the 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
1394#define VMX_VMCS_CTRL_PROC_EXEC_CR3_LOAD_EXIT RT_BIT(15)
1395/** VM-exit when executing the MOV from CR3 instruction. (forced to 1 on the 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
1396#define VMX_VMCS_CTRL_PROC_EXEC_CR3_STORE_EXIT RT_BIT(16)
1397/** VM-exit on CR8 loads. */
1398#define VMX_VMCS_CTRL_PROC_EXEC_CR8_LOAD_EXIT RT_BIT(19)
1399/** VM-exit on CR8 stores. */
1400#define VMX_VMCS_CTRL_PROC_EXEC_CR8_STORE_EXIT RT_BIT(20)
1401/** Use TPR shadow. */
1402#define VMX_VMCS_CTRL_PROC_EXEC_USE_TPR_SHADOW RT_BIT(21)
1403/** VM-exit when virtual NMI blocking is disabled. */
1404#define VMX_VMCS_CTRL_PROC_EXEC_NMI_WINDOW_EXIT RT_BIT(22)
1405/** VM-exit when executing a MOV DRx instruction. */
1406#define VMX_VMCS_CTRL_PROC_EXEC_MOV_DR_EXIT RT_BIT(23)
1407/** VM-exit when executing IO instructions. */
1408#define VMX_VMCS_CTRL_PROC_EXEC_UNCOND_IO_EXIT RT_BIT(24)
1409/** Use IO bitmaps. */
1410#define VMX_VMCS_CTRL_PROC_EXEC_USE_IO_BITMAPS RT_BIT(25)
1411/** Monitor trap flag. */
1412#define VMX_VMCS_CTRL_PROC_EXEC_MONITOR_TRAP_FLAG RT_BIT(27)
1413/** Use MSR bitmaps. */
1414#define VMX_VMCS_CTRL_PROC_EXEC_USE_MSR_BITMAPS RT_BIT(28)
1415/** VM-exit when executing the MONITOR instruction. */
1416#define VMX_VMCS_CTRL_PROC_EXEC_MONITOR_EXIT RT_BIT(29)
1417/** VM-exit when executing the PAUSE instruction. */
1418#define VMX_VMCS_CTRL_PROC_EXEC_PAUSE_EXIT RT_BIT(30)
1419/** Determines whether the secondary processor based VM-execution controls are used. */
1420#define VMX_VMCS_CTRL_PROC_EXEC_USE_SECONDARY_EXEC_CTRL RT_BIT(31)
1421/** @} */
1422
1423/** @name VMX_VMCS_CTRL_PROC_EXEC2
1424 * @{
1425 */
1426/** Virtualize APIC access. */
1427#define VMX_VMCS_CTRL_PROC_EXEC2_VIRT_APIC RT_BIT(0)
1428/** EPT supported/enabled. */
1429#define VMX_VMCS_CTRL_PROC_EXEC2_EPT RT_BIT(1)
1430/** Descriptor table instructions cause VM-exits. */
1431#define VMX_VMCS_CTRL_PROC_EXEC2_DESCRIPTOR_TABLE_EXIT RT_BIT(2)
1432/** RDTSCP supported/enabled. */
1433#define VMX_VMCS_CTRL_PROC_EXEC2_RDTSCP RT_BIT(3)
1434/** Virtualize x2APIC mode. */
1435#define VMX_VMCS_CTRL_PROC_EXEC2_VIRT_X2APIC RT_BIT(4)
1436/** VPID supported/enabled. */
1437#define VMX_VMCS_CTRL_PROC_EXEC2_VPID RT_BIT(5)
1438/** VM-exit when executing the WBINVD instruction. */
1439#define VMX_VMCS_CTRL_PROC_EXEC2_WBINVD_EXIT RT_BIT(6)
1440/** Unrestricted guest execution. */
1441#define VMX_VMCS_CTRL_PROC_EXEC2_UNRESTRICTED_GUEST RT_BIT(7)
1442/** APIC register virtualization. */
1443#define VMX_VMCS_CTRL_PROC_EXEC2_APIC_REG_VIRT RT_BIT(8)
1444/** Virtual-interrupt delivery. */
1445#define VMX_VMCS_CTRL_PROC_EXEC2_VIRT_INTR_DELIVERY RT_BIT(9)
1446/** A specified number of pause loops cause a VM-exit. */
1447#define VMX_VMCS_CTRL_PROC_EXEC2_PAUSE_LOOP_EXIT RT_BIT(10)
1448/** VM-exit when executing RDRAND instructions. */
1449#define VMX_VMCS_CTRL_PROC_EXEC2_RDRAND_EXIT RT_BIT(11)
1450/** Enables INVPCID instructions. */
1451#define VMX_VMCS_CTRL_PROC_EXEC2_INVPCID RT_BIT(12)
1452/** Enables VMFUNC instructions. */
1453#define VMX_VMCS_CTRL_PROC_EXEC2_VMFUNC RT_BIT(13)
1454/** Enables VMCS shadowing. */
1455#define VMX_VMCS_CTRL_PROC_EXEC2_VMCS_SHADOWING RT_BIT(14)
1456/** Enables ENCLS VM-exits. */
1457#define VMX_VMCS_CTRL_PROC_EXEC2_ENCLS_EXIT RT_BIT(15)
1458/** VM-exit when executing RDSEED. */
1459#define VMX_VMCS_CTRL_PROC_EXEC2_RDSEED_EXIT RT_BIT(16)
1460/** Enables page-modification logging. */
1461#define VMX_VMCS_CTRL_PROC_EXEC2_PML RT_BIT(17)
1462/** Controls whether EPT-violations may cause \#VE instead of exits. */
1463#define VMX_VMCS_CTRL_PROC_EXEC2_EPT_VE RT_BIT(18)
1464/** Conceal VMX non-root operation from Intel processor trace (PT). */
1465#define VMX_VMCS_CTRL_PROC_EXEC2_CONCEAL_FROM_PT RT_BIT(19)
1466/** Enables XSAVES/XRSTORS instructions. */
1467#define VMX_VMCS_CTRL_PROC_EXEC2_XSAVES_XRSTORS RT_BIT(20)
1468/** Use TSC scaling. */
1469#define VMX_VMCS_CTRL_PROC_EXEC2_TSC_SCALING RT_BIT(25)
1470
1471/** @} */
1472
1473
1474/** @name VMX_VMCS_CTRL_ENTRY
1475 * @{
1476 */
1477/** Load guest debug controls (dr7 & IA32_DEBUGCTL_MSR) (forced to 1 on the 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
1478#define VMX_VMCS_CTRL_ENTRY_LOAD_DEBUG RT_BIT(2)
1479/** 64 bits guest mode. Must be 0 for CPUs that don't support AMD64. */
1480#define VMX_VMCS_CTRL_ENTRY_IA32E_MODE_GUEST RT_BIT(9)
1481/** In SMM mode after VM-entry. */
1482#define VMX_VMCS_CTRL_ENTRY_ENTRY_SMM RT_BIT(10)
1483/** Disable dual treatment of SMI and SMM; must be zero for VM-entry outside of SMM. */
1484#define VMX_VMCS_CTRL_ENTRY_DEACTIVATE_DUALMON RT_BIT(11)
1485/** Whether the guest IA32_PERF_GLOBAL_CTRL MSR is loaded on VM-entry. */
1486#define VMX_VMCS_CTRL_ENTRY_LOAD_GUEST_PERF_MSR RT_BIT(13)
1487/** Whether the guest IA32_PAT MSR is loaded on VM-entry. */
1488#define VMX_VMCS_CTRL_ENTRY_LOAD_GUEST_PAT_MSR RT_BIT(14)
1489/** Whether the guest IA32_EFER MSR is loaded on VM-entry. */
1490#define VMX_VMCS_CTRL_ENTRY_LOAD_GUEST_EFER_MSR RT_BIT(15)
1491/** @} */
1492
1493
1494/** @name VMX_VMCS_CTRL_EXIT
1495 * @{
1496 */
1497/** Save guest debug controls (dr7 & IA32_DEBUGCTL_MSR) (forced to 1 on the 'first' VT-x capable CPUs; this actually includes the newest Nehalem CPUs) */
1498#define VMX_VMCS_CTRL_EXIT_SAVE_DEBUG RT_BIT(2)
1499/** Return to long mode after a VM-exit. */
1500#define VMX_VMCS_CTRL_EXIT_HOST_ADDR_SPACE_SIZE RT_BIT(9)
1501/** Whether the IA32_PERF_GLOBAL_CTRL MSR is loaded on VM-exit. */
1502#define VMX_VMCS_CTRL_EXIT_LOAD_PERF_MSR RT_BIT(12)
1503/** Acknowledge external interrupts with the irq controller if one caused a VM-exit. */
1504#define VMX_VMCS_CTRL_EXIT_ACK_EXT_INT RT_BIT(15)
1505/** Whether the guest IA32_PAT MSR is saved on VM-exit. */
1506#define VMX_VMCS_CTRL_EXIT_SAVE_GUEST_PAT_MSR RT_BIT(18)
1507/** Whether the host IA32_PAT MSR is loaded on VM-exit. */
1508#define VMX_VMCS_CTRL_EXIT_LOAD_HOST_PAT_MSR RT_BIT(19)
1509/** Whether the guest IA32_EFER MSR is saved on VM-exit. */
1510#define VMX_VMCS_CTRL_EXIT_SAVE_GUEST_EFER_MSR RT_BIT(20)
1511/** Whether the host IA32_EFER MSR is loaded on VM-exit. */
1512#define VMX_VMCS_CTRL_EXIT_LOAD_HOST_EFER_MSR RT_BIT(21)
1513/** Whether the value of the VMX preemption timer is saved on every VM-exit. */
1514#define VMX_VMCS_CTRL_EXIT_SAVE_VMX_PREEMPT_TIMER RT_BIT(22)
1515/** @} */
1516
1517
1518/** @name VMX_VMCS_CTRL_VMFUNC
1519 * @{
1520 */
1521/** EPTP-switching function changes the value of the EPTP to one chosen from the EPTP list. */
1522#define VMX_VMCS_CTRL_VMFUNC_EPTP_SWITCHING RT_BIT_64(0)
1523/** @} */
1524
1525
1526/** @name VMCS field encoding - 32 Bits read-only fields
1527 * @{
1528 */
1529#define VMX_VMCS32_RO_VM_INSTR_ERROR 0x4400
1530#define VMX_VMCS32_RO_EXIT_REASON 0x4402
1531#define VMX_VMCS32_RO_EXIT_INTERRUPTION_INFO 0x4404
1532#define VMX_VMCS32_RO_EXIT_INTERRUPTION_ERROR_CODE 0x4406
1533#define VMX_VMCS32_RO_IDT_INFO 0x4408
1534#define VMX_VMCS32_RO_IDT_ERROR_CODE 0x440A
1535#define VMX_VMCS32_RO_EXIT_INSTR_LENGTH 0x440C
1536#define VMX_VMCS32_RO_EXIT_INSTR_INFO 0x440E
1537/** @} */
1538
1539/** @name VMX_VMCS32_RO_EXIT_REASON
1540 * @{
1541 */
1542#define VMX_EXIT_REASON_BASIC(a) ((a) & 0xffff)
1543/** @} */
1544
1545/** @name VMX_VMCS32_CTRL_ENTRY_INTERRUPTION_INFO
1546 * @{
1547 */
1548#define VMX_ENTRY_INTERRUPTION_INFO_IS_VALID(a) RT_BOOL((a) & RT_BIT(31))
1549#define VMX_ENTRY_INTERRUPTION_INFO_TYPE_SHIFT 8
1550#define VMX_ENTRY_INTERRUPTION_INFO_TYPE(a) ((a >> VMX_ENTRY_INTERRUPTION_INFO_TYPE_SHIFT) & 7)
1551/** @} */
1552
1553
1554/** @name VMX_VMCS32_RO_EXIT_INTERRUPTION_INFO
1555 * @{
1556 */
1557#define VMX_EXIT_INTERRUPTION_INFO_VECTOR(a) ((a) & 0xff)
1558#define VMX_EXIT_INTERRUPTION_INFO_TYPE_SHIFT 8
1559#define VMX_EXIT_INTERRUPTION_INFO_TYPE(a) (((a) >> VMX_EXIT_INTERRUPTION_INFO_TYPE_SHIFT) & 7)
1560#define VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_VALID RT_BIT(11)
1561#define VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_IS_VALID(a) RT_BOOL((a) & VMX_EXIT_INTERRUPTION_INFO_ERROR_CODE_VALID)
1562#define VMX_EXIT_INTERRUPTION_INFO_NMI_UNBLOCK_IRET(a) ((a) & RT_BIT(12))
1563#define VMX_EXIT_INTERRUPTION_INFO_VALID RT_BIT(31)
1564#define VMX_EXIT_INTERRUPTION_INFO_IS_VALID(a) RT_BOOL((a) & RT_BIT(31))
1565/** Construct an irq event injection value from the exit interruption info value (same except that bit 12 is reserved). */
1566#define VMX_VMCS_CTRL_ENTRY_IRQ_INFO_FROM_EXIT_INT_INFO(a) ((a) & ~RT_BIT(12))
1567/** @} */
1568
1569/** @name VMX_VMCS_RO_EXIT_INTERRUPTION_INFO_TYPE
1570 * @{
1571 */
1572#define VMX_EXIT_INTERRUPTION_INFO_TYPE_EXT_INT 0
1573#define VMX_EXIT_INTERRUPTION_INFO_TYPE_NMI 2
1574#define VMX_EXIT_INTERRUPTION_INFO_TYPE_HW_XCPT 3
1575#define VMX_EXIT_INTERRUPTION_INFO_TYPE_SW_INT 4
1576#define VMX_EXIT_INTERRUPTION_INFO_TYPE_PRIV_SW_XCPT 5
1577#define VMX_EXIT_INTERRUPTION_INFO_TYPE_SW_XCPT 6
1578/** @} */
1579
1580/** @name VMX_VMCS32_RO_IDT_VECTORING_INFO
1581 * @{
1582 */
1583#define VMX_IDT_VECTORING_INFO_VECTOR(a) ((a) & 0xff)
1584#define VMX_IDT_VECTORING_INFO_TYPE_SHIFT 8
1585#define VMX_IDT_VECTORING_INFO_TYPE(a) (((a) >> VMX_IDT_VECTORING_INFO_TYPE_SHIFT) & 7)
1586#define VMX_IDT_VECTORING_INFO_ERROR_CODE_VALID RT_BIT(11)
1587#define VMX_IDT_VECTORING_INFO_ERROR_CODE_IS_VALID(a) RT_BOOL((a) & VMX_IDT_VECTORING_INFO_ERROR_CODE_VALID)
1588#define VMX_IDT_VECTORING_INFO_VALID(a) ((a) & RT_BIT(31))
1589#define VMX_ENTRY_INT_INFO_FROM_EXIT_IDT_INFO(a) ((a) & ~RT_BIT(12))
1590/** @} */
1591
1592/** @name VMX_VMCS_RO_IDT_VECTORING_INFO_TYPE
1593 * @{
1594 */
1595#define VMX_IDT_VECTORING_INFO_TYPE_EXT_INT 0
1596#define VMX_IDT_VECTORING_INFO_TYPE_NMI 2
1597#define VMX_IDT_VECTORING_INFO_TYPE_HW_XCPT 3
1598#define VMX_IDT_VECTORING_INFO_TYPE_SW_INT 4
1599#define VMX_IDT_VECTORING_INFO_TYPE_PRIV_SW_XCPT 5
1600#define VMX_IDT_VECTORING_INFO_TYPE_SW_XCPT 6
1601/** @} */
1602
1603
1604/** @name VMCS field encoding - 32 Bits guest state fields
1605 * @{
1606 */
1607#define VMX_VMCS32_GUEST_ES_LIMIT 0x4800
1608#define VMX_VMCS32_GUEST_CS_LIMIT 0x4802
1609#define VMX_VMCS32_GUEST_SS_LIMIT 0x4804
1610#define VMX_VMCS32_GUEST_DS_LIMIT 0x4806
1611#define VMX_VMCS32_GUEST_FS_LIMIT 0x4808
1612#define VMX_VMCS32_GUEST_GS_LIMIT 0x480A
1613#define VMX_VMCS32_GUEST_LDTR_LIMIT 0x480C
1614#define VMX_VMCS32_GUEST_TR_LIMIT 0x480E
1615#define VMX_VMCS32_GUEST_GDTR_LIMIT 0x4810
1616#define VMX_VMCS32_GUEST_IDTR_LIMIT 0x4812
1617#define VMX_VMCS32_GUEST_ES_ACCESS_RIGHTS 0x4814
1618#define VMX_VMCS32_GUEST_CS_ACCESS_RIGHTS 0x4816
1619#define VMX_VMCS32_GUEST_SS_ACCESS_RIGHTS 0x4818
1620#define VMX_VMCS32_GUEST_DS_ACCESS_RIGHTS 0x481A
1621#define VMX_VMCS32_GUEST_FS_ACCESS_RIGHTS 0x481C
1622#define VMX_VMCS32_GUEST_GS_ACCESS_RIGHTS 0x481E
1623#define VMX_VMCS32_GUEST_LDTR_ACCESS_RIGHTS 0x4820
1624#define VMX_VMCS32_GUEST_TR_ACCESS_RIGHTS 0x4822
1625#define VMX_VMCS32_GUEST_INTERRUPTIBILITY_STATE 0x4824
1626#define VMX_VMCS32_GUEST_ACTIVITY_STATE 0x4826
1627#define VMX_VMCS32_GUEST_SYSENTER_CS 0x482A /**< MSR IA32_SYSENTER_CS */
1628#define VMX_VMCS32_GUEST_PREEMPT_TIMER_VALUE 0x482E
1629/** @} */
1630
1631
1632/** @name VMX_VMCS_GUEST_ACTIVITY_STATE
1633 * @{
1634 */
1635/** The logical processor is active. */
1636#define VMX_VMCS_GUEST_ACTIVITY_ACTIVE 0x0
1637/** The logical processor is inactive, because executed a HLT instruction. */
1638#define VMX_VMCS_GUEST_ACTIVITY_HLT 0x1
1639/** The logical processor is inactive, because of a triple fault or other serious error. */
1640#define VMX_VMCS_GUEST_ACTIVITY_SHUTDOWN 0x2
1641/** The logical processor is inactive, because it's waiting for a startup-IPI */
1642#define VMX_VMCS_GUEST_ACTIVITY_SIPI_WAIT 0x3
1643/** @} */
1644
1645
1646/** @name VMX_VMCS_GUEST_INTERRUPTIBILITY_STATE
1647 * @{
1648 */
1649#define VMX_VMCS_GUEST_INTERRUPTIBILITY_STATE_BLOCK_STI RT_BIT(0)
1650#define VMX_VMCS_GUEST_INTERRUPTIBILITY_STATE_BLOCK_MOVSS RT_BIT(1)
1651#define VMX_VMCS_GUEST_INTERRUPTIBILITY_STATE_BLOCK_SMI RT_BIT(2)
1652#define VMX_VMCS_GUEST_INTERRUPTIBILITY_STATE_BLOCK_NMI RT_BIT(3)
1653/** @} */
1654
1655
1656/** @name VMCS field encoding - 32 Bits host state fields
1657 * @{
1658 */
1659#define VMX_VMCS32_HOST_SYSENTER_CS 0x4C00
1660/** @} */
1661
1662/** @name Natural width control fields
1663 * @{
1664 */
1665#define VMX_VMCS_CTRL_CR0_MASK 0x6000
1666#define VMX_VMCS_CTRL_CR4_MASK 0x6002
1667#define VMX_VMCS_CTRL_CR0_READ_SHADOW 0x6004
1668#define VMX_VMCS_CTRL_CR4_READ_SHADOW 0x6006
1669#define VMX_VMCS_CTRL_CR3_TARGET_VAL0 0x6008
1670#define VMX_VMCS_CTRL_CR3_TARGET_VAL1 0x600A
1671#define VMX_VMCS_CTRL_CR3_TARGET_VAL2 0x600C
1672#define VMX_VMCS_CTRL_CR3_TARGET_VAL31 0x600E
1673/** @} */
1674
1675
1676/** @name Natural width read-only data fields
1677 * @{
1678 */
1679#define VMX_VMCS_RO_EXIT_QUALIFICATION 0x6400
1680#define VMX_VMCS_RO_IO_RCX 0x6402
1681#define VMX_VMCS_RO_IO_RSX 0x6404
1682#define VMX_VMCS_RO_IO_RDI 0x6406
1683#define VMX_VMCS_RO_IO_RIP 0x6408
1684#define VMX_VMCS_RO_EXIT_GUEST_LINEAR_ADDR 0x640A
1685/** @} */
1686
1687
1688/** @name VMX_VMCS_RO_EXIT_QUALIFICATION
1689 * @{
1690 */
1691/** 0-2: Debug register number */
1692#define VMX_EXIT_QUALIFICATION_DRX_REGISTER(a) ((a) & 7)
1693/** 3: Reserved; cleared to 0. */
1694#define VMX_EXIT_QUALIFICATION_DRX_RES1(a) (((a) >> 3) & 1)
1695/** 4: Direction of move (0 = write, 1 = read) */
1696#define VMX_EXIT_QUALIFICATION_DRX_DIRECTION(a) (((a) >> 4) & 1)
1697/** 5-7: Reserved; cleared to 0. */
1698#define VMX_EXIT_QUALIFICATION_DRX_RES2(a) (((a) >> 5) & 7)
1699/** 8-11: General purpose register number. */
1700#define VMX_EXIT_QUALIFICATION_DRX_GENREG(a) (((a) >> 8) & 0xF)
1701/** Rest: reserved. */
1702/** @} */
1703
1704/** @name VMX_EXIT_QUALIFICATION_DRX_DIRECTION values
1705 * @{
1706 */
1707#define VMX_EXIT_QUALIFICATION_DRX_DIRECTION_WRITE 0
1708#define VMX_EXIT_QUALIFICATION_DRX_DIRECTION_READ 1
1709/** @} */
1710
1711
1712
1713/** @name CRx accesses
1714 * @{
1715 */
1716/** 0-3: Control register number (0 for CLTS & LMSW) */
1717#define VMX_EXIT_QUALIFICATION_CRX_REGISTER(a) ((a) & 0xF)
1718/** 4-5: Access type. */
1719#define VMX_EXIT_QUALIFICATION_CRX_ACCESS(a) (((a) >> 4) & 3)
1720/** 6: LMSW operand type */
1721#define VMX_EXIT_QUALIFICATION_CRX_LMSW_OP(a) (((a) >> 6) & 1)
1722/** 7: Reserved; cleared to 0. */
1723#define VMX_EXIT_QUALIFICATION_CRX_RES1(a) (((a) >> 7) & 1)
1724/** 8-11: General purpose register number (0 for CLTS & LMSW). */
1725#define VMX_EXIT_QUALIFICATION_CRX_GENREG(a) (((a) >> 8) & 0xF)
1726/** 12-15: Reserved; cleared to 0. */
1727#define VMX_EXIT_QUALIFICATION_CRX_RES2(a) (((a) >> 12) & 0xF)
1728/** 16-31: LMSW source data (else 0). */
1729#define VMX_EXIT_QUALIFICATION_CRX_LMSW_DATA(a) (((a) >> 16) & 0xFFFF)
1730/* Rest: reserved. */
1731/** @} */
1732
1733/** @name VMX_EXIT_QUALIFICATION_CRX_ACCESS
1734 * @{
1735 */
1736#define VMX_EXIT_QUALIFICATION_CRX_ACCESS_WRITE 0
1737#define VMX_EXIT_QUALIFICATION_CRX_ACCESS_READ 1
1738#define VMX_EXIT_QUALIFICATION_CRX_ACCESS_CLTS 2
1739#define VMX_EXIT_QUALIFICATION_CRX_ACCESS_LMSW 3
1740/** @} */
1741
1742/** @name VMX_EXIT_QUALIFICATION_TASK_SWITCH
1743 * @{
1744 */
1745#define VMX_EXIT_QUALIFICATION_TASK_SWITCH_SELECTOR(a) ((a) & 0xffff)
1746#define VMX_EXIT_QUALIFICATION_TASK_SWITCH_TYPE(a) (((a) >> 30) & 0x3)
1747/** Task switch caused by a call instruction. */
1748#define VMX_EXIT_QUALIFICATION_TASK_SWITCH_TYPE_CALL 0
1749/** Task switch caused by an iret instruction. */
1750#define VMX_EXIT_QUALIFICATION_TASK_SWITCH_TYPE_IRET 1
1751/** Task switch caused by a jmp instruction. */
1752#define VMX_EXIT_QUALIFICATION_TASK_SWITCH_TYPE_JMP 2
1753/** Task switch caused by an interrupt gate. */
1754#define VMX_EXIT_QUALIFICATION_TASK_SWITCH_TYPE_IDT 3
1755/** @} */
1756
1757
1758/** @name VMX_EXIT_EPT_VIOLATION
1759 * @{
1760 */
1761/** Set if the violation was caused by a data read. */
1762#define VMX_EXIT_QUALIFICATION_EPT_DATA_READ RT_BIT(0)
1763/** Set if the violation was caused by a data write. */
1764#define VMX_EXIT_QUALIFICATION_EPT_DATA_WRITE RT_BIT(1)
1765/** Set if the violation was caused by an instruction fetch. */
1766#define VMX_EXIT_QUALIFICATION_EPT_INSTR_FETCH RT_BIT(2)
1767/** AND of the present bit of all EPT structures. */
1768#define VMX_EXIT_QUALIFICATION_EPT_ENTRY_PRESENT RT_BIT(3)
1769/** AND of the write bit of all EPT structures. */
1770#define VMX_EXIT_QUALIFICATION_EPT_ENTRY_WRITE RT_BIT(4)
1771/** AND of the execute bit of all EPT structures. */
1772#define VMX_EXIT_QUALIFICATION_EPT_ENTRY_EXECUTE RT_BIT(5)
1773/** Set if the guest linear address field contains the faulting address. */
1774#define VMX_EXIT_QUALIFICATION_EPT_GUEST_ADDR_VALID RT_BIT(7)
1775/** If bit 7 is one: (reserved otherwise)
1776 * 1 - violation due to physical address access.
1777 * 0 - violation caused by page walk or access/dirty bit updates
1778 */
1779#define VMX_EXIT_QUALIFICATION_EPT_TRANSLATED_ACCESS RT_BIT(8)
1780/** @} */
1781
1782
1783/** @name VMX_EXIT_PORT_IO
1784 * @{
1785 */
1786/** 0-2: IO operation width. */
1787#define VMX_EXIT_QUALIFICATION_IO_WIDTH(a) ((a) & 7)
1788/** 3: IO operation direction. */
1789#define VMX_EXIT_QUALIFICATION_IO_DIRECTION(a) (((a) >> 3) & 1)
1790/** 4: String IO operation (INS / OUTS). */
1791#define VMX_EXIT_QUALIFICATION_IO_IS_STRING(a) RT_BOOL((a) & RT_BIT_64(4))
1792/** 5: Repeated IO operation. */
1793#define VMX_EXIT_QUALIFICATION_IO_IS_REP(a) RT_BOOL((a) & RT_BIT_64(5))
1794/** 6: Operand encoding. */
1795#define VMX_EXIT_QUALIFICATION_IO_ENCODING(a) (((a) >> 6) & 1)
1796/** 16-31: IO Port (0-0xffff). */
1797#define VMX_EXIT_QUALIFICATION_IO_PORT(a) (((a) >> 16) & 0xffff)
1798/* Rest reserved. */
1799/** @} */
1800
1801/** @name VMX_EXIT_QUALIFICATION_IO_DIRECTION
1802 * @{
1803 */
1804#define VMX_EXIT_QUALIFICATION_IO_DIRECTION_OUT 0
1805#define VMX_EXIT_QUALIFICATION_IO_DIRECTION_IN 1
1806/** @} */
1807
1808
1809/** @name VMX_EXIT_QUALIFICATION_IO_ENCODING
1810 * @{
1811 */
1812#define VMX_EXIT_QUALIFICATION_IO_ENCODING_DX 0
1813#define VMX_EXIT_QUALIFICATION_IO_ENCODING_IMM 1
1814/** @} */
1815
1816/** @name VMX_EXIT_APIC_ACCESS
1817 * @{
1818 */
1819/** 0-11: If the APIC-access VM-exit is due to a linear access, the offset of access within the APIC page. */
1820#define VMX_EXIT_QUALIFICATION_APIC_ACCESS_OFFSET(a) ((a) & 0xfff)
1821/** 12-15: Access type. */
1822#define VMX_EXIT_QUALIFICATION_APIC_ACCESS_TYPE(a) (((a) & 0xf000) >> 12)
1823/* Rest reserved. */
1824/** @} */
1825
1826
1827/** @name VMX_EXIT_QUALIFICATION_APIC_ACCESS_TYPE return values
1828 * @{
1829 */
1830/** Linear read access. */
1831#define VMX_APIC_ACCESS_TYPE_LINEAR_READ 0
1832/** Linear write access. */
1833#define VMX_APIC_ACCESS_TYPE_LINEAR_WRITE 1
1834/** Linear instruction fetch access. */
1835#define VMX_APIC_ACCESS_TYPE_LINEAR_INSTR_FETCH 2
1836/** Linear read/write access during event delivery. */
1837#define VMX_APIC_ACCESS_TYPE_LINEAR_EVENT_DELIVERY 3
1838/** Physical read/write access during event delivery. */
1839#define VMX_APIC_ACCESS_TYPE_PHYSICAL_EVENT_DELIVERY 10
1840/** Physical access for an instruction fetch or during instruction execution. */
1841#define VMX_APIC_ACCESS_TYPE_PHYSICAL_INSTR 15
1842/** @} */
1843
1844/** @name VMX_XDTR_INSINFO_XXX - VMX_EXIT_XDTR_ACCESS instruction information
1845 * Found in VMX_VMCS32_RO_EXIT_INSTR_INFO.
1846 * @{
1847 */
1848/** Address calculation scaling field (powers of two). */
1849#define VMX_XDTR_INSINFO_SCALE_SHIFT 0
1850#define VMX_XDTR_INSINFO_SCALE_MASK UINT32_C(0x00000003)
1851/** Bits 2 thru 6 are undefined. */
1852#define VMX_XDTR_INSINFO_UNDEF_2_6_SHIFT 2
1853#define VMX_XDTR_INSINFO_UNDEF_2_6_MASK UINT32_C(0x0000007c)
1854/** Address size, only 0(=16), 1(=32) and 2(=64) are defined.
1855 * @remarks anyone's guess why this is a 3 bit field... */
1856#define VMX_XDTR_INSINFO_ADDR_SIZE_SHIFT 7
1857#define VMX_XDTR_INSINFO_ADDR_SIZE_MASK UINT32_C(0x00000380)
1858/** Bit 10 is defined as zero. */
1859#define VMX_XDTR_INSINFO_ZERO_10_SHIFT 10
1860#define VMX_XDTR_INSINFO_ZERO_10_MASK UINT32_C(0x00000400)
1861/** Operand size, either (1=)32-bit or (0=)16-bit, but get this, it's undefined
1862 * for exits from 64-bit code as the operand size there is fixed. */
1863#define VMX_XDTR_INSINFO_OP_SIZE_SHIFT 11
1864#define VMX_XDTR_INSINFO_OP_SIZE_MASK UINT32_C(0x00000800)
1865/** Bits 12 thru 14 are undefined. */
1866#define VMX_XDTR_INSINFO_UNDEF_12_14_SHIFT 12
1867#define VMX_XDTR_INSINFO_UNDEF_12_14_MASK UINT32_C(0x00007000)
1868/** Applicable segment register (X86_SREG_XXX values). */
1869#define VMX_XDTR_INSINFO_SREG_SHIFT 15
1870#define VMX_XDTR_INSINFO_SREG_MASK UINT32_C(0x00038000)
1871/** Index register (X86_GREG_XXX values). Undefined if HAS_INDEX_REG is clear. */
1872#define VMX_XDTR_INSINFO_INDEX_REG_SHIFT 18
1873#define VMX_XDTR_INSINFO_INDEX_REG_MASK UINT32_C(0x003c0000)
1874/** Is VMX_XDTR_INSINFO_INDEX_REG_XXX valid (=1) or not (=0). */
1875#define VMX_XDTR_INSINFO_HAS_INDEX_REG_SHIFT 22
1876#define VMX_XDTR_INSINFO_HAS_INDEX_REG_MASK UINT32_C(0x00400000)
1877/** Base register (X86_GREG_XXX values). Undefined if HAS_BASE_REG is clear. */
1878#define VMX_XDTR_INSINFO_BASE_REG_SHIFT 23
1879#define VMX_XDTR_INSINFO_BASE_REG_MASK UINT32_C(0x07800000)
1880/** Is VMX_XDTR_INSINFO_BASE_REG_XXX valid (=1) or not (=0). */
1881#define VMX_XDTR_INSINFO_HAS_BASE_REG_SHIFT 27
1882#define VMX_XDTR_INSINFO_HAS_BASE_REG_MASK UINT32_C(0x08000000)
1883/** The instruction identity (VMX_XDTR_INSINFO_II_XXX values) */
1884#define VMX_XDTR_INSINFO_INSTR_ID_SHIFT 28
1885#define VMX_XDTR_INSINFO_INSTR_ID_MASK UINT32_C(0x30000000)
1886#define VMX_XDTR_INSINFO_II_SGDT 0 /**< Instruction ID: SGDT */
1887#define VMX_XDTR_INSINFO_II_SIDT 1 /**< Instruction ID: SIDT */
1888#define VMX_XDTR_INSINFO_II_LGDT 2 /**< Instruction ID: LGDT */
1889#define VMX_XDTR_INSINFO_II_LIDT 3 /**< Instruction ID: LIDT */
1890/** Bits 30 & 31 are undefined. */
1891#define VMX_XDTR_INSINFO_UNDEF_30_31_SHIFT 30
1892#define VMX_XDTR_INSINFO_UNDEF_30_31_MASK UINT32_C(0xc0000000)
1893RT_BF_ASSERT_COMPILE_CHECKS(VMX_XDTR_INSINFO_, UINT32_C(0), UINT32_MAX,
1894 (SCALE, UNDEF_2_6, ADDR_SIZE, ZERO_10, OP_SIZE, UNDEF_12_14, SREG, INDEX_REG, HAS_INDEX_REG,
1895 BASE_REG, HAS_BASE_REG, INSTR_ID, UNDEF_30_31));
1896/** @} */
1897
1898
1899/** @name VMX_YYTR_INSINFO_XXX - VMX_EXIT_TR_ACCESS instruction information
1900 * Found in VMX_VMCS32_RO_EXIT_INSTR_INFO.
1901 * This is similar to VMX_XDTR_INSINFO_XXX.
1902 * @{
1903 */
1904/** Address calculation scaling field (powers of two). */
1905#define VMX_YYTR_INSINFO_SCALE_SHIFT 0
1906#define VMX_YYTR_INSINFO_SCALE_MASK UINT32_C(0x00000003)
1907/** Bit 2 is undefined. */
1908#define VMX_YYTR_INSINFO_UNDEF_2_SHIFT 2
1909#define VMX_YYTR_INSINFO_UNDEF_2_MASK UINT32_C(0x00000004)
1910/** Register operand 1. Undefined if VMX_YYTR_INSINFO_HAS_REG1 is clear. */
1911#define VMX_YYTR_INSINFO_REG1_SHIFT 3
1912#define VMX_YYTR_INSINFO_REG1_MASK UINT32_C(0x00000078)
1913/** Address size, only 0(=16), 1(=32) and 2(=64) are defined.
1914 * @remarks anyone's guess why this is a 3 bit field... */
1915#define VMX_YYTR_INSINFO_ADDR_SIZE_SHIFT 7
1916#define VMX_YYTR_INSINFO_ADDR_SIZE_MASK UINT32_C(0x00000380)
1917/** Is VMX_YYTR_INSINFO_REG1_XXX valid (=1) or not (=0). */
1918#define VMX_YYTR_INSINFO_HAS_REG1_SHIFT 10
1919#define VMX_YYTR_INSINFO_HAS_REG1_MASK UINT32_C(0x00000400)
1920/** Bits 11 thru 14 are undefined. */
1921#define VMX_YYTR_INSINFO_UNDEF_11_14_SHIFT 11
1922#define VMX_YYTR_INSINFO_UNDEF_11_14_MASK UINT32_C(0x00007800)
1923/** Applicable segment register (X86_SREG_XXX values). */
1924#define VMX_YYTR_INSINFO_SREG_SHIFT 15
1925#define VMX_YYTR_INSINFO_SREG_MASK UINT32_C(0x00038000)
1926/** Index register (X86_GREG_XXX values). Undefined if HAS_INDEX_REG is clear. */
1927#define VMX_YYTR_INSINFO_INDEX_REG_SHIFT 18
1928#define VMX_YYTR_INSINFO_INDEX_REG_MASK UINT32_C(0x003c0000)
1929/** Is VMX_YYTR_INSINFO_INDEX_REG_XXX valid (=1) or not (=0). */
1930#define VMX_YYTR_INSINFO_HAS_INDEX_REG_SHIFT 22
1931#define VMX_YYTR_INSINFO_HAS_INDEX_REG_MASK UINT32_C(0x00400000)
1932/** Base register (X86_GREG_XXX values). Undefined if HAS_BASE_REG is clear. */
1933#define VMX_YYTR_INSINFO_BASE_REG_SHIFT 23
1934#define VMX_YYTR_INSINFO_BASE_REG_MASK UINT32_C(0x07800000)
1935/** Is VMX_YYTR_INSINFO_BASE_REG_XXX valid (=1) or not (=0). */
1936#define VMX_YYTR_INSINFO_HAS_BASE_REG_SHIFT 27
1937#define VMX_YYTR_INSINFO_HAS_BASE_REG_MASK UINT32_C(0x08000000)
1938/** The instruction identity (VMX_YYTR_INSINFO_II_XXX values) */
1939#define VMX_YYTR_INSINFO_INSTR_ID_SHIFT 28
1940#define VMX_YYTR_INSINFO_INSTR_ID_MASK UINT32_C(0x30000000)
1941#define VMX_YYTR_INSINFO_II_SLDT 0 /**< Instruction ID: SLDT */
1942#define VMX_YYTR_INSINFO_II_STR 1 /**< Instruction ID: STR */
1943#define VMX_YYTR_INSINFO_II_LLDT 2 /**< Instruction ID: LLDT */
1944#define VMX_YYTR_INSINFO_II_LTR 3 /**< Instruction ID: LTR */
1945/** Bits 30 & 31 are undefined. */
1946#define VMX_YYTR_INSINFO_UNDEF_30_31_SHIFT 30
1947#define VMX_YYTR_INSINFO_UNDEF_30_31_MASK UINT32_C(0xc0000000)
1948RT_BF_ASSERT_COMPILE_CHECKS(VMX_YYTR_INSINFO_, UINT32_C(0), UINT32_MAX,
1949 (SCALE, UNDEF_2, REG1, ADDR_SIZE, HAS_REG1, UNDEF_11_14, SREG, INDEX_REG, HAS_INDEX_REG,
1950 BASE_REG, HAS_BASE_REG, INSTR_ID, UNDEF_30_31));
1951/** @} */
1952
1953
1954/** @name VMCS field encoding - Natural width guest state fields
1955 * @{
1956 */
1957#define VMX_VMCS_GUEST_CR0 0x6800
1958#define VMX_VMCS_GUEST_CR3 0x6802
1959#define VMX_VMCS_GUEST_CR4 0x6804
1960#define VMX_VMCS_GUEST_ES_BASE 0x6806
1961#define VMX_VMCS_GUEST_CS_BASE 0x6808
1962#define VMX_VMCS_GUEST_SS_BASE 0x680A
1963#define VMX_VMCS_GUEST_DS_BASE 0x680C
1964#define VMX_VMCS_GUEST_FS_BASE 0x680E
1965#define VMX_VMCS_GUEST_GS_BASE 0x6810
1966#define VMX_VMCS_GUEST_LDTR_BASE 0x6812
1967#define VMX_VMCS_GUEST_TR_BASE 0x6814
1968#define VMX_VMCS_GUEST_GDTR_BASE 0x6816
1969#define VMX_VMCS_GUEST_IDTR_BASE 0x6818
1970#define VMX_VMCS_GUEST_DR7 0x681A
1971#define VMX_VMCS_GUEST_RSP 0x681C
1972#define VMX_VMCS_GUEST_RIP 0x681E
1973#define VMX_VMCS_GUEST_RFLAGS 0x6820
1974#define VMX_VMCS_GUEST_PENDING_DEBUG_EXCEPTIONS 0x6822
1975#define VMX_VMCS_GUEST_SYSENTER_ESP 0x6824 /**< MSR IA32_SYSENTER_ESP */
1976#define VMX_VMCS_GUEST_SYSENTER_EIP 0x6826 /**< MSR IA32_SYSENTER_EIP */
1977/** @} */
1978
1979
1980/** @name VMX_VMCS_GUEST_DEBUG_EXCEPTIONS
1981 * Bits 4-11, 13 and 15-63 are reserved.
1982 * @{
1983 */
1984/** Hardware breakpoint 0 was met. */
1985#define VMX_VMCS_GUEST_DEBUG_EXCEPTIONS_B0 RT_BIT(0)
1986/** Hardware breakpoint 1 was met. */
1987#define VMX_VMCS_GUEST_DEBUG_EXCEPTIONS_B1 RT_BIT(1)
1988/** Hardware breakpoint 2 was met. */
1989#define VMX_VMCS_GUEST_DEBUG_EXCEPTIONS_B2 RT_BIT(2)
1990/** Hardware breakpoint 3 was met. */
1991#define VMX_VMCS_GUEST_DEBUG_EXCEPTIONS_B3 RT_BIT(3)
1992/** At least one data or IO breakpoint was hit. */
1993#define VMX_VMCS_GUEST_DEBUG_EXCEPTIONS_BREAKPOINT_ENABLED RT_BIT(12)
1994/** A debug exception would have been triggered by single-step execution mode. */
1995#define VMX_VMCS_GUEST_DEBUG_EXCEPTIONS_BS RT_BIT(14)
1996/** @} */
1997
1998/** @name VMCS field encoding - Natural width host state fields
1999 * @{
2000 */
2001#define VMX_VMCS_HOST_CR0 0x6C00
2002#define VMX_VMCS_HOST_CR3 0x6C02
2003#define VMX_VMCS_HOST_CR4 0x6C04
2004#define VMX_VMCS_HOST_FS_BASE 0x6C06
2005#define VMX_VMCS_HOST_GS_BASE 0x6C08
2006#define VMX_VMCS_HOST_TR_BASE 0x6C0A
2007#define VMX_VMCS_HOST_GDTR_BASE 0x6C0C
2008#define VMX_VMCS_HOST_IDTR_BASE 0x6C0E
2009#define VMX_VMCS_HOST_SYSENTER_ESP 0x6C10
2010#define VMX_VMCS_HOST_SYSENTER_EIP 0x6C12
2011#define VMX_VMCS_HOST_RSP 0x6C14
2012#define VMX_VMCS_HOST_RIP 0x6C16
2013/** @} */
2014
2015
2016/** @defgroup grp_hm_vmx_asm VMX Assembly Helpers
2017 * @{
2018 */
2019
2020/**
2021 * Restores some host-state fields that need not be done on every VM-exit.
2022 *
2023 * @returns VBox status code.
2024 * @param fRestoreHostFlags Flags of which host registers needs to be
2025 * restored.
2026 * @param pRestoreHost Pointer to the host-restore structure.
2027 */
2028DECLASM(int) VMXRestoreHostState(uint32_t fRestoreHostFlags, PVMXRESTOREHOST pRestoreHost);
2029
2030
2031/**
2032 * Dispatches an NMI to the host.
2033 */
2034DECLASM(int) VMXDispatchHostNmi(void);
2035
2036
2037/**
2038 * Executes VMXON.
2039 *
2040 * @returns VBox status code.
2041 * @param HCPhysVmxOn Physical address of VMXON structure.
2042 */
2043#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
2044DECLASM(int) VMXEnable(RTHCPHYS HCPhysVmxOn);
2045#else
2046DECLINLINE(int) VMXEnable(RTHCPHYS HCPhysVmxOn)
2047{
2048# if RT_INLINE_ASM_GNU_STYLE
2049 int rc = VINF_SUCCESS;
2050 __asm__ __volatile__ (
2051 "push %3 \n\t"
2052 "push %2 \n\t"
2053 ".byte 0xF3, 0x0F, 0xC7, 0x34, 0x24 # VMXON [esp] \n\t"
2054 "ja 2f \n\t"
2055 "je 1f \n\t"
2056 "movl $" RT_XSTR(VERR_VMX_INVALID_VMXON_PTR)", %0 \n\t"
2057 "jmp 2f \n\t"
2058 "1: \n\t"
2059 "movl $" RT_XSTR(VERR_VMX_VMXON_FAILED)", %0 \n\t"
2060 "2: \n\t"
2061 "add $8, %%esp \n\t"
2062 :"=rm"(rc)
2063 :"0"(VINF_SUCCESS),
2064 "ir"((uint32_t)HCPhysVmxOn), /* don't allow direct memory reference here, */
2065 "ir"((uint32_t)(HCPhysVmxOn >> 32)) /* this would not work with -fomit-frame-pointer */
2066 :"memory"
2067 );
2068 return rc;
2069
2070# elif VMX_USE_MSC_INTRINSICS
2071 unsigned char rcMsc = __vmx_on(&HCPhysVmxOn);
2072 if (RT_LIKELY(rcMsc == 0))
2073 return VINF_SUCCESS;
2074 return rcMsc == 2 ? VERR_VMX_INVALID_VMXON_PTR : VERR_VMX_VMXON_FAILED;
2075
2076# else
2077 int rc = VINF_SUCCESS;
2078 __asm
2079 {
2080 push dword ptr [HCPhysVmxOn + 4]
2081 push dword ptr [HCPhysVmxOn]
2082 _emit 0xF3
2083 _emit 0x0F
2084 _emit 0xC7
2085 _emit 0x34
2086 _emit 0x24 /* VMXON [esp] */
2087 jnc vmxon_good
2088 mov dword ptr [rc], VERR_VMX_INVALID_VMXON_PTR
2089 jmp the_end
2090
2091vmxon_good:
2092 jnz the_end
2093 mov dword ptr [rc], VERR_VMX_VMXON_FAILED
2094the_end:
2095 add esp, 8
2096 }
2097 return rc;
2098# endif
2099}
2100#endif
2101
2102
2103/**
2104 * Executes VMXOFF.
2105 */
2106#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
2107DECLASM(void) VMXDisable(void);
2108#else
2109DECLINLINE(void) VMXDisable(void)
2110{
2111# if RT_INLINE_ASM_GNU_STYLE
2112 __asm__ __volatile__ (
2113 ".byte 0x0F, 0x01, 0xC4 # VMXOFF \n\t"
2114 );
2115
2116# elif VMX_USE_MSC_INTRINSICS
2117 __vmx_off();
2118
2119# else
2120 __asm
2121 {
2122 _emit 0x0F
2123 _emit 0x01
2124 _emit 0xC4 /* VMXOFF */
2125 }
2126# endif
2127}
2128#endif
2129
2130
2131/**
2132 * Executes VMCLEAR.
2133 *
2134 * @returns VBox status code.
2135 * @param HCPhysVmcs Physical address of VM control structure.
2136 */
2137#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
2138DECLASM(int) VMXClearVmcs(RTHCPHYS HCPhysVmcs);
2139#else
2140DECLINLINE(int) VMXClearVmcs(RTHCPHYS HCPhysVmcs)
2141{
2142# if RT_INLINE_ASM_GNU_STYLE
2143 int rc = VINF_SUCCESS;
2144 __asm__ __volatile__ (
2145 "push %3 \n\t"
2146 "push %2 \n\t"
2147 ".byte 0x66, 0x0F, 0xC7, 0x34, 0x24 # VMCLEAR [esp] \n\t"
2148 "jnc 1f \n\t"
2149 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
2150 "1: \n\t"
2151 "add $8, %%esp \n\t"
2152 :"=rm"(rc)
2153 :"0"(VINF_SUCCESS),
2154 "ir"((uint32_t)HCPhysVmcs), /* don't allow direct memory reference here, */
2155 "ir"((uint32_t)(HCPhysVmcs >> 32)) /* this would not work with -fomit-frame-pointer */
2156 :"memory"
2157 );
2158 return rc;
2159
2160# elif VMX_USE_MSC_INTRINSICS
2161 unsigned char rcMsc = __vmx_vmclear(&HCPhysVmcs);
2162 if (RT_LIKELY(rcMsc == 0))
2163 return VINF_SUCCESS;
2164 return VERR_VMX_INVALID_VMCS_PTR;
2165
2166# else
2167 int rc = VINF_SUCCESS;
2168 __asm
2169 {
2170 push dword ptr [HCPhysVmcs + 4]
2171 push dword ptr [HCPhysVmcs]
2172 _emit 0x66
2173 _emit 0x0F
2174 _emit 0xC7
2175 _emit 0x34
2176 _emit 0x24 /* VMCLEAR [esp] */
2177 jnc success
2178 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
2179success:
2180 add esp, 8
2181 }
2182 return rc;
2183# endif
2184}
2185#endif
2186
2187
2188/**
2189 * Executes VMPTRLD.
2190 *
2191 * @returns VBox status code.
2192 * @param HCPhysVmcs Physical address of VMCS structure.
2193 */
2194#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
2195DECLASM(int) VMXActivateVmcs(RTHCPHYS HCPhysVmcs);
2196#else
2197DECLINLINE(int) VMXActivateVmcs(RTHCPHYS HCPhysVmcs)
2198{
2199# if RT_INLINE_ASM_GNU_STYLE
2200 int rc = VINF_SUCCESS;
2201 __asm__ __volatile__ (
2202 "push %3 \n\t"
2203 "push %2 \n\t"
2204 ".byte 0x0F, 0xC7, 0x34, 0x24 # VMPTRLD [esp] \n\t"
2205 "jnc 1f \n\t"
2206 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
2207 "1: \n\t"
2208 "add $8, %%esp \n\t"
2209 :"=rm"(rc)
2210 :"0"(VINF_SUCCESS),
2211 "ir"((uint32_t)HCPhysVmcs), /* don't allow direct memory reference here, */
2212 "ir"((uint32_t)(HCPhysVmcs >> 32)) /* this will not work with -fomit-frame-pointer */
2213 );
2214 return rc;
2215
2216# elif VMX_USE_MSC_INTRINSICS
2217 unsigned char rcMsc = __vmx_vmptrld(&HCPhysVmcs);
2218 if (RT_LIKELY(rcMsc == 0))
2219 return VINF_SUCCESS;
2220 return VERR_VMX_INVALID_VMCS_PTR;
2221
2222# else
2223 int rc = VINF_SUCCESS;
2224 __asm
2225 {
2226 push dword ptr [HCPhysVmcs + 4]
2227 push dword ptr [HCPhysVmcs]
2228 _emit 0x0F
2229 _emit 0xC7
2230 _emit 0x34
2231 _emit 0x24 /* VMPTRLD [esp] */
2232 jnc success
2233 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
2234
2235success:
2236 add esp, 8
2237 }
2238 return rc;
2239# endif
2240}
2241#endif
2242
2243/**
2244 * Executes VMPTRST.
2245 *
2246 * @returns VBox status code.
2247 * @param pHCPhysVmcs Where to store the physical address of the current
2248 * VMCS.
2249 */
2250DECLASM(int) VMXGetActivatedVmcs(RTHCPHYS *pHCPhysVmcs);
2251
2252/**
2253 * Executes VMWRITE.
2254 *
2255 * @returns VBox status code.
2256 * @retval VINF_SUCCESS.
2257 * @retval VERR_VMX_INVALID_VMCS_PTR.
2258 * @retval VERR_VMX_INVALID_VMCS_FIELD.
2259 *
2260 * @param idxField VMCS index.
2261 * @param u32Val 32-bit value.
2262 *
2263 * @remarks The values of the two status codes can be OR'ed together, the result
2264 * will be VERR_VMX_INVALID_VMCS_PTR.
2265 */
2266#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
2267DECLASM(int) VMXWriteVmcs32(uint32_t idxField, uint32_t u32Val);
2268#else
2269DECLINLINE(int) VMXWriteVmcs32(uint32_t idxField, uint32_t u32Val)
2270{
2271# if RT_INLINE_ASM_GNU_STYLE
2272 int rc = VINF_SUCCESS;
2273 __asm__ __volatile__ (
2274 ".byte 0x0F, 0x79, 0xC2 # VMWRITE eax, edx \n\t"
2275 "ja 2f \n\t"
2276 "je 1f \n\t"
2277 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
2278 "jmp 2f \n\t"
2279 "1: \n\t"
2280 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_FIELD)", %0 \n\t"
2281 "2: \n\t"
2282 :"=rm"(rc)
2283 :"0"(VINF_SUCCESS),
2284 "a"(idxField),
2285 "d"(u32Val)
2286 );
2287 return rc;
2288
2289# elif VMX_USE_MSC_INTRINSICS
2290 unsigned char rcMsc = __vmx_vmwrite(idxField, u32Val);
2291 if (RT_LIKELY(rcMsc == 0))
2292 return VINF_SUCCESS;
2293 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
2294
2295#else
2296 int rc = VINF_SUCCESS;
2297 __asm
2298 {
2299 push dword ptr [u32Val]
2300 mov eax, [idxField]
2301 _emit 0x0F
2302 _emit 0x79
2303 _emit 0x04
2304 _emit 0x24 /* VMWRITE eax, [esp] */
2305 jnc valid_vmcs
2306 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
2307 jmp the_end
2308
2309valid_vmcs:
2310 jnz the_end
2311 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_FIELD
2312the_end:
2313 add esp, 4
2314 }
2315 return rc;
2316# endif
2317}
2318#endif
2319
2320/**
2321 * Executes VMWRITE.
2322 *
2323 * @returns VBox status code.
2324 * @retval VINF_SUCCESS.
2325 * @retval VERR_VMX_INVALID_VMCS_PTR.
2326 * @retval VERR_VMX_INVALID_VMCS_FIELD.
2327 *
2328 * @param idxField VMCS index.
2329 * @param u64Val 16, 32 or 64-bit value.
2330 *
2331 * @remarks The values of the two status codes can be OR'ed together, the result
2332 * will be VERR_VMX_INVALID_VMCS_PTR.
2333 */
2334#if !defined(RT_ARCH_X86)
2335# if !VMX_USE_MSC_INTRINSICS || ARCH_BITS != 64
2336DECLASM(int) VMXWriteVmcs64(uint32_t idxField, uint64_t u64Val);
2337# else /* VMX_USE_MSC_INTRINSICS */
2338DECLINLINE(int) VMXWriteVmcs64(uint32_t idxField, uint64_t u64Val)
2339{
2340 unsigned char rcMsc = __vmx_vmwrite(idxField, u64Val);
2341 if (RT_LIKELY(rcMsc == 0))
2342 return VINF_SUCCESS;
2343 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
2344}
2345# endif /* VMX_USE_MSC_INTRINSICS */
2346#else
2347# define VMXWriteVmcs64(idxField, u64Val) VMXWriteVmcs64Ex(pVCpu, idxField, u64Val) /** @todo dead ugly, picking up pVCpu like this */
2348VMMR0DECL(int) VMXWriteVmcs64Ex(PVMCPU pVCpu, uint32_t idxField, uint64_t u64Val);
2349#endif
2350
2351#if ARCH_BITS == 32
2352# define VMXWriteVmcsHstN VMXWriteVmcs32
2353# define VMXWriteVmcsGstN(idxField, u64Val) VMXWriteVmcs64Ex(pVCpu, idxField, u64Val)
2354#else /* ARCH_BITS == 64 */
2355# define VMXWriteVmcsHstN VMXWriteVmcs64
2356# define VMXWriteVmcsGstN VMXWriteVmcs64
2357#endif
2358
2359
2360/**
2361 * Invalidate a page using INVEPT.
2362 *
2363 * @returns VBox status code.
2364 * @param enmFlush Type of flush.
2365 * @param pDescriptor Pointer to the descriptor.
2366 */
2367DECLASM(int) VMXR0InvEPT(VMXFLUSHEPT enmFlush, uint64_t *pDescriptor);
2368
2369/**
2370 * Invalidate a page using INVVPID.
2371 *
2372 * @returns VBox status code.
2373 * @param enmFlush Type of flush.
2374 * @param pDescriptor Pointer to the descriptor.
2375 */
2376DECLASM(int) VMXR0InvVPID(VMXFLUSHVPID enmFlush, uint64_t *pDescriptor);
2377
2378/**
2379 * Executes VMREAD.
2380 *
2381 * @returns VBox status code.
2382 * @retval VINF_SUCCESS.
2383 * @retval VERR_VMX_INVALID_VMCS_PTR.
2384 * @retval VERR_VMX_INVALID_VMCS_FIELD.
2385 *
2386 * @param idxField VMCS index.
2387 * @param pData Where to store VM field value.
2388 *
2389 * @remarks The values of the two status codes can be OR'ed together, the result
2390 * will be VERR_VMX_INVALID_VMCS_PTR.
2391 */
2392#if ((RT_INLINE_ASM_EXTERNAL || !defined(RT_ARCH_X86)) && !VMX_USE_MSC_INTRINSICS)
2393DECLASM(int) VMXReadVmcs32(uint32_t idxField, uint32_t *pData);
2394#else
2395DECLINLINE(int) VMXReadVmcs32(uint32_t idxField, uint32_t *pData)
2396{
2397# if RT_INLINE_ASM_GNU_STYLE
2398 int rc = VINF_SUCCESS;
2399 __asm__ __volatile__ (
2400 "movl $" RT_XSTR(VINF_SUCCESS)", %0 \n\t"
2401 ".byte 0x0F, 0x78, 0xc2 # VMREAD eax, edx \n\t"
2402 "ja 2f \n\t"
2403 "je 1f \n\t"
2404 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_PTR)", %0 \n\t"
2405 "jmp 2f \n\t"
2406 "1: \n\t"
2407 "movl $" RT_XSTR(VERR_VMX_INVALID_VMCS_FIELD)", %0 \n\t"
2408 "2: \n\t"
2409 :"=&r"(rc),
2410 "=d"(*pData)
2411 :"a"(idxField),
2412 "d"(0)
2413 );
2414 return rc;
2415
2416# elif VMX_USE_MSC_INTRINSICS
2417 unsigned char rcMsc;
2418# if ARCH_BITS == 32
2419 rcMsc = __vmx_vmread(idxField, pData);
2420# else
2421 uint64_t u64Tmp;
2422 rcMsc = __vmx_vmread(idxField, &u64Tmp);
2423 *pData = (uint32_t)u64Tmp;
2424# endif
2425 if (RT_LIKELY(rcMsc == 0))
2426 return VINF_SUCCESS;
2427 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
2428
2429#else
2430 int rc = VINF_SUCCESS;
2431 __asm
2432 {
2433 sub esp, 4
2434 mov dword ptr [esp], 0
2435 mov eax, [idxField]
2436 _emit 0x0F
2437 _emit 0x78
2438 _emit 0x04
2439 _emit 0x24 /* VMREAD eax, [esp] */
2440 mov edx, pData
2441 pop dword ptr [edx]
2442 jnc valid_vmcs
2443 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_PTR
2444 jmp the_end
2445
2446valid_vmcs:
2447 jnz the_end
2448 mov dword ptr [rc], VERR_VMX_INVALID_VMCS_FIELD
2449the_end:
2450 }
2451 return rc;
2452# endif
2453}
2454#endif
2455
2456/**
2457 * Executes VMREAD.
2458 *
2459 * @returns VBox status code.
2460 * @retval VINF_SUCCESS.
2461 * @retval VERR_VMX_INVALID_VMCS_PTR.
2462 * @retval VERR_VMX_INVALID_VMCS_FIELD.
2463 *
2464 * @param idxField VMCS index.
2465 * @param pData Where to store VM field value.
2466 *
2467 * @remarks The values of the two status codes can be OR'ed together, the result
2468 * will be VERR_VMX_INVALID_VMCS_PTR.
2469 */
2470#if (!defined(RT_ARCH_X86) && !VMX_USE_MSC_INTRINSICS)
2471DECLASM(int) VMXReadVmcs64(uint32_t idxField, uint64_t *pData);
2472#else
2473DECLINLINE(int) VMXReadVmcs64(uint32_t idxField, uint64_t *pData)
2474{
2475# if VMX_USE_MSC_INTRINSICS
2476 unsigned char rcMsc;
2477# if ARCH_BITS == 32
2478 size_t uLow;
2479 size_t uHigh;
2480 rcMsc = __vmx_vmread(idxField, &uLow);
2481 rcMsc |= __vmx_vmread(idxField + 1, &uHigh);
2482 *pData = RT_MAKE_U64(uLow, uHigh);
2483# else
2484 rcMsc = __vmx_vmread(idxField, pData);
2485# endif
2486 if (RT_LIKELY(rcMsc == 0))
2487 return VINF_SUCCESS;
2488 return rcMsc == 2 ? VERR_VMX_INVALID_VMCS_PTR : VERR_VMX_INVALID_VMCS_FIELD;
2489
2490# elif ARCH_BITS == 32
2491 int rc;
2492 uint32_t val_hi, val;
2493 rc = VMXReadVmcs32(idxField, &val);
2494 rc |= VMXReadVmcs32(idxField + 1, &val_hi);
2495 AssertRC(rc);
2496 *pData = RT_MAKE_U64(val, val_hi);
2497 return rc;
2498
2499# else
2500# error "Shouldn't be here..."
2501# endif
2502}
2503#endif
2504
2505/**
2506 * Gets the last instruction error value from the current VMCS.
2507 *
2508 * @returns VBox status code.
2509 */
2510DECLINLINE(uint32_t) VMXGetLastError(void)
2511{
2512#if ARCH_BITS == 64
2513 uint64_t uLastError = 0;
2514 int rc = VMXReadVmcs64(VMX_VMCS32_RO_VM_INSTR_ERROR, &uLastError);
2515 AssertRC(rc);
2516 return (uint32_t)uLastError;
2517
2518#else /* 32-bit host: */
2519 uint32_t uLastError = 0;
2520 int rc = VMXReadVmcs32(VMX_VMCS32_RO_VM_INSTR_ERROR, &uLastError);
2521 AssertRC(rc);
2522 return uLastError;
2523#endif
2524}
2525
2526#ifdef IN_RING0
2527VMMR0DECL(int) VMXR0InvalidatePage(PVM pVM, PVMCPU pVCpu, RTGCPTR GCVirt);
2528VMMR0DECL(int) VMXR0InvalidatePhysPage(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys);
2529#endif /* IN_RING0 */
2530
2531/** @} */
2532
2533/** @} */
2534
2535#endif
2536
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette